[Laszlo-checkins] r7029 - in openlaszlo/trunk/docs: . component-design src/developers src/reference
lou@openlaszlo.org
lou at openlaszlo.org
Sun Oct 28 10:12:56 PDT 2007
Author: lou
Date: 2007-10-28 10:12:11 -0700 (Sun, 28 Oct 2007)
New Revision: 7029
Modified:
openlaszlo/trunk/docs/component-design/index.html
openlaszlo/trunk/docs/index.html
openlaszlo/trunk/docs/src/developers/language-preliminaries.dbk
openlaszlo/trunk/docs/src/developers/methods-events-attributes.dbk
openlaszlo/trunk/docs/src/reference/preface.dbk
Log:
Change 20071022-lou-U by lou at loumac.local on 2007-10-22 19:00:17 AST
in /Users/lou/src/svn/openlaszlo/trunk
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: improve preface to the Reference
New Features:
sect 1, other sources of information:
change simple list to nested bulleted list
add components and admin guides to list
change titles of docs to match dguide and others
add description to each item in list
add description of Laszlo Explorer
fix link to section 6.2 Attribute Types
added link to section Combining Tags and Script in LZX Programs
(I think this addresses the second paragraph after the bulleted list in
the JIRA report.)
In language priliminaries:
add id tag to section so we can link to section Combining Tags and Script in LZX Programs
In docs/index.html
change titles to match the rest of the doc
in docs/component-design/index.html:
change title ot match the rest of the doc
in methods-events-attributes.dbk
add id to section Attribute types so the reference can xref here
Bugs Fixed: LPP-3733
Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: John Sundman
Modified: openlaszlo/trunk/docs/component-design/index.html
===================================================================
--- openlaszlo/trunk/docs/component-design/index.html 2007-10-28 05:29:52 UTC (rev 7028)
+++ openlaszlo/trunk/docs/component-design/index.html 2007-10-28 17:12:11 UTC (rev 7029)
@@ -1,17 +1,18 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- * X_LZ_COPYRIGHT_BEGIN ***************************************************
-* Copyright 2001-2006 Laszlo Systems, Inc. All Rights Reserved. *
+* Copyright 2001-2007 Laszlo Systems, Inc. All Rights Reserved. *
* Use is subject to license terms. *
* X_LZ_COPYRIGHT_END ****************************************************** -->
<html>
<link href="../../lps/includes/styles.css" type="text/css" rel="STYLESHEET">
<head>
-<title>OpenLaszlo Component Design Guide</title>
+<title>OpenLaszlo Components Guide</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body bgcolor="#ffffff">
-<h1>Working with the OpenLaszlo Component Set</h1>
+<!-- change title to match reference and dguide. IORIO 22 oct 2007 -->
+<h1>OpenLaszlo Components Guide</h1>
<h2>An Overview for User Interface Designers</h2>
<ol start="0">
<li><a href="#overview">Components Overview</a></li>
Modified: openlaszlo/trunk/docs/index.html
===================================================================
--- openlaszlo/trunk/docs/index.html 2007-10-28 05:29:52 UTC (rev 7028)
+++ openlaszlo/trunk/docs/index.html 2007-10-28 17:12:11 UTC (rev 7029)
@@ -1,7 +1,6 @@
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
<html>
<head>
<title>OpenLaszlo Documentation</title>
@@ -13,24 +12,31 @@
<h1>OpenLaszlo Documentation</h1>
<p>OpenLaszlo's developer documentation includes overviews, tutorials, and details on application development with Laszlo's technology. Follow the links below to find specific documentation. </p>
-
+<!-- change user's guides titles to match dguide and reference. IORIO 22 oct 2007 -->
+<!-- moved release notes to first item on list. IORIO 22 oct 2007 -->
<ul>
<li>
-<b><a href="./userindex.html">User's Guide</a></b><br />
+<b><a href="./userindex.html">User's Guides</a></b><br />
Materials for adopters of the OpenLaszlo platform.
<ul>
+
<li>
+<b><a href="./release-notes.html">Release Notes</a></b><br />
+What's new in the release; changes to LZX syntax.
+</li>
+
+<li>
<b><a href="./installation/index.html">Installation Instructions</a></b><br />
How to install and upgrade the OpenLaszlo Server.
</li>
<li>
-<b><a href="./developers/index.html">Software Developer's Guide</a></b><br />
+<b><a href="./developers/index.html">OpenLaszlo Application Developer's Guide</a></b><br />
In depth explanations of OpenLaszlo concepts.
</li>
<li>
-<b><a href="./deployers/index.html">System Administrator's Guide to Deploying OpenLaszlo Applications</a></b><br />
+<b><a href="./deployers/index.html">OpenLaszlo System Administrator's Guide</a></b><br />
How to make OpenLaszlo applications available on the web.
</li>
@@ -41,12 +47,7 @@
</li>
<li>
-<b><a href="./release-notes.html">Release Notes</a></b><br />
-What's new in the release; changes to LZX syntax.
-</li>
-
-<li>
-<b><a href="./component-design/index.html">Component Design</a></b><br />
+<b><a href="./component-design/index.html">OpenLaszlo Components Guide</a></b><br />
An Overview of the OpenLaszlo Component Set for User Interface Designers.
</li>
Modified: openlaszlo/trunk/docs/src/developers/language-preliminaries.dbk
===================================================================
--- openlaszlo/trunk/docs/src/developers/language-preliminaries.dbk 2007-10-28 05:29:52 UTC (rev 7028)
+++ openlaszlo/trunk/docs/src/developers/language-preliminaries.dbk 2007-10-28 17:12:11 UTC (rev 7029)
@@ -579,7 +579,10 @@
<para>The key thing to understand is that while other languages and technologies have implemented merge algorithms that may appear similar on the surface, LZX's data binding is novel in the creation of program objects that retain a live connection with the entities of the data source.</para>
-<para/></section></section><section><title>Combining Tags and Script in LZX Programs</title>
+<para/></section></section>
+<!-- add id tag to section so we can link to here. IORIO 22 oct 2007 -->
+<section id="combine-tags-script">
+><title>Combining Tags and Script in LZX Programs</title>
<para>As mentioned earlier, virtually all nontrivial LZX programs contain both (XML) tags and script. Tags are used declaratively, that is, to define objects and their attributes. Script is used procedurally, that is, to explicitly define a series of steps. Although the two kinds of code are liberally intermixed within LZX — for example, script can appear within tags — each syntax locally maintains its integrity.</para>
Modified: openlaszlo/trunk/docs/src/developers/methods-events-attributes.dbk
===================================================================
--- openlaszlo/trunk/docs/src/developers/methods-events-attributes.dbk 2007-10-28 05:29:52 UTC (rev 7028)
+++ openlaszlo/trunk/docs/src/developers/methods-events-attributes.dbk 2007-10-28 17:12:11 UTC (rev 7029)
@@ -1037,7 +1037,9 @@
See the <xref linkend="constraints"/> for details.
</para>
-<para/></section><section><title>Attribute types</title>
+<para/></section>
+<!-- add id to section so the reference can xref here. IORIO 22 0ct 2007 -->
+<section id="attribute-types"><title>Attribute types</title>
<para>
By default, attributes are of the JavaScript expression type, but in some cases the default declaration doesn't give enough instruction to achieve the desired result. In this example, no labels are displayed in the boxes:
</para>
Modified: openlaszlo/trunk/docs/src/reference/preface.dbk
===================================================================
--- openlaszlo/trunk/docs/src/reference/preface.dbk 2007-10-28 05:29:52 UTC (rev 7028)
+++ openlaszlo/trunk/docs/src/reference/preface.dbk 2007-10-28 17:12:11 UTC (rev 7029)
@@ -4,68 +4,142 @@
* Use is subject to license terms. *
* X_LZ_COPYRIGHT_END ****************************************************** -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<preface id="ref.preface">
-<title>Preface</title>
-
- <para>The OpenLaszlo Reference describes all of the public XML tags and JavaScript APIs in the LZX language. A companion document, the Contributor's Guide, includes descriptions of all private APIs, and other information of interest to contributors to the OpenLaszlo platform.</para>
-
- <sect1><title>Other Sources of Information</title>
- <simplelist>
- <member><ulink url="../guide/tutorials.html" target="_blank"><citetitle>Tutorials</citetitle></ulink></member>
- <member><ulink url="../guide/index.html" target="_blank"><citetitle>Developers Guide</citetitle></ulink></member>
- <member><ulink url="../../laszlo-explorer/" target="_blank"><citetitle>Laszlo Explorer</citetitle></ulink></member>
- <member><ulink url="http://www.openlaszlo.org/community" target="_blank"><citetitle>OpenLaszlo Community</citetitle></ulink></member>
- <member><ulink url="http://forum.openlaszlo.org" target="_blank"><citetitle>Developer Forums</citetitle></ulink></member>
- </simplelist>
- </sect1>
-
- <sect1><title>Using the Reference</title>
-
- <sect2><title>Section Organization</title>
- <para>
- The Reference Guide is divided into chapters, each describing a distinct category of programming interfaces.
- Each chapter contains a number of sub-chapters, corresponding to sub-categories of APIs, and each sub-chapter contains entries for each of those APIs.
- </para>
- <para>
- Each reference entry contains a title (with an optional short description), a synopsis (floated to the right of the page in HTML), an optional Usage section, a Description, followed by a Details section.
- Each of these is pretty self-explanatory except for the Details section, which is described in the next section.
- </para>
- <para>
- </para>
- </sect2>
-
- <sect2><title>Reference Entry Details Section</title>
-
- <para>
- The Details section contains information about the methods and properties of each LZX tag-class.
- Each method or property is described using both LZX syntax and JavaScript syntax.
- </para>
- <para>
- Fully understanding a method or property entry requires understanding a bit about how LZX tags correspond to JavaScript classes.
- Almost every LZX tag in the language -- and every LZX class declared in your program -- is implemented under the covers as a JavaScript class.
- An LZX tag's methods and attributes correspond to JavaScript methods and properties. LZX's events and handlers correspond to more complex JavaScript constructs.
- </para>
-
- <para>
- Certain information about a class or its methods or properties can only be described using JavaScript syntax.
- For example, an item can be public, private, or protected (meaning that it is only visible to a subclass); this information is given as a modifier to the JavaScript item declaration.
- </para>
-
- <sect3><title>LZX and JavaScript Types</title>
+ <title>Preface</title>
+ <para>The OpenLaszlo Reference describes all of the public XML
+ tags and JavaScript APIs in the LZX language. A companion
+ document, the Contributor's Guide, includes descriptions of all
+ private APIs, and other information of interest to contributors
+ to the OpenLaszlo platform.</para>
+ <sect1>
+ <title>Other Sources of Information</title>
+ <itemizedlist>
+ <listitem>
<para>
- Certain parts of the LZX language are actually written in JavaScript, so LZX type information given for these entries in the Reference Guide must be inferred from the original JavaScript type declaration.
- All other portions of LZX -- including your application source -- are of course written in LZX, so JavaScript type information given in the Reference Guide for those portions (useful when writing scripts) much be inferred from any typing information given in the LZX source.
+ <ulink url="../guide/index.html" target="_blank">Developers
+ Guide</ulink>: targeted at software developers who have
+ familiarity with the concepts of object-oriented
+ programming as implemented in languages such as Java, C++,
+ or JavaScript, and with the fundamentals of XML data
+ formats, including scores of live, editable examples</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="../developers/tutorials.html"
+ target="_blank">Tutorials</ulink>: part of the
+ OpenLaszlo Application Developer's Guide, the tutorials
+ present simple, live examples that you can edit and run
+ to help you become more familiar with OpenLaszlo
+ concepts.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="../component-design/">OpenLaszlo Components
+ Guide</ulink>: a complete description of the core set of customizable user interface devices included with OpenLaszlo
</para>
-
+ </listitem>
+ <listitem>
<para>
- LZX types are mostly advisory, but can have an effect on program execution.
- See the <a href="../guide/methods-events-attributes.html#d0e18610">Attribute Types</a> section in the Developer's Guide for more information on this.
+ <ulink url="../deployers/">OpenLaszlo System
+ Administrator's Guide</ulink>: how to put OpenLaszlo applications on the web
</para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="../../laszlo-explorer/" target="_blank">
+ Laszlo Explorer</ulink>: all the documentation listed above, and:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>Demos: rich internet applications that show unity
+ of design</para>
+ </listitem>
+ <listitem>
+ <para>OpenLaszlo in Ten Minutes: an interactive guided
+ tour to get you started</para>
+ </listitem>
+ <listitem>
+ <para>Small Applications: shorter programs that
+ illustrate specific aspects of OpenLaszlo
+ development</para>
+ </listitem>
+ <listitem>
+ <para>Components: an illustrated compendium of
+ OpenLaszlo's prebuilt, user-extendable objects</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.openlaszlo.org/community"
+ target="_blank">OpenLaszlo Community</ulink>: a way for you to get involved in OpenLaszlo development and support
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://forum.openlaszlo.org" target="_blank">
+ Developer Forums</ulink>: discussion lists about all things OpenLaszlo
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect1>
+ <sect1>
+ <title>Using the Reference</title>
+ <sect2>
+ <title>Section Organization</title>
+ <para>The Reference Guide is divided into chapters, each
+ describing a distinct category of programming interfaces.
+ Each chapter contains a number of sub-chapters, corresponding
+ to sub-categories of APIs, and each sub-chapter contains
+ entries for each of those APIs.</para>
+ <para>Each reference entry contains a title (with an optional
+ short description), a synopsis (floated to the right of the
+ page in HTML), an optional Usage section, a Description,
+ followed by a Details section. Each of these is pretty
+ self-explanatory except for the Details section, which is
+ described in the next section.</para>
+ <para></para>
+ </sect2>
+ <sect2>
+ <title>Reference Entry Details Section</title>
+ <para>The Details section contains information about the
+ methods and properties of each LZX tag-class. Each method or
+ property is described using both LZX syntax and JavaScript
+ syntax.</para>
+ <para>Fully understanding a method or property entry requires
+ understanding a bit about how LZX tags correspond to
+ JavaScript classes. Almost every LZX tag in the language --
+ and every LZX class declared in your program -- is
+ implemented under the covers as a JavaScript class. An LZX
+ tag's methods and attributes correspond to JavaScript methods
+ and properties. LZX's events and handlers correspond to more
+ complex JavaScript constructs. How to combine JavaSaript and LZX
+ tags is described in more detail in <xref linkend="combine-tags-script" />.</para>
+ <para>Certain information about a class or its methods or
+ properties can only be described using JavaScript syntax. For
+ example, an item can be public, private, or protected
+ (meaning that it is only visible to a subclass); this
+ information is given as a modifier to the JavaScript item
+ declaration.</para>
+ <sect3>
+ <title>LZX and JavaScript Types</title>
+ <para>Certain parts of the LZX language are actually
+ written in JavaScript, so LZX type information given for
+ these entries in the Reference Guide must be inferred from
+ the original JavaScript type declaration. All other
+ portions of LZX -- including your application source -- are
+ of course written in LZX, so JavaScript type information
+ given in the Reference Guide for those portions (useful
+ when writing scripts) much be inferred from any typing
+ information given in the LZX source.</para>
+ <para>LZX types are mostly advisory, but can have an effect
+ on program execution. See the
+ <xref linkend="attribute-types" /> in the OpenLaszlo Application Developer's Guide for
+ more information.</para>
</sect3>
-
</sect2>
-
</sect1>
-
</preface>
More information about the Laszlo-checkins
mailing list