Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change "Build" to "Complie" #1594

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/int_howto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Organising Your Text
within chapters. Like for instance if you switch point-of-view character often.

In such cases you may want to use the scene heading for hard scene breaks and section headings
for soft scene breaks. the :guilabel:`Build Manuscript` tool will let you add separate
for soft scene breaks. the :guilabel:`Compile Manuscript` tool will let you add separate
formatting for the two when you generate your manuscript. You can for instance add the common
"``* * *``" for hard breaks and select to hide section breaks, which will just insert an empty
paragraph in their place. See :ref:`a_manuscript_settings` for more details.
Expand Down
14 changes: 7 additions & 7 deletions docs/source/int_introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Below are some key features of novelWriter.

**Organise your documents how you like**
You can split your novel project up into as many individual documents as you want to. When you
build the project into a manuscript, they are all glued together in the top-to-bottom order in
compile the project into a manuscript, 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 into chapters and scenes means you can easily reorder them using the
drag-and-drop feature. You can also start out with a few documents and then later split them
Expand All @@ -66,13 +66,13 @@ Below are some key features of novelWriter.
subset of the outline information is also available in the :guilabel:`Novel View` as an
alternative view to the project tree.

**Building your manuscript**
**Compiling your manuscript**
Whether you want to assemble a manuscript, or export all your notes, or generate an outline of
your chapters and scenes with a synopsis, you can use the :guilabel:`Build Manuscript` tool to
do so. The tool lets you select what information you want to include in the generated document,
and how it is formatted. You can send the result to a printer, a PDF, or to an Open Document
file that can be opened by most office type word processors. You can also generate the result
as HTML, or Markdown, both suitable for further conversion to other formats.
your chapters and scenes with a synopsis, you can use the :guilabel:`Settings Manuscript` tool
to do so. The tool lets you select what information you want to include in the generated
document, and how it is formatted. You can send the result to a printer, a PDF, or to an Open
Document file that can be opened by most office type word processors. You can also generate the
result as HTML, or Markdown, both suitable for further conversion to other formats.


.. _a_intro_screenshots:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/int_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,5 +88,5 @@ meta data for it to extract.
the application interface.

:ref:`a_manuscript` - Recommended Reading
This chapter explains how the :guilabel:`Manuscript Build` tool works, how you can control the
This chapter explains how the :guilabel:`Manuscript Compile` tool works, how you can control the
way chapter titles are formatted, and how scene and section breaks are handled.
84 changes: 43 additions & 41 deletions docs/source/project_manuscript.rst
Original file line number Diff line number Diff line change
@@ -1,45 +1,46 @@
.. _a_manuscript:

***********************
Building the Manuscript
***********************
************************
Compiling the Manuscript
************************

You can at any time build a manuscript, an outline of your notes, or any other type of document
from the text in your project. All of this is handled by the :guilabel:`Manuscript Build` tool.
You can activate it from the sidebar, the :guilabel:`Tools` menu, or by pressing :kbd:`F5`.
You can at any time compile a manuscript, an outline of your notes, or any other type of document
from the text in your project. All of this is handled by the :guilabel:`Compile ManuscriptBuild`
tool. You can activate it from the sidebar, the :guilabel:`Tools` menu, or by pressing :kbd:`F5`.

.. versionadded:: 2.1
This tool is new for version 2.1. A simpler tool was used for earlier versions. The simpler tool
only allows you to define a single set of options for the build, but otherwise has much the same
functionality.
only allowed you to define a single set of options for the manuscript, but otherwise has much
the same functionality as the new one.


.. _a_manuscript_main:

The Manuscript Build Tool
=========================
The Compile Manuscript Tool
===========================

.. figure:: images/fig_manuscript_build.png

The :guilabel:`Manuscript Build` tool main window.
The :guilabel:`Compile Manuscript` tool main window.

