Changes between Version 24 and Version 25 of DocsTranslationsProject
- Timestamp:
- Jun 26, 2007, 2:25:13 PM (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DocsTranslationsProject
v24 v25 38 38 39 39 SVN: snadbox/boost_docs/trunk/libs/lib_name 40 41 42 '''Docbook source''' - ''Required'' 43 44 * '''doc/lib_name.xml''' 45 [[Br]] Doc source in docbook format. Optionally it can include boostbook extensions. 46 * '''doc/lib_name.xsl''' 47 [[Br]] Library dependents output configuration parameters (i.e. chunker depth). 48 * '''doc/Jamfile.v2''' 49 [[Br]] "doc/bjam --v2" will generate the html docs. 50 51 '''Quickbook Source''' - ''Optional'' 52 53 * '''doc/lib_name.qbk''' 54 [[Br]] Main quickbook file. 55 56 * '''doc/*.qbk''' 57 [[Br]] Moderate size main sections quickbook files 58 59 * '''doc/larger_section.qbk''' 60 * '''doc/larger_section/*.qbk''' 61 [[Br]] Large size main sections (i.e reference) may be splitted again, organizing them 62 in a directory tree to avoid clutering the '''doc''' directory. 63 64 '''Images''' - ''Optional'' 65 66 * '''doc/images/*.png''' 67 [[Br]] You can use other formats, but be a good web citizen and use portable networks graphics. 68 * '''doc/images/*.svg''' 69 [[Br]] If you intend to have a decent rendering in the pdf docs, use svg. 70 71 '''Examples''' - ''Optional'' 72 73 * '''example/doc/*.cpp''' 74 [[Br]] Quickbook allows us to import code chuncks, instead of harcoding them in the qbk source. 75 This allow as to be sure that every code example will be in sync and with out typos. 76 * '''example/doc/Jamfile.v2''' 77 [[Br]] Testsuite for the doc examples. 78 79 '''Navigation aid''' - ''Will be automated in the future'' 80 81 * '''doc/html/sections.xml''' 82 [[Br]] Nested links xml definition of the library sections. This file is used to generate the 83 navigation select boxes and tree sidebar (''expected it soon!''). 84 85 === Library docs organization example === 40 86 41 87 '''Docbook source''' - ''Required'' … … 100 146 101 147 </library> 102 103 148 }}} 104 149 * '''doc/lib_name.xsl''' 150 [[Br]] Library dependents output configuration parameters (i.e. chunker depth). 105 151 [[Br]] Example: 106 152 {{{ … … 117 163 version="1.0"> 118 164 119 <!-- H tml boostbook parameters -->165 <!-- HTML Boostbook parameters --> 120 166 121 167 <xsl:param name = "chapter.logo.img" select = "'../images/library_logo.png'" /> … … 123 169 <xsl:param name = "quickbook.source.style.show" select = "'true'" /> 124 170 125 <!-- Dockbook parameters -->171 <!-- HTML Dockbook parameters --> 126 172 127 173 <xsl:param name = "chunk.section.depth" select = "2" /> 128 174 129 175 </xsl:stylesheet> 130 131 }}} 132 [[Br]] Library dependents output configuration parameters (i.e. chunker depth). 176 }}} 133 177 * '''doc/Jamfile.v2''' 134 178 [[Br]] "doc/bjam --v2" will generate the html docs. 135 179 [[Br]] Example: 136 180 {{{ 137 138 181 # Boost.LibraryName 139 182 # … … 157 200 library_name.xsl 158 201 ; 159 160 202 }}} 161 203 … … 213 255 214 256 [endsect] 215 216 257 }}} 217 258 * '''doc/*.qbk''' 218 259 [[Br]] Moderate size main sections quickbook files 260 [[Br]] Example: 219 261 {{{ 220 262 [/ … … 257 299 258 300 [endsect] 259 260 301 }}} 261 302 * '''doc/larger_section.qbk''' … … 310 351 311 352 //] 312 313 353 }}} 314 354 [[Br]] Use it qbk source: … … 352 392 353 393 [endsect] 354 355 394 }}} 356 395 * '''example/doc/Jamfile.v2''' … … 358 397 [[Br]] Example: 359 398 {{{ 360 361 399 # Boost.LibraryName 362 400 # … … 375 413 [ compile-fail compile_fail_example.cpp ] 376 414 ; 377 378 415 }}} 379 416 … … 417 454 418 455 </nestedLinks> 419 420 456 }}} 421 457
