[[Image(ImprovingBoostDocs:ibdp.png,nolink)]] * [ImprovingBoostDocs Improving Boost Docs] * [ImprovingBoostDocs About this project] * [BoostDocsRepository Boost docs repository] * [UnifiedLookAndFeelProject Unified look & feel project] * [HelpingBoostAuthors Helping Boost Authors] * [GlueDocsProject Glue docs project] * [StandardCppLibraryDocumentation Standard C++ Library Docs] * [DocumentationBestPractices Documentation Best Practices] * [DocumentationTools Documentation Tools] * '''[ImprovingBoostDocsSubprojects Subprojects]''' * [BoostDocTest Boost.DocTest ] * [BoostHtmlStylesheet Boost HTML stylesheet] * [BoostKateSupport Boost Kate support] * [BoostPdfStylesheet Boost PDF stylesheet] * [BoostSpecificWikiMacros Boost-Specific WikiMacros] * [BoostTracStylesheet Boost Trac stylesheet] * [BoostscriptProject Boostscript] * [GoogleSearchBoxProject Google Search Box project] * [HtmlToDockbookProject HTML to docbook] * [QuickbookWikiProcessor Quickbook WikiProcessor] * [QuickbookSourceStylesheetProject Quickbook source stylesheet] * [SvgIconsSetProject SVG icons set project] * [SyntaxHighlightingProject Syntax highlighting project] * [BoostTracSyntaxColoring Trac Syntax Coloring] * [DebuggerVisualizers Debugger Visualizers] * [BrowserTestingChart Browser Testing Chart] * [LibrariesLogos Logo Playground] ---- == Improving Boost Docs Subprojects == [[PageOutline(3-5,Table of contents,inline)]] ---- === Subprojects organization === ''The branch organization presented here is based on the discussion in the Boost dev list about the best way to organize the main Boost repository. Since we must define our work methodology, this subproject can be used as a proof of concept.'' Projects (such as the translation effort) are being committed directly to the Boost Docs project trunk. The repository is in the following location: [http://svn.boost.org/trac/boost/browser/sandbox/boost_docs/trunk https://svn.boost.org/svn/boost/sandbox/boost_docs/trunk] The Docs project can not affect the work of other people. If we commit a buggy version of a subproject to the trunk, we can bother the work of other users! To avoid this, we will use the trunk as a merging repository. Each subproject will have its own repository placed at: [http://svn.boost.org/trac/boost/browser/sandbox/boost_docs/subprojects https://svn.boost.org/svn/boost/sandbox/boost_docs/subprojects] The organization will be the same for each subproject * '''''subproject_name''''' * '''branches''' * '''tags''' [[Br]]We will use dates to specify not so buggy versions with the format: ''subproject_name''_yyyy-mm-dd [[Br]]Example: boostbook_2007-06-28 * '''trunk''' [[Br]]Development branch for the subproject. * '''doc''' * '''example''' * '''test''' There are some subprojects that must be integrated in the Boost Docs trunk repository, such as Improving Boostbook and Stylesheets projects. When you feel confident with a given version, you can simply copy the last tag of your subproject to the main trunk. Each subproject has a Wiki page with additional information. ---- === Projects waiting for developers === If you are interested, please send a mail to the [https://lists.sourceforge.net/lists/listinfo/boost-docs Boost-docs list] telling us you want to help. [[Image(CommonImages:help_wanted.png,nolink)]] [[Br]] * '''[BoostSpecificWikiMacros Boost Specific WikiMacros]''' [[Br]]Write a simple proposal for new Boost-specific !WikiMacros. Proposals should include the rationale behind each decision and the implementation of each proposed macro. [[Br]][[Br]] * '''[GoogleSearchBoxProject Google Search Box Project]''' [[Br]]We need help with the Google Search Box that appears in the banner. Our idea is to use a Linked CSE Custom Google Search, an XML-based approach that allows us to specify the generated search page. [[Br]]We need to investigate the Linked CSE technology and came up with a tested XML definition for our libs. [[Br]][[Br]] * '''[QuickbookWikiProcessor Quickbook WikiProcessor]''' [[Br]]A Trac !WikiProcessor written in Python that integrates Rene Rivera's HTML backend in the Trac Wiki. [[Br]][[Br]] * '''[SyntaxHighlightingProject Syntax highlighting project]''' [[Br]]This project consists of checking that the colors are right. Workers will also create color schemas for missing IDEs. When this first task is finished, this project will determine a default syntax highlighting scheme for Boost. This color scheme may be a combination of existing schemes. [[Br]][[Br]] * '''[BoostTracSyntaxColoring Trac Syntax Coloring]''' [[Br]]Trac can be extended to support coloring of source code both in the Wiki and while browsing the repository. [[Br]]The project will consist in developing style definitions for common Boost file extensions (.hpp, .xml, etc) so Trac correctly performs source coloring. [[Br]][[Br]] ---- === Projects in progress === [[Br]] * '''[BoostDocTest Boost.DocTest ]''' [[Br]]A Quickbook based document that exercise all possible constructs. [[Br]]''Eric Niebler, Joel de Guzman, John Maddock, Matias Capeletto, Paul Bristow'' [[Br]] [[Image(People:eric_niebler.png,50)]] [[Image(People:joel_de_guzman.png,50)]] [[Image(People:john_maddock.png,50)]] [[Image(People:matias_capeletto.png,50)]] [[Image(People:paul_bristow.png,50)]] [[Br]][[Br]] * '''[BoostHtmlStylesheet Boost HTML Stylesheet]''' [[Br]]As part of the Unified Look & Feel Project, we are making a standard CSS file that can be used in Boost HTML docs. [[Br]]''Rene Rivera, Matias Capeletto, Joel de Guzman'' [[Br]] [[Image(People:rene_rivera.png,50)]] [[Image(People:matias_capeletto.png,50)]] [[Image(People:joel_de_guzman.png,50)]] [[Br]][[Br]] * '''[BoostKateSupport Boost Kate Support]''' [[Br]]Syntax coloring, auto-commet and folding support for Boost C++, Quickbook and Jamfiles. [[Br]]''Matias Capeletto'' [[Br]] [[Image(People:matias_capeletto.png,50)]] [[Br]][[Br]] * '''[BoostPdfStylesheet Boost PDF Stylesheet]''' [[Br]]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 decisions. [[Br]]''John Maddock'' [[Br]] [[Image(People:john_maddock.png,50)]] [[Br]][[Br]] * '''[BoostTracStylesheet Boost Trac Stylesheet]''' [[Br]]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. [[Br]]''Douglas Gregor, Matias Capeletto'' [[Br]] [[Image(People:doug_gregor.png,50)]] [[Image(People:matias_capeletto.png,50)]] [[Br]][[Br]] * '''[BoostscriptProject Boostscript]''' [[Br]] Javascript library used by Boostbook to achieve things like dynamic selection of syntax coloring, easy navigation of Boost docs, and old browser fixes. [[Br]]''Matias Capeletto'' [[Br]] [[Image(People:matias_capeletto.png,50)]] [[Br]][[Br]] * '''[HtmlToDockbookProject HTML to docbook]''' [[Br]]We are looking for solution to convert normal HTML into Docbook files. [[Br]]''Glyn Matthews'' [[Br]] [[Image(People:glyn_matthews.png,50)]] [[Br]][[Br]] * '''[QuickbookSourceStylesheetProject Quickbook source stylesheet]''' [[Br]]We are developing a CSS file that allows a Boostbook-based HTML as Quickbook source in a common browser. [[Br]]''Rene Rivera, Matias Capeletto'' [[Br]] [[Image(People:rene_rivera.png,50)]] [[Image(People:matias_capeletto.png,50)]] [[Br]][[Br]] * '''[SvgIconsSetProject SVG icons set project]''' [[Br]]Find scalable vector graphics icons for navigation and admonitions. These can be used in PDF and HTML output. [[Br]]''Peter Foley'' [[Br]] [[Image(People:no_picture.png,50)]] [[Br]][[Br]] * '''[DebuggerVisualizers Debugger Visualizers]''' [[Br]]Support for Boost data types debugging in common IDEs. [[Br]]''Filip Konvička'' [[Br]] [[Image(People:no_picture.png,50)]] [[Br]][[Br]] ---- === Important External Projects === These projects are independent from the "Improving Boost Docs" umbrella. They are included here because they are helpful to this project. If you are a developer from one of the projects, feel free to move them to the list above! * '''[QuickbookHtmlBackend Quickbook HTML backend]''' [[Br]]Rene Rivera * '''[SandboxTemplate Automatic Generation of Doc Files Standard Structure]''' [[Br]]Stjepan Rajko * '''[wiki:soc/2007/VisualizationOfContainers Generation of SVG Images From Standard Containers]''' [[Br]]Jacob Robert Voytko ---- * [ImprovingBoostDocs Improving Boost Docs] * [ImprovingBoostDocs About this project] * [BoostDocsRepository Boost docs repository] * [UnifiedLookAndFeelProject Unified look & feel project] * [HelpingBoostAuthors Helping Boost Authors] * [GlueDocsProject Glue docs project] * [StandardCppLibraryDocumentation Standard C++ Library Docs] * [DocumentationBestPractices Documentation Best Practices] * [DocumentationTools Documentation Tools] * '''[ImprovingBoostDocsSubprojects Subprojects]''' * [BoostDocTest Boost.DocTest ] * [BoostHtmlStylesheet Boost HTML stylesheet] * [BoostKateSupport Boost Kate support] * [BoostPdfStylesheet Boost PDF stylesheet] * [BoostSpecificWikiMacros Boost-Specific WikiMacros] * [BoostTracStylesheet Boost Trac stylesheet] * [BoostscriptProject Boostscript] * [GoogleSearchBoxProject Google Search Box project] * [HtmlToDockbookProject HTML to docbook] * [QuickbookWikiProcessor Quickbook WikiProcessor] * [QuickbookSourceStylesheetProject Quickbook source stylesheet] * [SvgIconsSetProject SVG icons set project] * [SyntaxHighlightingProject Syntax highlighting project] * [BoostTracSyntaxColoring Trac Syntax Coloring] * [DebuggerVisualizers Debugger Visualizers] * [BrowserTestingChart Browser Testing Chart] * [LibrariesLogos Logo Playground] ----