gatein SVN: r1400 - in portal/trunk/docs/reference-guide/en/modules: configuration and 1 other directory.
12:33 a.m.
Author: smumford
Date: 2010-01-21 01:33:57 -0500 (Thu, 21 Jan 2010)
New Revision: 1400
Modified:
portal/trunk/docs/reference-guide/en/modules/Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Database_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Default_Portal_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Default_Permission_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Navigation_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Predefined_User_Configuration.xml
Log:
early edits
Modified: portal/trunk/docs/reference-guide/en/modules/Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/Configuration.xml 2010-01-21 06:32:28 UTC
(rev 1399)
+++ portal/trunk/docs/reference-guide/en/modules/Configuration.xml 2010-01-21 06:33:57 UTC
(rev 1400)
@@ -10,9 +10,11 @@
<xi:include href="configuration/Portal_Navigation_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/Database_Configuration.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<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" />
+ <!-- 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" />
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-21
06:32:28 UTC (rev 1399)
+++
portal/trunk/docs/reference-guide/en/modules/configuration/Database_Configuration.xml 2010-01-21
06:33:57 UTC (rev 1400)
@@ -8,7 +8,7 @@
<section id="sect-Reference_Guide-Database_Configuration-Overview">
<title>Overview</title>
<para>
- GateIn Portal has two different database dependencies. One is the Hibernate service
configuration, which depends on the the Hibernate and c3p0 projects. The other database
dependency is Java content repository (JCR) service, which depends on the native JDBC API
and it can integrate with any existing datasource implementation.
+ &PRODUCT; has two different database dependencies. One is the Hibernate service
configuration, which depends on the the Hibernate and c3p0 projects. The other database
dependency is Java content repository (JCR) service, which depends on the native JDBC API
and it can integrate with any existing datasource implementation.
</para>
<para>
When you change the database configuration for the first time, GateIn will
automatically generate the proper schema (assuming that the database user has the
appropriate permissions).
Modified:
portal/trunk/docs/reference-guide/en/modules/configuration/Default_Portal_Configuration.xml
===================================================================
---
portal/trunk/docs/reference-guide/en/modules/configuration/Default_Portal_Configuration.xml 2010-01-21
06:32:28 UTC (rev 1399)
+++
portal/trunk/docs/reference-guide/en/modules/configuration/Default_Portal_Configuration.xml 2010-01-21
06:33:57 UTC (rev 1400)
@@ -8,14 +8,14 @@
<section
id="sect-Reference_Guide-Default_Portal_Configuration-Overview">
<title>Overview</title>
<para>
- default portal will be accessed when the user doesn't specify the portal. For
example: <literal>http://hostname:port/portal/</literal>. And the default
portal be used for checking at starting of tomcat to determine whether database is empty
or not, too.
+ The default portal will be accessed if the user doesn't specify another portal.
For example: <literal>http://hostname:port/portal/</literal>. The default
portal also be used at startup to determine if the tomcat database is empty or not.
</para>
</section>
<section
id="sect-Reference_Guide-Default_Portal_Configuration-Configuration">
<title>Configuration</title>
<para>
- Configuration file path :
"02portal.war:/WEB-INF/conf/portal/portal-configuration.xml"
+ The example configuration file below is found at:
"<filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>".
</para>
<programlisting role="XML"><component>
@@ -40,7 +40,7 @@
</component>
</programlisting>
<para>
- You can see in the configuration above, we defined the classic as a default portal.
Notes that the definition should be as a initial parameter of the NewPortalConfigListener
component-plugin
+ In this example the <emphasis role="bold">classic</emphasis>
portal has been set as the default. Note that the definition should be as a initial
parameter of the NewPortalConfigListener component-plugin.
</para>
</section>
Modified:
portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Default_Permission_Configuration.xml
===================================================================
---
portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Default_Permission_Configuration.xml 2010-01-21
06:32:28 UTC (rev 1399)
+++
portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Default_Permission_Configuration.xml 2010-01-21
06:33:57 UTC (rev 1400)
@@ -13,34 +13,48 @@
<para>
It defines 5 permissions types:
</para>
- <itemizedlist>
+ <variablelist>
+ <varlistentry>
+ <term>super.user</term>
<listitem>
<para>
- <emphasis>super.user</emphasis> : The super user has all the rights on
the platform, by default this user is called root
+ The super user has all the rights on the platform, this user is referred to as
<emphasis>root</emphasis>.
</para>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>portal.creator.groups</term>
<listitem>
<para>
- <emphasis>portal.creator.groups</emphasis> : This list defines all
groups that will be able to manage the different portals, they also have the permission to
create new portals. The format is "membership:/group/subgroup".
+ This list defines all groups that will be able to manage the different portals.
Members of this group also have the permission to create new portals. The format is
"<literal>membership:/group/subgroup</literal> ".
</para>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>navigation.creator.membership.type</term>
<listitem>
<para>
- <emphasis>navigation.creator.membership.type</emphasis> : Defines the
membership type of the group managers. The group managers have the permission to create
and edit group pages and they can modify the group navigation.
+ Defines the membership type of the group managers. The group managers have the
permission to create and edit group pages and they can modify the group navigation.
</para>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>guests.group</term>
<listitem>
<para>
- <emphasis>guests.group</emphasis> : Contains the name of the group that
is used as guest group. Any anonymous user becomes automatically member of this group when
he enters the public pages.
+ Any anonymous user automatically becomes a member of this group whent they enter the
public pages.
</para>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>access.control.workspace</term>
<listitem>
<para>
- <emphasis>access.control.workspace</emphasis> : Defines the users that
have access to the control workspace. In the demo version the control workspace is
accessible only to 'root' and 'john'. They can expand/collapse the
workspace at the left hand side. The format is "membership:/group/subgroup", An
asterisk '' gives permission to all memberships.
+ Defines the users that have access to the control workspace. In the demo version the
control workspace is accessible only to 'root' and 'john'. They can
expand/collapse the workspace at the left hand side. The format is
"membership:/group/subgroup", An asterisk '' gives permission to all
memberships.
</para>
</listitem>
- </itemizedlist>
-
+ </varlistentry>
+ </variablelist>
<programlisting role="XML"><component>
<key>org.exoplatform.portal.config.UserACL</key>
<type>org.exoplatform.portal.config.UserACL</type>
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-01-21
06:32:28 UTC (rev 1399)
+++
portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Navigation_Configuration.xml 2010-01-21
06:33:57 UTC (rev 1400)
@@ -8,27 +8,27 @@
<section
id="sect-Reference_Guide-Portal_Navigation_Configuration-Overview">
<title>Overview</title>
<para>
- When a user logs in he sees three types of navigation tree:
+ Three types of navigation are available to portal users:
</para>
<itemizedlist>
<listitem>
<para>
- Portal Navigation
+ <xref
linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation"/>
</para>
</listitem>
<listitem>
<para>
- Group Navigation
+ <xref
linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Group_Navigation"/>
</para>
</listitem>
<listitem>
<para>
- User Navigation
+ <xref
linkend="sect-Reference_Guide-Portal_Navigation_Configuration-User_Navigation"/>
</para>
</listitem>
</itemizedlist>
<para>
- they all are configured thanks to the usual XML configuration syntax in a file:
"02portal.war:/WEB-INF/conf/portal/portal-configuration.xml"
+ These navigations are configured with standard XML syntax in the file;
"<filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>".
</para>
<programlisting role="XML"><component>
@@ -97,21 +97,216 @@
</component-plugins>
</programlisting>
<para>
- In the previous XML file we define, for the 3 navigation types, some sets of
predefined portal, groups or users that will have some XML files inside the war. Those
files will be used to create an initial navigation the first time the portal is launched.
That information will then be stored in the JCR and hence only modifiable from the portal
UI.
+ This XML file defines, for the three navigations, which sets of portals, groups or
users will have XML files inside the apprpriate <literal>war</literal>. Those
files will be used to create an initial navigation the first time the portal is launched.
That information will then be stored in the JCR and is then modifiable from the portal
UI.
</para>
</section>
<section
id="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation">
<title>Portal Navigation</title>
<para>
- The portal navigation incorporates the pages that can be accessed even when the user
is not logged in (if the permission allow a public access). Several portal navigations are
used for example when a company has several trademarks and each trade would have its own
website.
+ 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 configuration of a portal called "classic" is made by providing 4 XML
files under the directory portal/WEBINF/conf/portal/portal/classic:
+ The <emphasis role="bold">classic</emphasis> portal is
configured by four XML files in the
<filename>portal/WEBINF/conf/portal/portal/classic</filename> directory:
</para>
+
+ <variablelist>
+ <varlistentry>
+ <term>Portal.xml</term>
+ <listitem>
+ <para>
+ This file describes the layout and portlets that will be shown on all pages. Usually
the layout contains the banner, footer, menu and breadcrumbs portlets. &PRODUCT; is
extremely configurable as every area (even the banner and footer) is a portlet.
+ </para>
+<programlisting role="XML"><?xml version="1.0"
encoding="ISO-8859-1"?>
+<portal-config>
+ <portal-name>classic</portal-name>
+ <locale>en</locale>
+ <factory-id>office</factory-id>
+ <access-permissions>Everyone</access-permissions>
+
<edit-permission>*:/platform/administrators</edit-permission>
+ <creator>root</creator>
+
+ <portal-layout>
+ <application>
+
<instance-id>portal#classic:/web/BannerPortlet/banner</instance-id>
+ <show-info-bar>false</show-info-bar>
+ </application>
+ <application>
+
<instance-id>portal#classic:/web/NavigationPortlet/toolbar</instance-id>
+ <show-info-bar>false</show-info-bar>
+ </application>
+
+ <application>
+
<instance-id>portal#classic:/web/BreadcumbsPortlet/breadcumbs</instance-id>
+ <show-info-bar>false</show-info-bar>
+ </application>
+
+
+ <page-body> </page-body>
+
+ <application>
+
<instance-id>portal#classic:/web/FooterPortlet/footer</instance-id>
+ <show-info-bar>false</show-info-bar>
+ </application>
+ </portal-layout>
+
+</portal-config>
+</programlisting>
+ <para>
+ It is also possible to apply a nested container that can also contain portlets. Row,
column or tab containers are then responsible of the layout of their child portlets.
+ </para>
+ <para>
+ Each application references a portlet using the id
<literal>portal#{portalName}:/{portletWarName}/{portletName}/{uniqueId}</literal>
+ </para>
+ <para>
+ Use the <literal>page-body</literal> tag to define where &PRODUCT;
should render the current page.
+ </para>
+ <para>
+ The defined <emphasis role="bold">classic</emphasis> portal is
accessible to "Everyone" (at
<literal>/portal/public/classic</literal>) but only members of the group
<literal>/platform/administrators</literal> can edit it.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Navigation.xml</term>
+ <listitem>
+ <para>
+ This file defines all the navigation nodes the portal will have. The syntax is
simple, using nested node tags. Each node references a page that is defined in the next
XML file.
+ </para>
+ <para>
+ If the label <literal>#{}</literal> node label is used, the
internationalization mechanism is activated and the actual label to render is taken from
an associated properties file for the current locale.
+ </para>
+<programlisting role="XML"><?xml version="1.0"
encoding="UTF-8"?>
+<node-navigation>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+ <priority>1</priority>
+ <page-nodes>
+ <node>
+ <uri>home</uri>
+ <name>home</name>
+ <label>#{portal.classic.home}</label>
+
<page-reference>portal::classic::homepage</page-reference>
+ </node>
+ <node>
+ <uri>webexplorer</uri>
+ <name>webexplorer</name>
+ <label>#{portal.classic.webexplorer}</label>
+
<page-reference>portal::classic::webexplorer</page-reference>
+ </node>
+ </page-nodes>
+</node-navigation>
+</programlisting>
+ <para>
+ This navigation tree can have multiple views inside portlets (such as the breadcrumbs
portlet) that render the current view node, the site map or the menu portlets.
+ </para>
+ <warning>
+ <para>
+ For top nodes, the <emphasis role="bold">uri</emphasis> and
the <emphasis role="bold">name</emphasis> of your navigation nodes
must have the <emphasis>same</emphasis> value. For the other nodes the
<emphasis role="bold">uri</emphasis> is composed like
<emphasis><uri>contentmanagement/fileexplorer</uri></emphasis>
where '<literal>contentmanagement</literal> ' is the name of the
parent node and '<literal>fileexplorer</literal>' is the name of the
node ( <emphasis><name>fileexplorer</name>
</emphasis> ).
+ </para>
+ </warning>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Pages.xml</term>
+ <listitem>
+ <para>
+ This XML file structure is very similar to
<filename>portal.xml</filename> and it can also contain container tags. Each
application can decide whether to render the portlet border, the window state icons or the
mode.
+ </para>
+<programlisting role="XML"><?xml version="1.0"
encoding="ISO-8859-1"?>
+<page-set>
+ <page>
+ <page-id>portal::classic::homepage</page-id>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+ <name>homepage</name>
+ <title>Home Page</title>
+ <access-permissions>Everyone</access-permissions>
+
<edit-permission>*:/platform/administrators</edit-permission>
+ <application>
+
<instance-id>portal#classic:/web/HomePagePortlet/homepageportlet</instance-id>
+ <title>Home Page portlet</title>
+ <show-info-bar>false</show-info-bar>
+ <show-application-state>false</show-application-state>
+ <show-application-mode>false</show-application-mode>
+ </application>
+ </page>
+
+ <page>
+ <page-id>portal::classic::webexplorer</page-id>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+ <name>webexplorer</name>
+ <title>Web Explorer</title>
+
<access-permissions>*:/platform/users</access-permissions>
+
<edit-permission>*:/platform/administrators</edit-permission>
+ <application>
+
<instance-id>group#platform/users:/web/BrowserPortlet/WebExplorer</instance-id>
+ <title>Web Explorer</title>
+ <show-info-bar>false</show-info-bar>
+ </application>
+ </page>
+</page-set>
+</programlisting>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Portlet-preferences.xml</term>
+ <listitem>
+ <para>
+ Porlet instances can be associated with
<literal>portlet-preferences</literal> that override the one defined in
<filename>portlet.xml </filename>file of the portlet application
<literal>war</literal> .
+ </para>
+<programlisting role="XML"><?xml version="1.0"
encoding="ISO-8859-1"?>
+<portlet-preferences-set>
+ <portlet-preferences>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+
<window-id>portal#classic:/web/BannerPortlet/banner</window-id>
+ <preference>
+ <name>template</name>
+
<value>par:/groovy/groovy/webui/component/UIBannerPortlet.gtmpl</value>
+ <read-only>false</read-only>
+ </preference>
+ </portlet-preferences>
+ <portlet-preferences>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+
<window-id>portal#classic:/web/NavigationPortlet/toolbar</window-id>
+ <preference>
+ <name>useAJAX</name>
+ <value>true</value>
+ <read-only>false</read-only>
+ </preference>
+ </portlet-preferences>
+ <portlet-preferences>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+
<window-id>portal#classic:/web/FooterPortlet/footer</window-id>
+ <preference>
+ <name>template</name>
+
<value>par:/groovy/groovy/webui/component/UIFooterPortlet.gtmpl</value>
+ <read-only>false</read-only>
+ </preference>
+ </portlet-preferences>
+
+
+ <portlet-preferences>
+ <owner-type>portal</owner-type>
+ <owner-id>classic</owner-id>
+
<window-id>portal#classic:/web/GroovyPortlet/groovyportlet</window-id>
+ <preference>
+ <name>template</name>
+
<value>par:/groovy/groovy/webui/component/UIGroovyPortlet.gtmpl</value>
+ <read-only>false</read-only>
+ </preference>
+ </portlet-preferences>
+</portlet-preferences-set>
+</programlisting>
+
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
-
- <section
id="sect-Reference_Guide-Portal_Navigation_Configuration-Portal.xml">
+<!-- <section
id="sect-Reference_Guide-Portal_Navigation_Configuration-Portal.xml">
<title>Portal.xml</title>
<para>
That file describes the layout and portlets that will be shown for all pages. Usually
the layout contains the banner, footer, menu, breadcrumbs portlets. Indeed, in GateIn,
every area is a portlet even the banner and footer which makes the platform extremely
configurable.
@@ -164,7 +359,7 @@
<para>
The defined classic portal is accessible to "Everyone" (that means it can be
accessed through the URL /portal/public/classic) but only members of the group
/platform/administrators can edit it.
</para>
- </section>
+ </section>
<section
id="sect-Reference_Guide-Portal_Navigation_Configuration-Navigation.xml">
<title>Navigation.xml</title>
@@ -204,7 +399,7 @@
For top nodes, the <emphasis role="bold">uri</emphasis> and the
<emphasis role="bold">name</emphasis> of your navigation nodes must
have the <emphasis role="bold">same</emphasis> value. For the other
nodes the uri is composed like
<emphasis><uri>contentmanagement/fileexplorer</uri></emphasis>
where 'contentmanagement' is the name of the parent node and
'fileexplorer' the name of the node (
<emphasis><name>fileexplorer</name> </emphasis>
).
</para>
</warning>
- </section>
+ </section>
<section
id="sect-Reference_Guide-Portal_Navigation_Configuration-Pages.xml">
<title>Pages.xml</title>
@@ -301,30 +496,35 @@
</portlet-preferences>
</portlet-preferences-set>
</programlisting>
- </section>
+ </section> -->
<section
id="sect-Reference_Guide-Portal_Navigation_Configuration-Group_Navigation">
<title>Group Navigation</title>
<para>
- Group navigations are dynamically added (mounted) to the user navigation when he logs
in. This means that a user sees in his menu also all the pages that are assigned to the
groups to which he belongs to.
+ Group navigations are dynamically added to the user navigation at login. This allows
users to see all the pages assigned to any groups they belong to in the menu.
</para>
<para>
- Here only 3 XML files are necessary: navigation.xml, pages.xml and
portlet-preferences.xml. The syntax is the same as for portal navigations.
- </para>
+ The group navigation menu is configured by three XML files
(<filename>navigation.xml</filename>,
<filename>pages.xml</filename> and
<filename>portlet-preferences.xml</filename>). The syntax used in these files
is the same as those covered in <xref
linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation"/>.
+ </para>
<para>
- The 3 files are located in the directory:
"portal/WEB-INF/conf/portal/group/group-name-path/" like for example
"portal/WEB-INF/conf/portal/group/platform/administrators/"
+ They are located in the
<filename>portal/WEB-INF/conf/portal/group<replaceable>/group-name-path/</replaceable></filename>
directory (For example;
<filename>portal/WEB-INF/conf/portal/group/platform/administrators/</filename>).
</para>
</section>
<section
id="sect-Reference_Guide-Portal_Navigation_Configuration-User_Navigation">
<title>User Navigation</title>
<para>
- The user navigation is the set of nodes and pages that is owned by a user. You can see
that part as the user dashboard. The files needed are navigation.xml, pages.xml,
portlet-preferences.xml. You will also find gadgets.xml (formerly called widgets.xml)
which defines the gadgets (widgets) that will be located in the user workspace. The user
workspace is located at the left hand side, the access is restricted to some privileged
users, see <xref linkend="sect-Reference_Guide-Predefined_User_Configuration"
/>
+ The user navigation is the set of nodes and pages that are owned by a user. They are
part of the user dashboard.
+ </para>
+ <para>
+ Three files configure the user navigation
(<filename>navigation.xml</filename>,
<filename>pages.xml</filename> and
<filename>portlet-preferences.xml</filename>). They are located in the
directory
"<filename>portal/WEB-INF/conf/portal/users/{userName}</filename>".
</para>
<para>
- Those files are located in the directory
"portal/WEB-INF/conf/portal/users/{userName}"
+ This directory also contains a <filename>gadgets.xml</filename> file
(which was formerly called <filename>widgets.xml</filename>). This file
defines the gadgets located in the user workspace.
+ </para>
+ <para>
+ The user workspace is located at the left hand side of the page and access is
restricted to some privileged users, see <xref
linkend="sect-Reference_Guide-Predefined_User_Configuration" />
</para>
-
<programlisting role="XML"><?xml version="1.0"
encoding="ISO-8859-1"?>
<widgets>
<owner-type>user</owner-type>
@@ -360,9 +560,9 @@
</widgets>
</programlisting>
- <para>
+<!-- <para>
Note that when you develop a portal, we advise you to use the XML instead of the User
Interface as XML will allow you to provide a preconfigured package to your customer. But
as each time you start the server the first time, the XML files are stored in the JCR, it
will be necessary to remove the database (the jcr leverages a database). During the
development phase using tomcat it simply means to delete the directory: exo-tomcat/temp
- </para>
+ </para> -->
</section>
<section
id="sect-Reference_Guide-Portal_Navigation_Configuration-Tips">
@@ -370,9 +570,13 @@
<section id="sect-Reference_Guide-Tips-Direct_External_Links">
<title>Direct External Links</title>
<para>
- If you wish to add a link to a URL outside the portal you you first have to define a
"page" which will not be used. Then add the URL to the navigation. pages.xml:
+ If you wish to add a link to a URL outside the portal you you first have to define a
"page" which will not be used. Then add the URL to the navigation.
</para>
-
+ <variablelist>
+ <varlistentry>
+ <term>pages.xml</term>
+ <listitem>
+ <para>
<programlisting><page>
<owner-type>portal</owner-type>
<owner-id>website</owner-id>
@@ -382,10 +586,13 @@
<edit-permission>*:/platform/administrators</edit-permission>
</page>
</programlisting>
- <para>
- naviguation.xml:
- </para>
-
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>navigation.xml</term>
+ <listitem>
+ <para>
<programlisting><node>
<uri>http://wiki.exoplatform.com/xwiki/bin/view/Main/WebHome</uri>
<name>documentation</name>
@@ -393,6 +600,10 @@
<page-reference>portal::website::documentation</page-reference>
</node>
</programlisting>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
<warning>
<title>Direct external links were not a design goal</title>
<para>
Modified:
portal/trunk/docs/reference-guide/en/modules/configuration/Predefined_User_Configuration.xml
===================================================================
---
portal/trunk/docs/reference-guide/en/modules/configuration/Predefined_User_Configuration.xml 2010-01-21
06:32:28 UTC (rev 1399)
+++
portal/trunk/docs/reference-guide/en/modules/configuration/Predefined_User_Configuration.xml 2010-01-21
06:33:57 UTC (rev 1400)
@@ -8,21 +8,28 @@
<section
id="sect-Reference_Guide-Predefined_User_Configuration-Overview">
<title>Overview</title>
<para>
- To specify the initial Organization configuration, the content of
<literal>02portal.war:/WEB-INF/conf/organization/organization-configuration.xml
</literal> should be edited. This file complies with the XML GateIn configuration
schema. It lists several configuration plugins.
+ To specify the initial Organization configuration, the content of
<literal>02portal.war:/WEB-INF/conf/organization/organization-configuration.xml
</literal> should be edited. This file uses the portal XML configuration schema. It
lists several configuration plugins.
</para>
</section>
<section
id="sect-Reference_Guide-Predefined_User_Configuration-Plugin_for_adding_users_groups_and_membership_types_">
- <title>Plugin for adding users, groups and membership types </title>
+ <title>Plugin for adding users, groups and membership types</title>
<para>
- The plugin of type
<literal>org.exoplatform.services.organization.OrganizationDatabaseInitializer
</literal> specifies the list of users, groups and membership types to be created.
The initialization parameter named "checkDatabaseAlgorithm" determines how the
creation is triggered. Thus, the value "entry" means that each user, group and
membership listed in the configuration is checked each time GateIn is started. If not
existing, it is created. The value "empty" means that the whole list of
preconfigured users, groups and memberships is processed only if the database is empty.
+ The plugin of type
<literal>org.exoplatform.services.organization.OrganizationDatabaseInitializer</literal>
specifies the list of users, groups and membership types to be created.
+ </para>
+ <para>
+ The initialization parameter
"<parameter>checkDatabaseAlgorithm</parameter>" determines how the
creation is triggered.
</para>
+
+ <para>
+ The value "<literal>entry</literal>" means that each user, group
and membership listed in the configuration file is checked each time &PRODUCT; is
started. If the entry doesn't exist, it is created. The value
"<literal>empty</literal>" sets the configuration file to be
processed only if the database is empty.
+ </para>
</section>
<section
id="sect-Reference_Guide-Predefined_User_Configuration-Membership_types">
<title>Membership types</title>
<para>
- The predefined membership types are specified in the "membershipType" field
of the "OrganizationConfig" plugin parameter.
+ The predefined membership types are specified in the
"<parameter>membershipType</parameter>" field of the
"<parameter>OrganizationConfig</parameter>" plugin parameter.
</para>
<programlisting role="XML"><field
name="membershipType">
@@ -65,7 +72,7 @@
<section
id="sect-Reference_Guide-Predefined_User_Configuration-Groups">
<title>Groups</title>
<para>
- The predefined groups are specified in the "group" field of the
"OrganizationConfig" plugin parameter.
+ The predefined groups are specified in the "group" field of the
"<parameter>OrganizationConfig</parameter>" plugin parameter.
</para>
<programlisting role="XML"><field name="group">
@@ -111,7 +118,7 @@
<section id="sect-Reference_Guide-Predefined_User_Configuration-Users">
<title>Users</title>
<para>
- The predefined users are specified in the "membershipType" field of the
"OrganizationConfig" plugin parameter.
+ The predefined users are specified in the
"<parameter>membershipType</parameter>" field of the
"<parameter>OrganizationConfig</parameter>" plugin parameter.
</para>
<programlisting role="XML"><field name="user">
5452
days inactive
5452
days old
gatein-commits@lists.jboss.org
0 comments
1 participants
participants (1)
-
do-not-reply＠jboss.org