Author: thomas.heute(a)jboss.com Date: 2008-07-07 16:53:32 -0400 (Mon, 07 Jul 2008) New Revision: 11335 Added: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/images/common/ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/images/common/frontpage.png Removed: docs/branches/JBoss_Portal_Branch_2_7/common/en/images/ Modified: docs/branches/JBoss_Portal_Branch_2_7/common/en/modules/overview.xml docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/images/ajax/partial-refresh-admin.png docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/images/ajax/partial-refresh.png docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/master.xml docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/ajax.xml docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/installation.xml docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/pom.xml Log: Migrating to new docbook features (syntax coloration and image resizing) Modified: docs/branches/JBoss_Portal_Branch_2_7/common/en/modules/overview.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_7/common/en/modules/overview.xml 2008-07-07 20:47:30 UTC (rev 11334) +++ docs/branches/JBoss_Portal_Branch_2_7/common/en/modules/overview.xml 2008-07-07 20:53:32 UTC (rev 11335) @@ -2,7 +2,7 @@ <title>JBoss Portal - Overview</title> <para> <imageobject> - <imagedata fileref="images/frontpage.png" format="png" align="center" + <imagedata fileref="images/common/frontpage.png" format="png" align="center" valign="middle"/> </imageobject> </para> Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/images/ajax/partial-refresh-admin.png =================================================================== (Binary files differ) Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/images/ajax/partial-refresh.png =================================================================== (Binary files differ) Added: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/images/common/frontpage.png =================================================================== (Binary files differ) Property changes on: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/images/common/frontpage.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/master.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/master.xml 2008-07-07 20:47:30 UTC (rev 11334) +++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/master.xml 2008-07-07 20:53:32 UTC (rev 11335) @@ -1,42 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" - "../../docbook-support/support/docbook-dtd/docbookx.dtd" [ - <!ENTITY trademarks SYSTEM "modules/trademarks.xml"> - <!ENTITY overview SYSTEM "../../common/en/modules/overview.xml"> - <!ENTITY featurelist SYSTEM "../../common/en/modules/featurelist.xml"> - <!ENTITY target SYSTEM "modules/target.xml"> - <!ENTITY acknowledgements SYSTEM "../../common/en/modules/acknowledgements.xml"> - <!ENTITY supported SYSTEM "modules/supported.xml"> - <!ENTITY installation SYSTEM "modules/installation.xml"> - <!ENTITY configuration SYSTEM "modules/configuration.xml"> - <!ENTITY migration SYSTEM "modules/migration.xml"> - <!ENTITY tutorials SYSTEM "modules/tutorials.xml"> - <!ENTITY xmldescriptors SYSTEM "modules/xmldescriptors.xml"> - <!ENTITY urls SYSTEM "modules/urls.xml"> - <!ENTITY CMS SYSTEM "modules/cmsPortlet.xml"> - <!ENTITY workflow SYSTEM "modules/workflow.xml"> - <!ENTITY navtabs SYSTEM "modules/navtabs.xml"> - <!ENTITY themeandlayouts SYSTEM "modules/themeandlayouts.xml"> - <!ENTITY ajax SYSTEM "modules/ajax.xml"> - <!ENTITY identity SYSTEM "modules/identity.xml"> - <!ENTITY identityportlets SYSTEM "modules/identityportlets.xml"> - <!ENTITY authentication SYSTEM "modules/authentication.xml"> - <!ENTITY ldap SYSTEM "modules/ldap.xml"> - <!ENTITY sso SYSTEM "modules/sso.xml"> - <!ENTITY clustering SYSTEM "modules/clustering.xml"> - <!ENTITY wsrp SYSTEM "modules/wsrp.xml"> - <!ENTITY security SYSTEM "modules/security.xml"> - <!ENTITY troubleshooting SYSTEM "modules/troubleshooting.xml"> - <!ENTITY contentintegration SYSTEM "modules/contentintegration.xml"> - <!ENTITY widgetintegration SYSTEM "modules/widgetintegration.xml"> - <!ENTITY portalapi SYSTEM "modules/portalapi.xml"> - <!ENTITY errorhandling SYSTEM "modules/errorhandling.xml"> - <!ENTITY portletmodes SYSTEM "modules/portletmodes.xml"> - <!ENTITY portalObjectsDTD SYSTEM "modules/portalObjectsDTD.xml"> - <!ENTITY portletInstancesDTD SYSTEM "modules/portletInstancesDTD.xml"> - <!ENTITY jbossPortletDTD SYSTEM "modules/jbossPortletDTD.xml"> - ]> -<book lang="en"> + "../../docbook-support/support/docbook-dtd/docbookx.dtd" + > +<book lang="en" xmlns:xi="http://www.w3.org/2001/XInclude"> <bookinfo> <title><trademark class="registered">JBoss</trademark> Portal 2.7.0</title> <subtitle>Reference Guide</subtitle> @@ -73,39 +39,40 @@ </author> </bookinfo> <toc/> - <!-- Trademark - Trying to make all vendor legal teams happy --> &trademarks; - <!-- Portal overview - marketing stuff --> &overview; - <!-- Comprehensive list of included features --> &featurelist; - <!-- Target audience of this document --> &target; - <!-- Thanks for all the fish --> &acknowledgements; - <!-- Support AS, OS, DB listings --> &supported; - <!-- Installation guide --> &installation; - <!-- Configuration --> &configuration; - <!-- Upgrading and migration issues --> &migration; - <!-- Portlet tutorials --> &tutorials; - <!-- Deployment desc --> &xmldescriptors; - <!-- Understanding urls --> &urls; - <!-- Error handling --> &errorhandling; - <!-- Content integration --> &contentintegration; - <!-- Widget integration --> &widgetintegration; - <!-- Portlet modes --> &portletmodes; - <!-- Portal API --> &portalapi; - <!-- Clustering configuration --> &clustering; - <!-- WSRP --> &wsrp; - <!-- Security administration --> &security; - <!-- Identity --> &identity; - <!-- Identity Portlets --> &identityportlets; - <!-- Authentication --> &authentication; - <!-- LDAP --> &ldap; - <!-- SSO --> &sso; - <!-- CMS --> &CMS; - <!-- Workflow --> &workflow; - <!-- NavTabs --> &navtabs; - <!-- Theme/layout api --> &themeandlayouts; - <!-- Ajax --> &ajax; - <!-- Troubleshooting FAQ--> &troubleshooting; - &portalObjectsDTD; - &portletInstancesDTD; - &jbossPortletDTD; + <xi:include href="modules/trademarks.xml" /> + <xi:include href="../../common/en/modules/overview.xml" /> + <xi:include href="../../common/en/modules/featurelist.xml" /> + <xi:include href="modules/target.xml" /> + <xi:include href="../../common/en/modules/acknowledgements.xml" /> + <xi:include href="modules/supported.xml" /> + <xi:include href="modules/installation.xml" /> + <xi:include href="modules/configuration.xml" /> + <xi:include href="modules/migration.xml" /> + <xi:include href="modules/tutorials.xml" /> + <xi:include href="modules/xmldescriptors.xml" /> + <xi:include href="modules/urls.xml" /> + <xi:include href="modules/errorhandling.xml" /> + <xi:include href="modules/contentintegration.xml" /> + <xi:include href="modules/widgetintegration.xml" /> + <xi:include href="modules/portletmodes.xml" /> + <xi:include href="modules/portalapi.xml" /> + <xi:include href="modules/clustering.xml" /> + <xi:include href="modules/wsrp.xml" /> + <xi:include href="modules/security.xml" /> + <xi:include href="modules/identity.xml" /> + <xi:include href="modules/identityportlets.xml" /> + <xi:include href="modules/authentication.xml" /> + <xi:include href="modules/ldap.xml" /> + <xi:include href="modules/sso.xml" /> + <xi:include href="modules/cmsPortlet.xml" /> + <xi:include href="modules/workflow.xml" /> + <xi:include href="modules/navtabs.xml" /> + <xi:include href="modules/themeandlayouts.xml" /> + <xi:include href="modules/ajax.xml" /> + <xi:include href="modules/troubleshooting.xml" /> + <xi:include href="modules/portalObjectsDTD.xml" /> + <xi:include href="modules/portletInstancesDTD.xml" /> + <xi:include href="modules/jbossPortletDTD.xml" /> + </book> Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/ajax.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/ajax.xml 2008-07-07 20:47:30 UTC (rev 11334) +++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/ajax.xml 2008-07-07 20:53:32 UTC (rev 11335) @@ -1,4 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.docbook.org/xml/4.5/docbookx.dtd"> <chapter id="ajax"> <chapterinfo> <author> @@ -73,12 +75,12 @@ </html> ]]></programlisting> <itemizedlist> - <listitem><![CDATA[<p:theme themeName="renaissance"/>]]> should be already present as it exists since 2.4 but is even more - necessary as it will inject in the page the reference to the ajax stylesheet.</listitem> - <listitem><![CDATA[<p:region regionName='AJAXScripts' regionID='AJAXScripts'/>]]> should be added before any other region - in the markup of the layout.</listitem> - <listitem><![CDATA[<p:region regionName='AJAXFooter' regionID='AJAXFooter'/>]]> should be added after any other region - in the markup of the layout.</listitem> + <listitem><para><![CDATA[<p:theme themeName="renaissance"/>]]> should be already present as it exists since 2.4 but is even more + necessary as it will inject in the page the reference to the ajax stylesheet.</para></listitem> + <listitem><para><![CDATA[<p:region regionName='AJAXScripts' regionID='AJAXScripts'/>]]> should be added before any other region + in the markup of the layout.</para></listitem> + <listitem><para><![CDATA[<p:region regionName='AJAXFooter' regionID='AJAXFooter'/>]]> should be added after any other region + in the markup of the layout.</para></listitem> </itemizedlist> </para> </sect2> @@ -87,7 +89,7 @@ <para>At runtime the portal combines the layout and the renderers in order create the markup returned to the web browser. The most used render set is the divRenderer. Renderers only need a modification in the deployment descriptor to indicate that they support ajax. Here is the declaration of the default divRenderer now in 2.6:</para> - <programlisting><![CDATA[ + <programlisting role="XML"><![CDATA[ <renderSet name="divRenderer"> <set content-type="text/html"> <ajax-enabled>true</ajax-enabled> @@ -119,7 +121,7 @@ to its user.</para> <para>In the file <emphasis>jboss-portal.sar/conf/data/default-object.xml</emphasis> is declared and configured the creation of the dashboard portal:</para> - <programlisting><![CDATA[ + <programlisting role="XML"><![CDATA[ <deployment> <parent-ref/> <if-exists>keep</if-exists> @@ -148,7 +150,7 @@ to detect which portlets needs to be refreshed and will update only these portlets.</para> <mediaobject> <imageobject> - <imagedata align="center" fileref="images/ajax/partial-refresh.png" format="png"/> + <imagedata fileref="images/ajax/partial-refresh.png" format="PNG" scalefit="1"/> </imageobject> <caption> <para>The portal providing partial refresh</para> @@ -162,7 +164,7 @@ it is automatically inherited by the sub hierarchy located under that object. By default the drag and drop feature is positioned on the dashboard object and not on the rest of the portal objects. </para> - <programlisting><![CDATA[ + <programlisting role="XML"><![CDATA[ <deployment> <parent-ref/> <if-exists>keep</if-exists> @@ -181,17 +183,17 @@ </deployment> ]]></programlisting> <note> - The partial page refresh feature is compatible with the Portal API. The Portal API allows programmatic + <para>The partial page refresh feature is compatible with the Portal API. The Portal API allows programmatic update of the state of portlets at runtime. For instance it is possible to modify the window state or the mode of several portlets on a given page. When such event occurs, the portal detects the changes - which occurred and will update the portlet fragments in the page. + which occurred and will update the portlet fragments in the page.</para> </note> <para>It is possible to change that behavior at runtime using the property editor of the management portlet. If you want to enable partial refreshing on the default portal you should set the property to true directly on the portal and all the pages in that portal will automatically inherit those properties.</para> <mediaobject> <imageobject> - <imagedata align="center" fileref="images/ajax/partial-refresh-admin.png" format="png"/> + <imagedata fileref="images/ajax/partial-refresh-admin.png" format="PNG" scalefit="1"/> </imageobject> <caption> <para>The default portal configured for partial page refresh</para> @@ -218,15 +220,15 @@ <listitem> <para>Form uploads are not handled.</para> </listitem> - <listitem>Having an interaction that deals with the <emphasis>MAXIMIZED</emphasis> window state. + <listitem><para>Having an interaction that deals with the <emphasis>MAXIMIZED</emphasis> window state. When a window is entering a maximized state or leaving a maximized window state, the portal will - perform a full page refresh.</listitem> + perform a full page refresh.</para></listitem> </itemizedlist> </para> <para>It can happen that a portlet does not want to support partial refreshing, in those situations the <emphasis>jboss-portlet.xml</emphasis> can be used to control that behavior. Since 2.6 an ajax section has been added in order to configure ajax features related to the portlet.</para> - <programlisting><![CDATA[ + <programlisting role="XML"><![CDATA[ <portlet> <portlet-name>MyPortletNoAjax</portlet-name> <ajax> @@ -256,7 +258,7 @@ emission of an event then JBoss Portal will not be able to transform it into a partial refresh and it will result instead of a full refresh. This can happen with programmatic submission of forms. </para> - <programlisting><![CDATA[ + <programlisting role="XHTML"><![CDATA[ <form id="<%= formId %>" action="<%= renderResponse.createActionURL() %>" method="post"> ... <select onclick="document.getElementById('<%= formId %>').submit()"> 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-07 20:47:30 UTC (rev 11334) +++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/installation.xml 2008-07-07 20:53:32 UTC (rev 11335) @@ -221,7 +221,7 @@ <para> <mediaobject> <imageobject> - <imagedata align="center" valign="middle" fileref="images/frontpage.png"/> + <imagedata align="center" valign="middle" fileref="images/common/frontpage.png"/> </imageobject> </mediaobject> </para> @@ -369,7 +369,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="modules/extras/runconf_javaops.xmlt" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... +<screen><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> @@ -514,7 +514,7 @@ <para> <mediaobject> <imageobject> - <imagedata align="center" valign="middle" fileref="images/frontpage.png"/> + <imagedata align="center" valign="middle" fileref="images/common/frontpage.png"/> </imageobject> </mediaobject> </para> Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/pom.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/pom.xml 2008-07-07 20:47:30 UTC (rev 11334) +++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/pom.xml 2008-07-07 20:53:32 UTC (rev 11335) @@ -5,9 +5,9 @@ <modelVersion>4.0.0</modelVersion> <parent> - <groupId>org.jboss</groupId> - <artifactId>documentation</artifactId> - <version>1.0</version> + <groupId>org.jboss.portal</groupId> + <artifactId>jboss-portal-docs-parent</artifactId> + <version>1-SNAPSHOT</version> </parent> <repositories>