The main window of the :guilabel:`Manuscript Build` tool contains a list of all the builds you have
defined, a selection of settings, and a few buttons to generate preview, open the print dialog, or
run the build to create a manuscript document.
The main window of the :guilabel:`Compile Manuscript` tool contains a list of all the compile
settings have defined, an overview of some of their settings, and a few buttons to generate
preview, open the print dialog, or compile a manuscript document.


.. _a_manuscript_settings:

Build Settings
==============
Manuscript Compile Settings
===========================

Each build definition can be edited by opening it in the :guilabel:`Manuscript Build Settings`
dialog, either by double-clicking or by selecting it and pressing the edit button in the toolbar.
Each compile settings definition can be edited by opening it in the
:guilabel:`Manuscript Compile Settings` dialog, either by double-clicking or by selecting it and
pressing the edit button in the toolbar.

.. tip::
You can keep the :guilabel:`Manuscript Build Settings` dialog open while testing the different
You can keep the :guilabel:`Manuscript Compile Settings` dialog open while testing the different
options, and just hit the :guilabel:`Apply` button. You can test the result of your settings
by pressing the :guilabel:`Preview` button in the main :guilabel:`Manuscript Build` window.
by pressing the :guilabel:`Preview` button in the main :guilabel:`Compile Manuscript` window.
When you're happy with the result, you can close the settings.


Expand All @@ -48,11 +49,11 @@ Document Selection

.. figure:: images/fig_build_settings_selections.png

The :guilabel:`Selections` page of the :guilabel:`Manuscript Build Settings` dialog.
The :guilabel:`Selections` page of the :guilabel:`Manuscript Compile Settings` dialog.

The :guilabel:`Selections` page of the :guilabel:`Manuscript Build Settings` dialog allows you to
fine tune which documents are included in the build. They are indicated by a green arrow icon in
the last column. On the right you have some filter options for selecting content of a specific
The :guilabel:`Selections` page of the :guilabel:`Manuscript Compile Settings` dialog allows you to
fine tune which documents are included in the manuscript. They are indicated by a green arrow icon
in the last column. On the right you have some filter options for selecting content of a specific
type, and a set of switches for which root folders to include.

You can override the result of these filters by marking one or more documents and selecting to
Expand All @@ -68,23 +69,24 @@ Formatting Headings

.. figure:: images/fig_build_settings_headings.png

The :guilabel:`Headings` page of the :guilabel:`Manuscript Build Settings` dialog.
The :guilabel:`Headings` page of the :guilabel:`Manuscript Compile Settings` dialog.

The :guilabel:`Headings` page of the :guilabel:`Manuscript Build Settings` dialog allows you to set
how the headings in your :term:`Novel Documents` are formatted. By default, the title is just
The :guilabel:`Headings` page of the :guilabel:`Manuscript Compile Settings` dialog allows you to
set how the headings in your :term:`Novel Documents` are formatted. By default, the title is just
copied as-is, indicated by the ``{Title}`` format. You can change this to for instance add chapter
numbers and scene numbers like shown int he figure above.

Clicking the edit button next to a format will copy the formatting string into the edit box where
it can be modified, and where a syntax highlighter will help indicate which parts are automatically
generated by the build tool. The :guilabel:`Insert` button is a dropdown list of these formats, and
selecting one will insert it at the position of the cursor.
generated by the compile tool. The :guilabel:`Insert` button is a dropdown list of these formats,
and selecting one will insert it at the position of the cursor.

Any text you add that isn't highlighted in colours will remain in your formatted titles.
``{Title}`` will always be replaced by the text in the heading from your documents.

You can preview the result of these format strings by clicking :guilabel:`Apply`, and then clicking
:guilabel:`Preview` in the :guilabel:`Manuscript Build` tool main window.
:guilabel:`Preview` in the :guilabel:`Compile Manuscript` tool main window.


Scene Separators
^^^^^^^^^^^^^^^^
Expand All @@ -103,30 +105,30 @@ Output Settings
---------------

