Skip to content

Commit

Permalink
document encoding option
Browse files Browse the repository at this point in the history
  • Loading branch information
letuananh committed Aug 26, 2021
1 parent c8906a4 commit 4b66ff3
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/recipe_elan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,14 @@ Converting ELAN files to CSV

.. code-block:: bash
python -m speach eaf2csv my_transcript.eaf -o my_transcript.csv
python -m speach eaf2csv path/to/my_transcript.eaf -o path/to/my_transcript.csv
By default, speach generate output using ``utf-8`` and this should be useful for general uses.
However in some situations users may want to customize the output encoding.
For example Microsoft Excel on Windows may require a file to be encoded in ``utf-8-sig`` (UTF-8 file with explicit BOM signature in the beginning of the file) to recognize it as an UTF-8 file.
It is possible to specify output encoding using the keyword ``encoding``, as in the example below:

.. code-block:: bash
python -m speach eaf2csv my_transcript.eaf -o my_transcript.csv --encoding=utf-8-sig

0 comments on commit 4b66ff3

Please sign in to comment.