[gatein-commits] gatein SVN: r1414 - portal/trunk/docs/reference-guide/en/modules/configuration.

Author: smumford Date: 2010-01-22 01:57:52 -0500 (Fri, 22 Jan 2010) New Revision: 1414 Modified: 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/Skin_Configuration.xml Log: continuing edits 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-01-22 03:14:28 UTC (rev 1413) +++ portal/trunk/docs/reference-guide/en/modules/configuration/Data_Injector_Configuration.xml 2010-01-22 06:57:52 UTC (rev 1414) @@ -8,7 +8,8 @@ <section id="sect-Reference_Guide-Data_Injector_Configuration-Data_Injector"> <title>Data Injector</title> <para> - <emphasis>Data-injector</emphasis> is an utility to initialize enterprise data for Portal. It is packed as a .jar. <!-- + <emphasis>Data-injector</emphasis> is a utility to initialize enterprise data for &PRODUCT;. It is packed as a .jar. +<!-- and deployed under $TOMCATHOME/lib. It is started automatically when Tomcat starts. --> @@ -18,13 +19,11 @@ <section id="sect-Reference_Guide-Data_Injector_Configuration-OrganizationInitializer"> <title>OrganizationInitializer</title> <para> - <emphasis>OrganizationInitializer</emphasis> is the service that allows creating a large organization with many groups and users. It also creates portal navigation and page(s) for each group, each user. + <emphasis>OrganizationInitializer</emphasis> is the service that allows creating a large organization with many groups and users. It also creates portal navigation and page(s) for each group and each user. </para> - </section> - - <section id="sect-Reference_Guide-Data_Injector_Configuration-Service_configuration_file"> + <formalpara > <title>Service configuration file</title> - + <para> <programlisting role="XML">&lt;configuration&gt; &lt;component&gt; &lt;key&gt;org.exoplatform.portal.initializer.organization.OrganizationInitializer&lt;/key&gt; @@ -90,83 +89,125 @@ &lt;/component&gt; &lt;/configuration&gt; </programlisting> + </para> + </formalpara> </section> - <section id="sect-Reference_Guide-Data_Injector_Configuration-Parameters_for_Group"> - <title>Parameters for Group</title> - <itemizedlist> + <section id="sect-Reference_Guide-Data_Injector_Configuration-Group_Parameters"> + <title>Group Parameters</title> + <variablelist> + <varlistentry> + <term>Name</term> <listitem> <para> - <emphasis>name</emphasis> : The name of group. + The name of the group. </para> </listitem> + </varlistentry> + <varlistentry> + <term>ParentId</term> <listitem> <para> - <emphasis>parentId</emphasis> : The id of parent group. If the parent id is null, it means that the group is at the first level. If parent groups do not exist, it will be created automatically. + The ID of the parent group. If the parent ID is null the group is at the first level. If parent groups do not exist, this ID will be created automatically. </para> </listitem> + </varlistentry> + <varlistentry> + <term>Description</term> <listitem> <para> - <emphasis>description</emphasis> : The description of group. + A description of the group. </para> </listitem> + </varlistentry> + <varlistentry> + <term>Label</term> <listitem> <para> - <emphasis>label</emphasis> : The label of group. + A label for the group. </para> </listitem> + </varlistentry> + <varlistentry> + <term>From and to</term> <listitem> <para> - <emphasis>from and to</emphasis> : This group can be cloned to may copies and each copy is marked a number from!images/number.png!images/ to!images/ number.png!. + This group can be cloned to may copies and each copy is marked with a number. </para> </listitem> - </itemizedlist> + </varlistentry> + </variablelist> </section> - <section id="sect-Reference_Guide-Data_Injector_Configuration-Parameters_for_User"> - <title>Parameters for User</title> - <itemizedlist> + <section id="sect-Reference_Guide-Data_Injector_Configuration-User_Parameters"> + <title>User Parameters</title> + <variablelist> + <varlistentry> + <term>UserName</term> <listitem> <para> - <emphasis>userName</emphasis> : The ID of user. + The user's ID. </para> </listitem> + </varlistentry> + <varlistentry> + <term>Password</term> <listitem> <para> - <emphasis>password</emphasis> : The password of user. + The user's password. </para> </listitem> + </varlistentry> + <varlistentry> + <term>FirstName</term> <listitem> <para> - <emphasis>firstName</emphasis> : The first name of user. + </para> </listitem> + </varlistentry> + <varlistentry> + <term>LastName</term> <listitem> <para> - <emphasis>lastName</emphasis> : The last name of user. + last name. </para> </listitem> + </varlistentry> + <varlistentry> + <term>Email</term> <listitem> <para> - <emphasis>email</emphasis> : The email of user. + The user's email address. </para> </listitem> + </varlistentry> + <varlistentry> + <term>Groups</term> + <listitem> <para> - <emphasis>groups</emphasis> : The list of groups that user join with membership type + A list of the groups that user belongs to. </para> </listitem> + </varlistentry> + <varlistentry> + <term>From and to</term> <listitem> <para> - <emphasis>from and to</emphasis> : This user can be cloned to may copies and each copy is marked a number from!images/number.png!images/ to!images/ number.png!. With this configuration we can create a range of users and put them to various groups and other range to other groups. + Users can be cloned and each copy is assigned a number. This allows the creation of a range of users that can be put into various groups based on the range value. </para> </listitem> - </itemizedlist> + </varlistentry> + </variablelist> + </section> + <section> + <title>Automatic Navigation Creation</title> <para> - The " <emphasis>auto.create.group.page.navigation</emphasis> " Parameter Value is true or false. If TRUE it automatically create portal navigation and page for each group. If FALSE it does not create portal navigation and page for each group. + The " <literal>auto.create.group.page.navigation</literal>" parameter value is <parameter>true</parameter> or <parameter>false</parameter>. If this value is set to <parameter>true</parameter> it automatically creates portal navigations and pages for each group. If <parameter>false</parameter> it does not. </para> <para> - The " <emphasis>auto.create.user.page.navigation</emphasis> " Parameter Value is number of pages that automatically created for each user. + The "<literal>auto.create.user.page.navigation</literal>" parameter value is the number of pages that are automatically created for each user. </para> </section> Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Database_Configuration.xml =================================================================== --- portal/trunk/docs/reference-guide/en/modules/configuration/Database_Configuration.xml 2010-01-22 03:14:28 UTC (rev 1413) +++ portal/trunk/docs/reference-guide/en/modules/configuration/Database_Configuration.xml 2010-01-22 06:57:52 UTC (rev 1414) @@ -84,10 +84,10 @@ &lt;/configuration&gt; </programlisting> <para> - The first component configuration is for the Hibernate service. You can enter any additional properties in a hibernate.properties file, but GateIn will override hibernate.properties with values read in from this configuration file. + The first component configuration is for the Hibernate service. You can enter any additional properties in a <literal>hibernate.properties</literal> file, but &PRODUCT; will override <literal>hibernate.properties</literal> with values read in from this configuration file. </para> <para> - The second component configuration is for the JCR datasource. The InitialContextInitializer component will load the factory class, use the factory object to create a datasource, and bind that datasource in the JNDI tree with the value of the "bind-name" parameter. If you want to change the bind-name, for example "jdbcexo" to "myjdbc", you also need to change JCR repository configuration in order that the service picks up the right datasource. + The second component configuration is for the JCR datasource. The <literal>InitialContextInitializer</literal> component will load the factory class, use the factory object to create a datasource, and bind that datasource in the JNDI tree with the value of the "bind-name" parameter. If you want to change the bind-name, for example "<parameter>jdbcexo</parameter>" to "<parameter>myjdbc</parameter>", you also need to change JCR repository configuration in order that the service picks up the right datasource. </para> <para> Make sure you update the database connection properties and dialect for both of these component configurations. @@ -97,7 +97,7 @@ <section id="sect-Reference_Guide-Database_Configuration-JCR_database_configuration"> <title>JCR database configuration</title> <para> - There are two JCR configuration files that must be changed to support a different database. In both files, <emphasis role="bold">edit the dialect (and the data source name if necessary)</emphasis> . + There are two JCR configuration files that must be changed to support a different database. In both files, <emphasis>edit the dialect (and the data source name if necessary)</emphasis> . </para> <para> The first file is <filename>02portal.war:/WEB-INF/conf/jcr/jcr-configuration.xml</filename> : Modified: portal/trunk/docs/reference-guide/en/modules/configuration/IDM_Configuration.xml =================================================================== --- portal/trunk/docs/reference-guide/en/modules/configuration/IDM_Configuration.xml 2010-01-22 03:14:28 UTC (rev 1413) +++ portal/trunk/docs/reference-guide/en/modules/configuration/IDM_Configuration.xml 2010-01-22 06:57:52 UTC (rev 1414) @@ -236,7 +236,7 @@ </para> </listitem> </itemizedlist> --> -<!-- MARK --> + <para> A sample <emphasis role="bold">JBoss Identity IDM</emphasis> configuration file is shown below. To understand all the options present in it please refer to the JBoss Identity IDM Reference Guide </para> Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Skin_Configuration.xml =================================================================== --- portal/trunk/docs/reference-guide/en/modules/configuration/Skin_Configuration.xml 2010-01-22 03:14:28 UTC (rev 1413) +++ portal/trunk/docs/reference-guide/en/modules/configuration/Skin_Configuration.xml 2010-01-22 06:57:52 UTC (rev 1414) @@ -8,7 +8,7 @@ <section id="sect-Reference_Guide-Skin_Configuration-Overview"> <title>Overview</title> <para> - GateIn provides support for skinning the entire portal User Interface (UI) including your own portlets. Skins are designed to help you pack and reuse common graphic resources. + &PRODUCT; provides support for skinning the entire portal User Interface (UI) including your own portlets. Skins are designed to help you pack and reuse common graphic resources. </para> </section> @@ -23,16 +23,23 @@ </imageobject> </mediaobject> <para> - When you switch, the whole portal will be repainted and new styles will be applied to the UI. + When you switch, the whole portal will be repainted and the new styles will be applied to the UI. </para> </section> <section id="sect-Reference_Guide-Skin_Configuration-Skins_in_Page_Markups"> <title>Skins in Page Markups</title> <para> - An GateIn skin contains css styles for GateIn portal's components but also shares components that may be reused in portlets. When GateIn generates a portal page markup, it inserts stylesheet links in the page's <literal>head</literal> tag. + A &PRODUCT; skin contains css styles for the portal's components but also shares components that may be reused in portlets. When &PRODUCT; generates a portal page markup, it inserts stylesheet links in the page's <literal>head</literal> tag. </para> - + <para> + In the snipped code below you can see two types of links: + </para> + <programlistingco> + <areaspec> + <area coords="3" id="area-Reference_Guide-Skin_Configuration-Coreskin" /> + <area coords="4" id="area-Reference_Guide-Skin_Configuration-Stylesheets" /> + </areaspec> <programlisting>&lt;head&gt; ... &lt;link id="CoreSkin" rel="stylesheet" type="text/css" href="/eXoResources/skin/Stylesheet.css" /&gt; @@ -43,49 +50,55 @@ ... &lt;/head&gt; </programlisting> - <para> - In the snipped code above, you can see two types of links : - </para> - <itemizedlist> - <listitem> - <para> - Portal skin stylesheet (<literal>id="CoreSkin"</literal>). - </para> - </listitem> - <listitem> - <para> - Portlets skin stylesheets (all others) : each portlet within the page may contribute its own styles. - </para> - </listitem> - </itemizedlist> + + <calloutlist> + <callout arearefs="area-Reference_Guide-Skin_Configuration-Coreskin"> + <para> + Portal skin stylesheet (<literal>id="CoreSkin"</literal>). + </para> + </callout> + <callout arearefs="area-Reference_Guide-Skin_Configuration-Stylesheets"> + <para> + Portlets skin stylesheets (<emphasis role="bold">all others</emphasis>). Each portlet within the page may contribute its own style(s). + </para> + </callout> + </calloutlist> + </programlistingco> </section> <section id="sect-Reference_Guide-Skin_Configuration-Types_of_Styles"> <title>Types of Styles</title> - <orderedlist numeration="arabic"> - <listitem> - <para> - portal skin is typically made of 3 types of styles: - </para> - </listitem> - <listitem> - <para> - Portlet themes : decorations for portlet windows. - </para> - </listitem> - <listitem> - <para> - Portal styles : default styles for html tags (ex div,th,td...) + the portal UI including the sidebar and portal admin screens. - </para> - </listitem> - <listitem> - <para> - Shared styles : GateIn WebUI components styles are reused among different GateIn portlets. - </para> - </listitem> - </orderedlist> + <para> + The portal skin is typically made of 3 types of styles: + </para> + <variablelist> + <varlistentry> + <term>Portlet themes</term> + <listitem> + <para> + Decorations for portlet windows. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Portal styles</term> + <listitem> + <para> + Default styles for html tags (ex div,th,td...) and the portal UI (including the sidebar and portal admin screens). + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Shared styles</term> + <listitem> + <para> + &PRODUCT; WebUI components styles are reused among different portlets. + </para> + </listitem> + </varlistentry> + </variablelist> <para> - This is revealed easily by the main portal skin stylesheets. For example <emphasis role="bold">/eXoVistaSkin/skin/Stylesheet.css</emphasis> + The main portal skin stylesheet (<filename>/eXoVistaSkin/skin/Stylesheet.css</filename>)is shown below as an example: </para> <programlisting>@import url(/eXoResources/skin/PortletThemes/Stylesheet.css) ; @@ -97,14 +110,14 @@ <section id="sect-Reference_Guide-Skin_Configuration-Portlet_Styles"> <title>Portlet Styles</title> <para> - Portlets often require additionnal styles that may not be defined by the portal skin. GateIn allows portlets to define additional stylesheets for each portlet and will append the corresponding <literal>link</literal> tags to the <literal>head</literal>. + Portlets often require additionnal styles that may not be defined by the portal skin. &PRODUCT; allows portlets to define additional stylesheets for each portlet and will append the corresponding <literal>link</literal> tags to the <literal>head</literal>. </para> <para> - The link ID will be of the form {portletAppName}{}<literal>$$<literal>PortletName</literal>. For example: <literal>ContentPortlet</literal> in <literal>content.war</literal>, will give <parameter>id="content</parameter>ContentPortlet"</literal> + The link ID will be of the form <parameter>{portletAppName}{}$$PortletName</parameter>. For example: <literal>ContentPortlet</literal> in <literal>content.war</literal>, will give <parameter>id="content<literal>ContentPortlet"</literal></parameter> </para> - <para> - TODO: give some rules to follow in order to avoid overriding portal styles - </para> + +<!-- #################### TODO: give some rules to follow in order to avoid overriding portal styles #####################--> + </section> <section id="sect-Reference_Guide-Skin_Configuration-How_to_Configure_a_Portal_Skin">