QuickBook

OvermindDL1

13 Aug 2010 13 Aug '10

5:40 a.m.

Attempting to use QuickBook to create both HTML and PDF documentation. First of all, compiled just about everything I can compile in boost, including about all the tools, on Ubuntu. I created a directory named qb_test. I created a file called test.qbk and filled it with: """ [article TestingArticle [quickbook 1.5] [version 0.1] [authors [, OvermindDL1]] [copyright 2010 OvermindDL1] [/ [purpose /WikiWiki/ style documentation tool]] [id test] ] [section:intro Introduction] This is just a simple testing thing, we shall see how it works overall... [endsect] [section:change_log Change Log] [h3 Version 0.1] * Initial creation... * Two pages setup, intro and change_log [endsect] """ I ran: """ quickbook test.qbk """ It created a test.xml file, not quite what I was looking for, I take it that it does not call boostbook directly... So then I started looking for how to call boostbook and became pretty lost, for some reason I recall this being easier on Windows... Decided to try to use bjam (although the project this is eventually going into uses CMake, so no bjam eventually...), made a Jamfile containing: """ project test import boostbook : boostbook ; boostbook test : test.qbk : <include>. ; """ And running bjam complains about not having found boost, which makes sense since boost was build as a different user so its building directory is inaccessible. Basically I want to build a quickbook documentation for another very large C++ project that itself uses CMake, how would I go about doing this? The quickbook documentation is lacking in how to get a finished html/pdf/etc...

Show replies by date

Daniel James

13 Aug 13 Aug

6:58 a.m.

On 13 August 2010 06:40, OvermindDL1 wrote:

...

Attempting to use QuickBook to create both HTML and PDF documentation.

First of all, compiled just about everything I can compile in boost, including about all the tools, on Ubuntu.

To use quickbook you need to install a few more things. There's some instructions in the quickbook documentation: http://www.boost.org/doc/libs/1_43_0/doc/html/quickbook/install.html#quickbo...

...

And running bjam complains about not having found boost, which makes sense since boost was build as a different user so its building directory is inaccessible.

If you use a prebuilt quickbook (you need to specify the location in your user-config.jam), you'll only need read access to the boost repository. If you set $BOOST_ROOT to its location, you should be okay. This is just to access boost build, the xsl stylesheets and dtd files. Daniel

OvermindDL1

7:12 a.m.

On Fri, Aug 13, 2010 at 12:58 AM, Daniel James wrote:

...

On 13 August 2010 06:40, OvermindDL1 wrote:

...
Attempting to use QuickBook to create both HTML and PDF documentation.

First of all, compiled just about everything I can compile in boost, including about all the tools, on Ubuntu.

To use quickbook you need to install a few more things. There's some instructions in the quickbook documentation:

http://www.boost.org/doc/libs/1_43_0/doc/html/quickbook/install.html#quickbo...

I did follow that, and everything is installed, I built quickbook as root and 'installed' it into /usr/local/bin/, just as bjam and such is. On Fri, Aug 13, 2010 at 12:58 AM, Daniel James wrote:

...

...
And running bjam complains about not having found boost, which makes sense since boost was build as a different user so its building directory is inaccessible.

If you use a prebuilt quickbook (you need to specify the location in your user-config.jam), you'll only need read access to the boost repository. If you set $BOOST_ROOT to its location, you should be okay. This is just to access boost build, the xsl stylesheets and dtd files.

Is there any way to remove the dependency on bjam?

Daniel James

8 a.m.

...

On Fri, Aug 13, 2010 at 12:58 AM, Daniel James wrote:

...
...
And running bjam complains about not having found boost, which makes sense since boost was build as a different user so its building directory is inaccessible.

If you use a prebuilt quickbook (you need to specify the location in your user-config.jam), you'll only need read access to the boost repository. If you set $BOOST_ROOT to its location, you should be okay. This is just to access boost build, the xsl stylesheets and dtd files.

Is there any way to remove the dependency on bjam?

Apparently, boost-cmake can (or perhaps could) build quickbook documentation: http://article.gmane.org/gmane.comp.lib.boost.cmake/336 Other than that, it's complicated, there's a lot of parts to get right. You can see what bjam's doing by running 'bjam -n'. Daniel

John Maddock

8:58 a.m.

...

Is there any way to remove the dependency on bjam?

It's somewhat Windows specific, but take a look at libs/math/doc/sf_and_dist/win32_nmake.mak which provides an example makefile for building without bjam. HTH, John.

OvermindDL1

9:57 a.m.

My current results are: ...patience... ...found 1311 targets... ...updating 7 targets... common.mkdir bin common.mkdir bin/gcc-4.4.3 common.mkdir bin/gcc-4.4.3/debug quickbook.quickbook-to-boostbook bin/gcc-4.4.3/debug/test.xml Generating Output File: bin/gcc-4.4.3/debug/test.xml xslt-xsltproc bin/gcc-4.4.3/debug/test.docbook xslt-xsltproc bin/gcc-4.4.3/debug/test.html warning: failed to load external entity "http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl" compilation error: file /usr/local/share/boost-trunk/tools/boostbook/xsl/html-single.xsl line 15 element import xsl:import : unable to load http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl warning: failed to load external entity "http://docbook.sourceforge.net/release/xsl/current/html/admon.xsl" compilation error: file /usr/local/share/boost-trunk/tools/boostbook/xsl/admon.xsl line 12 element import xsl:import : unable to load http://docbook.sourceforge.net/release/xsl/current/html/admon.xsl warning: failed to load external entity "http://docbook.sourceforge.net/release/xsl/current/lib/lib.xsl" compilation error: file /usr/local/share/boost-trunk/tools/boostbook/xsl/relative-href.xsl line 12 element import xsl:import : unable to load http://docbook.sourceforge.net/release/xsl/current/lib/lib.xsl XML_CATALOG_FILES="bin/boostbook_catalog.xml" export XML_CATALOG_FILES "/usr/bin/xsltproc" --stringparam chunk.first.sections "1" --stringparam chunk.section.depth "4" --stringparam generate.section.toc.level "4" --stringparam toc.max.depth "3" --stringparam toc.section.depth "3" --xinclude -o "bin/gcc-4.4.3/debug/test.html" "/usr/local/share/boost-trunk/tools/boostbook/xsl/html-single.xsl" "bin/gcc-4.4.3/debug/test.docbook" ...failed xslt-xsltproc bin/gcc-4.4.3/debug/test.html... ...failed updating 1 target... ...updated 6 targets... So this is still failing with the above simple qbk file, any thoughts? On Fri, Aug 13, 2010 at 2:00 AM, Daniel James wrote:

