Skip to content

Commit

Permalink
Update help files.
Browse files Browse the repository at this point in the history
  • Loading branch information
peter88213 committed Jan 15, 2024
1 parent 54354f2 commit c043748
Show file tree
Hide file tree
Showing 13 changed files with 145 additions and 212 deletions.
2 changes: 1 addition & 1 deletion docs/help/characters_menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
You can add a character to the tree with **Characters > Add**.

- If a character is selected, the new character is placed after the selected one.
- Otherwise, the new character is placed at the first position.
- Otherwise, the new character is placed at the last position.
- The new character has an auto-generated title. You can change it in the right pane.
- The status of newly created characters is *minor*.

Expand Down
18 changes: 9 additions & 9 deletions docs/help/desktop.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

---


# Desktop overview


Expand All @@ -19,14 +18,15 @@ The project tree in the left pane shows the organization of the project.
- The tree elements are color-coded according to the section type (see [Basic concepts](basic_concepts)). *Normal* type sections are highlighted according to the selected coloring mode (see *Program settings* in the [View menu](view_menu)).
- The order of the columns can be changed (see *Program settings* in the [View menu](tools_menu)).
- Right-clicking on a tree element opens a [context menu](tree_context_menu) with several options.
- The type of chapters and sections, as well as the completion status of the sections are color coded and can be changed via context menu.

---

### Project tree structure

- The **Book** branch contains the parts, chapters, and sections that belong to the novel manuscript.
- The **Characters/Locations/Items** branches contain descriptions of the story world's elements that can be associated with the book's sections.
- The **Arcs** branch contains all *Notes* type parts with chapters and sections intended for the documentation of the story world.
- The **Arcs** branch contains the arcs and Turning points.
- The **Project notes** branch contains all project notes.

---
Expand Down Expand Up @@ -54,13 +54,12 @@ Drag and drop while pressing the **Alt** key. Be aware, there is no "Undo" featu

Select item and hit the **Del** key.

- When deleting a part, chapter oder section, the sections are moved to the _Trash_ chapter at the bottom.
- The _Trash_ chapter is created automatically, if needed.
- When deleting the _Trash_ chapter, all sections are deleted.

- The type of chapters and sections, as well as the completion status of the sections are color coded and can be changed via context menu.
- Within chapters, sections of the same type and with the same viewpoint can be joined.
- "Notes" and "To do" type chapters can be exported to a separate ODT document.
- Parts and chapters are deleted.
- Sections are marked "unused" and moved to the "Trash" chapter.
- Deleting a part has no effect on its subordinate chapters.
- Deleting a chapter moves its sections to the "Trash" chapter.
- The "Trash" chapter is created automatically, if needed.
- When deleting the "Trash" chapter, all its sections are deleted.

---

Expand All @@ -80,6 +79,7 @@ The **Content viewer** in the middle pane shows the part/chapter/section content
---

## Properties

The **Properties** in the right pane show properties/metadata of the element selected in the project tree.

- You can open or close the element properties window with **View > Toggle Properties** or **Ctrl-Alt-T**.
Expand Down
108 changes: 17 additions & 91 deletions docs/help/export_menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

---

**NOTE:** This help page applies to *novelyst* and is not yet updated for *noveltree*.

# Export menu

**File export**
Expand All @@ -13,82 +11,36 @@
## Manuscript for editing

This will write parts, chapters, and sections into a new OpenDocument
text document (odt) with invisible chapter and section sections (to be
seen in the Navigator). File name suffix is `_manuscript`.
text document (odt) split into sections (to be seen in the Navigator).
File name suffix is `_manuscript_tmp`.

