DocBook: The Definitive Guide

docbook: the definitive guide
By Norman Walsh & Leonard Muellner
1st Edition October 1999
1-56592-580-7, Order Number: 5807
652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide


SynopFragmentRef -- A reference to a fragment of a command synopsis


Declared Content

SynopFragmentRef ::= RCDATA


Common attributes





Tag Minimization

Both the start- and end-tags are required for this element.


A complex CmdSynopsis can be made more manageable with SynopFragments. Rather than attempting to present the entire synopsis in one large piece, parts of the synopsis can be extracted out and presented elsewhere.

At the point where each piece was extracted, insert a SynopFragmentRef that points to the fragment. The content of the SynopFragmentRef will be presented inline.

The extracted pieces are placed in SynopFragments at the end of the CmdSynopsis.


The content model of SynopFragmentRef is unique in the SGML version of DocBook because it contains RCDATA declared content. What this means is that all markup inside a SynopFragmentRef is ignored, except for entity references.

How, you might ask, is this different from a content model that includes only #PCDATA? The difference is only apparent when you consider inclusions. Recall that an inclusion provides a list of elements that can occur anywhere inside an element. So, for example, the fact that Chapter lists IndexTerm as an inclusion means that IndexTerm can legally occur inside of a SynopFragmentRef that's nested inside a chapter, even if the content model of SynopFragmentRef does not explicitly allow IndexTerms. Making the content RCDATA ensures that the markup will not be recognized, even if it's allowed by inclusion. A neat trick.

XML does not support RCDATA.

Processing expectations

Formatted as a displayed block.

The presentation system is responsible for generating text that makes the reader aware of the link. This can be done with numbered bullets, or any other appropriate mechanism.

Online systems have additional flexibility. They may generate hot links between the references and the fragments, for example, or place the fragments in pop-up windows.


These elements contain SynopFragmentRef: Arg, Group.



Linkend points to the SynopFragment referenced.

See Also

Arg, CmdSynopsis, Group, RefSynopsisDiv, SBR, SynopFragment


For examples, see SynopFragment.


Back to: DocBook: The Definitive Guide

O'Reilly Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts
International | About O'Reilly | Affiliated Companies

© 1999, O'Reilly & Associates, Inc.

DocBook. The Definitive Guide
DocBook 5: The Definitive Guide
ISBN: 0596805020
EAN: 2147483647
Year: 1999
Pages: 412
Authors: Walsh Norman, Richard L. Hamilton

Similar book on Amazon
DocBook XSL: The Complete Guide (4th Edition)
DocBook XSL: The Complete Guide (4th Edition)
XSLT, 2nd Edition
XSLT, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XML: Visual QuickStart Guide (2nd Edition)
XML: Visual QuickStart Guide (2nd Edition) © 2008-2017.
If you may any questions please contact us: