Changes between Version 44 and Version 45 of ImprovingBoostDocsSubprojects


Ignore:
Timestamp:
Jul 18, 2007, 6:03:47 PM (15 years ago)
Author:
jakevoytko
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ImprovingBoostDocsSubprojects

    v44 v45  
    1515           * [BoostKateSupport Boost Kate support]
    1616           * [BoostPdfStylesheet Boost PDF stylesheet]
    17            * [BoostSpecificWikiMacros Boost specific WikiMacros]
     17           * [BoostSpecificWikiMacros Boost-Specific WikiMacros]
    1818           * [BoostTracStylesheet Boost Trac stylesheet]
    1919           * [BoostscriptProject Boostscript]
     
    3939=== Subprojects organization ===
    4040
    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:
     41  ''The branch organization presented here is based on the discussion in the Boost dev
     42  list about the best way to organize the main Boost repository. Since we must
     43  define our work methodology, this subproject can be used as a proof of concept.''
     44
     45Projects (such as the translation effort) are being committed directly to the Boost Docs
     46project trunk. The repository is in the following location:
    4747
    4848[http://svn.boost.org/trac/boost/browser/sandbox/boost_docs/trunk https://svn.boost.org/svn/boost/sandbox/boost_docs/trunk]
    4949
    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:
     50The Docs project can not affect the work of other people. If we commit a buggy
     51version of a subproject to the trunk, we can bother the work of other users! To avoid this, we will
     52use the trunk as a merging repository. Each subproject will have its own repository placed at:
    5553
    5654[http://svn.boost.org/trac/boost/browser/sandbox/boost_docs/subprojects https://svn.boost.org/svn/boost/sandbox/boost_docs/subprojects]
     
    6967         * '''test'''
    7068
    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
     69There are some subprojects that must be integrated in the Boost Docs trunk repository,
     70such as Improving Boostbook and Stylesheets projects.
     71When you feel confident with a given version, you can simply copy the last tag of your
    7472subproject to the main trunk.
    7573
    76 Each subproject have a Wiki page with additional information.
     74Each subproject has a Wiki page with additional information.
    7775
    7876----
     
    8179
    8280If you are interested, please send a mail to the
    83 [https://lists.sourceforge.net/lists/listinfo/boost-docs boost-docs list]
     81[https://lists.sourceforge.net/lists/listinfo/boost-docs Boost-docs list]
    8482telling us you want to help.
    8583
     
    8886[[Br]]
    8987
    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]'''
     88  * '''[BoostSpecificWikiMacros Boost Specific WikiMacros]'''
     89    [[Br]]Write a simple proposal for new Boost-specific !WikiMacros. Proposals should include
     90    the rationale behind each decision and the implementation of each proposed macro.
     91    [[Br]][[Br]]
     92
     93  * '''[GoogleSearchBoxProject Google Search Box Project]'''
    9694    [[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.
     95    Our idea is to use a Linked CSE Custom Google Search, an XML-based
     96    approach that allows us to specify the generated search page.
    9997    [[Br]]We need to investigate the Linked CSE technology and came up with a tested XML definition for our
    10098    libs.
     
    102100
    103101  * '''[QuickbookWikiProcessor Quickbook WikiProcessor]'''
    104     [[Br]]A Trac !WikiProcessor written in Python that integrates Rene Rivera HTML backend
     102    [[Br]]A Trac !WikiProcessor written in Python that integrates Rene Rivera's HTML backend
    105103    in the Trac Wiki.
    106104    [[Br]][[Br]]
    107105
    108106  * '''[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.
     107    [[Br]]This project consists of checking that the colors are right. Workers
     108    will also create color schemas for missing IDEs. When this first task is finished,
     109    this project will determine a default syntax highlighting scheme for Boost.
     110    This color scheme may be a combination of existing schemes.
    113111    [[Br]][[Br]]
    114112
    115113  * '''[BoostTracSyntaxColoring Trac Syntax Coloring]'''
    116114    [[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.
     115    Wiki and while browsing the repository.
     116    [[Br]]The project will consist in developing style definitions for common Boost
     117    file extensions (.hpp, .xml, etc) so Trac correctly performs source coloring.
    120118    [[Br]][[Br]]
    121119
     
    136134    [[Br]][[Br]]
    137135
    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.
     136  * '''[BoostHtmlStylesheet Boost HTML Stylesheet]'''
     137    [[Br]]As part of the Unified Look & Feel Project, we are making a standard CSS file that can be used in Boost HTML docs.
    140138    [[Br]]''Rene Rivera, Matias Capeletto, Joel de Guzman''
    141139    [[Br]]
     
    145143    [[Br]][[Br]]
    146144
    147   * '''[BoostKateSupport Boost Kate support]'''
     145  * '''[BoostKateSupport Boost Kate Support]'''
    148146    [[Br]]Syntax coloring, auto-commet and folding support for Boost C++, Quickbook and Jamfiles.
    149147    [[Br]]''Matias Capeletto''
     
    152150    [[Br]][[Br]]
    153151
    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
     152  * '''[BoostPdfStylesheet Boost PDF Stylesheet]'''
     153    [[Br]]Another project member of the Unified Look & Feel Project. We will adapt the PDF look and feel to be
    156154    as close as possible to the HTML generated docs (but not closer, because PDF design rationale is different
    157     from HTML design ddecisions.
     155    from HTML design decisions.
    158156    [[Br]]''John Maddock''
    159157    [[Br]]
     
    161159    [[Br]][[Br]]
    162160
    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
     161  * '''[BoostTracStylesheet Boost Trac Stylesheet]'''
     162    [[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
    165163    by doing some testing.
    166164    [[Br]]''Douglas Gregor, Matias Capeletto''
     
    171169
    172170  * '''[BoostscriptProject Boostscript]'''
    173     [[Br]]Javascript library used by Boostbook to achieve things like dynamic selection of
    174     syntax coloring, easy navigation of boost docs and old browser fixes.
     171    [[Br]] Javascript library used by Boostbook to achieve things like dynamic selection of
     172    syntax coloring, easy navigation of Boost docs, and old browser fixes.
    175173    [[Br]]''Matias Capeletto''
    176174    [[Br]]
     
    179177
    180178  * '''[HtmlToDockbookProject HTML to docbook]'''
    181     [[Br]]We are looking for solution to convert normal HTML into dockook files.
     179    [[Br]]We are looking for solution to convert normal HTML into Docbook files.
    182180    [[Br]]''Glyn Matthews''
    183181    [[Br]]
     
    186184
    187185  * '''[QuickbookSourceStylesheetProject Quickbook source stylesheet]'''
    188     [[Br]]We are developing a c CSS that lets as see boostbook based HTML as Quickbook source in
     186    [[Br]]We are developing a CSS file that allows a Boostbook-based HTML as Quickbook source in
    189187    a common browser.
    190188    [[Br]]''Rene Rivera, Matias Capeletto''
     
    195193
    196194  * '''[SvgIconsSetProject SVG icons set project]'''
    197     [[Br]]Find scalable vector graphics icons for navigation and admonitions, so we can use them in
    198     both PDF and HTML output.
     195    [[Br]]Find scalable vector graphics icons for navigation and admonitions. These can be used in PDF and HTML output.
    199196    [[Br]]''Peter Foley''
    200197    [[Br]]
     
    211208----
    212209
    213 === Important external projects ===
     210=== Important External Projects ===
    214211
    215212These projects are independent from the "Improving Boost Docs" umbrella.
    216 They are included here because they are really important for this project, if you are the developper
    217 of one of them, be free to move them to the list above.
     213They are included here because they are helpful to this project. If you are a developer
     214from one of the projects, feel free to move them to the list above!
    218215
    219216  * '''[QuickbookHtmlBackend Quickbook HTML backend]'''
    220217    [[Br]]Rene Rivera
    221218
    222   * '''[SandboxTemplate Automatic generation of doc files standard structure]'''
     219  * '''[SandboxTemplate Automatic Generation of Doc Files Standard Structure]'''
    223220    [[Br]]Stjepan Rajko
    224221
    225   * '''[wiki:soc/2007/VisualizationOfContainers Generation of SVG images from standard containers]'''
     222  * '''[wiki:soc/2007/VisualizationOfContainers Generation of SVG Images From Standard Containers]'''
    226223    [[Br]]Jacob Robert Voytko
    227224
     
    242239           * [BoostKateSupport Boost Kate support]
    243240           * [BoostPdfStylesheet Boost PDF stylesheet]
    244            * [BoostSpecificWikiMacros Boost specific WikiMacros]
     241           * [BoostSpecificWikiMacros Boost-Specific WikiMacros]
    245242           * [BoostTracStylesheet Boost Trac stylesheet]
    246243           * [BoostscriptProject Boostscript]