Updated the remaining sections of the docs
This commit is contained in:
@@ -23,12 +23,13 @@ a series of keyword–replace steps. They are all on the format ``%keyword%``.
|
||||
|
||||
``%ch%``
|
||||
This is replaced by a chapter number. The number is incremented by one each time the build tool
|
||||
sees a new heading of level two in a file with layout :guilabel:`Chapter`. If the file has layout
|
||||
:guilabel:`Unnumbered`, the counter is *not* incremented. The latter is useful for for instance
|
||||
Prologue and Epilogue chapters.
|
||||
sees a new heading of level two in a document with layout :guilabel:`Chapter`. If the document
|
||||
has layout :guilabel:`Unnumbered`, the counter is *not* incremented. The latter is useful for
|
||||
for instance Prologue and Epilogue chapters.
|
||||
|
||||
``%chw%``
|
||||
This is like ``%ch%``, but the number is expressed as a word like for instance "One", "Two", etc.
|
||||
This is like ``%ch%``, but the number is expressed as a word like for instance "One", "Two",
|
||||
etc.
|
||||
|
||||
``%chi%``
|
||||
This is also like ``%ch%``, but the number is represented as a lower case Roman number.
|
||||
@@ -49,7 +50,7 @@ a series of keyword–replace steps. They are all on the format ``%keyword%``.
|
||||
This inserts a line break within the title.
|
||||
|
||||
.. note::
|
||||
Header formatting only applies to novel files. Headings in note files will will be left as-is on
|
||||
Header formatting only applies to novel documents. Headings in notes will be left as-is on
|
||||
export. However, heading levels 1 through 4 are converted to the correct heading level in the
|
||||
respective output formats.
|
||||
|
||||
@@ -65,8 +66,8 @@ a series of keyword–replace steps. They are all on the format ``%keyword%``.
|
||||
Scene Separators
|
||||
================
|
||||
|
||||
If you don't want any titles for your scenes (and for your sections if you have them), you can leave
|
||||
the boxes empty, and an empty paragraph will be inserted between the scenes or sections instead.
|
||||
If you don't want any titles for your scenes (or for your sections if you have them), you can leave
|
||||
the boxes empty. If so, an empty paragraph will be inserted between the scenes or sections instead.
|
||||
|
||||
Alternatively, if you want a separator between them, like the common ``* * *``, you can also enter
|
||||
that in the box. In fact, if the format is a piece of static text, it will always be treated as a
|
||||
@@ -78,10 +79,11 @@ separator.
|
||||
File Selection
|
||||
==============
|
||||
|
||||
Which files are selected for export can also be controlled from the options on the left side of the
|
||||
dialog window. The switch for :guilabel:`Include novel files` will select any file that isn't
|
||||
classified as a note. The switch for :guilabel:`Include note files` will select any file that *is*
|
||||
a note. This is allows for exporting just the novel, just your notes, or both, as you see fit.
|
||||
Which document files are selected for export can be controlled from the options on the left side of
|
||||
the dialog window. The switch for :guilabel:`Include novel files` will select any document that
|
||||
isn't classified as a note. The switch for :guilabel:`Include note files` will select any document
|
||||
that *is* a note. This is allows for exporting just the novel, just your notes, or both, as you see
|
||||
fit.
|
||||
|
||||
In addition, you can select to export the synopsis comments, regular comments, keywords, and even
|
||||
exclude the body text itself.
|
||||
@@ -91,11 +93,12 @@ exclude the body text itself.
|
||||
keywords and synopsis export and disable body text, thus getting a document with each heading
|
||||
followed by the tags and references and the synopsis.
|
||||
|
||||
If you need to exclude specific files from your exports, like draft files or files you want to take
|
||||
out of your manuscript, but don't want to delete, you can un-check the :guilabel:`Include when
|
||||
building project` option for each file in the project tree. An included file has a checkmark after
|
||||
the status icon in the :guilabel:`Flags` column. The :guilabel:`Build Novel Project` tool has a
|
||||
switch to ignore this flag if you need to collectively override these settings.
|
||||
If you need to exclude specific documents from your exports, like draft documents or documents you
|
||||
want to take out of your manuscript, but don't want to delete, you can un-check the
|
||||
:guilabel:`Include when building project` option for each document in the project tree. An included
|
||||
document has a checkmark after the status icon in the :guilabel:`Flags` column. The
|
||||
:guilabel:`Build Novel Project` tool has a switch to ignore this flag if you need to collectively
|
||||
override these settings.
|
||||
|
||||
|
||||
.. _a_export_formats:
|
||||
@@ -107,26 +110,26 @@ Currently, six formats are supported for exporting.
|
||||
|
||||
OpenDocument Format
|
||||
This produces an open document ``.odt`` file. The document produced has very little formatting,
|
||||
and may require further editing afterwards. For a better formatted office document, you may get a
|
||||
better result with exporting to HTML and then import that HTML document into your office word
|
||||
processor. They are generally very good at importing HTML files.
|
||||
and may require further editing afterwards. For a better formatted office document, you may get
|
||||
a better result with exporting to HTML and then import that HTML document into your office word
|
||||
processor. They are generally very good at importing HTML documents.
|
||||
|
||||
PDF Format
|
||||
The PDF export is just a shortcut for print to file. For a better PDF result, you may instead
|
||||
want to export HTML, and use a word processor to convert the HTML document to PDF.
|
||||
want to export to HTML, and use a word processor to convert the HTML document to PDF.
|
||||
|
||||
novelWriter HTML
|
||||
The HTML export format writes a single ``.htm`` file with minimal style formatting. The exported
|
||||
HTML file is suitable for further processing by document conversion tools like Pandoc, for
|
||||
HTML document is suitable for further processing by document conversion tools like Pandoc, for
|
||||
importing in word processors, or for printing from browser. It is generally the best formatted
|
||||
export option and supports all features of novelWriter since it is entirely geenrated by the
|
||||
application and doesn't depend on Qt library features.
|
||||
|
||||
novelWriter Markdown
|
||||
This is simply a concatenation of the files selected by the filters. The files in the project are
|
||||
stacked together in the order they appear in the tree view, 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. 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 Markdown
|
||||
If you have Qt 5.14 or higher, the option to export to plain markdown is available. This feature
|
||||
@@ -142,7 +145,7 @@ Additional Export Options
|
||||
=========================
|
||||
|
||||
In addition to the above document formats, the novelWriter HTML and Markdown formats can also be
|
||||
wrapped in a JSON file. The files will have a meta data entry and a body entry. For HTML, also the
|
||||
wrapped in a JSON file. These files will have a meta data entry and a body entry. For HTML, also
|
||||
accompanying css styles are exported.
|
||||
|
||||
The text body is saved in a two-level list. The outer list contains one entry per exported file, in
|
||||
|
||||
Reference in New Issue
Block a user