Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move recording variables to Advanced Variables section #213

Merged
merged 5 commits into from
Oct 18, 2023
Merged

Move recording variables to Advanced Variables section #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
02ebda0
Move recording variables to Advanced Variables.
rdswift Sep 29, 2023
7582f7f
Categorize tags and variables into groups depending on options selected
rdswift Oct 15, 2023
c01f1e2
More fine tuning of tag and variable categorization
rdswift Oct 17, 2023
d9a31e2
Fix accidentally moving the wrong tag. (Oops...)
rdswift Oct 17, 2023
331b5bb
Move `_releasegroup_series*` variables to "Use release relationships"
rdswift Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 69 additions & 38 deletions variables/tags_advanced.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,106 +4,137 @@

.. TODO: Note which tags are not provided by Picard


.. Test Release 1

.. No extra relationships specified
.. https://musicbrainz.org/ws/2/release/8c759d7a-2ade-4201-abc2-a2a7c1a6ad6c?inc=aliases+annotation+artist-credits+artists+collections+discids+isrcs+labels+media+recordings+release-groups&fmt=json

.. Release extra relationships specified
.. https://musicbrainz.org/ws/2/release/8c759d7a-2ade-4201-abc2-a2a7c1a6ad6c?inc=aliases+annotation+artist-credits+artists+collections+discids+isrcs+labels+media+recordings+release-groups+artist-rels+recording-rels+release-group-level-rels+release-rels+series-rels+url-rels+work-rels&fmt=json

.. Track extra relationships specified
.. https://musicbrainz.org/ws/2/release/8c759d7a-2ade-4201-abc2-a2a7c1a6ad6c?inc=aliases+annotation+artist-credits+artists+collections+discids+isrcs+labels+media+recordings+release-groups+artist-rels+recording-rels+release-group-level-rels+release-rels+series-rels+url-rels+work-rels+recording-level-rels+work-level-rels&fmt=json


.. Test Release 2

.. No extra relationships specified
.. https://musicbrainz.org/ws/2/release/59f6dc82-6e05-4d58-8fae-d93c55a250ef?inc=aliases+annotation+artist-credits+artists+collections+discids+isrcs+labels+media+recordings+release-groups&fmt=json

.. Release extra relationships specified
.. https://musicbrainz.org/ws/2/release/59f6dc82-6e05-4d58-8fae-d93c55a250ef?inc=aliases+annotation+artist-credits+artists+collections+discids+isrcs+labels+media+recordings+release-groups+artist-rels+recording-rels+release-group-level-rels+release-rels+series-rels+url-rels+work-rels&fmt=json

.. Track extra relationships specified
.. https://musicbrainz.org/ws/2/release/59f6dc82-6e05-4d58-8fae-d93c55a250ef?inc=aliases+annotation+artist-credits+artists+collections+discids+isrcs+labels+media+recordings+release-groups+artist-rels+recording-rels+release-group-level-rels+release-rels+series-rels+url-rels+work-rels+recording-level-rels+work-level-rels&fmt=json


:index:`Advanced Tags <tags; advanced>`
========================================

You can make additional tags available by enabling the :doc:`Use track relationships </config/options_metadata>` and the
:doc:`Use genres from MusicBrainz </config/options_genres>` settings in Picard.
You can make additional tags available by enabling the :doc:`Use track relationships </config/options_metadata>` and/or the :doc:`Use genres from MusicBrainz </config/options_genres>` settings in Picard.

Some tags provide the :index:`MusicBrainz Identifier (MBID) <identifier; musicbrainz, mbid>` of the entity. The MBID is a 32-character identifier assigned to an entity (e.g.: artist, album, track or work) to uniquely identify the entity. For more information about MBIDs, please see the `MusicBrainz Identifier <https://musicbrainz.org/doc/MusicBrainz_Identifier>`_ page in the MusicBrainz documentation.

.. note::

Tags will not be created and will not be available as variables if there was no value retrieved for the tag
from the MusicBrainz database.
Tags will not be created and will not be available as variables if there was no value retrieved for the tag from the MusicBrainz database.

.. note::

Some of these tags are only supported for certain file types or tag formats. Please see the :doc:`Picard Tag Mapping
</appendices/tag_mapping>` section for details.
Some of these tags are only supported for certain file types or tag formats. Please see the :doc:`Picard Tag Mapping </appendices/tag_mapping>` section for details.


