Updated documentation for export and the user interface

This commit is contained in:
Veronica K. B. Olsen
2019-10-27 15:44:40 +01:00
parent aba339f8e3
commit 43ebcec4e9
7 changed files with 122 additions and 74 deletions
+24 -3
View File
@@ -32,13 +32,34 @@ Plain Text
==========
The plain text export format writes a simple ``.txt`` file without any formatting at all.
It does, however, respect the centering of text if the
Word-wrapping to a fixed column width is supported.
It does, however, respect the centering of text if the :guilabel:`Fixed width` setting is larger than ``0``.
Markdown
========
The markdown export formats writes a file using the valid markdown formats used by novelWriter, and converts comments to preformatted blocks by indenting it with four spaces.
Word-wrapping to a fixed column width is supported.
HTML5 Document
==============
The html5 export format writes a single ``.htm`` file with a minimal style settings block.
The style setting block sets a maximum page width of ``768px``.
Comments are exported as indented text boxes with a light yellow background.
LaTeX Document
==============
The latex export formats generats a simple ``.tex`` file using a ``report`` document format.
All chapters and sections are exported as unnumbered, and the internal header numbering formatting of novelWriter is used instead.
Word-wrapping to a fixed column width in the LaTeX source is supported.
*****************
Header Formatting
*****************
The chapter, scene and section headers for novel files can receive some special treatment using the formats under "Chapter Headings" and "Other Headings".
The chapter, scene and section headers for novel files can receive some special treatment using the formats under :guilabel:`Chapter Headings` and :guilabel:`Other Headings`.
The chapters can either be of numbered or unnumbered type, the latter being suitable for prologues, epilogues, interludes, etc.
The headers can be generated using free text in combination with replace tags.
The tooltip will explain which tags are available for each heading type.
@@ -53,7 +74,7 @@ Numbered Chapters
Numbered chapters can be automatically assigned a number from 1 and upwards.
The number is inserted in place of the ``%num%`` tag.
Alternatively, the number can be translated to a word by using the ``%numword%`` tag.
The word numbers are currently only supported in English, and work for the range from "One" to "Nine Hundred and Ninety-Nine".
The word numbers feature is currently only supported in English, and works for the range from "One" to "Nine Hundred and Ninety-Nine".
Unnumbered Chapters
===================