[Boost-commit] svn:boost r68431 - sandbox/guild/pool/libs/pool/doc

Subject: [Boost-commit] svn:boost r68431 - sandbox/guild/pool/libs/pool/doc
From: pbristow_at_[hidden]
Date: 2011-01-25 09:53:49

Author: pbristow
Date: 2011-01-25 09:53:48 EST (Tue, 25 Jan 2011)
New Revision: 68431
URL: http://svn.boost.org/trac/boost/changeset/68431

Log:
Added auto-index with manually selected index terms.
Binary files modified: 
   sandbox/guild/pool/libs/pool/doc/pool.modified.pdf
   sandbox/guild/pool/libs/pool/doc/pool.pdf
Text files modified: 
   sandbox/guild/pool/libs/pool/doc/jamfile.v2 |    31 +++++++++++++++++++++++--------         
   sandbox/guild/pool/libs/pool/doc/pool.qbk   |     4 ++++                                    
   2 files changed, 27 insertions(+), 8 deletions(-)

Modified: sandbox/guild/pool/libs/pool/doc/jamfile.v2
==============================================================================
--- sandbox/guild/pool/libs/pool/doc/jamfile.v2	(original)
+++ sandbox/guild/pool/libs/pool/doc/jamfile.v2	2011-01-25 09:53:48 EST (Tue, 25 Jan 2011)
@@ -11,8 +11,8 @@
 #path-constant images_location : html/images/ ; # location of SVG and PNG images referenced by Quickbook.
 path-constant images_location : html ; # location of SVG and PNG images referenced by Quickbook.
 
-echo "images_location" $(images_location) ;
-echo "nav-images" $(nav_images) ;
+echo "images_location" $(images_location) ; # \guild\pool\libs\pool\doc\html
+echo "nav_images" $(nav_images) ; # \guild\pool\libs\pool\doc\html\images
 
 import modules ;
 
@@ -23,16 +23,20 @@
    project : requirements
         <auto-index>on # Turns on index (or off).
         
-        # Choose indexing method:
+        # Choose indexing method (separately for html and pdf):
         <format>html:<auto-index-internal>on  # on (or off) to use internally generated indexes.
         # <format>html:<xsl:param>generate.index=0 # Don't let the XSL stylesheets generate indexes.
         
-        <format>pdf:<auto-index-internal>on # on (or off) to use internally generated indexes.
+        <format>pdf:<auto-index-internal>off # on (or off) to use internally generated indexes.
         # <auto-index-type>index  # Use <index>...</index> as the XML wrapper.
+        
+        <format>pdf:<xsl:param>index.on.type=1 # For the native stylesheets to generate the different indexes.
+        # PDF native index support is probably better for PDFs as then you actually get page numbers.
 
         <auto-index-script>index.idx # Specifies the name of the script to load. 
         # <auto-index-prefix>../../../.. used by math
-        <auto-index-prefix>../../../ 
+        # <auto-index-prefix>../../../ # OK
+        <auto-index-prefix>../../.. 
         <quickbook-define>enable_index ;
 }
 else
@@ -142,13 +146,15 @@
                 <xsl:param>page.margin.inner=0.5in
                 # Margin size:
                 <xsl:param>page.margin.outer=0.5in
+		
                 # Yes, we want graphics for admonishments:
                 <xsl:param>admon.graphics=1
-		# Set this one for PDF generation *only*:
+		
+		# Set these one for PDF generation *only*:
                 # default png graphics are awful in PDF form,
                 # better use SVG instead:
                 #<format>pdf:<xsl:param>admon.graphics.extension=".svg"
-		<format>pdf:<xsl:param>admon.graphics.extension=".png" 
+		<format>pdf:<xsl:param>admon.graphics.extension=".png" # Only png images are available.
                 <format>pdf:<xsl:param>admon.graphics.path=$(nav_images)/ # next, prev, note, tip ... for pdf.
                 <format>pdf:<xsl:param>use.role.for.mediaobject=1 
                 <format>pdf:<xsl:param>preferred.mediaobject.role=print
@@ -160,4 +166,13 @@
 
    ;
 
-install pdf-install : standalone : <location>. <install-type>PDF ; # copy pdf to libs/pool/doc, same location as .qbk .
+#install pdf-install : standalone : <location>. <install-type>PDF ; # copy pdf to libs/pool/doc, . means same location as .qbk = /doc .
+# for pdf moves pool.modified.pdf instead.
+
+# install pdf-install : standalone : <install-type>PDF <location>.<name>math.pdf ;
+
+#install pdf-install : standalone : <location>.<name>math.pdf <install-type>PDF ;
+#install pdf-install : standalone : <install-type>PDF <location>. <name>type_traits.pdf ;
+install pdf-install : standalone : <install-type>PDF <location>. <name>pool.pdf ;
+
+# copy pdf to libs/pool/doc, same location as .qbk .

Modified: sandbox/guild/pool/libs/pool/doc/pool.modified.pdf
==============================================================================
Binary files. No diff available.

Modified: sandbox/guild/pool/libs/pool/doc/pool.pdf
==============================================================================
Binary files. No diff available.

Modified: sandbox/guild/pool/libs/pool/doc/pool.qbk
==============================================================================
--- sandbox/guild/pool/libs/pool/doc/pool.qbk	(original)
+++ sandbox/guild/pool/libs/pool/doc/pool.qbk	2011-01-25 09:53:48 EST (Tue, 25 Jan 2011)
@@ -1145,12 +1145,16 @@
 
 [? enable_index
 '''
+  <index/>
+
   <index type="function_name">
   <title>Function Index</title>
   </index>
+  
   <index type="class_name">
   <title>Class Index</title>
   </index>
+  
   <index type="typedef_name">
   <title>Typedef Index</title>
   </index>