Guide to the DocBook DTD
Prev		Next

CO

Name

CO -- Callout area specification embedded in a code example

Content Model

  EMPTY

Attributes

This element has common and Role attributes.

Name	Value(s)	Type	Default Value
Label	CDATA	#IMPLIED
Linkends	IDREFS	#IMPLIED

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Description

CO is an empty element holding information describing a one-dimensional callout area specification embedded in a code example. It has Label and Linkends attributes, and common attributes with ID required.

Processing Expectations

CO appears in the code example, either in a ProgramListing or a Screen; at or pointing graphically to its position, the value of the Label attribute should be rendered. Its Linkends attribute holds pointers to related information; its ID attribute allows the construction of pointers to its location. Both methods may be used to link callouts with locations in code examples, but CO should not be used within ProgramListingCO or ScreenCO; if it is, the results are undefined.

Parents

These elements contain CO: ProgramListing, Screen.

Attributes

Label: Label holds an identifying number or string to be output in some manner when the element it is applied to is rendered.
Linkends: IDs of targets pointed to by this element.

Examples

<SECT1>
<TITLE>ProgramListing with CO</TITLE>
<PROGRAMLISTING>
<SYSTEMITEM CLASS="PROMPT">%</SYSTEMITEM><CO LABEL="1" LINKENDS="sco123" ID="pro123"> <USERINPUT>make install</USERINPUT>
install -c -m 0644 rgb.txt /usr/lib/X11
install -c -m 0644 rgb.dir /usr/lib/X11
install -c -m 0644 rgb.pag /usr/lib/X11
install -c -s showrgb /usr/lib/X11
install in<CO LABEL="2" LINKENDS="sco124" ID="pro124"> ./rgb done

</PROGRAMLISTING>
<BRIDGEHEAD>Comments on the Screen Shown Above</BRIDGEHEAD>
<PARA ID="sco123">Note % prompt.</PARA>
<PARA ID="sco124">Note use of install without flag.</PARA>
</SECT1>

Prev	Home	Next
CmdSynopsis	Up	Collab