From 2abe214b2fd5d870ae0dfb0d3ca2eab97f10bf22 Mon Sep 17 00:00:00 2001 From: "Veronica K. B. Olsen" <1619840+vkbo@users.noreply.github.com> Date: Mon, 3 Aug 2020 22:52:25 +0200 Subject: [PATCH] Added anchors to the already updated files --- docs/source/index.rst | 2 +- docs/source/introduction.rst | 22 ++++++++++++++++++---- docs/source/started.rst | 15 +++++++++++++++ 3 files changed, 34 insertions(+), 5 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 2e1d982d..92294013 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,7 +7,7 @@ This is the documentation for novelWriter |version|. **Contents** .. toctree:: - :maxdepth: 1 + :maxdepth: 2 introduction started diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 5b3d22d4..6613f1e2 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -1,3 +1,5 @@ +.. _a_intro: + ************ Introduction ************ @@ -16,8 +18,11 @@ These additional features are not standard in markdown, but are available throug keywords. Syntax highlighting is provided to make it easier to verify that the markdown tags are used correctly. + +.. _a_intro_design: + Design Philosophy ------------------ +================= The user interface of novelWriter is intended to be as minimalistic as practically possible, while at the same time provide a complete set of features needed for writing a novel. @@ -44,8 +49,11 @@ A second tab is also available on the main window. This is the Outline tab where structure can be displayed, with all the tags and references listed. Depending on how you structure your novel project files, this outline can be quite different than your project tree. + +.. _a_intro_project: + Project Layout --------------- +============== You are free to structure your project files as you wish in subfolders and split between files. All that matters to novelWriter is the linear order they appear in the project tree (top to bottom) and @@ -61,8 +69,11 @@ The four heading levels (H1 to H4) are treated as follows: This structure is only considered on novel files. For the files designated as project notes, the usage of headers imply no structural meaning, and the user is free to do whatever they want. + +.. _a_intro_export: + Project Export --------------- +============== The project can at any time be exported to a range of different formats. Natively, novelWriter supports export to plain text file, HTML document, novelWriter flavoured markdown, standard @@ -76,8 +87,11 @@ It is also possible to export the content of the project to a JSON file. This is to write your own processing script in for instance Python, as the entire novel can be read into a Python dictionary with a couple of lines of code. + +.. _a_intro_screenshots: + Screenshot ----------- +========== **novelWriter with default system theme:** diff --git a/docs/source/started.rst b/docs/source/started.rst index 32298e9a..43f7322a 100644 --- a/docs/source/started.rst +++ b/docs/source/started.rst @@ -1,9 +1,14 @@ +.. _a_started: + *************** Getting Started *************** Latest version of novelWriter is |version|. + +.. _a_started_install: + Installation ============ @@ -15,6 +20,8 @@ directly from the PyPi_ project page. .. _PyPi: https://pypi.org/project/novelWriter/ +.. _a_started_depend: + Dependencies ============ @@ -29,6 +36,8 @@ is less sophisticated than full spell checking libaries, but if you only work wi performance loss is not noticeable. +.. _a_started_depend_packages: + Package Installation -------------------- @@ -66,6 +75,8 @@ The optional spell check library must be at least 3.0.0 to work with Windows. On works fine. +.. _a_started_running: + Running novelWriter =================== @@ -90,6 +101,8 @@ launch icon and the novelWriter project file mimetype for Gnome desktops on Linu there's one script for Debian and one for Ubuntu. +.. _a_started_standalone: + Building a Standalone Executable ================================ @@ -105,6 +118,8 @@ into your command prompt: If successful, the executable will be in the "dist" folder. +.. _a_started_standalone_win: + Additional Instructions for Windows -----------------------------------