The reference page for <para> lists <xref> as a valid child element [1].
And after assigning the "LFC-to-js2doc" ID to an element in
doc-backwards-xform.dbk, the validation error is gone, too. Doesn't that
mean the validation error in only caused by the bad ID and thus can be
ignored? I'm a bit confused right now...
[1] http://www.docbook.org/tdg/en/html/para.html
On 5/7/2010 5:28 PM, Lou Iorio wrote:
Yes, the ID errors can be ignored, but this error is not related to that:
Document doc-toolchain.dbk does not validate against
/Users/lou/src/svn/vendor/docbook-xml-4.5/docbookx.dtd
means the file is not valid docbook. A docbook element can only
contain certain other docbook elements, so
<xref linkend="LFC-to-js2doc"/>
in a <para> tag is not legal docbook. That's why you need to escape it.
On Fri, May 7, 2010 at 10:41 AM, André Bargull <[email protected]
<mailto:[email protected]>> wrote:
On 5/6/2010 4:10 PM, Lou Iorio wrote:
A couple of issues:
doc-backwards-xform.dbk : there is a docbook validity error in
line 193:
<note><para>Review the table in <xref linkend="LFC-to-js2doc"/> ...
The xref part needs to be escaped:
<xref linkend="LFC-to-js2doc"/>
I found similar errors in at least one other file: doc-toolchain.dbk
You can validate the docbook files like this:
xmllint -dtdvalid ~/src/svn/vendor/docbook-xml-4.5/docbookx.dtd
<filename>
Then look for an error like:
Document doc-toolchain.dbk does not validate...
I only see validation errors caused by invalid IDs. This happens
because the IDs are actually defined in different files, for example:
$ xmllint -dtdvalid
~/src/svn/vendor/docbook-xml-4.5/docbookx.dtd
doc-backwards-xform.dbk > /dev/null
IDREF attribute linkend references an unknown ID "LFC-to-js2doc"
Document doc-backwards-xform.dbk does not validate against
/home/anba/src/svn/vendor/docbook-xml-4.5/docbookx.dtd
That ID is defined in doc-toolchain.dbk:
$ grep "LFC-to-js2doc" doc-toolchain.dbk
<section id="LFC-to-js2doc">
-------------------------------
Line 211:
<imagedata fileref="images/reference-methods-explanation.png"/>
The image file does not exist.
Yes I know that, the file was never checked in by Ben. That's why
I've added this TODO:
+ <!-- TODO [20100502 anba] image does not exist -->
<mediaobject>
<imageobject>
<imagedata fileref="images/reference-methods-explanation.png"/>
On Wed, May 5, 2010 at 11:58 AM, André Bargull
<[email protected] <mailto:[email protected]>
<mailto:[email protected] <mailto:[email protected]>>>
wrote:
Change 20100505-bargull-bNJ by barg...@bargull02 on
2010-05-05 17:36:48
in /home/anba/src/svn/openlaszlo/trunk
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: updates for dguide chapters 54, 55, 56 and Appendix B
Bugs Fixed: LPP-8856 (DGuide: Found a few bits which need
updates)
Doc Reviewer: ptw
Details:
doc-toolchain.dbk (Chapter 54. The Documentation Toolchain)
- id for <view> is still LzView, not lz.view
doc-backwards-xform.dbk (Chapter 55. The Backwards
Transformation:
From Reference Page to Source)
- correct number of columns in Page Header table
- left align all examples for better readibility
- update Lz.swfEmbed to lz.embed.swf
- update listing in section 4 "Method Details", so it's
up-to-date again
docbook-local.dbk (Chapter 56. Local Docbook Style Guide)
- left align all examples for better readibility
- fix missing white spaces after <sgmltag>s
- removed LPP-4033 and LPP-4146 from "Current Gotchas" list,
both
issues are resolved
ecmascript-and-lzx.dbk (Appendix B. ECMAScript)
- fix listing to use <script> when referring to <script> (!)
- change all "SWF" references to say "SWF8"
- fix property access listing to use foo['length'] instead of
foo.['length']
- left align all examples for better readibility
- hide section "Forward references", this works for me
- todateString() -> toDateString()
- Error, encodeURIComponent and decodeURIComponent are supported
- add note for Function.toString()
- update link to ES-Harmony classes proposal, change wording
from
"ECMAScript 4 committee" to "ES-Harmony committee"
Tests:
ant developers
visual verify
Files:
M docs/src/developers/ecmascript-and-lzx.dbk
M docs/src/developers/docbook-local.dbk
M docs/src/developers/doc-toolchain.dbk
M docs/src/developers/doc-backwards-xform.dbk
Changeset:
http://svn.openlaszlo.org/openlaszlo/patches/20100505-bargull-bNJ.tar
