Author: lou
Date: 2007-10-18 06:04:24 -0700 (Thu, 18 Oct 2007)
New Revision: 6896
Modified:
openlaszlo/trunk/docs/src/deployers/deploy-preface.dbk
openlaszlo/trunk/docs/src/deployers/deployers-index.dbk
openlaszlo/trunk/docs/src/developers/debugging.dbk
openlaszlo/trunk/docs/src/developers/deployers-index.dbk
openlaszlo/trunk/docs/src/developers/designers.dbk
openlaszlo/trunk/docs/src/developers/developers_guide_preface.dbk
openlaszlo/trunk/docs/src/developers/index.dbk
openlaszlo/trunk/docs/src/developers/language-preliminaries.dbk
openlaszlo/trunk/docs/src/developers/media-resources.dbk
openlaszlo/trunk/docs/src/developers/persistent_connection.dbk
openlaszlo/trunk/docs/src/developers/proxied.dbk
openlaszlo/trunk/index.jsp
Log:
Change 20071016-lou-6 by [EMAIL PROTECTED] on 2007-10-16 10:54:52 AST
in /Users/lou/src/svn/openlaszlo/trunk
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: rationalize documentation titles
New Features: go through the designer's and administrator's guides, and change
titles:
current name -> new name
System Administrator's Guide to Deploying OpenLaszlo Applications -> OpenLaszlo
System Administrator's Guide
Software Engineer's Guide to Developing OpenLaszlo Applications ->OpenLaszlo
Application Developer's Guide
In addition, check cross references to these docs, and fix any broken links
Bugs Fixed: LPP-4804
Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: John Sundman
Documentation:
Release Notes:
Details:
Tests:
Modified: openlaszlo/trunk/docs/src/deployers/deploy-preface.dbk
===================================================================
--- openlaszlo/trunk/docs/src/deployers/deploy-preface.dbk 2007-10-18
09:30:15 UTC (rev 6895)
+++ openlaszlo/trunk/docs/src/deployers/deploy-preface.dbk 2007-10-18
13:04:24 UTC (rev 6896)
@@ -1,8 +1,7 @@
<section>
-
+<!-- change title per LPP-4804, IORIO 16 oct 2007 -->
<para>OpenLaszlo applications are written in the LZX language and compiled to
.swf files that execute in the Flash Player. This
-Guide explains how to make those applications available to users on the Web.
The <ulink url="../guide">Software Developer's
-Guide to Laszlo Applications</ulink> explains how to construct and test
applications before you deploy them for general use.</para>
+Guide explains how to make those applications available to users on the Web.
The <ulink url="../developers/">OpenLaszlo Application Developer's
Guide</ulink> explains how to construct and test applications before you deploy
them for general use.</para>
<para/><section><title>Audience and rationale for this book</title>
@@ -51,9 +50,11 @@
-
-<para>In addition to this <emphasis role="em">Administrator's
Guide</emphasis>, please see also</para>
-<itemizedlist spacing="compact"><listitem><para>The <ulink
url="../guide"><emphasis role="em">Software Developer's Guide to Laszlo
Applications</emphasis></ulink>, the comprehensive
+<!-- change title per LPP-4804, IORIO 16 oct 2007 -->
+<para>In addition to this <emphasis role="em">OpenLaszlo System
Administrator's Guide</emphasis>, please see also</para>
+<itemizedlist spacing="compact"><listitem>
+<!-- change title per LPP-4804, IORIO 16 oct 2007 -->
+<para>The <ulink url="../developers"><emphasis role="em">OpenLaszlo
Application Developer's Guide</emphasis></ulink>, the comprehensive
explanation of how to write and test OpenLaszlo
programs.</para></listitem><listitem><para>The <ulink url="../design"><emphasis
role="em">User Interface Designer's Guide to Laszlo
Applications</emphasis></ulink>,
which addresses aspects
of the Laszlo platform that are of special interest to UI and graphic
designers</para></listitem><listitem><para>The <ulink
url="../reference/../reference/" type="laszlo-reference"><emphasis
role="em">LZX Reference
Modified: openlaszlo/trunk/docs/src/deployers/deployers-index.dbk
===================================================================
--- openlaszlo/trunk/docs/src/deployers/deployers-index.dbk 2007-10-18
09:30:15 UTC (rev 6895)
+++ openlaszlo/trunk/docs/src/deployers/deployers-index.dbk 2007-10-18
13:04:24 UTC (rev 6896)
@@ -8,7 +8,8 @@
<book xmlns:xi="http://www.w3.org/2003/XInclude";>
<?dbhtml dir="deployers" ?>
<?dbhtml filename="index.html" ?>
- <title>System Administrator's Guide to Deploying OpenLaszlo
Applications</title>
+ <!-- change title per LPP-4804, IORIO 14 oct 2007 -->
+ <title>OpenLaszlo System Administrator's Guide</title>
<titleabbrev>Deployer Guide</titleabbrev>
<preface id="deployers.preface">
Modified: openlaszlo/trunk/docs/src/developers/debugging.dbk
===================================================================
--- openlaszlo/trunk/docs/src/developers/debugging.dbk 2007-10-18 09:30:15 UTC
(rev 6895)
+++ openlaszlo/trunk/docs/src/developers/debugging.dbk 2007-10-18 13:04:24 UTC
(rev 6896)
@@ -65,8 +65,8 @@
This is equivalent to pressing the "Debug" button in the developer
console.</para>
-
-<para>See the<ulink url="../deploy/request-types.html" type="">System
Administrator's Guide</ulink> for more information
+<!-- change title per LPP-4804, IORIO 15 oct 2007 -->
+<para>See the <ulink url="../deployers/request-types.html" type="">OpenLaszlo
System Administrator's Guide</ulink> for more information
about request types.</para></listitem></varlistentry></variablelist>
<para/></section><section id="debugging.runtime-error-checking"><title>Runtime
Error Checking</title>
@@ -367,8 +367,8 @@
method.</para>
<para role="todo"><remark role="todo"><emphasis role="para-label">TODO:
</emphasis>Examples</remark></para>
-
-<para>See the <ulink url="../deploy/logging.html" type="">System
Administrator's Guide to Delpoying OpenLaszlo Applications</ulink> for
information about configuration
+<!-- change title per LPP-4804, IORIO 15 oct 2007 -->
+<para>See the <ulink url="../deployers/logging.html" type="">OpenLaszlo System
Administrator's Guide</ulink> for information about configuration
and reading the server log.</para>
<para/></section><section><title>Formatting Output</title>
<para>
@@ -432,8 +432,9 @@
<para>
The configuration parameter <literal>compiler.debug.backtrace</literal>, when
true, causes the compiler to instrument functions to maintain a call stack. You
must recompile both the OpenLaszlo Runtime Library and your program if you
change the setting of this parameter. It defaults to false because there is
significant overhead introduced in enabling backtracing; in general it is only
useful on small test cases.
</para>
+<!-- change title per LPP-4804, IORIO 15 oct 2007 -->
<para>
-The configuration parameter is set in the configuration file<literal>
lps.config </literal>, as explained in the <ulink
url="../deploy/deployers-guide.html#deployers-guide.lps.properties"
type="">System Administrator's Guide</ulink>.</para>
+The configuration parameter is set in the configuration file<literal>
lps.config </literal>, as explained in the <ulink
url="../deployers/deployers-guide.html#deployers-guide.lps.properties"
type="">OpenLaszlo System Administrator's Guide</ulink>.</para>
<para>
To create your own backtrace at any time:
Modified: openlaszlo/trunk/docs/src/developers/deployers-index.dbk
===================================================================
--- openlaszlo/trunk/docs/src/developers/deployers-index.dbk 2007-10-18
09:30:15 UTC (rev 6895)
+++ openlaszlo/trunk/docs/src/developers/deployers-index.dbk 2007-10-18
13:04:24 UTC (rev 6896)
@@ -6,7 +6,8 @@
<!--DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"-->
<book xmlns:xi="http://www.w3.org/2003/XInclude";>
- <title>System Administrator's Guide to Deploying OpenLaszlo
Applications</title>
+ <!-- change title per LPP-4804, IORIO 15 oct 2007 -->
+ <title>OpenLaszlo System Administrator's Guidee</title>
<titleabbrev>Administrator's Guide</titleabbrev>
<part id="preface">
<xi:include href="deploy-preface.dbk"/>
Modified: openlaszlo/trunk/docs/src/developers/designers.dbk
===================================================================
--- openlaszlo/trunk/docs/src/developers/designers.dbk 2007-10-18 09:30:15 UTC
(rev 6895)
+++ openlaszlo/trunk/docs/src/developers/designers.dbk 2007-10-18 13:04:24 UTC
(rev 6896)
@@ -10,12 +10,13 @@
We'll discuss OpenLaszlo's ability to support designers and engineers in
building innovative Internet applications.
</para>
<para/><section><title>Leaning to Think Laszlorificly</title>
+<!-- change link for tutorials per LPP-4923, IORIO 17 oct 2007 -->
<para>
With OpenLaszlo technology, web application designers are freed from the
familiar limitations of static, linear, page-based task flow.
Your visions of dynamic, data-driven, concise and intelligent UI can become a
reality. But you may need to change your thinking
a little bit, because things are possible with OpenLaszlo that aren't possible
with most other technologies. And while it is not necessary for you to learn
to write code in order to be an effective designer on an OpenLaszlo project,
a familiarity with the basic structure and features of the LZX language will
help you understand how to approach your task.
-So we recommend that you at least work through a few of the <ulink
url="../guide/" type="laszlo-dguide">tutorials</ulink>.
+So we recommend that you at least work through a few of the <ulink
url="../developers/" type="laszlo-dguide">tutorials</ulink>.
</para>
<para>
@@ -131,9 +132,9 @@
change size. Verity contains an unaccented subset of characters; for the full
Windows Western Unicode font set, use VerityPlus,
which includes accented European characters. The Bitstream font Vera was
released as an open source font for the Gnome Project.
The Ultra Pixel font Verity was built by Christopher Lowery using technology
produced by Truth in Design.</para>
-<para>
<!-- fix broken link per LPP-4896, IORIO 15 oct 2007 -->
<!-- change title per LPP-4804, IORIO 15 oct 2007 -->
+<para>
For more on fonts, see <ulink url="../developers/fonts.html"
type="laszlo-dguide">OpenLaszlo Application Developer's Guide</ulink>.</para>
<para/></section><section><title>OpenLaszlo Components Design Guide</title>
Modified: openlaszlo/trunk/docs/src/developers/developers_guide_preface.dbk
===================================================================
--- openlaszlo/trunk/docs/src/developers/developers_guide_preface.dbk
2007-10-18 09:30:15 UTC (rev 6895)
+++ openlaszlo/trunk/docs/src/developers/developers_guide_preface.dbk
2007-10-18 13:04:24 UTC (rev 6896)
@@ -83,8 +83,9 @@
Nevertheless, as a developer you have to decide whether to:
</para>
<orderedlist spacing="compact"><listitem><para>optimize for swf (employ
swf-only APIs, (and maybe even touch Flash
APIs))</para></listitem><listitem><para>optimize for dhtml (employ dhtml-only
APIs)</para></listitem><listitem><para>code to lowest common denominator
("core" APIs only)</para></listitem><listitem><para>conditionalize (include
both. An example would be including comma separated list of embedded and system
fonts; when compiled to swf you get embedded font, to dhtml you get system
font).</para></listitem></orderedlist>
+<!-- change title per LPP-4804, IORIO 16 oct 2007 -->
<para>
-The focus of the <emphasis role="i">Developer's Guide</emphasis> is (c), the
lowest common denominator; runtime-specific APIs and engineering approaches are
presented as adjuncts. Graphic devices ("glyphs") in the margin call attention
to non core/non SOLO information.
+The focus of the <emphasis role="i">OpenLaszlo Application Developer's
Guide</emphasis> is (c), the lowest common denominator; runtime-specific APIs
and engineering approaches are presented as adjuncts. Graphic devices
("glyphs") in the margin call attention to non core/non SOLO information.
</para>
<para role="fixme"><remark role="fixme"><emphasis role="para-label">FIXME:
</emphasis>illustrate the glyphs here when they're ready</remark></para>
<para>
@@ -155,8 +156,8 @@
-
-<para>In addition to this <emphasis role="em">Developer's Guide</emphasis>,
please see also</para>
+<!-- change title per LPP-4804, IORIO 16 oct 2007 -->
+<para>In addition to this <emphasis role="em">OpenLaszlo Application
Developer's Guide</emphasis>, please see also</para>
<itemizedlist spacing="compact"><listitem><para>The <ulink
url="../reference/../reference/" type="laszlo-reference"><emphasis
role="em">LZX Reference
Manual</emphasis></ulink>. This online, hyperlinked, comprehensive reference
for LZX contains entries for each LZX tag and API. Its format will
Modified: openlaszlo/trunk/docs/src/developers/index.dbk
===================================================================
--- openlaszlo/trunk/docs/src/developers/index.dbk 2007-10-18 09:30:15 UTC
(rev 6895)
+++ openlaszlo/trunk/docs/src/developers/index.dbk 2007-10-18 13:04:24 UTC
(rev 6896)
@@ -8,7 +8,8 @@
<book xmlns:xi="http://www.w3.org/2003/XInclude";>
<?dbhtml dir="developers" ?>
<?dbhtml filename="index.html" ?>
- <title>Software Engineer's Guide to Developing OpenLaszlo
Applications</title>
+ <!-- change title per LPP-4804, IORIO 14 oct 2007 -->
+ <title>OpenLaszlo Application Developer's Guide</title>
<titleabbrev>Developer Guide</titleabbrev>
<preface id="developers.preface">
Modified: openlaszlo/trunk/docs/src/developers/language-preliminaries.dbk
===================================================================
--- openlaszlo/trunk/docs/src/developers/language-preliminaries.dbk
2007-10-18 09:30:15 UTC (rev 6895)
+++ openlaszlo/trunk/docs/src/developers/language-preliminaries.dbk
2007-10-18 13:04:24 UTC (rev 6896)
@@ -29,9 +29,14 @@
different from its use in traditional web applications in which JavaScript is
used to do things like communicate with the browser
or generate HTML pages. Those functions are basically irrelevant in LZX
applications. Thus, although the language design is
rather traditional, the programming paradigm is fundamentally new.</para>
+<!-- change link for laszlo_basics per LPP-4923, IORIO 17 oct 2007 -->
+<para>This chapter summarizes the traditional and innovative aspects of LZX.
It's an overview, not a tutorial;
+after reading it you will be better able to decide how to go about learning
the language. Depending on your
+background and experience, you may determine that you need to go learn some
more about XML or object-oriented
+programming before addressing LZX. On the other hand, if you find these
concepts accessible, you may want to
+jump right in and begin coding, in which case we suggest starting with the
+tutorial: <xref linkend="laszlo_basics" /></para>
-<para>This chapter summarizes the traditional and innovative aspects of LZX.
It's an overview, not a tutorial; after reading it you will be better able to
decide how to go about learning the language. Depending on your background and
experience, you may determine that you need to go learn some more about XML or
object-oriented programming before addressing LZX. On the other hand, if you
find these concepts accessible, you may want to jump right in and begin coding,
in which case we suggest starting with the <ulink
url="../guide/laszlo_basics.html" type="laszlo-dguide">OpenLaszlo
Basics</ulink> tutorial.</para>
-
<para/><section><title>Overview of Syntax and Semantics</title>
<para>In LZX, XML tags are used to create JavaScript objects, and JavaScript
is used inside of LZX programs to
@@ -704,8 +709,9 @@
Nevertheless, as a developer you have to decide whether to:
</para>
<orderedlist spacing="compact"><listitem><para>optimize for swf (employ
swf-only APIs, (and maybe even touch Flash
APIs))</para></listitem><listitem><para>optimize for dhtml (employ dhtml-only
APIs)</para></listitem><listitem><para>code to lowest common denominator
("core" APIs only)</para></listitem><listitem><para>conditionalize (include
both. An example would be including comma separated list of embedded and system
fonts; when compiled to SWF you get embedded font, to DHTML you get system
font).</para></listitem></orderedlist>
+<!-- change title per LPP-4804, IORIO 16 oct 2007 -->
<para>
-The focus of the <emphasis role="i">Developer's Guide</emphasis> is (c), the
lowest common denominator; runtime-specific APIs and engineering approaches are
presented as adjuncts. Graphic devices ("glyphs") in the margin call attention
to non core/non SOLO information.
+The focus of the <emphasis role="i">OpenLaszlo Application Developer's
Guide</emphasis> is (c), the lowest common denominator; runtime-specific APIs
and engineering approaches are presented as adjuncts. Graphic devices
("glyphs") in the margin call attention to non core/non SOLO information.
</para>
<para role="fixme"><remark role="fixme"><emphasis role="para-label">FIXME:
</emphasis>illustrate the glyphs here when they're ready</remark></para>
<para>
Modified: openlaszlo/trunk/docs/src/developers/media-resources.dbk
===================================================================
--- openlaszlo/trunk/docs/src/developers/media-resources.dbk 2007-10-18
09:30:15 UTC (rev 6895)
+++ openlaszlo/trunk/docs/src/developers/media-resources.dbk 2007-10-18
13:04:24 UTC (rev 6896)
@@ -781,9 +781,9 @@
<glossterm>Compiler Media Cache</glossterm>. In general,
the Compiler Media Cache settings only affect the speed of
the OpenLaszlo compiler. The settings for the Media Cache
- can affect server performance. See
- <ulink url="../deploy/" type="">The Administrator's
- Guide</ulink>for details.</para>
+ can affect server performance. See the
+ <!-- change title per LPP-4804, IORIO 15 oct 2007 -->
+ <ulink url="../deployers/">OpenLaszlo System Administrator's
Guide</ulink>for details.</para>
<para>The example below provides a text input area for you
to type in urls that you'd like to test. To run the
example, copy it into your local environment and compile
Modified: openlaszlo/trunk/docs/src/developers/persistent_connection.dbk
===================================================================
--- openlaszlo/trunk/docs/src/developers/persistent_connection.dbk
2007-10-18 09:30:15 UTC (rev 6895)
+++ openlaszlo/trunk/docs/src/developers/persistent_connection.dbk
2007-10-18 13:04:24 UTC (rev 6896)
@@ -788,12 +788,11 @@
<connection authenticator="org.openlaszlo.auth.HTTPAuthentication"
authparam="url=http://other.host.com/MySecurityServer"/>
</programlisting>
-
+<!-- change title and add link per LPP-4804, IORIO 15 oct 2007 -->
<para>If the authentication was successful, the security server should return
HTTPAuthentication a username, which, in turn, is returned to the OpenLaszlo
Server. You can
change the default authenticator with the
-<literal>connection.default.authenticator</literal> property. See the
"Administrator's
-Guide" for more on how to configure your server and <link
linkend="persistent_connection.httpauthentication">HTTPAuthentication</link>
for what the XML response
+<literal>connection.default.authenticator</literal> property. See the <ulink
url="../deployers/">OpenLaszlo System Administrator's Guide</ulink> for more on
how to configure your server and <link
linkend="persistent_connection.httpauthentication">HTTPAuthentication</link>
for what the XML response
format of authentication servers should look like.</para>
Modified: openlaszlo/trunk/docs/src/developers/proxied.dbk
===================================================================
--- openlaszlo/trunk/docs/src/developers/proxied.dbk 2007-10-18 09:30:15 UTC
(rev 6895)
+++ openlaszlo/trunk/docs/src/developers/proxied.dbk 2007-10-18 13:04:24 UTC
(rev 6896)
@@ -104,8 +104,9 @@
Note that the default behavior is proxied. See below.
</para></note>
<para/><section><title>Availability of J2EE Server or Servlet Container</title>
+<!-- change title per LPP-4804, IORIO 15 oct 2007 -->
<para>
-As explained in the <ulink url="../deploy/">System Administrator's Guide to
Deploying OpenLaszlo Applications</ulink>, deploying proxied OpenLaszlo
applications
+As explained in the <ulink url="../deployers/">OpenLaszlo System
Administrator's Guide</ulink>, deploying proxied OpenLaszlo applications
requires that you install a J2EE application server or servlet container.
OpenLaszlo comes with the Tomcat servlet container included,
but, depending on how you have access to the web, it may not be practical or
even possible for you to use this to make your applications
generally available. So, before you decide to start development of an
OpenLaszlo application for, say, a hobby website, you should find out
@@ -132,8 +133,9 @@
If either deployment manner is available to you, the decision may come down to
which works better. You should do test deployments under each
method and see which gives the faster performance.</para>
<para/><section><title>GZipping DHTML Applications</title>
+<!-- change title per LPP-4804, IORIO 15 oct 2007 -->
<para>
-When compiling for DHTML, you should ensure that gzipping is turned on at the
server. This is done automatically for DHTML files, but not for DHTML. See the
Administrator's Guide for details.
+When compiling for DHTML, you should ensure that gzipping is turned on at the
server. This is done automatically for DHTML files, but not for DHTML. See the
<ulink url="../deployers/">OpenLaszlo System Administrator's Guide</ulink> for
details.
</para>
<para>
The data transfer size and run-time performance may be bigger or smaller,
faster or slower.
@@ -143,8 +145,9 @@
It would be redundant to have the web server compress them as well.</para>
<para/></section></section><section><title>Open Proxy by Default</title>
+<!-- change title per LPP-4804, IORIO 15 oct 2007 -->
<para>
-By default, the OpenLaszlo proxy server ships "wide open", which can be a
security hazard. See the <ulink url="../deploy/">System Administrator's Guide
to Deploying OpenLaszlo Applications</ulink>, for a discussion of OpenLaszlo
security management.</para>
+By default, the OpenLaszlo proxy server ships "wide open", which can be a
security hazard. See the <ulink url="../deployers/">OpenLaszlo System
Administrator's Guide</ulink>, for a discussion of OpenLaszlo security
management.</para>
<para/></section><section><title>Compile-time and run-time differences between
proxied and SOLO applications</title>
<para>
If an application is compiled for proxied operation, all data and media
requests are proxied and the remote
Modified: openlaszlo/trunk/index.jsp
===================================================================
--- openlaszlo/trunk/index.jsp 2007-10-18 09:30:15 UTC (rev 6895)
+++ openlaszlo/trunk/index.jsp 2007-10-18 13:04:24 UTC (rev 6896)
@@ -86,9 +86,11 @@
<p>Docs</p>
<ul>
<li><a href="docs">Docs index</a></li>
- <li><a href="docs/developers">Software Developer's Guide</a></li>
+ <!-- change title per LPP-4804, IORIO 14 oct 2007 -->
+ <li><a href="docs/developers">Application Developer's
Guide</a></li>
<li><a href="docs/component-design">UI Designer's Guide</a></li>
- <li><a href="docs/deployers">Deployer's Guide</a></li>
+ <!-- change title per LPP-4804, IORIO 14 oct 2007 -->
+ <li><a href="docs/deployers">System Administrator's Guide</a></li>
<li><a
href="http://www.openlaszlo.org/lps3/docs/reference";>Reference Guide (for OL
3.4, served from www.openlaszlo.org)</a> or <a href="docs/reference">Reference
Guide (local)</a></li>
<li><a href="docs/contributors">Contributor's Guide</a></li>
<li><a href="docs/release-notes.html">Latest Release Notes</a></li>
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
