Changes between Version 33 and Version 34 of DocsTranslationsProject
- Timestamp:
- Jun 26, 2007, 2:59:14 PM (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DocsTranslationsProject
v33 v34 46 46 * '''[#example_boostbook_xml doc/lib_name.xml]''' 47 47 [[Br]] Doc source in docbook format. Optionally it can include boostbook extensions. 48 * ''' doc/lib_name.xsl'''48 * '''[#example_boostbook_xsl doc/lib_name.xsl]''' 49 49 [[Br]] Library dependents output configuration parameters (i.e. chunker depth). 50 * ''' doc/Jamfile.v2'''50 * '''[#example_boostbook_jamfile doc/Jamfile.v2]''' 51 51 [[Br]] "doc/bjam --v2" will generate the html docs. 52 52 53 ''' Quickbook Source''' - ''Optional''54 55 * ''' doc/lib_name.qbk'''53 '''[#example_quickbook Quickbook Source]''' - ''Optional'' 54 55 * '''[#example_quickbook_main_qbk doc/lib_name.qbk]''' 56 56 [[Br]] Main quickbook file. 57 57 58 * ''' doc/*.qbk'''58 * '''[#example_quickbook_moderate_section_qbk doc/*.qbk]''' 59 59 [[Br]] Moderate size main sections quickbook files 60 60 61 * ''' doc/larger_section.qbk'''62 * ''' doc/larger_section/*.qbk'''61 * '''[#example_code_example_qbk doc/larger_section.qbk]''' 62 * '''[#example_code_example_qbk doc/larger_section/*.qbk]''' 63 63 [[Br]] Large size main sections (i.e reference) may be splitted again, organizing them 64 64 in a directory tree to avoid clutering the '''doc''' directory. 65 65 66 ''' Images''' - ''Optional''67 68 * ''' doc/images/*.png'''66 '''[http://en.wikipedia.org/wiki/Category:Graphics_file_formats Images]''' - ''Optional'' 67 68 * '''[http://en.wikipedia.org/wiki/PNG doc/images/*.png]''' 69 69 [[Br]] You can use other formats, but be a good web citizen and use portable networks graphics. 70 * ''' doc/images/*.svg'''70 * '''[http://en.wikipedia.org/wiki/Scalable_Vector_Graphics doc/images/*.svg]''' 71 71 [[Br]] If you intend to have a decent rendering in the pdf docs, use svg. 72 72 73 ''' Examples''' - ''Optional''74 75 * ''' example/doc/*.cpp'''73 '''[#example_code_example Examples]''' - ''Optional'' 74 75 * '''[#example_code_example_cpp example/doc/*.cpp]''' 76 76 [[Br]] Quickbook allows us to import code chuncks, instead of harcoding 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/doc/Jamfile.v2'''78 * '''[#example_code_example_jamfile example/doc/Jamfile.v2]''' 79 79 [[Br]] Testsuite for the doc examples. 80 80 81 ''' Navigation aid''' - ''Will be automated in the future''82 83 * ''' doc/html/sections.xml'''81 '''[#example_code_navigation Navigation aid]''' - ''Will be automated in the future'' 82 83 * '''[#example_code_navigation_sections_xml doc/html/sections.xml]''' 84 84 [[Br]] Nested links xml definition of the library sections. This file is used to generate the 85 85 navigation select boxes and tree sidebar (''expected it soon'').