« Return to Thread: refentry or section

RE: refentry or section

by David Cramer (Tech Pubs) :: Rate this Message:

Reply to Author | View in Thread

Not sure it justifies the extra markup, but in terms of what the xsls
do, one thing you get with a reference and refentries that you don't
with a chapter and sections is additional summary info (the refpurpose)
in the toc. You can see this in the toc for tdg under "I. DocBook
Element Reference" where the toc has the element name and the refpurpose
instead of just the section's title:
http://www.docbook.org/tdg/en/html/docbook.html

On the other hand, the <reference> has to be the child of a book (i.e.
it's like a <chapter>). I've found myself wanting to use a <reference>
as if it were a <section>.

David

>
> So to sum up here, I feel as though I _should_ use
> references, refsections and refentries for my api
> information, and chapters/sections/etc for my other content,
> _BUT_ I don't see that much advantage in doing so, and you
> also accrue some extra markup for no great reason.
>
> Any more thoughts?

---------------------------------------------------------------------
To unsubscribe, e-mail: docbook-apps-unsubscribe@...
For additional commands, e-mail: docbook-apps-help@...

 « Return to Thread: refentry or section