1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Preface</title> 5<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../index.html" title="Spirit X3 3.0.4"> 8<link rel="up" href="../index.html" title="Spirit X3 3.0.4"> 9<link rel="prev" href="../index.html" title="Spirit X3 3.0.4"> 10<link rel="next" href="introduction.html" title="Introduction"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="../index.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="introduction.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h2 class="title" style="clear: both"> 27<a name="spirit_x3.preface"></a><a class="link" href="preface.html" title="Preface">Preface</a> 28</h2></div></div></div> 29<div class="blockquote"><blockquote class="blockquote"><p> 30 <span class="emphasis"><em><span class="quote">“<span class="quote">Examples of designs that meet most of the criteria for "goodness" 31 (easy to understand, flexible, efficient) are a recursive-descent parser, 32 which is traditional procedural code. Another example is the STL, which is 33 a generic library of containers and algorithms depending crucially on both 34 traditional procedural code and on parametric polymorphism.</span>”</span></em></span> 35 <span class="bold"><strong>--Bjarne Stroustrup</strong></span> 36 </p></blockquote></div> 37<h4> 38<a name="spirit_x3.preface.h0"></a> 39 <span class="phrase"><a name="spirit_x3.preface.how_to_use_this_manual"></a></span><a class="link" href="preface.html#spirit_x3.preface.how_to_use_this_manual">How 40 to use this manual</a> 41 </h4> 42<p> 43 This document is roughly divided into 3 parts: 44 </p> 45<div class="orderedlist"><ol class="orderedlist" type="1"> 46<li class="listitem"> 47 Tutorials: A step by step guide with heavily annotated code. These are 48 meant to get the user acquainted with the library as quickly as possible. 49 The objective is to build the confidence of the user in using the library 50 through abundant examples and detailed instructions. Examples speak volumes 51 and we have volumes of examples! 52 </li> 53<li class="listitem"> 54 Abstracts: A high level summary of key topics. The objective is to give 55 the user a high level view of the library, the key concepts, background 56 and theories. 57 </li> 58<li class="listitem"> 59 Reference: Detailed formal technical reference. We start with a quick reference 60 -- an easy to use table that maps into the reference proper. The reference 61 proper starts with C++ concepts followed by models of the concepts. 62 </li> 63</ol></div> 64<p> 65 Some icons are used to mark certain topics indicative of their relevance. These 66 icons precede some text to indicate: 67 </p> 68<div class="table"> 69<a name="spirit_x3.preface.icons"></a><p class="title"><b>Table 1. Icons</b></p> 70<div class="table-contents"><table class="table" summary="Icons"> 71<colgroup> 72<col> 73<col> 74<col> 75</colgroup> 76<thead><tr> 77<th> 78 <p> 79 Icon 80 </p> 81 </th> 82<th> 83 <p> 84 Name 85 </p> 86 </th> 87<th> 88 <p> 89 Meaning 90 </p> 91 </th> 92</tr></thead> 93<tbody> 94<tr> 95<td> 96 <p> 97 <span class="inlinemediaobject"><img src=".././images/note.png" alt="note"></span> 98 </p> 99 </td> 100<td> 101 <p> 102 Note 103 </p> 104 </td> 105<td> 106 <p> 107 Generally useful information (an aside that doesn't fit in the flow 108 of the text) 109 </p> 110 </td> 111</tr> 112<tr> 113<td> 114 <p> 115 <span class="inlinemediaobject"><img src=".././images/tip.png" alt="tip"></span> 116 </p> 117 </td> 118<td> 119 <p> 120 Tip 121 </p> 122 </td> 123<td> 124 <p> 125 Suggestion on how to do something (especially something that is not 126 obvious) 127 </p> 128 </td> 129</tr> 130<tr> 131<td> 132 <p> 133 <span class="inlinemediaobject"><img src=".././images/important.png" alt="important"></span> 134 </p> 135 </td> 136<td> 137 <p> 138 Important 139 </p> 140 </td> 141<td> 142 <p> 143 Important note on something to take particular notice of 144 </p> 145 </td> 146</tr> 147<tr> 148<td> 149 <p> 150 <span class="inlinemediaobject"><img src=".././images/caution.png" alt="caution"></span> 151 </p> 152 </td> 153<td> 154 <p> 155 Caution 156 </p> 157 </td> 158<td> 159 <p> 160 Take special care with this - it may not be what you expect and may 161 cause bad results 162 </p> 163 </td> 164</tr> 165<tr> 166<td> 167 <p> 168 <span class="inlinemediaobject"><img src=".././images/alert.png" alt="alert"></span> 169 </p> 170 </td> 171<td> 172 <p> 173 Danger 174 </p> 175 </td> 176<td> 177 <p> 178 This is likely to cause serious trouble if ignored 179 </p> 180 </td> 181</tr> 182</tbody> 183</table></div> 184</div> 185<br class="table-break"><p> 186 This documentation is automatically generated by Boost QuickBook documentation 187 tool. QuickBook can be found in the <a href="http://www.boost.org/tools/index.html" target="_top">Boost 188 Tools</a>. 189 </p> 190<h4> 191<a name="spirit_x3.preface.h1"></a> 192 <span class="phrase"><a name="spirit_x3.preface.support"></a></span><a class="link" href="preface.html#spirit_x3.preface.support">Support</a> 193 </h4> 194<p> 195 Please direct all questions to Spirit's mailing list. You can subscribe to 196 the <a href="https://lists.sourceforge.net/lists/listinfo/spirit-general" target="_top">Spirit 197 Mailing List</a>. The mailing list has a searchable archive. A search link 198 to this archive is provided in <a href="http://boost-spirit.com" target="_top">Spirit</a>'s 199 home page. You may also read and post messages to the mailing list through 200 <a href="news://news.gmane.org/gmane.comp.spirit.general" target="_top">Spirit General 201 NNTP news portal</a> (thanks to <a href="http://www.gmane.org" target="_top">Gmane</a>). 202 The news group mirrors the mailing list. Here is a link to the archives: <a href="http://news.gmane.org/gmane.comp.parsers.spirit.general" target="_top">http://news.gmane.org/gmane.comp.parsers.spirit.general</a>. 203 </p> 204</div> 205<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 206<td align="left"></td> 207<td align="right"><div class="copyright-footer">Copyright © 2001-2018 Joel de Guzman, 208 Hartmut Kaiser<p> 209 Distributed under the Boost Software License, Version 1.0. (See accompanying 210 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>) 211 </p> 212</div></td> 213</tr></table> 214<hr> 215<div class="spirit-nav"> 216<a accesskey="p" href="../index.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="introduction.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 217</div> 218</body> 219</html> 220
