From: Joaquim B. <px...@gm...> - 2007-06-08 19:27:41
|
On 2007/06/08, at 13:51, Lea Wiemann wrote: > I'm not sure how to support transition text at the beginning of a > sub-document. (I assume "at the beginning" means after the title, > right? Because text that goes before the title could as well be > specified as transition text after the previous section.) Perhaps a > :beginning: option? DITA has the concept of "shortdesc" (for short description) which is used to summarize or introduce a topic. It displays right after the title, although DITA also uses the shortdesc in other contexts. I checked the docutils docs, and it seems that field lists can have complex blocks as contents. In particular, docs/user/rst/quickref.html has the following example: :Authors: Tony J. (Tibs) Ibbs, David Goodger (and sundry other good-natured folks) So, perhaps the introductory and transitional text can just be introduced by extra fields? For example: .. subdocument:: product1-functionA.txt :title: Function A :introduction: Product 1 supports function A, but beware of the limitation Y. :transition: If you are interested in function A, you should also be aware of the following alternatives: - Function C with option X - Function D with Z turned off |