Update docs
This commit is contained in:
@@ -54,7 +54,6 @@ of writing novels. The formatting is currently limited to:
|
|||||||
* Headings levels 1 to 4 using the `#` syntax only.
|
* Headings levels 1 to 4 using the `#` syntax only.
|
||||||
* Emphasised and strongly emphasised text. These are rendered as italicised and bold text.
|
* Emphasised and strongly emphasised text. These are rendered as italicised and bold text.
|
||||||
* Strikethrough text.
|
* Strikethrough text.
|
||||||
* Hard line breaks using two or more spaces at the end of a line.
|
|
||||||
|
|
||||||
That is it. Features not supported in the editor are also not exported when using the export tool.
|
That is it. Features not supported in the editor are also not exported when using the export tool.
|
||||||
|
|
||||||
|
|||||||
@@ -38,8 +38,7 @@ at the same time provide a complete set of features needed for writing a novel.
|
|||||||
|
|
||||||
.. tip::
|
.. tip::
|
||||||
If you do need to align information in rows and columns in your notes, you can achieve this with
|
If you do need to align information in rows and columns in your notes, you can achieve this with
|
||||||
tabs and hard line breaks. The tab stop width can be specified in :guilabel:`Preferences` and
|
tabs and line breaks. The tab stop width can be specified in :guilabel:`Preferences`.
|
||||||
hard line breaks can be inserted by adding to spaces at the end of the line.
|
|
||||||
|
|
||||||
The main window does not have a toolbar like many other applications do. This reduces clutter, and
|
The main window does not have a toolbar like many other applications do. This reduces clutter, and
|
||||||
since the documents are formatted with markdown tags, is more or less redundant. However, all
|
since the documents are formatted with markdown tags, is more or less redundant. However, all
|
||||||
|
|||||||
@@ -205,15 +205,16 @@ tricky for languages that use the same symbol for these.
|
|||||||
|
|
||||||
.. _a_ui_md:
|
.. _a_ui_md:
|
||||||
|
|
||||||
Markdown Format
|
The Markdown-Like Format
|
||||||
===============
|
========================
|
||||||
|
|
||||||
The document editor uses a simplified markdown format. That is, it supports basic formatting like
|
The editor itself is a plaintext editor that uses formatting codes for setting meta data values and
|
||||||
emphasis (italic), strong importance (bold) and strikethrough text, as well as four levels of
|
allowing for some text formatting. The syntax is based on Markdown, but novelWriter is *not* a
|
||||||
headings.
|
Markdown editor. It supports basic formatting like emphasis (italic), strong importance (bold)
|
||||||
|
and strikethrough text, as well as four levels of headings.
|
||||||
|
|
||||||
Some non-standard markdown features have been added. For instance, novelWriter allows for comments,
|
In addition to formatting codes, novelWriter allows for comments, a synopsis tag, and a set of
|
||||||
a synopsis tag, and a set of keyword and value sets used for tags and references.
|
keyword and value sets used for tags and references.
|
||||||
|
|
||||||
|
|
||||||
.. _a_ui_md_head:
|
.. _a_ui_md_head:
|
||||||
@@ -253,6 +254,33 @@ level of the novel. See :ref:`a_struct_heads` for more details.
|
|||||||
itself. See :ref:`a_struct_heads_unnum` for more details.
|
itself. See :ref:`a_struct_heads_unnum` for more details.
|
||||||
|
|
||||||
|
|
||||||
|
.. _a_ui_md_text:
|
||||||
|
|
||||||
|
Text Paragraphs
|
||||||
|
---------------
|
||||||
|
|
||||||
|
A text paragraph is indicated by a blank line. That is, you need two line breaks to separate two
|
||||||
|
fragments of text into two paragraphs. Single line breaks are treated as line breaks within a
|
||||||
|
paragraph.
|
||||||
|
|
||||||
|
In addition, the editor supports a few additional types of whitespaces.
|
||||||
|
|
||||||
|
* A non-breaking space can be inserted with :kbd:`Ctrl`:kbd:`K`, :kbd:`Space`.
|
||||||
|
* Thin spaces are also supported, and can be inserted with :kbd:`Ctrl`:kbd:`K`,
|
||||||
|
:kbd:`Shift`:kbd:`Space`.
|
||||||
|
* Non-breaking thin space can be inserted with :kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`Space`.
|
||||||
|
|
||||||
|
These are all insert features, and the :guilabel:`Insert` menu has more. They are also listed
|
||||||
|
in :ref:`a_ui_shortcuts_ins`.
|
||||||
|
|
||||||
|
Non-breaking spaces are highlighted by the syntax highlighter with an alternate coloured
|
||||||
|
background, depending on the selected theme.
|
||||||
|
|
||||||
|
.. tip::
|
||||||
|
Non-breaking spaces are the correct type of space to separate a number from its unit. Generally,
|
||||||
|
it prevents the line wrapping algorithms from adding line breaks where it shouldn't.
|
||||||
|
|
||||||
|
|
||||||
.. _a_ui_md_emph:
|
.. _a_ui_md_emph:
|
||||||
|
|
||||||
Text Emphasis
|
Text Emphasis
|
||||||
@@ -333,34 +361,6 @@ The available tag and reference keywords are listed in the :ref:`a_struct_tags`
|
|||||||
also be inserted at the cursor position in the editor via the :guilabel:`Insert` menu.
|
also be inserted at the cursor position in the editor via the :guilabel:`Insert` menu.
|
||||||
|
|
||||||
|
|
||||||
.. _a_ui_md_add:
|
|
||||||
|
|
||||||
Additional Markdown and Non-Standard Features
|
|
||||||
---------------------------------------------
|
|
||||||
|
|
||||||
The editor and viewer also support markdown standard hard line breaks, and preserve non-breaking
|
|
||||||
spaces if running with Qt 5.9 or higher. For older versions, the non-breaking spaces are lost when
|
|
||||||
the document is saved. This is unfortunately hard-coded into the Qt text editor.
|
|
||||||
|
|
||||||
* A hard line break can be achieved by leaving two or more spaces at the end of the line. This is
|
|
||||||
standard markdown syntax. Alternatively, the user can press :kbd:`Ctrl`:kbd:`K`, :kbd:`Return` to
|
|
||||||
insert this type of line break.
|
|
||||||
* A non-breaking space can be inserted with :kbd:`Ctrl`:kbd:`K`, :kbd:`Space`.
|
|
||||||
* Thin spaces are also supported, and can be inserted with :kbd:`Ctrl`:kbd:`K`,
|
|
||||||
:kbd:`Shift`:kbd:`Space`.
|
|
||||||
* Non-breaking thin space can be inserted with :kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`Space`.
|
|
||||||
|
|
||||||
These are all insert features, and the :guilabel:`Insert` menu has more. They are also listed
|
|
||||||
in :ref:`a_ui_shortcuts_ins`.
|
|
||||||
|
|
||||||
Both hard line breaks and non-breaking spaces are highlighted by the syntax highlighter as an
|
|
||||||
alternate coloured background, depending on the selected theme.
|
|
||||||
|
|
||||||
.. tip::
|
|
||||||
Non-breaking spaces are the correct type of space to separate a number from its unit. Generally,
|
|
||||||
it prevents the line wrapping algorithms from adding line breaks where it shouldn't.
|
|
||||||
|
|
||||||
|
|
||||||
.. _a_ui_outline:
|
.. _a_ui_outline:
|
||||||
|
|
||||||
Project Outline View
|
Project Outline View
|
||||||
@@ -514,7 +514,6 @@ a key or key combination for the inserted content.
|
|||||||
":kbd:`Ctrl`:kbd:`K`, :kbd:`.`", "Insert an ellipsis."
|
":kbd:`Ctrl`:kbd:`K`, :kbd:`.`", "Insert an ellipsis."
|
||||||
":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`'`", "Insert a prime."
|
":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`'`", "Insert a prime."
|
||||||
":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`""`", "Insert a double prime."
|
":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`""`", "Insert a double prime."
|
||||||
":kbd:`Ctrl`:kbd:`K`, :kbd:`Return`", "Insert a hard line break."
|
|
||||||
":kbd:`Ctrl`:kbd:`K`, :kbd:`Space`", "Insert a non-breaking space."
|
":kbd:`Ctrl`:kbd:`K`, :kbd:`Space`", "Insert a non-breaking space."
|
||||||
":kbd:`Ctrl`:kbd:`K`, :kbd:`Shift`:kbd:`Space`", "Insert a thin space."
|
":kbd:`Ctrl`:kbd:`K`, :kbd:`Shift`:kbd:`Space`", "Insert a thin space."
|
||||||
":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`Space`", "Insert a thin non-breaking space."
|
":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`Space`", "Insert a thin non-breaking space."
|
||||||
|
|||||||
Reference in New Issue
Block a user