OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

docbook message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]

Subject: DOCBOOK: Re: ambiguity in <xref> regarding cross-reference text

Hash: SHA1

/ "Robert P. J. Day" <rpjday@mindspring.com> was heard to say:
|   again, nitpicky, but in the online TDG 2.0.7, in the explanation
| of <xref>, we read:
|   "... If the Endterm attribute is specified, the content of the
|   element pointed by by Endterm must be used as the text of the
|   cross-reference ... If the object pointed to has a specified
|   XRefLabel, that should be used as the cross-reference text."
|   and if both happen to be true?  it's not clear from the <xref>
| page which takes precedence.

This section now reads:

<refsect2 id="dbreproc.xref"><title>Processing expectations</title>

<para>Under ordinary circumstances, the <sgmltag>xref</sgmltag>
points to the some element with its
<sgmltag class="attribute">linkend</sgmltag> attribute and the processing system
generates appropriate cross reference text. There are three
ways for the author to influence the generated text:</para>

<para>If the <sgmltag class='attribute'>endterm</sgmltag> attribute is specified
on <sgmltag>xref</sgmltag>, the
content of the element pointed to by <sgmltag class='attribute'>endterm</sgmltag>
will be used as the text of the cross-reference.

<para>Otherwise, if the object <emphasis>pointed to</emphasis> has a
specified <sgmltag class='attribute'>XRefLabel</sgmltag>, the content of
that attribute will be used as the cross-reference text.

<para>Finally, the author may specify a keyword (or other information) in the
<sgmltag class="attribute">xrefstyle</sgmltag> attribute. Unlike
<sgmltag class="attribute">endterm</sgmltag> and
<sgmltag class="attribute">xreflabel</sgmltag> which have rigid semantics,
the content of the <sgmltag class="attribute">xrefstyle</sgmltag> attribute is simply
additional information for the processing system. What effect it has, if any,
is dependent on the processing system.</para>


                                        Be seeing you,

- -- 
Norman Walsh <ndw@nwalsh.com>      | Taste ripens at the expense of
http://www.oasis-open.org/docbook/ | happiness.--Jules Renard
Chair, DocBook Technical Committee |
Version: GnuPG v1.0.6 (GNU/Linux)
Comment: Processed by Mailcrypt 3.5.7 <http://mailcrypt.sourceforge.net/>


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]

Powered by eList eXpress LLC