Author: julien(a)jboss.com
Date: 2007-01-23 09:42:13 -0500 (Tue, 23 Jan 2007)
New Revision: 6077
Modified:
trunk/core/src/resources/dtd/jboss-portlet_2_6.dtd
Log:
dtd for jboss-portlet.xml 2.6
Modified: trunk/core/src/resources/dtd/jboss-portlet_2_6.dtd
===================================================================
--- trunk/core/src/resources/dtd/jboss-portlet_2_6.dtd 2007-01-23 14:36:09 UTC (rev 6076)
+++ trunk/core/src/resources/dtd/jboss-portlet_2_6.dtd 2007-01-23 14:42:13 UTC (rev 6077)
@@ -23,7 +23,8 @@
~ 02110-1301 USA, or see the FSF site:
http://www.fsf.org. ~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-->
-<!--
+<!-- The additional configuration elements of the JBoss portlet container.
+
<!DOCTYPE jboss-web PUBLIC
"-//JBoss Portal//DTD JBoss Portlet 2.6//EN"
"http://www.jboss.org/portal/dtd/jboss-portlet_2_6.dtd">
@@ -40,12 +41,31 @@
<!--
Additional configuration for a portlet.
+The portlet-name defines the name of the portlet. It must match a portlet defined already
in portlet.xml
+of the same web application.
+
+The remotable element configures the portlet exposure to WSRP. If no value is present
then the value considered
+is either the value defined globally at the portlet application level or false.
+
+The trans-attribute value specifies the behavior of the portlet when it is invoked at
runtime with
+respect to the transactionnal context. According to how the portlet is invoked a
transaction may exist or not
+before the portlet is invoked. Usually in the local context the portal transaction could
be present.
+By default the value considered is NotSupported which means that the portal transaction
will be suspended
+for the duration of the portlet invocation.
+
+Example :
+
+<portlet>
+ <portlet-name>MyPortlet</portlet-name>
+ <remotable>true</remotable>
+ <trans-attribute>Required</trans-attribute>
+</portlet>
+
-->
<!ELEMENT portlet (portlet-name,remotable?,trans-attribute?)>
<!--
-The portlet name defines the name of the portlet. It must match a portlet defined already
in portlet.xml
-of the same web application.
+The portlet name.
-->
<!ELEMENT portlet-name (#PCDATA)>
@@ -55,11 +75,7 @@
<!ELEMENT remotable (#PCDATA)>
<!--
-The trans-attribute value specifies the behavior of the portlet when it is invoked at
runtime with
-respect to the transactionnal context. The accepted values are Required, Mandatory,
Never, Supports,
-NotSupported and RequiresNew. According to how the portlet is invoked a transaction may
exist or not
-before the portlet is invoked. Usually in the local context the portal transaction could
be present.
-By default the value considered is NotSupported which means that the portal transaction
will be suspended
-for the duration of the portlet invocation.
+The trans-attribute value defines the transactionnal behavior. The accepted values are
Required,
+Mandatory, Never, Supports, NotSupported and RequiresNew.
-->
<!ELEMENT trans-attribute (#PCDATA)>