- Only "normal" chapters and sections are exported. Chapters and
sections marked "unused", "todo" or "notes" are not exported.
- Comments within sections are written back as section titles
if surrounded by `~`.
- Comments in the text bracketed with slashes and asterisks (like
`/* this is a comment */`) are converted to author's comments.
sections marked "unused" are not exported.
- Section titles are invisible, but appear in the *Navigator*.
- Chapters and sections can neither be rearranged nor deleted.
- With *OpenOffice/LibreOffice Writer*, you can split sections by inserting headings or a section divider:
- *Heading 1* → New part title. Optionally, you can add a description, separated by `|`.
- *Heading 2* → New chapter title. Optionally, you can add a description, separated by `|`.
- `###` → Section divider. Optionally, you can append the
section title to the section divider. You can also add a description, separated by `|`.
- **Note:** Export documents with split sections from *Writer* to *noveltree* not more than once.
- Paragraphs starting with `> ` are formatted as quotations.
- **Note:** Documents with split sections are automatically discarded after the *noveltree* project is updated.
- Text markup: Bold and italics are supported. Other highlighting such
as underline and strikethrough are lost.


---

## Notes chapters for editing

This will write "Notes" parts and chapters with child sections into a new
OpenDocument text document (odt) with invisible chapter and section
sections (to be seen in the Navigator). File name suffix is `_notes`.

- Comments within sections are written back as section titles
if surrounded by `~`.
- Chapters and sections can neither be rearranged nor deleted.
- With *OpenOffice/LibreOffice Writer*, you can split sections by inserting headings or a section divider:
- *Heading 1* → New part title. Optionally, you can add a description, separated by `|`.
- *Heading 2* → New chapter title. Optionally, you can add a description, separated by `|`.
- `###` → Section divider. Optionally, you can append the
section title to the section divider. You can also add a description, separated by `|`.
- **Note:** Export documents with split sections from *Writer* to *noveltree* not more than once.
- Paragraphs starting with `> ` are formatted as quotations.
- Text markup: Bold and italics are supported. Other highlighting such
as underline and strikethrough are lost.

---

## Todo chapters for editing

This will write "Todo" parts and chapters with child sections into a new
OpenDocument text document (odt) with invisible chapter and section
sections (to be seen in the Navigator). File name suffix is `_todo`.

- Comments within sections are written back as section titles
if surrounded by `~`.
- Chapters and sections can neither be rearranged nor deleted.
- With *OpenOffice/LibreOffice Writer*, you can split sections by inserting headings or a section divider:
- *Heading 1* → New part title. Optionally, you can add a description, separated by `|`.
- *Heading 2* → New chapter title. Optionally, you can add a description, separated by `|`.
- `###` → Section divider. Optionally, you can append the
section title to the section divider. You can also add a description, separated by `|`.
- **Note:** Export documents with split sections from *Writer* to *noveltree* not more than once.
- Paragraphs starting with `> ` are formatted as quotations.
- Text markup: Bold and italics are supported. Other highlighting such
as underline and strikethrough are lost.

---

## Manuscript with visible structure tags for proof reading

This will write parts, chapters, and sections into a new OpenDocument
text document (odt) with visible section markers. File name suffix is
`_proof`.
`_proof_tmp`.

- Only "normal" chapters and sections are exported. Chapters and
sections marked "unused", "todo" or "notes" are not exported.
- Sections beginning with `<HTML>` or `<TEX>` are not exported.
sections marked "unused" are not exported.
- The document contains chapter and section headings. However, changes will not be written back.
- The document contains section `[ScID:x]` markers.
- The document contains section `[scx]` markers.
**Do not touch lines containing the markers** if you want to
be able to write the document back to *noveltree* format.
- Chapters and sections can neither be rearranged nor deleted.
Expand All @@ -97,7 +49,7 @@ text document (odt) with visible section markers. File name suffix is
- *Heading 2* → New chapter title. Optionally, you can add a description, separated by `|`.
- `###` → Section divider. Optionally, you can append the
section title to the section divider. You can also add a description, separated by `|`.
- **Note:** Export documents with split sections from *Writer* to *noveltree* not more than once.
- **Note:** Documents with split sections are automatically discarded after the *noveltree* project is updated.
- Text markup: Bold and italics are supported. Other highlighting such
as underline and strikethrough are lost.

