| 1 | <html> |
|---|
| 2 | <head> |
|---|
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
|---|
| 4 | <title>Part I. quickbook 1.1</title> |
|---|
| 5 | <link rel="stylesheet" href="boostbook.css" type="text/css"> |
|---|
| 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.66.1"> |
|---|
| 7 | <link rel="start" href="index.html" title="Part I. quickbook 1.1"> |
|---|
| 8 | <link rel="next" href="quickbook/syntax.html" title=" Syntax Summary"> |
|---|
| 9 | </head> |
|---|
| 10 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
|---|
| 11 | <table cellpadding="2" width="100%"> |
|---|
| 12 | <td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> |
|---|
| 13 | <td align="center"><a href="../../../../index.htm">Home</a></td> |
|---|
| 14 | <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> |
|---|
| 15 | <td align="center"><a href="../../../../people/people.htm">People</a></td> |
|---|
| 16 | <td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> |
|---|
| 17 | <td align="center"><a href="../../../../more/index.htm">More</a></td> |
|---|
| 18 | </table> |
|---|
| 19 | <hr> |
|---|
| 20 | <div class="spirit-nav"><a accesskey="n" href="quickbook/syntax.html"><img src="images/next.png" alt="Next"></a></div> |
|---|
| 21 | <div class="part" lang="en"> |
|---|
| 22 | <div class="titlepage"><div> |
|---|
| 23 | <div><h1 class="title"> |
|---|
| 24 | <a name="quickbook"></a>quickbook 1.1</h1></div> |
|---|
| 25 | <div><div class="author"><h3 class="author"> |
|---|
| 26 | <span class="firstname">Joel</span> <span class="surname">de Guzman</span> |
|---|
| 27 | </h3></div></div> |
|---|
| 28 | <div><div class="author"><h3 class="author"> |
|---|
| 29 | <span class="firstname">Eric</span> <span class="surname">Niebler</span> |
|---|
| 30 | </h3></div></div> |
|---|
| 31 | <div><p class="copyright">Copyright © 2002, 2004 Joel de Guzman, Eric Niebler</p></div> |
|---|
| 32 | <div><div class="legalnotice"> |
|---|
| 33 | <a name="id372213"></a><p> |
|---|
| 34 | Distributed under the Boost Software License, Version 1.0. |
|---|
| 35 | (See accompanying file LICENSE_1_0.txt or copy at |
|---|
| 36 | <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top"> |
|---|
| 37 | http://www.boost.org/LICENSE_1_0.txt |
|---|
| 38 | </a>) |
|---|
| 39 | |
|---|
| 40 | </p> |
|---|
| 41 | </div></div> |
|---|
| 42 | </div></div> |
|---|
| 43 | <div class="section" lang="en"> |
|---|
| 44 | <div class="titlepage"><div><div><h2 class="title" style="clear: both"> |
|---|
| 45 | <a name="quickbook.intro"></a> Introduction</h2></div></div></div> |
|---|
| 46 | <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 |
|---|
| 47 | life automating?"</em></span></b></span><br><br> |
|---|
| 48 | -- Terrence Parr, author ANTLR/PCCTS</p></blockquote></div> |
|---|
| 49 | <p> |
|---|
| 50 | Well, QuickBook started as a weekend hack. It was originally intended to be a |
|---|
| 51 | sample application using <a href="http://spirit.sourceforge.net" target="_top">Spirit</a>. What is it? What you are viewing now, this |
|---|
| 52 | documentation, is autogenerated by QuickBook. These files were generated from |
|---|
| 53 | one master:</p> |
|---|
| 54 | <div class="blockquote"><blockquote class="blockquote"><p><a href="../quickbook.qbk" target="_top">quickbook.qbk</a></p></blockquote></div> |
|---|
| 55 | <p> |
|---|
| 56 | Originally named QuickDoc, this funky tool that never dies evolved into a |
|---|
| 57 | funkier tool thanks to Eric Niebler who resurrected the project making it |
|---|
| 58 | 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 |
|---|
| 59 | is an extension of <a href="http://www.docbook.org/" target="_top">DocBook</a>, an SGML- or XML- based format for describing |
|---|
| 60 | documentation.</p> |
|---|
| 61 | <p> |
|---|
| 62 | QuickBook is a WikiWiki style documentation tool geared towards C++ |
|---|
| 63 | documentation using simple rules and markup for simple formatting tasks. |
|---|
| 64 | QuickBook extends the WikiWiki concept. Like the WikiWiki, QuickBook documents are |
|---|
| 65 | simple text files. A single QuickBook document can generate a fully linked set |
|---|
| 66 | of nice HTML and PostScript/PDF documents complete with images and syntax- |
|---|
| 67 | colorized source code.</p> |
|---|
| 68 | <p> |
|---|
| 69 | Features include:</p> |
|---|
| 70 | <div class="itemizedlist"><ul type="disc"> |
|---|
| 71 | <li> |
|---|
| 72 | generate <a href="http://www.boost.org/doc/html/boostbook.html" target="_top">BoostBook</a> xml, to generate HTML, PostScript and PDF |
|---|
| 73 | </li> |
|---|
| 74 | <li> |
|---|
| 75 | simple markup to link to Doxygen-generated entities |
|---|
| 76 | </li> |
|---|
| 77 | <li> |
|---|
| 78 | macro system for simple text substitution |
|---|
| 79 | </li> |
|---|
| 80 | <li> |
|---|
| 81 | simple markup for italics, bold, preformatted, blurbs, code samples, |
|---|
| 82 | tables, URLs, anchors, images, etc. |
|---|
| 83 | </li> |
|---|
| 84 | <li> |
|---|
| 85 | automatic syntax coloring of code samples |
|---|
| 86 | </li> |
|---|
| 87 | <li> |
|---|
| 88 | CSS support |
|---|
| 89 | </li> |
|---|
| 90 | </ul></div> |
|---|
| 91 | </div> |
|---|
| 92 | </div> |
|---|
| 93 | <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
|---|
| 94 | <td align="left"><small><p>Last revised: April 30, 2005 at 01:48:44 GMT</p></small></td> |
|---|
| 95 | <td align="right"><small></small></td> |
|---|
| 96 | </tr></table> |
|---|
| 97 | <hr> |
|---|
| 98 | <div class="spirit-nav"><a accesskey="n" href="quickbook/syntax.html"><img src="images/next.png" alt="Next"></a></div> |
|---|
| 99 | </body> |
|---|
| 100 | </html> |
|---|