...

...
On Fri, Aug 13, 2010 at 12:58 AM, Daniel James wrote:

...
...
And running bjam complains about not having found boost, which makes sense since boost was build as a different user so its building directory is inaccessible.

If you use a prebuilt quickbook (you need to specify the location in your user-config.jam), you'll only need read access to the boost repository. If you set $BOOST_ROOT to its location, you should be okay. This is just to access boost build, the xsl stylesheets and dtd files.

Is there any way to remove the dependency on bjam?

Apparently, boost-cmake can (or perhaps could) build quickbook documentation:

http://article.gmane.org/gmane.comp.lib.boost.cmake/336

Other than that, it's complicated, there's a lot of parts to get right. You can see what bjam's doing by running 'bjam -n'.

Ooo, thanks for the hint, shall look at that. On Fri, Aug 13, 2010 at 2:58 AM, John Maddock wrote:

...

...
Is there any way to remove the dependency on bjam?

It's somewhat Windows specific, but take a look at libs/math/doc/sf_and_dist/win32_nmake.mak which provides an example makefile for building without bjam.

HTH, John.

Hmm, I shall examine that too...

OvermindDL1

10:01 a.m.

On Fri, Aug 13, 2010 at 3:57 AM, OvermindDL1 wrote:

...

/* snip */

For note, here is the failing build with -n, and it should be rewriteURI'ing fine, but it is still trying to get it from the web? ...patience... ...found 1311 targets... ...updating 7 targets... common.mkdir bin mkdir -p "bin" file /tmp/jam3fd91736.000 <?xml version="1.0"?> <!DOCTYPE catalog PUBLIC "-//OASIS/DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"> <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"> <rewriteURI uriStartString="http://www.boost.org/tools/boostbook/dtd/" rewritePrefix="file:///usr/local/share/boost-trunk/tools/boostbook/dtd/"/> <rewriteURI uriStartString="http://docbook.sourceforge.net/release/xsl/current/" rewritePrefix="file:///usr/local/share/boost-trunk/tools/boostbook/docbook-xsl-1.75.2/"/> <rewriteURI uriStartString="http://www.oasis-open.org/docbook/xml/4.2/" rewritePrefix="file:///usr/local/share/boost-trunk/tools/boostbook/docbook-dtd-4.2/"/> </catalog> text-action bin/boostbook_catalog.xml cat "/tmp/jam3fd91736.000" > "bin/boostbook_catalog.xml" common.mkdir bin/gcc-4.4.3 mkdir -p "bin/gcc-4.4.3" common.mkdir bin/gcc-4.4.3/debug mkdir -p "bin/gcc-4.4.3/debug" quickbook.quickbook-to-boostbook bin/gcc-4.4.3/debug/test.xml "/usr/local/share/boost-trunk/bin.v2/tools/quickbook/gcc-4.4.3/debug/link-static/quickbook" -I"." --output-file="bin/gcc-4.4.3/debug/test.xml" "test.qbk" xslt-xsltproc bin/gcc-4.4.3/debug/test.docbook XML_CATALOG_FILES="bin/boostbook_catalog.xml" export XML_CATALOG_FILES "/usr/bin/xsltproc" --stringparam chunk.first.sections "1" --stringparam chunk.section.depth "4" --stringparam generate.section.toc.level "4" --stringparam toc.max.depth "3" --stringparam toc.section.depth "3" --xinclude -o "bin/gcc-4.4.3/debug/test.docbook" "/usr/local/share/boost-trunk/tools/boostbook/xsl/docbook.xsl" "bin/gcc-4.4.3/debug/test.xml" xslt-xsltproc bin/gcc-4.4.3/debug/test.html XML_CATALOG_FILES="bin/boostbook_catalog.xml" export XML_CATALOG_FILES "/usr/bin/xsltproc" --stringparam chunk.first.sections "1" --stringparam chunk.section.depth "4" --stringparam generate.section.toc.level "4" --stringparam toc.max.depth "3" --stringparam toc.section.depth "3" --xinclude -o "bin/gcc-4.4.3/debug/test.html" "/usr/local/share/boost-trunk/tools/boostbook/xsl/html-single.xsl" "bin/gcc-4.4.3/debug/test.docbook" ...updated 7 targets...

Daniel James

11:05 a.m.

On 13 August 2010 11:01, OvermindDL1 wrote:

...

<rewriteURI uriStartString="http://docbook.sourceforge.net/release/xsl/current/" rewritePrefix="file:///usr/local/share/boost-trunk/tools/boostbook/docbook-xsl-1.75.2/"/>

Can you post the contents of /usr/local/share/boost-trunk/tools/boostbook/docbook-xsl-1.75.2/ Daniel

OvermindDL1

8:58 p.m.

On Fri, Aug 13, 2010 at 5:05 AM, Daniel James wrote:

...

On 13 August 2010 11:01, OvermindDL1 wrote:

