|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r71017 - in branches/quickbook-dev/tools: doc-guide quickbook/doc
From: dnljms_at_[hidden]
Date: 2011-04-05 17:14:28
Author: danieljames
Date: 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
New Revision: 71017
URL: http://svn.boost.org/trac/boost/changeset/71017
Log:
Doc tools: Combined documentation.
Added:
branches/quickbook-dev/tools/doc-guide/doc-tools.qbk (contents, props changed)
branches/quickbook-dev/tools/doc-guide/documentation.qbk (contents, props changed)
branches/quickbook-dev/tools/doc-guide/index.html (contents, props changed)
branches/quickbook-dev/tools/doc-guide/preface.qbk (contents, props changed)
Text files modified:
branches/quickbook-dev/tools/doc-guide/Jamfile.v2 | 20 +++++---------------
branches/quickbook-dev/tools/doc-guide/install.qbk | 7 ++++---
branches/quickbook-dev/tools/quickbook/doc/block.qbk | 8 +++++---
branches/quickbook-dev/tools/quickbook/doc/change_log.qbk | 8 +++++---
branches/quickbook-dev/tools/quickbook/doc/editors.qbk | 8 +++++---
branches/quickbook-dev/tools/quickbook/doc/faq.qbk | 8 +++++---
branches/quickbook-dev/tools/quickbook/doc/install.qbk | 8 +++++---
branches/quickbook-dev/tools/quickbook/doc/intro.qbk | 8 +++++---
branches/quickbook-dev/tools/quickbook/doc/phrase.qbk | 8 +++++---
branches/quickbook-dev/tools/quickbook/doc/quickbook.qbk | 10 ++--------
branches/quickbook-dev/tools/quickbook/doc/ref.qbk | 8 +++++---
branches/quickbook-dev/tools/quickbook/doc/syntax.qbk | 8 +++++---
12 files changed, 56 insertions(+), 53 deletions(-)
Modified: branches/quickbook-dev/tools/doc-guide/Jamfile.v2
==============================================================================
--- branches/quickbook-dev/tools/doc-guide/Jamfile.v2 (original)
+++ branches/quickbook-dev/tools/doc-guide/Jamfile.v2 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -6,27 +6,17 @@
# http://www.boost.org/LICENSE_1_0.txt)
#==============================================================================
-project boost/quickbook/doc ;
+project boost/doc-guide ;
using boostbook ;
using quickbook ;
-xml install : install.qbk ;
+xml doc-tools : doc-tools.qbk ;
-path-constant images : . ;
-
-boostbook standalone
+boostbook doc-tools-book
:
- install
+ doc-tools
:
<xsl:param>boost.root=../../..
- <xsl:param>generate.section.toc.level=3
- <xsl:param>chunk.section.depth=1
- <xsl:param>chunk.first.sections=1
-
- <format>html:<xsl:param>img.src.path=../
-
- #<xsl:param>callout.graphics.path=../../images/callouts//
- <format>pdf:<xsl:param>img.src.path=$(images)/
- <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html
+ <xsl:param>img.src.path=../
;
Added: branches/quickbook-dev/tools/doc-guide/doc-tools.qbk
==============================================================================
--- (empty file)
+++ branches/quickbook-dev/tools/doc-guide/doc-tools.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -0,0 +1,9 @@
+[book Boost Documentation Tools
+ [quickbook 1.6]
+ [id doc-guide]
+]
+
+[include preface.qbk]
+[include documentation.qbk]
+[include ../quickbook/doc/quickbook.qbk]
+[xinclude ../boostbook/doc/boostbook.xml]
\ No newline at end of file
Added: branches/quickbook-dev/tools/doc-guide/documentation.qbk
==============================================================================
--- (empty file)
+++ branches/quickbook-dev/tools/doc-guide/documentation.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -0,0 +1,6 @@
+[part Documentation
+ [quickbook 1.6]
+ [id doc-guide.docs]
+]
+
+[include install.qbk]
\ No newline at end of file
Added: branches/quickbook-dev/tools/doc-guide/index.html
==============================================================================
--- (empty file)
+++ branches/quickbook-dev/tools/doc-guide/index.html 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -0,0 +1,15 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+ <head>
+ <meta http-equiv="refresh" content="0; URL=html/index.html">
+ </head>
+ <body>
+ Automatic redirection failed, click this
+ link
+ <p>Copyright Daniel James 2011</p>
+ <p>Distributed under the Boost Software License, Version 1.0. (See accompanying file
+ LICENSE_1_0.txt or copy at
+ www.boost.org/LICENSE_1_0.txt).
+ </p>
+ </body>
+</html>
Modified: branches/quickbook-dev/tools/doc-guide/install.qbk
==============================================================================
--- branches/quickbook-dev/tools/doc-guide/install.qbk (original)
+++ branches/quickbook-dev/tools/doc-guide/install.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -1,6 +1,7 @@
-[article How to build boost documentation
-[quickbook 1.5]
-[source-mode teletype]
+[chapter Installation
+ [quickbook 1.5]
+ [source-mode teletype]
+ [id doc-guide.install]
]
Required packages (see below for platform specific instructions):
Added: branches/quickbook-dev/tools/doc-guide/preface.qbk
==============================================================================
--- (empty file)
+++ branches/quickbook-dev/tools/doc-guide/preface.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -0,0 +1,6 @@
+[preface Introduction
+ [quickbook 1.6]
+ [id doc-guide.preface]
+]
+
+Blah, blah, blah.
\ No newline at end of file
Modified: branches/quickbook-dev/tools/quickbook/doc/block.qbk
==============================================================================
--- branches/quickbook-dev/tools/quickbook/doc/block.qbk (original)
+++ branches/quickbook-dev/tools/quickbook/doc/block.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -7,7 +7,11 @@
[@http://www.boost.org/LICENSE_1_0.txt])
]
-[section:block Block Level Elements]
+[chapter Block Level Elements
+ [quickbook 1.5]
+ [id quickbook.block]
+ [source-mode teletype]
+]
[section xinclude]
@@ -1106,5 +1110,3 @@
See the actual code here: [@boost:/tools/quickbook/test/stub.cpp]
[endsect] [/Import]
-
-[endsect] [/Block Level Elements]
Modified: branches/quickbook-dev/tools/quickbook/doc/change_log.qbk
==============================================================================
--- branches/quickbook-dev/tools/quickbook/doc/change_log.qbk (original)
+++ branches/quickbook-dev/tools/quickbook/doc/change_log.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -7,7 +7,11 @@
[@http://www.boost.org/LICENSE_1_0.txt])
]
-[section:change_log Change Log]
+[chapter Change Log
+ [quickbook 1.5]
+ [id quickbook.change_log]
+ [source-mode teletype]
+]
[section:versions Language Versions]
@@ -243,5 +247,3 @@
[endsect] [/releases]
-
-[endsect] [/Change log]
Modified: branches/quickbook-dev/tools/quickbook/doc/editors.qbk
==============================================================================
--- branches/quickbook-dev/tools/quickbook/doc/editors.qbk (original)
+++ branches/quickbook-dev/tools/quickbook/doc/editors.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -7,7 +7,11 @@
[@http://www.boost.org/LICENSE_1_0.txt])
]
-[section:editors Editor Support]
+[chapter Editor Support
+ [quickbook 1.5]
+ [id quickbook.editors]
+ [source-mode teletype]
+]
Editing quickbook files is usually done with text editors both simple and
powerful. The following sections list the settings for some editors which can
@@ -49,5 +53,3 @@
[/ KDE support (Kate, KWrite, Konqueror, KDevelop) ]
[include ../extra/katepart/katepart.qbk]
-
-[endsect] [/editors]
Modified: branches/quickbook-dev/tools/quickbook/doc/faq.qbk
==============================================================================
--- branches/quickbook-dev/tools/quickbook/doc/faq.qbk (original)
+++ branches/quickbook-dev/tools/quickbook/doc/faq.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -7,7 +7,11 @@
[@http://www.boost.org/LICENSE_1_0.txt])
]
-[section:faq Frequently Asked Questions]
+[chapter Frequently Asked Questions
+ [quickbook 1.5]
+ [id quickbook.faq]
+ [source-mode teletype]
+]
[heading Can I use QuickBook for non-Boost documentation?]
@@ -48,5 +52,3 @@
QuickBook (which IMO is a whole lot easier to edit and maintain).
--John Maddock
-
-[endsect] [/faq]
Modified: branches/quickbook-dev/tools/quickbook/doc/install.qbk
==============================================================================
--- branches/quickbook-dev/tools/quickbook/doc/install.qbk (original)
+++ branches/quickbook-dev/tools/quickbook/doc/install.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -7,7 +7,11 @@
[@http://www.boost.org/LICENSE_1_0.txt])
]
-[section:install Installation and configuration]
+[chapter Installation and configuration
+ [quickbook 1.5]
+ [id quickbook.install]
+ [source-mode teletype]
+]
This section provides some guidelines on how to install and configure
BoostBook and Quickbook under several operating systems. Before installing
@@ -308,5 +312,3 @@
;
[endsect] [/Linux]
-
-[endsect] [/Installation and configuration]
Modified: branches/quickbook-dev/tools/quickbook/doc/intro.qbk
==============================================================================
--- branches/quickbook-dev/tools/quickbook/doc/intro.qbk (original)
+++ branches/quickbook-dev/tools/quickbook/doc/intro.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -7,7 +7,11 @@
[@http://www.boost.org/LICENSE_1_0.txt])
]
-[section:intro Introduction]
+[chapter Introduction
+ [quickbook 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?]]]
@@ -44,5 +48,3 @@
tables, URLs, anchors, images, etc.
* automatic syntax coloring of code samples
* CSS support
-
-[endsect] [/Introduction]
Modified: branches/quickbook-dev/tools/quickbook/doc/phrase.qbk
==============================================================================
--- branches/quickbook-dev/tools/quickbook/doc/phrase.qbk (original)
+++ branches/quickbook-dev/tools/quickbook/doc/phrase.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -7,7 +7,11 @@
[@http://www.boost.org/LICENSE_1_0.txt])
]
-[section:phrase Phrase Level Elements]
+[chapter Phrase Level Elements
+ [quickbook 1.5]
+ [id quickbook.phrase]
+ [source-mode teletype]
+]
[section Font Styles]
@@ -518,5 +522,3 @@
Yes![footnote Conditional Generation makes quickbook turing complete.]
[endsect] [/Condition Generation]
-
-[endsect] [/Phrase Level Elements]
Modified: branches/quickbook-dev/tools/quickbook/doc/quickbook.qbk
==============================================================================
--- branches/quickbook-dev/tools/quickbook/doc/quickbook.qbk (original)
+++ branches/quickbook-dev/tools/quickbook/doc/quickbook.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -1,5 +1,5 @@
-[article Quickbook
- [quickbook 1.5]
+[part Quickbook
+ [quickbook 1.6]
[version 1.5]
[authors [de Guzman, Joel], [Niebler, Eric], [James, Daniel]]
[copyright 2002 2004 2006 Joel de Guzman, Eric Niebler]
@@ -14,12 +14,6 @@
[source-mode teletype]
]
-[/ QuickBook Document version 1.5 ]
-[/ Sept 24, 2002 ]
-[/ Sept 2, 2004 ]
-[/ Feb 14, 2005 ]
-[/ Sept 13, 2005 ]
-
[/ Some links]
[def :-) [$../src/images/smiley.png]]
Modified: branches/quickbook-dev/tools/quickbook/doc/ref.qbk
==============================================================================
--- branches/quickbook-dev/tools/quickbook/doc/ref.qbk (original)
+++ branches/quickbook-dev/tools/quickbook/doc/ref.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -7,7 +7,11 @@
[@http://www.boost.org/LICENSE_1_0.txt])
]
-[section:ref Quick Reference]
+[chapter Quick Reference
+ [quickbook 1.5]
+ [id quickbook.ref]
+ [source-mode teletype]
+]
[teletype]
@@ -99,5 +103,3 @@
[[conditional generation]
[[^'''[? symbol phrase]''']] [__cond__]]
]
-
-[endsect] [/ quick reference]
Modified: branches/quickbook-dev/tools/quickbook/doc/syntax.qbk
==============================================================================
--- branches/quickbook-dev/tools/quickbook/doc/syntax.qbk (original)
+++ branches/quickbook-dev/tools/quickbook/doc/syntax.qbk 2011-04-05 17:14:26 EDT (Tue, 05 Apr 2011)
@@ -7,7 +7,11 @@
[@http://www.boost.org/LICENSE_1_0.txt])
]
-[section:syntax Syntax Summary]
+[chapter Syntax Summary
+ [quickbook 1.5]
+ [id quickbook.syntax]
+ [source-mode teletype]
+]
A simple quickbook document might look something like:
@@ -228,5 +232,3 @@
[/ for testing [*only ] ]
[endsect] [/Comments]
-
-[endsect] [/Syntax Summary]
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk