diff --git a/docs/source/index.rst b/docs/source/index.rst index 1495d713..b0020fc6 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -5,9 +5,9 @@ novelWriter User Guide | **Release Version:** |release| | **Updated:** |today| -novelWriter is an open source plain text editor designed for writing novels assembled from many -smaller text documents. It uses a minimal formatting syntax inspired by Markdown, and adds a meta -data syntax for comments, synopsis, and cross-referencing. It is designed to be a simple text +novelWriter is an open source plain text editor designed for writing novels assembled from +individual text documents. It uses a minimal formatting syntax inspired by Markdown, and adds a +meta data syntax for comments, synopsis, and cross-referencing. It is designed to be a simple text editor that allows for easy organisation of text and notes, using human readable text files as storage for robustness. @@ -23,13 +23,14 @@ See the :ref:`a_breakdown_storage` section for more details. Any operating system that can run Python 3 and has the Qt 5 libraries should be able to run novelWriter. It runs fine on Linux, Windows and MacOS, and users have tested it on other platforms -as well. novelWriter can also be run directly from the Python source, or installed from packages or -with pip. See :ref:`a_started` for more details. +as well. novelWriter can be run directly from the Python source, or installed from packages or with +pip. See :ref:`a_started` for more details. **Useful Links** * Website: https://novelwriter.io * Documentation: https://docs.novelwriter.io +* Public Releases: https://releases.novelwriter.io * Internationalisation: https://crowdin.com/project/novelwriter * Source Code: https://github.com/vkbo/novelWriter * Source Releases: https://github.com/vkbo/novelWriter/releases @@ -66,7 +67,6 @@ with pip. See :ref:`a_started` for more details. usage_format usage_shortcuts usage_typography - usage_projectformat .. toctree:: :maxdepth: 1 @@ -80,7 +80,15 @@ with pip. See :ref:`a_started` for more details. .. toctree:: :maxdepth: 1 - :caption: Additional Topics + :caption: Additional Details + :hidden: + + more_projectformat + more_counting + +.. toctree:: + :maxdepth: 1 + :caption: Technical Topics :hidden: tech_locations diff --git a/docs/source/more_counting.rst b/docs/source/more_counting.rst new file mode 100644 index 00000000..3f0d221b --- /dev/null +++ b/docs/source/more_counting.rst @@ -0,0 +1,39 @@ +.. _a_counting: + +******************** +Word and Text Counts +******************** + +This is an overview of how words and other counts of your text are performed. The counting rules +should be relatively standard, and are compared to LibreOffice Writer rules. The counts provided in +the app on the raw text are only meant to be approximate. + + +Text Word Counts and Stats +========================== + +These are the rules for the main counts available for for each document in a project. + +For all counts, the following rules apply. + +#. Short (–) and long (—) dashes are considered word separators. +#. Any line starting with ``%`` or ``@`` is ignored. +#. Trailing white spaces are ignored, including line breaks. +#. Leading ``>`` and trailing ``<`` are ignored with any spaces next to them. +#. Valid shortcodes and other commands wrapped in brackets ``[]`` are ignored. +#. In-line Markdown syntax in text paragraphs is treated as part of the text. + +After the above preparation of the text, the following counts are available. + +**Character Count** + The character count is the sum of characters per line, including leading and in-text white space + characters, but excluding trailing white space characters. Shortcodes in the text are not + included, but Markdown codes are. Only headers and text are counted. + +**Word Count** + The words count is the sum of blocks of continuous character per line separated by any number of + white space characters or dashes. Only headers and text are counted. + +**Paragraph Count** + The paragraph count is the number of text blocks separated by one or more empty line. A line + consisting only of white spaces is considered empty. diff --git a/docs/source/usage_projectformat.rst b/docs/source/more_projectformat.rst similarity index 100% rename from docs/source/usage_projectformat.rst rename to docs/source/more_projectformat.rst