Skip to content

Commit

Permalink
v2.17 update
Browse files Browse the repository at this point in the history
  • Loading branch information
eturpault authored Dec 23, 2024
1 parent 6daf3e9 commit 35fdc9e
Showing 1 changed file with 29 additions and 18 deletions.
47 changes: 29 additions & 18 deletions src/resources/Help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,26 @@
>> General information
This tool is intended to help in editing and checking a GrandOrgue organ definition file (ODF, extension .organ) in plain text mode, with the help of objects sections browsers (sorted list or tree).
To completely check the goodness of an ODF, loading it in GrandOrgue will detect deeply all the remaining errors if any.
The ODF syntax help below is largely inspired and copy/pasted from the GrandOrgue help.

Commands
------------------
Double clicking a section name in the sections list will expand the sections tree so that all the occurrences of the selected section are visible in the tree.
Double clicking on a parent or child section name in the parents/children list will make this section the selected one in the sections list and tree.
Double clicking on a search result in the HW sample set will make show the related section in the "HW sections" tab.
Right clicking in the logs area displays a contextual menu, permitting to clear logs or to select the section which the name is under the mouse cursor.
Pressing on the Delete button of the computer keyboard will do the same as clicking on the Delete button of OdfEdit.
The help below is largely inspired and copy/pasted from the GrandOrgue help.
Double clicking on a search result in the HW sample set will show the related section in the "HW sections" tab.
Right clicking in the logs area displays a contextual menu permitting to clear logs or to select the section which the name is under the mouse cursor.
Pressing on the Delete button of the computer keyboard will do the same as clicking on the Delete button of OdfEdit if the mouse cursor is over a sections list or tree.

Multiple sections selection in sections lists/tree
------------------
Mouse left click + Shift key permits to extend the selected sections until the clicked section.
Mouse left click + Control key permits to add/remove the clicked sections.
Only sections of same type, and under the same parent if selected in the sections tree, can be selected together.

Drag & drop of selected sections :
------------------
Sections can be moved or cloned (if Control key pressed) under another parent.
Sections can be moved before or after another section of the same type.

Menu items
------------------
Expand All @@ -26,11 +40,17 @@ If some notes of the converted ODF are not played at the expected pitch in Grand
HW to GO - correct pipes pitch from samples file name => if checked, the MIDI note number defined in samples file name is used to apply if necessary a pitch tuning correction to some pipes.
HW to GO - correct pipes pitch from samples metadata => if checked, the MIDI note number defined in samples metadata is used to apply if necessary a pitch tuning correction to some pipes. This method can increase the conversion time as the metadata of each sample file are decoded, so this option should be used after the first one (from file name) if it does not fix the observed pipes pitch issues.

Drag & drop
------------------
A section name can be dragged from the sections list or tree and dropped onto another section name of the sections list or tree. The mouse cursor indicates dynamically if the drop is possible or not.
If a section name is dropped onto a same type section name it is moved before it (if it has a higher section number) or after it (if it has a lower section number).
If a section name is dropped onto a section which can be its parent section, it is moved as child of this parent section. If the Control key is pressed at the same time, the dragged section is copied under the parent section instead of moved. This is possible only with the following section types : Coupler, Enclosure, PanelElement, PanelImage, Rank, Stop, Switch, Tremulant.
>> Hauptwerk sample sets

OdfEdit permits as well to open the ODF of a Hauptwerk sample set (not encrypted, not dongle protected, located in the folder OrganDefinitions of the sample set package, extension .Organ_Hauptwerk_xml or .xml) and to generate from it a GrandOrgue ODF permitting to play this sample set with GrandOrgue (GO ODF located in the same folder as the HW ODF). None file of the Hauptwerk sample set is modified.
A Hauptwerk ODF having more numerous and complex settings than a GrandOrgue ODF, the organ played with GrandOrgue will not have necessarily the same sound quality and control possibilities as it can have with Hauptwerk.
The generated GO ODF does not permit to apply a different temperament than the native one of the organ.

Please do this operation only with a free Hauptwerk sample set or a not-free sample set that you have duly paid for, and if the editor of this sample set does not preclude its use outside Hauptwerk.

In case of bugs observed with this tool, or errors generated by this tool when converting a Hauptwerk ODF to a GrandOrgue ODF, please open an issue in the github project GrandOrgue/OdfEdit.

>> GrandOrgue sample sets

An ODF is a text file in ISO-8859-1 encoding. The standard extension is .organ. As an alternative, the file can be encoded in UTF-8 if it starts with the appropriate byte order marker.
It is composed of several sections, each one being organized like this :
Expand All @@ -44,15 +64,6 @@ The text is case sensitive for sections name and attributes.
Each section name must be defined only once in the whole ODF.
Each attribute must be defined only once in his section.

>> Hauptwerk sample sets
This tool permits as well to open the ODF of a Hauptwerk sample set (not encrypted, not dongle protected, located in the folder OrganDefinitions of the sample set package, extension .Organ_Hauptwerk_xml or .xml) and to generate from it a GrandOrgue ODF permitting to play this sample set with GrandOrgue (GO ODF located in the same folder as the HW ODF). None file of the Hauptwerk sample set is modified.
A Hauptwerk ODF having more numerous and complex settings than a GrandOrgue ODF, the organ played with GrandOrgue will not have necessarily the same sound quality and control possibilities as it can have with Hauptwerk.
The generated GO ODF does not permit to apply a different temperament than the native one of the organ.

Please do this operation only with a free Hauptwerk sample set or a not-free sample set that you have duly paid for, and if the editor of this sample set does not preclude its use outside Hauptwerk.

In case of bugs observed with this tool, or errors generated by this tool when converting a Hauptwerk ODF to a GrandOrgue ODF, please open an issue in the github project GrandOrgue/OdfEdit.

>> Sections names summary
Available sections names (999 stands for a 3-digits placeholder, it must be higher than 0, it can be equal to 0 for Manual and Panel only) :
[ Organ ] : the general description of the instrument (and the main panel for old panel format)
Expand Down

0 comments on commit 35fdc9e

Please sign in to comment.