Veronica Berglyd Olsen
108 lines
2.3 KiB
ReStructuredText
108 lines
2.3 KiB
ReStructuredText
##########
|
|
User Guide
|
|
##########
|
|
|
|
| **Release Version:** |release|
|
|
| **Updated:** |today|
|
|
|
|
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.
|
|
|
|
.. figure:: images/screenshot_multi.png
|
|
:class: dark-light
|
|
:align: center
|
|
:width: 500
|
|
|
|
**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
|
|
* Issue Tracker: https://github.com/vkbo/novelWriter/issues
|
|
* Feature Discussions: https://github.com/vkbo/novelWriter/discussions
|
|
* PyPi Project: https://pypi.org/project/novelWriter
|
|
* Social Media: https://fosstodon.org/@novelwriter
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
Main Page <self>
|
|
More Documents <https://novelwriter.io/more/>
|
|
|
|
.. toctree::
|
|
:caption: Using novelWriter
|
|
:hidden:
|
|
|
|
usage/introduction
|
|
usage/organising_project
|
|
usage/chapters_and_scenes
|
|
usage/basic_formatting
|
|
usage/comments
|
|
usage/tags_and_references
|
|
usage/alignment_and_indent
|
|
usage/advanced_formatting
|
|
|
|
.. toctree::
|
|
:caption: The Manuscript Tool
|
|
:hidden:
|
|
|
|
manuscript/introduction
|
|
|
|
.. toctree::
|
|
:caption: Additional Features
|
|
:hidden:
|
|
|
|
features/introduction
|
|
features/shortcuts
|
|
features/breaks_and_spaces
|
|
features/story_structure
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Special Topics
|
|
:hidden:
|
|
|
|
more/howto
|
|
more/counting
|
|
more/typography
|
|
more/customise
|
|
more/project_format
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Technical Topics
|
|
:hidden:
|
|
|
|
technical/locations
|
|
technical/storage
|
|
technical/source
|
|
technical/tests
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Using novelWriter
|
|
:hidden:
|
|
|
|
usage_breakdown
|
|
usage_project
|
|
usage_writing
|
|
usage_shortcuts
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Organising Your Project
|
|
:hidden:
|
|
|
|
project_overview
|
|
project_structure
|
|
project_manuscript
|