| 1 | <html> |
|---|
| 2 | <head> |
|---|
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
|---|
| 4 | <title>Chapter 23. Quickbook 1.3</title> |
|---|
| 5 | <link rel="stylesheet" href="boostbook.css" type="text/css"> |
|---|
| 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> |
|---|
| 7 | <link rel="start" href="index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> |
|---|
| 8 | <link rel="up" href="tools.html" title="Part II. Boost Tools"> |
|---|
| 9 | <link rel="prev" href="boostbook/dtd/rationale.html" title=" |
|---|
| 10 | BoostBook element rationale"> |
|---|
| 11 | <link rel="next" href="quickbook/change_log.html" title=" Change Log"> |
|---|
| 12 | </head> |
|---|
| 13 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
|---|
| 14 | <table cellpadding="2" width="100%"> |
|---|
| 15 | <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../boost.png"></td> |
|---|
| 16 | <td align="center"><a href="../../index.htm">Home</a></td> |
|---|
| 17 | <td align="center"><a href="../../libs/libraries.htm">Libraries</a></td> |
|---|
| 18 | <td align="center"><a href="../../people/people.htm">People</a></td> |
|---|
| 19 | <td align="center"><a href="../../more/faq.htm">FAQ</a></td> |
|---|
| 20 | <td align="center"><a href="../../more/index.htm">More</a></td> |
|---|
| 21 | </table> |
|---|
| 22 | <hr> |
|---|
| 23 | <div class="spirit-nav"> |
|---|
| 24 | <a accesskey="p" href="boostbook/dtd/rationale.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="tools.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="quickbook/change_log.html"><img src="images/next.png" alt="Next"></a> |
|---|
| 25 | </div> |
|---|
| 26 | <div class="chapter" lang="en"> |
|---|
| 27 | <div class="titlepage"><div> |
|---|
| 28 | <div><h2 class="title"> |
|---|
| 29 | <a name="quickbook"></a>Chapter 23. Quickbook 1.3</h2></div> |
|---|
| 30 | <div><div class="author"><h3 class="author"> |
|---|
| 31 | <span class="firstname">Joel</span> <span class="surname">de Guzman</span> |
|---|
| 32 | </h3></div></div> |
|---|
| 33 | <div><div class="author"><h3 class="author"> |
|---|
| 34 | <span class="firstname">Eric</span> <span class="surname">Niebler</span> |
|---|
| 35 | </h3></div></div> |
|---|
| 36 | <div><p class="copyright">Copyright © 2002, 2004 Joel de Guzman, Eric Niebler</p></div> |
|---|
| 37 | <div><div class="legalnotice"> |
|---|
| 38 | <a name="id2086262"></a><p> |
|---|
| 39 | Distributed under the Boost Software License, Version 1.0. (See accompanying |
|---|
| 40 | 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>) |
|---|
| 41 | </p> |
|---|
| 42 | </div></div> |
|---|
| 43 | </div></div> |
|---|
| 44 | <div class="toc"> |
|---|
| 45 | <p><b>Table of Contents</b></p> |
|---|
| 46 | <dl> |
|---|
| 47 | <dt><span class="section"><a href="quickbook.html#quickbook.intro"> Introduction</a></span></dt> |
|---|
| 48 | <dt><span class="section"><a href="quickbook/change_log.html"> Change Log</a></span></dt> |
|---|
| 49 | <dt><span class="section"><a href="quickbook/syntax.html"> Syntax Summary</a></span></dt> |
|---|
| 50 | <dd><dl> |
|---|
| 51 | <dt><span class="section"><a href="quickbook/syntax.html#quickbook.syntax.comments">Comments</a></span></dt> |
|---|
| 52 | <dt><span class="section"><a href="quickbook/syntax.html#quickbook.syntax.phrase"> Phrase Level Elements</a></span></dt> |
|---|
| 53 | <dt><span class="section"><a href="quickbook/syntax.html#quickbook.syntax.block"> Block Level Elements</a></span></dt> |
|---|
| 54 | </dl></dd> |
|---|
| 55 | <dt><span class="section"><a href="quickbook/ref.html"> Quick Reference</a></span></dt> |
|---|
| 56 | </dl> |
|---|
| 57 | </div> |
|---|
| 58 | <div class="section" lang="en"> |
|---|
| 59 | <div class="titlepage"><div><div><h2 class="title" style="clear: both"> |
|---|
| 60 | <a name="quickbook.intro"></a> Introduction</h2></div></div></div> |
|---|
| 61 | <div class="blockquote"><blockquote class="blockquote"><p> |
|---|
| 62 | <span class="bold"><strong><span class="emphasis"><em>“<span class="quote">Why program by hand in five days what |
|---|
| 63 | you can spend five years of your life automating?</span>”</em></span></strong></span><br> |
|---|
| 64 | <br> -- Terrence Parr, author ANTLR/PCCTS |
|---|
| 65 | </p></blockquote></div> |
|---|
| 66 | <p> |
|---|
| 67 | Well, QuickBook started as a weekend hack. It was originally intended to be |
|---|
| 68 | a sample application using <a href="http://spirit.sourceforge.net" target="_top">Spirit</a>. |
|---|
| 69 | What is it? What you are viewing now, this documentation, is autogenerated |
|---|
| 70 | by QuickBook. These files were generated from one master: |
|---|
| 71 | </p> |
|---|
| 72 | <div class="blockquote"><blockquote class="blockquote"><p> |
|---|
| 73 | <a href="../quickbook.qbk" target="_top">quickbook.qbk</a> |
|---|
| 74 | </p></blockquote></div> |
|---|
| 75 | <p> |
|---|
| 76 | Originally named QuickDoc, this funky tool that never dies evolved into a funkier |
|---|
| 77 | tool thanks to Eric Niebler who resurrected the project making it generate |
|---|
| 78 | <a href="http://www.boost.org/doc/html/boostbook.html" target="_top">BoostBook</a> |
|---|
| 79 | instead of HTML. The <a href="http://www.boost.org/doc/html/boostbook.html" target="_top">BoostBook</a> |
|---|
| 80 | documentation format is an extension of <a href="http://www.docbook.org/" target="_top">DocBook</a>, |
|---|
| 81 | an SGML or XML based format for describing documentation. |
|---|
| 82 | </p> |
|---|
| 83 | <p> |
|---|
| 84 | QuickBook is a WikiWiki style documentation tool geared towards C++ documentation |
|---|
| 85 | using simple rules and markup for simple formatting tasks. QuickBook extends |
|---|
| 86 | the WikiWiki concept. Like the WikiWiki, QuickBook documents are simple text |
|---|
| 87 | files. A single QuickBook document can generate a fully linked set of nice |
|---|
| 88 | HTML and PostScript/PDF documents complete with images and syntax- colorized |
|---|
| 89 | source code. |
|---|
| 90 | </p> |
|---|
| 91 | <p> |
|---|
| 92 | Features include: |
|---|
| 93 | </p> |
|---|
| 94 | <div class="itemizedlist"><ul type="disc"> |
|---|
| 95 | <li> |
|---|
| 96 | generate <a href="http://www.boost.org/doc/html/boostbook.html" target="_top">BoostBook</a> |
|---|
| 97 | xml, to generate HTML, PostScript and PDF |
|---|
| 98 | </li> |
|---|
| 99 | <li> |
|---|
| 100 | simple markup to link to Doxygen-generated entities |
|---|
| 101 | </li> |
|---|
| 102 | <li> |
|---|
| 103 | macro system for simple text substitution |
|---|
| 104 | </li> |
|---|
| 105 | <li> |
|---|
| 106 | simple markup for italics, bold, preformatted, blurbs, code samples, tables, |
|---|
| 107 | URLs, anchors, images, etc. |
|---|
| 108 | </li> |
|---|
| 109 | <li> |
|---|
| 110 | automatic syntax coloring of code samples |
|---|
| 111 | </li> |
|---|
| 112 | <li> |
|---|
| 113 | CSS support |
|---|
| 114 | </li> |
|---|
| 115 | </ul></div> |
|---|
| 116 | </div> |
|---|
| 117 | </div> |
|---|
| 118 | <table width="100%"><tr> |
|---|
| 119 | <td align="left"></td> |
|---|
| 120 | <td align="right"><small></small></td> |
|---|
| 121 | </tr></table> |
|---|
| 122 | <hr> |
|---|
| 123 | <div class="spirit-nav"> |
|---|
| 124 | <a accesskey="p" href="boostbook/dtd/rationale.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="tools.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="quickbook/change_log.html"><img src="images/next.png" alt="Next"></a> |
|---|
| 125 | </div> |
|---|
| 126 | </body> |
|---|
| 127 | </html> |
|---|
