diff --git a/docs/plugins/bucket.rst b/docs/plugins/bucket.rst index 173d3d147..c4f05d2fe 100644 --- a/docs/plugins/bucket.rst +++ b/docs/plugins/bucket.rst @@ -6,6 +6,7 @@ by grouping your files into buckets folders representing ranges. This kind of files organization is usually used to classify your music by periods (eg *1960s*, *1970s* etc), or to divide bloated folders into smaller subfolders by grouping albums/artists alphabetically (eg *A-F*, *G-M*, *N-Z*). + To use this plugin, enable it by including ``bucket`` into ``plugins`` line of your beets config. The plugin provides a template function called ``%bucket`` for use in path format expressions:: @@ -14,7 +15,7 @@ use in path format expressions:: default: /%bucket($year)/%bucket($artist)/$albumartist-$album-$year You must then define what ranges representations you allow in the ``bucket:`` -section of the config file : +section of the config file:: bucket: bucket_alpha: ['A-F', 'G-M', 'N-Z'] @@ -28,10 +29,10 @@ The definition of a range is somewhat loose, and multiple formats are allowed : - for alpha ranges: the range is defined by the lowest and highest (ascii-wise) alphanumeric characters. eg *'ABCD'*, *'A-D'*, *'A->D'*, *[AD]* are equivalent. - for year ranges: digits characters are extracted and the two extremes years define the range. eg *'1975-77'*, *'1975,76,77'* and *'1975-1977'* are equivalent. If no upper bound is given, the range is extended to current year (unless a later range is defined). eg *'1975'* encompasses all years from 1975 until now. -If you want to group your files into many small year ranges, you don't have to +If you want to group your files into multiple year ranges, you don't have to enumerate them all in `bucket_year` parameter but can activate the ``extrapolate`` option instead. This option will generate year bucket names by reproducing characteristics -of declared buckets. +of declared buckets:: bucket: bucket_year: ['2000-05']