[gatein-commits] gatein SVN: r8931 - in epp/docs/branches/6.0/Reference_Guide/en-US: extras/Advanced_Development_Foundations and 17 other directories.

Author: ppenicka Date: 2012-10-22 17:23:56 -0400 (Mon, 22 Oct 2012) New Revision: 8931 Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_Foundations/default2.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/orig.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_external-value-storages/default25.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_lock-manager-config/default50.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_lock-manager-config/default51.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_lock-manager-config/you.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_search-configuration/default62.java epp/docs/branches/6.0/Reference_Guide/en-US/extras/Authentication_Identity_AuthenticationTokenConfiguration/default95.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/Authentication_Identity_LDAP/default-ldap.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/Authentication_Identity_LDAP/readonly-opends.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/subpage.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortalDevelopment_InternationalizationConfiguration/default151.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortalDevelopment_Skinning/default184.java epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/SimplestHelloWorldPortlet.java epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/default245.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/default252.xml epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/default254.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/exojcr-backup-service.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/workspace-persistence-storage.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/lock-manager-config.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-creation-service.xml Log: Replaced callouts in all code examples with code comments. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -7,6 +7,19 @@ <title>Revision History</title> <simpara> <revhistory> + <revision> + <revnumber>6.0.0-8</revnumber> + <date>Mon Oct 22 2012</date> + <author> + <firstname>Petr</firstname> + <surname>Penicka</surname> + <email/> + </author> + <revdescription> + <simplelist> + <member>Replaced callouts in all code examples with code comments.</member> + </revdescription> + </revision> <revision> <revnumber>6.0.0-7</revnumber> <date>Fri Oct 22 2012</date> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_Foundations/default2.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_Foundations/default2.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_Foundations/default2.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -2,7 +2,7 @@ xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd"> - + <!-- Comment #1 --> <import>war:/conf/sample-ext/jcr/jcr-configuration.xml</import> <import>war:/conf/sample-ext/portal/portal-configuration.xml</import> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/orig.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/orig.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_Configuration/orig.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -1,16 +1,22 @@ +<!-- The name of the default repository (the one returned by RepositoryService.getRepository() ). --> <repository-service default-repository="repository"> + <!-- The list of repositories. --> <repositories> + <!-- Parameters left to right: the name of a repository, the name of workspace where /jcr:system node is placed and the name of the workspace obtained using Session's login() or login(Credentials) methods (the ones without an explicit workspace name). --> <repository name="repository" system-workspace="system" default-workspace="portal-system"> + <!-- The name of a security domain for JAAS authentication. --> <security-domain>gatein-domain</security-domain> + <!-- The name of an access control policy. There can be 3 types: optional - ACL is created on-demand(default), disable - no access control, mandatory - an ACL is created for each added node(not supported yet). --> <access-control>optional</access-control> + <!-- The name of an authentication policy class. --> <authentication-policy>org.exoplatform.services.jcr.impl.core.access.JAASAuthenticator</authentication-policy> ... - <!-- System --> + <!-- The list of workspaces. --> <workspaces> ... - - <!-- Portal system data --> + <!-- The name of the workspace. --> <workspace name="portal-system"> + <!-- Workspace data container (physical storage) configuration. --> <container class="org.exoplatform.services.jcr.impl.storage.jdbc.optimisation.CQJDBCWorkspaceDataContainer"> <properties> <property name="source-name" value="${gatein.jcr.datasource.name}${container.name.suffix}"/> @@ -31,12 +37,14 @@ </value-storage> </value-storages> </container> + <!-- Workspace initializer configuration. --> <initializer class="org.exoplatform.services.jcr.impl.core.ScratchWorkspaceInitializer"> <properties> <property name="root-nodetype" value="nt:unstructured"/> <property name="root-permissions" value="*:/platform/administrators read;*:/platform/administrators add_node;*:/platform/administrators set_property;*:/platform/administrators remove"/> </properties> </initializer> + <!-- Workspace storage cache configuration. --> <cache enabled="true" class="org.exoplatform.services.jcr.impl.dataflow.persistent.jbosscache.JBossCacheWorkspaceStorageCache"> <properties> <property name="jbosscache-configuration" value="${gatein.jcr.cache.config}" /> @@ -45,6 +53,7 @@ <property name="jbosscache-cluster-name" value="jcr-${container.name.suffix}-portal-system" /> </properties> </cache> + <!-- Query handler configuration. --> <query-handler class="org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex"> <properties> <property name="index-dir" value="${gatein.jcr.index.data.dir}/portal-system${container.name.suffix}"/> @@ -58,6 +67,7 @@ </query-handler> <lock-manager class="org.exoplatform.services.jcr.impl.core.lock.jbosscache.CacheableLockManagerImpl"> <properties> + <!-- The amount of time before the unused global lock is removed. --> <property name="time-out" value="15m" /> <property name="jbosscache-configuration" value="${gatein.jcr.lock.cache.config}" /> <property name="jgroups-configuration" value="${gatein.jcr.jgroups.config}" /> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_external-value-storages/default25.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_external-value-storages/default25.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_external-value-storages/default25.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -1,5 +1,7 @@ +<!-- Comment #1 --> <value-storage id="Storage #1" class="org.exoplatform.services.jcr.impl.storage.value.fs.TreeFileValueStorage"> + <!-- Comment #2 --> <properties> <property name="path" value="data/values"/> </properties> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_lock-manager-config/default50.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_lock-manager-config/default50.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_lock-manager-config/default50.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -2,7 +2,7 @@ <jbosscache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:jboss:jbosscache-core:config:3.2"> <locking useLockStriping="false" concurrencyLevel="50000" lockParentForChildInsertRemove="false" lockAcquisitionTimeout="20000" /> - + <!-- Comment #1 --> <clustering mode="replication" clusterName="JBoss-Cache-Lock-Cluster_Name"> <stateRetrieval timeout="20000" fetchInMemoryState="false" nonBlocking="true" /> <jgroupsConfig> @@ -38,13 +38,16 @@ </preload> <loader class="org.jboss.cache.loader.JDBCCacheLoader" async="false" fetchPersistentState="false" ignoreModifications="false" purgeOnStartup="false"> <properties> + <!-- Comment #2 --> cache.jdbc.table.name=jcrlocks_ws cache.jdbc.table.create=true cache.jdbc.table.drop=false cache.jdbc.table.primarykey=jcrlocks_ws_pk cache.jdbc.fqn.column=fqn + <!-- Comment #3 --> cache.jdbc.fqn.type=VARCHAR(512) cache.jdbc.node.column=node + <!-- Comment #3 --> cache.jdbc.node.type=<BLOB> cache.jdbc.parent.column=parent cache.jdbc.datasource=jdbcjcr Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_lock-manager-config/default51.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_lock-manager-config/default51.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_lock-manager-config/default51.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -2,6 +2,7 @@ <properties> <property name="time-out" value="15m" /> <property name="jbosscache-configuration" value="test-jbosscache-lock.xml" /> + <!-- Comment #1 --> <property name="jgroups-configuration" value="udp-mux.xml" /> <property name="jgroups-multiplexer-stack" value="true" /> <property name="jbosscache-cluster-name" value="JCR-cluster-locks-ws" /> @@ -9,9 +10,11 @@ <property name="jbosscache-cl-cache.jdbc.table.create" value="true" /> <property name="jbosscache-cl-cache.jdbc.table.drop" value="false" /> <property name="jbosscache-cl-cache.jdbc.table.primarykey" value="jcrlocks_ws_pk" /> + <!-- Comment #2 --> <property name="jbosscache-cl-cache.jdbc.fqn.column" value="fqn" /> <property name="jbosscache-cl-cache.jdbc.fqn.type" value="AUTO"/> <property name="jbosscache-cl-cache.jdbc.node.column" value="node" /> + <!-- Comment #2 --> <property name="jbosscache-cl-cache.jdbc.node.type" value="AUTO"/> <property name="jbosscache-cl-cache.jdbc.parent.column" value="parent" /> <property name="jbosscache-cl-cache.jdbc.datasource" value="jdbcjcr" /> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_lock-manager-config/you.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_lock-manager-config/you.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_lock-manager-config/you.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -21,7 +21,8 @@ --> <loader class="org.jboss.cache.loader.JDBCCacheLoader" async="false" fetchPersistentState="false" ignoreModifications="false" purgeOnStartup="false"> - <properties> + <!-- All the configurable parameters in this file are populated with templates which will be replaced with LockManager configuration parameters. --> + <properties> cache.jdbc.table.name=${jbosscache-cl-cache.jdbc.table.name} cache.jdbc.table.create=${jbosscache-cl-cache.jdbc.table.create} cache.jdbc.table.drop=${jbosscache-cl-cache.jdbc.table.drop} Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_search-configuration/default62.java =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_search-configuration/default62.java 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/Advanced_Development_JCR_search-configuration/default62.java 2012-10-22 21:23:56 UTC (rev 8931) @@ -1,8 +1,11 @@ public TokenStream tokenStream(String fieldName, Reader reader) { StandardTokenizer tokenStream = new StandardTokenizer(reader, replaceInvalidAcronym); tokenStream.setMaxTokenLength(maxTokenLength); + // Comment #1 TokenStream result = new StandardFilter(tokenStream); + // Comment #2 result = new LowerCaseFilter(result); + // Comment #3 result = new StopFilter(result, stopSet); return result; } Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/Authentication_Identity_AuthenticationTokenConfiguration/default95.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/Authentication_Identity_AuthenticationTokenConfiguration/default95.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/Authentication_Identity_AuthenticationTokenConfiguration/default95.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -4,8 +4,11 @@ <init-params> <values-param> <name>service.configuration</name> + <!-- Service name --> <value>jcr-token</value> + <!-- Amount of time --> <value>7</value> + <!-- Unit of time --> <value>DAY</value> <value>autologin</value> </values-param> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/Authentication_Identity_LDAP/default-ldap.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/Authentication_Identity_LDAP/default-ldap.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/Authentication_Identity_LDAP/default-ldap.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -7,6 +7,7 @@ <identity-store-mappings> <identity-store-mapping> <identity-store-id>PortalLDAPStore</identity-store-id> + <!-- Comment #1 --> <identity-object-types> <identity-object-type>USER</identity-object-type> <identity-object-type>platform_type</identity-object-type> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/Authentication_Identity_LDAP/readonly-opends.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/Authentication_Identity_LDAP/readonly-opends.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/Authentication_Identity_LDAP/readonly-opends.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -7,11 +7,13 @@ <identity-store-mappings> <identity-store-mapping> <identity-store-id>PortalLDAPStore</identity-store-id> + <!-- Comment #1 --> <identity-object-types> <identity-object-type>USER</identity-object-type> <identity-object-type>acme_roles_type</identity-object-type> <identity-object-type>acme_ou_type</identity-object-type> </identity-object-types> + <!-- Comment #2 --> <options> <option> <name>readOnly</name> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/subpage.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/subpage.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/subpage.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -6,6 +6,7 @@ <visibility>DISPLAYED</visibility> <page-reference>portal::classic::page</page-reference> <node> + <!-- This element defines the parent/child relationship between a node and a subnode. --> <uri>page/subpage</uri> <name>subpage</name> <label>Sub-page</label> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortalDevelopment_InternationalizationConfiguration/default151.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortalDevelopment_InternationalizationConfiguration/default151.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortalDevelopment_InternationalizationConfiguration/default151.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -2,6 +2,7 @@ <key>org.exoplatform.services.resources.ResourceBundleService</key> <type>org.exoplatform.services.resources.impl.SimpleResourceBundleService</type> <init-params> + <!-- Comment #1 --> <values-param> <name>classpath.resources</name> <description>The resources that start with the following package name should be load from file system</description> @@ -20,6 +21,7 @@ <value>locale.navigation.group.platform.guests</value> <value>locale.navigation.group.organization.management.executive-board</value> </values-param> + <!-- Comment #2 --> <values-param> <name>portal.resource.names</name> <description>The properties files of the portal , those file will be merged Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortalDevelopment_Skinning/default184.java =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortalDevelopment_Skinning/default184.java 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortalDevelopment_Skinning/default184.java 2012-10-22 21:23:56 UTC (rev 8931) @@ -1,5 +1,8 @@ +/* Skin for the main portal page */ @import url(DefaultSkin/portal/webui/component/UIPortalApplicationSkin.css); +/* Skins for various portal components */ @import url(DefaultSkin/webui/component/Stylesheet.css); +/* Window decoration skins */ @import url(PortletThemes/Stylesheet.css); +/* The portlet specification CSS classes */ @import url(Portlet/Stylesheet.css); - Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/SimplestHelloWorldPortlet.java =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/SimplestHelloWorldPortlet.java 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/SimplestHelloWorldPortlet.java 2012-10-22 21:23:56 UTC (rev 8931) @@ -2,17 +2,21 @@ import java.io.IOException; import java.io.PrintWriter; - +// Comment #1 import javax.portlet.GenericPortlet; import javax.portlet.RenderRequest; import javax.portlet.RenderResponse; public class SimplestHelloWorldPortlet extends GenericPortlet { + // Comment #2 public void doView(RenderRequest request, RenderResponse response) throws IOException { + // Comment #3 PrintWriter writer = response.getWriter(); + // Comment #4 writer.write("Hello World !"); + // Comment #5 writer.close(); } } Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/default245.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/default245.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/default245.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -3,13 +3,17 @@ xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2... http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" version="2.0"> <portlet> + <!-- Comment #1 --> <portlet-name>SimplestHelloWorldPortlet</portlet-name> + <!-- Comment #2 --> <portlet-class> org.jboss.portal.portlet.samples.SimplestHelloWorldPortlet </portlet-class> + <!-- Comment #3 --> <supports> <mime-type>text/html</mime-type> </supports> + <!-- Comment #4 --> <portlet-info> <title>Simplest Hello World Portlet</title> </portlet-info> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/default252.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/default252.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/default252.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -1,3 +1,4 @@ +<!-- Comment #1 --> <%@ taglib uri="http://java.sun.com/portlet" prefix="portlet" %> <div class="portlet-section-header">Welcome !</div> @@ -10,6 +11,7 @@ <br/> <div class="portlet-font">Method 1: We simply pass the parameter to the render phase:<br/> +<!-- Comment #2 --> <a href="<portlet:renderURL><portlet:param name="yourname" value="John Doe"/> </portlet:renderURL>">John Doe</a></div> @@ -17,17 +19,20 @@ <div class="portlet-font">Method 2: We pass the parameter to the render phase, using valid XML: Please check the source code to see the difference with Method 1. +<!-- Comment #3 --> <portlet:renderURL var="myRenderURL"> <portlet:param name="yourname" value='John Doe'/> </portlet:renderURL> <br/> +<!-- Comment #4 --> <a href="<%= myRenderURL %>">John Doe</a></div> <br/> <div class="portlet-font">Method 3: We use a form:<br/> - +<!-- Comment #5 --> <portlet:actionURL var="myActionURL"/> +<!-- Comment #6 --> <form action="<%= myActionURL %>" method="POST"> <span class="portlet-form-field-label">Name:</span> <input class="portlet-form-input-field" type="text" name="yourname"/> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/default254.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/default254.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/extras/PortletDevelopment_Standard/default254.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -5,6 +5,7 @@ version="2.0"> <portlet> <portlet-name>JSFHelloUserPortlet</portlet-name> + <!-- Comment #1 --> <portlet-class>javax.portlet.faces.GenericFacesPortlet</portlet-class> <supports> <mime-type>text/html</mime-type> @@ -18,16 +19,19 @@ <init-param> <name>javax.portlet.faces.defaultViewId.view</name> + <!-- Comment #2 --> <value>/jsf/welcome.jsp</value> </init-param> <init-param> <name>javax.portlet.faces.defaultViewId.edit</name> + <!-- Comment #3 --> <value>/jsf/edit.jsp</value> </init-param> <init-param> <name>javax.portlet.faces.defaultViewId.help</name> + <!-- Comment #4 --> <value>/jsf/help.jsp</value> </init-param> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/Advanced/Foundations/Configuring_Services.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -352,19 +352,10 @@ <para> Below is an example <filename>configuration.xml</filename> that &apos;outsources&apos; its content into several files: </para> - <programlistingco> - <areaspec> - <area coords="6 90" id="area-Reference_Guide-Components-Includes_and_special_URLs-url_schema"/> - </areaspec> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_Foundations/default2.xml" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-Components-Includes_and_special_URLs-url_schema"> <para> - This line is being used to reference another configuration file. The <code>war:</code> URL schema indicates that the following path is to be resolved relative to the current <literal>PortalContainer</literal>&apos;s servlet context resource path, starting with <emphasis role="bold">WEB-INF</emphasis> as a root. + Comment #1: This line is being used to reference another configuration file. The <code>war:</code> URL schema indicates that the following path is to be resolved relative to the current <literal>PortalContainer</literal>&apos;s servlet context resource path, starting with <emphasis role="bold">WEB-INF</emphasis> as a root. </para> - </callout> - </calloutlist> - </programlistingco> <note> <para> The current <literal>PortalContainer</literal> is really a newly created <literal>PortalContainer</literal>, as <code>war:</code> URLs only make sense for <literal>PortalContainer</literal> scoped configuration. Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -44,31 +44,7 @@ <para> This property must have three values. </para> - <programlistingco> - <areaspec> - <area coords="7 90" id="area-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services-name"/> - <area coords="8 90" id="area-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services-time"/> - <area coords="9 90" id="area-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services-unit"/> - </areaspec> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_AuthenticationTokenConfiguration/default95.xml" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services-name"> - <para> - Service name - </para> - </callout> - <callout arearefs="area-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services-time"> - <para> - Amount of time - </para> - </callout> - <callout arearefs="area-Reference_Guide-Authentication_Token_Configuration-Configuring_Token_Services-unit"> - <para> - Unit of time - </para> - </callout> - </calloutlist> - </programlistingco> <para> In this case, the service name is <emphasis role="bold">jcr-token</emphasis> and the token expiration time is one week. </para> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -686,28 +686,13 @@ <para> For RHDS, OpenDS and OpenLDAP the <filename>picketlink-idm-LDAP-acme-config.xml</filename> and <filename>picketlink-idm-openLDAP-acme-config.xml</filename> files contain the following values: </para> - <programlistingco> - <areaspec> - <areaset coords="" id="area-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-opends"> - <area coords="10 87" id="area-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-users-opends"/> - <area coords="14 87" id="area-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-groups-opends"/> - </areaset> - <area coords="17 87" id="area-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-read-only-opends"/> - </areaspec> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_LDAP/readonly-opends.xml" parse="text"/></programlisting> - <calloutlist> -<!--#1--> <callout arearefs="area-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-opends"> <para> - The PicketLink IDM configuration file dictates that users and those two group types be stored in LDAP. + Comment #1: The PicketLink IDM configuration file dictates that users and those two group types be stored in LDAP. </para> - </callout> -<!--#2--> <callout arearefs="area-Reference_Guide-LDAP_Integration-Examples-Read_Only_groupTypeMappings-config-read-only-opends"> <para> - An additional option defines that nothing else (except password updates) should be written there. + Comment #2: An additional option defines that nothing else (except password updates) should be written there. </para> - </callout> - </calloutlist> - </programlistingco> <para> All groups under <emphasis role="bold">/acme/roles</emphasis> will be stored in PicketLink IDM with the <emphasis role="bold">acme_roles_type</emphasis> group type name and groups under <emphasis role="bold">/acme/organization_units</emphasis> will be stored in PicketLink IDM with <emphasis role="bold">acme_ou_type group</emphasis> type name. </para> @@ -727,23 +712,12 @@ <para> All of the supported LDAP configurations use the following values when implemented as the default identity store: </para> - <programlistingco> - <areaspec> - <areaset coords="" id="area-Reference_Guide-LDAP_Integration-Examples-Default_groupTypeMappings-config"> - <area coords="10 87" id="area-Reference_Guide-LDAP_Integration-Examples-Default_groupTypeMappings-config-1"/> - </areaset> - </areaspec> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_LDAP/default-ldap.xml" parse="text"/></programlisting> - <calloutlist> -<!--#1--> <callout arearefs="area-Reference_Guide-LDAP_Integration-Examples-Default_groupTypeMappings-config"> <para> - The <parameter>groupTypeMappings</parameter> define that all groups under <parameter>/platform</parameter> should be stored in PicketLink IDM with the <parameter>platform_type</parameter> group type name and groups under <parameter>/organization</parameter> should be stored in PicketLink IDM with <parameter>organization_type</parameter> group type name. + Comment #1: The <parameter>groupTypeMappings</parameter> define that all groups under <parameter>/platform</parameter> should be stored in PicketLink IDM with the <parameter>platform_type</parameter> group type name and groups under <parameter>/organization</parameter> should be stored in PicketLink IDM with <parameter>organization_type</parameter> group type name. </para> <para> The PicketLink IDM configuration file repository maps users and those two group types as stored in LDAP. </para> - </callout> - </calloutlist> - </programlistingco> </example> </section> </chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -40,13 +40,8 @@ <!-- DOC NOTE: Added based on Gatein revision 6987 --> <para> Each portal, groups and users navigation is indicated by a configuration paragraph, for example: </para> - <programlistingco> - <areaspec> - <area coords="5 90" id="area-Reference_Guide-Portal_Navigation_Configuration-Overview-predifinedOwner"/> - <area coords="10 90" id="area-Reference_Guide-Portal_Navigation_Configuration-Overview-ownerType"/> - <area coords="13 90" id="area-Reference_Guide-Portal_Navigation_Configuration-Overview-templateLocation"/> - <area coords="16 90" id="area-Reference_Guide-Portal_Navigation_Configuration-Overview-importMode"/> - </areaspec> +<example> +<title>Navigation Configuration Paragraph Example</title> <programlisting language="XML" role="XML">&lt;object-param&gt; &lt;name&gt;portal.configuration&lt;/name&gt; &lt;description&gt;description&lt;/description&gt; @@ -68,26 +63,17 @@ &lt;/object&gt; &lt;/object-param&gt; </programlisting> - </programlistingco> - <calloutlist> - <callout arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Overview-predifinedOwner"> <para> <parameter>predefinedOwner</parameter> defines the navigation owner, portal will look for the configuration files in folder with this name, if there is no suitable folder, a default portal will be created with name is this value. </para> - </callout> - <callout arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Overview-ownerType"> <para> <parameter>ownerType</parameter> defines the type of portal navigation. It may be a portal, group, or user. </para> - </callout> - <callout arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Overview-templateLocation"> <para> - <parameter>templateLocation</parameter> defines the classpath for portal configuration files. + <parameter>templateLocation</parameter> defines the classpath to all portal configuration files </para> - </callout> - <callout arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Overview-importMode"> <para> - <parameter>importMode</parameter> defines the mode of navigation import. There are 4 types of import mode: + <parameter>importMode</parameter> is the mode for navigation import. There are 4 types of import mode: </para> <itemizedlist> <listitem> @@ -111,8 +97,7 @@ </para> </listitem> </itemizedlist> - </callout> - </calloutlist> +</example> <para> Based on these parameters, the portal will look for the configuration files and create a relevant portal navigation, pages and data import strategy. </para> @@ -187,19 +172,7 @@ <para> Subnodes can also be created using the following XML structure </para> - <programlistingco> - <areaspec> - <area coords="9 83" id="area-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation-subpage"/> - </areaspec> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/subpage.xml" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation-subpage"> - <para> - This element defines the parent/child relationship between a node and a subnode. - </para> - </callout> - </calloutlist> - </programlistingco> </listitem> </varlistentry> <varlistentry> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/InternationalizationConfiguration.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -67,71 +67,41 @@ <para> The locale configuration file (<filename>02portal.war:/WEB-INF/conf/common/locales-config.xml</filename>) contains the following code: </para> - <programlistingco> - <areaspec> - <area coords="4 90" id="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-locale"/> - <area coords="5 90" id="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-output-encoding"/> - <area coords="6 90" id="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-input-encoding"/> - <area coords="7 90" id="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-description"/> - <area coords="22 90" id="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-orientation"/> - </areaspec> + <example> + <title>The locales-config.xml File Explanation</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_InternationalizationConfiguration/default150.xml" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-locale"> <para> - <emphasis>locale</emphasis>: The locale has to be defined as per the codes defined <ulink url="http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt" type="http">here</ulink>. In this example &quot;<emphasis>ar</emphasis>&quot; is Arabic. + <literal>locale</literal>: The locale has to be defined as per the codes defined <ulink url="http://ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt" type="http">here</ulink>. In this example &quot;<emphasis>ar</emphasis>&quot; is Arabic. </para> - </callout> - <callout arearefs="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-output-encoding"> <para> - <emphasis>output-encoding</emphasis>: deals with character encoding. It is recommended that UTF-8 be used. + <literal>output-encoding</literal>: deals with character encoding. It is recommended that UTF-8 be used. </para> - </callout> - <callout arearefs="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-input-encoding"> <para> - <emphasis>input-encoding</emphasis>: In the Java implementation, the encoding parameters will be used for the request response stream. The input-encoding parameter will be used for request <literal>setCharacterEncoding(..)</literal>. + <literal>input-encoding</literal>: In the Java implementation, the encoding parameters will be used for the request response stream. The input-encoding parameter will be used for request <literal>setCharacterEncoding(..)</literal>. </para> - </callout> - <callout arearefs="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-description"> <para> - <emphasis>description</emphasis>: A description of the language + <literal>description</literal>: A description of the language. </para> - </callout> - <callout arearefs="area-Reference_Guide-Internationalization_Configuration-Locales_Configuration-orientation"> <para> - <emphasis>orientation</emphasis>: Although the default orientation of text and images is Left-To-Right, JBoss Enterprise Portal Platform supports <emphasis role="bold">Right-To-Left</emphasis> orientation. Modifying text orientation is explained in <xref linkend="chap-Reference_Guide-Right_To_Left_RTL_Framework"/>. + <literal>orientation</literal>: Although the default orientation of text and images is Left-To-Right, JBoss Enterprise Portal Platform supports <emphasis>Right-To-Left</emphasis> orientation. Modifying text orientation is explained in <xref linkend="chap-Reference_Guide-Right_To_Left_RTL_Framework"/>. </para> - </callout> - </calloutlist> - </programlistingco> + </example> </section> <section id="sect-Reference_Guide-Internationalization_Configuration-ResourceBundleService"> <title>ResourceBundleService</title> <para> The resource bundle service is configured in: <filename>02portal.war:/WEB-INF/conf/common/common-configuration.xml</filename>: </para> - <programlistingco> - <areaspec> - <area coords="6 90" id="area-Reference_Guide-Internationalization_Configuration-ResourceBundleService-classpath_resources"/> - <area coords="24 90" id="area-Reference_Guide-Internationalization_Configuration-ResourceBundleService-portal_resource_names"/> - </areaspec> + <example> + <title>The common-configuration.xml file explained</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_InternationalizationConfiguration/default151.xml" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-Internationalization_Configuration-ResourceBundleService-classpath_resources"> <para> - <emphasis>classpath.resources</emphasis>: These are discussed in a later section. + Comment #1: resources whose package name starts with the name specified in the <emphasis>classpath.resources</emphasis> parameter are loaded from the file system. Detailed information can be found in a later section of this chapter. </para> - </callout> - <callout arearefs="area-Reference_Guide-Internationalization_Configuration-ResourceBundleService-portal_resource_names"> <para> - <emphasis>portal.resource.names</emphasis>: Defines all resources that belong to the <emphasis>Portal Resource Bundle</emphasis>. + Comment #2: the <emphasis>portal.resource.names</emphasis> parameter defines all resources that belong to the <emphasis>Portal Resource Bundle</emphasis>. These resources are merged to a single resource bundle which is accessible from anywhere in JBoss Enterprise Portal Platform. All these keys are located in the same bundle, which is separated from the navigation resource bundles. </para> - <para> - These resources are merged to a single resource bundle which is accessible from anywhere in JBoss Enterprise Portal Platform. All these keys are located in the same bundle, which is separated from the navigation resource bundles. - </para> - </callout> - </calloutlist> - </programlistingco> + </example> </section> <section id="sect-Reference_Guide-Internationalization_Configuration-Navigation_Resource_Bundles"> <title>Navigation Resource Bundles</title> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/Skinning.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -195,37 +195,7 @@ <para> This file is the main portal skin stylesheet. It is the main entry point to the CSS class definitions for the skin. The main content points of this file are: </para> - <programlistingco> - <areaspec> - <area coords="1 83" id="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-uiportletapplication"/> - <area coords="2 83" id="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-components"/> - <area coords="3 83" id="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-portletthemes"/> - <area coords="4 83" id="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-portlet"/> - </areaspec> - <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_Skinning/default184.java" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-uiportletapplication"> - <para> - Skin for the main portal page - </para> - </callout> - <callout arearefs="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-components"> - <para> - Skins for various portal components - </para> - </callout> - <callout arearefs="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-portletthemes"> - <para> - Window decoration skins - </para> - </callout> - <callout arearefs="area-Reference_Guide-Skinning_the_Portal-The_Default_Skin-portlet"> - <para> - The portlet specification CSS classes - </para> - </callout> - </calloutlist> - </programlistingco> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortalDevelopment_Skinning/default184.java" parse="text"/></programlisting> <para> This method imports other CSS stylesheet files (some of which may also import further CSS stylesheets) instead of defining all the CSS classes in this one file. Splitting the CSS classes between multiple files allows new skins to reuse parts of the default skin. </para> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -176,83 +176,53 @@ Like other Java EE applications, JBoss Enterprise Portal Platform portlets are packaged in <literal>WAR</literal> files. A typical portlet <literal>WAR</literal> file can include servlets, resource bundles, images, HTML, JavaServer Pages (JSP), and other static or dynamic files. </para> <para> - The following is an example of the directory structure of the <filename>SimplestHelloWorld</filename> portlet: + The following is an example of the directory structure of the <filename>SimplestHelloWorld</filename> portlet. </para> - <programlistingco> - <areaspec> - <area coords="9 90" id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-javaclass"/> - <area coords="10 90" id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-portlet"/> - <area coords="11 90" id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-web"/> - </areaspec> + <example> + <title>Portlet Directory Structure Explanation</title> <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default244.java" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-javaclass"> - <para> - The compiled Java class implementing <emphasis>javax.portlet.Portlet</emphasis> (through <emphasis>javax.portlet.GenericPortlet </emphasis> ) - </para> - </callout> - <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-portlet"> - <para> - This is the mandatory descriptor file for portlets. It is used during deployment. - </para> - </callout> - <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure-web"> - <para> - This is the mandatory descriptor for web applications. - </para> - </callout> - </calloutlist> - </programlistingco> + <para> + <filename>SimplestHelloWorldPortlet.class</filename>: The compiled Java class implementing <emphasis>javax.portlet.Portlet</emphasis> (through <emphasis>javax.portlet.GenericPortlet</emphasis>). + </para> + <para> + <filename>portlet.xml</filename>: This is the mandatory descriptor file for portlets. It is used during deployment. + </para> + <para> + <filename>web.xml</filename>: This is the mandatory descriptor for web applications. + </para> + </example> </section> <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class"> <title>Portlet Class</title> <para> - Below is the Java source for an example portlet named <filename>SimplestHelloWorldPortlet</filename>: + Below is the Java source for an example portlet named <filename>SimplestHelloWorldPortlet</filename>. </para> - <programlistingco> - <areaspec> - <area coords="6 90" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-extends"/> - <area coords="12 90" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-doview"/> - <area coords="14 90" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-writer"/> - <area coords="15 90" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-write"/> - <area coords="16 90" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-close"/> - </areaspec> - <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/SimplestHelloWorldPortlet.java" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-extends"> - <remark>BZ#812412 - adjusted the description for this based on feedback in the ticket.</remark> - <para> - All portlets must implement the <literal>javax.portlet.Portlet</literal> interface. The <classname>GenericPortlet</classname> class provides a default implementation for the Portlet interface. - </para> - <para> - The <classname>javax.portlet.GenericPortlet</classname> class implements the <methodname>render</methodname> method to dispatch to abstract mode-specific methods. This makes it easier to support the standard portlet modes. - </para> - <para><classname> GenericPortlet</classname> also provides a default implementation for the <methodname>processAction</methodname>, <methodname>init</methodname> and <methodname>destroy</methodname> methods. It is recommended to extend <literal>GenericPortlet</literal> for most cases. - </para> - </callout> - <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-doview"> - <para> - If only the <literal>view</literal> mode is required, then only the <literal>doView</literal> method needs to be implemented. The <classname>GenericPortlet</classname> render implementation calls our implementation when the <literal>view</literal> mode is requested. - </para> - </callout> - <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-writer"> - <para> - Use the <methodname>RenderResponse</methodname> method to obtain a writer to be used to produce content. - </para> - </callout> - <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-write"> - <para> - Write the markup to display. - </para> - </callout> - <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class-close"> - <para> - Closing the writer. - </para> - </callout> - </calloutlist> - </programlistingco> + <example> + <title>SimplestHelloWorldPortlet Explanation</title> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/SimplestHelloWorldPortlet.java" parse="text"/></programlisting> <para> + Comment #1: All portlets must implement the <literal>javax.portlet.Portlet</literal> interface. The <classname>GenericPortlet</classname> class provides a default implementation for the Portlet interface. + </para> + <para> + The <classname>javax.portlet.GenericPortlet</classname> class implements the <methodname>render</methodname> method to dispatch to abstract mode-specific methods. This makes it easier to support the standard portlet modes. + </para> + <para> + <classname>GenericPortlet</classname> also provides a default implementation for the <methodname>processAction</methodname>, <methodname>init</methodname> and <methodname>destroy</methodname> methods. It is recommended to extend <literal>GenericPortlet</literal> for most cases. + </para> + <para> + Comment #2: If only the <literal>view</literal> mode is required, then only the <literal>doView</literal> method needs to be implemented. The <classname>GenericPortlet</classname> render implementation calls our implementation when the <literal>view</literal> mode is requested. + </para> + <para> + Comment #3: Use the <methodname>RenderResponse</methodname> method to obtain a writer to be used to produce content. + </para> + <para> + Comment #4: Write the markup to display. + </para> + <para> + Comment #5: Closing the writer. + </para> + </example> + <para> <note> <title>Markup Fragments</title> <para> @@ -268,48 +238,30 @@ JBoss Enterprise Portal Platform requires certain descriptors to be included in a portlet <literal>WAR</literal> file. These descriptors are defined by the Java EE (<filename>web.xml</filename>) and Portlet Specification (<filename>portlet.xml</filename>). </para> <para> - Below is an example of the <filename>SimplestHelloWorldPortlet/WEB-INF/portlet.xml</filename> file. This file must adhere to its definition in the JSR-286 Portlet Specification. More than one portlet application may be defined in this file: + Below is an example of the <filename>SimplestHelloWorldPortlet/WEB-INF/portlet.xml</filename> file. This file must adhere to its definition in the JSR-286 Portlet Specification. More than one portlet application may be defined in this file. </para> - <programlistingco> - <areaspec> - <area coords="6 90" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletname"/> - <area coords="8 83" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletclass"/> - <area coords="10 90" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-supports"/> - <area coords="13 90" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletinfo"/> - </areaspec> + <example> + <title>The portlet.xml File Explanation</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default245.xml" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletname"> - <para> - Define the portlet name. It does not have to be the class name. - </para> - </callout> - <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletclass"> - <para> - The Fully Qualified Name (<literal>FQN</literal>) of your portlet class must be declared here. - </para> - </callout> - <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-supports"> - <para> - The <literal>&lt;supports&gt;</literal> element declares all of the markup types that a portlet supports in the <literal>render</literal> method. This is accomplished via the <literal>&lt;mime-type&gt;</literal> element, which is required for every portlet. - </para> - <para> - The declared MIME types must match the capability of the portlet. It allows administrators to pair which modes and window states are supported for each markup type. - </para> - <para> - This does not have to be declared as all portlets must support the <literal>view</literal> portlet mode. - </para> - <para> - Use the <literal>&lt;mime-type&gt;</literal> element to define which markup type the portlet supports. In the example above this is <literal>text/html</literal>. This section tells the portal to only output <literal>HTML</literal>. - </para> - </callout> - <callout arearefs="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors-portletinfo"> - <para> - When rendered, the portlet&apos;s title is displayed as the header in the portlet window, unless it is overridden programmatically. In the example above the title would be <literal>Simplest Hello World Portlet</literal> . - </para> - </callout> - </calloutlist> - </programlistingco> + <para> + Comment #1: Define the portlet name. It does not have to be the class name. + </para> + <para> + Comment #2: The Fully Qualified Name (<literal>FQN</literal>) of your portlet class must be declared here. + </para> + <para> + Comment #3: The <literal>&lt;supports&gt;</literal> element declares all of the markup types that a portlet supports in the <literal>render</literal> method. This is accomplished via the <literal>&lt;mime-type&gt;</literal> element, which is required for every portlet. + </para> + <para> + The declared MIME types must match the capability of the portlet. It allows administrators to pair which modes and window states are supported for each markup type. This does not have to be declared as all portlets must support the <literal>view</literal> portlet mode. + </para> + <para> + Use the <literal>&lt;mime-type&gt;</literal> element to define which markup type the portlet supports. In the example above this is <literal>text/html</literal>. This section tells the portal to only output <literal>HTML</literal>. + </para> + <para> + Comment #4: When rendered, the portlet&apos;s title is displayed as the header in the portlet window, unless it is overridden programmatically. In the example above the title would be <literal>Simplest Hello World Portlet</literal> . + </para> + </example> </section> </section> <section id="sect-Reference_Guide-Tutorials-JavaServer_Pages_Portlet_Example"> @@ -460,51 +412,30 @@ <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default250.xml" parse="text"/></programlisting> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default251.xml" parse="text"/></programlisting> <para> - The landing page contains the links and form to call our portlet: + The landing page contains the links and form to call our portlet. </para> - <programlistingco> - <areaspec> - <area coords="1 90" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-taglib"/> - <area coords="14 90" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method1"/> - <area coords="20 90" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.1"/> - <area coords="24 90" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.2"/> - <area coords="30 90" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.1"/> - <area coords="31 90" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.2"/> - </areaspec> + <example> + <title>Landing Page Explanation</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default252.xml" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-taglib"> - <para> - The portlet taglib. This needs to be declared. - </para> - </callout> - <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method1"> - <para> - The first method showed here is the simplest one. <literal>portlet:renderURL</literal> will create a URL that calls the render phase of the current portlet and append the result at the place of the markup (within a tag). A parameter is also added directly to the URL. - </para> - </callout> - <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.1"> - <para> - In this method the <literal>var</literal> attribute is used. This avoids having one XML tag within another. Instead of printing the url the <literal>portlet:renderURL</literal> tag will store the result in the referenced variable ( <literal>myRenderURL</literal>). - </para> - </callout> - <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method2.2"> - <para> - The variable <literal>myRenderURL</literal> is used like any other JSP variable. - </para> - </callout> - <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.1"> - <para> - The third method mixes form submission and action request. Again, a temporary variable is used to put the created URL into. - </para> - </callout> - <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library-method3.2"> - <para> - The action URL is used in HTML form. - </para> - </callout> - </calloutlist> - </programlistingco> + <para> + Comment #1: The portlet taglib. This needs to be declared. + </para> + <para> + Comment #2: The first method showed here is the simplest one. <literal>portlet:renderURL</literal> will create a URL that calls the render phase of the current portlet and append the result at the place of the markup (within a tag). A parameter is also added directly to the URL. + </para> + <para> + Comment #3: In this method the <literal>var</literal> attribute is used. This avoids having one XML tag within another. Instead of printing the url the <literal>portlet:renderURL</literal> tag will store the result in the referenced variable ( <literal>myRenderURL</literal>). + </para> + <para> + Comment #4: The variable <literal>myRenderURL</literal> is used like any other JSP variable. + </para> + <para> + Comment #5: The third method mixes form submission and action request. Again, a temporary variable is used to put the created URL into. + </para> + <para> + Comment #6: The action URL is used in HTML form. + </para> + </example> <para> In the third method, the action phase is triggered first then the render phase is triggered, which outputs some content back to the web browser based on the available render parameters. </para> @@ -536,37 +467,22 @@ <para> The other differences when compared to a regular portlet application are in the portlet descriptor. All the relevant details about this can be found in the JSR-329 specification that the JBoss Portlet Bridge implements. </para> - <programlistingco> - <areaspec> - <area coords="8 90" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-portlet"/> - <area coords="21 90" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-view"/> - <area coords="26 90" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-edit"/> - <area coords="31 90" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-help"/> - </areaspec> + <example> + <title>Portlet Descriptor Explanation</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/PortletDevelopment_Standard/default254.xml" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-portlet"> - <para> - All JSF portlets define <literal>javax.portlet.faces.GenericFacesPortlet </literal> as portlet class. This class is part of the JBoss Portlet Bridge. - </para> - </callout> - <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-view"> - <para> - This is a mandatory parameter to define what&apos;s the default page to display. - </para> - </callout> - <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-edit"> - <para> - This parameter defines which page to display on the &apos;edit&apos; mode. - </para> - </callout> - <callout arearefs="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge-help"> - <para> - This parameter defines which page to display on the &apos;help&apos; mode. - </para> - </callout> - </calloutlist> - </programlistingco> + <para> + Comment #1: All JSF portlets define <literal>javax.portlet.faces.GenericFacesPortlet</literal> as a portlet class. This class is part of the JBoss Portlet Bridge. + </para> + <para> + Comment #2: This is a mandatory parameter to define what&apos;s the default page to display. + </para> + <para> + Comment #3: This parameter defines which page to display on the &apos;edit&apos; mode. + </para> + <para> + Comment #4: This parameter defines which page to display on the &apos;help&apos; mode. + </para> + </example> <note> <title>JBoss Portlet Bridge</title> <para> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/exojcr-backup-service.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/exojcr-backup-service.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/backup/exojcr-backup-service.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -162,18 +162,10 @@ <section id="sect-Reference_Guide-eXo_JCR_Backup_Service-Configuration"> <title>Configuration</title> <para> - As an optional extension, the Backup service is not enabled by default. <emphasis role="bold">You need to enable it via configuration</emphasis>. + As an optional extension, the Backup service is not enabled by default. You need to enable it via configuration. </para> - <para> - The following is an example configuration: - </para> - <programlistingco> - <areaspec> - <area coords="7 90" id="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-backup-dir"/> - <area coords="8 137" id="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-incremental-backup-type"/> - <area coords="9 130" id="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-full-backup-type"/> - <area coords="10 90" id="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-default-incremental-job-period"/> - </areaspec> + <example> + <title>Example Backup Service Configuration</title> <programlisting language="XML">&lt;component&gt; &lt;key&gt;org.exoplatform.services.jcr.ext.backup.BackupManager&lt;/key&gt; &lt;type&gt;org.exoplatform.services.jcr.ext.backup.impl.BackupManagerImpl&lt;/type&gt; @@ -187,33 +179,19 @@ &lt;/properties-param&gt; &lt;/init-params&gt; &lt;/component&gt;</programlisting> - <calloutlist id="call-Reference_Guide-Configuration-Mandatory_parameter"> - <title>Mandatory parameter</title> - <callout arearefs="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-backup-dir"> <para> - <parameter>backup-dir</parameter> is the path to a working directory where the service will store internal files and chain logs. + <parameter>backup-dir</parameter> is the path to a working directory where the service will store internal files and chain logs. This parameter is mandatory. </para> - </callout> - </calloutlist> - <calloutlist id="call-Reference_Guide-Configuration-Optional_parameters"> - <title>Optional parameters</title> - <callout arearefs="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-incremental-backup-type"> <para> - <parameter>incremental-backup-type</parameter> The FQN of incremental job class. Must implement <literal>org.exoplatform.services.jcr.ext.backup.BackupJob</literal>. By default, <literal>org.exoplatform.services.jcr.ext.backup.impl.fs.FullBackupJob</literal> is used. - </para> - </callout> - <callout arearefs="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-full-backup-type"> + <parameter>incremental-backup-type</parameter> is an optional parameter. It specifies the FQN of incremental job class and must implement the <literal>org.exoplatform.services.jcr.ext.backup.BackupJob</literal> interface. By default, <literal>org.exoplatform.services.jcr.ext.backup.impl.fs.FullBackupJob</literal> is used. + </para> <para> - <parameter>full-backup-type</parameter> is the FQN of the full backup job class. It must implement <literal>org.exoplatform.services.jcr.ext.backup.BackupJob</literal>. By default, <literal>org.exoplatform.services.jcr.ext.backup.impl.rdbms.FullBackupJob</literal> is used. Please, notice that file-system based implementation <literal>org.exoplatform.services.jcr.ext.backup.impl.fs.FullBackupJob</literal> is deprecated and not recommended for use.. + <parameter>full-backup-type</parameter> is an optional parameter. It specifies the FQN of the full backup job class. The class must implement the <literal>org.exoplatform.services.jcr.ext.backup.BackupJob</literal> interface. By default, <literal>org.exoplatform.services.jcr.ext.backup.impl.rdbms.FullBackupJob</literal> is used. Please, notice that file-system based implementation <literal>org.exoplatform.services.jcr.ext.backup.impl.fs.FullBackupJob</literal> is deprecated and not recommended for use. </para> - </callout> - <callout arearefs="area-Reference_Guide-eXo_JCR_Backup_Service-Configuration-default-incremental-job-period"> <para> - <parameter>default-incremental-job-period</parameter> is the period between incremental flushes (in seconds). Default is <literal>3600</literal> seconds. + <parameter>default-incremental-job-period</parameter> is an optional parameter. It specifies the period between incremental flushes (in seconds). Default is <literal>3600</literal> seconds. </para> - </callout> - </calloutlist> - </programlistingco> + </example> </section> <section id="sect-Reference_Guide-eXo_JCR_Backup_Service-RDBMS_backup"> <title>RDBMS backup</title> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/cluster-config.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -89,13 +89,8 @@ <para> The configuration file must be formatted as follows: </para> - <programlistingco> - <areaspec> - <area coords="19 87" id="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-value_storages"/> - <area coords="28 87" id="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_cache"/> - <area coords="31 87" id="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_indexer"/> - <area coords="34 87" id="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_lock_manager"/> - </areaspec> + <example> + <title>External Configuration</title> <programlisting language="XML" role="XML">&lt;repository-service default-repository=&quot;repository1&quot;&gt; &lt;repositories&gt; &lt;repository name=&quot;repository1&quot; system-workspace=&quot;ws1&quot; default-workspace=&quot;ws1&quot;&gt; @@ -114,7 +109,7 @@ &lt;property name=&quot;swap-directory&quot; value=&quot;../temp/swap/production&quot; /&gt; &lt;/properties&gt; &lt;value-storages&gt; - + <![CDATA[<!-- Comment #1 -->]]> &lt;/value-storages&gt; &lt;/container&gt; &lt;initializer class=&quot;org.exoplatform.services.jcr.impl.core.ScratchWorkspaceInitializer&quot;&gt; @@ -123,13 +118,13 @@ &lt;/properties&gt; &lt;/initializer&gt; &lt;cache enabled=&quot;true&quot; class=&quot;org.exoplatform.services.jcr.impl.dataflow.persistent.jbosscache.JBossCacheWorkspaceStorageCache&quot;&gt; - + <![CDATA[<!-- Comment #2 -->]]> &lt;/cache&gt; &lt;query-handler class=&quot;org.exoplatform.services.jcr.impl.core.query.lucene.SearchIndex&quot;&gt; - + <![CDATA[<!-- Comment #3 -->]]> &lt;/query-handler&gt; &lt;lock-manager class=&quot;org.exoplatform.services.jcr.impl.core.lock.jbosscache.CacheableLockManagerImpl&quot;&gt; - + <![CDATA[<!-- Comment #4 -->]]> &lt;/lock-manager&gt; &lt;/workspace&gt; &lt;workspace name=&quot;ws2&quot;&gt; @@ -142,29 +137,19 @@ &lt;/repository&gt; &lt;/repositories&gt; &lt;/repository-service&gt;</programlisting> - <calloutlist> -<!-- # --> <callout arearefs="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-value_storages"> <para> - Refer to <xref linkend="exam-Reference_Guide-Configuration_requirements-Value_Storage_configuration"/>. + Comment #1: Refer to <xref linkend="exam-Reference_Guide-Configuration_requirements-Value_Storage_configuration"/>. </para> - </callout> - <callout arearefs="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_cache"> <para> - Refer to <xref linkend="exam-Reference_Guide-Configuration_requirements-Cache_configuration"/>. + Comment #2: Refer to <xref linkend="exam-Reference_Guide-Configuration_requirements-Cache_configuration"/>. </para> - </callout> - <callout arearefs="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_indexer"> <para> - Refer to <xref linkend="exam-Reference_Guide-Configuration_requirements-Indexer_configuration"/>. + Comment #3: Refer to <xref linkend="exam-Reference_Guide-Configuration_requirements-Indexer_configuration"/>. </para> - </callout> - <callout arearefs="area-Reference_Guide-Launching_Cluster-Configuring_JCR_to_use_external_configuration-conf_lock_manager"> <para> - Refer to <xref linkend="exam-Reference_Guide-Configuration_requirements-Lock_Manager_configuration"/>. + Comment #4: Refer to <xref linkend="exam-Reference_Guide-Configuration_requirements-Lock_Manager_configuration"/>. </para> - </callout> - </calloutlist> - </programlistingco> + </example> </listitem> <listitem> <para> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/exo-jcr-configuration.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -161,103 +161,7 @@ </section> <section id="sect-Reference_Guide-Portal_configuration-Repository_service_configuration_JCR_repositories_configuration"> <title>Repository service configuration (JCR repositories configuration)</title> - <programlistingco> - <areaspec> -<!-- 1 --> <area coords="1 90" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-default-repository"/> -<!-- 2 --> <area coords="2 90" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-repositories"/> -<!-- 3 --> <area coords="3 172" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-name"/> -<!-- 4 --> <area coords="3 172" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-default-workspace"/> -<!-- 5 --> <area coords="3 172" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-system-workspace"/> -<!-- 6 --> <area coords="4 90" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-security-domain"/> -<!-- 7 --> <area coords="5 90" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-access-control"/> -<!-- 8 --> <area coords="6 199" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-authentication-policy"/> -<!-- 9 --> <area coords="9 90" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-workspaces"/> -<!-- 10 --> <area coords="13 90" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-workspace-name"/> -<!-- 11 --> <area coords="14 204" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-container"/> -<!-- 12 --> <area coords="34 113" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_initializer"/> -<!-- 13 --> <area coords="40 215" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_cache"/> -<!-- 14 --> <area coords="48 115" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_query-handler"/> -<!-- 15 --> <area coords="61 90" id="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_lock-manager-timeout"/> - </areaspec> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../../extras/Advanced_Development_JCR_Configuration/orig.xml" parse="text"/></programlisting> - <calloutlist> -<!-- 1 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-default-repository"> - <para> - <emphasis>default-repository</emphasis>: The name of a default repository (one returned by <parameter> RepositoryService.getRepository() </parameter> ). - </para> - </callout> -<!-- 2 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-repositories"> - <para> - <emphasis>repositories</emphasis>: The list of repositories. - </para> - </callout> -<!-- 3 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-name"> - <para> - <emphasis>name</emphasis>: The name of a repository. - </para> - </callout> -<!-- 4 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-default-workspace"> - <para> - <emphasis>default-workspace</emphasis>: The name of a workspace obtained using Session&apos;s login() or login(Credentials) methods (ones without an explicit workspace name). - </para> - </callout> -<!-- 5 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-system-workspace"> - <para> - <emphasis>system-workspace</emphasis>: The name of workspace where <emphasis>/jcr:system</emphasis> node is placed. - </para> - </callout> -<!-- 6 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-security-domain"> - <para> - <emphasis>security-domain</emphasis>: The name of a security domain for JAAS authentication. - </para> - </callout> -<!-- 7 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-access-control"> - <para> - <emphasis>access-control</emphasis>: The name of an access control policy. There can be 3 types: optional - ACL is created on-demand(default), disable - no access control, mandatory - an ACL is created for each added node(not supported yet). - </para> - </callout> -<!-- 8 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-authentication-policy"> - <para> - <emphasis>authentication-policy</emphasis>: The name of an authentication policy class. - </para> - </callout> -<!-- 9 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-workspaces"> - <para> - <emphasis>workspaces</emphasis>: The list of workspaces. - </para> - </callout> -<!-- 10 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-workspace-name"> - <para> - The name of the workspace. - </para> - </callout> -<!-- 11 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-container"> - <para> - Workspace data container (physical storage) configuration. - </para> - </callout> -<!-- 12 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_initializer"> - <para> - Workspace initializer configuration. - </para> - </callout> -<!-- 13 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_cache"> - <para> - Workspace storage cache configuration. - </para> - </callout> -<!-- 14 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_query-handler"> - <para> - Query handler configuration. - </para> - </callout> -<!-- 15 --> <callout arearefs="area-Reference_Guide-JCR_configuration-Example_of_the_portal_system_workspace-service_lock-manager-timeout"> - <para> - The amount of time before the unused global lock is removed. - </para> - </callout> - </calloutlist> - </programlistingco> <note> <title> <parameter> session-max-age </parameter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/external-value-storages.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -32,32 +32,16 @@ <para> However, using Tree File Value Storage can result in a higher time on value deletion, due to the removal of unused tree-nodes. </para> - <programlistingco> - <areaspec> - <area coords="1 90" id="area-Reference_Guide-External_Value_Storages-Tree_File_Value_Storage-id" /> - <area coords="3 90" id="area-Reference_Guide-External_Value_Storages-Tree_File_Value_Storage-path" /> - - </areaspec> - +<example> +<title>Tree File Value Storage Configuration</title> <programlisting language="XML" role="XML"><xi:include href="../../../../extras/Advanced_Development_JCR_external-value-storages/default25.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-External_Value_Storages-Tree_File_Value_Storage-id"> <para> - The <emphasis role="bold">id</emphasis> is the value storage unique identifier, used for linking with properties stored in a workspace container + Comment #1: The <emphasis role="bold">id</emphasis> is the value storage unique identifier, used for linking with properties stored in a workspace container. </para> - - </callout> - <callout arearefs="area-Reference_Guide-External_Value_Storages-Tree_File_Value_Storage-path"> <para> - <emphasis role="bold">path</emphasis> is a location where value files will be stored. + Comment #2: the <emphasis role="bold">path</emphasis> is a location where value files will be stored. </para> - - </callout> - - </calloutlist> - - </programlistingco> - +</example> <para> Each file value storage can have the <function>filters</function> for incoming values. A filter can match values by <property>property-type</property>, <property>property-name</property>, <property>ancestor-path</property>. It can also match the size of values stored (<property>min-value-size</property>) in bytes. </para> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/search-configuration.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -500,33 +500,21 @@ <section id="sect-Reference_Guide-Search_Configuration-Global_Search_Index"> <title>Global Search Index</title> <para> - By default eXo JCR uses the Lucene standard Analyzer to index contents. This analyzer uses some standard filters in the method that analyzes the content: + By default eXo JCR uses the Lucene standard Analyzer to index contents. This analyzer uses some standard filters in the method that analyzes the content </para> - <programlistingco> - <areaspec> - <area coords="3 85" id="area-Reference_Guide-Search_Configuration-Global_Search_Index-StandardFilter"/> - <area coords="4 85" id="area-Reference_Guide-Search_Configuration-Global_Search_Index-LowerCaseFilter"/> - <area coords="5 85" id="area-Reference_Guide-Search_Configuration-Global_Search_Index-StopFilter"/> - </areaspec> + <example> + <title>Standard Analyzed Filters</title> <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../../extras/Advanced_Development_JCR_search-configuration/default62.java" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-Search_Configuration-Global_Search_Index-StandardFilter"> <para> - The first filter (StandardFilter) removes possessive apostrophes (<emphasis role="bold">&apos;s</emphasis>) from the end of words and removes periods (<emphasis role="bold">.</emphasis>) from acronyms. + Comment #1: The first filter (StandardFilter) removes possessive apostrophes (<emphasis role="bold">&apos;s</emphasis>) from the end of words and removes periods (<emphasis role="bold">.</emphasis>) from acronyms. </para> - </callout> - <callout arearefs="area-Reference_Guide-Search_Configuration-Global_Search_Index-LowerCaseFilter"> <para> - The second filter (LowerCaseFilter) normalizes token text to lower case. + Comment #2: The second filter (LowerCaseFilter) normalizes token text to lower case. </para> - </callout> - <callout arearefs="area-Reference_Guide-Search_Configuration-Global_Search_Index-StopFilter"> <para> - The last filter (StopFilter) removes stop words from a token stream. The stop set is defined in the analyzer. + Comment #3: The last filter (StopFilter) removes stop words from a token stream. The stop set is defined in the analyzer. </para> - </callout> - </calloutlist> - </programlistingco> + </example> <para> The global search index is configured in the <filename><replaceable>EPP_DIST</replaceable>/jboss-as/server/<replaceable>VERSION</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml</filename> configuration file within the &quot;query-handler&quot; tag. </para> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/workspace-persistence-storage.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/workspace-persistence-storage.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/configuration/workspace-persistence-storage.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -9,19 +9,10 @@ Each Workspace of the JCR has its own persistent storage to hold that workspace&apos;s items data. The eXo JCR can be configured so that it can use one or more workspaces that are logical units of the repository content. </para> <para> - The physical data storage mechanism is configured using mandatory element <emphasis role="bold">container</emphasis>. The type of container is described in the attribute <parameter>class = <replaceable>fully_qualified_name_of_org.exoplatform.services.jcr.storage.WorkspaceDataContainer_subclass</replaceable></parameter>. For example: + The physical data storage mechanism is configured using mandatory element <emphasis role="bold">container</emphasis>. The type of container is described in the attribute <parameter>class = <replaceable>fully_qualified_name_of_org.exoplatform.services.jcr.storage.WorkspaceDataContainer_subclass</replaceable></parameter>. </para> - <programlistingco> - <areaspec> - <area coords="3 90" id="area-Reference_Guide-Workspace_Data_Container-source_name"/> - <area coords="4 90" id="area-Reference_Guide-Workspace_Data_Container-dialect"/> - <area coords="5 90" id="area-Reference_Guide-Workspace_Data_Container-multidb"/> - <area coords="6 90" id="area-Reference_Guide-Workspace_Data_Container-maxbuffer"/> - <area coords="7 90" id="area-Reference_Guide-Workspace_Data_Container-swap"/> - <area coords="8 90" id="area-Reference_Guide-Workspace_Data_Container-lazy-node-iterator-page-size"/> - <area coords="9 90" id="area-Reference_Guide-Workspace_Data_Container-acl-bloomfilter-false-positive-probability"/> - <area coords="10 90" id="area-Reference_Guide-Workspace_Data_Container-acl-bloomfilter-elements-number"/> - </areaspec> + <example> + <title>Physical Data Storage Configuration</title> <programlisting language="XML" role="XML">&lt;container class=&quot;org.exoplatform.services.jcr.impl.storage.jdbc.JDBCWorkspaceDataContainer&quot;&gt; &lt;properties&gt; &lt;property name=&quot;source-name&quot; value=&quot;jdbcjcr1&quot;/&gt; @@ -33,49 +24,31 @@ &lt;property name=&quot;acl-bloomfilter-false-positive-probability&quot; value=&quot;0.1d&quot;/&gt; &lt;property name=&quot;acl-bloomfilter-elements-number&quot; value=&quot;1000000&quot;/&gt; &lt;/properties&gt;</programlisting> - <calloutlist> -<!-- # --> <callout arearefs="area-Reference_Guide-Workspace_Data_Container-source_name"> <para> <literal>source-name</literal>: The JDBC data source name which is registered in JDNI by InitialContextInitializer. This was known as <literal>sourceName</literal> in versions prior to 1.9. </para> - </callout> -<!-- # --> <callout arearefs="area-Reference_Guide-Workspace_Data_Container-dialect"> <para> <literal>dialect</literal>: The database dialect. Must be one of the following: <literal>hsqldb</literal>, <literal>mysql</literal>, <literal>mysql-utf8</literal>, <literal>pgsql</literal>, <literal>oracle</literal>, <literal>oracle-oci</literal>, <literal>mssql</literal>, <literal>sybase</literal>, <literal>derby</literal>, <literal>db2</literal> or <literal>db2v8</literal>). </para> - </callout> -<!-- # --> <callout arearefs="area-Reference_Guide-Workspace_Data_Container-multidb"> <para> <literal>multi-db</literal>: This parameter, if <literal>true</literal>, enables multi-database container. </para> - </callout> -<!-- # --> <callout arearefs="area-Reference_Guide-Workspace_Data_Container-maxbuffer"> <para> <literal>max-buffer-size</literal>: A threshold in bytes. If a value size is greater than this setting, then it will be spooled to a temporary file. </para> - </callout> -<!-- # --> <callout arearefs="area-Reference_Guide-Workspace_Data_Container-swap"> <para> <literal>swap-directory</literal>: A location where the value will be spooled if no value storage is configured but a <literal>max-buffer-size</literal> is exceeded. </para> - </callout> -<!-- # --> <callout arearefs="area-Reference_Guide-Workspace_Data_Container-lazy-node-iterator-page-size"> <para> <literal>lazy-node-iterator-page-size</literal>: &quot;Lazy&quot; child nodes iterator settings. Defines size of page, the number of nodes that are retrieved from persistent storage at once. </para> - </callout> -<!-- # --> <callout arearefs="area-Reference_Guide-Workspace_Data_Container-acl-bloomfilter-false-positive-probability"> <para> <literal>acl-bloomfilter-false-positive-probability</literal>: ACL Bloom-filter settings. ACL Bloom-filter desired false positive probability. Range [0..1]. Default value 0.1d. </para> - </callout> -<!-- # --> <callout arearefs="area-Reference_Guide-Workspace_Data_Container-acl-bloomfilter-elements-number"> <para> <literal>acl-bloomfilter-elements-number</literal>: ACL Bloom-filter settings. Expected number of ACL-elements in the Bloom-filter. Default value 1000000. </para> - </callout> - </calloutlist> - </programlistingco> + </example> <note> <para> Bloom filters are not supported by all the cache implementations so far only the inplementation for infinispan supports it. @@ -96,11 +69,8 @@ <para> The Data Container will try to read or write a Value using the underlying value storage plug-in if the filter criteria (see below) match the current property. </para> - <programlistingco> - <areaspec> - <area coords="2 123" id="area-Reference_Guide-Workspace_Data_Container-value_storage"/> - <area coords="6 90" id="area-Reference_Guide-Workspace_Data_Container-filters"/> - </areaspec> + <example> + <title>External Value Storage Configuration</title> <programlisting language="XML" role="XML">&lt;value-storages&gt; &lt;value-storage id=&quot;Storage #1&quot; class=&quot;org.exoplatform.services.jcr.impl.storage.value.fs.TreeFileValueStorage&quot;&gt; &lt;properties&gt; @@ -111,16 +81,13 @@ &lt;/filters&gt; ......... &lt;/value-storages&gt;</programlisting> - <calloutlist> -<!-- # --> <callout arearefs="area-Reference_Guide-Workspace_Data_Container-value_storage"> <para> <literal>value-storage</literal> is the subclass of <literal>org.exoplatform.services.jcr.storage.value.ValueStoragePlugin</literal> and <literal>properties</literal> are optional plug-in specific parameters. </para> - </callout> -<!-- # --> <callout arearefs="area-Reference_Guide-Workspace_Data_Container-filters"> <para> <literal>filters</literal>: Each file value storage can have the filter(s) for incoming values. If there are several filter criteria, they all have to match (AND-Condition). </para> + </example> <para> A filter can match values by property type (property-type), property name (property-name), ancestor path (ancestor-path) and/or the size of values stored (min-value-size, e.g. 1M, 4.2G, 100 (bytes)). </para> @@ -130,7 +97,4 @@ <para> It is recommended that you store properties with large values in a file value storage only. </para> - </callout> - </calloutlist> - </programlistingco> </chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/lock-manager-config.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/lock-manager-config.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/lock-manager-config.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -93,53 +93,23 @@ <para> The required configuration is shown in the example below: </para> - <programlistingco> - <areaspec> - <area coords="4 173" id="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-jbosscache-lock-config.xml"/> - </areaspec> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_JCR_lock-manager-config/default49.xml" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-jbosscache-lock-config.xml"> <para> - The <replaceable>jbosscache-lock-config.xml</replaceable> is shown below. + Sample content of the <replaceable>jbosscache-lock-config.xml</replaceable> file specified in the <replaceable>jbosscache-configuration</replaceable> property is shown in the code example below. </para> - </callout> - </calloutlist> - </programlistingco> - <para> - The <filename>jbosscache-lock-config.xml</filename> file: - </para> - <programlistingco> - <areaspec> - <area coords="6 90" id="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-clusterName"/> - <area coords="41 90" id="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.table.name"/> - <areaset coords="" id="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.types"> - <area coords="48 90" id="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.node.type"/> - <area coords="46 90" id="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.fqn.type"/> - </areaset> - </areaspec> + <example> + <title>Sample Content of the jbosscache-lock-config.xml File</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_JCR_lock-manager-config/default50.xml" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-clusterName"> <para> - The cluster name at <parameter>clustering mode=&quot;replication&quot; clusterName=&quot;JBoss-Cache-Lock-Cluster_Name&quot;</parameter> must be unique; + Comment #1: The cluster name at <parameter>clustering mode=&quot;replication&quot; clusterName=&quot;JBoss-Cache-Lock-Cluster_Name&quot;</parameter> must be unique; </para> - </callout> - <callout arearefs="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.table.name"> <para> - The <parameter>cache.jdbc.table.name</parameter> must be unique per datasource. + Comment #2: The <parameter>cache.jdbc.table.name</parameter> must be unique per datasource. </para> - </callout> - <callout arearefs="area-Reference_Guide-CacheableLockManagerImpl-Simple_JBoss_Cache_Configuration-cache.jdbc.types"> <para> - The <parameter>cache.jdbc.node.type</parameter> and <parameter>cache.jdbc.fqn.type</parameter> parameters must be configured according to the database in use. + Comment #3: The <parameter>cache.jdbc.node.type</parameter> and <parameter>cache.jdbc.fqn.type</parameter> parameters must be configured according to the database in use. Refer to the table below for information about data types. </para> - <para> - Refer to the table below for information about data types. - </para> - </callout> - </calloutlist> - </programlistingco> + </example> <table id="tabl-Reference_Guide-Simple_JBoss_Cache_Configuration-Data_Types_in_Different_Databases"> <title>Data Types in Different Databases</title> <tgroup cols="3"> @@ -203,52 +173,23 @@ <para> Below is an example <filename>test-jbosscache-lock.xml</filename> template file: </para> - <programlistingco> - <areaspec> - <areaset coords="" id="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-cache.jdbc.templates"> - <area coords="24 90" id="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-cache.jdbc.table.name"/> - </areaset> - </areaspec> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_JCR_lock-manager-config/you.xml" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-cache.jdbc.templates"> - <para> - All the configurable parameters in this file are populated with templates which will be replaced with LockManager&apos;s configuration parameters. - </para> - </callout> - </calloutlist> - </programlistingco> <para> The parameters that will populate the above file are shown below: </para> - <programlistingco> - <areaspec> - <area coords="5 90" id="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-udp-mux.xml"/> - <areaset coords="" id="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-jbosscache-cl-cache.jdbc.parameters"> - <area coords="12 90" id="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-jbosscache-cl-cache.jdbc.fqn.column"/> - <area coords="15 90" id="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-jbosscache-cl-cache.jdbc.node.type"/> - </areaset> - </areaspec> + <example> + <title>JBoss Cache Configuration Parameters</title> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../../extras/Advanced_Development_JCR_lock-manager-config/default51.xml" parse="text"/></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-udp-mux.xml"> <para> - The <literal>jgroups-configuration</literal> has been moved to a separate configuration file (<filename>udp-mux.xml</filename>, shown below). + Comment #1: The <literal>jgroups-configuration</literal> has been moved to a separate configuration file (<filename>udp-mux.xml</filename>, shown below). In this case the <filename>udp-mux.xml</filename> is a common configuration for all JGroup components (QueryHandler, cache, LockManager), but this is not a requirement of the configuration method. </para> <para> - In this case the <filename>udp-mux.xml</filename> is a common configuration for all JGroup components (QueryHandler, cache, LockManager), but this is not a requirement of the configuration method. + Comment #2: The <parameter>jbosscache-cl-cache.jdbc.fqn.column</parameter> and <parameter>jbosscache-cl-cache.jdbc.node.type</parameter> parameters are not explicitly defined as <parameter>cache.jdbc.fqn.type</parameter> and <parameter>cache.jdbc.node.type</parameter> are defined in the JBoss Cache configuration. </para> - </callout> - <callout arearefs="area-Reference_Guide-CacheableLockManagerImpl-Template_JBoss_Cache_Configuration-jbosscache-cl-cache.jdbc.parameters"> + </example> <para> - The <parameter>jbosscache-cl-cache.jdbc.fqn.column</parameter> and <parameter>jbosscache-cl-cache.jdbc.node.type</parameter> parameters are not explicitly defined as <parameter>cache.jdbc.fqn.type</parameter> and <parameter>cache.jdbc.node.type</parameter> are defined in the JBoss Cache configuration. - </para> - <para> Refer to <xref linkend="tabl-Reference_Guide-Simple_JBoss_Cache_Configuration-Data_Types_in_Different_Databases"/> for information about setting these parameters or set them as <parameter>AUTO</parameter> and the data type will by detected automatically. </para> - </callout> - </calloutlist> - </programlistingco> <para> <filename>udp-mux.xml</filename>: </para> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-creation-service.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-creation-service.xml 2012-10-22 21:10:35 UTC (rev 8930) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/eXoJCR/jcr/repository-creation-service.xml 2012-10-22 21:23:56 UTC (rev 8931) @@ -44,12 +44,6 @@ <para> RepositoryCreationService configuration </para> - <programlistingco> - <areaspec> - <area coords="63 90" id="area-Reference_Guide-RepositoryCreationService-Configuration-factory-class-name" /> - - </areaspec> - <programlisting language="XML" role="XML">&lt;component&gt; &lt;key&gt;org.exoplatform.services.jcr.ext.backup.BackupManager&lt;/key&gt; &lt;type&gt;org.exoplatform.services.jcr.ext.backup.impl.BackupManagerImpl&lt;/type&gt; @@ -108,25 +102,15 @@ org.exoplatform.services.jcr.ext.repository.creation.RepositoryCreationServiceImpl &lt;/type&gt; &lt;init-params&gt; + <![CDATA[<!-- + Not a mandatory parameter. It indicates what to use to create DataSource objects. + -->]]> &lt;value-param&gt; &lt;name&gt;factory-class-name&lt;/name&gt; &lt;value&gt;org.apache.commons.dbcp.BasicDataSourceFactory&lt;/value&gt; &lt;/value-param&gt; &lt;/init-params&gt; &lt;/component&gt;</programlisting> - <calloutlist> - <!-- # --> <callout arearefs="area-Reference_Guide-RepositoryCreationService-Configuration-factory-class-name"> - <para> - <parameter>factory-class-name</parameter> is not mandatory parameter, indicates what the factory need to use to create DataSource objects - </para> - - </callout> - - </calloutlist> - - </programlistingco> - - </section> <!--<section id="sect-Reference_Guide-RepositoryCreationService-RepositoryCreationService_Interface">