Changes between Version 35 and Version 36 of DocsTranslationsProject
- Timestamp:
- Jun 26, 2007, 3:08:42 PM (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DocsTranslationsProject
v35 v36 32 32 === Translation Guide === 33 33 34 To translate html docs we should wait for the result of Glyn Matthews's [HtmlToDockbookProject Htmlto docbook project].34 To translate HTML docs we should wait for the result of Glyn Matthews's [HtmlToDockbookProject HTML to docbook project]. 35 35 36 36 Once we have docbook docs, if the authors wants to have a Quickbook version of it (really recommended), we can use the … … 49 49 [[Br]] Library dependents output configuration parameters (i.e. chunker depth). 50 50 * '''[#example_boostbook_jamfile doc/Jamfile.v2]''' 51 [[Br]] "doc/bjam --v2" will generate the htmldocs.51 [[Br]] "doc/bjam --v2" will generate the HTML docs. 52 52 53 53 '''[#example_quickbook Quickbook Source]''' - ''Optional'' … … 59 59 [[Br]] Moderate size main sections quickbook files 60 60 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]''' 63 63 [[Br]] Large size main sections (i.e reference) may be splitted again, organizing them 64 in a directory tree to avoid clut ering the '''doc''' directory.64 in a directory tree to avoid cluttering the '''doc''' directory. 65 65 66 66 '''[http://en.wikipedia.org/wiki/Category:Graphics_file_formats Images]''' - ''Optional'' … … 71 71 [[Br]] If you intend to have a decent rendering in the pdf docs, use svg. 72 72 73 '''[#example_ code_example Examples]''' - ''Optional''74 75 * '''[#example_ code_example_cpp example/doc/*.cpp]'''76 [[Br]] Quickbook allows us to import code chun cks, 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. 77 77 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]''' 79 79 [[Br]] Testsuite for the doc examples. 80 80 … … 183 183 }}} 184 184 185 ===== doc/Jamfile.v2 ===== #example_ doc_jamfile185 ===== doc/Jamfile.v2 ===== #example_boostbook_jamfile 186 186 187 187 "doc/bjam --v2" will generate the html docs. … … 303 303 [[Wiki style formating ][High signal to noise ratio in source code ]] 304 304 [[Internal links ][Easy to use inter-doc anchors ]] 305 [[Syntax Highlig thing ][Both in code blocks and in `inline code` ]]305 [[Syntax Highlighting ][Both in code blocks and in `inline code` ]] 306 306 307 307 ] … … 314 314 ===== example/doc/code_example.cpp ===== #example_doc_example_cpp 315 315 316 Quickbook allows us to import code chun cks, instead of harcoding them in the qbk source.316 Quickbook allows us to import code chunks, instead of hard-coding them in the qbk source. 317 317 This allow as to be sure that every code example will be in sync and with out typos. 318 318 {{{ … … 456 456 }}} 457 457 458 459 458 460 ---- 459 461