Commit graph

433 commits

Author SHA1 Message Date
Bart Kleijngeld
91722aea36 added documentation 2017-05-30 21:29:49 +02:00
SpirosChadoulos
3c852d3539 docs 2017-05-13 12:26:31 +03:00
Adrian Sampson
8a99eea146 Merge pull request #2509 from mattmurch/Issue549
Add default replace for - to _
2017-04-16 08:56:22 -04:00
Adrian Sampson
346ecbc6d4 Slightly more verbose config overlay description 2017-04-15 15:43:26 -04:00
Adrian Sampson
8e58a61eb4 Remove one blank line 2017-04-15 15:34:09 -04:00
MolarAmbiguity
a526eb7222 Implement feedback from sampsyo 2017-04-15 09:23:35 +10:00
MolarAmbiguity
94b75e8fb4 Fix bulleted list 2017-04-14 12:57:42 +10:00
MolarAmbiguity
ad87d2af92 Add info about overlaying configs 2017-04-14 12:40:32 +10:00
Matt Murch
e224621e83 Add default replace for - to _
Also updated changelog and docs.

Resolves: #549
2017-04-12 13:48:37 -04:00
Adrian Sampson
70ef6e7df8 Fix heading underline length 2017-03-27 23:23:23 -04:00
SpirosChadoulos
218968235e small changes for the bell issue 2017-03-28 01:09:14 +03:00
SpirosChadoulos
c605a918c8 Added an if statement that allows the bell ring according to the user's configuration. 2017-03-27 20:49:28 +03:00
Adrian Sampson
af335868a8 Writing refinement for #2480
A slightly more nuanced description. Also use two separate paragraphs.
2017-03-18 14:10:21 -04:00
abigaildelarosa
bbd0b22005 change modify paragraph 2017-03-17 16:38:59 +01:00
Adrian Sampson
d22a257008 Main guide: clarify meaning of plain keyword query
Fixes #2463.
2017-03-01 20:22:30 -05:00
Adrian Sampson
d10bfa1af6 Changelog & thanks for #2445 2017-02-20 22:11:34 -05:00
Jacob Gillespie
4e77ef4484 Address review comments 2017-02-19 20:48:34 -06:00
Jacob Gillespie
1fd22604fb Fix linter issues 2017-02-19 17:33:26 -06:00
Jacob Gillespie
b4efecb709 Add option to hardlink when importing 2017-02-19 15:56:13 -06:00
karpinski
88d26e7694 Adding a move option to the importer's CLI and updating the docs. 2017-02-07 21:19:45 +01:00
euri10
d2cd4c0f21 Change relative date's format to further simplify it
A relative date doesn't need to be prefixed by @ anymore.
The relative date pattern now displays named groups.
Digits have been change to [0-9] to avoid other digit characters.
Removed the @ character in tests.
Updated subsequent documentation.
2017-01-31 16:56:03 +01:00
euri10
f0aca5e0d3 Explain relative dates
The previous version wasn't user-friendly enough and too technical.
2017-01-30 09:06:26 +01:00
euri10
c9177f2b56 removed unrelated PR changes
corrected docs with correct example
added relative date usage to it
2017-01-29 14:38:25 +01:00
euri10
e4a7d37a6d implementing changes asked
corrected rst
fixed flake8 in test
2017-01-29 11:49:22 +01:00
euri10
8d054f3656 tests flake8 issues
added some doc
2017-01-28 21:40:26 +01:00
A.L. Kleijngeld
24027d1bf8 Update config.rst: see issue #2410
`When a match is above the *medium* recommendation threshold`
->
`When a match is below the *medium* recommendation threshold`

