Made another pass of editing of the entire documentation

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
+28 -20
View File
@@ -13,8 +13,9 @@ The novelWriter project can be exported in various formats using the build tool
Header Formatting
=================
The titles for the four levels of story structure can be formatted collectively in the export tool.
This is done through a series of keywordreplace steps. They are all on the format ``%keyword%``.
The titles for the five types of titles (the chapter headings come in a numbered and unnumbered
version) of story structure can be formatted collectively in the export tool. This is done through
a series of keywordreplace steps. They are all on the format ``%keyword%``.
``%title%``
This keyword will always be replaced with the title text you put after the ``#`` characters in
@@ -52,6 +53,12 @@ This is done through a series of keywordreplace steps. They are all on the fo
export. However, heading levels 1 through 4 are converted to the correct heading level in the
respective output formats.
**Example**
* The format ``%title%`` just reproduces the title you set in the document file.
* The format ``Chapter %ch%: %title%`` produces something like "Chapter 1: My Chapter Title".
* The format ``Scene %ch%.%sc%`` produces something like "Scene 1.2" for scene 2 in chapter 1.
.. _a_export_scenes:
@@ -73,10 +80,8 @@ 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. That is, files with layout "Book", "Page", "Partition", "Chapet",
"Unnumbered", or "Scene". The switch for :guilabel:`Include note files` will select any file that is
a note. That is, files with layout "Note". This is allows for exporting just the novel, just your
notes, or both, as you see fit.
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.
In addition, you can select to export the synopsis comments, regular comments, keywords, and even
exclude the body text itself.
@@ -87,10 +92,10 @@ exclude the body text itself.
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 build, 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.
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.
.. _a_export_formats:
@@ -101,18 +106,21 @@ Export Formats
Currently, six formats are supported for exporting.
OpenDocument Format
This is 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 the import that HTML document in your
office word processor.
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 the import that HTML document into your office word
processor. They are generally very good at importing HTML files.
PDF Format
The PDF export is just a shortcut for print to file.
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.
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
importing in word processors, or for printing from browser.
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
@@ -121,8 +129,8 @@ novelWriter Markdown
novelWriter.
Standard Markdown
If you have Qt 5.14 or higher, the option to export to plain Markdown is available. This feature
uses Qt's own Markdown export feature.
If you have Qt 5.14 or higher, the option to export to plain markdown is available. This feature
uses Qt's own markdown export feature.
Plain Text
The plain text export format writes a simple ``.txt`` file without any formatting at all.
@@ -138,8 +146,8 @@ wrapped in a JSON file. The files will have a meta data entry and a body entry.
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
the order they appear in the project tree. Each file is then split up into a lst as well, with one
entry per line.
the order they appear in the project tree. Each file is then split up into a list as well, with one
entry per paragraph in the document.
These files are mainly intended for scripted post-processing for those who want that option. A JSON
file can be imported directly into a Python dict object or a PHP array, to mentions a few options.