[BoostDocs] Need help with getting started with BoostDocs
Hi Everyone, Perhaps someone in this list can help me generate html documentation from qbk sources. I am using MinGW on Windows and try to build the docs. I use the instructions form the following links. https://svn.boost.org/trac/boost/wiki/BoostDocs/GettingStarted http://www.boost.org/doc/libs/1_55_0/doc/html/quickbook/install.html#quickbo... I am not sure if they are up to date. I downloaded all the necessary components, and when I try to run b2 on my doc folder, I get the following error messages: runtime error: file
file:///C:/_data/cpp/optional/boptional/quickbook/docbook-xsl/html/chunkfast.xsl line 23 element variable Recursive definition of chunks runtime error: file file:///C:/_data/cpp/optional/boptional/quickbook/docbook-xsl/html/chunkfast.xsl line 32 element variable Variable 'chunks' has not been declared. xmlXPathCompiledEval: evaluation failed runtime error: file file:///C:/_data/cpp/optional/boptional/quickbook/docbook-xsl/html/chunkfast.xsl line 32 element variable Failed to evaluate the expression of variable 'div'.
I am not sure exactly where they are coming from. But they look like an error from the tool, rather than my qbk sources. Perhaps anyone here experienced a similar problem and knows a solution? Or perhaps there is a newer version of the instructions? Regards, &rzej
AMDG On 04/11/2014 07:33 AM, Andrzej Krzemienski wrote:
<snip>
runtime error: file
file:///C:/_data/cpp/optional/boptional/quickbook/docbook-xsl/html/chunkfast.xsl line 23 element variable Recursive definition of chunks <snip>
I am not sure exactly where they are coming from. But they look like an error from the tool, rather than my qbk sources. Perhaps anyone here experienced a similar problem and knows a solution? Or perhaps there is a newer version of the instructions?
This error is coming from xsltproc while processing the docbook xsl stylesheets. What versions of these do you have installed? In Christ, Steven Watanabe
2014-04-11 16:51 GMT+02:00 Steven Watanabe
AMDG
On 04/11/2014 07:33 AM, Andrzej Krzemienski wrote:
<snip>
runtime error: file
file:///C:/_data/cpp/optional/boptional/quickbook/docbook-xsl/html/chunkfast.xsl
line 23 element variable Recursive definition of chunks <snip>
I am not sure exactly where they are coming from. But they look like an error from the tool, rather than my qbk sources. Perhaps anyone here experienced a similar problem and knows a solution? Or perhaps there is a newer version of the instructions?
This error is coming from xsltproc while processing the docbook xsl stylesheets. What versions of these do you have installed?
In Christ, Steven Watanabe
iconv-1.9.2 libxml2-2.7.8 libxslt-1.1.26 zlib-1.2.5 docbook-xml-4.2 docbook-xsl-ns-1.77.1 docbook-xsl-ns-1.78.0 docbook-xsl-doc-1.78.1 (tried 3 versions) Regards, &rzej
AMDG On 04/11/2014 08:07 AM, Andrzej Krzemienski wrote:
docbook-xml-4.2 docbook-xsl-ns-1.77.1 docbook-xsl-ns-1.78.0 docbook-xsl-doc-1.78.1 (tried 3 versions)
"Be careful that you download the correct file, sometimes the 'looking for the latest version' link often links to another file. The name should be of the form docbook-xsl-1.nn.n.tar.bz2, with no suffix such as -ns.tar.bz2 or -doc.tar.bz2." In Christ, Steven Watanabe
2014-04-11 17:21 GMT+02:00 Steven Watanabe
AMDG
On 04/11/2014 08:07 AM, Andrzej Krzemienski wrote:
docbook-xml-4.2 docbook-xsl-ns-1.77.1 docbook-xsl-ns-1.78.0 docbook-xsl-doc-1.78.1 (tried 3 versions)
"Be careful that you download the correct file, sometimes the 'looking for the latest version' link often links to another file. The name should be of the form docbook-xsl-1.nn.n.tar.bz2, with no suffix such as -ns.tar.bz2 or -doc.tar.bz2."
Indeed. that's what it said. Silly me. Thanks a lot! &rzej
2014-04-11 17:33 GMT+02:00 Andrzej Krzemienski
2014-04-11 17:21 GMT+02:00 Steven Watanabe
: AMDG
On 04/11/2014 08:07 AM, Andrzej Krzemienski wrote:
docbook-xml-4.2 docbook-xsl-ns-1.77.1 docbook-xsl-ns-1.78.0 docbook-xsl-doc-1.78.1 (tried 3 versions)
"Be careful that you download the correct file, sometimes the 'looking for the latest version' link often links to another file. The name should be of the form docbook-xsl-1.nn.n.tar.bz2, with no suffix such as -ns.tar.bz2 or -doc.tar.bz2."
Indeed. that's what it said. Silly me. Thanks a lot! &rzej
Please, bear with me as I am trying to pick up this QuickBook. I downloaded a fairly old docbook-xsl version 1.72 (the only one not having the "ns" infix). The generated documentation is almost fine, except that I do not get the "left", "up", "home", "right" icons that help navigate through documentation. Is there any place to turn them on in my QBK files, or is it entirely up to the program? Regards, &rzej
AMDG On 04/11/2014 09:17 AM, Andrzej Krzemienski wrote:
I downloaded a fairly old docbook-xsl version 1.72 (the only one not having the "ns" infix).
The current release is here: http://sourceforge.net/projects/docbook/files/docbook-xsl/1.78.1/
The generated documentation is almost fine, except that I do not get the "left", "up", "home", "right" icons that help navigate through documentation. Is there any place to turn them on in my QBK files, or is it entirely up to the program?
They should be added by default. Are the links present but missing the images or are they not there at all? In Christ, Steven Watanabe
2014-04-11 18:50 GMT+02:00 Steven Watanabe
AMDG
On 04/11/2014 09:17 AM, Andrzej Krzemienski wrote:
I downloaded a fairly old docbook-xsl version 1.72 (the only one not
having
the "ns" infix).
The current release is here: http://sourceforge.net/projects/docbook/files/docbook-xsl/1.78.1/
The generated documentation is almost fine, except that I do not get the "left", "up", "home", "right" icons that help navigate through documentation. Is there any place to turn them on in my QBK files, or is it entirely up to the program?
They should be added by default. Are the links present but missing the images or are they not there at all?
In Christ, Steven Watanabe
It worked!. Apparently I was using a wrong mirror or something. Your link has the right binaries. I decided to use v 1.77.1. The newer one generate a somewhat wrong table of contents (it is one frame nested in another). Thanks again. &rzej
On 11 April 2014 22:35, Andrzej Krzemienski
It worked!. Apparently I was using a wrong mirror or something. Your link has the right binaries. I decided to use v 1.77.1. The newer one generate a somewhat wrong table of contents (it is one frame nested in another).
What css file are you using? I think there was a change to the generated html that didn't work well with our css, but I fixed that a while ago.
2014-04-12 0:15 GMT+02:00 Daniel James
On 11 April 2014 22:35, Andrzej Krzemienski
wrote: It worked!. Apparently I was using a wrong mirror or something. Your link has the right binaries. I decided to use v 1.77.1. The newer one
generate a
somewhat wrong table of contents (it is one frame nested in another).
What css file are you using? I think there was a change to the generated html that didn't work well with our css, but I fixed that a while ago.
I use the one I found in sub-module Optional (enclosed). Is there a recommended one? If so, am I supposed to copy it to sub-module Optional? Regards, &rzej
On 11 April 2014 23:27, Andrzej Krzemienski
I use the one I found in sub-module Optional (enclosed). Is there a recommended one? If so, am I supposed to copy it to sub-module Optional?
You can use the one from 'doc/src/boostbook.css' in the main repo. I just created a pull request to do that. If you'd rather have your own copy you can add a rule to copy the super-project files into your documentation, something like: install css : [ glob $(BOOST_ROOT)/doc/src/*.css ] : <location>html ;
Thanks Daniel. I applied the change.
I've got one more question. In order for Optional documentation to look as
most of the other libraries' docs, I need this green panel at the top with
the quote "...one of the most highly regarded and expertly designed C++
library projects in the world." Is there an easy way to do that?
Regards,
&rzej
2014-04-12 10:15 GMT+02:00 Daniel James
On 11 April 2014 23:27, Andrzej Krzemienski
wrote: I use the one I found in sub-module Optional (enclosed). Is there a recommended one? If so, am I supposed to copy it to sub-module Optional?
You can use the one from 'doc/src/boostbook.css' in the main repo. I just created a pull request to do that.
If you'd rather have your own copy you can add a rule to copy the super-project files into your documentation, something like:
install css : [ glob $(BOOST_ROOT)/doc/src/*.css ] : <location>html ;
_______________________________________________ Unsubscribe & other changes: http://lists.boost.org/mailman/listinfo.cgi/boost
On Sat, Apr 12, 2014 at 2:16 PM, Andrzej Krzemienski wrote:
Thanks Daniel. I applied the change. I've got one more question. In order for Optional documentation to look as most of the other libraries' docs, I need this green panel at the top with the quote "...one of the most highly regarded and expertly designed C++ library projects in the world." Is there an easy way to do that?
Daniel can correct me if I'm wrong, but isn't that applied automatically? i.e. you do not need to do it yourself. Glen
On 12 April 2014 22:18, Glen Fernandes
On Sat, Apr 12, 2014 at 2:16 PM, Andrzej Krzemienski wrote:
Thanks Daniel. I applied the change. I've got one more question. In order for Optional documentation to look as most of the other libraries' docs, I need this green panel at the top with the quote "...one of the most highly regarded and expertly designed C++ library projects in the world." Is there an easy way to do that?
Daniel can correct me if I'm wrong, but isn't that applied automatically? i.e. you do not need to do it yourself.
It's disabled for some libraries as their markup doesn't work well with the html filter. The old optional documentation was an example of this. I've just activated it.
2014-04-12 23:36 GMT+02:00 Daniel James
On 12 April 2014 22:18, Glen Fernandes
wrote: On Sat, Apr 12, 2014 at 2:16 PM, Andrzej Krzemienski wrote:
Thanks Daniel. I applied the change. I've got one more question. In order for Optional documentation to look as most of the other libraries' docs, I need this green panel at the top with the quote "...one of the most highly regarded and expertly designed C++ library projects in the world." Is there an easy way to do that?
Daniel can correct me if I'm wrong, but isn't that applied automatically? i.e. you do not need to do it yourself.
It's disabled for some libraries as their markup doesn't work well with the html filter. The old optional documentation was an example of this. I've just activated it.
Do I need to do anything to be able to see the difference after you activated it? (When I run bjam in my doc folder I still cannot see this green banner.) Regards, &rzej
On 12 April 2014 23:04, Andrzej Krzemienski
2014-04-12 23:36 GMT+02:00 Daniel James
: It's disabled for some libraries as their markup doesn't work well with the html filter. The old optional documentation was an example of this. I've just activated it.
Do I need to do anything to be able to see the difference after you activated it? (When I run bjam in my doc folder I still cannot see this green banner.)
It's only on the website. You can see it on the existing documentation, although you'll probably need to shift-reload to see it.
participants (4)
-
Andrzej Krzemienski
-
Daniel James
-
Glen Fernandes
-
Steven Watanabe