...
<rewriteURI uriStartString="http://docbook.sourceforge.net/release/xsl/current/" rewritePrefix="file:///usr/local/share/boost-trunk/tools/boostbook/docbook-xsl-1.75.2/"/>

Can you post the contents of /usr/local/share/boost-trunk/tools/boostbook/docbook-xsl-1.75.2/

Hmm, might be the reason why, did not get a chance to look last night, but let me show something, here is the $BOOST_ROOT/tools/boostbook directory: """ doc download fop-1.0 setup_boostbook_new.sh test docbook-dtd-4.2 dtd fop-1.0-bin.tar.gz setup_boostbook.py user-config-backup.jam docbook-xml-4.2.zip fop-0.94-bin-jdk1.4.tar.gz index.html setup_boostbook.sh xsl """ When I initially ran setup_boostbook.sh it would not install because it failed installing fop, which was because it was downloading an old version (0.94) that did not exist on the mirror it was downloading from, so it was downloading the 404 page as the gz file. I made a copy of setup_boostbook.sh as setup_boostbook_new.sh and edited it to use fop-1.0 instead, unsure why it needed to anyway considering that fop 1.0 was pre-installed using aptitude anyway. But yes, as you can see it did not download a docbook-xsl-1.75.2, or any xsl actually. When I run the setup_boostbook_new.sh, it does this: """ /usr/local/share/boost-trunk/tools/boostbook# ./setup_boostbook_new.sh Downloading DocBook XSLT Stylesheets version 1.75.2... % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 2357k 100 2357k 0 0 383k 0 0:00:06 0:00:06 --:--:-- 792k Expanding DocBook XSLT Stylesheets into /usr/local/share/boost-trunk/tools/boostbook/docbook-xsl-1.75.2...gzip: docbook-xsl-1.75.2.tar.gz: No such file or directory tar: This does not look like a tar archive tar: Exiting with failure status due to previous errors done. Using existing DocBook XML DTD (version 4.2). Searching for xsltproc... /usr/bin/xsltproc. Searching for Doxygen... /usr/bin/doxygen. Searching for Java... /usr/bin/java. Using existing FOP distribution (version 0.94). Expanding FOP distribution into /usr/local/share/boost-trunk/tools/boostbook/fop-0.94... done. Updating Boost.Jam configuration in /root/user-config.jam... done. Done! Execute "bjam --v2" in a documentation directory to generate documentation with BoostBook. If you have not already, you will need to compile Boost.Jam. """ As you can see, it 'says' it downloaded the XSLT stylesheet, but when it tries to extract it, it fails saying that it does not exist. It looks like it should download it fine. So instead, I downloaded it manually into the boostbook directory and ran it again, it said it was using the existing one and no errors this time. I then ran bjam in my test directory and it made html's just fine. Now to figure out why it is putting: """ [id test] [id test] ] """ On the main index.html page... onehtml seems to work well. man fails: """ ~/projects/qb_test$ bjam man ...patience... ...found 1312 targets... ...updating 2 targets... common.mkdir man xslt-xsltproc-dir man/test_man.manifest No refentry elements! ...updated 2 targets... """ pdf also fails, but it failed because it was looking for a 0.94 directory of fop, not 1.0. When I fix that, then I get a java exception: """ SEVERE: Exception java.lang.IllegalArgumentException: factor < 0; was: -1 at org.apache.fop.cli.InputHandler.transformTo(InputHandler.java:302) at org.apache.fop.cli.InputHandler.renderTo(InputHandler.java:130) at org.apache.fop.cli.Main.startFOP(Main.java:174) at org.apache.fop.cli.Main.main(Main.java:205) Caused by: java.lang.IllegalArgumentException: factor < 0; was: -1 at org.apache.fop.traits.MinOptMax.mult(MinOptMax.java:251) at org.apache.fop.layoutmgr.inline.TextLayoutManager.processWord(TextLayoutManager.java:825) at org.apache.fop.layoutmgr.inline.TextLayoutManager.getNextKnuthElements(TextLayoutManager.java:710) at org.apache.fop.layoutmgr.inline.LineLayoutManager.collectInlineKnuthElements(LineLayoutManager.java:639) at org.apache.fop.layoutmgr.inline.LineLayoutManager.getNextKnuthElements(LineLayoutManager.java:579) at org.apache.fop.layoutmgr.BlockStackingLayoutManager.getNextChildElements(BlockStackingLayoutManager.java:571) at org.apache.fop.layoutmgr.BlockStackingLayoutManager.getNextChildElements(BlockStackingLayoutManager.java:552) at org.apache.fop.layoutmgr.BlockStackingLayoutManager.getNextKnuthElements(BlockStackingLayoutManager.java:280) at org.apache.fop.layoutmgr.BlockLayoutManager.getNextKnuthElements(BlockLayoutManager.java:123) at org.apache.fop.layoutmgr.BlockLayoutManager.getNextKnuthElements(BlockLayoutManager.java:115) at org.apache.fop.layoutmgr.FlowLayoutManager.getNextChildElements(FlowLayoutManager.java:199) at org.apache.fop.layoutmgr.FlowLayoutManager.addChildElements(FlowLayoutManager.java:140) at org.apache.fop.layoutmgr.FlowLayoutManager.addChildElements(FlowLayoutManager.java:129) at org.apache.fop.layoutmgr.FlowLayoutManager.getNextKnuthElements(FlowLayoutManager.java:70) at org.apache.fop.layoutmgr.PageBreaker.getNextKnuthElements(PageBreaker.java:216) at org.apache.fop.layoutmgr.AbstractBreaker.getNextBlockList(AbstractBreaker.java:692) at org.apache.fop.layoutmgr.PageBreaker.getNextBlockList(PageBreaker.java:149) at org.apache.fop.layoutmgr.PageBreaker.getNextBlockList(PageBreaker.java:132) at org.apache.fop.layoutmgr.AbstractBreaker.doLayout(AbstractBreaker.java:337) at org.apache.fop.layoutmgr.PageBreaker.doLayout(PageBreaker.java:85) at org.apache.fop.layoutmgr.PageSequenceLayoutManager.activateLayout(PageSequenceLayoutManager.java:107) at org.apache.fop.area.AreaTreeHandler.endPageSequence(AreaTreeHandler.java:238) at org.apache.fop.fo.pagination.PageSequence.endOfNode(PageSequence.java:120) at org.apache.fop.fo.FOTreeBuilder$MainFOHandler.endElement(FOTreeBuilder.java:349) at org.apache.fop.fo.FOTreeBuilder.endElement(FOTreeBuilder.java:177) at org.apache.xalan.transformer.TransformerIdentityImpl.endElement(TransformerIdentityImpl.java:1101) at org.apache.xerces.parsers.AbstractSAXParser.endElement(Unknown Source) at org.apache.xerces.xinclude.XIncludeHandler.endElement(Unknown Source) at org.apache.xerces.impl.XMLNSDocumentScannerImpl.scanEndElement(Unknown Source) at org.apache.xerces.impl.XMLDocumentFragmentScannerImpl$FragmentContentDispatcher.dispatch(Unknown Source) at org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanDocument(Unknown Source) at org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source) at org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source) at org.apache.xerces.parsers.XMLParser.parse(Unknown Source) at org.apache.xerces.parsers.AbstractSAXParser.parse(Unknown Source) at org.apache.xerces.jaxp.SAXParserImpl$JAXPSAXParser.parse(Unknown Source) at org.apache.xalan.transformer.TransformerIdentityImpl.transform(TransformerIdentityImpl.java:484) at org.apache.fop.cli.InputHandler.transformTo(InputHandler.java:299) ... 3 more --------- java.lang.IllegalArgumentException: factor < 0; was: -1 at org.apache.fop.traits.MinOptMax.mult(MinOptMax.java:251) at org.apache.fop.layoutmgr.inline.TextLayoutManager.processWord(TextLayoutManager.java:825) at org.apache.fop.layoutmgr.inline.TextLayoutManager.getNextKnuthElements(TextLayoutManager.java:710) at org.apache.fop.layoutmgr.inline.LineLayoutManager.collectInlineKnuthElements(LineLayoutManager.java:639) at org.apache.fop.layoutmgr.inline.LineLayoutManager.getNextKnuthElements(LineLayoutManager.java:579) at org.apache.fop.layoutmgr.BlockStackingLayoutManager.getNextChildElements(BlockStackingLayoutManager.java:571) at org.apache.fop.layoutmgr.BlockStackingLayoutManager.getNextChildElements(BlockStackingLayoutManager.java:552) at org.apache.fop.layoutmgr.BlockStackingLayoutManager.getNextKnuthElements(BlockStackingLayoutManager.java:280) at org.apache.fop.layoutmgr.BlockLayoutManager.getNextKnuthElements(BlockLayoutManager.java:123) at org.apache.fop.layoutmgr.BlockLayoutManager.getNextKnuthElements(BlockLayoutManager.java:115) at org.apache.fop.layoutmgr.FlowLayoutManager.getNextChildElements(FlowLayoutManager.java:199) at org.apache.fop.layoutmgr.FlowLayoutManager.addChildElements(FlowLayoutManager.java:140) at org.apache.fop.layoutmgr.FlowLayoutManager.addChildElements(FlowLayoutManager.java:129) at org.apache.fop.layoutmgr.FlowLayoutManager.getNextKnuthElements(FlowLayoutManager.java:70) at org.apache.fop.layoutmgr.PageBreaker.getNextKnuthElements(PageBreaker.java:216) at org.apache.fop.layoutmgr.AbstractBreaker.getNextBlockList(AbstractBreaker.java:692) at org.apache.fop.layoutmgr.PageBreaker.getNextBlockList(PageBreaker.java:149) at org.apache.fop.layoutmgr.PageBreaker.getNextBlockList(PageBreaker.java:132) at org.apache.fop.layoutmgr.AbstractBreaker.doLayout(AbstractBreaker.java:337) at org.apache.fop.layoutmgr.PageBreaker.doLayout(PageBreaker.java:85) at org.apache.fop.layoutmgr.PageSequenceLayoutManager.activateLayout(PageSequenceLayoutManager.java:107) at org.apache.fop.area.AreaTreeHandler.endPageSequence(AreaTreeHandler.java:238) at org.apache.fop.fo.pagination.PageSequence.endOfNode(PageSequence.java:120) at org.apache.fop.fo.FOTreeBuilder$MainFOHandler.endElement(FOTreeBuilder.java:349) at org.apache.fop.fo.FOTreeBuilder.endElement(FOTreeBuilder.java:177) at org.apache.xalan.transformer.TransformerIdentityImpl.endElement(TransformerIdentityImpl.java:1101) at org.apache.xerces.parsers.AbstractSAXParser.endElement(Unknown Source) at org.apache.xerces.xinclude.XIncludeHandler.endElement(Unknown Source) at org.apache.xerces.impl.XMLNSDocumentScannerImpl.scanEndElement(Unknown Source) at org.apache.xerces.impl.XMLDocumentFragmentScannerImpl$FragmentContentDispatcher.dispatch(Unknown Source) at org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanDocument(Unknown Source) at org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source) at org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source) at org.apache.xerces.parsers.XMLParser.parse(Unknown Source) at org.apache.xerces.parsers.AbstractSAXParser.parse(Unknown Source) at org.apache.xerces.jaxp.SAXParserImpl$JAXPSAXParser.parse(Unknown Source) at org.apache.xalan.transformer.TransformerIdentityImpl.transform(TransformerIdentityImpl.java:484) at org.apache.fop.cli.InputHandler.transformTo(InputHandler.java:299) at org.apache.fop.cli.InputHandler.renderTo(InputHandler.java:130) at org.apache.fop.cli.Main.startFOP(Main.java:174) at org.apache.fop.cli.Main.main(Main.java:205) """ So, much further then I was for getting quickbook working in linux, but still not as far as I was in Windows, any further help?

