Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2026-01-04 15:03:22 +01:00
Code Issues Projects Releases Wiki Activity

Updated Format description layout

Browse source
This commit is contained in:
Austin Marino 2019-10-13 11:45:33 -07:00 committed by GitHub
parent 294b3cdb8c
commit 4f0a2b78a3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/plugins/export.rst
View file

@ -48,25 +48,28 @@ Configuration
To configure the plugin, make a ``export:`` section in your configuration
file. Under the ``json``, ``csv``, and ``xml`` keys, these options are available:
- **ensure_ascii**: Escape non-ASCII characters with ``\uXXXX`` entities.
- **JSON Formatting**
- **ensure_ascii**: Escape non-ASCII characters with ``\uXXXX`` entities.
- **indent**: The number of spaces for indentation.
- **indent**: The number of spaces for indentation.
- **separators**: A ``[item_separator, dict_separator]`` tuple.
- **separators**: A ``[item_separator, dict_separator]`` tuple.
- **sort_keys**: Sorts the keys in JSON dictionaries.
- **sort_keys**: Sorts the keys in JSON dictionaries.
- **delimiter**: Used as the separating character between fields. The default value is a comma (,).
- **CSV Formatting**
- **delimiter**: Used as the separating character between fields. The default value is a comma (,).
- **dialect**: A dialect, in the context of reading and writing CSVs, is a construct that allows you to create, store, and re-use various formatting parameters for your data.
- **dialect**: A dialect, in the context of reading and writing CSVs, is a construct that allows you to create, store, and re-use various formatting parameters for your data.
- **encoding**: Use encoding="unicode" to generate a Unicode string (otherwise, a bytestring is generated).
- **XML Formatting**
- **encoding**: Use encoding="unicode" to generate a Unicode string (otherwise, a bytestring is generated).
- **xml_declaration**: Controls if an XML declaration should be added to the file. Use False for never, True for always, None for only if not US-ASCII or UTF-8 or Unicode (default is None).
- **xml_declaration**: Controls if an XML declaration should be added to the file. Use False for never, True for always, None for only if not US-ASCII or UTF-8 or Unicode (default is None).
- **method**: Can be either "xml", "html" or "text" (default is "xml")
- **method**: Can be either "xml", "html" or "text" (default is "xml")
- **short_empty_elements**: Controls the formatting of elements that contain no content. If True (the default), they are emitted as a single self-closed tag, otherwise they are emitted as a pair of start/end tags.
- **short_empty_elements**: Controls the formatting of elements that contain no content. If True (the default), they are emitted as a single self-closed tag, otherwise they are emitted as a pair of start/end tags.
These options match the options from the `Python json module`_.