Changes between Version 2 and Version 3 of DocsOrganization

Timestamp:

Jun 28, 2007, 1:29:33 PM (15 years ago)

Author:

Matias Capeletto

Comment:

--

DocsOrganization

@@ -14 +14 @@
 ----
 
+== Docs orgainzation proposal ==
+
+A standard layout for our docs files.
+
 '''[#example_boostbook Docbook source]''' - ''Required''
 
@@ -57 +61 @@
 ----
 
-=== Library docs organization example ===
+== Library docs organization example ==
 
 [[PageOutline(4-5,Examples list,inline)]]
 
-==== Docbook source ==== #example_boostbook
-
-===== doc/lib_name.xml ===== #example_boostbook_xml
+=== Docbook source === #example_boostbook
+
+==== doc/lib_name.xml ==== #example_boostbook_xml
 
 Doc source in docbook format. Optionally it can include boostbook extensions.
@@ -124 +128 @@
 }}}
 
-===== doc/lib_name.xsl ===== #example_boostbook_xsl
+==== doc/lib_name.xsl ==== #example_boostbook_xsl
 
 Library dependents output configuration parameters (i.e. chunker depth).
@@ -153 +157 @@
 }}}
 
-===== doc/Jamfile.v2 ===== #example_boostbook_jamfile
+==== doc/Jamfile.v2 ==== #example_boostbook_jamfile
 
 "doc/bjam --v2" will generate the html docs.
@@ -180 +184 @@
 }}}
 
-==== Quickbook Source ==== #example_quickbook
-
-===== doc/lib_name.qbk ===== #example_quickbook_main_qbk
+=== Quickbook Source === #example_quickbook
+
+==== doc/lib_name.qbk ==== #example_quickbook_main_qbk
 
 Main quickbook file.
@@ -235 +239 @@
 }}}
 
-===== doc/moderate_section.qbk ===== #example_quickbook_moderate_section_qbk
+==== doc/moderate_section.qbk ==== #example_quickbook_moderate_section_qbk
 
 Moderate size main sections quickbook files
@@ -280 +284 @@
 }}}
 
-==== Doc Examples ==== #example_doc_example
-
-===== example/doc/code_example.cpp ===== #example_doc_example_cpp
+=== Doc Examples === #example_doc_example
+
+==== example/doc/code_example.cpp ==== #example_doc_example_cpp
 
 Quickbook allows us to import code chunks, instead of hard-coding them in the qbk source.
@@ -321 +325 @@
 }}}
 
-===== doc/larger_section.qbk ===== #example_doc_example_qbk
+==== doc/larger_section.qbk ==== #example_doc_example_qbk
 
 {{{
@@ -363 +367 @@
 }}}
 
-===== example/doc/Jamfile.v2 ===== #example_doc_example_jamfile
+==== example/doc/Jamfile.v2 ==== #example_doc_example_jamfile
 
 Testsuite for the doc examples.
@@ -385 +389 @@
 }}}
 
-==== Navigation aid ==== #example_navigation
-
-===== doc/html/sections.xml ===== #example_navigation_sections_xml
+=== Navigation aid === #example_navigation
+
+==== doc/html/sections.xml ==== #example_navigation_sections_xml
 
 Nested links xml definition of the library sections. This file is used to generate the