Skip to content

Commit

Permalink
Merge branch 'release' into i18n
Browse files Browse the repository at this point in the history
  • Loading branch information
vkbo authored Jan 26, 2025
2 parents 8dc4b66 + b2ba932 commit 3d4d9ed
Show file tree
Hide file tree
Showing 22 changed files with 291 additions and 166 deletions.
Binary file modified docs/source/images/fig_build_settings_headings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/images/fig_build_settings_selections.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/images/fig_manuscript_build.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/images/fig_manuscript_build_outline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/images/screenshot_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/images/screenshot_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/source/int_glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Glossary
see :ref:`a_proj_roots`.

Novel Documents
These are documents that are created under a "Novel" :term:`root folder`. They behave
These are documents that are created under a "Novel" :term:`Root Folder`. They behave
differently than :term:`Project Notes`, and have some more restrictions. For instance, they
can not exist in folders intended only for project notes. See the :ref:`a_struct` chapter for
more details.
Expand Down
54 changes: 27 additions & 27 deletions docs/source/int_howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ This is a list of hopefully helpful little tips on how to get the most out of no
Managing the Project
====================

.. dropdown:: Create a Project from a Template
.. 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:: Merge Multiple Documents Into One
.. 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
Expand All @@ -35,28 +35,18 @@ Managing the Project
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:`a_ui_tree_split_merge` for more details.


Layout Tricks
=============

.. dropdown:: Align Paragraphs with Line Breaks
.. dropdown:: How do I share status or importance labels between projects?
:animate: fade-in-slide-down

If you have line breaks in you paragraphs, and also want to apply additional text alignment or
indentation, you must apply the alignment tags to the first line.

For example, this will centre the two lines.

.. code-block:: md
>> Line one is centred. <<
Line two is also centred.
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.

This text is not centred, because it is a new paragraph.

See :ref:`a_fmt_align` for more details.
Layout Tricks
=============

.. dropdown:: Create a Simple Table
.. 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.
Expand All @@ -69,20 +59,30 @@ Layout Tricks
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:: Turn Off First Line Indent for a Paragraph
.. 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 add text alignment. Aligned paragraphs
are not indented. For instance by adding ``<<`` to the end to left-align it,
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:`a_fmt_align` for more details.


Organising Your Text
====================

.. dropdown:: Add Introductory Text to Chapters
.. 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
Expand All @@ -92,7 +92,7 @@ Organising Your Text
such text. Separating chapter and scene files also allows you to make scene files child
documents of the chapter.

.. dropdown:: Distinguishing Soft and Hard Scene Breaks
.. 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
Expand All @@ -101,16 +101,16 @@ Organising Your Text
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 soft scene breaks, which will just insert an
empty paragraph in their place. See :ref:`a_manuscript_settings` for more details.
common "``* * *``" for hard breaks and select to hide soft scene breaks, which will just insert
an empty paragraph in their place. See :ref:`a_manuscript_settings` for more details.

.. versionadded:: 2.4


Other Tools
===========

