1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Editor Support</title> 6<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../quickbook.html" title="Chapter 50. Quickbook 1.7"> 10<link rel="prev" href="install.html" title="Installation and configuration"> 11<link rel="next" href="faq.html" title="Frequently Asked Questions"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> 16<td align="center"><a href="../../../index.html">Home</a></td> 17<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="install.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quickbook.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="faq.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="section"> 27<div class="titlepage"><div><div><h2 class="title" style="clear: both"> 28<a name="quickbook.editors"></a>Editor Support</h2></div></div></div> 29<div class="toc"><dl class="toc"> 30<dt><span class="section"><a href="editors.html#quickbook.editors.scite">Scintilla Text Editor</a></span></dt> 31<dt><span class="section"><a href="editors.html#editor_support.kde_support">KDE Support</a></span></dt> 32</dl></div> 33<p> 34 Editing quickbook files is usually done with text editors both simple and powerful. 35 The following sections list the settings for some editors which can help make 36 editing quickbook files a bit easier. 37 </p> 38<div class="note"><table border="0" summary="Note"> 39<tr> 40<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../doc/src/images/note.png"></td> 41<th align="left">Note</th> 42</tr> 43<tr><td align="left" valign="top"><p> 44 You may submit your settings, tips, and suggestions to the authors, or through 45 the <a href="https://lists.sourceforge.net/lists/listinfo/boost-" target="_top">docs 46 Boost Docs mailing list</a>. 47 </p></td></tr> 48</table></div> 49<div class="section"> 50<div class="titlepage"><div><div><h3 class="title"> 51<a name="quickbook.editors.scite"></a><a class="link" href="editors.html#quickbook.editors.scite" title="Scintilla Text Editor">Scintilla Text Editor</a> 52</h3></div></div></div> 53<div class="blockquote"><blockquote class="blockquote"><p> 54 <span class="emphasis"><em>Section contributed by Dean Michael Berris</em></span> 55 </p></blockquote></div> 56<p> 57 The Scintilla Text Editor (SciTE) is a free source code editor for Win32 58 and X. It uses the SCIntilla source code editing component. 59 </p> 60<div class="tip"><table border="0" summary="Tip"> 61<tr> 62<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../doc/src/images/tip.png"></td> 63<th align="left">Tip</th> 64</tr> 65<tr><td align="left" valign="top"><p> 66 SciTE can be downloaded from <a href="http://www.scintilla.org/SciTE.html" target="_top">http://www.scintilla.org/SciTE.html</a> 67 </p></td></tr> 68</table></div> 69<p> 70 You can use the following settings to highlight quickbook tags when editing 71 quickbook files. 72 </p> 73<pre class="programlisting">qbk=*.qbk 74lexer.*.qbk=props 75use.tabs.$(qbk)=0 76tab.size.$(qbk)=4 77indent.size.$(qbk)=4 78style.props.32=$(font.base) 79comment.stream.start.props=[/ 80comment.stream.end.props=] 81comment.box.start.props=[/ 82comment.box.middle.props= 83comment.box.end.props=] 84</pre> 85<div class="note"><table border="0" summary="Note"> 86<tr> 87<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../doc/src/images/note.png"></td> 88<th align="left">Note</th> 89</tr> 90<tr><td align="left" valign="top"><p> 91 Thanks to Rene Rivera for the above SciTE settings. 92 </p></td></tr> 93</table></div> 94</div> 95<div class="section"> 96<div class="titlepage"><div><div><h3 class="title"> 97<a name="editor_support.kde_support"></a><a class="link" href="editors.html#editor_support.kde_support" title="KDE Support">KDE Support</a> 98</h3></div></div></div> 99<h4> 100<a name="editor_support.kde_support.h0"></a> 101 <span class="phrase"><a name="editor_support.kde_support.boost__hs__quickbook"></a></span><a class="link" href="editors.html#editor_support.kde_support.boost__hs__quickbook">boost::hs::quickbook</a> 102 </h4> 103<p> 104 boost::hs::quickbook is a syntax highlighting designed to work with Katepart. 105 It can be used in KWrite, Kate, Konqueror and KDevelop, and supports all 106 the constructs of Quickbook 1.4 including tables, list, templates and macros. 107 </p> 108<div class="variablelist"> 109<p class="title"><b></b></p> 110<dl class="variablelist"> 111<dt><span class="term">.qbk loaded in a text editor</span></dt> 112<dd><p> 113 <span class="inlinemediaobject"><img src="../../../tools/quickbook/doc/html/images/extra/katepart/table.text.editor.png"></span> 114 </p></dd> 115<dt><span class="term">.qbk loaded with boost::hs support</span></dt> 116<dd><p> 117 <span class="inlinemediaobject"><img src="../../../tools/quickbook/doc/html/images/extra/katepart/table.boost.hs.png"></span> 118 </p></dd> 119</dl> 120</div> 121<p> 122 <span class="bold"><strong>html generated from this .qbk file</strong></span> 123 </p> 124<div class="table"> 125<a name="editor_support.kde_support.code_examples"></a><p class="title"><b>Table 50.7. Code examples</b></p> 126<div class="table-contents"><table class="table" summary="Code examples"> 127<colgroup> 128<col> 129<col> 130<col> 131</colgroup> 132<thead><tr> 133<th> 134 <p> 135 Name 136 </p> 137 </th> 138<th> 139 <p> 140 Code 141 </p> 142 </th> 143<th> 144 <p> 145 Description 146 </p> 147 </th> 148</tr></thead> 149<tbody> 150<tr> 151<td> 152 <p> 153 for loop 154 </p> 155 </td> 156<td> 157 <p> 158 <code class="computeroutput"> for(int k=0; k<10; k++) v+=k; </code> 159 </p> 160 </td> 161<td> 162 <p> 163 Sums some numbers. 164 </p> 165 </td> 166</tr> 167<tr> 168<td> 169 <p> 170 while loop 171 </p> 172 </td> 173<td> 174 <p> 175 <code class="computeroutput"> { int k; while( k < 10 ) { v+=k; k++ } } </code> 176 </p> 177 </td> 178<td> 179 <p> 180 Same effect. 181 </p> 182 </td> 183</tr> 184<tr> 185<td> 186 <p> 187 infinite loop 188 </p> 189 </td> 190<td> 191 <p> 192 <code class="computeroutput"> while( true ) { v+=1; } </code> 193 </p> 194 </td> 195<td> 196 <p> 197 Not a good example. 198 </p> 199 </td> 200</tr> 201</tbody> 202</table></div> 203</div> 204<br class="table-break"><h4> 205<a name="editor_support.kde_support.h1"></a> 206 <span class="phrase"><a name="editor_support.kde_support.code_folding_"></a></span><a class="link" href="editors.html#editor_support.kde_support.code_folding_">Code 207 Folding </a> 208 </h4> 209<p> 210 boost::hs goes far beyond simple coloring. One useful thing you can get the 211 editor to do is to mark regions. They appear in a small grey line and each 212 region can be folded or unfolded independently. 213 </p> 214<h4> 215<a name="editor_support.kde_support.h2"></a> 216 <span class="phrase"><a name="editor_support.kde_support.auto_comment___uncomment_"></a></span><a class="link" href="editors.html#editor_support.kde_support.auto_comment___uncomment_">Auto Comment 217 / Uncomment </a> 218 </h4> 219<p> 220 Another important feature is the possibility to auto-comment or uncomment 221 some piece of code (<span class="emphasis"><em>Tools - Comment</em></span>). Commented regions 222 can be uncommented simple calling the <span class="emphasis"><em>uncomment</em></span> command 223 while being in it. 224 </p> 225<h4> 226<a name="editor_support.kde_support.h3"></a> 227 <span class="phrase"><a name="editor_support.kde_support.styles_reference_"></a></span><a class="link" href="editors.html#editor_support.kde_support.styles_reference_">Styles 228 reference </a> 229 </h4> 230<div class="informaltable"><table class="table"> 231<colgroup> 232<col> 233<col> 234<col> 235</colgroup> 236<thead><tr> 237<th> 238 <p> 239 Name 240 </p> 241 </th> 242<th> 243 <p> 244 Style 245 </p> 246 </th> 247<th> 248 <p> 249 Description 250 </p> 251 </th> 252</tr></thead> 253<tbody> 254<tr> 255<td> 256 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 257 plain text* 258 </li></ul></div> 259 </td> 260<td> 261 <p> 262 normal black 263 </p> 264 </td> 265<td> 266 <p> 267 Plain text at each level. 268 </p> 269 </td> 270</tr> 271<tr> 272<td> 273 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 274 formatted text* 275 </li></ul></div> 276 </td> 277<td> 278 <p> 279 formatted black 280 </p> 281 </td> 282<td> 283 <p> 284 Bold, italic, underline and mixes. Teletype, replaceable, strikeout. 285 </p> 286 </td> 287</tr> 288<tr> 289<td> 290 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 291 structure* 292 </li></ul></div> 293 </td> 294<td> 295 <p> 296 light blue 297 </p> 298 </td> 299<td> 300 <p> 301 All quickbook structures characters ([, ], [block-type, simple 302 formating boundaries, lists keywords (*, #) 303 </p> 304 </td> 305</tr> 306<tr> 307<td> 308 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 309 macros* 310 </li></ul></div> 311 </td> 312<td> 313 <p> 314 red 315 </p> 316 </td> 317<td> 318 <p> 319 Names in macro definitions, macros insertion if it is used the 320 __xxx__ proposed sintaxis. 321 </p> 322 </td> 323</tr> 324<tr> 325<td> 326 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 327 templates* 328 </li></ul></div> 329 </td> 330<td> 331 <p> 332 red 333 </p> 334 </td> 335<td> 336 <p> 337 Names in template definitions 338 </p> 339 </td> 340</tr> 341<tr> 342<td> 343 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 344 anchors* 345 </li></ul></div> 346 </td> 347<td> 348 <p> 349 red 350 </p> 351 </td> 352<td> 353 <p> 354 All the keywords that are used to link quickbooks together. 355 </p> 356 </td> 357</tr> 358<tr> 359<td> 360 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 361 comments* 362 </li></ul></div> 363 </td> 364<td> 365 <p> 366 italic light gray 367 </p> 368 </td> 369<td> 370 <p> 371 Inside the commentaries. 372 </p> 373 </td> 374</tr> 375<tr> 376<td> 377 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 378 tables* 379 </li></ul></div> 380 </td> 381<td> 382 <p> 383 HTML like 384 </p> 385 </td> 386<td> 387 <p> 388 Reveal the structure, bold title, higlighted HTML like columns 389 titles. 390 </p> 391 </td> 392</tr> 393<tr> 394<td> 395 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 396 variable lists* 397 </li></ul></div> 398 </td> 399<td> 400 <p> 401 HTML like 402 </p> 403 </td> 404<td> 405 <p> 406 Reveal the structure, bold title, bold HTML like items names. 407 </p> 408 </td> 409</tr> 410<tr> 411<td> 412 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 413 c++ code* 414 </li></ul></div> 415 </td> 416<td> 417 <p> 418 cpp Kate syntax 419 </p> 420 </td> 421<td> 422 <p> 423 Code blocks and inline code. 424 </p> 425 </td> 426</tr> 427<tr> 428<td> 429 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 430 paths* 431 </li></ul></div> 432 </td> 433<td> 434 <p> 435 green 436 </p> 437 </td> 438<td> 439 <p> 440 Image, files and web paths 441 </p> 442 </td> 443</tr> 444<tr> 445<td> 446 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 447 IDE specific* 448 </li></ul></div> 449 </td> 450<td> 451 <p> 452 dark blue 453 </p> 454 </td> 455<td> 456 <p> 457 IDE commands 458 </p> 459 </td> 460</tr> 461</tbody> 462</table></div> 463<h4> 464<a name="editor_support.kde_support.h4"></a> 465 <span class="phrase"><a name="editor_support.kde_support.about_boost__hs"></a></span><a class="link" href="editors.html#editor_support.kde_support.about_boost__hs">About 466 boost::hs</a> 467 </h4> 468<p> 469 <span class="inlinemediaobject"><img src="../../../tools/quickbook/doc/html/images/extra/katepart/boost.hs.logo.png"></span> 470 </p> 471<p> 472 boost::hs::quickbook is a component of boost::hs, a syntax highlighting for 473 C++, doxygen, Boost.Build jamfiles and QuickBook. boost::hs has his own page 474 <a href="http://tinyurl.com/2l7u33" target="_top">here</a>. 475 </p> 476<div class="note"><table border="0" summary="Note"> 477<tr> 478<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../doc/src/images/note.png"></td> 479<th align="left">Note</th> 480</tr> 481<tr><td align="left" valign="top"><p> 482 boost::hs::cpp support QuickBook code import comments style! 483 </p></td></tr> 484</table></div> 485<h4> 486<a name="editor_support.kde_support.h5"></a> 487 <span class="phrase"><a name="editor_support.kde_support.installing_boost__hs"></a></span><a class="link" href="editors.html#editor_support.kde_support.installing_boost__hs">Installing 488 boost::hs</a> 489 </h4> 490<p> 491 There exist an ongoing effort to push boost::hs upstream to the KatePart 492 project. In a few months KDE may have native Quickbook support! For the moment 493 you must download and install it. 494 </p> 495<p> 496 You can download boost::hs from <a href="http://matias.capeletto.googlepages.com/boost_hs.zip" target="_top">here</a>. 497 </p> 498<div class="note"><table border="0" summary="Note"> 499<tr> 500<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../doc/src/images/note.png"></td> 501<th align="left">Note</th> 502</tr> 503<tr><td align="left" valign="top"><p> 504 A copy of boost::hs::quickbook and boost::hs::cpp is available in <code class="computeroutput">boost/tools/quickbook/extra/katepart</code>. 505 </p></td></tr> 506</table></div> 507<p> 508 In order to install it you must copy the content in the folder <span class="bold"><strong>katepart/syntax/</strong></span> to the appropriate katepart syntax 509 folder in your machine. In general this folder will be in <span class="bold"><strong>/usr/share/apps/katepart/syntax</strong></span>. 510 A bash script named <span class="emphasis"><em>install.sh</em></span> is included that copy 511 the files to this folder. 512 </p> 513</div> 514</div> 515<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 516<td align="left"></td> 517<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman, 518 Eric Niebler<br>Copyright © 2010-2017 Daniel James<p> 519 Distributed under the Boost Software License, Version 1.0. (See accompanying 520 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 521 </p> 522</div></td> 523</tr></table> 524<hr> 525<div class="spirit-nav"> 526<a accesskey="p" href="install.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quickbook.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="faq.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> 527</div> 528</body> 529</html> 530
