Commit 3dd17086 authored by Ralph Giles's avatar Ralph Giles
Browse files

minor comment doc cleanups

svn path=/trunk/vorbis/; revision=1186
parent 709a202a
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
Ogg Vorbis comment field specification Ogg Vorbis comment field specification
</font></h1> </font></h1>
<em>Last update to this document: June 16, 2000</em><p> <em>Last update to this document: January 19, 2001</em><p>
The text comment header is the second (of three) header packets that The text comment header is the second (of three) header packets that
begin a Vorbis bitstream. It is meant for short, text comments, begin a Vorbis bitstream. It is meant for short, text comments,
...@@ -16,7 +16,6 @@ metadata stream (usually an XML stream type).<p> ...@@ -16,7 +16,6 @@ metadata stream (usually an XML stream type).<p>
<h2>Comment use rationale</h2> <h2>Comment use rationale</h2>
The comment field is meant to be used much like someone jotting a The comment field is meant to be used much like someone jotting a
quick note on the bottom of a CDR. It should be a little information to quick note on the bottom of a CDR. It should be a little information to
remember the disc by and explain it to others; a short, to-the-point remember the disc by and explain it to others; a short, to-the-point
...@@ -37,7 +36,7 @@ is limited to 2^32-1 bytes. The vector length is encoded; the vector ...@@ -37,7 +36,7 @@ is limited to 2^32-1 bytes. The vector length is encoded; the vector
is not null terminated. In addition to the vector list, there is a is not null terminated. In addition to the vector list, there is a
single vector for vendor name (also 8 bit clean, length encoded in 32 single vector for vendor name (also 8 bit clean, length encoded in 32
bits). Libvorbis currently sets the vendor string to "Xiphophorus bits). Libvorbis currently sets the vendor string to "Xiphophorus
libVorbis I 20000508".<p> libVorbis I 20010119".<p>
The comment vectors are structured similarly to a UNIX environment. The comment vectors are structured similarly to a UNIX environment.
That is, comment fields consist of a field name and a field value and That is, comment fields consist of a field name and a field value and
...@@ -72,7 +71,8 @@ in this list. ...@@ -72,7 +71,8 @@ in this list.
<dl> <dl>
<dt>TITLE<dd>Track name <dt>TITLE<dd>Track name
<dt>VERSION<dd>The version field may be used to differentiate multiple version of the same track title in a single collection. <dt>VERSION<dd>The version field may be used to differentiate multiple
version of the same track title in a single collection. (e.g. remix info)
<dt>ALBUM<dd>The collection name to which this track belongs <dt>ALBUM<dd>The collection name to which this track belongs
...@@ -80,7 +80,7 @@ in this list. ...@@ -80,7 +80,7 @@ in this list.
<dt>ARTIST<dd>Track performer <dt>ARTIST<dd>Track performer
<dt>ORGANIZATION<dd>Name of the organization producing the track (ie, <dt>ORGANIZATION<dd>Name of the organization producing the track (i.e.
the 'record label') the 'record label')
<dt>DESCRIPTION<dd>A short text description of the contents <dt>DESCRIPTION<dd>A short text description of the contents
...@@ -116,7 +116,7 @@ common namespace. ...@@ -116,7 +116,7 @@ common namespace.
<li> <li>
Field names are not required to be unique (occur once) within a Field names are not required to be unique (occur once) within a
comment header. As an example, assume a track was recorded by three comment header. As an example, assume a track was recorded by three
well know artists; the following is permissible: well know artists; the following is permissible, and encouraged:
<pre> <pre>
ARTIST=Dizzy Gillespie ARTIST=Dizzy Gillespie
ARTIST=Sonny Rollins ARTIST=Sonny Rollins
...@@ -189,8 +189,3 @@ copyright (C) 1994-2000 Xiphophorus. All rights reserved.<p> ...@@ -189,8 +189,3 @@ copyright (C) 1994-2000 Xiphophorus. All rights reserved.<p>
</body> </body>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment