diff --git a/docs/source/images/fig_editor.png b/docs/source/images/fig_editor.png index f8aee5bb..b2f772bf 100644 Binary files a/docs/source/images/fig_editor.png and b/docs/source/images/fig_editor.png differ diff --git a/docs/source/images/fig_novel_tree_view.png b/docs/source/images/fig_novel_tree_view.png index b0f92b8f..41eaf1fa 100644 Binary files a/docs/source/images/fig_novel_tree_view.png and b/docs/source/images/fig_novel_tree_view.png differ diff --git a/docs/source/images/fig_outline_view.png b/docs/source/images/fig_outline_view.png index 90b4f3d1..3142af04 100644 Binary files a/docs/source/images/fig_outline_view.png and b/docs/source/images/fig_outline_view.png differ diff --git a/docs/source/images/fig_project_split_tool.png b/docs/source/images/fig_project_split_tool.png index a7809f82..cb3c498c 100644 Binary files a/docs/source/images/fig_project_split_tool.png and b/docs/source/images/fig_project_split_tool.png differ diff --git a/docs/source/images/fig_project_tree_view.png b/docs/source/images/fig_project_tree_view.png index f5058038..b891d3f1 100644 Binary files a/docs/source/images/fig_project_tree_view.png and b/docs/source/images/fig_project_tree_view.png differ diff --git a/docs/source/images/fig_viewer.png b/docs/source/images/fig_viewer.png index 7fbdc71d..d53beee1 100644 Binary files a/docs/source/images/fig_viewer.png and b/docs/source/images/fig_viewer.png differ diff --git a/docs/source/project_structure.rst b/docs/source/project_structure.rst index 0763fed7..dd6e9153 100644 --- a/docs/source/project_structure.rst +++ b/docs/source/project_structure.rst @@ -120,3 +120,8 @@ for normal chapters. the first character of the chapter title itself. This feature has been dropped in favour of the current format in order to keep level 1 and 2 headers consistent. Please update your chapter headings if you've used this syntax. + +.. _a_struct_heads_scenes: + +Hard and Soft Scene Breaks +-------------------------- diff --git a/docs/source/usage_breakdown.rst b/docs/source/usage_breakdown.rst index c0f14968..9a59ccb9 100644 --- a/docs/source/usage_breakdown.rst +++ b/docs/source/usage_breakdown.rst @@ -21,14 +21,15 @@ GUI Layout and Design The user interface of novelWriter is intended to be as minimalistic as practically possible, while at the same time provide useful features needed for writing a novel. -The main window does not have an editor toolbar like many other applications do. This reduces -clutter, and since the documents are formatted with style tags, it is more or less redundant. -Still, a small formatting toolbar can be popped out by clicking the three dots in the header of the -document editor to give quick access to standard formatting codes. +The main window does not by default have an editor toolbar like many other applications do. This +reduces clutter, and since the documents are formatted with style tags, it is not needed most of +the time. Still, a small formatting toolbar can be popped out by clicking the left-most button in +the header of the document editor. It gives quick access to standard formatting codes. Most formatting features supported are available through convenient keyboard shortcuts. They are -also available in the main menu, so you don't have to look up formatting codes every time you need -them. For reference, a list of all shortcuts can be found in the :ref:`a_kb` chapter. +also available in the main menu under **Format**, so you don't have to look up formatting codes +every time you need them. For reference, a list of all shortcuts can be found in the :ref:`a_kb` +chapter. .. note:: novelWriter is not intended to be a full office type word processor. It doesn't support images, @@ -37,13 +38,13 @@ them. For reference, a list of all shortcuts can be found in the :ref:`a_kb` cha 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 **Build Manuscript** tool, and a set of project-related tools and quick access to settings at the bottom. .. versionadded:: 2.2 A number of new formatting options were added in 2.2 to allow for some special formatting cases. At the same time, a small formatting toolbar was added in the editor. It is hidden by default, - but can be opened by pressing the three dots icon in the top right corner. + but can be opened by pressing the icon button in the top right corner. Project Tree and Editor View @@ -53,19 +54,19 @@ Project Tree and Editor View A screenshot of the Project Tree and Editor View. -When in :guilabel:`Project Tree View` mode, the main work area of the main window is split in two, -or optionally three, panels. The left-most panel contains the project tree and all the documents in -your project. The second panel is the document editor. +When the application is in **Project Tree View** mode, the main work area of the main window is +split in two, or optionally three, panels. The left-most panel contains the project tree and all +the documents in your project. The second panel is the document editor. An optional third panel on the right side contains a document viewer which can view any document in your project independently of what is open in the document editor. This panel is not intended as a -preview window, although you can use it for this purpose if you wish if you need to check that the -formatting tags behave as you expected. The main purpose of the viewer is for viewing your notes -next to your editor while you're writing. +preview window, although you can use it for this purpose if you wish. For instance if you need to +check that the formatting tags behave as you expect. However, the main purpose of the viewer is for +viewing your notes next to your editor while you're writing. -The editor also has a :guilabel:`Focus Mode` you can toggle either from the menu, from the icon in -the editor's header, or by pressing :kbd:`F8`. When :guilabel:`Focus Mode` is enabled, all the user -interface elements other than the document editor itself are hidden away. +The editor also has a **Focus Mode** you can toggle either from the menu, from the icon in the +editor's header, or by pressing :kbd:`F8`. When **Focus Mode** is enabled, all the user interface +elements other than the document editor itself are hidden away. Novel View and Editor View @@ -73,31 +74,32 @@ Novel View and Editor View .. figure:: images/fig_novel_tree_view.png - A screenshot of the Novel Tree View. + A screenshot of the Novel Tree and Editor View. -When in :guilabel:`Novel Tree View` mode, the project tree is replaced by an overview of your novel -structure for a specific Novel :term:`root folder`. Instead of showing individual documents, the -tree now shows all headings of your novel text. This includes multiple headings within the same -document. +When the application is in **Novel Tree View** mode, the project tree is replaced by an overview of +your novel structure for a specific Novel :term:`root folder`. Instead of showing individual +documents, the tree now shows all headings of your novel text. This includes multiple headings +within the same document. -Each heading is indented according to the heading level. You can open and edit your novel documents -from this view as well. All headings contained in the currently open document should be highlighted -in the view to indicate which ones belong together in the same document. +Each heading is indented according to the heading level, not its parent/child relationship to other +elements of your project. You can open and edit your novel documents from this view as well. All +headings contained in the currently open document should be highlighted in the view to indicate +which ones belong together in the same document. -If you have multiple "Novel" type root folders, the header of the novel view becomes a dropdown +If you have multiple **Novel** type root folders, the header of the novel view becomes a dropdown box. You can then switch between them by clicking the :guilabel:`Outline of ...` text. You can also click the novel icon button next to it. Generally, the novel view should update when you make changes to the novel structure, including edits of the current document in the editor. The information is only updated when the automatic save of the document is triggered, or you manually press :kbd:`Ctrl+S` to save changes. (You can -adjust the auto-save interval in :guilabel:`Preferences`.) You can also regenerate the whole novel -view by pressing the refresh button in the novel view header. +adjust the auto-save interval in **Preferences**.) You can also regenerate the whole novel view by +pressing the refresh button in the novel view header. It is possible to show an optional third column in the novel view. The settings are available from the menu button in the toolbar. -If you click the arrow icon to the right of each item, a tooltip will pop out showing you all the +If you click the triangular icon to the right of each item, a tooltip will pop out showing all the meta data collected for that heading. @@ -108,9 +110,9 @@ Novel Outline View A screenshot of the Novel Outline View. -When in :guilabel:`Novel Outline View` mode, the tree, editor and viewer will be replaced by a -large table that shows the entire novel structure with all the tags and references listed. Pretty -much all collected meta data is available here in different columns. +When the application is in **Novel Outline View** mode, the tree, editor and viewer will be +replaced by a large table that shows the entire novel structure with all the tags and references +listed. Pretty much all collected meta data is available here in different columns. You can select which novel root folder to display from the dropdown box, and you can select which columns to show or hide from the menu button. You can also rearrange the columns by drag and drop. @@ -120,20 +122,27 @@ The app will remember your column order and size between sessions, and for each Colour Themes ------------- -By default, novelWriter will use the colour theme provided by the Qt library, which is determined -by the Fusion_ style setting. You can also choose between a standard dark and light theme that have -neutral colours from :guilabel:`Preferences`. Other colour themes are also available. More themes -can be contributed to novelWriter on GitHub. +By default, novelWriter will use a light colour theme. You can change this colour theme from the +**Preferences**. If you wish, you *can* create your own colour themes, and even have them added to +the application. See :ref:`a_custom_theme` for more details. Switching the GUI colour theme does not affect the colours of the editor and viewer. They have -separate colour selectable from the "Document colour theme" setting in :guilabel:`Preferences`. -They are separated because there are a lot more options to choose from for the editor and viewer. +separate colour selectable from the "Document colour theme" setting in **Preferences**. They are +separated because there are a lot more options to choose from for the editor and viewer. .. note:: If you switch between light and dark mode on the GUI, you should also switch editor theme to match, otherwise icons may be hard to see in the editor and viewer. +Project Search +-------------- + +A global search tool is available from the side bar. It allows you to search through your entire +project. The tool does not provide a replace feature. There is a search and replace tool available +in the document editor that acts on the open document. + + .. _a_breakdown_project: Project Layout @@ -152,12 +161,12 @@ within those documents. An illustration of how heading levels correspond to the novel structure. -The four heading levels (**H1** to **H4**) are treated as follows: +The four heading levels, **Level 1** to **Level 4**, are treated as follows: -* **H1** is used for the novel title, and for partitions. -* **H2** is used for chapter tiles. -* **H3** is used for scene titles -- optionally replaced by separators. -* **H4** is for section titles within scenes, if such granularity is needed. +* **Level 1** is used for the novel title, and for partitions. +* **Level 2** is used for chapter tiles. +* **Level 3** is used for scene titles -- optionally replaced by separators. +* **Level 4** is for section titles within scenes, if such granularity is needed. The project tree will select an icon for the document based on the first heading in it. @@ -178,25 +187,25 @@ Building a 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 +**Build 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 importing into word processors if the Open Document format isn't suitable. The Open Document format -is supported by most Office type applications. In addition, printing is also possible. Print to PDF +is supported by most office type applications. In addition, printing is also possible. Print to PDF is available from the print dialog. -In addition, you can export the content of the project to a JSON file. This is useful if you want -to write your own custom processing script in for instance Python, as the entire novel can be read -into a Python dictionary with a couple of lines of code. The JSON file can be populated with either -HTML formatted text, or with the raw text as typed into the novel documents. +For advanced processing, you can export the content of the project to a JSON file. This is useful +if you want to write your own custom processing script in for instance Python, as the entire novel +can be read into a Python dictionary with a couple of lines of code. The JSON file can be populated +with either 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 - allows you to define specific settings for various types of draft documents, outline documents, - and manuscript formats. See :ref:`a_manuscript` for more details. + You can now define multiple build definitions in the **Build 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. .. _a_breakdown_storage: diff --git a/docs/source/usage_format.rst b/docs/source/usage_format.rst index f452c5fd..85b79c54 100644 --- a/docs/source/usage_format.rst +++ b/docs/source/usage_format.rst @@ -10,7 +10,7 @@ values and allowing for some text formatting. The syntax is based on Markdown, b (bold) and strike through text, as well as four levels of headings. For some further complex formatting needs, a set of shortcodes can be used. -In addition to formatting codes, novelWriter allows for comments, a synopsis tag, and a set of +In addition to formatting codes, novelWriter allows for comments, a synopsis tag, and a number of keyword and value sets used for :term:`tags` and :term:`references`. There are also some codes that apply to whole paragraphs. See :ref:`a_fmt_text` for more details. @@ -35,7 +35,7 @@ have a distinct colour, and the references themselves will get a colour if they references will get a squiggly error line underneath. The same applies to duplicate tags. There are a number of syntax highlighter colour themes available, both for light and dark GUIs. You -can select them from :guilabel:`Preferences`. +can select them from **Preferences**. .. _a_fmt_head: @@ -54,6 +54,9 @@ correctly to produce the intended result. See :ref:`a_struct_heads` for more det ``# Title Text`` Heading level one. For novel documents, the level indicates the start of a new partition. + Partitions are for when you want to split your story into "Part 1", "Part 2", etc. You can also + choose to use them for splitting the text up into acts, and then hide these headings in your + manuscript. ``## Title Text`` Heading level two. For novel documents, the level indicates the start of a new chapter. Chapter @@ -62,16 +65,17 @@ correctly to produce the intended result. See :ref:`a_struct_heads` for more det ``### Title Text`` Heading level three. For novel documents, the level indicates the start of a new scene. Scene numbers or scene separators can be inserted automatically when building the manuscript, so you - can use the title field as a working title for your scenes if you wish. + can use the title field as a working title for your scenes if you wish, but you must provide a + minimal title. ``#### Title Text`` Heading level four. For novel documents, the level indicates the start of a new section. Section titles can be replaced by separators or ignored completely when building the manuscript. -For headings level one through three, adding a ``!`` modifies its meaning: +For headings level one through three, adding a ``!`` modifies the meaning of the heading: ``#! Title Text`` - This tells the build tool that the level one heading is intended to be used for the novel's or + This tells the build tool that the level one heading is intended to be used for the novel or notes folder's main title, like for instance on the front page. When building the manuscript, this will use a different styling and will exclude the title from, for instance, a Table of Contents in Libre Office. @@ -82,9 +86,10 @@ For headings level one through three, adding a ``!`` modifies its meaning: :ref:`a_struct_heads_unnum` for more details. ``###! Title Text`` - This is an alternative scene heading that can be formatted differently in the - :guilabel:`Manuscript Build` tool. It is intended for separating "soft" and "hard" scene breaks. - Otherwise, it behaves identically to a regular scene heading. + This is an alternative scene heading that can be formatted differently in the **Manuscript + Build** tool. It is intended for separating "soft" and "hard" scene breaks. Aside from this, it + behaves identically to a regular scene heading. See :ref:`a_struct_heads_scenes` for more + details. .. note:: The space after the ``#`` or ``!`` character is mandatory. The syntax highlighter will change @@ -106,8 +111,8 @@ In addition, the editor supports a few additional types of white spaces: * Thin spaces are also supported, and can be inserted with :kbd:`Ctrl+K`, :kbd:`Shift+Space`. * Non-breaking thin space can be inserted with :kbd:`Ctrl+K`, :kbd:`Ctrl+Space`. -These are all insert features, and the :guilabel:`Insert` menu has more. The keyboard shortcuts for -them are also listed in :ref:`a_kb_ins`. +These are all insert features, and the **Insert** menu has more. The keyboard shortcuts for them +are also listed in :ref:`a_kb_ins`. Non-breaking spaces are highlighted by the syntax highlighter with an alternate coloured background, depending on the selected theme. @@ -129,12 +134,12 @@ A minimal set of Markdown text emphasis styles are supported for text paragraphs The text is rendered as emphasised text (italicised). ``**text**`` - The text is rendered as strongly important text (bold). + The text is rendered as strongly emphasised text (bold). ``~~text~~`` Strike through text. -In Markdown guides it is often recommended to differentiate between strong importance and emphasis +In Markdown guides it is often recommended to differentiate between strong emphasis and emphasis by using ``**`` for strong and ``_`` for emphasis, although Markdown generally also supports ``__`` for strong and ``*`` for emphasis. However, since the differentiation makes the highlighting and conversion significantly simpler and faster, in novelWriter this is a rule, not just a @@ -182,14 +187,15 @@ solved with simple Markdown-like formatting codes. Available shortcodes are list "``[i]text[/i]``", "Text is rendered as italicised text." "``[s]text[/s]``", "Text is rendered as strike through text." "``[u]text[/u]``", "Text is rendered as underlined text." + "``[m]text[/m]``", "Text is rendered as highlighted text." "``[sup]text[/sup]``", "Text is rendered as superscript text." "``[sub]text[/sub]``", "Text is rendered as subscript text." Unlike Markdown style codes, these can be used anywhere within a paragraph. Even in the middle of a word if you need to. You can also freely combine them to form more complex formatting. -The shortcodes are available from the :guilabel:`Format` menu and in the editor toolbar, which can -be activated by clicking the three dots in the editor header. +The shortcodes are available from the **Format** menu and in the editor toolbar, which can be +activated by clicking the left-most icon button in the editor header. .. versionadded:: 2.2 @@ -199,30 +205,39 @@ be activated by clicking the three dots in the editor header. Comments and Synopsis ===================== -In addition to these standard Markdown features, novelWriter also allows for comments in documents. -The text of a comment is ignored by the word counter. The text can also be filtered out when -building the manuscript or viewing the document. +In addition to the above formatting features, novelWriter also allows for comments in documents. +The text of a comment is always ignored by the word counter. The text can also be filtered out +when building the manuscript or viewing the document. -If the first word of a comment is ``Synopsis:`` (with the colon included), the comment is treated -in a special manner and will show up in the :ref:`a_ui_outline` in a dedicated column. The word -``synopsis`` is not case sensitive. If it is correctly formatted, the syntax highlighter will -indicate this by altering the colour of the word. +The first word of a comment, followed by a colon, can be one of a small set of modifiers that +indicates the comment is intended for a specific purpose. For instance, if the comment starts with +``Synopsis:``, the comment is treated in a special manner and will show up in the +:ref:`a_ui_outline` in a dedicated column. The word ``synopsis`` is not case sensitive. If it is +correctly formatted, the syntax highlighter will indicate this by altering the colour of the word. -``% text ...`` +The different styles of comments are as follows: + +``% Comment text ...`` This is a comment. The text is not rendered by default (this can be overridden), seen in the - document viewer, or counted towards word counts. + document viewer, or counted towards word counts. It is intended for you to make notes in your + text for your own sake, whatever that may be, that isn't part of the story text. This is the + general format of a comment. -``%Synopsis: text ...`` +``%Synopsis: Comment text ...`` This is a synopsis comment. It is generally treated in the same way as a regular comment, except that it is also captured by the indexing algorithm and displayed in the :ref:`a_ui_outline`. It can also be filtered separately when building the project to for instance generate an outline document of the whole project. -``%Short: text ...`` +``%Short: Comment text ...`` This is a short description comment. It is identical to the synopsis comment (they are interchangeable), but is intended to be used for project notes. The text shows up in the - Reference panel below the document viewer in the last column labelled - :guilabel:`Short Description`. + Reference panel below the document viewer in the last column labelled **Short Description**. + +``%~ Comment text ...`` + This can be used to exclude story text from your manuscript without having to delete it from + your text. Comments with the ``~`` will *never* be included in the manuscript, even if you have + chosen to include comments in it. That is the main difference between these two formats. .. note:: Only one comment can be flagged as a synopsis or short comment for each heading. If multiple @@ -245,14 +260,14 @@ heading. Setting it multiple times under the same heading will just override the A tag keyword followed by the tag value, like for instance the name of a character. References can be set anywhere within a section, and are collected according to their category. -References are in the form: +References are on the form: -``@keyword: value`` +``@keyword: value1, value2, ..., valueN`` A reference keyword followed by a value, or a comma separated list of values. Tags and references are covered in detail in the :ref:`a_references` chapter. The keywords can be -inserted at the cursor position in the editor via the :guilabel:`Insert` menu. If you start typing -an ``@`` on a new line, and auto-complete menu will also pop up suggesting keywords. +inserted at the cursor position in the editor via the **Insert** menu. If you start typing an ``@`` +on a new line, and auto-complete menu will also pop up suggesting keywords. .. _a_fmt_align: @@ -260,8 +275,8 @@ an ``@`` on a new line, and auto-complete menu will also pop up suggesting keywo Paragraph Alignment and Indentation =================================== -All documents have the text by default aligned to the left or justified, depending on your -settings in :guilabel:`Preferences`. +All documents have the text by default aligned to the left or justified, depending on your setting +in **Preferences**. You can override the default text alignment on individual paragraphs by specifying alignment tags. These tags are double angle brackets. Either ``>>`` or ``<<``. You put them either before or after @@ -296,6 +311,10 @@ Examples: Vertical Space and Page Breaks ============================== +You can apply page breaks to partition, chapter and scene headings for novel documents from the +**Manuscript Build** tool. If you need to add a page break or additional vertical spacing in other +places, there are special codes available for this purpose. + Adding more than one line break between paragraphs will **not** increase the space between those paragraphs when building the project. To add additional space between paragraphs, add the text ``[vspace]`` on a line of its own, and the build tool will insert a blank paragraph in its place. @@ -303,13 +322,8 @@ paragraphs when building the project. To add additional space between paragraphs If you need multiple blank paragraphs just add a colon and a number to the above code. For instance, writing ``[vspace:3]`` will insert three blank paragraphs. -Normally, the manuscript build tool will insert a page break before all headings of level one and -for all headings of level two for novel documents, i.e. chapters, but not for project notes. - -If you need to add a page break somewhere else, put the text ``[new page]`` on a line by itself -before the text you wish to start on a new page. - -If you want page breaks for scenes and sections, you must add them manually. +If you need to add a page break somewhere, put the text ``[new page]`` on a line by itself before +the text you wish to start on a new page. .. note:: The page break code is applied to the text that follows it. It adds a "page break before" mark @@ -325,8 +339,8 @@ If you want page breaks for scenes and sections, you must add them manually. [vspace:2] This is another text paragraph, but there will be two empty paragraphs - in-between them. + between them. [new page] - This text will always start on a new page if the build format has pages. + This text will start on a new page if the build format has pages. diff --git a/docs/source/usage_project.rst b/docs/source/usage_project.rst index 76bccb48..fceca8b5 100644 --- a/docs/source/usage_project.rst +++ b/docs/source/usage_project.rst @@ -8,7 +8,7 @@ This chapter covers in more detail the different project views available in nove .. figure:: images/fig_project_tree_detailed.png - The Project Tree as it appears when loading a sample project. + The **Project Content** tree as it appears when loading a sample project. .. _a_ui_tree: @@ -21,33 +21,32 @@ the project, and has four columns. **Column 1** The first column shows the icon and label of each folder, document, or note in your project. The - label is not the same as the title you set inside the document. However, the document's label - will appear in the header above the document text itself so you know where in the project an - open document belongs. The icon is selected based on the type of item, and for novel documents, - the level of the first header in the document text. + label is not the same as the heading title you set inside the document. However, the document's + label will appear in the header above the document text itself so you know where in the project + an open document belongs. The icon is selected based on the type of item, and for novel + documents, the level of the first heading in the document text. **Column 2** The second column shows the word count of the document, or the sum of words of the child items for folders and documents with sub-documents. If the counts seem incorrect, they can be updated - by rebuilding the :term:`project index` from the :guilabel:`Tools` menu, or by pressing - :kbd:`F9`. + by rebuilding the :term:`project index` from the **Tools** menu, or by pressing :kbd:`F9`. **Column 3** The third column indicates whether the document is considered active or inactive in the project. You can use this flag to indicate that a document is still in the project, but should not be - considered an active part of it. When you run the :guilabel:`Build Manuscript` tool, you can - include or exclude documents based on this flag. You can change this value from the + considered an active part of it. When you run the **Build Manuscript** tool, you can include or + exclude documents based on this flag. You can change this value from the right-click :term:`context menu`. **Column 4** The fourth column shows the user-defined status or importance labels you've assigned to each project item. See :ref:`a_ui_tree_status` for more details on how to uses these labels. You can - change these labels from the :term:`context menu`. + select these labels from the :term:`context menu`, and define them in **Project Settings**. Right-clicking an item in the project tree will open a context menu under the cursor, displaying a selection of actions that can be performed on the selected item. -At the top of the tree, you will find a set of buttons. +At the top of the project tree, you will find a set of buttons. * The first button is a quick links button that will show you a dropdown menu of all the :term:`root folders` in your project. Selecting one will move to that position in @@ -73,10 +72,10 @@ addition to the word count. Splitting and Merging Documents ------------------------------- -Under the :guilabel:`Transform` submenu in the context menu of an item in the project tree, you -will find several options on how to change a document or folder. This includes changing between -document and note, but also splitting them into multiple documents, or merging child items into a -single document. +Under the **Transform** submenu in the context menu of an item in the project tree, you will find +several options on how to change a document or folder. This includes changing between document and +note, but also splitting them into multiple documents, or merging child items into a single +document. Splitting Documents @@ -84,12 +83,12 @@ Splitting Documents .. figure:: images/fig_project_split_tool.png - The :guilabel:`Split Document` dialog. + The **Split Document** dialog. -The :guilabel:`Split Document by Heading` option will open a dialog that allows you to split the -selected document into multiple new documents based on the headings it contains. You can select at -which heading level the split is to be performed from the dropdown box. The list box will preview -which headings will be split into new documents. +The **Split Document by Headings** option will open a dialog that allows you to split the selected +document into multiple new documents based on the headings it contains. You can select at which +heading level the split is to be performed from the dropdown box. The list box will preview which +headings will be split into new documents. You are given the option to create a folder for these new documents, and whether or not to create a hierarchy of documents. That is, put sections under scenes, and scenes under chapters. @@ -103,18 +102,18 @@ Merging Documents .. figure:: images/fig_project_merge_tool.png - The :guilabel:`Merge Documents` dialog. + The **Merge Documents** dialog. You have two options for merging documents that are child elements of another document. You can -either :guilabel:`Merge Child Items into Self` and :guilabel:`Merge Child Items into New`. The -first option will pull all content of child items and merge them into the parent document, while -the second option will create a new document in the process. +either **Merge Child Items into Self** and **Merge Child Items into New**. The first option will +pull all content of child items and merge them into the parent document, while the second option +will create a new document in the process. When merging documents in a folder, you only have the latter process is possible, so only the -choice :guilabel:`Merge Documents in Folder` is available. +choice **Merge Documents in Folder** is available. -In either case, the :guilabel:`Merge Documents` dialog will let you exclude documents you don't -want to include, and it also lets you reorder them if you wish. +In either case, the **Merge Documents** dialog will let you exclude documents you don't want to +include, and it also lets you reorder them if you wish. .. _a_ui_tree_status: @@ -124,14 +123,14 @@ Document Importance and Status Each document or folder in your project can have either a "Status" or "Importance" flag set. These are flags that you control and define yourself, and novelWriter doesn't use them for anything. To -modify the labels, go to their respective tabs in :guilabel:`Project Settings`. +modify the labels, go to their respective tabs in **Project Settings**. The "Status" flag is intended to tag a :term:`novel document` as for instance a draft or as completed, and the "Importance" flag is intended to tag character notes, or other :term:`project notes`, as for instance a main, major, or minor character or story element. Whether a document uses a "Status" or "Importance" flag depends on which :term:`root folder` it -lives in. If it's in a Novel type folder, it uses the "Status" flag, otherwise it uses an +lives in. If it's in a **Novel** type folder, it uses the "Status" flag, otherwise it uses an "Importance" flag. @@ -142,7 +141,7 @@ Project Tree Drag & Drop The project tree allows drag & drop to a certain extent to allow you to reorder your documents and folders. Moving a document in the project tree will affect the text's position when you assemble -your manuscript in the :guilabel:`Manuscript Build` tool. +your manuscript in the **Manuscript Build** tool. .. versionadded:: 2.2 You can now select multiple items in the project tree by holding down the :kbd:`Ctrl` or @@ -150,14 +149,15 @@ your manuscript in the :guilabel:`Manuscript Build` tool. You can drag and drop documents and regular folders, but not root folders. If you select multiple items, they can only be dragged and dropped if they are siblings. That is, they have the same -parent item in the project. This is due to the way drag and drop is implemented in the user -interface framework novelWriter is built upon. +parent item in the project. This limitation is due to the way drag and drop is implemented in the +user interface framework novelWriter is built upon. -Documents and their folders can be rearranged freely within their root folders. If you move a Novel -document out of a Novel folder, it will be converted to a project note. Notes can be moved freely -between all root folders, but keep in mind that if you move a note into a Novel type root folder, -its "Importance" setting will be switched with a "Status" setting. See :ref:`a_ui_tree_status`. The -old value will not be overwritten though, and should be restored if you move it back at some point. +Documents and their folders can be rearranged freely within their root folders. If you move a +**Novel Document** out of a **Novel** folder, it will be converted to a **Project Note**. Notes can +be moved freely between all root folders, but keep in mind that if you move a note into a **Novel** +type root folder, its "Importance" setting will be switched with a "Status" setting. See +:ref:`a_ui_tree_status`. The old value will not be overwritten though, and should be restored if +you move it back at some point. Root folders in the project tree cannot be dragged and dropped at all. If you want to reorder them, you can move them up or down with respect to each other from the arrow buttons at the top of the @@ -175,8 +175,8 @@ The Novel Tree View An alternative way to view the project structure is the novel view. You can switch to this view by selecting the :guilabel:`Novel View` button in the sidebar. This view is a simplified version of -the view in the :guilabel:`Outline View`. It is convenient when you want to browse the structure -of the story itself rather than the document files. +the view in the **Outline View**. It is convenient when you want to browse the structure of the +story itself rather than the document files. .. note:: You cannot reorganise the entries in the novel view, or add any new documents, as that would @@ -194,14 +194,14 @@ The Novel Outline View A screenshot of the Novel Outline View. -The project's :guilabel:`Novel Outline View` is available as another view option from the sidebar. -The outline provides an overview of the novel structure, displaying a tree hierarchy of the -elements of the novel, that is, the level 1 to 4 headings representing partitions, chapters, scenes -and sections. +The project's **Novel Outline View** is available as another view option from the sidebar. The +outline provides an overview of the novel structure, displaying a tree hierarchy of the elements of +the novel, that is, the level 1 to 4 headings representing partitions, chapters, scenes and +sections. The document containing the heading can also be displayed as a separate column, as well as the line number where the heading is defined. Double-clicking an entry will open the corresponding document -in the editor and switch to :guilabel:`Project Tree View` mode. +in the editor and switch to **Project Tree View** mode. You can select which novel folder to display from the dropdown menu. You can optionally also choose to show a combination of all novel folders. @@ -217,7 +217,7 @@ the menu button in the toolbar. The order of the columns can also be rearranged a different position. You column settings are saved between sessions on a per-project basis. .. note:: - The :guilabel:`Title` column cannot be disabled or moved. + The **Title** column cannot be disabled or moved. The information viewed in the outline is based on the :term:`project index`. While novelWriter does its best to keep the index up to date when contents change, you can always rebuild it manually by @@ -226,5 +226,5 @@ pressing :kbd:`F9` if something isn't right. The outline view itself can be regenerated by pressing the refresh button. By default, the content is refreshed each time you switch to this view. -The :guilabel:`Synopsis` column of the outline view takes its information from a specially -formatted comment. See :ref:`a_fmt_comm`. +The **Synopsis** column of the outline view takes its information from a specially formatted +comment. See :ref:`a_fmt_comm`. diff --git a/docs/source/usage_shortcuts.rst b/docs/source/usage_shortcuts.rst index af54254b..a8f8163f 100644 --- a/docs/source/usage_shortcuts.rst +++ b/docs/source/usage_shortcuts.rst @@ -20,22 +20,22 @@ Main Window Shortcuts :header: "Shortcut", "Description" ":kbd:`F1`", "Open the online user manual" - ":kbd:`F5`", "Open the :guilabel:`Build Manuscript` tool" - ":kbd:`F6`", "Open the :guilabel:`Writing Statistics` tool" - ":kbd:`F8`", "Toggle :guilabel:`Focus Mode`" + ":kbd:`F5`", "Open the **Build Manuscript** tool" + ":kbd:`F6`", "Open the **Writing Statistics** tool" + ":kbd:`F8`", "Toggle **Focus Mode**" ":kbd:`F9`", "Re-build the project's index" ":kbd:`F11`", "Toggle full screen mode" - ":kbd:`Ctrl+,`", "Open the :guilabel:`Preferences` dialog" + ":kbd:`Ctrl+,`", "Open the **Preferences** dialog" ":kbd:`Ctrl+E`", "Switch focus to the document editor" ":kbd:`Ctrl+T`", "Switch or toggle focus for the project tree or novel view" ":kbd:`Ctrl+Q`", "Exit novelWriter" - ":kbd:`Ctrl+Shift+,`", "Open the :guilabel:`Project Settings` dialog" + ":kbd:`Ctrl+Shift+,`", "Open the **Project Settings** dialog" ":kbd:`Ctrl+Shift+O`", "Open the Welcome dialog to open or create a project" ":kbd:`Ctrl+Shift+S`", "Save the current project" ":kbd:`Ctrl+Shift+T`", "Switch focus to the outline view" ":kbd:`Ctrl+Shift+W`", "Close the current project" ":kbd:`Shift+F1`", "Open the local user manual (PDF) if it is available" - ":kbd:`Shift+F6`", "Open the :guilabel:`Project Details` dialog" + ":kbd:`Shift+F6`", "Open the **Project Details** dialog" .. _a_kb_tree: @@ -53,8 +53,8 @@ Project Tree Shortcuts ":kbd:`Alt+Left`", "Jump to the parent item in the tree" ":kbd:`Alt+Right`", "Jump to the first child item in the project tree" ":kbd:`Ctrl+.`", "Open the context menu on the selected item" - ":kbd:`Ctrl+L`", "Open the :guilabel:`Quick Links` menu" - ":kbd:`Ctrl+N`", "Open the :guilabel:`Create New Item` menu" + ":kbd:`Ctrl+L`", "Open the **Quick Links** menu" + ":kbd:`Ctrl+N`", "Open the **Create New Item** menu" ":kbd:`Ctrl+O`", "Open the selected document in the editor" ":kbd:`Ctrl+R`", "Open the selected document in the viewer" ":kbd:`Ctrl+Up`", "Move selected item one step up in the tree" @@ -75,11 +75,12 @@ Text Search Shortcuts :header: "Shortcut", "Description" ":kbd:`F3`", "Find the next occurrence of the search word" - ":kbd:`Ctrl+F`", "Open the search bar and search for the selected word, if any is selected" + ":kbd:`Ctrl+F`", "Open search and look for the selected word" ":kbd:`Ctrl+G`", "Find the next occurrence of the search word" - ":kbd:`Ctrl+H`", "Open the search tool and populate with the selected word (Mac :kbd:`Cmd+=`)" - ":kbd:`Ctrl+Shift+1`", "Replace selected occurrence of the search word, and move to the next" + ":kbd:`Ctrl+H`", "Open replace and look for the selected word (Mac :kbd:`Cmd+=`)" + ":kbd:`Ctrl+Shift+1`", "Replace selected occurrence, and move to the next" ":kbd:`Ctrl+Shift+G`", "Find the previous occurrence of the search word" + ":kbd:`Ctrl+Shift+F`", "Open project search and look for the selected word" ":kbd:`Shift+F3`", "Find the previous occurrence of the search word" @@ -91,8 +92,8 @@ Text Formatting Shortcuts ":kbd:`Ctrl+'`", "Wrap selected text, or word under cursor, in single quotes" ":kbd:`Ctrl+""`", "Wrap selected text, or word under cursor, in double quotes" - ":kbd:`Ctrl+/`", "Toggle block format as comment for block under cursor, or selected text" - ":kbd:`Ctrl+0`", "Remove block formatting for block under cursor, or selected text" + ":kbd:`Ctrl+/`", "Toggle comment format for block or selected text" + ":kbd:`Ctrl+0`", "Remove format for block or selected text" ":kbd:`Ctrl+1`", "Change block format to heading level 1" ":kbd:`Ctrl+2`", "Change block format to heading level 2" ":kbd:`Ctrl+3`", "Change block format to heading level 3" @@ -102,11 +103,11 @@ Text Formatting Shortcuts ":kbd:`Ctrl+7`", "Change block alignment to right-aligned" ":kbd:`Ctrl+8`", "Add a left margin to the block" ":kbd:`Ctrl+9`", "Add a right margin to the block" - ":kbd:`Ctrl+B`", "Format selected text, or word under cursor, with strong emphasis (bold)" + ":kbd:`Ctrl+B`", "Format selected text, or word under cursor, with bold" ":kbd:`Ctrl+D`", "Format selected text, or word under cursor, with strike through" - ":kbd:`Ctrl+I`", "Format selected text, or word under cursor, with emphasis (italic)" - ":kbd:`Ctrl+Shift+/`", "Remove block formatting for block under cursor, or selected text" - ":kbd:`Ctrl+Shift+D`", "Toggle block format as ignored text for block under cursor, or selected text" + ":kbd:`Ctrl+I`", "Format selected text, or word under cursor, with italic" + ":kbd:`Ctrl+Shift+/`", "Remove format for block or selected text" + ":kbd:`Ctrl+Shift+D`", "Toggle ignored text format for block or selected text" Other Editor Shortcuts diff --git a/docs/source/usage_typography.rst b/docs/source/usage_typography.rst index e96d6185..189e0dd1 100644 --- a/docs/source/usage_typography.rst +++ b/docs/source/usage_typography.rst @@ -11,7 +11,7 @@ Typographical Notes novelWriter has some support for typographical symbols that are not usually easily available in many text editors. This includes for instance the proper unicode quotation marks, dashes, ellipsis, -thin spaces, etc. All these symbols are available from the :guilabel:`Insert` menu, and via +thin spaces, etc. All these symbols are available from the **Insert** menu, and via keyboard shortcuts. See :ref:`a_kb_ins`. This chapter provides some additional information on how novelWriter handles these symbols. @@ -43,22 +43,22 @@ Single and Double Quotes All the different quotation marks listed on the `Quotation Mark`_ Wikipedia page are available, and can be selected as auto-replaced symbols for straight single and double quote key strokes. The -settings can be found in :guilabel:`Preferences`. +settings can be found in **Preferences**. Ordinarily, text wrapped in quotes are highlighted by the editor. This is meant as a convenience for highlighting dialogue between characters. This feature can be disabled in -:guilabel:`Preferences` if this feature isn't wanted. +**Preferences** if this feature isn't wanted. The editor distinguishes between text wrapped in regular straight double quotes and the user-selected double quote symbols. This is to help the writer recognise which parts of the text -are not using the chosen quote symbols. Two convenience functions in the :guilabel:`Format` menu +are not using the chosen quote symbols. Two convenience functions in the **Format** menu can be used to re-format a selected section of text with the correct quote symbols. Single and Double Prime ------------------------ -Both single and double prime symbols are available in the :guilabel:`Insert` menu. These symbols +Both single and double prime symbols are available in the **Insert** menu. These symbols are the correct symbols to use for unit symbols for feet, inches, minutes, and seconds. The usage of these is described in more detail on the Wikipedia Prime_ page. They look very similar to single and double straight quotes, and may be rendered similarly by the font, but they have different @@ -79,7 +79,7 @@ right single quotation marks, depending on the font. There is a Wikipedia articl `Modifier letter apostrophe`_ with more details. .. note:: - On export with the :guilabel:`Build Manuscript` tool, these apostrophes will be replaced + On export with the **Build Manuscript** tool, these apostrophes will be replaced automatically with the corresponding right hand single quote symbol as is generally recommended. Therefore it doesn't really matter if you only use them to correct syntax highlighting. diff --git a/docs/source/usage_writing.rst b/docs/source/usage_writing.rst index d9d6400f..a1b59c67 100644 --- a/docs/source/usage_writing.rst +++ b/docs/source/usage_writing.rst @@ -23,13 +23,14 @@ having it selected. This will open the document in the document editor. The edit Markdown-like syntax for some features, and a novelWriter-specific syntax for others. The syntax format is described in the :ref:`a_fmt` chapter. -The editor has a maximise button (toggles the :guilabel:`Focus Mode`) and a close button in the +The editor has a maximise button, which toggles the **Focus Mode**, and a close button in the top--right corner. On the top--left side you will find a tools button that opens a toolbar with a -few buttons for applying text formatting, and a search button to open the search dialog. +few buttons for applying text formatting, a drop down menu for navigating between headings, and a +search button to open the search dialog. Both the document editor and viewer will show the label of the currently open document in the header at the top of the edit or view panel. Optionally, the full project path to the document can -be shown. This can be set in :guilabel:`Preferences`. +be shown. This can be set in **Preferences**. .. tip:: Clicking on the document title bar will select the document in the project tree and thus reveal @@ -42,10 +43,10 @@ the label and pressing :kbd:`Ctrl+Return`. You can also control-click them with Editor Auto-Completer --------------------- -If you type the character ``@`` on a new line, a menu will appear showing the different available -keywords. The list will shorten as you type. Once a keyword command has been selected or typed, the -editor may suggest further content based on your project content. See :ref:`a_references_completer` -for more details. +If you type the character ``@`` on a new line, a pop-up menu will appear showing the different +available keywords. The list will shorten as you type. Once a keyword command has been selected or +typed, the editor may suggest further options based on your project content. See +:ref:`a_references_completer` for more details. .. versionadded:: 2.2 @@ -60,9 +61,9 @@ Viewing a Document A screenshot of the Document Viewer panel. Any document in the project tree can also be viewed in parallel in a right hand side document -viewer. To view a document, press :kbd:`Ctrl+R`, or select :guilabel:`View Document` in the menu or -context menu. If you have a middle mouse button, middle-clicking on the document will also open it -in the viewer. +viewer. To view a document, press :kbd:`Ctrl+R`, or select **View Document** in the menu or context +menu. If you have a middle mouse button, middle-clicking on the document will also open it in the +viewer. The document viewed does not have to be the same document as the one currently being edited. However, If you *are* viewing the same document, pressing :kbd:`Ctrl+R` again will update the @@ -75,19 +76,20 @@ content of the viewer with the content of the document the reference points to. The document viewer keeps a history of viewed documents, which you can navigate with the arrow buttons in the top--left corner of the viewer. If your mouse has backward and forward navigation buttons, these can be used as well. They work just like the backward and forward features in a -browser. +browser. The left-most button is a dropdown menu for quickly navigation between headings in the +document. -At the bottom of the view panel there is a :guilabel:`References` panel. (If it is hidden, click -the button on the left side of the footer area to reveal it.) This panel contains a References tab -with links to all documents referring back to the one you're currently viewing, if any has been -defined. If you have created root folders and tags for various story elements like characters and -plot points, these will appear as additional tabs in this panel. +At the bottom of the view panel there is a **References** panel. (If it is hidden, click the button +on the left side of the footer area to reveal it.) This panel contains a References tab with links +to all documents referring back to the one you're currently viewing, if any has been defined. If +you have created root folders and tags for various story elements like characters and plot points, +these will appear as additional tabs in this panel. .. note:: - The :guilabel:`References` panel relies on an up-to-date :term:`index` of the - project. The index is maintained automatically. However, if anything is missing, or seems wrong, - the index can always be rebuilt by selecting :guilabel:`Rebuild Index` from the - :guilabel:`Tools` menu, or by pressing :kbd:`F9`. + The **References** panel relies on an up-to-date :term:`index` of the project. + The index is maintained automatically. However, if anything is missing, or seems wrong, the + index can always be rebuilt by selecting **Rebuild Index** from the **Tools** menu, or by + pressing :kbd:`F9`. .. versionadded:: 2.2 The reference panel was redesigned and the additional tabs added. @@ -131,8 +133,7 @@ Auto-Replace as You Type ======================== A few auto-replace features are supported by the editor. You can control every aspect of the -auto-replace feature from :guilabel:`Preferences`. You can also disable this feature entirely if -you wish. +auto-replace feature from **Preferences**. You can also disable this feature entirely if you wish. .. tip:: If you don't like auto-replacement, all symbols inserted by this feature are also available in