Changes between Version 35 and Version 36 of DocsTranslationsProject


Ignore:
Timestamp:
Jun 26, 2007, 3:08:42 PM (15 years ago)
Author:
Matias Capeletto
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DocsTranslationsProject

    v35 v36  
    3232=== Translation Guide ===
    3333
    34 To translate html docs we should wait for the result of Glyn Matthews's [HtmlToDockbookProject Html to docbook project].
     34To translate HTML docs we should wait for the result of Glyn Matthews's [HtmlToDockbookProject HTML to docbook project].
    3535
    3636Once we have docbook docs, if the authors wants to have a Quickbook version of it (really recommended), we can use the
     
    4949    [[Br]] Library dependents output configuration parameters (i.e. chunker depth).
    5050  * '''[#example_boostbook_jamfile doc/Jamfile.v2]'''
    51     [[Br]] "doc/bjam --v2" will generate the html docs.
     51    [[Br]] "doc/bjam --v2" will generate the HTML docs.
    5252
    5353'''[#example_quickbook Quickbook Source]''' - ''Optional''
     
    5959    [[Br]] Moderate size main sections quickbook files
    6060
    61   * '''[#example_code_example_qbk doc/larger_section.qbk]'''
    62   * '''[#example_code_example_qbk doc/larger_section/*.qbk]'''
     61  * '''[#example_doc_example_qbk doc/larger_section.qbk]'''
     62  * '''[#example_doc_example_qbk doc/larger_section/*.qbk]'''
    6363    [[Br]] Large size main sections (i.e reference) may be splitted again, organizing them
    64     in a directory tree to avoid clutering the  '''doc''' directory.
     64    in a directory tree to avoid cluttering the  '''doc''' directory.
    6565
    6666'''[http://en.wikipedia.org/wiki/Category:Graphics_file_formats Images]''' - ''Optional''
     
    7171    [[Br]] If you intend to have a decent rendering in the pdf docs, use svg.
    7272
    73 '''[#example_code_example Examples]''' - ''Optional''
    74 
    75   * '''[#example_code_example_cpp example/doc/*.cpp]'''
    76     [[Br]] Quickbook allows us to import code chuncks, instead of harcoding them in the qbk source.
     73'''[#example_doc_example Examples]''' - ''Optional''
     74
     75  * '''[#example_doc_example_cpp example/doc/*.cpp]'''
     76    [[Br]] Quickbook allows us to import code chunks, instead of hard-coding them in the qbk source.
    7777    This allow as to be sure that every code example will be in sync and with out typos.
    78   * '''[#example_code_example_jamfile example/doc/Jamfile.v2]'''
     78  * '''[#example_doc_example_jamfile example/doc/Jamfile.v2]'''
    7979    [[Br]] Testsuite for the doc examples.
    8080
     
    183183}}}
    184184
    185 ===== doc/Jamfile.v2 ===== #example_doc_jamfile
     185===== doc/Jamfile.v2 ===== #example_boostbook_jamfile
    186186
    187187"doc/bjam --v2" will generate the html docs.
     
    303303[[Wiki style formating ][High signal to noise ratio in source code ]]
    304304[[Internal links       ][Easy to use inter-doc anchors             ]]
    305 [[Syntax Highligthing  ][Both in code blocks and in `inline code`  ]]
     305[[Syntax Highlighting  ][Both in code blocks and in `inline code`  ]]
    306306
    307307]
     
    314314===== example/doc/code_example.cpp ===== #example_doc_example_cpp
    315315
    316 Quickbook allows us to import code chuncks, instead of harcoding them in the qbk source.
     316Quickbook allows us to import code chunks, instead of hard-coding them in the qbk source.
    317317This allow as to be sure that every code example will be in sync and with out typos.
    318318{{{
     
    456456}}}
    457457
     458
     459
    458460----
    459461