]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | [/============================================================================== |
2 | Copyright (C) 2001-2015 Joel de Guzman | |
3 | Copyright (C) 2001-2011 Hartmut Kaiser | |
4 | ||
5 | Distributed under the Boost Software License, Version 1.0. (See accompanying | |
6 | file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) | |
7 | ===============================================================================/] | |
8 | ||
9 | [section Preface] | |
10 | ||
11 | [:['["Examples of designs that meet most of the criteria for | |
12 | "goodness" (easy to understand, flexible, efficient) are a | |
13 | recursive-descent parser, which is traditional procedural | |
14 | code. Another example is the STL, which is a generic library of | |
15 | containers and algorithms depending crucially on both traditional | |
16 | procedural code and on parametric polymorphism.]] [*--Bjarne | |
17 | Stroustrup]] | |
18 | ||
19 | [heading How to use this manual] | |
20 | ||
21 | This document is roughly divided into 3 parts: | |
22 | ||
23 | # Tutorials: A step by step guide with heavily annotated code. These | |
24 | are meant to get the user acquainted with the library as quickly as | |
25 | possible. The objective is to build the confidence of the user in | |
26 | using the library through abundant examples and detailed | |
27 | instructions. Examples speak volumes and we have volumes of | |
28 | examples! | |
29 | ||
30 | # Abstracts: A high level summary of key topics. The objective is to | |
31 | give the user a high level view of the library, the key concepts, | |
32 | background and theories. | |
33 | ||
34 | # Reference: Detailed formal technical reference. We start with a quick | |
35 | reference -- an easy to use table that maps into the reference proper. | |
36 | The reference proper starts with C++ concepts followed by | |
37 | models of the concepts. | |
38 | ||
39 | Some icons are used to mark certain topics indicative of their relevance. | |
40 | These icons precede some text to indicate: | |
41 | ||
42 | [table Icons | |
43 | ||
44 | [[Icon] [Name] [Meaning]] | |
45 | ||
46 | [[__note__] [Note] [Generally useful information (an aside that | |
47 | doesn't fit in the flow of the text)]] | |
48 | ||
49 | [[__tip__] [Tip] [Suggestion on how to do something | |
50 | (especially something that is not obvious)]] | |
51 | ||
52 | [[__important__] [Important] [Important note on something to take | |
53 | particular notice of]] | |
54 | ||
55 | [[__caution__] [Caution] [Take special care with this - it may | |
56 | not be what you expect and may cause bad | |
57 | results]] | |
58 | ||
59 | [[__danger__] [Danger] [This is likely to cause serious | |
60 | trouble if ignored]] | |
61 | ] | |
62 | ||
63 | This documentation is automatically generated by Boost QuickBook | |
64 | documentation tool. QuickBook can be found in the __boost_tools__. | |
65 | ||
66 | [heading Support] | |
67 | ||
68 | Please direct all questions to Spirit's mailing list. You can subscribe | |
69 | to the __spirit_list__. The mailing list has a searchable archive. A | |
70 | search link to this archive is provided in __spirit__'s home page. You | |
71 | may also read and post messages to the mailing list through | |
72 | __spirit_general__ (thanks to __gmane__). The news group mirrors the | |
73 | mailing list. Here is a link to the archives: __mlist_archive__. | |
74 | ||
75 | [endsect] [/ Preface] |