You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tapestry.apache.org by hl...@apache.org on 2005/09/06 00:32:06 UTC
svn commit: r278873 - in /jakarta/tapestry/trunk: ./
framework/src/documentation/content/xdocs/tapestry/ComponentReference/
src/documentation/content/xdocs/
Author: hlship
Date: Mon Sep 5 15:31:59 2005
New Revision: 278873
URL: http://svn.apache.org/viewcvs?rev=278873&view=rev
Log:
Add documentation for the Describe component
Added:
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Describe.xml
Modified:
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Conditional.xml
jakarta/tapestry/trunk/src/documentation/content/xdocs/links.ent
jakarta/tapestry/trunk/src/documentation/content/xdocs/site.xml
jakarta/tapestry/trunk/status.xml
Modified: jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Conditional.xml
URL: http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Conditional.xml?rev=278873&r1=278872&r2=278873&view=diff
==============================================================================
--- jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Conditional.xml (original)
+++ jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Conditional.xml Mon Sep 5 15:31:59 2005
@@ -35,13 +35,13 @@
<p>
<strong>See also:</strong> <link href="&apiroot;/components/Conditional.html">org.apache.tapestry.components.Conditional</link>,
- <link href="site:If">If</link>,
- <link href="site:Else">Else</link>
+ &If;,
+ &Else;
</p>
<warning>
- This component has been deprecated; Tapestry 4.0 adds the '<link href="site:If">If</link>' component which
- allows conditionalized elements to be safely contained by form components.
+ This component has been deprecated; Tapestry 4.0 adds the &If; component which
+ allows conditionalized elements to be safely contained by &Form; components.
</warning>
@@ -93,7 +93,7 @@
<td> </td>
<td>
If specified and condition is satisfied, then the component behaves like
- an <link href="site:Any">Any</link>, emitting an open and close tag.
+ an &Any;, emitting an open and close tag.
Informal parameters are applied to the tag. If no element is
specified, informal parameters are ignored.
</td>
Added: jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Describe.xml
URL: http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Describe.xml?rev=278873&view=auto
==============================================================================
--- jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Describe.xml (added)
+++ jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Describe.xml Mon Sep 5 15:31:59 2005
@@ -0,0 +1,86 @@
+<?xml version="1.0"?>
+<!--
+ Copyright 2005 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "./dtd/document-v12.dtd"
+[
+ <!ENTITY projectroot '../../'>
+ <!ENTITY % links.ent SYSTEM "../../links.ent">
+ %links.ent;
+]>
+<document>
+ <header>
+ <title>Describe</title>
+ </header>
+
+ <body>
+
+<p>
+Used to produce an HTML description of an object; typically a table is rendered, and the object's
+properties are displayed in successive rows of the table. In some cases, a property may be described recursively.
+Simple objects may be described as strings. The behavior behind this is extensible, defined in terms
+of contributions to the
+<link href="&hivedoc;/config/tapestry.describe.DescribableStrategies">tapestry.describe.DescribableStrategies</link>
+configuration point.
+</p>
+
+<p>
+ This component is used internally by Tapestry as part of the default Exception page.
+</p>
+
+<p>
+ <strong>See also: <link href="&apiroot;/html/Describe.html">org.apache.tapestry.html.Describe</link>,
+ <link href="&hivedoc;/service/tapestry.describe.HTMLDescriber">tapestry.describe.HTMLDescriber</link>
+ </strong>
+</p>
+
+<section>
+ <title>Parameters</title>
+
+<table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+
+<tr>
+ <td>object</td> <td>any</td>
+ <td>in</td> <td>yes</td> <td/>
+ <td>The object to be described.</td>
+</tr>
+
+ </table>
+
+<p>
+ Body: <strong>removed</strong>
+</p>
+
+<p>
+ Informal parameters: <strong> forbidden</strong>
+</p>
+
+<p>
+ Reserved parameters: <em>none</em>
+</p>
+
+</section>
+
+</body>
+</document>
\ No newline at end of file
Modified: jakarta/tapestry/trunk/src/documentation/content/xdocs/links.ent
URL: http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/src/documentation/content/xdocs/links.ent?rev=278873&r1=278872&r2=278873&view=diff
==============================================================================
--- jakarta/tapestry/trunk/src/documentation/content/xdocs/links.ent (original)
+++ jakarta/tapestry/trunk/src/documentation/content/xdocs/links.ent Mon Sep 5 15:31:59 2005
@@ -129,8 +129,10 @@
<!ENTITY Checkbox '<link href="site:Checkbox">Checkbox</link>'>
<!ENTITY Conditional '<link href="site:Conditional">Conditional</link>'>
<!ENTITY Delegator '<link href="site:Delegator">Delegator</link>'>
+<!ENTITY Describe '<link href="site:Describe">Describe</link>'>
<!ENTITY DirectLink '<link href="site:DirectLink">DirectLink</link>'>
<!ENTITY ExceptionDisplay '<link href="site:ExceptionDisplay">ExceptionDisplay</link>'>
+<!ENTITY Else '<link href="site:Else">Else</link>'>
<!ENTITY ExternalLink '<link href="site:ExternalLink">ExternalLink</link>'>
<!ENTITY FieldLabel '<link href="site:FieldLabel">FieldLabel</link>'>
<!ENTITY Foreach '<link href="site:Foreach">Foreach</link>'>
@@ -140,6 +142,7 @@
<!ENTITY Hidden '<link href="site:Hidden">Hidden</link>'>
<!ENTITY ListEdit '<link href="site:ListEdit">ListEdit</link>'>
<!ENTITY LinkSubmit '<link href="site:LinkSubmit">LinkSubmit</link>'>
+<!ENTITY If '<link href="site:If">If</link>'>
<!ENTITY Image '<link href="site:Image">Image</link>'>
<!ENTITY ImageSubmit '<link href="site:ImageSubmit">ImageSubmit</link>'>
<!ENTITY Insert '<link href="site:Insert">Insert</link>'>
Modified: jakarta/tapestry/trunk/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/src/documentation/content/xdocs/site.xml?rev=278873&r1=278872&r2=278873&view=diff
==============================================================================
--- jakarta/tapestry/trunk/src/documentation/content/xdocs/site.xml (original)
+++ jakarta/tapestry/trunk/src/documentation/content/xdocs/site.xml Mon Sep 5 15:31:59 2005
@@ -83,6 +83,7 @@
<Conditional label="Conditional" href="Conditional.html"/>
<DatePicker label="DatePicker" href="DatePicker.html"/>
<Delegator label="Delegator" href="Delegator.html"/>
+ <Describe label="Describe" href="Describe.html"/>
<DirectLink label="DirectLink" href="DirectLink.html"/>
<ExceptionDisplay label="ExceptionDisplay" href="ExceptionDisplay.html"/>
<ExternalLink label="ExternalLink" href="ExternalLink.html"/>
Modified: jakarta/tapestry/trunk/status.xml
URL: http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/status.xml?rev=278873&r1=278872&r2=278873&view=diff
==============================================================================
--- jakarta/tapestry/trunk/status.xml (original)
+++ jakarta/tapestry/trunk/status.xml Mon Sep 5 15:31:59 2005
@@ -59,6 +59,7 @@
<action type="fix" dev="HLS" fixes-bug="TAPESTRY-613">Javascript problem with @LinkSubmit</action>
<action type="fix" dev="HLS" fixes-bug="TAPESTRY-386">Big overhaul of the Tapestry Inspector</action>
<action type="fix" dev="HLS" fixes-bug="TAPESTRY-626">Form component can render id tag twice</action>
+ <action type="add" dev="HLS">Add documentation for the Describe component</action>
</release>
<release version="4.0-beta-5" date="Aug 26 2005">
<action type="fix" dev="MB,HLS" fixes-bug="TAPESTRY-552">Improperly configured SerializableAdaptor (for DataSqueezer) prevents serialized objects from being de-serialized</action>
---------------------------------------------------------------------
To unsubscribe, e-mail: tapestry-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: tapestry-dev-help@jakarta.apache.org