From bc1c54b643e8311e061952feada9fd067db3b0a4 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Sat, 22 Aug 2020 14:06:57 +0200 Subject: [PATCH] Updated documentation --- docs/source/index.rst | 1 + docs/source/interface.rst | 27 ++++++----- docs/source/typography.rst | 93 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 109 insertions(+), 12 deletions(-) create mode 100644 docs/source/typography.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 8ac56990..fe485433 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -60,6 +60,7 @@ already familiar with how to run Python applications on your platform. introduction started interface + typography .. toctree:: diff --git a/docs/source/interface.rst b/docs/source/interface.rst index 48b27691..9191a5d8 100644 --- a/docs/source/interface.rst +++ b/docs/source/interface.rst @@ -1,8 +1,8 @@ .. _a_ui: -*************** +************** User Interface -*************** +************** The user interface is kept as simple as possible to avoid distractions when writing. This page lists all the main GUI elements, and explains what they do. @@ -341,11 +341,12 @@ Most features are available as keyboard shortcuts. These are as follows: ":kbd:`Ctrl`:kbd:`B`", "Format selected text, or word under cursor, with strong emphasis (bold)." ":kbd:`Ctrl`:kbd:`C`", "Copy selected text to clipboard." ":kbd:`Ctrl`:kbd:`D`", "Wrap selected text, or word under cursor, in double quotes." - ":kbd:`Ctrl`:kbd:`E`", "If in the project tree, edit a document or folder settings. (Same as :kbd:`F2`)" + ":kbd:`Ctrl`:kbd:`E`", "If in the project tree, edit a document or folder settings. (Same as :kbd:`F2`.)" ":kbd:`Ctrl`:kbd:`F`", "Open the search bar and search for the selected word, if any is selected." - ":kbd:`Ctrl`:kbd:`G`", "Find next occurrence of search word in current document. (Same as :kbd:`F3`)" - ":kbd:`Ctrl`:kbd:`H`", "Open the search and replace bar and search for the selected word, if any is selected. (On Mac, this is :kbd:`Cmd`:kbd:`=`)" + ":kbd:`Ctrl`:kbd:`G`", "Find next occurrence of search word in current document. (Same as :kbd:`F3`.)" + ":kbd:`Ctrl`:kbd:`H`", "Open the search and replace bar and search for the selected word, if any is selected. (On Mac, this is :kbd:`Cmd`:kbd:`=`.)" ":kbd:`Ctrl`:kbd:`I`", "Format selected text, or word under cursor, with emphasis (italic)." + ":kbd:`Ctrl`:kbd:`K`", "Activate the insert commands. The commands are listed in :ref:`a_ui_shortcuts_ins`." ":kbd:`Ctrl`:kbd:`N`", "Create new document." ":kbd:`Ctrl`:kbd:`O`", "Open selected document." ":kbd:`Ctrl`:kbd:`Q`", "Exit novelWriter." @@ -365,7 +366,7 @@ Most features are available as keyboard shortcuts. These are as follows: ":kbd:`Ctrl`:kbd:`Shift`:kbd:`1`", "Replace occurrence of search word in current document, and search for next occurrence." ":kbd:`Ctrl`:kbd:`Shift`:kbd:`A`", "Select all text in current paragraph." ":kbd:`Ctrl`:kbd:`Shift`:kbd:`D`", "Wrap selected text, or word under cursor, in single quotes." - ":kbd:`Ctrl`:kbd:`Shift`:kbd:`G`", "Find previous occurrence of search word in current document. (Same as :kbd:`Shift`:kbd:`F3`)" + ":kbd:`Ctrl`:kbd:`Shift`:kbd:`G`", "Find previous occurrence of search word in current document. (Same as :kbd:`Shift`:kbd:`F3`.)" ":kbd:`Ctrl`:kbd:`Shift`:kbd:`I`", "Import text to the current document from a text file." ":kbd:`Ctrl`:kbd:`Shift`:kbd:`N`", "Create new folder." ":kbd:`Ctrl`:kbd:`Shift`:kbd:`O`", "Open a project." @@ -386,7 +387,7 @@ Most features are available as keyboard shortcuts. These are as follows: ":kbd:`F10`", "Re-build the project outline." ":kbd:`F11`", "Activate full screen mode." ":kbd:`Shift`:kbd:`F1`", "Open the online documentation in the system default browser." - ":kbd:`Shift`:kbd:`F3`", "Find previous occurrence of search word in current document. (Same as :kbd:`Ctrl`:kbd:`Shift`:kbd:`G`)" + ":kbd:`Shift`:kbd:`F3`", "Find previous occurrence of search word in current document. (Same as :kbd:`Ctrl`:kbd:`Shift`:kbd:`G`.)" ":kbd:`Return`", "If in the project tree, open a document for editing." .. note:: @@ -409,11 +410,13 @@ combination for the inserted character or punctuation. ":kbd:`Ctrl`:kbd:`K`, :kbd:`-`", "Insert a short dash (en dash)." ":kbd:`Ctrl`:kbd:`K`, :kbd:`_`", "Insert a long dash (em dash)." - ":kbd:`Ctrl`:kbd:`K`, :kbd:`.`", "Insert ellipsis." - ":kbd:`Ctrl`:kbd:`K`, :kbd:`1`", "Insert left single quote." - ":kbd:`Ctrl`:kbd:`K`, :kbd:`2`", "Insert right single quote." - ":kbd:`Ctrl`:kbd:`K`, :kbd:`3`", "Insert left double quote." - ":kbd:`Ctrl`:kbd:`K`, :kbd:`4`", "Insert right double quote." + ":kbd:`Ctrl`:kbd:`K`, :kbd:`.`", "Insert an ellipsis." + ":kbd:`Ctrl`:kbd:`K`, :kbd:`1`", "Insert a left single quote." + ":kbd:`Ctrl`:kbd:`K`, :kbd:`2`", "Insert a right single quote." + ":kbd:`Ctrl`:kbd:`K`, :kbd:`3`", "Insert a left double quote." + ":kbd:`Ctrl`:kbd:`K`, :kbd:`4`", "Insert a right double quote." + ":kbd:`Ctrl`:kbd:`K`, :kbd:`'`", "Insert a modifier single apostrophe." + ":kbd:`Ctrl`:kbd:`K`, :kbd:`""`", "Insert a modifier double apostrophe." ":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." diff --git a/docs/source/typography.rst b/docs/source/typography.rst new file mode 100644 index 00000000..debddb50 --- /dev/null +++ b/docs/source/typography.rst @@ -0,0 +1,93 @@ +.. _a_typ: + +******************* +Typographical Notes +******************* + +novelWriter has some support for typographical symbols that are not usually easily available in many +text editors. This includes for instance the proper unicode quotation marks, dashes, ellipsis, thin +spaces, etc. All these symbols are available from the :guilabel:`Insert` menu, and via keyboard +shortcuts. See :ref:`a_ui_shortcuts_ins`. + +This chapter provides some additional information on how novelWriter handles these symbols. + + +.. _a_typ_notes: + +Special Notes on Symbols +======================== + +Some additional notes on these symbols. + + +Dashes and Ellipsis +------------------- + +With the auto-replace feature enabled (see :ref:`a_ui_edit_auto`), multiple hyphens are converted +automatically to short and long dashes, and three dots to ellipsis. The last auto-replace can always +be reverted with the undo command :kbd:`Ctrl`:kbd:`Z`, reverting the text to what you typed before +the automatic replacement occurred. + + +Single and Double Quotes +------------------------ + +All the different quotation marks listed on the `Quotation Mark`_ Wikipedia page are available, and +can be selected as auto-replaced symbols for straight single and double quote key strokes. The +settings can be found in the :guilabel:`Preferences`. + +Ordinarily, text wrapped in quotes are highlighted by the editor. This is meant as a convenience for +highlighting dialogue between characters. This feature can be disabled in the +:guilabel:`Preferences` if this feature isn't wanted. + +The editor distinguishes between text wrapped in straight quotes and with the user-selected double +quote symbols. This is to help the writer recognise which parts of the text are not using the chosen +quote symbols. Two convenience functions in the :guilabel:`Format` menu can be used to re-format a +selected section of text with the correct quote symbols. + +.. _Quotation Mark: https://en.wikipedia.org/wiki/Quotation_mark + + +Modifier Letter Apostrophes +--------------------------- + +The auto-replace feature will consider any right-facing single straight quote as a quote symbol, +even if it's intended as an apostrophe. This also includes the syntax highlighter, which may decide +to use an apostrophe as the closing symbol of a single quoted string. + +Alternative apostrophes, both single and double, are available. They are special Unicode characters +that are not categorised as punctuation, but modifiers. They are usually renderred the same way as +right single and double quotation marks, but not always, depending on the font. + +There is a Wikipedia article for both the single_ and double_ version of this symbol, explaining +what they're for. + +You can use these symbols if you want, and especially if you have an apostrophe within a single +quoted piece of text. + +.. note:: + On export with the :guilabel:`Build Novel Project` tool, these apostrophes will be replaced + automatically with the corresponding right hand quote symbols. In that respect, it doesn't matter + if you mix them. + +.. _single: https://en.wikipedia.org/wiki/Modifier_letter_apostrophe +.. _double: https://en.wikipedia.org/wiki/Modifier_letter_double_apostrophe + + +Special Space Symbols +--------------------- + +A few variations of the regular space character is supported. The correct typographical way to +separate a number from its unit is with a `thin space`_. It is usually 2/3 the width of a regular +space. For numbers and units, this should in addition be a non-breaking space, that is, the text +wrapping should not add a line break on this particular space. + +A regular space can also be made into a non-breaking space. + +All non-breaking spaces are highlighted with a differently coloured packground. The colour will +depend on the selected colour theme. + +The thin and non-breaking spaces are converted to their corresponding HTML codes on export to HTML +format. For plain text, they are exported as regular spaces. + +.. _thin space: https://en.wikipedia.org/wiki/Thin_space