Changes between Version 12 and Version 13 of BoostSpecificWikiMacros


Ignore:
Timestamp:
Jul 17, 2007, 9:16:36 AM (15 years ago)
Author:
paolog
Comment:

proof-reading

Legend:

Unmodified
Added
Removed
Modified

  • BoostSpecificWikiMacros

    v12 v13  
    44      * [ImprovingBoostDocs About this project]
    55      * [BoostDocsRepository Boost docs repository]
    6       * [UnifiedLookAndFeelProject Unified look & feel project]
     6      * [UnifiedLookAndFeelProject Unified look and feel project]
    77      * [HelpingBoostAuthors Helping Boost Authors]
    88      * [GlueDocsProject Glue docs project]
    9       * [StandardCppLibraryDocumentation Standard C++ Library Docs]
    10       * [DocumentationBestPractices Documentation Best Practices]
    11       * [DocumentationTools Documentation Tools]
     9      * [StandardCppLibraryDocumentation Standard C++ Library docs]
     10      * [DocumentationBestPractices Documentation best practices]
     11      * [DocumentationTools Documentation tools]
    1212      * [ImprovingBoostDocsSubprojects Subprojects]
    1313           * [BoostDocTest Boost.DocTest ]
    … …  
    2323           * [QuickbookSourceStylesheetProject Quickbook source stylesheet]
    2424           * [SvgIconsSetProject SVG icons set project]
    25            * [SyntaxHighlightingProject Syntax highlighting project]
    26            * [BoostTracSyntaxColoring Trac Syntax Coloring]
    27            * [DebuggerVisualizers Debugger Visualizers]
    28       * [BrowserTestingChart Browser Testing Chart]
    29       * [LibrariesLogos Logo Playground]
     25           * [SyntaxHighlightingProject Syntax-highlighting project]
     26           * [BoostTracSyntaxColoring Trac syntax-coloring]
     27           * [DebuggerVisualizers Debugger visualizers]
     28      * [BrowserTestingChart Browser-testing chart]
     29      * [LibrariesLogos Logo playground]
    3030
    3131----
    … …  
    3636
    3737Trac Wiki allows the use of macros to help with common needs like
    38 a TOC or the insertion of a n image. They work similarly to Quickbook
     38a table of contents (TOC) or the insertion of an image. They work similarly to Quickbook
    3939templates.
    4040There are only a bunch of them in the official Trac release, and it
    41 will be very helpful to have a set of boost specific macros that makes
    42 common things like referring to a particular section of boost docs
    43 very easy. Something like:
     41will be very helpful to have a set of Boost-specific macros that make it easy to do
     42common things like referring to a particular section of boost docs. Something like:
    4443
    4544{{{
    … …  
    5049
    5150   * Investigate current official [WikiMacros Macros]
    52      and [http://trac.edgewall.org/wiki/MacroBazaar not so official macros]
     51     and [http://trac.edgewall.org/wiki/MacroBazaar not-so-official macros]
    5352     to look for the things we may find useful ( See
    5453     [http://trac.edgewall.org/wiki/MacroBazaar#Includes Includes],
    55      [http://trac.edgewall.org/wiki/MacroBazaar#LastModified Last Modified],
     54     [http://trac.edgewall.org/wiki/MacroBazaar#LastModified Last modified],
    5655     [http://trac.edgewall.org/wiki/MacroBazaar#AddComment Add comment],
    5756     [http://trac.edgewall.org/wiki/MacroBazaar#FootNote footnote],
    … …  
    6059     examples).
    6160
    62    * Write a not too clutter proposal for new Boost specific WikiMacros,
     61   * Write a not-too-cluttered proposal for new Boost-specific WikiMacros,
    6362     including the rationale behind each decision.
    6463
    … …  
    6867=== Initial Ideas ===
    6968
    70 ==== Link to boost libraries documentation ====
     69==== Link to Boost libraries documentation ====
    7170{{{
    7271[[BoostDocLink(regex,introduction)]]
    7372}}}
    7473
    75 ==== Toc generator ====
     74==== TOC-generator ====
    7675
    77 A macro that generates something similar to the naviagtion TOCs used by this Wiki page.
     76A macro that generates something similar to the naviagtion TOCs used by this wiki page.
    7877
    79 It will be great if we could reuse the xml format that we are pushing for the sections in the new HTML style.
    80 See an [http://beta.boost.org/development/doc/doc_test/doc/html/sections.xml online xml] for the sections of the DocTest document.
     78It will be great if we could reuse the XML format that we are pushing for the sections in the new HTML style.
     79See [http://beta.boost.org/development/doc/doc_test/doc/html/sections.xml online XML] for the sections of the DocTest document.
    8180
    8281==== People info ====
    … …  
    9190[[Br]][[Image(People:joel_de_guzman.png,nolink)]]
    9291[[Br]]'''Joel de Guzman'''
    93 [[Br]][http://www.ohloh.net/projects/3/contributors/92 Ohloh Statistics]
    94 [[Br]][http://www.linkedin.com/pub/0/89/716 Linked In Profile]
     92[[Br]][http://www.ohloh.net/projects/3/contributors/92 Ohloh statistics]
     93[[Br]][http://www.linkedin.com/pub/0/89/716 Linked In profile]
    9594[[Br]]''joel at somewhere dot com''
    9695}}}
    9796
    98 This look in the wiki page like this:
     97This will look like this in the wiki page:
    9998
    10099[[Br]][[Image(People:joel_de_guzman.png,nolink)]]
    101100[[Br]]'''Joel de Guzman'''
    102 [[Br]][http://www.ohloh.net/projects/3/contributors/92 Ohloh Statistics]
    103 [[Br]][http://www.linkedin.com/pub/0/89/716 Linked In Profile]
     101[[Br]][http://www.ohloh.net/projects/3/contributors/92 Ohloh statistics]
     102[[Br]][http://www.linkedin.com/pub/0/89/716 Linked In profile]
    104103[[Br]]''joel at somewhere dot com''
    105104
    106 We can look the person in an external xml file with the format:
     105We can see the person in an external XML file in the format:
    107106
    108107{{{
    … …  
    143142=== Help wanted ===
    144143
    145 If you are interested, please send a mail to the
     144If you are interested, please send an email to the
    146145[https://lists.sourceforge.net/lists/listinfo/boost-docs boost-docs list]
    147146telling us you want to help.
    … …  
    152151----
    153152
    154 === Knowledgeable people you can contact for help ===
     153=== Knowledgeable people whom you can contact for help ===
    155154
    156155[[Br]][[Image(People:dave_abrahams.png,50)]]
    157156[[Br]]'''Dave Abrahams'''
    158 [[Br]][http://www.ohloh.net/projects/3/contributors/94 Ohloh Statistics]
    159 [[Br]][http://www.linkedin.com/pub/0/87/22a Linked In Profile]
     157[[Br]][http://www.ohloh.net/projects/3/contributors/94 Ohloh statistics]
     158[[Br]][http://www.linkedin.com/pub/0/87/22a Linked In profile]
    160159[[Br]]''dave at boost-consulting dot com''
    161160
    … …  
    165164      * [ImprovingBoostDocs About this project]
    166165      * [BoostDocsRepository Boost docs repository]
    167       * [UnifiedLookAndFeelProject Unified look & feel project]
     166      * [UnifiedLookAndFeelProject Unified look and feel project]
    168167      * [HelpingBoostAuthors Helping Boost Authors]
    169168      * [GlueDocsProject Glue docs project]
    170       * [StandardCppLibraryDocumentation Standard C++ Library Docs]
    171       * [DocumentationBestPractices Documentation Best Practices]
     169      * [StandardCppLibraryDocumentation Standard C++ Library docs]
     170      * [DocumentationBestPractices Documentation best practices]
     171      * [DocumentationTools Documentation tools]
    172172      * [ImprovingBoostDocsSubprojects Subprojects]
    173173           * [BoostDocTest Boost.DocTest ]
    … …  
    177177           * '''[BoostSpecificWikiMacros Boost specific WikiMacros]'''
    178178           * [BoostTracStylesheet Boost Trac stylesheet]
    179            * [BoostBuildSupportForDocsTools Boost.Build support for doc tools]
    180179           * [BoostscriptProject Boostscript]
    181180           * [GoogleSearchBoxProject Google Search Box project]
    182181           * [HtmlToDockbookProject HTML to docbook]
    183            * [ImprovingBoostbook Improving Boostbook]
    184182           * [QuickbookWikiProcessor Quickbook WikiProcessor]
    185183           * [QuickbookSourceStylesheetProject Quickbook source stylesheet]
    186184           * [SvgIconsSetProject SVG icons set project]
    187            * [SyntaxHighlightingProject Syntax highlighting project]
    188            * [BoostTracSyntaxColoring Trac Syntax Coloring]
    189       * [BrowserTestingChart Browser Testing Chart]
    190       * [LibrariesLogos Logo Playground]
     185           * [SyntaxHighlightingProject Syntax-highlighting project]
     186           * [BoostTracSyntaxColoring Trac syntax-coloring]
     187           * [DebuggerVisualizers Debugger visualizers]
     188      * [BrowserTestingChart Browser-testing chart]
     189      * [LibrariesLogos Logo playground]