The :guilabel:`Content`, :guilabel:`Format` and :guilabel:`Output` pages of the
:guilabel:`Manuscript Build Settings` dialog control a number of other settings for the output.
:guilabel:`Manuscript Compile Settings` dialog control a number of other settings for the output.
Some of these only apply to specific output formats, which is indicated by the section headings on
the settings pages.


.. _a_manuscript_build:

Building Manuscript Documents
=============================
Compiling Manuscript Documents
==============================

.. figure:: images/fig_build_build.png

The :guilabel:`Manuscript Build` dialog used for writing the actual manuscript documents.
The :guilabel:`Compile Manuscript` dialog used for writing the actual manuscript documents.

When you press the :guilabel:`Build` button on the :guilabel:`Build Manuscript` tool main window, a
special file dialog opens up. This is where you pick your desired output format and where to write
the file.
When you press the :guilabel:`Compile` button on the :guilabel:`Compile Manuscript` tool main
window, a special file dialog opens up. This is where you pick your desired output format and where
to write the file.

On the left side of the dialog is a list of all the available file formats, and on the right, a
list of the documents which are included based on the build definition you selected. You can choose
list of the documents which are included based on the compile settings you selected. You can choose
an output path, and set a base file name as well. The file extension will be added automatically.

To generate the manuscript document, press the :guilabel:`Build` button. A small progress bar will
show the build progress, but for small projects it may pass very fast.
To generate the manuscript document, press the :guilabel:`Compile` button. A small progress bar
will show the progress, but for small projects it may pass very fast.


File Formats
Expand All @@ -135,7 +137,7 @@ File Formats
Currently, four document formats are supported.

Open Document Format
The Build tool can produce either an ``.odt`` file, or an ``.fodt`` file. The latter is just a
The Compile tool can produce either an ``.odt`` file, or an ``.fodt`` file. The latter is just a
flat version of the document format as a single XML file. Most rich text editors support the
former, and only a few the latter.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/project_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ deleted accidentally, but still want it out of your main project tree, you can c
:guilabel:`Archive` root folder and move it there.

You can drag any document to this folder and preserve its settings. The document will always be
excluded from the :guilabel:`Build Manuscript` tool. It is also removed from the
excluded from the :guilabel:`Compile Manuscript` tool. It is also removed from the
:term:`project index`, so the tags and references defined in it will not show up anywhere else.


Expand Down
4 changes: 2 additions & 2 deletions docs/source/project_references.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ colour that valid tags do.
The tag is the only part of these notes that the novelWriter uses. The rest of the document content
is there for the writer to use in whatever way they wish. Of course, the content of the documents
can be added to the manuscript, or an outline document. If you want to compile a single document of
all your notes, you can do this from the :guilabel:`Manuscript Build` tool.
all your notes, you can do this from the :guilabel:`Compile Manuscript` tool.

Example of a heading with a tag for a character of the story:

Expand Down Expand Up @@ -159,7 +159,7 @@ highlight that two notes are related.

.. tip::
If you cross-reference between notes and export your project as an HTML document using the
:guilabel:`Manuscript Build` tool, the cross-references become clickable links in the exported
:guilabel:`Compile Manuscript` tool, the cross-references become clickable links in the exported
HTML document as well.

Example of a novel document with references to characters and plots:
Expand Down
16 changes: 8 additions & 8 deletions docs/source/project_structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The syntax for the four basic header types, and the two special header types, is

**Header Level 3: Scene**
This header level signifies a scene level partition. You must provide a title text, but the
title text can be replaced with a scene separator or just skipped entirely when you build your
title text can be replaced with a scene separator or just skipped entirely when you compile your
manuscript.

**Header Level 4: Section**
Expand All @@ -59,13 +59,13 @@ The syntax for the four basic header types, and the two special header types, is
mid-scene, like if you change the point-of-view character. You are free to use sections as you
wish, and you can filter them out of the final manuscript just like with scene titles.

