From bfb94363c35ce65705bcd4a0c595c7825fab794e Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Sat, 8 Jun 2019 21:37:24 -0400 Subject: [PATCH] Changelog & doc tweaks for #3279 --- docs/changelog.rst | 4 +++ docs/plugins/parentwork.rst | 54 ++++++++++++++++++------------------- 2 files changed, 31 insertions(+), 27 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 06c662be6..e21168078 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -22,6 +22,10 @@ New features: level. Thanks to :user:`samuelnilsson` :bug:`293` +* A new :doc:`/plugins/parentwork` gets information about the original work, + which is useful for classical music. + Thanks to :user:`dosoe`. + :bug:`2580` :bug:`3279` Fixes: diff --git a/docs/plugins/parentwork.rst b/docs/plugins/parentwork.rst index a221e19b5..cb9d7e6f6 100644 --- a/docs/plugins/parentwork.rst +++ b/docs/plugins/parentwork.rst @@ -1,30 +1,30 @@ -Parentwork Plugin +ParentWork Plugin ================= -The ``parentwork`` plugin fetches the work title, parent work title and +The ``parentwork`` plugin fetches the work title, parent work title and parent work composer from MusicBrainz. -In the MusicBrainz database, a recording can be associated with a work. A -work can itself be associated with another work, for example one being part -of the other (what we call the *direct parent*). This plugin looks the work id -from the library and then looks up the direct parent, then the direct parent -of the direct parent and so on until it reaches the top. The work at the top -is what we call the *parent work*. This plugin is especially designed for -classical music. For classical music, just fetching the work title as in -MusicBrainz is not satisfying, because MusicBrainz has separate works for, for -example, all the movements of a symphony. This plugin aims to solve this -problem by not only fetching the work itself from MusicBrainz but also its -parent work which would be, in this case, the whole symphony. +In the MusicBrainz database, a recording can be associated with a work. A +work can itself be associated with another work, for example one being part +of the other (what we call the *direct parent*). This plugin looks the work id +from the library and then looks up the direct parent, then the direct parent +of the direct parent and so on until it reaches the top. The work at the top +is what we call the *parent work*. This plugin is especially designed for +classical music. For classical music, just fetching the work title as in +MusicBrainz is not satisfying, because MusicBrainz has separate works for, for +example, all the movements of a symphony. This plugin aims to solve this +problem by not only fetching the work itself from MusicBrainz but also its +parent work which would be, in this case, the whole symphony. -This plugin adds five tags: +This plugin adds five tags: -- **parentwork**: The title of the parent work. -- **mb_parentworkid**: The musicbrainz id of the parent work. -- **parentwork_disambig**: The disambiguation of the parent work title. -- **parent_composer**: The composer of the parent work. -- **parent_composer_sort**: The sort name of the parent work composer. -- **work_date**: The composition date of the work, or the first parent work - that has a composition date. Format: yyyy-mm-dd. +- **parentwork**: The title of the parent work. +- **mb_parentworkid**: The musicbrainz id of the parent work. +- **parentwork_disambig**: The disambiguation of the parent work title. +- **parent_composer**: The composer of the parent work. +- **parent_composer_sort**: The sort name of the parent work composer. +- **work_date**: The composition date of the work, or the first parent work + that has a composition date. Format: yyyy-mm-dd. To use the ``parentwork`` plugin, enable it in your configuration (see :ref:`using-plugins`). @@ -35,11 +35,11 @@ Configuration To configure the plugin, make a ``parentwork:`` section in your configuration file. The available options are: -- **force**: As a default, ``parentwork`` only fetches work info for - recordings that do not already have a ``parentwork`` tag. If ``force`` - is enabled, it fetches it for all recordings. +- **force**: As a default, ``parentwork`` only fetches work info for + recordings that do not already have a ``parentwork`` tag. If ``force`` + is enabled, it fetches it for all recordings. Default: ``no`` - -- **auto**: If enabled, automatically fetches works at import. It takes quite - some time, because beets is restricted to one musicbrainz query per second. + +- **auto**: If enabled, automatically fetches works at import. It takes quite + some time, because beets is restricted to one musicbrainz query per second. Default: ``no``