Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
peter88213 committed Jan 9, 2024
1 parent 5a7af27 commit 9518ade
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/help/export_menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,4 +227,4 @@ This will generate a list-formatted HTML file, and launch your system's web brow

---

[<< Previous](project_notes_menu) -- [Next >>](tools_menu)
[<< Previous](project_notes_menu) -- [Next >>](import_menu)
2 changes: 2 additions & 0 deletions docs/help/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,10 @@ With [arcs](arcs), you can link your plot to the narrative.
- **[Characters menu](characters_menu)**
- **[Locations menu](locations_menu)**
- **[Items menu](items_menu)**
- **[Plot menu](plot_menu)**
- **[Project notes menu](project_notes_menu)**
- **[Export menu](export_menu)**
- **[Import menu](import_menu)**
- **[Tools menu](tools_menu)**
- **[Tree view context menu](tree_context_menu)**

Expand Down
14 changes: 14 additions & 0 deletions docs/help/import_menu.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[Project homepage](../index) > [Instructions for use](../usage) > [Online help](help) > Command reference: Import menu

---

# Import menu

**File Import**

---


---

[<< Previous](export_menu) -- [Next >>](tools_menu)
34 changes: 34 additions & 0 deletions docs/help/plot_menu.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
[Project homepage](../index) > [Instructions for use](../usage) > [Online help](help) > Command reference: Plot menu

---

# Plot menu

**Plot elements operation**

---

## Add Arc

**Add a new story arc**

You can add a project note to the tree with **Plot > Add arc**.

- If a item is selected, the new item is placed after the selected one.
- Otherwise, the new item is placed at the first position.
- The new item has an auto-generated title. You can change it in the right pane.

---

## Show plot list

**Show an HTML report with plot elements**

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.
- If needed, you can have your web browser save or print it.

---

[<< Previous](items_menu) -- [Next >>](project_notes_menu)
10 changes: 4 additions & 6 deletions docs/help/project_notes_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*.

# Project notes menu

**Project notes operation**
Expand All @@ -16,9 +14,9 @@

You can add a project note to the tree with **Project notes > Add**.

- If a item is selected, the new item is placed after the selected one.
- Otherwise, the new item is placed at the first position.
- The new item has an auto-generated title. You can change it in the right pane.
- If a project note is selected, the new item is placed after the selected one.
- Otherwise, the new project note is placed at the first position.
- The new project note has an auto-generated title. You can change it in the right pane.

---

Expand All @@ -33,4 +31,4 @@ This will generate a list-formatted HTML file, and launch your system's web brow

---

[<< Previous](items_menu) -- [Next >>](export_menu)
[<< Previous](plot_menu) -- [Next >>](export_menu)

0 comments on commit 9518ade

Please sign in to comment.