Re: [Boost-docs] Quickbook wish list..

Subject: Re: [Boost-docs] Quickbook wish list..
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2011-11-23 10:45:30

> -----Original Message-----
> From: boost-docs-bounces_at_[hidden] [mailto:boost-docs-bounces_at_[hidden]] On Behalf Of
> Vicente J. Botet Escriba
> Sent: Tuesday, November 22, 2011 9:11 PM
> To: Discussion of Boost Documentation
> Subject: Re: [Boost-docs] Quickbook wish list..
> 
> Le 22/11/11 17:18, Rene Rivera a écrit :
> > While doing the documentation for the Predef library I'm working on
> > I've run into a set of features that seems either inconsistent or just
> > missing. I thought it would be good to share the list for future
> > reference and general feedback:
> >
> > * Ability to apply syntax coloring to code blocks one at a time. Right
> > now one can globally switch the language system with "[c++]" etc. But
> > what I'd rather have is the capability to to a temporary switch (i.e.
> > a push and pop). In my case I want to set the global default to
> > "teletype" and then choose "c++" for certain places.

Can you achieve this now (albeit perhaps with more markup) by enclosing the contents of part or all
of your snippet in a [^ ...]?

For example, I have tried this at the end of a demo program

/*

//[mylibrary_example_output

//`[* Output from running my_library_example.cpp is:]

------ Rebuild All started: Project: mylibrary_example, Configuration: Debug Win32 ------
  mylibrary_example.cpp
  mylibrary_example.vcxproj -> J:\Cpp\mylibrary_example\Debug\mylibrary_example.exe
  Hello World!
========== Rebuild All: 1 succeeded, 0 failed, 0 skipped ==========

//] [mylibrary_example_output] // End of output snippet.

*/

This puts the line "Output from running my_library_example.cpp is"  in bold (but equally could be
others like italic, bold, underline or teletype [^ etc for your usage).

/*`
[*Output from running my_library_example.cpp is:]

------ Rebuild All started: Project: mylibrary_example, Configuration: Debug Win32 ------
  mylibrary_example.cpp
...
]
*/

would put it all in bold.

The section Code Snippet Markup and Sepcial comments
boost_1_48_0/tools/quickbook/doc/html/quickbook/syntax/block.html

says more about it.

HTH

Paul

---
Paul A. Bristow,
Prizet Farmhouse, Kendal LA8 8AB  UK
[phone]  07714330204
pbristow_at_[hidden]