From a3819a778514875900e467b94b5b0461168ea23e Mon Sep 17 00:00:00 2001 From: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com> Date: Sun, 23 May 2021 15:20:26 +0200 Subject: [PATCH] Update docs --- README.md | 1 - docs/source/int_introduction.rst | 3 +- docs/source/usage_interface.rst | 71 ++++++++++++++++---------------- 3 files changed, 36 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index af613ee4..2af3f52b 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,6 @@ of writing novels. The formatting is currently limited to: * Headings levels 1 to 4 using the `#` syntax only. * Emphasised and strongly emphasised text. These are rendered as italicised and bold 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. diff --git a/docs/source/int_introduction.rst b/docs/source/int_introduction.rst index 900c3921..693b8dbe 100644 --- a/docs/source/int_introduction.rst +++ b/docs/source/int_introduction.rst @@ -38,8 +38,7 @@ at the same time provide a complete set of features needed for writing a novel. .. tip:: 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 - hard line breaks can be inserted by adding to spaces at the end of the line. + tabs and line breaks. The tab stop width can be specified in :guilabel:`Preferences`. 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 diff --git a/docs/source/usage_interface.rst b/docs/source/usage_interface.rst index 47038ae9..7c4f92ee 100644 --- a/docs/source/usage_interface.rst +++ b/docs/source/usage_interface.rst @@ -205,15 +205,16 @@ tricky for languages that use the same symbol for these. .. _a_ui_md: -Markdown Format -=============== +The Markdown-Like Format +======================== -The document editor uses a simplified markdown format. That is, it supports basic formatting like -emphasis (italic), strong importance (bold) and strikethrough text, as well as four levels of -headings. +The editor itself is a plaintext editor that uses formatting codes for setting meta data values and +allowing for some text formatting. The syntax is based on Markdown, but novelWriter is *not* a +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, -a synopsis tag, and a set of keyword and value sets used for tags and references. +In addition to formatting codes, novelWriter allows for comments, a synopsis tag, and a set of +keyword and value sets used for tags and references. .. _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. +.. _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: 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. -.. _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: 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:`Ctrl`:kbd:`'`", "Insert a 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:`Shift`:kbd:`Space`", "Insert a thin space." ":kbd:`Ctrl`:kbd:`K`, :kbd:`Ctrl`:kbd:`Space`", "Insert a thin non-breaking space."