Просмотр исходного кода

Alphabetized toc keywords.

master
Svend Sorensen 19 лет назад
Родитель
Сommit
a48aa2dec0
1 измененных файлов: 79 добавлений и 88 удалений
  1. +79
    -88
      doc/formats.txt

+ 79
- 88
doc/formats.txt Просмотреть файл

@@ -196,13 +196,26 @@ brackets.
Comments
--------

Comments begin with ``//`` and may be placed anywhere. Because they can be
placed anywhere in a line, toc comments are treated as a special case (not as a
keyword). Any text beginning with ``//`` is stripped from each line.
Comments begin with ``//`` and may be placed anywhere except inside quoted
strings. A comment beginning with ``//`` is stripped from each line.

Keywords
--------

AUDIOFILE
~~~~~~~~~

:Description: Add file to current track.
:Section(s): track
:Format:
``AUDIOFILE "<filename>" <start> [length]``

``start``
time in MSF format.

``length``
time in MSF format.

CATALOG
~~~~~~~

@@ -235,22 +248,13 @@ CD_ROM_XA
:Section(s): global
:Format: ``CD_ROM_XA``

TRACK
~~~~~

:Description: Starts a new track.
:Section(s): track
:Format: ``TRACK <track_mode> [sub_channel_mode]``
CD_TEXT
~~~~~~~

NO
~~
:Description: Negates (clears) track flags.
:Section(s): track
:Format:
``NO <flag>``
:Section(s): any
:Format: ``CD_TEXT {}``

``flag``
one of: ``COPY`` or ``PRE_EMPHASIS``.
Begins a CD-TEXT block.

COPY
~~~~
@@ -259,27 +263,12 @@ COPY
:Section(s): track
:Format: ``COPY``

PRE_EMPHASIS
~~~~~~~~~~~~

:Description: Sets the pre-emphasis flag.
:Section(s): track
:Format: ``PRE_EMPHASIS``

TWO_CHANNEL_AUDIO
~~~~~~~~~~~~~~~~~
DATAFILE
~~~~~~~~

:Description: Sets the two channel audio flag.
:Section(s): track
:Format: ``TWO_CHANNEL_AUDIO``


FOUR_CHANNEL_AUDIO
~~~~~~~~~~~~~~~~~~

:Description: Sets the four channel audio flag.
:Section(s): track
:Format: ``FOUR_CHANNEL_AUDIO``
*TODO*

ISRC
~~~~
@@ -292,14 +281,7 @@ ISRC
``ISRC_number``
a string with the format CCOOOOYYSSSSS.

SILENCE
~~~~~~~

:Section(s): track

*TODO*

ZERO
FIFO
~~~~

:Section(s): track
@@ -320,41 +302,54 @@ FILE
``length``
time in MSF format.

AUDIOFILE
~~~~~~~~~
FOUR_CHANNEL_AUDIO
~~~~~~~~~~~~~~~~~~

:Description: Add file to current track.
:Description: Sets the four channel audio flag.
:Section(s): track
:Format:
``AUDIOFILE "<filename>" <start> [length]``
:Format: ``FOUR_CHANNEL_AUDIO``

``start``
time in MSF format.
INDEX
~~~~~

``length``
:Description: Sets a track index.
:Section(s): track
:Format: ``INDEX <index_number> <index_time>``

``index_number``
a non-negative integer.
``index_time``
time in MSF format.

DATAFILE
LANGUAGE
~~~~~~~~

:Section(s): track
:Subsection(s): CD-TEXT block
:Format: ``LANGUAGE language_number { cd_text }``

*TODO*

FIFO
~~~~
Begins a language block. ``language_number`` must be an integer in the range
0-255. ``cd_text`` is a series of CD-TEXT keyword lines.

:Section(s): track
LANGUAGE_MAP
~~~~~~~~~~~~

*TODO*
:Section(s): global
:Subsection(s): CD-TEXT block
:Format: ``LANGUAGE_MAP { language_map... }``

START
~~~~~
Begins a language map block. ``language_map`` is a mapping of an integer in
the range 0-255 to a country code.

NO
~~
:Description: Negates (clears) track flags.
:Section(s): track
:Format: ``START <start>``
:Format:
``NO <flag>``

*TODO*
``flag``
one of: ``COPY`` or ``PRE_EMPHASIS``.

PREGAP
~~~~~~
@@ -367,45 +362,41 @@ PREGAP
``pregap``
time in MSF format.

INDEX
~~~~~
SILENCE
~~~~~~~

:Description: Sets a track index.
:Section(s): track
:Format: ``INDEX <index_number> <index_time>``

``index_number``
a non-negative integer.
``index_time``
time in MSF format.
*TODO*

CD_TEXT
~~~~~~~
START
~~~~~

:Section(s): any
:Format: ``CD_TEXT {}``
:Section(s): track
:Format: ``START <start>``

Begins a CD-TEXT block.
*TODO*

LANGUAGE_MAP
~~~~~~~~~~~~
TRACK
~~~~~

:Section(s): global
:Subsection(s): CD-TEXT block
:Format: ``LANGUAGE_MAP { language_map... }``
:Description: Starts a new track.
:Section(s): track
:Format: ``TRACK <track_mode> [sub_channel_mode]``

Begins a language map block. ``language_map`` is a mapping of an integer in
the range 0-255 to a country code.
TWO_CHANNEL_AUDIO
~~~~~~~~~~~~~~~~~

LANGUAGE
~~~~~~~~
:Description: Sets the two channel audio flag.
:Section(s): track
:Format: ``TWO_CHANNEL_AUDIO``

ZERO
~~~~

:Section(s): track
:Subsection(s): CD-TEXT block
:Format: ``LANGUAGE language_number { cd_text }``

Begins a language block. ``language_number`` must be an integer in the range
0-255. ``cd_text`` is a series of CD-TEXT keyword lines.
*TODO*

(CD-TEXT keywords)
~~~~~~~~~~~~~~~~~~


Загрузка…
Отмена
Сохранить