OvermindDL1

9:07 p.m.

On Fri, Aug 13, 2010 at 2:58 PM, OvermindDL1 wrote:

...

When I initially ran setup_boostbook.sh it would not install because it failed installing fop, which was because it was downloading an old version (0.94) that did not exist on the mirror it was downloading from, so it was downloading the 404 page as the gz file. I made a copy of setup_boostbook.sh as setup_boostbook_new.sh and edited it to use fop-1.0 instead, unsure why it needed to anyway considering that fop 1.0 was pre-installed using aptitude anyway.

Correction, what Aptitude installed was fop 0.95, when I run that manually instead of letting bjam try it (again, thanks for the -n command for bjam), it worked, it created the pdf. So it seems boostbook needs some updating, or at the very least, the setup script needs updating. 'man' is still failing however, and for the project I intend to use this for, having it generate man pages would be useful. And in the generated PDF it put: """ [id test] [id test] ] """ too, like it did in the html, see attached... Is my qbk wrong? Also, I could not get the qbk to 'compile' with the purpose declarative inside article. Also, what is the difference between article and the other possible types, the documentation did not elaborate at all, just listed them...

Steven Watanabe

10:46 p.m.

AMDG OvermindDL1 wrote:

...

And in the generated PDF it put: """ [id test] [id test] ] """ too, like it did in the html, see attached...

