Make a second apss through the entire documentation to fix issues
This commit is contained in:
@@ -10,7 +10,7 @@ You can activate it from the sidebar, the :guilabel:`Tools` menu, or by pressing
|
||||
|
||||
.. versionadded:: 2.1
|
||||
This tool is new for version 2.1. A simpler tool was used for earlier versions. The simpler tool
|
||||
only allows you to define a single set of options for one build, but otherwise has much the same
|
||||
only allows you to define a single set of options for the build, but otherwise has much the same
|
||||
functionality.
|
||||
|
||||
|
||||
@@ -52,7 +52,7 @@ Document Selection
|
||||
|
||||
The :guilabel:`Selections` page of the :guilabel:`Manuscript Build Settings` dialog allows you to
|
||||
fine tune which documents are included in the build. They are indicated by a green arrow icon in
|
||||
the last column. On the right, you have some filter options for selecting content of a specific
|
||||
the last column. On the right you have some filter options for selecting content of a specific
|
||||
type, and a set of switches for which root folders to include.
|
||||
|
||||
You can override the result of these filters by marking one or more documents and selecting to
|
||||
@@ -71,14 +71,14 @@ Formatting Headings
|
||||
The :guilabel:`Headings` page of the :guilabel:`Manuscript Build Settings` dialog.
|
||||
|
||||
The :guilabel:`Headings` page of the :guilabel:`Manuscript Build Settings` dialog allows you to set
|
||||
how the headings in your :term:`Novel Documents` as formatted. By default, the title is just copied
|
||||
as-is, indicated by the ``{Title}`` format. You can change this to for instance add chapter
|
||||
how the headings in your :term:`Novel Documents` are formatted. By default, the title is just
|
||||
copied as-is, indicated by the ``{Title}`` format. You can change this to for instance add chapter
|
||||
numbers and scene numbers like shown int he figure above.
|
||||
|
||||
Clicking the edit button will copy the formatting string into the edit box, where a syntax
|
||||
highlighter will help indicate which parts are automatically generated by the build tool. The
|
||||
:guilabel:`Insert` button is a dropdown list of these formats, and selecting one will insert it at
|
||||
the position of the cursor.
|
||||
Clicking the edit button next to a format will copy the formatting string into the edit box where
|
||||
it can be modified, and where a syntax highlighter will help indicate which parts are automatically
|
||||
generated by the build tool. The :guilabel:`Insert` button is a dropdown list of these formats, and
|
||||
selecting one will insert it at the position of the cursor.
|
||||
|
||||
Any text you add that isn't highlighted in colours will remain in your formatted titles.
|
||||
``{Title}`` will always be replaced by the text in the heading from your documents.
|
||||
@@ -92,11 +92,11 @@ Scene Separators
|
||||
If you don't want any titles for your scenes (or for your sections if you have them), you can leave
|
||||
the formatting boxes empty. If so, an empty paragraph will be inserted between the scenes or
|
||||
sections instead, resulting in a gap in the text. You can also switch on the :guilabel:`Hide`
|
||||
setting, which will ignore them completely. That is, there won't even be an extra gap insetred.
|
||||
setting, which will ignore them completely. That is, there won't even be an extra gap inserted.
|
||||
|
||||
Alternatively, if you want a separator text between them, like the common ``* * *``, you can enter
|
||||
the desired separator text in the formatting box. In fact, if the format is any piece of static
|
||||
text, it will always be treated as a separator.
|
||||
the desired separator text as the format. If the format is any piece of static text, it will always
|
||||
be treated as a separator.
|
||||
|
||||
|
||||
Output Settings
|
||||
@@ -115,15 +115,15 @@ Building Manuscript Documents
|
||||
|
||||
.. figure:: images/fig_build_build.png
|
||||
|
||||
The :guilabel:`Manuscript Build` dialog sued for writing the actual manuscript documents.
|
||||
The :guilabel:`Manuscript Build` dialog used for writing the actual manuscript documents.
|
||||
|
||||
When you press the :guilabel:`Build` button on the :guilabel:`Build Manuscript` tool main window, a
|
||||
special file dialog opens up. This is where you pick your desired output format and where to write
|
||||
the file.
|
||||
|
||||
On the left is a list of all the available file formats, and on the right, a list of what documents
|
||||
are included based on the build definition you selected. You can choose an output path, and set a
|
||||
base file name as well. The file extension will be added automatically.
|
||||
On the left side of the dialog is a list of all the available file formats, and on the right, a
|
||||
list of the documents which are included based on the build definition you selected. You can choose
|
||||
an output path, and set a base file name as well. The file extension will be added automatically.
|
||||
|
||||
To generate the manuscript document, press the :guilabel:`Build` button. A small progress bar will
|
||||
show the build progress, but for small projects it may pass very fast.
|
||||
@@ -137,7 +137,7 @@ Currently, four document formats are supported.
|
||||
Open Document Format
|
||||
The Build tool can produce either an ``.odt`` file, or an ``.fodt`` file. The latter is just a
|
||||
flat version of the document format as a single XML file. Most rich text editors support the
|
||||
former, and a few the latter.
|
||||
former, and only a few the latter.
|
||||
|
||||
novelWriter HTML
|
||||
The HTML format writes a single ``.htm`` file with minimal style formatting. The HTML document
|
||||
@@ -145,10 +145,10 @@ novelWriter HTML
|
||||
word processors, or for printing from browser.
|
||||
|
||||
novelWriter Markup
|
||||
This is simply a concatenation of the project documents selected by the filters. The documents
|
||||
are stacked together in the order they appear in the project tree, with comments, tags, etc.
|
||||
included if they are selected. This is a useful format for exporting the project for later
|
||||
import back into novelWriter.
|
||||
This is simply a concatenation of the project documents selected by the filters into a ``.txt``
|
||||
file. The documents are stacked together in the order they appear in the project tree, with
|
||||
comments, tags, etc. included if they are selected. This is a useful format for exporting the
|
||||
project for later import back into novelWriter.
|
||||
|
||||
Standard/Extended Markdown
|
||||
The Markdown format comes in both Standard and Extended flavour. The *only* difference in terms
|
||||
@@ -161,7 +161,7 @@ Additional Formats
|
||||
|
||||
In addition to the above document formats, the novelWriter HTML and Markup formats can also be
|
||||
wrapped in a JSON file. These files will have a meta data entry and a body entry. For HTML, also
|
||||
the accompanying css styles are included.
|
||||
the accompanying CSS styles used by the preview are included.
|
||||
|
||||
The text body is saved in a two-level list. The outer list contains one entry per document, in the
|
||||
order they appear in the project tree. Each document is then split up into a list as well, with one
|
||||
|
||||
Reference in New Issue
Block a user