Author: mmcallis
Date: 2008-02-24 18:30:39 -0500 (Sun, 24 Feb 2008)
New Revision: 10100
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml
Log:
6. XML Descriptors
minor revisions, trying to remove passive voice...
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-02-24
18:33:20 UTC (rev 10099)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/xmldescriptors.xml 2008-02-24
23:30:39 UTC (rev 10100)
@@ -10,7 +10,7 @@
<title>XML Descriptors</title>
<sect1>
<title>Changes from previous releases</title>
- <para>The previous releases of JBoss Portal did not have an external schema
to validate the various XML descriptors; however, it was internally validated by the
portal. Since JBoss Portal 2.6, a Document Type Definition (DTD) has been provided to
validate descriptors.
+ <para>The previous releases of JBoss Portal did not have an external schema
to validate XML descriptors; however, they were internally validated by the portal. Since
JBoss Portal 2.6, a Document Type Definition (DTD) has been provided to validate
descriptors.
</para>
<para>
To use the DTD, add the following declaration to the start of the desired
descriptors:
@@ -24,7 +24,7 @@
</screen>
</para>
<para>
- If you do not use the DTD declaration, the previous mechanism for XML validation will
be used. The DTD is more strict, specifically with the order of XML elements. The
following is an example from a <filename>*-object.xml</filename> descriptor,
which will be valid if you are not using the DTD, but will be rejected if you are:
+ If you do not use the DTD declaration, the previous mechanism for XML validation is
used. The DTD is more strict, specifically with the order of XML elements. The following
is an example from a <filename>*-object.xml</filename> descriptor, which is
valid if you are not using the DTD, but will be rejected if you are:
</para>
<para>
<screen><![CDATA[
@@ -33,7 +33,7 @@
</screen>
</para>
<para>
- The correct element order, and one which would be valid against the DTD, would be
as follows:
+ The correct element order, and one which is valid against the DTD, is as
follows:
</para>
<para>
<screen><![CDATA[
@@ -102,7 +102,7 @@
</para>
<para>
The <computeroutput><trans-attribute></computeroutput>
element specifies the behavior of the portlet when it is invoked at runtime with respect
to the transactional context. Depending on how the portlet is
- invoked, a transaction may or may not exist before the portlet is invoked. The portal
transaction is usually present in the local context. The default value is
<computeroutput>NotSupported</computeroutput>, which means that the portal
transaction will be suspended for the duration of the session. Accepted values are
<computeroutput>Required</computeroutput>,
<computeroutput>Mandatory</computeroutput>,
<computeroutput>Never</computeroutput>,
<computeroutput>Supports</computeroutput>,
<computeroutput>NotSupported</computeroutput>, and
<computeroutput>RequiresNew</computeroutput>.
+ invoked, a transaction may or may not exist before the portlet is invoked. The portal
transaction is usually present in the local context. The default value is
<computeroutput>NotSupported</computeroutput>, which means that the portal
transaction will be suspended for the duration of the portlet's invocation. Accepted
values are <computeroutput>Required</computeroutput>,
<computeroutput>Mandatory</computeroutput>,
<computeroutput>Never</computeroutput>,
<computeroutput>Supports</computeroutput>,
<computeroutput>NotSupported</computeroutput>, and
<computeroutput>RequiresNew</computeroutput>.
</para>
<para>
The following is an example section from a
<filename>WEB-INF/portlet.xml</filename> file, which uses the
<computeroutput><portlet-name></computeroutput>,
<computeroutput><remotable></computeroutput>, and
<computeroutput><trans-attribute></computeroutput> elements:
@@ -202,12 +202,12 @@
</screen>
</para>
<para>
- The default value is <computeroutput>NotSupported</computeroutput>, which
means that the portal transaction will be suspended for the duration of the session.
Accepted values are <computeroutput>Required</computeroutput>,
<computeroutput>Mandatory</computeroutput>,
<computeroutput>Never</computeroutput>,
<computeroutput>Supports</computeroutput>,
<computeroutput>NotSupported</computeroutput>, and
<computeroutput>RequiresNew</computeroutput>.
+ The default value is <computeroutput>NotSupported</computeroutput>, which
means that the portal transaction will be suspended for the duration of the portlet's
invocation. Accepted values are <computeroutput>Required</computeroutput>,
<computeroutput>Mandatory</computeroutput>,
<computeroutput>Never</computeroutput>,
<computeroutput>Supports</computeroutput>,
<computeroutput>NotSupported</computeroutput>, and
<computeroutput>RequiresNew</computeroutput>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><screen><![CDATA[
-<!ELEMENT header-content (link | script | meta)*>]]>
+<!ELEMENT header-content (link|script|meta)*>]]>
</screen></term>
<listitem>
<para>
@@ -291,7 +291,7 @@
</screen>
</para>
<para>
- The <computeroutput><service-ref></computeroutput> defines
the reference to the service. In the JMX Microkernel environment, this consist of the JMX
name of the service MBean. For an MBean reference, if the domain is left out, then the
current domain of the portal is used.
+ The <computeroutput><service-ref></computeroutput> element
defines the reference to the service. In the JMX Microkernel environment, this consist of
the JMX name of the service MBean. For an MBean reference, if the domain is left out, then
the current domain of the portal is used.
</para>
</listitem>
</varlistentry>