ODF New Proposal Template

Summary

Proposal owner:

Svante Schubert

Proposal short name:

Change Proposal for ODF 1.2 using URL fragment identifiers for ODF media types

Rationale

Use cases:

When using ODF documents in a web environment, there is often the problem to refer to a certain subset of an ODF‚ document:
a heading, paragraph, table, cell, graphic,...

The solution would be to specify for our ODF media types a fragment identifier as HTML had done it before, just extended for usage for a package format. 

A single ID as fragment identifer (as in HTML) would not be sufficient as we might have multiple XML files within the package with the same xml:id. Therefore we need in addition the path to the file to make the ID unique.

According to the URI RFC (http://www.rfc-editor.org/rfc/rfc3986.txt)

URI         = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
fragment      = *( pchar | "/" | "?" )

we could define fragment identifier for ODF 1.2 as follows:

A fragment identifier for all OpenDocument format mediatype (odf-fragment) refers to a resource within the OpenDocument package.

An odf-fragment consists either of a stream-path or a stream-path and a fragment identifier of a stream.

(An ODF URL with fragment identifier might look like:
http://www.oasis-open.org/committees/download.php/19275/OpenDocument-v1.0ed2-cs1.odt#/content.xml?id1)

The fragment within the ODF fragment has to be resolved accordingly to the mediatype of the stream.
(For example for 
http://www.oasis-open.org/committees/download.php/19275/OpenDocument-v1.0ed2-cs1.odt#/test.html?id1
id1 would be resolved as an fragment identifier for HTML. )


SYNTAX:
The syntax of ODF fragment identifiers is:

odf-fragment = [ "#"  stream-path  | ( stream-path "?" fragment ) |  xml-id ]
stream-path =  "/" pchar *( pchar  |  "/" )
fragment      = *( pchar  | "/" | "?" )
xml-id     =  see W3C xml:id spec


ABBREVIATION SYNTAX:
As general the xml:id of the content.xml will be used, an abbreviation would ease the usage:

An xml:id without path shall always belong to the root "/content.xml" stream.

The following two URLs therefor would be considered as equal:
http://www.oasis-open.org/committees/download.php/19275/OpenDocument-v1.0ed2-cs1.odt#/content.xml?id1
http://www.oasis-open.org/committees/download.php/19275/OpenDocument-v1.0ed2-cs1.odt#id1

Further examples:

http://www.oasis-open.org/committees/download.php/19275/OpenDocument-v1.0ed2-cs1.odt#/Configurations2/accelerator/current.xml
http://www.oasis-open.org/committees/download.php/19275/OpenDocument-v1.0ed2-cs1.odt#/styles.xml?id1
http://www.oasis-open.org/committees/download.php/19275/OpenDocument-v1.0ed2-cs1.odt#id1
http://www.oasis-open.org/committees/download.php/19275/OpenDocument-v1.0ed2-cs1.odt#/Pictures/Svante.png

Alternatives considered:

No adequate standard known to fulfill this task.  

Requested changes to the ODF Standard

Text changes/additions (please state section numbers):

The text changes are in progress and will be submitted on Wednesday the 10th of December latest.

Schema changes/additions:

The Relax NG schema changes are in progress and will be submitted on Wednesday the 10th of December latest.

Impacts

Conformance:

No mandatory features or behaviors to ODF documents or applications had been added.

Backwards compatibility:

No compatibility problems as it is addition to the new ODF 1.2 metadata feature.

Accessibility impact:

No Accessibility impact

Workflow (to be filled in by TC Chairs)

Category: CategoryNewProposal

Date Proposal initially made:

Dates Proposal discussed on TC calls:

Date vote is requested:

Date vote is held:

Results of vote:

Change_Proposal_for_ODF_1.2_using_URL_fragment_identifiers_for_ODF_media_types (last edited 2009-08-12 18:04:28 by localhost)