[cvs-annodex] commit (/annodex):
standards/draft-pfeiffer-cmml-v2-update.xml
silvia
nobody at lists.annodex.net
Tue Feb 15 20:01:49 EST 2005
Update of /annodex (new revision 914)
Modified files:
standards/draft-pfeiffer-cmml-v2-update.xml
Log Message:
Deleted v3 tags - it's done!
Needs some proofreading still, but the content is there!
uff
Modified: standards/draft-pfeiffer-cmml-v2-update.xml
===================================================================
--- standards/draft-pfeiffer-cmml-v2-update.xml 2005-02-15 08:39:33 UTC (rev 913)
+++ standards/draft-pfeiffer-cmml-v2-update.xml 2005-02-15 09:01:47 UTC (rev 914)
@@ -169,8 +169,7 @@
<t>Please note that this document assumes that the reader has a
fluent working knowledge of <xref target="XML">Extensible Markup
Language (XML)</xref>, <xref target="HTML">Hypertext Markup
- Language (HTML)</xref>, <xref target="XHTML">XHTML</xref>,
- <xref target="CSS">Cascading Style Sheets (CSS)</xref> and
+ Language (HTML)</xref>, <xref target="XHTML">XHTML</xref> and
the World Wide Web. Basic knowledge about the <xref
target="ANX">Annodex</xref> format is also assumed.
</t>
@@ -187,11 +186,7 @@
<t>The format of the CMML derives much from XHTML. Yet, instead
of enabling the annotation of textual documents, it enables
- creation of mark-up for time-continuous documents. CMML has a much
- stricter separation of structure and presentation information than
- HTML or XHTML. CMML's tags only hold structural and semantic tags,
- while the presentation of these tags in a user interface is fully
- controlled by style sheets.
+ creation of mark-up for time-continuous documents.
</t>
<t>The CMML can describe one or several time-continuous data
@@ -271,127 +266,6 @@
</t>
</section>
- <section title="LinkTypes">
- <t>"LinkTypes" specifies a space-separated list of the types of
- relationships a linked, i.e. related, document has to the current
- one. As in XHTML, user agents, search engines, etc. may interpret
- these link types in a variety of ways. For example, user agents
- may provide access to linked documents through a navigation bar.
- Authors may use the following recognized link types which are a
- subset of the ones used for XHTML/HTML:
- <list style="symbols">
- <t>alternate: Designates substitute versions for the document
- in which the link occurs. When used together with the media
- attribute, it implies a version designed for a different
- medium (or media).
- </t>
- <t>stylesheet: Refers to an external style sheet.
- </t>
- <t>start: Refers to the first document in a collection of
- documents. This link type tells search engines which document
- is considered by the author to be the starting point of the
- collection.
- </t>
- <t>next: Refers to the next document in a linear sequence of
- documents. User agents may choose to pre-load the "next"
- document, to reduce the perceived load time.
- </t>
- <t>prev: Refers to the previous document in an ordered series of
- documents.
- </t>
- <t>contents: Refers to a document serving as a table of contents.
- Although this may seem strange in a CMML file, it makes sense
- in an Annodex file and may simply refer back to the CMML file
- or to a HTML page that provides similar information.
- </t>
- <t>index: Refers to a document providing an index for the current
- document.
- </t>
- <t>glossary: Refers to a document providing a glossary of terms
- that pertain to the current document.
- </t>
- <t>copyright: Refers to a copyright statement for the current
- document. While this could also be given in the meta tags,
- this could refer to a formatted, legal document.
- </t>
- <t>chapter: Refers to a document serving as a chapter in a
- collection of documents.
- </t>
- <t>section: Refers to a document serving as a section in a
- collection of documents.
- </t>
- <t>subsection: Refers to a document serving as a subsection in a
- collection of documents.
- </t>
- <t>appendix: Refers to a document serving as an appendix in a
- collection of documents.
- </t>
- <t>help: Refers to a document offering help (more information,
- links to other sources information, etc.)
- </t>
- <t>bookmark: Refers to a bookmark. A bookmark is a link to a key
- entry point within an extended document. The title attribute may
- be used, for example, to label the bookmark. Note that several
- bookmarks may be defined in each document.
- </t>
- </list>
- </t>
- </section>
-
-<!-- IS DISCOURAGED IN XHTML, SO LET'S NOT START BAD STYLE
- <section title="StyleProperties">
- <t>A "StyleProperties" specifies style properties to be used for
- this element. This is used for the style attribute, which
- specifieds style information for the current element.
- In XHMTL the use of the style attribute is strongly discouraged
- in favor of the style element and external style sheets. Small
- devices don't generally support these in-line styles.
- </t>
- </section>
--->
-
- <section title="MediaDesc">
- <t>A "MediaDesc" describes one or several types of devices for
- which the given style is appropriate. Which devices are supported
- will need to be specified in a separate style sheet specification.
- The following set of device types, adapted from XHTML/HTML
- in CSS1, are currently recommended:
- <list style="symbols">
- <t>all: suitable for all devices.
- </t>
- <t>aural: suitable for speech synthesizers.
- </t>
- <t>braille: intended for braille tactile feedback devices.
- </t>
- <t>embossed: intended for paged braille printers.
- </t>
- <t>handheld: intended for handheld devices (characterized
- by a small, monochrome or colour display and limited bandwidth).
- </t>
- <t>print: intended for paged output to a printer or print
- preview on a screen.
- </t>
- <t>projection: intended for projected presentations (projectors
- or print to transparencies).
- </t>
- <t>screen: intended for non-paged, colour computer screens.
- </t>
- <t>tty: intended for fixed-pitch character grid displays (such
- as the teletypes or terminals).
- </t>
- <t>tv: for television-type devices with low resolution and
- limited scrollability.
- </t>
- </list>
- </t>
- </section>
-
- <section title="Text">
- <t>A "Text" describes a short, free form text being used for
- the "title" attribute.
- </t>
- </section>
-
<section title="URIs">
<t>A "URI" is a character string that conforms to the
specification of the Uniform Resource Identifier as defined in
@@ -507,19 +381,6 @@
</t>
</section>
-
- <section title="Core Attributes">
- <t>To cluster together the attributes that are common to
- most displayable elements, the "attrs" entity draws them together.
- As "i18n" is already a cluster, a "coreattrs" entity is defined,
- which groups together the other commonly used attributes for
- displayable elements, namely the unique identifier given in "id",
- the "class" attribute which provides a space-separated list of
- style sheet classes that the element belongs to, and the "title"
- attribute, which provides a short tooltip-like description
- for an element.
- </t>
- </section>
</section>
@@ -615,7 +476,7 @@
<!ELEMENT stream (import*)>
<!ATTLIST stream
id ID #IMPLIED
- basetime %Playbacktime; "0"
+ timebase %Playbacktime; "0"
utc %UTCtime; #IMPLIED
>
]]></artwork>
@@ -627,22 +488,22 @@
element.
</t>
- <t>The "basetime" attribute contains a playback time in seconds
+ <t>The "timebase" attribute contains a playback time in seconds
associated with the first data packet of the Annodex
bitstream. All other times in the CMML file MUST be calculated
- relative to this basetime. For example, a basetime of 300
+ relative to this timebase. For example, a timebase of 300
seconds npt for a video file implies that the first frame is
related to a play time of 300 seconds, and a clip with a start
time of 350 seconds is to be included 50 seconds into the
- Annodex bitstream. If no basetime (or no stream tag) is given,
- the basetime defaults to 0 npt. The basetime can be given as a
+ Annodex bitstream. If no timebase (or no stream tag) is given,
+ the timebase defaults to 0 npt. The timebase can be given as a
SMPTE or NPT time, or as a rational number as in 5/1300, but
not as a utc time.
</t>
<t>The "utc" attribute associates a calendar date and a
- wall-clock time with the basetime. It therefore provides a
- mapping of the basetime to a real-world clock time and is given
+ wall-clock time with the timebase. It therefore provides a
+ mapping of the timebase to a real-world clock time and is given
as a UTC time. If it is omitted, the start attribute in the
import tag, and the start and end attributes in clip tags MUST
NOT be specified as UTC times.
@@ -736,13 +597,13 @@
<t>The "start" attribute specifies a time in the output
Annodex bitstream at which the media bitstream will be
inserted. This time is specified with respect to the
- "basetime" attribute given in the "stream" element.
+ "timebase" attribute given in the "stream" element.
</t>
<t>The "end" attribute specifies a time in the output Annodex
bitstream at which the media bitstream will stop at the
latest. This time is also specified with respect to the
- "basetime" attribute given in the "stream" element. This
+ "timebase" attribute given in the "stream" element. This
attribute is not required when the full bitstream is used.
</t>
@@ -805,11 +666,9 @@
</t>
<figure>
<artwork><![CDATA[
-<!ENTITY % head.misc "(style|meta|link)*">
-
-<!ELEMENT head (%head.misc;,
- ((title, %head.misc;, (base, %head.misc;)?) |
- (base, %head.misc;, (title, %head.misc;))))>
+<!ELEMENT head (meta*,
+ ((title, meta*, (base, meta*)?) |
+ (base, meta*, (title, meta*)?)))>
<!ATTLIST head
%i18n;
id ID #IMPLIED
@@ -820,7 +679,7 @@
<t>The "head" tag must contain a "title" tag. It may contain one
"base" tag before or after the "title" tag and any number of
- "style", "meta", or "link" tags at any position.
+ "meta", or "link" tags at any position.
</t>
<t>The "%i18n;" attribute specifies the base language of the
@@ -935,113 +794,9 @@
</t>
</section>
-
-
- <!--**************-->
- <!-- Link element -->
- <!--**************-->
- <section title="The 'link' element">
-
- <t>The "link" element in the "head" element defines links to a
- related external resource. These resources are often used to augment
- the user agent's ability to process the current document.
- The "link" element is declared as follows:
- </t>
- <figure>
- <artwork><![CDATA[
-<!ELEMENT link EMPTY>
-<!ATTLIST link
- %attrs;
- href %URI; #IMPLIED
- type %ContentType; #IMPLIED
- rel %LinkTypes; #IMPLIED
- rev %LinkTypes; #IMPLIED
- media %MediaDesc; #IMPLIED
- >
- ]]></artwork>
- </figure>
- <t>The "attrs;" attribute covers the specification of the language
- of the title attribute, a unique identifing name, a reference to a
- style sheet specification, and a title attribute to provides a
- short description of the relationship between the current document
- and the one referred to in the "href" attributed.
- </t>
+ </section>
- <t>The "href" attribute contains a URI reference to a related
- external resource. These resources are often used to augment
- the user agent's ability to process the current document.
- </t>
-
- <t>The "type" attribute contains a media type specification for
- the linked document as per <xref target="ContentType">RFC 2045</xref>,
- e.g. "text/x-css-cmml".
- </t>
-
- <t>The "rel" attribute describes the relationship from the
- current document to the resource specified by the href attribute.
- The value of this attribute is a space-separated list of link
- types.
- </t>
-
- <t>The "rev" attribute describes a reverse link from the
- resource specified by the href attribute to the current document.
- The value of this attribute is a space-separated list of link types.
- </t>
-
- <t>The "media" attribute specifies the intended destination device
- for style information, if the href points to an external style sheet.
- It may be a single media descriptor or a comma-separated list.
- The default value for this attribute is "screen".
- </t>
-
- </section>
-
-
- <!--***************-->
- <!-- Style element -->
- <!--***************-->
- <section title="The 'style' element">
-
- <t>The "style" element in the "head" element contains an internally
- defined style sheet.
- The "style" element is declared as follows:
- </t>
- <figure>
- <artwork><![CDATA[
-<!ELEMENT style (#PCDATA)>
-<!ATTLIST style
- %i18n;
- id ID #IMPLIED
- title %Text; #IMPLIED
- type %ContentType; #REQUIRED
- media %MediaDesc; #IMPLIED
- xml:space (preserve) #FIXED 'preserve'
- >
- ]]></artwork>
- </figure>
-
- <t>The "i18n;" attribute containt the language of the title attribute.
- </t>
-
- <t>The "title" attribute contains a short description of the style in
- human readable form.
- </t>
-
- <t>The "type" attribute contains a media type specification for
- the linked document as per <xref target="ContentType">RFC 2045</xref>,
- e.g. "text/x-css-cmml".
- </t>
-
- <t>The "media" attribute specifies the intended destination device
- for the style information.
- It may be a single media descriptor or a comma-separated list.
- The default value for this attribute is "screen".
- </t>
-
- </section>
-
- </section>
<!--****************-->
<!-- Clip element -->
@@ -1059,9 +814,10 @@
<figure>
<artwork><![CDATA[
-<!ELEMENT clip ((meta|style)*, a?, img?, desc?)>
+<!ELEMENT clip (meta*, a?, img?, desc?)>
<!ATTLIST clip
- %attrs;
+ %i18n;
+ id ID #IMPLIED
track CDATA "default"
start %Timestamp; #REQUIRED
end %Timestamp; #IMPLIED
@@ -1069,22 +825,22 @@
]]></artwork>
</figure>
- <t>Any number of "meta" or "style" elements may appear in a clip, and at
+ <t>Any number of "meta" elements may appear in a clip, and at
most one "a" element, one "img" element, and one "desc"
- element. Though "meta", "style", "a", "img", and "desc" tag are given in
+ element. Though "meta", "a", "img", and "desc" tag are given in
a specific order in the DTD, their order is actually random.
</t>
- <t>The "%i18n;" attributes part of the "%attrs;" attributes specify
- the base language for all the clip's attribute values and content
- elements. Also, a unique identifying name is specified for the clip
- in the "id" attribute. This name can be used in URIs that point
- either to the CMML file or the Annodex bitstream created from it,
- and allow to point straight at the clip. This may either be done
- as a URI fragment or URI query specification. The "class" attribute
- provides a space-separated list of style sheet classes, and the
- "title" attribute a short tooltip-like clip description.
+ <t>A "clip" element defines a unique identifying name for the
+ clip in its "id" attribute. This name can be used in URIs that
+ point either to the CMML file or the Annodex bitstream created
+ from it, and allow to point straight at the clip. This may
+ either be done as a URI fragment or URI query specification.
</t>
+
+ <t>The "%i18n;" attribute specifies the base language for all
+ the clip's attribute values and content elements.
+ </t>
<t>The "track" attribute specifies the track that this clip
belongs to. An annotation track is a set of clips that belong
@@ -1100,7 +856,7 @@
<t>The "start" and "end" attributes specify the time range
during which the clip element is defined. This time range is
- specified with respect to the "basetime" and "utc" attributes
+ specified with respect to the "timebase" and "utc" attributes
given in the "stream" tag. If the "stream" tag does not contain
a "utc" specification, "start" and "end" times are not allowed
to be given in UTC time. "start" is a required attribute because
@@ -1123,21 +879,7 @@
</section>
- <!--***************-->
- <!-- Style element -->
- <!--***************-->
- <section title="The 'style' element">
- <t>The "style" element is specified above in the "head"
- section. While a "style" element in the "head" tag provides
- style sheet information for the complete Annodex bitstream, the
- "style" elements in a "clip" tag only provide style sheet information
- for the clip.
- </t>
-
- </section>
-
-
<!--****************-->
<!-- Anchor element -->
<!--****************-->
@@ -1154,18 +896,22 @@
<artwork><![CDATA[
<!ELEMENT a (#PCDATA)>
<!ATTLIST a
- %attrs;
+ %i18n;
+ id ID #IMPLIED
+ class CDATA #IMPLIED
href %URI; #REQUIRED
>
]]></artwork>
</figure>
- <t>The "attrs" attributes specify internationalisation of
- the anchor's attribute values and of the anchor text, style
- sheet class, unique id, and a short, textual description of
- the hyperlink to be given e.g. in tooltips.
- </t>
+ <t>The internationalisation attributes specify the language of
+ the anchor's attribute values and of the anchor text.
+ </t>
+ <t>The "class" attribute allows to override style sheet
+ defaults for this anchor instance.
+ </t>
+
<t>The "href" attribute specifies the location of a Web
resource given through a URI. It thus defines a link between
the current clip and a resource which the author believes to
@@ -1206,18 +952,17 @@
<artwork><![CDATA[
<!ELEMENT img EMPTY>
<!ATTLIST img
- %attrs;
+ %i18n;
+ id ID #IMPLIED
src %URI; #REQUIRED
alt CDATA #IMPLIED
>
]]></artwork>
</figure>
- <a>The "attrs" attributes specify internationalisation of
- the image's attribute values, provide an "id" attribute, a
- short "title" text, and a style sheet "class" for formatting
- the layout of the image.
- </a>
+ <a>The internationalisation attributes specify the language of
+ the image's attribute values.
+ </a>
<t>The "src" attribute specifies the location of an image on
the Web given through a URI.
@@ -1245,16 +990,23 @@
<artwork><![CDATA[
<!ELEMENT desc (#PCDATA)>
<!ATTLIST desc
- %attrs;
+ %i18n;
+ id ID #IMPLIED
>
]]></artwork>
</figure>
+ <t>For extracting a short text from the "desc" element as
+ needs to be displayed in a table of contents or as caption,
+ the first few characters of the description will be taken. It
+ is therefore recommended to place a short meaningful summary
+ sentence at the beginning of the description when authoring
+ annotations.
+ </t>
+
<t>The internationalisation attributes specify the language of
- the text in the description, the "id" attribute a unique identifier
- for the element, the "class" attribute a style-sheet mapping, and
- the "title" attribute a brief description to be displayed in e.g.
- a table of contents or as caption.
+ the text in the description snf the "id" attribute a unique identifier
+ for the element.
</t>
</section>
@@ -1517,7 +1269,7 @@
<t>Granule rate numerator & denominater: 8 Byte integer
number each. They represent the temporal resolution of the
logical bitstream in Hz given as a rational number in the
- same way as the fishead basetime field above.
+ same way as the fishead timebase field above.
</t>
<t>Granuleshift: a 1 Byte integer number describing whether to
partition the granule_position into two for the CMML logical
@@ -1554,7 +1306,7 @@
</t>
<t>If CMML is encapsulated in Ogg without the skeleton bitstream,
- it potentially loses time information. The basetime will then be
+ it potentially loses time information. The timebase will then be
mapped always to 0 and utc time mappings cannot be represented.
It also loses all the message header fields which contain
machine-readable meta information on the physical bitstream.
@@ -1589,22 +1341,22 @@
<section title="Creating the skeleton ident packet">
- <t>The skeleton ident packet receives the "basetime" and the
+ <t>The skeleton ident packet receives the "timebase" and the
"utc" field information from the "stream" tag.
</t>
- <t>"Basetime numerator & denominator": if the "basetime"
+ <t>"Timebase numerator & denominator": if the "timebase"
attribute is given in a CMML instance document, it MUST be
represented in the skeleton ident header in the fields
- "Basetime numerator" and "Basetime denominator". It is converted
+ "Timebase numerator" and "Timebase denominator". It is converted
from a possible NPT or SMPTE representation to a rational number
to be stored in these fishead fields.
</t>
- <t>"Presentationtime numerator & denominator": if the "basetime"
+ <t>"Presentationtime numerator & denominator": if the "timebase"
attribute is given in a CMML instance document, it also
determines the presentation time of the interleaved bitstream and
- the "Basetime numerator" and "Basetime denominator" MUST be
+ the "Timebase numerator" and "Timebase denominator" MUST be
copied to the "Presentationtime numerator" and "Presentationtime
denominator" fields of the skeleton ident header.
</t>
@@ -1724,8 +1476,8 @@
therefore be lost on encoding.
</t>
- <t>basetime: this attribute maps to the skeleton
- ident header fields "Basetime numerator" and "Basetime
+ <t>timebase: this attribute maps to the skeleton
+ ident header fields "Timebase numerator" and "Timebase
denominator".
</t>
@@ -1838,12 +1590,12 @@
<t>The creation of a "stream" tag is not necessary to extract the
content of the CMML logical bitstream and thus a textual representation
of the interleaved bitstream. However, if the Annodex bitstream has
- a non-zero "basetime" or a non-null "utc" time in the skeleton
+ a non-zero "timebase" or a non-null "utc" time in the skeleton
ident header, a "stream" tag will allow accurate time information
in the CMML file and SHOULD be created with these attribute values.
</t>
- <t>If a "stream" tag is created with the "basetime" and "utc" attributes,
+ <t>If a "stream" tag is created with the "timebase" and "utc" attributes,
it is empty by default. A ripping application MAY however extract all
the data bitstreams out of the Annodex bitstream into files, and then
reference these files in the "src" attribute of "import" tags.
@@ -1868,7 +1620,7 @@
<t>A stream tag will thus roughly be created like this:
<figure>
<artwork><![CDATA[
-<stream basetime="[Basetime]" utc="[UTC]">
+<stream timebase="[Timebase]" utc="[UTC]">
<import id="[ID]"
granulerate="[Granulerate numerator/Granulerate denominator]"
contenttype="[Content-type message header value]"
@@ -2564,7 +2316,7 @@
<cmml lang="en">
-<stream basetime="0">
+<stream timebase="0">
<import contenttype="video/mpeg" src="fish.mpg" start="0"/>
</stream>
--
silvia
More information about the cvs-annodex
mailing list