[gatein-commits] gatein SVN: r2245 - in portal/trunk/docs/reference-guide/en: modules and 2 other directories.

Author: thomas.heute(a)jboss.com Date: 2010-03-14 06:55:14 -0400 (Sun, 14 Mar 2010) New Revision: 2245 Added: portal/trunk/docs/reference-guide/en/modules/configuration/EMailService_Configuration.xml Modified: portal/trunk/docs/reference-guide/en/Introduction.xml portal/trunk/docs/reference-guide/en/modules/Configuration.xml portal/trunk/docs/reference-guide/en/modules/Foundations.xml portal/trunk/docs/reference-guide/en/modules/Portlets.xml portal/trunk/docs/reference-guide/en/modules/configuration/Authentication_Token_Configuration.xml portal/trunk/docs/reference-guide/en/modules/configuration/Data_Injector_Configuration.xml portal/trunk/docs/reference-guide/en/modules/configuration/Database_Configuration.xml portal/trunk/docs/reference-guide/en/modules/configuration/IDM_Configuration.xml portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Navigation_Configuration.xml portal/trunk/docs/reference-guide/en/modules/development/JavaScript_Inter_Application_Communication.xml Log: Doc update Modified: portal/trunk/docs/reference-guide/en/Introduction.xml =================================================================== --- portal/trunk/docs/reference-guide/en/Introduction.xml 2010-03-14 10:54:08 UTC (rev 2244) +++ portal/trunk/docs/reference-guide/en/Introduction.xml 2010-03-14 10:55:14 UTC (rev 2245) @@ -1,24 +1,3 @@ -<!-- - - Copyright (C) 2009 eXo Platform SAS. - - This is free software; you can redistribute it and/or modify it - under the terms of the GNU Lesser General Public License as - published by the Free Software Foundation; either version 2.1 of - the License, or (at your option) any later version. - - This software is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this software; if not, write to the Free - Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - 02110-1301 USA, or see the FSF site: http://www.fsf.org. - ---> - <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.4//EN" "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd"> <chapter> <title>Introduction</title> @@ -45,7 +24,7 @@ <listitem> <para> GateIn videos: - <ulink url="http://www.jboss.org/gatein/videos.html">www.jboss.org/... + <ulink url="http://vimeo.com/channels/gatein">vimeo.com/channels/ga... </para> </listitem> <listitem> Modified: portal/trunk/docs/reference-guide/en/modules/Configuration.xml =================================================================== --- portal/trunk/docs/reference-guide/en/modules/Configuration.xml 2010-03-14 10:54:08 UTC (rev 2244) +++ portal/trunk/docs/reference-guide/en/modules/Configuration.xml 2010-03-14 10:55:14 UTC (rev 2245) @@ -5,16 +5,19 @@ ]> <chapter id="chap-Reference_Guide-Configuration"> <title>Configuration</title> + <xi:include href="configuration/Database_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="configuration/EMailService_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="configuration/Default_Portal_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="configuration/IDM_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="configuration/Default_Portal_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="configuration/Portal_Navigation_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="configuration/Authentication_Token_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="configuration/Predefined_User_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="configuration/Portal_Default_Permission_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!-- Kernel/Service_Configuration_for_Beginners --><!-- Kernel/Service_Configuration_in_Detail --><xi:include href="configuration/Database_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!-- Kernel/Service_Configuration_for_Beginners --> + <!-- Kernel/Service_Configuration_in_Detail --> <xi:include href="configuration/Data_Injector_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <!-- Core/LDAP_Configuration --><xi:include href="configuration/Skin_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="configuration/JavaScript_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="configuration/Dashboard_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="configuration/Authentication_Token_Configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </chapter> Modified: portal/trunk/docs/reference-guide/en/modules/Foundations.xml =================================================================== --- portal/trunk/docs/reference-guide/en/modules/Foundations.xml 2010-03-14 10:54:08 UTC (rev 2244) +++ portal/trunk/docs/reference-guide/en/modules/Foundations.xml 2010-03-14 10:55:14 UTC (rev 2245) @@ -2,8 +2,6 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % BOOK_ENTITIES SYSTEM "../Reference_Guide.ent"> %BOOK_ENTITIES; -<!ENTITY % BOOK_ENTITIES SYSTEM "../Reference_Guide.ent"> -%BOOK_ENTITIES; ]> <chapter id="chap-Reference_Guide-Foundations" xmlns:x="http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"... @@ -429,7 +427,7 @@ which returns the current <emphasis role="bold">PortalContainer</emphasis>. If your servlet handles the requests by implementing a <emphasis role="bold">service()</emphasis> method, you need to rename that method to match - the following signature: + the following signature:</para> <programlisting role="JAVA"><![CDATA[ /** * Use this method instead of Servlet.service() @@ -437,8 +435,6 @@ protected void onService(ExoContainer container, HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException; ]]></programlisting> - - </para> <note> The reason is that AbstractHttpServlet implements service() to perform its interception, and you don't want to overwrite (by overriding) this functionality. @@ -446,7 +442,7 @@ <para> You may also need to access portal information within your <emphasis role="bold">HttpSessionListener</emphasis>. Again, make sure to extend the provided abstract class - <emphasis role="bold">org.exoplatform.container.web. AbstractHttpSessionListener</emphasis>. - Also, modify your method signitures as follows: + Also, modify your method signitures as follows:</para> <programlisting role="JAVA"><![CDATA[ /** * Use this method instead of HttpSessionListener.sessionCreated() @@ -458,9 +454,8 @@ */ protected void onSessionDestroyed(ExoContainer container, HttpSessionEvent event); ]]></programlisting> - </para> <para> - There is another method you have to implement in this case: + There is another method you have to implement in this case:</para> <programlisting role="JAVA"><![CDATA[ /** * Method should return true if unified servlet context, @@ -468,7 +463,7 @@ */ protected boolean requirePortalEnvironment(); ]]></programlisting> - + <para> If this method returns true, current thread's context classloader is set up according to <emphasis role="bold">Dependencies</emphasis> configuration, and availability of the associated web applications. If it returns false, the standard application separation rules are used for resource loading (effectively turning off the Modified: portal/trunk/docs/reference-guide/en/modules/Portlets.xml =================================================================== --- portal/trunk/docs/reference-guide/en/modules/Portlets.xml 2010-03-14 10:54:08 UTC (rev 2244) +++ portal/trunk/docs/reference-guide/en/modules/Portlets.xml 2010-03-14 10:55:14 UTC (rev 2245) @@ -5,11 +5,18 @@ ]> <chapter id="chap-Reference_Guide-Portlet_development"> <title>Portlet development</title> + <!-- Commented out as it's not for public usage --> + <!-- <xi:include href="portlets/WebUI.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + --> <xi:include href="portlets/AJAX_in_GateIn_Framework.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="portlets/Groovy_Templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="portlets/Portlet_Lifecycle.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="portlets/Standard.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!-- Unedited pending new example --> <xi:include href="portlets/Create_a_WebUI_Portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!-- Unedited pending new example --> + <!-- Commented out as it's not for public usage --> + <!-- + <xi:include href="portlets/Create_a_WebUI_Portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + --> </chapter> Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Authentication_Token_Configuration.xml =================================================================== --- portal/trunk/docs/reference-guide/en/modules/configuration/Authentication_Token_Configuration.xml 2010-03-14 10:54:08 UTC (rev 2244) +++ portal/trunk/docs/reference-guide/en/modules/configuration/Authentication_Token_Configuration.xml 2010-03-14 10:55:14 UTC (rev 2245) @@ -56,7 +56,7 @@ <area coords="8" id="area-Reference_Guide-Authentication_Token_Configuration-Configure_token_services-time" /> <area coords="9" id="area-Reference_Guide-Authentication_Token_Configuration-Configure_token_services-unit" /> </areaspec> -<programlisting role="XML">&#60;component&#62; +<programlisting>&#60;component&#62; &#60;key&#62;org.exoplatform.web.security.security.CookieTokenService&#60;/key&#62; &#60;type&#62;org.exoplatform.web.security.security.CookieTokenService&#60;/type&#62; &#60;init-params&#62; Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Data_Injector_Configuration.xml =================================================================== --- portal/trunk/docs/reference-guide/en/modules/configuration/Data_Injector_Configuration.xml 2010-03-14 10:54:08 UTC (rev 2244) +++ portal/trunk/docs/reference-guide/en/modules/configuration/Data_Injector_Configuration.xml 2010-03-14 10:55:14 UTC (rev 2245) @@ -24,7 +24,7 @@ <title>Service configuration file</title> <para> -<programlisting role="XML">&#60;configuration&#62; +<programlisting>&#60;configuration&#62; &#60;component&#62; &#60;key&#62;org.exoplatform.portal.initializer.organization.OrganizationInitializer&#60;/key&#62; &#60;type&#62;org.exoplatform.portal.initializer.organization.OrganizationInitializer&#60;/type&#62; Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Database_Configuration.xml =================================================================== --- portal/trunk/docs/reference-guide/en/modules/configuration/Database_Configuration.xml 2010-03-14 10:54:08 UTC (rev 2244) +++ portal/trunk/docs/reference-guide/en/modules/configuration/Database_Configuration.xml 2010-03-14 10:55:14 UTC (rev 2245) @@ -22,7 +22,7 @@ GateIn will automatically generate the proper schema (assuming that the database user has the appropriate permissions).</para> - <para>GateIn assumes the default encoding for your database is + <para>&PRODUCT; assumes the default encoding for your database is <literal>latin1</literal> . You will need to change this parameter for your database in order to work properly.</para> </section> @@ -30,29 +30,26 @@ <section id="sect-Reference_Guide-Database_Configuration-JCR_database_configuration"> <title>Configuring the database for JCR</title> - <para>To configure the databaseused by JCR you will need to edit the - file:<programlisting>gatein.ear/02portal.war/WEB-INF/conf/jcr/jcr-configuration.xml</programlisting></para> + <para>To configure the database used by JCR you will need to edit the + file:<programlisting>$JBOSS_HOME/server/default/conf/gatein/configuration.properties</programlisting></para> - <para>And edit the values of driverClassName, url, username and password - with the values for your JDBC connection (Please refer to your database - JDBC driver documentation).</para> + <para>For Tomcat, the file is located at <programlisting>$TOMCAT_HOME/gatein/conf/configuration.properties</programlisting></para> - <programlisting role="XML">&lt;properties-param&gt; - &lt;name&gt;ref-addresses&lt;/name&gt; - &lt;description&gt;ref-addresses&lt;/description&gt; - &lt;property name="driverClassName" value="org.hsqldb.jdbcDriver"/&gt; - &lt;property name="url" value="jdbc:hsqldb:file:${gatein.db.data.dir}/data/jdbcjcr${container.name.suffix}"/&gt; - property name="username" value="sa"/&gt; - &lt;property name="password" value=""/&gt; -&lt;/properties-param&gt; + <para>And edit the values of driver, url, username and password with the + values for your JDBC connection (Please refer to your database JDBC driver + documentation).</para> + + <programlisting role="XML">gatein.jcr.datasource.driver=org.hsqldb.jdbcDriver +gatein.jcr.datasource.url=jdbc:hsqldb:file:${gatein.db.data.dir}/data/jdbcjcr_${name} +gatein.jcr.datasource.username=sa +gatein.jcr.datasource.password= </programlisting> - <para>In that case, the name of the database is - "jdbcjcr${container.name.suffix}", ${container.name.suffix} should be part - of the database name, as it is dynamically replaced by the name of the - portal extension (for instance gatein-sample-portal.ear defines - "sample-portal" as container name and the default portal defines "portal" - as container name). </para> + <para>In that case, the name of the database is "jdbcjcr_${name}", ${name} + should be part of the database name, as it is dynamically replaced by the + name of the portal container extension (for instance + gatein-sample-portal.ear defines "sample-portal" as container name and the + default portal defines "portal" as container name).</para> <para>In the case of HSQL the databases are created automatically, for any other database you will need to create a database named jdbcjcr_portal @@ -78,14 +75,11 @@ <para>Then we need to add the MySQL JDBC connector in the classpath and finally edit gatein.ear/02portal.war/WEB-INF/conf/jcr/jcr-configuration - with:<programlisting>&lt;properties-param&gt; - &lt;name&gt;ref-addresses&lt;/name&gt; - &lt;description&gt;ref-addresses&lt;/description&gt; - &lt;property name="driverClassName" value="com.mysql.jdbc.Driver"/&gt; - &lt;property name="url" value="jdbc:mysql://localhost:3306/mygateindb${container.name.suffix}"/&gt; - &lt;property name="username" value="gateinuser"/&gt; - &lt;property name="password" value="gateinpassword"/&gt; -&lt;/properties-param&gt;</programlisting></para> + with:<programlisting>gatein.jcr.datasource.driver=com.mysql.jdbc.Driver +gatein.jcr.datasource.url=jdbc:mysql://localhost:3306/mygateindb${container.name.suffix} +gatein.jcr.datasource.username=gateinuser +gatein.jcr.datasource.password=gateinpassword +</programlisting></para> </section> <section> @@ -94,18 +88,13 @@ <para>By default users are stored in database. To change the database to store users, you will need to edit the file:</para> - <para><programlisting>gatein.ear/02portal.war/WEB-INF/conf/organization/idm-configuration.xml</programlisting>You - will find the same configuration as in - jcr-configuration.xml:<programlisting>&lt;properties-param&gt; - &lt;name&gt;ref-addresses&lt;/name&gt; - &lt;description&gt;ref-addresses&lt;/description&gt; - &lt;property name="driverClassName" value="org.hsqldb.jdbcDriver"/&gt; - &lt;property name="url" value="jdbc:hsqldb:file:${gatein.db.data.dir}/data/jdbcidm${container.name.suffix}"/&gt; - property name="username" value="sa"/&gt; - &lt;property name="password" value=""/&gt; -&lt;/properties-param&gt;</programlisting></para> + <para><programlisting>$JBOSS_HOME/server/default/conf/gatein/configuration.properties</programlisting>For + Tomcat, the file is located at <programlisting>$TOMCAT_HOME/gatein/conf/configuration.properties</programlisting></para> - <para>It is recommended to use a different database than the one used by - JCR.</para> + <para>You will find the same configuration as in + jcr-configuration.xml:<programlisting>gatein.idm.datasource.driver=org.hsqldb.jdbcDriver +gatein.idm.datasource.url=jdbc:hsqldb:file:${gatein.db.data.dir}/data/jdbcidm_${name} +gatein.idm.datasource.username=sa +gatein.idm.datasource.password</programlisting></para> </section> </section> Added: portal/trunk/docs/reference-guide/en/modules/configuration/EMailService_Configuration.xml =================================================================== --- portal/trunk/docs/reference-guide/en/modules/configuration/EMailService_Configuration.xml (rev 0) +++ portal/trunk/docs/reference-guide/en/modules/configuration/EMailService_Configuration.xml 2010-03-14 10:55:14 UTC (rev 2245) @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="sect-Reference_Guide-EMail_Service_Configuration"> + <title>E-Mail Service Configuration</title> + + <section id="sect-Reference_Guide-EMail_Service_Configuration-Overview"> + <title>Overview</title> + + <para>&PRODUCT; has a service to send e-mails that requires to be configured + before it can work properly. This service is used to send e-mails to users who forgot + their username or password for instance.</para> + + </section> + + <section id="sect-Reference_Guide-EMail_Service_Configuration-Parameters"> + <title>Configuring the database for JCR</title> + + <para>The e-mail service can use any SMTP account that needs to be configured in + $JBOSS_HOME/server/default/conf/gatein/configuration.properties + (Or $TOMCAT_HOME/gatein/conf/configuration.properties if you are using Tomcat).</para> + + <para>The relevant section looks like:</para> + + <programlisting># EMail +gatein.email.smtp.username= +gatein.email.smtp.password= +gatein.email.smtp.host=smtp.gmail.com +gatein.email.smtp.port=465 +gatein.email.smtp.starttls.enable=true +gatein.email.smtp.auth=true +gatein.email.smtp.socketFactory.port=465 +gatein.email.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory</programlisting> + + <para>It is preconfigured for GMail so that any GMail account can be easily used (Just use a full gmail address + as username and fill-in the password.</para> + </section> +</section> Modified: portal/trunk/docs/reference-guide/en/modules/configuration/IDM_Configuration.xml =================================================================== --- portal/trunk/docs/reference-guide/en/modules/configuration/IDM_Configuration.xml 2010-03-14 10:54:08 UTC (rev 2244) +++ portal/trunk/docs/reference-guide/en/modules/configuration/IDM_Configuration.xml 2010-03-14 10:55:14 UTC (rev 2245) @@ -37,7 +37,7 @@ <area coords="5" id="area-Reference_Guide-PicketLink_IDM_integration-Configuration_files-JBossIDMServiceImpl" /> <area coords="22" id="area-Reference_Guide-PicketLink_IDM_integration-Configuration_files-JBossIDMOrganizationServiceImpl" /> </areaspec> -<programlisting role="XML">&#60;configuration xmlns:xsi=&#34;http://www.w3.org/2001/XMLSchema-instance&#34; +<programlisting>&#60;configuration xmlns:xsi=&#34;http://www.w3.org/2001/XMLSchema-instance&#34; xsi:schemaLocation=&#34;http://www.exoplaform.org/xml/ns/kernel_1_0.xsd http://www.exoplaform.org/xml/ns/kernel_1_0.xsd&#34; xmlns=&#34;http://www.exoplaform.org/xml/ns/kernel_1_0.xsd&#34;&a...; Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Navigation_Configuration.xml =================================================================== --- portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Navigation_Configuration.xml 2010-03-14 10:54:08 UTC (rev 2244) +++ portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Navigation_Configuration.xml 2010-03-14 10:55:14 UTC (rev 2245) @@ -107,7 +107,7 @@ The portal navigation incorporates the pages that can be accessed when the user is not logged in (if the applicable permissions allow public access). For example; several portal navigations are used when a company has multiple trademarks and each trade has its own website. </para> <para> - The <emphasis role="bold">classic</emphasis> portal is configured by four XML files in the <filename>portal/WEBINF/conf/portal/portal/classic</filename> directory: + The <emphasis role="bold">classic</emphasis> portal is configured by four XML files in the <filename>02portal.war:/WEB-INF/conf/portal/portal/classic</filename> directory: </para> <variablelist> <varlistentry> Modified: portal/trunk/docs/reference-guide/en/modules/development/JavaScript_Inter_Application_Communication.xml =================================================================== --- portal/trunk/docs/reference-guide/en/modules/development/JavaScript_Inter_Application_Communication.xml 2010-03-14 10:54:08 UTC (rev 2244) +++ portal/trunk/docs/reference-guide/en/modules/development/JavaScript_Inter_Application_Communication.xml 2010-03-14 10:55:14 UTC (rev 2245) @@ -246,7 +246,7 @@ </section> <section id="sect-Reference_Guide-JavaScript_Inter_Application_Communication-Example_of_what"> - <title>Example [of what?]</title> + <title>Example of Javascript events usage</title> <programlisting role="HTML">&#60;%@ taglib uri=&#34;http://java.sun.com/portlet&#34; prefix=&#34;portlet&#34; %&#62; &#60;portlet:defineObjects/&#62;