Commit graph

127 commits

Author SHA1 Message Date
Adrian Sampson
8ddf04e711 refine config location discussion (#513) 2014-02-21 21:22:55 -05:00
Adrian Sampson
622ca2b244 Unixy location is fallback on OS X
This is mainly for backwards compatibility. It's also an effort to reduce the
support burden; this way, I can say "your config directory is ~/.config/beets"
without needing to ascertain whether someone is on a Mac.
2014-02-21 20:57:06 -05:00
Thomas Scholtes
d0e5b411cf Documentation for configuration location 2014-02-18 18:24:49 +01:00
Adrian Sampson
5d55312fdb add TOCs to some documentation 2014-02-16 19:25:26 -08:00
Adrian Sampson
276a09bad7 clean up --config handling
In reference to a363d9672f. This helps preserve
modularity/readability by avoiding contamination of the subcommand logic with
beets-specific logic.
2014-02-13 13:46:20 -08:00
Thomas Scholtes
ba226f566d Update docs for fix a363d967 2014-02-10 17:29:23 +01:00
Adrian Sampson
5e2f7d6fcc remove some anachronisms from the docs 2014-02-07 19:55:07 -08:00
Adrian Sampson
802c4560d4 changelog/docs for #521, fix #402 2014-02-05 20:44:43 -08:00
Stig Inge Lea Bjørnsen
58924375d3 Merge pull request #521 from silb/datequery_plugin
Add a plugin for querying date fields against date intervals or instants...
2014-02-04 13:03:39 -08:00
Stig Inge Lea Bjørnsen
732daddf53 Move the date query documentation into the query reference documentation. 2014-02-04 21:48:33 +01:00
Adrian Sampson
aaeb166608 a bit more documentation for --config 2014-02-02 13:48:21 -08:00
Adrian Sampson
8b87fff3e3 a bit more documentation for --group-albums (#518) 2014-02-01 12:52:16 -08:00
Thomas Scholtes
d75f6667e1 Add --config cli option 2014-01-29 23:38:05 +01:00
Thomas Scholtes
a4b6976755 Make plugin path configuration useable 2014-01-20 17:39:46 +01:00
Adrian Sampson
f239489549 docs: remove outdated path_format config option
The example config contained a configuration key that's been unsupported for
years! How embarrassing.
2014-01-10 19:12:45 -08:00
Adrian Sampson
f98dde1b7e docs/changelog for write (#328, #448) 2013-11-25 15:34:11 -08:00
Adrian Sampson
c0c01b2680 id3v23 config option (fix #388) 2013-10-06 20:20:18 -07:00
Adrian Sampson
ddf5c4ce54 integrate FAQ links with the rest of the docs 2013-09-16 19:26:09 -07:00
Adrian Sampson
4f1ce5a64c docs: mention musicbrainz port config (closes #365) 2013-09-12 11:11:04 -07:00
Adrian Sampson
bb191e7ced Merge pull request #354 from mineo/docs-fixup-2
Docs fixup
2013-08-06 09:46:14 -07:00
Wieland Hoffmann
39d67363b5 ref/cli.rst: Remove a 'd' 2013-08-06 10:40:17 +02:00
Wieland Hoffmann
e0ea009508 ref/cli.rst: Add a missing 'k' 2013-08-06 10:40:17 +02:00
Wieland Hoffmann
0082570e11 pathformat.rst: Add back "track"
This got lost in e0bb3b5cd0 but is really essential enough to appear in that list.
2013-08-03 15:13:29 +02:00
Wieland Hoffmann
cc3d12f218 docs/.../cli.rst: Add an of to the description of update -p
This seems to have been missed when the documentation was added in the first place.
2013-07-12 19:11:47 +02:00
Adrian Sampson
58bd8a9e24 docs: a note about albums and the update command 2013-06-15 22:49:14 -07:00
Adrian Sampson
b1ea90a724 don't duplicate penalty names in max_rec section
This is for maintanability: in the future, when we add new distance penalty
components, now we won't have to list them twice in the default config.
2013-06-10 15:59:41 -07:00
Adrian Sampson
82991ce614 documentation enhancements for new config opts 2013-06-10 15:53:06 -07:00
Tai Lee
f3545860da Add ignored setting. Don't show matches with specified penalties applied, e.g. missing tracks or unmatched tracks.
If you know you never want these, they can clutter up the interface
especially now that we have multiple data sources.
2013-06-03 00:35:32 +10:00
Tai Lee
45dc99f1a9 Group preferred media patterns, in case they contain "|" to keep them separate from the number of media. 2013-06-03 00:25:31 +10:00
Tai Lee
e6ac8e1646 Use a Distance object instead of floats for distance calculations.
The new Distance object knows how to perform various types of distance
calculations (expression, equality, number, priority, string).

It will keep track of each individual penalty that has been applied so
that we can utilise that information in the UI and when making decisions
about the recommendation level.

We now display the top 3 penalties (sorted by weight) on the release
list (and "..." if there are more than 3), and we display all penalties
on the album info line and track change line.

The implementation of the `max_rec` setting has been simplified by
removing duplicate validation and instead looking at the penalties that
have been applied to a distance. As a result, we can now configure a
maximum recommendation for any penalty that might be applied.

We have a few new checks when calculating album distance:

`match: preferred: countries` and `match: preferred: media` can each be
set to a list of countries and media in order of your preference. These
are empty by default. A value that matches the first item will have no
penalty, and a value that doesn't match any item will have an unweighted
penalty of 1.0.

If `match: preferred: original_year` is set to "yes", beets will apply
an unweighted penalty of 1.0 for each year of difference between the
release year and the original year.

We now configure individual weights for `mediums` (disctotal), `label`,
`catalognum`, `country` and `albumdisambig` instead of a single generic
`minor` weight. This gives more control, but more importantly separates
and names the applied penalties so that the UI can convey exactly which
fields have contributed to the overall distance penalty.

Likewise, `missing tracks` and `unmatched tracks` are penalised and
displayed in the UI separately, instead of a combined `partial` penalty.

Display non-MusicBrainz source in the disambiguation string, and
"source" in the list of penalties if a release is penalised for being
a non-MusicBrainz.
2013-06-02 18:25:10 +10:00
Adrian Sampson
b3646f2659 fix some docs syntax 2013-05-28 21:28:26 -07:00
Tai Lee
a5151bb32e Look at many more metadata fields when calculating distance.
Produce slightly more varied similarity score to prioritise extremely
similar releases.
2013-05-29 10:18:55 +10:00
Tai Lee
e66a865f17 Rename the discogs max rec setting to non_mb_source, so it can apply to all data source plugins. 2013-05-25 22:44:41 +10:00
Tai Lee
f5557a74d7 Update intersecting max_rec and discogs docs. 2013-05-24 15:01:19 +10:00
Adrian Sampson
45baa6efe1 first stab at "advanced guide" 2013-05-19 17:35:23 -07:00
Adrian Sampson
0bb51e9f1b thanks and doc tweaks for duplicates (#278) 2013-05-17 12:20:27 -07:00
Adrian Sampson
916ceb4b15 changelog and tweaks for #275
I've removed the -p option. The command now always shows plugin-provided
template fields if any are available. We also avoid printing out blank lines
for plugins that don't provide fields.
2013-05-17 11:55:17 -07:00
Pedro Silva
4f5faeccac Append plugin template fields to 'beet fields' output with -p, --plugins 2013-05-15 13:41:54 +01:00
Adrian Sampson
056cf932d8 docs/changelog for date added (#264) 2013-05-11 13:31:42 -07:00
Lucas Duailibe
5c31d3ac15 Formatting the import time in the view and paths
Added the %format{} template function to output the time to any format supported by time.strftime()
2013-05-11 10:53:43 -03:00
Adrian Sampson
cc13edf49f changelog/docs for range queries #261 2013-05-09 16:13:22 -07:00
Adrian Sampson
e920cacfed fix link to MusicBrainz albumtype docs 2013-04-25 09:19:33 -07:00
single-sandwiches
563c4be2ad Update pathformat.rst
Fixed link pointing to the MusicBrainz wiki in regards to the list of albumtype: type names
2013-03-11 22:46:26 +11:00
Adrian Sampson
5f3ebde6bb mbsync: docs/changelog
As discussed on #115, this has the "reimport" docs refer to the mbsync plugin.
2013-03-03 16:41:48 -08:00
Adrian Sampson
f268aae17f add --flat option to import command (GC-202) 2013-02-26 20:59:52 -08:00
Adrian Sampson
706c4fb7f6 import.detail config option (GC-263) 2013-02-26 20:36:29 -08:00
Adrian Sampson
0045880f58 change option name to "languages"; docs (#102) 2013-02-26 14:38:34 -08:00
Adrian Sampson
fa9d326d39 ignore "System Volume Information" directory
This is a control directory on Windows whose permissions are always set very
restrictively:
http://blogs.msdn.com/b/oldnewthing/archive/2003/11/20/55764.aspx
2013-02-24 15:53:47 -08:00
Adrian Sampson
3e624ea884 original_date config option (GC-441) 2013-02-08 13:45:31 -08:00
Adrian Sampson
e0bb3b5cd0 original_{year,month,day,date} fields (GC-441) 2013-02-08 13:28:51 -08:00