[ceph.git] / ceph / src / boost / tools / quickbook / doc / introduction.qbk

[/
    Copyright 2002,2004,2006 Joel de Guzman, Eric Niebler
    Copyright 2010-2011 Daniel James

    Distributed under the Boost Software License, Version 1.0.
    (See accompanying file LICENSE_1_0.txt or copy at
    http://www.boost.org/LICENSE_1_0.txt)
]

[chapter Introduction
    [quickbook 1.6]
    [compatibility-mode 1.5]
    [id quickbook.intro]
    [source-mode teletype]
]

[:[*['["Why program by hand in five days what you can spend five years of your
life automating?]]]

-- Terrence Parr, author ANTLR/PCCTS
]

Well, QuickBook started as a weekend hack. It was originally intended to be a
sample application using __spirit__. What is it? What you are viewing now, this
documentation, is autogenerated by QuickBook. These files were generated from
one master:

[:[@boost:/tools/quickbook/doc/quickbook.qbk quickbook.qbk]]

Originally named QuickDoc, this funky tool that never dies, evolved into a
funkier tool thanks to Eric Niebler who resurrected the project making it
generate __boostbook__ instead of HTML. The __boostbook__ documentation format
is an extension of __docbook__, an SGML or XML based format for describing
documentation.

[tip You don't need to know anything about __boostbook__ or __docbook__
to use QuickBook. A basic understanding of __docbook__ might help, but
shouldn't be necessary. For really advanced stuff you will need to know
__docbook__, but you can ignore it at first, and maybe continue to do so.
]

QuickBook is a WikiWiki style documentation tool geared towards C++
documentation using simple rules and markup for simple formatting tasks.
QuickBook extends the WikiWiki concept. Like the WikiWiki, QuickBook documents are
simple text files. A single QuickBook document can generate a fully linked set
of nice HTML and PostScript/PDF documents complete with images and syntax-
colorized source code.

Features include:

* generate __boostbook__ xml, to generate HTML, PostScript and PDF
* simple markup to link to Doxygen-generated entities
* macro system for simple text substitution
* simple markup for italics, bold, preformatted, blurbs, code samples,
  tables, URLs, anchors, images, etc.
* automatic syntax coloring of code samples
* CSS support
Commit	Line	Data
7c673cae FG	1	[/
	2	Copyright 2002,2004,2006 Joel de Guzman, Eric Niebler
	3	Copyright 2010-2011 Daniel James
	4
	5	Distributed under the Boost Software License, Version 1.0.
	6	(See accompanying file LICENSE_1_0.txt or copy at
	7	http://www.boost.org/LICENSE_1_0.txt)
	8	]
	9
	10	[chapter Introduction
	11	[quickbook 1.6]
	12	[compatibility-mode 1.5]
	13	[id quickbook.intro]
	14	[source-mode teletype]
	15	]
	16
	17	[:[*['["Why program by hand in five days what you can spend five years of your
	18	life automating?]]]
	19
	20	-- Terrence Parr, author ANTLR/PCCTS
	21	]
	22
	23	Well, QuickBook started as a weekend hack. It was originally intended to be a
	24	sample application using __spirit__. What is it? What you are viewing now, this
	25	documentation, is autogenerated by QuickBook. These files were generated from
	26	one master:
	27
	28	[:[@boost:/tools/quickbook/doc/quickbook.qbk quickbook.qbk]]
	29
	30	Originally named QuickDoc, this funky tool that never dies, evolved into a
	31	funkier tool thanks to Eric Niebler who resurrected the project making it
	32	generate __boostbook__ instead of HTML. The __boostbook__ documentation format
	33	is an extension of __docbook__, an SGML or XML based format for describing
	34	documentation.
	35
	36	[tip You don't need to know anything about __boostbook__ or __docbook__
	37	to use QuickBook. A basic understanding of __docbook__ might help, but
	38	shouldn't be necessary. For really advanced stuff you will need to know
	39	__docbook__, but you can ignore it at first, and maybe continue to do so.
	40	]
	41
	42	QuickBook is a WikiWiki style documentation tool geared towards C++
	43	documentation using simple rules and markup for simple formatting tasks.
	44	QuickBook extends the WikiWiki concept. Like the WikiWiki, QuickBook documents are
	45	simple text files. A single QuickBook document can generate a fully linked set
	46	of nice HTML and PostScript/PDF documents complete with images and syntax-
	47	colorized source code.
	48
	49	Features include:
	50
	51	* generate __boostbook__ xml, to generate HTML, PostScript and PDF
	52	* simple markup to link to Doxygen-generated entities
	53	* macro system for simple text substitution
	54	* simple markup for italics, bold, preformatted, blurbs, code samples,
	55	tables, URLs, anchors, images, etc.
	56	* automatic syntax coloring of code samples
	57	* CSS support