Author: mmcallis
Date: 2008-03-31 22:57:23 -0400 (Mon, 31 Mar 2008)
New Revision: 10442
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml
Log:
6.2.4. The portlet.xml Descriptor
- revising text
- periodic backup
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-01
00:57:20 UTC (rev 10441)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-01
02:57:23 UTC (rev 10442)
@@ -1391,10 +1391,10 @@
<sect2>
<title>The <filename>portlet.xml</filename>
Descriptor</title>
<para>
- The <filename>portlet.xml</filename> descriptor is the standard portlet
descriptor covered by the <ulink
url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet
Specification</ulink>. Developers are strongly encouraged to read the <ulink
url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet
Specification</ulink> items covering the correct use of this descriptor, as it is
oinly covered briefly in this section. Normally, the
<filename>portlet.xml</filename> descriptor is packaged inside your portlet
WAR file, alongside other the other descriptors in these sections. The following example
is a modified version of the JBoss Portal UserPortlet definition:
+ The <filename>portlet.xml</filename> descriptor is the standard portlet
descriptor covered by the <ulink
url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet
Specification</ulink>. Developers are strongly encouraged to read the <ulink
url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet
Specification</ulink> items covering the correct use of this descriptor, as it is
only covered briefly in these sections. Normally, the
<filename>portlet.xml</filename> descriptor is packaged inside your portlet
WAR file, alongside the other descriptors in these sections. The following example is a
modified version of the JBoss Portal UserPortlet definition:
</para>
<para>
- <programlisting><![CDATA[
+<screen><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<portlet-app
xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd"
@@ -1425,39 +1425,49 @@
<title>User portlet</title>
</portlet-info>
</portlet>
-</portlet-app>
-]]></programlisting>
+</portlet-app>]]>
+</screen>
+ </para>
+ <para>
<itemizedlist>
<listitem>
<para>
<programlisting><![CDATA[<portlet-app>...</portlet-app>]]></programlisting>
- The <emphasis>portlet-app</emphasis> tag, encapsulates
the entire document. You may specify more
- than one portlet, within this tag.
+ </para>
+ <para>
+ The <computeroutput><portlet-app></computeroutput>
element encapsulates the entire document. Multiple portlets can be specified using the
<computeroutput><portlet-app></computeroutput> element.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<portlet>...</portlet>]]></programlisting>
- The <emphasis>portlet</emphasis> tag is used to define
one portlet that is deployed within
- this archive.
+ </para>
+ <para>
+ The
<computeroutput><portlet></computeroutput> element defines one
portlet that is deployed within this archive.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<description>...</description>]]></programlisting>
- A verbal description of this portlet's function.
+ </para>
+ <para>
+ The <computeroutput><description></computeroutput> element
is a verbal description of the portlet's function.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<portlet-name>...</portlet-name>]]></programlisting>
- The name of this portlet, usually the class name, though it
doesn't have to be.
+ </para>
+ <para>
+ The <computeroutput><portlet-name></computeroutput>
element defines the portlet name. It does not have to be the class name.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<portlet-class>...</portlet-class>]]></programlisting>
- The fully-qualified name of this portlet class.
+ </para>
+ <para>
+ The <computeroutput><portlet-class></computeroutput>
element defines the Fully Qualified Name (FQN) of the portlet class.
</para>
</listitem>
<listitem>