Expand All @@ -111,26 +63,15 @@ text document (odt).
- The document is placed in the same folder as the project.
- Document's **filename**: `<project name>.odt`.
- Only "normal" chapters and sections are exported. Chapters and
sections marked "unused", "todo" or "notes" are not exported.
- Comments in the text bracketed with slashes and asterisks (like
`/* this is a comment */`) are converted to author's comments.
- Comments with special marks (like `/*@en this is an endnote. */`)
are converted into footnotes or endnotes. Markup:
- `@fn*` -- simple footnote, marked with an astersik
- `@fn` -- numbered footnote
- `@en` -- numbered endnote
- Gobal variables and project variables are not resolved.
sections marked "unused" are not exported.
- Part titles appear as first level heading.
- Chapter titles appear as second level heading.
- Section titles appear as navigable comments pinned to the beginning of
the section.
- Sections are separated by `* * *`. The first line is not
indented.
- Starting from the second paragraph, paragraphs begin with
indentation of the first line.
- Sections marked "attach to previous section" appear like
continuous paragraphs.
- Paragraphs starting with `> ` are formatted as quotations.
- Text markup: Bold and italics are supported. Other highlighting such
as underline and strikethrough are lost.

Expand All @@ -142,8 +83,7 @@ This will write a brief synopsis with part, chapter, and sections titles into a
OpenDocument text document. File name suffix is `_brf_synopsis`.

- Only "normal" chapters and sections are exported. Chapters and
sections marked "unused", "todo" or "notes" are not exported.
- Titles of sections beginning with `<HTML>` or `<TEX>` are not exported.
sections marked "unused" are not exported.
- Part titles appear as first level heading.
- Chapter titles appear as second level heading.
- Section titles appear as plain paragraphs.
Expand All @@ -166,14 +106,6 @@ references are:

---

## Obfuscated text for word count

This will generate a text file (txt) containing all "normal" sections
(without headings), where the characters are replaced with "x".
It generates the same word count as you see displayed in *noveltree*.

---

## Characters/locations/items data files

This will create a set of XML files containing the project's characters,
Expand All @@ -188,20 +120,14 @@ in the **Characters**, **Locations**, or **Items** menu.

## Plot description (export only)

This will write plot-defining "Todo" parts and chapters into a new
This will write the plot-defining elements into a new
OpenDocument text document (odt). File name suffix is `_plot`.

The document contains:

