[portal-commits] JBoss Portal SVN: r9109 - in docs/branches/JBoss_Portal_Branch_2_6/referenceGuide: en/modules and 1 other directory.

Author: thomas.heute(a)jboss.com Date: 2007-11-26 09:52:55 -0500 (Mon, 26 Nov 2007) New Revision: 9109 Added: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/jbossPortletDTD.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portalObjectsDTD.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portletInstancesDTD.xml Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/build.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/contentintegration.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portalapi.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/supported.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml Log: - Created a simple task to convert DTDs to docbook - Added full DTDs as appendix - Minor updates for 2.6.3 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/build.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/build.xml 2007-11-26 14:29:16 UTC (rev 9108) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/build.xml 2007-11-26 14:52:55 UTC (rev 9109) @@ -12,6 +12,59 @@ </antcall> </target> + <target name="portalObjectsDTD"> + <antcall target="createDocbookFromDTD"> + <param name="dest" value="portalObjectsDTD.xml"/> + <param name="dtdFileName" value="portal-object_2_6.dtd"/> + <param name="title" value="*-object.xml DTD"/> + <param name="id" value="portalObjectsDTD"/> + </antcall> + </target> + + <target name="portletInstancesDTD"> + <antcall target="createDocbookFromDTD"> + <param name="dest" value="portletInstancesDTD.xml"/> + <param name="dtdFileName" value="portlet-instances_2_6.dtd"/> + <param name="title" value="portlet-instances.xml DTD"/> + <param name="id" value="portletInstancesDTD"/> + </antcall> + </target> + + <target name="jbossPortletDTD"> + <antcall target="createDocbookFromDTD"> + <param name="dest" value="jbossPortletDTD.xml"/> + <param name="dtdFileName" value="jboss-portlet_2_6.dtd"/> + <param name="title" value="jboss-portlet.xml DTD"/> + <param name="id" value="jbossPortletDTD"/> + </antcall> + </target> + + <target name="createDocbookFromDTD"> + <concat destfile="${basedir}/en/modules/${dest}" + force="no"> + <![CDATA[ +<!-- DO NOT EDIT ME DIRECTLY, I AM GENERATED FROM THE DTD USING THE dtd2docbook ANT TASK --> +<appendix id="${id}"> + <title>]]>${title}<![CDATA[</title> + <para> +<programlisting><![CDATA[ +]]> + </concat> + <concat destfile="${basedir}/en/modules/${dest}" + append="true"> + <filelist dir="../../core/src/resources/portal-core-sar/dtd/" files="${dtdFileName}"/> + </concat> + <concat destfile="${basedir}/en/modules/${dest}" + append="true"> + +]]&gt;<![CDATA[</programlisting> + </para> +</appendix> +]]> </concat> + </target> + + <target name="dtd2docbook" depends="portalObjectsDTD, portletInstancesDTD, jbossPortletDTD"/> + <target name="all.doc" depends="clean"> <antcall target="lang.all"><param name="lang" value="en"/></antcall> </target> Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml 2007-11-26 14:29:16 UTC (rev 9108) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml 2007-11-26 14:52:55 UTC (rev 9109) @@ -29,7 +29,6 @@ number manually. </para> <para>To change it, you need to edit the file <literal>$JBOSS_HOME/server/default/deploy/jboss-web.deployer/server.xml</literal> - (<literal>$JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/server.xml</literal> on JBoss AS 4.0.x) and change the port value of the HTTP Connector. </para> <para> @@ -61,7 +60,6 @@ <note> By default, Tomcat holds on to the root context '/'. You may need to either remove <literal>$JBOSS_HOME/server/default/deploy/jboss-web.deployer/ROOT.war</literal> - (<literal>$JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/ROOT.war</literal> on JBoss AS 4.0.x) or add a <literal>jboss-web.xml</literal> file (declaring another context-root other than '/') under <literal>ROOT.war/WEB-INF</literal> directory for the below changes to take effect on restart. <programlisting><![CDATA[ Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/contentintegration.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/contentintegration.xml 2007-11-26 14:29:16 UTC (rev 9108) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/contentintegration.xml 2007-11-26 14:52:55 UTC (rev 9109) @@ -141,7 +141,8 @@ protected void doDispatch(RenderRequest req, RenderResponse resp) throws PortletException, PortletSecurityException, IOException { - if (EDIT_CONTENT_MODE.equals(req.getPortletMode()) || SELECT_CONTENT_MODE.equals(req.getPortletMode())) + if (EDIT_CONTENT_MODE.equals(req.getPortletMode()) || + SELECT_CONTENT_MODE.equals(req.getPortletMode())) { doEditContent(req, resp); } Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2007-11-26 14:29:16 UTC (rev 9108) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2007-11-26 14:52:55 UTC (rev 9109) @@ -4,26 +4,16 @@ <para>Depending on your needs, there are several different methods to get JBoss Portal up and running. <note>Pre-configured clustered versions are available from the - <ulink url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu... page</ulink> - , in the same 3 flavors as the non-clustered version. The installation differences, being that they must be - deployed in the - <emphasis>all</emphasis> + <ulink url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu... page</ulink>. + The installation differences, being that they must be deployed in the <emphasis>all</emphasis> configuration in JBoss AS and all your instances must reference the same datasource. Read - <xref linkend="clustering"/> - for more details on how to customize your clustered install, once deployed. + <xref linkend="clustering"/> for more details on how to customize your clustered install, once deployed. </note> - <note> - <title>Installation of JBoss Portal on former version of JBoss AS</title> - <para>If you need to install JBoss Portal on JBoss AS 4.0.x, please refer to the dedicated - <ulink url="http://wiki.jboss.org/wiki/Wiki.jsp?page=Portal26_AS40">... page</ulink>.</para> - </note> - </para> <sect1 id="install_bundle"> <title>Installing from Bundled Download</title> <para>This is the easiest and fastest way to get JBoss Portal installed and running. The reason is that the - download bundle contains JBoss Application Server, and JBoss Portal uses the embedded Hypersonic - Database. + download bundle contains JBoss Application Server, and JBoss Portal uses the embedded Hypersonic Database. </para> <sect2> <title>Installing the Bundle</title> @@ -63,8 +53,7 @@ , and you should see the Portal HomePage. You can now login using one of the two default accounts: <emphasis>user/user</emphasis> or - <emphasis>admin/admin</emphasis> - . + <emphasis>admin/admin</emphasis>. </para> </sect2> </sect1> @@ -100,7 +89,7 @@ <sect3> <title>Application Server Setup</title> <para>Of course you will need to install JBoss Application Server prior to installing JBoss - portal, if you didn't do so yet, please install JBoss EAP 4.2 or JBoss AS 4.2.1. If you have a + portal, if you didn't do so yet, please install JBoss EAP 4.2 or JBoss AS 4.2.2. If you have a subscription contract with Red Hat, can have access to the EAP version from the <ulink url="http://network.jboss.com/">support portal</ulink>. For the other versions you can get them @@ -261,7 +250,7 @@ <sect3> <title>Application Server Setup</title> <para>Of course you will need to install JBoss Application Server prior to installing JBoss - portal, if you didn't do so yet, please install JBoss EAP 4.2 or JBoss AS 4.2.1. If you have a + portal, if you didn't do so yet, please install JBoss EAP 4.2 or JBoss AS 4.2.2. If you have a subscription contract with Red Hat, can have access to the EAP version from the <ulink url="http://network.jboss.com/">support portal</ulink>. For the other versions you can get them Added: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/jbossPortletDTD.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/jbossPortletDTD.xml (rev 0) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/jbossPortletDTD.xml 2007-11-26 14:52:55 UTC (rev 9109) @@ -0,0 +1,299 @@ + + +<!-- DO NOT EDIT ME DIRECTLY, I AM GENERATED FROM THE DTD USING THE dtd2docbook ANT TASK --> +<appendix id="jbossPortletDTD"> + <title>jboss-portlet.xml DTD</title> + <para> +<programlisting><![CDATA[ + + <?xml version="1.0" encoding="UTF-8" ?> + +<!--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ~ JBoss, a division of Red Hat ~ + ~ Copyright 2006, Red Hat Middleware, LLC, and individual ~ + ~ contributors as indicated by the @authors tag. See the ~ + ~ copyright.txt in the distribution for a full listing of ~ + ~ individual contributors. ~ + ~ ~ + ~ This is free software; you can redistribute it and/or modify it ~ + ~ under the terms of the GNU Lesser General Public License as ~ + ~ published by the Free Software Foundation; either version 2.1 of ~ + ~ the License, or (at your option) any later version. ~ + ~ ~ + ~ This software is distributed in the hope that it will be useful, ~ + ~ but WITHOUT ANY WARRANTY; without even the implied warranty of ~ + ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ~ + ~ Lesser General Public License for more details. ~ + ~ ~ + ~ You should have received a copy of the GNU Lesser General Public ~ + ~ License along with this software; if not, write to the Free ~ + ~ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA ~ + ~ 02110-1301 USA, or see the FSF site: http://www.fsf.org. ~ + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~--> + +<!-- The additional configuration elements of the JBoss portlet container. + +<!DOCTYPE portlet-app PUBLIC + "-//JBoss Portal//DTD JBoss Portlet 2.6//EN" + "http://www.jboss.org/portal/dtd/jboss-portlet_2_6.dtd"> +--> + +<!-- +The remotable element is used to configure the default behavior of the portlets with +respect to WSRP exposure. + +For each portlet defined in portlet.xml, it is possible to configure specific +settings of the portlet container. + +It is also possible to inject services in the portlet context of the application +using the service elements. +--> +<!ELEMENT portlet-app (remotable?,portlet*,service*)> + +<!-- +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?,ajax?,session-config?,transaction?, + header-content?,portlet-info?)> + +<!-- +The portlet name. +--> +<!ELEMENT portlet-name (#PCDATA)> + +<!-- +The remotable value is used for WSRP exposure. The accepted values are the +litterals true of false. +--> +<!ELEMENT remotable (#PCDATA)> + +<!-- +The ajax tag allows to configure the ajax capabilities of the portlet. If +the portlet is tagged as partial-refresh then the portal may use partial page +refreshing and render only that portlet. If the portlet partial-refresh value +is false, then the portal will perform a full page refresh when the portlet is refreshed. +--> +<!ELEMENT ajax (partial-refresh)> + +<!-- +The authorized values for the partial-refresh element are true or false. +--> +<!ELEMENT partial-refresh (#PCDATA)> + +<!-- +Additional portlet information +--> +<!ELEMENT portlet-info (icon?)> + +<!-- +Defines icons for the portlet, they can be used by the administration portlet +to represent a particular portlet. +--> +<!ELEMENT icon (small-icon?, large-icon?)> + +<!-- +A small icon image, usually 16x16, gif, jpg and png are usually supported. +An absolute URL or a URL starting with a '/' in the context of the webapp are accepted: +eg. http://www.example.com/images/smallIcon.png +eg. /images/smallIcon.png +--> +<!ELEMENT small-icon (#PCDATA)> + +<!-- +A large icon image, usually 32x32, gif, jpg and png are usually supported. +An absolute URL or a URL starting with a '/' in the context of the webapp are accepted: +eg. http://www.example.com/images/smallIcon.png +eg. /images/smallIcon.png +--> +<!ELEMENT large-icon (#PCDATA)> + +<!-- +This element configure the portlet session of the portlet. + +The distributed element instructs the container to distribute the session attributes +using the portal session replication. It applies only to local portlets are not to +remote portlets. The default value is false. + +Example: + +<session-config> + <distributed>true</distributed> +</session-config> + +--> +<!ELEMENT session-config (distributed)> + +<!-- +The authorized values for the distributed element are true or false. +--> +<!ELEMENT distributed (#PCDATA)> + +<!-- +Defines how the portlet behaves with the transactionnal context. The default value +is Never. + +Example: + +<transaction> + <trans-attribute>Required</transaction> +<transaction> +--> +<!ELEMENT transaction (trans-attribute)> + +<!-- +The trans-attribute value defines the transactionnal behavior. The accepted values +are Required, Mandatory, Never, Supports, NotSupported and RequiresNew. +--> +<!ELEMENT trans-attribute (#PCDATA)> + +<!-- +Specify content which should 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. +--> +<!ELEMENT header-content (link|script|meta)*> + +<!-- +Creates a header markup element for linked resources, +see http://www.w3.org/TR/html401/struct/links.html#h-12.3 + +At runtime the href attribute value will be prefixed with the context path +of the web application. + +Example: + +<link rel="stylesheet" type="text/css" href="/style.css" media="screen"/> + +will produce at runtime the following markup + +<link rel="stylesheet" type="text/css" href="/my-web-application/style.css" media="screen"/> +--> +<!ATTLIST link + href CDATA #IMPLIED + rel CDATA #IMPLIED + type CDATA #IMPLIED + media CDATA #IMPLIED + title CDATA #IMPLIED> + +<!-- +No content is allowed inside an link element. +--> +<!ELEMENT link EMPTY> + +<!-- +Creates a header markup for scripting, +see http://www.w3.org/TR/html401/interact/scripts.html + +At runtime the src attribute value will be prefixed with the context path +of the web application. + +Example 1: + +<script type="text/javascript" src="/myscript.js"></script> + +will produce at runtime the following markup + +<script type="text/javascript" src="/my-web-application/myscript.js"></script> + +Example 2: + +<script type="text/javascript"> + function hello() { + alert('Hello'); + } +</script> +--> +<!ATTLIST script + src CDATA #IMPLIED + type CDATA #IMPLIED + language CDATA #IMPLIED> + +<!-- +The script header element can contain inline script definitions. +--> +<!ELEMENT script (#PCDATA)> + +<!-- +Creates a header markup for adding meta data to a page, +see http://www.w3.org/TR/html401/struct/global.html#h-7.4.4 + +Example: + +<meta name="keywords" content="jboss, portal, redhat"/> +--> +<!ATTLIST meta + name CDATA #REQUIRED + content CDATA #REQUIRED> + +<!-- +No content is allowed for meta element. +--> +<!ELEMENT meta EMPTY> + +<!-- +Declare a service that will be injected by the portlet container as an +attribute of the portlet context. + +Example: + +<service> + <service-name>UserModule</service-name> + <service-class>org.jboss.portal.identity.UserModule</service-class> + <service-ref>:service=Module,type=User</service-ref> +</service> + +In the portlet it is then possible to use it by doing a lookup on the service +name, for example in the init() lifecycle method : + +public void init() +{ + UserModule userModule = (UserModule)getPortletContext().getAttribute("UserModule"); +} + +--> +<!ELEMENT service (service-name,service-class,service-ref)> + +<!-- +The service name that will be used to bind the service as a portlet context attribute. +--> +<!ELEMENT service-name (#PCDATA)> + +<!-- +The full qualified name of the interface that the service implements. +--> +<!ELEMENT service-class (#PCDATA)> + +<!-- +The reference to the service. In the JMX Microkernel environment it consist of the JMX +name of the service MBean. For an MBean reference if the domain is left out, then the +current domain of the portal will be used. +--> +<!ELEMENT service-ref (#PCDATA)> + + +]]></programlisting> + </para> +</appendix> + \ No newline at end of file Added: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portalObjectsDTD.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portalObjectsDTD.xml (rev 0) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portalObjectsDTD.xml 2007-11-26 14:52:55 UTC (rev 9109) @@ -0,0 +1,344 @@ + + +<!-- DO NOT EDIT ME DIRECTLY, I AM GENERATED FROM THE DTD USING THE dtd2docbook ANT TASK --> +<appendix id="portalObjectsDTD"> + <title>*-object.xml DTD</title> + <para> +<programlisting><![CDATA[ + + <?xml version="1.0" encoding="UTF-8" ?> + +<!--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ~ JBoss, a division of Red Hat ~ + ~ Copyright 2006, Red Hat Middleware, LLC, and individual ~ + ~ contributors as indicated by the @authors tag. See the ~ + ~ copyright.txt in the distribution for a full listing of ~ + ~ individual contributors. ~ + ~ ~ + ~ This is free software; you can redistribute it and/or modify it ~ + ~ under the terms of the GNU Lesser General Public License as ~ + ~ published by the Free Software Foundation; either version 2.1 of ~ + ~ the License, or (at your option) any later version. ~ + ~ ~ + ~ This software is distributed in the hope that it will be useful, ~ + ~ but WITHOUT ANY WARRANTY; without even the implied warranty of ~ + ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ~ + ~ Lesser General Public License for more details. ~ + ~ ~ + ~ You should have received a copy of the GNU Lesser General Public ~ + ~ License along with this software; if not, write to the Free ~ + ~ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA ~ + ~ 02110-1301 USA, or see the FSF site: http://www.fsf.org. ~ + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~--> + +<!-- +<!DOCTYPE deployments PUBLIC + "-//JBoss Portal//DTD Portal Object 2.6//EN" + "http://www.jboss.org/portal/dtd/portal-object_2_6.dtd"> +--> + +<!-- +The deployements element is a generic container for deployment elements. +--> +<!ELEMENT deployments (deployment*)> + +<!-- +The deployment is a generic container for portal object elements. The parent-ref +child gives the name of the parent object that the current object will use as parent. +The optional if-exists element define the behavior when a portal object which +an identical name is already child of the parent element. The default behavior of +the if-exist tag is to keep the existing object and not create a new object. The +last element is the portal object itself. + +Example: + +<deployment> + <parent-ref>default</parent-ref> + <page> + ... + </page> +</deployment> + +All portal objects have a common configuration which can be : + +1/ a listener : specifies the id of a listener is the listener registry. A listener +object is able to listen portal events which apply to the portal node hierarchy. + +2/ properties : a set of generic properties owned by the portal object. Some +properties can drive the behavior of the object. + +3/ security-constraint : defines security configuration of the portal object. + +--> +<!ELEMENT deployment (parent-ref?,if-exists?,(context|portal|page|window))> + +<!-- +Contains a reference to the parent object. The naming convention for naming object +is to concatenate the names of the path to the object and separate the names by a dot. +If the path is empty then the empty string must be used. + +Example: + +<parent-ref/> the root having an empty path + +<parent-ref>default</parent-ref> the object with the name default under the root +having the path (default) + +<parent-ref>default.default</parent-ref> the object with the path (default,default) + +--> +<!ELEMENT parent-ref (#PCDATA)> + +<!-- +The authorized values are overwrite and keep. Overwrite means that the existing +object will be destroyed and the current declaration will be used. Keep means that +the existing object will not be destroyed and no creation hence will be done. +--> +<!ELEMENT if-exists (#PCDATA)> + +<!-- +A portal object of type context. A context type represent a node in the tree which +does not have a visual representation. It can exist only under the root. A context can +only have children with the portal type. +--> +<!ELEMENT context (context-name,properties?,listener?,security-constraint?,portal*, + (display-name* | (resource-bundle, supported-locale+)))> + +<!-- +The context name value. +--> +<!ELEMENT context-name (#PCDATA)> + +<!-- +A portal object of type portal. A portal type represents a virtual portal and can +have children of type page. In addition of the common portal object elements it support +also the declaration of the modes and the window states it supports. If no declaration +of modes or window states is done then the default value will be respectively +(view,edit,help) and (normal,minimized,maximized). +--> +<!ELEMENT portal (portal-name,supported-modes,supported-window-states?,properties?, + listener?,security-constraint?,page*, + (display-name* | (resource-bundle, supported-locale+)))> + +<!-- +The portal name value. +--> +<!ELEMENT portal-name (#PCDATA)> + + +<!-- +The supported modes of a portal. + +Example: + +<supported-mode> + <mode>view</mode> + <mode>edit</mode> + <mode>help</mode> +</supported-mode> +--> +<!ELEMENT supported-modes (mode*)> + +<!-- +A portlet mode value. +--> +<!ELEMENT mode (#PCDATA)> + +<!-- +The supported window states of a portal. + +Example: + +<supported-window-states> + <window-state>normal</window-state> + <window-state>minimized</window-state> + <window-state>maximized</window-state> +</supported-window-states> + +--> +<!ELEMENT supported-window-states (window-state*)> + +<!-- +A window state value. +--> +<!ELEMENT window-state (#PCDATA)> + +<!-- +A portal object of type page. A page type represents a page which can have children of +type page and window. The children windows are the windows of the page and the children +pages are the subpages of this page. +--> +<!ELEMENT page (page-name,properties?,listener?,security-constraint?,(page|window)*, + (display-name* | (resource-bundle, supported-locale+)))> + +<!ELEMENT display-name (#PCDATA)> +<!ATTLIST display-name + xml:lang NMTOKEN #IMPLIED +> + +<!ELEMENT resource-bundle (#PCDATA)> + +<!ELEMENT supported-locale (#PCDATA)> + +<!-- +The page name value. +--> +<!ELEMENT page-name (#PCDATA)> + +<!-- +A portal object of type window. A window type represents a window. Beside the common +properties a window has a content and belong to a region on the page. + +The instance-ref or content tags are used to define the content of the window. The +usage of the content tag is generic and can be used to describe any kind of content. +The instance-ref is a shortcut to define a content type of portlet which points to a +portlet instance. + +The region and height defines how the window is placed in the page. +--> +<!ELEMENT window (window-name,(instance-ref|content),region,height, + initial-window-state?,initial-mode?,properties?,listener?, + (display-name* | (resource-bundle, supported-locale+)))> + +<!-- +The window name value. +--> +<!ELEMENT window-name (#PCDATA)> + +<!-- +Define the content of the window as a reference to a portlet instance. The value +is the id of the instance. + +Example: + +<instance-ref>MyPortletInstance</instance-ref> + +--> +<!ELEMENT instance-ref (#PCDATA)> + +<!-- +Define the content of the window in a generic manner. The content is define by +the type of the content and an URI which acts as an identificator for the content. + +Example: + +<content> + <content-type>portlet</content-type> + <content-uri>MyPortletInstance</content-uri> +</content> + +<content> + <content-type>cms</content-type> + <content-uri>/default/index.html</content-uri> +</content> + +--> +<!ELEMENT content (content-type,content-uri)> + +<!-- +The content type of the window. +--> +<!ELEMENT content-type (#PCDATA)> + +<!-- +The content URI of the window. +--> +<!ELEMENT content-uri (#PCDATA)> + +<!-- +The region the window belongs to. +--> +<!ELEMENT region (#PCDATA)> + +<!-- +The window state to use when the window is first accessed +--> +<!ELEMENT initial-window-state (#PCDATA)> + +<!-- +The mode to use when the window is first accessed +--> +<!ELEMENT initial-mode (#PCDATA)> + +<!-- +The height of the window in the particular region. +--> +<!ELEMENT height (#PCDATA)> + +<!-- +Define a listener for a portal object. The value is the id of the listener. +--> +<!ELEMENT listener (#PCDATA)> + +<!-- +A set of generic properties for the portal object. +--> +<!ELEMENT properties (property*)> + +<!-- +A generic string property. +--> +<!ELEMENT property (name,value)> + +<!-- +A name value. +--> +<!ELEMENT name (#PCDATA)> + +<!-- +A value. +--> +<!ELEMENT value (#PCDATA)> + +<!-- +The security-constraint element is a container for policy-permission elements + +Examples: + +<security-constraint> + <policy-permission> + <role-name>User</role-name> + <action-name>view</action-name> + </policy-permission> +</security-constraint> + +<security-constraint> + <policy-permission> + <unchecked/> + <action-name>view</action-name> + </policy-permission> +</security-constraint> +--> +<!ELEMENT security-constraint (policy-permission*)> + +<!-- +The policy-permission element is used to secure a specific portal page based on a +user's role. +--> +<!ELEMENT policy-permission (action-name*,unchecked?,role-name*)> + +<!-- +The role-name element is used to define a role that this security constraint will apply to + + * <role-name>SOMEROLE</role-name> Access to this portal page is limited to the defined role. +--> +<!ELEMENT action-name (#PCDATA)> + +<!-- +The unchecked element is used to define (if present) that anyone can view this portal page +--> +<!ELEMENT unchecked EMPTY> + +<!-- +The action-name element is used to define the access rights given to the role defined. +Possible values are: + + * view - Users can view the page. +--> +<!ELEMENT role-name (#PCDATA)> + + +]]></programlisting> + </para> +</appendix> + \ No newline at end of file Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portalapi.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portalapi.xml 2007-11-26 14:29:16 UTC (rev 9108) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portalapi.xml 2007-11-26 14:52:55 UTC (rev 9109) @@ -587,7 +587,9 @@ optional-attribute-name="Registry" proxy-type="attribute">portal:service=ListenerRegistry</depends> <attribute name="RegistryId">test_listener</attribute> - <attribute name="ListenerClassName">org.jboss.portal.core.samples.basic.event.PortletB$Listener</attribute> + <attribute name="ListenerClassName"> + org.jboss.portal.core.samples.basic.event.PortletB$Listener + </attribute> </mbean>]]></programlisting> For node events, we also need to declare on which node we want to listen, this is done by modifying the <literal>*-object.xml</literal> that defines your portal nodes. In this example we want to trigger Added: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portletInstancesDTD.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portletInstancesDTD.xml (rev 0) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/portletInstancesDTD.xml 2007-11-26 14:52:55 UTC (rev 9109) @@ -0,0 +1,191 @@ + + +<!-- DO NOT EDIT ME DIRECTLY, I AM GENERATED FROM THE DTD USING THE dtd2docbook ANT TASK --> +<appendix id="portletInstancesDTD"> + <title>portlet-instances.xml DTD</title> + <para> +<programlisting><![CDATA[ + + <?xml version="1.0" encoding="UTF-8" ?> + +<!--~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ~ JBoss, a division of Red Hat ~ + ~ Copyright 2006, Red Hat Middleware, LLC, and individual ~ + ~ contributors as indicated by the @authors tag. See the ~ + ~ copyright.txt in the distribution for a full listing of ~ + ~ individual contributors. ~ + ~ ~ + ~ This is free software; you can redistribute it and/or modify it ~ + ~ under the terms of the GNU Lesser General Public License as ~ + ~ published by the Free Software Foundation; either version 2.1 of ~ + ~ the License, or (at your option) any later version. ~ + ~ ~ + ~ This software is distributed in the hope that it will be useful, ~ + ~ but WITHOUT ANY WARRANTY; without even the implied warranty of ~ + ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ~ + ~ Lesser General Public License for more details. ~ + ~ ~ + ~ You should have received a copy of the GNU Lesser General Public ~ + ~ License along with this software; if not, write to the Free ~ + ~ Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA ~ + ~ 02110-1301 USA, or see the FSF site: http://www.fsf.org. ~ + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~--> + +<!-- +<!DOCTYPE deployments PUBLIC + "-//JBoss Portal//DTD Portlet Instances 2.6//EN" + "http://www.jboss.org/portal/dtd/portlet-instances_2_6.dtd"> +--> + +<!-- +The deployements element is a container for deployment elements. +--> +<!ELEMENT deployments (deployment*)> + +<!-- +The deployment is a container for an instance element. +--> +<!ELEMENT deployment (if-exists?,instance)> + +<!-- +The if-exists element is used to define action to take if instance with such name is +already present. Possible values are overwrite or keep . Overwrite will destroy the +existing object in the database and create a new one, based on the content of the +deployment. Keep will maintain the existing object deployment or create a new one if +it does not yet exist. +--> +<!ELEMENT if-exists (#PCDATA)> + +<!-- +The instance element is used to create an instance of a portlet from the portlet +application of the same war file containing the portlet-instances.xml file. The portlet +will be created and configured only if the portlet is present and an instance with +such a name does not already exist. + +Example : + +<instance> + <instance-id>MyPortletInstance</instance-id> + <portlet-ref>MyPortlet</portlet-ref> + <preferences> + <preference> + <name>abc</name> + <value>def</value> + </preference> + </preferences> + <security-constraint> + <policy-permission> + <role-name>User</role-name> + <action-name>view</action-name> + </policy-permission> + </security-constraint> +</instance> + +--> +<!ELEMENT instance (instance-id,portlet-ref,display-name*,preferences?, + security-constraint?, (display-name* | (resource-bundle, supported-locale+)))> + +<!ELEMENT display-name (#PCDATA)> +<!ATTLIST display-name + xml:lang NMTOKEN #IMPLIED +> + +<!ELEMENT resource-bundle (#PCDATA)> + +<!ELEMENT supported-locale (#PCDATA)> + + +<!-- +The identifier of the instance. +--> +<!ELEMENT instance-id (#PCDATA)> + +<!-- +The reference to the portlet which is its portlet name. +--> +<!ELEMENT portlet-ref (#PCDATA)> + +<!-- +Display name is the string used to represent this instance +--> +<!ELEMENT display-name (#PCDATA)> +<!ATTLIST display-name + xml:lang NMTOKEN #IMPLIED +> + +<!-- +The preferences element configures the instance with a specific set of preferences. +--> +<!ELEMENT preferences (preference+)> + +<!-- +The preference configure one preference of a set of preferences. +--> +<!ELEMENT preference (name,value)> + +<!-- +A name. +--> +<!ELEMENT name (#PCDATA)> + +<!-- +A string value. +--> +<!ELEMENT value (#PCDATA)> + +<!-- +The security-constraint element is a container for policy-permission elements + +Examples: + +<security-constraint> + <policy-permission> + <role-name>User</role-name> + <action-name>view</action-name> + </policy-permission> +</security-constraint> + +<security-constraint> + <policy-permission> + <unchecked/> + <action-name>view</action-name> + </policy-permission> +</security-constraint> +--> +<!ELEMENT security-constraint (policy-permission*)> + +<!-- +The policy-permission element is used to secure a specific portlet instance based on a +user's role. +--> +<!ELEMENT policy-permission (action-name*,unchecked?,role-name*)> + +<!-- +The action-name element is used to define the access rights given to the role defined. +Possible values are: + + * view - Users can view the page. + * viewrecursive - Users can view the page and child pages. + * personalize - Users are able to view AND personalize the page. + * personalizerecursive - Users are able to view AND personalize the page AND its child + pages. +--> +<!ELEMENT action-name (#PCDATA)> + +<!-- +The unchecked element is used to define (if present) that anyone can view this instance +--> +<!ELEMENT unchecked EMPTY> + +<!-- +The role-name element is used to define a role that this security constraint will apply to + + * <role-name>SOMEROLE</role-name> Access to this instance is limited to the defined role. +--> +<!ELEMENT role-name (#PCDATA)> + + +]]></programlisting> + </para> +</appendix> + \ No newline at end of file Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/supported.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/supported.xml 2007-11-26 14:29:16 UTC (rev 9108) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/supported.xml 2007-11-26 14:52:55 UTC (rev 9109) @@ -20,15 +20,12 @@ <title>Minimum System Requirements</title> <para> <itemizedlist> - <listitem>JDK 1.4 or JDK 5 (JDK 6 is not part of the test platform)</listitem> + <listitem>JDK 5 (JDK 6 is not part of the test platform)</listitem> <listitem>512 MB RAM</listitem> <listitem>100 MB hard disk space</listitem> <listitem>400 MHz CPU</listitem> </itemizedlist> </para> - <warning> - <para>JBoss Portal 2.6.2 is the last release to support JDK 1.4.</para> - </warning> </sect1> <sect1> <title>Supported Operating Systems</title> @@ -38,13 +35,11 @@ </sect1> <sect1> <title>JBoss Application Server</title> - <para>JBoss Portal 2.6.2 is tested with JBoss AS 4.0.5, JBoss AS 4.2.1 and JBoss EAP 4.2. It is - highly recommended to use JBoss Portal 2.6.2 with JBoss Enterprise Application Platform 4.2 for - customers who have access to it through the support portal and JBoss AS 4.2.1 for everybody else.</para> + <para>JBoss Portal 2.6.3 is tested with JBoss AS 4.2.1, JBoss AS 4.2.2 and JBoss EAP 4.2. It is + highly recommended to use JBoss Portal 2.6.3 with JBoss Enterprise Application Platform 4.2 for + customers who have access to it through the support portal and JBoss AS 4.2.2 for everybody else.</para> <warning> - <para> Versions before 4.0.4 of JBoss Application Server are not supported with this version of JBoss Portal. - And JBoss AS 4.0.5 will not be supported in newer release of JBoss Portal. - </para> + <para>4.0.x versions are not supported</para> </warning> </sect1> <sect1 id="supportedversions-db"> 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 2007-11-26 14:29:16 UTC (rev 9108) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2007-11-26 14:52:55 UTC (rev 9109) @@ -479,7 +479,7 @@ Deploying a portlet is as simple as copying/moving <literal>helloworldportlet.war</literal> to your server <literal>deploy</literal> directory. Doing this on a running instance of JBoss Portal and application server, will trigger a <emphasis>hot-deploy</emphasis> of your portlet: - <programlisting><![CDATA[18:25:56,366 INFO [Server] JBoss (MX MicroKernel) [4.0.5.GA (build: + <programlisting><![CDATA[18:25:56,366 INFO [Server] JBoss (MX MicroKernel) [4.2.2.GA (build: CVSTag=JBoss_4_0_5_GA date=2006000000)] Started in 1m:3s:688ms 18:26:21,147 INFO [TomcatDeployer] deploy, ctxPath=/helloworldportlet, warUrl=.../tmp/deploy/tmp35219helloworldportlet-exp.war/]]></programlisting> @@ -1149,7 +1149,7 @@ </mediaobject> </para> </sect2> - <sect2 id="richfaces"> + <!-- sect2 id="richfaces"> <title>Portal and RichFaces: A basic demonstration using Ajax4JSF and RichFaces components</title> <sect3> <para> @@ -1160,9 +1160,9 @@ <title>Downloading The Binaries or Project Source</title> <para> You have 2 options for getting started. - <!--<para> + <-<para> For instructions on setting up Subversion and/or Maven 2 see <xref linkend="build_instructions"/> - </para>--> + </para>-> <itemizedlist> <listitem> <para> @@ -1283,6 +1283,6 @@ </itemizedlist> </para> </sect3> - </sect2> + </sect2--> </sect1> </chapter> \ No newline at end of file