Changes between Version 11 and Version 12 of DocsTranslationsProject


Ignore:
Timestamp:
Jun 26, 2007, 12:57:49 PM (15 years ago)
Author:
Matias Capeletto
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • DocsTranslationsProject

    v11 v12  
    3535"Quickbook source" stylesheet. It works very well in Opera ( Menu: "View" ---> "Style" ---> "Quickbook source" ).
    3636
    37 === Organization in the repository === #docs-organization
     37=== Organization in the repository ===
    3838
    3939SVN: snadbox/boost_docs/trunk/libs/lib_name
    … …  
    4242
    4343  * '''doc/lib_name.xml'''
     44    [[Br]] Doc source in docbook format. Optionally it can include boostbook extensions.
     45    [[Br]] Example:
     46    {{{
     47
     48
     49    }}}
    4450  * '''doc/lib_name.xsl'''
     51    [[Br]] Example:
     52    {{{
     53
     54    }}}
     55    [[Br]] Library dependents output configuration parameters (i.e. chunker depth).
     56  * '''doc/Jamfile.v2'''
     57    [[Br]] "doc/bjam --v2" will generate the html docs.
     58    [[Br]] Example:
     59    {{{
     60
     61
     62    }}}
    4563
    4664'''Quickbook Source''' - ''Optional''
    4765
    48   * '''doc/Jamfile.v2'''
    4966  * '''doc/lib_name.qbk'''
     67    [[Br]] Main quickbook file.
     68    [[Br]] Example:
     69    {{{
     70
     71    }}}
    5072  * '''doc/*.qbk'''
     73    [[Br]] Moderate size main sections quickbook files
     74  * '''doc/big_section.qbk'''
    5175  * '''doc/big_section/*.qbk'''
     76    [[Br]] Big size main sections (i.e reference) may be splitted again, organizing them
     77    in a directory tree to avoid clutering the  '''doc''' directory.
    5278
    5379'''Images''' - ''Optional''
    5480
    5581  * '''doc/images/*.png'''
     82    [[Br]] You can use other formats, but be a good web citizen and use portable networks graphics.
    5683  * '''doc/images/*.svg'''
     84    [[Br]] If you intend to have a decent rendering in the pdf docs, use svg.
    5785
    5886'''Examples''' - ''Optional''
    5987
    6088  * '''example/doc/*.cpp'''
     89    [[Br]] Quickbook allows us to import code chuncks, instead of harcoding them in the qbk source.
     90    This allow as to be sure that every code example will be in sync and with out typos.
     91    [[Br]] Example:
     92    {{{
     93
     94    }}}
     95    [[Br]] Use it qbk source:
     96    [[Br]] Example:
     97    {{{
     98
     99
     100    }}}
    61101  * '''example/doc/Jamfile.v2'''
     102    [[Br]] Testsuite for the doc examples.
     103    [[Br]] Example:
     104    {{{
    62105
    63 '''Navigation aid''' - ''May be automated in the future''
     106   
     107    }}}
     108
     109'''Navigation aid''' - ''Will be automated in the future''
    64110
    65111  * '''doc/html/sections.xml'''
     112    [[Br]] Nested links xml definition of the library sections. This file is used to generate the
     113    navigation select boxes and tree sidebar (''expected it soon!'').
     114    [[Br]] Example:
     115    {{{
     116
     117    }}}
    66118
    67119=== Volunteers looking for something to do ===