ODF New Proposal Template

Summary

Proposal owner:

Doug Mahugh

Proposal short name:

ref-link for ref marks

Rationale

Use cases:

This is a proposal to add the ability to provide a hyperlink to the source of the reference for bookmark-refs, note-refs, etc.  At the moment, the ODF standard does not specifically state that references should be linked to their source.  However, it would be beneficial to allow end users to decide whether their referenced text is a clickable link or not.

Alternatives considered:

There are a few alternatives that were considered.  The processor can always or never link references to the source.  If the processor never links to the reference, the end user could apply a hyperlink (to the source location) around the referenced text.

Requested changes to the ODF Standard

Text changes/additions (please state section numbers):

Add the following attribute to sections 6.7.5 <text:reference-ref>, 6.7.6 <text:bookmark-ref>, and 6.7.7 <text:note-ref>

<text:ref-link>

------------------------
Add a new section after 18.1220 text:reference-format

18.1221 text:ref-link
The text:ref-lnk attribute specifies if an application should treat referenced text as a link to its source.

If the value of text:ref-link is true, then the referenced text can act as a link to its source

If the value of text:ref-link is false, then the referenced text does not act as a link to its source

The default value for this attribute is false.

Schema changes/additions:

<define name="paragraph-content" combine="choice">
    <element>
        <choice>
            <name>text:reference-ref</name>
            <name>text:bookmark-ref</name>
        </choice>
        <interleave>
            <ref name="text-common-ref-content"/>
            <ref name="text-ref-content"/>
        </interleave>
    </element>
</define>

<define name="paragraph-content" combine="choice">
    <element name="text:note-ref">
        <interleave>
            <ref name="text-common-ref-content"/>
            <ref name="text-note-ref-content"/>
            <ref name="text-ref-content"/>
        </interleave>
    </element>
</define>

<define name="paragraph-content" combine="choice">
    <element name="text:sequence-ref">
        <interleave>
            <ref name="text-common-ref-content"/>
            <ref name="text-sequence-ref-content"/>
        </interleave>
    </element>
</define>

<define name="text-common-ref-content" combine="interleave">
    <text/>
</define>

<define name="text-common-ref-content" combine="interleave">
    <optional>
        <attribute name="text:ref-name">
            <ref name="string"/>
        </attribute>
    </optional>
</define>

<define name="text-note-ref-content" combine="interleave">
    <ref name="text-note-class"/>
</define>

<define name="text-ref-content" combine="interleave">
    <optional>
        <attribute name="text:reference-format">
            <choice>
                <value>page</value>
                <value>chapter</value>
                <value>direction</value>
                <value>text</value>
            </choice>
        </attribute>
    </optional>
</define>

<define name="text-ref-content" combine="interleave">
    <optional>
        <attribute name="text:ref-link" a:defaultValue=”false”>
                <ref name=”boolean” />
        </attribute>
    </optional>
</define>

<define name="text-sequence-ref-content" combine="interleave">
    <optional>
        <attribute name="text:reference-format">
            <choice>
                <value>page</value>
                <value>chapter</value>
                <value>direction</value>
                <value>text</value>
                <value>category-and-value</value>
                <value>caption</value>
                <value>value</value>
            </choice>
        </attribute>
    </optional>
</define>

Impacts

Conformance:

No impact on conformance (optional attribute).

Backwards compatibility:

None; existing ODF processors can ignore this (optional) attribute and apply their existing application behavior.

Accessibility impact:

No impact on accessibility.

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:

ref-link_for_ref_marks (last edited 2009-08-12 18:04:28 by localhost)