Author: dda
Date: 2008-03-08 08:03:53 -0800 (Sat, 08 Mar 2008)
New Revision: 8212
Modified:
openlaszlo/trunk/docs/src/reference/wrappers.xml
openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl
Log:
Change 20080308-dda-t by [EMAIL PROTECTED] on 2008-03-08 10:32:54 EST
in /Users/dda/laszlo/src/svn/openlaszlo/trunk-doc2
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: Doc: add attributes for markup entries, remove empty Events section
and empty Extends
New Features:
Bugs Fixed: LPP-5563, LPP-5564, LPP-5559, LPP-5537 (partial)
Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: liorio (pending)
Documentation:
Release Notes:
Details:
Added attribute information in <a>,<img>,<face>,<frame> wrappers to match
3.4
I'm leaving LPP-5537 open for now:
<a> is troublesome, would like to have a list of values _blank, etc.
appearing
in the attribute description (as in 3.4), but could not find a way to do
that.
For the moment, I moved that list into the description of <a>, and will
continue
to try to fix it 'for real'.
When there is no class to Extend from, we no longer show 'Extends: ' with a
blank.
When there are no Events, the event list no longer appears.
Tests:
built all docs and examined the output for the gven pages.
Compared all html to make sure that no real 'Extends' entry got lost.
Modified: openlaszlo/trunk/docs/src/reference/wrappers.xml
===================================================================
--- openlaszlo/trunk/docs/src/reference/wrappers.xml 2008-03-08 16:03:28 UTC
(rev 8211)
+++ openlaszlo/trunk/docs/src/reference/wrappers.xml 2008-03-08 16:03:53 UTC
(rev 8212)
@@ -11,7 +11,7 @@
<property id="tag-a" topic="LZX" subtopic="HTML Markup" access="public">
<doc>
-<tag name="lzxname"><text><a></text></tag>
+<tag name="lzxname"><text>a</text></tag>
<tag name="shortdesc"><text>HTML hypertext link.</text></tag>
<text>
<p/>
@@ -34,10 +34,48 @@
</text>
</canvas>
</example>
+<p/>The user agent will interpret the <tagname>a</tagname> tag depending on
the following value of the target attribute:
+<ul>
+ <li>_blank<p/>
+ The user agent should load the designated document in a new, unnamed
window.
+ </li>
+ <li>_parent<p/>
+ The user agent should load the document into the full, original window
(thus canceling all other frames). This value is equivalent to _self if the
current frame has no parent.
+ </li>
+ <li>_self<p/>
+ The user agent should load the document in the same frame as the element
that refers to this target.
+ </li>
+ <li>_top<p/>
+ The user agent should load the document into the immediate FRAMESET parent
of the current frame. This value is equivalent to _self if the current frame
has no parent.
+ </li>
+</ul>
</text>
</doc>
+
+<class>
+ <property name="__ivars__">
+ <attribute name="id" select="$attrs-id"/>
+ <object>
+ <property id="tag-a.__ivars__.href" name="href" type=""
modifiers="final">
+ <doc>
+ <tag name="lzxtype"><text>URL</text></tag>
+ <text>The link target</text>
+ </doc>
+ </property>
+ <property id="tag-a.__ivars__.target" name="target" type=""
modifiers="final">
+ <doc>
+ <tag name="lzxtype"><text>_blank | _parent | _self |
_top</text></tag>
+ <text>
+ The value of this attribute determines where the link target will
be displayed. The interpretation is the same as in HTML, where the "current
frame" is the frame containing the LZX application. The value must be a name
beginning with an alphabetic character, or one of: "_blank", "_parent",
"_self", "_top"
+ </text>
+ </doc>
+ </property>
+ </object>
+ </property>
+</class>
</property>
+
<property id="tag-b" topic="LZX" subtopic="HTML Markup" access="public">
<doc>
<tag name="shortdesc"><text>Bold Text.</text></tag>
@@ -104,7 +142,7 @@
<property id="tag-img" topic="LZX" subtopic="HTML Markup" access="public">
<doc>
<tag name="shortdesc"><text>A way to import images into html</text></tag>
-<tag name="lzxname"><text><img></text></tag>
+<tag name="lzxname"><text>img</text></tag>
<text>
<p>
The compiler supports the <img> tag in HTML text content, for
@@ -114,6 +152,49 @@
</p>
</text>
</doc>
+<class>
+ <property name="__ivars__">
+ <attribute name="id" select="$attrs-id"/>
+ <object>
+ <property id="tag-img.__ivars__.align" name="align" type=""
modifiers="final">
+ <doc>
+ <tag name="lzxtype"><text>String</text></tag>
+ <text></text>
+ </doc>
+ </property>
+ <property id="tag-img.__ivars__.height" name="height" type=""
modifiers="final">
+ <doc>
+ <tag name="lzxtype"><text>String</text></tag>
+ <text></text>
+ </doc>
+ </property>
+ <property id="tag-img.__ivars__.hspace" name="hspace" type=""
modifiers="final">
+ <doc>
+ <tag name="lzxtype"><text>String</text></tag>
+ <text></text>
+ </doc>
+ </property>
+ <property id="tag-img.__ivars__.src" name="src" type=""
modifiers="final">
+ <doc>
+ <tag name="lzxtype"><text>String</text></tag>
+ <text></text>
+ </doc>
+ </property>
+ <property id="tag-img.__ivars__.vspace" name="vspace" type=""
modifiers="final">
+ <doc>
+ <tag name="lzxtype"><text>String</text></tag>
+ <text></text>
+ </doc>
+ </property>
+ <property id="tag-img.__ivars__.width" name="width" type=""
modifiers="final">
+ <doc>
+ <tag name="lzxtype"><text>String</text></tag>
+ <text></text>
+ </doc>
+ </property>
+ </object>
+ </property>
+</class>
</property>
<property id="tag-p" topic="LZX" subtopic="HTML Markup" access="public">
@@ -185,6 +266,7 @@
</doc>
</property>
+
<!-- ================================================================ -->
<property id="tag-audio" topic="LZX" subtopic="Media" access="public">
<doc>
@@ -234,7 +316,7 @@
<property id="tag-face" topic="LZX" subtopic="Media" access="public">
<doc>
<tag name="shortdesc"><text></text></tag>
-<tag name="lzxname"><text><face></text></tag>
+<tag name="lzxname"><text>face</text></tag>
<text>
<p>Defines a font face or style within the font family that the
outer element defines.</p>
@@ -243,6 +325,25 @@
</p>
</text>
</doc>
+<class>
+ <property name="__ivars__">
+ <attribute name="id" select="$attrs-id"/>
+ <object>
+ <property id="tag-face.__ivars__.src" name="src" type=""
modifiers="final">
+ <doc>
+ <tag name="lzxtype"><text>URL</text></tag>
+ <text>The path of a file that contains the source for this
object.</text>
+ </doc>
+ </property>
+ <property id="tag-face.__ivars__.style" name="style" type=""
modifiers="final">
+ <doc>
+ <tag name="lzxtype"><text>bold | italic | bold italic | italic bold
| plain </text></tag>
+ <text>Corresponds to the fontstyle attribute of a view.</text>
+ </doc>
+ </property>
+ </object>
+ </property>
+</class>
</property>
<property id="tag-resource" topic="LZX" subtopic="Media" access="public">
@@ -282,7 +383,7 @@
<property id="tag-frame" topic="LZX" subtopic="Media" access="public">
<doc>
<tag name="shortdesc"><text>A frame of a multi-frame resource.</text></tag>
-<tag name="lzxname"><text><frame></text></tag>
+<tag name="lzxname"><text>frame</text></tag>
<text>
<p>The <tagname>frame</tagname> tag is used to define a single frame
of a multi-frame <tagname>resource</tagname>. A multi-frame resource
@@ -345,6 +446,25 @@
</text>
</doc>
+<class>
+ <property name="__ivars__">
+ <attribute name="id" select="$attrs-id"/>
+ <object>
+ <property id="tag-frame.__ivars__.name" name="name" type=""
modifiers="final">
+ <doc>
+ <tag name="lzxtype"><text>token</text></tag>
+ <text>The name of a variable that will be set to this object when
the application is started. If this element is directly within a
<tagname>canvas</tagname> or <tagname>library</tagname> element, the global
variable and the canvas property with this name will be set to this object. If
this element is within another object, that object's property with this name
will be set to this object.</text>
+ </doc>
+ </property>
+ <property id="tag-frame.__ivars__.src" name="src" type=""
modifiers="final">
+ <doc>
+ <tag name="lzxtype"><text>URL</text></tag>
+ <text>The path of a file that contains the source for this
object.</text>
+ </doc>
+ </property>
+ </object>
+ </property>
+</class>
</property>
</js2doc>
Modified: openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl
===================================================================
--- openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl 2008-03-08 16:03:28 UTC
(rev 8211)
+++ openlaszlo/trunk/docs/src/xsl/js2doc2dbk.xsl 2008-03-08 16:03:53 UTC
(rev 8212)
@@ -574,13 +574,7 @@
</informaltable>
</refsect2>
</xsl:if>
-
- <xsl:if test="count($visible-members) = 0">
- <refsect2><title>Events</title>
- <para>(no events found)</para>
- </refsect2>
- </xsl:if>
-
+
</xsl:template>
<xsl:template match="initarg|property" mode="describe-member">
@@ -985,7 +979,7 @@
</refsect1>
</xsl:if>
- <xsl:if test="child::class">
+ <xsl:if test="child::[EMAIL PROTECTED]">
<refsect1>
<xsl:text>Extends </xsl:text>
<xsl:call-template name="describe-superclass-chain">
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