- "Todo" chapters within the narrative part (titles and descriptions).
- Part titles (first level heading, only if the part's first chapter defines an arc)
- Arc titles (second level heading)
- Arc descriptions
- Point titles (third level heading)
- Links to the associated section, if any
- Point descrptions.
- Point contents.

- First and second level stages (titles and descriptions).
- Arcs (titles and descriptions).
- Turning points (titles, descriptions, and links to the associated section, if any).

---

Expand All @@ -210,7 +136,7 @@ The document contains:
**Export an ODS document**

This will generate a new OpenDocument spreadsheet (ods) containing sections,
arcs, plot structure, and plot points. File name suffix is `_plotlist`.
arcs, and turning points. File name suffix is `_plotlist`.
The spreadsheet is not meant to be written back to *noveltree*.

- There are hyperlinks to the sections in the manuscript, and to the chapters in the plot description.
Expand All @@ -219,7 +145,7 @@ The spreadsheet is not meant to be written back to *noveltree*.

## Show Plot list

Show sections, arcs, plot structure, and plot points.
Show sections, arcs, and turning points.
This will generate a list-formatted HTML file, and launch your system's web browser for displaying it.

- The Report is a temporary file, auto-deleted on program exit.
Expand Down
64 changes: 46 additions & 18 deletions docs/help/file_menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

---

**NOTE:** This help page applies to *novelyst* and is not yet updated for *noveltree*.

# File menu

**File operation**
Expand All @@ -14,9 +12,45 @@

**Create a new novel project**

- You can create a new project with **File > New** or **Ctrl-N**. This will close the current project
and open a file dialog asking for the location and file name of the project to create.
- Once you specified a valid file path, a blank project appears. Be aware, it's not saved on disk yet.
- You can create a new project with **File > New** or **Ctrl-N**. This will open a submenu.

**Note:** The submenu can be extended by plugins to add more file types from which a *noveltree* project can be created.

---

### Empty project

- This will close the current project and create a blank project.
- This project is not yet saved on disc. When saving manually (see below), a file dialo will open and ask for a locantion and file name.

---

### Create from ODT...

- This will close the current project and open a file dialog asking for an ODT document to create the new projec from.
- The newly created project is saved automatically in the same directory as the ODT document, using its file name and the extension *.novx*.
- If a project with the same file name as the ODT document already exists, no new project will be created.
- If you select a previously exported document belonging to an existing project, this project will be updated and loaded.
- The ODT document can either be a **work in progress** i.e. a regular novel manuscript with chapter headings and section contents,
or an **outline**, containing the chapter and section structure with titles and descriptions.

#### How to set up a work in progress for import

A work in progress has no third level heading.

- *Heading 1* → New chapter title (beginning a new section).
- *Heading 2* → New chapter title.
- `* * *` → Section divider (not needed for the first section in a chapter).
- All other text is considered section content.

#### How to set up an outline for import

An outline has at least one third level heading.

- *Heading 1* → New chapter title (beginning a new section).
- *Heading 2* → New chapter title.
- *Heading 3* → New section title.
- All other text is considered to be chapter/section description.

---

Expand Down Expand Up @@ -51,15 +85,13 @@

## Refresh tree

**Update the project structure after making changes**
**Enforce tree refresh after making changes**

You can refresh the tree with **File > Refresh tree** or **F5**.

You can synchronize the tree with the project structure with **File > Refresh tree** or **F5**.
This ensures for instance,
that sections within a "Notes", "Unused", or "To do" chapter are of the same type after moving them there.
- Refreshing the tree may trigger the "Modified" flag.
- When refreshing the tree, "Normal type" chapters in the *Research* tree are moved to the *Book* tree.
- When refreshing the tree, parts and chapters are renumbered according to the settings.
- When refreshing the tree, the tree view is reset and the browsing history is cleared.
- "Normal" sections that have been moved to an "Unused" chapter are made "Unused".
- Parts and chapters are renumbered according to the settings.
- The "Trash" chapter is moved to the end of the book, if necessary.

---

Expand Down Expand Up @@ -103,8 +135,6 @@ In case you edit the project "outsides", consider locking it before.

- You can add the *.bak* extension to the current manuscript with **File > Discard manuscript**.
This may help to avoid confusion about changes made with *noveltree* and OpenOffice/LibreOffice.
It is recommended in any case if new sections or chapters were created by splitting during the
last export from OpenOffice/LibreOffice.

---

Expand All @@ -114,8 +144,6 @@ last export from OpenOffice/LibreOffice.

- You can save the project with **File > Save** or **Ctrl-S**.
- If the project has changed on disk since last opened, you will get a warning.
- It is recommended to refresh the tree (see above) before saving. So you can see how
it will look after reloading.

---

Expand All @@ -124,7 +152,7 @@ last export from OpenOffice/LibreOffice.
**Save the project with another file name/at another place**

- You can save the project with another file name/at another place with **File > Save as...** or **Ctrl-Shift-S**. Then a file select dialog opens.
- Your current project remains as saved the last time. Changes since then go to the new project.
- Your current project remains as saved the last time. Changes since then apply to the new project.

---

Expand Down
2 changes: 0 additions & 2 deletions docs/help/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

---

**NOTE:** This help page applies to *novelyst* and is not yet updated for *noveltree*.

# Online help

This page refers to the latest *noveltree* release.
Expand Down
Loading

0 comments on commit c043748

Please sign in to comment.