From: Ralph Giles Date: Fri, 19 Jan 2001 22:24:56 +0000 (+0000) Subject: minor comment doc cleanups X-Git-Tag: v1.3.3~1059 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=3dd1708684cff5133146b81440bd3b90038090aa;p=platform%2Fupstream%2Flibvorbis.git minor comment doc cleanups svn path=/trunk/vorbis/; revision=1186 --- diff --git a/doc/v-comment.html b/doc/v-comment.html index f6f9981..4334d62 100644 --- a/doc/v-comment.html +++ b/doc/v-comment.html @@ -7,7 +7,7 @@ Ogg Vorbis comment field specification -Last update to this document: June 16, 2000

+Last update to this document: January 19, 2001

The text comment header is the second (of three) header packets that begin a Vorbis bitstream. It is meant for short, text comments, @@ -16,7 +16,6 @@ metadata stream (usually an XML stream type).

Comment use rationale

- 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 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 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 bits). Libvorbis currently sets the vendor string to "Xiphophorus -libVorbis I 20000508".

+libVorbis I 20010119".

The comment vectors are structured similarly to a UNIX environment. That is, comment fields consist of a field name and a field value and @@ -72,7 +71,8 @@ in this list.

TITLE
Track name -
VERSION
The version field may be used to differentiate multiple version of the same track title in a single collection. +
VERSION
The version field may be used to differentiate multiple +version of the same track title in a single collection. (e.g. remix info)
ALBUM
The collection name to which this track belongs @@ -80,7 +80,7 @@ in this list.
ARTIST
Track performer -
ORGANIZATION
Name of the organization producing the track (ie, +
ORGANIZATION
Name of the organization producing the track (i.e. the 'record label')
DESCRIPTION
A short text description of the contents @@ -116,7 +116,7 @@ common namespace.
  • Field names are not required to be unique (occur once) within a 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:
                   ARTIST=Dizzy Gillespie 
                   ARTIST=Sonny Rollins 
    @@ -189,8 +189,3 @@ copyright (C) 1994-2000 Xiphophorus. All rights reserved.

    - - - - -