Update of handbook before its restructuring

docs/_config.yml

@@ -79,7 +79,7 @@ back_to_top: true
 back_to_top_text: "Back to top"
 
 # Footer content appears at the bottom of every page's main content
-footer_content: "Copyright &copy; Audiveris 2023. Distributed under <a href=\"http://www.gnu.org/licenses\">Affero General Public License</a>."
+footer_content: "Copyright &copy; Audiveris 2024. Distributed under <a href=\"http://www.gnu.org/licenses\">Affero General Public License</a>."
 
 # Color scheme currently only supports "dark" or nil (default)
 color_scheme: nil
@@ -138,45 +138,61 @@ java_version: 17
 tesseract_version: 5.3.1
 
 # File menu paths
-file_input:         <code>File → Input</code>
+file_input:         <a href="/audiveris/_pages/menus/file/#input"><code>File → Input</code></a>
 
 # Book menu paths
-book_split:         <code>Book → Split and merge</code>
-book_parameters:    <code>Book → Set book parameters</code>
-book_transcribe:    <code>Book → Transcribe book</code>
-book_swap:          <code>Book → Swap book sheets</code>
-book_select:        <code>Book → Select sheets</code>
-book_export:        <code>Book → Export book</code>
-book_stop:          <code>Book → Stop book transcription</code>
-book_save:          <code>Book → Save book</code>
-book_close:         <code>Book → Close book</code>
+book_split:         <a href="/audiveris/_pages/menus/book/#split-and-merge"><code>Book → Split and merge</code></a>
+book_parameters:    <a href="/audiveris/_pages/menus/book/#set-book-parameters"><code>Book → Set book parameters</code></a>
+book_transcribe:    <a href="/audiveris/_pages/menus/book/#transcrive-book"><code>Book → Transcribe book</code></a>
+book_swap:          <a href="/audiveris/_pages/menus/book/#swap-book-sheets"><code>Book → Swap book sheets</code></a>
+book_select:        <a href="/audiveris/_pages/menus/book/#select-sheets"><code>Book → Select sheets</code></a>
+book_export:        <a href="/audiveris/_pages/menus/book/#export-book"><code>Book → Export book</code></a>
+book_stop:          <a href="/audiveris/_pages/menus/book/#stop-book-transcription"><code>Book → Stop book transcription</code></a>
+book_save:          <a href="/audiveris/_pages/menus/book/#save-book"><code>Book → Save book</code></a>
+book_close:         <a href="/audiveris/_pages/menus/book/#close-book"><code>Book → Close book</code></a>
 
 # Sheet menu paths
-sheet_repetitive:   <code>Sheet → Toggle repetitive input</code>
-sheet_transcribe:   <code>Sheet → Transcribe sheet</code>
-sheet_status:       <code>Sheet → Current status</code>
-sheet_scaling:      <code>Sheet → Set scaling data</code>
-sheet_scale_plots:  <code>Sheet → Display scale plots</code>
-sheet_binary:       <code>Sheet → Display binary</code>
+sheet_repetitive:   <a href="/audiveris/_pages/menus/sheet/#toggle-repetitive-input"><code>Sheet → Toggle repetitive input</code></a>
+sheet_transcribe:   <a href="/audiveris/_pages/menus/sheet/#transcribe-sheet"><code>Sheet → Transcribe sheet</code></a>
+sheet_status:       <a href="/audiveris/_pages/menus/sheet/#current-status"><code>Sheet → Current status</code></a>
+sheet_scaling:      <a href="/audiveris/_pages/menus/sheet/#set-scaling-data"><code>Sheet → Set scaling data</code></a>
+sheet_scale_plots:  <a href="/audiveris/_pages/menus/sheet/#display-scale-plots"><code>Sheet → Display scale plots</code></a>
+sheet_staves_plots: <a href="/audiveris/_pages/menus/sheet/#display-staves-plots"><code>Sheet → Display staves plots</code></a>
+sheet_stem_plot:    <a href="/audiveris/_pages/menus/sheet/#display-stem-plot"><code>Sheet → Display stem plot</code></a>
+sheet_binary:       <a href="/audiveris/_pages/menus/sheet/#display-binary"><code>Sheet → Display binary</code></a>
+sheet_nostaff:      <a href="/audiveris/_pages/menus/sheet/#display-nostaff"><code>Sheet → Display no-staff</code></a>
 
 # View menu paths
