diff --git a/docs/source/interface.txt b/docs/source/interface.txt index 6a077c44..f0231ad2 100644 --- a/docs/source/interface.txt +++ b/docs/source/interface.txt @@ -1,6 +1,6 @@ -############## +*************** User Interface -############## +*************** The user interface is kept as simple as possible to avoid distractions. The main window contains a tree vew pane with the entire structure of the project, and a small details panel below it to display additional information. @@ -11,9 +11,8 @@ This will open the source editor which uses a simplified markdown format describ The document can also be viewed as html with all the comments and commands stripped out. To view a document, simply press Ctrl+R or select a file and go to :menuselection:`Document --> View Document` in the menu. The document viewed does not need to be the same document currently being edited. -*************** Markdown Format -*************** +=============== the document editor uses a simplified markdown format. That is, it supports basic formatting like bold, italics and underline, as well as four levels of headings. @@ -24,7 +23,7 @@ The editor also has a minimal set of commands used for setting tags and referenc .. csv-table:: Formatting Syntax :header: "Format", "Description" - :widths: 15, 70 + :widths: 15, 50 "``# Title``", "Heading level one. The space after the # is mandatory." "``## Title``", "Heading level two. The space after the # is mandatory." @@ -36,16 +35,15 @@ The editor also has a minimal set of commands used for setting tags and referenc "``% text...``", "A comment. The text is not exported, seen in viewer, or counted towards word counts." "``@keyword: value``", "A keyword argument followed by a value, or a comma separated list of values." -****************** Keyboard Shortcuts -****************** +================== All features are available as keyboard shortcuts. These are as following: .. csv-table:: Keyboard Shortcuts :header: "Shortcut", "Description" - :widths: 15, 70 + :widths: 15, 50 ":kbd:`Ctrl-.`", "Correct word under cursor." ":kbd:`Ctrl-1`", "Switch focus to tree view pane." diff --git a/docs/source/introduction.txt b/docs/source/introduction.txt index 78d01174..f52a0e8f 100644 --- a/docs/source/introduction.txt +++ b/docs/source/introduction.txt @@ -1,6 +1,6 @@ -############ +************ Introduction -############ +************ novelWriter is a simple multi-document plain text editor using a modified markdown syntax to apply simple formatting. Additional features are available diff --git a/docs/source/notes.txt b/docs/source/notes.txt index ef477191..77a152f8 100644 --- a/docs/source/notes.txt +++ b/docs/source/notes.txt @@ -1,14 +1,13 @@ -######################## +************************ Supporting Files (Notes) -######################## +************************ Supporting files, or notes, are any files stored in root folders that are not the Novel root folder. These files are intended for summaries and outlines of the various plot elements, characters, locations, and so on, of the novel. These are not required, but making at least minimal files for each such element makes it possible to use the timeline view feature to see how each element intersects with each section of the novel itself. -********* File Tags -********* +========= Each note file can have a tag associated with it, The format of a tag is ``@tag: tagname``, where tagname is a unique identifier. diff --git a/docs/source/projects.txt b/docs/source/projects.txt index 1fb63392..4766e133 100644 --- a/docs/source/projects.txt +++ b/docs/source/projects.txt @@ -1,6 +1,6 @@ -############## +************** Novel Projects -############## +************** A novelWriter project requires a dedicated folder for storing its files. See the Technical Information section for further details. @@ -11,9 +11,8 @@ A list of recently opened projects is also maintained and can be selected from t The project specific settings are available in :menuselection:`Project --> Project Settings`. See further details below. -***************** Project Structure -***************** +================= Projects are structured into a set of root folders, visible in the left side tree view panel. @@ -38,7 +37,7 @@ Deleted files will be moved into a special "Trash" root folder. Currently, these files cannot be permanently deleted from the project. Orphaned Documents -================== +------------------ In the event the editor crashes or otherwise exits without saving the project state, files that have been added to the project tree and are saved to disk will appear in a special "Orphaned Items" root folder next time the application is started. These orphaned files will not have any meta data associated with them, so the title and other information has to be set again, and the files moved back to the correct location in the project. @@ -46,15 +45,14 @@ Using Project Folders Folders, aside from root folders, have no structural significance to the project. They are there purely as a way for the user to organise the files in meaningful sections and to be able to close them in the tree view. When processing the files in the novel, the folders are ignored. -**************** Project Settings -**************** +================ The project settings can be accessed from the :menuselection:`Project --> Project Settings` menu entry. This will open a dialog box. Settings Tab -============ +------------ The Settings tab holds the project title and author settings. Working Title can be set to a different title than the Book Title. @@ -65,7 +63,7 @@ The Book Authors text box takes one author per line. The line breaks matter in that this is converted to a list for later correct formatting. Status Tab -========== +---------- Each file of type NOVEL can be given a status level, signified by a coloured icon. These are purely there for the user's convenience, and you are not required to use them for any other feature to work. @@ -74,7 +72,7 @@ The intention is to use this list to set what stage of writing you are on, altho Note that status levels currently in use by a file cannot be deleted. Importance Tab -============== +-------------- Each file of types PLOT, CHARACTER, WORLD, TIMELINE, OBJECT or CUSTOM can be given an importance level, signified by a coloured icon like for status level. These are also purely there for the user's convenience, and you are not required to use them for any other feature to work. @@ -84,7 +82,7 @@ Again, these can in principle be used for whatever you want. Note that importance levels currently in use by a file cannot be deleted. Auto-Replace Tab -================ +---------------- A set of automatically replaced keywords can be added in this tab. The keywords in the left column wile be replaced by the text in the right column when documents are opened in the viewer. @@ -94,9 +92,8 @@ Note that a keyword cannot contain any spaces. The angle brackets are added by default, and when used in the text are a part of the keyword to be replaced. This is to ensure that parts of the text isn't unintentionally replaced by the content of the list. -************* Writing Files -************* +============= New document files can be created from the Document menu, or by pressing Ctrl+N while in the tree view pane. This will create a new, empty file, and open the item settings dialog where the filename and various other settings can be set. @@ -104,9 +101,8 @@ This dialog can also be opened again later from either the menu, :menuselection: The different classes of documents have some restrictions. -****** Backup -****** +====== An automatic backup system is built into novelWriter. In order to use it, a backup path to where the backups are to be stored needs to be provided in :menuselection:`Tools --> Preferences`. diff --git a/docs/source/structure.txt b/docs/source/structure.txt index e54dd1e3..f674bd03 100644 --- a/docs/source/structure.txt +++ b/docs/source/structure.txt @@ -1,13 +1,12 @@ -################# +***************** Project Structure -################# +***************** This section concerns files under the Novel type root folder. There are some restrictions and features that only applies to these type of files. -********************** Importance of Headings -********************** +====================== Subfolders under root folders have no impact on the structure of the novel itself. The structure is instead dictated by the heading level. @@ -24,9 +23,8 @@ The different header levels are interpreted as specific section types of the nov * ``### Header3``: Header level 3 signifies a scene level partition. * ``#### Header4``: Header level 4 signifies a sub-scene level partition. -************** Tag References -************** +============== Each section, indicated by a heading, can contain references to tags set in the supporting files of the project. See the File Tags section. @@ -64,9 +62,8 @@ the syntax highlighter will alert the user that only the correct keywords are us If the index of defined tags is out of date, press F9 to regenerate it, or select :menuselection:`Tools --> Rebuild Indices` from the menu. In general, the index for a file is regenerated when a file is saved, so this shouldn't normally be necessary. -***************** Novel File Layout -***************** +================= Files that exist under the NOVEL type root folder can have a number of layouts set. See overview below. diff --git a/docs/source/technical.txt b/docs/source/technical.txt index 88aced07..08b026b0 100644 --- a/docs/source/technical.txt +++ b/docs/source/technical.txt @@ -1,15 +1,14 @@ -##################### +********************* Technical Information -##################### +********************* This section contains details of how novelWriter stores and handles the project data. -****************** How Data is Stored -****************** +================== Main Project File -================= +----------------- The project itself requires a dedicated folder for storing its files. The main project file is stored as an XML file with the name ``nwProject.nwx``. @@ -22,7 +21,7 @@ It is important to keep this file backed up. The project XML file is suitable for diff tools and version control, although a timesetamp is set in the meta section on line 2 each time the file is saved. Project Documents -================= +----------------- The project documents are saved in folders staring with ``data_``. Each document has a file handle taken from the first 13 characters of a SHA256 hash of the system time.