As discussed in issue #2410, which is fixed by this edit.
2017-01-27 21:48:46 +01:00
diomekes
04f7915d41 change no-bracket argument from white space to empty 2017-01-20 22:47:47 -05:00
diomekes
3a967df396 simplify check for empty disam_val, update changelog and docs, add change bracket test 2017-01-19 20:41:44 -05:00
diomekes
377a2a6964 add bracket argument to aunique 2017-01-19 20:39:12 -05:00
diomekes
5ee89666b6 fix typo in config docs 2017-01-07 09:54:54 -05:00
Adrian Sampson
f621d7f4f1 Merge pull request #1992 from jackwilsdon/add-write-bpm
Add write option to bpm plugin
2017-01-01 23:09:41 -05:00
Adrian Sampson
8cb6ff3892 Simplify the example config
I never meant for people to copy and paste this example---it's redundant and
probably wrong---but lots of people do! Removing a few weird options makes the
example clearer, I think, and will result in less-strange initial configs for
people who do copy & paste.
2017-01-01 19:18:25 -05:00
Adrian Sampson
f31e6110e6 Simplify #2280 docs
I've backed out the FAQ entry, since the main docs seem like the right place
for this.
2016-11-24 23:59:00 -05:00
Adrian Sampson
d6b15f4eaa Remove duplicated line in docs (#2280)
For consistency: we don't show the aliases here for the other commands.
2016-11-24 23:51:10 -05:00
Peter Kessen
488225d837 Added documentation and FAQ for selective modify 2016-11-24 19:41:31 +01:00
Peter Kessen
9f48338291 Corrected docs for modify command
added short form ´mod´ and added switch ´-f´
2016-11-24 19:04:42 +01:00
Dang Mai
8d07bfe693 Documentation for new flag 2016-10-20 23:33:20 -04:00
Diego Moreda
f0a14bfdd5 Fix documentation issues for %first
Fix a formatting problem related to sphinx not allowing spaces at the
beginning or end of an inline literal, and removed an extra sentence
at th end of the %first template function documentation.
2016-10-04 16:20:52 +02:00
Diego Moreda
0eb0353453 Revise documentation for commas in Parser 2016-10-04 16:17:26 +02:00
Stefano Rivera
bcb1f8036a Correct a typo
Spotted by lintian which runs spellchecks on man pages.
2016-08-29 16:29:32 -07:00
Dixon Xavier
80ca527f76 Fix typo in documentation 2016-06-19 13:20:54 +05:30
Dixon Xavier
fbcc8dbf1e Update changelog and documentation 2016-06-19 12:54:27 +05:30
Gondlar
3ea9706f4e Clarify which fields are searched by default 2016-06-16 18:53:55 +02:00
Jack Wilsdon
0d2923e4ea Add documentation for beet remove --force 2016-06-08 19:26:19 +01:00
Adrian Sampson
a440e44abd Proofread the changelog 2016-05-31 10:33:56 -07:00
Johnny Robeson
c1a168590c add lost+found directory to default ignore list 2016-05-06 20:51:37 -04:00
Jack Wilsdon
2d5c68cec9 Remove write option from bpm and use import.write 2016-05-06 17:50:27 +01:00
Jack Wilsdon
38a3726b1b Add documentation 2016-05-06 00:45:45 +01:00
Guilherme Danno
8c471581e0 Use the 'terminal_encoding' option for overriding the sys.stdin.encoding in some cases (#1964)
* Use the 'terminal_encoding' option for overriding the `sys.stdin.encoding` in some cases
* Add the documentation
2016-04-28 00:17:19 -03:00
Dave Hayes
2f1dd9451b Add notes for installing the ZSH completion script 2016-04-25 13:04:05 -05:00
Guilherme Danno
271f7c8d17 new template path functions: %first{} and %ifdef{} (#1951)
* New template functions: %first{} and %ifdef{}
* Add documentation
* Add to changelog
2016-04-23 13:59:25 -03:00
Peter Kessen
f6b81c1bdd Made changes suggested by @sampsyo 2016-02-04 18:35:01 +01:00
Peter Kessen
fac814421a Added documentation for changes by #1843 2016-02-04 17:59:59 +01:00
Sven-Hendrik Haase
a942719ffc Fix grammar 2016-02-03 20:38:29 +01:00
Adrian Sampson
d093ef9a47 A little more documentation for fields (#1818) 2016-01-28 13:52:07 -08:00
Diego Moreda
4f51302d09 Fix typo on importer search by id documentation 2016-01-22 19:48:22 +01:00
Diego Moreda
79d84c0e4f Style and doc fixes for MB_id importer argument
* Rename the importer argument and related variables to make it more
generic, as the feature should be independent of the backend used and
not restricted to MusicBrainz.
* Update documentation and docstrings accordingly.
* Add changelog entry.
2016-01-22 16:31:00 +01:00
Diego Moreda
b526227482 Cleanup and documentation for MB_id importer arg
* Style cleanup and fixes for the "--musicbrainzid" import argument.
* Allow the input of several IDs (separated by spaces) on the "enter Id"
importer prompt.
* Add basic documentation.
2016-01-21 17:08:53 +01:00
Adrian Sampson
c7045daf90 sampsyo -> beetbox (#1730) 🎉 2016-01-08 20:36:16 -08:00
François-Xavier Thomas
50789e88fe Fix 1583: Move command only shows modified files 2016-01-01 17:49:53 +01:00
Adrian Sampson
3855fa0766 Doc refinements for #1749 2015-12-12 17:33:23 -08:00
Diego Moreda
47ceb492dc Add docs note for custom-field sorting, fix typo
* Add note about ordering when sorting by custom-fields on query.rst.
* Fix typo on inline.rst.
2015-11-25 19:15:01 +01:00
Adrian Sampson
fd2cacbc25 Minor docs refinements for #1728
- Use a marginally more realistic example in the changelog.
- The -- convention is actually not the purview of shells; it's just a de
  facto standard for command-line parsers. Fortunately, argparse supports it
  out of the box.
2015-11-20 10:07:29 -08:00
Diego Moreda
51bf6a1c9f Add documentation for NotQuery, cleanup
* Add changelog and query.rst documentation entries for the usage of negated
queries.
* Cleanup NotQuery class as suggested during code review (PEP conforming
docstring, clarification on empty clause match behaviour).
2015-11-20 18:06:22 +01:00
Adrian Sampson
98f48237f5 Tiny docs tweaks for #1708 2015-11-08 13:04:26 -08:00
Manfred Urban
95b80b37aa Updated documentation 2015-11-08 17:04:36 +01:00
Adrian Sampson
80bfd186ae Use should_write for modify, update, and mbsync
This should address the surprising situation in #1697, where `import` went
fine but then `update` unexpectedly changed filenames.
2015-11-07 13:34:47 -08:00
Adrian Sampson
f4a617e641 Move color option in config example (fix #1653) 2015-10-19 13:44:52 -07:00
Adrian Sampson
d29cc7b2c0 Refine docs for #1586 2015-10-07 16:36:12 -07:00
Adrian Sampson
3b604c7ff9 Merge pull request #1586 from mried/RobustCaseSensitiveDetection
A robust way to check for a case sensitive file system
2015-10-07 15:43:38 -07:00
David Logie
bfc5a1b803 Add new `include` config option.
This new option allows users to provide a list of external config files
which will be evaluated when beets starts.

This is useful for keeping private settings (e.g. API keys) out of the
main configuration file.
2015-10-05 14:01:26 +01:00
Malte Ried
5832e8730e Changed the documentation of the PathQueries to reflect the usage of the file system cas-sensitivity. 2015-09-11 20:38:53 +02:00
Adrian Sampson
f8d9019d1b Better explanation of threaded option
It was pointed out that the old wording was too worrisome.
2015-09-06 17:14:55 -07:00
Ben Boeckel
323f79ecdb colors: support standard terminal colors
Fixes #1548.

Signed-off-by: Ben Boeckel <mathstuf@gmail.com>
2015-08-05 22:00:25 -04:00
Ben Ockmore
1f1e0f7240 Added warning message and paragraph about replacements/max length interaction in documentation. 2015-07-07 17:46:42 +01:00
Adrian Sampson
e360438977 Note about escaping regex arguments in shell
A la #1520.
2015-06-25 21:27:28 -07:00
Adrian Sampson
419a12a2f2 Further clarify docs for #1493 2015-06-02 19:54:16 -07:00
Adrian Sampson
bc9caa5845 Update docs for #1493/#1104 2015-06-02 19:38:30 -07:00
Rui Gonçalves
93c8f834f0 Add support for pregap tracks 2015-06-03 00:54:25 +01:00
Adrian Sampson
7f5c274c46 Grouped-album tasks have paths
Close #1475, fix #825.
2015-05-25 12:57:23 -07:00
Adrian Sampson
061f0f71bf Merge pull request #1466 from tomjaspers/move-pretend-option
Implement `--pretend` option for the move command
2015-05-20 21:41:15 -07:00
Scott Thomas
07e352143e File modification note in docs
I couldn't get beet update to read metadata changes - turns out that puddletag
doesn't touch the file modification time by default. It's a perfectly sensible
behaviour but I thought I'd add a note in the `beet update` section in case
anyone else has this problem.
2015-05-21 00:45:20 +01:00
Tom Jaspers
be484f2af0 Implement --pretend option for the move command
The method `show_path_changes` takes a list of tuples (source, destination)
that will be printed on either single / double line, as proposed in #1405.
2015-05-20 13:03:18 +02:00
Tom Jaspers
0302c44909 Docs & changelog for case insensitive sort 2015-04-18 10:27:56 +02:00
Adrian Sampson
6004da7c42 Expand changelog for "or" queries (#1423) 2015-04-16 19:34:20 -07:00
Adrian Sampson
bc698c3c0e Merge pull request #1423 from tomjaspers/or-query-operator
Use comma as "or" operator for queries
2015-04-16 19:25:24 -07:00
Tom Jaspers
c98835709f Query documentation to include "or" operator 2015-04-16 09:44:49 +02:00
Adrian Sampson
0c7823b4a5 Add zsh completion instructions (fix #1420) 2015-04-15 19:53:27 -07:00
Bruno Cauet
8a71935a95 Document path detection update 2015-03-30 13:18:35 +02:00
Adrian Sampson
c37561c74b Redact by default (#1376) 2015-03-29 14:26:16 -07:00
Adrian Sampson
37860bf2ef --redacted is now --redact
Seems more direct to me.
2015-03-27 22:44:32 -04:00
Tom Jaspers
ce78be3eb6 Config: add docs & tests for --redacted option 2015-03-26 12:49:54 +01:00
Bruno Cauet
679b0a586b Remove list_format_{album,item} sections from docs 2015-03-07 13:45:58 +01:00
Bruno Cauet
58b39f1000 Merge branch 'master' into subcommand-auto-format-path 2015-03-05 17:53:31 +01:00
Bruno Cauet
f14f47f059 Renamed list_format_* into format_* 2015-03-04 16:51:28 +01:00
Adrian Sampson
eec8d5d2be Doc rewording for #1330 2015-03-01 17:09:36 -08:00
Adrian Sampson
e14f28fdda Merge pull request #1330 from brunal/path-query-case-sensitivity
Fix path query case sensitivity

Conflicts:
	docs/changelog.rst
2015-03-01 17:01:45 -08:00
Adrian Sampson
c05dea123e Docs clarity for verbosity levels (#1320) 2015-02-17 17:12:42 -05:00
Bruno Cauet
83e34322e9 Update changelog & docs 2015-02-17 13:14:29 +01:00
Bruno Cauet
a014750e2d Update docs: mention multi-level logging
If you think what I wrote suck, it's because it does.
2015-02-10 17:29:02 +01:00
Tom Jaspers
ea687baebd Configurable colors: update documentation and changelog 2015-01-29 14:05:00 +01:00
Frederik “Freso” S. Olesen
ad00c5dc7b docs: Fix hyperlink targets.
I inserted musicbrainz.searchlimit at the wrong place, breaking the
hyperlink target `match-config` - and I also forgot to add a hyperlink
target for `searchlimit`.
2015-01-19 02:24:32 +01:00
Frederik “Freso” S. Olesen
7c429e8c58 docs: New entry for musicbrainz.searchlimit config option. 2015-01-19 02:19:43 +01:00
Adrian Sampson
a892128996 Changelog and rewording for import --pretend
(#1162)
2014-12-23 09:10:28 -05:00
Malte Ried
af36d85ef8 Implemented a better solution for the pretend flag
Corrected the documentation (shortcut -e is not available any more)
2014-12-23 13:52:22 +01:00
Malte Ried
2db346388a Added option --pretend to only print the filenames of files to import without importing them 2014-12-21 15:56:56 +01:00
Adrian Sampson
a197a12c3a Mention #130 in docs 2014-12-15 04:36:01 +00:00
Adrian Sampson
c6af552703 docs: item_linked event (#710) 2014-11-15 12:21:14 -08:00
Adrian Sampson
1eebb6af3c Docs for link option (#710) 2014-11-15 12:07:49 -08:00
Adrian Sampson
2343387a68 beet stats output clarification (#1052)
Explicitly say that size calculation is approximate.
2014-11-01 12:46:14 -07:00
Adrian Sampson
f88a960a63 Changelog for #984
[ci skip]
2014-09-28 11:50:05 -07:00
Adrian Sampson
5f2ca0b75b Rename smartartist to artist/albumartist (#953)
This is basically always what you want, so now you can just use the name of
the field without "smart".
2014-09-16 14:53:16 -07:00
Adrian Sampson
d572bde13b Tiny docs typos
Conflicts:
	docs/plugins/index.rst
2014-09-12 20:58:24 -07:00
Adrian Sampson
132fad847b Changelog for sorting (#823) 2014-08-22 15:02:50 -07:00
Adrian Sampson
eb579cf14b Merge pull request #823 from PierreRust/sortquery
Sorting support in beets query mecanism (dbcore)
2014-08-22 14:59:44 -07:00
Harry Khanna
65c4ae627e Clarify the default behavior for the write subcommand 2014-08-19 14:06:41 -04:00
Harry Khanna
2ffd3e287f Add --always flag for write subcommand
Forces a write of tags to file even if the file's tags match the database.
This is useful to force plugins that respond to write (e.g., Scrub and Zero) to run on those tags.
This may also make the TODO comment in zero.py less important since creates a way to manually run the zero plugin on a file imported as-is.
2014-08-19 13:43:16 -04:00
Adrian Sampson
3771134716 Add zsh completion script by @vapniks (#862) 2014-08-13 21:54:43 -07:00
Stig Inge Lea Bjørnsen
64fc3539cd Correct the textual description of a date query
The the date query syntax `2008-12..2009-10-11` covers the interval [2008-12-01T00:00:00, 2009-10-12T00:00:00).
2014-08-14 00:44:19 +02:00
Adrian Sampson
d5910b4e85 Docs tweaks 2014-08-10 16:20:17 -07:00
Thomas Scholtes
f1388eb23d docs: Add note for 'replace' config and unicode 2014-08-06 18:00:18 +02:00
Thomas Scholtes
76c7ba9186 Add asciify_paths configuration option 2014-08-06 17:53:44 +02:00
Adrian Sampson
35994e4bbd Docs: remove reference to "beet write -a"
This flag doesn't really exist!
2014-07-12 10:56:24 -07:00
Adrian Sampson
38bf08a49e Move path entry in field list 2014-07-02 18:59:37 -07:00
r04r
f6b59cf7df Add $path to the list of available values in pathformat.rst 2014-07-03 03:30:34 +02:00
Adrian Sampson
b6582e417f Changelog and doc fixes for #852 2014-07-02 14:51:41 -07:00
oprietop
8a4c668218 Documenting #852 2014-07-02 09:27:58 +02:00
Adrian Sampson
16f6a3daa7 Note about group-albums and import log (#825) 2014-06-25 10:05:31 -07:00
Pierre Rust
486289b11a Add documentation about default sort configuration. 2014-06-15 22:32:25 +02:00
Pierre Rust
3426363775 Add documentation about sort specification. 2014-06-15 22:32:25 +02:00
Stig Inge Lea Bjørnsen
5d7c78c219 Minor correction in the documentation for date queries. 2014-05-15 20:06:25 +02:00
Adrian Sampson
06ab0ec2e2 Tiny wording tweaks for #754 2014-05-10 17:19:04 -07:00
Fabrice L.
befc9746d9 Update pathformat.rst
mention bucket function
2014-05-10 23:28:59 +02:00
Fabrice Laporte
1303f0a4df Merge branch 'doc_plugins_templ_funcs' of github.com:KraYmer/beets into doc_plugins_templ_funcs
Conflicts:
	docs/reference/pathformat.rst
2014-05-09 09:01:07 +02:00
Fabrice Laporte
c002e4599c Add text to new _templ_plugins section
Replace links to ‘writing-plugin’ by internal links to ‘templ_plugins’.
Add small paragraph at the end of _templ_plugins to mention ‘inline’
plugin and the ‘Writing Plugins’ page.
2014-05-09 08:59:22 +02:00
Fabrice L.
c5babea31f fix typo from copy/paste 2014-05-08 22:27:21 +02:00
Fabrice Laporte
d8008e145f Add section listing template functions/fields provided by plugins for path
formatting
2014-05-08 22:05:26 +02:00
Adrian Sampson
9101b88499 Slightly shorter description of autotag
Brevity is the soul of documentation.
2014-04-29 21:57:39 -07:00
Evan Purkhiser
63fc7e04e6 docs: Document 'import.autotag' configuration 2014-04-30 00:14:49 -04:00
Adrian Sampson
d91960a8cf minor comment/doc tweaks for #690
The description of the import command was getting a bit unwieldy. Splitting up
the paragraph helped a little, but the docs could still use some love here.
2014-04-15 20:41:10 -07:00
Thomas Scholtes
63097650ff Add docs and changelog for archive import 2014-04-15 20:36:46 +02:00
sahandKashani
3d675b2339 bash completion documentation fix for GNU Bash-4.2
In GNU Bash-4.2, I have to put quotes around the eval statement for the shell to correctly interpret the output of the beet completion command.
2014-04-04 09:28:53 +02:00
Adrian Sampson
b683f239f0 some style tweaks for #638 2014-04-02 21:18:41 -07:00
Bruno Tournay
cd70e92b7f Modify command: ability to delete/reset an attribute (beet modify field!) 2014-04-01 22:38:33 +02:00
Adrian Sampson
810841ba5a a couple new extremely basic FAQs
These are also very common questions from new users.
2014-03-21 18:04:35 -07:00
Adrian Sampson
882d2305c0 docs: emphasize that you create config.yaml
This is, shockingly, the #1 question I get asked. I hope this helps.
2014-03-21 17:55:18 -07:00
Adrian Sampson
b0fd64662d update docs for #619 2014-03-19 10:34:03 -07:00
Adrian Sampson
c846ecd48d completion: mention shell startup time
according to @geigerzaehler's suggestion
2014-03-08 12:07:21 -08:00
Adrian Sampson
a6ca63d67c bash completion (#553): expand docs 2014-03-07 15:03:30 -08:00
Adrian Sampson
f71307f87e changelog for #570 2014-03-06 11:00:00 -08:00
Thomas Scholtes
8a5a2fcebf Merge branch 'completion'
Conflicts:
	beets/ui/commands.py
	docs/reference/cli.rst
2014-03-02 23:06:05 +01:00
Thomas Scholtes
44c843793b Add completion of plugin commands 2014-03-02 16:18:16 +01:00
Thomas Scholtes
25080bd59f Add documentation for completion command 2014-03-02 15:50:23 +01:00
Adrian Sampson
692645466e documentation expansion for config command (#552) 2014-02-28 09:31:10 -08:00
Thomas Scholtes
c345df9155 Merge branch 'config_command'
Conflicts:
	beets/ui/commands.py
	docs/reference/config.rst
	test/_common.py
2014-02-28 16:50:06 +01:00
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
575dc9d0c1 Documentation for config command 2014-02-18 21:29:31 +01: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