-view_jumbos:        <code>View → Show jumbo inters</code>
-view_voices:        <code>View → Show score voices</code>
-view_errors:        <code>View → Show score errors</code>
-view_selections:    <code>View → Switch selections</code>
-view_layers:        <code>View → Switch layers</code>
-view_slots:         <code>View → Show score slots</code>
-view_annotations:   <code>View → Show annotations</code>
-view_chords:        <code>View → Show chord IDs</code>
-view_parts:         <code>View → Show part names</code>
+view_jumbos:        <a href="/audiveris/_pages/menus/view/#show-jumbo-inters-f7"><code>View → Show jumbo inters</code></a>
+view_voices:        <a href="/audiveris/_pages/menus/view/#show-score-voices-f8"><code>View → Show score voices</code></a>
+view_errors:        <a href="/audiveris/_pages/menus/view/#show-score-errors-f9"><code>View → Show score errors</code></a>
+view_selections:    <a href="/audiveris/_pages/menus/view/#switch-selections-f11"><code>View → Switch selections</code></a>
+view_layers:        <a href="/audiveris/_pages/menus/view/#switch-layers-f12"><code>View → Switch layers</code></a>
+view_slots:         <a href="/audiveris/_pages/menus/view/#show-score-slots"><code>View → Show score slots</code></a>
+view_annotations:   <a href="/audiveris/_pages/menus/view/#show-annotations"><code>View → Show annotations</code></a>
+view_chords:        <a href="/audiveris/_pages/menus/view/#show-chord-ids"><code>View → Show chord IDs</code></a>
+view_parts:         <a href="/audiveris/_pages/menus/view/#show-part-names"><code>View → Show part names</code></a>
 
 # Tools menu paths
-tools_train:        <code>Tools → Train classifier</code>
-tools_memory:       <code>Tools → Memory</code>
-tools_options:      <code>Tools → Options</code>
-tools_advanced:     <code>Tools → Advanced topics</code>
+tools_train:        <a href="/audiveris/_pages/menus/tools/#train-classifier"><code>Tools → Train classifier</code></a>
+tools_memory:       <a href="/audiveris/_pages/menus/tools/#memory"><code>Tools → Memory</code></a>
+tools_options:      <a href="/audiveris/_pages/menus/tools/#options"><code>Tools → Options</code></a>
+tools_advanced:     <a href="/audiveris/_pages/menus/tools/#advanced-topics"><code>Tools → Advanced topics</code></a>
 
 # Help menu paths
-help_handbook:      <code>Help → Handbook</code>
-help_updates:       <code>Help → Check for updates</code>
-help_about:         <code>Help → About</code>
+help_handbook:      <a href="/audiveris/_pages/menus/help/#handbook"><code>Help → Handbook</code></a>
+help_updates:       <a href="/audiveris/_pages/menus/help/#check-for-updates"><code>Help → Check for updates</code></a>
+help_about:         <a href="/audiveris/_pages/menus/help/#about"><code>Help → About</code></a>
+
+# Popup menu paths
+popup_chords:       <a href="/audiveris/_pages/menus/popup/#chords"><code>≡ Chords</code></a>
+popup_inters:       <a href="/audiveris/_pages/menus/popup/#inters"><code>≡ Inters</code></a>
+popup_glyphs:       <a href="/audiveris/_pages/menus/popup/#glyphs"><code>≡ Glyphs</code></a>
+popup_slot:         <a href="/audiveris/_pages/menus/popup/#slot-n-offset"><code>≡ Slot N°</code></a>
+popup_measure:      <a href="/audiveris/_pages/menus/popup/#measure-n"><code>≡ Measure N°</code></a>
+popup_staff:        <a href="/audiveris/_pages/menus/popup/#staff-n"><code>≡ Staff N°</code></a>
+popup_part:         <a href="/audiveris/_pages/menus/popup/#part-n"><code>≡ Part N°</code></a>
+popup_system:       <a href="/audiveris/_pages/menus/popup/#system-n"><code>≡ System N°</code></a>
+popup_page:         <a href="/audiveris/_pages/menus/popup/#page-n"><code>≡ Page N°</code></a>
+popup_score:        <a href="/audiveris/_pages/menus/popup/#score-n"><code>≡ Score N°</code></a>
+popup_extraction:   <a href="/audiveris/_pages/menus/popup/#extraction"><code>≡ Extraction</code></a>

docs/_pages/advanced/cli.md

