From d5910b4e856debc531bcd1fc59649b27be2f039a Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Sun, 10 Aug 2014 16:18:15 -0700 Subject: [PATCH] Docs tweaks --- docs/changelog.rst | 2 +- docs/reference/config.rst | 17 ++++++++++------- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index bfc6da537..edc3919c9 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -69,7 +69,7 @@ Little improvements and fixes: fingerprinting on import. Thanks to ddettrittus. * :doc:`/plugins/convert`: Add ``--format`` option to select the transoding command from the command-line. -* Add :ref:`asciify-paths` configuration option to replace non-ASCII +* A new :ref:`asciify-paths` configuration option replaces all non-ASCII characters in paths. diff --git a/docs/reference/config.rst b/docs/reference/config.rst index d7ca4b090..04deddd37 100644 --- a/docs/reference/config.rst +++ b/docs/reference/config.rst @@ -121,8 +121,8 @@ clients, are also removed. Note that paths might contain special characters such as typographical quotes (``“”``). With the configuration above, those will not be -replaced as they don’t match the typewriter quote (``"``). You either -have to add them to the replacement list or use the +replaced as they don't match the typewriter quote (``"``). To also strip these +special characters, you can either add them to the replacement list or use the :ref:`asciify-paths` configuration option below. .. _asciify-paths: @@ -130,13 +130,16 @@ have to add them to the replacement list or use the asciify_paths ~~~~~~~~~~~~~ -Works like a specialized ``replace`` configuration. If set to ``yes``, -all non-ASCII characters in paths created by beets are converted to -their ASCII equivalents. For example, if your path template for +Convert all non-ASCII characters in paths to ASCII equivalents. + +For example, if your path template for singletons is ``singletons/$title`` and the title of a track is "Café", then the track will be saved as ``singletons/Cafe.mp3``. The changes -take place before applying the ``replace`` configuration. Uses the -mapping provided by the `unidecode module`_. Defaults to ``no``. +take place before applying the :ref:`replace` configuration and are roughly +equivalent to wrapping all your path templates in the ``%asciify{}`` +:ref:`template function `. + +Default: ``no``. .. _unidecode module: http://pypi.python.org/pypi/Unidecode