Release 1.7 Beta 1 (#1064)

CHANGELOG.md

@@ -1,5 +1,94 @@
 # novelWriter Changelog
 
+## Version 1.7 Beta 1 [2022-05-17]
+
+### Release Notes
+
+This is a beta release of the next release version, and is intended for testing purposes. Please be
+careful when using this version on live writing projects, and make sure you take frequent backups.
+
+Please check the changelog for an overview of changes. The full release notes will be added to the
+final release.
+
+### Detailed Changelog
+
+**Features**
+
+* A simple tool to add Lorem Ipsum placeholder text has been added to the Insert menu. PR #1028.
+* Status and Importance flags can now be reorganised in Project Settings. Issue #1035. PR #1040.
+* It is now possible to create multiple Root Folders of the same kind. This makes it possible to
+  add multiple Novel root folders in a project, for instance. Issue #967. PR #1031.
+* All documents can now be dragged and dropped anywhere in the project tree. The document layout
+  may be converted in the process. PR #1031.
+* Documents in the project tree can now have other documents as child documents. Issue #1002.
+  PR #1047.
+* Folders in the project tree that are not empty, can now be moved to trash. PR #1048.
+* Empty folders are deleted on request, and not moved to trash. Issue #1052. PR #1055.
+
+**User Interface**
+
+* The tabs under the project tree and to the right of the main window have been replaced with a
+  toolbar on the left hand side. The toolbar has a set of buttons to change view between Project,
+  Novel and Outline. The three buttons that were available under the project tree have been moved
+  to the bottom of the new toolbar. Issue #1056. PR #1057.
+* When a document changes from a project document to a note, and back again, the Status flag
+  setting is preserved. Previously, the Importance setting would overwrite it during the
+  conversion. PR #1030.
+* Item labels, Status labels, and other labels on the GUI are now run through a "simplify" function
+  before being accepted. This functions strips out all whitespaces and consecutive whitespaces and
+  replace them with single plain whitespaces. This is a safer format to store in XML, and also
+  makes sure there aren't invisible characters floating around in the labels. PR #1038.
+* Due to the changes to how drag and drop works, there are no longer any restrictions on folders
+  and documents. Only root folders remain restricted in terms of moving. Root folders can only be
+  reordered with the Move Up and Move Down commands. PR #1047.
+* The label for the highlighting of redundant spaces in the Preferences dialog has been updated to
+  better reflect what it does. Issue #1043. PR #1046.
+* The New Project Wizard will now try to check if the path selected for the new project can
+  actually be used before letting the user proceed to the next page. Issue #1058. PR #1062.
+
+**Internationalisation**
+
+* Dutch translations have been added by Martijn van der Kleijn (@mvdkleijn). PR #1027.
+
+**Functionality**
+
+* Documents that are missing in the project index when a project is opened are automatically
+  re-indexed. This also handles cases where the cached index is missing. PR #1039.
+
+**Installation and Packaging**
+
+* Python 3.6 is no longer supported. PR #1004.
+* Ubuntu 18.04 packages will no longer be released, due to dropping Python 3.6. Issue #1005.
+  PR #1014.
+
+**Project File Format**
+
+* The item nodes in the content section of the main project XML file have been compacted. It now
+  consists of a main item node and meta and a name node. All settings have been made attributes of
+  one of these three nodes, except the item label which is the text value of the name node. The
+  file format version has been bumped to 1.4. Issue #995. PR #993.
+* Both Importance and Status flag values are now saved to the project file. This means if a
+  document changes layout, the value is no longer lost. PR #1030.
+
+**Code Improvements**
+
+* The linting settings have been updated to select between mutually exclusive options in
+  pycodestyle. PR #1014.
+* The Tokenizer class has been converted to an abstract base class. PR #1026.
+* The class handling Status and Importance flags has been completely rewritten. The flags are now
+  handled using a unique random key as reference rather than relying on the text of the label
+  itself. This makes it a lot easier to rename them as there is no need to update project items.
+  PR #1034.
+* Many of the decisions regarding where items are allowed to belong has been delegated to the
+  NWItem class that holds the item. Some is also handled by the NWTree class that holds the project
+  tree. A new maintenance function in the NWTree class will also ensure that the meta data of an
+  item is correct and up to date. This is especially important after an item has been moved, but is
+  also checked when items are initially loaded. PRs #1031 and #1054.
+* Item handles are now generated using the standard library random number generator. The new
+  handles have the same format as the old algorithm, so they are compatible. PR #1044.
+
+----
+
 ## Version 1.6.2 [2022-03-20]
 
 ### Release Notes

CREDITS.md

@@ -11,12 +11,14 @@
 
 ## Translations
 
+The default language is English (UK) with English (US) as an option.
+
+* Dutch: Martijn van der Kleijn (@mvdkleijn)
 * French: Jan Lüdke (@jyhelle)
+* Latin American Spanish: Tommy Marplatt (@tmarplatt)
 * Norwegian: Veronica Berglyd Olsen (@vkbo)
 * Portuguese: Bruno Meneguello (@bkmeneguello)
 * Simplified Chinese: Qianzhi Long (@longqzh)
-* Latin American Spanish: Tommy Marplatt (@tmarplatt)
-* Dutch: Martijn van der Kleijn (@mvdkleijn)
 
 ## Libraries
 
@@ -32,7 +34,7 @@ The following libraries are dependencies of novelWriter:
 
 Some of the assets bundled with novelWriter were adapted from the following sources:
 
-* [Typicons](https://github.com/stephenhutchings/typicons.font) icons by Stephen Hutchings (CC BY-SA 4.0)
+* Typicons icons by [Stephen Hutchings](https://github.com/stephenhutchings/typicons.font) (CC BY-SA 4.0)
 * Tomorrow syntax themes by Chris Kempson (MIT License)
 * Owl syntax themes by Sarah Drasner (MIT License)
 * Solarized themes by Ethan Schoonover, added by @nullbasis (MIT License)

novelwriter/__init__.py

@@ -60,9 +60,9 @@
 __author__     = "Veronica Berglyd Olsen"
 __maintainer__ = "Veronica Berglyd Olsen"
 __email__      = "[email protected]"
-__version__    = "1.7-alpha0"
-__hexversion__ = "0x010700a0"
-__date__       = "2022-02-20"
+__version__    = "1.7-beta1"
+__hexversion__ = "0x010700b1"
+__date__       = "2022-05-17"
 __status__     = "Stable"
 __domain__     = "novelwriter.io"
 __url__        = "https://novelwriter.io"

novelwriter/assets/text/release_notes.htm

@@ -2,56 +2,16 @@
 <html>
 <body>
 
-<h2>Release Notes for 1.6</h2>
-<p><i>Released on 20 February 2022</i></p>
+<h2>Release Notes for 1.7 Beta 1</h2>
+<p><i>Released on 17 May 2022</i></p>
 
-<p>This release does not introduce any major new features, but is instead a collection of minor
-improvements and tweaks based on user requests. There are also a number of changes under the hood
-to improve the structure and performance of novelWriter.</p>
-<p><u>Some key improvements to the user interface are:</u></p>
-<p>&#10003; The max text width setting in Preferences now also applies to the document viewer, and
-the setting itself on the Preference dialog has been simplified a bit.</p>
-<p>&#10003; When text is selected in the document editor, the number of words selected is displayed
-in the editor's footer area.</p>
-<p>&#10003; The search tool in the document editor now shows the number of results in the
-document.</p>
-<p>&#10003; The Enter and Ctrl+O keyboard shortcuts should now work the same way in all tree
-views.</p>
-<p>&#10003; It is now possible to set a blank section title format on the Build Novel Project tool
-and get empty paragraphs in the output. Previously, a blank format would just remove the section
-break entirely. This change allows the user to define hard and soft scene breaks using level three
-and four headings. The scene and section titles can be hidden completely with two new switches
-added to the user interface.</p>
-<p><u>Other feature changes include:</u></p>
-<p>&#10003; The project index is now automatically rebuilt in the event it is empty or incomplete
-when the project is opened.</p>
-<p>&#10003; The user can now add their own syntax and GUI theme files in the app folder in their
-user area on the host operating system. Where the custom files must be added is described in the
-documentation.</p>
-<p>&#10003; A Windows installer is yet again provided for novelWriter. If you have novelWriter
-installed using another method, make sure you uninstall it properly first as the two methods are
-not compatible.</p>
-<p>&#10003; Release versions for Ubuntu 21.04 have been dropped, and added for the upcoming Ubuntu
-22.04.</p>
-<p>&#10003; Most translations have been updated. A Dutch translation is in the works.</p>
+<p>This is a beta release of the next release version, and is intended for testing purposes. Please
+be careful when using this version on live writing projects, and make sure you take frequent
+backups.</p>
+<p>Please check the changelog for an overview of changes. The full release notes will be added to
+the final release.</p>
 
 <p><i>See also the <a href="https://github.com/vkbo/novelWriter/releases">Releases</a> page.</i></p>
 
-<h2>Patch Notes</h2>
-
-<h3>Patch 1.6.1 &ndash; 16 March 2022</h3>
-
-<p>This is a bugfix and patch release that fixes two recursion/loop issues. One would potentially
-cause a crash if the window was resized rapidly, and one would cause a hang with certain search
-parameters in the editor's search box. The Latin American Spanish translation has also been
-updated.</p>
-
-<h3>Patch 1.6.2 &ndash; 20 March 2022</h3>
-
-<p>This is a bugfix release that fixes a couple of minor issues. Projects containing one or more
-empty documents would trigger a rebuild of the index each time the project was opened. This has now
-been fixed. Another fix resolves an error message being written to the console logging output when
-a new document was created. Both errors were harmless.</p>
-
 </body>
 </html>

novelwriter/dialogs/about.py

@@ -182,12 +182,12 @@ def _fillAboutPage(self):
             self.tr("Translations"),
             self._wrapTable([
                 ("English", "Veronica Berglyd Olsen"),
+                ("Español Latinoamericano", "Tommy Marplatt"),
                 ("Français", "Jan Lüdke (jyhelle)"),
+                ("Nederlands", "Martijn van der Kleijn"),
                 ("Norsk Bokmål", "Veronica Berglyd Olsen"),
                 ("Português", "Bruno Meneguello"),
                 ("简体中文", "Qianzhi Long"),
-                ("Español Latinoamericano", "Tommy Marplatt"),
-                ("Nederlands", "Martijn van der Kleijn"),
             ])
         )
 

sample/content/636b6aa9b697b.nwd

@@ -7,13 +7,13 @@
 @char: John
 @location: Earth
 
-A scene is defined by a level three heading, like the one at the top of this page. The scene will be assigned to the chapter preceding it in the project tree.
+A scene is defined by a level three heading, like the one at the top of this page. The scene will be assigned to the chapter preceding it in the project tree. The scene document can be sorted after the chapter document, or as a child of the chapter. Both result in the same output in the end, so it is a matter of preference.
 
 Each paragraph in the scene is separated by a blank line. The text supports minimal formatting, like **bold**, _italic_ and **_bold italic_**. You can also ~~strike through~~ text. There is **some support for _nested_ emphasis**, but there are some known limitations. If the syntax highlighter doesn’t show it correctly, the export tool will not either.
 
-In addition, the editor supports automatic formatting of “quotes”, both double and ‘single’. Depending on the syntax highlighter, these can be in different colours. “You can of course use **bold** and _italic_ text inside of quotes too.”
+In addition, the editor supports automatic formatting of “quotes”, both double and ‘single’. Depending on the syntax highlighter settings and colour theme, these can be in different colours. “You can of course use **bold** and _italic_ text inside of quotes too.”
 
-If you have the need for it, you can also add text that can be automatically replaced by other text when you generate a preview or export the project. Now, let’s auto-replace this A with <A>, and this C with <C>. While <E> is just <E>. Press Ctrl+R to see what this looks like in the view pane.
+If you have the need for it, you can also add text that can be automatically replaced by other text when you generate a preview or export the project. Now, let’s auto-replace this A with <A>, and this C with <C>. While <E> is just <E>. Press Ctrl+R to see what this looks like in the view pane. The list of auto-replaced text is sett in Project Settings.
 
 The editor also supports non breaking spaces, and the spell checker accepts long dashes—like this—as valid word separators. Regular dashes are also supported – and can be automatically inserted when typing two hyphens.
 
@@ -25,7 +25,7 @@ If you need to split a scene file up into further pieces, you can do so with the
 
 Both scene and section titles can be left out of the final exported document. The formatting of titles can be selected from the Build Novel Project dialog. You can also have them replaced with scene separators like “* * *”.
 
-#### Text Alignment
+#### Text Alignment and Indentation
 
 The text by default will have the left or justified alignment in the main text files in your project. You can also specify alignment for a specific paragraph by “pushing” it away from an edge with a set of ‘>>’ or ‘<<’ symbols, like so:
 
@@ -35,8 +35,6 @@ This text is left-aligned. <<
 
 >> This text is centred. <<
 
-#### Text Indent
-
 You can indent a paragraph from both the left and right margin with ‘>’ and ‘<’ symbols.
 
 > This paragraph is indented from both the left margin and the right margin. This is useful for when you want to quote a large chunk of text for instance. <

sample/content/6a2d6d5f4f401.nwd

@@ -1,11 +1,11 @@
 %%~name: Chapter One
-%%~path: e7ded148d6e4a/6a2d6d5f4f401
+%%~path: 7031beac91f75/6a2d6d5f4f401
 %%~kind: NOVEL/DOCUMENT
 ## So it Begins
 
 @pov: Jane
 @location: Earth
 
-% Synopsis: We can add a chapter file, but keep the scene files separate. In the chapter file we can set the meta data that applies to the whole chapter if we wish to.
+% Synopsis: We can add a chapter document, but keep the scene files separate. In the chapter document we can set the meta data that applies to the whole chapter if we wish to. You can add the scenes as child documents directly under the chapter.
 
-A chapter can also contain leading text before the first scene.
+A chapter can contain leading text before the first scene, like this piece of text.

sample/content/8a5deb88c0e97.nwd

@@ -1,6 +1,6 @@
 %%~name: Old File
 %%~path: ae9bf3c3ea159/8a5deb88c0e97
-%%~kind: NOVEL/DOCUMENT
+%%~kind: ARCHIVE/DOCUMENT
 ### Discarded Scene
 
-If you have files you no longer want in your main project, you can move them to the “Archive” folder. This is equivalent to turning off the “Include when building project” switch, just that you also put the file away, although the switch can be ignored when building the project, this folder cannot.
+If you have files you no longer want in your main project, you can move them to the “Archive” folder. This is equivalent to turning off the “Include when building project” switch, just that you also put the file away.

sample/content/96b68994dfa3d.nwd

@@ -1,11 +1,11 @@
 %%~name: A Note on Structure
-%%~path: e7ded148d6e4a/96b68994dfa3d
+%%~path: 7031beac91f75/96b68994dfa3d
 %%~kind: NOVEL/NOTE
 # A Note on Structure
 
 This file is just a note. You can save notes anywhere you like in the project tree. Notes can be filtered out when you export the project.
 
-In root folders that isn’t the Novel root folder, you can _only_ add notes. In the Novel root folder, you can choose between a number of layouts. Some of them are just to let yourself know what each file is for.
+In root folders that aren’t the Novel or Archive root folders, you can _only_ add notes. In the Novel and Archive folder you can also add Project Documents, which are the documents that make up your actual story.
 
 ## Headers in Notes
 
@@ -15,8 +15,10 @@ Unlike in novel files, headers in notes have no particular meaning other than vi
 
 The folders in the tree view have no structural meaning other than they’re a way for you to organise your files into groups in whatever way suits you. They are not intended to represent chapters, but you can of course use them for that. If you do, know that you still need to define chapter headers in your structure so novelWriter knows where you want them.
 
+If you do have separate chapter documents, you can always add scene documents as child document of the chapter instead of using folders.
+
 ## Linking Files and Notes
 
-You can link files and notes together by assigning tags to them, and then reference them from other files. The file class of a file determines which reference keywords apply to each file. For instance a file in the Characters root folder can be referenced using either the @char keyword or the @pov keyword.
+You can link project documents and notes together by assigning tags to the notes with the @tag keyword, and then reference them from other files using one of the many reference keywords. The file class of a file determines which reference keywords apply to each file. For instance a file in the Characters root folder can be referenced using either the @char keyword or the @pov keyword.
 
 If you want to see the content of the file the reference points to, you can click Ctrl+Enter with the cursor on top of the reference, and the view pane will show you the file. In the view pane, all references are clickable, so you can navigate further. At the bottom of the view pane, a list of files referencing the one your viewing will appear. This panel updates when you navigate, unless you make it sticky by clicking the sticky checkbox.

sample/content/974e400180a99.nwd

@@ -6,4 +6,4 @@
 
 This is a plain page with some text on it.
 
-If you want the text to start on a fresh page, add the [NEW PAGE] code above the text. You can also add empty paragraphs with the [VSPACE] code.
+If you want the text to start on a fresh page, add the [NEW PAGE] code above the text. You can also add empty paragraphs with the [VSPACE] code. The above code adds two empty paragraphs before the text starts.

sample/content/ba8a28a246524.nwd

@@ -1,9 +1,9 @@
 %%~name: Interlude
-%%~path: e7ded148d6e4a/ba8a28a246524
+%%~path: 7031beac91f75/ba8a28a246524
 %%~kind: NOVEL/DOCUMENT
 ##! Interlude
 
-% Notice that this is a file with the flag ‘N.Un’. The ‘N’ means it’s a novel file, and the ‘Un’ means it’s an unnumbered chapter. Unnumbered chapters can be treated separately from numbered chapters during export. Perfect for when you want to add an interlude, or for a prologue or epilogue.
+% Notice that this document has a title with a ‘!’ in it in addition to the two hash symbols. This means it is an unnumbered chapter. Unnumbered chapters can be treated separately from numbered chapters during export. Perfect for when you want to add an interlude, or for a prologue or epilogue.
 
 I am the very model of a modern Major-General
 I've information vegetable, animal, and mineral