Author: mmcallis
Date: 2008-03-31 00:10:24 -0400 (Mon, 31 Mar 2008)
New Revision: 10422
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml
Log:
6.2.2. The portlet-instances.xml Descriptor
- periodic backup
- revising text
- adding text from previous sections
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-03-31
03:22:45 UTC (rev 10421)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-03-31
04:10:24 UTC (rev 10422)
@@ -376,7 +376,7 @@
</screen>
</para>
<para>
- The reference to the portlet, which is the name of the portlet. The
<computeroutput><portlet-ref></computeroutput> value must match
the <computeroutput><portlet-name></computeroutput> give in the
<filename>WEB-INF/portlet.xml</filename> file.
+ The <computeroutput><portlet-ref></computeroutput> element
defines the portlet that an instance will represent. The
<computeroutput><portlet-ref></computeroutput> value must match
the <computeroutput><portlet-name></computeroutput> given in the
<filename>WEB-INF/portlet.xml</filename> file.
</para>
<para>
<screen><![CDATA[
@@ -1003,6 +1003,8 @@
<listitem>
<para>
<programlisting><![CDATA[<deployments>...</deployments>]]></programlisting>
+ </para>
+ <para>
The <computeroutput><deployments></computeroutput>
element encapsulates the entire document, and is a container for
<computeroutput><deployment></computeroutput> elements. Multiple
deployments can be specified within the
<computeroutput><deployments></computeroutput> element.
</para>
</listitem>
@@ -1081,7 +1083,7 @@
</para>
<para>
<note>
- <title>Are <filename>*-object.xml</filename> descriptors
necessary?</title>
+ <title>Are <filename>*-object.xml</filename> descriptors
required?</title>
<para>
Technically, they are not. The portal object hierarchy, such as creating portals,
pages, instances, and organizing them on the page, can be defined using the management
portlet, which is accessible to JBoss Portal administrators.
</para>
@@ -1089,20 +1091,12 @@
</para>
</sect2>
<sect2 id="desc_instancesxml">
- <title>portlet-instances.xml</title>
- <para>This is a JBoss Portal specific descriptor that allows a developer
to instantiate one-or-many instances
- of one-or-many portlets. The benefit of using this technique, is to allow one
portlet to be instantiated
- several times with different preference parameters.
- <note>
- <emphasis>Is this descriptor mandatory?</emphasis>
- Technically, no, as you can define your portal object hierarchy (create
portals, pages, instances and
- organize them as you see fit) from the management portlet accessible to
Portal administrators.
- </note>
- Our example, below, has us instantiating two separate instances of the
- <emphasis>NewsPortlet</emphasis>
- with different preference parameters, one instance will draw a feed for
RedHat announcements and the other
- from McDonalds announcements.
- <programlisting><![CDATA[
+ <title>The <filename>portlet-instances.xml</filename>
Descriptor</title>
+ <para>
+ The <filename>portlet-instances.xml</filename> Descriptor is JBoss Portal
specific, and allows developers to instantiate one-or-many instances of one-or-many
portlets. The benifit of this allows one portlet to be instantiated several times, with
different prefence parameters. The following example instiantiates two separate instances
of the <computeroutput>NewsPorlet</computeroutput>, both using different
parameters. One instance draws feeds for Red Hat annoucnments, and the other draws
McDonalds announcements:
+ </para>
+ <para>
+<screen><![CDATA[
<?xml version="1.0" standalone="yes"?>
<!DOCTYPE deployments PUBLIC
"-//JBoss Portal//DTD Portlet Instances 2.6//EN"
@@ -1153,48 +1147,41 @@
</instance>
</deployment>
</deployments>
-]]></programlisting>
+]]></screen>
+ </para>
+ <para>
<itemizedlist>
- <listitem>
+ <listitem>
+ <para>
+
<programlisting><![CDATA[<deployments>...</deployments>]]></programlisting>
+ </para>
+ <para>
+ The <computeroutput><deployments></computeroutput>
element encapsulates the entire document, and is a container for
<computeroutput><deployment></computeroutput> elements. Multiple
deployments can be specified within the
<computeroutput><deployments></computeroutput> element.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+
<programlisting><![CDATA[<deployment><instance>...</instance></deployment>]]></programlisting>
+ </para>
+ <para>
+ The <computeroutput><deployment></computeroutput>, and
the embedded <computeroutput><instance></computeroutput>
elements, specify a portlet instance. The
<computeroutput><deployment></computeroutput> element specifies
object deployments, such as portals, pages, windows, and so on.
+ </para>
+ </listitem>
+ <listitem>
<para>
-
<programlisting><![CDATA[<deployments>...</deployments>]]></programlisting>
- The
- <emphasis>deployments</emphasis>
- tag, encapsulates the entire document. You may specify more than one
portlet instance deployment,
- within this tag.
- </para>
- </listitem>
- <listitem>
- <para>
-
<programlisting><![CDATA[<deployment><instance>...</instance></deployment>]]></programlisting>
- The
- <emphasis>deployment</emphasis>
- , and embedded
- <emphasis>instance</emphasis>
- tags are used to specify one portlet instance.
- </para>
- </listitem>
- <listitem>
- <para>
<programlisting><![CDATA[<instance-id>...</instance-id>]]></programlisting>
- A
- <emphasis role="bold">unique name</emphasis>
- given to this instance of the portlet. It must correspond to the
value of
- <emphasis>instance-ref</emphasis>
- , assigned to the window in your
- <emphasis>*-object.xml</emphasis>
- .
+ </para>
+ <para>
+ The <computeroutput><instance-id></computeroutput>
elements defines a <emphasis role="bold">unique name</emphasis>
given to an instance of a portlet. The
<computeroutput><instance-id></computeroutput> value can be
named anything, but it must match the value of one of the
<computeroutput><instance-ref></computeroutput> elements in the
<filename>WEB-INF/*-object.xml</filename> file.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<portlet-ref>...</portlet-ref>]]></programlisting>
- The portlet that this instance will represent. It must correspond to
the value of
- <emphasis>portlet-name</emphasis>
- , assigned in your
- <emphasis>portlet.xml</emphasis>
- .
- </para>
+ </para>
+ <para>
+ The <computeroutput><portlet-ref></computeroutput> element
defines the portlet that an instance will represent. The
<computeroutput><portlet-ref></computeroutput> value must match
the <computeroutput><portlet-name></computeroutput> given in the
<filename>WEB-INF/portlet.xml</filename> file.
+ </para>
</listitem>
<listitem>
<para>
@@ -1270,6 +1257,12 @@
</imageobject>
</mediaobject>
</para>
+ <note>
+ <title>Is the <filename>portlet-instances.xml</filename> descriptor
required?</title>
+ <para>
+ Technically, they are not. The portal object hierarchy, such as creating portals,
pages, instances, and organizing them on the page, can be defined using the management
portlet, which is accessible to JBoss Portal administrators.
+ </para>
+ </note>
</sect2>
<sect2>
<title>jboss-portlet.xml</title>