Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2026-01-03 22:42:44 +01:00
Code Issues Projects Releases Wiki Activity

Improve albumtypes plugin documentation

Browse source
This commit is contained in:
Edgars Supe 2021-09-10 09:51:56 +03:00
parent 131befa132
commit c5764df989
1 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/plugins/albumtypes.rst
View file

@ -2,14 +2,14 @@ AlbumTypes Plugin
=================
The ``albumtypes`` plugin adds the ability to format and output album types,
such as "Album", "EP", "Single", etc. List of available type can be found
`here`_.
such as "Album", "EP", "Single", etc. For the list of available album types,
see the `MusicBrainz documentation`_.
To use the ``albumtypes`` plugin, enable it in your configuration
(see :ref:`using-plugins`). Then, add ``$atypes`` to your path formats as
desired.
(see :ref:`using-plugins`). The plugin defines a new field ``$atypes``, which
you can use in your path formats or elsewhere.
.. _here: https://musicbrainz.org/doc/Release_Group/Type
.. _MusicBrainz documentation: https://musicbrainz.org/doc/Release_Group/Type
Configuration
-------------
@ -48,10 +48,9 @@ Example config::
albumtype:soundtrack Various Artists/$album ($year)$atypes)/...
comp: Various Artists/$album ($year)$atypes/...
Example outputs::
This configuration generates paths that look like this, for example::
Aphex Twin/(1993)(EP)(Remix) On Remixes
Pink Flow/(1995)(Live) p·u·l·s·e
Various Artists/20th Century Lullabies (1999)
Various Artists/Ocean's Eleven (2001)(OST)