Author: chris.laprun(a)jboss.com
Date: 2007-10-12 19:40:19 -0400 (Fri, 12 Oct 2007)
New Revision: 8624
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml
docs/trunk/referenceGuide/en/modules/xmldescriptors.xml
Log:
- Minor content improvements.
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 2007-10-12
21:06:39 UTC (rev 8623)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2007-10-12
23:40:19 UTC (rev 8624)
@@ -607,9 +607,13 @@
The *-object.xml file is used to define: portal instances, pages, windows,
window layout. Additionally,
you can also specify the themes and layouts used for specific portal
instances, pages, and windows. The
description below, only defines a portlet window being added to the default
page in the default portal. For
- advanced functionality, using this descriptor, please read
- <xref linkend="desc_examples"/>
- .
+ advanced functionality, using this descriptor, please read <xref
linkend="desc_examples"/>.
+
+ <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>
<programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE deployments PUBLIC
@@ -725,9 +729,8 @@
several times with different preference parameters.
<note>
<emphasis>Is this descriptor mandatory?</emphasis>
- Technically, no, as you can deploy your portlet without this descriptor
AND without the *-object.xml and
- then use the management portlet to create instances, assign the instances
to windows, and then assign the
- windows to pages.
+ 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>
@@ -904,8 +907,13 @@
</sect2>
<sect2>
<title>jboss-portlet.xml</title>
- <para>This descriptor is not mandatory, but is useful when having to add
JBoss-Specific contexts to your
- portlet descriptor. It would normally be packaged inside your portlet war,
alongside the other descriptors
+ <note>
+ <emphasis>Is this descriptor mandatory?</emphasis>
+ Technically, no, but might be required to access JBoss-specific functionality
that is not covered by the
+ Portlet specification.
+ </note>
+ <para>This descriptor is useful when you need to access JBoss-specific
functionality within your portlet
+ application. It would normally be packaged inside your portlet war, alongside
the other descriptors
in this section.</para>
<sect3>
<title>Injecting Header Content</title>
@@ -943,7 +951,7 @@
<service-ref>:service=Module,type=User</service-ref>
</service>
</portlet-app>]]></programlisting>
- Injects the UserModule service in to the portlet context, allowing a
portlet to then leverage the
+ Injects the UserModule service as an attribute to the portlet context,
allowing a portlet to then leverage the
service. For example:
<programlisting><![CDATA[
UserModule userModule = (UserModule)
getPortletContext().getAttribute("UserModule");
@@ -953,18 +961,39 @@
</para>
</sect3>
<sect3>
+ <title>Defining extra portlet information</title>
+ <para>Since JBoss Portal 2.6.3, icons can be defined for a portlet.
+ <programlisting><![CDATA[
+<?xml version="1.0" standalone="yes"?>
+<!DOCTYPE portlet-app PUBLIC
+ "-//JBoss Portal//DTD JBoss Portlet 2.6//EN"
+ "http://www.jboss.org/portal/dtd/jboss-portlet_2_6.dtd">
+<portlet-app>
+ <portlet>
+ <portlet-name>ManagementPortlet</portlet-name>
+ <portlet-info>
+ <icon>
+ <small-icon>/images/smallIcon.png</small-icon>
+ <large-icon>/images/largeIcon.png</small-icon>
+ </icon>
+ </portlet-info>
+ </portlet>
+</portlet-app>]]></programlisting>
+ The reference can be absolute
(
http://www.example.com/images/smallIcon.png) or relative to the webapp
+ context if starting with a '/'. Those icons can be used by
different parts of the portal User Interface.
+ </para>
+ </sect3>
+ <sect3>
<title>Portlet Session Replication in a Clustered
Environment</title>
</sect3>
- <para>See
- <xref linkend="portlet_session_replication"/>
- </para>
+ <para>See <xref
linkend="portlet_session_replication"/>.</para>
</sect2>
<sect2>
<title>portlet.xml</title>
<para>This is the standard portlet descriptor covered by the JSR-168
Specification. It is
advisable that developers read the specification items covering proper use of
this descriptor, as it is only
- covered here briefly. For example purposes, we use an editted version of our
JBoss Portal UserPortlet
- definition. Normally, you would package this descriptor in your portlet war.
+ covered here briefly. For example purposes, we use an edited version of our
JBoss Portal UserPortlet
+ definition. Normally, you would package this descriptor in your portlet WAR
file.
<programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<portlet-app
@@ -1002,68 +1031,60 @@
<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.
+ The <emphasis>portlet-app</emphasis> tag, encapsulates
the entire document. You may specify more
+ than one portlet, within this tag.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<portlet>...</portlet>]]></programlisting>
- The
- <emphasis>portlet</emphasis>
- tag is used to define one portlet that is deployed withing this
archive.
+ The <emphasis>portlet</emphasis> tag is used to define
one portlet that is deployed within
+ this archive.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<description>...</description>]]></programlisting>
- A verbal description of tis portlet's function.
+ A verbal description of this portlet's function.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<portlet-name>...</portlet-name>]]></programlisting>
- The name of this portlet, usually the class name
+ The name of this portlet, usually the class name, though it
doesn't have to be.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<portlet-class>...</portlet-class>]]></programlisting>
- The fully-qualified-name of this portlet class.
+ The fully-qualified name of this portlet class.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<init-param><name>...</name><value>...</value></init-param>]]></programlisting>
- Using the
- <emphasis>init-param</emphasis>
- tag, you can specify initialization parameters to create initial
state inside your portlet class.
- Normally, they would be used in the portlet's
- <emphasis>init()</emphasis>
- method. You can specify more than one init-param.
+ Using the <emphasis>init-param</emphasis> tag, you can
specify initialization parameters to create
+ initial state inside your portlet class. Normally, they would be
used in the portlet's
+ <emphasis>init()</emphasis> method. You can specify more
than one init-param.
</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.
+ Here, you would advertise the supported
<emphasis>mime-type</emphasis> and supported
+ <emphasis>portlet-modes</emphasis> for this portlet.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<supported-locale>...</supported-locale>]]></programlisting>
- Here, you would advertise the supported locales for this portlet.
You can specify many.
+ Here, you would advertise the supported locales for this portlet.
Several locales can be specified.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<resource-bundle>...</resource-bundle>]]></programlisting>
- The resource bundle that will back the locales specified.
+ The resource bundle that will containing the localized information
for the specified locales.
</para>
</listitem>
<listitem>
Modified: docs/trunk/referenceGuide/en/modules/xmldescriptors.xml
===================================================================
--- docs/trunk/referenceGuide/en/modules/xmldescriptors.xml 2007-10-12 21:06:39 UTC (rev
8623)
+++ docs/trunk/referenceGuide/en/modules/xmldescriptors.xml 2007-10-12 23:40:19 UTC (rev
8624)
@@ -607,9 +607,13 @@
The *-object.xml file is used to define: portal instances, pages, windows,
window layout. Additionally,
you can also specify the themes and layouts used for specific portal
instances, pages, and windows. The
description below, only defines a portlet window being added to the default
page in the default portal. For
- advanced functionality, using this descriptor, please read
- <xref linkend="desc_examples"/>
- .
+ advanced functionality, using this descriptor, please read <xref
linkend="desc_examples"/>.
+
+ <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>
<programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE deployments PUBLIC
@@ -725,9 +729,8 @@
several times with different preference parameters.
<note>
<emphasis>Is this descriptor mandatory?</emphasis>
- Technically, no, as you can deploy your portlet without this descriptor
AND without the *-object.xml and
- then use the management portlet to create instances, assign the instances
to windows, and then assign the
- windows to pages.
+ 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>
@@ -904,8 +907,13 @@
</sect2>
<sect2>
<title>jboss-portlet.xml</title>
- <para>This descriptor is not mandatory, but is useful when having to add
JBoss-Specific contexts to your
- portlet descriptor. It would normally be packaged inside your portlet war,
alongside the other descriptors
+ <note>
+ <emphasis>Is this descriptor mandatory?</emphasis>
+ Technically, no, but might be required to access JBoss-specific functionality
that is not covered by the
+ Portlet specification.
+ </note>
+ <para>This descriptor is useful when you need to access JBoss-specific
functionality within your portlet
+ application. It would normally be packaged inside your portlet war, alongside
the other descriptors
in this section.</para>
<sect3>
<title>Injecting Header Content</title>
@@ -943,7 +951,7 @@
<service-ref>:service=Module,type=User</service-ref>
</service>
</portlet-app>]]></programlisting>
- Injects the UserModule service in to the portlet context, allowing a
portlet to then leverage the
+ Injects the UserModule service as an attribute to the portlet context,
allowing a portlet to then leverage the
service. For example:
<programlisting><![CDATA[
UserModule userModule = (UserModule)
getPortletContext().getAttribute("UserModule");
@@ -971,24 +979,21 @@
</portlet-info>
</portlet>
</portlet-app>]]></programlisting>
- The reference can be absolute (
http://www.example.com/images/smallIcon.png) or
relative to the
- webapp context if starting with a '/'.
- Those icons can be used by different part of the portal User Interface.
+ The reference can be absolute
(
http://www.example.com/images/smallIcon.png) or relative to the webapp
+ context if starting with a '/'. Those icons can be used by
different parts of the portal User Interface.
</para>
</sect3>
<sect3>
<title>Portlet Session Replication in a Clustered
Environment</title>
</sect3>
- <para>See
- <xref linkend="portlet_session_replication"/>
- </para>
+ <para>See <xref
linkend="portlet_session_replication"/>.</para>
</sect2>
<sect2>
<title>portlet.xml</title>
<para>This is the standard portlet descriptor covered by the JSR-168
Specification. It is
advisable that developers read the specification items covering proper use of
this descriptor, as it is only
- covered here briefly. For example purposes, we use an editted version of our
JBoss Portal UserPortlet
- definition. Normally, you would package this descriptor in your portlet war.
+ covered here briefly. For example purposes, we use an edited version of our
JBoss Portal UserPortlet
+ definition. Normally, you would package this descriptor in your portlet WAR
file.
<programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<portlet-app
@@ -1026,68 +1031,60 @@
<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.
+ The <emphasis>portlet-app</emphasis> tag, encapsulates
the entire document. You may specify more
+ than one portlet, within this tag.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<portlet>...</portlet>]]></programlisting>
- The
- <emphasis>portlet</emphasis>
- tag is used to define one portlet that is deployed withing this
archive.
+ The <emphasis>portlet</emphasis> tag is used to define
one portlet that is deployed within
+ this archive.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<description>...</description>]]></programlisting>
- A verbal description of tis portlet's function.
+ A verbal description of this portlet's function.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<portlet-name>...</portlet-name>]]></programlisting>
- The name of this portlet, usually the class name
+ The name of this portlet, usually the class name, though it
doesn't have to be.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<portlet-class>...</portlet-class>]]></programlisting>
- The fully-qualified-name of this portlet class.
+ The fully-qualified name of this portlet class.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<init-param><name>...</name><value>...</value></init-param>]]></programlisting>
- Using the
- <emphasis>init-param</emphasis>
- tag, you can specify initialization parameters to create initial
state inside your portlet class.
- Normally, they would be used in the portlet's
- <emphasis>init()</emphasis>
- method. You can specify more than one init-param.
+ Using the <emphasis>init-param</emphasis> tag, you can
specify initialization parameters to create
+ initial state inside your portlet class. Normally, they would be
used in the portlet's
+ <emphasis>init()</emphasis> method. You can specify more
than one init-param.
</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.
+ Here, you would advertise the supported
<emphasis>mime-type</emphasis> and supported
+ <emphasis>portlet-modes</emphasis> for this portlet.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<supported-locale>...</supported-locale>]]></programlisting>
- Here, you would advertise the supported locales for this portlet.
You can specify many.
+ Here, you would advertise the supported locales for this portlet.
Several locales can be specified.
</para>
</listitem>
<listitem>
<para>
<programlisting><![CDATA[<resource-bundle>...</resource-bundle>]]></programlisting>
- The resource bundle that will back the locales specified.
+ The resource bundle that will containing the localized information
for the specified locales.
</para>
</listitem>
<listitem>