Change 20080307-dda-B by [EMAIL PROTECTED] on 2008-03-07 15:20:58 EST
in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: docs: Fixed problems in Classes and Tags tabs in left pane
navigator
New Features:
Bugs Fixed: LPP-5366
Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: liorio (pending)
Documentation:
Release Notes:
Details:
Overhauled navxmlbuilder.rb somewhat (navbuilder.rb is
a red herring, probably no longer useful - added a
message to it to use navxmlbuilder). Now navxmlbuilder
examines all files that might have tags in them, like
LzCanvas.html . This means 1) it cannot use the name of
the file to determine the tag, now it specifically looks for
the html title tag and the presence of <TAG_NAME>
Rather kludgy, but accurate. And 2) since we are looking
at a much larger set of files, including incubator files,
we need a way to eliminate incubator software from the reference
doc. Another kludge - we look for any <link> to a name
with Incubator in it. Easy enough in ruby.
There is probably a cleaner way to do this - we'd like for
the doc build process to communicate more directly to
navxmlbuilder.
Either by inserting recognizable comments or div labels into the
final
.html, or collected into another file. Saying for example,
this source came from the incubator, or this .html file has a
tag, called <foo>.
I explored the first of these, but made little headway, so
a cleaner solution will need to be deferred.
The classes.xml and tags.xml produced by running the script are
part of this commit.
The ruby files now generate in the xml a copyright comment and a
'do not
edit this file' comment, also to make it clear that
navxmlbuilder.rb
shold be used to build them.
Tests:
Clicked around in Classes Tags. There should be no more broken
links and many of the <tags> that were missing before can be found.
Files:
M docs/src/nav/classes.xml
M docs/src/nav/tags.xml
M docs/src/reference/navbuilder/navbuilder.rb
M docs/src/reference/navbuilder/navxmlbuilder.rb
Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20080307-dda-B.tar
--
Don Anderson
Java/C/C++, Berkeley DB, systems consultant
voice: 617-547-7881
email: [EMAIL PROTECTED]
www: http://www.ddanderson.com
