Changes between Version 33 and Version 34 of DocsTranslationsProject


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

--

Legend:

Unmodified
Added
Removed
Modified
  • DocsTranslationsProject

    v33 v34  
    4646  * '''[#example_boostbook_xml doc/lib_name.xml]'''
    4747    [[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]'''
    4949    [[Br]] Library dependents output configuration parameters (i.e. chunker depth).
    50   * '''doc/Jamfile.v2'''
     50  * '''[#example_boostbook_jamfile doc/Jamfile.v2]'''
    5151    [[Br]] "doc/bjam --v2" will generate the html docs.
    5252
    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]'''
    5656    [[Br]] Main quickbook file.
    5757
    58   * '''doc/*.qbk'''
     58  * '''[#example_quickbook_moderate_section_qbk doc/*.qbk]'''
    5959    [[Br]] Moderate size main sections quickbook files
    6060
    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]'''
    6363    [[Br]] Large size main sections (i.e reference) may be splitted again, organizing them
    6464    in a directory tree to avoid clutering the  '''doc''' directory.
    6565
    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]'''
    6969    [[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]'''
    7171    [[Br]] If you intend to have a decent rendering in the pdf docs, use svg.
    7272
    73 '''Examples''' - ''Optional''
    74 
    75   * '''example/doc/*.cpp'''
     73'''[#example_code_example Examples]''' - ''Optional''
     74
     75  * '''[#example_code_example_cpp example/doc/*.cpp]'''
    7676    [[Br]] Quickbook allows us to import code chuncks, instead of harcoding 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/doc/Jamfile.v2'''
     78  * '''[#example_code_example_jamfile example/doc/Jamfile.v2]'''
    7979    [[Br]] Testsuite for the doc examples.
    8080
    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]'''
    8484    [[Br]] Nested links xml definition of the library sections. This file is used to generate the
    8585    navigation select boxes and tree sidebar (''expected it soon'').