Changes between Version 26 and Version 27 of DocsTranslationsProject


Ignore:
Timestamp:
Jun 26, 2007, 2:35:18 PM (15 years ago)
Author:
Matias Capeletto
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • DocsTranslationsProject

    v26 v27  
    8787=== Library docs organization example ===
    8888
    89 '''Docbook source''' - ''Required''
    90 
    91   * '''doc/lib_name.xml'''
    92     [[Br]] Doc source in docbook format. Optionally it can include boostbook extensions.
    93     [[Br]] Example:
    94     {{{
     89==== Docbook source ====
     90
     91===== doc/lib_name.xml =====
     92
     93Doc source in docbook format. Optionally it can include boostbook extensions.
     94[[Br]] Example:
     95{{{
    9596<?xml version="1.0" encoding="UTF-8"?>
    9697<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
    … …  
    148149
    149150</library>
    150     }}}
    151   * '''doc/lib_name.xsl'''
    152     [[Br]] Library dependents output configuration parameters (i.e. chunker depth).
    153     [[Br]] Example:
    154     {{{
     151}}}
     152
     153===== doc/lib_name.xsl =====
     154
     155Library dependents output configuration parameters (i.e. chunker depth).
     156[[Br]] Example:
     157{{{
    155158<?xml version="1.0" encoding="utf-8"?>
    156159<!--
    … …  
    176179
    177180</xsl:stylesheet>
    178     }}}
    179   * '''doc/Jamfile.v2'''
    180     [[Br]] "doc/bjam --v2" will generate the html docs.
    181     [[Br]] Example:
    182     {{{
     181}}}
     182===== doc/Jamfile.v2 =====
     183
     184"doc/bjam --v2" will generate the html docs.
     185[[Br]] Example:
     186{{{
    183187# Boost.LibraryName
    184188#
    … …  
    202206        library_name.xsl
    203207    ;
    204     }}}
    205 
    206 '''Quickbook Source''' - ''Optional''
    207 
    208   * '''doc/lib_name.qbk'''
    209     [[Br]] Main quickbook file.
    210     [[Br]] Example:
    211     {{{
     208}}}
     209
     210==== Quickbook Source ====
     211
     212===== doc/lib_name.qbk =====
     213
     214Main quickbook file.
     215[Br]] Example:
     216{{{
    212217[library LibraryName
    213218    [quickbook 1.4]
    … …  
    257262
    258263[endsect]
    259     }}}
    260   * '''doc/*.qbk'''
    261     [[Br]] Moderate size main sections quickbook files
    262     [[Br]] Example:
    263     {{{
     264}}}
     265
     266===== doc/*.qbk =====
     267
     268Moderate size main sections quickbook files
     269[[Br]] Example:
     270{{{
    264271[/
    265272    Boost.LibrayName
    … …  
    301308
    302309[endsect]
    303     }}}
    304   * '''doc/larger_section.qbk'''
    305   * '''doc/larger_section/*.qbk'''
    306     [[Br]] Large size main sections (i.e reference) may be splitted again, organizing them
    307     in a directory tree to avoid clutering the  '''doc''' directory.
    308 
    309 '''Images''' - ''Optional''
    310 
    311   * '''doc/images/*.png'''
    312     [[Br]] You can use other formats, but be a good web citizen and use portable networks graphics.
    313   * '''doc/images/*.svg'''
    314     [[Br]] If you intend to have a decent rendering in the pdf docs, use svg.
    315 
    316 '''Examples''' - ''Optional''
    317 
    318   * '''example/doc/*.cpp'''
    319     [[Br]] Quickbook allows us to import code chuncks, instead of harcoding them in the qbk source.
    320     This allow as to be sure that every code example will be in sync and with out typos.
    321     [[Br]] Example:
    322     {{{
     310}}}
     311
     312==== Examples ====
     313
     314===== example/doc/*.cpp =====
     315
     316Quickbook allows us to import code chuncks, instead of harcoding them in the qbk source.
     317This allow as to be sure that every code example will be in sync and with out typos.
     318[[Br]] Example:
     319{{{
    323320// Boost.LibraryName
    324321//
    … …  
    353350
    354351//]
    355     }}}
    356     [[Br]] Use it qbk source:
    357     [[Br]] Example:
    358     {{{
     352}}}
     353
     354Use it qbk source:
     355[[Br]] Example:
     356{{{
    359357[/
    360358    Boost.LibrayName
    … …  
    394392
    395393[endsect]
    396     }}}
    397   * '''example/doc/Jamfile.v2'''
    398     [[Br]] Testsuite for the doc examples.
    399     [[Br]] Example:
    400     {{{
     394}}}
     395
     396===== example/doc/Jamfile.v2 =====
     397
     398Testsuite for the doc examples.
     399[[Br]] Example:
     400{{{
    401401# Boost.LibraryName
    402402#
    … …  
    415415    [ compile-fail  compile_fail_example.cpp    ]
    416416    ;
    417     }}}
    418 
    419 '''Navigation aid''' - ''Will be automated in the future''
    420 
    421   * '''doc/html/sections.xml'''
    422     [[Br]] Nested links xml definition of the library sections. This file is used to generate the
    423     navigation select boxes and tree sidebar (''expected it soon!'').
    424     [[Br]] Example:
    425     {{{
     417}}}
     418
     419==== Navigation aid ====
     420
     421===== doc/html/sections.xml =====
     422
     423Nested links xml definition of the library sections. This file is used to generate the
     424navigation select boxes and tree sidebar (''expected it soon!'').
     425[[Br]] Example:
     426{{{
    426427<?xml version="1.0" encoding="UTF-8" ?>
    427428
    … …  
    456457
    457458</nestedLinks>
    458     }}}
     459}}}
    459460
    460461=== Volunteers looking for something to do ===