Added anchors to the already updated files
This commit is contained in:
@@ -7,7 +7,7 @@ This is the documentation for novelWriter |version|.
|
|||||||
**Contents**
|
**Contents**
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 2
|
||||||
|
|
||||||
introduction
|
introduction
|
||||||
started
|
started
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
.. _a_intro:
|
||||||
|
|
||||||
************
|
************
|
||||||
Introduction
|
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
|
keywords. Syntax highlighting is provided to make it easier to verify that the markdown tags are
|
||||||
used correctly.
|
used correctly.
|
||||||
|
|
||||||
|
|
||||||
|
.. _a_intro_design:
|
||||||
|
|
||||||
Design Philosophy
|
Design Philosophy
|
||||||
-----------------
|
=================
|
||||||
|
|
||||||
The user interface of novelWriter is intended to be as minimalistic as practically possible, while
|
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.
|
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
|
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.
|
your novel project files, this outline can be quite different than your project tree.
|
||||||
|
|
||||||
|
|
||||||
|
.. _a_intro_project:
|
||||||
|
|
||||||
Project Layout
|
Project Layout
|
||||||
--------------
|
==============
|
||||||
|
|
||||||
You are free to structure your project files as you wish in subfolders and split between files. All
|
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
|
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
|
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.
|
usage of headers imply no structural meaning, and the user is free to do whatever they want.
|
||||||
|
|
||||||
|
|
||||||
|
.. _a_intro_export:
|
||||||
|
|
||||||
Project Export
|
Project Export
|
||||||
--------------
|
==============
|
||||||
|
|
||||||
The project can at any time be exported to a range of different formats. Natively, novelWriter
|
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
|
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
|
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.
|
Python dictionary with a couple of lines of code.
|
||||||
|
|
||||||
|
|
||||||
|
.. _a_intro_screenshots:
|
||||||
|
|
||||||
Screenshot
|
Screenshot
|
||||||
----------
|
==========
|
||||||
|
|
||||||
**novelWriter with default system theme:**
|
**novelWriter with default system theme:**
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,14 @@
|
|||||||
|
.. _a_started:
|
||||||
|
|
||||||
***************
|
***************
|
||||||
Getting Started
|
Getting Started
|
||||||
***************
|
***************
|
||||||
|
|
||||||
Latest version of novelWriter is |version|.
|
Latest version of novelWriter is |version|.
|
||||||
|
|
||||||
|
|
||||||
|
.. _a_started_install:
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
============
|
============
|
||||||
|
|
||||||
@@ -15,6 +20,8 @@ directly from the PyPi_ project page.
|
|||||||
.. _PyPi: https://pypi.org/project/novelWriter/
|
.. _PyPi: https://pypi.org/project/novelWriter/
|
||||||
|
|
||||||
|
|
||||||
|
.. _a_started_depend:
|
||||||
|
|
||||||
Dependencies
|
Dependencies
|
||||||
============
|
============
|
||||||
|
|
||||||
@@ -29,6 +36,8 @@ is less sophisticated than full spell checking libaries, but if you only work wi
|
|||||||
performance loss is not noticeable.
|
performance loss is not noticeable.
|
||||||
|
|
||||||
|
|
||||||
|
.. _a_started_depend_packages:
|
||||||
|
|
||||||
Package Installation
|
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.
|
works fine.
|
||||||
|
|
||||||
|
|
||||||
|
.. _a_started_running:
|
||||||
|
|
||||||
Running novelWriter
|
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.
|
there's one script for Debian and one for Ubuntu.
|
||||||
|
|
||||||
|
|
||||||
|
.. _a_started_standalone:
|
||||||
|
|
||||||
Building a Standalone Executable
|
Building a Standalone Executable
|
||||||
================================
|
================================
|
||||||
|
|
||||||
@@ -105,6 +118,8 @@ into your command prompt:
|
|||||||
If successful, the executable will be in the "dist" folder.
|
If successful, the executable will be in the "dist" folder.
|
||||||
|
|
||||||
|
|
||||||
|
.. _a_started_standalone_win:
|
||||||
|
|
||||||
Additional Instructions for Windows
|
Additional Instructions for Windows
|
||||||
-----------------------------------
|
-----------------------------------
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user