Author: mmcallis
Date: 2008-04-01 00:31:25 -0400 (Tue, 01 Apr 2008)
New Revision: 10444
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml
Log:
6.2.4. The portlet.xml Descriptor
- revising content
Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-04-01
03:10:40 UTC (rev 10443)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-04-01
04:31:25 UTC (rev 10444)
@@ -316,7 +316,7 @@
</supports>]]></screen></term>
<listitem>
<para>
- The <computeroutput><supports></computeroutput> element
allows you to declare all of the markup types that your portlet supports in the
<literal>render</literal> method. This is accomplished via the
+ The <computeroutput><supports></computeroutput> element
declares all of the markup types that your portlet supports in the
<literal>render</literal> method. This is accomplished via the
<computeroutput><mime-type></computeroutput> element, which
is required for every portlet. The declared MIME types must match the capability of the
portlet. As well, it allows you to pair which modes and window states are supported for
each markup type. All portlets must support the
<computeroutput>view</computeroutput> portlet mode, so this does not have to
be declared. Use the
<computeroutput><mime-type></computeroutput> element to define
which markup type your portlet supports, which in this example, is
<computeroutput>text/html</computeroutput>. This section tells the portal that
it only outputs text and HTML, and that it only supports the
<computeroutput>view</computeroutput> mode.
</para>
</listitem>
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
03:10:40 UTC (rev 10443)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-04-01
04:31:25 UTC (rev 10444)
@@ -1161,7 +1161,10 @@
</listitem>
<listitem>
<para>
-
<programlisting><![CDATA[<deployment><instance>...</instance></deployment>]]></programlisting>
+<programlisting><![CDATA[
+<deployment>
+ <instance>...</instance>
+</deployment>]]></programlisting>
</para>
<para>
The <computeroutput><deployment></computeroutput> element,
and the embedded <computeroutput><instance></computeroutput>
element, specify a portlet instance. The
<computeroutput><deployment></computeroutput> element specifies
object deployments, such as portals, pages, windows, and so on. The
<computeroutput><instance></computeroutput> element is used to
create instances of portlets. The portlet will only be created and configured if the
portlet is present, and an instance with the same name does not already exist.
@@ -1185,7 +1188,10 @@
</listitem>
<listitem>
<para>
-
<programlisting><![CDATA[<preferences><preference>...</preference></preferences>]]></programlisting>
+<programlisting><![CDATA[
+<preferences>
+ <preference>...</preference>
+</preferences>]]></programlisting>
</para>
<para>
The <computeroutput><preference></computeroutput> element
configures a preference as a key-value pair. This value can be composed of a single string
value, for example, the preference <emphasis>fruit</emphasis> can have the
<emphasis>apple</emphasis> value. As well, this value can be composed of
multiple strings, for example, the preference <emphasis>fruits</emphasis> can
have values of <emphasis>apple</emphasis>,
<emphasis>orange</emphasis>, and <emphasis>kiwi</emphasis>:
@@ -1472,40 +1478,60 @@
</listitem>
<listitem>
<para>
-
<programlisting><![CDATA[<init-param><name>...</name><value>...</value></init-param>]]></programlisting>
+ <programlisting><![CDATA[
+<init-param>
+ <name>...</name>
+ <value>...</value>
+</init-param>]]></programlisting>
</para>
<para>
- Use the <computeroutput><init-param></computeroutput>
element to specify initialization parameters to create an initial state inside your
portlet class. This is used in the portlet's <emphasis>init()</emphasis>
method. Multiple <computeroutput><init-param></computeroutput>
elements can be used.
+ The <computeroutput><init-param></computeroutput> element
specifies initialization parameters to create an initial state inside your portlet class.
This is used in the portlet's <emphasis>init()</emphasis> method. Multiple
<computeroutput><init-param></computeroutput> elements can be
used.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<supports>...</supports>]]></programlisting>
- Here, you would advertise the supported
<emphasis>mime-type</emphasis> and supported
- <emphasis>portlet-modes</emphasis> for this portlet.
+ </para>
+ <para>
+ The <computeroutput><supports></computeroutput> element
declares all of the markup types that your portlet supports. Use the
<computeroutput><mime-type></computeroutput> element to declare
supported capabilities, for example, if the only outputs are text and HTML, use
<computeroutput><mime-type>text/html</mime-type></computeroutput>.
Use the <computeroutput><portlet-mode></computeroutput> element
to define the supported portlet modes for the portlet. For example, all portlets must
support <computeroutput>view</computeroutput> portlet mode, which is defined
using
<computeroutput><portlet-mode>view</portlet-mode></computeroutput>.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<supported-locale>...</supported-locale>]]></programlisting>
- Here, you would advertise the supported locales for this portlet.
Several locales can be specified.
+ </para>
+ <para>
+ The <computeroutput><supported-locale></computeroutput>
elements advertise the supported locales for the portlet. Use multiple
<computeroutput><supported-locale></computeroutput> elements to
specify multiple locales.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<resource-bundle>...</resource-bundle>]]></programlisting>
- The resource bundle that will containing the localized information
for the specified locales.
+ </para>
+ <para>
+ The <computeroutput><resource-bundle></computeroutput>
element contains the localized information for the specified locales.
</para>
</listitem>
<listitem>
<para>
-
<programlisting><![CDATA[<portlet-info><title>...</title></portlet-info>]]></programlisting>
- The portlet title that will be displayed in the portlet window's
title bar.
+ <programlisting><![CDATA[
+<portlet-info>
+ <title>...</title>
+</portlet-info>]]></programlisting>
</para>
+ <para>
+ The <computeroutput><title></computeroutput> element
defines the portlet's title, which is displayed in the portlet window's title
bar.
+ </para>
</listitem>
</itemizedlist>
- <note>This is a simple portlet.xml primer, and is not meant as a
replacement for what is covered in the
- actual Portlet specification.</note>
+ </para>
+ <para>
+ <warning>
+ <title>The <filename>portlet.xml</filename>
Example</title>
+ <para>
+ This <filename>portlet.xml</filename> example is not a replacement for
what is covered in the JSR-168 Portlet Specification.
+ </para>
+ </warning>
</para>
</sect2>
</sect1>
Show replies by date