Whole document tree


www.fifi.org
    Documentation
        Manpages
        GNU Info
        Debian document tree
        Whole document tree
    Trigance web page
    Public services
    User info
    Mailing lists
    Secure server
    Multilingual usage
 

Copyright (C) 2000-2012
Philippe Troin
<webmaster@fifi.org>.

Validate HTML
Validate CSS

    

Whole document tree

Callout
Guide to the DocBook DTD
PrevNext

Callout

Name

Callout -- Description linked to Areas in a graphic or code example

Content Model

  (CalloutList | GlossList | ItemizedList | OrderedList
  | SegmentedList | SimpleList | VariableList | Caution
  | Important | Note | Tip | Warning | LiteralLayout
  | ProgramListing | ProgramListingCO | Screen | ScreenCO
  | ScreenShot | Synopsis | CmdSynopsis | FuncSynopsis
  | FormalPara | Para | SimPara | Address | BlockQuote
  | Graphic | GraphicCO | InformalEquation
  | InformalExample | InformalTable | Equation | Example
  | Figure | Table | MsgSet | Procedure | Sidebar | Anchor
  | BridgeHead | Comment | Highlights | Abstract
  | AuthorBlurb
  | Epigraph)+

Attributes

This element has common and Role attributes.

NameValue(s)TypeDefault Value
AreaRefsIDREFS#REQUIRED 

Tag Minimization

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

Description

A description that is linked to a region or collection of regions in a graphic or code example. Callout has AreaRefs and common attributes.

Parents

Callout occurs in CalloutList.

Children

Callout contains these elements: Abstract, Address, Anchor, AuthorBlurb, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, Highlights, Important, InformalEquation, InformalExample, InformalTable, ItemizedList, LiteralLayout, MsgSet, Note, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, Screen, ScreenCO, ScreenShot, SegmentedList, Sidebar, SimPara, SimpleList, Synopsis, Table, Tip, VariableList, Warning.

Attributes

AreaRefs

AreaRefs hold the IDs of one or more Areas or AreaSets described by this Callout.

Examples

<PROGRAMLISTINGCO>
<AREASPEC UNITS="LINECOLUMN">
<AREA ID="sco123" COORDS="1 1">
<AREA ID="sco124" COORDS="6 9">
</AREASPEC>
<PROGRAMLISTING>
<SYSTEMITEM CLASS="PROMPT">%</SYSTEMITEM> <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 ./rgb done

</PROGRAMLISTING>
<CALLOUTLIST>
<TITLE>Comments on the Screen Shown Above</TITLE>
<CALLOUT AREAREFS="sco123">
<PARA>Note % prompt.</PARA>
</CALLOUT>
<CALLOUT AREAREFS="sco124">
<PARA>Note use of install without flag.
</PARA>
</CALLOUT>
</CALLOUTLIST>
</PROGRAMLISTINGCO>
<GRAPHICCO>
<AREASPEC UNITS="CALSPAIR">
<AREA ID="co123" LABEL="1" COORDS="100,100 550,935">
<AREA ID="co124" LABEL="2" COORDS="1500,1500 2175,3184">
</AREASPEC>
<GRAPHIC FILEREF="gr061ch05t2.gif" FORMAT="GIF"></GRAPHIC>
<CALLOUTLIST>
<TITLE>Comments on the Picture Above</TITLE>
<CALLOUT AREAREFS="co123">
<PARA>A bit too far down and left</PARA>
</CALLOUT>
<CALLOUT AREAREFS="co124">
<PARA>This is the most interesting part of the diagram.
</PARA>
</CALLOUT>
</CALLOUTLIST>
</GRAPHICCO>
<programlistingco>
<areaspec>
<area id="ex.plco.ret" coords=12>
<area id="ex.plco.dest" coords=12>
<areaset id="ex.plco.const" coords="">
  <area id="ex.plco.c1" coords=4>
  <area id="ex.plco.c2" coords=8>
</areaset>
</areaspec>
<programlisting>
sub do_nothing_useful {
    my($a, $b, $c);

    $a = new A;
    
    $a->does_nothing_either();

    $b = new B; 

    $c = "frog";

    return ($a, $c);
}
</programlisting>
<calloutlist>
<callout arearefs="ex.plco.const">
<para>
These are calls to the constructor <function>new</function> 
in the object classes.
</para>
</callout>
<callout arearefs="ex.plco.ret">
<para>
This function returns a two-element list.
</para>
</callout>
<callout arearefs="ex.plco.dest">
<note>
<para>
The <emphasis>destructor</emphasis> (<function>DESTROY</function>) 
for the object <literal>$b</literal> will be called automatically for 
this object as there can be no other references to it outside 
this function.
</para>
</note>
</callout>
</calloutlist>
</programlistingco>
PrevHomeNext
BridgeHeadUpCalloutList