Added documentation for export, and renamed all files to .txt as per recommendation
This commit is contained in:
+2
-2
@@ -48,7 +48,7 @@ templates_path = ["_templates"]
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = [".rst", ".md"]
|
||||
source_suffix = ".rst"
|
||||
source_suffix = ".txt"
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = "index"
|
||||
@@ -150,7 +150,7 @@ man_pages = [
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, "novelWriter", "novelWriter Documentation",
|
||||
author, "novelWriter", "One line description of project.",
|
||||
author, "novelWriter", "Markdown-like editor for novels.",
|
||||
"Miscellaneous"),
|
||||
]
|
||||
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
##################
|
||||
Exporting Projects
|
||||
##################
|
||||
|
||||
The novelWriter project can be exported in various formats using the export tool available from :menuselection:`Project --> Export Project` or by pressing :kbd:`F5`.
|
||||
|
||||
**************
|
||||
File Selection
|
||||
**************
|
||||
|
||||
Which files are selected for export can be controlled from the "Selection" section.
|
||||
The check box for "Novel files" will select any file that isn't classified as a note.
|
||||
This is useful when exporting a document containing the novel itself.
|
||||
|
||||
It is also possible to select the "Note files" for export, with or without the "Novel files".
|
||||
Comments can also optionally be included in the export for those formats that supports this.
|
||||
|
||||
**************
|
||||
Export Formats
|
||||
**************
|
||||
|
||||
Currently, five formats are supported for exporting.
|
||||
|
||||
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.
|
||||
This is a useful format for exporting the project for later import back into novelWriter.
|
||||
|
||||
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
|
||||
|
||||
*****************
|
||||
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 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.
|
||||
|
||||
.. note::
|
||||
Header formatting only applies to novel files.
|
||||
Headings in note files will will be left as-is, but heading levels 1 through 4 are converted to the correct heading level in the respective output formats.
|
||||
|
||||
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".
|
||||
|
||||
Unnumbered Chapters
|
||||
===================
|
||||
|
||||
Unnumbered chapters only support the ``%title%`` tag for auto-replacement.
|
||||
|
||||
Scenes and Sections
|
||||
===================
|
||||
|
||||
Both scenes and sections support the ``%title%`` tag.
|
||||
In addition, scenes behave differently than the other headings when the format does not contain any auto-replace tags.
|
||||
If the text in the box is any static text, the heading formatter will treat it as a scene separator, and insert that text as centred text between scenes, and ignoring the first scene of a chapter if the chapter heading is not followed by any text.
|
||||
|
||||
Leaving these fields blank will disable any output of scene and section headers or separators to the exported file.
|
||||
@@ -1,10 +1,12 @@
|
||||
####################################
|
||||
Welcome to novelWriter Documentation
|
||||
====================================
|
||||
####################################
|
||||
|
||||
This is the documentation for novelWriter |version|.
|
||||
|
||||
********
|
||||
Contents
|
||||
^^^^^^^^
|
||||
********
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
@@ -14,10 +16,12 @@ Contents
|
||||
projects
|
||||
structure
|
||||
notes
|
||||
export
|
||||
technical
|
||||
|
||||
******************
|
||||
Indices and Tables
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
******************
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
@@ -1,6 +1,6 @@
|
||||
|
||||
##############
|
||||
User Interface
|
||||
==============
|
||||
##############
|
||||
|
||||
The user interface is kept as simple as possible to avoid distractions.
|
||||
The main window contains a tree vew pane with the entire structure of the project, and a small details panel below it to display additional information.
|
||||
@@ -11,8 +11,9 @@ This will open the source editor which uses a simplified markdown format describ
|
||||
The document can also be viewed as html with all the comments and commands stripped out. To view a document, simply press Ctrl+R or select a file and go to :menuselection:`Document --> View Document` in the menu.
|
||||
The document viewed does not need to be the same document currently being edited.
|
||||
|
||||
***************
|
||||
Markdown Format
|
||||
^^^^^^^^^^^^^^^
|
||||
***************
|
||||
|
||||
the document editor uses a simplified markdown format.
|
||||
That is, it supports basic formatting like bold, italics and underline, as well as four levels of headings.
|
||||
@@ -31,8 +32,9 @@ The editor also has a minimal set of commands used for setting tags and referenc
|
||||
* ``% text...``: A comment. The text is not exported, seen in viewer, or counted towards word counts.
|
||||
* ``@keyword: value``: A keyword argument followed by a value, or a comma separated list of values.
|
||||
|
||||
******************
|
||||
Keyboard Shortcuts
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
******************
|
||||
|
||||
All features are available as keyboard shortcuts.
|
||||
These are as following:
|
||||
Reference in New Issue
Block a user