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

Clarify and cross-reference the two sections of the docs describing references and tags

Browse Source
This commit is contained in:
Veronica K. B. Olsen
2021-02-06 01:41:56 +01:00
parent 003b056301
commit 190e74b4d2
2 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/usage_notes.rst
+2 -1
View File
@@ -24,7 +24,8 @@ Tags in Notes
Each new heading in a note can have a tag associated with it. The format of a tag is Each new heading in a note 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 ``@tag: tagname``, where tagname is a unique identifier. Tags can then be referenced in the novel
documents, or cross-referenced in other notes, and will show up in the outline view and in the documents, or cross-referenced in other notes, and will show up in the outline view and in the
back-reference panel when a document is being viewed. back-reference panel when a document is being viewed. See :ref:`a_struct_tags` for how to reference
notes.
The syntax highlighter will alert the user that the keyword is correctly used and that the tag is 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 allowed, that is, the tag is unique. Duplicate tags should be detected as long as the index is up
docs/source/usage_structure.rst
+5 -4
View File
@@ -86,10 +86,11 @@ more details.
Tag References Tag References
============== ==============
Each text partition indicated by a heading of any level, can contain references to tags set in the Each text partition, indicated by a heading of any level, can contain references to tags set in the
supporting notes of the project. The references are gathered by the indexer and used to generate supporting notes of the project. The references are gathered by the indexer and used to generate an
an outline view on the :guilabel:`Outline` tab of how the different parts of the novel are outline view on the :guilabel:`Outline` tab of how the different parts of the novel are connected.
connected. This section covers how to set references to tags. See :ref:`a_notes_tags` for how to define tags
the references can point to.
References and tags are also clickable in the document editor and viewer, making it easy to References and tags are also clickable in the document editor and viewer, making it easy to
navigate between reference notes while writing. Clicked links are always opened in the view panel. navigate between reference notes while writing. Clicked links are always opened in the view panel.