Update of /cvsroot/boost/boost/tools/quickbook/doc/html/quickbook/editors
In directory
sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv28166/tools/quickbook_backend/doc/html/quickbook/editors
Added Files:
Tag: QUICKBOOK_BACKEND
kde_support.html
Log Message:
Merge from head.
--- NEW FILE: kde_support.html ---
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>KDE Support</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../../index.html" title="Quickbook 1.4">
<link rel="up" href="../editors.html" title=" Editor Support">
<link rel="prev" href="scite.html" title=" Scintilla Text Editor">
<link rel="next" href="../faq.html" title=" Frequently Asked Questions">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084"
alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86"
src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.htm">Home</a></td>
<td align="center"><a
href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="scite.html"><img
src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a
accesskey="u" href="../editors.html"><img
src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h"
href="../../index.html"><img src="../../../../../../doc/html/images/home.png"
alt="Home"></a><a accesskey="n" href="../faq.html"><img
src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="quickbook.editors.kde_support"></a><a href="kde_support.html"
title="KDE Support">KDE Support</a></h3></div></div></div>
<a name="quickbook.editors.kde_support.boost__hs__quickbook"></a><h4>
<a name="id466157"></a>
<a
href="kde_support.html#quickbook.editors.kde_support.boost__hs__quickbook">boost::hs::quickbook</a>
</h4>
<p>
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.
</p>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">.qbk loaded in a text editor</span></dt>
<dd><span class="inlinemediaobject"><img
src="../../images/extra/katepart/table.text.editor.png"
alt="table.text.editor"></span></dd>
<dt><span class="term">.qbk loaded with boost::hs support</span></dt>
<dd><span class="inlinemediaobject"><img
src="../../images/extra/katepart/table.boost.hs.png"
alt="table.boost.hs"></span></dd>
</dl>
</div>
<p>
<span class="bold"><b>html generated from this .qbk file</b></span>
</p>
<div class="table">
<a name="id466251"></a><p class="title"><b>Table 7. Code examples</b></p>
<table class="table" summary="Code examples">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Code
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
for loop
</p>
</td>
<td>
<p>
<tt class="computeroutput"> <span class="keyword">for</span><span
class="special">(</span><span class="identifier">int</span> <span
class="identifier">k</span><span class="special">=</span><span
class="number">0</span><span class="special">;</span>
<span class="identifier">k</span><span
class="special"><</span><span class="number">10</span><span
class="special">;</span> <span class="identifier">k</span><span
class="special">++)</span> <span class="identifier">v</span><span
class="special">+=</span><span class="identifier">k</span><span
class="special">;</span> </tt>
</p>
</td>
<td>
<p>
Sums some numbers.
</p>
</td>
</tr>
<tr>
<td>
<p>
while loop
</p>
</td>
<td>
<p>
<tt class="computeroutput"> <span class="special">{</span> <span
class="identifier">int</span>
<span class="identifier">k</span><span class="special">;</span>
<span class="keyword">while</span><span class="special">(</span>
<span class="identifier">k</span> <span
class="special"><</span>
<span class="number">10</span> <span class="special">)</span>
<span class="special">{</span> <span
class="identifier">v</span><span class="special">+=</span><span
class="identifier">k</span><span class="special">;</span> <span
class="identifier">k</span><span class="special">++</span> <span
class="special">}</span> <span class="special">}</span> </tt>
</p>
</td>
<td>
<p>
Same effect.
</p>
</td>
</tr>
<tr>
<td>
<p>
infinite loop
</p>
</td>
<td>
<p>
<tt class="computeroutput"> <span
class="keyword">while</span><span class="special">(</span>
<span class="identifier">true</span> <span
class="special">)</span>
<span class="special">{</span> <span
class="identifier">v</span><span class="special">+=</span><span
class="number">1</span><span class="special">;</span>
<span class="special">}</span> </tt>
</p>
</td>
<td>
<p>
Not a good example.
</p>
</td>
</tr>
</tbody>
</table>
</div>
<a name="quickbook.editors.kde_support.code_folding_"></a><h4>
<a name="id466658"></a>
<a
href="kde_support.html#quickbook.editors.kde_support.code_folding_">Code Folding
</a>
</h4>
<p>
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.
</p>
<a name="quickbook.editors.kde_support.auto_comment___uncomment_"></a><h4>
<a name="id466690"></a>
<a
href="kde_support.html#quickbook.editors.kde_support.auto_comment___uncomment_">Auto
Comment / Uncomment </a>
</h4>
<p>
Another important feature is the possibility to auto-comment or
uncomment
some piece of code (<span class="emphasis"><em>Tools -
Comment</em></span>). Commented regions
can be uncommented simple calling the <span
class="emphasis"><em>uncomment</em></span> command
while being in it.
</p>
<a name="quickbook.editors.kde_support.styles_reference_"></a><h4>
<a name="id466732"></a>
<a
href="kde_support.html#quickbook.editors.kde_support.styles_reference_">Styles
reference
</a>
</h4>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Style
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<span class="bold"><b>plain text</b></span>
</p>
</td>
<td>
<p>
normal black
</p>
</td>
<td>
<p>
Plain text at each level.
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><b>formatted text</b></span>
</p>
</td>
<td>
<p>
formatted black
</p>
</td>
<td>
<p>
Bold, italic, underline and mixes. Teletype, replaceable,
strikeout.
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><b>structure</b></span>
</p>
</td>
<td>
<p>
light blue
</p>
</td>
<td>
<p>
All quickbook structures characters ([, ], [block-type, simple
formating
boundaries, lists keywords (*, #)
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><b>macros</b></span>
</p>
</td>
<td>
<p>
red
</p>
</td>
<td>
<p>
Names in macro definitions, macros insertion if it is used the
__xxx__
proposed sintaxis.
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><b>templates</b></span>
</p>
</td>
<td>
<p>
red
</p>
</td>
<td>
<p>
Names in template definitions
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><b>anchors</b></span>
</p>
</td>
<td>
<p>
red
</p>
</td>
<td>
<p>
All the keywords that are used to link quickbooks together.
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><b>comments</b></span>
</p>
</td>
<td>
<p>
italic light gray
</p>
</td>
<td>
<p>
Inside the commentaries.
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><b>tables</b></span>
</p>
</td>
<td>
<p>
HTML like
</p>
</td>
<td>
<p>
Reveal the structure, bold title, higlighted HTML like columns
titles.
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><b>variable lists</b></span>
</p>
</td>
<td>
<p>
HTML like
</p>
</td>
<td>
<p>
Reveal the structure, bold title, bold HTML like items names.
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><b>c++ code</b></span>
</p>
</td>
<td>
<p>
cpp Kate syntax
</p>
</td>
<td>
<p>
Code blocks and inline code.
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><b>paths</b></span>
</p>
</td>
<td>
<p>
green
</p>
</td>
<td>
<p>
Image, files and web paths
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><b>IDE specific</b></span>
</p>
</td>
<td>
<p>
dark blue
</p>
</td>
<td>
<p>
IDE commands
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="quickbook.editors.kde_support.about_boost__hs"></a><h4>
<a name="id467180"></a>
<a
href="kde_support.html#quickbook.editors.kde_support.about_boost__hs">About
boost::hs</a>
</h4>
<p>
<span class="inlinemediaobject"><img
src="../../images/extra/katepart/boost.hs.logo.png" alt="boost.hs.logo"></span>
</p>
<p>
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
<a href="http://tinyurl.com/2l7u33"; target="_top">here</a>.
</p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]"
src="../../../../../../doc/html/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td colspan="2" align="left" valign="top">
<p>
</p>
<p>
boost::hs::cpp support QuickBook code import comments style!
</p>
<p>
</p>
</td></tr>
</table></div>
<a name="quickbook.editors.kde_support.installing_boost__hs"></a><h4>
<a name="id467252"></a>
<a
href="kde_support.html#quickbook.editors.kde_support.installing_boost__hs">Installing
boost::hs</a>
</h4>
<p>
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.
</p>
<p>
You can download boost::hs from <a
href="http://matias.capeletto.googlepages.com/boost_hs.zip";
target="_top">here</a>.
</p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]"
src="../../../../../../doc/html/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td colspan="2" align="left" valign="top">
<p>
</p>
<p>
A copy of boost::hs::quickbook and boost::hs::cpp is available in
<tt class="computeroutput"><span class="identifier">boost</span><span
class="special">/</span><span class="identifier">tools</span><span
class="special">/</span><span class="identifier">quickbook</span><span
class="special">/</span><span class="identifier">extra</span><span
class="special">/</span><span class="identifier">katepart</span></tt>.
</p>
<p>
</p>
</td></tr>
</table></div>
<p>
In order to install it you must copy the content in the folder <span
class="bold"><b>katepart/syntax/</b></span> to the appropriate katepart syntax
folder in your machine. In general this folder will be in <span
class="bold"><b>/usr/share/apps/katepart/syntax</b></span>.
A bash script named <span class="emphasis"><em>install.sh</em></span>
is included that copy
the files to this folder.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision";
width="100%"><tr>
<td align="left"></td>
<td align="right"><small>Copyright © 2002, 2004, 2006 Joel de Guzman,
Eric Niebler</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="scite.html"><img
src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a
accesskey="u" href="../editors.html"><img
src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h"
href="../../index.html"><img src="../../../../../../doc/html/images/home.png"
alt="Home"></a><a accesskey="n" href="../faq.html"><img
src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Boost-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/boost-cvs
