diff --git a/docs/plugins/beatport.rst b/docs/plugins/beatport.rst index 539c80ffb..b10ee8c59 100644 --- a/docs/plugins/beatport.rst +++ b/docs/plugins/beatport.rst @@ -18,7 +18,7 @@ both MusicBrainz and (to a lesser degree) Discogs show no matches. Installation ------------ -To use the plugin, first enable it in your configuration (see +To use the ``beatport`` plugin, first enable it in your configuration (see :ref:`using-plugins`). Then, install the `requests`_ library (which we need for querying the Beatport API) by typing:: diff --git a/docs/plugins/bpd.rst b/docs/plugins/bpd.rst index 846d4638e..2af13152f 100644 --- a/docs/plugins/bpd.rst +++ b/docs/plugins/bpd.rst @@ -41,7 +41,7 @@ installing GStreamer plugins. Usage ----- -To use the plugin, first enable it in your configuration (see +To use the ``bpd`` plugin, first enable it in your configuration (see :ref:`using-plugins`). Then, you can run BPD by invoking:: diff --git a/docs/plugins/bpm.rst b/docs/plugins/bpm.rst index 4494106dd..ce1f62298 100644 --- a/docs/plugins/bpm.rst +++ b/docs/plugins/bpm.rst @@ -7,7 +7,7 @@ tapping out the beat on your keyboard. Usage ----- -To use the plugin, first enable it in your configuration (see +To use the ``bpm`` plugin, first enable it in your configuration (see :ref:`using-plugins`). Then, play a song you want to measure in your favorite media player and type:: diff --git a/docs/plugins/bucket.rst b/docs/plugins/bucket.rst index 43ffeec55..9992661e4 100644 --- a/docs/plugins/bucket.rst +++ b/docs/plugins/bucket.rst @@ -7,7 +7,7 @@ The ``bucket`` plugin groups your files into buckets folders representing smaller subfolders by grouping albums or artists alphabetically (e.g. *A-F*, *G-M*, *N-Z*). -To use the plugin, first enable it in your configuration (see +To use the ``bucket`` plugin, first enable it in your configuration (see :ref:`using-plugins`). The plugin provides a :ref:`template function ` called ``%bucket`` for use in path format expressions:: diff --git a/docs/plugins/chroma.rst b/docs/plugins/chroma.rst index 4603ee3de..3640e642b 100644 --- a/docs/plugins/chroma.rst +++ b/docs/plugins/chroma.rst @@ -90,9 +90,9 @@ standard set of Gstreamer plugins. For example, on Ubuntu, install the packages Usage ----- -Once you have all the dependencies sorted out, enable the plugin in your -configuration (see :ref:`using-plugins`) to benefit from fingerprinting the -next time you run ``beet import``. +Once you have all the dependencies sorted out, enable the ``chroma`` plugin in +your configuration (see :ref:`using-plugins`) to benefit from fingerprinting +the next time you run ``beet import``. You can also use the ``beet fingerprint`` command to generate fingerprints for items already in your library. (Provide a query to fingerprint a subset of your diff --git a/docs/plugins/convert.rst b/docs/plugins/convert.rst index ee99e15a6..7b3a0c9fb 100644 --- a/docs/plugins/convert.rst +++ b/docs/plugins/convert.rst @@ -10,7 +10,7 @@ line. Installation ------------ -To use the plugin, first enable it in your configuration (see +To use the ``chroma`` plugin, first enable it in your configuration (see :ref:`using-plugins`). By default, the plugin depends on `FFmpeg`_ to transcode the audio, so you might want to install it. diff --git a/docs/plugins/discogs.rst b/docs/plugins/discogs.rst index 912aea7be..35fcaf455 100644 --- a/docs/plugins/discogs.rst +++ b/docs/plugins/discogs.rst @@ -9,7 +9,7 @@ include matches from the `Discogs`_ database. Installation ------------ -To use the plugin, first enable it in your configuration (see +To use the ``discogs`` plugin, first enable it in your configuration (see :ref:`using-plugins`). Then, install the `discogs-client`_ library by typing:: pip install discogs-client diff --git a/docs/plugins/duplicates.rst b/docs/plugins/duplicates.rst index eca009b5d..b5f0e32a0 100644 --- a/docs/plugins/duplicates.rst +++ b/docs/plugins/duplicates.rst @@ -7,7 +7,7 @@ and lists duplicate tracks or albums in your collection. Usage ----- -To use the plugin, first enable it in your configuration (see +To use the ``duplicates`` plugin, first enable it in your configuration (see :ref:`using-plugins`). By default, the ``beet duplicates`` command lists the names of tracks diff --git a/docs/plugins/echonest.rst b/docs/plugins/echonest.rst index e5e033778..e154a8816 100644 --- a/docs/plugins/echonest.rst +++ b/docs/plugins/echonest.rst @@ -41,7 +41,7 @@ algorithms supported by the Echo Nest. Please note that fingerprinting is not required if ``upload`` and ``convert`` is enabled, which is the default (but it can be faster than uploading). -Finally, to use the plugin, enable it in your configuration (see +Finally, enable the ``echonest`` plugin in your configuration (see :ref:`using-plugins`). .. _pip: http://pip.openplans.org/ diff --git a/docs/plugins/echonest_tempo.rst b/docs/plugins/echonest_tempo.rst deleted file mode 100644 index 99ffc3873..000000000 --- a/docs/plugins/echonest_tempo.rst +++ /dev/null @@ -1,67 +0,0 @@ -Echo Nest Tempo Plugin -====================== - -.. note:: - - A newer :doc:`echonest` is available that supersedes this plugin. In - addition to the tempo, the new plugin can fetch the Echo Nest's full - complement of acoustic attributes. This older tempo-specific plugin is - **deprecated**. - -The ``echonest_tempo`` plugin fetches and stores a track's tempo (the "bpm" -field) from the `Echo Nest API`_. - -.. _Echo Nest API: http://developer.echonest.com/ - -Installing Dependencies ------------------------ - -This plugin requires the pyechonest library in order to talk to the EchoNest -API. - -There are packages for most major linux distributions, you can download the -library from the Echo Nest, or you can install the library from `pip`_, -like so:: - - $ pip install pyechonest - -.. _pip: http://pip.openplans.org/ - -Configuration -------------- - -Available options: - -- ``auto``: set to ``no``to disable automatic tempo fetching during import. - Default: ``true``. -- ``apikey``: set this option to specify your own EchoNest API key. - You can `apply for your own`_ for free from the EchoNest. - Default: beets includes its own Echo Nest API key. - -.. _apply for your own: http://developer.echonest.com/account/register - -Fetch Tempo During Import -------------------------- - -To automatically fetch the tempo for songs you import, just enable the plugin -by putting ``echonest_tempo`` on your config file's ``plugins`` line (see -:doc:`/plugins/index`). When importing new files, beets will now fetch the -tempo for files that don't already have them. The bpm field will be stored in -the beets database. If the ``import.write`` config option is on, then the tempo -will also be written to the files' tags. - -This behavior can be disabled with the ``autofetch`` config option (see below). - -Fetching Tempo Manually ------------------------ - -The ``tempo`` command provided by this plugin fetches tempos for -items that match a query (see :doc:`/reference/query`). For example, -``beet tempo magnetic fields absolutely cuckoo`` will get the tempo for the -appropriate Magnetic Fields song, ``beet tempo magnetic fields`` will get -tempos for all my tracks by that band, and ``beet tempo`` will get tempos for -my entire library. The tempos will be added to the beets database and, if -``import.write`` is on, embedded into files' metadata. - -The ``-p`` option to the ``tempo`` command makes it print tempos out to the -console so you can view the fetched (or previously-stored) tempos. diff --git a/docs/plugins/embedart.rst b/docs/plugins/embedart.rst index e03a5f929..963c8f4cd 100644 --- a/docs/plugins/embedart.rst +++ b/docs/plugins/embedart.rst @@ -11,7 +11,7 @@ Usage ----- To automatically embed discovered album art into imported files, just enable -the plugin (see :doc:`/plugins/index`). You'll also want to enable the +the ``embedart`` plugin (see :doc:`/plugins/index`). You'll also want to enable the :doc:`/plugins/fetchart` to obtain the images to be embedded. Art will be embedded after each album is added to the library. diff --git a/docs/plugins/fetchart.rst b/docs/plugins/fetchart.rst index e217c804b..8733a21d9 100644 --- a/docs/plugins/fetchart.rst +++ b/docs/plugins/fetchart.rst @@ -4,7 +4,7 @@ FetchArt Plugin The ``fetchart`` plugin retrieves album art images from various sources on the Web and stores them as image files. -To use the plugin, first enable it in your configuration (see +To use the ``fetchart`` plugin, first enable it in your configuration (see :ref:`using-plugins`). Then, install the `requests`_ library by typing:: pip install requests diff --git a/docs/plugins/fromfilename.rst b/docs/plugins/fromfilename.rst index 634b49f98..5cb6ccb76 100644 --- a/docs/plugins/fromfilename.rst +++ b/docs/plugins/fromfilename.rst @@ -9,4 +9,5 @@ When you attempt to import a track that's missing a title, this plugin will look at the track's filename and guess its track number, title, and artist. These will be used to search in MusicBrainz and match track ordering. -To use the plugin, enable it in your configuration (see :ref:`using-plugins`). +To use the ``fromfilename`` plugin, enable it in your configuration +(see :ref:`using-plugins`). diff --git a/docs/plugins/ftintitle.rst b/docs/plugins/ftintitle.rst index 4ba4224d9..51b7772f7 100644 --- a/docs/plugins/ftintitle.rst +++ b/docs/plugins/ftintitle.rst @@ -10,7 +10,8 @@ tracks in your library like "Tellin' Me Things" by the artist "Blakroc feat. RZA". If you prefer to tag this as "Tellin' Me Things feat. RZA" by "Blakroc", then this plugin is for you. -To use the plugin, enable it in your configuration (see :ref:`using-plugins`). +To use the ``ftintitle`` plugin, enable it in your configuration +(see :ref:`using-plugins`). Configuration ------------- diff --git a/docs/plugins/fuzzy.rst b/docs/plugins/fuzzy.rst index 4f5524efd..64a086ed4 100644 --- a/docs/plugins/fuzzy.rst +++ b/docs/plugins/fuzzy.rst @@ -14,7 +14,7 @@ You'll then be able to use the ``~`` prefix to use fuzzy matching:: Configuration ------------- -Available options : +Available options: - ``threshold``: a value of 1.0 will show only perfect matches and a value of 0.0 will match everything. diff --git a/docs/plugins/ihate.rst b/docs/plugins/ihate.rst index 8c7631725..82203cf6e 100644 --- a/docs/plugins/ihate.rst +++ b/docs/plugins/ihate.rst @@ -6,7 +6,7 @@ import or warn you about them. You specify queries (see :doc:`/reference/query`) and the plugin skips (or warns about) albums or items that match any query. -To use the plugin, enable it in your configuration (see +To use the ``ihate`` plugin, enable it in your configuration (see :ref:`using-plugins`). Configuration diff --git a/docs/plugins/importadded.rst b/docs/plugins/importadded.rst index 6530e587a..8924aad2c 100644 --- a/docs/plugins/importadded.rst +++ b/docs/plugins/importadded.rst @@ -1,7 +1,7 @@ ImportAdded Plugin ================== -The ``importadded`` plugin is useful when an existing collection is imported +This plugin is useful when an existing collection is imported and the time when albums and items were added should be preserved. The :abbr:`mtime (modification time)` of files that are imported into the diff --git a/docs/plugins/importfeeds.rst b/docs/plugins/importfeeds.rst index f0930aee5..8f0180f20 100644 --- a/docs/plugins/importfeeds.rst +++ b/docs/plugins/importfeeds.rst @@ -4,7 +4,8 @@ ImportFeeds Plugin The ``importfeeds`` plugin helps you keep track of newly imported music in your library. -To use the plugin, enable it in your configuration (see :ref:`using-plugins`). +To use the ``importfeeds`` plugin, enable it in your configuration +(see :ref:`using-plugins`). Configuration ------------- diff --git a/docs/plugins/info.rst b/docs/plugins/info.rst index 676102688..944f17c55 100644 --- a/docs/plugins/info.rst +++ b/docs/plugins/info.rst @@ -5,8 +5,8 @@ The ``info`` plugin provides a command that dumps the current tag values for any file format supported by beets. It works like a supercharged version of `mp3info`_ or `id3v2`_. -Enable the plugin in your configuration (see :ref:`using-plugins`) and then - type:: +Enable the ``info`` plugin in your configuration (see :ref:`using-plugins`) and +then type:: $ beet info /path/to/music.flac diff --git a/docs/plugins/inline.rst b/docs/plugins/inline.rst index 99fad299a..ebe298ae7 100644 --- a/docs/plugins/inline.rst +++ b/docs/plugins/inline.rst @@ -6,7 +6,8 @@ it, you can define template fields in your beets configuration file and refer to them from your template strings in the ``paths:`` section (see :doc:`/reference/config/`). -To use the plugin, enable it in your configuration (see :ref:`using-plugins`). +To use the `ìnline`` plugin, enable it in your configuration +(see :ref:`using-plugins`). Then, make a `item_fields:`` block in your config file. Under this key, every line defines a new template field; the key is the name of the field (you'll use the name to refer to the field in your templates) and the value is a Python expression or diff --git a/docs/plugins/keyfinder.rst b/docs/plugins/keyfinder.rst index 15d35a4ed..71fea1770 100644 --- a/docs/plugins/keyfinder.rst +++ b/docs/plugins/keyfinder.rst @@ -7,7 +7,7 @@ musical key of track from its audio data and store it in the automatically when importing music or through the ``beet keyfinder [QUERY]`` command. -To use the plugin, enable it in your configuration (see +To use the ``keyfinder`` plugin, enable it in your configuration (see :ref:`using-plugins`). Configuration diff --git a/docs/plugins/lastgenre.rst b/docs/plugins/lastgenre.rst index 069de9efa..d998d19ab 100644 --- a/docs/plugins/lastgenre.rst +++ b/docs/plugins/lastgenre.rst @@ -17,8 +17,8 @@ The plugin requires `pylast`_, which you can install using `pip`_ by typing:: pip install pylast -After you have pylast installed, nable the plugin in your configuration (see -:ref:`using-plugins`). +After you have pylast installed, enable the ``lastgenre`` plugin in your +configuration (see :ref:`using-plugins`). Usage ----- diff --git a/docs/plugins/lyrics.rst b/docs/plugins/lyrics.rst index ec0ac56d7..a2f2996ba 100644 --- a/docs/plugins/lyrics.rst +++ b/docs/plugins/lyrics.rst @@ -12,8 +12,8 @@ and, optionally, the Google custom search API. Fetch Lyrics During Import -------------------------- -To automatically fetch lyrics for songs you import, enable the plugin in your -configuration (see :ref:`using-plugins`). +To automatically fetch lyrics for songs you import, enable the ``lyrics`` +plugin in your configuration (see :ref:`using-plugins`). When importing new files, beets will now fetch lyrics for files that don't already have them. The lyrics will be stored in the beets database. If the ``import.write`` config option is on, then the lyrics will also be written to diff --git a/docs/plugins/mbsync.rst b/docs/plugins/mbsync.rst index 5497d93f0..633725b69 100644 --- a/docs/plugins/mbsync.rst +++ b/docs/plugins/mbsync.rst @@ -15,8 +15,8 @@ configuration. Usage ----- -Enable the plugin in your configuration (see :ref:`using-plugins`) and then -run ``beet mbsync QUERY`` to fetch updated metadata for a part of your +Enable the ``mbsync`` plugin in your configuration (see :ref:`using-plugins`) +and then run ``beet mbsync QUERY`` to fetch updated metadata for a part of your collection (or omit the query to run over your whole library). This plugin treats albums and singletons (non-album tracks) separately. It diff --git a/docs/plugins/missing.rst b/docs/plugins/missing.rst index 7cac8cbd6..5062f298f 100644 --- a/docs/plugins/missing.rst +++ b/docs/plugins/missing.rst @@ -27,7 +27,7 @@ tracks over your whole library, using command-line switches :: Configuration ------------- -Available options : +Available options: - ``count`` prints a count of missing tracks per album, with ``format`` defaulting to ``$albumartist - $album: $missing``. diff --git a/docs/plugins/mpdstats.rst b/docs/plugins/mpdstats.rst index 3e2d7f207..d0ccc363a 100644 --- a/docs/plugins/mpdstats.rst +++ b/docs/plugins/mpdstats.rst @@ -35,7 +35,7 @@ Use the ``mpdstats`` command to fire it up:: Configuration ------------- -Available options : +Available options: - ``host``: mpd server name. Default: ``localhost``. diff --git a/docs/plugins/mpdupdate.rst b/docs/plugins/mpdupdate.rst index f16d5ffdd..92ca25794 100644 --- a/docs/plugins/mpdupdate.rst +++ b/docs/plugins/mpdupdate.rst @@ -6,7 +6,8 @@ update `MPD`_'s index whenever you change your beets library. .. _MPD: http://www.musicpd.org/ -To use it, enable it in your configuration (see :ref:`using-plugins`). +To use ``mpdupdate`` plugin, enable it in your configuration +(see :ref:`using-plugins`). Then, you'll probably want to configure the specifics of your MPD server. You can do that using an ``mpd:`` section in your ``config.yaml``, which looks like this:: @@ -16,7 +17,8 @@ which looks like this:: port: 6600 password: seekrit -With that all in place, you'll see beets send the "update" command to your MPD server every time you change your beets library. +With that all in place, you'll see beets send the "update" command to your MPD +server every time you change your beets library. If you want to communicate with MPD over a Unix domain socket instead over TCP, just give the path to the socket in the filesystem for the ``host`` diff --git a/docs/plugins/play.rst b/docs/plugins/play.rst index 26182e18f..595c7db0d 100644 --- a/docs/plugins/play.rst +++ b/docs/plugins/play.rst @@ -7,7 +7,7 @@ player in the form of an m3u playlist. Usage ----- -To use the plugin, enable it in your configuration (see +To use the ``play`` plugin, enable it in your configuration (see :ref:`using-plugins`). Then use it by invoking the ``beet play`` command with a query. The command will create a temporary m3u file and open it using an appropriate application. You can query albums instead of tracks using the diff --git a/docs/plugins/replaygain.rst b/docs/plugins/replaygain.rst index 0ddfed2ae..65bf31b74 100644 --- a/docs/plugins/replaygain.rst +++ b/docs/plugins/replaygain.rst @@ -28,8 +28,8 @@ You will need at least GStreamer 1.0 and `PyGObject 3.x`_ (a.k.a. python-gi). .. _PyGObject 3.x: https://wiki.gnome.org/action/show/Projects/PyGObject .. _GStreamer: http://gstreamer.freedesktop.org/ -Then, enable the plugin (see :ref:`using-plugins`) and specify the GStreamer -backend by adding this to your configuration file:: +Then, enable the ``replaygain`` plugin (see :ref:`using-plugins`) and specify +the GStreamer backend by adding this to your configuration file:: replaygain: backend: gstreamer diff --git a/docs/plugins/rewrite.rst b/docs/plugins/rewrite.rst index 995783d55..3706d940a 100644 --- a/docs/plugins/rewrite.rst +++ b/docs/plugins/rewrite.rst @@ -6,7 +6,8 @@ path formats. Specifically, it is intended to let you *canonicalize* names such as artists: for example, perhaps you want albums from The Jimi Hendrix Experience to be sorted into the same folder as solo Hendrix albums. -To use field rewriting, first enable the plugin (see :ref:`using-plugins`). +To use field rewriting, first enable the ``rewrite`` plugin +(see :ref:`using-plugins`). Then, make a ``rewrite:`` section in your config file to contain your rewrite rules. Each rule consists of a field name, a regular expression pattern, and a replacement value. Rules are written ``fieldname regex: replacement``. diff --git a/docs/plugins/scrub.rst b/docs/plugins/scrub.rst index becb21d06..4760df9d8 100644 --- a/docs/plugins/scrub.rst +++ b/docs/plugins/scrub.rst @@ -11,7 +11,7 @@ Automatic Scrubbing ------------------- To automatically remove files' tags before writing new ones, just -enable the plugin (see :ref:`using-plugins`). When importing new files (with +enable the ``scrub`` plugin (see :ref:`using-plugins`). When importing new files (with ``import.write`` turned on) or modifying files' tags with the ``beet modify`` command, beets will first strip all types of tags entirely and then write the database-tracked metadata to the file. diff --git a/docs/plugins/smartplaylist.rst b/docs/plugins/smartplaylist.rst index 789b7c051..8dfce724e 100644 --- a/docs/plugins/smartplaylist.rst +++ b/docs/plugins/smartplaylist.rst @@ -7,7 +7,8 @@ created to work well with `MPD's`_ playlist functionality. .. _MPD's: http://www.musicpd.org/ -To use it, enable the plugin in your configuration (see :ref:`using-plugins`). +To use it, enable the ``smartplaylist`` plugin in your configuration +(see :ref:`using-plugins`). Then configure your smart playlists like the following example:: smartplaylist: diff --git a/docs/plugins/spotify.rst b/docs/plugins/spotify.rst index 14ef72c8a..42370e855 100644 --- a/docs/plugins/spotify.rst +++ b/docs/plugins/spotify.rst @@ -16,8 +16,8 @@ Why Use This Plugin? Basic Usage ----------- -First, enable the plugin (see :ref:`using-plugins`). Then, use the ``spotify`` -command with a beets query:: +First, enable the ``spotify`` plugin (see :ref:`using-plugins`). +Then, use the ``spotify`` command with a beets query:: beet spotify [OPTIONS...] QUERY diff --git a/docs/plugins/the.rst b/docs/plugins/the.rst index 493e79493..dd16c7c7a 100644 --- a/docs/plugins/the.rst +++ b/docs/plugins/the.rst @@ -11,8 +11,8 @@ regexp patterns can be added by user. How it works:: A Band -> Band, A An Orchestra -> Orchestra, An -Enable the plugin (see :doc:`/plugins/index`) and then make use of a template -function called ``%the`` for use in path format expressions:: +Enable the ``the`` plugin (see :doc:`/plugins/index`) and then make use of a +template function called ``%the`` for use in path format expressions:: paths: default: %the{$albumartist}/($year) $album/$track $title diff --git a/docs/plugins/types.rst b/docs/plugins/types.rst index 978654e8d..94d56e288 100644 --- a/docs/plugins/types.rst +++ b/docs/plugins/types.rst @@ -6,8 +6,8 @@ library. For example, you can declare that a ``rating`` field is numeric so that you can query it with ranges---which isn't possible when the field is considered a string (the default). -Enable the plugin as described in :doc:`/plugins/index` and then add a -``types`` section to your :doc:`configuration file `. The +Enable the ``types`` plugin as described in :doc:`/plugins/index` and then add +a ``types`` section to your :doc:`configuration file `. The configuration section should map field name to one of ``int``, ``float``, ``bool``, or ``date``. diff --git a/docs/plugins/web.rst b/docs/plugins/web.rst index 59a153dc2..be8e158f7 100644 --- a/docs/plugins/web.rst +++ b/docs/plugins/web.rst @@ -20,7 +20,8 @@ flask``. .. _Flask: http://flask.pocoo.org/ -Finally, enable the plugin in your configuration (see :ref:`using-plugins`). +Finally, enable the ``web`` plugin in your configuration +(see :ref:`using-plugins`). Run the Server -------------- diff --git a/docs/plugins/zero.rst b/docs/plugins/zero.rst index 81eaacedb..781f95b31 100644 --- a/docs/plugins/zero.rst +++ b/docs/plugins/zero.rst @@ -6,7 +6,8 @@ can be nulled unconditionally or conditioned on a pattern match. For example, the plugin can strip useless comments like "ripped by MyGreatRipper." This plugin only affects files' tags ; the beets database is left unchanged. -To use the plugin, enable the plugin in your configuration (see :ref:`using-plugins`). +To use the ``zero`` plugin, enable the plugin in your configuration +(see :ref:`using-plugins`). Configuration -------------