Update Docs (#1462)

This commit is contained in:
Veronica Berglyd Olsen
2023-06-10 13:16:23 +02:00
committed by GitHub
4 changed files with 23 additions and 8 deletions
+2 -2
View File
@@ -148,12 +148,12 @@ the ``assets`` folder of the source. This file can be built from setup script by
Building the Documentation
==========================
A local copy of this documentation can be generated as HTML. This requires the following Python
A local copy of this documentation can be generated as HTML. This requires installing some Python
packages from PyPi:
.. code-block:: bash
pip install furo sphinx
pip install -r docs/source/requirements.txt
The documentation can then be built from the root folder in the source code by running:
+1 -1
View File
@@ -186,7 +186,7 @@ command will not work in the command line window.
Screenshot of the Python installer on Windows.
When Python is installed, you should be able to run Python commands from the COmmand Prompt or
When Python is installed, you should be able to run Python commands from the Command Prompt or
from PowerShell. You can verify this by running:
.. code-block:: bash
+14 -5
View File
@@ -109,7 +109,7 @@ background, depending on the selected theme.
Text Emphasis
=============
A minimal set of text emphasis styles are supported.
A minimal set of text emphasis styles are supported for text paragraphs.
``_text_``
The text is rendered as emphasised text (italicised).
@@ -120,7 +120,7 @@ A minimal set of text emphasis styles are supported.
``~~text~~``
Strikethrough text.
In markdown guides it is often recommended to differentiate between strong importance and emphasis
In Markdown guides it is often recommended to differentiate between strong importance and emphasis
by using ``**`` for strong and ``_`` for emphasis, although Markdown generally also supports ``__``
for strong and ``*`` for emphasis. However, since the differentiation makes the highlighting and
conversion significantly simpler and faster, in novelWriter this is a rule, not just a
@@ -132,11 +132,20 @@ In addition, the following rules apply:
itself. That is, ``**text**`` is valid, ``**text **`` is not.
2. More generally, the delimiters must be on the outer edge of words. That is, ``some **text in
bold** here`` is valid, ``some** text in bold** here`` is not.
3. If using both ``**`` and ``_`` to wrap the same text, the underscore must be the inner wrapper.
This is due to the underscore also being a valid word character, so if they are on the outside,
they violate rule 2.
3. If using both ``**`` and ``_`` to wrap the same text, the underscore must be the *inner*
wrapper. This is due to the underscore also being a valid word character, so if they are on the
outside, they violate rule 2.
4. Text emphasis does not span past line breaks. If you need to add emphasis to multiple lines or
paragraphs, you must apply it to each of them in turn.
5. Text emphasis can only be used in plain paragraphs. Comments, titles, and meta data tags don't
allow for formatting, and any formatting markup will be renderred as-is.
.. tip::
novelWriter supports standard escape syntax for the emphasis markup characters in case the
editor misunderstands your intended usage of them. That is, ``\*``, ``\_`` and ``\~`` will
generate a plain ``*``, ``_`` and ``~``, respectively, without interpreting them as part of the
markup.
.. _a_fmt_comm:
+6
View File
@@ -204,6 +204,12 @@ match the word being replaced.
The regular expression search is somewhat dependant on which version of Qt your system has. If you
have Qt 5.13 or higher, there is better support for unicode symbols in the search.
.. seealso::
For more information on the capabilities of the Regular Expression option, see the Qt
documentation for the `QRegularExpression <https://doc.qt.io/qt-5/qregularexpression.html>`_
class.
.. _a_ui_edit_auto: