Changes between Version 36 and Version 37 of ImprovingBoostDocsSubprojects


Ignore:
Timestamp:
Jul 2, 2007, 7:42:34 PM (15 years ago)
Author:
Matias Capeletto
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • ImprovingBoostDocsSubprojects

    v36 v37  
    11[[Image(ImprovingBoostDocs:ibdp.png,nolink)]]
    2 
    3    * [ImprovingBoostDocs Improving Boost Docs]
    4       * [ImprovingBoostDocs About this project]
    5       * [BoostDocsRepository Boost docs repository]
    6       * [UnifiedLookAndFeelProject Unified look & feel project]
    7       * [DocsTranslationsProject Docs translations project]
    8       * [GlueDocsProject Glue docs project]
    9       * [StandardCppLibraryDocumentation Standard C++ Library Docs]
    10       * [DocumentationBestPractices Documentation Best Practices]
    11       * '''[ImprovingBoostDocsSubprojects Subprojects]'''
    12            * [BoostDocTest Boost.DocTest ]
    13            * [BoostHtmlStylesheet Boost HTML stylesheet]
    14            * [BoostKateSupport Boost Kate support]
    15            * [BoostPdfStylesheet Boost PDF stylesheet]
    16            * [BoostSpecificWikiMacros Boost specific WikiMacros]
    17            * [BoostTracStylesheet Boost Trac stylesheet]
    18            * [BoostBuildSupportForDocsTools Boost.Build support for doc tools]
    19            * [BoostscriptProject Boostscript]
    20            * [GoogleSearchBoxProject Google Search Box project]
    21            * [HtmlToDockbookProject HTML to docbook]
    22            * [ImprovingBoostbook Improving Boostbook]
    23            * [QuickbookWikiProcessor Quickbook WikiProcessor]
    24            * [QuickbookSourceStylesheetProject Quickbook source stylesheet]
    25            * [SvgIconsSetProject SVG icons set project]
    26            * [SyntaxHighlightingProject Syntax highlighting project]
    27            * [BoostTracSyntaxColoring Trac Syntax Coloring]
    28       * [BrowserTestingChart Browser Testing Chart]
    29       * [LibrariesLogos Logo Playground]
    30 
    31 ----
    32 
    33 == Improving Boost Docs Subprojects ==
    34 
    35 [[PageOutline(3-5,Table of contents,inline)]]
    36 
    37 ----
    38 
    39 === Subprojects organization ===
    40 
    41   ''The organization presented here is based on the discussion in the boost devel
    42   list about the best way to organize the main boost repository. Since we have to
    43   define the way we will work, this subprojects can be used as a proof of concept.''
    44 
    45 Projects like the translation effort are being committed directly to the boost docs
    46 project trunk placed at:
    47 
    48 [http://svn.boost.org/trac/boost/browser/sandbox/boost_docs/trunk https://svn.boost.org/svn/boost/sandbox/boost_docs/trunk]
    49 
    50 This is done for the sake of simplicity. Docs can not affect the work of other people.
    51 
    52 With subprojects, if we commit a buggy version to the trunk we can bother other
    53 people work. To avoid this, we will use the trunk as a merging repository.
    54 Each subproject will have his own repository placed at:
    55 
    56 [http://svn.boost.org/trac/boost/browser/sandbox/boost_docs/subprojects https://svn.boost.org/svn/boost/sandbox/boost_docs/subprojects]
    57 
    58 The organization will be the same for each subproject
    59 
    60    * '''''subproject_name'''''
    61       * '''branches'''
    62       * '''tags'''
    63       [[Br]]We will use dates to specify not so buggy versions with the format: ''subproject_name''_{year}_{month}_{day}
    64       [[Br]]Example: boostbook_07_06_28
    65       * '''trunk'''
    66       [[Br]]Development branch for the subproject.
    67          * '''doc'''
    68          * '''example'''
    69          * '''test'''
    70 
    71 There are some subprojects that must be integrated in the boost docs trunk repository,
    72 like Improving Boostbook and stylesheets projects.
    73 When you feel confident with a given version, you just copy the last tag of your
    74 subproject to the main trunk.
    75 
    76 Each subproject have a Wiki page with additional information.
    77 
    78 ----
    79 
    80 === Projects waiting for developers ===
    81 
    82 If you are interested, please send a mail to the
    83 [https://lists.sourceforge.net/lists/listinfo/boost-docs boost-docs list]
    84 telling us you want to help.
    85 
    86 [[Image(CommonImages:help_wanted.png,nolink)]]
    87 
    88 [[Br]]
    89 
    90   * '''[BoostSpecificWikiMacros Boost specific WikiMacros]'''
    91     [[Br]]Write a not too clutter proposal for new Boost specific !WikiMacros, including the rationale behind each decision
    92     and implement the Macros specified in the proposal.
    93     [[Br]][[Br]]
    94 
    95   * '''[GoogleSearchBoxProject Google Search Box project]'''
    96     [[Br]]We need help with the Google Search Box that appears in the banner.
    97     Our idea is to use a Linked CSE Custom Google Search, a XML based
    98     approach to specify the generated search page.
    99     [[Br]]We need to investigate the Linked CSE technology and came up with a tested XML definition for our
    100     libs.
    101     [[Br]][[Br]]
    102 
    103   * '''[QuickbookWikiProcessor Quickbook WikiProcessor]'''
    104     [[Br]]A Trac !WikiProcessor written in Python that integrates Rene Rivera HTML backend
    105     in the Trac Wiki.
    106     [[Br]][[Br]]
    107 
    108   * '''[SyntaxHighlightingProject Syntax highlighting project]'''
    109     [[Br]]The project consist in checking that the colours are right, and make
    110     the colour set for the missing IDEs. When this first task is finished,
    111     we must came up with a default syntax highlighting scheme for boost,
    112     that may be a combination of the others.
    113     [[Br]][[Br]]
    114 
    115   * '''[BoostTracSyntaxColoring Trac Syntax Coloring]'''
    116     [[Br]]Trac can be extended to support coloring of source code both in the
    117     Wiki and browsing the repository.
    118     [[Br]]The project will consist in developing style definitions for boost
    119     used file types so Trac know how to show us our source.
    120     [[Br]][[Br]]
    121 
    122 ----
    123 
    124 === Projects in progress ===
    125 [[Br]]
    126 
    127   * '''[BoostDocTest Boost.DocTest ]'''
    128     [[Br]]A Quickbook based document that exercise all possible constructs.
    129     [[Br]]''Eric Niebler, Joel de Guzman, John Maddock, Matias Capeletto, Paul Bristow''
    130     [[Br]]
    131     [[Image(People:eric_niebler.png,50)]]
    132     [[Image(People:joel_de_guzman.png,50)]]
    133     [[Image(People:john_maddock.png,50)]]
    134     [[Image(People:matias_capeletto.png,50)]]
    135     [[Image(People:no_picture.png,50)]]
    136     [[Br]][[Br]]
    137 
    138   * '''[BoostHtmlStylesheet Boost HTML stylesheet]'''
    139     [[Br]]As part of the unified look & feel project, we are making a standard CSS to be used in boost HTML docs.
    140     [[Br]]''Rene Rivera, Matias Capeletto, Joel de Guzman''
    141     [[Br]]
    142     [[Image(People:rene_rivera.png,50)]]
    143     [[Image(People:matias_capeletto.png,50)]]
    144     [[Image(People:joel_de_guzman.png,50)]]
    145     [[Br]][[Br]]
    146 
    147   * '''[BoostKateSupport Boost Kate support]'''
    148     [[Br]]Syntax coloring, auto-commet and folding support for Boost C++, Quickbook and Jamfiles.
    149     [[Br]]''Matias Capeletto''
    150     [[Br]]
    151     [[Image(People:matias_capeletto.png,50)]]
    152     [[Br]][[Br]]
    153 
    154   * '''[BoostPdfStylesheet Boost PDF stylesheet]'''
    155     [[Br]]Another project member of the unified look & feel project. We will adapt the PDF look and feel to be
    156     as close as possible to the HTML generated docs (but not closer, because PDF design rationale is different
    157     from HTML design ddecisions.
    158     [[Br]]''John Maddock''
    159     [[Br]]
    160     [[Image(People:john_maddock.png,50)]]
    161     [[Br]][[Br]]
    162 
    163   * '''[BoostTracStylesheet Boost Trac stylesheet]'''
    164     [[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
    165     by doing some testing.
    166     [[Br]]''Douglas Gregor, Matias Capeletto''
    167     [[Br]]
    168     [[Image(People:doug_gregor.png,50)]]
    169     [[Image(People:matias_capeletto.png,50)]]
    170     [[Br]][[Br]]
    171 
    172   * '''[BoostBuildSupportForDocsTools Boost.Build support for doc tools]'''
    173     [[Br]]Integration of new tools into the boost build system. It will be nice to have a Boost.Build expert to work
    174     with us.
    175     [[Br]]''John Maddock, Matias Capeletto''
    176     [[Br]]
    177     [[Image(People:john_maddock.png,50)]]
    178     [[Image(People:matias_capeletto.png,50)]]
    179     [[Br]][[Br]]
    180 
    181   * '''[BoostscriptProject Boostscript]'''
    182     [[Br]]Javascript library used by Boostbook to achieve things like dynamic selection of
    183     syntax coloring, easy navigation of boost docs and old browser fixes.
    184     [[Br]]''Matias Capeletto''
    185     [[Br]]
    186     [[Image(People:matias_capeletto.png,50)]]
    187     [[Br]][[Br]]
    188 
    189   * '''[HtmlToDockbookProject HTML to docbook]'''
    190     [[Br]]We are looking for solution to convert normal HTML into dockook files.
    191     [[Br]]''Glyn Matthews''
    192     [[Br]]
    193     [[Image(People:no_picture.png,50)]]
    194     [[Br]][[Br]]
    195 
    196   * '''[ImprovingBoostbook Improving Boostbook]'''
    197     [[Br]] Simplify and integrate new stuff from the project into Boostbook stylesheets.
    198     [[Br]]''Matias Capeletto''
    199     [[Br]]
    200     [[Image(People:matias_capeletto.png,50)]]
    201     [[Br]][[Br]]
    202 
    203   * '''[QuickbookSourceStylesheetProject Quickbook source stylesheet]'''
    204     [[Br]]We are developing a c CSS that lets as see boostbook based HTML as Quickbook source in
    205     a common browser.
    206     [[Br]]''Rene Rivera, Matias Capeletto''
    207     [[Br]]
    208     [[Image(People:rene_rivera.png,50)]]
    209     [[Image(People:matias_capeletto.png,50)]]
    210     [[Br]][[Br]]
    211 
    212   * '''[SvgIconsSetProject SVG icons set project]'''
    213     [[Br]]Find scalable vector graphics icons for navigation and admonitions, so we can use them in
    214     both PDF and HTML output.
    215     [[Br]]''Peter Foley''
    216     [[Br]]
    217     [[Image(People:no_picture.png,50)]]
    218     [[Br]][[Br]]
    219 
    220 ----
    221 
    222 === Important external projects ===
    223 
    224 These projects are independent from the "Improving Boost Docs" umbrella.
    225 They are included here because they are really important for this project, if you are the developper
    226 of one of them, be free to move them to the list above.
    227 
    228   * '''[QuickbookHtmlBackend Quickbook HTML backend]'''
    229     [[Br]]Rene Rivera
    230 
    231   * '''[SandboxTemplate Automatic generation of doc files standard structure]'''
    232     [[Br]]Stjepan Rajko
    233 
    234   * '''[wiki:soc/2007/VisualizationOfContainers Generation of SVG images from standard containers]'''
    235     [[Br]]Jacob Robert Voytko
    236 
    237 ----
    2382
    2393   * [ImprovingBoostDocs Improving Boost Docs]
    … …  
    26832
    26933----
     34
     35== Improving Boost Docs Subprojects ==
     36
     37[[PageOutline(3-5,Table of contents,inline)]]
     38
     39----
     40
     41=== Subprojects organization ===
     42
     43  ''The organization presented here is based on the discussion in the boost devel
     44  list about the best way to organize the main boost repository. Since we have to
     45  define the way we will work, this subprojects can be used as a proof of concept.''
     46
     47Projects like the translation effort are being committed directly to the boost docs
     48project trunk placed at:
     49
     50[http://svn.boost.org/trac/boost/browser/sandbox/boost_docs/trunk https://svn.boost.org/svn/boost/sandbox/boost_docs/trunk]
     51
     52This is done for the sake of simplicity. Docs can not affect the work of other people.
     53
     54With subprojects, if we commit a buggy version to the trunk we can bother other
     55people work. To avoid this, we will use the trunk as a merging repository.
     56Each subproject will have his own repository placed at:
     57
     58[http://svn.boost.org/trac/boost/browser/sandbox/boost_docs/subprojects https://svn.boost.org/svn/boost/sandbox/boost_docs/subprojects]
     59
     60The organization will be the same for each subproject
     61
     62   * '''''subproject_name'''''
     63      * '''branches'''
     64      * '''tags'''
     65      [[Br]]We will use dates to specify not so buggy versions with the format: ''subproject_name''_{year}_{month}_{day}
     66      [[Br]]Example: boostbook_07_06_28
     67      * '''trunk'''
     68      [[Br]]Development branch for the subproject.
     69         * '''doc'''
     70         * '''example'''
     71         * '''test'''
     72
     73There are some subprojects that must be integrated in the boost docs trunk repository,
     74like Improving Boostbook and stylesheets projects.
     75When you feel confident with a given version, you just copy the last tag of your
     76subproject to the main trunk.
     77
     78Each subproject have a Wiki page with additional information.
     79
     80----
     81
     82=== Projects waiting for developers ===
     83
     84If you are interested, please send a mail to the
     85[https://lists.sourceforge.net/lists/listinfo/boost-docs boost-docs list]
     86telling us you want to help.
     87
     88[[Image(CommonImages:help_wanted.png,nolink)]]
     89
     90[[Br]]
     91
     92  * '''[BoostSpecificWikiMacros Boost specific WikiMacros]'''
     93    [[Br]]Write a not too clutter proposal for new Boost specific !WikiMacros, including the rationale behind each decision
     94    and implement the Macros specified in the proposal.
     95    [[Br]][[Br]]
     96
     97  * '''[GoogleSearchBoxProject Google Search Box project]'''
     98    [[Br]]We need help with the Google Search Box that appears in the banner.
     99    Our idea is to use a Linked CSE Custom Google Search, a XML based
     100    approach to specify the generated search page.
     101    [[Br]]We need to investigate the Linked CSE technology and came up with a tested XML definition for our
     102    libs.
     103    [[Br]][[Br]]
     104
     105  * '''[QuickbookWikiProcessor Quickbook WikiProcessor]'''
     106    [[Br]]A Trac !WikiProcessor written in Python that integrates Rene Rivera HTML backend
     107    in the Trac Wiki.
     108    [[Br]][[Br]]
     109
     110  * '''[SyntaxHighlightingProject Syntax highlighting project]'''
     111    [[Br]]The project consist in checking that the colours are right, and make
     112    the colour set for the missing IDEs. When this first task is finished,
     113    we must came up with a default syntax highlighting scheme for boost,
     114    that may be a combination of the others.
     115    [[Br]][[Br]]
     116
     117  * '''[BoostTracSyntaxColoring Trac Syntax Coloring]'''
     118    [[Br]]Trac can be extended to support coloring of source code both in the
     119    Wiki and browsing the repository.
     120    [[Br]]The project will consist in developing style definitions for boost
     121    used file types so Trac know how to show us our source.
     122    [[Br]][[Br]]
     123
     124----
     125
     126=== Projects in progress ===
     127[[Br]]
     128
     129  * '''[BoostDocTest Boost.DocTest ]'''
     130    [[Br]]A Quickbook based document that exercise all possible constructs.
     131    [[Br]]''Eric Niebler, Joel de Guzman, John Maddock, Matias Capeletto, Paul Bristow''
     132    [[Br]]
     133    [[Image(People:eric_niebler.png,50)]]
     134    [[Image(People:joel_de_guzman.png,50)]]
     135    [[Image(People:john_maddock.png,50)]]
     136    [[Image(People:matias_capeletto.png,50)]]
     137    [[Image(People:no_picture.png,50)]]
     138    [[Br]][[Br]]
     139
     140  * '''[BoostHtmlStylesheet Boost HTML stylesheet]'''
     141    [[Br]]As part of the unified look & feel project, we are making a standard CSS to be used in boost HTML docs.
     142    [[Br]]''Rene Rivera, Matias Capeletto, Joel de Guzman''
     143    [[Br]]
     144    [[Image(People:rene_rivera.png,50)]]
     145    [[Image(People:matias_capeletto.png,50)]]
     146    [[Image(People:joel_de_guzman.png,50)]]
     147    [[Br]][[Br]]
     148
     149  * '''[BoostKateSupport Boost Kate support]'''
     150    [[Br]]Syntax coloring, auto-commet and folding support for Boost C++, Quickbook and Jamfiles.
     151    [[Br]]''Matias Capeletto''
     152    [[Br]]
     153    [[Image(People:matias_capeletto.png,50)]]
     154    [[Br]][[Br]]
     155
     156  * '''[BoostPdfStylesheet Boost PDF stylesheet]'''
     157    [[Br]]Another project member of the unified look & feel project. We will adapt the PDF look and feel to be
     158    as close as possible to the HTML generated docs (but not closer, because PDF design rationale is different
     159    from HTML design ddecisions.
     160    [[Br]]''John Maddock''
     161    [[Br]]
     162    [[Image(People:john_maddock.png,50)]]
     163    [[Br]][[Br]]
     164
     165  * '''[BoostTracStylesheet Boost Trac stylesheet]'''
     166    [[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
     167    by doing some testing.
     168    [[Br]]''Douglas Gregor, Matias Capeletto''
     169    [[Br]]
     170    [[Image(People:doug_gregor.png,50)]]
     171    [[Image(People:matias_capeletto.png,50)]]
     172    [[Br]][[Br]]
     173
     174  * '''[BoostBuildSupportForDocsTools Boost.Build support for doc tools]'''
     175    [[Br]]Integration of new tools into the boost build system. It will be nice to have a Boost.Build expert to work
     176    with us.
     177    [[Br]]''John Maddock, Matias Capeletto''
     178    [[Br]]
     179    [[Image(People:john_maddock.png,50)]]
     180    [[Image(People:matias_capeletto.png,50)]]
     181    [[Br]][[Br]]
     182
     183  * '''[BoostscriptProject Boostscript]'''
     184    [[Br]]Javascript library used by Boostbook to achieve things like dynamic selection of
     185    syntax coloring, easy navigation of boost docs and old browser fixes.
     186    [[Br]]''Matias Capeletto''
     187    [[Br]]
     188    [[Image(People:matias_capeletto.png,50)]]
     189    [[Br]][[Br]]
     190
     191  * '''[HtmlToDockbookProject HTML to docbook]'''
     192    [[Br]]We are looking for solution to convert normal HTML into dockook files.
     193    [[Br]]''Glyn Matthews''
     194    [[Br]]
     195    [[Image(People:no_picture.png,50)]]
     196    [[Br]][[Br]]
     197
     198  * '''[ImprovingBoostbook Improving Boostbook]'''
     199    [[Br]] Simplify and integrate new stuff from the project into Boostbook stylesheets.
     200    [[Br]]''Matias Capeletto''
     201    [[Br]]
     202    [[Image(People:matias_capeletto.png,50)]]
     203    [[Br]][[Br]]
     204
     205  * '''[QuickbookSourceStylesheetProject Quickbook source stylesheet]'''
     206    [[Br]]We are developing a c CSS that lets as see boostbook based HTML as Quickbook source in
     207    a common browser.
     208    [[Br]]''Rene Rivera, Matias Capeletto''
     209    [[Br]]
     210    [[Image(People:rene_rivera.png,50)]]
     211    [[Image(People:matias_capeletto.png,50)]]
     212    [[Br]][[Br]]
     213
     214  * '''[SvgIconsSetProject SVG icons set project]'''
     215    [[Br]]Find scalable vector graphics icons for navigation and admonitions, so we can use them in
     216    both PDF and HTML output.
     217    [[Br]]''Peter Foley''
     218    [[Br]]
     219    [[Image(People:no_picture.png,50)]]
     220    [[Br]][[Br]]
     221
     222----
     223
     224=== Important external projects ===
     225
     226These projects are independent from the "Improving Boost Docs" umbrella.
     227They are included here because they are really important for this project, if you are the developper
     228of one of them, be free to move them to the list above.
     229
     230  * '''[QuickbookHtmlBackend Quickbook HTML backend]'''
     231    [[Br]]Rene Rivera
     232
     233  * '''[SandboxTemplate Automatic generation of doc files standard structure]'''
     234    [[Br]]Stjepan Rajko
     235
     236  * '''[wiki:soc/2007/VisualizationOfContainers Generation of SVG images from standard containers]'''
     237    [[Br]]Jacob Robert Voytko
     238
     239----
     240
     241   * [ImprovingBoostDocs Improving Boost Docs]
     242      * [ImprovingBoostDocs About this project]
     243      * [BoostDocsRepository Boost docs repository]
     244      * [UnifiedLookAndFeelProject Unified look & feel project]
     245      * [DocsTranslationsProject Docs translations project]
     246      * [GlueDocsProject Glue docs project]
     247      * [StandardCppLibraryDocumentation Standard C++ Library Docs]
     248      * [DocumentationBestPractices Documentation Best Practices]
     249      * '''[ImprovingBoostDocsSubprojects Subprojects]'''
     250           * [BoostDocTest Boost.DocTest ]
     251           * [BoostHtmlStylesheet Boost HTML stylesheet]
     252           * [BoostKateSupport Boost Kate support]
     253           * [BoostPdfStylesheet Boost PDF stylesheet]
     254           * [BoostSpecificWikiMacros Boost specific WikiMacros]
     255           * [BoostTracStylesheet Boost Trac stylesheet]
     256           * [BoostBuildSupportForDocsTools Boost.Build support for doc tools]
     257           * [BoostscriptProject Boostscript]
     258           * [GoogleSearchBoxProject Google Search Box project]
     259           * [HtmlToDockbookProject HTML to docbook]
     260           * [ImprovingBoostbook Improving Boostbook]
     261           * [ImprovingQuickbook Improving Quickbook]
     262           * [QuickbookWikiProcessor Quickbook WikiProcessor]
     263           * [QuickbookSourceStylesheetProject Quickbook source stylesheet]
     264           * [SvgIconsSetProject SVG icons set project]
     265           * [SyntaxHighlightingProject Syntax highlighting project]
     266           * [BoostTracSyntaxColoring Trac Syntax Coloring]
     267           * [DebuggerVisualizers Debugger Visualizers]
     268      * [BrowserTestingChart Browser Testing Chart]
     269      * [LibrariesLogos Logo Playground]
     270
     271----