[[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] * [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] ---- [[Image(ImprovingBoostDocsSubprojects:boost_trac_wiki_macros.png,nolink)]] === Introduction === Trac Wiki allows the use of macros to help with common needs like a table of contents (TOC) or the insertion of an image. They work similarly to Quickbook templates. There are only a bunch of them in the official Trac release, and it will be very helpful to have a set of Boost-specific macros that make it easy to do common things like referring to a particular section of boost docs. Something like: {{{ [[BoostDocSection(regex,introduction)]] }}} === Objectives === * Investigate current official [WikiMacros Macros] and [http://trac.edgewall.org/wiki/MacroBazaar not-so-official macros] to look for the things we may find useful ( See [http://trac.edgewall.org/wiki/MacroBazaar#Includes Includes], [http://trac.edgewall.org/wiki/MacroBazaar#LastModified Last modified], [http://trac.edgewall.org/wiki/MacroBazaar#AddComment Add comment], [http://trac.edgewall.org/wiki/MacroBazaar#FootNote footnote], [http://trac.edgewall.org/wiki/MacroBazaar#RSSget rss get] and [http://trac.edgewall.org/wiki/MacroBazaar#VisitCounter visit counter] for some examples). * Write a not-too-cluttered proposal for new Boost-specific WikiMacros, including the rationale behind each decision. * [WikiMacros#DevelopingCustomMacros Implement the Macros] specified in the proposal. Luckily Trac uses Python for this! === Initial Ideas === ==== Link to Boost libraries documentation ==== {{{ [[BoostDocLink(regex,introduction)]] }}} ==== TOC-generator ==== A macro that generates something similar to the naviagtion TOCs used by this wiki page. It will be great if we could reuse the XML format that we are pushing for the sections in the new HTML style. See [http://beta.boost.org/development/doc/doc_test/doc/html/sections.xml online XML] for the sections of the DocTest document. Some nice features: * Orthogonal page organization system to the general Wiki mess. That is, we define an extern xml nested links file with the organization we want. * Use bold ( or something else ) to show you where you are. * Hide all internal sections trees except from the one you are looking at. ==== People info ==== {{{ [[PeopleInfo(Joel de Guzman)]] }}} This will render: {{{ [[Br]][[Image(People:joel_de_guzman.png,nolink)]] [[Br]]'''Joel de Guzman''' [[Br]][http://www.ohloh.net/projects/3/contributors/92 Ohloh statistics] [[Br]][http://www.linkedin.com/pub/0/89/716 Linked In profile] [[Br]]''joel at somewhere dot com'' }}} This will look like this in the wiki page: [[Br]][[Image(People:joel_de_guzman.png,nolink)]] [[Br]]'''Joel de Guzman''' [[Br]][http://www.ohloh.net/projects/3/contributors/92 Ohloh statistics] [[Br]][http://www.linkedin.com/pub/0/89/716 Linked In profile] [[Br]]''joel at somewhere dot com'' We can see the person in an external XML file in the format: {{{ #!xml Joel de Guzman http://www.linkedin.com/pub/0/89/716 http://www.ohloh.net/projects/3/contributors/92 joel at somewhere dot com url jdguzman jdg 5 Spirit Fusion Spirit Fusion }}} ---- === Active developers === [[Br]][[Image(People:chris_fairles.png,50)]] [[Br]]'''Chris Fairles''' [[Br]]''chris dot fairles at gmail dot com'' ---- === Knowledgeable people whom you can contact for help === [[Br]][[Image(People:dave_abrahams.png,50)]] [[Br]]'''Dave Abrahams''' [[Br]][http://www.ohloh.net/projects/3/contributors/94 Ohloh statistics] [[Br]][http://www.linkedin.com/pub/0/87/22a Linked In profile] [[Br]]''dave at boost-consulting dot com'' ---- * [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] * [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]