Author: mmcallis
Date: 2008-02-11 02:52:14 -0500 (Mon, 11 Feb 2008)
New Revision: 9934
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml
Log:
minor rivisions to 5.2.1.4. Application Descriptors
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-02-11
04:56:13 UTC (rev 9933)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-11
07:52:14 UTC (rev 9934)
@@ -297,7 +297,7 @@
<portlet-name>HelloWorldPortlet</portlet-name>]]></screen></term>
<listitem>
<para>
- Define the portlet name. It does not have to be the Class name.
+ Define the portlet name. It does not have to be the class name.
</para>
</listitem>
</varlistentry>
@@ -318,11 +318,8 @@
<para>
The <literal><supports></literal> element allows you to
declare all the markup types your
portlet supports in the <literal>render</literal> method. This is
accomplished via the
- <literal><mime-type></literal> element, which is required for
every portlet. The declared MIME types must match the capability of the portlet.
+ <literal><mime-type></literal> 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 VIEW portlet mode, so this does not have to be declared. Use
<literal><mime-type></literal> to define which markup type your
portlet supports, which in this example, is <literal>text/html</literal>. This
section tells the portal that it will only output text and HTML, and that it only supports
the VIEW mode.
</para>
- <para>
- As well, it allows you to pair which modes and window states are supported for each
markup type. All portlets must support the VIEW portlet mode, so this does not have to be
declared. Use <literal><mime-type></literal> to define which
markup type your portlet supports, which in this example, is
<literal>text/html</literal>. This section tells the portal that it will only
output text and HTML, and that it only supports the VIEW mode.
- </para>
</listitem>
</varlistentry>
<varlistentry><term><screen><![CDATA[
@@ -337,14 +334,15 @@
</varlistentry>
</variablelist>
</para>
-<para>
<para>
The <filename>HelloWorldPortlet/WEB-INF/portlet-instances.xml</filename>
file is a JBoss Portal specific descriptor, that allows you to create instances of
portlets. The
<literal><portlet-ref></literal> value must match the
<literal><portlet-name></literal> value
given in the <filename>HelloWorldPortlet/WEB-INF/portlet.xml</filename>
file. The <literal><instance-id></literal>
- value can be named anything, but it must match the
<literal><instance-ref></literal> values given
- in the <literal>*-object.xml</literal> files, which in this example, would
be <filename>HelloWorldPortlet/WEB-INF/helloworld-object.xml</filename>.
-</para>The following is an example of the
<filename>HelloWorldPortlet/WEB-INF/portlet-instances.xml</filename> file:
+ value can be named anything, but it must match the
<literal><instance-ref></literal> value given
+ in the <literal>*-object.xml</literal> files, which in this example, would
be the <filename>HelloWorldPortlet/WEB-INF/helloworld-object.xml</filename>
file.
+ </para>
+<para>
+ The following is an example of the
<filename>HelloWorldPortlet/WEB-INF/portlet-instances.xml</filename> file:
</para>
<para>
<screen><![CDATA[
@@ -376,7 +374,7 @@
</listitem>
<listitem>
<para>
- specifies that it will display the markup generated by the
<literal>HelloWorldPortletInstance</literal> portlet instance.
+ specifies that the window will display the markup generated by the
<literal>HelloWorldPortletInstance</literal> portlet instance.
</para>
</listitem>
<listitem>
@@ -386,7 +384,7 @@
</listitem>
<listitem>
<para>
- specifies where the window will appear on the page, by the
<computeroutput><region></computeroutput> element.
+ the <computeroutput><region></computeroutput> element
specifies where the window will appear on the page.
</para>
</listitem>
</itemizedlist>
@@ -421,8 +419,7 @@
</screen></term>
<listitem>
<para>
- Tells the portal where this portlet should appear. In this case,
<computeroutput>default.default</computeroutput> specifies that this portlet
should appear in the portal instance named <literal>default</literal> and the
page named
- <literal>default</literal>.
+ Tells the portal where this portlet should appear. In this case,
<computeroutput>default.default</computeroutput> specifies that the portlet
will appear in the portal instance named <literal>default</literal>, and on
the page named <literal>default</literal>.
</para>
</listitem>
</varlistentry>
@@ -431,7 +428,7 @@
</screen></term>
<listitem>
<para>
- Instructs the portal to overwrite or keep this object if it already exists. Possible
values are <literal>overwrite</literal> or
<literal>keep</literal>. <literal>overwrite</literal> will destroy
the existing object and create a new one based on the content of the deployment.
<literal>keep</literal> will maintain the existing object deployment or create
a new one if it does not yet exist.
+ Instructs the portal to overwrite or keep this object if it already exists. Possible
values are <literal>overwrite</literal> or
<literal>keep</literal>. The <literal>overwrite</literal> value
will destroy the existing object and create a new one based on the content of the
deployment. The <literal>keep</literal> option will maintain the existing
object deployment or create a new one if it does not exist.
</para>
</listitem>
</varlistentry>
@@ -449,8 +446,8 @@
</screen></term>
<listitem>
<para>
- The value of <literal>instance-ref</literal> must match the value of one of
the
- <literal>instance-id</literal> found in
<literal>portlet-instances.xml</literal>.
+ The value of <literal><instance-ref></literal> must match the
value of one of the
+ <literal><instance-id></literal> elements found in the
<filename>HelloWorldPortlet/WEB-INF/portlet-instances.xml</filename> file.
</para>
</listitem>
</varlistentry>
@@ -460,22 +457,23 @@
</screen></term>
<listitem>
<para>
- Specify the layout region and order this window will be found on the portal page.
+ Specifies the layout region, and the order this window will be found on the portal
page.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
-
- <para>
- To illustrate the relationship between the descriptors, we have provided
this simple diagram
+<para>
+ The following diagram illustrates the relationship between the
<filename>portlet.xml</filename>,
<filename>portlet-instances.xml</filename>, and
<filename>helloworld-object.xml</filename> descriptors:
+</para>
+<para>
<mediaobject>
<imageobject>
<imagedata align="center"
fileref="images/tutorials/first_portlet/desc_relationship.gif"
valign="middle"/>
</imageobject>
</mediaobject>
- </para>
+</para>
<para>
Portal 2.6 introduces the notion of <emphasis>content
type</emphasis>, which is a generic mechanism to