Skip to content

Commit 308a164

Browse files
committed
Update docs project section
1 parent 09c414c commit 308a164

File tree

4 files changed

+168
-119
lines changed

4 files changed

+168
-119
lines changed

docs/source/project_export.rst

Lines changed: 30 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
.. _a_export:
22

3-
******************
4-
Exporting Projects
5-
******************
3+
***********************
4+
Building the Manuscript
5+
***********************
66

7-
The novelWriter project can be exported in various formats using the build tool available from
8-
:guilabel:`Build Novel Project` in the :guilabel:`Tools` menu, or by pressing :kbd:`F5`.
7+
You can at any time build a manuscript, an outline of your notes, or any other type of document
8+
from the text in your project. All of this is handled by the :guilabel:`Build Novel Project` tool.
9+
You can activate it from the sidebar, the :guilabel:`Tools` menu, or by pressing :kbd:`F5`.
910

1011

1112
.. _a_export_headers:
@@ -66,7 +67,7 @@ Scene Separators
6667

6768
If you don't want any titles for your scenes (or for your sections if you have them), you can leave
6869
the formatting boxes empty. If so, an empty paragraph will be inserted between the scenes or
69-
sections instead resulting in a gap in the text.
70+
sections instead, resulting in a gap in the text.
7071

7172
Alternatively, if you want a separator between them, like the common ``* * *``, you can enter the
7273
desired separator text in the formatting box. In fact, if the format is a piece of static text, it
@@ -78,25 +79,19 @@ will always be treated as a separator.
7879
File Selection
7980
==============
8081

81-
Which documents and notes are selected for export can be controlled from the options on the left
82-
side of the dialog window. The switch for :guilabel:`Include novel files` will enable or disable
83-
inclusion of novel documents, and the switch for :guilabel:`Include note files` will do the same
84-
for project notes. This allows for exporting just the novel, just your notes, or both, as you wish.
85-
86-
In addition, you can select to export the synopsis comments, regular comments, keywords, and even
87-
exclude the body text itself.
82+
Which documents and notes are selected for the build can be controlled from the options on the left
83+
side of the dialog window. In addition, you can select to include the synopsis comments, regular
84+
comments, keywords, and even exclude the body text itself if you just want an outline.
8885

8986
.. tip::
9087
If you for instance want to export a document with an outline of the novel, you can enable
9188
keywords and synopsis export and disable body text, thus getting a document with each heading
9289
followed by the tags and references and the synopsis.
9390

9491
If you need to exclude specific documents from your exports, like draft documents or documents you
95-
want to take out of your manuscript, but don't want to delete, you can un-check the
96-
:guilabel:`Include when building project` option for each such document in the project tree. An
97-
included document has a checkmark after in the third column of the project tree. The
98-
:guilabel:`Build Novel Project` tool has a switch to ignore this flag if you need to collectively
99-
override these settings.
92+
want to take out of your manuscript, but don't want to delete, you can set the documents as
93+
"inactive" in the project tree. :guilabel:`Build Novel Project` tool has a switch to collectively
94+
exclude inactive documents.
10095

10196

10297
.. _a_export_print:
@@ -108,23 +103,27 @@ The print button allows you to print the content in the preview window. You can
108103
of your system's printers, or print directly to a file as PDF. You can also print to file from the
109104
regular print dialog. The direct to file option is just a shortcut.
110105