@@ -4,7 +4,7 @@ title: Command Line Interface
 parent: Advanced Features
 nav_order: 1
 ---
-## Command Line Interface
+# Command Line Interface
 {: .no_toc }
 
 ---
@@ -15,7 +15,7 @@ Table of contents
 {:toc}
 ---
 
-### Syntax
+## Syntax
 
 Note that any argument beginning with the `@` character is considered as the name of a text file
 to be immediately expended _in situ_ (the text file is assumed to contain one argument per line).
@@ -82,46 +82,46 @@ Sheet steps are in order:
     PAGE       : Connect systems within page
 ```
 
-### Arguments
+## Arguments
 
 These are the standard arguments that are listed when the help option is used.
 They are presented here in alphabetical order.
 
-#### -batch
+### -batch
 
 Launches Audiveris without any Graphic User Interface.
 
-#### -export
+### -export
 
 Exports each book music as a MusicXML file.
 
-#### -force
+### -force
 
 Forces reprocessing even if target step has already been reached.  
 This option is effective only when a target step is specified
 (see the `-step` option) or the `-transcribe` option is present.
 
-#### -help
+### -help
 
 Displays the arguments summary as printed above, then exits.
 
-#### -option KEY=VALUE
+### -option KEY=VALUE
 
 Specifies the value of one application option,
 KEY being the qualified name of the option,
 VALUE being the value to assign.
 
 This is the CLI equivalent of the GUI pull-down menu {{ site.tools_options }}.
 
-#### -output DIRNAME
+### -output DIRNAME
 
 Defines the path to the target output folder, that is the precise folder where all output files
 (``.omr``, ``.mxl``, etc) should be stored.
 
 if this option is not present, a default output folder is chosen according to the policy described
 in [Standard folders](../folders/standard.md) section.
 
-#### -playlist FILE.XML
+### -playlist FILE.XML
 
 Loads the provided `.xml` file as a playlist.
 
@@ -133,18 +133,18 @@ If in interactive mode, the loaded playlist is used only to populated and displa
 The user can then review and/or edit the playlist and potentially launch the building of
 the compound book at a desired location.
 
-#### -print
+### -print
 
 Exports each book music as a PDF file.
 
-#### -save
+### -save
 
 Saves each book OMR data to its `.omr` project file as soon as a sheet step is processed
 successfully.
 
 This option is effective only in `-batch` mode.
 
-#### -sheets N M X-Y
+### -sheets N M X-Y
 
 Specifies the IDs of sheets to process.
 
@@ -158,7 +158,7 @@ If no sheet IDs are specified, all (valid) sheets are concerned.
 
 Sheet IDs apply to all books referenced on the command line.
 
-#### -step STEPNAME
+### -step STEPNAME
 
 Specifies a sheet target step.
 
@@ -169,17 +169,17 @@ For any given sheet, if the target step has already been reached, no further pro
 However, if the `-force` option is present, this sheet will be reset to BINARY and then processed
 again to the target step.
 
-#### -transcribe
+### -transcribe
 
 Transcribes each book.
 
-#### `--`
+### `--`
 
 This argument (a double dash: "`--`") is not a real argument _per se_, but merely a delimiter
 so that each following argument in the command line is taken as an input file path
 (even if this argument begins with a `-` character).
 
-#### FILENAME
+### FILENAME
 
 Path to one input file.
 
@@ -188,11 +188,11 @@ as input / output.
 
 For any other extension, the file is considered as an image input file.
 
-### Advanced Arguments
+## Advanced Arguments
 
 These arguments are made available for the advanced user.
 
-#### -annotate
+### -annotate
 
 For each book, populates a Zip archive with images and symbol annotations derived from book Inter
 instances.
@@ -201,14 +201,14 @@ These annotations are meant to populate a dataset for training future Audiveris
 (Page and/or Patch).
 
 
-#### -sample
+### -sample
 
 Populates each book sample repository with samples derived from the book Inter instances.
 
 A book-level repository can be later merged into the global Audiveris sample repository in order
 to prepare a training of Audiveris 5.x Glyph classifier.
 
-#### -run CLASS_NAME
+### -run CLASS_NAME
 Runs the specified Java class on each valid sheet.
 
 CLASS_NAME must be the fully qualified name of a Java class, which must extend the abstract class

docs/_pages/advanced/improve_input.md

@@ -4,7 +4,7 @@ title: Improve Input
 parent: Advanced Features
 nav_order: 3
 ---
-## Improve Input
+# Improve Input
 {: .no_toc }
 
 Sometimes the base image is of rather bad quality.
@@ -19,13 +19,13 @@ Table of contents
 {:toc}
 ---
 
-### Using Gimp
+## Using Gimp
 
 [Contribution by Baruch Hoffart]
 
 Here are some possible improvements using Gimp.
 
-#### Adjust Brightness and Contrast
+### Adjust Brightness and Contrast
 
 The simplest way is to adjust the brightness of an input image.
 Although Audiveris has a very good automatic binarization algorithm, sometimes manual adjustment
@@ -40,7 +40,7 @@ Keep the dark parts black, to get an image like this:
 
 ![](../assets/images/adjust_brightness_2.png)
 
-#### Improve Image using Filters
+### Improve Image using Filters
 
 Have a look at the following image: here we have a lot of noise in the lines and in the bars.
 The transcriptions will have problem to properly detect the bars in such a case.
@@ -66,7 +66,7 @@ Finally use an "unsharp mask" filter with standard deviation set to about 1.0 to
 
 You see that now the noise is almost completely removed.
 
-### Enlarging Low Resolution Scans
+## Enlarging Low Resolution Scans
 
 [Contribution by Ram Kromberg]
 
@@ -85,7 +85,7 @@ It is possible to improve or even entirely overcome such obstacles using super-r
 
 This document will detail an example using free, open-source software that is commonly distributed in Linux distributions. Alternatives for Macintosh and Windows will be mentioned as well.
 
-#### Software Required
+### Software Required
 
 1. _waifu2x_. For the enlargement.
 
@@ -99,7 +99,7 @@ This document will detail an example using free, open-source software that is co
 
 4. Audiveris OMR.
 
-#### Step-by-step
+### Step-by-step
 
 1. In this example we'll be using the [Icelandic national anthem](https://commons.wikimedia.org/wiki/File:Icelandic_national_anthem_sheet_music.gif) as follows:  
 ```bash
