Make a second apss through the entire documentation to fix issues

This commit is contained in:
Veronica Berglyd Olsen
2023-10-15 20:11:29 +02:00
parent cceb31aac7
commit ccffa91c49
21 changed files with 278 additions and 269 deletions
+27 -24
View File
@@ -5,14 +5,14 @@ Tags and References
*******************
In novelWriter there are no forms or tables to fill in to define the characters, locations and
other elements of your story. Instead, you can mark your :term:`Project Notes` as representing
these story elements by creating a :term:`tag`. Whenever you want to link a piece of yur story to
other elements of your story. Instead, you can mark your :term:`project notes` as representing
these story elements by creating a :term:`tag`. Whenever you want to link a piece of your story to
a note defining a story element, like a character, you create a :term:`reference` back to that tag.
You can also cross-link your Project Notes in the same way.
You can also cross-link your project notes in the same way.
This is perhaps one of the features that makes novelWriter quite different than other, similar
This is perhaps one of the features that makes novelWriter different from other, similar
applications. It is therefore not always obvious to new users how this is supposed to work, so
this chapter hopes to explains in more detail how these tags and references system works.
this chapter hopes to explains in more detail how to use the tags and references system.
.. tip::
If you find the Tags and Reference system difficult to follow just from reading this chapter,
@@ -30,11 +30,11 @@ The structure of your novelWriter project is inferred from the :term:`headings`
documents, not the documents themselves. See :ref:`a_struct_heads` for more details. Therefore,
metadata is also associated with headings, and not documents.
If you split your project into separate documents for each scene, this may not matter. However,
there are several benefits to using documents at a larger structural scale when starting your
project. For instance, it may make more sense to define all your scenes, and even chapters, in a
single document at first, or perhaps a document per act. You can later split these documents up
using the split feature. See :ref:`a_ui_tree_split_merge` for more details on this feature.
If you split your project into separate documents for each scene, this distinction may not matter.
However, there are several benefits to using documents at a larger structural scale when starting
your project. For instance, it may make more sense to define all your scenes, and even chapters, in
a single document at first, or perhaps a document per act. You can later split these documents up
using the document split feature. See :ref:`a_ui_tree_split_merge` for more details.
The implication here is that you can treat each heading as an independent element of your notes
that can be referenced somewhere else. In order to make it possible to reference a header section,
@@ -53,23 +53,23 @@ has to be unique across all documents in the project.
.. note::
In version 2.2, tags will be made case insensitive, but as of novelWriter 2.1 they are not. You
should avoid using tags that are only distinquished by case.
should however avoid using tags that are only distinguished by case.
Tags can then be referenced in the novel documents, or cross-referenced in other notes, and will
show up in the :guilabel:`Outline View` and in the back-reference panel when a document is opened
in the viewer.
After the tags have been defined, they can then be referenced in the novel documents, or
cross-referenced in other notes. they will also show up in the :guilabel:`Outline View` and in the
back-reference panel when a document is opened in the viewer.
The syntax highlighter will alert you that the keyword is correctly used and that the tag is
The syntax highlighter will indicate to you 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. An invalid tag should have a green wiggly line under it, and will not receive the syntax
colour that valid tags do.
The tag is the only part of these notes that the application uses. The rest of the document content
The tag is the only part of these notes that the novelWriter uses. The rest of the document content
is there for the writer to use in whatever way they wish. Of course, the content of the documents
can be added to the manuscript, or an outline document. If you want to compile a single document of
all your notes, you can do this from the :guilabel:`Manuscript Build` tool.
Example:
Example of a heading with a tag for a character of the story:
.. code-block:: none
@@ -81,10 +81,11 @@ Example:
When this is done in a document in a :term:`Root Folder` of type "Characters", the tag is
automatically treated as an available character in your project, and you will be able to reference
it in any of your other documents.
it in any of your other documents using the reference keywords for characters.
It is the root folder type that defines what category of story elements the tag is indexed under.
See the :ref:`a_proj_roots` section for an overview of availabe root folder types.
See the :ref:`a_proj_roots` section for an overview of availabe root folder types. They are also
covered in the next section.
.. _a_references_references:
@@ -98,7 +99,7 @@ other things.
References are set as a :term:`keyword` and a list of corresponding tags. The valid keywords are
listed below. The format of a reference line is ``@keyword: value1, [value2] ... [valueN]``. All
keywords allow multiple values.
reference keywords allow multiple values.
``@pov``
The point-of-view character for the current section. The target must be a note tag in a
@@ -141,9 +142,11 @@ keywords allow multiple values.
The syntax highlighter will alert the user that the tags and references are used correctly, and
that the tags referenced exist.
The highlighter may be mistaken if the index of defined tags is out of date. If so, press :kbd:`F9`
to regenerate it, or select :guilabel:`Rebuild Index` from the :guilabel:`Tools` menu. In general,
the index for a document is regenerated when it is saved, so this shouldn't normally be necessary.
.. note::
The highlighter may be mistaken if the index of defined tags is out of date. If so, press
:kbd:`F9` to regenerate it, or select :guilabel:`Rebuild Index` from the :guilabel:`Tools` menu.
In general, the index for a document is regenerated when it is saved, so this shouldn't normally
be necessary.
One note can also reference another note in the same way novel documents do. When the note is
opened in the document viewer, the references become clickable links, making it easier to follow
@@ -157,7 +160,7 @@ highlight that two notes are related.
.. tip::
If you cross-reference between notes and export your project as an HTML document using the
:guilabel:`Manuscript Build` tool, the cross-references become clickable links in the exported
HTML document.
HTML document as well.
Example of a novel document with references to characters and plots: