wiki:ImprovingBoostDocsSubprojects

Version 41 (modified by Matias Capeletto, 15 years ago) ( diff )

--

Improving Boost Docs Project

Improving Boost Docs Subprojects

Table of contents

  1. Subprojects organization
  2. Projects waiting for developers
  3. Projects in progress
  4. Important external projects

Subprojects organization

The organization presented here is based on the discussion in the boost devel list about the best way to organize the main boost repository. Since we have to define the way we will work, this subprojects can be used as a proof of concept.

Projects like the translation effort are being committed directly to the boost docs project trunk placed at:

​https://svn.boost.org/svn/boost/sandbox/boost_docs/trunk

This is done for the sake of simplicity. Docs can not affect the work of other people.

With subprojects, if we commit a buggy version to the trunk we can bother other people work. To avoid this, we will use the trunk as a merging repository. Each subproject will have his own repository placed at:

​https://svn.boost.org/svn/boost/sandbox/boost_docs/subprojects

The organization will be the same for each subproject

  • subproject_name
    • branches
    • tags
      We will use dates to specify not so buggy versions with the format: subproject_name_yyyy-mm-dd
      Example: boostbook_2007-06-28
    • trunk
      Development branch for the subproject.
      • doc
      • example
      • test

There are some subprojects that must be integrated in the boost docs trunk repository, like Improving Boostbook and stylesheets projects. When you feel confident with a given version, you just copy the last tag of your subproject to the main trunk.

Each subproject have a Wiki page with additional information.

Projects waiting for developers

If you are interested, please send a mail to the ​boost-docs list telling us you want to help.

Help wanted


  • Boost specific WikiMacros
    Write a not too clutter proposal for new Boost specific WikiMacros, including the rationale behind each decision and implement the Macros specified in the proposal.

  • Google Search Box project
    We need help with the Google Search Box that appears in the banner. Our idea is to use a Linked CSE Custom Google Search, a XML based approach to specify the generated search page.
    We need to investigate the Linked CSE technology and came up with a tested XML definition for our libs.

  • Quickbook WikiProcessor
    A Trac WikiProcessor written in Python that integrates Rene Rivera HTML backend in the Trac Wiki.

  • Syntax highlighting project
    The project consist in checking that the colours are right, and make the colour set for the missing IDEs. When this first task is finished, we must came up with a default syntax highlighting scheme for boost, that may be a combination of the others.

  • Trac Syntax Coloring
    Trac can be extended to support coloring of source code both in the Wiki and browsing the repository.
    The project will consist in developing style definitions for boost used file types so Trac know how to show us our source.

Projects in progress


  • Boost.DocTest
    A Quickbook based document that exercise all possible constructs.
    Eric Niebler, Joel de Guzman, John Maddock, Matias Capeletto, Paul Bristow
    Eric Niebler Joel de Guzman John Maddock Matias Capeletto

  • Boost HTML stylesheet
    As part of the unified look & feel project, we are making a standard CSS to be used in boost HTML docs.
    Rene Rivera, Matias Capeletto, Joel de Guzman
    Rene Rivera Matias Capeletto Joel de Guzman

  • Boost Kate support
    Syntax coloring, auto-commet and folding support for Boost C++, Quickbook and Jamfiles.
    Matias Capeletto
    Matias Capeletto

  • Boost PDF stylesheet
    Another project member of the unified look & feel project. We will adapt the PDF look and feel to be as close as possible to the HTML generated docs (but not closer, because PDF design rationale is different from HTML design ddecisions.
    John Maddock
    John Maddock

  • Boost Trac stylesheet
    Once we settled down with a look and feel for our docs, we will tuned the trac CSS to match it. We have started by doing some testing.
    Douglas Gregor, Matias Capeletto
    Douglas Gregor Matias Capeletto

  • Boostscript
    Javascript library used by Boostbook to achieve things like dynamic selection of syntax coloring, easy navigation of boost docs and old browser fixes.
    Matias Capeletto
    Matias Capeletto

  • HTML to docbook
    We are looking for solution to convert normal HTML into dockook files.
    Glyn Matthews


  • Quickbook source stylesheet
    We are developing a c CSS that lets as see boostbook based HTML as Quickbook source in a common browser.
    Rene Rivera, Matias Capeletto
    Rene Rivera Matias Capeletto

  • SVG icons set project
    Find scalable vector graphics icons for navigation and admonitions, so we can use them in both PDF and HTML output.
    Peter Foley


Important external projects

These projects are independent from the "Improving Boost Docs" umbrella. They are included here because they are really important for this project, if you are the developper of one of them, be free to move them to the list above.

Attachments (15)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.