[[Image(ImprovingBoostDocs:ibdp.png,nolink)]] * [ImprovingBoostDocs Improving Boost Docs] * [ImprovingBoostDocs About this project] * [BoostDocsRepository Boost docs repository] * '''[UnifiedLookAndFeelProject Unified look and feel project]''' * [HelpingBoostAuthors Helping Boost authors] * [GlueDocsProject Glue docs project] * [StandardCppLibraryDocumentation Standard C++ Library docs] * [DocumentationBestPractices Documentation best practices] * [DocumentationTools Documentation tools] * [ImprovingBoostDocsSubprojects Subprojects] * [BrowserTestingChart Browser-testing chart] * [LibrariesLogos Logo playground] ---- [[Image(unified_look_and_feel.png,nolink)]] Integrate Boost documents and resources with a common look and feel. [[PageOutline(2-5,Table of contents,inline)]] ---- == HTML docs == === Check out the new style === You can see the latest iteration of the [http://beta.boost.org/development/doc/doc_test/doc/html/index.html new style here]. If you checkout boost from the SVN repository, you can build docs with the new style by switching the boostbook directory to the updated version in the sandbox. To switch, go to the tools/boostbook directory of your checked out boost working copy, and depending on whether you check out using http or https, execute one of the following: {{{ svn switch http://svn.boost.org/svn/boost/sandbox/boost_docs/trunk/tools/boostbook . (or) svn switch https://svn.boost.org/svn/boost/sandbox/boost_docs/trunk/tools/boostbook . }}} This will make the boostbook subdirectories be synchronized with the new style. After switching, you may also need to update your docbook/fop tools by using one of the setup_boostbook scripts in the boostbook subdirectory. To switch back, return to the boostbook subdirectory and execute: {{{ svn switch http://svn.boost.org/svn/boost/trunk/tools/boostbook . (or) svn switch https://svn.boost.org/svn/boost/trunk/tools/boostbook . }}} To use the new style, you may need to modify to your Jamfile. The root directory containing doc/style, doc/javascript, etc. may be specified with a line something like: {{{ project.root="path-to-project-style-root" }}} === Some of the new features === * Validated XHTML 1.1 output (better than strict XHTML) * New header and footer based on beta.boost.org. * [http://tinyurl.com/332tsh GroupedLinks] select boxes for Boost libraries and quick jumps to sections. * Google Search box for our docs. * Box-wrapper-based blurbs that allow us to include rounded corners, drop shadows, etc. * Highlighting of alternative syntax that simulates your own IDE (move the mouse to the upper righthand corner of a code block) * Chapter logo support * Modular CSS design * CSS-based admonitions and navigation graphics * Quickbook source stylesheet === Known issues === * On [http://beta.boost.org/development/doc/doc_test/doc/html/index.html] * Firefox and IE7 don't display code blocks correctly in print-preview (and presumably when printed). * IE7 indicates that there were Javascript errors on the page when loading the above page. And when stylesheets are used locally then IE7 complains about "active content". === Subprojects === The following subprojects deal with HTML documents * [BoostHtmlStylesheet Boost HTML stylesheet] * [BoostscriptProject Boostscript] * [GoogleSearchBoxProject Google Search box project] * [ImprovingBoostbook Improving Boostbook] * [QuickbookSourceStylesheetProject Quickbook source stylesheet] * [SvgIconsSetProject SVG icons set project] * [SyntaxHighlightingProject Syntax-highlighting project] ---- == PDF docs == PDF stylesheet matches the ULF. Look for the following subprojects: * [BoostPdfStylesheet Boost PDF stylesheet] * [SvgIconsSetProject SVG icons set project] * [SyntaxHighlightingProject Syntax-highlighting project] ---- == Trac == Trac stylesheet that matches the ULF of Boost. Subproject * [BoostTracStylesheet Boost Trac stylesheet] ---- * [ImprovingBoostDocs Improving Boost Docs] * [ImprovingBoostDocs About this project] * [BoostDocsRepository Boost docs repository] * '''[UnifiedLookAndFeelProject Unified look and feel project]''' * [HelpingBoostAuthors Helping Boost authors] * [GlueDocsProject Glue docs project] * [StandardCppLibraryDocumentation Standard C++ Library docs] * [DocumentationBestPractices Documentation best practices] * [DocumentationTools Documentation tools] * [ImprovingBoostDocsSubprojects Subprojects] * [BrowserTestingChart Browser-testing chart] * [LibrariesLogos Logo playground] ----