.. dropdown:: Convert Project to/from yWriter Format
.. 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>`_
Expand Down
27 changes: 14 additions & 13 deletions docs/source/int_introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ your notes about your characters, your world building, and so on.
You can at any point split the individual documents by their headings up into multiple documents,
or merge multiple documents into a single document. This makes it easier to use variations of the
Snowflake_ method for writing. You can start by writing larger structure-focused documents, like
for instance one document per act, and later effortlessly split these up into chapters or scenes.
for instance one document per act, and later effortlessly split these up into individual chapter or
scene documents.


.. _a_intro_features:
Expand All @@ -53,7 +54,7 @@ Below are some key features of novelWriter.
The aim of the user interface is to let you focus on writing instead of spending time formatting
text. Formatting is therefore limited to a small set of formatting tags for simple things like
text emphasis and paragraph alignment. Additional shortcodes are available for special
formatting cases.
formatting cases when you need them.

When you really want to focus on just writing, you can switch the editor into **Focus Mode**
where only the text editor panel itself is visible, and the project structure view is hidden
Expand All @@ -78,19 +79,19 @@ Below are some key features of novelWriter.
Your main story text lives in the "Novel" root folder. You can have multiple such folders in a
project, and rename them to whatever you want. This allows you to keep a series of individual
novels with the same characters and world building in the same project, and create manuscripts
for them individually.
for them separately.

**Keep track of your story elements**
All notes in your project can be assigned a :term:`tag` that you can then :term:`reference` from
any other document or note. In fact, you can add a new tag under each heading of a note if you
need to be able to reference specific sections of it, or you want to keep several topics in the
same note.
All documents in your project can be assigned a :term:`tag` that you can then :term:`reference`
from any other document or note. In fact, you can add a new tag under each heading of a note if
you need to be able to reference specific sections of it, or you want to keep several topics or
scenes in the same document.

**Get an overview of your story**
It is not the documents themselves that define the chapters and scenes of your story, but the
headings that separate them. In the **Outline View** on the main window you can see an outline
of all the chapter and scene headings of each novel root folder in your project. If they have
any references in them, like which character is in what chapter and scene, these are listed in
headings within them. In the **Outline View** on the main window you can see an outline of all
the chapter and scene headings of each novel root folder in your project. If they have any
references in them, like which character is in what chapter and scene, these are listed in
additional columns.

You can also add a synopsis to each chapter or scene, which can be listed here as well. You have
Expand All @@ -107,9 +108,9 @@ Below are some key features of novelWriter.
Whether you want to assemble a manuscript, or export all your notes, or generate an outline of
your chapters and scenes with a synopsis included, you can use the **Build Manuscript** tool to
do so. The tool lets you select what information you want to include in the generated document,
and how it is formatted. You can send the result to a printer or PDF, or generate an Open
Document file that can be opened by most office type word processors. You can also generate the
result as HTML, or Markdown, both suitable for further conversion to other formats.
and how it is formatted. You can send the result to a printer, or generate an Open Document or
Word Document file that can be opened by most office type word processors. You can also generate
the result as HTML, or Markdown, both suitable for further conversion to other formats.


.. _a_intro_screenshots:
Expand Down
6 changes: 3 additions & 3 deletions docs/source/int_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ What to Read First
******************

The documentation of novelWriter is quite extensive. There are a lot of features to get used to,
but you don't need all of them to get started.
but you don't need to know all of them to get started.

The chapters below labelled "Essential Information" are the ones you need to know to use the
application correctly. By "correctly", it is meant: in a way so novelWriter understands the basic
application correctly. By "correctly" it is meant: in a way so novelWriter understands the basic
structure of your text. It collects a lot of information from your text and uses it to display the
structure of it in various ways to help you get an overview of your writing.

Expand All @@ -23,7 +23,7 @@ Using novelWriter
=================

In order to use novelWriter effectively, you need to know the basics of how it works. The following
chapters will explain the main principles. It starts with the basics, and gets more detailed as you
chapters will explain the main principles. They start with the basics, and get more detailed as you
read on.

:ref:`a_breakdown` – Essential Information
Expand Down
16 changes: 3 additions & 13 deletions docs/source/int_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Setup and Installation
**********************

.. _Enchant: https://abiword.github.io/enchant/
.. _Enchant: http://rrthomas.github.io/enchant/
.. _GitHub: https://github.com/vkbo/novelWriter
.. _Downloads page: https://download.novelwriter.io
.. _PPA: https://launchpad.net/~vkbo/+archive/ubuntu/novelwriter
Expand All @@ -15,7 +15,7 @@ Setup and Installation
.. _AppImage: https://appimage.org/

Ready-made packages and installers for novelWriter are available for all major platforms, including
Linux, Windows and MacOS, from the `Downloads page`_. See below for install additional instructions
Linux, Windows and MacOS, from the `Downloads page`_. See below for additional install instructions
for each platform.

You can also install novelWriter from the Python Package Index (PyPi_). See :ref:`a_started_pip`.
Expand All @@ -40,12 +40,6 @@ If you have any issues, try uninstalling the previous version and making a fresh
already had a version installed via a different method, you should uninstall that first as having
multiple installations has been known to cause problems.

.. note::
The novelWriter installer is not signed because Microsoft doesn't currently provide a way for
non-profit open source projects to properly sign their installers. The novelWriter project
doesn't have the funding to pay for commercial software signing certificates. You will therefore
see an additional warning about this when you download and run the installer.


.. _a_started_linux:

Expand Down Expand Up @@ -93,10 +87,6 @@ Then run the update and install commands as for Ubuntu:
sudo apt update
sudo apt install novelwriter
.. note::
You may need to use the Ubuntu 20.04 (focal) packages for Debian 11 or earlier. The newer Ubuntu
packages use a different compression algorithm that may not be supported.

.. tip::
If you get an error message like ``gpg: failed to create temporary file`` when importing the key
from the Ubuntu keyserver, try creating the folder it fails on, and import the key again:
Expand Down Expand Up @@ -142,7 +132,7 @@ done by holding down the option key on your keyboard and clicking on the applica
.. note::
The novelWriter DMG is not signed because Apple doesn't currently provide a way for non-profit
open source projects to properly sign their installers. The novelWriter project doesn't have the
funding to pay for commercial software signing certificates.
funding to pay for a commercial software signing certificate.


.. _a_started_pip:
Expand Down
28 changes: 22 additions & 6 deletions docs/source/project_manuscript.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ from the text in your project. All of this is handled by the **Manuscript Build*
activate it from the sidebar, the **Tools** menu, or by pressing :kbd:`F5`.

.. versionadded:: 2.1

This tool is new for version 2.1. A simpler tool was used for earlier versions. The simpler tool
only allows you to define a single set of options for the build, but otherwise had much the same
functionality.
Expand Down Expand Up @@ -58,6 +59,7 @@ Each build definition can be edited by opening it in the **Manuscript Build Sett
either by double-clicking or by selecting it and pressing the edit button in the toolbar.

.. tip::

You can keep the **Manuscript Build Settings** dialog open while testing the different options,
and just hit the :guilabel:`Apply` button. You can test the result of your settings by pressing
the :guilabel:`Preview` button in the main **Manuscript Build** window. When you're happy with
Expand Down Expand Up @@ -177,21 +179,34 @@ Open Document Format
flat version of the document format as a single XML file. Most rich text editors support the
former, and only a few the latter.

Microsoft Word Document Format
The Microsoft Word Document format writes a single ``.docx`` file. It uses a fairly basic format
that should be compatible with most rich text editors.

Portable Document Format (PDF)
The PDF is generated from a copy of the preview document, and should have the same formatting
capabilities as the preview. It's identical to what is produced if you select the print option
and print to PDF.

novelWriter HTML
The HTML format writes a single ``.htm`` file with minimal style formatting. The HTML document
is suitable for further processing by document conversion tools like Pandoc_, for importing in
word processors, or for printing from browser.

Standard/Extended Markdown
The Markdown format comes in both Standard and Extended flavour. The *only* difference in terms
of novelWriter functionality is the support for strike through text, which is not supported by
the Standard flavour.

novelWriter Markup
This is simply a concatenation of the project documents selected by the filters into a ``.txt``
file. The documents are stacked together in the order they appear in the project tree, with
comments, tags, etc. included if they are selected. This is a useful format for exporting the
project for later import back into novelWriter.

Standard/Extended Markdown
The Markdown format comes in both Standard and Extended flavour. The *only* difference in terms
of novelWriter functionality is the support for strike through text, which is not supported by
the Standard flavour.
.. versionadded:: 2.6

Microsoft Word and PDF output options were added.


Additional Formats
Expand All @@ -211,13 +226,14 @@ file can be imported directly into a Python dict object or a PHP array, to menti

.. _a_manuscript_print:

Print and PDF
=============
Printing
========

The :guilabel:`Print` button allows you to print the content in the preview window. You can either
print to one of your system's printers, or select PDF as your output format from the printer icon
on the print dialog.

.. note::

The paper format should in all cases default to whatever your system default is. If you want to
change it, you have to select it from the **Print Preview** dialog.
Loading

0 comments on commit 3d4d9ed

Please sign in to comment.