Docs tweaks

This commit is contained in:
Adrian Sampson 2014-08-10 16:18:15 -07:00
parent e6fdf4c0e5
commit d5910b4e85
2 changed files with 11 additions and 8 deletions

View file

@ -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.

View file

@ -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 dont 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 <template-functions>`.
Default: ``no``.
.. _unidecode module: http://pypi.python.org/pypi/Unidecode