Skip to content

Commit

Permalink
Improve the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@Josef-Friedrich
Josef-Friedrich committed Feb 4, 2024
1 parent 0fb90cf commit 16785b6
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 58 deletions.
56 changes: 28 additions & 28 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -318,23 +318,23 @@ XML structure of a meta tag:
All meta tags:

- arranger
- audioComUrl (new in v4)
- composer
- copyright
- creationDate
- lyricist
- movementNumber
- movementTitle
- mscVersion
- platform
- poet (not in v4)
- source
- sourceRevisionId
- subtitle
- translator
- workNumber
- workTitle
- ``arranger``
- ``audioComUrl`` (new in v4)
- ``composer``
- ``copyright``
- ``creationDate``
- ``lyricist``
- ``movementNumber``
- ``movementTitle``
- ``mscVersion``
- ``platform``
- ``poet`` (not in v4)
- ``source``
- ``sourceRevisionId``
- ``subtitle``
- ``translator``
- ``workNumber``
- ``workTitle``

vbox
^^^^
Expand All @@ -345,26 +345,26 @@ XML structure of a vbox tag:
<VBox>
<Text>
<style>Title</style>
<style>title</style>
<text>Some title text</text>
</Text>
All vbox tags:

- title (v2,3: Title)
- subtitle (v2,3: Subtitle)
- composer (v2,3: Composer)
- lyricist (v2,3: Lyricist)
- ``title`` (v2,3: ``Title``)
- ``subtitle`` (v2,3: ``Subtitle``)
- ``composer`` (v2,3: ``Composer``)
- ``lyricist`` (v2,3: ``Lyricist``)

This command line tool bundles some meta data informations:

Combined meta data fields:
^^^^^^^^^^^^^^^^^^^^^^^^^^

- title (1. vbox_title 2. metatag_work_title)
- subtitle (1. vbox_subtitle 2. metatag_movement_title)
- composer (1. vbox_composer 2. metatag_composer)
- lyricist (1. vbox_lyricist 2. metatag_lyricist)
- ``title`` (1. ``vbox_title`` 2. ``metatag_work_title``)
- ``subtitle`` (1. ``vbox_subtitle`` 2. ``metatag_subtitle`` 3. ``metatag_movement_title``)
- ``composer`` (1. ``vbox_composer`` 2. ``metatag_composer``)
- ``lyricist`` (1. ``vbox_lyricist`` 2. ``metatag_lyricist``)

Set the meta tag ``composer``:

Expand Down Expand Up @@ -399,7 +399,7 @@ CLI Usage
usage: musescore-manager [-h] [--print-completion {bash,zsh,tcsh}]
[-C <file-path>] [-b] [-d] [--catch-errors] [-m]
[-e FILE_PATH] [-V] [-v] [-k] [--diff] [--print-xml]
[-E <extension>] [--compress] [-c META_CLEAN] [-D]
[-E <extension>] [--compress] [-c <fields>] [-D]
[-i <source-fields> <format-string>] [-j]
[-l <log-file> <format-string>] [-y]
[-S <field> <format-string>]
Expand Down Expand Up @@ -474,7 +474,7 @@ CLI Usage
meta:
Deal with meta data informations stored in the MuseScore file.

-c META_CLEAN, --clean-meta META_CLEAN
-c <fields>, --clean-meta <fields>
Clean the meta data fields. Possible values: „all“ or a
comma separated list of fields, for example:
„field_one,field_two“.
Expand Down
52 changes: 26 additions & 26 deletions README_template.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -323,23 +323,23 @@ XML structure of a meta tag:
All meta tags:

- arranger
- audioComUrl (new in v4)
- composer
- copyright
- creationDate
- lyricist
- movementNumber
- movementTitle
- mscVersion
- platform
- poet (not in v4)
- source
- sourceRevisionId
- subtitle
- translator
- workNumber
- workTitle
- ``arranger``
- ``audioComUrl`` (new in v4)
- ``composer``
- ``copyright``
- ``creationDate``
- ``lyricist``
- ``movementNumber``
- ``movementTitle``
- ``mscVersion``
- ``platform``
- ``poet`` (not in v4)
- ``source``
- ``sourceRevisionId``
- ``subtitle``
- ``translator``
- ``workNumber``
- ``workTitle``

vbox
^^^^
Expand All @@ -350,26 +350,26 @@ XML structure of a vbox tag:
<VBox>
<Text>
<style>Title</style>
<style>title</style>
<text>Some title text</text>
</Text>
All vbox tags:

- title (v2,3: Title)
- subtitle (v2,3: Subtitle)
- composer (v2,3: Composer)
- lyricist (v2,3: Lyricist)
- ``title`` (v2,3: ``Title``)
- ``subtitle`` (v2,3: ``Subtitle``)
- ``composer`` (v2,3: ``Composer``)
- ``lyricist`` (v2,3: ``Lyricist``)

This command line tool bundles some meta data informations:

Combined meta data fields:
^^^^^^^^^^^^^^^^^^^^^^^^^^

- title (1. vbox_title 2. metatag_work_title)
- subtitle (1. vbox_subtitle 2. metatag_movement_title)
- composer (1. vbox_composer 2. metatag_composer)
- lyricist (1. vbox_lyricist 2. metatag_lyricist)
- ``title`` (1. ``vbox_title`` 2. ``metatag_work_title``)
- ``subtitle`` (1. ``vbox_subtitle`` 2. ``metatag_subtitle`` 3. ``metatag_movement_title``)
- ``composer`` (1. ``vbox_composer`` 2. ``metatag_composer``)
- ``lyricist`` (1. ``vbox_lyricist`` 2. ``metatag_lyricist``)

Set the meta tag ``composer``:

Expand Down
4 changes: 2 additions & 2 deletions docs/cli.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Comande line interface
usage: musescore-manager [-h] [--print-completion {bash,zsh,tcsh}]
[-C <file-path>] [-b] [-d] [--catch-errors] [-m]
[-e FILE_PATH] [-V] [-v] [-k] [--diff] [--print-xml]
[-E <extension>] [--compress] [-c META_CLEAN] [-D]
[-E <extension>] [--compress] [-c <fields>] [-D]
[-i <source-fields> <format-string>] [-j]
[-l <log-file> <format-string>] [-y]
[-S <field> <format-string>]
Expand Down Expand Up @@ -82,7 +82,7 @@ Comande line interface
meta:
Deal with meta data informations stored in the MuseScore file.

-c META_CLEAN, --clean-meta META_CLEAN
-c <fields>, --clean-meta <fields>
Clean the meta data fields. Possible values: „all“ or a
comma separated list of fields, for example:
„field_one,field_two“.
Expand Down
5 changes: 3 additions & 2 deletions mscxyz/cli.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ def _split_lines(self, text: typing.Text, width: int) -> typing.List[str]:
meta_group.add_argument(
"-c",
"--clean-meta",
metavar="<fields>",
dest="meta_clean",
help="Clean the meta data fields. Possible values: „all“ or a comma separated "
"list of fields, for example: "
Expand Down Expand Up @@ -714,7 +715,7 @@ def _split_lines(self, text: typing.Text, width: int) -> typing.List[str]:
action.complete = shtab.FILE # type: ignore


def __print_error(error: Exception) -> None:
def _print_error(error: Exception) -> None:
msg = ""

if isinstance(error, SyntaxError):
Expand Down Expand Up @@ -969,4 +970,4 @@ def list_styles(version: int) -> None:
if not args.general_catch_errors:
raise e
else:
__print_error(e)
_print_error(e)

0 comments on commit 16785b6

Please sign in to comment.