70d74e675f
- Rename project name and package: novelWriter -> UmbraEdit, novelwriter -> umbraedit - Rename entry script novelWriter.py -> UmbraEdit.py - Rename package directory novelwriter/ -> umbraedit/ - Rename i18n translation sources nw_*.ts -> ue_*.ts - Rename packaging files (appdata, project xml template) - Update all imports, references, docs, workflows, tests and build config - Update pyproject.toml project name, GUI script and URLs - Preserve full upstream git history; origin repointed below
93 lines
2.2 KiB
ReStructuredText
93 lines
2.2 KiB
ReStructuredText
##########
|
|
User Guide
|
|
##########
|
|
|
|
| **Release Version:** |release|
|
|
| **Updated:** |today|
|
|
|
|
UmbraEdit 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://umbraedit.io
|
|
* Documentation: https://docs.umbraedit.io
|
|
* Public Releases: https://releases.umbraedit.io
|
|
* Internationalisation: https://crowdin.com/project/umbraedit
|
|
* Source Code: https://github.com/saga-soft/UmbraEdit
|
|
* Source Releases: https://github.com/saga-soft/UmbraEdit/releases
|
|
* Issue Tracker: https://github.com/saga-soft/UmbraEdit/issues
|
|
* Feature Discussions: https://github.com/saga-soft/UmbraEdit/discussions
|
|
* PyPi Project: https://pypi.org/project/UmbraEdit
|
|
* Social Media: https://fosstodon.org/@umbraedit
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
self
|
|
More Documents <https://umbraedit.io/more/>
|
|
|
|
.. toctree::
|
|
:caption: Getting Started
|
|
: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
|
|
usage/front_back_matter
|
|
usage/howto
|
|
|
|
.. toctree::
|
|
:caption: The User Interface
|
|
:hidden:
|
|
|
|
user_interface/main_window
|
|
user_interface/projects
|
|
user_interface/editor_viewer
|
|
user_interface/split_and_merge
|
|
user_interface/manuscript
|
|
user_interface/formatting
|
|
user_interface/statistics
|
|
|
|
.. toctree::
|
|
:caption: Other Features
|
|
:hidden:
|
|
|
|
features/dialogue
|
|
features/story_comments
|
|
features/shortcuts
|
|
features/vim_mode
|
|
|
|
.. toctree::
|
|
:caption: In-Depth Topics
|
|
:hidden:
|
|
|
|
more/counting
|
|
more/typography
|
|
more/dictionaries
|
|
more/customise
|
|
more/handling_errors
|
|
more/project_format
|
|
|
|
.. toctree::
|
|
:caption: Technical Topics
|
|
:hidden:
|
|
|
|
technical/locations
|
|
technical/storage
|
|
technical/source
|
|
technical/tests
|