Re: [docbook] Docbook guidance

["Paul A. Hoadley" <paulh@logicsquad.net>]

On Tue, Feb 17, 2004 at 12:07:46PM -0800, Ren? Hach? wrote:

> -Many cross-references and links: although I understand the basic
> concept of linking and cross-referencing with docbook, I am unclear
> on how to implement it. Does anyone know of good tutorials online?

Norman Walsh's 'DocBook: The Definitive Guide', and for later when you
are producing output, Bob Stayton's 'DocBook XSL: The Complete Guide'
are available in print and online:

http://docbook.org/tdg/en/html/docbook.html

http://www.sagehill.net/book-description.html

> -Versioning: I would like to be able to track different versions of
> the document as it evolves as well as the date of those changes. I
> am unclear of what attributes to use for this purpose, if possible.

Have a look at the 'revhistory' element:

http://docbook.org/tdg/en/html/revhistory.html

> -Ouput Media: the document will be ouputed as a personal website,
> suitable for handheld and printing. I assuming this is not a problem
> for docbook.

No problem.

> -Notes and sidebars: I know docbook has sidebars, notes and example
> elements, all of which I will use extensively. Is it possible
> through attributes to categorize them differently so they get a
> different visual treatment from the stylesheet? If so, what
> attributes (or other means) is appropriate for such a task.

Conventionally people use the 'role' attribute on these elements.  You
then write a custom template for the element (easier than it
sounds---see Bob's book) for each of your roles.

[Others will be able to answer the questions I have not.]


-- 
Paul.

mailto:paulh@logicsquad.net
mailto:phoadley@maths.adelaide.edu.au