Veronica K. B. Olsen
24 lines
1.5 KiB
ReStructuredText
24 lines
1.5 KiB
ReStructuredText
************************
|
|
Supporting Files (Notes)
|
|
************************
|
|
|
|
Supporting files, or notes, are any files stored in root folders that are not the Novel root folder.
|
|
These files are intended for summaries and outlines of the various plot elements, characters, locations, and so on, of the novel.
|
|
These are not required, but making at least minimal files for each such element, and add a tag to them, makes it possible to use the Outline View feature to see how each element intersects with each section of the novel itself, and add clickable cross-references between document in the editor and viewer.
|
|
|
|
File Tags
|
|
=========
|
|
|
|
Each new heading in a note file can have a tag associated with it.
|
|
The format of a tag is ``@tag: tagname``, where tagname is a unique identifier.
|
|
Tags can then be referenced in the novel files, or other note files, and will show up in the Outline View and in the back-reference panel when a document is being viewed.
|
|
|
|
The syntax highlighter will alert the user that the keyword is correctly used and that the tag is allowed, that is, the tag is unique.
|
|
Duplicate tags should be detected as long as the index is up to date.
|
|
|
|
The tag is the only part of these files that the application uses.
|
|
The rest of the file is there for the writer to use in whatever way they wish.
|
|
|
|
A note file can also reference other note files in the same way novel files do.
|
|
When the note file is opened in the view pane, these become clickable links, making it easier to follow connections in the plot.
|