diff --git a/README.md b/README.md index 7629e567..a69a866b 100644 --- a/README.md +++ b/README.md @@ -85,8 +85,6 @@ For the apt package manager on Debian systems, the following Python3 packages ar These are optional, but recommended: * `python3-enchant` for better spell checking -* `python3-latexcodec` for escaping unicode characters in LaTeX export -* `python3-pypandoc` for additional exports to Word, Open Office, eBooks, etc. Alternatively, the packages can be installed with `pip` by running ``` @@ -99,14 +97,12 @@ You can also do them one at a time, skipping the ones you don't need: python3 -m pip install pyqt5 python3 -m pip install lxml python3 -m pip install pyenchant -python3 -m pip install latexcodec -python3 -m pip install pypandoc ``` -On Windows,`pyenchant` may cause problems. + If no external spell checking tool is installed, novelWriter will use a basic spell checker based on standard Python package `difflib`. -Currently, only English dictionaries are available, but more can be added to the `nw/assets/dict` folder. -See the RADME.md file in that folder for how to generate more dictionaries. -This option is both slow and limited. +Currently, only English dictionaries are available for this spell checker, but more can be added to the `nw/assets/dict` folder. +See the [nw/assets/dict/README.md](README.md) file in that folder for how to generate more dictionaries. +Note that the difflib-based option is both slow and limited. Note: On Windows, make sure Python3 is in your PATH if you want to launch novelWriter from command line. You can also right click the `novelWriter.py` file, create a shortcut, then right click again, select "Properties" and change the target to your python executable and `novelWriter.py`. @@ -118,7 +114,7 @@ C:\...\AppData\Local\Programs\Python\Python38\python.exe novelWriter.py ## Key Features -The text documents of novelWriter uses a format similar to markdown, but with a few extensions and a few omissions. +The text documents of novelWriter use a format similar to markdown, but with a few extensions and a few omissions. Project meta data is stored as XML. ### Colour Themes @@ -129,15 +125,15 @@ The GUI also has an optional dark theme in addition to the default system theme. Note that the dark theme may not render all elements of the GUI as dark colours if you are running an early version of Qt5. This is not due to a bug in novelWriter, but due to the fact that the the styling options in the Qt API in some versions were incomplete. -New themes can easily be added to the `nw/themes` folder. +New themes can easily be added to the `nw/assets/themes` folder. Have a look in the existing folders for examples of how to define the colours. ### Auto-Saving and Document Stats -Open documents and the project file itself is saved regularly on a timer if they have been altered. -The status of this is indicated by two indicators in the right corner of the status bar. -Unsaved changes are in yellow, and saved is indicated by green. -Latest character count, word count, and paragraph count is shown next to these indicators in the status bar. +Open documents and the project file itself is saved regularly on a timer – if they have been altered. +The status of this is indicated by two indicators on the right hand side of the status bar. +Unsaved changes are in yellow, and saved is indicated by green in the default theme. +Latest word count for the document and project is shown next to these indicators in the status bar. The counts are updated regularly, but not as-you-type. ### Easy Organising of Project Files @@ -154,8 +150,8 @@ Headings of level two signify the start of a new chapter. Headings of level three signify the start of a new scene. Headings of level four can be used internally in each scene to separate sections. -Each novel file can be assigned a layout format, which shows up as a flag next to the item in the tree view. -These are mostly to help the user see what they contain, but some of them have impact on the format of the exported document. +Each novel file can be assigned a layout format, which shows up as a flag next to the item in the project tree. +These are mostly to help the user see what they contain, but they also have some impact on the format of the exported document. See the documentation for further details. #### Project Notes @@ -167,12 +163,13 @@ These are optional files. ### Visualisation of Story Elements The different notes can be assigned tags, which the novel files can refer back to using special meta keywords. -Currently, this information can be used to display a Timeline View of the story, showing where each scene connects to the plot, and which characters, etc. occur in them. -Further features using this meta data will be added in the future. +This information can be used to display an outline of the story, showing where each scene connects to the plot, and which characters, etc. occur in them. +In addition, the tags themselves are clickable in the document view pane, and control-clickable in the editor. +They make it possible to quickly navigate between the documents while editing. ## Contribution -If you ant to contribute to novelWriter, please follow the coding convention laid out in the [Style Guide](docs/markdown/style.md). +If you want to contribute to novelWriter, please follow the coding convention laid out in the [Style Guide](docs/markdown/style.md). They broadly follow Python PEP8, but there are a few modifications. ## Screenshot diff --git a/docs/source/export.txt b/docs/source/export.txt index c2240aa5..a125a2a7 100644 --- a/docs/source/export.txt +++ b/docs/source/export.txt @@ -2,18 +2,51 @@ Exporting Projects ################## -The novelWriter project can be exported in various formats using the export tool available from :menuselection:`Project --> Export Project` or by pressing :kbd:`F5`. +The novelWriter project can be exported in various formats using the build tool available from :menuselection:`Project --> Build Project` or by pressing :kbd:`F5`. + +***************** +Header Formatting +***************** + +The titles for the four levels of story structure can be formatted collectively in the export tool. +This is done through a series of keyword-replace steps. + +The keyword ``%title%`` will always be replaced by the text you put after the ``#`` characters in your document. + +The keywords ``%chnum%`` and ``%chnumword%`` is replaced by a number, or a number word, respectively. +The number is incremented by one each time the build tool sees a new heading of level two in a file with layout "Chapter". +If the file has layout "Unnumbered", the counter is not incremented. +the latter is useful for for instance Prologue and Epilogue chapters. + +Likewise, the keywords ``%scnum%`` and ``%scabsnum%`` are number counters for scene files. +These are incremented each time a heading of level three is encountered. +The former keyword is reset to one for each new chapter, while the latter is not reset but counts from first scene encountered. + +If you want to insert a line break in you=r title format, add two backslashes ``%\\%``. + +.. note:: + Header formatting only applies to novel files. + Headings in note files will will be left as-is, but heading levels 1 through 4 are converted to the correct heading level in the respective output formats. + +**************** +Scene Separators +**************** + +If you don't want any titles for your scenes (and for your sections if you have them), you can leave the boxes empty, and an empty paragraph will be inserted between the scenes or sections instead. +Alternatively, if you want a separator between them, like the common "\*\*\*", you can also enter that in the box. +In fact, if the format is a piece of static text, it will always be treated as a separator. ************** File Selection ************** -Which files are selected for export can be controlled from the "Selection" section. -The check box for "Novel files" will select any file that isn't classified as a note. -This is useful when exporting a document containing the novel itself. +Which files are selected for export can be controlled from the options on the left side of the dialog window. +The switch for "Include novel files" will select any file that isn't classified as a note. +The switch for "Include note files" will select any file that is a note. +This is allows for exporting just the novel, just your notes, or both, as you see fit. -It is also possible to select the "Note files" for export, with or without the "Novel files". -Comments can also optionally be included in the export for those formats that supports this. +In addition, you can select to export the synopsis comments, regular comments, keywords, and even exclude the body text itself. +If you for instance want to export a document with an outline of the novel, you can enable keywords and synopsis export and disable body text, thus getting a document with each heading followed by the tags and references and the synopsis. ************** Export Formats @@ -21,71 +54,32 @@ Export Formats Currently, five formats are supported for exporting. +OpenDocument Format +=================== + +This is produces an open document odt file. +The document produced has very little formatting, and may require further editing afterwards. +For a better formatted office document, you may get a better result with exporting to HTML and the import that HTML document in your office word processor. + +PDF Format +========== + +The PDF export is just a shortcut for print to file. + +novelWriter HTML +================ + +The HTML export format writes a single ``.htm`` file with minimal style formatting. +The exported HTML file is suitable for further processing by document conversion tools like Pandoc, for importing in word processors, or for printing from browser. + novelWriter Markdown ==================== This is simply a concatenation of the files selected by the filters. -The files in the project are stacked together in the order they appear in the tree view, with comments, tags, etc. included. +The files in the project are stacked together in the order they appear in the tree view, with comments, tags, etc. included if they are selected. This is a useful format for exporting the project for later import back into novelWriter. Plain Text ========== The plain text export format writes a simple ``.txt`` file without any formatting at all. -Word-wrapping to a fixed column width is supported. -It does, however, respect the centering of text if the :guilabel:`Fixed width` setting is larger than ``0``. - -Markdown -======== - -The markdown export formats writes a file using the valid markdown formats used by novelWriter, and converts comments to preformatted blocks by indenting it with four spaces. -Word-wrapping to a fixed column width is supported. - -HTML5 Document -============== - -The html5 export format writes a single ``.htm`` file with a minimal style settings block. -The style setting block sets a maximum page width of ``768px``. -Comments are exported as indented text boxes with a light yellow background. - -LaTeX Document -============== - -The latex export formats generats a simple ``.tex`` file using a ``report`` document format. -All chapters and sections are exported as unnumbered, and the internal header numbering formatting of novelWriter is used instead. -Word-wrapping to a fixed column width in the LaTeX source is supported. - -***************** -Header Formatting -***************** - -The chapter, scene and section headers for novel files can receive some special treatment using the formats under :guilabel:`Chapter Headings` and :guilabel:`Other Headings`. -The chapters can either be of numbered or unnumbered type, the latter being suitable for prologues, epilogues, interludes, etc. -The headers can be generated using free text in combination with replace tags. -The tooltip will explain which tags are available for each heading type. - -.. note:: - Header formatting only applies to novel files. - Headings in note files will will be left as-is, but heading levels 1 through 4 are converted to the correct heading level in the respective output formats. - -Numbered Chapters -================= - -Numbered chapters can be automatically assigned a number from 1 and upwards. -The number is inserted in place of the ``%num%`` tag. -Alternatively, the number can be translated to a word by using the ``%numword%`` tag. -The word numbers feature is currently only supported in English, and works for the range from "One" to "Nine Hundred and Ninety-Nine". - -Unnumbered Chapters -=================== - -Unnumbered chapters only support the ``%title%`` tag for auto-replacement. - -Scenes and Sections -=================== - -Both scenes and sections support the ``%title%`` tag. -In addition, scenes behave differently than the other headings when the format does not contain any auto-replace tags. -If the text in the box is any static text, the heading formatter will treat it as a scene separator, and insert that text as centred text between scenes, and ignoring the first scene of a chapter if the chapter heading is not followed by any text. - -Leaving these fields blank will disable any output of scene and section headers or separators to the exported file.