JBoss Portal SVN: r11398 - docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules.
by portal-commits@lists.jboss.org
Author: mmcallis
Date: 2008-07-10 00:40:22 -0400 (Thu, 10 Jul 2008)
New Revision: 11398
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml
Log:
Chapter 6. XML Descriptors
- code highlighting
- moving from <screen> to <programlisting> for consistency
with other chapters
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-07-10 03:52:14 UTC (rev 11397)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-07-10 04:40:22 UTC (rev 11398)
@@ -2199,7 +2199,6 @@
<param-value>true</param-value>
</context-param>]]>
</programlisting>
- </para>
<para>
These extra parameters let the application server know that the portlet
embeds its own libraries. This avoids collision with the Sun JSF RI
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml 2008-07-10 03:52:14 UTC (rev 11397)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml 2008-07-10 04:40:22 UTC (rev 11398)
@@ -1,4 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter id="xmldescriptors">
<chapterinfo>
<author>
@@ -14,32 +16,26 @@
<para>
To use the DTD, add the following declaration to the start of the desired descriptors:
</para>
- <para>
-<screen><![CDATA[
+<programlisting role="XML"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE deployments PUBLIC
"-//JBoss Portal//DTD Portal Object 2.6//EN"
"http://www.jboss.org/portal/dtd/portal-object_2_6.dtd">]]>
-</screen>
- </para>
+</programlisting>
<para>
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 is rejected if you are:
</para>
- <para>
-<screen><![CDATA[
+ <programlisting role="XML"><![CDATA[
<if-exists>overwrite</if-exists>
<parent-ref>default.default</parent-ref>]]>
-</screen>
- </para>
+</programlisting>
<para>
The correct element order, and one which is valid against the DTD, is as follows:
</para>
- <para>
-<screen><![CDATA[
+<programlisting role="XML"><![CDATA[
<parent-ref>default.default</parent-ref>
<if-exists>overwrite</if-exists>]]>
-</screen>
- </para>
+</programlisting>
<para>
The following DTDs are available:
</para>
@@ -77,9 +73,9 @@
</para>
<para>
<variablelist>
- <varlistentry><term><screen><![CDATA[
+ <varlistentry><term><programlisting><![CDATA[
<!ELEMENT portlet-app (remotable?,portlet*,service*)>]]>
-</screen></term>
+</programlisting></term>
<listitem>
<para>
Use the <computeroutput><remotable></computeroutput> element to configure the default behavior of portlets with respect to WSRP exposure: if no value is given, the value is either the value globally defined at the portlet application level, or <computeroutput>false</computeroutput>. Accepted values are <computeroutput>true</computeroutput> and <computeroutput>false</computeroutput>.
@@ -89,10 +85,10 @@
</para>
</listitem>
</varlistentry>
-<varlistentry><term><screen><![CDATA[
+<varlistentry><term><programlisting><![CDATA[
<!ELEMENT portlet (portlet-name,remotable?,ajax?,session-config?,transaction?,
header-content?,portlet-info?)>]]>
-</screen></term>
+</programlisting></term>
<listitem>
<para>
Additional configuration of the portlet. The <computeroutput><portlet-name></computeroutput> element defines the portlet name. It must match a portlet defined in the <filename>WEB-INF/portlet.xml</filename> file for that application.
@@ -107,54 +103,44 @@
<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:
</para>
- <para>
-<screen><![CDATA[
+ <programlisting><![CDATA[
<portlet>
<portlet-name>MyPortlet</portlet-name>
<remotable>true</remotable>
<trans-attribute>Required</trans-attribute>
</portlet>]]>
-</screen>
- </para>
- <para>
-<screen><![CDATA[
+</programlisting>
+<programlisting><![CDATA[
<!ELEMENT portlet-name (#PCDATA)>]]>
-</screen>
- </para>
-
- <para>
+</programlisting><para>
The portlet name.
</para>
- <para>
-<screen><![CDATA[
+ <programlisting><![CDATA[
<!ELEMENT remotable (#PCDATA)>]]>
-</screen>
- </para>
+</programlisting>
<para>
Accepted values are <computeroutput>true</computeroutput> and <computeroutput>false</computeroutput>.
</para>
</listitem>
</varlistentry>
-<varlistentry><term><screen><![CDATA[
+<varlistentry><term><programlisting><![CDATA[
<!ELEMENT ajax (partial-refresh)>]]>
-</screen></term>
+</programlisting></term>
<listitem>
<para>
Use the <computeroutput>ajax</computeroutput> element to configure the Asynchronous JavaScript and XML (AJAX) capabilities of the portlet.
</para>
- <para>
-<screen><![CDATA[
+ <programlisting><![CDATA[
<!ELEMENT partial-refresh (#PCDATA)>]]>
-</screen>
- </para>
+</programlisting>
<para>
If a portlet uses the <computeroutput>true</computeroutput> value for the <computeroutput><partial-refresh></computeroutput> element, the portal uses partial-page refreshing and only renders that portlet. If the <computeroutput><partial-refresh></computeroutput> element uses a <computeroutput>false</computeroutput> value, the portal uses a full-page refresh when the portlet is refreshed.
</para>
</listitem>
</varlistentry>
-<varlistentry><term><screen><![CDATA[
+<varlistentry><term><programlisting><![CDATA[
<!ELEMENT session-config (distributed)>]]>
-</screen></term>
+</programlisting></term>
<listitem>
<para>
The <computeroutput><session-config></computeroutput> element configures the portlet session for the portlet. The <computeroutput><distributed></computeroutput> element instructs the container to distribute the session attributes using portal session replication. This only applies to local portlets, not remote portlets.
@@ -162,18 +148,14 @@
<para>
The following is an example of the <computeroutput><session-config></computeroutput> and <computeroutput><distributed></computeroutput> elements:
</para>
- <para>
-<screen><![CDATA[
+ <programlisting><![CDATA[
<session-config>
<distributed>true</distributed>
</session-config>]]>
-</screen>
- </para>
- <para>
-<screen><![CDATA[
+</programlisting>
+ <programlisting><![CDATA[
<!ELEMENT distributed (#PCDATA)>]]>
-</screen>
- </para>
+</programlisting>
<para>
Accepted values are <computeroutput>true</computeroutput> and <computeroutput>false</computeroutput>. The default value is <computeroutput>false</computeroutput>.
</para>
16 years, 3 months
JBoss Portal SVN: r11397 - docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules.
by portal-commits@lists.jboss.org
Author: mmcallis
Date: 2008-07-09 23:52:14 -0400 (Wed, 09 Jul 2008)
New Revision: 11397
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml
Log:
- code highlighting
- minor changes to screen/command examples to avoid mangled output
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-07-10 03:32:55 UTC (rev 11396)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-07-10 03:52:14 UTC (rev 11397)
@@ -1901,7 +1901,7 @@
</filename>
directory into the JBoss AS or JBoss EAP
<filename>deploy/</filename>
- directory. On Linux, run the <command>touch $JBOSS_HOME/server/ <replaceable>configuration</replaceable>/deploy/helloworldjsfsunriportlet.war/WEB-INF/web.xml</command> command to re-deploy the HelloWorldJSFSunRIPortlet.
+ directory. On Linux, run the <command>touch $JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldjsfsunriportlet.war/WEB-INF/web.xml</command> command to re-deploy the HelloWorldJSFSunRIPortlet.
</para>
<para>
Re-deploying the HelloWorldJSFSunRIPortlet produces output to the JBoss AS
@@ -2041,8 +2041,7 @@
Specification. You may define more than one portlet application in this
file:
</para>
- <para>
- <screen><![CDATA[
+ <programlisting role="XML"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -2065,15 +2064,14 @@
</portlet-info>
</portlet>
</portlet-app>]]>
- </screen>
- </para>
+ </programlisting>
<para>
<variablelist>
<varlistentry>
<term>
- <screen><![CDATA[
+ <programlisting><![CDATA[
<portlet-class>org.apache.myfaces.portlet.MyFacesGenericPortlet</portlet-class>]]>
- </screen>
+</programlisting>
</term>
<listitem>
<para>
@@ -2090,12 +2088,12 @@
</varlistentry>
<varlistentry>
<term>
- <screen><![CDATA[
+ <programlisting><![CDATA[
<init-param>
<name>default-view</name>
<value>/WEB-INF/jsp/index.jsp</value>
</init-param>]]>
- </screen>
+</programlisting>
</term>
<listitem>
<para>
@@ -2106,11 +2104,11 @@
</varlistentry>
<varlistentry>
<term>
- <screen><![CDATA[
+ <programlisting><![CDATA[
<supports>
<mime-type>text/html</mime-type>
<portlet-mode>view</portlet-mode>
-</supports>]]></screen>
+</supports>]]></programlisting>
</term>
<listitem>
<para>
@@ -2154,8 +2152,7 @@
<filename>HelloWorldJSFMyFaces42Portlet/WEB-INF/faces-config.xml</filename>
file:
</para>
- <para>
- <screen><![CDATA[
+ <programlisting role="XML"><![CDATA[
<?xml version="1.0"?>
<!DOCTYPE faces-config PUBLIC
"-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.0//EN"
@@ -2175,8 +2172,7 @@
</navigation-case>
</navigation-rule>
</faces-config>]]>
- </screen>
- </para>
+ </programlisting>
<para>
Without the
<filename>faces-config.xml</filename>
@@ -2197,13 +2193,12 @@
<filename>HelloWorldJSFMyFaces42Portlet/WEB-INF/web.xml</filename>
file:
</para>
- <para>
- <screen><![CDATA[
+ <programlisting role="XML"><![CDATA[
<context-param>
<param-name>org.jboss.jbossfaces.WAR_BUNDLES_JSF_IMPL</param-name>
<param-value>true</param-value>
</context-param>]]>
- </screen>
+ </programlisting>
</para>
<para>
These extra parameters let the application server know that the portlet
@@ -2385,16 +2380,9 @@
</filename>
directory into the JBoss AS or JBoss EAP
<filename>deploy/</filename>
- directory. On Linux, run the following command to re-deploy the
- HelloWorldJSFMyFaces42Portlet:
+ directory. On Linux, run the <command>touch $JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldjsfmyfacesportlet.war/WEB-INF/web.xml</command> command to re-deploy the
+ HelloWorldJSFMyFaces42Portlet.
</para>
- <para>
- <screen>
- touch $JBOSS_HOME/server/
- <replaceable>configuration</replaceable>
- /deploy/helloworldjsfmyfacesportlet.war/WEB-INF/web.xml
- </screen>
- </para>
</sect3>
</sect2>
<!-- sect2>
16 years, 3 months
JBoss Portal SVN: r11396 - docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules.
by portal-commits@lists.jboss.org
Author: mmcallis
Date: 2008-07-09 23:32:55 -0400 (Wed, 09 Jul 2008)
New Revision: 11396
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml
Log:
moving command out of screen to avoid mangling
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-07-10 03:23:44 UTC (rev 11395)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-07-10 03:32:55 UTC (rev 11396)
@@ -1552,14 +1552,13 @@
</portlet>
</portlet-app>]]>
</programlisting>
- </para>
<para>
<variablelist>
<varlistentry>
<term>
- <screen><![CDATA[
+ <programlisting><![CDATA[
<portlet-class>com.sun.faces.portlet.FacesPortlet</portlet-class>]]>
- </screen>
+</programlisting>
</term>
<listitem>
<para>
@@ -1578,12 +1577,12 @@
</varlistentry>
<varlistentry>
<term>
- <screen><![CDATA[
+ <programlisting><![CDATA[
<init-param>
<name>com.sun.faces.portlet.INIT_VIEW</name>
<value>/WEB-INF/jsp/index.jsp</value>
</init-param>]]>
- </screen>
+</programlisting>
</term>
<listitem>
<para>
@@ -1594,11 +1593,11 @@
</varlistentry>
<varlistentry>
<term>
- <screen><![CDATA[
+ <programlisting><![CDATA[
<supports>
<mime-type>text/html</mime-type>
<portlet-mode>view</portlet-mode>
-</supports>]]></screen>
+</supports>]]></programlisting>
</term>
<listitem>
<para>
@@ -1633,8 +1632,7 @@
<filename>HelloWorldJSFSunRIPortlet/WEB-INF/faces-config.xml</filename>
file:
</para>
- <para>
- <screen><![CDATA[
+ <programlisting role="XML"><![CDATA[
<?xml version="1.0"?>
<!DOCTYPE faces-config PUBLIC
"-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.0//EN"
@@ -1654,8 +1652,7 @@
</navigation-case>
</navigation-rule>
</faces-config>]]>
- </screen>
- </para>
+ </programlisting>
<para>
Without the
<filename>faces-config.xml</filename>
@@ -1678,8 +1675,7 @@
<filename>HelloWorldJSFSunRIPortlet/WEB-INF/web.xml</filename>
file:
</para>
- <para>
- <screen><![CDATA[
+ <programlisting role="XML"><![CDATA[
<?xml version="1.0"?>
<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
@@ -1701,8 +1697,7 @@
</servlet-mapping>
</web-app>]]>
- </screen>
- </para>
+ </programlisting>
<para>
For Sun JSF RI portlets, the
<computeroutput>Faces Servlet</computeroutput>
@@ -1906,17 +1901,9 @@
</filename>
directory into the JBoss AS or JBoss EAP
<filename>deploy/</filename>
- directory. On Linux, run the following command to re-deploy the
- HelloWorldJSFSunRIPortlet:
+ directory. On Linux, run the <command>touch $JBOSS_HOME/server/ <replaceable>configuration</replaceable>/deploy/helloworldjsfsunriportlet.war/WEB-INF/web.xml</command> command to re-deploy the HelloWorldJSFSunRIPortlet.
</para>
<para>
- <screen>
- touch $JBOSS_HOME/server/
- <replaceable>configuration</replaceable>
- /deploy/helloworldjsfsunriportlet.war/WEB-INF/web.xml
- </screen>
- </para>
- <para>
Re-deploying the HelloWorldJSFSunRIPortlet produces output to the JBoss AS
or JBoss EAP console, similar to the following:
</para>
16 years, 3 months
JBoss Portal SVN: r11395 - docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules.
by portal-commits@lists.jboss.org
Author: mmcallis
Date: 2008-07-09 23:23:44 -0400 (Wed, 09 Jul 2008)
New Revision: 11395
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml
Log:
Deploying your JSF portlet
- moving command out of screen to avoid mangling
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-07-10 03:15:45 UTC (rev 11394)
+++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-07-10 03:23:44 UTC (rev 11395)
@@ -1248,13 +1248,8 @@
</mediaobject>
</para>
<para>
- To re-deploy the portlet, for example, if you have made changes to any of the application descriptors, touch the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldjsfsunriportlet.war/WEB-INF/web.xml</filename> file. This only works if you copied the <filename>HelloWorldJSFSunRIPortlet/output/lib/exploded/helloworldjsfsunriportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. On Linux, run the following command to re-deploy the HelloWorldJSFSunRIPortlet:
+ To re-deploy the portlet, for example, if you have made changes to any of the application descriptors, touch the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldjsfsunriportlet.war/WEB-INF/web.xml</filename> file. This only works if you copied the <filename>HelloWorldJSFSunRIPortlet/output/lib/exploded/helloworldjsfsunriportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. On Linux, run the <command>touch $JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldjsfsunriportlet.war/WEB-INF/web.xml</command> command to re-deploy the HelloWorldJSFSunRIPortlet.
</para>
- <para>
-<screen>
-touch $JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldjsfsunriportlet.war/WEB-INF/web.xml
-</screen>
- </para>
<para>
Re-deploying the HelloWorldJSFSunRIPortlet produces output to the JBoss AS or JBoss EAP console, similar to the following:
</para>
16 years, 3 months
JBoss Portal SVN: r11394 - docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules.
by portal-commits@lists.jboss.org
Author: mmcallis
Date: 2008-07-09 23:15:45 -0400 (Wed, 09 Jul 2008)
New Revision: 11394
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/configuration.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml
Log:
- code highlighting.
- moving certain commands out of screen tags
to remove mangling, and make consistent with the same
changes to the 2.6 branch.
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/configuration.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/configuration.xml 2008-07-10 03:06:55 UTC (rev 11393)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/configuration.xml 2008-07-10 03:15:45 UTC (rev 11394)
@@ -52,7 +52,7 @@
<listitem>
<para>Open the <emphasis>$JBOSS_HOME/server/default/deploy/jboss-portal.sar/portal-server.war/WEB-INF/jboss-web.xml</emphasis> file. If this file does not exist, copy and save the following example:
</para>
-<programlisting role="XML"><![CDATA[
+<programlisting><![CDATA[
<?xml version="1.0"?>
<jboss-web>
<security-domain>java:jaas/portal</security-domain>
@@ -70,7 +70,7 @@
<para>Edit the
<computeroutput><context-root></computeroutput> element with the desired context path:
</para>
-<programlisting role="XML">
+<programlisting>
<![CDATA[<context-root>/testing</context-root>]]>
</programlisting>
<para>
@@ -165,7 +165,7 @@
<para>
Un-comment the following line, so that it looks like the following:
</para>
-<programlisting role="XML"><![CDATA[
+<programlisting><![CDATA[
<!-- Force the dialect instead of using autodetection -->
<property name="dialect">org.hibernate.dialect.PostgreSQLDialect</property>
]]></programlisting>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-07-10 03:06:55 UTC (rev 11393)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-07-10 03:15:45 UTC (rev 11394)
@@ -340,7 +340,7 @@
<area id="supports" coords='12' />
<area id="portletinfo" coords='15' />
</areaspec>
- <programlisting role="XML"><![CDATA[
+ <programlisting><![CDATA[
<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd
@@ -490,7 +490,7 @@
<area id="region" coords='14' />
<area id="height" coords='15' />
</areaspec>
- <programlisting role="XML"><![CDATA[
+ <programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE deployments PUBLIC
"-//JBoss Portal//DTD Portal Object 2.6//EN"
@@ -807,8 +807,7 @@
<para>
<screen><![CDATA[
INFO [TomcatDeployer] deploy, ctxPath=/helloworldportlet,
-warUrl=.../tmp/deploy/tmp35219helloworldportlet-exp.war/]]>
- </screen>
+warUrl=.../tmp/deploy/tmp35219helloworldportlet-exp.war/]]></screen>
</para>
<para>
To see the HelloWorldPortlet, navigate to
@@ -842,15 +841,9 @@
</filename>
directory into the JBoss AS or JBoss EAP
<filename>deploy/</filename>
- directory. On Linux, run the following command to re-deploy the
- HelloWorldPortlet:
+ directory. On Linux, run the <command>touch $JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldportlet.war/WEB-INF/web.xml</command> command to re-deploy the HelloWorldPortlet.
</para>
<para>
-<screen>
-touch $JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldportlet.war/WEB-INF/web.xml
-</screen>
- </para>
- <para>
Re-deploying the HelloWorldPortlet produces output to the JBoss AS or JBoss
EAP console, similar to the following:
</para>
@@ -936,7 +929,7 @@
</filename>
file:
</para>
- <programlisting role="XML"><![CDATA[
+ <programlisting role="JAVA"><![CDATA[
package org.jboss.portlet.hello;
import javax.portlet.ActionRequest;
@@ -1006,14 +999,14 @@
<variablelist>
<varlistentry>
<term>
- <screen><![CDATA[
+ <programlisting><![CDATA[
protected void doHelp(RenderRequest rRequest, RenderResponse rResponse)
throws PortletException, IOException, UnavailableException]]>
- </screen>
- <screen><![CDATA[
+ </programlisting>
+ <programlisting><![CDATA[
protected void doEdit(RenderRequest rRequest, RenderResponse rResponse)
throws PortletException, IOException, UnavailableException]]>
- </screen>
+ </programlisting>
</term>
<listitem>
<para>
@@ -1027,7 +1020,7 @@
</varlistentry>
<varlistentry>
<term>
- <screen><![CDATA[
+ <programlisting><![CDATA[
public void processAction(ActionRequest aRequest, ActionResponse aResponse)
throws PortletException, IOException, UnavailableException
{
@@ -1036,8 +1029,7 @@
// do something
aResponse.setRenderParameter("yourname", sYourname);
-}]]>
- </screen>
+}]]></programlisting>
</term>
<listitem>
<para>
@@ -1057,9 +1049,9 @@
</varlistentry>
<varlistentry>
<term>
- <screen><![CDATA[
+ <programlisting><![CDATA[
rResponse.setContentType("text/html");]]>
- </screen>
+ </programlisting>
</term>
<listitem>
<para>
@@ -1071,10 +1063,10 @@
</varlistentry>
<varlistentry>
<term>
- <screen><![CDATA[
+ <programlisting><![CDATA[
protected void doView(RenderRequest rRequest, RenderResponse rResponse)
throws PortletException, IOException, UnavailableException]]>
- </screen>
+ </programlisting>
</term>
<listitem>
<para>
@@ -1134,7 +1126,7 @@
<filename>HelloWorldJSPPortlet/WEB-INF/jsp/view.jsp</filename>
file:
</para>
- <programlisting role="JSP"><![CDATA[
+ <programlisting><![CDATA[
<%@ taglib uri="http://java.sun.com/portlet" prefix="portlet" %>
<portlet:defineObjects/>
@@ -1153,15 +1145,14 @@
You can also link to other pages, using a renderURL, like <a
href="<portlet:renderURL><portlet:param name="yourname" value="Roy Russo">
</portlet:param></portlet:renderURL>">this</a>.
-</div>]]>
- </programlisting>
+</div>]]></programlisting>
<para>
<variablelist>
<varlistentry>
<term>
- <screen><![CDATA[
+ <programlisting><![CDATA[
<%@ taglib uri="http://java.sun.com/portlet" prefix="portlet" %>]]>
- </screen>
+</programlisting>
</term>
<listitem>
<para>
@@ -1172,9 +1163,9 @@
</varlistentry>
<varlistentry>
<term>
- <screen><![CDATA[
+<programlisting><![CDATA[
<portlet:defineObjects/>]]>
- </screen>
+</programlisting>
</term>
<listitem>
<para>
@@ -1192,10 +1183,10 @@
</varlistentry>
<varlistentry>
<term>
- <screen><![CDATA[
+ <programlisting><![CDATA[
<form action="<portlet:actionURL><portlet:param name="page" value="mainview"/>
</portlet:actionURL>" method="POST">]]>
- </screen>
+</programlisting>
</term>
<listitem>
<para>
@@ -1210,10 +1201,10 @@
</varlistentry>
<varlistentry>
<term>
- <screen><![CDATA[
+ <programlisting><![CDATA[
<a href="<portlet:renderURL><portlet:param name="yourname" value="Roy Russo">
</portlet:param></portlet:renderURL>">]]>
- </screen>
+</programlisting>
</term>
<listitem>
<para>
@@ -1425,17 +1416,9 @@
</filename>
directory into the JBoss AS or JBoss EAP
<filename>deploy/</filename>
- directory. On Linux, run the following command to re-deploy the
- HelloWorldJSPPortlet:
+ directory. On Linux, run the <command>touch $JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldjspportlet.war/WEB-INF/web.xml</command> command to re-deploy the HelloWorldJSPPortlet.
</para>
<para>
- <screen>
- touch $JBOSS_HOME/server/
- <replaceable>configuration</replaceable>
- /deploy/helloworldjspportlet.war/WEB-INF/web.xml
- </screen>
- </para>
- <para>
Re-deploying the HelloWorldJSPPortlet produces output to the JBoss AS or
JBoss EAP console, similar to the following:
</para>
@@ -1545,8 +1528,7 @@
Specification. You may define more than one portlet application in this
file:
</para>
- <para>
- <screen><![CDATA[
+ <programlisting role="XML"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -1569,7 +1551,7 @@
</portlet-info>
</portlet>
</portlet-app>]]>
- </screen>
+ </programlisting>
</para>
<para>
<variablelist>
16 years, 3 months
JBoss Portal SVN: r11393 - docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules.
by portal-commits@lists.jboss.org
Author: mmcallis
Date: 2008-07-09 23:06:55 -0400 (Wed, 09 Jul 2008)
New Revision: 11393
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml
Log:
5.2.2.6. Deploying your JSP?\226?\132?\162 portlet
- moving touch command from <screen> to avoid mangling
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-07-10 02:56:43 UTC (rev 11392)
+++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-07-10 03:06:55 UTC (rev 11393)
@@ -970,14 +970,9 @@
</mediaobject>
</para>
<para>
- To re-deploy the portlet, for example, if you have made changes to any of the application descriptors, touch the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldjspportlet.war/WEB-INF/web.xml</filename> file. This only works if you copied the <filename>HelloWorldJSPPortlet/output/lib/exploded/helloworldjspportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. On Linux, run the following command to re-deploy the HelloWorldJSPPortlet:
+ To re-deploy the portlet, for example, if you have made changes to any of the application descriptors, touch the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldjspportlet.war/WEB-INF/web.xml</filename> file. This only works if you copied the <filename>HelloWorldJSPPortlet/output/lib/exploded/helloworldjspportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. On Linux, run the <command>touch $JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldjspportlet.war/WEB-INF/web.xml</command> command to re-deploy the HelloWorldJSPPortlet.
</para>
<para>
-<screen>
-touch $JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldjspportlet.war/WEB-INF/web.xml
-</screen>
-</para>
-<para>
Re-deploying the HelloWorldJSPPortlet produces output to the JBoss AS or JBoss EAP console, similar to the following:
</para>
<para>
16 years, 3 months
JBoss Portal SVN: r11392 - docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules.
by portal-commits@lists.jboss.org
Author: mmcallis
Date: 2008-07-09 22:56:43 -0400 (Wed, 09 Jul 2008)
New Revision: 11392
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml
Log:
5.2.1.6. Deploying your Portlet
- screen tags around a touch command caused mangled output. Moving
tag into <command>, and doing the same for 2.7 branch
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-07-10 01:35:48 UTC (rev 11391)
+++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2008-07-10 02:56:43 UTC (rev 11392)
@@ -619,13 +619,8 @@
</mediaobject>
</para>
<para>
- To re-deploy the portlet, for example, if you have made changes to any of the application descriptors, touch the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldportlet.war/WEB-INF/web.xml</filename> file. This only works if you copied the <filename>HelloWorldPortlet/output/lib/exploded/helloworldportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. On Linux, run the following command to re-deploy the HelloWorldPortlet:
+ To re-deploy the portlet, for example, if you have made changes to any of the application descriptors, touch the <filename>$JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldportlet.war/WEB-INF/web.xml</filename> file. This only works if you copied the <filename>HelloWorldPortlet/output/lib/exploded/helloworldportlet.war/</filename> directory into the JBoss AS or JBoss EAP <filename>deploy/</filename> directory. On Linux, run the <command>touch $JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldportlet.war/WEB-INF/web.xml</command> command to re-deploy the HelloWorldPortlet.
</para>
- <para>
-<screen>
-touch $JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldportlet.war/WEB-INF/web.xml
-</screen>
- </para>
<para>
Re-deploying the HelloWorldPortlet produces output to the JBoss AS or JBoss EAP console, similar to the following:
</para>
16 years, 3 months
JBoss Portal SVN: r11391 - docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules.
by portal-commits@lists.jboss.org
Author: mmcallis
Date: 2008-07-09 21:35:48 -0400 (Wed, 09 Jul 2008)
New Revision: 11391
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/migration.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml
Log:
updating programlistings for code highlighting
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/migration.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/migration.xml 2008-07-09 22:42:00 UTC (rev 11390)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/migration.xml 2008-07-10 01:35:48 UTC (rev 11391)
@@ -26,7 +26,7 @@
the new portlet as a JSR-286 portlet so that the filter can be applied. For a portlet named <emphasis>MyFooPortlet</emphasis>
it would now look like this:
</para>
-<programlisting><![CDATA[
+<programlisting role="XML"><![CDATA[
<portlet-app
xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-07-09 22:42:00 UTC (rev 11390)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-07-10 01:35:48 UTC (rev 11391)
@@ -340,7 +340,7 @@
<area id="supports" coords='12' />
<area id="portletinfo" coords='15' />
</areaspec>
- <programlisting><![CDATA[
+ <programlisting role="XML"><![CDATA[
<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd
@@ -490,7 +490,8 @@
<area id="region" coords='14' />
<area id="height" coords='15' />
</areaspec>
- <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+ <programlisting role="XML"><![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE deployments PUBLIC
"-//JBoss Portal//DTD Portal Object 2.6//EN"
"http://www.jboss.org/portal/dtd/portal-object_2_6.dtd">
@@ -845,11 +846,9 @@
HelloWorldPortlet:
</para>
<para>
- <screen>
- touch $JBOSS_HOME/server/
- <replaceable>configuration</replaceable>
- /deploy/helloworldportlet.war/WEB-INF/web.xml
- </screen>
+<screen>
+touch $JBOSS_HOME/server/<replaceable>configuration</replaceable>/deploy/helloworldportlet.war/WEB-INF/web.xml
+</screen>
</para>
<para>
Re-deploying the HelloWorldPortlet produces output to the JBoss AS or JBoss
@@ -937,8 +936,7 @@
</filename>
file:
</para>
- <para>
- <screen><![CDATA[
+ <programlisting role="XML"><![CDATA[
package org.jboss.portlet.hello;
import javax.portlet.ActionRequest;
@@ -1003,8 +1001,7 @@
prd.include(rRequest, rResponse);
}
}]]>
- </screen>
- </para>
+ </programlisting>
<para>
<variablelist>
<varlistentry>
@@ -1137,8 +1134,7 @@
<filename>HelloWorldJSPPortlet/WEB-INF/jsp/view.jsp</filename>
file:
</para>
- <para>
- <screen><![CDATA[
+ <programlisting role="JSP"><![CDATA[
<%@ taglib uri="http://java.sun.com/portlet" prefix="portlet" %>
<portlet:defineObjects/>
@@ -1158,8 +1154,7 @@
href="<portlet:renderURL><portlet:param name="yourname" value="Roy Russo">
</portlet:param></portlet:renderURL>">this</a>.
</div>]]>
- </screen>
- </para>
+ </programlisting>
<para>
<variablelist>
<varlistentry>
16 years, 3 months
JBoss Portal SVN: r11390 - in modules/presentation/trunk/ajax/src/main/java/org/jboss/portal/presentation/ajax/client: util and 1 other directory.
by portal-commits@lists.jboss.org
Author: julien(a)jboss.com
Date: 2008-07-09 18:42:00 -0400 (Wed, 09 Jul 2008)
New Revision: 11390
Modified:
modules/presentation/trunk/ajax/src/main/java/org/jboss/portal/presentation/ajax/client/model/AjaxPane.java
modules/presentation/trunk/ajax/src/main/java/org/jboss/portal/presentation/ajax/client/model/AjaxWindow.java
modules/presentation/trunk/ajax/src/main/java/org/jboss/portal/presentation/ajax/client/util/Tools.java
Log:
fix issue where a pane drag would prevent the usage of one of its children
Modified: modules/presentation/trunk/ajax/src/main/java/org/jboss/portal/presentation/ajax/client/model/AjaxPane.java
===================================================================
--- modules/presentation/trunk/ajax/src/main/java/org/jboss/portal/presentation/ajax/client/model/AjaxPane.java 2008-07-09 21:43:10 UTC (rev 11389)
+++ modules/presentation/trunk/ajax/src/main/java/org/jboss/portal/presentation/ajax/client/model/AjaxPane.java 2008-07-09 22:42:00 UTC (rev 11390)
@@ -27,9 +27,11 @@
import com.google.gwt.user.client.Element;
import java.util.Map;
+import java.util.Iterator;
import org.jboss.portal.presentation.ajax.client.dnd.Draggable;
import org.jboss.portal.presentation.ajax.client.dnd.Droppable;
+import org.jboss.portal.presentation.ajax.client.util.Tools;
/**
* @author <a href="mailto:julien@jboss-portal.org">Julien Viet</a>
@@ -116,12 +118,20 @@
protected Draggable doFindDraggable(int x, int y)
{
- int left = widget.getAbsoluteLeft();
- int right = left + widget.getOffsetWidth();
- int top = widget.getAbsoluteTop();
- int bottom = top + widget.getOffsetHeight();
- if (x >= left && x <= right && y >= top && y <= bottom)
+ // Let's not shadow any widget
+ for (Iterator i = getChildren().iterator();i.hasNext();)
{
+ AjaxObject child = (AjaxObject)i.next();
+ Widget childWidget = child.getWidget();
+ if (Tools.contains(childWidget, x, y))
+ {
+ return null;
+ }
+ }
+
+ //
+ if (Tools.contains(widget, x, y))
+ {
return draggable;
}
else
Modified: modules/presentation/trunk/ajax/src/main/java/org/jboss/portal/presentation/ajax/client/model/AjaxWindow.java
===================================================================
--- modules/presentation/trunk/ajax/src/main/java/org/jboss/portal/presentation/ajax/client/model/AjaxWindow.java 2008-07-09 21:43:10 UTC (rev 11389)
+++ modules/presentation/trunk/ajax/src/main/java/org/jboss/portal/presentation/ajax/client/model/AjaxWindow.java 2008-07-09 22:42:00 UTC (rev 11390)
@@ -134,11 +134,7 @@
protected Draggable doFindDraggable(int x, int y)
{
- int left = title.getAbsoluteLeft();
- int right = left + title.getOffsetWidth();
- int top = title.getAbsoluteTop();
- int bottom = top + title.getOffsetHeight();
- if (x >= left && x <= right && y >= top && y <= bottom)
+ if (Tools.contains(title, x, y))
{
return draggable;
}
Modified: modules/presentation/trunk/ajax/src/main/java/org/jboss/portal/presentation/ajax/client/util/Tools.java
===================================================================
--- modules/presentation/trunk/ajax/src/main/java/org/jboss/portal/presentation/ajax/client/util/Tools.java 2008-07-09 21:43:10 UTC (rev 11389)
+++ modules/presentation/trunk/ajax/src/main/java/org/jboss/portal/presentation/ajax/client/util/Tools.java 2008-07-09 22:42:00 UTC (rev 11390)
@@ -24,6 +24,7 @@
import com.google.gwt.user.client.Element;
import com.google.gwt.user.client.DOM;
+import com.google.gwt.user.client.ui.Widget;
import java.util.Map;
@@ -37,6 +38,29 @@
{
/**
+ * Returns true if the specified widget does contain the point located at (x,y).
+ *
+ * @param widget the widget
+ * @param x the x value
+ * @param y the y value
+ * @return true is the point is contained within the widget
+ */
+ public static boolean contains(Widget widget, int x, int y)
+ {
+ if (widget == null)
+ {
+ throw new IllegalArgumentException();
+ }
+
+ //
+ int left = widget.getAbsoluteLeft();
+ int right = left + widget.getOffsetWidth();
+ int top = widget.getAbsoluteTop();
+ int bottom = top + widget.getOffsetHeight();
+ return x >= left && x <= right && y >= top && y <= bottom;
+ }
+
+ /**
* Returns an element tag name.
*
* @param element the element to obtain the tag name from
16 years, 3 months