106+
.. note::
107+
The paper format should in all cases default to whatever your system default is. Of you want to
108+
change it, you have to select it from the :guilabel:`Print Preview`` dialog.
109+
111110

112111
.. _a_export_formats:
113112

114113
Export Formats
115114
==============
116115

117-
Currently, six formats are supported for exporting.
116+
Currently, six formats are supported.
118117

119118
Open Document Format
120119
The Build tool can produce either an ``.odt`` file, or an ``.fodt`` file. The latter is just a
121120
flat version of the document format as a single XML file. Most rich text editors support the
122121
former, and a few the latter.
123122

124123
novelWriter HTML
125-
The HTML export format writes a single ``.htm`` file with minimal style formatting. The exported
126-
HTML document is suitable for further processing by document conversion tools like Pandoc, for
127-
importing in word processors, or for printing from browser.
124+
The HTML format writes a single ``.htm`` file with minimal style formatting. The HTML document
125+
is suitable for further processing by document conversion tools like Pandoc, for importing in
126+
word processors, or for printing from browser.
128127

129128
novelWriter Markdown
130129
This is simply a concatenation of the project documents selected by the filters. The documents
@@ -133,23 +132,23 @@ novelWriter Markdown
133132
import back into novelWriter.
134133

135134
Standard/GitHub Markdown
136-
The Markdown export format comes in both Standard and GitHub flavour. The *only* difference in
137-
terms of novelWriter functionality is the support for strikethrough text, which is not supported
138-
by the Standard flavour, but *is* supported by the GitHub flavour.
135+
The Markdown format comes in both Standard and GitHub flavour. The *only* difference in terms of
136+
novelWriter functionality is the support for strikethrough text, which is not supported by the
137+
Standard flavour, but *is* supported by the GitHub flavour.
139138

140139

141140
.. _a_export_options:
142141

143-
Additional Export Options
144-
=========================
142+
Additional Formats
143+
==================
145144

146145
In addition to the above document formats, the novelWriter HTML and Markdown formats can also be
147146
wrapped in a JSON file. These files will have a meta data entry and a body entry. For HTML, also
148-
the accompanying css styles are exported.
147+
the accompanying css styles are included.
149148

150-
The text body is saved in a two-level list. The outer list contains one entry per exported
151-
document, in the order they appear in the project tree. Each document is then split up into a list
152-
as well, with one entry per paragraph it contains.
149+
The text body is saved in a two-level list. The outer list contains one entry per document, in the
150+
order they appear in the project tree. Each document is then split up into a list as well, with one
151+
entry per paragraph it contains.
153152

154153
These files are mainly intended for scripted post-processing for those who want that option. A JSON
155154
file can be imported directly into a Python dict object or a PHP array, to mentions a few options.

docs/source/project_notes.rst

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ Tags in Notes
2525

2626
Each new heading in a note can have a tag associated with it. The format of a tag is
2727
``@tag: tagname``, where tagname is a unique identifier. Tags can then be referenced in the novel
28-
documents, or cross-referenced in other notes, and will show up in the outline view and in the
29-
back-reference panel when a document is being viewed. See :ref:`a_struct_tags` for how to reference
30-
notes.
28+
documents, or cross-referenced in other notes, and will show up in the Outline View and in the
29+
back-reference panel when a document is opened in the viewer. See :ref:`a_struct_tags` for how to
30+
reference notes.
3131

3232
The syntax highlighter will alert the user that the keyword is correctly used and that the tag is
3333
allowed, that is, the tag is unique. Duplicate tags should be detected as long as the index is up
@@ -36,15 +36,37 @@ colour that valid tags do.
3636

3737
The tag is the only part of these notes that the application uses. The rest of the document content
3838
is there for the writer to use in whatever way they wish. Of course, the content of the documents
39-
can be exported if you want to compile a single document of all your notes, or include them in an
40-
outline.
39+
can be added to the manuscript, or an outline document. If you want to compile a single document of
40+
all your notes, you can do this from the :guilabel:`Build Novel Project` tool.
4141

4242
A note can also reference other notes in the same way novel documents do. When the note is opened
4343
in the view panel, the references become clickable links, making it easier to follow connections in
44-
the plot. Notes don't show up in the outline view though, so referencing between notes is only
45-
meaningful if you want to be able to click-navigate between them.
44+
the plot. Notes don't show up in the Outline View though, so referencing between notes is only
45+
meaningful if you want to be able to click-navigate between them, or of course if you just want to
46+
highlight that two notes are related.
4647

4748
.. tip::
4849
If you cross-reference between notes and export your project as an HTML document using the
4950
:guilabel:`Build Novel Project` tool, the cross-references become clickable links in the
5051
exported HTML document.
52+
53+
Example of a project note with two headers, with separate tags, and with references to other notes:
54+
55+
.. code-block:: none
56+
:linenos:
57+
58+
# Main Characters
59+
60+
## Jane Doe
61+
62+
@tag: Jane
63+
@location: Earth
64+
65+
Something about Jane ...
66+
67+
## John Doh
68+
69+
@tag: John
70+
@location: Mars
71+
72+
Something about John ...

0 commit comments

Comments
 (0)