1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Chapter 50. Quickbook 1.7</title> 6<link rel="stylesheet" href="../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="tools.html" title="Part II. Boost Tools"> 10<link rel="prev" href="boostbook/dtd/rationale.html" title="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%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../boost.png"></td> 16<td align="center"><a href="../../index.html">Home</a></td> 17<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="boostbook/dtd/rationale.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="tools.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="quickbook/change_log.html"><img src="../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="chapter"> 27<div class="titlepage"><div> 28<div><h2 class="title"> 29<a name="quickbook"></a>Chapter 50. Quickbook 1.7</h2></div> 30<div><div class="authorgroup"> 31<div class="author"><h3 class="author"> 32<span class="firstname">Joel</span> <span class="surname">de Guzman</span> 33</h3></div> 34<div class="author"><h3 class="author"> 35<span class="firstname">Eric</span> <span class="surname">Niebler</span> 36</h3></div> 37</div></div> 38<div><p class="copyright">Copyright © 2002, 2004, 2006 Joel de Guzman, 39 Eric Niebler</p></div> 40<div><p class="copyright">Copyright © 2010-2017 Daniel James</p></div> 41<div><div class="legalnotice"> 42<a name="quickbook.legal"></a><p> 43 Distributed under the Boost Software License, Version 1.0. (See accompanying 44 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>) 45 </p> 46</div></div> 47</div></div> 48<div class="toc"> 49<p><b>Table of Contents</b></p> 50<dl class="toc"> 51<dt><span class="section"><a href="quickbook.html#quickbook.intro">Introduction</a></span></dt> 52<dt><span class="section"><a href="quickbook/change_log.html">Change Log</a></span></dt> 53<dt><span class="section"><a href="quickbook/command_line.html">Command Line Usage</a></span></dt> 54<dd><dl><dt><span class="section"><a href="quickbook/command_line.html#quickbook.command_line.options">Command Line Options</a></span></dt></dl></dd> 55<dt><span class="section"><a href="quickbook/syntax.html">Syntax Summary</a></span></dt> 56<dd><dl><dt><span class="section"><a href="quickbook/syntax.html#quickbook.syntax.comments">Comments</a></span></dt></dl></dd> 57<dt><span class="section"><a href="quickbook/syntax/structure.html">Document Structure</a></span></dt> 58<dd><dl> 59<dt><span class="section"><a href="quickbook/syntax/structure.html#quickbook.syntax.structure.docinfo">Document 60 Info</a></span></dt> 61<dt><span class="section"><a href="quickbook/syntax/structure.html#quickbook.syntax.structure.section">Sections</a></span></dt> 62</dl></dd> 63<dt><span class="section"><a href="quickbook/syntax/phrase.html">Phrase Level Elements</a></span></dt> 64<dd><dl> 65<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.font_styles">Font 66 Styles</a></span></dt> 67<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.replaceable">Replaceable</a></span></dt> 68<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.quotations">Quotations</a></span></dt> 69<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.simple_formatting">Simple 70 formatting</a></span></dt> 71<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.role">Role</a></span></dt> 72<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.inline_code">Inline 73 code</a></span></dt> 74<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.code_blocks">Code 75 blocks</a></span></dt> 76<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.source_mode">Source 77 Mode</a></span></dt> 78<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.line_break">line-break</a></span></dt> 79<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.anchors">Anchors</a></span></dt> 80<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.links">Links</a></span></dt> 81<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.anchor_links">Anchor 82 links</a></span></dt> 83<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.refentry_links">refentry 84 links</a></span></dt> 85<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.code_links">Code 86 Links</a></span></dt> 87<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.escape">Escape</a></span></dt> 88<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.single_char_escape">Single 89 char escape</a></span></dt> 90<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.unicode_escape">Unicode 91 escape</a></span></dt> 92<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.images">Images</a></span></dt> 93<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.footnotes">Footnotes</a></span></dt> 94<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.macro_expansion">Macro 95 Expansion</a></span></dt> 96<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.template_expansion">Template 97 Expansion</a></span></dt> 98<dt><span class="section"><a href="quickbook/syntax/phrase.html#quickbook.syntax.phrase.cond">Conditional 99 Generation</a></span></dt> 100</dl></dd> 101<dt><span class="section"><a href="quickbook/syntax/block.html">Block Level Elements</a></span></dt> 102<dd><dl> 103<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.xinclude">xinclude</a></span></dt> 104<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.paragraphs">Paragraphs</a></span></dt> 105<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.lists">Lists</a></span></dt> 106<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.code">Code</a></span></dt> 107<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.escape_back">Escaping 108 Back To QuickBook</a></span></dt> 109<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.preformatted">Preformatted</a></span></dt> 110<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.blockquote">Blockquote</a></span></dt> 111<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.admonitions">Admonitions</a></span></dt> 112<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.headings">Headings</a></span></dt> 113<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.generic_heading">Generic 114 Heading</a></span></dt> 115<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.macros">Macros</a></span></dt> 116<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.predefined_macros">Predefined 117 Macros</a></span></dt> 118<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.templates">Templates</a></span></dt> 119<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.blurbs">Blurbs</a></span></dt> 120<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.tables">Tables</a></span></dt> 121<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.variable_lists">Variable 122 Lists</a></span></dt> 123<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.include">Include</a></span></dt> 124<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.import">Import</a></span></dt> 125<dt><span class="section"><a href="quickbook/syntax/block.html#quickbook.syntax.block.block">Plain 126 blocks</a></span></dt> 127</dl></dd> 128<dt><span class="section"><a href="quickbook/versions.html">Language Versions</a></span></dt> 129<dd><dl> 130<dt><span class="section"><a href="quickbook/versions.html#quickbook.versions.upgrading">Upgrading to a new version</a></span></dt> 131<dt><span class="section"><a href="quickbook/versions.html#quickbook.versions.stable">Stable Versions</a></span></dt> 132<dt><span class="section"><a href="quickbook/versions.html#language_versions.1_6">Quickbook 1.6</a></span></dt> 133<dt><span class="section"><a href="quickbook/versions.html#language_versions.1_7">Quickbook 1.7</a></span></dt> 134</dl></dd> 135<dt><span class="section"><a href="quickbook/install.html">Installation and configuration</a></span></dt> 136<dd><dl> 137<dt><span class="section"><a href="quickbook/install.html#quickbook.install.macosx">Mac OS X</a></span></dt> 138<dt><span class="section"><a href="quickbook/install.html#quickbook.install.windows">Windows 2000, XP, 2003, Vista, 139 7</a></span></dt> 140<dt><span class="section"><a href="quickbook/install.html#quickbook.install.linux">Debian, Ubuntu</a></span></dt> 141</dl></dd> 142<dt><span class="section"><a href="quickbook/editors.html">Editor Support</a></span></dt> 143<dd><dl> 144<dt><span class="section"><a href="quickbook/editors.html#quickbook.editors.scite">Scintilla Text Editor</a></span></dt> 145<dt><span class="section"><a href="quickbook/editors.html#editor_support.kde_support">KDE Support</a></span></dt> 146</dl></dd> 147<dt><span class="section"><a href="quickbook/faq.html">Frequently Asked Questions</a></span></dt> 148<dt><span class="section"><a href="quickbook/ref.html">Quick Reference</a></span></dt> 149</dl> 150</div> 151<div class="section"> 152<div class="titlepage"><div><div><h2 class="title" style="clear: both"> 153<a name="quickbook.intro"></a>Introduction</h2></div></div></div> 154<div class="blockquote"><blockquote class="blockquote"> 155<p> 156 <span class="bold"><strong><span class="emphasis"><em><span class="quote">“<span class="quote">Why program by hand in five days what 157 you can spend five years of your life automating?</span>”</span></em></span></strong></span> 158 </p> 159<p> 160 -- Terrence Parr, author ANTLR/PCCTS 161 </p> 162</blockquote></div> 163<p> 164 Well, QuickBook started as a weekend hack. It was originally intended to be 165 a sample application using <a href="http://spirit.sourceforge.net" target="_top">Spirit</a>. 166 What is it? What you are viewing now, this documentation, is autogenerated 167 by QuickBook. These files were generated from one master: 168 </p> 169<div class="blockquote"><blockquote class="blockquote"><p> 170 <a href="../../tools/quickbook/doc/quickbook.qbk" target="_top">quickbook.qbk</a> 171 </p></blockquote></div> 172<p> 173 Originally named QuickDoc, this funky tool that never dies, evolved into a 174 funkier tool thanks to Eric Niebler who resurrected the project making it generate 175 <a href="http://www.boost.org/doc/html/boostbook.html" target="_top">BoostBook</a> 176 instead of HTML. The <a href="http://www.boost.org/doc/html/boostbook.html" target="_top">BoostBook</a> 177 documentation format is an extension of <a href="http://www.docbook.org/" target="_top">DocBook</a>, 178 an SGML or XML based format for describing documentation. 179 </p> 180<div class="tip"><table border="0" summary="Tip"> 181<tr> 182<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../doc/src/images/tip.png"></td> 183<th align="left">Tip</th> 184</tr> 185<tr><td align="left" valign="top"><p> 186 You don't need to know anything about <a href="http://www.boost.org/doc/html/boostbook.html" target="_top">BoostBook</a> 187 or <a href="http://www.docbook.org/" target="_top">DocBook</a> to use QuickBook. 188 A basic understanding of <a href="http://www.docbook.org/" target="_top">DocBook</a> 189 might help, but shouldn't be necessary. For really advanced stuff you will 190 need to know <a href="http://www.docbook.org/" target="_top">DocBook</a>, but you 191 can ignore it at first, and maybe continue to do so. 192 </p></td></tr> 193</table></div> 194<p> 195 QuickBook is a WikiWiki style documentation tool geared towards C++ documentation 196 using simple rules and markup for simple formatting tasks. QuickBook extends 197 the WikiWiki concept. Like the WikiWiki, QuickBook documents are simple text 198 files. A single QuickBook document can generate a fully linked set of nice 199 HTML and PostScript/PDF documents complete with images and syntax- colorized 200 source code. 201 </p> 202<p> 203 Features include: 204 </p> 205<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 206<li class="listitem"> 207 generate <a href="http://www.boost.org/doc/html/boostbook.html" target="_top">BoostBook</a> 208 xml, to generate HTML, PostScript and PDF 209 </li> 210<li class="listitem"> 211 simple markup to link to Doxygen-generated entities 212 </li> 213<li class="listitem"> 214 macro system for simple text substitution 215 </li> 216<li class="listitem"> 217 simple markup for italics, bold, preformatted, blurbs, code samples, tables, 218 URLs, anchors, images, etc. 219 </li> 220<li class="listitem"> 221 automatic syntax coloring of code samples 222 </li> 223<li class="listitem"> 224 CSS support 225 </li> 226</ul></div> 227</div> 228</div> 229<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 230<td align="left"></td> 231<td align="right"><div class="copyright-footer"></div></td> 232</tr></table> 233<hr> 234<div class="spirit-nav"> 235<a accesskey="p" href="boostbook/dtd/rationale.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="tools.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="quickbook/change_log.html"><img src="../../doc/src/images/next.png" alt="Next"></a> 236</div> 237</body> 238</html> 239
