Hi,

I have just tried to setup Boostbook for the first time following the
instructions here (http://tinyurl.com/y2kda6) and thought I would provide
some comments on the documentation to hopefully improve it.  (Hopefully I
will become proficient and be able to provide diff's)

Chapter 17 

Getting started (http://tinyurl.com/quh3t):

*       Just a minor comment, this statement is not correct "To use the
Boost documentation tools, you will need several tools:".  Besides xsltproc
and doxygen you need to download the DocBook XSL, Doc Book DTD and Apache
FOP (plus JAVA if it is not already installed).

*       The link for "MAC OS X without FINK: is incorrect it has a message
that it has now moved to this page:
http://www.explain.com.au/oss/libxml2xslt.html

Manual setup for all systems

Configuring xsltproc

*       "... where XSLTPROC is the full pathname to xsltproc (including
xsltproc)" - Although you already have a note in brackets I still walked
straight into it!  Maybe provide an explicit example or at least reword it
to "... where XSLTPROC is the full pathname to xsltproc (including xsltproc
executable).  For example c:\dev\tools\boostbook\xsltproc\xsltproc.exe".

Configuring local DocBook XSL and DTD distributions

*       The URL to get the DocBook DTD no longer works.  It can now be found
linked from here: http://www.docbook.org/schemas/4x which lists all the 4.
releases.  Direct link to 4.2 is http://www.docbook.org/xml/4.2/ also
reading through the change logs there appears to be no
backwards-incompatible changes up to the current release which is 4.5.  

(I have download 4.5 and have no issues yet)

*       Does the bug for removing the bin.v2 directory still stand?  I tried
to access: http://zigzag.cs.msu.su:7814/ the BJam bug tracker but could not
check it to see if it has been resolved.

*       Not sure if it matters but with Bjam now defaulting to version 2.
Should "bjam --v2" be changed.

(Yeah!!  I managed to compile (or is that generate?) the function doc's

I have attached the output of running bjam in the
$BOOST_ROOT/libs/function/doc as function_doc.txt.  Not sure if it is
important or not but it is complaining about a couple of re-definition's.
(Just incase it is important I am using docbook-xml-4_5 against two day old
CVS version of RC 1 3.4).

Configuring Doxygen for Documentation Extraction

*       The latest version of Doxygen is 1.5.1p1.  I have installed this
version. 

*       For HTML and PDF generation it asks you to test it.  Where is a good
location to test that DOXYGEN is working?

Configuring Apache FOP

*       It might be worthwhile using an explicit example for FOP_COMMAND.  I
read "replacing the FOP_COMMAND with the pull path to the FOP main script"
as just the path not including the directory.

*       I could not generate the PDF file.  I have attached my
user-config.jam and the output of the command function_pdf.txt. 

I hope this helps to improve the documentation.

Thanks,

Peter.

C:\Development\boost\boost_RC_1_34_0\libs\function\doc>bjam
warning: Python location is not configured
warning: the Boost.Python library won't be built
Building Boost.Regex with the optional Unicode/ICU support disabled.
Please refer to the Boost.Regex documentation for more information
(don't panic: this is a strictly optional feature).
...found 23 targets...
...updating 2 targets...
xslt-xsltproc 
..\..\..\bin.v2\libs\function\doc\msvc-8.0\debug\threading-multi\function.docbook
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
warning: Cannot find library 'Preprocessor'
warning: Cannot find library 'Bind'
warning: Cannot find library 'Lambda'
Cannot find function named 'boost::ref'
Cannot find function named 'boost::ref'
warning: cannot find concept 'EqualityComparable'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find function named 'boost::ref'
Cannot find function named 'boost::ref'
warning: cannot find concept 'EqualityComparable'
Cannot find function named 'boost::ref'
Cannot find class named 'boost::is_stateless'
Cannot find class named 'std::allocator'
Cannot find class named 'std::allocator'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'std::allocator'
Cannot find class named 'std::allocator'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'std::runtime_error'
Cannot find class named 'std::runtime_error'
Cannot find class named 'std::allocator'
warning: Cannot find library 'Lambda'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find method named 'reference_wrapper::get_pointer'
Cannot find class named 'reference_wrapper'
warning: cannot find concept 'EqualityComparable'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find method named 'reference_wrapper::get_pointer'
Cannot find class named 'reference_wrapper'
warning: cannot find concept 'EqualityComparable'
Cannot find class named 'std::allocator'
warning: Cannot find library 'Lambda'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find method named 'reference_wrapper::get_pointer'
Cannot find class named 'reference_wrapper'
Cannot find function named 'function_equals'
warning: cannot find concept 'EqualityComparable'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find method named 'reference_wrapper::get_pointer'
Cannot find class named 'reference_wrapper'
Cannot find function named 'function_equals'
warning: cannot find concept 'EqualityComparable'
warning: Cannot find library 'Signals'
Cannot find function named 'boost::unlambda'
Cannot find method named 'target'
Cannot find function named 'boost::ref'
Cannot find function named 'boost::ref'
xslt-xsltproc-dir html\HTML.manifest
Writing function/history.html for section(function.history)
ID recommended on section: Basic Usage
ID recommended on section: Free functions
ID recommended on section: Member functions
ID recommended on section: References to Function Objects
ID recommended on section: Comparing Boost.Function function object...
Writing function/tutorial.html for section(function.tutorial)
Writing boost/bad_function_call.html for refentry(boost.bad_function_call)
Writing boost/function_base.html for refentry(boost.function_base)
Writing boost/functionN.html for refentry(boost.functionN)
Writing boost/function.html for refentry(boost.function)
Writing boost/function_equal.html for refentry(boost.function_equal)
Writing function/reference.html for section(function.reference)
Writing function/faq.html for section(function.faq)
ID recommended on section: Boost.Function vs. Function Pointers
ID recommended on section: Performance
ID recommended on section: Function object wrapper size
ID recommended on section: Copying efficiency
ID recommended on section: Invocation efficiency
ID recommended on section: Combatting virtual function "bloat"
ID recommended on section: Acknowledgements
Writing function/misc.html for section(function.misc)
Writing function/testsuite.html for section(function.testsuite)
Writing index.html for chapter(function)
Writing HTML.manifest
...updated 2 targets...

C:\Development\boost\boost_RC_1_34_0\libs\function\doc>
C:\Development\boost\boost_RC_1_34_0\libs\function\doc>bjam pdf
warning: Python location is not configured
warning: the Boost.Python library won't be built
Building Boost.Regex with the optional Unicode/ICU support disabled.
Please refer to the Boost.Regex documentation for more information
(don't panic: this is a strictly optional feature).
...found 23 targets...
...updating 9 targets...
MkDir1 ..\..\..\bin.v2\libs\function
MkDir1 ..\..\..\bin.v2\libs\function\doc
MkDir1 ..\..\..\bin.v2\libs\function\doc\msvc-8.0
MkDir1 ..\..\..\bin.v2\libs\function\doc\msvc-8.0\debug
MkDir1 ..\..\..\bin.v2\libs\function\doc\msvc-8.0\debug\threading-multi
xslt-xsltproc 
..\..\..\bin.v2\libs\function\doc\msvc-8.0\debug\threading-multi\function.docbook
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
file:///C%3A/Development/tools/boostbook/docbook-xml-4_5/dbpoolx.mod:7254: 
validity error : Redefinition of element code

<!ELEMENT code %ho; (%cptr.char.mix;)*>
                                       ^
validity warning : Attribute id of element code: already defined
 %common.attrib;
                ^
        lang            CDATA           #IMPLIED
        ^
validity warning : Attribute last-revision of element code: already defined
 %code.role.attrib;
                   ^
role            CDATA           #IMPLIED
^
warning: Cannot find library 'Preprocessor'
warning: Cannot find library 'Bind'
warning: Cannot find library 'Lambda'
Cannot find function named 'boost::ref'
Cannot find function named 'boost::ref'
warning: cannot find concept 'EqualityComparable'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find function named 'boost::ref'
Cannot find function named 'boost::ref'
warning: cannot find concept 'EqualityComparable'
Cannot find function named 'boost::ref'
Cannot find class named 'boost::is_stateless'
Cannot find class named 'std::allocator'
Cannot find class named 'std::allocator'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'std::allocator'
Cannot find class named 'std::allocator'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'std::runtime_error'
Cannot find class named 'std::runtime_error'
Cannot find class named 'std::allocator'
warning: Cannot find library 'Lambda'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find method named 'reference_wrapper::get_pointer'
Cannot find class named 'reference_wrapper'
warning: cannot find concept 'EqualityComparable'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find method named 'reference_wrapper::get_pointer'
Cannot find class named 'reference_wrapper'
warning: cannot find concept 'EqualityComparable'
Cannot find class named 'std::allocator'
warning: Cannot find library 'Lambda'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find method named 'reference_wrapper::get_pointer'
Cannot find class named 'reference_wrapper'
Cannot find function named 'function_equals'
warning: cannot find concept 'EqualityComparable'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find class named 'reference_wrapper'
Cannot find method named 'reference_wrapper::get_pointer'
Cannot find class named 'reference_wrapper'
Cannot find function named 'function_equals'
warning: cannot find concept 'EqualityComparable'
warning: Cannot find library 'Signals'
Cannot find function named 'boost::unlambda'
Cannot find method named 'target'
Cannot find function named 'boost::ref'
Cannot find function named 'boost::ref'
xslt-xsltproc 
..\..\..\bin.v2\libs\function\doc\msvc-8.0\debug\threading-multi\function.fo
Making portrait pages on USletter paper (8.5inx11in)
fop.render.pdf 
..\..\..\bin.v2\libs\function\doc\msvc-8.0\debug\threading-multi\function.pdf
Exception in thread "main" java.lang.NoClassDefFoundError: 
org/apache/xalan/xslt/Process

  set JAVA_HOME=C:/Program Files/Java/jre1.5.0_10/bin/
 C:/Development/tools/boostbook/fop-0.20.5/xalan.bat 
..\..\..\bin.v2\libs\function\doc\msvc-8.0\debug\threading-multi\fu
nction.fo 
..\..\..\bin.v2\libs\function\doc\msvc-8.0\debug\threading-multi\function.pdf

...failed fop.render.pdf 
..\..\..\bin.v2\libs\function\doc\msvc-8.0\debug\threading-multi\function.pdf...
...failed updating 1 target...
...updated 8 targets...

C:\Development\boost\boost_RC_1_34_0\libs\function\doc>

Attachment: user-config.jam
Description: Binary data

-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Boost-docs mailing list
[email protected]
Unsubscribe and other administrative requests: 
https://lists.sourceforge.net/lists/listinfo/boost-docs

Reply via email to