I'd guess that the comment is prematurely terminated.

...

Is my qbk wrong? Also, I could not get the qbk to 'compile' with the purpose declarative inside article.

It compiles fine for me with the trunk.

...

Also, what is the difference between article and the other possible types, the documentation did not elaborate at all, just listed them...

In Christ, Steven Watanabe

OvermindDL1

11:07 p.m.

On Fri, Aug 13, 2010 at 4:46 PM, Steven Watanabe wrote:

...

AMDG

OvermindDL1 wrote:

...
And in the generated PDF it put: """ [id test] [id test] ] """ too, like it did in the html, see attached...

I'd guess that the comment is prematurely terminated.

It was not prematurely terminated, I had to comment out that one line or quickbooks would not compile, which is odd because the documentation says that line should be allowed. The id line is also in the documentation, but it is seeming like it is not supported either, but it still lets it compile... On Fri, Aug 13, 2010 at 4:46 PM, Steven Watanabe wrote:

...

...
Is my qbk wrong? Also, I could not get the qbk to 'compile' with the purpose declarative inside article.

It compiles fine for me with the trunk.

It compiles fine for me on trunk as well, sans the id issue, but if you uncomment the line above, it fails to compile, although the documentation says that is a supported line. On Fri, Aug 13, 2010 at 4:46 PM, Steven Watanabe wrote:

...

...
Also, what is the difference between article and the other possible types, the documentation did not elaborate at all, just listed them...

Still curious. Also, what about the man not building issue, and the fop issue? Why does the setup sh script try to download a non-existing fop version, and why does fop1.0 fail with what boostbook generates for it, although fop0.95 works?

Steven Watanabe

14 Aug 14 Aug

12:46 a.m.

AMDG OvermindDL1 wrote:

...

On Fri, Aug 13, 2010 at 4:46 PM, Steven Watanabe wrote:

...
...
Is my qbk wrong? Also, I could not get the qbk to 'compile' with the purpose declarative inside article.

It compiles fine for me with the trunk.

It compiles fine for me on trunk as well, sans the id issue, but if you uncomment the line above, it fails to compile, although the documentation says that is a supported line.

I did uncomment the purpose and it works okay as of trunk revision 64649.

...

On Fri, Aug 13, 2010 at 4:46 PM, Steven Watanabe wrote:

...
...
Also, what is the difference between article and the other possible types, the documentation did not elaborate at all, just listed them...

Still curious.

The document types are just propagated to docbook, except that library is handled by BoostBook, I think.

...

Also, what about the man not building issue,

I've never tried building man pages. It's quite possible that it's been broken at some point. I'll look into it if I find time.

...

and the fop issue? Why does the setup sh script try to download a non-existing fop version, and why does fop1.0 fail with what boostbook generates for it, although fop0.95 works?

In Christ, Steven Watanabe

Daniel James

9:27 a.m.

On 14 August 2010 00:07, OvermindDL1 wrote:

...

It was not prematurely terminated, I had to comment out that one line or quickbooks would not compile, which is odd because the documentation says that line should be allowed. The id line is also in the documentation, but it is seeming like it is not supported either, but it still lets it compile...

I found out recently that some of the document info attributes are only valid for the 'library' documentation type. So I put in an error if they were used, but then I realised that it broke some of the documentation, so I changed it to a warning (this was about a month ago). I suspect that you built quickbook between those changes. If you're using a prebuilt quickbook, you should build it from a released version, since that will be better tested.

...

On Fri, Aug 13, 2010 at 4:46 PM, Steven Watanabe wrote:

...
...
Also, what is the difference between article and the other possible types, the documentation did not elaborate at all, just listed them...

Still curious.

Types other than library are docbook document types. You can read about them in the docbook documentation.

...

Also, what about the man not building issue, and the fop issue? Why does the setup sh script try to download a non-existing fop version, and why does fop1.0 fail with what boostbook generates for it, although fop0.95 works?

