mirror of
https://github.com/boostorg/quickbook.git
synced 2026-02-01 08:42:16 +00:00
101 lines
4.6 KiB
HTML
Executable File
101 lines
4.6 KiB
HTML
Executable File
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||
<title>Part I. quickbook 1.1</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="Part I. quickbook 1.1">
|
||
<link rel="next" href="quickbook/syntax.html" title=" Syntax Summary">
|
||
</head>
|
||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||
<table cellpadding="2" width="100%">
|
||
<td valign="top"><img alt="boost.png (6897 bytes)" 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>
|
||
</table>
|
||
<hr>
|
||
<div class="spirit-nav"><a accesskey="n" href="quickbook/syntax.html"><img src="images/next.png" alt="Next"></a></div>
|
||
<div class="part" lang="en">
|
||
<div class="titlepage"><div>
|
||
<div><h1 class="title">
|
||
<a name="quickbook"></a>quickbook 1.1</h1></div>
|
||
<div><div class="author"><h3 class="author">
|
||
<span class="firstname">Joel</span> <span class="surname">de Guzman</span>
|
||
</h3></div></div>
|
||
<div><div class="author"><h3 class="author">
|
||
<span class="firstname">Eric</span> <span class="surname">Niebler</span>
|
||
</h3></div></div>
|
||
<div><p class="copyright">Copyright © 2002, 2004 Joel de Guzman, Eric Niebler</p></div>
|
||
<div><div class="legalnotice">
|
||
<a name="id372213"></a><p>
|
||
Distributed under the Boost Software License, Version 1.0.
|
||
(See accompanying 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>)
|
||
|
||
</p>
|
||
</div></div>
|
||
</div></div>
|
||
<div class="section" lang="en">
|
||
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
|
||
<a name="quickbook.intro"></a> Introduction</h2></div></div></div>
|
||
<div class="blockquote"><blockquote class="blockquote"><p><span class="bold"><b><span class="emphasis"><em>"Why program by hand in five days what you can spend five years of your
|
||
life automating?"</em></span></b></span><br><br>
|
||
-- Terrence Parr, author ANTLR/PCCTS</p></blockquote></div>
|
||
<p>
|
||
Well, QuickBook started as a weekend hack. It was originally intended to be a
|
||
sample application using <a href="http://spirit.sourceforge.net" target="_top">Spirit</a>. What is it? What you are viewing now, this
|
||
documentation, is autogenerated by QuickBook. These files were generated from
|
||
one master:</p>
|
||
<div class="blockquote"><blockquote class="blockquote"><p><a href="../quickbook.qbk" target="_top">quickbook.qbk</a></p></blockquote></div>
|
||
<p>
|
||
Originally named QuickDoc, this funky tool that never dies evolved into a
|
||
funkier tool thanks to Eric Niebler who resurrected the project making it
|
||
generate <a href="http://www.boost.org/doc/html/boostbook.html" target="_top">BoostBook</a> instead of HTML. The <a href="http://www.boost.org/doc/html/boostbook.html" target="_top">BoostBook</a> documentation format
|
||
is an extension of <a href="http://www.docbook.org/" target="_top">DocBook</a>, an SGML- or XML- based format for describing
|
||
documentation.</p>
|
||
<p>
|
||
QuickBook is a WikiWiki style documentation tool geared towards C++
|
||
documentation using simple rules and markup for simple formatting tasks.
|
||
QuickBook extends the WikiWiki concept. Like the WikiWiki, QuickBook documents are
|
||
simple text files. A single QuickBook document can generate a fully linked set
|
||
of nice HTML and PostScript/PDF documents complete with images and syntax-
|
||
colorized source code.</p>
|
||
<p>
|
||
Features include:</p>
|
||
<div class="itemizedlist"><ul type="disc">
|
||
<li>
|
||
generate <a href="http://www.boost.org/doc/html/boostbook.html" target="_top">BoostBook</a> xml, to generate HTML, PostScript and PDF
|
||
</li>
|
||
<li>
|
||
simple markup to link to Doxygen-generated entities
|
||
</li>
|
||
<li>
|
||
macro system for simple text substitution
|
||
</li>
|
||
<li>
|
||
simple markup for italics, bold, preformatted, blurbs, code samples,
|
||
tables, URLs, anchors, images, etc.
|
||
</li>
|
||
<li>
|
||
automatic syntax coloring of code samples
|
||
</li>
|
||
<li>
|
||
CSS support
|
||
</li>
|
||
</ul></div>
|
||
</div>
|
||
</div>
|
||
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
||
<td align="left"><small><p>Last revised: April 30, 2005 at 01:48:44 GMT</p></small></td>
|
||
<td align="right"><small></small></td>
|
||
</tr></table>
|
||
<hr>
|
||
<div class="spirit-nav"><a accesskey="n" href="quickbook/syntax.html"><img src="images/next.png" alt="Next"></a></div>
|
||
</body>
|
||
</html>
|