Update docs introduction section
This commit is contained in:
@@ -58,18 +58,3 @@ For novelWriter to be able to locate the custom theme files, you must copy them
|
|||||||
|
|
||||||
Once the files are copied there, they should show up in :guilabel:`Preferences` with the label you
|
Once the files are copied there, they should show up in :guilabel:`Preferences` with the label you
|
||||||
set as ``name`` inside the file.
|
set as ``name`` inside the file.
|
||||||
|
|
||||||
|
|
||||||
Theme CSS Files
|
|
||||||
---------------
|
|
||||||
|
|
||||||
If you wish, you can also modify the CSS styles of the GUI in addition to change colour settings.
|
|
||||||
This is only available for GUI themes, and you do this by creating a file with the exact same file
|
|
||||||
name as the ``.conf`` file with colour settings and give it the ``.qss`` extension.
|
|
||||||
|
|
||||||
On Windows, file extensions may not be visible by default, so make sure you only have one file
|
|
||||||
extension, and don't end up with two.
|
|
||||||
|
|
||||||
The QSS files are Qt Style Sheet files. See Qt's
|
|
||||||
`The Style Sheet Syntax <https://doc.qt.io/qt-5/stylesheet-syntax.html>`_ documentation for more
|
|
||||||
details.
|
|
||||||
|
|||||||
@@ -4,10 +4,10 @@
|
|||||||
Key Features
|
Key Features
|
||||||
************
|
************
|
||||||
|
|
||||||
novelWriter is a multi-document plain text editor using a markup syntax inspired by markdown to
|
novelWriter is a multi-document plain text editor using a markup syntax inspired by Markdown to
|
||||||
apply simple formatting to the text. It is designed for writing novels, so the formatting features
|
apply simple formatting to the text. It is designed for writing novels, so the formatting features
|
||||||
are limited. Your novel project is organised as a collection of separate plain text documents
|
are limited to those relevant for this purpose. Your novel project is organised as a collection of
|
||||||
instead of a single, large document.
|
separate plain text documents instead of a single, large document.
|
||||||
|
|
||||||
Below are some key features of novelWriter.
|
Below are some key features of novelWriter.
|
||||||
|
|
||||||
@@ -27,7 +27,9 @@ Below are some key features of novelWriter.
|
|||||||
You can split your novel project up into as many individual documents as you want to. When you
|
You can split your novel project up into as many individual documents as you want to. When you
|
||||||
build the project, they are all glued together in the top-to-bottom order in which they appear
|
build the project, they are all glued together in the top-to-bottom order in which they appear
|
||||||
in the project tree. You can use as few text documents as you like, but splitting the project up
|
in the project tree. You can use as few text documents as you like, but splitting the project up
|
||||||
into chapters and scenes means you can easily reorder them using the drag and drop feature.
|
into chapters and scenes means you can easily reorder them using the drag and drop feature. You
|
||||||
|
can start out with a few documents and then later split the document into multiple documents
|
||||||
|
based on its headers.
|
||||||
|
|
||||||
**Keep track of your plot elements**
|
**Keep track of your plot elements**
|
||||||
All notes in your project can be assigned a *tag* you can *reference* from any other document or
|
All notes in your project can be assigned a *tag* you can *reference* from any other document or
|
||||||
@@ -36,11 +38,12 @@ Below are some key features of novelWriter.
|
|||||||
keywords.
|
keywords.
|
||||||
|
|
||||||
**Get an overview of your plot elements**
|
**Get an overview of your plot elements**
|
||||||
In the :guilabel:`Outline` tab on the main window you can see an outline of all the chapter and
|
In the :guilabel:`Outline View` on the main window you can see an outline of all the chapters,
|
||||||
scene sections of your project. If they have any references in them, these are listed in
|
scenes, and sections of your project. If they have any references in them, these are listed in
|
||||||
columns. You can also add a synopsis to each document, which can be listed here. You have the
|
columns. You can also add a synopsis to each document, which can be listed here. You have the
|
||||||
option to add or remove columns of information from the outline. A subset of the outline
|
option to add or remove columns of information from the outline. A subset of the outline
|
||||||
information is also available in the :guilabel:`Novel` tab under the main project tree.
|
information is also available in the :guilabel:`Novel View` as a replacement for the main
|
||||||
|
project tree.
|
||||||
|
|
||||||
**Building your manuscript**
|
**Building your manuscript**
|
||||||
Whether you want to compile a manuscript, or export all your notes, or generate an outline of
|
Whether you want to compile a manuscript, or export all your notes, or generate an outline of
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ language that doesn't require a compiler to build and run. That means that the c
|
|||||||
computer right out of the box, or from a zip file.
|
computer right out of the box, or from a zip file.
|
||||||
|
|
||||||
While it is developed for Linux primarily, it runs just fine on Windows as well. It also works fine
|
While it is developed for Linux primarily, it runs just fine on Windows as well. It also works fine
|
||||||
on macOS, but the author is not a mac user so less attention is paid to that platform.
|
on macOS, but the author is not a mac user, so less attention is paid to that platform.
|
||||||
|
|
||||||
In order to run novelWriter, you also need a few additional packages. The user interface is built
|
In order to run novelWriter, you also need a few additional packages. The user interface is built
|
||||||
with `Qt 5 <https://www.qt.io/>`_, a cross platform library for building graphical user interface
|
with `Qt 5 <https://www.qt.io/>`_, a cross platform library for building graphical user interface
|
||||||
@@ -86,5 +86,5 @@ meta data for it to extract.
|
|||||||
them for tags you've set so that it knows which file to open when you click on a reference.
|
them for tags you've set so that it knows which file to open when you click on a reference.
|
||||||
|
|
||||||
:ref:`a_export` - Recommended Reading
|
:ref:`a_export` - Recommended Reading
|
||||||
This section explains in more detail how the export tool works. In particular how you can
|
This section explains in more detail how the build tool works. In particular how you can
|
||||||
control the way chapter titles are formatted, and how scene and section breaks are handled.
|
control the way chapter titles are formatted, and how scene and section breaks are handled.
|
||||||
|
|||||||
@@ -110,6 +110,19 @@ needed package is called `qttools5-dev-tools`.
|
|||||||
the ``i18n`` folder of the source code.
|
the ``i18n`` folder of the source code.
|
||||||
|
|
||||||
|
|
||||||
|
.. _a_source_sample:
|
||||||
|
|
||||||
|
Building the Example Project
|
||||||
|
============================
|
||||||
|
|
||||||
|
In order to be able to create new projects from example files, you need a ``sample.zip`` file in
|
||||||
|
the ``assets`` folder of the source. This file can be built from setup script by running:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
python setup.py sample
|
||||||
|
|
||||||
|
|
||||||
.. _a_source_docs:
|
.. _a_source_docs:
|
||||||
|
|
||||||
Building the Documentation
|
Building the Documentation
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ Getting Started
|
|||||||
.. _python.org: https://www.python.org/downloads/windows
|
.. _python.org: https://www.python.org/downloads/windows
|
||||||
.. _Releases: https://github.com/vkbo/novelWriter/releases
|
.. _Releases: https://github.com/vkbo/novelWriter/releases
|
||||||
.. _RPM: https://github.com/vkbo/novelWriter/issues/907
|
.. _RPM: https://github.com/vkbo/novelWriter/issues/907
|
||||||
|
.. _AppImage: https://appimage.org/
|
||||||
|
|
||||||
If you are using Windows or a Debian-based Linux distribtuion, you can install novelWriter from
|
If you are using Windows or a Debian-based Linux distribtuion, you can install novelWriter from
|
||||||
package installers. If you are on macOS, you have the option to run novelWriter from a standalone
|
package installers. If you are on macOS, you have the option to run novelWriter from a standalone
|
||||||
@@ -46,10 +47,10 @@ If you have any issues, try uninstalling the previous version and making a fresh
|
|||||||
already had a version installed via a different method, you should uninstall that first.
|
already had a version installed via a different method, you should uninstall that first.
|
||||||
|
|
||||||
|
|
||||||
.. _a_started_debian:
|
.. _a_started_linux:
|
||||||
|
|
||||||
Install on Debian/Ubuntu/Mint
|
Install on Linux
|
||||||
=============================
|
================
|
||||||
|
|
||||||
A Debian package can be downloaded from the `main website`_, or from the Releases_ page on GitHub.
|
A Debian package can be downloaded from the `main website`_, or from the Releases_ page on GitHub.
|
||||||
This package should work on both Debian, Ubuntu and Linux Mint.
|
This package should work on both Debian, Ubuntu and Linux Mint.
|
||||||
@@ -57,8 +58,8 @@ This package should work on both Debian, Ubuntu and Linux Mint.
|
|||||||
If you prefer, you can also add the novelWriter repository on Launchpad to your package manager.
|
If you prefer, you can also add the novelWriter repository on Launchpad to your package manager.
|
||||||
|
|
||||||
|
|
||||||
Ubuntu and Mint
|
Ubuntu
|
||||||
---------------
|
------
|
||||||
|
|
||||||
You can add the Ubuntu PPA_ and install novelWriter with the following commands.
|
You can add the Ubuntu PPA_ and install novelWriter with the following commands.
|
||||||
|
|
||||||
@@ -71,11 +72,11 @@ You can add the Ubuntu PPA_ and install novelWriter with the following commands.
|
|||||||
If you want pre-releases, add the ``ppa:vkbo/novelwriter-pre`` repository instead.
|
If you want pre-releases, add the ``ppa:vkbo/novelwriter-pre`` repository instead.
|
||||||
|
|
||||||
|
|
||||||
Debian
|
Debian and Mint
|
||||||
------
|
---------------
|
||||||
|
|
||||||
Since this is a pure Python package, the Launchpad PPA can in principle also be used on Debian.
|
Since this is a pure Python package, the Launchpad PPA can in principle also be used on Debian or
|
||||||
However, the above command will fail to add the signing key.
|
Mint. However, the above command will fail to add the signing key.
|
||||||
|
|
||||||
Instead, run the following commands to add the repository and key:
|
Instead, run the following commands to add the repository and key:
|
||||||
|
|
||||||
@@ -97,6 +98,14 @@ Then run the update and install commands as for Ubuntu:
|
|||||||
different compression algorithm that Debian doesn't currently support.
|
different compression algorithm that Debian doesn't currently support.
|
||||||
|
|
||||||
|
|
||||||
|
Other Distros
|
||||||
|
-------------
|
||||||
|
|
||||||
|
For other Linux distros than the ones mentioned above, the primary option is AppImage_. These are
|
||||||
|
completely standalone images for the app that include the necessary environment to run novelWriter.
|
||||||
|
They can be run on any Linux distro.
|
||||||
|
|
||||||
|
|
||||||
.. _a_started_minimal:
|
.. _a_started_minimal:
|
||||||
|
|
||||||
Minimal Package Install
|
Minimal Package Install
|
||||||
|
|||||||
Reference in New Issue
Block a user