Boost C++ Libraries of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Click here to view the latest version of this page.

Editor Support

Scintilla Text Editor
KDE Support

Editing quickbook files is usually done with text editors both simple and powerful. The following sections list the settings for some editors which can help make editing quickbook files a bit easier.

[Note] Note

You may submit your settings, tips, and suggestions to the authors, or through the docs Boost Docs mailing list.

Section contributed by Dean Michael Berris

The Scintilla Text Editor (SciTE) is a free source code editor for Win32 and X. It uses the SCIntilla source code editing component.

[Tip] Tip

SciTE can be downloaded from

You can use the following settings to highlight quickbook tags when editing quickbook files.

[Note] Note

Thanks to Rene Rivera for the above SciTE settings.


boost::hs::quickbook is a syntax highlighting designed to work with Katepart. It can be used in KWrite, Kate, Konqueror and KDevelop, and supports all the constructs of Quickbook 1.4 including tables, list, templates and macros.

.qbk loaded in a text editor

.qbk loaded with boost::hs support

html generated from this .qbk file

Table 37.7. Code examples




for loop

for(int k=0; k<10; k++) v+=k;

Sums some numbers.

while loop

{ int k; while( k < 10 ) { v+=k; k++ } }

Same effect.

infinite loop

while( true ) { v+=1; }

Not a good example.

Code Folding

boost::hs goes far beyond simple coloring. One useful thing you can get the editor to do is to mark regions. They appear in a small grey line and each region can be folded or unfolded independently.

Auto Comment / Uncomment

Another important feature is the possibility to auto-comment or uncomment some piece of code (Tools - Comment). Commented regions can be uncommented simple calling the uncomment command while being in it.

Styles reference




plain text

normal black

Plain text at each level.

formatted text

formatted black

Bold, italic, underline and mixes. Teletype, replaceable, strikeout.


light blue

All quickbook structures characters ([, ], [block-type, simple formating boundaries, lists keywords (*, #)



Names in macro definitions, macros insertion if it is used the __xxx__ proposed sintaxis.



Names in template definitions



All the keywords that are used to link quickbooks together.


italic light gray

Inside the commentaries.


HTML like

Reveal the structure, bold title, higlighted HTML like columns titles.

variable lists

HTML like

Reveal the structure, bold title, bold HTML like items names.

c++ code

cpp Kate syntax

Code blocks and inline code.



Image, files and web paths

IDE specific

dark blue

IDE commands

About boost::hs

boost::hs::quickbook is a component of boost::hs, a syntax highlighting for C++, doxygen, Boost.Build jamfiles and QuickBook. boost::hs has his own page here.

[Note] Note

boost::hs::cpp support QuickBook code import comments style!

Installing boost::hs

There exist an ongoing effort to push boost::hs upstream to the KatePart project. In a few months KDE may have native Quickbook support! For the moment you must download and install it.

You can download boost::hs from here.

[Note] Note

A copy of boost::hs::quickbook and boost::hs::cpp is available in boost/tools/quickbook/extra/katepart.

In order to install it you must copy the content in the folder katepart/syntax/ to the appropriate katepart syntax folder in your machine. In general this folder will be in /usr/share/apps/katepart/syntax. A bash script named is included that copy the files to this folder.