Re: [docbook-apps] refentry or section

[Denis Bradford <denis.bradford@verizon.net>]

Sorry, I meant to say, the analog of a section is a refsection.

Also, I think a reference can be a good choice for an API, for the 
reason that you guessed: it's designed to give you a regular structure 
that makes information easy to up. I think that's what most people do 
with API docs. Non-reference components (chapters, articles), are less 
restrictive, more suitable (I would argue) for more narrative or 
variable content.




Samuel Wright wrote:
> Hi All,
> 
> I'm documenting some software apis, and was thinking of using sections
> (rather than sect1,2, etc due to possible reuse). Have since sound
> references and refentries.
> 
> Is the main advantage of using references and refentries that you can
> format them in a different manner to sections containing other text?
> Is that a strong enough reason to use them? What do you all use for
> apis in docbook?
> 
> Thanks in advance for any thoughts
> 
> S
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: docbook-apps-unsubscribe@lists.oasis-open.org
> For additional commands, e-mail: docbook-apps-help@lists.oasis-open.org
> 
>