I wouldn't bother with fop, it doesn't produce very good results. We've have better luck with xep, The setup script is problematic, it breaks quite frequently. I've been thinking about deleting it or cutting it down to something simpler. The instructions I linked to earlier would setup quickbook without using that script. Daniel

OvermindDL1

3:20 p.m.

On Sat, Aug 14, 2010 at 3:26 AM, Daniel James wrote:

...

On 13 August 2010 23:46, Steven Watanabe wrote:

...
AMDG

OvermindDL1 wrote:

...
And in the generated PDF it put: """ [id test] [id test] ] """ too, like it did in the html, see attached...

I'd guess that the comment is prematurely terminated.

For some reason, the comment parser for document info is defined differently to the other parts of quickbook and doesn't deal with nested brackets. I'll fix that in the 1.45.

Ah, thanks, was wondering what was going on. On Sat, Aug 14, 2010 at 3:27 AM, Daniel James wrote:

...

On 14 August 2010 00:07, OvermindDL1 wrote:

...
It was not prematurely terminated, I had to comment out that one line or quickbooks would not compile, which is odd because the documentation says that line should be allowed. The id line is also in the documentation, but it is seeming like it is not supported either, but it still lets it compile...

I found out recently that some of the document info attributes are only valid for the 'library' documentation type. So I put in an error if they were used, but then I realised that it broke some of the documentation, so I changed it to a warning (this was about a month ago). I suspect that you built quickbook between those changes. If you're using a prebuilt quickbook, you should build it from a released version, since that will be better tested.

I built quickbook less then a week ago from trunk since that is what I have available, could download a release version if necessary. On Sat, Aug 14, 2010 at 3:27 AM, Daniel James wrote:

...

...
On Fri, Aug 13, 2010 at 4:46 PM, Steven Watanabe wrote:

...
...
Also, what is the difference between article and the other possible types, the documentation did not elaborate at all, just listed them...

Still curious.

Types other than library are docbook document types. You can read about them in the docbook documentation.

What about the 'library' type? This should all be explained in the quickbook documentation, along with a look to the proper docbook page for the other types perhaps? On Sat, Aug 14, 2010 at 3:27 AM, Daniel James wrote:

...

...
Also, what about the man not building issue, and the fop issue? Why does the setup sh script try to download a non-existing fop version, and why does fop1.0 fail with what boostbook generates for it, although fop0.95 works?

I wouldn't bother with fop, it doesn't produce very good results. We've have better luck with xep, The setup script is problematic, it breaks quite frequently. I've been thinking about deleting it or cutting it down to something simpler. The instructions I linked to earlier would setup quickbook without using that script.

Heh, well fop is what quickbook recommends and uses, never heard of xep, will it pick it up if I aptitude install it?

OvermindDL1

4:29 p.m.

On Sat, Aug 14, 2010 at 9:20 AM, OvermindDL1 wrote:

...

/* snip */

I am not sure if this is a quickbook bug, or a bug in how I have designed this. I have a cpp file with a setup like this: """ // some code //[ SomeFunc_1_2 //[ SomeFunc_1 void aFunction(void) { if(something) { //] doThing(); doSomethingElse() //[ SomeFunc_2 } return calcIt(); } //] //] // more code """ And in the documentation, I import the cpp file with pseudo-text like this: """ [/ some text ] And we setup the function like this: [SomeFunc_1] And we finish it up like this [SomeFunc_2] And later on we fill in the if body to do its thing so the whole function becomes this: [SomeFunc_1_2] """ However, it ends up creating this: """ And we setup the function like this: [SomeFunc_1] And we finish it up like this } return calcIt(); } And later on we fill in the if body to do its thing so the whole function becomes this: //[ SomeFunc_1 void aFunction(void) { if(something) { """ Which is not what I am wanting, I want this: """ However, it ends up creating this: """ And we setup the function like this: void aFunction(void) { if(something) { And we finish it up like this } return calcIt(); } And later on we fill in the if body to do its thing so the whole function becomes this: void aFunction(void) { if(something) { doThing(); doSomethingElse() } return calcIt(); } """ How can I pull this off?

OvermindDL1

4:38 p.m.

On Sat, Aug 14, 2010 at 10:29 AM, OvermindDL1 wrote:

...

On Sat, Aug 14, 2010 at 9:20 AM, OvermindDL1 wrote:

...
/* snip */

I am not sure if this is a quickbook bug, or a bug in how I have designed this. I have a cpp file with a setup like this: """ // some code

//[ SomeFunc_1_2 //[ SomeFunc_1 void aFunction(void) { if(something) { //] doThing(); doSomethingElse() //[ SomeFunc_2 } return calcIt(); } //] //]

// more code """

And in the documentation, I import the cpp file with pseudo-text like this: """ [/ some text ]

And we setup the function like this:

[SomeFunc_1]

And we finish it up like this

[SomeFunc_2]

And later on we fill in the if body to do its thing so the whole function becomes this:

[SomeFunc_1_2] """

However, it ends up creating this: """ And we setup the function like this:

[SomeFunc_1]

And we finish it up like this

} return calcIt(); }

And later on we fill in the if body to do its thing so the whole function becomes this:

//[ SomeFunc_1 void aFunction(void) { if(something) { """

Which is not what I am wanting, I want this: """ However, it ends up creating this: """ And we setup the function like this:

void aFunction(void) { if(something) {

And we finish it up like this

} return calcIt(); }

And later on we fill in the if body to do its thing so the whole function becomes this:

