Reproog/novelWriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Made another pass of editing of the entire documentation

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2020-08-07 23:06:35 +02:00
parent 566c704c87
commit d7c1e47113
10 changed files with 349 additions and 238 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/notes.rst
+8 -7
View File
@@ -4,9 +4,10 @@
Supporting Files (Notes)
************************
Supporting files, or notes, are any file stored in root folders that are not a part of the novel
story itself. These files are intended for summaries and outlines of the various plot elements,
characters, locations, and so on, of the novel.
novelWriter doesn't have a database and compicated forms to fill in all details about plot elements,
characters, and all sorts of additional information that isn't a part of the novel text itself.
Instead, all such information is saved in notes. The relation between all these additional elements
is extracted from these files by the project indexer based on the tags and references you set.
These files are not required, but making at least minimal files for each such plot element, and add
a tag to them, makes it possible to use the :guilabel:`Outline` feature to see how each element
@@ -21,8 +22,8 @@ Tags in Notes
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.
files, or cross-referenced in 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
@@ -34,10 +35,10 @@ there for the writer to use in whatever way they wish. Of course, the content of
exported if you want to compile a single document of all your notes, or include them in an outline.
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
is opened in the view panel, these become clickable links, making it easier to follow connections in
the plot. Note files don't show up in the outline view though, so referencing between notes is only
meaningful if you want to be able to click-navigate between them.
.. tip::
If you cross-reference between notes as well, and export your project as an HTML file using the
export tool, the cross-references also become clickable in the exported document.
export tool, the cross-references become clickable in the exported document.