Update usage documentation and incorporate last usage file from old doc
This commit is contained in:
@@ -25,7 +25,7 @@ paragraph.
|
||||
|
||||
It is important that you actually follow this rule. You should not, for instance, mimic indented
|
||||
paragraphs manually in the editor. This, and a lot of other formatting options that can be
|
||||
applied to text paragraphs in the :ref:`Manuscript Tool <docs_manuscript>` depends on paragraphs
|
||||
applied to text paragraphs in the :ref:`Manuscript Tool <docs_ui_manuscript>` depends on paragraphs
|
||||
being separated by blank lines.
|
||||
|
||||
:bdg-success:`Correct`
|
||||
|
||||
@@ -30,7 +30,10 @@ Heading Levels
|
||||
|
||||
An illustration of how heading levels correspond to the novel structure.
|
||||
|
||||
Four levels of headings are understood for novel documents:
|
||||
Four levels of headings are understood for novel documents. You can pick and choose from these as
|
||||
you want, but if your story has chapters, you should use these headings to indicate them. If you
|
||||
also add scene headings, you have better control of how your scene separators are formatted in your
|
||||
manuscript.
|
||||
|
||||
``# Title Text``
|
||||
This is a heading level one. This heading indicates the start of a new partition. Partitions are
|
||||
@@ -40,7 +43,7 @@ Four levels of headings are understood for novel documents:
|
||||
``## Chapter Title``
|
||||
This is a heading level two. This heading indicates the start of a new chapter. Chapter numbers
|
||||
can be inserted automatically when building the manuscript, so you don't have to do this in the
|
||||
title. See :ref:`docs_manuscript_numbers` for more details.
|
||||
title. See :ref:`docs_ui_manuscript_head_numbers` for more details.
|
||||
|
||||
``### Scene Title``
|
||||
This is a heading level three. This heading indicates the start of a new scene. Scene numbers or
|
||||
@@ -72,13 +75,19 @@ may want to keep the use cases in mind while writing.
|
||||
``###! Scene Title``
|
||||
This is an alternative scene heading that can be formatted differently in the **Manuscript
|
||||
Build** tool. It is intended for separating "soft" and "hard" scene breaks. Aside from this, it
|
||||
behaves identically to a regular scene heading. See :ref:`docs_features_scene_breaks` for more
|
||||
details.
|
||||
behaves identically to a regular scene heading. See :ref:`docs_ui_manuscript_head_hard_soft`
|
||||
for more details.
|
||||
|
||||
The formatting of these headings can be customised quite extensively in the
|
||||
:ref:`Manuscript Tool <docs_manuscript>`, which is covered in a separate part of the documentation.
|
||||
:ref:`Manuscript Tool <docs_ui_manuscript>`, which is covered in a separate part of the
|
||||
documentation.
|
||||
|
||||
.. note::
|
||||
|
||||
The space after the ``#`` or ``!`` character is mandatory. The syntax highlighter will change
|
||||
colour and font size when the heading is correctly formatted.
|
||||
|
||||
Page breaks can be automatically added before titles, partition, chapter and scene headings from
|
||||
the **Manuscript Build** tool when you build your project to a format that supports page breaks.
|
||||
If you want page breaks in other places, you have to specify them manually.
|
||||
See :ref:`docs_usage_formatting_breaks` for more details.
|
||||
|
||||
@@ -158,6 +158,6 @@ on your keyboard with your cursor somewhere in the paragraph.
|
||||
|
||||
### Scene
|
||||
|
||||
%~ This text is completely ignored.
|
||||
%~ This text is ignored.
|
||||
|
||||
This text is a regular paragraph.
|
||||
|
||||
@@ -0,0 +1,77 @@
|
||||
.. _docs_usage_front_back_matter:
|
||||
|
||||
*********************
|
||||
Front and Back Matter
|
||||
*********************
|
||||
|
||||
Front and back matter documents are documents that go before and after your main story text. They
|
||||
can include pages like your cover page, content tables, prologues, epilogues, etc. These special
|
||||
pages and sections are supported to some extent by novelWriter.
|
||||
|
||||
|
||||
.. _docs_usage_front_back_matter_title:
|
||||
|
||||
The Title Page
|
||||
==============
|
||||
|
||||
It is recommended that you add a document at the very top of each **Novel** root folder with the
|
||||
novel title in it. You should modify the level 1 heading format code with an ``!`` in order to
|
||||
render it as a document title that is excluded from any automatic Table of Content in a manuscript
|
||||
build document.
|
||||
|
||||
You can also add the author name and address above this if this is required by the manuscript
|
||||
format you use, and additional space added before the title.
|
||||
|
||||
:bdg-info:`Example`
|
||||
|
||||
This is the title page novelWriter generates automatically for a new project as of version 2.6:
|
||||
|
||||
.. code-block:: md
|
||||
|
||||
Jane Doe[br]
|
||||
Address Line 1[br]
|
||||
Address Line 2 <<
|
||||
|
||||
[vspace:5]
|
||||
|
||||
#! My Novel
|
||||
|
||||
>> **By Jane Doe** <<
|
||||
|
||||
>> Word Count: [field:textWords] <<
|
||||
|
||||
The title is by default centred on the page. You can add more text to the page as you wish, like
|
||||
for instance the author's name and details.
|
||||
|
||||
|
||||
.. _docs_usage_front_back_matter_pages:
|
||||
|
||||
Additional Pages
|
||||
================
|
||||
|
||||
If you want an additional page of text after the title page, starting on a fresh page, you can add
|
||||
``[new page]`` on a line by itself, and continue the text after it. This will insert a page break
|
||||
before the text. See :ref:`docs_usage_formatting_breaks` for more details.
|
||||
|
||||
|
||||
.. _docs_usage_front_back_matter_unnumbered:
|
||||
|
||||
Unnumbered Chapters
|
||||
===================
|
||||
|
||||
If you use the automatic numbering feature for your chapters, but you want to keep some special
|
||||
chapters separate from this, you can add an ``!`` to the level 2 heading formatting code to tell
|
||||
the build tool to skip these chapters when adding numbers.
|
||||
|
||||
Unnumbered chapters are useful for prologue and epilogue chapters, and also for interlude chapters
|
||||
if you use those in your text. There is a separate formatting feature for such chapter titles in
|
||||
the **Manuscript Build** tool. See the :ref:`docs_ui_manuscript` page for more details.
|
||||
|
||||
|
||||
:bdg-info:`Example`
|
||||
|
||||
.. code-block:: md
|
||||
|
||||
##! Unnumbered Chapter Title
|
||||
|
||||
Chapter Text
|
||||
@@ -0,0 +1,119 @@
|
||||
.. _docs_usage_howto:
|
||||
|
||||
*************
|
||||
Tips & Tricks
|
||||
*************
|
||||
|
||||
.. _Discussions Page: https://github.com/vkbo/novelWriter/discussions
|
||||
|
||||
This is a list of hopefully helpful little tips on how to get the most out of novelWriter.
|
||||
|
||||
.. note::
|
||||
This section will be expanded over time. If you would like to have something added, feel free to
|
||||
contribute, or start a discussion on the project's `Discussions Page`_.
|
||||
|
||||
|
||||
Managing the Project
|
||||
====================
|
||||
|
||||
.. dropdown:: How do I create a project from a template?
|
||||
:animate: fade-in-slide-down
|
||||
|
||||
On the Welcome dialog's **Create New Project** form, you can select to "Prefill Project" from
|
||||
the content of a different project. This feature is most useful if you copy a project you have
|
||||
dedicated to be a template project. If you have a structure and settings you want to use for
|
||||
every new project, this is the best solution.
|
||||
|
||||
.. dropdown:: How do I merge multiple documents into one?
|
||||
:animate: fade-in-slide-down
|
||||
|
||||
If you need to merge a selection of documents in your project into a single document, you can
|
||||
achieve this by first making a new folder for just that purpose, and drag all the documents you
|
||||
want merged into this folder. Then you can right click the folder, select :guilabel:`Transform`
|
||||
and :guilabel:`Merge Documents in Folder`.
|
||||
|
||||
In the dialog that pops up, the documents will be in the same order as in the folder, but you
|
||||
can rearrange them here of you wish. See :ref:`docs_ui_split_merge` for more details.
|
||||
|
||||
.. dropdown:: How do I share status or importance labels between projects?
|
||||
:animate: fade-in-slide-down
|
||||
|
||||
The status or importance labels you have defined in a project can be exported from **Project
|
||||
Settings** from the respective configuration tabs. You can then import these labels in another
|
||||
project.
|
||||
|
||||
|
||||
Layout Tricks
|
||||
=============
|
||||
|
||||
.. dropdown:: How do I create a table?
|
||||
:animate: fade-in-slide-down
|
||||
|
||||
The formatting tools available in novelWriter don't allow for complex structures like tables.
|
||||
However, the editor does render tabs in a similar way that regular word processors do. You can
|
||||
set the width of a tab in **Preferences**.
|
||||
|
||||
The tab key should have the same distance in the editor as in the viewer, so you can align text
|
||||
in columns using the tab key, and it should look the same when viewed next to the editor.
|
||||
|
||||
This is most suitable for your notes, as the result in exported documents cannot be guaranteed
|
||||
to match. Especially if you don't use the same font in your manuscript as in the editor.
|
||||
|
||||
.. dropdown:: How do I force a line break when line breaks are ignored in my manuscript?
|
||||
:animate: fade-in-slide-down
|
||||
|
||||
In the **Manuscript Build Settings** you can choose to ignore line breaks within paragraphs in
|
||||
your text. However, some times you still need those breaks. Like for instance on the cover page
|
||||
where you may need to add your name and address. In such cases, you can add ``[br]`` where you
|
||||
want line breaks. These breaks cannot be ignored by any settings and will always be respected.
|
||||
|
||||
.. versionadded:: 2.6
|
||||
|
||||
.. dropdown:: How do I turn off first line indent for a specific paragraph?
|
||||
:animate: fade-in-slide-down
|
||||
|
||||
If you have first line indent enabled, but have a specific paragraph that you don't want
|
||||
indented, you can disable the indentation by explicitly adding text alignment. For instance by
|
||||
adding ``<<`` to the end to left-align it. Aligned paragraphs are not indented.
|
||||
|
||||
See :ref:`docs_usage_align_indent` for more details.
|
||||
|
||||
|
||||
Organising Your Text
|
||||
====================
|
||||
|
||||
.. dropdown:: How do I add introductory text to chapters?
|
||||
:animate: fade-in-slide-down
|
||||
|
||||
Sometimes chapters have a short preface, like a brief piece of text or a quote to set the stage
|
||||
before the first scene begins.
|
||||
|
||||
If you add separate files for chapters and scenes, the chapter file is the perfect place to add
|
||||
such text. Separating chapter and scene files also allows you to make scene files child
|
||||
documents of the chapter.
|
||||
|
||||
.. dropdown:: How do I distinguishing between soft and hard scene breaks?
|
||||
:animate: fade-in-slide-down
|
||||
|
||||
Depending on your writing style, you may need to separate between soft and hard scene breaks
|
||||
within chapters. Like for instance if you switch point-of-view character often.
|
||||
|
||||
In such cases you may want to use different scene headings for hard and soft scene breaks. The
|
||||
**Build Manuscript** tool will let you define a different format for scenes using the ``###``
|
||||
and ``###!`` heading codes when you generate your manuscript. You can for instance add the
|
||||
common "``* * *``" for hard breaks and select to hide soft scene breaks, which will just insert
|
||||
an empty paragraph in their place. See :ref:`docs_ui_manuscript_settings` for more details.
|
||||
|
||||
.. versionadded:: 2.4
|
||||
|
||||
|
||||
Other Tools
|
||||
===========
|
||||
|
||||
.. dropdown:: How do I convert my project to/from the yWriter format?
|
||||
:animate: fade-in-slide-down
|
||||
|
||||
There is a tool available that lets you convert a `yWriter <http://spacejock.com/yWriter7.html>`_
|
||||
project to a novelWriter project, and vice versa.
|
||||
|
||||
The tool is available at `peter88213.github.io/yw2nw <https://peter88213.github.io/yw2nw/>`__
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 26 KiB |
@@ -85,6 +85,10 @@ Root Folder Types
|
||||
The custom root folder type can be used for tracking anything else not covered by the above
|
||||
options.
|
||||
|
||||
**Templates**
|
||||
Any document added under this root folder will be made available as template options when
|
||||
creating new documents. See :ref:`docs_usage_project_documents_templates` for more details.
|
||||
|
||||
**Archive**
|
||||
If you don't want to delete a document, or put it in the **Trash** folder where it may be
|
||||
deleted, but still want it out of your main project, you can put it in this folder. The contents
|
||||
@@ -120,21 +124,41 @@ documents.
|
||||
|
||||
.. _docs_usage_project_documents:
|
||||
|
||||
Project Documents
|
||||
=================
|
||||
Documents
|
||||
=========
|
||||
|
||||
New documents can be created from the toolbar in the project tree, or by pressing :kbd:`Ctrl+N`.
|
||||
This will open the create new item menu and let you choose between a number of pre-defined
|
||||
documents and folders. You will be prompted for a label for the new item.
|
||||
You can add documents anywhere you want in your project structure. You can even add documents as
|
||||
child items of other documents, just like if they were folders. This makes it easy to associate a
|
||||
set of scenes with their chapter. You can also do this in your notes, where you for instance may
|
||||
have a hierarchy of your locations.
|
||||
|
||||
You can always rename an item by selecting **Rename Item** from the **Project** menu, or by
|
||||
pressing :kbd:`F2` when a document or folder is selected.
|
||||
The name on a document in the project tree is not linked to any headings in the document text.
|
||||
Think of the document name as a file name. You can rename a document, or any other item in the
|
||||
project, at any time.
|
||||
|
||||
Other settings for project documents and folders are available from the context menu that you can
|
||||
activate by right-clicking on an it in the tree. The **Transform** submenu includes options for
|
||||
converting, splitting, or merging documents. See :ref:`docs_ui_split_merge` for more details on
|
||||
the latter two.
|
||||
|
||||
Documents come in two types:
|
||||
|
||||
**Novel Documents**
|
||||
These are the documents that make up your story or novel. They can only be added under a root
|
||||
folder of type **Novel**. You can technically also add them under **Archive**. See
|
||||
:ref:`docs_usage_headers` for more details about how these documents are handled by novelWriter.
|
||||
|
||||
**Project Notes**
|
||||
These are the documents where you keep your notes. You can add them anywhere in your project,
|
||||
including under **Novel** type folders. If you do add them there, they are not treated as a part
|
||||
of the story by default.
|
||||
|
||||
You can convert between the two types of documents where the types are allowed. You can also
|
||||
convert folders into documents, which may sometimes be convenient.
|
||||
|
||||
Another convenient feature is that documents can be split into sub-documents by its containing
|
||||
headings, or multiple documents merged into one. This is particularly convenient if you start out
|
||||
with larger structural documents, like one containing all chapters and scenes in an act, and then
|
||||
split those. See :ref:`docs_ui_split_merge` for more details.
|
||||
|
||||
|
||||
.. _docs_usage_project_documents_templates:
|
||||
|
||||
Document Templates
|
||||
------------------
|
||||
|
||||
Reference in New Issue
Block a user