Page breaks are automatically added before level 1 and 2 headers when you build your project to a
Page breaks are automatically added before level 1 and 2 headers when you compile your project to a
format that supports page breaks, or when you print the document directly from the
:guilabel:`Manuscript Build` tool. If you want page breaks in other places, you have to specify
:guilabel:`Compile Manuscript` tool. If you want page breaks in other places, you have to specify
them manually. See :ref:`a_fmt_break`.

.. tip::
There are multiple options of how to process novel titles when building the manuscript. For
There are multiple options of how to process novel titles when compiling the manuscript. For
instance, chapter numbers can be applied automatically, and so can scene numbers if you want
them in a draft manuscript. See the :ref:`a_manuscript` page for more details.

Expand All @@ -78,7 +78,7 @@ Novel Title and Front Matter
It is recommended that you add a document at the very top of each Novel root folder with the novel
title as the first line. You should modify the level 1 header format code with an ``!`` in order to
render it as a document title that is excluded from any automatic Table of Content in a manuscript
build document, like so:
document, like so:

``#! My Novel``

Expand All @@ -97,12 +97,12 @@ Unnumbered Chapter Headings

If you use the automatic numbering feature for your chapters, but you want to keep some special
chapters separate from this, you cam add an ``!`` to the level 2 header formatting code to tell the
build tool to skip these chapters.
compile tool to skip these chapters.

``##! Unnumbered Chapter Title``

There is a separate formatting feature for such chapters in the :guilabel:`Manuscript Build` tool
as well. See the :ref:`a_manuscript` page for more details. When building a document of a format
There is a separate formatting feature for such chapters in the :guilabel:`Compile Manuscript` tool
as well. See the :ref:`a_manuscript` page for more details. When compiling a document of a format
that supports page breaks, also unnumbered chapters will have a page break added just like for
normal chapters.

Expand Down
8 changes: 4 additions & 4 deletions docs/source/tech_storage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,11 @@ check somehow fails and novelWriter keeps crashing, you can delete the file manu
the index. If this too fails, you have likely encountered a bug.


Build Definitions
-----------------
Compile Definitions
-------------------

The build definitions from the :guilabel:`Manuscript Build` tool are kept in the
``meta/builds.json`` file. If this file is lost, all custom build definitions are lost too.
The compile definitions from the :guilabel:`Compile Manuscript` tool are kept in the
``meta/builds.json`` file. If this file is lost, all custom definitions are lost too.


Cached GUI Options
Expand Down
10 changes: 5 additions & 5 deletions docs/source/usage_breakdown.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ them. For reference, a list of all shortcuts can be found in the :ref:`a_kb` cha
Formatting is limited to headers, emphasis, text alignment, and a few other simple features.

On the left side of the main window, you will find a sidebar. This bar has buttons for the standard
views you can switch between, a quick link to the :guilabel:`Build Manuscript` tool, and a set of
views you can switch between, a quick link to the :guilabel:`Compile Manuscript` tool, and a set of
project-related tools and quick access to settings at the bottom.


Expand Down Expand Up @@ -165,11 +165,11 @@ whatever they want. See :ref:`a_struct` and :ref:`a_references` for more details

.. _a_breakdown_export:

Building the Manuscript
=======================
Compiling the Manuscript
========================

The project can at any time be assembled into a range of different formats through the
:guilabel:`Build Manuscript` tool. Natively, novelWriter supports `Open Document`_, HTML5, and
:guilabel:`Compile Manuscript` tool. Natively, novelWriter supports `Open Document`_, HTML5, and
various flavours of Markdown.

The HTML5 format is suitable for conversion by a number of other tools like Pandoc_, or for
Expand All @@ -184,7 +184,7 @@ HTML formatted text, or with the raw text as typed into the novel documents.
See :ref:`a_manuscript` for more details.

.. versionadded:: 2.1
You can now define multiple build definitions in the :guilabel:`Build Manuscript` tool. This
You can now define multiple compile settings in the :guilabel:`Compile Manuscript` tool. This
allows you to define specific settings for various types of draft documents, outline documents,
and manuscript formats. See :ref:`a_manuscript` for more details.

Expand Down
Loading