.. _advanced_relationships:


Track Relationship Tags
--------------------------
If you enable tagging with "Use track relationships", you get these extra tags:
-----------------------

If you enable "Use track relationships" in the Option settings, you get these extra tags:
phw marked this conversation as resolved.
Show resolved Hide resolved

**arranger**

The names of the arrangers associated with the track. These can include the instrument and orchestra arrangers,
and could be associated with the release, recording or work. (*since Picard 0.10*)
The names of the arrangers associated with the track. These can include the instrument and orchestra arrangers, and could be associated with the release, recording or work. (*since Picard 0.10*)

**composer**

The names of the composers for the associated work.
The names of the composers for the associated work.

**composersort**

The sort names of the composers for the associated work.
The sort names of the composers for the associated work.

**conductor**

Tha names of the conductors associated with the track. These can include the conductor and chorus master, and could
be associated with the release or recording.
The names of the conductors associated with the track. These can include the conductor and chorus master, and could be associated with the release or recording.

**director**

The director of a track as provided by the Video Director or Audio Director relationship in MusicBrainz. (*Since Picard 2.6, updated in Picard 2.9*)
The director of a track as provided by the *Video Director* or *Audio Director* relationship in MusicBrainz. (*Since Picard 2.6, updated in Picard 2.9*)

**djmixer**

The names of the DJ mixers for the track. (*since Picard 0.9*)
The names of the DJ mixers for the track. (*since Picard 0.9*)

**engineer**

The names of the engineers associated with the track.
The names of the engineers associated with the track.

**language**

Work lyric language as per `ISO 639-3 <https://en.wikipedia.org/wiki/ISO_639-3>`_ if a related work exists. (*since Picard 0.10*)

**license**

The licenses associated with the track, either through the release or recording relationships. (*since Picard 1.0*)
The licenses associated with the track, either through the release or recording relationships. (*since Picard 1.0*)

**lyricist**

The names of the lyricists for the associated work.
The names of the lyricists for the associated work.

**mixer**

The names of the "Mixed By" engineers associated with the track. (*since Picard 0.9*)
The names of the "*Mixed By*" engineers associated with the track. (*since Picard 0.9*)

**performer:<type>**
**musicbrainz_workid**

The names of the performers for the specified type. These types include:
The MBID for the Work if a related work exists.

- vocals or instruments for the associated release or recording, where <type> can be "vocal", "guest guitar", "solo violin", etc.
**performer:<type>**

- the orchestra for the associated release or recording, where <type> is "orchestra"
The names of the performers for the specified type. These types include:

- the concert master for the associated release or recording, where <type> is "concertmaster"
- vocals or instruments for the associated release or recording, where <type> can be "*vocal*", "*guest guitar*", "*solo violin*", etc.

**producer**
- the orchestra for the associated release or recording, where <type> is "*orchestra*"

The names of the producers for the associated release or recording.
- the concert master for the associated release or recording, where <type> is "*concertmaster*"

**releasedate**
**producer**

Explicit tag for the release date (*since Picard 2.9*). This tag exists for specific use in scripts and plugins,
but is not filled by default. In most cases it is recommended to use the ``date`` tag instead for compatibility
with existing software.
The names of the producers for the associated release or recording.

**remixer**

The names of the remixer engineers associated with the track.
The names of the remixer engineers associated with the track.

**work**

The name of the work associated with the track. (*since Picard 1.3*)
The name of the work associated with the track. (*since Picard 1.3*)

**writer**

The names of the writers associated with the related work. (*since Picard 1.0*). This is not written to most file formats automatically.
You can merge this with composers with a script like:
A multi-value tag containing the names of the writers associated with the related work. (*since Picard 1.0*). This is not written to most file formats automatically. You can merge this with composers with a script like:

.. code-block:: taggerscript

$copymerge(composer, writer)

.. note::

.. code-block:: taggerscript
Some tags such as **performer** are available as both track and release level relationships, and the values may be different depending on which relationship options are enabled.

$copymerge(composer, writer)

.. _genre_settings:

Expand All @@ -114,4 +145,4 @@ If you enable "Use genres from MusicBrainz", you get:

**genre**

Genre information from MusicBrainz (*since Picard 2.1, earlier versions used folksonomy tags*)
A multi-value tag containing the specified genre information from MusicBrainz (*since Picard 2.1, earlier versions used folksonomy tags*)
Loading
Loading