Referring to Appendices from within a chapter

Hi,

I'm new to docbook (literally started with it yesterday),
and am writing up
some system documentation using a book/chapter model.

I've created a few appendices, and was wondering how to
refer (link) to them
using the '<appendix id="name">' they were
created with instead of doing a
<link> to an <xref>, or whether that is the
right approach to take at all.

Thanks

Stuart J. Browne


------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-unsubscribelists.oasis-open.org
For additional commands, e-mail: docbook-helplists.oasis-open.org

I recommend using Olinks. See Bob Stayton's chapter from
DocBook XSL:
The Definitive Guide: http
://www.sagehill.net/docbookxsl/Olinking.html

Regards,
Jeff Powanda

-----Original Message-----
From: Stuart J. Browne [mailto:sjbrownebluebottle.com] 
Sent: Tuesday, July 24, 2007 6:00 PM
To: docbooklists.oasis-open.org
Subject: [docbook] Referring to Appendices from within a
chapter

Hi,

I'm new to docbook (literally started with it yesterday),
and am writing
up
some system documentation using a book/chapter model.

I've created a few appendices, and was wondering how to
refer (link) to
them
using the '<appendix id="name">' they were
created with instead of doing
a
<link> to an <xref>, or whether that is the
right approach to take at
all.

Thanks

Stuart J. Browne


------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-unsubscribelists.oasis-open.org
For additional commands, e-mail: docbook-helplists.oasis-open.org


------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-unsubscribelists.oasis-open.org
For additional commands, e-mail: docbook-helplists.oasis-open.org

Well, olinks may not be necessary in this case.  Is the
appendix in the 
same document as the text referencing the appendix?  If so,
then you can 
use an xref element with a linkend attribute matching the id
value of the 
appendix:

<xref linkend="name"/>

Then the stylesheet will generate the cross reference text
and make it a 
hot link.

Bob Stayton
Sagehill Enterprises
DocBook Consulting
bobssagehill.net


----- Original Message ----- 
From: "Jeff Powanda" <jpowandavocera.com>
To: "Stuart J. Browne" <sjbrownebluebottle.com>
Cc: <docbooklists.oasis-open.org>
Sent: Tuesday, July 24, 2007 6:54 PM
Subject: RE: [docbook] Referring to Appendices from within a
chapter



I recommend using Olinks. See Bob Stayton's chapter from
DocBook XSL:
The Definitive Guide: http
://www.sagehill.net/docbookxsl/Olinking.html

Regards,
Jeff Powanda

-----Original Message-----
From: Stuart J. Browne [mailto:sjbrownebluebottle.com]
Sent: Tuesday, July 24, 2007 6:00 PM
To: docbooklists.oasis-open.org
Subject: [docbook] Referring to Appendices from within a
chapter

Hi,

I'm new to docbook (literally started with it yesterday),
and am writing
up
some system documentation using a book/chapter model.

I've created a few appendices, and was wondering how to
refer (link) to
them
using the '<appendix id="name">' they were
created with instead of doing
a
<link> to an <xref>, or whether that is the
right approach to take at
all.

Thanks

Stuart J. Browne


------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-unsubscribelists.oasis-open.org
For additional commands, e-mail: docbook-helplists.oasis-open.org


------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-unsubscribelists.oasis-open.org
For additional commands, e-mail: docbook-helplists.oasis-open.org





------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-unsubscribelists.oasis-open.org
For additional commands, e-mail: docbook-helplists.oasis-open.org

> Well, olinks may not be necessary in this case.  Is the

> appendix in the same document as the text referencing
the
> appendix?  If so, then you can use an xref element with
a
> linkend attribute matching the id value of the
appendix:
> 
> <xref linkend="name"/>
> 
> Then the stylesheet will generate the cross reference
text 
> and make it a hot link.
> 
> > I recommend using Olinks. See Bob Stayton's
chapter from DocBook XSL:

Yes, the appendix is in the same document.

I stumbled across and thus am currently using '<link
linkend="appendix_id">', and it seems to work.

Stuart

<!-- chapter-installation.xml -->
<chapter id='installation'>
    <title>Installation / Implementation
Process</title>
    <section>
        <title>All Nodes</title>
        <para>
            All systems should ... <link
linkend="packagelist">base package
list</link>.
        </para>
...
    </section>
</chapter>

<!-- appendix-package-listing.xml -->
<appendix id='packagelist'>
    <title>Package List</title>
    <section>
        <title>Base package list</title>
        <para>
           
<programlisting>&base_pkg_list;</programlisting
>
        </para>
    </section>
...
</appendix>


------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-unsubscribelists.oasis-open.org
For additional commands, e-mail: docbook-helplists.oasis-open.org