[Boost-docs] [quickbook] Problems with callouts

Subject: [Boost-docs] [quickbook] Problems with callouts
From: Steven Watanabe (watanabesj_at_[hidden])
Date: 2009-11-28 17:27:28

AMDG

a) I tried to use both the /*` text */ and /*< callout >*/
markups in a single block.
/*`
  Now we can define a function that simulates an ordinary
  six-sided die.
*/
int roll_die() {
    boost::uniform_int<> dist(1, 6); /*< create a uniform_int 
distribution >*/
}

In the final result, the roll_die code block gets split up into two sections
at the callout.  This looks rather ugly.  I worked around this by splitting
the /*`*/ markup into a separate template.

b) I tried to use Admonitions inside callouts.

int roll_die() {
    /*<< [warning uniform_int uses a closed range, not a half-open 
range. ] >>*/
    boost::uniform_int<> dist(1, 6);
}

This generates invalid XML.  I worked around the problem by
inserting the XML markup explicitly.
'''<warning><para>''' and '''</para></warning>'''

This is with the current trunk, revision 58004.

In Christ,
Steven Watanabe