doc/html/quickbook/editors.html

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