From 82f0c59f46d6a0bd164313bc83540d2c4dcc442b Mon Sep 17 00:00:00 2001 From: MrNuggelz Date: Sun, 3 May 2020 13:10:24 +0200 Subject: [PATCH] review: updated subsonicplaylist.rst --- docs/plugins/subsonicplaylist.rst | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/plugins/subsonicplaylist.rst b/docs/plugins/subsonicplaylist.rst index c712a4823..b9a54c3de 100644 --- a/docs/plugins/subsonicplaylist.rst +++ b/docs/plugins/subsonicplaylist.rst @@ -2,11 +2,11 @@ Subsonic Playlist Plugin ======================== The ``subsonicplaylist`` plugin allows to import playlists from a subsonic server. -This is done by retrieving the track infos from the subsonic server, searching -them in the beets library and adding the playlist names to the +This is done by retrieving the track info from the subsonic server, searching +for them in the beets library, and adding the playlist names to the `subsonic_playlist` tag of the found items. The content of the tag has the format: - subsonic_playlist: ";first playlist;second playlist" + subsonic_playlist: ";first playlist;second playlist;" To get all items in a playlist use the query `;playlist name;`. @@ -15,12 +15,22 @@ Command Line Usage To use the ``subsonicplaylist`` plugin, enable it in your configuration (see :ref:`using-plugins`). Then use it by invoking the ``subsonicplaylist`` command. +Next, configure the plugin to connect to your Subsonic server, like this:: + + subsonicplaylist: + base_url: http://subsonic.example.com + username: someUser + password: somePassword + +After this you can import your playlists by invoking the `subsonicplaylist` command. + By default only the tags of the items found for playlists will be updated. This means that, if one imported a playlist, then delete one song from it and imported the playlist again, the deleted song will still have the playlist set in its `subsonic_playlist` tag. To solve this problem one can use the `-d/--delete` flag. This resets all `subsonic_playlist` tag before importing playlists. -Options to be defined in your config with their default value:: + +Here's an example configuration with all the available options and their default values:: subsonicplaylist: base_url: "https://your.subsonic.server"