audiveris icon indicating copy to clipboard operation
audiveris copied to clipboard

Target location of project files

Open hbitteur opened this issue 3 years ago • 0 comments

We have to clarify the various possibilities to determine where Audiveris files are created, beginning with the.omr project file. Today, there is just one default policy and a couple of low-level switches. This needs to be clarified and explained. Perhaps a specific UI dialog could be put in place, to provide a high-level interface hiding the current handling of low-level switches.

Default policy is as follows:

  • A default <base> folder is defined according to the OS (a specific path can still be set via the -output CLI option)
  • For a given /some/path/to/foo.pdf input,
    • if the 'useSeparateBookFolders' switch is set (and it is set by default) then a specific folder will be created under the base folder and the foo.omr will be located there, resulting in <base>/foo/foo.omr
    • if the 'useSeparateBookFolders' switch is false, no specific folder is created and the foo.omr file is located directly in the base folder, resulting in <base>/foo.omr

If the 'useInputBookFolder' switch is set (and it is NOT set by default) the policy is different.

  • The default base folder is not used
  • Instead, for a given /some/path/to/foo.pdf input, the related foo.omr will be located next to the input file, exactly as /some/path/to/foo.omr

In both policies all the output artifacts are by default written as siblings of the foo.omr project file.

hbitteur avatar Feb 16 '22 08:02 hbitteur