Author: mmcallis
Date: 2008-02-10 18:26:50 -0500 (Sun, 10 Feb 2008)
New Revision: 9928
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml
Log:
5.2.1.4. Application Descriptors
adding an itemizedlist to describe what the
example object.xml file does
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-10
23:14:25 UTC (rev 9927)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-02-10
23:26:50 UTC (rev 9928)
@@ -321,7 +321,7 @@
<literal><mime-type></literal> element, which is required for
every portlet. The declared MIME types must match the capability of the portlet.
</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
decared. Define which markup type your porlet supports, which in this examepl 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.
+ 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>
@@ -357,16 +357,45 @@
</screen>
</para>
<para>
- This is a JBoss Portal specific descriptor that allows you to create instances of
portlets. The
+ This 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 <literal>*-object.xml</literal> files as we shall below.
+ in the <literal>*-object.xml</literal> files, which in this example, would
be <filename>HelloWorldPortlet/WEB-INF/helloworld-object.xml</filename>, as
shown below.
</para>
<para>
- The following is an example <filename>helloworld-object.xml</filename>
file:
+ The <literal>*-object.xml</literal> files are JBoss Portal specific
descriptors that allow users to
+ define the structure of their portal instances, as well as create and configure their
windows and
+ pages. In this example:
</para>
<para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ a portlet window is created.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ it is specified that it will display the markup generated by the
<literal>HelloWorldPortletInstance</literal> portlet instance.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ the window is assinged to the <literal>default.default</literal> page.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ specify where the window will appear on the page, by the
<computeroutput><region></computeroutput> element.
+ </para>
+ </listitem>
+ </itemizedlist>
+</para>
+<para>
+ The following is an example <filename>HelloWorldPortlet/WEB-INF</filename>
file:
+</para>
+<para>
<screen><![CDATA[<?xml version="1.0"
encoding="UTF-8"?>
<!DOCTYPE deployments PUBLIC
"-//JBoss Portal//DTD Portal Object 2.6//EN"
@@ -385,14 +414,8 @@
</deployments>]]>
</screen>
</para>
+
<para>
-<literal>*-object.xml</literal> files are JBoss Portal specific descriptors
and allow users to
-define the structure of their portal instances as well as create/configure their windows
and
-pages. In our example, we create a portlet window, specify that it will display the
markup
-generated by the <literal>HelloWorldPortletInstance</literal> portlet
instance, assign it to the
-<literal>default.default</literal> page, and specify where it should appear
on that page.
-</para>
-<para>
<variablelist>
<varlistentry><term><screen><![CDATA[
<parent-ref>default.default</parent-ref>]]>
Show replies by date