Author: thomas.heute(a)jboss.com Date: 2010-05-20 04:17:38 -0400 (Thu, 20 May 2010) New Revision: 3136 Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/gadgets.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/navigation.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/pages.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/portal.xml Log: JBEPP-276: REference Guide Updating Portal Navigation Configuration Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2010-05-20 08:07:23 UTC (rev 3135) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2010-05-20 08:17:38 UTC (rev 3136) @@ -28,73 +28,113 @@ </listitem> </itemizedlist> <para> - These navigations are configured using standard XML syntax in the file; "<filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>". + These navigations are configured using XML syntax in the file; "<filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>". </para> <programlisting language="XML" role="XML"><![CDATA[<component> <key>org.exoplatform.portal.config.UserPortalConfigService</key> <type>org.exoplatform.portal.config.UserPortalConfigService</type> <component-plugins> - <component-plugin> - <name>new.portal.config.user.listener</name> - <set-method>initListener</set-method> - <type>org.exoplatform.portal.config.NewPortalConfigListener</type> - <description>this listener init the portal configuration</description> - <init-params> - <value-param> - <name>default.portal</name> - <description>The default portal for checking db is empty or not</description> - <value>classic</value> - </value-param> - <object-param> - <name>portal.configuration</name> - <description>description</description> - <object type="org.exoplatform.portal.config.NewPortalConfig"> - <field name="predefinedOwner"> - <collection type="java.util.HashSet"> - <value><string>classic</string></value> - <value><string>webos</string></value> - </collection> - </field> - <field name="ownerType"><string>portal</string></field> - <field name="templateLocation"><string>war:/conf/portal</string></field> - </object> - </object-param> - <object-param> - <name>group.configuration</name> - <description>description</description> - <object type="org.exoplatform.portal.config.NewPortalConfig"> - <field name="predefinedOwner"> - <collection type="java.util.HashSet"> - <value><string>platform/administrators</string></value> - <value><string>platform/users</string></value> - <value><string>platform/guests</string></value> - <value><string>organization/management/executive-board</string></value> - </collection> - </field> - <field name="ownerType"><string>group</string></field> - <field name="templateLocation"><string>war:/conf/portal</string></field> - </object> - </object-param> - <object-param> - <name>user.configuration</name> - <description>description</description> - <object type="org.exoplatform.portal.config.NewPortalConfig"> - <field name="predefinedOwner"> - <collection type="java.util.HashSet"> - <value><string>root</string></value> - <value><string>john</string></value> - <value><string>mary</string></value> - <value><string>demo</string></value> - </collection> - </field> - <field name="ownerType"><string>user</string></field> - <field name="templateLocation"><string>war:/conf/portal</string></field> - </object> - </object-param> - </init-params> - </component-plugin> -</component-plugins>]]></programlisting> + <component-plugin> + <name>new.portal.config.user.listener</name> + <set-method>initListener</set-method> + <type>org.exoplatform.portal.config.NewPortalConfigListener</type> + <description>this listener init the portal configuration</descript +ion> + <init-params> + <value-param> + <name>default.portal</name> + <description>The default portal for checking db is empty or no +t</description> + <value>classic</value> + </value-param> + <value-param> + <name>page.templates.location</name> + <description>the path to the location that contains Page templ +ates</description> + <value>war:/conf/portal/template/pages</value> + </value-param> + <object-param> + <name>site.templates.location</name> + <description>description</description> + <object type="org.exoplatform.portal.config.SiteConfigTemplate +"> + <field name="location"> + <string>war:/conf/portal</string> + </field> + <field name="portalTemplates"> + <collection type="java.util.HashSet"> + <value> + <string>classic</string> + </value> + </collection> + </field> + <field name="groupTemplates"> + <collection type="java.util.HashSet"> + <value> + <string>group</string> + </value> + </collection> + </field> + <field name="userTemplates"> + <collection type="java.util.HashSet"> + <value> + <string>user</string> + </value> + </collection> + </field> + </object> + </object-param> + <object-param> + <name>portal.configuration</name> + <description>description</description> + <object type="org.exoplatform.portal.config.NewPortalConfig"> + <field name="predefinedOwner"> + <collection type="java.util.HashSet"> + <value><string>classic</string></value> + </collection> + </field> + <field name="ownerType"><string>portal</string></field> + <field name="templateLocation"><string>war:/conf/portal/</string></field> + </object> + </object-param> + <object-param> + <name>group.configuration</name> + <description>description</description> + <object type="org.exoplatform.portal.config.NewPortalConfig"> + <field name="predefinedOwner"> + <collection type="java.util.HashSet"> + <value><string>/platform/administrators</string></value> + <value><string>/platform/users</string></value> + <value><string>/platform/guests</string></value> + <value><string>/organization/management/executive-board</string></value> + </collection> + </field> + <field name="ownerType"><string>group</string></field> + <field name="templateLocation"><string>war:/conf/portal</string></field> + </object> + </object-param> + <object-param> + <name>user.configuration</name> + <description>description</description> + <object type="org.exoplatform.portal.config.NewPortalConfig"> + <field name="predefinedOwner"> + <collection type="java.util.HashSet"> + <value><string>root</string></value> + <value><string>john</string></value> + <value><string>mary</string></value> + <value><string>demo</string></value> + <value><string>user</string></value> + </collection> + </field> + <field name="ownerType"><string>user</string></field> + <field name="templateLocation"><string>war:/conf/portal</string></field> + </object> + </object-param> + </init-params> + </component-plugin> + </component-plugins> +</component>]]></programlisting> <para> This XML configuration defines where in the portal's <literal>WAR</literal> to look for configuration settings, and which portals, groups, and user specific views to include in portal/group/user navigation. @@ -110,7 +150,7 @@ The portal navigation incorporates the pages that can be accessed even when a user is not logged in (assuming the applicable permissions allow public access). For example; several portal navigations could be used when a company has multiple trademarks, and websites are set up for each of them. </para> <para> - The <emphasis>Classic</emphasis> portal is configured by four XML files in the <filename>02portal.war:/WEB-INF/conf/portal/portal/classic</filename> directory: + The <emphasis>Classic</emphasis> portal is configured by three XML files in the <filename>02portal.war:/WEB-INF/conf/portal/portal/classic</filename> directory: </para> <variablelist> <varlistentry> @@ -118,50 +158,14 @@ <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 view element (even the banner and footer) is a portlet. - </para><!-- -<programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="ISO-8859-1"?> + </para> + <programlisting role="XML" language="XML"><xi:include href="portal.xml" xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" /></programlisting> -<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> ---> -<programlisting role="XML" language="XML"><xi:include href="portal.xml" xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" /></programlisting> - <para> It is also possible to apply a nested container that can also contain portlets. Row, column or tab containers are then responsible for the layout of their child portlets. </para> <para> - Each application references a portlet using the id <literal>portal#{portalName}:/{portletWarName}/{portletName}/{uniqueId}</literal> + Each application references a portlet using its application name (usually the name of the WAR file) and a portlet reference (The name of the portlet as defined in portlet.xml) </para> <para> Use the <literal>page-body</literal> tag to define where &PRODUCT; should render the current page. @@ -180,27 +184,7 @@ <para> When the <literal>#{...}</literal> syntax is used, the enclosed property name serves as a key that is automatically passed to internationalization mechanism so the literal property name is replaced by a localized value taken from the associated properties file matching the current locale. </para> - -<programlisting language="XML" role="XML"><![CDATA[<?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> + <programlisting role="XML" language="XML"><xi:include href="nodes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" /></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> @@ -220,301 +204,18 @@ <para> This configuration 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, the icons or portlet's mode. </para> - -<programlisting language="XML" role="XML"><![CDATA[<?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> - + <programlisting role="XML" language="XML"><xi:include href="pages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" /></programlisting> </listitem> </varlistentry> - <varlistentry> - <term>portlet-preferences.xml</term> - <listitem> - <para> - Porlet instances can be associated with <literal>portlet-preferences</literal> that override the ones defined in <filename>portlet.xml</filename> of the portlet application <literal>war</literal>. - </para> - -<programlisting language="XML" role="XML"><![CDATA[<?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"> - <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. - </para> - -<programlisting role="XML">&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt; -&lt;portal-config&gt; - &lt;portal-name&gt;classic&lt;/portal-name&gt; - &lt;locale&gt;en&lt;/locale&gt; - &lt;factory-id&gt;office&lt;/factory-id&gt; - &lt;access-permissions&gt;Everyone&lt;/access-permissions&gt; - &lt;edit-permission&gt;*:/platform/administrators&lt;/edit-permission&gt; - &lt;creator&gt;root&lt;/creator&gt; - - &lt;portal-layout&gt; - &lt;application&gt; - &lt;instance-id&gt;portal#classic:/web/BannerPortlet/banner&lt;/instance-id&gt; - &lt;show-info-bar&gt;false&lt;/show-info-bar&gt; - &lt;/application&gt; - &lt;application&gt; - &lt;instance-id&gt;portal#classic:/web/NavigationPortlet/toolbar&lt;/instance-id&gt; - &lt;show-info-bar&gt;false&lt;/show-info-bar&gt; - &lt;/application&gt; - - &lt;application&gt; - &lt;instance-id&gt;portal#classic:/web/BreadcumbsPortlet/breadcumbs&lt;/instance-id&gt; - &lt;show-info-bar&gt;false&lt;/show-info-bar&gt; - &lt;/application&gt; - - - &lt;page-body&gt; &lt;/page-body&gt; - - &lt;application&gt; - &lt;instance-id&gt;portal#classic:/web/FooterPortlet/footer&lt;/instance-id&gt; - &lt;show-info-bar&gt;false&lt;/show-info-bar&gt; - &lt;/application&gt; - &lt;/portal-layout&gt; - -&lt;/portal-config&gt; -</programlisting> - <para> - Even if not shown in the previous XML file, it is also possible to apply a nested container that can also contain portlets. Containers are then responsible of the layout of their children (row, column or tabs containers exist). - </para> - <para> - Each application references a portlet using the id portal#{portalName}:/{portletWarName}/{portletName}/{uniqueId} - </para> - <para> - In order to define at which location GateIn Portal shall render the current page use the page-body tag. - </para> - <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 id="sect-Reference_Guide-Portal_Navigation_Configuration-Navigation.xml"> - <title>Navigation.xml</title> - <para> - This file defines all the navigation nodes the portal will have. The syntax is simple as we get nested node tags. Each node references a page that is defined in the next XML file. - </para> - <para> - If the label #{} is used then it means the i18n mechanism is activated and that the real label to render is taken from an associated properties file for the current locale. - </para> - -<programlisting role="XML">&lt;?xml version="1.0" encoding="UTF-8"?&gt; -&lt;node-navigation&gt; - &lt;owner-type&gt;portal&lt;/owner-type&gt; - &lt;owner-id&gt;classic&lt;/owner-id&gt; - &lt;priority&gt;1&lt;/priority&gt; - &lt;page-nodes&gt; - &lt;node&gt; - &lt;uri&gt;home&lt;/uri&gt; - &lt;name&gt;home&lt;/name&gt; - &lt;label&gt;#{portal.classic.home}&lt;/label&gt; - &lt;page-reference&gt;portal::classic::homepage&lt;/page-reference&gt; - &lt;/node&gt; - &lt;node&gt; - &lt;uri&gt;webexplorer&lt;/uri&gt; - &lt;name&gt;webexplorer&lt;/name&gt; - &lt;label&gt;#{portal.classic.webexplorer}&lt;/label&gt; - &lt;page-reference&gt;portal::classic::webexplorer&lt;/page-reference&gt; - &lt;/node&gt; - &lt;/page-nodes&gt; -&lt;/node-navigation&gt; -</programlisting> - <para> - This navigation tree can have multiple views inside portlets such as the breadcrumbs 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 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>&lt;name&gt;fileexplorer&lt;/name&gt; </emphasis> ). - </para> - </warning> - </section> - - <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Pages.xml"> - <title>Pages.xml</title> - <para> - This XML file structure is very similar to portal.xml and it can also contain container tags. Each application can decide if it wishes to render the portlet border, the window state icons or the mode. - </para> - -<programlisting role="XML">&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt; -&lt;page-set&gt; - &lt;page&gt; - &lt;page-id&gt;portal::classic::homepage&lt;/page-id&gt; - &lt;owner-type&gt;portal&lt;/owner-type&gt; - &lt;owner-id&gt;classic&lt;/owner-id&gt; - &lt;name&gt;homepage&lt;/name&gt; - &lt;title&gt;Home Page&lt;/title&gt; - &lt;access-permissions&gt;Everyone&lt;/access-permissions&gt; - &lt;edit-permission&gt;*:/platform/administrators&lt;/edit-permission&gt; - &lt;application&gt; - &lt;instance-id&gt;portal#classic:/web/HomePagePortlet/homepageportlet&lt;/instance-id&gt; - &lt;title&gt;Home Page portlet&lt;/title&gt; - &lt;show-info-bar&gt;false&lt;/show-info-bar&gt; - &lt;show-application-state&gt;false&lt;/show-application-state&gt; - &lt;show-application-mode&gt;false&lt;/show-application-mode&gt; - &lt;/application&gt; - &lt;/page&gt; - - &lt;page&gt; - &lt;page-id&gt;portal::classic::webexplorer&lt;/page-id&gt; - &lt;owner-type&gt;portal&lt;/owner-type&gt; - &lt;owner-id&gt;classic&lt;/owner-id&gt; - &lt;name&gt;webexplorer&lt;/name&gt; - &lt;title&gt;Web Explorer&lt;/title&gt; - &lt;access-permissions&gt;*:/platform/users&lt;/access-permissions&gt; - &lt;edit-permission&gt;*:/platform/administrators&lt;/edit-permission&gt; - &lt;application&gt; - &lt;instance-id&gt;group#platform/users:/web/BrowserPortlet/WebExplorer&lt;/instance-id&gt; - &lt;title&gt;Web Explorer&lt;/title&gt; - &lt;show-info-bar&gt;false&lt;/show-info-bar&gt; - &lt;/application&gt; - &lt;/page&gt; -&lt;/page-set&gt; -</programlisting> - </section> - - <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Portlet_preferences.xml"> - <title>Portlet-preferences.xml</title> - <para> - Porlet instances can be associated with portlet-preferences that override the one defined in the usual portlet.xml file of the portlet application WAR. - </para> - -<programlisting role="XML">&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt; -&lt;portlet-preferences-set&gt; - &lt;portlet-preferences&gt; - &lt;owner-type&gt;portal&lt;/owner-type&gt; - &lt;owner-id&gt;classic&lt;/owner-id&gt; - &lt;window-id&gt;portal#classic:/web/BannerPortlet/banner&lt;/window-id&gt; - &lt;preference&gt; - &lt;name&gt;template&lt;/name&gt; - &lt;value&gt;par:/groovy/groovy/webui/component/UIBannerPortlet.gtmpl&lt;/value&gt; - &lt;read-only&gt;false&lt;/read-only&gt; - &lt;/preference&gt; - &lt;/portlet-preferences&gt; - &lt;portlet-preferences&gt; - &lt;owner-type&gt;portal&lt;/owner-type&gt; - &lt;owner-id&gt;classic&lt;/owner-id&gt; - &lt;window-id&gt;portal#classic:/web/NavigationPortlet/toolbar&lt;/window-id&gt; - &lt;preference&gt; - &lt;name&gt;useAJAX&lt;/name&gt; - &lt;value&gt;true&lt;/value&gt; - &lt;read-only&gt;false&lt;/read-only&gt; - &lt;/preference&gt; - &lt;/portlet-preferences&gt; - &lt;portlet-preferences&gt; - &lt;owner-type&gt;portal&lt;/owner-type&gt; - &lt;owner-id&gt;classic&lt;/owner-id&gt; - &lt;window-id&gt;portal#classic:/web/FooterPortlet/footer&lt;/window-id&gt; - &lt;preference&gt; - &lt;name&gt;template&lt;/name&gt; - &lt;value&gt;par:/groovy/groovy/webui/component/UIFooterPortlet.gtmpl&lt;/value&gt; - &lt;read-only&gt;false&lt;/read-only&gt; - &lt;/preference&gt; - &lt;/portlet-preferences&gt; - - - &lt;portlet-preferences&gt; - &lt;owner-type&gt;portal&lt;/owner-type&gt; - &lt;owner-id&gt;classic&lt;/owner-id&gt; - &lt;window-id&gt;portal#classic:/web/GroovyPortlet/groovyportlet&lt;/window-id&gt; - &lt;preference&gt; - &lt;name&gt;template&lt;/name&gt; - &lt;value&gt;par:/groovy/groovy/webui/component/UIGroovyPortlet.gtmpl&lt;/value&gt; - &lt;read-only&gt;false&lt;/read-only&gt; - &lt;/preference&gt; - &lt;/portlet-preferences&gt; -&lt;/portlet-preferences-set&gt; -</programlisting> - </section> --> - <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Group_Navigation"> <title>Group Navigation</title> <para> Group navigations are dynamically added to the user navigation at login. This allows users to see the pages assigned to any groups they belong to in the menu. </para> <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" />. + The group navigation menu is configured by two XML files (<filename>navigation.xml</filename> and <filename>pages.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> They are located in <filename>02portal.war/WEB-INF/conf/portal/group<replaceable>/group-name-path/</replaceable></filename> directory (For example; <filename>02portal.war/WEB-INF/conf/portal/group/platform/administrators/</filename>). @@ -527,111 +228,12 @@ User navigation is the set of nodes and pages that are owned by a user. They are part of the user's 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>02portal.war/WEB-INF/conf/portal/users/{userName}</filename>". + Two files configure the user navigation (<filename>navigation.xml</filename> and <filename>pages.xml</filename>). They are located in the directory "<filename>02portal.war/WEB-INF/conf/portal/users/{userName}</filename>". </para> <para> - This <filename>eXoGadgets.war/WEB-INF/</filename>directory also contains a <filename>gadgets.xml</filename> file (formerly called <filename>widgets.xml</filename>). This file defines the gadgets located in the user's workspace. + The file <filename>eXoGadgets.war/WEB-INF/gadget.xml</filename> defines the gadgets that will be available on a user dashboard. </para> - <para> - The user's 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 language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="ISO-8859-1"?> -<widgets> - <owner-type>user</owner-type> - <owner-id>root</owner-id> - - <container id="Information"> - <name>Information</name> - <description>Information's Description</description> - <application> - <instance-id>user#root:/GateInWidgetWeb/WelcomeWidget/WelcomeWidget1</instance-id> - <application-type>GateInWidget</application-type> - </application> - - <application> - <instance-id>user#root:/GateInWidgetWeb/StickerWidget/StickerWidget</instance-id> - <application-type>GateInWidget</application-type> - </application> - - <application> - <instance-id>user#root:/GateInWidgetWeb/InfoWidget/InfoWidget1</instance-id> - <application-type>GateInWidget</application-type> - </application> - </container> - - <container id="Calendar"> - <name>Calendar</name> - <description>Calendar's Description</description> - <application> - <instance-id>user#root:/GateInWidgetWeb/CalendarWidget/CalendarWidget</instance-id> - <application-type>GateInWidget</application-type> - </application> - </container> - -</widgets>]]></programlisting> ---> <programlisting role="XML" language="XML"><xi:include href="gadgets.xml" xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" /></programlisting> - - <!-- <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> --> </section> - <!-- - <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Tips"> - <title>Tips</title> - <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 must first define a "page" that will only serve as a navigation placeholder for an external redirect. This page will not be used for any portlets. Then add the URL to the navigation. - </para> - <variablelist> - <varlistentry> - <term>pages.xml</term> - <listitem> - <para>--> - <!-- -<programlisting language="XML" role="XML"><![CDATA[<page> - <owner-type>portal</owner-type> - <owner-id>website</owner-id> - <name>documentation</name> - <title>Documentation</title> - <access-permissions>Everyone</access-permissions> - <edit-permission>*:/platform/administrators</edit-permission> -</page>]]></programlisting>--><!-- - <programlisting role="XML" language="XML"><xi:include href="extras/pages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" /></programlisting> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>navigation.xml</term> - <listitem> - <para>--> -<!-- -<programlisting language="XML" role="XML"><![CDATA[<node> - <uri>http://wiki.exoplatform.com/xwiki/bin/view/Main/WebHome</uri> - <name>documentation</name> - <label>#{portal.classic.documentation}</label> - <page-reference>portal::website::documentation</page-reference> -</node>]]></programlisting> ---><!-- -<programlisting role="XML" language="XML"><xi:include href="extras/navigation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" /></programlisting>--><!-- - </para> - </listitem> - </varlistentry> - </variablelist> - <warning> - <title>Direct external links were not a design goal</title> - <para> - Currently you cannot modify the URL using the portal interface, you must change it in the configuration files or modify the underlying database table. - </para> - </warning> - - - </section> - - </section> ---> </chapter> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/gadgets.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/gadgets.xml 2010-05-20 08:07:23 UTC (rev 3135) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/gadgets.xml 2010-05-20 08:17:38 UTC (rev 3136) @@ -1,45 +1,24 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<!-- - - 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. - ---> - <gadgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_0 http://www.gatein.org/xml/ns/gadgets_1_0" xmlns="http://www.gatein.org/xml/ns/gadgets_1_0"> - <gadget name="Todo"> - <path>/gadgets/Todo/Todo.xml</path> - </gadget> + <gadget name="Todo"> + <path>/gadgets/Todo/Todo.xml</path> + </gadget> - <gadget name="Calendar"> - <path>/gadgets/Calendar/Calendar.xml</path> - </gadget> + <gadget name="Calendar"> + <path>/gadgets/Calendar/Calendar.xml</path> + </gadget> - <gadget name="Calculator"> - <path>/gadgets/Calculator/Calculator.xml</path> - </gadget> + <gadget name="Calculator"> + <path>/gadgets/Calculator/Calculator.xml</path> + </gadget> - <gadget name="rssAggregator"> - <path>/gadgets/rssAggregator/rssAggregator.xml</path> - </gadget> + <gadget name="rssAggregator"> + <path>/gadgets/rssAggregator/rssAggregator.xml</path> + </gadget> <gadget name="Currency"> <url>http://www.donalobrien.net/apps/google/currency.xml</url> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/navigation.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/navigation.xml 2010-05-20 08:07:23 UTC (rev 3135) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/navigation.xml 2010-05-20 08:17:38 UTC (rev 3136) @@ -1,71 +1,50 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- - - 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. - ---> - <node-navigation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_0 http://www.gatein.org/xml/ns/gatein_objects_1_0" xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_0"> <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>home</uri> + <name>home</name> + <label>#{portal.classic.home}</label> + <page-reference>portal::classic::homepage</page-reference> + </node> + <node> <uri>sitemap</uri> <name>sitemap</name> <label>#{portal.classic.sitemap}</label> <visibility>DISPLAYED</visibility> <page-reference>portal::classic::sitemap</page-reference> </node> - <node> - <uri>groupnavigation</uri> - <name>groupnavigation</name> - <label>#{portal.classic.groupnavigation}</label> + <node> + <uri>groupnavigation</uri> + <name>groupnavigation</name> + <label>#{portal.classic.groupnavigation}</label> <visibility>SYSTEM</visibility> - <page-reference>portal::classic::groupnavigation</page-reference> - </node> - <node> - <uri>portalnavigation</uri> - <name>portalnavigation</name> - <label>#{portal.classic.portalnavigation}</label> + <page-reference>portal::classic::groupnavigation</page-reference> + </node> + <node> + <uri>portalnavigation</uri> + <name>portalnavigation</name> + <label>#{portal.classic.portalnavigation}</label> <visibility>SYSTEM</visibility> - <page-reference>portal::classic::portalnavigation</page-reference> - </node> - <node> - <uri>register</uri> - <name>register</name> - <label>#{portal.classic.register}</label> + <page-reference>portal::classic::portalnavigation</page-reference> + </node> + <node> + <uri>register</uri> + <name>register</name> + <label>#{portal.classic.register}</label> <visibility>SYSTEM</visibility> - <page-reference>portal::classic::register</page-reference> - </node> - <!-- NOT FOUND node --> - <node> - <uri>notfound</uri> - <name>notfound</name> - <label>NotFound</label> + <page-reference>portal::classic::register</page-reference> + </node> + <!-- NOT FOUND node --> + <node> + <uri>notfound</uri> + <name>notfound</name> + <label>NotFound</label> <visibility>SYSTEM</visibility> - </node> + </node> </page-nodes> </node-navigation> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/pages.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/pages.xml 2010-05-20 08:07:23 UTC (rev 3135) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/pages.xml 2010-05-20 08:17:38 UTC (rev 3136) @@ -1,25 +1,4 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<!-- - - 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. - ---> - <page-set xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_0 http://www.gatein.org/xml/ns/gatein_objects_1_0" @@ -28,8 +7,8 @@ <page> <name>homepage</name> <title>Home Page</title> - <access-permissions>Everyone</access-permissions> - <edit-permission>*:/platform/administrators</edit-permission> + <access-permissions>Everyone</access-permissions> + <edit-permission>*:/platform/administrators</edit-permission> <portlet-application> <portlet> <application-ref>web</application-ref> @@ -53,8 +32,8 @@ <page> <name>groupnavigation</name> <title>Group Navigation</title> - <access-permissions>*:/platform/users</access-permissions> - <edit-permission>*:/platform/administrators</edit-permission> + <access-permissions>*:/platform/users</access-permissions> + <edit-permission>*:/platform/administrators</edit-permission> <portlet-application> <portlet> <application-ref>exoadmin</application-ref> @@ -69,8 +48,8 @@ <page> <name>portalnavigation</name> <title>Portal Navigation</title> - <access-permissions>*:/platform/users</access-permissions> - <edit-permission>*:/platform/administrators</edit-permission> + <access-permissions>*:/platform/users</access-permissions> + <edit-permission>*:/platform/administrators</edit-permission> <portlet-application> <portlet> <application-ref>exoadmin</application-ref> @@ -85,8 +64,8 @@ <page> <name>register</name> <title>Register</title> - <access-permissions>*:/platform/guests</access-permissions> - <edit-permission>*:/platform/administrators</edit-permission> + <access-permissions>*:/platform/guests</access-permissions> + <edit-permission>*:/platform/administrators</edit-permission> <portlet-application> <portlet> <application-ref>exoadmin</application-ref> @@ -100,8 +79,8 @@ <page> <name>sitemap</name> <title>Site Map</title> - <access-permissions>Everyone</access-permissions> - <edit-permission>*:/platform/administrators</edit-permission> + <access-permissions>Everyone</access-permissions> + <edit-permission>*:/platform/administrators</edit-permission> <portlet-application> <portlet> <application-ref>web</application-ref> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/portal.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/portal.xml 2010-05-20 08:07:23 UTC (rev 3135) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortalDevelopment/portal.xml 2010-05-20 08:17:38 UTC (rev 3136) @@ -1,25 +1,4 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<!-- - - 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. - ---> - <portal-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_0 http://www.gatein.org/xml/ns/gatein_objects_1_0"