[Home]Boost Documentation Format

BOOST WIKI | RecentChanges | Preferences | Page List | Links List

Difference (from prior major revision) (no other diffs)

Changed: 1,115c1,50



BoostBook? is an XML format for documenting Boost libraries. It is based on DocBook, providing extensions to allow authors to describe library interfaces and then generate documentation that is consistent across all Boost libraries. It is currently used for the Any, Array, Function, Ref, Signals, and Variant libraries.

If you are interested in this, then Sign up for a Task.

There is a new mailing list for this called boost-docs. To sign up go to https://lists.sourceforge.net/lists/listinfo/boost-docs

Before you start you might want to understand the requirements

BoostBook? documentation for Boost CVS is generated nightly by Metacomm at http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/index.html.

The Graphical Overview




This diagram represents a sketch of what we are attempting to create.

(As developed by Doug G and enhanced by David B)


+---------+
| Doxygen |--------+ +---------+
+---------+ | +->| (X)HTML |
v | +---------+
+----------+ +---------+ +---------+ | +-----+
| ReStText |--> | C++ XML |-->(merger)--> | DocBook |--+--->| TeX |-+
+----------+ +---------+ A +---------+ | +-----+ |
^ | | +----+ |
+----------+ | | +->| FO |-+ |
| Synopsis |-------+ | +----+ | |
+----------+ | V V
| +--------+
+-----------+ +---------+ | PS/PDF |
| Developer |-------> | C++ XML | +--------+
+-----------+ +---------+

Getting Started



The "Getting Started" guide to BoostBook? has moved to
http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/boostbook.html

References and Other Tools




*Input Tools
**Synopsis (unsupported) http://synopsis.sourceforge.net/ Instructions for building Synopsis
**Doxygen http://www.stack.nl/~dimitri/doxygen/
**reST (unsupported) http://docutils.sourceforge.net/ (reStructuredText? is now part of docutils)
*Storage Formats
**DocBook http://www.docbook.org
**LaTeX? (unsupported) http://www.latex-project.org/
*Dot Net Documentation Stuff
** NDOC Project http://ndoc.sourceforge.net/
** Article on C# documenation http://www.squiffler.com/squiffler/article.aspx?id=1

BoostBook? is an XML format for documenting Boost libraries. It is based on DocBook, providing extensions to allow authors to describe library interfaces and then generate documentation that is consistent across all Boost libraries. It is currently used for the Any, Array, Function, Ref, Signals, and Variant libraries.

If you are interested in this, then Sign up for a Task.

There is a new mailing list for this called boost-docs. To sign up go to https://lists.sourceforge.net/lists/listinfo/boost-docs

Before you start you might want to understand the requirements

BoostBook? documentation for Boost CVS is generated nightly by Metacomm at http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/index.html.

The Graphical Overview

This diagram represents a sketch of what we are attempting to create.

(As developed by Doug G and enhanced by David B)

 +---------+                                                  
 | Doxygen |--------+                                      +---------+
 +---------+        |                                   +->| (X)HTML |
                    v                                   |  +---------+
 +----------+    +---------+               +---------+  |    +-----+  
 | ReStText |--> | C++ XML |-->(merger)--> | DocBook |--+--->| TeX |-+
 +----------+    +---------+     A         +---------+  |    +-----+ |
                    ^            |                      |  +----+    |
 +----------+       |            |                      +->| FO |-+  |
 | Synopsis |-------+            |                         +----+ |  |
 +----------+                    |                                V  V
                                 |                           +--------+
 +-----------+         +---------+                           | PS/PDF |
 | Developer |-------> | C++ XML |                           +--------+
 +-----------+         +---------+

Getting Started

The "Getting Started" guide to BoostBook? has moved to http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/boostbook.html

References and Other Tools


BOOST WIKI | RecentChanges | Preferences | Page List | Links List
Edit text of this page | View other revisions
Last edited December 18, 2004 12:18 pm (diff)
Search:
Disclaimer: This site not officially maintained by Boost Developers