void aFunction(void) { if(something) { doThing(); doSomethingElse() } return calcIt(); } """

How can I pull this off?

Also, how can I pull in an entire cpp file into a code block?

OvermindDL1

11:24 p.m.

On Sat, Aug 14, 2010 at 10:38 AM, OvermindDL1 wrote:

...

/* snip */

Also, the onehtml does not want to use the boostbook.css where the html one uses it fine. Is it trying to include it manually into the file somehow, and if so, it seems like it is not finding the file (same directory as the root qbk file, the specified root directory), where does it need to be or how do I tell it where the file is located?

Steven Watanabe

15 Aug 15 Aug

4:52 a.m.

AMDG OvermindDL1 wrote:

...

Also, the onehtml does not want to use the boostbook.css where the html one uses it fine. Is it trying to include it manually into the file somehow, and if so, it seems like it is not finding the file (same directory as the root qbk file, the specified root directory), where does it need to be or how do I tell it where the file is located?

Look at the html source to see what stylesheet it uses. In Christ, Steven Watanabe

OvermindDL1

5:32 a.m.

On Sat, Aug 14, 2010 at 10:52 PM, Steven Watanabe wrote:

...

AMDG

OvermindDL1 wrote:

...
Also, the onehtml does not want to use the boostbook.css where the html one uses it fine. Is it trying to include it manually into the file somehow, and if so, it seems like it is not finding the file (same directory as the root qbk file, the specified root directory), where does it need to be or how do I tell it where the file is located?

Look at the html source to see what stylesheet it uses.

It does not, that is the problem, it has no stylesheet import or anything, else I would have done so, but onehtml does not use a stylesheet at all in the generated html.

John Maddock

8:43 a.m.

...

...
...
Also, the onehtml does not want to use the boostbook.css where the html one uses it fine. Is it trying to include it manually into the file somehow, and if so, it seems like it is not finding the file (same directory as the root qbk file, the specified root directory), where does it need to be or how do I tell it where the file is located?

Look at the html source to see what stylesheet it uses.

It does not, that is the problem, it has no stylesheet import or anything, else I would have done so, but onehtml does not use a stylesheet at all in the generated html.

I think what happens here is that our XSL stylesheets for html generation set a default value for the css stylesheet to use, but the XSL wrapper used for the "onehtml" target doesn't. You can always set your own stylesheet for the html to use using an xsl:param of course, but maybe we should fix the onehtml target to be as similar as possible to the html one - just with chunking turned off? John.

Daniel James

7:54 a.m.

On 14 August 2010 17:29, OvermindDL1 wrote:

...

How can I pull this off?

It's not supported. You'll have to write your code out twice for now. You could implement it yourself if it's really a problem. Daniel

Daniel James

7:51 a.m.

On 14 August 2010 16:20, OvermindDL1 wrote:

...

On Sat, Aug 14, 2010 at 3:27 AM, Daniel James wrote:

...
Types other than library are docbook document types. You can read about them in the docbook documentation.

What about the 'library' type? This should all be explained in the quickbook documentation, along with a look to the proper docbook page for the other types perhaps?

That's an old bug report: https://svn.boost.org/trac/boost/ticket/1483 As I implied in a previous mail, I'm only getting to grips with that part of boostbook at the moment.

...

Heh, well fop is what quickbook recommends and uses

No it isn't.

...

never heard of xep, will it pick it up if I aptitude install it?

No, it's not open source. https://svn.boost.org/trac/boost/wiki/BoostDocs/GettingStarted#Howtobuildpdf... Daniel

Paul A. Bristow

11:45 a.m.

--- Paul A. Bristow Prizet Farmhouse Kendal, UK LA8 8AB +44 1539 561830, mobile +44 7714330204 pbristow@hetp.u-net.com

...

-----Original Message----- From: boost-users-bounces@lists.boost.org [mailto:boost-users-bounces@lists.boost.org] On Behalf Of Daniel James Sent: Sunday, August 15, 2010 8:51 AM To: boost-users@lists.boost.org Subject: Re: [Boost-users] QuickBook

On 14 August 2010 16:20, OvermindDL1 wrote:

...
On Sat, Aug 14, 2010 at 3:27 AM, Daniel James wrote:

...
Types other than library are docbook document types. You can read about them in the docbook documentation.

What about the 'library' type? This should all be explained in the quickbook documentation, along with a look to the proper docbook page for the other types perhaps?

That's an old bug report:

https://svn.boost.org/trac/boost/ticket/1483

As I implied in a previous mail, I'm only getting to grips with that part of boostbook at the moment.

...
Heh, well fop is what quickbook recommends and uses

No it isn't.

...
never heard of xep, will it pick it up if I aptitude install it?

No, it's not open source.

https://svn.boost.org/trac/boost/wiki/BoostDocs/GettingStarted#Howtobuildpdf...

But RendeX helpfully gave permission for it to be used free to generate Boost docs. Otherwise you probably should buy it :-( (Unlike fop, it actually works ;-) (I found specifying the line in my user-config was picky # XSLT-FO processor from RenderX.com using fop : # XEP batch filename # Note you may need to increase the Java heap size. "C:/Progra~1/renderx/xep/xep.bat" # OK # "C:/Program Files/renderx/xep/xep.bat" # Definitely does NOT seem to work. # "C:\\Program Files\\renderx\\xep\\xep.bat" # NOT OK #'C:\Program' is not recognized as an internal or external command, operable program or batch file. # Java executable called by xep.bat. # C:/PROGRA~1/Java/jre6 #OK # "C:/PROGRA~1/Java/jre6" # OK #"C:/Program files/Java/jre6" # OK "C:\\Program files\\Java\\jre6" # OK #"C:\Program files\Java\jre6" # NOT OK ; # actually C:\Program Files\RenderX\XEP\xep.bat # actually C:\Program Files\Java\jre6 Good luck! Paul

OvermindDL1

10:45 p.m.

On Sun, Aug 15, 2010 at 1:51 AM, Daniel James wrote:

...

...
Heh, well fop is what quickbook recommends and uses

No it isn't.

Well on: http://boost.org/doc/libs/1_43_0/doc/html/boostbook/getting/started.html and: http://beta.boost.org/doc/libs/1_44_0/doc/html/boostbook/getting/started.htm... and the auto setup script those pages mention, they all only talk about fop On Sun, Aug 15, 2010 at 1:51 AM, Daniel James wrote:

...

...
never heard of xep, will it pick it up if I aptitude install it?

No, it's not open source.

https://svn.boost.org/trac/boost/wiki/BoostDocs/GettingStarted#Howtobuildpdf...

If that is the current documentation, then the official docs need to be updated, pretty badly, as linked to above... On Sun, Aug 15, 2010 at 1:54 AM, Daniel James wrote:

...

On 14 August 2010 17:29, OvermindDL1 wrote:

...
How can I pull this off?

It's not supported. You'll have to write your code out twice for now. You could implement it yourself if it's really a problem.

Hmm, maybe later, I am not doing this for myself, but a different open-source project. On Sun, Aug 15, 2010 at 2:43 AM, John Maddock wrote:

...

...
...
...
Also, the onehtml does not want to use the boostbook.css where the html one uses it fine. Is it trying to include it manually into the file somehow, and if so, it seems like it is not finding the file (same directory as the root qbk file, the specified root directory), where does it need to be or how do I tell it where the file is located?

Look at the html source to see what stylesheet it uses.

It does not, that is the problem, it has no stylesheet import or anything, else I would have done so, but onehtml does not use a stylesheet at all in the generated html.

I think what happens here is that our XSL stylesheets for html generation set a default value for the css stylesheet to use, but the XSL wrapper used for the "onehtml" target doesn't. You can always set your own stylesheet for the html to use using an xsl:param of course, but maybe we should fix the onehtml target to be as similar as possible to the html one - just with chunking turned off?

What xsl:param do I use? I did not see this in quickboook or boostbook's docs. On Sun, Aug 15, 2010 at 5:45 AM, Paul A. Bristow wrote:

...

...
From: boost-users-bounces@lists.boost.org [mailto:boost-users-bounces@lists.boost.org] On Behalf Of Daniel James But RendeX helpfully gave permission for it to be used free to generate Boost docs.

Otherwise you probably should buy it :-(

(Unlike fop, it actually works ;-)

(I found specifying the line in my user-config was picky

# XSLT-FO processor from RenderX.com using fop : # XEP batch filename # Note you may need to increase the Java heap size. "C:/Progra~1/renderx/xep/xep.bat" # OK # "C:/Program Files/renderx/xep/xep.bat" # Definitely does NOT seem to work. # "C:\\Program Files\\renderx\\xep\\xep.bat" # NOT OK #'C:\Program' is not recognized as an internal or external command, operable program or batch file.

# Java executable called by xep.bat. # C:/PROGRA~1/Java/jre6 #OK # "C:/PROGRA~1/Java/jre6" # OK #"C:/Program files/Java/jre6" # OK "C:\\Program files\\Java\\jre6" # OK #"C:\Program files\Java\jre6" # NOT OK ;

# actually C:\Program Files\RenderX\XEP\xep.bat # actually C:\Program Files\Java\jre6

I am doing this on linux currently, but easy enough to figure out paths, however I need something that will not cost money as if this is used, it will be used for a major and rather large open-source project.

Paul A. Bristow

16 Aug 16 Aug

8:24 a.m.

...

-----Original Message----- From: boost-users-bounces@lists.boost.org [mailto:boost-users-bounces@lists.boost.org] On Behalf Of OvermindDL1 Sent: Sunday, August 15, 2010 11:45 PM To: boost-users@lists.boost.org Subject: Re: [Boost-users] QuickBook

<snip>

...

I am doing this on linux currently, but easy enough to figure out paths, however I need something that will not cost money as if this is used, it will be used for a major and rather large open-source project.

I'd write to RenderX and ask nicely - I think you'll get a free licence for an open-source project. Paul PS The 'price' is that they get a discreet one line free ad at the bottom of each page (so discreet that you may not have noticed it on all the Boost Quickbook docs ;-) --- Paul A. Bristow Prizet Farmhouse Kendal, UK LA8 8AB +44 1539 561830, mobile +44 7714330204 pbristow@hetp.u-net.com

Daniel James

9:37 a.m.

On 16 August 2010 09:24, Paul A. Bristow wrote:

...

I'd write to RenderX and ask nicely - I think you'll get a free licence for an open-source project.

You can get it from their site. http://www.renderx.com/download/personal.html Daniel

Daniel James

14 Aug 14 Aug

9:26 a.m.

On 13 August 2010 23:46, Steven Watanabe wrote:

...

AMDG

OvermindDL1 wrote:

...
And in the generated PDF it put: """ [id test] [id test] ] """ too, like it did in the html, see attached...

I'd guess that the comment is prematurely terminated.

For some reason, the comment parser for document info is defined differently to the other parts of quickbook and doesn't deal with nested brackets. I'll fix that in the 1.45. Daniel

5204

Age (days ago)

5207

Last active (days ago)

List overview

Download

27 comments

5 participants

participants (5)

Daniel James
John Maddock
OvermindDL1
Paul A. Bristow
Steven Watanabe

QuickBook

OvermindDL1

Daniel James

OvermindDL1

Daniel James

John Maddock

OvermindDL1

OvermindDL1

Daniel James

OvermindDL1

OvermindDL1

Steven Watanabe

OvermindDL1

Steven Watanabe

Daniel James

OvermindDL1

OvermindDL1

OvermindDL1

OvermindDL1

Steven Watanabe

OvermindDL1

John Maddock

Daniel James

Daniel James

Paul A. Bristow

OvermindDL1

Paul A. Bristow

Daniel James

Daniel James

tags

participants (5)