@@ -116,7 +116,7 @@ convert "is~.gif" 00.png
 waifu2x-ncnn-vulkan -s 4 -i 00.png -o O4.png
 ```
 
-#### Notes
+### Notes
 
 1. By default, _waifu2x-ncnn-vulkan_ makes use of the GPU. It is possible to force the use of the CPU with the `-g -1` flag and specify the use of more threads with the `-j` flag. e.g. 4 CPU threads: `waifu2x-ncnn-vulkan -g -1 -j 2:4:4 -s 2 -i 00.png -o 04.png`.
 Be advised even low-end GPUs will out-perform the CPU many times over.

docs/_pages/advanced/options.md

@@ -4,7 +4,7 @@ title: Options
 parent: Advanced Features
 nav_order: 4
 ---
-## Options {#options}
+# Options {#options}
 {: .no_toc }
 
 There is (or should be) no hard-coded constant in Audiveris code.
@@ -22,7 +22,7 @@ Table of contents
 1. TOC
 {:toc}
 ---
-### Dialog
+## Dialog
 
 The display below combines a tree of classes on the left side, and a table on the right side,
 where details of the options from the containing classes are available for display and modification.
@@ -61,7 +61,7 @@ number of pixels using the sheet interline scale (42 and 63 on this picture).
 value there.
 The new value applies immediately.
 
-### Options Lifecycle
+## Options Lifecycle
 
 The overriding mechanism is defined as follows, from lower to higher priority:
 

docs/_pages/advanced/plugins.md

@@ -4,7 +4,7 @@ title: Plugins
 parent: Advanced Features
 nav_order: 5
 ---
-## Plugins {#plugins}
+# Plugins {#plugins}
 {: .no_toc }
 
 Many music notation programs, if not all, can import MusicXML files as those exported by Audiveris.
@@ -26,7 +26,7 @@ Table of contents
 {:toc}
 ---
 
-### Use of Plugins
+## Use of Plugins
 
 Once plugins are correctly configured, we can call an external program by selecting the desired one
 in the pull-down `Plugins` menu:
@@ -42,7 +42,7 @@ exists and is up-to-date with the latest score modifications performed manually
 and finally launches the proper external program,
 providing the path to the exported file as an import argument.
 
-### Plugins Configuration
+## Plugins Configuration
 
 We can define one or more plugins, by creating a single XML file, named `plugins.xml`,
 in [Audiveris configuration folder](../folders/essential.md#config-folder).