From c7ba7b5d3a64778db127657acf52404a2eda7ec1 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Tue, 18 Apr 2023 11:07:33 +0200 Subject: [PATCH 1/3] Add a link to the regular expression Qt docs for the search/replace tool --- docs/source/usage_interface.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/usage_interface.rst b/docs/source/usage_interface.rst index 2fd5991f..1b560743 100644 --- a/docs/source/usage_interface.rst +++ b/docs/source/usage_interface.rst @@ -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 `_ + class. + .. _a_ui_edit_auto: From d1c62e4bbc5dac81f044030ae626222c0ecb4ee8 Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sat, 22 Apr 2023 10:06:23 +0200 Subject: [PATCH 2/3] Docs: Add a note about escape characters for text emphasis --- docs/source/usage_format.rst | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/source/usage_format.rst b/docs/source/usage_format.rst index 9f3f73b4..63a860c9 100644 --- a/docs/source/usage_format.rst +++ b/docs/source/usage_format.rst @@ -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: From f9a4d7ec1f412b70197bad5adebcb04e3a157e6a Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sat, 10 Jun 2023 13:13:36 +0200 Subject: [PATCH 3/3] Make a couple of corrections --- docs/source/int_source.rst | 4 ++-- docs/source/int_started.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/int_source.rst b/docs/source/int_source.rst index 272f18c3..bddd7ae2 100644 --- a/docs/source/int_source.rst +++ b/docs/source/int_source.rst @@ -134,12 +134,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: diff --git a/docs/source/int_started.rst b/docs/source/int_started.rst index dab20afd..002fdcae 100644 --- a/docs/source/int_started.rst +++ b/docs/source/int_started.rst @@ -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