Advanced Functionality#

Protecting Fields and Tags#

Protecting Fields with Special Tags#

You can protect fields of individual notes using special tags. For example AnkiHub_Protect::Front protects the Front field of the note that has this tag. (Use underscore if there are spaces in the field name). AnkiHub_Protect::All protects all fields of the note. These tags are only used in the add-on, not on the Website. These are case sensitive.

Resetting local changes to notes#

There is an action for resetting local changes to notes in the Anki Browser. You can now make note contents be the same as on the AnkiHub website by selecting them in the browser, right clicking and selecting the AnkiHub: Reset local changes option. You can also reset all local changes to a deck (Anki Browser -> AnkiHub -> Reset all local changes to a deck). This is useful if, for example, you edited some notes and want to undo the changes or lost some updates by doing a full sync from AnkiWeb.

Choosing a Deck for New Notes#

  • There is a Set Home Deck button in the Subscribed Decks dialog (accessible from the AnkiHub menu) which allows you to configure the deck that new cards will be added to for an AnkiHub deck.

Subdecks and Subdeck tags#

Note: Currently there is no easy way to add subdeck support to an existing AnkiHub deck. At the moment it is only supported for new decks you create. We are working on making it possible to use this feature with all decks.

Notes within an AnkiHub deck are not organized into subdecks on the website, but each note can have a subdeck tag, that indicates which subdeck it belongs to. The add-on can use this tag to put the note into this subdeck. Subdeck tags look like this: AnkiHub_Subdeck::MyDeck::Subdeck.

When creating a collaborative deck from a deck that has subdecks, the add-on will ask you if you want to add subdeck tags to your notes.


These subdecks tags will make it possible for subscribers to have the same subdecks as you have. The Subscribed Decks menu (main Anki window -> AnkiHub -> Subscribed Decks) now has the option to Enable/Disable subdecks for a deck.

When you enable the option, the subdeck tags will be used to create missing subdecks and to move the notes to the deck indicated in their subdeck tag. Notes without a subdeck tag will end up in the main deck.

New notes synced from AnkiHub will be added to the deck indicated in their subdeck tag when subdecks are enabled for a deck.

Subdeck tags are synced to AnkiHub and can be changed using suggestions.

Anki Profiles#

The add-on changes its behavior based on the active Anki profile. If you have multiple Anki profiles you should only login into AnkiHub in one profile. When you subscribe to a deck in the add-on in one profile you won’t be subscribed to the deck in other profiles.

AnkiHub sidebar tree and AnkiHub-specific search parameters#

There is a AnkiHub sidebar tree in the Anki browser (similar to the sidebar trees for Tags and Decks) that includes categories you can select to e.g. show all AnkiHub notes in your collection or all notes that were updated by AnkiHub today.

Under the hood the sidebar tree uses AnkiHub-specific search parameters, similar to Ankis special search parameters like added:1(which searches for all notes that were added one day ago) or tag:some_tag (which searches for all notes that have the some_tag tag). You can see these search parameters when clicking on the different categories in the AnkiHub sidebar tree. They can be combined with other search parameters.

Optional Tags#

Resetting an Optional Tag Group#

There is an action for resetting local changes to an Optional Tag Group (Anki Browser -> AnkiHub -> Reset Optional Tag Group). This is useful if e.g. you edited some optional tags and want to undo the changes or lost some updates by doing a full sync from AnkiWeb.