- Tesseract *program* vs. Tesseract *library* (linked by Audiveris)
- Tesseract `LSTM` model vs. `legacy` model (the one needed by Audiveris)
- Version of Tesseract language files to be downloaded (4.x)
- `TESSDATA_PREFIX` environment variable (pointing to the local tessdata folder) diff --git a/docs/_pages/main/pipeline.md b/docs/_pages/guides/main/pipeline.md similarity index 74% rename from docs/_pages/main/pipeline.md rename to docs/_pages/guides/main/pipeline.md index 4a350bc88..5f9d5f0a6 100644 --- a/docs/_pages/main/pipeline.md +++ b/docs/_pages/guides/main/pipeline.md @@ -1,26 +1,25 @@ --- layout: default title: Pipeline -parent: Main Features -nav_order: 3 -has_children: true +parent: Main features +nav_order: 1 --- # Pipeline {: .no_toc } --- -{: .no_toc .text-delta } +{: .no_toc .text-epsilon } 1. TOC {:toc} --- -## Global Book Workflow +## Global book workflow When working on a book, the Audiveris V5 OMR engine can process any sheet of the book independently of the others. Only the final gathering of sheets results, which comparatively is a very fast action, is performed at book level. - + The diagram above presents the typical workflow for an example input file, named `foo.pdf`: 1. When opening the `foo.pdf` input file, Audiveris creates a Book instance. @@ -37,22 +36,23 @@ To save on memory, especially during long interactive sessions, we can ask Audiv transparently swap all book sheets to disk (except the current sheet). This is done via the pull-down menu {{ site.book_swap }}. -## Sheet Pipeline +## Sheet pipeline The processing of a given sheet by the OMR engine is done via a pipeline of some 20 steps applied, one after the other, on sheet OMR data. Here below is the sheet pipeline sequence, with the main inputs and outputs of every step: - + {: .note } -Each of these 20 steps is further detailed in dedicated pages below. -There is no need to go through all of them in a first reading of this handbook. -Just keep in mind that the documentation is available and is likely to help -you understand how each of these steps works. +Each of these 20 steps is detailed in the dedicated +[explanation pages](../../explanation/steps/README.md). +There is no need to go through all of them in a first reading of this handbook. +We can just keep in mind that this information is available and is likely to help +us understand how each of these steps works. -## Driving the Pipeline +## Driving the pipeline A sheet step is like a mini-batch applied on the sheet data, and this is the smallest increment that the OMR engine can perform. @@ -61,16 +61,17 @@ In the selected sheet, we can decide to move the pipeline forward until a targe step. To do so, we select the target step in the pull-down `Step` menu: - + Note that selecting the pull-down menu {{ site.sheet_transcribe }} is just another way of selecting the pull-down menu `Step → PAGE`. -Beware that we cannot directly move the pipeline backward. -There are two indirect workarounds: +Be careful, we cannot move the pipeline directly backward. +But there are two indirect workarounds: + * We can select a target step that has already been performed: 1. we are first prompted for confirmation, 2. the sheet data is then reset to its initial status -- the gray image if available, otherwise the binary image, - 3. and all necessary steps are performed up to the target step. -* We can also abandon the book and reload it from a previously saved version. + 3. and all necessary steps are re-performed up to the target step. +* We can also abandon the book and reload it from a previously saved status. diff --git a/docs/_pages/guides/main/preferences.md b/docs/_pages/guides/main/preferences.md new file mode 100644 index 000000000..4d920b992 --- /dev/null +++ b/docs/_pages/guides/main/preferences.md @@ -0,0 +1,74 @@ +--- +layout: default +title: Preferences +parent: Main features +nav_order: 2 +--- + +# Preferences +{: .no_toc } + +The {{ site.tools_preferences }} pull-down menu opens this dialog, +focused on on the handling of a few user preferences. +It operates at a much higher level than the direct handling of application constants. + + + +Beside standard features, the dialog also presents a set of `Advanced Topics` +that impact the Audiveris user interface and thus require an application restart. + +--- +Table of contents +{: .no_toc .text-epsilon } +1. TOC +{:toc} +--- + +## Early steps + +This box allows to define which step is automatically trigerred on an input file. + +## Default plugin + +This allows to interactively choose a new default plugin among the declared ones, +since by default the first declared plugin is set as the default one +(See the [Plugins](./plugins.md) section). + +## Output folder + +These boxes govern where output files are located by default. + +- **Input sibling**: If set, all outputs are stored in the same folder as the input file +(unless the ``-output`` option is specified on the command line). +- **Browse**: Allows to define a default output folder. +- **Separate folders**: If set, all outputs related to a given input file are stored +in a *separate* folder, created according to the input file name without its extension. + +For further explanations, see the section on [Standard folders](../../reference/folders/standard.md). + +## Global font ratio + +The slider allows to select a larger font size used throughout the application views. + +## Locale + +We can pick up a different user language. +As of this writing, the available locales are: +- **en** (English), the default +- **fr** (French), not yet fully implemented...[^locales] + +## Advanced Topics + + Each of these topics can gather several related features. + +* `SAMPLES` deals with sample repositories and classifier training. +* `ANNOTATIONS` deals with the production of symbol annotations. +* `PLOTS` deals with the display of plots for scale, stem, staff or header projections. +* `SPECIFIC_VIEWS` deals with specific sheet tabs (staff free, staff-line glyphs). +* `SPECIFIC_ITEMS` deals with the display of specific items on views (attachments, glyph axis, ...) +* `DEBUG` deals with many debug features (notably browsing the book internal hierarchy). + + Note that an __application restart__ is needed to take any modified selection into account + for these advanced topics, because of the various impacts this implies on many UI elements. + + [^locales]: If you are willing to add another locale, please post a message on the [Audiveris discussion forum](https://github.com/Audiveris/audiveris/discussions). \ No newline at end of file diff --git a/docs/_pages/main/sheet_scale.md b/docs/_pages/guides/main/sheet_scale.md similarity index 88% rename from docs/_pages/main/sheet_scale.md rename to docs/_pages/guides/main/sheet_scale.md index 4d9d16f98..1d3b07613 100644 --- a/docs/_pages/main/sheet_scale.md +++ b/docs/_pages/guides/main/sheet_scale.md @@ -1,14 +1,15 @@ --- layout: default -title: Sheet Scale -parent: Main Features +title: Sheet scale +parent: Main features nav_order: 6 --- -# Sheet Scale +# Sheet scale {: .no_toc } +--- Table of contents -{: .no_toc .text-delta } +{: .no_toc .text-epsilon } 1. TOC {:toc} --- @@ -27,7 +28,7 @@ Here are two examples of such histograms: | Combo histogram | Black histogram | | :---: | :---: | -|  |  | +|  |  | - The combo histogram focuses on the combined length of a black run and its following white run. @@ -70,7 +71,7 @@ Initially, all rows appear in gray, and the data values, if any, are displayed o | Original scaling | Edited scaling | | :---: | :---: | -||| +||| - Pros: - We directly tell the engine which beam thickness to use in this sheet. @@ -86,7 +87,7 @@ A different approach is to provide upfront the OMR engine with a beam thickness #### Interactive mode We can do this using the {{ site.book_parameters }} pull-down menu: - + Here, we have chosen the whole book tab, selected beam specification and entered a thickness value as a number of pixels. @@ -96,7 +97,7 @@ This is generally a good strategy, since often all sheets in a book share the sa and the same beam thickness. If ever we need a different value for a given sheet, we can simply select the related sheet tab -in the ``Book Parameters`` dialog, and enter a specific value for this particular sheet. +in the ``Book parameters`` dialog, and enter a specific value for this particular sheet. Specification value ``0`` has a special meaning, which is: ``no specification``. It can be used at book and/or sheet levels. @@ -114,7 +115,7 @@ It can be used at book and/or sheet levels. When running in batch on a brand new input, we can include this beam specification in the command line arguments, using an option like: -> -option org.audiveris.omr.sheet.Scale.defaultBeamSpecification=10 +> -constant org.audiveris.omr.sheet.Scale.defaultBeamSpecification=10 As opposed to the interactive mode, this batch specification is *not* stored within the book project file. @@ -122,5 +123,5 @@ And we must keep in mind the fact that, in batch, this beam thickness specificat *all* books processed by the current command entered on the command line interface. Similarly, we can notice that there is no beam specification available in the ``Default`` tab -of the ``Book Parameters`` dialog. +of the ``Book parameters`` dialog. Otherwise this hard-coded pixel specification would apply for all books processed from now on... diff --git a/docs/_pages/guides/specific/README.md b/docs/_pages/guides/specific/README.md new file mode 100644 index 000000000..8283eb384 --- /dev/null +++ b/docs/_pages/guides/specific/README.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Specific features +parent: How-to guides +nav_order: 3 +--- +# Specific features + +Aimed at the end user, this chapter gathers features that deserve a specific description. + +These are generally new features and are therefore presented here in reverse chronological order. diff --git a/docs/_pages/specific/bar_repeat.md b/docs/_pages/guides/specific/bar_repeat.md similarity index 72% rename from docs/_pages/specific/bar_repeat.md rename to docs/_pages/guides/specific/bar_repeat.md index 9a691d3dd..bb0ba36c5 100644 --- a/docs/_pages/specific/bar_repeat.md +++ b/docs/_pages/guides/specific/bar_repeat.md @@ -1,34 +1,32 @@ --- layout: default title: Bar Repeat -parent: Specific Features +parent: Specific features nav_order: 5 -has_children: false --- # Bar Repeat {: .no_toc } {: .d-inline-block } -new in 5.3 -{: .label .label-yellow } +since 5.3 +{: .label } A "bar repeat" sign indicates that preceding written measures must be repeated exactly. --- Table of contents -{: .text-delta } - +{: .text-epsilon } 1. TOC {:toc} --- ## Example - + In the example above, we have two systems, the first one with 4 measures #1, #2, #3 and #4 and the second one with 3 measures #5, #6 and #7: -- On first system, measures #2 and #3 contain both a one-bar repeat sign, to repeat measure #1 twice. -- On second system, a two-bar repeat sign appears right above the barline between measures #6 and #7, +- On the first system, the measures #2 and #3 contain both a one-bar repeat sign, to repeat the measure #1 twice. +- On the second system, a two-bar repeat sign appears right above the barline between the measures #6 and #7, to repeat the previous two measures (#4 and #5). We could also encounter a four-bar sign, to repeat the four previous measures. @@ -40,19 +38,19 @@ Since release 5.3, Audiveris OMR engine is able to recognize both: - An optional measure count that can appear above the sign. It should correspond to the count of slashes in the repeat sign. - + ## Editing If needed, we can manually assign or drag these signs from the shape palette, -using the three symbols available in ``Barlines`` set. +using the three symbols available in the ``Barlines`` set. - + The measure count is not mandatory, but can be manually assigned or dragged from the shape palette, -in ``Times`` set. +in the ``Times`` set. - + We can choose a predefined item from the ``Parts`` numbers. diff --git a/docs/_pages/specific/drums.md b/docs/_pages/guides/specific/drums.md similarity index 91% rename from docs/_pages/specific/drums.md rename to docs/_pages/guides/specific/drums.md index b631b72e2..9e02bb5a5 100644 --- a/docs/_pages/specific/drums.md +++ b/docs/_pages/guides/specific/drums.md @@ -1,9 +1,8 @@ --- layout: default title: Drums -parent: Specific Features +parent: Specific features nav_order: 1 -has_children: false --- # Drums {: .no_toc } @@ -11,14 +10,15 @@ has_children: false updated for 5.4 {: .label .label-green} -We owe many thanks to Brian Boe for his decisive contribution to this long-awaited functionality. +We owe many thanks to [Brian Boe] for his decisive contribution to this long-awaited functionality. The first requests for drum notation go back to 2017, see Audiveris [issue #33](https://github.com/Audiveris/audiveris/issues/33). This delay certainly originated in my personal ignorance (Hervé speaking) about this kind of notation. +--- Table of contents -{: .no_toc .text-delta } +{: .no_toc .text-epsilon } 1. TOC {:toc} --- @@ -32,15 +32,16 @@ Since the 5.3 release, Audiveris supports unpitched precussion notation on both as shown in the excerpt below. {: .highlight } -Note this handbook contains a [User editing session](../ui_examples/eyes/README.md) dedicated to this precise score example. +Note this handbook contains a [User editing session](../ui/ui_examples/eyes/README.md) +dedicated to this precise score example. - + 1. Each staff starts with a percussion clef, 2. Each individual instrument is defined by a given head motif at a given line position (drum set mapping). 3. Though not specific to drum notation, we can frequently observe -[multi-measure rests](./multi_rest.md) and [measure-repeat signs](./bar_repeat.md). +[multi-measure rests](./multi_rest.md) as well as [measure-repeat signs](./bar_repeat.md). ## Mandatory processing switches @@ -48,12 +49,12 @@ To be able to transcribe the example above, we have to set two specific processi available in the dialog {{ site.book_parameters }}, in the section named "Staves", one for 1-line and one for 5-line percussion stave sizes: - + In batch mode, we can also set these switches at the command line interface level: -> -option org.audiveris.omr.sheet.ProcessingSwitches.oneLineStaves=true +> -constant org.audiveris.omr.sheet.ProcessingSwitches.oneLineStaves=true -> -option org.audiveris.omr.sheet.ProcessingSwitches.drumNotation=true +> -constant org.audiveris.omr.sheet.ProcessingSwitches.drumNotation=true ## Additional switches @@ -96,7 +97,7 @@ The mapping definition is a list of entries within the containing ``staff`` XML This protected resource is just the *default* mapping: - As an end-user, we can always incrementally override some or all of the default mapping entries, by writing our own entries in a similar but certainly smaller ``drum-set.xml`` file to be located -in theh user ``config`` folder. +in the user ``config`` folder. - To "nullify" an existing default entry, we simply specify a "``null``" value for its "``sound``" attribute. @@ -112,12 +113,12 @@ a simple one-page score. The beginning of the PDF file, downloaded from Redeye Percussion site, is as follows: - + Before launching the OMR engine, we specify book parameters using the {{ site.book_parameters }} dialog: - + Note the specific selections made: - **Music font**: We do need the "JazzPerc" music font family for best efficiency on this example. @@ -128,7 +129,7 @@ Note the specific selections made: And with no additional user action, the raw transcription gives: - + There is one abnormal measure, shown in pink. It is due to a flag mistaken with a black head, something easy to fix. @@ -138,7 +139,7 @@ with the ``HeadsAndDot`` palette in the shape board. For the "``Jazz Perc``" font family and the selected processing switches, this palette provides the following symbols: - + It is organized as follows: - First, the heads part: @@ -323,4 +324,6 @@ via a similar ``drum-set.xml`` file to be located in the user ``config`` folder. ``` -[^playing_signs]: These playing signs are not heads *per se*, they are plain symbols recognized via the glyph classifier during the SYMBOLS step. \ No newline at end of file +[^playing_signs]: These playing signs are not heads *per se*, they are plain symbols recognized via the glyph classifier during the SYMBOLS step. + +[Brian Boe]: https://github.com/brian-math diff --git a/docs/_pages/specific/fingering_plucking.md b/docs/_pages/guides/specific/fingering_plucking.md similarity index 63% rename from docs/_pages/specific/fingering_plucking.md rename to docs/_pages/guides/specific/fingering_plucking.md index 5c30bf35f..f3cc68ff1 100644 --- a/docs/_pages/specific/fingering_plucking.md +++ b/docs/_pages/guides/specific/fingering_plucking.md @@ -1,27 +1,25 @@ --- layout: default title: Fingering and Plucking -parent: Specific Features -nav_order: 8 -has_children: false +parent: Specific features +nav_order: 9 --- # Fingering and Plucking {: .no_toc } {: .d-inline-block } completed in 5.3 -{: .label .label-green } +{: .label } These are technical informations for guitar or similar instrument, to indicate how a note should be played. [Assuming a right-handed person]: - **Fingering** describes the left-hand finger, via a digit number (0, 1, 2, 3, 4) -- **Plucking** describes the right-hand finger, via a letter (``p``, ``i``, ``m``, ``a``) +- **Plucking** describes the right-hand finger, via a letter (`p`, `i`, `m`, `a`) --- Table of contents -{: .text-delta } - +{: .text-epsilon } 1. TOC {:toc} --- @@ -31,29 +29,29 @@ Table of contents Here is an example with fingering indications (in red squares) and plucking indications (in green circles): - + ## Detection The OMR engine must be explicitly told to detect these indications. This can be done via the processing switches in the {{ site.book_parameters }} pull-down menu: - + ## Insertion Regardless of the switches values, we can always manually assign or drag & drop these indications from the shape board: - + | Shape Set | Palette | | :---: | :---: | -| Fingerings |  | -| Pluckings |  | +| Fingerings |  | +| Pluckings |  | ## Export These indications get exported to MusicXML and are thus visible from MuseScore for example: - \ No newline at end of file + \ No newline at end of file diff --git a/docs/_pages/specific/fonts.md b/docs/_pages/guides/specific/fonts.md similarity index 64% rename from docs/_pages/specific/fonts.md rename to docs/_pages/guides/specific/fonts.md index 7156bb2f4..44dcac348 100644 --- a/docs/_pages/specific/fonts.md +++ b/docs/_pages/guides/specific/fonts.md @@ -1,20 +1,20 @@ --- layout: default title: Fonts -parent: Specific Features +parent: Specific features nav_order: 2 -has_children: false --- # Fonts {: .no_toc } {: .d-inline-block } -new in 5.3 -{: .label .label-yellow } +since 5.3 +{: .label } Audiveris uses specific fonts for music symbols and for text symbols. +--- Table of contents -{: .no_toc .text-delta } +{: .no_toc .text-epsilon } 1. TOC {:toc} --- @@ -34,24 +34,24 @@ detect them during the HEADS step. Here below are samples of just two significant head shapes -- black head and cross head -- for each of the available music font families -(**Bravura** (the default), **Finale Jazz** and **Jazz Perc**). +(**Bravura** (the default), **Leland**, **Finale Jazz** and **Jazz Perc**). Pictures are magnified 4 times for a better reading: -| Shape / Font Family | Bravura | Finale Jazz | Jazz Perc | -| :---:| :---:| :---:| :---:| -| **Black Head**
and
**Cross Head** | | | | +| Shape / Font Family | Bravura | Leland | Finale Jazz | Jazz Perc | +| :---:| :---:| :---:| :---:| :---:| +| **Black Head**
and
**Cross Head** | | | | | -Head templates are built upon a specific font: +The head templates are built upon a specific font: - its family is the user-selected music font family, -- its precise size is derived from measured staff interline. +- its precise size is derived from the measured staff interline. {: .important } -Because of the way template matching works, it is critical to carefully check -adequacy between the score input image and the selected font family. -- The major difference is between standard font (Bravura) and jazz fonts (Finale Jazz and Jazz Perc), -especially for all the cross-like shapes. -- Within jazz fonts, Finale Jazz and Jazz Perc differ mainly by their width, and impact -on template matching is more visible on oval-like shapes. +Due to the way template matching works, it is essential to carefully check the match +between the input score image and the selected font family. +- The major difference is between _standard_ fonts (`Bravura` and `Leland`) and _jazz_ fonts +(`Finale Jazz` and `Jazz Perc`), especially for all the cross-like shapes. +- Within the jazz fonts, `Finale Jazz` and `Jazz Perc` differ mainly by their width, +and the impact on template matching is more visible on oval-like shapes. ### Other symbols @@ -62,7 +62,7 @@ With proper training on representative samples, the neural network is able to re regardless of the selected music font family. We can observe its top 5 results in the ``Glyph Classifier`` board. -At this point, you may wonder why this network is not also used for head recognition... +At this point, the reader may wonder why this neural network approach is not also used for head recognition... The reason is the current network needs a glyph to work upon, and there is yet no way to isolate a head glyph *reliably*. [^prototype] @@ -79,6 +79,7 @@ The current family hierarchy is as follows:[^musical_symbols] ``` Bravura + ├── Leland ├── Finale Jazz │ └── Jazz Perc └── Musical Symbols @@ -94,9 +95,9 @@ Since 5.3 release, we can tell Audiveris which text font family to use among the | Sample / Font Family | Sans Serif | Serif | Finale Jazz Text | | :---: | :---: | :---: | :---: | -| Ophelia |||| +| Ophelia |||| -Proper choice of text font family will result in a better consistency between the input image +A proper choice of text font family will result in a better consistency between the input image and its displayed transcription. ## Selection of fonts families @@ -104,18 +105,18 @@ and its displayed transcription. In interactive mode, we can use the {{ site.book_parameters }} dialog in its ``Music font`` and ``Text font`` fields: - + In batch mode, we can make choices on the command line interface. -- For **music**, choice is between *Bravura*, *FinaleJazz* and *JazzPerc*: +- For **music**, choice is between *Bravura*, *Leland*, *FinaleJazz* and *JazzPerc*: ``` --option org.audiveris.omr.ui.symbol.MusicFont.defaultMusicFamily=JazzPerc +-constant org.audiveris.omr.ui.symbol.MusicFont.defaultMusicFamily=JazzPerc ``` - For **text**, choice is between *SansSerif*, *Serif* and *FinaleJazzText*: ``` --option org.audiveris.omr.ui.symbol.TextFont.defaultTextFamily=FinaleJazzText +-constant org.audiveris.omr.ui.symbol.TextFont.defaultTextFamily=FinaleJazzText ``` [^musical_symbols]: The old "Musical Symbols" family has been totally replaced by "Bravura" family. It is kept only for samples generation from old ``.omr`` projects, something the end user can safely ignore. diff --git a/docs/_pages/specific/logical_parts.md b/docs/_pages/guides/specific/logical_parts.md similarity index 88% rename from docs/_pages/specific/logical_parts.md rename to docs/_pages/guides/specific/logical_parts.md index 92c6daf61..04f488cbb 100644 --- a/docs/_pages/specific/logical_parts.md +++ b/docs/_pages/guides/specific/logical_parts.md @@ -1,23 +1,21 @@ --- layout: default title: Logical Parts -parent: Specific Features +parent: Specific features nav_order: 3 -has_children: false --- # Logical Parts {: .no_toc } {: .d-inline-block } -new in 5.3 -{: .label .label-yellow } +since 5.3 +{: .label } Mapping the individual parts of every system in every page to logical parts defined at score level is a topic where we may have to help the OMR engine. --- Table of contents -{: .text-delta } - +{: .text-epsilon } 1. TOC {:toc} --- @@ -40,7 +38,7 @@ the same instrument all along the score. In some cases, from one system to the next, the system composition in terms of physical parts may vary as shown in the following example: - + - System #1: A part made of 2 staves. This part is named "PIANO" in its left margin. - System #2: A part made of 2 staves. No name is indicated but we can easily assume it's still the piano instrument. @@ -58,12 +56,12 @@ Part collation is automatically triggered at the end of score transcription, and before any export to MusicXML. We can also manually trigger parts collation. This is done via a right-click in a score area, which opens a contextual menu as follows: - + To visualize the current mapping, one easy way is to use the {{ site.view_parts }} pull-down menu. This results in: - + Each physical part is prefixed with the name of its corresponding logical part. - System #1 @@ -77,11 +75,11 @@ Each physical part is prefixed with the name of its corresponding logical part. ## Editing of logical parts Still via a right-click in the score area, we can open an editor on logical parts: - + In our example, this editor will open as follows: - + On the left side, we have a sequence of rows, one per logical part: - **Staves**: The physical configuration of staves in part: @@ -108,13 +106,13 @@ to move them up or down, and to save the logicals configuration. For instance, we can decide to name the 1-staff part: "VOICE" to be consistent with the existing "PIANO" name. That's all we need to do, so we save it: - + Notice that the lower-right button (which was "*Unlocked*" in gray) is now "*Locked*" in black. This means that the logicals just saved are now locked (but can be manually unlocked if so desired). Notice also that the main score window now displays the updated parts names: - + ## Unlocked/Locked logicals configuration @@ -155,10 +153,10 @@ If the score gets too complex for the OMR engine, we can always fall back to the manual mapping of any "un-mappable" physical part. This is done via a right-click in the physical part to be manually mapped: - + We simply have to pick up the corresponding logical among the presented sequence of logicals. -See a real-life example in [Can't Take My Eyes Off of You](../ui_examples/eyes/README.md#logical-parts) +See a real-life example in [Can't Take My Eyes Off of You](../ui/ui_examples/eyes/README.md#logical-parts) -[^name_offset]: Created part names are displayed slightly off of the expected vertical location, to avoid hiding any potential existing part name. \ No newline at end of file +[^name_offset]: The created part names are displayed slightly off of the expected vertical location, to avoid hiding any potential existing part name. \ No newline at end of file diff --git a/docs/_pages/guides/specific/metronome.md b/docs/_pages/guides/specific/metronome.md new file mode 100644 index 000000000..a40cf793b --- /dev/null +++ b/docs/_pages/guides/specific/metronome.md @@ -0,0 +1,144 @@ +--- +layout: default +title: Metronome +parent: Specific features +nav_order: -1 +--- +# Metronome +{: .no_toc } +{: .d-inline-block } +new in 5.4 +{: .label .label-yellow } + +The picture below displays a typical metronome mark : + + + +--- +Table of contents +{: .no_toc .text-epsilon } +1. TOC +{:toc} +--- + +## Structure + +From left to right, a metronome mark can contain: [^swing] + +| Mandatory? | Item| +|:---:|:--- | +| - | a tempo textual indication, like "Allegretto quasi andantino" | +| - | an opening parenthesis `(` | +| YES | a beat unit symbol, like "♩"| +| YES | the equal (`=`) character | +| - | some text, like "ca." | +| YES | an integer value | +| - | a minus (`-`) character, followed by a second integer value | +| - | some text, like "env." | +| - | a closing parenthesis `)` | + + + +## Engine recognition + +The OCR can recognize text characters, words and sentences. + +The main problem comes from the *beat unit symbol*, like the quarter symbol in the example above, +because there is no way to make Tesseract OCR recognize this symbol as a known character. [^symbol] + +For the time being, the OMR engine uses a rather acrobatic approach: +1. It looks for an OCR'd sentence which matches a regular expression +crafted for the optional and mandatory items listed above, +2. It isolates the word located just before the `=` character[^colon] and grabs its underlying glyph, +3. It submits this glyph to the glyph classifier, looking for a beat unit symbol. + +If the test is positive, then the sentence is recognized as a metronome sentence. +As any sentence, the metronome mark is made of words, but one of them is special, +it's the beat unit word which contains just the beat unit symbol. + +## MusicXML export + +The various metronome items (textual tempo, beat unit, bpm values, ...) are exported in a MusicXML `direction` element including a `tempo` element. + +The tempo value is the number of *quarters* per minute, which is determined according to: +- The beat unit, +- The number of beats per minute (either the single value or the mean value if two values are found). + +## Manual editing + +In Audiveris, a standard sentence content cannot be edited directly. +The editing can be made at word level only. +But specially for the metronome sentence, editing can be made at both sentence and word levels. + +For instance, we can click on any word of the metronome sentence, it gets displayed in the `Inter` board. +There, we can click on the `To Ensemble` button to get to the containing sentence: the metronome mark. + + + +There, we have a small pane where we can see and directly edit the metronome content. +The field accepts standard cut and paste actions on text and music characters. + +Text can be entered by typing on the keyboard, but music characters are different. +They are displayed in red to make them stand out. + +To enter a beat unit, we use a right-click in the pane. +This opens a popup menu with all the supported beat units: + + + +The selected beat unit is inserted at the current position -- +or replaces the selected characters if any were selected. + +As usual, the modifications get committed when we press the `ENTER` key. +And we can always undo/redo such actions. + +## Changing a sentence to metronome + +The OMR engine may have mis-recognized a metronome mark, and consider it as a **plain sentence**, +for example with a *direction* role. + +In that case, we can simply select this sentence and manually change its **role** to +the `Metronome` role. + +The `Inter` board will consequently display the metronome mark, based on the recognized items. +Typically, we'll have to manually correct or insert items like the beat unit, the `=` character, ... + +The OCR engine may also have totally **ignored the sentence**, for whatever reason. +In that case we can select the sentence (actually we select the underlying glyphs as a whole) +and assign it the Metronome **shape**. +And, here again, we manually correct the metronome mark. + +## Creating from scratch + +We can always create a metronome mark from scratch. + +To do so, we click on the `Texts` set in the shape board, which opens this set as: + + + +This set (new in 5.4) gathers just the text-oriented shapes: `lyric`, (plain) `text` and `metronome`. + +We now can make a drag n' drop from the metronome button to the sheet location of our choice. + +Notice, as we drag away from the `metronome` button and enter the sheet view, +that the "metronome" label is replaced by a metronome symbol: + + + +We can drop the symbol, this creates a **minimum** metronome mark, using default elements, +at the drop location. + +The `Inter` board now displays this minimum metronome mark: + + + +We finally have to modify/augment this basic version to get something more in line with what we want. +For example: + + + +[^swing]: The rhythm-oriented marks, like this one:  are not supported yet. + +[^symbol]: If you know of a way to train Tesseract on beat units, please post a message on the [project discussions](https://github.com/Audiveris/audiveris/discussions). + +[^colon]: The equal character (`=`) is sometimes OCR'd as a colon character (`:`), so the regular expression has been adjusted to also accept the colon character. \ No newline at end of file diff --git a/docs/_pages/specific/multi_rest.md b/docs/_pages/guides/specific/multi_rest.md similarity index 69% rename from docs/_pages/specific/multi_rest.md rename to docs/_pages/guides/specific/multi_rest.md index 91d984b85..567e697a7 100644 --- a/docs/_pages/specific/multi_rest.md +++ b/docs/_pages/guides/specific/multi_rest.md @@ -1,23 +1,21 @@ --- layout: default title: Multi-Measure Rest -parent: Specific Features +parent: Specific features nav_order: 6 -has_children: false --- # Multi-Measure Rest {: .no_toc } {: .d-inline-block } -new in 5.3 -{: .label .label-yellow } +since 5.3 +{: .label } A multiple measure rest indicates a rest of more than one measure. --- Table of contents -{: .text-delta } - +{: .text-epsilon } 1. TOC {:toc} --- @@ -27,7 +25,7 @@ Table of contents It is drawn as a thick horizontal line centered on staff middle line with serifs at both ends, completed by a time-like number drawn above the staff. - + In the example above, we have instances of multiple measure rests, on 5-line and 1-line staves. @@ -41,15 +39,15 @@ together with the related measure count number. If not detected, we can still assign or drag a multiple rest item from the shape palette in its ``Rests`` set: - + A double-click on a multiple rest enters its fairly limited editing status: - Vertically, the item remains stuck to the staff mid-line, - Horizontally, the mid handle can translate the whole item, while a side handle can resize it. - + -As for [bar repeats editing](bar_repeat.md#editing), the measure count item can be assigned -or dragged from the shape palette in its ``Time`` set. +And, as for [bar repeats editing](bar_repeat.md#editing), the measure count item can be assigned +or dragged from the shape palette in its `Times` set. diff --git a/docs/_pages/specific/octave_shift.md b/docs/_pages/guides/specific/octave_shift.md similarity index 82% rename from docs/_pages/specific/octave_shift.md rename to docs/_pages/guides/specific/octave_shift.md index af5254dd5..c72c19d95 100644 --- a/docs/_pages/specific/octave_shift.md +++ b/docs/_pages/guides/specific/octave_shift.md @@ -1,23 +1,21 @@ --- layout: default title: Octave Shift -parent: Specific Features +parent: Specific features nav_order: 4 -has_children: false --- # Octave Shift {: .no_toc } {: .d-inline-block } -new in 5.3 -{: .label .label-yellow } +since 5.3 +{: .label } An octave shift indicates that some notes of a staff should be played one or several octaves higher or lower than actually printed. --- Table of contents -{: .text-delta } - +{: .text-epsilon } 1. TOC {:toc} --- @@ -26,12 +24,12 @@ Table of contents Here is an example of a one-line shift: - + And here is an example of a multi-line shift: We can consider we have one "logical" shift composed of three "physical" shifts. - + ## Recognition @@ -39,16 +37,16 @@ Automatic recognition of octave shifts by the OMR engine is difficult for variou - The value is not always just a number to be found in {8, 17, 22} set. There can be a suffix, such as "va" or "vb", sometimes located slightly above or below the number. Sometimes but not always, "va" and "vb" stand respectively for "ottava alta" and "ottava bassa". -- The line is often composed of dots or short dashes, that may have been consumed by OCR TEXT step. +- The line is often composed of dots or short dashes, that may have been consumed by the OCR TEXT step. - Even if they survive OCR, these long sequences of dots are difficult to recognize in the SYMBOLS step by the current classifier, which requires identified glyphs. - The line itself is sometimes far from being a straight line, see the image below. - + ## Model -In Audiveris, we have chosen to focus on a simplified model. +Audiveris has chosen to focus on a simplified model. An octave shift element is defined as a horizontal sequence of: 1. A number value (8, 15 or 22), @@ -57,7 +55,7 @@ An octave shift element is defined as a horizontal sequence of: The ending hook appears only at the end of the last (physical) shift of a perhaps longer logical shift. - + The vertical location of this octave shift element with respect to the related staff indicates its kind (``ALTA`` if above the related staff, ``BASSA`` if below). @@ -78,24 +76,24 @@ The closest staff is by default the related staff. When the glyph is located between two systems, it can lead to two mutually exclusive Inters, one for the system above and one for the system below, as shown by the picture below (notice the two end hooks). -In that case we can manually discard the Inter we don't want to keep. +In that case we can manually discard the `Inter` we don't want to keep. - + - The shift can also be dragged from the shape palette and dropped at proper location. - + As we hover on staves, the shift related staff changes and so does its ending hook. At drop time, the last staff is kept as the related staff. - + ### Single line editing -As usual, a double-click on the shift Inter opens a dedicated editor on it. +As usual, a double-click on the shift `Inter` opens a dedicated editor on it. - + For a one-line shift, there are 3 handles: - Left handle can move horizontally and vertically @@ -116,7 +114,7 @@ And it can continue its evolution. ### Multiple line editing - + The picture above represents the current status of a 3-line shift being edited: - The first line goes until the staff right side; diff --git a/docs/_pages/specific/snippets.md b/docs/_pages/guides/specific/snippets.md similarity index 79% rename from docs/_pages/specific/snippets.md rename to docs/_pages/guides/specific/snippets.md index 0b3fe61d1..1d2e7d2e7 100644 --- a/docs/_pages/specific/snippets.md +++ b/docs/_pages/guides/specific/snippets.md @@ -1,9 +1,8 @@ --- layout: default title: Snippets -parent: Specific Features +parent: Specific features nav_order: 0 -has_children: false --- # Snippets {: .no_toc } @@ -16,12 +15,13 @@ For example, this [Wikipedia page](https://en.wikipedia.org/wiki/Fandango) is ab It provides some explanation text, a picture of fandango dancers and a snippet of music score to describe the specific fandango rhythm: - + For the Audiveris OMR engine, the processing of such a tiny score brings a few challenges. +--- Table of contents -{: .no_toc .text-delta } +{: .no_toc .text-epsilon } 1. TOC {:toc} --- @@ -30,13 +30,13 @@ Table of contents Let's have a closer look at this image (By Hyacinth, CC BY-SA 3.0, https://commons.wikimedia.org/w/index.php?curid=27409005): - + ### Interline If we naively launch Audiveris on this input image, we almost immediately get this alert message: - + The engine complains about a too low interline value of 9 pixels. This message is issued by the ``SCALE`` step, whose main task is to retrieve the sheet "interline value", @@ -50,7 +50,7 @@ populated with the vertical runs lengths of the image. The engine measures any vertical black run followed by a vertical white run. The total length is recorded in the combo histogram, which then exhibits a very visible peak at the interline value. -For further details, please refer to the [Sheet Scale chapter](../main/sheet_scale.md). +For further details, please refer to the [Sheet scale chapter](../main/sheet_scale.md). But in the case of our snippet, the image contains just one staff line. Therefore, there is no physical "interline" the engine could retrieve. @@ -59,8 +59,8 @@ For the sake of completion, here below are the black histogram and the combo his | Legend | Histogram| | :--- | :---:| -|The black histogram gives correct values for the typical staff line height (4 pixels) and the typical beam height (16 pixels) |  | -|The combo histogram should give the typical interline value, but provides only erratic values | | +|The black histogram gives correct values for the typical staff line height (4 pixels) and the typical beam height (16 pixels) |  | +|The combo histogram should give the typical interline value, but provides only erratic values | | ### Barline height @@ -69,7 +69,7 @@ barline height that the engine should expect. For a multi-line staff, any barline is expected to go from the top staff line to the bottom staff line. But what if the staff at hand is a 1-line staff? This is no upper line or lower line. -So, how far should a barline go above and below the single staff line? +So, how far should the OMR engine expect a barline to go above and below the single staff line? In our snippet example, we have two barlines, one at the center and one at the right side of the staff. They both go from roughly one head height above to one head height below the line. @@ -78,7 +78,7 @@ These barlines thus have a height of about 2 "interlines". But let's consider this other example, with a 5-line staff and a 1-line staff: - + The typical barline height for the 1-line staff is here the same as for the 5-line staff, that is 4 interlines. @@ -86,15 +86,15 @@ The typical barline height for the 1-line staff is here the same as for the 5-li Since the engine has no way to guess by itself the needed values of interline and barline height, we have to tell the engine which values to use for the image at hand. -This can be performed via the ``Book | Set book parameters`` menu as follows: +This can be performed via the {{ site.book_parameters }} menu as follows: | Comment | Dialog | | :--- | :---: | -| 0/ Initial dialog,
by default the engine expects standard 5-line staves |  | -| 1/ The 1-line switch has been selected,
the "Barline height" field appears |  | -| 2/ Barline height set to "two" interlines |  | -| 3/ No multi-line staff in image,
the "Interline" field appears |  | -| 4/ Final dialog content |  | +| 0/ Initial dialog,
by default the engine expects standard 5-line staves |  | +| 1/ The 1-line switch has been selected,
the "Barline height" field appears |  | +| 2/ Barline height set to "two" interlines |  | +| 3/ No multi-line staff in image,
the "Interline" field appears |  | +| 4/ Final dialog content |  | Regarding the "Barline height" field, the dialog prompts for a value among four possibilities: - ``four``: This is the default value of 4 interlines, as seen on typical standard staves. @@ -114,4 +114,4 @@ This gives about 31 pixels for our snippet example. Once the book parameters are correctly set, the snippet gets perfectly transcribed. Here is the final result using the MuseScore plugin: - + diff --git a/docs/_pages/specific/tablature.md b/docs/_pages/guides/specific/tablature.md similarity index 86% rename from docs/_pages/specific/tablature.md rename to docs/_pages/guides/specific/tablature.md index 9be8c8aae..ead651079 100644 --- a/docs/_pages/specific/tablature.md +++ b/docs/_pages/guides/specific/tablature.md @@ -1,30 +1,28 @@ --- layout: default title: Tablature -parent: Specific Features -nav_order: 9 -has_children: false +parent: Specific features +nav_order: 8 --- # Tablature {: .no_toc } {: .d-inline-block } -new in 5.3 -{: .label .label-yellow } +since 5.3 +{: .label .label-white } A *tablature* is a special kind of staff that represents the physical locations of strings and frets to be pressed. --- Table of contents -{: .text-delta } - +{: .text-epsilon } 1. TOC {:toc} --- ## Example - + This tablature example contains 6 lines, and corresponds to a 6-string guitar. There exist also tablatures for 4-string bass guitar, represented with 4 lines. @@ -38,7 +36,7 @@ By default, tablatures are not detected. To enable their detection, we have to explicitly set the processing switches (either or both the 4-line or 6-line tablatures as depicted below): - + The GRID step of OMR engine detects clusters of regularly spaced horizontal lines. Typically a cluster of 5 lines is considered as a "standard" 5-line staff. diff --git a/docs/_pages/specific/tremolo.md b/docs/_pages/guides/specific/tremolo.md similarity index 74% rename from docs/_pages/specific/tremolo.md rename to docs/_pages/guides/specific/tremolo.md index f14deec5b..cc2676764 100644 --- a/docs/_pages/specific/tremolo.md +++ b/docs/_pages/guides/specific/tremolo.md @@ -1,19 +1,18 @@ --- layout: default title: Tremolo -parent: Specific Features +parent: Specific features nav_order: 7 -has_children: false --- # Tremolo {: .no_toc } {: .d-inline-block } -new in 5.3 -{: .label .label-yellow } +since 5.3 +{: .label } Since release 5.3, Audiveris can handle tremolos as depicted below: - + A tremolo is composed of 1, 2 or 3 slanted segments. @@ -25,10 +24,10 @@ Audiveris does not yet address the case of tremolos located _**between**_ two ch as shown in the picture below, stolen from Wikipedia:  -If the OMR engine has not recognized a tremolo, you can always assign or drag the desired +If the OMR engine has not recognized a tremolo, we can always assign or drag the desired tremolo from the shape palette, using the ``BeamsEtc`` shape set. - + Tremolo editing is limited to translations of the item, which will snap on compatible chords nearby. diff --git a/docs/_pages/ui.md b/docs/_pages/guides/ui/README.md similarity index 65% rename from docs/_pages/ui.md rename to docs/_pages/guides/ui/README.md index 81ea53668..2ea13ec63 100644 --- a/docs/_pages/ui.md +++ b/docs/_pages/guides/ui/README.md @@ -1,16 +1,17 @@ --- layout: default -title: User Editing -nav_order: 4 -has_children: true +title: User editing +parent: How-to guides +nav_order: 2 has_toc: false --- -# User Editing +# User editing In the transcription process made by the OMR engine, some elements may not be recognized correctly for various reasons, such as poor image quality or over-crowded score, to name a few. -There is a continuous effort going on to improve the OMR engine but on many examples a completely error free transcription is just out of reach. +There is a continuous effort going on to improve the OMR engine but on many examples +a completely error free transcription is just out of reach. It is thus globally more efficient to complement the OMR engine with a convenient graphical editor so that the end-user can easily fix most of the OMR errors. @@ -26,27 +27,31 @@ score image to its symbolic representation. In particular, it tries to remain as close as possible to the original layout, including any image skew or warping. -## Tutorial Video +## Tutorial videos As an introduction, you can watch Audiveris 5.1 user editor in action -thanks to Baruch's -[tutorial video](https://www.youtube.com/watch?v=718iy10sKV4&feature=youtu.be). +thanks to [Baruch Hoffart] who recorded this +[tutorial video](https://www.youtube.com/watch?v=718iy10sKV4&feature=youtu.be). -{: .warning } -Keep in mind that this tutorial was based on the **5.1** version, and some topics may be -significantly different when using the current **{{ site.audiveris_version }}** version. +For those who understand French, we highly recommend the YouTube channel run by [Dominique Verriere]. +It is an impressive collection of detailed tutorials about Audiveris and MuseScore. +Here is a direct link to his [Audiveris videos]. ## Documentation content -1. [UI Foundations](./ui_foundations/README.md): Editable OMR data, +1. [UI foundations](./ui_foundations/README.md): Editable OMR data, how to select and inspect it. -2. [UI Tools](./ui_tools/README.md): How to modify OMR data, +2. [UI tools](./ui_tools/README.md): How to modify OMR data, beginning with the general tools to add/edit/remove both Inters and Relations. Then more ad-hoc tools are presented to address specific cases. -3. [UI Examples](./ui_examples/README.md): Complete editing sessions +3. [UI examples](./ui_examples/README.md): Complete editing sessions on representative input scores. The best way to learn an editor is certainly by practicing rather than studying a long documentation. So, you could start by reading **Foundations** and then discover **Examples**. Then, you could go back to the **Tools** of interest for you, at your own pace. + +[Baruch Hoffart]: https://github.com/Bacchushlg +[Dominique Verriere]: https://www.youtube.com/@DominiqueVerriere +[Audiveris videos]: https://www.youtube.com/playlist?list=PLZNad9Wu-U5FHwu02qGFA_18Ebsz6Ifm8 diff --git a/docs/_pages/ui_examples/README.md b/docs/_pages/guides/ui/ui_examples/README.md similarity index 60% rename from docs/_pages/ui_examples/README.md rename to docs/_pages/guides/ui/ui_examples/README.md index a3f231983..c05b72021 100644 --- a/docs/_pages/ui_examples/README.md +++ b/docs/_pages/guides/ui/ui_examples/README.md @@ -1,12 +1,15 @@ --- layout: default -title: UI Examples -parent: User Editing +title: UI examples +parent: User editing nav_order: 3 has_children: true --- -# UI Examples +# UI examples +{: .d-inline-block } +Augmented in 5.4 +{: .label .label-yellow } The purpose of this chapter is to present editing sessions on representative scores to be used as concrete examples for the Audiveris user. -We can expect this chapter to grow incrementally, as more and more example sessions get included here. +We can expect this chapter to grow incrementally, as more and more example sessions get included here. \ No newline at end of file diff --git a/docs/_pages/ui_examples/eyes/README.md b/docs/_pages/guides/ui/ui_examples/eyes/README.md similarity index 88% rename from docs/_pages/ui_examples/eyes/README.md rename to docs/_pages/guides/ui/ui_examples/eyes/README.md index 0ff3d5777..a3486416d 100644 --- a/docs/_pages/ui_examples/eyes/README.md +++ b/docs/_pages/guides/ui/ui_examples/eyes/README.md @@ -1,8 +1,7 @@ --- layout: default title: Can't Take My Eyes Off of You -grand_parent: User Editing -parent: UI Examples +parent: UI examples nav_order: 2 --- # Can't Take My Eyes Off of You @@ -11,7 +10,7 @@ nav_order: 2 This case is one of the examples discussed on [issue #33](https://github.com/Audiveris/audiveris/issues/33) posted on Audiveris forum, dedicated to the support of drum notation. -[PDF available here](https://github.com/Audiveris/audiveris/files/8421680/Can.t_Take_My_Eyes_Off_of_You-Drums%2BClap.pdf) +[Input file available here](https://github.com/Audiveris/audiveris/files/8421680/Can.t_Take_My_Eyes_Off_of_You-Drums%2BClap.pdf) {: .btn .text-center } Main score specificities: @@ -29,15 +28,14 @@ Main UI actions: --- Table of contents -{: .text-delta } - +{: .text-epsilon } 1. TOC {:toc} --- ## Input -{: .note } +{: .highlight } If you are reading this handbook via a web browser, you can ask the browser to display each of these sheet images in a separate tab. @@ -71,7 +69,7 @@ percussion staves. This "Cross note heads" feature is meant for cross heads on * Since we are dealing with drum notation, we check the default drum-set.xml specifications. It is available in the Audiveris ``res`` (resources) folder. -Its content is also displayed in [this handbook section](../../specific/drums.md#appendix). +Its content is also displayed in [this handbook section](../../../specific/drums.md#appendix). The default specifications should be OK for the 5-line staff (named Drumset in the input). @@ -100,10 +98,12 @@ So, we create a "personal" ``drum-set.xml`` that provides one overriding definit ``` And we put this file in the user Audiveris ``config`` folder. -On my PC, the path to this folder is precisely: +On my Windows PC, the path to this folder is precisely: > C:\Users\herve\AppData\Roaming\AudiverisLtd\audiveris\config And that's it. +Audiveris will pick up this personal `drum-set.xml` file and load it to complete +and/or replace the definitions provided by the default `drum-set.xml` file. ## Raw results @@ -132,18 +132,23 @@ At the very beginning of sheet #1, we can see some header text partly recognized We select the text with a lasso, then in the ``Physicals`` palette in the shape board we double-click on the ``text`` button. This manually calls the OCR on the selected text which is this time well recognized. - The Inter board now presents the sentence "Drums/Clap" and proposes ``CreatorLyricist`` + The `Inter` board now presents the sentence "Drums/Clap" and proposes ``CreatorLyricist`` as its role. We manually change this role to ``Number``. - "**Can't Take My Eyes Off of You**": The apostrophe is mistaken for a separate "v" sentence. We select both sentences with a lasso and press the ``Delete`` key to remove them. With the underlying glyphs still selected, we double-click on the ``text`` button. The text is correctly OCR'ed as a single sentence and its role correctly set as ``Title``. -- "**𝅘𝅥 = 120**": Recognized as "J: 120". +- ~~"**𝅘𝅥 = 120**": Recognized as "J: 120". This is due to the quarter character (**𝅘𝅥**) which the OCR does not handle correctly. - And there is currently no way to fix this. + And there is currently no way to fix this.~~ - "**Molto Moderato**": Correctly OCR'd and assigned the ``Direction`` role. - "**Bob Crewe and Bob Gaudio**": Correctly OCR'd and assigned the ``CreatorComposer`` role. +{: .highlight } +UPDATE: +With 5.4 release, the sentence "**𝅘𝅥 = 120**" is now correctly recognized as a metronome indication, meaning 120 quarters per minute. + + Regarding rhythm, we have 3 measures displayed with a pink background. Their (local) ids are measures 4 and 8 in the first system and measure 27 in the last system. @@ -268,7 +273,7 @@ That is, for the OMR engine we have 4 separate logical parts: - Hand Clap And indeed, if within Audiveris we open the -[logical parts editor](../../specific/logical_parts.md#editing-of-logical-parts), +[logical parts editor](../../../specific/logical_parts.md#editing-of-logical-parts), we get this dialog:  diff --git a/docs/_pages/guides/ui/ui_examples/eyes/book_parameters.png b/docs/_pages/guides/ui/ui_examples/eyes/book_parameters.png new file mode 100644 index 000000000..b0f721005 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/eyes/book_parameters.png differ diff --git a/docs/_pages/ui_examples/eyes/finale_export.png b/docs/_pages/guides/ui/ui_examples/eyes/finale_export.png similarity index 100% rename from docs/_pages/ui_examples/eyes/finale_export.png rename to docs/_pages/guides/ui/ui_examples/eyes/finale_export.png diff --git a/docs/_pages/ui_examples/eyes/logicals_edited.png b/docs/_pages/guides/ui/ui_examples/eyes/logicals_edited.png similarity index 100% rename from docs/_pages/ui_examples/eyes/logicals_edited.png rename to docs/_pages/guides/ui/ui_examples/eyes/logicals_edited.png diff --git a/docs/_pages/ui_examples/eyes/logicals_editing.png b/docs/_pages/guides/ui/ui_examples/eyes/logicals_editing.png similarity index 100% rename from docs/_pages/ui_examples/eyes/logicals_editing.png rename to docs/_pages/guides/ui/ui_examples/eyes/logicals_editing.png diff --git a/docs/_pages/ui_examples/eyes/musescore_4_parts.png b/docs/_pages/guides/ui/ui_examples/eyes/musescore_4_parts.png similarity index 100% rename from docs/_pages/ui_examples/eyes/musescore_4_parts.png rename to docs/_pages/guides/ui/ui_examples/eyes/musescore_4_parts.png diff --git a/docs/_pages/ui_examples/eyes/parts_collation.png b/docs/_pages/guides/ui/ui_examples/eyes/parts_collation.png similarity index 100% rename from docs/_pages/ui_examples/eyes/parts_collation.png rename to docs/_pages/guides/ui/ui_examples/eyes/parts_collation.png diff --git a/docs/_pages/ui_examples/eyes/sheet1.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet1.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet1.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet1.png diff --git a/docs/_pages/ui_examples/eyes/sheet1_header.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet1_header.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet1_header.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet1_header.png diff --git a/docs/_pages/ui_examples/eyes/sheet1_header_ok.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet1_header_ok.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet1_header_ok.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet1_header_ok.png diff --git a/docs/_pages/ui_examples/eyes/sheet1_m25.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet1_m25.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet1_m25.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet1_m25.png diff --git a/docs/_pages/ui_examples/eyes/sheet1_m27.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet1_m27.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet1_m27.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet1_m27.png diff --git a/docs/_pages/ui_examples/eyes/sheet1_m27_ok.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet1_m27_ok.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet1_m27_ok.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet1_m27_ok.png diff --git a/docs/_pages/ui_examples/eyes/sheet1_m31.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet1_m31.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet1_m31.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet1_m31.png diff --git a/docs/_pages/ui_examples/eyes/sheet1_m31_ok.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet1_m31_ok.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet1_m31_ok.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet1_m31_ok.png diff --git a/docs/_pages/ui_examples/eyes/sheet1_m3_4.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet1_m3_4.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet1_m3_4.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet1_m3_4.png diff --git a/docs/_pages/ui_examples/eyes/sheet1_m3_4_ok.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet1_m3_4_ok.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet1_m3_4_ok.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet1_m3_4_ok.png diff --git a/docs/_pages/ui_examples/eyes/sheet1_raw.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet1_raw.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet1_raw.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet1_raw.png diff --git a/docs/_pages/ui_examples/eyes/sheet2.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet2.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet2.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet2.png diff --git a/docs/_pages/ui_examples/eyes/sheet2_m29.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet2_m29.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet2_m29.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet2_m29.png diff --git a/docs/_pages/ui_examples/eyes/sheet2_m29_ok.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet2_m29_ok.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet2_m29_ok.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet2_m29_ok.png diff --git a/docs/_pages/ui_examples/eyes/sheet2_m4.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet2_m4.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet2_m4.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet2_m4.png diff --git a/docs/_pages/ui_examples/eyes/sheet2_m4_ok.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet2_m4_ok.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet2_m4_ok.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet2_m4_ok.png diff --git a/docs/_pages/ui_examples/eyes/sheet2_raw.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet2_raw.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet2_raw.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet2_raw.png diff --git a/docs/_pages/ui_examples/eyes/sheet3.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet3.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet3.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet3.png diff --git a/docs/_pages/ui_examples/eyes/sheet3_m16.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet3_m16.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet3_m16.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet3_m16.png diff --git a/docs/_pages/ui_examples/eyes/sheet3_m16_ok.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet3_m16_ok.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet3_m16_ok.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet3_m16_ok.png diff --git a/docs/_pages/ui_examples/eyes/sheet3_m25.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet3_m25.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet3_m25.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet3_m25.png diff --git a/docs/_pages/ui_examples/eyes/sheet3_m25_ok.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet3_m25_ok.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet3_m25_ok.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet3_m25_ok.png diff --git a/docs/_pages/ui_examples/eyes/sheet3_m5.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet3_m5.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet3_m5.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet3_m5.png diff --git a/docs/_pages/ui_examples/eyes/sheet3_m5_ok.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet3_m5_ok.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet3_m5_ok.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet3_m5_ok.png diff --git a/docs/_pages/ui_examples/eyes/sheet3_raw.png b/docs/_pages/guides/ui/ui_examples/eyes/sheet3_raw.png similarity index 100% rename from docs/_pages/ui_examples/eyes/sheet3_raw.png rename to docs/_pages/guides/ui/ui_examples/eyes/sheet3_raw.png diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/README.md b/docs/_pages/guides/ui/ui_examples/moonlight/README.md new file mode 100644 index 000000000..c4b8f203a --- /dev/null +++ b/docs/_pages/guides/ui/ui_examples/moonlight/README.md @@ -0,0 +1,367 @@ +--- +layout: default +title: Moonlight sonata +parent: UI examples +nav_order: 3 +--- +# Moonlight sonata +{: .no_toc } +{: .d-inline-block } +new in 5.4 +{: .label .label-yellow } + +This famous *Sonata No. 14 "Moonlight"*, 1st movement, +is a typical example of a score with implicit tuplets. +The OMR engine is able to detect most of them but not all, so some user guiding actions are needed. + +[Input file available here](https://www.free-scores.com/download-sheet-music.php?pdf=282) +{: .btn .text-center } + +It is one of the numerous free scores (190 000+ as of this writing) +available on the [free-scores.com](https://www.free-scores.com/) site. + +Main score specificities: +- Book of 5 sheets +- Lots of implicit tuplets + +Main UI actions: +- Use of the `Chords` popup menu to fix voices, +notably `Next in voice`, `Separate voices` and `Preferred voice` actions +- Manual insertion of tuplets + +--- +Table of contents +{: .text-epsilon } +1. TOC +{:toc} +--- + +## Input + +Here is the first image of a total of 5: + +| Sheet ID | Input image | +| :---: | :---: | +| Sheet#1 |  | + +{: .note } +> Loading any image of this PDF file generates a dozen messages like: +> "*Unknown string command in glyph p of font QPTMAY+CMR10*" +> +> These messages can be safely ignored. They are emitted by the PDFBox library +> and would be fixed in the upcoming new version of the library. + +## Book parameters + +The input score has a "common cut" time signature (2/2), +while each measure is made up of a sequence of 4 linked triplets. +But none of these triplets is explicitly marked with a "3" tuplet sign. + +So we'll have to rely on the OMR engine to detect which groups of notes +should be considered *triplets*. + +Before launching the transcription, we have to set a few things in the book parameters: +- First, the settings should apply to the entire book, +and not only to the (current) first sheet. +So, we make sure to select the "Moonlight" book tab rather than the "S#1" sheet tab. +- The `Text font` is set to `Serif` rather than the default `Sans Serif` font. +This has no impact on the OCR efficiency, +the effect is mainly a more faithful display of texts. +- The `Input quality` is set to `Synthetic` rather than the default `Standard`. +This higher quality results in a more strict checking and thus less mistakes. +- Finally, setting the `Implicit tuplets` to ON is absolutely mandatory! + + + +We can save the book right now, to save the book parameters with it. + +## Raw results + +We can launch transcription of the entire book, +for example via the {{ site.book_transcribe }} pull-down menu. + +With Audiveris 5.4, the transcription took exactly 2 minutes for 5 sheets +on a 14-year old laptop running Windows 10. + + +We use the {{ site.view_voices }} menu item to display voices with different colors, +and the {{ site.view_chords }} item to display the chord numeric IDs. + +| Sheet ID | Raw results | +| :---: | :---: | +| Sheet#1 |  | +| Sheet#2 |  | +| Sheet#3 |  | +| Sheet#4 |  | +| Sheet#5 |  | + +## Sheet #1 + +No measures to fix. + +## Sheet #2 + +One measure in pink + +### Measure #12 + + + +Here we have a mess on the lower left side: +- A non-recognized beam +- A false note head +- A tuplet sign + +We first delete the note head and the tuplet sign: + + + +We then assign the Beam shape to the underlying glyph. + +We enter the edit mode via a double click on the beam, to extend the beam to the left, +until it embraces the left-most stem +(at this point the beam shows 3 links to the embraced 3 stems). + + + +And the measure turns white. + + + +However, the upper staff exhibits 2 unrecognized quarter rests +and the lower staff a missing whole head. + +We assign each of the quarter rests for example by clicking on the underlying glyph, +which triggers the glyph classifier, and we simply click on the top 1 shape (quarter rest). + +For the non-recognized whole head, we have no correct underlying glyph. +So, we simply drag a whole head from the ShapeBoard and drop it on the proper location. + + + +We could stop at this point, because it's OK as far as the rhythm is concerned. + +We can also further refine the result with two actions: +- At the bottom of the lower staff, we could decide to merge the 3 whole heads into a single chord. +To do so, we select the 3 whole heads, then in the pop-up `Chords` menu, we select the `Merge` action. + + +- Between upper and lower staff, we can consider that the quarter note +(chord #5358 in voice 5 cyan) should rather belong to the voice 1 (blue). +To do so, we use the `Next in voice` action twice: + - Between the last quarter #5318 of previous measure and the chord #5358 + - Between chord #5358 and the first quarter rest #5955 in the upper staff. + + + +Here is the final status of this measure: + + + + +### Measures #1, #2, #3 + +Let's have a look back at the top of this page, the system #1: + + + +All measures in this system are displayed in white and would be correctly exported. + +However, we can notice that the "intermediate" voice varies between the three measures of the system: +- Green (voice #2) in measure #1 +- Cyan (voice #5) in measures #2 and #3 + +And similarly, the "lower" voice appears in cyan (voice #5) in measure #1 +and in orange (voice #6) in the following two measures. + +We may wish to further improve this system. + +The current policy of the rhythm algorithm is to assign the voice number +at the very beginnning of a measure according to: +- The containing staff (1-4 for staff #1, 5-8 for staff #2) +- The vertical rank within the staff. + +We can override this policy via two ways: +- Within the *same* system, we can use the `Next in voice` action between +the last note of a measure and the first note of the following measure, +- At the *beginning* of a system, we can use the `Preferred voice` action on the note +of a starting chord to assign an absolute voice number. + + + +Doing so for the "intermediate" and for the "lower" voices, we get this final result: + + + +## Sheet #3 + +We have four measures to fix. + +### Measure #3 + + + +We can observe that the 3 first chords in the upper staff should have a tuplet. + +We manually insert a tuplet-3, dragged from the Shape board (the `BeamsEtc` subset) +and dropped at proper location. + +{: .highlight } +While being dragged, a tuplet is displayed with its potential links with the embraced chords. +These links, shown as green dashed lines, +are a good visual aid to decide where to precisely drop the tuplet. + + + +We can notice that this manual fix at the start of the measure resulted +in the automatic insertion of the last implicit tuplet at the end of the measure. + +### Measure #4 + + + +On the upper right, a stem has not been detected. + +We select the underlying glyph and in the Shape board (Physicals set) +we double-click on the stem button. + +We now have a note head with two stems, one linked on the head left side, +and the other (the new one) on the head right side, but not yet linked. + +To link head and stem, we press the mouse on the stem, drag to the head and release the mouse. + + + +The physical note head is now split into 2 logical half-heads, and the measure turns white. + +### Measure #5 + + + +We have missing implicit tuplets on two locations. + +So, we manually insert a tuplet of the left location (at the beginning of the measure). +The second (implicit) tuplet is automatically inserted. + + + + +### Measure #11 + + + +A false slur detected (to be manually deleted) +and a bass clef not detected (to be manually assigned). + +Regarding the tuplets, there is none, certainly due to the complexity at the end of the measure. + +So we insert them manually from left to right. + +When the 3rd one is inserted between the down eighth and the down quarter, +the measure turns white with the upper tuplets automatically inserted: + + + +## Sheet #4 + +Just one measure to fix. + +### Measure #9 + + + +A small glyph has been mistaken for a dot, considered as an augmentation dot. + +This kind of error is not often easy to detect visually. +This is why we now have a view option, activated via the {{ site.view_jumbos}} menu +or the `F7` function key. +When set to ON, all the augmentation dots are highlighted as big red dots, +as in the following picture: + + + +All we have to do now is to delete this false augmentation dot. + + + +## Sheet #5 + +Two measures to fix. + +### Measure #4 + + + +A dotted half-note is missing. +We can drag a half-note from the Shape board: + + + +And assign the augmentation dot. + + + +The dotted half-note is now fixed, but we still have no implicit tuplets. + +We could manually insert them, but there is an easier way: by voice chaining +the beamed notes on the left of the lower staff with the beamed notes on the upper staff. + + + +And voila: + + + +### Measure #11 + + + +No implicit tuplet has been detected. + +We have to insert them manually, from left to right. + + + +The first manual tuplet has been automatically followed by an implicit one. + +We finally insert the two missing tuplets on the second staff. + + + +## Conclusion + +A few remarks, to conclude this editing session. + +Regarding precise **tuplet location**: +- We cannot modify the location of an implicit tuplet sign. +We can put the sign in `Edit` mode and shift it, +but as soon as we leave the `Edit` mode, the containing measure is re-processed, +resulting in the removal of all implicit tuplets and the creation of new ones +at the same locations... +- To actually modify a tuplet location, we have to manually insert a tuplet +-- typically over the implicit one. +This results in a manual (non-implicit) tuplet at the desired location. +Moreover, this manual tuplet can be further edited if needed. + +Regarding **voice number**: +- We have seen how to generally guide the rhythm algorithm +-- see [this section](#measures-1-2-3) above in this chapter. +- The action `Next in voice` can work only within the same system, +but can cross measure boundaries. +- The link it establishes is dynamic, from the left partner to the right partner. +In other words, if we change the voice number in a measure, +it will impact the linked voice in the following measure. +- Between systems (and *a fortiori* between pages or sheets), +the action `Next in voice` cannot apply, +only the static action `Preferred voice` is available. + +Regarding the **implicit tuplets**: +- The raw transcription of this "Moonlight Sonata" resulted in: + - 68 measures processed (all requiring implicit tuplets), + - 3 measures in error because of mis-recognized symbols (we don't count them), + - 5 measures in error because of missing tuplets, + - 60 measures OK with implicit tuplets + which gives a success rate of 60/65, that is 92%. +- The "implicit tuplets" algorithm can still be improved, but it is usable right now. +It is recommended to reserve it for selected scores and to be prepared for manual corrections +as we did in this session. diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/book_parameters.png b/docs/_pages/guides/ui/ui_examples/moonlight/book_parameters.png new file mode 100644 index 000000000..58dddca32 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/book_parameters.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/half_note_up.png b/docs/_pages/guides/ui/ui_examples/moonlight/half_note_up.png new file mode 100644 index 000000000..5f786a3d0 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/half_note_up.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet1.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet1.png new file mode 100644 index 000000000..de863a70e Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet1.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet1_raw.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet1_raw.png new file mode 100644 index 000000000..d5b046706 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet1_raw.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12.png new file mode 100644 index 000000000..db97b97a7 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_beam.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_beam.png new file mode 100644 index 000000000..8c5d42961 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_beam.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_final.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_final.png new file mode 100644 index 000000000..5e1a48f35 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_final.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_merge.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_merge.png new file mode 100644 index 000000000..cd4657048 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_merge.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_mess.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_mess.png new file mode 100644 index 000000000..08d7a1b96 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_mess.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_niv.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_niv.png new file mode 100644 index 000000000..0dbe57fee Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_niv.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_ok.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_ok.png new file mode 100644 index 000000000..bf061c9aa Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_ok.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_rests.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_rests.png new file mode 100644 index 000000000..ef0a7f05c Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_m12_rests.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_raw.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_raw.png new file mode 100644 index 000000000..3b3bce95b Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_raw.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_s1.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_s1.png new file mode 100644 index 000000000..46de47595 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_s1.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_s1_ok.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_s1_ok.png new file mode 100644 index 000000000..a86174522 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_s1_ok.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_s1_preferred.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_s1_preferred.png new file mode 100644 index 000000000..dfb447fc3 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet2_s1_preferred.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m11.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m11.png new file mode 100644 index 000000000..ce44bd973 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m11.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m11_ok.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m11_ok.png new file mode 100644 index 000000000..d36729a7e Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m11_ok.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m11_t6.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m11_t6.png new file mode 100644 index 000000000..14a10ccb7 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m11_t6.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m11_voice.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m11_voice.png new file mode 100644 index 000000000..3ac9d08a9 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m11_voice.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m3.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m3.png new file mode 100644 index 000000000..c2a445c15 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m3.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m3_ok.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m3_ok.png new file mode 100644 index 000000000..4de5d61fb Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m3_ok.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m4.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m4.png new file mode 100644 index 000000000..acd8388c5 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m4.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m4_ok.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m4_ok.png new file mode 100644 index 000000000..ec039a1cb Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m4_ok.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5.png new file mode 100644 index 000000000..5e1c9bf1d Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5_ok.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5_ok.png new file mode 100644 index 000000000..ae1fdefb9 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5_ok.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5_separate.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5_separate.png new file mode 100644 index 000000000..d3a2e5c59 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5_separate.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5_separate2.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5_separate2.png new file mode 100644 index 000000000..81934ed4b Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5_separate2.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5_separated.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5_separated.png new file mode 100644 index 000000000..43e990ccb Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_m5_separated.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_raw.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_raw.png new file mode 100644 index 000000000..1514377ac Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet3_raw.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet4_m9.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet4_m9.png new file mode 100644 index 000000000..4d8b57434 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet4_m9.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet4_m9_jumbo.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet4_m9_jumbo.png new file mode 100644 index 000000000..98434bd3c Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet4_m9_jumbo.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet4_m9_ok.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet4_m9_ok.png new file mode 100644 index 000000000..dc2d852a8 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet4_m9_ok.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet4_raw.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet4_raw.png new file mode 100644 index 000000000..6fd84d1a4 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet4_raw.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m11.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m11.png new file mode 100644 index 000000000..2ae1452bd Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m11.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m11_ok.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m11_ok.png new file mode 100644 index 000000000..1bd3a22b6 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m11_ok.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m11_tuplet_1.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m11_tuplet_1.png new file mode 100644 index 000000000..530cfc6a3 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m11_tuplet_1.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m4.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m4.png new file mode 100644 index 000000000..f043ca681 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m4.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m4_do_niv.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m4_do_niv.png new file mode 100644 index 000000000..4230dc275 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m4_do_niv.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m4_niv.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m4_niv.png new file mode 100644 index 000000000..9042d283e Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m4_niv.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m4_ok.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m4_ok.png new file mode 100644 index 000000000..ddcf47873 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_m4_ok.png differ diff --git a/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_raw.png b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_raw.png new file mode 100644 index 000000000..edb0afd09 Binary files /dev/null and b/docs/_pages/guides/ui/ui_examples/moonlight/sheet5_raw.png differ diff --git a/docs/_pages/ui_examples/trinitas/README.md b/docs/_pages/guides/ui/ui_examples/trinitas/README.md similarity index 93% rename from docs/_pages/ui_examples/trinitas/README.md rename to docs/_pages/guides/ui/ui_examples/trinitas/README.md index b342a8dbb..8fef48b51 100644 --- a/docs/_pages/ui_examples/trinitas/README.md +++ b/docs/_pages/guides/ui/ui_examples/trinitas/README.md @@ -1,8 +1,7 @@ --- layout: default title: O lux beata Trinitas -grand_parent: User Editing -parent: UI Examples +parent: UI examples nav_order: 1 --- # O lux beata Trinitas @@ -10,12 +9,12 @@ nav_order: 1 {: .note } You will notice that the description of user editing is very detailed in this example, perhaps too much. -This was done on purpose, so that the session content could be used as introductory material. +This was done on purpose, so that the session content could be used as an introductory material. The case at hand describes the processing of an old office hymn available on the IMSLP site. You can download it directly via the button below: -[O lux beata Trinitas](https://imslp.org/wiki/O_lux_beata_Trinitas_(Alberti%2C_Johann_Friedrich)) +[Input file available here](https://imslp.org/wiki/O_lux_beata_Trinitas_(Alberti%2C_Johann_Friedrich)) {: .btn .text-center } The case originated from [issue #481](https://github.com/Audiveris/audiveris/issues/481) @@ -37,8 +36,7 @@ The main UI actions: --- Table of contents -{: .text-delta } - +{: .text-epsilon } 1. TOC {:toc} --- @@ -51,7 +49,7 @@ If we haven't done so, we select [Audiveris releases on github](https://github.c Under Windows, we can simply run the installer (for example Audiveris_Setup-5.2.2-windows-x86_64.exe ). -Under Windows, Linux and MacOS, we can decide to clone the Audiveris project locally and then build it. +Under Windows, Linux and macOS, we can decide to clone the Audiveris project locally and then build it. In any case, we will have to make sure that a proper Java version is installed. Here are the first messages displayed, when pressing the Windows start icon, @@ -70,7 +68,7 @@ Classifier data loaded from default uri file:///D:/soft/audiveris-github/develop Versions. Poll frequency: Weekly, next poll on: 17-Jul-2021 ``` -Spme quick explanations about these early messages : +Some quick explanations about these early messages : 1. Program version (e.g. 5.2.2) 2. Logging: @@ -206,11 +204,11 @@ followed by a half note (chord #2837), for a total duration of 2 for voice #6. So, there is a conflict between the actual duration of this measure (and of almost all other measures in the same page) with the time signature: -2 for each measure vs 2/2=1 expected by the common-cut time signature. +2 for each measure vs. 2/2=1 expected by the common-cut time signature. What is the real "value" of a common-cut time signature? This [Wikipedia Alla breve article](https://en.wikipedia.org/wiki/Alla_breve) sheds an interesting -light, especially with the (1642-1710) indication on the score top right corner. +light, especially with the (1642-1710) date indication on the score top right corner. See also this [Ultimate music theory article](https://ultimatemusictheory.com/breve-note-and-breve-rest/). Instead of 2/2, it would be worth 4/2. @@ -218,14 +216,14 @@ Instead of 2/2, it would be worth 4/2. So let's replace all the common-cuts by explicit "4/2" time signatures. To delete: -- We select the common-cut Inter and press `DEL` key. -- Or we click on the `Deassign` button in the Inter board. +- We select the common-cut `Inter` and press `DEL` key. +- Or we click on the `Deassign` button in the `Inter` board. - Or we use the {{ site.popup_inters }} contextual menu. Inserting a 4/2 signature is more complex, since this is not one of the predefined time signatures: 1. From the Shape palette, we select the "Times" family (the family figured by a 4/4 sign) and from this shape family, we drag & drop the custom (0/0) time signature into the correct location. -2. Then in the Inter board, we replace the custom 0/0 value by 4/2 value and press `Enter`. +2. Then in the `Inter` board, we replace the custom 0/0 value by 4/2 value and press `Enter`. We do this for both common-cut signatures in the first measure of sheet #1. We'll do the same thing on sheet #4 later. @@ -247,7 +245,7 @@ in the lower staff, except the last one (measure #4) which exhibits 3 voices in  -Referring to voice legend , +Referring to voice legend , this upper staff contains: 1. Voice #1, chord #3382 made of a breve rest, horizontally located at the measure center, 2. Voice #2, chord #3381 made of a whole rest, located at the beginning of the measure, @@ -259,8 +257,8 @@ In fact, and there are other similar cases in this book, the whole rest is never but located as a plain chord in a time slot. We can visualize the content of the first slot, -using  combined mode and pressing the right mouse -button near the first slot. +using the combined mode () +and pressing the right mouse button near the first slot. Chord #3381 is *not* part of this slot:  @@ -325,7 +323,7 @@ In fact, its whole rest of chord #3374 had been mistaken for a half rest: | :---: | :---: | ||| -If we click on this rest, the Inter board gives HALF_REST shape. +If we click on this rest, the `Inter` board gives HALF_REST shape. But the binary view clearly indicates it should be a WHOLE_REST shape. The measure strip confirms the fact that chord #3374 duration is only 1/2, @@ -692,7 +690,7 @@ V 7 |........|........|........|Ch#4341 ==================|2 V 8 |........|........|........|Ch#3805 ==================|2 ``` The measure strip shows that chord #4340 is considered as a whole rest. -Also clicking on this rest shows WHOLE_REST in the Inter board. +Also clicking on this rest shows WHOLE_REST in the `Inter` board. However, a look at the binary image gives a different result:  @@ -883,9 +881,9 @@ We can see a mix of several languages the OCR had to deal with. Note, for visual check: - the original text is easier to read in the binary view in physical mode - + - while the OCR output is easier to read in logical mode - + Here are all the textual elements found in this book (we ignore text that represents a measure number) @@ -905,7 +903,7 @@ Here are all the textual elements found in this book If we except the book title "O lux beata Trinitas" which OCR totally failed to recognize, probably because of its exotic font, the raw Tesseract OCR results are pretty good. -We can manually correct the few mistakes, via the Inter board. +We can manually correct the few mistakes, via the `Inter` board. This must be done word by word, by selecting the word and modifying its content (typing new characters and validating by pressing the `Enter` key). @@ -920,7 +918,7 @@ whereas text **role** is modified at the _sentence_ level. In this book, nearly all sentences had their role correctly assigned by the OMR engine heuristics. An exception is "© Les Éditions Outremontaises - 2018" whose role appears to be "UnknownRole". -To fix this, we select one word of this sentence and, in the Inter board, +To fix this, we select one word of this sentence and, in the `Inter` board, click on the `To Ensemble` button (as you know, a sentence is modeled as an ensemble of words). We can then choose the proper sentence role ("Rights"): @@ -943,7 +941,7 @@ This book was exported as 3 separate .mxl files, one per detected movement. ### Plugin -If we have configured a few [plugins](../../advanced/plugins.md) +If we have configured a few [plugins](../../../advanced/plugins.md) to external programs such as MuseScore or Finale, clicking on the desired plugin would: 1. Export an updated version of the 3 movements files, if needed, diff --git a/docs/_pages/ui_examples/trinitas/initial_swapped.png b/docs/_pages/guides/ui/ui_examples/trinitas/initial_swapped.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/initial_swapped.png rename to docs/_pages/guides/ui/ui_examples/trinitas/initial_swapped.png diff --git a/docs/_pages/ui_examples/trinitas/initial_title.png b/docs/_pages/guides/ui/ui_examples/trinitas/initial_title.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/initial_title.png rename to docs/_pages/guides/ui/ui_examples/trinitas/initial_title.png diff --git a/docs/_pages/ui_examples/trinitas/initial_trinitas.png b/docs/_pages/guides/ui/ui_examples/trinitas/initial_trinitas.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/initial_trinitas.png rename to docs/_pages/guides/ui/ui_examples/trinitas/initial_trinitas.png diff --git a/docs/_pages/ui_examples/trinitas/musescore.png b/docs/_pages/guides/ui/ui_examples/trinitas/musescore.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/musescore.png rename to docs/_pages/guides/ui/ui_examples/trinitas/musescore.png diff --git a/docs/_pages/ui_examples/trinitas/partial_whole_rests_book.png b/docs/_pages/guides/ui/ui_examples/trinitas/partial_whole_rests_book.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/partial_whole_rests_book.png rename to docs/_pages/guides/ui/ui_examples/trinitas/partial_whole_rests_book.png diff --git a/docs/_pages/ui_examples/trinitas/partial_whole_rests_sheet.png b/docs/_pages/guides/ui/ui_examples/trinitas/partial_whole_rests_sheet.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/partial_whole_rests_sheet.png rename to docs/_pages/guides/ui/ui_examples/trinitas/partial_whole_rests_sheet.png diff --git a/docs/_pages/ui_examples/trinitas/sentence_role.png b/docs/_pages/guides/ui/ui_examples/trinitas/sentence_role.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sentence_role.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sentence_role.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_init.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_init.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_init.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_init.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m1.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m1.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m1.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m1.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m11.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m11.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m11.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m11.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m11_ok.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m11_ok.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m11_ok.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m11_ok.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m11_sequence.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m11_sequence.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m11_sequence.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m11_sequence.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m12.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m12.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m12.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m12.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m14.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m14.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m14.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m14.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m1_binary.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m1_binary.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m1_binary.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m1_binary.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m1_half_rest.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m1_half_rest.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m1_half_rest.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m1_half_rest.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m4.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m4.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m4.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m4.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m4_ok.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m4_ok.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m4_ok.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m4_ok.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m4_slot1.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m4_slot1.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m4_slot1.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m4_slot1.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m4_slot1_ok.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m4_slot1_ok.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m4_slot1_ok.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m4_slot1_ok.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m5.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m5.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m5.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m5.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m5_ok.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m5_ok.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m5_ok.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m5_ok.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m7.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m7.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m7.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m7.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m7_ok.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m7_ok.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m7_ok.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m7_ok.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m7_separate_relation.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m7_separate_relation.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m7_separate_relation.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m7_separate_relation.png diff --git a/docs/_pages/ui_examples/trinitas/sheet1_m7_separate_voices.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m7_separate_voices.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet1_m7_separate_voices.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet1_m7_separate_voices.png diff --git a/docs/_pages/ui_examples/trinitas/sheet2_init.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet2_init.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet2_init.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet2_init.png diff --git a/docs/_pages/ui_examples/trinitas/sheet2_m17.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m17.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet2_m17.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m17.png diff --git a/docs/_pages/ui_examples/trinitas/sheet2_m17_ok.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m17_ok.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet2_m17_ok.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m17_ok.png diff --git a/docs/_pages/ui_examples/trinitas/sheet2_m2.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m2.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet2_m2.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m2.png diff --git a/docs/_pages/ui_examples/trinitas/sheet2_m2_ok.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m2_ok.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet2_m2_ok.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m2_ok.png diff --git a/docs/_pages/ui_examples/trinitas/sheet2_m6.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m6.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet2_m6.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m6.png diff --git a/docs/_pages/ui_examples/trinitas/sheet2_m6_long.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m6_long.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet2_m6_long.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m6_long.png diff --git a/docs/_pages/ui_examples/trinitas/sheet2_m9.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m9.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet2_m9.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet2_m9.png diff --git a/docs/_pages/ui_examples/trinitas/sheet3_init.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet3_init.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet3_init.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet3_init.png diff --git a/docs/_pages/ui_examples/trinitas/sheet3_m11.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet3_m11.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet3_m11.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet3_m11.png diff --git a/docs/_pages/ui_examples/trinitas/sheet3_m11_ok.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet3_m11_ok.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet3_m11_ok.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet3_m11_ok.png diff --git a/docs/_pages/ui_examples/trinitas/sheet3_m14.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet3_m14.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet3_m14.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet3_m14.png diff --git a/docs/_pages/ui_examples/trinitas/sheet3_m14_classifier.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet3_m14_classifier.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet3_m14_classifier.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet3_m14_classifier.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_init.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_init.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_init.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_init.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m11.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m11.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m11.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m11.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m12.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m12.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m12.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m12.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m13.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m13.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m13.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m13.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m14.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m14.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m14.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m14.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m14_binary.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m14_binary.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m14_binary.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m14_binary.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m15.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m15.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m15.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m15.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m16.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m16.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m16.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m16.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m16_ok.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m16_ok.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m16_ok.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m16_ok.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m17.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m17.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m17.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m17.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m18.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m18.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m18.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m18.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m19.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m19.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m19.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m19.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m1_2.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m1_2.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m1_2.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m1_2.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m1_2_3.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m1_2_3.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m1_2_3.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m1_2_3.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m1_2_ok.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m1_2_ok.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m1_2_ok.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m1_2_ok.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m1_voice_assign.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m1_voice_assign.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m1_voice_assign.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m1_voice_assign.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m7.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m7.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m7.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m7.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m8.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m8.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m8.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m8.png diff --git a/docs/_pages/ui_examples/trinitas/sheet4_m9.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m9.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet4_m9.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet4_m9.png diff --git a/docs/_pages/ui_examples/trinitas/sheet5_init.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet5_init.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet5_init.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet5_init.png diff --git a/docs/_pages/ui_examples/trinitas/sheet5_m10.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m10.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet5_m10.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m10.png diff --git a/docs/_pages/ui_examples/trinitas/sheet5_m17.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m17.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet5_m17.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m17.png diff --git a/docs/_pages/ui_examples/trinitas/sheet5_m17_1.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m17_1.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet5_m17_1.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m17_1.png diff --git a/docs/_pages/ui_examples/trinitas/sheet5_m17_2.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m17_2.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet5_m17_2.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m17_2.png diff --git a/docs/_pages/ui_examples/trinitas/sheet5_m2.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m2.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet5_m2.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m2.png diff --git a/docs/_pages/ui_examples/trinitas/sheet5_m20.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m20.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet5_m20.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m20.png diff --git a/docs/_pages/ui_examples/trinitas/sheet5_m2_ok.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m2_ok.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet5_m2_ok.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m2_ok.png diff --git a/docs/_pages/ui_examples/trinitas/sheet5_m4.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m4.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet5_m4.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m4.png diff --git a/docs/_pages/ui_examples/trinitas/sheet5_m6.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m6.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet5_m6.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m6.png diff --git a/docs/_pages/ui_examples/trinitas/sheet5_m8.png b/docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m8.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/sheet5_m8.png rename to docs/_pages/guides/ui/ui_examples/trinitas/sheet5_m8.png diff --git a/docs/_pages/ui_examples/trinitas/trinitas_word.png b/docs/_pages/guides/ui/ui_examples/trinitas/trinitas_word.png similarity index 100% rename from docs/_pages/ui_examples/trinitas/trinitas_word.png rename to docs/_pages/guides/ui/ui_examples/trinitas/trinitas_word.png diff --git a/docs/_pages/ui_foundations/README.md b/docs/_pages/guides/ui/ui_foundations/README.md similarity index 82% rename from docs/_pages/ui_foundations/README.md rename to docs/_pages/guides/ui/ui_foundations/README.md index 013a5ad17..6e2ce594d 100644 --- a/docs/_pages/ui_foundations/README.md +++ b/docs/_pages/guides/ui/ui_foundations/README.md @@ -1,12 +1,12 @@ --- layout: default -title: UI Foundations -parent: User Editing +title: UI foundations +parent: User editing nav_order: 1 has_children: true --- -# UI Foundations +# UI foundations This chapter introduces the key components the end user can interact with, be they simple entities like glyphs, inters or relations or more complex containers diff --git a/docs/_pages/ui_foundations/inspection.md b/docs/_pages/guides/ui/ui_foundations/inspection.md similarity index 81% rename from docs/_pages/ui_foundations/inspection.md rename to docs/_pages/guides/ui/ui_foundations/inspection.md index 303c2c4d1..580e028ee 100644 --- a/docs/_pages/ui_foundations/inspection.md +++ b/docs/_pages/guides/ui/ui_foundations/inspection.md @@ -1,8 +1,7 @@ --- layout: default title: Inspection -grand_parent: User Editing -parent: UI Foundations +parent: UI foundations nav_order: 3 --- @@ -13,19 +12,19 @@ In a perfectly transcribed score, all the items would be correctly recognized and every chord in every voice in every measure would start at the right time and span the right duration. -This beautiful mechanism can seize up for various reasons, large or small, and result in +This beautiful mechanism can seize up for various reasons, large or small, and lead to abnormal results. The purpose of this inspection chapter is to present various means for detecting such abnormal results and for discovering their root cause(s). +--- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} - --- + ## Measure background A pink measure background is the most obvious sign, meant to call user attention to a measure, @@ -34,11 +33,11 @@ background and the others with standard white background: [Unless we have disabled this feature via the menu item {{ site.view_errors }} or the `F9` function key or the related toolbar icon] - + -Even though the rhythm is defined at _measure stack_ level +Even though the rhythm is defined at the _measure stack_ level (denoted by the system-high red rectangle in the picture above), -abnormal rhythm is displayed down to _measure_ level +abnormal rhythm is displayed down to the _measure_ level (the part-high rectangle with pink background). The measure background is defined: @@ -47,8 +46,8 @@ The measure background is defined: A measure is detected as _abnormal_ -- and thus displayed in pink -- if, for at least one of its voices: -- Voice **starting time cannot be determined**, or -- Voice **ending time exceeds measure expected duration** +- The voice **starting time cannot be determined**, or +- The voice **ending time exceeds the measure expected duration** -- as defined by the current time signature Note that, conversely, a measure not detected as abnormal @@ -58,15 +57,19 @@ We'll see examples of these cases that today only the human reader can detect an ## Colorized voices - + The interest in choosing to colorize voices -(see [Voice colors](../main/voice_colors.md#voice-colors)) +(see [Voice colors](../../../tutorials/main_window/voice_colors.md#voice-colors)) is to visually check the content of every voice. In the example above, voice 6 which appears in the bottom right corner of the measure is really suspicious (although the measure is not flagged as _abnormal_). +## Jumbo mode + + + ## Chords IDs By default, chord IDs are not displayed in sheet view because they look too invasive. @@ -75,7 +78,7 @@ To set them on, we use the pull-down menu {{ site.view_chords }}. This gives the new picture below, where it is clear that we could merge chord 3963 and chord 3964 into a single chord: - + ## Measure strip @@ -84,7 +87,7 @@ all voices for the measure at hand. For example, let's focus on the measure below: - + `≡ Measure #N | Dump stack voices` prints a strip for the whole system-high measure stack. `≡ Measure #N | Dump measure voices` prints a strip for just the part-high measure. @@ -94,7 +97,7 @@ system, to allow to focus on one part at a time. Here is a measure strip at stack level (with part P1 and part P2): - + Strip legend: - The strip top line displays the time offset of each slot within the measure. @@ -117,9 +120,9 @@ Here again there is nothing, from the OMR engine point of view, to flag this mea ## Time slots -Time slots are not visible in  physical mode. -They are displayed in  combined and - logical modes +Time slots are not visible in  physical mode. +They are displayed in  combined and + logical modes -- provided that the {{ site.view_annotations }} flag is on. A time slot is displayed as a thin vertical gray line, with its time offset value at the top. @@ -129,7 +132,7 @@ Here below, we can see 4 slots with respective offsets: | ---: | :---: | :---: | :---: | :---: | | Time Offset: | 0 | 1/4 | 1/2 | 3/4 | - + In this picture, we can notice that slot #3 at offset 1/2 looks strange, with no chord aligned with it. @@ -148,7 +151,7 @@ slot#3 start= 1/2 [V1 Ch#3979 s:7 Dur= 1/4, V5 Ch#4010 s:9 Dur= 1/2] These outputs are not very readable, but they say that this slot contains chords 3979 and 4010. Which looks strange. -A more readable output is available, but only in  +A more readable output is available, but only in  combined mode. We simply press the right mouse button and move it near a time slot, while staying vertically within part stave(s). @@ -156,7 +159,7 @@ This highlights both the designated slot and the slot-related chords as in the p | Correct slot #1 at offset 0 | | Abnormal slot #3 at offset 1/2 | | :---: | --- | :---: | -|| || +|| || We can immediately see that slot at offset 1/2 wrongly contains chords 4010 and 3979. diff --git a/docs/_pages/ui_foundations/principles.md b/docs/_pages/guides/ui/ui_foundations/principles.md similarity index 71% rename from docs/_pages/ui_foundations/principles.md rename to docs/_pages/guides/ui/ui_foundations/principles.md index 08327d10f..1613ae9d6 100644 --- a/docs/_pages/ui_foundations/principles.md +++ b/docs/_pages/guides/ui/ui_foundations/principles.md @@ -1,8 +1,7 @@ --- layout: default title: Principles -grand_parent: User Editing -parent: UI Foundations +parent: UI foundations nav_order: 1 --- @@ -19,11 +18,11 @@ interactive user. Some pixels may have been gathered into **Glyph** instances by the OMR engine, but this "_segmentation_", as it is called, is not always relevant, especially on poor quality images. -The entities that really matter for the final music content are the **Inter** (interpretation) -instances and the **Relation** instances that formalize a relationship between two Inter instances, +The entities that really matter for the final music content are the **`Inter`** (interpretation) +instances and the **Relation** instances that formalize a relationship between two `Inter` instances, resulting in the **SIG** (Symbol Interpretation Graph) of each system. If you are still unfamiliar with these notions of pixel / glyph / inter / relation / sig, please -have a look at the dedicated [Main Entities](../main/entities.md) section. +have a look at the dedicated [Main concepts](../../../tutorials/main_concepts/README.md) section. We can think of Audiveris OMR as a process that takes an image as input and produces as output a structured collection of music symbols. @@ -31,7 +30,7 @@ as output a structured collection of music symbols. * The OMR _engine_ is one actor, which moves forward from step to step, creating a bunch of entities. * The OMR _user_ is another actor, who can interactively modify some entities, -and decide how to move the engine. +and decide how to drive the engine. The resulting objects are divided into two categories: @@ -48,20 +47,20 @@ sheet musical content, organized in a hierarchical structure of containers: Since the 5.2 release, the user can partly modify this hierarchy, by splitting and merging systems, parts and measures. 2. **Inters**. -They represent candidate interpretations, formalized by `Inter` instances, handled -within each system by a graph (`SIG`) of Inter vertices linked by Relation edges. +They represent candidate interpretations, formalized by ``Inter`` instances, handled +within each system by a graph (`SIG`) of `Inter` vertices linked by `Relation` edges. Within each system SIG, it's the struggle for life, since only the strongest inters survive in the end. -There is no structure within the Inter instances of a SIG, just `Relation` instances possibly set -between a pair of Inter instances. -Since the 5.2 release, all these Inter and Relation instances can be modified interactively. +There is no structure within the `Inter` instances of a SIG, just `Relation` instances possibly set +between a pair of `Inter` instances. +Since the 5.2 release, all these `Inter` and `Relation` instances can be modified interactively. - Inter objects are everything except the static containers mentioned above: + `Inter` objects are everything except the static containers mentioned above: - Barline, ledger, clef, key signature, time signature, chord, head, alteration, - augmentation dot, stem, beam, rest, flag, slur, sentence, word, etc... are examples of Inters. - - An _InterEnsemble_ is an Inter composed of other Inter instances. + augmentation dot, stem, beam, rest, flag, slur, sentence, word, etc... all are examples of `Inter` 's. + - An _InterEnsemble_ is an `Inter` composed of other `Inter` instances. This composition is formalized by a `Containment` relation between the ensemble inter and - each of the contained Inter instances. + each of the contained `Inter` instances. These ensembles can be: - A Chord which contains one or several note heads or one rest. - A Sentence which contains words. @@ -73,9 +72,9 @@ Since the 5.2 release, all these Inter and Relation instances can be modified in Measures are hybrid, since they are not Inters but depend on barlines which are Inters. -Beside Inter and Relation entities, glyphs, which are just sets of foreground pixels, can be used +Beside `Inter` and `Relation` entities, the glyphs, which are just sets of foreground pixels, can be used to create new Inters. -Hence, Glyph instances are also entities that the user can select and transcribe to Inter entities. +Hence, Glyph instances are also entities that the user can select and transcribe to `Inter` entities. The Audiveris editor has been designed to work on the SIG data model, -that is essentially to play directly with Inter and Relation instances. +that is essentially to play directly with `Inter` and `Relation` instances. diff --git a/docs/_pages/ui_foundations/selection.md b/docs/_pages/guides/ui/ui_foundations/selection.md similarity index 68% rename from docs/_pages/ui_foundations/selection.md rename to docs/_pages/guides/ui/ui_foundations/selection.md index b680e9016..1bde94afa 100644 --- a/docs/_pages/ui_foundations/selection.md +++ b/docs/_pages/guides/ui/ui_foundations/selection.md @@ -1,17 +1,16 @@ --- layout: default title: Selection -grand_parent: User Editing -parent: UI Foundations +parent: UI foundations nav_order: 2 --- # Selection {: .no_toc } +--- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- @@ -25,7 +24,7 @@ The length of each segment does not vary with the zoom ratio, but the segment th | Zoom: 1 | Zoom: 8| | --- | --- | -||| +||| To define the current **point**, we either: * Press down the left or the right mouse button at the desired location. @@ -38,7 +37,7 @@ and keep the `SHIFT` key pressed while dragging the mouse. * Or, if the Pixel-Board is displayed, type numeric values in the X, Y, Width and Height fields. To precisely **shift** the current location: -* While keeping the `ALT` key pressed (`OPTION` key on MacOS), we use one of the 4 arrow keys +* While keeping the `ALT` key pressed (`OPTION` key on macOS), we use one of the 4 arrow keys to move the location (point or rectangle) one pixel at a time. ## Entity selection @@ -46,9 +45,9 @@ to move the location (point or rectangle) one pixel at a time. ### Selection modes There are 3 selections modes available: -1.  _glyph+inter_ based (the default) -2.  _inter_-only based -3.  _section_-only based. +1.  _glyph+inter_ based (the default) +2.  _inter_-only based +3.  _section_-only based. To switch from one mode to another, we use the toggle menu item {{ site.view_selections }}, click on the related toolbar icon or press the `F11` function key. @@ -59,28 +58,28 @@ The mouse-based selection works as expected, pointing to glyph entities, inter e section entities, according to the current selection mode. * **Pointing to an entity**: - A _left_-button mouse click grabs the entities that contain the + - A _left_-button mouse click grabs the entities that contain the location point. If several entities are grabbed, only one is chosen to start the new selection. - For glyphs, it's the smallest one. - For inters, it's the member before the ensemble. - A _right_-button mouse click opens the pop-up menu: - - with just the pointed entity if the previous selection was empty, - - with the previous selection if the previous selection was not empty. + - For glyphs, it's the smallest one. + - For inters, it's the member before the ensemble. + - A _right_-button mouse click opens the pop-up menu: + - with just the pointed entity if the previous selection was empty, + - with the previous selection if the previous selection was not empty. * **Using a lasso**: Pressing the `SHIFT` key while dragging with the mouse left-button defines a rectangular area. - All entities fully contained in this area start a new selection. + All entities *fully contained* in this area start a new selection. -* **Adding an entity**: A left click on an entity while pressing the `Ctrl` key (`Command` key for MacOS) +* **Adding an entity**: A left click on an entity while pressing the `Ctrl` key (`Command` key for macOS) adds this entity to the current selection, whether the selection was done via point or lasso. * **Naming an entity**: Entering the integer ID of a glyph in the Glyph-Board spinner or the ID - of an Inter in the Inter-Board spinner selects this entity. + of an `Inter` in the `Inter`-Board spinner selects this entity. - **Pointing outside of any entity**: -A left click clears both glyphs and inters selections. -A right click opens the pop-up menu (with the entities selected so far). + - A left click clears both glyphs and inters selections. + - A right click opens the pop-up menu (with the entities selected so far). * **Choosing an entity in the selection list**: The contextual pop-up menu, when entities have been selected, offers in the `Glyphs` and `Inters` sub-menus the list of selected entities. @@ -90,27 +89,27 @@ A right click opens the pop-up menu (with the entities selected so far). selected inter displays a sub-menu with all the relations the inter is part of. Selecting a relation offers to dump or delete this relation. -* **Double-click**: A double-click with the left mouse button on an Inter (not a Glyph) selects that - Inter and puts it in `Editing mode` (see [Inter editing](../ui_tools/edit_inter.md)). +* **Double-click**: A double-click with the left mouse button on an `Inter` (not a Glyph) selects that + `Inter` and puts it in `Editing mode` (see [`Inter` editing](../ui_tools/edit_inter.md)). A selected inter may display links to its related inter entities. The links appear as short straight lines in light green color --- together with the relation name if the zoom is high enough --. -The images below depict: +-- together with the relation name if the zoom is high enough. +The images below depict: 1. A tuplet glyph linked to its 3 embraced chords -2. A note head connected to a stem and a slur +2. A note head connected to a stem and to a slur 3. Lyrics text with links to the related chords | Tuplet | Head | Lyrics | | --- | --- | --- | -|  |  |  | +|  |  |  | ### Multi-selection A left-click in an entity area selects this entity (and deselects the entity previously selected if any). - + To select several entities: @@ -124,36 +123,36 @@ This can especially be useful when having selected several items using the "lass de-select items that are not wanted. A red rectangle always shows our selection frame. -When in  _glyph+inter_ mode, an additional black rectangle -shows the bounding box of a compound glyph built from all selected glyphs. +When in  _glyph+inter_ mode, an additional black rectangle +shows the bounding box of a compound glyph built from all the selected glyphs. Moreover, an entity changes color when it gets selected (a glyph turns red, an inter turns to nearly-reverse color, a section turns white). -### Member vs Ensemble +### Member vs. ensemble Selecting an entity by pointing at it can be ambiguous. This can be the case when two or more **Glyphs** overlap each other. When we point at an overlapping region, the software will pick up only the smallest glyph. -This is by definition always the case when pointing at an **Inter** which is a member of an -**Inter ensemble**, for example a note and its containing chord. -In this case, the software will choose the member over the ensemble, knowing that you can later -switch from selected member to selected ensemble in the Inter-board +This is by definition always the case when pointing at an **`Inter`** which is a member of an +**`Inter` ensemble**, for example a note and its containing chord. +In this case, the software will choose the member over the ensemble, knowing that we can later +switch from selected member to selected ensemble in the `Inter`-board (and in the Inters pop-up menu). For example: - + Here, we have pointed on a note head which is part of a head chord. We can note the (member) head inter is selected over the (ensemble) chord inter, the involved "_HeadStem_" -relation is visible between head and stem, the Inter-board focuses on the head inter, +relation is visible between head and stem, the `Inter`-board focuses on the head inter, with the `To Ensemble` button enabled. - + -Here, we have pressed `To Ensemble` button, and the focus is now on the head chord, +Here, we have pressed the `To Ensemble` button, and the focus is now on the head chord, with the "_ChordSyllable_" relation to the lyric item "Ver" below. ## Container selection @@ -165,7 +164,7 @@ This pop-up displays contextual information -- such as the selected glyphs, inters, etc, if any -- together with the containers being pointed at. - + For example, the pop-up above allows to access -- beside chords, inters and glyphs -- the containers related to current mouse location: diff --git a/docs/_pages/ui_tools/README.md b/docs/_pages/guides/ui/ui_tools/README.md similarity index 85% rename from docs/_pages/ui_tools/README.md rename to docs/_pages/guides/ui/ui_tools/README.md index 3b842cb81..057c59c56 100644 --- a/docs/_pages/ui_tools/README.md +++ b/docs/_pages/guides/ui/ui_tools/README.md @@ -1,11 +1,19 @@ --- layout: default -title: UI Tools -parent: User Editing +title: UI tools +parent: User editing nav_order: 2 has_children: true --- -# UI Tools +# UI tools +{: .no_toc } + +--- +Table of contents +{: .no_toc .text-epsilon } +1. TOC +{:toc} +--- ## Interaction with the OMR engine @@ -49,15 +57,15 @@ task history. The ``Undo`` command cancels the last task sequence (whether it was a do or a redo) with all its consequences. -* We press the **Undo** button  on the tool bar, -* Or type `Ctrl+Z` (`Command+Z` for MacOS) +* We press the **Undo** button  on the tool bar, +* Or type `Ctrl+Z` (`Command+Z` for macOS) ### Redo The ``Redo`` command re-performs the last un-done task sequence. -* We press the **Redo** button  on the tool bar, -* Or type `Ctrl+Shift+Z` (`Command+Shift+Z` for MacOS). +* We press the **Redo** button  on the tool bar, +* Or type `Ctrl+Shift+Z` (`Command+Shift+Z` for macOS). ## When to interact? @@ -73,11 +81,11 @@ we must be careful! This tells us that beam-related data could not reach the quorum needed to infer a reliable thickness value. So, let's measure the actual beam thickness on our own (using the Pixel Board) and modify -the beam scale if needed (see the [Sheet scale](../main/sheet_scale.md) section). +the beam scale if needed (see the [Sheet scale](../../main/sheet_scale.md) section). * **GRID** step is where staff lines, then staves and systems are detected. Hence, this is the most convenient point to interact if we need to manually modify lines -and staves (see the [Staff editing](./staff_editor.md) section). +and staves (see the [Staff editing](./staff_editing.md) section). * **REDUCTION** step is where all candidate note heads are combined with candidate stems and beams and then reduced to come up with reliable notes @@ -86,8 +94,6 @@ It is a key moment in the engine pipeline, because these "reliable" notes will n question by the following steps. So much so that their underlying pixels will not be presented to the glyph classifier during the `SYMBOLS` step. -This includes a "dilation" margin ring around each note head, something that the user cannot select -as a glyph in any subsequent selection. So, if some of these notes are false positives, then it's much more efficient to correct them immediately, at the end of the REDUCTION step. diff --git a/docs/_pages/ui_tools/add_inter.md b/docs/_pages/guides/ui/ui_tools/add_inter.md similarity index 68% rename from docs/_pages/ui_tools/add_inter.md rename to docs/_pages/guides/ui/ui_tools/add_inter.md index f781b72b8..9c7766b7a 100644 --- a/docs/_pages/ui_tools/add_inter.md +++ b/docs/_pages/guides/ui/ui_tools/add_inter.md @@ -1,22 +1,21 @@ --- layout: default -title: Inter Addition -grand_parent: User Editing -parent: UI Tools +title: Inter addition +parent: UI tools nav_order: 1 --- -# Inter Addition +# `Inter` addition {: .no_toc } -In the Audiveris data model, an Inter instance represents an interpretation, that is a candidate +In the Audiveris data model, an `Inter` instance represents an interpretation, that is a candidate likely to become a musical symbol in the end. -A manually created Inter is flagged as `MANUAL` and cannot be called into question by the +A manually created `Inter` is flagged as `MANUAL` and cannot be called into question by the OMR engine, it is considered as certain. -We can manually create an Inter instance from a selected glyph, by "assigning" this glyph the +We can manually create an `Inter` instance from a selected glyph, by "assigning" this glyph the desired shape. -If we have no suitable glyph available, we can still create an Inter from nothing, via a simple +If we have no suitable glyph available, we can still create an `Inter` from nothing, via a simple drag & drop from the shape palette. In both cases, we may have to specify the target staff for the created inter if the context is not @@ -24,46 +23,48 @@ clear enough for the engine. --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- -## Inter from underlying Glyph +## `Inter` from the underlying glyph -Inter creation from a glyph is the only case where a glyph is used in Audiveris manual editing. +`Inter` creation from a glyph is the only case where a glyph is used in Audiveris manual editing. The set of black pixels of one or several selected glyphs can be transcribed as one inter, by specifying the target inter shape. The precise location and bounds of the new inter are defined by the underlying set of pixels. {: .note } -This method of selecting a glyph to "assign" an Inter to it, requires of course that a **suitable +This method of selecting a glyph to "assign" an `Inter` to it, requires of course that a **suitable glyph** be available. In we can't find any such glyph, we'll have to drag & drop the desired shape from the shape palette instead. -Also, knowing the target location is not always sufficient to detect the Inter **target staff**. +Also, knowing the target location is not always sufficient to detect the `Inter` **target staff**. Several heuristics are used by the software, but if they fail we will be prompted for the target staff: - + The target shape can be specified via different means, as follows. ### Via the glyph classifier - + This classifier automatically operates on the current glyph, be it the single selected glyph or a transient glyph built on-the-fly from a multi-glyph selection. -Chances are we'll find our desired shape in this top 5. If so, we just press the shape button. +Chances are we'll find our desired shape in this "top 5". +If so: +- We can just press the shape *button* with the mouse left button +- Or, on the keyboard, we can type the *number* (generally in 1..5 range) +corresponding to the rank of our desired shape within the top 5. {: .note } -In order to use this method, the target shape must be handled by the glyph classifier -(based on a neural-network). +In order to use this classifier method, the target shape must be handled by the glyph classifier. This is **NOT** the case for the following shapes: - **Lines** (staff lines, ledgers, barlines, stems, slurs, endings) use ad-hoc methods, - **Beams** use image morphological closing, @@ -75,8 +76,9 @@ The top 5 is just a raw output of the glyph classifier, which runs on the glyph that is ***without taking the neighborhood into account***. This means that: - a dot (augmentation, staccato, ...) will be at best recognized as `DOT_set`, - - and a half or whole rest as `HW_REST_set`. -For these two cases -- and only for them -- the glyph classifier is not precise enough. + - a half or whole rest as `HW_REST_set`, + - a grace note or an 8th beat unit as `EIGHTH_set` . +For these three cases -- and only for them -- the glyph classifier is not precise enough. We'll have to explicitly select a more specific target shape, via the glyph pop-up menu or via the shape palette. @@ -85,7 +87,7 @@ or via the shape palette. Once a glyph has been selected, we use a mouse right click to access the {{ site.popup_glyphs }} sheet contextual menu. - + Then we navigate through shape sets to our precise target shape. @@ -94,11 +96,11 @@ Then we navigate through shape sets to our precise target shape. The shape palette (see next section) allows to assign a shape to the selected glyph. This is done by a double-click on the desired shape in the palette. -## The Shape Palette +## The shape palette The palette offers the ability to choose the desired shape for a selected glyph. -And even if no precise glyph can be selected, we can directly drag a "ghost" Inter +And even if no precise glyph can be selected, we can directly drag a "ghost" `Inter` from the shape palette, located on the right side of the sheet view, and drop this ghost at the desired target location. @@ -106,36 +108,36 @@ The starting aspect of the shape palette is a catalog of all shape sets. It exhibits a dark-gray background, with one representative button for each shape set. Nothing can be dragged from this catalog, we must first select a shape set: - + ### Entering a shape set Pressing a shape set button replaces the catalog view by a specific palette dedicated to the selected shape set. For example, pressing on the ``ClefsAndShifts`` set button gives: - + Within a set, a shape can be: * Assigned (by a left double-click) if a glyph has been selected, * Or dragged and dropped to a target location. - + -### Selecting target staff -While we are dragging a shape, we have the freedom to hover where we like. -The last staff we have been hovering over is selected as our current target staff. +### Selecting the target staff +While we are dragging a shape, we have the freedom to move it wherever we want. +The last staff we hovered over is selected as the current target staff. Before we "select" a staff, the dragged shape "ghost" is displayed isolated in dark-gray. Once a staff has been "selected", a thin vertical red segment goes from the shape center to -the target staff middle line, the shape turns into the Inter selected color, additional objects +the target staff middle line, the shape turns into the `Inter` selected color, additional objects can appear -- such as intermediate ledgers or potential relations with nearby inters --, it may get snapped according to staff lines, etc. | before staff selection | after staff selection | | --- | --- | -|  |  | +|  |  | We can drop the shape only when a staff target has been selected. If not, the drag & drop action is abandoned. @@ -144,7 +146,7 @@ If not, the drag & drop action is abandoned. Note the ``HeadsAndDot`` set now contains four new shapes located at the end. - + These are quarter notes and half notes, with stem either up or down. There are called "compound" because they combine two shapes: a head shape and a stem shape. @@ -154,7 +156,7 @@ or ledger and the stem can still be automatically linked to beams nearby. {: .note } Once dropped, such a compound shape is replaced by two separate Inters -(head Inter and stem Inter) linked by a HeadStemRelation. +(head `Inter` and stem `Inter`) linked by a HeadStemRelation. We can then later edit each "part" separately, for example to modify the stem length. And we can add flags to the stem. @@ -163,7 +165,7 @@ To leave the specific set palette and go back to the catalog view, we can: * Click on the "triangle-up" sign located on the left side of the set palette, -  +  * Or press the `ESC` key on the keyboard. ## Shape cache @@ -171,7 +173,7 @@ To leave the specific set palette and go back to the catalog view, we can: We can notice, appearing on a line above the shape palette, the list of the most recent shape buttons we have used so far. - + These _cached_ buttons are meant for further direct access, avoiding the navigation to their containing sets. @@ -187,33 +189,33 @@ temporarily to the "_Repetitive Input_" mode. We click on the toolbar icon or select the menu item {{ site.sheet_repetitive }} or use the shortcut `Ctrl+Shift+N` and this mode is now set on. - + -From that point on, pressing with the left-button anywhere on the sheet will add a new Inter +From that point on, pressing with the left-button anywhere on the sheet will add a new `Inter` (with the latest shape used) at the designated location. -We can shift the Inter location precisely, then release the mouse when we are satisfied. +We can shift the `Inter` location precisely, then release the mouse when we are satisfied. If we press the left-button again, yet another instance will be created, and so on. That's the rule, so let's mind our mouse press actions! -The latest Inter inserted is left in "Inter editing mode" with its editing handle(s) displayed. -We can press the `Enter` key to finish this edit, -or click somewhere else to create another Inter. +The latest ``Inter`` inserted is left in "`Inter` editing mode" with its editing handle(s) displayed. +We can press the `ENTER` key to finish this edit, +or click somewhere else to create another ``Inter``. This repetitive mode is meant for simple shapes -- like a head, a rest, an accidental, etc. -- that don't require any further resizing. -But what if we really need to resize the inserted Inter? +But what if we really need to resize the inserted `Inter`? We simply set the repetitive mode off, so that we can press and drag the inter editing handles. -Then we set the repetitive mode on again if so desired. +Then, we can set the repetitive mode on again if so desired. To exit this rather specific mode, we toggle the mode (via the toolbar icon, the menu item or the shortcut). -## Relations with other inters +## Relations with other ``Inter``'s -Key relation(s) with the nearby Inter(s), if any, will be updated automatically as we create --- or later edit -- the Inter, but only as long as the required geometrical relationships can apply +Key relation(s) with the nearby `Inter`(s), if any, will be updated automatically as we create +-- or later edit -- the `Inter`, but only as long as the required geometrical relationships can apply (for example, as long as an accidental is sufficiently close to a note head on its right side). If the relation constraints are not met, we will have to set the relation manually afterwards. @@ -232,13 +234,12 @@ They all work with a sequence of 2 strokes: Example: Let's press `h` (heads) then `b` (black) and we get the `HeadsAndDot` set content displayed and the black head shape in the cache. - + If we had a glyph selected beforehand, this glyph is assigned the selected shape. If not, no glyph gets assigned, but the shape cache now presents our selected shape in first position, ready for further use (via double-click, drag & drop or repetitive input). -*** ### Shortcuts table @@ -251,5 +252,6 @@ Only sets and shapes that are used rather often are supported. |**d** |dynamics | **p** (piano), **m** (mezzoforte), **f** (forte) |**f** |flags | **u** (up), **d** (down) |**h** |heads | **w** (whole), **v** (void), **b** (black), **d** (augmentation dot), **h** (half-note), **q** (quarter-note) +|**p** |physicals | **a** (slur above), **b** (slur below), **s** (stem) |**r** |rests | **1**, **2**, **4**, **8** (full, half, quarter, eighth) -|**p** |physicals | **l** (lyrics), **t** (text), **a** (slur above), **b** (slur below), **s** (stem) +|**t** |texts | **l** (lyrics), **t** (text), **m** (metronome) diff --git a/docs/_pages/ui_tools/add_relation.md b/docs/_pages/guides/ui/ui_tools/add_relation.md similarity index 75% rename from docs/_pages/ui_tools/add_relation.md rename to docs/_pages/guides/ui/ui_tools/add_relation.md index 8f8716fae..bbea5d7f8 100644 --- a/docs/_pages/ui_tools/add_relation.md +++ b/docs/_pages/guides/ui/ui_tools/add_relation.md @@ -1,39 +1,37 @@ --- layout: default -title: Relation Addition -grand_parent: User Editing -parent: UI Tools +title: Relation addition +parent: UI tools nav_order: 4 --- -# Relation Addition +# Relation addition {: .no_toc } --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- -Most Inter instances have relations with other Inter instances. +Most `Inter` instances have relations with other `Inter` instances. For example the note head below exhibits 2 relations: - a _SlurHead_ relation between slur and note head, - a _HeadStem_ relation between note head and stem. - + -We can visually check the relations when we select an Inter. +We can visually check the relations when we select an `Inter`. The name of each relation is also displayed, provided that the current zoom is high enough (>=2). -## Mandatory vs non-mandatory relations +## Mandatory vs. non-mandatory relations -Depending on the Inter class, an Inter instance may need a relation with another Inter instance. +Depending on the `Inter` class, an `Inter` instance may need a relation with another `Inter` instance. -If an Inter instance lacks a mandatory relation, it should somehow be removed before the end of +If an `Inter` instance lacks a mandatory relation, it should somehow be removed before the end of the transcription process. -This is the case when created as a candidate by the OMR engine but, if the Inter at hand was +This is the case when created as a candidate by the OMR engine but, if the `Inter` at hand was manually added, it can't be automatically removed by the engine. It is simply flagged as "_abnormal_" and shown in red to call the user's attention on it. @@ -42,7 +40,7 @@ In the example below, a _SlurHead_ relation between slur and note head is mandat | non-linked slur | linked slur | | --- | --- | -|  |  | +|  |  | A missing relation can happen when the geometry rules are not matched, perhaps because the gap is a bit too wide between the slur and any note head. @@ -71,9 +69,9 @@ Assuming the slur is not linked to the note head, we need to insert the relation To do so, we can point and drag from the slur to the note head (a thin black vector will appear as we move the mouse, see picture below) - + -Then we release the mouse when reaching the targeted head. +Then, we release the mouse when reaching the targeted head. Audiveris will search among all the inters grabbed at the first and last locations, find the missing relation if any between those two collections of inters and set the proper relation. diff --git a/docs/_pages/ui_tools/chords.md b/docs/_pages/guides/ui/ui_tools/chords.md similarity index 79% rename from docs/_pages/ui_tools/chords.md rename to docs/_pages/guides/ui/ui_tools/chords.md index a7a13415e..73c7b3158 100644 --- a/docs/_pages/ui_tools/chords.md +++ b/docs/_pages/guides/ui/ui_tools/chords.md @@ -1,8 +1,7 @@ --- layout: default title: Chords -grand_parent: User Editing -parent: UI Tools +parent: UI tools nav_order: 12 --- # Chords @@ -17,13 +16,12 @@ rather than its containing chord (this is the rule known as "_member over ensemb However, by selecting one or several notes, we can indirectly select and act on these chords. -This is made possible via the usual pop-up menu which can provides a specific `Chords...` +This is made possible via the usual pop-up menu which can provide a specific `Chords...` sub-menu, whose content tightly depends on the chords configuration. --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- @@ -33,7 +31,7 @@ Table of contents Below, we have selected two notes as indicated by the arrows: one note head and one rest, before opening the {{ site.popup_chords }} contextual menu: - + Notice that the global bounding box (gray rectangle) encompasses the bounds of both chords. @@ -44,12 +42,12 @@ This is meant to allow a visual check of the selected chords: | all chords | first chord | second chord | | --- | --- | --- | -|  |  |  | +|  |  |  | To ease manual dealing with chords, we can make each chord ID visible as in the picture below (via the pull-down menu {{ site.view_chords }}): - + {: .note} The example Chords menu above shows only a partial list of possible chords actions, @@ -65,13 +63,13 @@ The gathering of note heads into chords may need some user correction. | One chord? | Two chords? | | --- | --- | -|  |  | +|  |  | The OMR engine may have considered this as just one chord with a long stem, whereas we find these are in fact two separate chords, one above the other. In that case, select this chord and use the ``Split`` command. - + ### Merge @@ -82,7 +80,7 @@ In the specific case of whole notes, the ``Merge`` command is often needed. Because there is no stem involved, the engine has no clear heuristic [^whole_chord] to gather whole heads into one chord. - + ## Voice @@ -97,7 +95,7 @@ The purpose of these voice actions is to guide the engine in voice building. ### Next in Voice - + The `Next in Voice` command operates on a horizontal sequence of 2 chords, say chord A and chord B, by establishing a relation from A to B, @@ -108,11 +106,11 @@ stating two things: In other words, chord B time slot should **immediately** follow chord A time slot. So we have a double dynamic propagation rule: on voice and on time. -This is the reason why ``Next in Voice`` should be preferred whenever possible over `Same Voice` command. +This is the reason why ``Next in Voice`` is now preferred to the old `Same Voice` command. Here is the result: - + We can always **undo** such an action, as any other UI action described here, via the `Sheet → Undo` or `Ctrl+Z` standard commands. @@ -123,16 +121,8 @@ Cancelling this action removes the relation (and thus the related guidance). ### Same Voice -`Same Voice` command is weaker than `Next in Voice` command. - -It states only that the two selected chords should belong to the same voice. - -It provides no information about related time values. -This is the reason why the `Next in Voice` relation should be preferred whenever possible. - -Note that `Same Voice` (or `Next in Voice`) can be used in the context of rest chords interleaved -between beam head chords, to "push" these rests into the beam area. -And conversely, `Separate Voice` can be used to "pull" these rests out of the beam area. +Since 5.4 release, the old `Same Voice` command has been deprecated in favor of +the more efficient `Next in Voice` command. ### Separate Voices @@ -145,16 +135,16 @@ Note this is not exactly the reverse of the `Next in Voice` command ### Preferred Voice -Whereas the `Next in Voice`/`Same Voice" and "Separate Voices" commands operate on 2 chords, +Whereas the `Next in Voice`/`Same Voice` and `Separate Voices` commands operate on 2 chords, by establishing a **dynamic** computing rule from chord A to chord B, -the `Preferred Voice` command operates on the single chord at hand, by assigning this chord a **fixed** voice -numeric value. +the `Preferred Voice` command operates on the single chord at hand, +by assigning this chord a **fixed** voice numeric value. This feature is effective only on the _first chord_ in each measure voice. It can be useful only for the very first chord of a voice in a system: -- Because the A-B relations can take place only within the same system (SIG), there is no way to -establish a voice computing rule across systems. +- Because the A-B relations can take place only within the same system (SIG), +there is no way to establish a voice computing rule across systems. - Specifically, we may need a way to set the voice number of a chord at the start of the very first measure of a movement. @@ -173,7 +163,7 @@ time slot? ### Same Time Slot - + Here, we can see that time slots on the second staff of the part are not correctly assigned. This is because the whole note on the upper staff and the 8th note on the lower staff are too far apart diff --git a/docs/_pages/ui_tools/edit_inter.md b/docs/_pages/guides/ui/ui_tools/edit_inter.md similarity index 55% rename from docs/_pages/ui_tools/edit_inter.md rename to docs/_pages/guides/ui/ui_tools/edit_inter.md index 0ed28bec7..80840d651 100644 --- a/docs/_pages/ui_tools/edit_inter.md +++ b/docs/_pages/guides/ui/ui_tools/edit_inter.md @@ -1,46 +1,44 @@ --- layout: default -title: Inter Editing -grand_parent: User Editing -parent: UI Tools +title: Inter editing +parent: UI tools nav_order: 2 --- -# Inter Editing +# `Inter` editing {: .no_toc } -Since 5.2 release, any Inter -- whether it has been created by the OMR engine, +Since 5.2 release, any `Inter` -- whether it has been created by the OMR engine, manually created from a glyph or dragged & dropped from the shape palette -- can be edited in terms of precise location and size. -This is now the default general behavior, knowing that, depending on the Inter class at hand, +This is now the default general behavior, knowing that, depending on the `Inter` class at hand, our mileage may vary. -And an Inter being edited has a behavior identical to one being dragged & dropped, +And an `Inter` being edited has a behavior identical to one being dragged & dropped, in terms of dynamic relations evaluation and in terms of potential snapping to items nearby. --- Table of contents -{: .text-delta } - +{: .text-epsilon } 1. TOC {:toc} --- ## Entering editing mode -To start editing an Inter, we must first set it into `editing mode`: -- This is most conveniently done by a left double-click on the Inter. -- If the Inter is already selected, the InterBoard on the right displays information about it. - In this board, the `Edit` checkbox can be used to set the Inter into editing mode. +To start editing an `Inter`, we must first set it into `editing mode`: +- This is most conveniently done by a left double-click on the `Inter`. +- If the `Inter` is already selected, the InterBoard on the right displays information about it. + In this board, the `Edit` checkbox can be used to set the `Inter` into editing mode. -  +  -## Inter handles +## `Inter` handles -The Inter being edited now displays a set of one or several handles, depending on the -Inter class. +The `Inter` being edited now displays a set of one or several handles, depending on the +`Inter` class. - + Handles are displayed as small squares with rounded corners, filled in black for the current handle, in white for the others. Clicking on another handle makes it the new current handle. @@ -49,18 +47,18 @@ A handle is meant to be moved: - either by mouse dragging, - or by pressing the keyboard `ALT+ ←/↑/↓/→` keys in the desired direction. -Clicking on any location other than Inter handles makes the Inter exit its editing mode and +Clicking on any location other than `Inter` handles makes the `Inter` exit its editing mode and commits the editing. - + By default, just one handle is displayed as in the case of the 16th rest shown above, allowing the inter to be shifted in any direction. Since this inter exhibits only one handle, it offers no resizing capability -- not surprisingly, we cannot resize a 16th rest symbol. - + In the case of a beam, 3 handles are displayed. -The center handle shifts the beam in any direction. +The center handle shifts the whole beam in any direction. The left or the right handle moves just this beam edge in any direction, leaving the other edge in place. @@ -69,12 +67,12 @@ the related stems can come and go according to the possible geometric connection being moved or resized and the (static) stems. These are just two typical examples. -See the [Inter Editors](../ui_tools/inter_editors.md) reference section for a description -of all available Inter editors. +See the [`Inter` Editors](../../../reference/editors.md) reference section for a description +of all available `Inter` editors. ## Exiting editing mode Finally, to complete the on-going editing, we simply press the `Enter` key or -click on any location other than the Inter handles. +click on any location other than the `Inter` handles. It is always possible to undo (and redo) any manual editing. diff --git a/docs/_pages/ui_tools/key.md b/docs/_pages/guides/ui/ui_tools/key.md similarity index 75% rename from docs/_pages/ui_tools/key.md rename to docs/_pages/guides/ui/ui_tools/key.md index 76485e152..30ee1b1f2 100644 --- a/docs/_pages/ui_tools/key.md +++ b/docs/_pages/guides/ui/ui_tools/key.md @@ -1,8 +1,7 @@ --- layout: default -title: Key Signature -grand_parent: User Editing -parent: UI Tools +title: Key signature +parent: UI tools nav_order: 10 --- # Key Signature @@ -16,8 +15,7 @@ It must be built or modified **globally**: --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- @@ -25,15 +23,16 @@ Table of contents ## Flats and Sharps When dragging a "ghost" key from the shape palette, the ghost turns from dark-gray to green -when we enter a staff and, as usual, a thin red segment is drawn from the ghost center to the staff mid line. +when we enter a staff and, as usual, a thin red segment is drawn from the ghost center +to the staff mid line. -Moreover, the dragged key snaps immediately to the proper vertical position, according to the -effective clef at the point of insertion. +Moreover, the dragged key snaps immediately to the proper vertical position, +according to the effective clef at the point of insertion. For example, let's insert a 2-sharp key, into the measure that follows the measure with a 3-sharp key: - + Note the two sharp signs are located on F and C steps respectively, and they can move only horizontally until we release the mouse. @@ -50,9 +49,9 @@ However, we have the ability to manually insert a _cancel key_ -- i.e. an all-na To do so, we drag the 1-natural key from the shape palette and move it to the desired insertion point. - + -When we enter the target staff, the 1-natural ghost key with turn as usual from dark-gray to +When we enter the target staff, the 1-natural ghost key will turn as usual from dark-gray to green, but its configuration and position will be dynamically updated, to fit both: * The effective **clef**, * The effective **key** to be cancelled. @@ -62,10 +61,10 @@ with each natural sign located according to the corresponding sharp sign to canc | Staff-relative location| Cancel Key appearance| | --- | --- | -| Outside: |  | -| Inside: |  | +| Outside: |  | +| Inside: |  | -We notice that this works only when the ghost is located in a staff measure _different_ from +We can notice that this works only when the ghost is located in a staff measure _different_ from the staff measure that contains the key to be cancelled. This is so because there can't exist two keys in the same staff measure. diff --git a/docs/_pages/ui_tools/measure.md b/docs/_pages/guides/ui/ui_tools/measure.md similarity index 82% rename from docs/_pages/ui_tools/measure.md rename to docs/_pages/guides/ui/ui_tools/measure.md index 2a24301d4..3e32f6764 100644 --- a/docs/_pages/ui_tools/measure.md +++ b/docs/_pages/guides/ui/ui_tools/measure.md @@ -1,11 +1,10 @@ --- layout: default -title: Measure Merge -grand_parent: User Editing -parent: UI Tools +title: Measure merge +parent: UI tools nav_order: 9 --- -# Measure Merge +# Measure merge {: .no_toc } A right-click in any measure stack allows us to merge this measure with the following one diff --git a/docs/_pages/ui_tools/octave_shift.md b/docs/_pages/guides/ui/ui_tools/octave_shift.md similarity index 90% rename from docs/_pages/ui_tools/octave_shift.md rename to docs/_pages/guides/ui/ui_tools/octave_shift.md index 8d2051023..9e0d1ae39 100644 --- a/docs/_pages/ui_tools/octave_shift.md +++ b/docs/_pages/guides/ui/ui_tools/octave_shift.md @@ -1,11 +1,10 @@ --- layout: default -title: Octave Shift -grand_parent: User Editing -parent: UI Tools +title: Octave shift +parent: UI tools nav_order: 15 --- -# Octave Shift +# Octave shift {: .no_toc } {: .d-inline-block } New in 5.3 @@ -13,8 +12,7 @@ New in 5.3 --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- @@ -22,7 +20,7 @@ Table of contents ## Definition An octave shift looks like this: - + Its purpose is to tell a reader that there is a local shift in height between the notes as they are written and as they must be performed. @@ -50,7 +48,7 @@ The example at the beginning of this page presented a rather short octave shift, limited in range to a portion of the physical staff just below it. The following example is different: - + We can see an octave shift starting on the upper staff in the first system and stopping at the end of the upper staff in the second system. @@ -61,7 +59,7 @@ beyond the containing system. Notice also the other shift located on the lower staff of the second system, or the next example below, and how the notion of "straight horizontal line" should be taken with a grain of salt... - + ## Current status @@ -87,7 +85,7 @@ above for `alta`, below for `bassa`. The easiest way to create an octave shift is a drag & drop from the `ClefsAndShifts` family in the Shape board: - + 1. We drag the desired shift symbol 2. We pay attention to hover over the target staff. @@ -99,7 +97,7 @@ Shape board: | Above staff | Below staff | | :---: | :---: | | an `alta` downside hook appears | a `bassa` upside hook appears | - |  | | + |  | | 3. We drop the symbol at the desired location (typically the center of the number box) by releasing the mouse. Another way is to select a suitable glyph, which must be limited to the number part @@ -121,7 +119,7 @@ The octave shift editor provides up to 3 handles: left, middle and right: - Only the left and right handles, when present, can resize the shift line horizontally within current staff limits. - + What is specific to this editor is the ability to drag the user location (shown as a red cross), way beyond the limits of the current system, until the corresponding staff in some previous or @@ -129,11 +127,11 @@ succeeding system. In the example below, the user has selected the right handle as shown and will drag the mouse from staff #1 down to a location in staff #3: - + When reaching this staff #3 (which is the succeeding staff for staff #1), the editor configuration changes on-the-fly: - + Instead of the initial simple octave shift with 3 handles, we now have 2 physical shifts in a logical shift: diff --git a/docs/_pages/ui_tools/part.md b/docs/_pages/guides/ui/ui_tools/part.md similarity index 83% rename from docs/_pages/ui_tools/part.md rename to docs/_pages/guides/ui/ui_tools/part.md index ce8a9c083..0a9af85d8 100644 --- a/docs/_pages/ui_tools/part.md +++ b/docs/_pages/guides/ui/ui_tools/part.md @@ -1,11 +1,10 @@ --- layout: default -title: Part Merge -grand_parent: User Editing -parent: UI Tools +title: Part merge +parent: UI tools nav_order: 8 --- -# Part Merge +# Part merge {: .no_toc } During the ``GRID`` step, the OMR engine detects staves and assigns exactly one part per staff, @@ -23,18 +22,18 @@ This is the case in the following example, where a poorly done scan has cropped portion on the image left side (the faint red cross is just the current location as given by the user): - + So, this leads the OMR engine to detect a system with 3 parts. -To fix this, we manually drag & drop a brace Inter from the shape palette to where there should be +To fix this, we manually drag & drop a brace `Inter` from the shape palette to where there should be a brace. Let's pay attention to hover over a staff of the target system. The brace ghost will turn from dark-gray to green, with a red segment going from brace center to staff middle line: - + We can now drop the brace. The drop will commit the merge of the two embraced staves into a single part. diff --git a/docs/_pages/guides/ui/ui_tools/remove_inter.md b/docs/_pages/guides/ui/ui_tools/remove_inter.md new file mode 100644 index 000000000..02b995770 --- /dev/null +++ b/docs/_pages/guides/ui/ui_tools/remove_inter.md @@ -0,0 +1,28 @@ +--- +layout: default +title: Inter removal +parent: UI tools +nav_order: 3 +--- +# `Inter` removal +{: .no_toc } + +When one or several `Inter` instances have been selected, we can remove them as follows: + +* The `Inter`-board has a `Deassign` button which removes the selected inter displayed in the + board. + This applies only for the displayed `Inter`. +  + +* The {{ site.popup_inters }} contextual menu provides an item to + remove the selected `Inter` entities according to their containing system. +  + +* Pressing `DELETE` key or `BACKSPACE` key on the keyboard removes all the selected inters. + +If more than one `Inter` is selected, we will be prompted for confirmation beforehand. + +Removing a selected `Inter` (or a set of selected Inters) automatically removes the relations these +Inters were involved in. + +Removing the last member of an ensemble also removes that ensemble. diff --git a/docs/_pages/ui_tools/remove_relation.md b/docs/_pages/guides/ui/ui_tools/remove_relation.md similarity index 75% rename from docs/_pages/ui_tools/remove_relation.md rename to docs/_pages/guides/ui/ui_tools/remove_relation.md index e60d32a07..fb0b6d55b 100644 --- a/docs/_pages/ui_tools/remove_relation.md +++ b/docs/_pages/guides/ui/ui_tools/remove_relation.md @@ -1,17 +1,15 @@ --- layout: default -title: Relation Removal -grand_parent: User Editing -parent: UI Tools +title: Relation removal +parent: UI tools nav_order: 5 --- -# Relation Removal +# Relation removal {: .no_toc } --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- @@ -19,23 +17,23 @@ Table of contents ## Removing a wrong relation There is no direct way to select Relation instances. -They can be selected only indirectly, via the selection of one of the Inter instances they link. +They can be selected only indirectly, via the selection of one of the `Inter` instances they link. In the following example, a sharp sign has been linked to the wrong note head: - + -To select this relation, we first select the involved sharp sign. +To select this relation, we can first select the involved sharp sign. This will result in the picture above. Then we use a right-click to display the contextual menu {{ site.popup_inters }}, hover on the `Inters...` submenu, -then on the sharp item to see the `Relations:` list of relations this Inter is involved in. +then on the sharp item to see the `Relations:` list of relations this `Inter` is involved in. By clicking on the _AlterHead_ relation, we will be prompted to confirm the removal of this relation. - + Without this relation, the sharp sign is now no longer linked to any head, it thus appears in red abnormal status. @@ -44,7 +42,7 @@ Finally, the correct relation should be manually added (see the [Add Relation](../ui_tools/add_relation.md) previous section) to result in the configuration below: - + ## Implicit relation removal @@ -53,7 +51,7 @@ relation was not necessary, provided the correct relation is inserted manually. This is so, because an accidental can reference only one note head (if we except the special case of a -[note head shared by two voices](../ui_cases/shared_head.md)). +[note head shared by two voices](./shared_head.md)). So the wrong _AlterHead_ relation would be removed automatically when inserting a new one. diff --git a/docs/_pages/ui_tools/shared_head.md b/docs/_pages/guides/ui/ui_tools/shared_head.md similarity index 73% rename from docs/_pages/ui_tools/shared_head.md rename to docs/_pages/guides/ui/ui_tools/shared_head.md index f5b2d80dd..25d36bd45 100644 --- a/docs/_pages/ui_tools/shared_head.md +++ b/docs/_pages/guides/ui/ui_tools/shared_head.md @@ -1,8 +1,7 @@ --- layout: default -title: Shared Head -grand_parent: User Editing -parent: UI Tools +title: Shared head +parent: UI tools nav_order: 14 --- # Shared Head @@ -10,8 +9,7 @@ nav_order: 14 --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- @@ -23,11 +21,11 @@ Generally a note head (filled or void -- except whole and breve notes) is connec If head and stem are connected (via a `HeadStemRelation`), both appear with their own standard color. If not, one or both appear in red and to fix this, we can simply drag a link from one to the other. - + Then, if needed, we can insert a stem on the other side of the head, in the opposite direction. - + It appears in red because it can't get automatically connected to the head (because this head is already connected on the other side). @@ -43,17 +41,17 @@ This is the standard behavior. * But if the check succeeds, both connections are kept and the _'shared'_ head gets logically duplicated into two heads, one _'half'_ for the left and one _'half'_ for the right: - + By selecting all components, we can see the various links (_HeadStemRelation_ between each head half and "its" stem, and _MirrorRelation_ between the two half heads): - + And if voices are colorized, the separation between head 'halves' becomes even more visible: - + ## Impact on relations @@ -63,5 +61,5 @@ Simply, we have to pay attention to point precisely to the desired _'half'_ head | Example | Explanation | | :---: | :--- | -|  | Here, the alteration sign is _'shared'_ and thus also split, each sign _'half'_ colorized with the same color as its related head half.| -|  | Here, the augmentation dot is related only to one head _'half'_ (otherwise the dot would exhibit both colors as the alteration sign in the previous example) | +|  | Here, the alteration sign is _'shared'_ and thus also split, each sign _'half'_ colorized with the same color as its related head half.| +|  | Here, the augmentation dot is related only to one head _'half'_ (otherwise the dot would exhibit both colors as the alteration sign in the previous example) | diff --git a/docs/_pages/ui_tools/staff_editor.md b/docs/_pages/guides/ui/ui_tools/staff_editing.md similarity index 83% rename from docs/_pages/ui_tools/staff_editor.md rename to docs/_pages/guides/ui/ui_tools/staff_editing.md index 2799d184f..942058a62 100644 --- a/docs/_pages/ui_tools/staff_editor.md +++ b/docs/_pages/guides/ui/ui_tools/staff_editing.md @@ -1,11 +1,10 @@ --- layout: default -title: Staff Editing -grand_parent: User Editing -parent: UI Tools +title: Staff editing +parent: UI tools nav_order: 6 --- -# Staff Editing +# Staff editing {: .no_toc } During the `GRID` step, the OMR engine strives to detect sequences of equally spaced, @@ -29,8 +28,7 @@ contextual menu we select: --- Table of contents -{: .text-delta } - +{: .text-epsilon } 1. TOC {:toc} --- @@ -41,7 +39,7 @@ In this mode, we can modify the different lines of the staff individually. | Input view | Output view | | :---: | :---: | -|  |  | +|  |  | In the example above, on the left-side picture, we can see that pixels at the beginning of the staff have been left over (these are the horizontal sections displayed in pink color). @@ -54,7 +52,7 @@ right-side picture. The staff lines, as detected, are not evenly spaced near the To fix this, preferably right after the `GRID` step, we enter the staff editing in `lines` mode (Right-click in staff > ``Staff#n`` > ``Edit lines``). - + Each line of the staff now exhibits its own sequence of handles, which we can press and drag to modify the staff line locally. @@ -63,7 +61,7 @@ In this `Lines` mode, the handles can move only vertically. In the case at hand, we could slightly drag some left handles up or down. We notice that the pink sections disappear when they get crossed by a staff line. - + Clicking outside of any handle completes the editing. We can always undo/redo the operation. @@ -83,7 +81,7 @@ all staff lines as a whole. | Input view | Output view | | :---: | :---: | -|  |  | +|  |  | In the example above, the upper staff is so crowded with heads, stems and beams that the engine could not detect enough line portions. @@ -94,7 +92,7 @@ has even been truncated on its right side. To fix this, we enter the staff editing in `global` mode (Right-click in staff > ``Staff#n`` > ``Edit staff``). - + As opposed to the `lines` mode, we get handles only along the staff middle line. This is enough to move the whole staff: @@ -105,19 +103,19 @@ So, we press the right-most handle and drag it horizontally to the right until i the right barline and vertically so that most if not all pink sections disappear. We then release the mouse. - + We still have a couple of pink sections to fix on lines 2 and 3 (counted top down). This is a job for the `lines` mode. We simply right-click in the staff area, and select the `lines` mode. - + -We slightly drag down two handles, and voilà!: +We slightly drag down two handles, and voila!: - + {: .highlight } -A final remark: Since moving a handle is often a matter of very few pixels, we may find it more +TIP: Since moving a handle is often a matter of very few pixels, we may find it more convenient to move a handle via the **keyboard**: While keeping the `Alt` key pressed, we can use the 4 arrow keys to move the selected handle one pixel at a time in the desired direction. diff --git a/docs/_pages/ui_tools/system.md b/docs/_pages/guides/ui/ui_tools/system.md similarity index 72% rename from docs/_pages/ui_tools/system.md rename to docs/_pages/guides/ui/ui_tools/system.md index 45855013b..cee1621ea 100644 --- a/docs/_pages/ui_tools/system.md +++ b/docs/_pages/guides/ui/ui_tools/system.md @@ -1,11 +1,10 @@ --- layout: default -title: System Merge -grand_parent: User Editing -parent: UI Tools +title: System merge +parent: UI tools nav_order: 7 --- -# System Merge +# System merge {: .no_toc } In the Audiveris ``GRID`` step, detected staves are gathered into systems, based on barlines found on @@ -19,18 +18,18 @@ detection of systems by the OMR engine. | Left barline broken | Resulting grid before fix | Resulting grid after fix | | ---| --- | --- | -|  |  |  | +|  |  |  | Since the 5.2 release, we can manually fix this problem. We point at the upper system portion, and via the right-click {{ site.popup_system }} menu we select "_Merge with system below_". - + This is a key operation, so we need to confirm the detailed prompt: - + And it's done: a connector was created between the two barline portions and the two system portions merged. diff --git a/docs/_pages/ui_tools/text.md b/docs/_pages/guides/ui/ui_tools/text.md similarity index 87% rename from docs/_pages/ui_tools/text.md rename to docs/_pages/guides/ui/ui_tools/text.md index debfee568..bed10af8a 100644 --- a/docs/_pages/ui_tools/text.md +++ b/docs/_pages/guides/ui/ui_tools/text.md @@ -1,14 +1,13 @@ --- layout: default title: Text -grand_parent: User Editing -parent: UI Tools +parent: UI tools nav_order: 13 --- # Text {: .no_toc } -Recognition of textual elements is delegated to the Tesseract OCR library. +The recognition of textual elements is delegated to the Tesseract OCR library. This recognition is performed by the OMR engine (this is the `TEXTS` step). It can also be performed manually on a provided glyph. @@ -16,11 +15,11 @@ The resulting hierarchy of sentences and words can also be manually modified by --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- + ## Recognition of text items It is very difficult to automatically derive the meaning from the textual items in a musical score. @@ -31,14 +30,14 @@ nor is it always clear which voice is concerned. For **plain text**, Audiveris tries to detect the text role, such as directions or typical header elements like: title, composer and lyricist. -If it fails, the role can be easily corrected manually. +If it fails, the role can easily be corrected manually. ## TEXTS step The `TEXTS` step runs the Tesseract OCR on the whole image and tries to assign to each textual item its probable content, type and role. -This engine step is influenced by three options available in the `Book parameters` menu: +This engine step is influenced by three options available in the {{site.book_parameters }} menu: - [x] Support for chord names - [ ] Support for lyrics (assumed to be located below the related staff) - [x] Support for lyrics even located above staff @@ -53,22 +52,22 @@ buttons provided in the `Physicals` family of the Shape palette: * The `lyric` button, * The `text` button. - + There are two separate buttons because lyric items have a behavior significantly different from plain text items, especially the gap between words can be much wider. By choosing one button or the other, the user clearly specifies the desired result type of the OCR operation. -## Sentence vs Words +## Sentence vs. Words -A Sentence Inter is an ensemble of one or several Word Inter(s): +A Sentence `Inter` is an ensemble of one or several Word `Inter`(s): * A **Word** handles its textual value and location. Word sub-classes (ChordName and LyricItem) handle additional data. The word _value_ is modifiable by the user: -  +  * A **Sentence** is a sequence of words. (We can easily navigate from a selected word to its containing sentence via the `ToEnsemble` button). @@ -76,7 +75,7 @@ A Sentence Inter is an ensemble of one or several Word Inter(s): This content is not modifiable directly, but rather via its word members. The sentence _role_ is modifiable by the user. -  +  A sentence role can be set to any value among: UnknownRole, @@ -141,12 +140,12 @@ displayed as "B♭". A lyric line is a sentence composed of lyric items. -When selected, the Inter board displays additional data: +When selected, the `Inter` board displays additional data: * Voice number, * Verse number, * Location with respect to staff. - + Each syllable (lyric item) is usually linked to a related chord. diff --git a/docs/_pages/ui_tools/time.md b/docs/_pages/guides/ui/ui_tools/time.md similarity index 90% rename from docs/_pages/ui_tools/time.md rename to docs/_pages/guides/ui/ui_tools/time.md index e2451627c..083e767e6 100644 --- a/docs/_pages/ui_tools/time.md +++ b/docs/_pages/guides/ui/ui_tools/time.md @@ -1,21 +1,20 @@ --- layout: default -title: Time Signature -grand_parent: User Editing -parent: UI Tools +title: Time signature +parent: UI tools nav_order: 11 --- -# Time Signature +# Time signature {: .no_toc } --- Table of contents -{: .text-delta } - +{: .text-epsilon } 1. TOC {:toc} --- -## Whole vs Pair + +## Whole vs. pair Audiveris OMR is able to handle both whole- and pair- time signatures: @@ -58,11 +57,11 @@ This is a fully-customizable combo signature. To define a precise time signature, the most convenient way is often to drag the `custom` combo (0/0) from the shape palette to a target location: - + Once dropped, the custom combo displays its initial value (`0/0`): - + We can then use the inter board to enter the desired values for our custom combo, formatted as "numerator / denominator". @@ -73,7 +72,7 @@ The only constraint is that each numerator or denominator value must stay within (0 being just a temporary value, of course). - + ## Location diff --git a/docs/_pages/ui_tools/tips.md b/docs/_pages/guides/ui/ui_tools/tips.md similarity index 89% rename from docs/_pages/ui_tools/tips.md rename to docs/_pages/guides/ui/ui_tools/tips.md index 33e590c5b..6a7d65822 100644 --- a/docs/_pages/ui_tools/tips.md +++ b/docs/_pages/guides/ui/ui_tools/tips.md @@ -1,11 +1,10 @@ --- layout: default -title: Tips and Tricks -grand_parent: User Editing -parent: UI Tools +title: Tips and tricks +parent: UI tools nav_order: 16 --- -# Tips and Tricks +# Tips and tricks {: .no_toc } This section gathers a few things based on concrete user experience. @@ -13,8 +12,7 @@ These little tricks should save us time and efforts in our editing sessions. --- Table of contents -{: .text-delta } - +{: .text-epsilon } 1. TOC {:toc} --- @@ -27,7 +25,7 @@ In bad scans, often elements are detected as two or more separate glyphs In such a case, we use a selection frame and try to catch all parts of a suitable glyph before we define an inter for it: - + We have to make sure not to select parts of other elements (e.g. augmentation dots)! @@ -57,7 +55,7 @@ Sometimes grace notes are considered as standard notes with just a rather small And while all standard notes are involved in rhythm building, true grace notes are not, because they are considered as mere ornaments. - + In such a case we just delete the note and re-define with the correct interpretation (from the `Ornaments` palette in Shape board) @@ -71,13 +69,13 @@ In such a case we can add the missing triplet element by drag & drop to the 2nd | Lower triplet missing | | Lower triplet added | | :---: |:---:| :---: | -| | ===> || +| | ===> || ## Perfectly opposite notes Sometimes there are two notes of two voices with opposite stems in the same horizontal position. - + In such a case Audiveris often does not detect the two stems as separate elements, but as one long stem (on which the heads candidates will appear in abnormal positions, diff --git a/docs/_pages/handbook.md b/docs/_pages/handbook.md index c16f59d40..4459a5a51 100644 --- a/docs/_pages/handbook.md +++ b/docs/_pages/handbook.md @@ -2,7 +2,7 @@ layout: default title: Audiveris Handbook nav_order: 0 -has_children: true +has_children: false has_toc: false --- # Audiveris Handbook @@ -11,9 +11,8 @@ has_toc: false This documentation applies to release {{ site.audiveris_version }} and later. --- -Table of contents -{: .no_toc .text-delta } - +Table of Contents +{: .no_toc .text-epsilon } 1. TOC {:toc} --- @@ -26,9 +25,9 @@ as a progressive sequence of chapters. It is just a user manual; a true developer documentation is still to be written. Some material is already made available, through the -Audiveris [Wiki](https://github.com/Audiveris/audiveris/wiki) -and through the description of [.omr file format](./outputs/omr.md), to ease the software -learning curve for any potential developer. +Audiveris [Wiki] and through the description of the +[`.omr` file format](./reference/outputs/omr.md), +to ease the software learning curve for any potential developer. ## Overview @@ -38,12 +37,11 @@ When questioned about Audiveris in December 2023, ChatGPT answered: > The software is developed in Java and is available for various operating systems, including Windows, macOS, and Linux. It can be used to digitize printed sheet music, making it easier to edit, share, and playback on digital devices. -> If you're interested in using Audiveris, you can find more information, documentation, and download links on the official website or through open-source software repositories. Keep in mind that the information provided here is accurate as of my last knowledge update in January 2022, and there may have been updates or changes since then. Not that bad at all! But let's try to describe it on our own... Audiveris is an open source software, published under the -[AGPL](https://en.wikipedia.org/wiki/GNU_Affero_General_Public_License) V3 license. +[AGPL] V3 license. It is an **O**ptical **M**usic **R**ecognition (OMR) application, featuring an OMR engine coupled with an interactive editor. @@ -55,9 +53,8 @@ notably: digital playback, transposition and arrangement. Audiveris provides outputs in two main digital formats: its own OMR format and the standard MusicXML format. -* [OMR](https://github.com/Audiveris/audiveris/wiki/Project-Structure) is the -Audiveris specific format, a documented open source format based on XML. -* [MusicXML](http://usermanuals.musicxml.com/MusicXML/MusicXML.htm) is a *de facto* standard. +* [OMR] is the Audiveris specific format, a documented open source format based on XML. +* [MusicXML] is a *de facto* standard. It has been designed for score interchange and is today supported as input/output by almost every music notation program. @@ -72,32 +69,39 @@ the Audiveris application provides a graphical user interface specifically focus on quick verification and manual correction of the OMR outputs. External sophisticated music editors, such as MuseScore or Finale, can be used on -Audiveris MusicXML output. -They can even be directly connected via simple [plugins](./advanced/plugins.md) -to ease data transfer from Audiveris to these external editors. - -## Handbook content - -1. [Installation](./install/README.md): -How to install or build the program. - -1. [Quick tour](./quick/README.md): -A very brief tour, just to introduce a minimal usage of the software. - -1. [Main features](./main/README.md): -Thorough description of software main features. - -1. [UI](./ui.md): -Main tools and typical examples to correct OMR outputs. - -1. [Specific features](./specific/README.md): -Specific features recently added to Audiveris. - -1. [Advanced features](./advanced/README.md): -Features only relevant for an advanced usage of Audiveris. - -1. [References](./references.md): -Not meant to be read from A to Z, but when a specific item needs to be checked. - -1. [Updates](./updates.md): -History of major software updates. +the Audiveris MusicXML output. +They can even be directly connected via simple [plugins](./guides/advanced/plugins.md) +to ease the information handover from Audiveris to these external editors. + +## Handbook structure + +This documentation has been restructured for the 5.4 release, according to the principles +of the [DIVIO] Documentation System, around four different functions: + +- [Tutorials](./tutorials/README.md) -- To get started + - Installation of Audiveris application + - Quick tour from a score capture image to its playback by a music sequencer + - Introduction to the main concepts covered by the OMR process + - Presentation of the graphical user interface + +- [How-to guides](./guides/README.md) -- For precise tasks + - Frequent tasks like setting book parameters and driving the OMR pipeline + - Operating in batch through the command line interface + - Using the graphical interface to edit the OMR results + - Processing of specific musical items + - Advanced tasks like sampling symbols and training the neural glyph classifier + +- [Reference](./reference/README.md) -- Comprehensive technical descriptions + - Menus, boards, folders, outputs, editors + - Known limitations, history of updates + +- [Explanation](./explanation/README.md) -- How it works + - Steps internals + + +[AGPL]: https://en.wikipedia.org/wiki/GNU_Affero_General_Public_License +[DIVIO]: https://docs.divio.com/documentation-system/ +[MusicXML]: http://usermanuals.musicxml.com/MusicXML/MusicXML.htm +[OMR]: https://github.com/Audiveris/audiveris/wiki/Project-Structure +[.omr]: ./reference/outputs/omr.md +[Wiki]: https://github.com/Audiveris/audiveris/wiki diff --git a/docs/_pages/install/README.md b/docs/_pages/install/README.md deleted file mode 100644 index 3510a8e1c..000000000 --- a/docs/_pages/install/README.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: Installation -nav_order: 1 -has_children: true ---- -# Installation - -For **Windows** only, there is an **installer** available in 64-bit version, -which takes care of installing all Audiveris binaries. -The installer makes installation simple but has the main drawback of being limited to -the last official release, which can be several months old. - -For all three major operating systems, that is **Windows**, **Linux** and **MacOS**, -you have the ability to **download and build** from source material. -The main advantage is to benefit from all the bug fixes and improvements that are -continuously published on the Audiveris project site in its "development" branch. - -{: .warning } -In both cases, whether you decide to use the installer or to build Audiveris from source, -there are two points to take care of: - -{: .highlight } -Point #1: Proper **Java** version must be installed. -Audiveris version {{ site.audiveris_version }} requires Java version {{ site.java_version }} or up. - -{: .highlight } -Point #2: Suitable Tesseract **OCR language** files must be locally available. -Audiveris uses Tesseract OCR in legacy mode, which requires the standard (best) tessdata files. - diff --git a/docs/_pages/install/binaries.md b/docs/_pages/install/binaries.md deleted file mode 100644 index af61efb2a..000000000 --- a/docs/_pages/install/binaries.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -layout: default -title: Installing binaries -nav_order: 3 -parent: Installation ---- -# Installing binaries -{: .no_toc } - -Table of contents -{: .no_toc .text-delta } -1. TOC -{:toc} ---- - -## Windows - -### Installation - -The Audiveris installer for Windows is hosted on -[https://github.com/Audiveris/audiveris/releases](https://github.com/Audiveris/audiveris/releases). - -Installer versions are named "Audiveris_Setup-X.Y.Z-windows-x86_64.exe" where X.Y.Z values -refer to the related release. - -During installation, you will be prompted to associate the `.omr` file extension -(which represents an Audiveris Book) with Audiveris software. - -After installation, the Windows start menu should contain a sub-menu named `Audiveris`: - - - -#### Additional actions - -{: .warning } -Do not forget two additional actions: - - [Java environment](./java.md) - - [OCR languages](./languages.md) - -#### 64-bit architecture - -The installer is built for a 64-bit architecture. - -If a 32-bit version is really needed for whatever reason (perhaps because your equipment is too old), -you have to fall back using old Audiveris 5.1 installers which were available for both 32 and 64-bit -architectures. - -### Uninstallation - -To uninstall the program, you can simply select `Uninstall` in the Audiveris start menu. - -The uninstaller will optionally keep the configuration files of the program. -So, if you re-install this program or a new version later, you will find the same settings -that were used before uninstallation. - -{: .note } -You may not always see the `Uninstall` item under Audiveris in the Windows start menu. -This is reportedly a new Windows behavior, which now recommends to open `Windows Settings` -(keyboard shortcut is `Windows + I`), then look in `Apps & features` section for the Audiveris item -and there press the `Uninstall` button. - -## Linux -No installer yet. - -## MacOS -No installer yet. diff --git a/docs/_pages/install/java.md b/docs/_pages/install/java.md deleted file mode 100644 index 99f3f2c08..000000000 --- a/docs/_pages/install/java.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default -title: Java -nav_order: 1 -parent: Installation ---- -# Java -{: .no_toc } - -## Java runtime environment - -To check the installed Java environment, you can use the `java -version` command from a terminal window, to provide Java information like: -``` -$ java -version -java version "17.0.6" 2023-01-17 LTS -Java(TM) SE Runtime Environment (build 17.0.6+9-LTS-190) -Java HotSpot(TM) 64-Bit Server VM (build 17.0.6+9-LTS-190, mixed mode, sharing) -``` -If you don't have a suitable Java Runtime Environment (JRE) yet, you must install one. -If a JRE is not available for download, you can pick up a JDK (Java Development Kit) -which is a superset of a JRE. - -Make sure to install **Java version {{ site.java_version }}** -(which is today the latest LTS - Long Term Support - version) for instance from -[https://www.oracle.com/java/technologies/downloads/](https://www.oracle.com/java/technologies/downloads/) - -Audiveris {{ site.audiveris_version}} will not work with older Java versions. -It may work with newer versions. This section will be updated as new results become available. - -### 64-bit architecture - -The latest Audiveris version ({{ site.audiveris_version}}) -uses Java {{ site.java_version }}. -Starting with Java 10, Oracle now provides Java environments only for 64-bit architecture. - -So a 64-bit architecture is now required. diff --git a/docs/_pages/install/languages.md b/docs/_pages/install/languages.md deleted file mode 100644 index 68dee05a5..000000000 --- a/docs/_pages/install/languages.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -layout: default -title: OCR languages -nav_order: 2 -parent: Installation ---- -# OCR languages -{: .no_toc } - -Audiveris delegates text recognition to Tesseract OCR library. - -Whether you install Audiveris via its Windows installer or download the project and build it locally -from source, you will need to have a local copy of some Tesseract language files: -- `eng` (English) is mandatory, -- `deu` (German), `fra` (French), `ita` (Italian) are often useful. - -Note that you can always download additional languages later from the dedicated -[Tesseract tessdata] site which contains data files for 100+ languages. - ---- -Table of contents -{: .no_toc .text-delta } -1. TOC -{:toc} ---- - -## Tesseract as a linked library - -Audiveris calls Tesseract software as a linked binary _library_, -not as a separate executable _program_. -- Tesseract library is automatically provided via Audiveris installation or building. - As of this writing, Audiveris uses version {{ site.tesseract_version }} of Tesseract library. -- There is thus no need to _install_ any Tesseract program. - You may already have a Tesseract program of whatever version installed on our machine, - Audiveris will not interfere with that program. -- However, Tesseract library will need data (language files) which must be provided separately. - -## Data version - -Tesseract OCR engine can operate in two different OCR modes --- the ``legacy`` mode and the new ``LSTM`` mode -- each with its own model. - -To process text scattered among musical symbols, Audiveris must use the ``legacy`` mode. - -The language files downloadable from [Tesseract tessdata] page are meant for Tesseract -version 4.x and up, each language file containing both ``legacy`` and ``LSTM`` models. -So, these are the language data files that Audiveris requires. - -## Data location - -At starting time, Audiveris tries to initialize the Tesseract library with a `tessdata` folder: - 1. It first checks the location defined by the `TESSDATA_PREFIX` environment variable. - 2. If not found there, it tries the Tesseract tessdata default location according to the OS, - which for Windows can be for example `"C:\Program Files\tesseract-ocr\tessdata"`. - -If in doubt, we recommend the following actions: -1. Choose or create a specific folder, named ``tessdata`` for clarity. -2. Download a few language files (at least ``eng.traineddata`` file) from [Tesseract tessdata] page -to your specific folder. -3. Define the `TESSDATA_PREFIX` environment variable to point to your specific folder. - -For illustration purpose, here is a personal configuration: -- I have created a ``"tessdata"`` sub-folder in Audiveris user ``config`` folder. -```bash -$ echo $TESSDATA_PREFIX -C:\Users\herve\AppData\Roaming\AudiverisLtd\audiveris\config\tessdata -``` -- And downloaded just four files from [Tesseract tessdata] web page into it. -```bash -$ ls -lgh $TESSDATA_PREFIX -total 66M --rw-r--r-- 1 herve 15M Jun 22 14:15 deu.traineddata --rw-r--r-- 1 herve 23M Jun 22 12:18 eng.traineddata --rw-r--r-- 1 herve 14M Jun 22 14:16 fra.traineddata --rw-r--r-- 1 herve 16M Jun 22 14:16 ita.traineddata -``` - -The About dialog, launched from the {{ site.help_about }} pull-down menu, displays key information -about the OCR engine version and OCR tessdata folder: - - - -## Languages selection - -At runtime, you can specify which languages should be tried by the OCR software. -This is done via a language specification string, a plus-separated list of language names: -- The easiest way is to define this language specification interactively. -Using the {{ site.book_parameters }} menu, you can make specifications -at the global level, book level and even individual sheet level. -Depending upon the language files present in your local ``tessdata`` folder, -you will be presented with the list of languages available for selection. -- The default (global) specification is determined by the application constant -`org.audiveris.omr.text.Language.defaultSpecification`, whose initial value is `deu+eng+fra`. -Thus, you can also modify this default directly by changing the constant value: - - either interactively (using {{ site.tools_options }} menu) - - or in batch (using something like - `-option org.audiveris.omr.text.Language.defaultSpecification=ita+eng`). - -[Tesseract tessdata]: https://github.com/tesseract-ocr/tessdata diff --git a/docs/_pages/install/sources.md b/docs/_pages/install/sources.md deleted file mode 100644 index 6f3ffbbe4..000000000 --- a/docs/_pages/install/sources.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -layout: default -title: Building from sources -nav_order: 4 -parent: Installation ---- -# Building from sources (Windows, MacOS, Linux, ArchLinux) -{: .no_toc } - -{: .note } -For GitHub users: -- Audiveris "*master*" branch is updated only when a new release is published. -- Instead, Audiveris development happens continuously in "*development*" branch, so checkout and pull -this *development* branch to get and build the latest version. -- See workflow details in this dedicated [Wiki article][workflow]. - -Table of contents -{: .no_toc .text-delta } -1. TOC -{:toc} ---- - -## Dependencies - -* [Git][git]: version control system. - -* [Gradle][gradle]: build tool. - -* [Java Development Kit (JDK)][jdk]: version {{ site.java_version }} - (higher numbers may work, to be confirmed). - Audiveris {{ site.audiveris_version }} runs only on 64-bit architectures. - -* Tesseract OCR: The Tesseract *libraries* are automatically pulled as Gradle dependencies, -but you will need the Tesseract *language files* for this OCR to work properly. -Please check [OCR languages](./languages.md) section. - -* [FreeType library][freetype]: Unix-like platforms (including MacOS) need FreeType in your $PATH -to handle those specific PDFs that contain vector graphics. -Fortunately, every known Unix-like OS distribution already contains a package for FreeType. - -## Download, build and run -To download the Audiveris project, use the following command in a directory of your choice: - -```sh -git clone https://github.com/Audiveris/audiveris.git -``` - -This will create a sub-directory named "audiveris" in your current directory and populate it with -project material (notably source code and build procedure). - -Now move to this "audiveris" project directory: - -```sh -cd audiveris -``` - -Once in this `audiveris` project directory, you can select the branch you want. -By default, you are on `master`branch. -To use the `development`branch with its latest features, use: -```sh -git checkout development - -# To make sure you grab even the latest updates: -git pull --all -``` -You can build the software via the command: -```sh -# (Linux & Mac, or Cygwin terminal under Windows) -./gradlew build -``` -```sh -# (Windows terminal) -gradlew.bat build -``` - -You can run the software, as GUI tool, via the command: - -```sh -# (Linux & Mac, or Cygwin terminal under Windows) -./gradlew run -``` -```sh -# (Windows terminal) -gradlew.bat run -``` - -Please note that all these commands use **gradle wrapper** (`gradlew`) which, behind the scenes, -takes care of getting and launching the proper gradle version. - -## Alternative run - -The gradle-based run, as described above, makes sure that all your potential modifications are -compiled before the application is launched. -This is the preferred approach for a developer. - -However, if you don't modify the code and merely want to launch the (un-modified) -application you don't need to go through gradle for each and every run. - -Because, once you have built the software with the gradle `build` command as stated above, -you now have a `build/distributions` folder in the repository root with tarred/zipped libraries -(`Audiveris.tar` and `Audiveris.zip`). - -Simply extract either one of the archives: - -```sh -# Either extract the .tar archive -tar -xf build/distributions/Audiveris.tar -``` - -```sh -# Or extract the .zip archive -unzip build/distributions/Audiveris.zip -``` - -Then, you can repeatedly run audiveris from those files: -```sh -# Run audiveris (append arguments if so needed): -java -cp "Audiveris/lib/*" Audiveris -``` - -[freetype]: https://www.freetype.org -[git]: https://git-scm.com -[gradle]: https://gradle.org -[jdk]: http://www.oracle.com/technetwork/java/javase/downloads/index.html -[workflow]: https://github.com/Audiveris/audiveris/wiki/Git-Workflow diff --git a/docs/_pages/main/README.md b/docs/_pages/main/README.md deleted file mode 100644 index 228a7484f..000000000 --- a/docs/_pages/main/README.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: default -title: Main Features -nav_order: 3 -has_children: true ---- -# Main Features - -This chapter presents the main features of the Audiveris application, especially the user GUI and the -pipeline of the OMR engine, from input to outputs. - -The manual correction of OMR results is such an important topic that it deserves the separate -[UI Tools](../ui_tools/README.md) and [UI Examples](../ui_examples/README.md) chapters. - -A few specific features are gathered in the [Specific Features](../specific/README.md) chapter. - -And more advanced features can be found in the [Advanced Features](../advanced/README.md) chapter. diff --git a/docs/_pages/main/book_parameters.md b/docs/_pages/main/book_parameters.md deleted file mode 100644 index 0c8302bab..000000000 --- a/docs/_pages/main/book_parameters.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -layout: default -title: Book Parameters -parent: Main Features -nav_order: 5 ---- -# Book Parameters -{: .no_toc } - -Table of contents -{: .no_toc .text-delta } - -1. TOC -{:toc} - ---- - -## Dialog - -The pull-down menu {{ site.book_parameters }} opens a dialog to review and modify -high-level processing parameters. - -The following example displays the parameters dialog for a book (`Dichterliebe01`) which contains -two sheets: - - - -## Scopes - -The dialog is organized in several tabs to describe Default, Book and Sheet's scopes respectively. -In this example, the dialog provides 4 tabs, one for Default, one for Dichterliebe01 book, -and one for each sheet in the Dichterliebe01 book. - -The same parameters are defined for each scope, and each scope by default inherits from the upper -scopes in the hierarchy: -1. **Default** level: This is the information provided by default for all books. -Any such global value is read from source, unless we have overridden it at default level. -2. **Book** level: We can override any default value for this book only, and it will apply -transitively to all sheets in this book. -3. **Sheet** level: Finally, we can override any value for the specific sheet at hand. - -To override a value for a given scope: -1. We first select the proper scope tab, -2. We then put a checkmark on the left side to indicate that we want to override the selected parameter. -The line gets enabled, it changes from gray to black. -3. We define the new value, either by selecting in a list, or typing a number, -or checking a boolean box, etc. - -To cancel a value modification, we simply un-check the box on left side. -The line then gets disabled, changing from black to gray, and it now displays the inherited value -in lieu of the overriding value. - -## Lifecycle - -All modifications apply only when either the `OK` button or the `Apply` button is pressed, -which actually commits them. -The `OK` button completes the dialog, while the `Apply` button keeps the dialog open. - -* All the modified **default** values persist from one run of the application to the other -(until they are modified again or reset to their factory values). - -* All the modified **book/sheets** values persist in the book `.omr` project file. - -## Parameters - -* **Binarization** (needs SPECIFIC_ITEMS advanced topic) - We select the kind of filter (_global_ or _adaptive_) which gives the best results for the sheet - image at hand. - We can also adjust the related numbers. - Playing with the _global_ threshold is easy, but modifying the parameters of the _adaptive_ filter - is not recommended. - In fact, the default adaptive filter seems to give good results in all cases, therefore this - parameter is kept only for potential use on a specific case. - It does not appear unless the SPECIFIC_ITEMS advanced topic has been selected. - -* **Music font** -We can choose a specific music font between ``Bravura``, ``Finale Jazz`` or ``Jazz Perc``. -This decision is especially important for head recognition which is based on a font -template matching technique. -See the specific [Music Font](../specific/fonts.md#music-fonts) section. - -* **Text font** -The text font has no impact on recognition, but can provide a more faithful output. -We can adjust the text font between -``Sans Serif``, ``Serif`` and ``Finale Jazz Text``. - -* **Input quality** -This item allows adapting the OCR engine behavior to the expected quality of the input image between -``synthetic``, ``standard`` and ``poor``. - -* **OCR Languages** - Define the specification of dominant languages for OCR'd text - (note that we can select several languages) - -* **Switches** for a list of binary features. - In some cases, supporting a rather rare feature may imply collateral damage, the small note heads - are an example of such a tricky feature. - So it is safer to use them only when we have to. - * Keep loaded gray images - * Use of system indentation - * Link augmentation dot to both shared heads - * Support for percussion staves (1 line) - * Support for bass tablatures (4 lines) - * Support for unpitched percussion staves (5 lines) - * Support for guitar tablatures (6 lines) - * Support for small note heads - * Support for small beams - * Support for cross note heads - * Support for tremolos - * Support for fingering digits - * Support for frets roman digits (I, II, III, IV...) - * Support for plucking (p, i, m, a) - * Support for partial whole rests - * Support for multi-whole head chords - * Support for chord names - * Support for lyrics - * Support for lyrics even located above staff - * Support for articulations - * Support for implicit tuplets - -{: .highlight } -A switch can disable a feature for the OMR automatic recognition, -but in most cases the feature remains available for manual user actions. - - diff --git a/docs/_pages/main/book_sheet.md b/docs/_pages/main/book_sheet.md deleted file mode 100644 index 4af1677f0..000000000 --- a/docs/_pages/main/book_sheet.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default -title: Book of Sheets -grand_parent: Main Features -parent: Main Entities -nav_order: 1 ---- -# Book of Sheets - -An image file fed into OMR software contains one or several images. -Typically PDF and TIFF formats support the notion of multi-image files while, for example, -JPEG or PNG formats can deal only with single-image files. - -For Audiveris, using the metaphor of a physical book made of several sheets of paper, -this physical containment is modeled as one **Book** instance (corresponding to the input file) -and a sequence of one or several **Sheet** instances (one sheet corresponding to one image). - -Note that a sheet image may contain no music. -This happens for example for a title or illustration or simply a blank sheet. -In that case, the sheet will later be recognized as "_invalid_" (from the OMR point of view) -and flagged as such. - -With Audiveris 5.3, we can now split a book into smaller ones or, conversely, -merge small books into a larger one. -This feature is documented in the [Split and Merge](./split_merge.md) section. diff --git a/docs/_pages/main/entities.md b/docs/_pages/main/entities.md deleted file mode 100644 index 3ae82f49d..000000000 --- a/docs/_pages/main/entities.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: default -title: Main Entities -parent: Main Features -nav_order: 2 -has_children: true ---- -# Main Entities - -The purpose is not to describe the full data model of Audiveris, but simply to introduce some -key notions that are used throughout the whole application and that the end-user needs to -understand correctly. - -We will thus speak of: -* Physical containment: Book of Sheets, -* Logical containment: Score of Pages, -* Pixels assemblies: Runs, Sections and Lags, -* Interpretations: Glyphs vs Inters, -* Relations between Inters: the Symbol Interpretation Graph (SIG). diff --git a/docs/_pages/main/glyph_inter.md b/docs/_pages/main/glyph_inter.md deleted file mode 100644 index eca9f4af3..000000000 --- a/docs/_pages/main/glyph_inter.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default -title: Glyph vs Inter -grand_parent: Main Features -parent: Main Entities -nav_order: 4 ---- -# Glyph vs Inter - -## Glyph - -A **Glyph** is nothing more than a set of foreground (black) pixels -in a sheet binary image. - -It carries no shape. - -It is not related to a staff. -It does not even belong to a system. -The reason is there is no reliable way to assign a glyph located in the "gutter" between two systems -or two staves: does it belong to the upper or the lower system/staff? - -These restrictions on Glyph don't apply to glyph interpretations (Inter). - -## Inter - -An interpretation, or **Inter** for short, is precisely meant to formalize any reasonable -interpretation of a glyph. - -There may be several reasonable interpretations for a given glyph and, in many cases, -the OMR engine cannot immediately decide on the right interpretation among these mutually -exclusive interpretations. -This decision will then be postponed until later down in the OMR process, -when additional information (such as other Inter instances located nearby) becomes available -and helps clarify the configuration. - -As opposed to a Glyph, an Inter belongs to a system and is often related to a staff. - -It carries a shape and a grade in [0..1] range, which can be considered as the probability for the -interpretation to be a true positive. -This grade is an interpretation _intrinsic_ grade, only based on the glyph at hand in isolation -(this grade is often provided by the glyph classifier). - -Later, the Inter will generally be assigned a _contextual_ grade, based on the Inter grade -and the supporting relations with other Inter instances nearby. - -## Typical display example - - -| View | Inter over Glyph | -| --- | --- | -| | A Treble Clef **inter** appears in dark blue
Its related **glyph** is mostly hidden behind| diff --git a/docs/_pages/main/main_window.md b/docs/_pages/main/main_window.md deleted file mode 100644 index 1166f968d..000000000 --- a/docs/_pages/main/main_window.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -layout: default -title: Main Window -parent: Main Features -nav_order: 1 -has_children: true ---- -# Main Window - - - -The Audiveris main window is composed of 3 panels: - -## Sheet - -This is the large panel on the left side. -- The **Gray** tab, when available, presents the original image using gray values. -- The **Binary** tab presents the input image binarized into black and white colors. -- The **Data** tab presents the objects -([sections](), [glyphs](./glyph_inter.md#glyph) and -[inters](./glyph_inter.md#inter)) extracted from the image. -In this Data tab, the staff lines are drawn as thin lines. - -All tabs, except the Data tab, can be manually closed. -Most can be re-opened via the `Sheet` pull-down menu. - -## Boards - -The right panel is a vertical set of boards. -They provide information and editing functions. - -Only basic boards are displayed by default, others are hidden. -A right click in this column allows hiding or displaying any available board. - -## Events - -The lower left panel is a log of the main events that occurred so far. - -More details are available in the Audiveris log file -(the precise path to the log file is displayed at the top of this events panel) diff --git a/docs/_pages/main/output_formats.md b/docs/_pages/main/output_formats.md deleted file mode 100644 index 6f94758b7..000000000 --- a/docs/_pages/main/output_formats.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: default -title: Output Formats -parent: Main Features -nav_order: 8 ---- -# Output Formats - -There are 3 possibilities for output of a transcribed score: - -* Output as **OMR** file for saving and later reloading of OMR data for additional processing, -manual correction or production of other outputs. -See the [.omr format](../outputs/omr.md) section. - -* Output as **PDF** file for direct use by a musician. -It writes the resulting image into a PDF file, which is basically the content of the Picture/Binary -tab in logical mode. -See the [.pdf format](../outputs/pdf.md) section. - -* Output as **MusicXML** file for use in a score notation program. -It writes a MusicXML file with the exported score entities. -See the [.mxl format](../outputs/mxl.md) section. diff --git a/docs/_pages/main/run_section.md b/docs/_pages/main/run_section.md deleted file mode 100644 index f8850ada1..000000000 --- a/docs/_pages/main/run_section.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -layout: default -title: Pixels assemblies -grand_parent: Main Features -parent: Main Entities -nav_order: 3 ---- -# Pixels assemblies - -The ``BINARY`` step transforms the input image into a black and white image. -From this step on, the image will contain only black (foreground) pixels on a white background. - -A (black) pixel is just a black square, of dimension 1 x 1, located at some point (x,y). - -Depending on what the engine has to process (staff lines, stems, beams, etc), -the same pixels can be viewed through one structure or another. - -## Run and RunTable - -A horizontal (or vertical) contiguous sequence of pixels of the same color is called a -horizontal (or vertical) ``Run``. -In the same alignment, such run is followed by a run of the opposite color, and so on, -until the image border is reached. - -A ``RunTable`` is a rectangular area, made of sequences of runs, all of the same orientation. -Typically, the whole binarized image can be considered, at the same time, as: -- a table of horizontal runs -- a table of vertical runs - -## Section and LAG - -It can be interesting to transitively join adjacent (black) runs of the same orientation, -according to some compatibility rules. - -Each such resulting assembly is called a ``Section``. - -Typical compatibility rules are: -- Maximum difference in run lengths -- Maximum ratio of difference in run lengths -- Maximum shift on each run end -- Void rule (no check, except adjacency) - -Sections are gathered into ``LAG``s (**L**inear **A**djacency **G**raphs). - -Just like a ``RunTable`` gathers ``Run``s of the same orientation, -a ``LAG`` gathers ``Section``s of the same orientation. - -## Sections example - - - -The picture above is displayed, once the `GRID` step has been performed. -We select the "section" view  -via the {{ site.view_selections }} pull-down menu or the `F11` function key. - -Based on the maximum staff line thickness (previously determined by the `SCALE` step), -this picture combines sections from two different LAG's: -1. From the vertical LAG, all the (vertical) sections -with length greater than the maximum line thickness are displayed in pale blue. -2. From the horizontal LAG, the remaining pixels are organized in (horizontal) sections -and displayed in pale red. - -## Filament - -A ``Filament`` is a dynamic assembly of sections, long and thin, likely to represent lines. - -The engine uses: -- horizontal filaments to detect staff lines and ledgers alignments, -- vertical filaments to detect stems and legs of endings. - diff --git a/docs/_pages/menus/help.md b/docs/_pages/menus/help.md deleted file mode 100644 index ea803e9f9..000000000 --- a/docs/_pages/menus/help.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -layout: default -title: Help menu -grand_parent: References -parent: Pull-down menus -nav_order: 9 ---- -# Help menu -{: .no_toc } - - - ---- -Table of contents -{: .no_toc .text-delta } - -1. TOC -{:toc} ---- - -## Handbook - -Open this documentation (user-oriented handbook) from Audiveris program. - -## Wiki - -Open Audiveris Wiki. - -## Web Site - -Open Audiveris organization and contained repositories. - -## About - -Open an "à propos" dialog with information about Audiveris program and main external components -it depends upon (Tesseract OCR, Java, OS, machine architecture). - - diff --git a/docs/_pages/menus/plugins.md b/docs/_pages/menus/plugins.md deleted file mode 100644 index 497837c4c..000000000 --- a/docs/_pages/menus/plugins.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: default -title: Plugins menu -grand_parent: References -parent: Pull-down menus -nav_order: 7 ---- -# Plugins menu - - - -Display the registered plugins to external programs. - -See the [Plugins](../advanced/plugins.md) section. diff --git a/docs/_pages/menus/tools.md b/docs/_pages/menus/tools.md deleted file mode 100644 index 57981a3f4..000000000 --- a/docs/_pages/menus/tools.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -layout: default -title: Tools menu -grand_parent: References -parent: Pull-down menus -nav_order: 6 ---- -# Tools menu -{: .no_toc } - - - ---- -Table of contents -{: .no_toc .text-delta } - -1. TOC -{:toc} ---- - -## Browse Global repository - -Open a dialog to verify and edit the content of the Global sample repository -(this is _the_ only repository which is used for classifier training). - -(needs `SAMPLES` topic) - -## Save Global repository - -Saves the Global sample repository to disk. - -(needs `SAMPLES` topic) - -## Browse a local repository - -Open a dialog to verify and edit a local (book) sample repository -(generally before merging it into the Global repository). - -(needs `SAMPLES` topic) - -## Train Classifier - -Open a dialog to launch, monitor and evaluate the training of the glyph classifier. - -See [Training](../advanced/training.md) section. - -(needs `SAMPLES` topic) - -## Memory - -Displays the used memory in the output window - -## Options - -Opens the options window. - -All available options are listed. -Most of them concern development options only. - -A search window allows to search for a string part in the option name or its description. - - - -For more details, refer to [Options](../advanced/options.md) section. - -## Advanced Topics - -Opens a dialog with a couple of options concerning the program development only. - -See [Advanced Topics](../advanced/topics.md) section. diff --git a/docs/_pages/outputs/README.md b/docs/_pages/outputs/README.md deleted file mode 100644 index fec2c21ad..000000000 --- a/docs/_pages/outputs/README.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: default -title: Outputs -parent: References -nav_order: 7 -has_children: true ---- -# Outputs - -Output files are generally located in the dedicated subfolder of the related book. -See the [Folders](../folders/README.md) chapter. - -This chapter presents the various output formats designated by their file extension. - -A special emphasis is put on the `.omr` format, since this format governs the internal -structuring of any Audiveris project file. -Such file is also named a Book file, because there is one `.omr` project file per Book, and the -file merely represents the marshalling of Book internal data from memory to disk. diff --git a/docs/_pages/pages-tree.txt b/docs/_pages/pages-tree.txt deleted file mode 100644 index c6bf12c6a..000000000 --- a/docs/_pages/pages-tree.txt +++ /dev/null @@ -1,151 +0,0 @@ -. -├── advanced -│ ├── README.md -│ ├── cli.md -│ ├── improve_input.md -│ ├── options.md -│ ├── plugins.md -│ ├── samples.md -│ ├── topics.md -│ └── training.md -├── assets -│ └── images -├── boards -│ ├── README.md -│ ├── binarization.md -│ ├── classifier.md -│ ├── glyph.md -│ ├── inter.md -│ ├── pixel.md -│ ├── section.md -│ └── shape.md -├── folders -│ ├── README.md -│ ├── cached.md -│ ├── essential.md -│ └── standard.md -├── handbook.md -├── install -│ ├── README.md -│ ├── binaries.md -│ ├── java.md -│ ├── languages.md -│ └── sources.md -├── main -│ ├── README.md -│ ├── book_parameters.md -│ ├── book_portions.md -│ ├── book_sheet.md -│ ├── display_modes.md -│ ├── entities.md -│ ├── entity_colors.md -│ ├── glyph_inter.md -│ ├── limitations.md -│ ├── main_window.md -│ ├── output_formats.md -│ ├── pan_zoom.md -│ ├── pipeline.md -│ ├── run_section.md -│ ├── scanning.md -│ ├── score_page.md -│ ├── sheet_scale.md -│ ├── sheet_selection.md -│ ├── sheet_validity.md -│ ├── sig.md -│ ├── split_merge.md -│ └── voice_colors.md -├── menus -│ ├── README.md -│ ├── book.md -│ ├── debug.md -│ ├── file.md -│ ├── help.md -│ ├── plugins.md -│ ├── popup.md -│ ├── sheet.md -│ ├── step.md -│ ├── tools.md -│ └── view.md -├── outputs -│ ├── README.md -│ ├── log.md -│ ├── mxl.md -│ ├── omr.md -│ ├── pdf.md -│ └── zip.md -├── pages-tree.txt -├── quick -│ ├── README.md -│ ├── export.md -│ ├── launch.md -│ ├── load.md -│ ├── play.md -│ └── transcribe.md -├── references.md -├── specific -│ ├── README.md -│ ├── bar_repeat.md -│ ├── drums.md -│ ├── fingering_plucking.md -│ ├── fonts.md -│ ├── logical_parts.md -│ ├── multi_rest.md -│ ├── octave_shift.md -│ ├── snippets.md -│ ├── tablature.md -│ └── tremolo.md -├── steps -│ ├── beams.md -│ ├── binary.md -│ ├── chords.md -│ ├── cue_beams.md -│ ├── curves.md -│ ├── grid.md -│ ├── headers.md -│ ├── heads.md -│ ├── ledgers.md -│ ├── links.md -│ ├── load.md -│ ├── measures.md -│ ├── page.md -│ ├── reduction.md -│ ├── rhythms.md -│ ├── scale.md -│ ├── stem_seeds.md -│ ├── stems.md -│ ├── symbols.md -│ └── texts.md -├── ui.md -├── ui_examples -│ ├── README.md -│ ├── eyes -│ │ ├── README.md -│ └── trinitas -│ ├── README.md -├── ui_foundations -│ ├── README.md -│ ├── inspection.md -│ ├── principles.md -│ └── selection.md -├── ui_tools -│ ├── README.md -│ ├── add_inter.md -│ ├── add_relation.md -│ ├── chords.md -│ ├── edit_inter.md -│ ├── inter_editor.md -│ ├── key.md -│ ├── measure.md -│ ├── octave_shift.md -│ ├── part.md -│ ├── remove_inter.md -│ ├── remove_relation.md -│ ├── shared_head.md -│ ├── staff_editor.md -│ ├── system.md -│ ├── text.md -│ ├── time.md -│ └── tips.md -└── updates.md - -17 directories, 553 files diff --git a/docs/_pages/quick/export.md b/docs/_pages/quick/export.md deleted file mode 100644 index 2b5db454a..000000000 --- a/docs/_pages/quick/export.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: default -title: Export -nav_order: 4 -parent: Quick Tour ---- -# Export - -From the input image, Audiveris OMR engine has gradually built specific information that we -collectively refer to as "_OMR data_". - -In the advanced chapter, we describe more thoroughly how this OMR data is organized, can be -persisted on disk (in a `.omr` file) and directly reused by Audiveris or other external programs. - -Right now, we are focused only on how to feed a music sequencer with music data it can easily import. -And as of this writing, this is achieved by going through MusicXML-formatted data. - -We thus have to export OMR data as MusicXML data. -This can be done via the pull-down menu {{ site.book_export }}: - - - -From our "chula" example, this command produces a file named `chula.mxl` -(the `.mxl` extension indicates a compressed MusicXML format). - -The default policy is to put all output files related to a given input file into one specific sub-folder -(the "book folder"), named according to the input file name. -In our concrete example, the book folder ("chula") will contain the export file ("chula.mxl"). - -The default base folder location of all "book folders" depends on the operating system. -For Windows OS, the default base folder is the "Audiveris" sub-folder of the user's Documents folder. - -More details about available output policies and the default base folder are available in the -[Standard folders](../folders/standard.md) chapter. - -Note that this export, from OMR to MusicXML, is _lossy_, since a large amount of OMR -information can't go into MusicXML. -A `.omr` file can always be used to regenerate the `.mxl` export, but the reverse is not true. - -{: .note} -A good advice is to keep these `.omr` files --- unless we are running out of disk space! :-) -- -because they represent a valuable source of OMR information, -suitable for training newer versions of Audiveris (more on this later). diff --git a/docs/_pages/quick/launch.md b/docs/_pages/quick/launch.md deleted file mode 100644 index 447e772ef..000000000 --- a/docs/_pages/quick/launch.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: default -title: Launch -nav_order: 1 -parent: Quick Tour ---- -# Launch - -For the sake of simplicity, let's assume we are using Windows OS and have installed Audiveris via -the provided Windows Installer available in the Audiveris -[Releases area](https://github.com/Audiveris/audiveris/releases). -More details are available in [Installing binaries](../install/binaries.md). - -In this case, we get into the Windows Start Menu, by pressing the Windows logo key on our keyboard -or by clicking on the Start icon (left end of the taskbar). -In this menu, we move down to Audiveris folder and select the Audiveris executable. - -If we don't use binary installation, we should refer to [Building from sources](../install/sources.md) -to build and then launch the software. diff --git a/docs/_pages/reference/README.md b/docs/_pages/reference/README.md new file mode 100644 index 000000000..dc46a9dd7 --- /dev/null +++ b/docs/_pages/reference/README.md @@ -0,0 +1,28 @@ +--- +layout: default +title: Reference +nav_order: 3 +has_toc: false +--- + +# Reference + +This ``Reference`` chapter presents a few key topics that are not mandatory for a first reading. + +Each topic is meant to be exhaustive and often provides pointers back to +more specific and detailed sections in the handbook presentation. + +--- +Table of contents +{: .text-epsilon } + +| Topic | Content | +| :--- | :--- | +| [Limitations](./limitations.md) | The known limitations of Audiveris | +| [Editors](./editors.md) | All interactive editors per entity kind | +| [Pull-down menus](./menus/README.md) | All the pull-down menus | +| [Pop-up menu](./menus/popup.md) | The contextual pop-up menu | +| [Boards](./boards/README.md) | All the UI boards available in right column | +| [Folders](./folders/README.md) | The role and content of each folder,
Its location according to the operating system | +| [Outputs](./outputs/README.md) | All kinds of output files and formats | +| [Updates](./updates.md) | The history of major software updates | diff --git a/docs/_pages/boards/README.md b/docs/_pages/reference/boards/README.md similarity index 92% rename from docs/_pages/boards/README.md rename to docs/_pages/reference/boards/README.md index 6f242e3bf..968e64b2c 100644 --- a/docs/_pages/boards/README.md +++ b/docs/_pages/reference/boards/README.md @@ -1,9 +1,8 @@ --- layout: default title: Boards -parent: References +parent: Reference nav_order: 5 -has_children: true --- # Boards diff --git a/docs/_pages/reference/boards/binarization.md b/docs/_pages/reference/boards/binarization.md new file mode 100644 index 000000000..587927ac3 --- /dev/null +++ b/docs/_pages/reference/boards/binarization.md @@ -0,0 +1,86 @@ +--- +layout: default +title: Binarization board +parent: Boards +nav_order: 2 +--- +# Binarization board +{: .no_toc :} + +In release 5.4, the new binarization board provides the tools to manually +select the binarization filter (either global or adaptive), adjust its settings +and immediately see their impact on the sheet image. + +This new board is available only in the Binary tab, and is selected by default. + +--- +Table of contents +{: .text-epsilon } +1. TOC +{:toc} +--- + +## Board in action + +Let us take a gray image as input, here seen from the Gray tab: + + + + +### Default adaptive filter + +In the Binary tab on the same image, we can see both the Binarization board and the Binary board. + +The sheet view displays the result of applying the default binarization filter. +In this specific example, we can observe that many lines portions are missing: + + + +In the Binarization board, we can: +1. Select the filtering mode -- either adaptive (the default) or global +2. Modify the settings of the filter + - The threshold value for the global filter + - The coefficients for mean and standard deviation values for the adaptive filter, + from which the local threshold values will be computed + +For the vast majority of input images, the adaptive filter gives the best results. + +But for the image used in this example, we can try to modify the settings of the adaptive filter, +the results will never be OK. +The reason is the staff lines in this particular image use a pale gray color. +A global filter might better work. + +### Default global filter + +Here, we have switched to the global filter, using its default threshold value (140). + +The results are even worse, all the staff lines have disappeared: + + + +### Tuned global filter + +Here, we have raised the threshold of the global filter from 140 to 225. + +The binarized image is now OK for the next processing steps: + + + +## Case of a multi-sheet book + +As we adjust the binarization filter and settings, we can observe the results on the current sheet. + +If the sheet is part of a book containing several sheets, we have the ability to extend the +binarization parameters to the entire book. + +In such multi-sheet book, the binarization board displays an additional line, +meant for the book level: + + + +The button `Apply to whole book` extends the scope of the binarization parameters to the whole book. +- By default, this applies to all sheets is the book, +**except** for the sheets which have specific binarization parameters. +- However, if the option `Overwrite sheets?` is ticked, this extension will remove +any specific binarization parameter defined at a sheet level, +thus making **all** sheets inherit from the same (book) parameters. diff --git a/docs/_pages/reference/boards/binary.md b/docs/_pages/reference/boards/binary.md new file mode 100644 index 000000000..91b568e7d --- /dev/null +++ b/docs/_pages/reference/boards/binary.md @@ -0,0 +1,44 @@ +--- +layout: default +title: Binary board +parent: Boards +nav_order: 3 +--- +# Binary board +{: .no_toc :} + +This board, together with the [Pixel board](./pixel.md), is meant to visualize the results +of the binarization algorithm documented in the [BINARY step](../../explanation/steps/binary.md). + +The board is displayed by default in the Gray tab and in the Binary tab. + +- The *pixel* board displays the selected _location_ (x, y). +It can also display the _gray level_ at this location when this information is available. +- The *binary pixel* board always displays the _threshold_ value and the resulting _binary color_. + +## Threshold +This field displays the threshold value to be compared with the gray level at the selected location. + +## Color +This field displays the resulting color of binarization at the selected location: +- *Black* if the pixel value is less than, or equal to, the threshold value, +- *White* otherwise. + +## Board for the Global filter + + + +For the global filter, the threshold value is constant for all pixels in the image. +Nota: this example uses a global value (225) much higher than the default global value (140). + +## Board for the Adaptive filter + + +For the adaptive filter, the threshold value is computed for each location, +based on the mean and the standard deviation of all gray values read around the selected location. + +### Observed mean +This field displays the average value observed in location vicinity. + +### Observed std dev +This field displays the standard deviation value observed in location vicinity. \ No newline at end of file diff --git a/docs/_pages/reference/boards/classifier.md b/docs/_pages/reference/boards/classifier.md new file mode 100644 index 000000000..3baf73e6c --- /dev/null +++ b/docs/_pages/reference/boards/classifier.md @@ -0,0 +1,19 @@ +--- +layout: default +title: Classifier board +parent: Boards +nav_order: 8 +--- +# Basic Classifier board + + + +In current Audiveris version, the basic classifier is a Glyph classifier. + +If a glyph is selected by whatever means, it is automatically submitted to the classifier +and the top 5 shapes are displayed as active buttons, ordered by decreasing grade value. + +Notice that the sum of grade values may exceed 1.0 (because no SoftMax filter is applied). + +A simple click on a shape button assigns the related shape to the glyph at hand. +(To be strictly correct, an `Inter` instance is created with proper shape and glyph). diff --git a/docs/_pages/boards/glyph.md b/docs/_pages/reference/boards/glyph.md similarity index 85% rename from docs/_pages/boards/glyph.md rename to docs/_pages/reference/boards/glyph.md index 8b58ab7f8..9336ef5d0 100644 --- a/docs/_pages/boards/glyph.md +++ b/docs/_pages/reference/boards/glyph.md @@ -1,19 +1,17 @@ --- layout: default title: Glyph board -grand_parent: References parent: Boards -nav_order: 4 +nav_order: 5 --- # Glyph board {: .no_toc :} - + --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- diff --git a/docs/_pages/boards/inter.md b/docs/_pages/reference/boards/inter.md similarity index 74% rename from docs/_pages/boards/inter.md rename to docs/_pages/reference/boards/inter.md index e3154a5b6..93454a82c 100644 --- a/docs/_pages/boards/inter.md +++ b/docs/_pages/reference/boards/inter.md @@ -1,19 +1,17 @@ --- layout: default title: Inter board -grand_parent: References parent: Boards nav_order: 5 --- -# Inter board +# `Inter` board {: .no_toc :} - + --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- @@ -33,7 +31,7 @@ Integer ID of entity. ## Grade (output) -The intrinsic grade value assigned to the Inter instance. +The intrinsic grade value assigned to the `Inter` instance. Followed by the computed contextual grade, if any. ## Deassign @@ -42,7 +40,7 @@ Button available to manually delete this interpretation. ## (shape icon) (output) -If available, the icon related to the Inter shape. +If available, the icon related to the `Inter` shape. ## Edit (input/output) @@ -53,7 +51,7 @@ Button to navigate to the ensemble if any this entity is part of. ## (shape name) (output) -Name of the shape assigned to the Inter instance. +Name of the shape assigned to the `Inter` instance. ## (word) (input/output) @@ -68,13 +66,13 @@ Modifications can be performed at word level only. (input/output) Role of the sentence (such as Direction, PartName, Rights, Lyrics, ...). - + -Nota: `Lyrics` is such a specific sentence role that it cannot be changed in an existing Inter. +Nota: `Lyrics` is such a specific sentence role that it cannot be changed in an existing `Inter`. Instead, a new (lyrics) inter is created automatically. ## (lyrics) - + For a lyrics sentence, the inter board displays additional data: * Voice number, diff --git a/docs/_pages/boards/pixel.md b/docs/_pages/reference/boards/pixel.md similarity index 85% rename from docs/_pages/boards/pixel.md rename to docs/_pages/reference/boards/pixel.md index 41599d7e4..57dab7ed9 100644 --- a/docs/_pages/boards/pixel.md +++ b/docs/_pages/reference/boards/pixel.md @@ -1,22 +1,20 @@ --- layout: default title: Pixel board -grand_parent: References parent: Boards nav_order: 1 --- # Pixel board {: .no_toc } - + The pixel board handles the location within the sheet image, as well as the pixel gray value at the (x,y) location. --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- diff --git a/docs/_pages/boards/section.md b/docs/_pages/reference/boards/section.md similarity index 84% rename from docs/_pages/boards/section.md rename to docs/_pages/reference/boards/section.md index c9659e3e6..ccc01d14c 100644 --- a/docs/_pages/boards/section.md +++ b/docs/_pages/reference/boards/section.md @@ -1,22 +1,20 @@ --- layout: default title: Section board -grand_parent: References parent: Boards -nav_order: 3 +nav_order: 4 --- # Section board {: .no_toc :} - + There are two different section boards, one for sections with horizontal runs, one for sections with vertical runs. --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- diff --git a/docs/_pages/reference/boards/shape.md b/docs/_pages/reference/boards/shape.md new file mode 100644 index 000000000..8dfb46c03 --- /dev/null +++ b/docs/_pages/reference/boards/shape.md @@ -0,0 +1,90 @@ +--- +layout: default +title: Shape board +parent: Boards +nav_order: 7 +--- +# Shape board +{: .no_toc :} + +This board allows to handle about 200 different shapes. +To this end, the shapes are organized into some 20 shape-sets, +and each shape-set is presented in a dedicated palette. + +--- +Table of contents +{: .no_toc .text-epsilon } +1. TOC +{:toc} +--- + +## Catalog of all shape-sets + + + +The shape board initially displays the catalog of all shape-sets. + +In the picture above, we can see: +- Accidentals, Articulations, Attributes, Barlines, BeamsAndTuplets, + Clefs, Dynamics, Flags, Holds, +- Keys, HeadsAndDot, Markers, Ornaments, Rests, Times, Digits, + Pluckings, Romans, +- Texts, Physicals. + +From this catalog, displayed with a dark background, no action like a drag n' drop can be launched. +The purpose of the catalog is only to choose a shape-set. + +## One shape-set palette + +Clicking on a shape-set button replaces the global catalog by the selected shape-set, +presented in a dedicated palette. +For example, clicking on the ``HeadsAndDot`` button will display the ``HeadsAndDot`` palette, +whose content adapts to the book at hand: + +Here is a simple configuration + + + +And here is a more complex configuration for drums notation. +See the [Drums](../../guides/specific/drums.md) chapter for further details. + + + +From any shape palette we can: +* Assign a shape to the current glyph, via a double-click on the proper shape button; +* Initiate a drag & drop action, by pressing the proper shape button and dragging it +to the desired location in sheet. + +To leave the current palette and return to the global shape-set catalog, +we press the `ESCAPE` key or click on the ``up`` (▲) button. + +## Recently used shapes +The shapes most recently used (by whatever means) always appear at the top of the shape board, +making them easily available for a direct reuse. + + + +## Palettes contents + +| Palette name | Palette content | +| :--- | :--- | +| Accidentals |  | +| Articulations |  | +| Attributes |  | +| Barlines |  | +| BeamsEtc |  | +| ClefsAndShifts |  | +| Dynamics |  | +| Flags |  | +| Holds |  | +| Keys |  | +| HeadsAndDot |  | +| Markers |  | +| GraceAndOrnaments |  | +| Rests |  | +| Times |  | +| Digits |  | +| Pluckings |  | +| Romans |  | +| Texts |  | +| Physicals |  | diff --git a/docs/_pages/ui_tools/inter_editors.md b/docs/_pages/reference/editors.md similarity index 80% rename from docs/_pages/ui_tools/inter_editors.md rename to docs/_pages/reference/editors.md index 3e15216eb..03cc62f8b 100644 --- a/docs/_pages/ui_tools/inter_editors.md +++ b/docs/_pages/reference/editors.md @@ -1,38 +1,37 @@ --- layout: default -title: Inter Editors -parent: References +title: Editors +parent: Reference nav_order: 2 --- -# Inter Editors +# Editors {: .no_toc } -This reference chapter gathers the description of all Inter editors variants, -especially regarding the role and potential move of its handles. -It also presents the two variants (Lines and Global) of Staff editor, -even though -- strictly speaking -- a Staff is not an Inter. +This reference chapter gathers the description of all *`Inter`* editors variants, +especially regarding the role and potential move of its handles. ---- -Table of contents (editors are presented in alphabetical order) -{: .no_toc .text-delta } +It also presents the two variants (Lines and Global) of the *Staff* editor. +--- +Table of contents (in alphabetical order) +{: .no_toc .text-epsilon } 1. TOC {:toc} --- -## Default editor +## Default `Inter` editor -The default editor applies to every Inter class, for example the augmentation dot class here below, -unless a more specific editor is defined for the Inter class at hand. +The default editor applies to every `Inter` class, for example the augmentation dot class here below, +unless a more specific editor is defined for the `Inter` class at hand.  -The default editor provides only one handle located at Inter center. -This very basic editor allows to move the Inter in any direction, but provides no way to resize it. +The default editor provides only one handle located at `Inter` center. +This very basic editor allows to move the `Inter` in any direction, but provides no way to resize it. The involved relations if any -- like the "_Augmentation_" relation between the note head and the -augmentation dot in this example -- are dynamically updated while the Inter is being moved. +augmentation dot in this example -- are dynamically updated while the `Inter` is being moved.  Here, we have moved the augmentation dot one line below and the relation is @@ -67,7 +66,7 @@ Shifting or resizing a brace is meant for small adjustments only. If you want to extend or reduce the number of staves embraced by a Brace instance (which is a rather heavy operation that impacts the definition of parts within a system), this must be done **explicitly** by adding or removing a manual Brace. -Please refer to [Part merge](./part.md) section for such Brace usage. +Please refer to [Part merge](../guides/ui/ui_tools/part.md) section for such Brace usage. ## Beam editor @@ -121,7 +120,7 @@ then the editor can shift the **whole key** horizontally.  -See details in [Multi-measure rest section](../specific/multi_rest.md#editing) +See details in [Multi-measure rest section](../guides/specific/multi_rest.md#editing) ## Octave shift editor @@ -133,7 +132,7 @@ Multiple-line editor:  -See details in [Octave Shift section](../specific/octave_shift.md#editing) +See details in [Octave Shift section](../guides/specific/octave_shift.md#editing) ## Slur editor  @@ -151,7 +150,7 @@ This is the most complex editor: All the various lines handles in staff are available for individual vertical dragging. -See Staff Editing [Lines mode](staff_editor.md#lines-mode). +See Staff Editing [Lines mode](../guides/ui/ui_tools/staff_editing.md#lines-mode). ## Staff global editor @@ -164,7 +163,7 @@ Handles are located on the staff middle line but they work for all lines as a wh * Non-side handles can be dragged only vertically. -See Staff Editing [Global mode](staff_editor.md#global-mode). +See Staff Editing [Global mode](../guides/ui/ui_tools/staff_editing.md#global-mode). ## Stem/Arpeggiato/Connector editor diff --git a/docs/_pages/folders/README.md b/docs/_pages/reference/folders/README.md similarity index 94% rename from docs/_pages/folders/README.md rename to docs/_pages/reference/folders/README.md index 0a86a889f..25512e0cb 100644 --- a/docs/_pages/folders/README.md +++ b/docs/_pages/reference/folders/README.md @@ -1,9 +1,8 @@ --- layout: default title: Folders -parent: References +parent: Reference nav_order: 6 -has_children: true --- # Folders diff --git a/docs/_pages/folders/cached.md b/docs/_pages/reference/folders/cached.md similarity index 70% rename from docs/_pages/folders/cached.md rename to docs/_pages/reference/folders/cached.md index 9e695bd44..e3cae3be3 100644 --- a/docs/_pages/folders/cached.md +++ b/docs/_pages/reference/folders/cached.md @@ -1,7 +1,6 @@ --- layout: default title: Cached folders -grand_parent: References parent: Folders nav_order: 3 --- @@ -10,8 +9,7 @@ nav_order: 3 --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- @@ -25,16 +23,17 @@ These files are **not** meant to be edited, period! ## GUI folder These are opaque files used for GUI lifecycle (notably last position and size of each window) -- mainFrame.session.xml -- optionsFrame.session.xml -- aboutDialog.session.xml +- AudiverisMainFrame.session.xml +- LanguagesFrame.session.xml +- LogicalPartsEditor.session.xml - etc... -| OS | GUI folder | +| OS | `GUI folder` | | --- | --- | | **Windows** | %APPDATA%\\AudiverisLtd\\audiveris | -| **Linux** | ~/audiveris | -| **MacOS** | TODO: !!! **I DON'T KNOW** !!!| +| **Linux** | $HOME/.audiveris | +| **Flatpak** | $HOME/.audiveris | +| **macOS** | TODO: !!! **I DON'T KNOW** !!!| ## Log folder @@ -46,7 +45,8 @@ that covers all log events of the session. | **Windows** | %APPDATA%\\AudiverisLtd\\audiveris\\log | | **Linux** (choice #1)| $XDG_CACHE_HOME/AudiverisLtd/audiveris/log | | **Linux** (choice #2)| $HOME/.cache/AudiverisLtd/audiveris/log | -| **MacOS** | $HOME/Library/AudiverisLtd/audiveris/log | +| **Flatpak** | $HOME/.var/app/org.audiveris.audiveris/cache/log | +| **macOS** | $HOME/Library/AudiverisLtd/audiveris/log | ## Temp folder diff --git a/docs/_pages/folders/essential.md b/docs/_pages/reference/folders/essential.md similarity index 55% rename from docs/_pages/folders/essential.md rename to docs/_pages/reference/folders/essential.md index 36bf9b793..23b49d7fc 100644 --- a/docs/_pages/folders/essential.md +++ b/docs/_pages/reference/folders/essential.md @@ -1,48 +1,52 @@ --- layout: default title: Essential folders -grand_parent: References parent: Folders nav_order: 2 --- # Essential folders {: .no_toc :} +This is where Audiveris stores user-specific essential parameters: + +You can create or modify these files, provided you are an advanced user and +know what you are doing. + --- Table of contents -{: .no_toc .text-delta } - +{: .no_toc .text-epsilon } 1. TOC {:toc} --- -## Purpose - -This is where Audiveris stores user-specific essential parameters: - -Under Windows notably, these are _hidden locations_ by default. -Please do not create or modify these files, unless you are an advanced user and -know what you are doing. - ## Config folder Audiveris defines a `CONFIG_FOLDER` for configuration files: | File name | Description | | :--- | :--- | -| **run.properties** | User-modified application options | +| **run.properties** | User-modified application constants | | **logback.xml** | Logging configuration | -| **plugins.xml** | Definition of plugins to external programs | +| **plugins.xml** | Definition of plugins to external programs
See the [Plugins](../../guides/advanced/plugins.md) section. | | **user-actions.xml** | Additional GUI actions | -Precise location of `CONFIG_FOLDER` depends on OS environment: +The precise location of `CONFIG_FOLDER` depends on OS environment: | OS | `CONFIG_FOLDER` | | :--- | :--- | | **Windows** | %APPDATA%\\AudiverisLtd\\audiveris\\config | | **Linux** (choice #1)| $XDG_CONFIG_HOME/AudiverisLtd/audiveris | | **Linux** (choice #2)| $HOME/.config/AudiverisLtd/audiveris | -| **MacOS** | $HOME/Library/Application Support/AudiverisLtd/audiveris | +| **Flatpak** | $HOME/.var/app/org.audiveris.audiveris/config | +| **macOS** | $HOME/Library/Application Support/AudiverisLtd/audiveris | + +## Tessdata folder + +Starting with 5.4 release, the language files needed by Tesseract OCR software, +are hosted in the `tessdata` sub-folder of `CONFIG_FOLDER`. + +To populate this `tessdata` folder, the interactive user can simply use the +{{ site.tools_languages}} pull-down menu. ## Train folder @@ -51,7 +55,7 @@ material and trained model to override default Audiveris model: | File name | Description | | :--- | :--- | -| **basic-classifier.zip** | Trained model and norms for glyph classifier | +| **basic-classifier.zip** | Trained model and norms for the glyph classifier | | **samples.zip** | Global repository of training samples | | **images.zip** | Background sheet images of training samples | diff --git a/docs/_pages/reference/folders/standard.md b/docs/_pages/reference/folders/standard.md new file mode 100644 index 000000000..605c74206 --- /dev/null +++ b/docs/_pages/reference/folders/standard.md @@ -0,0 +1,82 @@ +--- +layout: default +title: Standard folders +parent: Folders +nav_order: 1 +--- + +# Standard folders +{: .no_toc } +{: .d-inline-block } +changed in 5.4 +{: .label .label-green} + +This is where Audiveris stores all score outputs, such as the `.omr` project +files, the `.pdf` printouts, the `.mxl` MusicXML files, etc. + +Of course, we always have the ability to interactively store output +by using the commands that prompt for a target location, like: +- {{ site.book_print_as}} +- {{ site.book_export_as}} +- {{ site.book_save_as}} + +Also, if we load an existing `.omr` file, perhaps to further modify it, +it will be saved by default to the same location it was loaded from. + +Now, if we are processing some input file, say `foo.pdf`, the question is: +where will its output files (`foo.omr`, `foo-print.pdf`, `foo.mxl`, ...) be stored *by default*? + +The target locations are presented in the following sections, by decreasing priority. + +--- +Table of contents +{: .no_toc .text-epsilon } +1. TOC +{:toc} +--- + +## Command line option + +The CLI option `-output
Its related `Glyph`, using pale blue and pink colors, is mostly hidden behind. | diff --git a/docs/_pages/tutorials/main_concepts/run_section.md b/docs/_pages/tutorials/main_concepts/run_section.md new file mode 100644 index 000000000..ac4da5808 --- /dev/null +++ b/docs/_pages/tutorials/main_concepts/run_section.md @@ -0,0 +1,69 @@ +--- +layout: default +title: Pixels assemblies +parent: Main concepts +nav_order: 2 +--- +# Pixels assemblies + +The `BINARY` step transforms the input image into a black and white image. +From this step on, the image will contain only black (foreground) pixels on a white background. + +A (black) pixel is just a black square, of dimension 1 x 1, located at some point (x,y). + +Depending on what the engine has to process (staff lines, stems, beams, etc), +the same pixels can be viewed through one structure or another. + +## `Run` and `RunTable` + +A horizontal (or vertical) contiguous sequence of pixels of the same color is called a +horizontal (or vertical) `Run`. +In the same alignment, such `run` is followed by a `run` of the opposite color, and so on, +until the image border is reached. + +A `RunTable` is a rectangular area, made of sequences of `run`'s, all of the same orientation. +Typically, the whole binarized image can be considered, at the same time, as: +- a table of horizontal `run`'s +- a table of vertical `run`'s + +## `Section` and `LAG` + +It can be interesting to transitively join adjacent (black) `run`'s of the same orientation, +according to some compatibility rules. + +Each such resulting assembly is called a `Section`. + +Typical compatibility rules are: +- Maximum difference in `run` lengths +- Maximum ratio of difference in `run` lengths +- Maximum shift on each `run` end +- Void rule (no check, except adjacency) + +Sections are gathered into `LAG`'s (**L**inear **A**djacency **G**raphs). + +Just like a `RunTable` gathers `Run`'s of the same orientation, +a `LAG` gathers `Section`'s of the same orientation. + +## Sections example + + + +The picture above can be displayed once the `GRID` step has been performed. +We select the "section" view  +via the {{ site.view_selections }} pull-down menu or the `F11` function key. + +Based on the maximum staff line thickness (previously determined by the `SCALE` step), +this picture combines sections from two different `LAG`'s: +1. From the vertical `LAG`, all the (vertical) sections +with length greater than the maximum line thickness are displayed in pale blue. +2. From the horizontal `LAG`, the remaining pixels are organized in (horizontal) sections +and displayed in pale pink. + +## Filament + +A `Filament` is a dynamic assembly of sections, long and thin, likely to represent lines. + +The engine uses: +- horizontal filaments to detect staff lines and ledgers alignments, +- vertical filaments to detect stems and legs of endings. + diff --git a/docs/_pages/main/sig.md b/docs/_pages/tutorials/main_concepts/sig.md similarity index 77% rename from docs/_pages/main/sig.md rename to docs/_pages/tutorials/main_concepts/sig.md index 1fad4387f..9c7cc1ebc 100644 --- a/docs/_pages/main/sig.md +++ b/docs/_pages/tutorials/main_concepts/sig.md @@ -1,43 +1,42 @@ --- layout: default title: SIG -grand_parent: Main Features -parent: Main Entities -nav_order: 5 +parent: Main concepts +nav_order: 4 --- -# Symbol Interpretation Graph +# Symbol Interpretation Graph (SIG) ## Relation -A Relation instance formalizes a relationship between a source Inter instance and a (separate) -target Inter instance. +A _Relation_ instance formalizes a relationship between a source `Inter` instance and a (separate) +target `Inter` instance. There are 3 kinds of relation: -* A _positive_ relation represents a **mutual support** between two Inter instances. - +* A _positive_ relation represents a **mutual support** between two `Inter` instances. + Here we have a typical example: a filled head interpretation and a stem interpretation nearby with a suitable _HeadStemRelation_ between them, shown as a "_HeadStem_"-labelled green segment (the "_Relation_" suffix is always omitted in relation name display). -Support relations _increase_ the contextual grade of their linked Inter instances. +Support relations _increase_ the contextual grade of their linked `Inter` instances. In this way, even rather low-quality interpretations, when well combined through supporting relations, may end up with acceptable contextual grade. -* A _negative_ relation represents a **mutual exclusion** between two Inter instances. +* A _negative_ relation represents a **mutual exclusion** between two `Inter` instances. Typically, two different interpretations for the same underlying glyph will compete with one another and will thus be linked by an _Exclusion_ relation. -An exclusion tells the engine that the two Inter instances cannot coexist in the final configuration, +An exclusion tells the engine that the two `Inter` instances cannot coexist in the final configuration, so at least one of them will be discarded at some point in the transcription process. * A _neutral_ relation is neither positive nor negative, it just conveys information between two -Inter instances. +`Inter` instances. For example a head-chord is an ensemble composed of one or several heads and often one stem. There is one _Containment_ relation between the chord ensemble and each of its heads members. If the chord has a stem, there is a _ChordStemRelation_ between chord and stem (along with a supporting _HeadStemRelation_ between each head and the stem). The image below shows a higher level of relation: -* We can see two Inter instances (a treble clef followed by a 2-flat key) linked by a supporting +* We can see two `Inter` instances (a treble clef followed by a 2-flat key) linked by a supporting _ClefKeyRelation_ instance. * This _ClefKeyRelation_ exists because the vertical positions (pitches) of the flat signs configuration in this key (B then E) are compatible with a treble clef. @@ -45,11 +44,11 @@ configuration in this key (B then E) are compatible with a treble clef. between the two competing clef candidates, plus another _Exclusion_ between the bass clef and this key (because the vertical positions of this key are not compatible with a bass clef). - + ## SIG -A **S**ymbol **I**nterpretation **G**raph (SIG), is simply a graph with Inter instances as vertices +A **S**ymbol **I**nterpretation **G**raph (SIG), is simply a graph with `Inter` instances as vertices and Relation instances as edges. The SIG plays a central role in Audiveris V5. @@ -57,5 +56,5 @@ Its main purpose is to host all candidate Interpretations and to formalize and m (mutual exclusions, supporting relations) within the population of candidate interpretations. There is one SIG per system, and at precise points in the OMR engine pipeline (the REDUCTION step and -the LINKS step), each SIG is _reduced_ so that all exclusions are resolved and no Inter with weak +the LINKS step), each SIG is _reduced_ so that all exclusions are resolved and no `Inter` with weak contextual grade remains in its graph. diff --git a/docs/_pages/tutorials/main_window/README.md b/docs/_pages/tutorials/main_window/README.md new file mode 100644 index 000000000..3adb8979d --- /dev/null +++ b/docs/_pages/tutorials/main_window/README.md @@ -0,0 +1,45 @@ +--- +layout: default +title: Main window +parent: Tutorials +nav_order: 4 +--- +# Main window + +This is the window that appears when Audiveris is run in the interactive mode +(which is the standard mode, unless the `-batch` option is specified on the command line). + +From this central window, we can drive the transcription process and edit the results. + + + +This main window is composed of 3 panels: sheet, boards and events. + +## Sheet + +This is the large panel on the left side. +- The **Gray** tab, when available, presents the original image using gray values. +- The **Binary** tab presents the input image binarized into black and white colors. +- The **Data** tab presents the objects +([sections](../main_concepts/run_section.md#section-and-lag), [glyphs](../main_concepts/glyph_inter.md#glyph) and +[inters](../main_concepts/glyph_inter.md#inter)) extracted from the image. +In this `Data` tab, the staff lines are logically removed and drawn as thin lines. + +All tabs, except the `Data` tab, can be manually closed. +Most can be re-opened via the `Sheet` pull-down menu. + +## Boards + +The right panel is a vertical set of boards. +They provide information and editing functions. + +Only basic boards are displayed by default, the others are hidden. +A right click in this column allows to hide or display any board +available for the current sheet tab. + +## Events + +The lower panel is a log of the main events that occurred so far. + +More details are available in the Audiveris log file +(the precise path to the log file is displayed at the top of this events panel). diff --git a/docs/_pages/main/display_modes.md b/docs/_pages/tutorials/main_window/display_modes.md similarity index 60% rename from docs/_pages/main/display_modes.md rename to docs/_pages/tutorials/main_window/display_modes.md index 8ca3666b8..ca19516dd 100644 --- a/docs/_pages/main/display_modes.md +++ b/docs/_pages/tutorials/main_window/display_modes.md @@ -1,36 +1,35 @@ --- layout: default -title: Display Modes -grand_parent: Main Features -parent: Main Window +title: Display modes +parent: Main window nav_order: 1 --- # Data display modes In the sheet panel we can choose between 3 display modes, that are effective in the **Data** tab: -*  The **_physical_** mode displays in the background the sheet +*  The **_physical_** mode displays in the background the sheet sections of pixels (pale blue for vertical sections, pale pink for horizontal sections) and in the foreground the current detected inters colorized according to their recognized shape and quality grade. -*  The **_combined_** mode is a combination of the physical +*  The **_combined_** mode is a combination of the physical and logical layers. It displays the logical interpretations in a translucent manner on top of the physical pixels, to ease the visual detection of any discrepancies. -*  The **_logical_** mode displays only the logical +*  The **_logical_** mode displays only the logical score entities (inters). It represents the current transcription of the original image, annotated by informations such as system number, measure number, time slot offset, etc. Using the menu {{ site.view_layers }} or the **F12** function key or the dedicated toolbar icon -(//), +(//), we can cycle through these 3 different modes: Physical / Combined / Logical. | Mode | Data tab | | --- | --- | -|  Physical mode |  | -|  Combined mode |  | -|  Logical mode |  | +|  Physical mode |  | +|  Combined mode |  | +|  Logical mode |  | The other tabs are not impacted by the display mode. Notably, the **Binary** tab (which was mode-sensitive in previous Audiveris versions) @@ -39,4 +38,4 @@ so that it can instantly be used as a reference via a simple click on its tab: | No mode impact | Binary tab | | --- | --- | -| |  | +| |  | diff --git a/docs/_pages/main/entity_colors.md b/docs/_pages/tutorials/main_window/entity_colors.md similarity index 83% rename from docs/_pages/main/entity_colors.md rename to docs/_pages/tutorials/main_window/entity_colors.md index c99a46ffa..ace3e7357 100644 --- a/docs/_pages/main/entity_colors.md +++ b/docs/_pages/tutorials/main_window/entity_colors.md @@ -1,16 +1,15 @@ --- layout: default -title: Entity Colors -grand_parent: Main Features -parent: Main Window +title: Entity colors +parent: Main window nav_order: 3 --- -# Entity Colors +# Entity colors The sheet window uses different colors to display the entities and the kind of entity that was recognized: - + In this example the _background_ of the third measure stack is colored in pink because the rhythm check has failed for this measure (the first note of the upper voice was mistaken for a quarter @@ -20,7 +19,7 @@ The following _foreground_ colors are used for interpretation items in this wind * blue: bars, clefs, times, lyrics * purple: accidentals, articulations -* pale blue / pale rose: non recognized elements (vertical sections / horizontal sections) +* pale blue / pale pink: non recognized elements (vertical sections / horizontal sections) * brown: stems, slurs, normal text (not lyrics) * green: note heads (also small heads and augmentation points), flags, rests * red: elements in some abnormal status; typically some needed connection is missing diff --git a/docs/_pages/main/pan_zoom.md b/docs/_pages/tutorials/main_window/pan_zoom.md similarity index 84% rename from docs/_pages/main/pan_zoom.md rename to docs/_pages/tutorials/main_window/pan_zoom.md index 5c8f56945..3e9768d71 100644 --- a/docs/_pages/main/pan_zoom.md +++ b/docs/_pages/tutorials/main_window/pan_zoom.md @@ -1,13 +1,12 @@ --- layout: default -title: Pan and Zoom -grand_parent: Main Features -parent: Main Window +title: Pan and zoom +parent: Main window nav_order: 2 --- -# Pan and Zoom {#pan-and-zoom} +# Pan and zoom -## Moving {#moving} +## Moving The sheet image is usually larger than the window where the sheet is displayed. We can move the display over the sheet using different means: @@ -21,7 +20,7 @@ We can move the display over the sheet using different means: * By pressing on one of the 4 arrow keys to move the display in related direction, * By pressing on one of the 4 arrow keys, while `Shift` is held down, to move pixel by pixel. -## Zoom {#zoom} +## Zoom It can be adjusted in the range [1:8 to 32:1] by several means: @@ -37,7 +36,7 @@ It can be adjusted in the range [1:8 to 32:1] by several means: - Key `Ctrl+ 0` (as well as `Ctrl+Shift 0`) to reset zoom. * By using a rectangular "lasso" while holding both keys `Ctrl+Shift` pressed. When releasing the mouse, the zoom will be adjusted so that both rectangle sides become fully visible. -* By using the predefined buttons and , +* By using the predefined buttons and , we can fit to the sheet's width or height, respectively. When zooming in or out, the display remains focused on its current selection, if any. diff --git a/docs/_pages/main/voice_colors.md b/docs/_pages/tutorials/main_window/voice_colors.md similarity index 53% rename from docs/_pages/main/voice_colors.md rename to docs/_pages/tutorials/main_window/voice_colors.md index d47faef9a..f2a482bc7 100644 --- a/docs/_pages/main/voice_colors.md +++ b/docs/_pages/tutorials/main_window/voice_colors.md @@ -1,45 +1,45 @@ --- layout: default -title: Voice Colors -grand_parent: Main Features -parent: Main Window +title: Voice colors +parent: Main window nav_order: 4 --- -# Voice Colors +# Voice colors By default, as described in the previous section, each score entity is displayed using a color determined according to the entity kind: - + -But we can decide to focus on **voices**, rather than entity **kinds**, and thus choose to display -each entity according to its voice, if any. +But we can decide to focus on **voices**, rather than entity **kinds**, +and thus choose to display each entity according to its voice, if applicable. This feature is reported to ease the detection of wrong voice assignment. -To do this, we can use the pull-down menu {{ site.view_voices }} -(or directly the related toolbar button): +To do this, we use the pull-down menu {{ site.view_voices }} +or the related toolbar button : - + This results in the following display: - + Within any given part, voice numbers (and thus colors) are assigned as follows: - -* Voices starting on the first staff use numbers 1 through 4, -* Voices starting on the second staff use numbers 5 through 8. + +* The voices *starting* on the upper staff use numbers 1 through 4, +* The voices *starting* on the lower staff use numbers 5 through 8. -## Shared Heads +## Shared heads Note that some note heads can be _shared_ between two chords. -In the example above, this is the case in the last staff, for the starting head of each measure +In the example above, this is the case in the last staff, for the starting head of each measure, except the first one. -In such canonical case, the chords involved are the chord below on the left and the chord above on the right. +In such canonical case, the chords involved are the chord below on the left +and the chord above on the right. To indicate the **_shared_** aspect of such head, a small diagonal red segment is drawn across the head, to indicate a logical split of the shared head. - + Here, voices are colorized, thus each head _'half'_ appears with its own voice color. diff --git a/docs/_pages/quick/README.md b/docs/_pages/tutorials/quick/README.md similarity index 55% rename from docs/_pages/quick/README.md rename to docs/_pages/tutorials/quick/README.md index 630a20774..64dd09685 100644 --- a/docs/_pages/quick/README.md +++ b/docs/_pages/tutorials/quick/README.md @@ -1,15 +1,15 @@ --- layout: default -title: Quick Tour +title: Quick tour +parent: Tutorials nav_order: 2 -has_children: true --- -# Quick Tour +# Quick tour This chapter describes a very early tour of Audiveris, featuring the basic workflow that goes from -the _image_ of some sheet of music to the _sound_ of contained music. +the _image_ of some sheet of music to the _sound_ of the music it represents. -The other chapters will cover in more details each step of perhaps more complex workflows, +Other chapters will cover in more details each step of perhaps more complex workflows, but for the sake of simplicity, let's assume that we already have: * Audiveris installed, @@ -23,10 +23,10 @@ All we have to do is, in sequence: 4. Export the score in MusicXML, 5. Play the exported MusicXML file with MuseScore. -For the impatient, note that if we have defined a [plugin](../advanced/plugins.md) to a sequencer -like MuseScore, the sub-sequence of bullets \#3, \#4 and \#5 could conveniently be replaced by just -pressing the plugin button. -This would give: +For the impatient, note that if we have defined a [plugin](../../guides/advanced/plugins.md) +to a sequencer like MuseScore, the sub-sequence of bullets \#3, \#4 and \#5 above could +conveniently be replaced by just pressing the plugin button. +This would now give: 1. Launch Audiveris, 2. Load the input image, 3. Press the Plugin button. diff --git a/docs/_pages/tutorials/quick/export.md b/docs/_pages/tutorials/quick/export.md new file mode 100644 index 000000000..86874486e --- /dev/null +++ b/docs/_pages/tutorials/quick/export.md @@ -0,0 +1,66 @@ +--- +layout: default +title: Export +nav_order: 4 +parent: Quick tour +--- +# Export + +## Saving to `.omr` file + +From the input image, the Audiveris OMR engine has gradually built specific information +that we collectively refer to as "_OMR data_". + +The reference chapter on [`.omr` files](../../reference/outputs/omr.md) +describes thoroughly how this OMR data is organized. +For now, it is enough to know that we can save (and reload) this OMR information to/from disk +(into a `.omr` file). + +Saving can be done via the pull-down menu {{ site.book_save }} +or via the `Ctrl+S` shortcut (`Command+S` for macOS): + + + +In our "chula" example, this will result in a `chula.omr` file. + +Saving the OMR job is not strictly necessary for our very small example. + +It is important to know that Audiveris can always restart from a saved `.omr` file, +even from very old files, which allows to resume processing and user editing +where they were stopped. + +For sizable OMR jobs, this capability is essential. + +## Exporting to `.mxl` file + +Right now, we are focused only on how to feed a music sequencer with music data it can easily import. +And as of this writing, this is achieved by going through the *de facto* standard of **MusicXML**-formatted data. + +This can be done via the pull-down menu {{ site.book_export }}: + + + +From our "chula" example, this command produces a file named `chula.mxl` +(the `.mxl` extension indicates a compressed MusicXML format). + +## Output location + +Starting with the 5.4 release, the default policy is to put any output file next to the input file. + +This default policy can be changed via the [Preferences](../../guides/advanced/preferences.md) dialog. + +We can also use the "`Save book as`" or the "`Export book as`" menu items to choose a specific output location and name. + +## `.omr` files vs. `.mxl` files + +These files are not equivalent. + +The export from OMR to MusicXML is _lossy_, since a large amount of OMR information +can't go into MusicXML. +A `.omr` file can always be used to regenerate the `.mxl` export, but the reverse is not true. + +{: .note} +A good advice is to keep these `.omr` files +-- unless we are running out of disk space! :-) -- +because they represent a valuable source of OMR information, +suitable for training newer versions of Audiveris (more on this later). diff --git a/docs/_pages/tutorials/quick/launch.md b/docs/_pages/tutorials/quick/launch.md new file mode 100644 index 000000000..7d6ddc7ee --- /dev/null +++ b/docs/_pages/tutorials/quick/launch.md @@ -0,0 +1,33 @@ +--- +layout: default +title: Launch +nav_order: 1 +parent: Quick tour +--- +# Launch + +For the sake of simplicity, let's assume that: +1. We are using Windows OS +2. We have installed Audiveris via the provided Windows Installer. +(This installer can be downloaded from the Audiveris +[Releases area](https://github.com/Audiveris/audiveris/releases). +See [Installing binaries](../install/binaries.md)). + +We get into the Windows Start Menu, by pressing the Windows logo key on our keyboard +or by clicking on the Start icon (left end of the taskbar). +In this menu organized by alphabetical order, we move down to the Audiveris folder, +open it, and finally click on the Audiveris executable. + + + +This opens a small terminal window which automatically: +1. Checks our installed Java environment. +If the check fails, Audiveris is not launched. +Instead, a message appears, warning about our [Java environment](../install/binaries.md#java-environment). +2. Launches Java on the Audiveris software. + +This results in the display of the Audiveris [main window](../main_window/README.md), from which we will be able to operate. + +If we don't use binary installation (either the Windows installer or the Linux flatpak), +we should refer to [Building from sources](../install/sources.md) +to build and then launch the software. diff --git a/docs/_pages/quick/load.md b/docs/_pages/tutorials/quick/load.md similarity index 77% rename from docs/_pages/quick/load.md rename to docs/_pages/tutorials/quick/load.md index 7ddd9ae46..7379fdacf 100644 --- a/docs/_pages/quick/load.md +++ b/docs/_pages/tutorials/quick/load.md @@ -2,18 +2,18 @@ layout: default title: Load nav_order: 2 -parent: Quick Tour +parent: Quick tour --- # Load To load an image from disk, we can use the pull-down menu {{ site.file_input }}: - + An `Open` dialog will show up, allowing us to navigate between folders and finally select an image input file: - + Another way to load an input file is to drag this file from the File Explorer and to drop it onto the Audiveris application window. @@ -24,4 +24,4 @@ Here, we have selected the file `chula.png`, and the application window now disp contained image. Actually, it's a *binarized* version of the image: - + diff --git a/docs/_pages/quick/play.md b/docs/_pages/tutorials/quick/play.md similarity index 73% rename from docs/_pages/quick/play.md rename to docs/_pages/tutorials/quick/play.md index 603e1c146..7a9517133 100644 --- a/docs/_pages/quick/play.md +++ b/docs/_pages/tutorials/quick/play.md @@ -2,7 +2,7 @@ layout: default title: Play nav_order: 5 -parent: Quick Tour +parent: Quick tour --- # Play @@ -11,16 +11,15 @@ external program (a simple music sequencer or some high-level editor). Many external programs can work on Audiveris MusicXML export, thanks to the _de facto_ standard MusicXML exchange format. - + Here, we have simply imported the `chula.mxl` MusicXML file into MuseScore. Note that this music editor displays the imported music correctly. -We just have to press the play button to hear the music. +We just have to press the play button to listen to the music.
This is the end of our quick tour. -For a more thorough understanding of Audiveris, we can visit the [Main Features](../main/README.md) -chapter. +For a more thorough understanding of Audiveris, we can visit the next chapter: [Main concepts](../main_concepts/README.md). diff --git a/docs/_pages/quick/transcribe.md b/docs/_pages/tutorials/quick/transcribe.md similarity index 50% rename from docs/_pages/quick/transcribe.md rename to docs/_pages/tutorials/quick/transcribe.md index 5be22d3ca..a2e1bf22b 100644 --- a/docs/_pages/quick/transcribe.md +++ b/docs/_pages/tutorials/quick/transcribe.md @@ -2,7 +2,7 @@ layout: default title: Transcribe nav_order: 3 -parent: Quick Tour +parent: Quick tour --- # Transcribe @@ -11,13 +11,13 @@ from low-level graphical data. This process can be launched directly from the toolbar icon: - + It can also be launched via the pull-down menu {{ site.book_transcribe }}: - + -Note this command applies to all images (sheets) in the input file (book). +This command applies to all images (sheets) in the input file (book). There is also the pull-down menu {{ site.sheet_transcribe }} which applies only to the current sheet. In the simple case at hand, since we have just one image in the input file, the book-level and @@ -25,11 +25,16 @@ sheet-level commands are equivalent. After some time, we get the following image of transcribed music: - + -Looking carefully at this result, we might detect a couple of mistakes near the bottom of the image: -a flat sign not recognized, and an 8th note mistaken for a quarter because of overlapping flag -and 8th-rest chunks. +Looking carefully at this result, we might detect a couple of mistakes: +- On the upper left, the word "Flûte" was OCR'd as "Flfite" [^flute] +- On the lower left, a flat sign was not recognized [^flat] +- On the lower right, a quarter rest was not recognized[^quarter] -This could easily be corrected by manual actions, but let us simply ignore them to keep this -example short. +This could easily be corrected by manual actions, but let us simply ignore them +for now to keep this example short. + +[^flute]: This is a French word, while the OCR language is English by default. See {{ site.tools_languages }} +[^flat]: The underlying glyph collides with a ledger, resulting in poor grade. +[^quarter]: This is due to an overlap with a flag item. \ No newline at end of file diff --git a/docs/_pages/ui_examples/eyes/book_parameters.png b/docs/_pages/ui_examples/eyes/book_parameters.png deleted file mode 100644 index 0d8ec992d..000000000 Binary files a/docs/_pages/ui_examples/eyes/book_parameters.png and /dev/null differ diff --git a/docs/_pages/ui_tools/remove_inter.md b/docs/_pages/ui_tools/remove_inter.md deleted file mode 100644 index 7c12447e0..000000000 --- a/docs/_pages/ui_tools/remove_inter.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: Inter Removal -grand_parent: User Editing -parent: UI Tools -nav_order: 3 ---- -# Inter Removal -{: .no_toc } - -When one or several Inter instances have been selected, we can remove them as follows: - -* The Inter-board has a `Deassign` button which removes the selected inter displayed in the - board. - This applies only for the displayed Inter. -  - -* The {{ site.popup_inters }} contextual menu provides an item to - remove the selected Inter entities according to their containing system. -  - -* Pressing `DELETE` key or `BACKSPACE` key on the keyboard removes all the selected inters. - -If more than one Inter is selected, we will be prompted for confirmation beforehand. - -Removing a selected Inter (or a set of selected Inters) automatically removes the relations these -Inters were involved in. - -Removing the last member of an ensemble also removes that ensemble. diff --git a/docs/_pages/updates.md b/docs/_pages/updates.md deleted file mode 100644 index 2ac8ff874..000000000 --- a/docs/_pages/updates.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -layout: default -title: Updates -nav_order: 8 -has_children: false ---- -# Software updates -{: .no_toc } - -As detailed in the [Git Workflow](https://github.com/Audiveris/audiveris/wiki/Git-Workflow) article -on Audiveris Wiki: -- Audiveris development is performed on the specific GitHub "**development**" branch. - It is thus continuously available for anyone that pulls and builds the software from source. -- The default "**master**" branch is updated only for software releases. - At this time only, a new release is created and uploaded to the [Releases section](https://github.com/Audiveris/audiveris/releases) on GitHub site. - ---- -Table of contents -{: .text-delta } - -1. TOC -{:toc} ---- - -## 5.4 (on-going) - -- User Interface - - Past the SYMBOLS step, the manual removal of any Inter now triggers a dynamic rebuilding of glyphs, - as if the removed Inter had never existed. - - Improvement and extension of default/book/sheet parameters (interline, barline) - - Ability to display some inters in jumbo mode to ease a visual inspection - -- by default this can apply to augmentation dots. - - Ability to gracefully stop the current book processing at the next step end. - - Ability to clear the log window -- the log file remains intact. -- Engine - - The recognition of fermata no longer requires separate recognitions of fermata-arc and fermata-dot. - - The processing of an input image with no white margin around the staves is now possible. -- Project - - A Linux Flatpak package, gathering the needed libraries, proper Java environment - and the main Tesseract language files, is now provided on FlatHub. - - The Windows installer pre-populates the user `config`/`tessdata` folder with the main Tesseract - languages. -- Documentation - - Support for a PDF version of the Audiveris Handbook. -- Java - - In `Audiveris.bat` (used by the Windows installer) and `Audiveris` start scripts, - the Java version is checked before the application is launched. - - Support of Java 21. - - Upgrade to Gradle 8.5 to support Java 21. - - Removal of all deprecated features such as JGoodies PanelBuilder, Observer/Observable, - class.newInstance(), etc. - -## 5.3 - -- User Interface - - Editing of staff geometry, at individual line and global staff levels - - User management of score logical parts, and their mapping to sheet physical parts - - User editing of newly supported features (multi-measure rests, octave shifts, etc) -- Engine - - Support for drums unpitched notation - - Support of several musical font families for better template matching - - Support of several text font families - - Support for multi-measure rests - - Support for measure repeats for 1, 2 and 4 measures - - Support for octave shifts (single and multi-line shifts) - - Support for endings with no left leg, with default number generation - - Support for two populations of beam height and head size - - Support for beam thickness specification - - Support for fingering and plucking -- Project - - Use of Tesseract 5.x in legacy mode - - Support of MusicXML 4.0 - - Generation of Schemas documentation -- Java - - Support of Java 17 - -## 5.2 - -- User Interface - - Ability to move and resize symbols - - Snapping note heads to staff line/ledgers and stems - - Repetitive input - - Ability to merge/split books - - Ability to merge/split parts via brace handling - - Ability to merge systems - - Ability to merge/split chords - - Ability to modify voice or time slot for chords - - Support for compound notes (head + stem) - - Support for key signature cancel (key made of natural signs) - - Improved support for chord names - - Better handling of sentences, chord names, lyrics - - Ability to correct beam thickness scale - - Ability to limit book processing on selected sheets - - Support for high DPI devices - - Internationalization of all menus -- Engine - - Better handling of poor-quality scores - - Support for 1-line percussion staves - - Detection of 4-line and 6-line tablatures - - New algorithm for time slots and voices - - Support for non measure-long whole rests - - Support for implicit tuplets - - Support for merged grand staff configuration - - Support for cross heads - - Plugin mechanism upgraded for multi-movement exports -- Project - - Automated checks for update on GitHub - - Documentation handled on GitHub Pages -- Java - - Support of Java 11 - - Refined dependencies on Java EE, JAXB, etc away from Java 8 - -## 5.1 - -- User Interface - - Visual separation of shared heads - - User assignment of fixed-shape symbols - - Ability to modify scale parameters -- Engine - - Augmentation dots apply to shared heads -- Project - - Windows binary installers (32 and 64) -- Java - - Support of Java 8 - -## 5.0 - -- Engine - - Creation of `.omr` project files diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss index d1512d9c9..83f1c52d6 100644 --- a/docs/_sass/custom/custom.scss +++ b/docs/_sass/custom/custom.scss @@ -1,7 +1,7 @@ h1, .text-alpha { - @include fs-8; - font-weight: 600; + @include fs-9; + font-weight: 300; } h2, @@ -23,6 +23,13 @@ h4, text-transform: none; } +h5, +.text-epsilon { + @include fs-4; + font-weight: 400; + text-transform: uppercase; +} + /* Reference to a footnote */ .footnote::before { content: "["; diff --git a/docs/index.md b/docs/index.md index 7ae39b34c..b495260a3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,10 +6,10 @@ nav_exclude: true ## For the end user -- [HandBook](_pages/handbook) +- [HandBook] This is the general documentation, meant for the end user. It is now available in two versions: - - A web version (what you are reading) + - A web version (the pages you are reading) - A PDF version (downloadable via the button below) {: .d-inline-block } @@ -20,7 +20,22 @@ new {: .btn .text-center } ## For the developer -- [Format of ".omr" files](_pages/outputs/omr) +- [Format of ".omr" files] This is the description of the internals of any ``.omr`` Audiveris book file -- [Audiveris Wiki](https://github.com/Audiveris/audiveris/wiki) +- [Audiveris Wiki] This Wiki gathers various articles about the development and potential evolutions of the Audiveris project. + +## All contributors + +
-
+{% for contributor in site.github.contributors %}
+
-
+
+
+{% endfor %}
+