raphael 2002/11/15 07:44:33
Modified: xdocs registry.xml registry_syntax.xml
Log:
Update to registry documentation. Should now be complete
Revision Changes Path
1.2 +5 -5 jakarta-jetspeed/xdocs/registry.xml
Index: registry.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/registry.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- registry.xml 13 Nov 2002 08:42:42 -0000 1.1
+++ registry.xml 15 Nov 2002 15:44:33 -0000 1.2
@@ -57,7 +57,7 @@
and provides access to the portal actions defined for the portlet, like
customization.
Only controls defined the Registry can be used in the user pages.
<p>
- For more information on controls, check out the <a href="">Jetspeed Layout
overview</a>.
+ For more information on controls, check out the <a
href="layout.html">Jetspeed Layout overview</a>.
</p>
</td>
</tr>
@@ -72,7 +72,7 @@
By default, all the controllers defined in the registry are available for
users to customize
their page layout.
<p>
- For more information on controllers, check out the <a href="">Jetspeed
Layout overview</a>.
+ For more information on controllers, check out the <a
href="layout.html">Jetspeed Layout overview</a>.
</p>
</td>
</tr>
@@ -85,7 +85,7 @@
The skins define the color schemes used by the portal on a specific user
page (or part
of a page)
<p>
- For more information on skins, check out the <a href="">Jetspeed Layout
overview</a>.
+ For more information on skins, check out the <a
href="layout.html">Jetspeed Layout overview</a>.
</p>
</td>
</tr>
@@ -99,7 +99,7 @@
this specific instance of Jetspeed. Working in cunjunction with the Clients
defintion,
it enables you to control how the different user-agents access your portal
<p>
- For more information on client handling, check out the <a href="">Client
detection</a>.
+ For more information on client handling, check out the <a
href="client-media.html">Client detection</a>.
</p>
</td>
</tr>
@@ -112,7 +112,7 @@
The clients definitions entries are used to describe user agent capabilities
and in
cunjunction with Media types information define how the clients access the
portal
<p>
- For more information on client handling, check out the <a href="">Client
detection</a>.
+ For more information on client handling, check out the <a
href="client-media.html">Client detection</a>.
</p>
</td>
</tr>
1.3 +282 -11 jakarta-jetspeed/xdocs/registry_syntax.xml
Index: registry_syntax.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/registry_syntax.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- registry_syntax.xml 13 Nov 2002 17:26:09 -0000 1.2
+++ registry_syntax.xml 15 Nov 2002 15:44:33 -0000 1.3
@@ -24,6 +24,7 @@
<li><a href="#Media">Media Types</a></li>
<li><a href="#Client">Clients</a></li>
<li><a href="#Security">Security entries</a></li>
+ <li><a href="#Strandard">Standard attributes</a></li>
</ul>
</section>
<section name="Registry">
@@ -222,7 +223,13 @@
<section name="Control">
<subsection name="Overview">
<p>
- The <code>portlet-control-entry</code> element defines
+ The <code>portlet-control-entry</code> element defines the available
+ <code>PortletControl</code> available to decorate the different portlets.
+ </p>
+ <p>
+ The <code>portlet-control-entry</code> definition is nearly identical
+ to those of instance type <code>portlet-entry</code>, expect that there's
+ no <code>category</code>, <code>url</code> or caching related attributes.
</p>
</subsection>
<subsection name="DTD">
@@ -256,14 +263,35 @@
]]></source>
</subsection>
<subsection name="Usage notes">
+ <p>
+ </p>
</subsection>
<subsection name="Examples">
+ <p>
+ A typical control defintion will use the default
<code>VelocityPortletControl</code>
+ and simply specify the associated template and working parameters.
+ </p>
+ <source><![CDATA[
+<portlet-control-entry name="TitlePortletControl">
+ <classname>org.apache.jetspeed.portal.controls.VelocityPortletControl</classname>
+ <parameter name="theme" value="jetspeed.vm"/>
+ <meta-info>
+ <title>Simple titled control</title>
+ </meta-info>
+ <media-type ref="html"/>
+ <media-type ref="wml"/>
+</portlet-control-entry>
+ ]]></source>
</subsection>
</section>
<section name="Controller">
<subsection name="Overview">
<p>
- The <code>portlet-controller-entry</code> element
+ The <code>portlet-controller-entry</code> element defines the available
+ <code>PortletController</code> that are used to lay out a pane content.
+ </p>
+ <p>
+ The syntax and usage of this element is exactly the same as the
<code>portlet-control-entry</code>
</p>
</subsection>
<subsection name="DTD">
@@ -285,19 +313,40 @@
]]></source>
</subsection>
<subsection name="Usage notes">
+ <p>
+ </p>
</subsection>
<subsection name="Examples">
+ <p>
+ A typical controller defintion will use the default
<code>VelocityPortletController</code>
+ and simply specify the associated template and working parameters.
+ </p>
+ <source><![CDATA[
+<portlet-controller-entry name="TwoColumns">
+
<classname>org.apache.jetspeed.portal.controllers.VelocityPortletController</classname>
+ <parameter name="template" value="multicolumn.vm" />
+ <parameter name="action" value="controllers.MultiColumnControllerAction" />
+ <parameter name="sizes" value="50%,50%" />
+ <parameter name="cols" value="2" />
+ <media-type ref="html"/>
+ <meta-info>
+ <title>Two columns (50/50)</title>
+ </meta-info>
+</portlet-controller-entry>
+ ]]></source>
</subsection>
</section>
<section name="Skin">
<subsection name="Overview">
<p>
- The <code>skin-entry</code> element
+ The <code>skin-entry</code> element defines the color scheme that can
be used to decorate
+ the portal pages. It contists of a simple named list of properties that can
be associated
+ to a portal or pane on a portal page.
</p>
</subsection>
<subsection name="DTD">
<source><![CDATA[
-<!ELEMENT skin-entry ( property+ )>
+<!ELEMENT skin-entry ( property+ )>
<!ATTLIST skin-entry
name ID #REQUIRED
hidden ( true | false ) "false" >
@@ -307,18 +356,120 @@
name CDATA #REQUIRED
value CDATA #REQUIRED
type (int | boolean | string | list) "string" >
-
]]></source>
</subsection>
<subsection name="Usage notes">
+ <p>
+ The following properties are currently used by the default controls and
controllers.
+ It's possible to freely add new properties.
+ </p>
+ <p>
+ These properties are only styling hints that may be disregarded by some
controls or
+ controllers.
+ </p>
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <th>text-color</th>
+ <td>The default text color for portlet content</td>
+ </tr>
+ <tr>
+ <th>background-color</th>
+ <td>The default background color for portlet context</td>
+ </tr>
+ <tr>
+ <th>title-text-color</th>
+ <td>The default text color within a control titlebar</td>
+ </tr>
+ <tr>
+ <th>title-background-color</th>
+ <td>The default background color within a control titlebar</td>
+ </tr>
+ <tr>
+ <th>highlight-text-color</th>
+ <td>The default text color for the selected pane title within a paned
titlebar</td>
+ </tr>
+ <tr>
+ <th>highlight-background-color</th>
+ <td>The default background color for the selected pane title within a
paned titlebar</td>
+ </tr>
+ <tr>
+ <th>title-style-class</th>
+ <td>The CSS class name for a control titlebar.</td>
+ </tr>
+ <tr>
+ <th>highlight-title-style-class</th>
+ <td>The CSS class name for the selected pane title within a paned
titlebar</td>
+ </tr>
+ <tr>
+ <th>controller-style-class</th>
+ <td>The CSS class name for a controller-managed content area </td>
+ </tr>
+ <tr>
+ <th>portlet-style-class</th>
+ <td>The CSS class name for a portlet area</td>
+ </tr>
+ <tr>
+ <th>content-style-class</th>
+ <td>The CSS class name for portlet content</td>
+ </tr>
+ <tr>
+ <th>tab-style-class</th>
+ <td>The CSS class name for a tabbed pane area</td>
+ </tr>
+ <tr>
+ <th>tab-title-style-class</th>
+ <td>The CSS class name for the title area in a tabbed pane</td>
+ </tr>
+ <tr>
+ <th>tab-content-style-class</th>
+ <td>The CSS class name for the content area in a tabbed pane</td>
+ </tr>
+ </table>
</subsection>
<subsection name="Examples">
+ <p>
+ This example presents the default skin definition used by the default
Jetspeed
+ portal.
+ </p>
+ <source><![CDATA[
+<skin-entry name="orange-grey">
+ <property name="text-color" value="#000000"/>
+ <property name="background-color" value="#ffffff"/>
+ <property name="title-text-color" value="#000000"/>
+ <property name="title-background-color" value="#dddddd"/>
+ <property name="title-style-class" value="TitleStyleClass"/>
+ <property name="highlight-text-color" value="#000000"/>
+ <property name="highlight-background-color" value="#FFCC00"/>
+ <property name="highlight-title-style-class" value="HighlightTitleStyleClass"/>
+ <property name="controller-style-class" value="ControllerStyleClass"/>
+ <property name="portlet-style-class" value="PortletStyleClass"/>
+ <property name="content-style-class" value="ContentStyleClass"/>
+ <property name="tab-style-class" value="TabStyleClass"/>
+ <property name="tab-title-style-class" value="TabTitleStyleClass"/>
+ <property name="tab-content-style-class" value="TabContentStyleClass"/>
+</skin-entry>
+ ]]></source>
</subsection>
</section>
<section name="Media">
<subsection name="Overview">
<p>
- The <code>media-type-entry</code> element
+ The <code>media-type-entry</code> element defines the media types
+ supported the portal instance.
+ </p>
+ <p>
+ These media types are defined by a MIME content type, an optional character
set
+ and an optional set of user agent capabilities required to correctly access
this
+ media type.
+ </p>
+ <p>
+ The media types are referenced by the <code>portlet-entry</code>,
+ <code>portlet-control-entry</code> and
<code>portlet-controller-entry</code> to
+ define when these entries can be used.
</p>
</subsection>
<subsection name="DTD">
@@ -331,22 +482,46 @@
name ID #REQUIRED
hidden ( true | false ) "false" >
-<!ELEMENT mime-type CDATA>
-<!ELEMENT character-set CDATA>
+<!ELEMENT mime-type CDATA>
+<!ELEMENT character-set CDATA>
<!ELEMENT capability-map ( capability* )>
-<!ELEMENT capability CDATA>
+<!ELEMENT capability CDATA>
]]></source>
</subsection>
<subsection name="Usage notes">
+ <p>
+ These elements needs to be ordered from most preferred to least preferred
+ for the client detection to work correctly.
+ </p>
+ <p>
+ For more information, see the <a href="client-media.html">Client media
detection</a>
+ document.
+ </p>
</subsection>
<subsection name="Examples">
+ <source><![CDATA[
+<media-type-entry name="html">
+ <mime-type>text/html</mime-type>
+ <character-set>UTF-8</character-set>
+ <meta-info>
+ <title>HTML</title>
+ <description>Rich HTML for HTML 4.0 compliants browsers</description>
+ </meta-info>
+ <capability-map>
+ <capability>HTML_TABLE</capability>
+ <capability>HTML_IMAGE</capability>
+ </capability-map>
+</media-type-entry>
+ ]]></source>
</subsection>
</section>
<section name="Client">
<subsection name="Overview">
<p>
- The <code>client-entry</code> element
+ The <code>client-entry</code> element, introduced in the Jetspeed release
1.4b2,
+ describes known user agents and their capabilities in handling the different
+ content-types.
</p>
</subsection>
<subsection name="DTD">
@@ -375,8 +550,48 @@
]]></source>
</subsection>
<subsection name="Usage notes">
+ <p>
+ These elements needs to be ordered from most preferred to least preferred
+ for the client detection to work correctly.
+ </p>
+ <p>
+ For more information, see the <a href="client-media.html">Client media
detection</a>
+ document.
+ </p>
</subsection>
<subsection name="Examples">
+ <source><![CDATA[
+<client-entry name="mozilla">
+ <user-agent-pattern>.*Mozilla/5.*</user-agent-pattern>
+ <manufacturer>Mozilla</manufacturer>
+ <model>Mozilla</model>
+ <version>1.1</version>
+ <mimetype-map>
+ <mimetype>text/html</mimetype>
+ <mimetype>text/xhtml</mimetype>
+ <mimetype>text/xml</mimetype>
+ </mimetype-map>
+ <capability-map>
+ <capability>HTML_3_2</capability>
+ <capability>HTML_4_0</capability>
+ <capability>HTML_JAVA</capability>
+ <capability>HTML_JAVA_JRE</capability>
+ <capability>HTML_JAVASCRIPT</capability>
+ <capability>HTML_TABLE</capability>
+ <capability>HTML_NESTED_TABLE</capability>
+ <capability>HTML_FORM</capability>
+ <capability>HTML_FRAME</capability>
+ <capability>HTML_IFRAME</capability>
+ <capability>HTML_IMAGE</capability>
+ <capability>HTML_CSS1</capability>
+ <capability>HTML_CSS2</capability>
+ <capability>HTML_CSSP</capability>
+ <capability>HTML_DOM_1</capability>
+ <capability>HTML_PLUGIN</capability>
+ <capability>HTTP_COOKIE</capability>
+ </capability-map>
+</client-entry>
+ ]]></source>
</subsection>
</section>
<section name="Security">
@@ -406,6 +621,9 @@
]]></source>
</subsection>
<subsection name="Usage notes">
+ <p>
+ See the <a href="security.html">Security system overview</a>
+ </p>
</subsection>
<subsection name="Examples">
<source><![CDATA[
@@ -424,5 +642,58 @@
]]></source>
</subsection>
</section>
-</body>
+ <section name="Standard">
+ <subsection name="Overview">
+ <p>
+ Several attributes and inner elements can be found in all registry entry
types
+ with similar semantics. This section describes these attributes and
elements.
+ </p>
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <th>hidden</th>
+ <td>attribute</td>
+ <td>
+ <p>
+ The <code>hidden</code> attribute that can be set on the registry
entries and
+ parameters to prevent them from being visible in a user browser.
+ </p>
+ <p>
+ Usage of this attribute should considered deprecated since the same
functionality
+ can be achieved better by using the <code>security</code> elements.
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <th>meta-info</th>
+ <td>element</td>
+ <td>
+ <p>
+ The <code>meta-info</code> element is used to describe properties of
the registry entry.
+ It can currently contains the 3 following sub-elements:
+ </p>
+ <ul>
+ <li>title</li>
+ <li>description</li>
+ <li>image</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <th>security-ref</th>
+ <td>element</td>
+ <td>
+ <p>
+ The <code>security-ref</code> element is used to describe access
rights on the registry
+ entry or parameter considered.
+ </p>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ </section></body>
</document>
--
To unsubscribe, e-mail: <mailto:jetspeed-dev-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:jetspeed-dev-help@;jakarta.apache.org>
