I'm just reading [1] and according to that documentation, all
information about the components goes into the file
docs/src/build/reference/compref.dbk. But that file is almost empty for me:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd";>
<part id="Components.ref">
<title>Components Reference</title>
</part>
So I guess I need to figure out why no components are picked up, that's
why I requested for the components.xml and
doctestLaszloLibrary[..].js2doc files.
-DQUICK=true works for me when building the reference (for sure apart
from the components problem), it just returns "build failed" because the
toccheck.rb fails [2]. I've made the following change to
docs/src/build.xml to handle that false error:
<exec executable="ruby" failonerror="false"
resultproperty="toccheck.result">
<arg value="${reference.src.dir}/navbuilder/toccheck.rb" />
<arg value="--inputdir" />
<arg value="${reference.output.dir}" />
</exec>
<!-- only fail if not building test version -->
<if>
<and>
<isfalse value="${QUICK}" />
<isfailure code="${toccheck.result}" />
</and>
<then><fail message="toccheck failed"/></then>
</if>
Thanks,
André
[1]
http://labs.openlaszlo.org/trunk-nightly/docs/developers/developers.doctools.html
[2] http://www.openlaszlo.org/pipermail/laszlo-dev/2009-February/019602.html
On 3/28/2010 7:40 PM, P T Withington wrote:
I know we've always had trouble building the docs on Windows. I don't know why.
One thing I discovered recently is that for machines that have limit RAM (and
Windows, which seems to artificially limit the RAM available to Java),
combining multiple ant commands can lead to a failure (although not usually a
silent one). Lou was trying:
% ant clean build doc
and always failing. Whereas I would say:
% ant clean; ant build; ant doc
and succeed.
I also recently fixed it so that the dependencies for
*library-{1,2,3,4,5,verbose}* should be correct and those files should be
rebuilt when needed, which should make it so you no longer have to do an `ant
clean` before each doc build. I won't swear that works, but I tried to make it
so.
I wasn't having any luck with -DQUICK=true the last time I fiddled with the
docs. Perhaps that has rotted?
On 2010-03-28, at 12:50, André Bargull wrote:
I'm trying to build the reference guide on my Windows machine, but somehow the reference pages for
the components aren't generated. The reference pages for the LFC are generated, though. I've tried
both "ant clean reference" and "ant clean reference -DQUICK=true", no
difference here. At some point last year it was possible for me to generate the reference pages for
the components, because back then I worked on the drawview pages.
I've made so far the following changes:
- commented out the "skip.doc.reference" entry in build-tools/build-opt.xml
- commented out the "reference.skip" condition in docs/src/build.xml
- changed the xsl:variable "programsource" to use a file:/// url in
docs/scr/xsl/dbkpreprocessexamples.xsl
- added xmlns:redirect="http://xml.apache.org/xalan/redirect"; because
xmlns:xalanredirect="org.apache.xalan.xslt.extensions.Redirect" doesn't work for me in
docs/scr/xsl/js2doc-comment2dbk.xsl
- converted \ in paths to / in toccheck.rb, navxmlbuilder.rb, postprocess.rb
(mixed paths don't work in ruby?)
There are entries for the components in
docs/src/build/reference/components{-raw}.xml and
doctestLaszloLibrary-{2,3,4,5,verbose}.js2doc. But I'm not sure whether these
entries are valid, so maybe someone can send these files, so I can check them.
- André
