David Abrahams wrote:
"Eric Niebler" <[EMAIL PROTECTED]> writes:
David Abrahams wrote:
That said, and speaking of maturity, the number of escapes to
BoostBook in the QuickBook docs is disappointing. We need to get
Quickbook to a point where you don't need to know BoostBook in order
to get real work done.
I'm not sure what you're referring to. There is exactly one place in
quickbook.qbk where we escape BoostBook markup, and that's where we show
how to escape BoostBook markup.
If you are referring to the frequent use of ''' escape sequences, that's
just to escape /QuickBook/ syntax.
Okay, maybe I misunderstood. If those ''' ... ''' blocks contained
'<' characters that weren't parts of XML tags, would everything be
fine? Otherwise, we need a separate escape.
I'm not sure. It should be the responsibility of the author
to handle these things while on escape. The quickbook doc
is a rare enough case because it eats itself. I don't know
of any other case where you have to escape quickdoc code
except in writing quickdoc's documentation. And it's explicitly
stated in the doc in a warning box:
! Be careful when using the escape. The text must
conform to BoostBook/DocBook syntax.
And when the local syntax definitions get finalized and integrated,
we'll have more flexibility by having a quickbook syntax mode.
Then, we only have to switch the source-mode to quickbook and
indent the code blocks or enclose the code in `ticks`, just as
you would for c++ and python, now. Then the quickbook code snippets
will be syntax-colorized in full glory.
Cheers,
--
Joel de Guzman
http://www.boost-consulting.com
http://spirit.sf.net
-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click
_______________________________________________
Boost-docs mailing list
[email protected]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
