Skip to content

Commit 16c034c

Browse files
committed
Update README
1 parent e568711 commit 16c034c

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ These three special files also nest in sub directories, so it's not just the roo
3636
### File Syntax
3737

3838
All files follow the same basic syntax: `[[key]] value ... [[otherkey]] value`.
39-
Whitespace is not significant between keys and the first non-whitespace character between a key and a value.
39+
Whitespace is not significant between keys and the first non-whitespace character of a value.
4040
You can think of this as building a dictionary of keys and values, where the value is all the text you wrote after the key, including whitespace, but then trimmed at the front and end of any excess whitespace.
4141
The strings `[[`, `]]`, `{{`, `}}` are reserved and must be escaped in order to use the literal values, e.g. `\{{`.
4242
You don't escape individual characters of the string, but the string in total.
4343
The double brackets are used for macro expansion.
44-
Assuming you have a macro appropriate defined, then `[[key]] {{macroname}}` will replace `{{macroname}}` with whatever the value for that macro key is.
44+
Assuming you have a macro appropriately defined, then `[[key]] {{macroname}}` will replace `{{macroname}}` with whatever the value for that macro key is.
4545

4646
This syntax is used for all files, including the special files `model`, `macros`, and `options`.
4747
Note that key names are context sensitive, so `Front` is a different key than `front`.
@@ -100,14 +100,19 @@ You can not, and should not define this field in your notes.
100100
This field is forced upon any model you define and is used to determine if two notes are the same.
101101
The field holds not just the filename but the relative path from the root directory to its location.
102102

103+
Finally, there is a special field `tags`.
104+
You are allowed to define this field in your model if you choose, but it assumes the same syntax as a `model` files fields.
105+
That is, space separated words.
106+
Each word in the value of the key `[[tags]]` will be added as a tag to the note.
107+
103108
## After Importing
104109

105110
Once you've imported your collection of notes into Anki it is advised that you don't make any changes to the notes inside Anki itself.
106111
Obviously, the entire point of this plugin is for you to make those changes on the file system, so doing it inside Anki would kind of defeat the purpose.
107112

108113
However, every imported card has an `ffsi:owned` tag.
109114
If you wish to take a given note for yourself yet still use the importer for other notes, then remove this tag.
110-
The importer can still find the card and note if it remains in the deck, but will never delete notes that it does not claim to own.
115+
The importer can still find the card and note if it remains in the deck (and thus potentially change it), but it will never delete notes that it does not claim to own.
111116
There are two other tags that will be of use as well: `ffsi:added` and `ffsi:changed`.
112117
These tags are set at import-time to brand new notes or notes were either the model or the field data has changed.
113118
These offer a quick way to preview all of the changes you've made and correct mistakes.

0 commit comments

Comments
 (0)