Change 20071025-ben-M by [EMAIL PROTECTED] on 2007-10-25 17:40:53 PDT
in /Users/ben/src/svn/openlaszlo/trunk
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: Merge reference and doctools fixes from paperpie to trunk
New Features:
Bugs Fixed:
LPP-4024 Clicking "edit" on doc example causes Firefox launch
inappropriate inquiry
LPP-4364 Create navbar for documentation
LPP-4683 Parameterize path to source in live-editor for
examples in dev guide
LPP-4696 Edit buttons missing from dguide code examples
LPP-4794 Editor for live code examples in dguide (Introduction
to Components chapter) isn't working
LPP-4943 edit button in tutorials doesn't work
Technical Reviewer: ptw (pending)
QA Reviewer: frisco (pending)
Doc Reviewer: sundman (pending)
Documentation:
This change wraps up several improvements to the doctools:
* add left-nav lzx app for reference
* make live examples work, and make the edit button launch the
example editor
* make the reference listings look more like the 3.4 attribute list
* turn off building the contributor's guide
Release Notes:
Details:
Merged revisions
6506-6574,6576-6688,6690-6750,6753-6761,6763-6764,6766-6769,6771-6772
,6774-6795,6798-6878,6880-7010,7012-7013 via svnmerge from
http://svn.openlaszlo.org/openlaszlo/branches/paperpie
........
r6846 | ben | 2007-10-15 12:18:46 -0700 (Mon, 15 Oct 2007) | 37
lines
Change 20071015-ben-m by [EMAIL PROTECTED] on 2007-10-15 10:58:30 PDT
in /Users/ben/src/svn/openlaszlo/branches/paperpie
for http://svn.openlaszlo.org/openlaszlo/branches/paperpie
Summary: Make reference list more like the 3.4 attribute list
Details:
Make the reference look more like the 3.4 reference, in these ways:
Format attribute list as table, with type (tag) and type (js), but
lacking usage and category, as the specification for these is not
yet clear.
Format list of methods more succinctly - take out listing
javascript and lzx signatures separately. List parameters
in a table, with name, type, and description. Note that static
methods are not currently listed.
Format list of events as in 3.4 reference, with name and
description.
Remove LZX synopsis and JavaScript synopsis.
Issues introduced with this checkin:
* Several cosmetic issues regarding table formatting in
parameter list, attribute list, and events list.
* More code duplication than is desirable; this
should be refactored to do less code-duplication,
but my knowledge of the overall xslt architecture isn't
yet good enough to do this well.
Tests:
cd docs/src; ant clean reference
........
r6853 | ben | 2007-10-15 17:45:15 -0700 (Mon, 15 Oct 2007) | 62
lines
Change 20071015-ben-y by [EMAIL PROTECTED] on 2007-10-15 16:25:23 PDT
in /Users/ben/src/svn/openlaszlo/branches/paperpie/docs/src
for http://svn.openlaszlo.org/openlaszlo/branches/paperpie/
docs/src
Summary: Add left nav for reference
New Features: left nav for reference
Documentation:
This change reinstates the lzx app, nav.lzx, which was the left-
frame
nav in the 3.4 reference.
nav/nav.lzx is the original lzx app from 3.4.
nav/toc.xml is a standin for a real table of contents, which will
have to be
either hand-generated or generated with tools that know what
topics each
reference page belongs in. (js2doc annotates each class with
what topic
it should be part of, but the new toolchain is not yet aware
of that
information. However, the TOC is relatively static, so it
won't hurt
much to generate and maintain this by hand, until the tools are
smartified.)
nav/classes.xml, and nav/tags.xml are generated contents lists
for nav.lzx. They are generated by navxmlbuilder.rb, a ruby
script which only needs to be run by a developer when updating
the classes.xml and tags.xml. This script just looks at
filenames in directories; it is not js2doc-aware.
(The addition of this script does not make the developer
build require ruby; the entire project will build and
run without even trying to execute this script.)
docs/src/build.xml copies the files necessary for the live nav
app to run into the reference directory,. It overwrites
the docbook-generated index.html; while this goes against
100% pure docbook philosophy, I've decided that it's
more appropriate to design and maintain our own table
of contents and home page, than to convince docbook to do
it for us.
welcome.html is the welcome page from the 3.4 reference, with
just the tiniest tweaking to make sense for 4.1. This page
will definitely require careful editorial review. The links
on this page are probably broken.
Release Notes:
nav.lzx does not currently work in dhtml; this needs to be
investigated.
The layout of nav.lzx is not quite right since we no longer have
the lztahoe8 font.
Details:
Tests:
ant clean doc
http://localhost:8080/paperpie/docs/reference/
Note that the left-nav app is back. Click on any
of the tabs or any of the entries in the tab, notice
that the associated reference page appears in the
right-hand frame.
........
r6880 | ben | 2007-10-16 19:43:07 -0700 (Tue, 16 Oct 2007) | 7 lines
Change 20071016-ben-C by [EMAIL PROTECTED] on 2007-10-16 19:39:06 PDT
in /Users/ben/src/svn/openlaszlo/branches/paperpie
for http://svn.openlaszlo.org/openlaszlo/branches/paperpie
Summary: Improvements to table of contents xml data
........
r6881 | ben | 2007-10-16 20:48:42 -0700 (Tue, 16 Oct 2007) | 1 line
Missing file merged in from trunk, didn't get added somehow.
........
r6882 | ben | 2007-10-16 20:56:16 -0700 (Tue, 16 Oct 2007) | 1 line
adding a few more links at the very end of the welcome page for
the reference, to point to the giant comprehensive index and the
contributor's guide.
........
r6890 | ben | 2007-10-17 12:50:33 -0700 (Wed, 17 Oct 2007) | 22
lines
Change 20071017-ben-p by [EMAIL PROTECTED] on 2007-10-17 12:45:52 PDT
in /Users/ben/src/svn/openlaszlo/branches/paperpie
for http://svn.openlaszlo.org/openlaszlo/branches/paperpie
Summary: Put the improved reference nav into the built reference
directory
Documentation:
I had forgotten to actually call the ant task that puts the
reference
nav into the reference output directory. I have corrected that with
this checkin, by explicitly calling the reference.frameset.generate
target.
Release Notes:
Details:
Tests:
ant clean build doc
http://localhost:8080/paperpie/docs/reference/ shows the left-
nav app.
........
r6910 | ben | 2007-10-18 15:59:58 -0700 (Thu, 18 Oct 2007) | 1 line
Made reference left-nav appear without developer console, in
proper width frame. Changed title of reference welcome page to LZX
4.1 Reference Manual.
........
r6912 | ben | 2007-10-18 17:29:21 -0700 (Thu, 18 Oct 2007) | 1 line
Filled out reference toc for structure, view basics, components,
layouts, animation, events, data, scripting, states, base classes,
menus and commands, rpc, services, audio video, persistent
connection, and development. Missing content for HTML Markup,
Media, Charts and Graphs, Appendices (bugs filed on missing data,
LPP-4931, LPP-4932, LPP-4933, LPP-4934, LPP-4935, LPP-4936, LPP-4937
........
r6952 | ben | 2007-10-22 13:41:08 -0700 (Mon, 22 Oct 2007) | 61
lines
Change 20071019-ben-b by [EMAIL PROTECTED] on 2007-10-19 21:30:38 PDT
in /Users/ben/src/svn/openlaszlo/branches/paperpie/docs
for http://svn.openlaszlo.org/openlaszlo/branches/paperpie/docs
Summary: Live examples links for developer's guide and reference
New Features:
Bugs Fixed:
LPP-4794 Editor for live code examples in dguide (Introduction
to Components chapter) isn't working
LPP-4696 Edit buttons missing from dguide code examples
LPP-4024 Clicking "edit" on doc example causes Firefox launch
inappropriate inquiry
LPP-4683 Parameterize path to source in live-editor for
examples in dev guide
Technical Reviewer: none
QA Reviewer: (pending)
Doc Reviewer: sundman (pending)
Documentation:
Live examples and links to edit live examples should all work, in
reference,
developers guide, and tutorials.
Release Notes:
Details:
docs/src/build.xml - Rearranged paths for building the reference
guide so that
the directory paths make sense. Everything goes from docs/src/
developers to
docs/build to docs/developers. I think this is how it was
*designed* to work,
but it's not quite how it *was* working.
1) The code examples go from the developers.input.dir
to the developers.build.dir in the developers.preprocess
target.
2) In the developers.examples.preprocess target, the examples
come from the
docs.build.dir and are transcluded in the developer's
guide index.dbk.
3) In developers.html.generate target, the input comes from
developers.build.dir
and is written out to docs/
Also, don't build the contributor's guide. It takes a long
time, and we're
not using it right now.
docs/src/xsl/common-html.xsl - Added templates and variables to
keep track of
where the current output is relative to $LPS_HOME. Various
things (like the link
to the editor.jsp) need to refer to $LPS_HOME, and other
things need to know
how far nested they are down from $LPS_HOME/docs. Rather than
being incredibly
clever and figuring it out by regexp analysis of the current
path, we just
check which part of the book we're building now, and map that
directly
to the relative path information we need.
Using this information, I rearranged the hrefs in the live
examples button
and link so that it works for both the developers guide, the
reference guide,
and the tutorials.
For the purposes of development, I have inserted some
debugging information
immediately after each live example. This will be removed
before we ship.
docs/src/xsl/simple-driver.xsl - Changed to test out techniques
for analyzing
local variables and directories.
Tests:
........
[Hand-merged r7013 fix for LPP-4960 to trunk]
Tests:
Files:
M .
M docs/includes/docbook.css
M docs/includes/styles.css
A + docs/src/nav
A + docs/src/nav/nav.lzx
A + docs/src/nav/toc.xml
A + docs/src/nav/classes.xml
A + docs/src/nav/tags.xml
M docs/src/build.xml
M docs/src/reference/navbuilder/index-frames.html
A + docs/src/reference/navbuilder/navxmlbuilder.rb
A + docs/src/reference/welcome.html
M docs/src/xsl/synop-javascript.xsl
M docs/src/xsl/simple-driver.xsl
M docs/src/xsl/js2doc2dbk/synopsis.xsl
M docs/src/xsl/js2doc2dbk.xsl
M docs/src/xsl/common-html.xsl
Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20071025-
ben-M.tar
