Huge commit… Running last.fm track mode

[mpd-sima.git] / doc / examples / all_settings.cfg

diff --git a/doc/examples/all_settings.cfg b/doc/examples/all_settings.cfg
index 77abb7a89a4d8393fd11225bc359f6434e505dca..1d0fb6ff44fad4eec21790ab4bda43c8c052f602 100644 (file)
--- a/doc/examples/all_settings.cfg
+++ b/doc/examples/all_settings.cfg
@@ -57,13 +57,59 @@ verbosity = info
 #
 [placeholder]
 key = Value
-##
+
+[lastfm]
+
+depth = 3
+
+## QUEUE_MODE # NOT COMPLETED #
+# type: string
+# description: The default is to queue random tracks from similar artists.
+# Possible values:
+#      track : Will queue tracks from similar artists (default).
+#      top   : Will queue top tracks from similar artists. # NOT IMPLEMENTED #
+#      album : Will queue whole album from similar artists. # NOT IMPLEMENTED #
+queue_mode = track
+
+## SIMILARITY
+# type: integer in [0 100]
+# description: Similarity as a percentage of similarity between artists
+# (this is a last.fm metric)
+similarity = 15
+
+## DYNAMIC
+# type: integer
+# description: Number of similar artist to retrieve from local media library.
+#  When set to something superior to zero, MPD_sima tries to get as much similar
+#  artists from media library provided artists similarity is superior to
+#  similarity value.
+dynamic = 10
+
+## SINGLE_ALBUM # NOT IMPLEMENTED #
+# type: boolean
+# scope: "track" and "top" queue modes
+# description: Prevent from queueing a track from the same album (for instance with OST).
+single_album = true
+
+## TRACK_TO_ADD
+# type: integer
+# scope: "track" and "top" queue modes
+# description: how many tracks the plugin will try to get
+track_to_add = 1
+
+## ALBUM_TO_ADD
+# type: integer
+# scope: "album" queue mode
+# description: how many albums the plugin will try to get
+album_to_add = 1
+
 #
 #######################################################################
 
 
 ######################## SIMA CORE ####################################
 #
+# These settings deal with MPD_sima core behaviour.
 [sima]
 ## PLUGINS
 # type: comma separated string list
@@ -76,6 +122,7 @@ key = Value
 # "AwesomePlugin" declared here gets its configuration from the
 # "[AwesomePlugin]" or "[awesomeplugin]" section (case insensitive).
 #
+#internals = 
 plugins = PlaceHolder
 
 ## HISTORY_DURATION
@@ -88,62 +135,18 @@ history_duration = 8
 
 ## CONSUME
 # type: integer
-#
-# How many played tracks to keep in the playlist.
-# Allow to maintain a fixed length playlist.
-# set to 0 to keep all played tracks.
+# description: How many played tracks to keep in the playlist.
+#  Allow to maintain a fixed length playlist.
+#  set to 0 to keep all played tracks.
 #
 consume = 0
 ##
 
-## SINGLE_ALBUM
-# type: boolean
-# scope: "track" and "top" queue modes
-#
-# Prevent from queueing a track from the same album (for instance with OST).
-single_album = false
-##
-
-
-# These settings deal with MPD_sima core behaviour.
-
-## Queue Mode
-##
-# The default is to queue random tracks from similar artists.
-#
-## QUEUE_MODE
-# type: string
-#
-# Possible values:
-#      track : Will queue tracks from similar artists (default).
-#      top   : Will queue top tracks from similar artists.
-#      album : Will queue whole album from similar artists.
-queue_mode = track
-
-## SIMILARITY
-# type: integer in [0 100]
-#
-# Similarity as a percentage of similarity for the artist the code is
-# looking for.
-similarity = 15
-##
-
-## DYNAMIC
-# type: integer
-#
-# Number of similar artist to retrieve from local media library.
-# When set to something superior to zero, MPD_sima tries to get as much similar
-# artists from media library provided artists similarity is superior to
-# similarity value.
-dynamic = 10
-##
-
-## USER_DB
+## USER_DB # NOT IMPLEMENTED #
 # type: boolean
-#
-# Load user database to find similar artists
-# User DB is loaded from $XDG_CONFIG_HOME/mpd_sima/sima.db
-# Use simadb_cli to edit/add entries.
+# description: Load user database to find similar artists
+#  User DB is loaded from $XDG_CONFIG_HOME/sima/sima.db
+#  Use simadb_cli to edit/add entries.
 user_db = false
 ##
 
@@ -159,21 +162,6 @@ user_db = false
 queue_length = 1
 ##
 
-## TRACK_TO_ADD
-# type: integer
-# scope: "track" and "top" queue modes
-#
-# Missing Description…
-track_to_add = 1
-##
-
-## ALBUM_TO_ADD
-# type: integer
-# scope: "album" queue mode
-#
-# Missing Description…
-album_to_add = 1
-##
 #
 ####################### END OF CONFIGURATION ##########################