Author: mmcallis Date: 2008-07-11 03:40:35 -0400 (Fri, 11 Jul 2008) New Revision: 11417 Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/configuration.xml docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/installation.xml docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml Log: changing <screen> to <programlisting> 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 21:48:41 UTC (rev 11416) +++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/configuration.xml 2008-07-11 07:40:35 UTC (rev 11417) @@ -247,17 +247,17 @@ JBoss Portal services use a special kind of Model MBean called <emphasis>JBossServiceModelMBean</emphasis>, which allows the un-wrapping of injected dynamic proxies, and replaces them with Plain Old Java Object (POJO) services. This removes the bottleneck when using Java 5, and also provides a performance boost on JDK 1.4. By default this feature is enabled, but it is possible to disable. To do this on Linux operating systems, change into the <filename>$JBOSS_HOME/bin/</filename> directory and run the following command: </para> <para> -<screen> +<programlisting> sh run.sh -Dportal.kernel.no_proxies=false -</screen> +</programlisting> </para> <para> On Windows, run the following command: </para> <para> -<screen> +<programlisting> run.bat -Dportal.kernel.no_proxies=false -</screen> +</programlisting> </para> </sect1> </chapter> Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/installation.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/installation.xml 2008-07-10 21:48:41 UTC (rev 11416) +++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/installation.xml 2008-07-11 07:40:35 UTC (rev 11417) @@ -119,9 +119,9 @@ Add the following line to the <filename>~/.bashrc</filename> file. Note: this must be configured while logged in as the user who runs JBoss EAP or JBoss AS: </para> <para> -<screen> +<programlisting> export JBOSS_HOME=/path/to/jboss/installation/ -</screen> +</programlisting> </para> </listitem> <listitem> @@ -129,9 +129,9 @@ Run the following command to enable the <filename>JBOSS_HOME</filename> environment variable: </para> <para> -<screen> +<programlisting> source ~/.bashrc -</screen> +</programlisting> </para> </listitem> </orderedlist> @@ -336,9 +336,9 @@ Add the following line to the <filename>~/.bashrc</filename> file. Note: this must be configured while logged in as the user who runs JBoss EAP or JBoss AS: </para> <para> -<screen> +<programlisting> export JBOSS_HOME=/path/to/jboss/installation/ -</screen> +</programlisting> </para> </listitem> <listitem> @@ -346,9 +346,9 @@ Run the following command to enable the <filename>JBOSS_HOME</filename> environment variable: </para> <para> -<screen> +<programlisting> source ~/.bashrc -</screen> +</programlisting> </para> </listitem> </orderedlist> @@ -368,7 +368,7 @@ repository, so you must be connected to the Internet, and if you are behind a proxy server, you need to define your proxy server address and proxy server port number. To define a proxy server, add the following line to the <filename>$JBOSS_HOME/bin/run.conf</filename> file: </para> <para> -<screen><xi:include href="extras/runconf_javaops.xmlt" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... +<programlisting><xi:include href="extras/runconf_javaops.xmlt" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... <!--JAVA_OPTS=-Dhttp.proxyHost=&lt;<replaceable>proxy-hostname </replaceable>&gt;-Dhttp.proxyPort=&lt;<replaceable>proxy-port</replaceable>&gt; --> </para> <para> @@ -404,9 +404,9 @@ Change into the <filename>JBOSS_PORTAL_SOURCE_DIRECTORY/build/</filename> directory, and run the following command: </para> <para> -<screen> +<programlisting> sh build.sh main -</screen> +</programlisting> </para> </listitem> <listitem> @@ -414,9 +414,9 @@ Change into the <filename>JBOSS_PORTAL_SOURCE_DIRECTORY/core/</filename> directory, and run the following command: </para> <para> -<screen> +<programlisting> sh build.sh deploy-ha -</screen> +</programlisting> </para> <para> After the <command>sh build.sh deploy-ha</command> command completes, the <filename>jboss-portal-ha.sar</filename> file is copied into the <filename>$JBOSS_HOME/server/all/deploy/</filename> directory. 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 21:48:41 UTC (rev 11416) +++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml 2008-07-11 07:40:35 UTC (rev 11417) @@ -161,9 +161,9 @@ </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT transaction (trans-attribute)>]]> -</screen></term> +</programlisting></term> <listitem> <para> The <computeroutput>&lt;transaction&gt;</computeroutput> element defines how the portlet behaves with regards to the transactional context. The <computeroutput>&lt;trans-attribute&gt;</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. @@ -172,58 +172,58 @@ The following is an example of the <computeroutput>&lt;transaction&gt;</computeroutput> and <computeroutput>&lt;trans-attribute&gt;</computeroutput> elements: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <transaction> <trans-attribute>Required</transaction> <transaction>]]> -</screen> +</programlisting> </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT trans-attribute (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The default value is <computeroutput>NotSupported</computeroutput>, which means that the portal transaction is 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[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT header-content (link|script|meta)*>]]> -</screen></term> +</programlisting></term> <listitem> <para> Specify the content to be included in the portal aggregated page when the portlet is present on that page. This setting only applies when the portlet is used in the local mode. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT link EMPTY>]]> -</screen> +</programlisting> </para> <para> No content is allowed inside a link element. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT script (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> Use the <computeroutput>&lt;script&gt;</computeroutput> element for inline script definitions. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT meta EMPTY>]]> -</screen> +</programlisting> </para> <para> No content is allowed for the <computeroutput>&lt;meta&gt;</computeroutput> element. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT service (service-name,service-class,service-ref)>]]> -</screen></term> +</programlisting></term> <listitem> <para> Declare a service that will be injected by the portlet container as an attribute of the portlet context. @@ -232,45 +232,45 @@ The following is an example of the <computeroutput>&lt;service&gt;</computeroutput> element: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <service> <service-name>UserModule</service-name> <service-class>org.jboss.portal.identity.UserModule</service-class> <service-ref>:service=Module,type=User</service-ref> </service>]]> -</screen> +</programlisting> </para> <para> To use an injected service in a portlet, perform a lookup of the <computeroutput>&lt;service-name&gt;</computeroutput>, for example, using the <computeroutput>init()</computeroutput> lifecycle method: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ public void init() { UserModule userModule = (UserModule)getPortletContext().getAttribute("UserModule"); }]]> -</screen> +</programlisting> </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT service-name (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;service-name&gt;</computeroutput> element defines the name that binds the service as a portlet context attribute. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT service-class (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;service-class&gt;</computeroutput> element defines the fully qualified name of the interface that the service implements. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT service-ref (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;service-ref&gt;</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, the current domain of the portal is used. @@ -287,35 +287,35 @@ </para> <para> <variablelist> - <varlistentry><term><screen><![CDATA[ + <varlistentry><term><programlisting><![CDATA[ <!ELEMENT deployments (deployment*)>]]> -</screen></term> +</programlisting></term> <listitem> <para> The <computeroutput>&lt;deployments&gt;</computeroutput> element is a container for <computeroutput>&lt;deployment&gt;</computeroutput> elements. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT deployment (if-exists?,instance)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;deployment&gt;</computeroutput> element is a container for the <computeroutput>&lt;instance&gt;</computeroutput> element. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT if-exists (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;if-exists&gt;</computeroutput> element defines the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option maintains the existing object deployment, or creates a new one if it does not exist. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT instance (instance-id,portlet-ref,display-name*,preferences?, security-constraint?, (display-name* | (resource-bundle, supported-locale+)))>]]> -</screen></term> +</programlisting></term> <listitem> <para> The <computeroutput>&lt;instance&gt;</computeroutput> element is used in the <filename>WEB-INF/portlet-instances.xml</filename> file, which creates instances of portlets. The portlet will only be created and configured if the portlet is present, and if an instance with the same name does not already exist. @@ -324,7 +324,7 @@ The following is an example of the <computeroutput>&lt;instance&gt;</computeroutput> element, which also contains the <computeroutput>&lt;security-constraint&gt;</computeroutput> element. Descriptions of each element follow afterwards: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <instance> <instance-id>MyPortletInstance</instance-id> <portlet-ref>MyPortlet</portlet-ref> @@ -341,68 +341,68 @@ </policy-permission> </security-constraint> </instance>]]> -</screen> +</programlisting> </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT instance-id (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The instance identifier. The <computeroutput>&lt;instance-id&gt;</computeroutput> value can be named anything, but it must match the <computeroutput>&lt;instance-ref&gt;</computeroutput>value given in the <filename>*-object.xml</filename> file. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT portlet-ref (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;portlet-ref&gt;</computeroutput> element defines the portlet that an instance represents. The <computeroutput>&lt;portlet-ref&gt;</computeroutput> value must match the <computeroutput>&lt;portlet-name&gt;</computeroutput> given in the <filename>WEB-INF/portlet.xml</filename> file. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT preferences (preference+)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;preferences&gt;</computeroutput> element configures an instance with a set of preferences. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT preference (name,value)>]]> -</screen></term> +</programlisting></term> <listitem> <para> The <computeroutput>&lt;preference&gt;</computeroutput> element configures one preference, which is part of a set of preferences. Use the <computeroutput>&lt;preferences&gt;</computeroutput> element to define a set of preferences. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT name (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> A name. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT value (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> A string value. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT security-constraint (policy-permission*)>]]> -</screen></term> +</programlisting></term> <listitem> <para> The <computeroutput>&lt;security-constraint&gt;</computeroutput> element is a container for <computeroutput>&lt;policy-permission&gt;</computeroutput> elements. The following is an example of the <computeroutput>&lt;security-constraint&gt;</computeroutput> and <computeroutput>&lt;policy-permission&gt;</computeroutput> elements: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <security-constraint> <policy-permission> <role-name>User</role-name> @@ -416,21 +416,21 @@ <action-name>view</action-name> </policy-permission> </security-constraint>]]> -</screen> +</programlisting> </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT policy-permission (action-name*,unchecked?,role-name*)>]]> -</screen></term> +</programlisting></term> <listitem> <para> The <computeroutput>&lt;policy-permission&gt;</computeroutput> element secures a specific portlet instance based on a user's role. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT action-name (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;action-name&gt;</computeroutput> element defines the access rights given to the role defined. Accepted values are: @@ -460,25 +460,25 @@ </itemizedlist> </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT unchecked EMPTY>]]> -</screen> +</programlisting> </para> <para> If present, the <computeroutput>&lt;unchecked&gt;</computeroutput> element defines anyone can view the instance. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT role-name (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;role-name&gt;</computeroutput> element defines a role that the security constraint will apply to. The following example only allows users that are part of the <computeroutput>EXAMPLEROLE</computeroutput> role to access the instance: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <role-name>EXAMPLEROLE</role-name>]]> -</screen> +</programlisting> </para> </listitem> </varlistentry> @@ -492,18 +492,18 @@ </para> <para> <variablelist> - <varlistentry><term><screen><![CDATA[ + <varlistentry><term><programlisting><![CDATA[ <!ELEMENT deployments (deployment*)>]]> -</screen></term> +</programlisting></term> <listitem> <para> The <computeroutput>&lt;deployments&gt;</computeroutput> element is a container for <computeroutput>&lt;deployment&gt;</computeroutput> elements. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT deployment (parent-ref?,if-exists?,(context|portal|page|window))>]]> -</screen></term> +</programlisting></term> <listitem> <para> The <computeroutput>&lt;deployment&gt;</computeroutput> element is a generic container for portal object elements. The <computeroutput>&lt;parent-ref&gt;</computeroutput> child element gives the name of the parent object that the current object will use as parent. The optional <computeroutput>&lt;if-exists&gt;</computeroutput> element defines the action to take if an instance with the same name already exists. The default behavior of the <computeroutput>&lt;if-exists&gt;</computeroutput> element is to keep the existing object, and not to create a new object. @@ -512,14 +512,14 @@ The following is an example of the <computeroutput>&lt;deployment&gt;</computeroutput> and <computeroutput>&lt;parent-ref&gt;</computeroutput> elements: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <deployment> <parent-ref>default</parent-ref> <page> ... </page> </deployment>]]> -</screen> +</programlisting> </para> <para> All portal objects have a common configuration which can include: @@ -544,9 +544,9 @@ </itemizedlist> </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT parent-ref (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;parent-ref&gt;</computeroutput> element contains a reference to the parent object. The naming convention for naming objects is to concatenate the names of the path to the object, and separate the names using a period. If the path is empty, the empty string must be used. The <computeroutput>&lt;parent-ref&gt;</computeroutput> element tells the portal where the portlet appears. The syntax for the <computeroutput>&lt;parent-ref&gt;</computeroutput> element is <computeroutput><replaceable>portal-instance</replaceable>.<replaceable>portal-page</replaceable></computeroutput>. @@ -555,74 +555,74 @@ The following is an example of the root having an empty path: </para> <para> -<screen> +<programlisting> &lt;parent-ref/&gt; -</screen> +</programlisting> </para> <para> The following specifies that the portlet appears in the portal instance named <computeroutput>default</computeroutput>: </para> <para> -<screen> +<programlisting> &lt;parent-ref&gt;default&lt;/parent-ref&gt; -</screen> +</programlisting> </para> <para> The following specifies that the portlet appear in the portal instance named <computeroutput>default</computeroutput>, and on the page named <computeroutput>default</computeroutput>: </para> <para> -<screen> +<programlisting> &lt;parent-ref&gt;default.default&lt;/parent-ref&gt; -</screen> +</programlisting> </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT if-exists (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;if-exists&gt;</computeroutput> element defines the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option matains the existing object deployment, or creates a new one if it does not exist. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT context (context-name,properties?,listener?,security-constraint?,portal*, (display-name* | (resource-bundle, supported-locale+)))>]]> -</screen></term> +</programlisting></term> <listitem> <para> The context type of the portal object. A context type represent a node in a tree, which does not have a visual representation, and only exists under the root. A context can only have children that use the <emphasis>portal</emphasis> type. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT context-name (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The context name. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT portal (portal-name,supported-modes,supported-window-states?,properties?,listener?, security-constraint?,page*, (display-name* | (resource-bundle, supported-locale+)))>]]> -</screen></term> +</programlisting></term> <listitem> <para> A portal object that uses the <emphasis>portal</emphasis> type. A portal type represents a virtual portal, and can only have children that use the <emphasis>page</emphasis> type. In addition to the common portal object elements, it also allows you to declare modes and window states that are supported. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT portal-name (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The portal name. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT supported-modes (mode*)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;supported-modes&gt;</computeroutput> elements defines the supported modes of the portal. Accepted values are <computeroutput>view</computeroutput>, <computeroutput>edit</computeroutput>, and <computeroutput>help</computeroutput>. @@ -631,73 +631,73 @@ The following is an example of the <computeroutput>&lt;supported-mode&gt;</computeroutput> and <computeroutput>&lt;mode&gt;</computeroutput> elements: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <supported-mode> <mode>view</mode> <mode>edit</mode> <mode>help</mode> </supported-mode>]]> -</screen> +</programlisting> </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT mode (#PCDATA)>]]> -</screen></term> +</programlisting></term> <listitem> <para> The portlet mode value. If there are no declarations of modes or window states, the default values are <computeroutput>view</computeroutput>, <computeroutput>edit</computeroutput>, <computeroutput>help</computeroutput>, and <computeroutput>normal</computeroutput>, <computeroutput>minimized</computeroutput>, <computeroutput>maximized</computeroutput>, respectively. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT supported-window-states (window-state*)>]]> -</screen></term> +</programlisting></term> <listitem> <para> Use the <computeroutput>&lt;supported-window-states&gt;</computeroutput> element to define the supported window states of the portal. The following is an example of the <computeroutput>&lt;supported-window-states&gt;</computeroutput> and <computeroutput>&lt;window-state&gt;</computeroutput> elements: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <supported-window-states> <window-state>normal</window-state> <window-state>minimized</window-state> <window-state>maximized</window-state> </supported-window-states>]]> -</screen> +</programlisting> </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT window-state (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> Use the <computeroutput>&lt;window-state&gt;</computeroutput> element to define a window states. Accepted values are <computeroutput>normal</computeroutput>, <computeroutput>minimized</computeroutput>, and <computeroutput>maximized</computeroutput>. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT page (page-name,properties?,listener?,security-constraint?,(page | window)*, (display-name* | (resource-bundle, supported-locale+)))>]]> -</screen></term> +</programlisting></term> <listitem> <para> A portal object that uses the <emphasis>page</emphasis> type. A page type represents a page, and can only have children that use the <emphasis>page</emphasis> and <emphasis>window</emphasis> types. The children windows are the windows of the page, and the children pages are the subpages of the page. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT page-name (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The page name. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT window (window-name,(instance-ref|content),region,height,initial-window-state?, initial-mode?,properties?,listener?, (display-name* | (resource-bundle, supported-locale+)))>]]> -</screen></term> +</programlisting></term> <listitem> <para> A portal object that uses the <emphasis>window</emphasis> type. A window type represents a window. Besides the common properties, a window has content, and belongs to a region on the page. @@ -706,61 +706,61 @@ The <computeroutput>&lt;instance-ref&gt;</computeroutput> and <computeroutput>&lt;content&gt;</computeroutput> elements, configured in the <filename>WEB-INF/*-object.xml</filename> files, define the content of a window. The <computeroutput>&lt;content&gt;</computeroutput> element is generic, and describes any kind of content. The <computeroutput>&lt;instance-ref&gt;</computeroutput> element is a shortcut to define the content-type of the portlet, which points to a portlet instance. The value of <computeroutput>&lt;instance-ref&gt;</computeroutput> must match the value of one of the <computeroutput>&lt;instance-id&gt;</computeroutput> elements in the <filename>WEB-INF/portlet-instances.xml</filename> file. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT window-name (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The window name value. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT instance-ref (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> Define the content of the window as a reference to a portlet instance. This value is the ID of a portlet instance, and must much the value of one of the <computeroutput>&lt;instance-id&gt;</computeroutput> elements in the <filename>WEB-INF/portlet-instances.xml</filename> file. The following is an example of the <computeroutput>&lt;instance-ref&gt;</computeroutput> element: </para> <para> -<screen> +<programlisting> &lt;instance-ref&gt;MyPortletInstance&lt;/instance-ref&gt; -</screen> +</programlisting> </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT region (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The region the window belongs to. The <computeroutput>&lt;region&gt;</computeroutput> element specifies where the window appears on the page. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT height (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The height of the window in a particular region. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT listener (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> Define a listener for a portal object. This value is the ID of the listener. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT content (content-type,content-uri)>]]> -</screen></term> +</programlisting></term> <listitem> <para> Define the content of a window in a generic manner. The content is defined by the type of content, and a URI, which acts as an identifier for the content. The following is an example of the <computeroutput>&lt;content&gt;</computeroutput> element, which is configured in the <filename>WEB-INF/*-object.xml</filename> files: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <content> <content-type>portlet</content-type> <content-uri>MyPortletInstance</content-uri> @@ -770,70 +770,70 @@ <content-type>cms</content-type> <content-uri>/default/index.html</content-uri> </content>]]> -</screen> +</programlisting> </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT content-type (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The content type of the window. The <computeroutput>&lt;content-type&gt;</computeroutput> element specifies the content to display, for example, a <computeroutput>portlet</computeroutput>. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT content-uri (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The content URI of the window. The <computeroutput>&lt;content-uri&gt;</computeroutput> element specifies which content to display, for example, a portlet instance. To display a file from the CMS, use the <computeroutput>&lt;content-uri&gt;</computeroutput> element to define the full path to that file in the CMS. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT properties (property*)>]]> -</screen></term> +</programlisting></term> <listitem> <para> A set of generic properties for the portal object. The <computeroutput>&lt;properties&gt;</computeroutput> elements contains definitions specific to a page. This is commonly used to define the specific theme and layout to use. If not defined, the default portal theme and layout are used. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT property (name,value)>]]> -</screen> +</programlisting> </para> <para> A generic string property. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT name (#PCDATA)>]]> -</screen></term> +</programlisting></term> <listitem> <para> A name value. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT value (#PCDATA)>]]> -</screen></term> +</programlisting></term> <listitem> <para> A value. </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT security-constraint (policy-permission*)>]]> -</screen></term> +</programlisting></term> <listitem> <para> The <computeroutput>&lt;security-constraint&gt;</computeroutput> element is a container for <computeroutput>&lt;policy-permission&gt;</computeroutput> elements. The following is an example of the <computeroutput>&lt;security-constraint&gt;</computeroutput> and <computeroutput>&lt;policy-permission&gt;</computeroutput> elements: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <security-constraint> <policy-permission> <role-name>User</role-name> @@ -847,21 +847,21 @@ <action-name>view</action-name> </policy-permission> </security-constraint>]]> -</screen> +</programlisting> </para> </listitem> </varlistentry> -<varlistentry><term><screen><![CDATA[ +<varlistentry><term><programlisting><![CDATA[ <!ELEMENT policy-permission (action-name*,unchecked?,role-name*)>]]> -</screen></term> +</programlisting></term> <listitem> <para> The <computeroutput>&lt;policy-permission&gt;</computeroutput> element is secures a specific portlet instance based on a user's role. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT action-name (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;action-name&gt;</computeroutput> element defines the access rights given to the role defined. Accepted values are: @@ -891,25 +891,25 @@ </itemizedlist> </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT unchecked EMPTY>]]> -</screen> +</programlisting> </para> <para> If present, the <computeroutput>&lt;unchecked&gt;</computeroutput> element defines that anyone can view the instance. </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT role-name (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;role-name&gt;</computeroutput> element defines a role that the security constraint applies to. The following example only allows users that are part of the <computeroutput>EXAMPLEROLE</computeroutput> role to access the instance: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <role-name>EXAMPLEROLE</role-name>]]> -</screen> +</programlisting> </para> </listitem> </varlistentry> @@ -923,21 +923,21 @@ </para> <para> <variablelist> - <varlistentry><term><screen><![CDATA[ + <varlistentry><term><programlisting><![CDATA[ <Element <![CDATA[<!ELEMENT jboss-app (app-name?)>]]> -</screen></term> +</programlisting></term> <listitem> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!DOCTYPE jboss-app PUBLIC "-//JBoss Portal//DTD JBoss Web Application 2.6//EN" "http://www.jboss.org/portal/dtd/jboss-app_2_6.dtd">]]> -</screen> +</programlisting> </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!ELEMENT app-name (#PCDATA)>]]> -</screen> +</programlisting> </para> <para> When a web application is deployed, the context path under which it is deployed @@ -1075,7 +1075,7 @@ The <filename>portlet-instances.xml</filename> descriptor is JBoss Portal specific, and allows developers to instantiate one-or-many instances of one-or-many portlets. The benefit of this allows one portlet to be instantiated several times, with different preference parameters. The following example instantiates two separate instances of the <computeroutput>NewsPortlet</computeroutput>, both using different parameters. One instance draws feeds from Red Hat announcements, and the other from McDonalds announcements: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <?xml version="1.0" standalone="yes"?> <!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD Portlet Instances 2.6//EN" @@ -1126,7 +1126,7 @@ </instance> </deployment> </deployments> -]]></screen> +]]></programlisting> </para> <para> <itemizedlist> @@ -1176,7 +1176,7 @@ The <computeroutput>&lt;preference&gt;</computeroutput> element configures a preference as a key-value pair. This value can be composed of a single string value, for example, the preference <emphasis>fruit</emphasis> can have the <emphasis>apple</emphasis> value. As well, this value can be composed of multiple strings, for example, the preference <emphasis>fruits</emphasis> can have values of <emphasis>apple</emphasis>, <emphasis>orange</emphasis>, and <emphasis>kiwi</emphasis>: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <preferences> <preference> <name>fruits</name> @@ -1185,7 +1185,7 @@ <value>kiwi</value> </preference> </preferences> -]]></screen> +]]></programlisting> </para> <para> The <computeroutput>&lt;preference&gt;</computeroutput> element configures one preference, which is part of a set of preferences. Use the <computeroutput>&lt;preferences&gt;</computeroutput> element to define a set of preferences. @@ -1193,12 +1193,12 @@ </listitem> <listitem> <para> -<screen><![CDATA[<security-constraint> +<programlisting><![CDATA[<security-constraint> <policy-permission> <action-name>viewrecursive</action-name> <unchecked/> </policy-permission> -</security-constraint>]]></screen> +</security-constraint>]]></programlisting> </para> <para> The <computeroutput>&lt;security-constraint&gt;</computeroutput> element is a container for <computeroutput>&lt;policy-permission&gt;</computeroutput> elements. This example demonstrates the <computeroutput>&lt;security-constraint&gt;</computeroutput> and <computeroutput>&lt;policy-permission&gt;</computeroutput> elements. @@ -1279,7 +1279,7 @@ The following example injects a specific style sheet, <computeroutput>/images/management/management.css</computeroutput>, allowing the portlet to leverage a specific style: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <?xml version="1.0" standalone="yes"?> <!DOCTYPE portlet-app PUBLIC "-//JBoss Portal//DTD JBoss Portlet 2.6//EN" @@ -1293,7 +1293,7 @@ </header-content> </portlet> </portlet-app>]]> -</screen> +</programlisting> </para> <para> Use the <computeroutput>&lt;header-content&gt;</computeroutput> and <computeroutput>&lt;link&gt;</computeroutput> elements to specify a style sheet. @@ -1305,7 +1305,7 @@ The following example injects the <computeroutput>UserModule</computeroutput> service as an attribute to the portlet context: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <?xml version="1.0" standalone="yes"?> <!DOCTYPE portlet-app PUBLIC "-//JBoss Portal//DTD JBoss Portlet 2.6//EN" @@ -1317,17 +1317,17 @@ <service-ref>:service=Module,type=User</service-ref> </service> </portlet-app>]]> -</screen> +</programlisting> </para> <para> This allows the portlet to leverage the service, for example: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ UserModule userModule = (UserModule) getPortletContext().getAttribute("UserModule"); String userId = request.getParameters().getParameter("userid"); User user = userModule.findUserById(userId);]]> -</screen> +</programlisting> </para> </sect3> <sect3> @@ -1336,7 +1336,7 @@ As of JBoss Portal 2.6.3, icons can be defined for a portlet by using the <computeroutput>&lt;icon&gt;</computeroutput>, <computeroutput>&lt;small-icon&gt;</computeroutput>, and <computeroutput>&lt;large-icon&gt;</computeroutput> elements: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <?xml version="1.0" standalone="yes"?> <!DOCTYPE portlet-app PUBLIC "-//JBoss Portal//DTD JBoss Portlet 2.6//EN" @@ -1352,7 +1352,7 @@ </portlet-info> </portlet> </portlet-app>]]> -</screen> +</programlisting> </para> <para> References to icons can be absolute, for example, <emphasis>http://www.example.com/images/smallIcon.png</emphasis>;, or relative to the web application context, for example, <computeroutput>/images/smallIcon.png</computeroutput>. Icons can be used by different parts of the portlet user interface. @@ -1379,7 +1379,7 @@ The <filename>portlet.xml</filename> descriptor is the standard portlet descriptor covered by the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink>. Developers are strongly encouraged to read the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink> items covering the correct use of this descriptor, as it is only covered briefly in these sections. Normally the <filename>portlet.xml</filename> descriptor is packaged inside your portlet WAR file, alongside the other descriptors in these sections. The following example is a modified version of the JBoss Portal UserPortlet definition: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <?xml version="1.0" encoding="UTF-8"?> <portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd" @@ -1410,7 +1410,7 @@ </portlet-info> </portlet> </portlet-app>]]> -</screen> +</programlisting> </para> <para> <itemizedlist> @@ -1587,11 +1587,11 @@ Note: if the JBoss Portal source was not built as per step 3, the <command>sh build.sh datasource</command> and <command>build.bat datasource</command> commands fail with an error, such as the following: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ BUILD FAILED java.io.FileNotFoundException: /jboss-portal-2.6.3.GA-src/core/../thirdparty/libraries.ent (No such file or directory)]]> -</screen> +</programlisting> </para> <para> The datasource build process produces the following directory and file structure, with the Datasource descriptors in the <filename>JBOSS_PORTAL_SOURCE_DIRECTORY/core/output/resources/setup</filename> directory: @@ -1607,7 +1607,7 @@ The following is an example Datasource descriptor for a PostgreSQL database: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <?xml version="1.0" encoding="UTF-8"?> <datasources> <local-tx-datasource> @@ -1618,7 +1618,7 @@ <password>portalpassword</password> </local-tx-datasource> </datasources>]]> -</screen> +</programlisting> </para> <para> Make sure the <computeroutput>user-name</computeroutput>, <computeroutput>password</computeroutput>, <computeroutput>connection-url</computeroutput>, and <computeroutput>driver-class</computeroutput>, are correct for your chosen database. @@ -1631,7 +1631,7 @@ By default, JBoss Portal is configured to display all errors. This behavior can be configured by modifying the <filename>jboss-portal.sar/conf/config.xml</filename> file: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!-- When a window has restrictedaccess : show or hide values are permitted --> <entry key="core.render.window_access_denied">show</entry> <!-- When a window is unavailable : show or hide values are permitted --> @@ -1642,7 +1642,7 @@ <entry key="core.render.window_internal_error">show</entry> <!-- When a window is not found : show or hide values are permitted --> <entry key="core.render.window_not_found">show</entry>]]> -</screen> +</programlisting> </para> <para> For these parameters, accepted values are <computeroutput>show</computeroutput> and <computeroutput>hide</computeroutput>. Depending on the setting, and the actual error, either an error message is displayed, or a full stack trace within the portlet window occurs. Additionally, the <computeroutput>core.render.window_error</computeroutput> property supports the <computeroutput>message_only</computeroutput> value. The <computeroutput>message_only</computeroutput> value will only display an error message, whereas the <computeroutput>show</computeroutput> value will, if available, display the full stack trace. @@ -1655,11 +1655,11 @@ forward a user to their Dashboard, set the <computeroutput>core.login.namespace</computeroutput> value to <computeroutput>dashboard</computeroutput> in the <filename>jboss-portal.sar/conf/config.xml</filename> file: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <!-- Namespace to use when logging-in, use "dashboard" to directly log-in the dashboard otherwise use "default" --> <entry key="core.login.namespace">dashboard</entry> -]]></screen> +]]></programlisting> </para> </sect2> </sect1> @@ -1698,7 +1698,7 @@ The HelloWorldPortalPage portlet is hot-deployable, so the JBoss EAP or JBoss AS server does not have to be restarted after deploying the HelloWorldPortalPage portlet. The following is an example of the <filename>HelloWorldPortalPage/WEB-INF/helloworld-object.xml</filename> descriptor: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD Portal Object 2.6//EN" @@ -1725,7 +1725,7 @@ </page> </deployment> </deployments>]]> -</screen> +</programlisting> </para> <para> A depoloyment is composed of a <computeroutput>&lt;deployments&gt;</computeroutput> element, which is a container for <computeroutput>&lt;deployment&gt;</computeroutput> elements. In the previous example, a page is defined, the portlet is placed as a window on a page, and an instance of the portlet is created. The Mangement portlet (bundled with JBoss Portal) can modify portal instances, page position, and so on. @@ -1736,98 +1736,98 @@ <para> <itemizedlist> <listitem> -<screen> +<programlisting> &lt;if-exists&gt; -</screen> +</programlisting> <para> The <computeroutput>&lt;if-exists&gt;</computeroutput> element defines the action to take if an instance with the same name already exists. Accepted values are <computeroutput>overwrite</computeroutput> and <computeroutput>keep</computeroutput>. The <computeroutput>overwrite</computeroutput> option destroys the existing object, and creates a new one based on the content of the deployment. The <computeroutput>keep</computeroutput> option matains the existing object deployment, or creates a new one if it does not exist. </para> </listitem> <listitem> -<screen> +<programlisting> &lt;parent-ref&gt; -</screen> +</programlisting> <para> The <computeroutput>&lt;parent-ref&gt;</computeroutput> element contains a reference to the parent object. The naming convention for naming objects is to concatenate the names of the path to the object, and separate the names using a period. If the path is empty, the empty string must be used. The <computeroutput>&lt;parent-ref&gt;</computeroutput> element tells the portal where the portlet appears. The syntax for the <computeroutput>&lt;parent-ref&gt;</computeroutput> element is <computeroutput><replaceable>portal-instance</replaceable>.<replaceable>portal-page</replaceable></computeroutput>. </para> </listitem> <listitem> -<screen> +<programlisting> &lt;properties&gt; -</screen> +</programlisting> <para> A set of generic properties for the portal object. The <computeroutput>&lt;properties&gt;</computeroutput> elements contains definitions specific to a page. This is commonly used to define the specific theme and layout to use. If not defined, the default portal theme and layout are used. </para> </listitem> <listitem> -<screen> +<programlisting> &lt;page&gt; -</screen> +</programlisting> <para> The start of a page definition. Among others, the <computeroutput>&lt;page&gt;</computeroutput> element is a container for the <computeroutput>&lt;page-name&gt;</computeroutput>, <computeroutput>&lt;window&gt;</computeroutput>, and <computeroutput>&lt;security-constraint&gt;</computeroutput> elements. </para> </listitem> <listitem> -<screen> +<programlisting> &lt;page-name&gt; -</screen> +</programlisting> <para> The page name. </para> </listitem> <listitem> -<screen> +<programlisting> &lt;window&gt; -</screen> +</programlisting> <para> The <computeroutput>&lt;window&gt;</computeroutput> element defines a portlet window. The <computeroutput>&lt;window&gt;</computeroutput> element requires an <computeroutput>&lt;instance-ref&gt;</computeroutput> element, which assigns a portal instance to a window. </para> </listitem> <listitem> -<screen> +<programlisting> &lt;window-name&gt; -</screen> +</programlisting> <para> The <computeroutput>&lt;window-name&gt;</computeroutput> element defines the <emphasis role="bold">unique name</emphasis> given to a portlet window. This can be named anything. </para> </listitem> <listitem> -<screen> +<programlisting> &lt;instance-ref&gt; -</screen> +</programlisting> <para> The <computeroutput>&lt;instance-ref&gt;</computeroutput> elements define the portlet instances that windows represent. This value is the ID of a portlet instance, and must match the value of one of the <computeroutput>&lt;instance-id&gt;</computeroutput> elements in the <filename>WEB-INF/portlet-instances.xml</filename> file. </para> </listitem> <listitem> -<screen> +<programlisting> &lt;region&gt;...&lt;/region&gt; &lt;height&gt;...&lt;/height&gt; -</screen> +</programlisting> <para> The <computeroutput>&lt;region&gt;</computeroutput> and <computeroutput>&lt;height&gt;</computeroutput> elements define where the window appears within the page layout. The <computeroutput>&lt;region&gt;</computeroutput> element specifies where the window appears on the page. The <computeroutput>&lt;region&gt;</computeroutput> element often depends on other regions defined in the portal layout. The <computeroutput>&lt;height&gt;</computeroutput> element can be assigned a value between one and <replaceable>X</replaceable>. </para> </listitem> <listitem> -<screen> +<programlisting> &lt;instance&gt; -</screen> +</programlisting> <para> The <computeroutput>&lt;instance&gt;</computeroutput> element creates instances of portlets. The portlet will only be created and configured if the portlet is present, and if an instance with the same name does not already exist. </para> </listitem> <listitem> -<screen> +<programlisting> &lt;instance-name&gt; -</screen> +</programlisting> <para> The <computeroutput>&lt;instance-name&gt;</computeroutput> element maps to the <computeroutput>&lt;instance-ref&gt;</computeroutput> element. </para> </listitem> <listitem> -<screen> +<programlisting> &lt;component-ref&gt; -</screen> +</programlisting> <para> The <computeroutput>&lt;component-ref&gt;</computeroutput> element takes the name of the application, followed by the name of the portlet, as defined in the <filename>WEB-INF/portlet.xml</filename> file. </para> @@ -1838,7 +1838,7 @@ The <computeroutput>&lt;security-constraint&gt;</computeroutput> element is a container for <computeroutput>&lt;policy-permission&gt;</computeroutput> elements. The following is an example of the <computeroutput>&lt;security-constraint&gt;</computeroutput> and <computeroutput>&lt;policy-permission&gt;</computeroutput> elements: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <security-constraint> <policy-permission> <role-name>User</role-name> @@ -1852,12 +1852,12 @@ <action-name>view</action-name> </policy-permission> </security-constraint>]]> -</screen> +</programlisting> </para> <para> -<screen> +<programlisting> &lt;action-name&gt; -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;action-name&gt;</computeroutput> element defines the access rights given to the role defined. Accepted values are: @@ -1887,25 +1887,25 @@ </itemizedlist> </para> <para> -<screen> +<programlisting> &lt;unchecked/&gt; -</screen> +</programlisting> </para> <para> If present, the <computeroutput>&lt;unchecked&gt;</computeroutput> element defines that anyone can view the instance. </para> <para> -<screen> +<programlisting> &lt;role-name&gt; -</screen> +</programlisting> </para> <para> The <computeroutput>&lt;role-name&gt;</computeroutput> element defines a role that the security constraint will apply to. The following example only allows users that are part of the <computeroutput>EXAMPLEROLE</computeroutput> role to access the instance: </para> <para> -<screen> +<programlisting> &lt;role-name&gt;EXAMPLEROLE&lt;/role-name&gt; -</screen> +</programlisting> </para> </sect2> <sect2 id="desc_example_portal"> @@ -1941,7 +1941,7 @@ The HelloWorldPortal portlet is hot-deployable, so the JBoss EAP or JBoss AS server does not have to be restarted after deploying the HelloWorldPortal portlet. The following is an example of the <filename>HelloWorldPortal/WEB-INF/helloworld-object.xml</filename> descriptor: </para> <para> -<screen><![CDATA[ +<programlisting><![CDATA[ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD Portal Object 2.6//EN" @@ -2025,7 +2025,7 @@ </page> </deployment> </deployments>]]> -</screen> +</programlisting> </para> <para> When deployed, this example registers a new portal instance, <computeroutput>HelloPortal</computeroutput>, that contains two pages. To view the default page in the <computeroutput>HelloPortal</computeroutput> instance, navigate to <ulink url="http://localhost:8080/portal/portal/HelloPortal" />, and for the second page, <ulink url="http://localhost:8080/portal/portal/HelloPortal/foobar" />.