1[/ 2 Boost.hs 3 4 Copyright 2007 Matias Capeletto 5 6 Distributed under the Boost Software License, Version 1.0. 7 (See accompanying file LICENSE_1_0.txt or copy at 8 http://www.boost.org/LICENSE_1_0.txt) 9] 10 11[section KDE Support] 12 13[heading boost::hs::quickbook] 14 15boost::hs::quickbook is a syntax highlighting designed to work with Katepart. 16It can be used in KWrite, Kate, Konqueror and KDevelop, and supports all the 17constructs of Quickbook 1.4 including tables, list, templates and macros. 18 19[variablelist 20[[.qbk loaded in a text editor][ 21[$../../tools/quickbook/doc/html/images/extra/katepart/table.text.editor.png] 22]] 23[[.qbk loaded with boost::hs support][ 24[$../../tools/quickbook/doc/html/images/extra/katepart/table.boost.hs.png] 25]] 26] 27 28[*html generated from this .qbk file] 29 30[table Code examples 31[[Name][Code][Description]] 32[[for loop ][` for(int k=0; k<10; k++) v+=k; ` ][Sums some numbers. ]] 33[[while loop ][` { int k; while( k < 10 ) { v+=k; k++ } } `][Same effect. ]] 34[[infinite loop][` while( true ) { v+=1; } ` ][Not a good example.]] 35] 36 37[heading Code Folding ] 38 39boost::hs goes far beyond simple coloring. One useful thing 40you can get the editor to do is to mark regions. They appear in a small grey line 41and each region can be folded or unfolded independently. 42 43[heading Auto Comment / Uncomment ] 44 45Another important feature is the possibility to auto-comment or uncomment some 46piece of code (/Tools - Comment/). 47Commented regions can be uncommented simple calling the /uncomment/ command 48while being in it. 49 50[heading Styles reference ] 51 52[table 53[[ Name ][ Style ][ Description ]] 54 55[[*plain text* ][normal black ] 56[Plain text at each level. ]] 57 58[[*formatted text* ][formatted black ] 59[ Bold, italic, underline and mixes. Teletype, replaceable, strikeout. ]] 60 61[[*structure* ][light blue ] 62[All quickbook structures characters (\[, \], \[block-type, simple 63formating boundaries, lists keywords (\*, \#) ]] 64 65[[*macros* ][red ] 66[Names in macro definitions, macros insertion if it is used the \_\_xxx\_\_ 67proposed sintaxis. ]] 68 69[[*templates* ][red ] 70[Names in template definitions ]] 71 72[[*anchors* ][red ] 73[All the keywords that are used to link quickbooks together. ]] 74 75[[*comments* ][italic light gray ] 76[Inside the commentaries. ]] 77 78[[*tables* ][HTML like ] 79[Reveal the structure, bold title, higlighted HTML like columns titles. ]] 80 81[[*variable lists* ][HTML like ] 82[Reveal the structure, bold title, bold HTML like items names. ]] 83 84[[*c++ code* ][cpp Kate syntax ] 85[Code blocks and inline code. ]] 86 87[[*paths* ][green ] 88[Image, files and web paths ]] 89 90[[*IDE specific* ][dark blue ] 91[IDE commands ]] 92] 93 94[heading About boost::hs] 95 96[$../../tools/quickbook/doc/html/images/extra/katepart/boost.hs.logo.png] 97 98boost::hs::quickbook is a component of boost::hs, a syntax highlighting 99for C++, doxygen, Boost.Build jamfiles and QuickBook. 100boost::hs has his own page [@http://tinyurl.com/2l7u33 here]. 101 102[note 103boost::hs::cpp support QuickBook code import comments style! 104] 105 106[heading Installing boost::hs] 107 108There exist an ongoing effort to push boost::hs upstream to the KatePart 109project. In a few months KDE may have native Quickbook support! 110For the moment you must download and install it. 111 112You can download boost::hs from 113[@http://matias.capeletto.googlepages.com/boost_hs.zip here]. 114 115[note 116A copy of boost::hs::quickbook and boost::hs::cpp is available in `boost/tools/quickbook/extra/katepart`. 117] 118 119In order to install it you must copy the content in the folder 120[*katepart\/syntax\/] to the appropriate katepart syntax folder in your 121machine. In general this folder will be in 122[*\/usr\/share\/apps\/katepart\/syntax]. A bash script named ['install.sh] 123is included that copy the files to this folder. 124 125[endsect] 126
