Skip to content

Commit 200a77b

Browse files
committed
Update docs
1 parent 6223bf2 commit 200a77b

File tree

3 files changed

+70
-32
lines changed

3 files changed

+70
-32
lines changed

docs/source/usage/howto.rst

Lines changed: 43 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ This is a list of hopefully helpful little tips on how to get the most out of no
1313
contribute, or start a discussion on the project's `Discussions Page`_.
1414

1515

16-
Managing the Project
17-
====================
16+
Your Project
17+
============
1818

1919
.. dropdown:: How do I create a project from a template?
2020
:animate: fade-in-slide-down
@@ -42,9 +42,48 @@ Managing the Project
4242
Settings** from the respective configuration tabs. You can then import these labels in another
4343
project.
4444

45+
.. dropdown:: How do I add introductory text to chapters?
46+
:animate: fade-in-slide-down
47+
48+
Sometimes chapters have a short preface, like a brief piece of text or a quote to set the stage
49+
before the first scene begins.
50+
51+
If you add separate files for chapters and scenes, the chapter file is the perfect place to add
52+
such text. Separating chapter and scene files also allows you to make scene files child
53+
documents of the chapter.
54+
55+
.. dropdown:: How do I distinguishing between soft and hard scene breaks?
56+
:animate: fade-in-slide-down
57+
58+
Depending on your writing style, you may need to separate between soft and hard scene breaks
59+
within chapters. Like for instance if you switch point-of-view character often.
60+
61+
In such cases you may want to use different scene headings for hard and soft scene breaks. The
62+
**Build Manuscript** tool will let you define a different format for scenes using the ``###``
63+
and ``###!`` heading codes when you generate your manuscript. You can for instance add the
64+
common "``* * *``" for hard breaks and select to hide soft scene breaks, which will just insert
65+
an empty paragraph in their place. See :ref:`docs_ui_manuscript_settings` for more details.
66+
67+
.. versionadded:: 2.4
68+
69+
.. dropdown:: How can I set the language for my manuscript?
70+
:animate: fade-in-slide-down
71+
72+
The language set for manuscript documents like Open Document and Word Document is taken from
73+
your project language setting in **Project Settings**. Only some languages are available here,
74+
but you can override the language information by setting the "Override Document Language" value
75+
in your Manuscript Build settings to a valid language code. The code uses the
76+
`IETF BCP 47 language tag <https://en.wikipedia.org/wiki/IETF_language_tag>`__ format.
77+
78+
Examples: ``en`` for English, ``de`` for German, etc.
79+
80+
If you want to help add new languages to novelWriter, see: :ref:`docs_contributing`.
4581

46-
Application Usage
47-
=================
82+
.. versionadded:: 2.8
83+
84+
85+
The Application
86+
===============
4887

4988
.. dropdown:: How can I increase the line height?
5089
:animate: fade-in-slide-down
@@ -91,34 +130,6 @@ Layout Tricks
91130
See :ref:`docs_usage_align_indent` for more details.
92131

93132

94-
Organising Your Text
95-
====================
96-
97-
.. dropdown:: How do I add introductory text to chapters?
98-
:animate: fade-in-slide-down
99-
100-
Sometimes chapters have a short preface, like a brief piece of text or a quote to set the stage
101-
before the first scene begins.
102-
103-
If you add separate files for chapters and scenes, the chapter file is the perfect place to add
104-
such text. Separating chapter and scene files also allows you to make scene files child
105-
documents of the chapter.
106-
107-
.. dropdown:: How do I distinguishing between soft and hard scene breaks?
108-
:animate: fade-in-slide-down
109-
110-
Depending on your writing style, you may need to separate between soft and hard scene breaks
111-
within chapters. Like for instance if you switch point-of-view character often.
112-
113-
In such cases you may want to use different scene headings for hard and soft scene breaks. The
114-
**Build Manuscript** tool will let you define a different format for scenes using the ``###``
115-
and ``###!`` heading codes when you generate your manuscript. You can for instance add the
116-
common "``* * *``" for hard breaks and select to hide soft scene breaks, which will just insert
117-
an empty paragraph in their place. See :ref:`docs_ui_manuscript_settings` for more details.
118-
119-
.. versionadded:: 2.4
120-
121-
122133
Other Tools
123134
===========
124135

docs/source/usage/introduction.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Introduction
55
************
66

77
.. _Markdown: https://en.wikipedia.org/wiki/Markdown
8+
.. _Contributing Guide: https://github.com/vkbo/novelWriter/blob/main/CONTRIBUTING.md
9+
.. _Crowding: https://crowdin.com/project/novelwriter
810

911
In a nutshell, novelWriter is a plain text editor that lets you organise one or more novels, and
1012
associated notes, as many smaller documents. You can at any time generate standard document formats
@@ -55,3 +57,22 @@ comments, and an auto-complete menu can help you here too. More about this later
5557
mainly intended for character profiles and plot outlines. It is recommended to use a proper
5658
note-taking tool for research. This is anyway more practical as you may use the same research
5759
for multiple projects.
60+
61+
62+
.. _docs_contributing:
63+
64+
Contributing
65+
============
66+
67+
This project relies on contributions to add new features. In particular, adding translations into
68+
other languages, or updating translations for existing languages, is particularly useful.
69+
70+
For code contributions, please read the official `Contributing Guide`_.
71+
72+
For translations, please use the project page on Crowdin_. For each language, there are two
73+
translation sets. One for the application itself, labelled "Main GUI". This is a fairly large
74+
dataset to translate. A smaller set called "Project Exports" is also available. The latter is what
75+
makes a language available in **Project Settings** in the application. It is a fairly small set to
76+
translate, and you can choose to translate only this set if you wish. If the language you wish to
77+
contribute to is not available in the list, you can message the maintainer on the Crowdin page to
78+
add new languages to the project.

docs/source/user_interface/manuscript.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,12 @@ Any text you add that isn't highlighted in colours will remain in your formatted
136136
You can preview the result of these format strings by clicking :guilabel:`Apply`, and then clicking
137137
:guilabel:`Preview` in the **Manuscript Build** tool main window.
138138

139+
.. note::
140+
141+
The language used for generating chapter numbers is defined by the project language set in
142+
**Project Settings**. This feature relies on translation files existing for each language.
143+
If you want to help add new languages to novelWriter, see: :ref:`docs_contributing`.
144+
139145

140146
.. _docs_ui_manuscript_head_numbers:
141147

0 commit comments

Comments
 (0)