3:10 p.m.
Author: smumford
Date: 2011-12-05 16:10:57 -0500 (Mon, 05 Dec 2011)
New Revision: 8193
Removed:
epp/docs/branches/5.2/Site_Publisher/Installation_Guide/en-US/Create_A_Site.xml
Modified:
epp/docs/branches/5.2/Site_Publisher/Installation_Guide/en-US/Site_Publisher_Installation_Guide.xml
Log:
JBEPP-846: Removing unecessary Create_A_Site content
Deleted: epp/docs/branches/5.2/Site_Publisher/Installation_Guide/en-US/Create_A_Site.xml
===================================================================
---
epp/docs/branches/5.2/Site_Publisher/Installation_Guide/en-US/Create_A_Site.xml 2011-12-05
04:34:52 UTC (rev 8192)
+++
epp/docs/branches/5.2/Site_Publisher/Installation_Guide/en-US/Create_A_Site.xml 2011-12-05
21:10:57 UTC (rev 8193)
@@ -1,1272 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!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 "Site_Publisher_Installation_Guide.ent">
-%BOOK_ENTITIES;
-]>
-<chapter
id="chap-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo">
- <title>Create a Site Using The Demo</title>
- <para>
- It is possible to use the source files of the
<literal>ecmdemo</literal> example site as a basis for a new site within your
portal deployment.
- </para>
- <para>
- <remark>Does it have to be the sources that get modified to do this? Can
the changes be made in the <filename>ecmdemo</filename>.ear that is part of
the SP download?</remark>
-
- </para>
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Pre_requisites">
- <title>Pre-requisites</title>
- <para>
- In order to use the demonstration portal to create a new site, you will need
the following tools:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- The <application>Subversion</application> version
management tool.
- </para>
-
- </listitem>
- <listitem>
- <para>
- The <application>Maven</application> build tool.
- </para>
-
- </listitem>
- <listitem>
- <para>
- A subscription to JBoss Enterprise Portal Platform Site Publisher and
the
<filename>jboss-eppsp-<version>-exo-<version>-GA.zip</filename>
package available from the JBoss Customer Service Portal.
- </para>
-
- </listitem>
-
- </itemizedlist>
-
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Get_Started">
- <title>Get Started</title>
- <procedure>
- <title></title>
- <step
id="step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Execution-Get_Started-step_1">
- <title>Get the sources</title>
- <para>
- Obtain the <literal>ecmdemo</literal> source files with
the following command:
- </para>
-
-<programlisting>svn export
http://svn.exoplatform.org/projects/ecms/tags/2.1.4/packaging/ecmdemo/
EXT_NAME</programlisting>
- <para>
- (In this instance, and throughout the rest of this guide, EXT_NAME
will be used to denote the name of your new site.)
- </para>
- <note>
- <title>SVN Export</title>
- <para>
- Using the <command>svn export</command> command
allows you to check out the source files without creating a local working copy of the
repository.
- </para>
-
- </note>
-
- </step>
-
- </procedure>
-
-
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Customize_the_extension">
- <title>Customize the extension</title>
- <para>
- The <literal>ecmdemo</literal> project uses the extension
mechanism to create a new portal container. This portal container is separate from the
default deployment; it uses its own IDM implementation, JCR datasources and URL context.
All services required by the new site area configured independently, meaning the default
portal instance in not affected in any way.
- </para>
- <para>
- The <literal>ecmdemo</literal> portal container includes two
portals; <emphasis role="bold">Classic</emphasis> and <emphasis
role="bold">Acme</emphasis>. The <emphasis
role="bold">Classic</emphasis> portal is a presentation of the JBoss
Enterprise Portal Platform product while the <emphasis
role="bold">Acme</emphasis> site serves as a demonstration of Site
Publisher's features.
- </para>
- <para>
- The following procedures will guide you through renaming the extension to
whatever you intend to call your new portal.
- </para>
- <procedure
id="proc-Site_Publisher_Installation_Guide-Customize_the_extension-Renaming_In_POM_Files">
- <title>Renaming In POM Files</title>
- <step
id="step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-step_1">
- <para>
- Files to be modified in this section:
- </para>
- <programlistingco>
- <areaspec>
- <area coords="1 20"
id="area-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-EXT_NAME"
/>
- <area coords="2 20"
id="area-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-pom"
/>
- <area coords="3 20"
id="area-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-config"
/>
- <area coords="5 20"
id="area-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-webapp"
/>
- <area coords="7 20"
id="area-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-rest"
/>
- <area coords="9 20"
id="area-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-ear"
/>
-
- </areaspec>
-
-<programlisting><replaceable>EXT_NAME</replaceable>
-├── pom.xml
-├── config
-│ └── pom.xml
-├── webapp
-│ └── pom.xml
-├── rest-webapp
-│ └── pom.xml
-└── ear
- └── pom.xml
-</programlisting>
- <calloutlist>
- <callout
arearefs="area-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-EXT_NAME">
- <para>
- The parent project.
- </para>
-
- </callout>
- <callout
arearefs="area-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-pom">
- <para>
- The extension's <filename>pom</filename>
file.
- </para>
- <para>
- Refer to <xref
linkend="step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-step_2"
/> for information on how to edit the <filename>pom.xml</filename>.
- </para>
-
- </callout>
- <callout
arearefs="area-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-config">
- <para>
- The configuration JAR. <remark>This is a normal
directory in my copy (not a JAR)</remark>
-
- </para>
- <para>
- Refer to <xref
linkend="step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-step_3"
/> for information on how to edit the <filename>pom.xml</filename>.
- </para>
-
- </callout>
- <callout
arearefs="area-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-webapp">
- <para>
- The configuration WAR. <remark>This is a normal
directory in my copy (not a WAR)</remark>
-
- </para>
- <para>
- Refer to <xref
linkend="step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-step_4"
/> for information on how to edit the <filename>pom.xml</filename>.
- </para>
-
- </callout>
- <callout
arearefs="area-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-rest">
- <para>
- The REST configuration WAR. <remark>This is a
normal directory in my copy (not a WAR)</remark>
-
- </para>
- <para>
- Refer to <xref
linkend="step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-step_5"
/> for information on how to edit the <filename>pom.xml</filename>.
- </para>
-
- </callout>
- <callout
arearefs="area-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-ear">
- <para>
- The deployable EAR archive. <remark>This is a
normal directory in my copy (not an EAR)</remark>
-
- </para>
- <para>
- Refer to <xref
linkend="step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-step_6"
/> for information on how to edit the <filename>pom.xml</filename>.
- </para>
-
- </callout>
-
- </calloutlist>
-
- </programlistingco>
-
-
- </step>
- <step
id="step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-step_2">
- <para>
- Remove references to the original project from the extension's
<filename>pom.xml</filename> file.
- </para>
-
-<programlisting language="XML" role="XML">...
- <groupId>org.myorg</groupId>
- <artifactId>EXT_NAME</artifactId>
- <version>1.0.0</version>
- <packaging>pom</packaging>
- <name>EXT NAME</name>
- <description/>
-...</programlisting>
-
- </step>
- <step
id="step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-step_3">
- <para>
- Remove references to the original project from the
<filename>config/pom.xml</filename> file.
- </para>
-
-<programlisting language="XML" role="XML">...
- <parent>
- <groupId>org.myorg</groupId>
- <artifactId>EXT_NAME</artifactId>
- <version>1.0.0</version>
- </parent>
- <artifactId>EXT_NAME-config</artifactId>
- <name>EXT NAME configuration jar</name>
-...</programlisting>
- <para>
- (You may also remove the <literal>src/main/java</literal>
resource folder definition because the <literal>EXT_NAME-config</literal>
project only contains one configuration file which is located in the
<filename>src/main/resources</filename> folder.)
- </para>
-
- </step>
- <step
id="step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-step_4">
- <para>
- Remove references to the original project from the
<filename>webapp/pom.xml</filename> file.
- </para>
-
-<programlisting language="XML" role="XML">...
- <parent>
- <groupId>org.myorg</groupId>
- <artifactId>EXT_NAME</artifactId>
- <version>1.0.0</version>
- </parent>
- <artifactId>EXT_NAME-webapp</artifactId>
- <packaging>war</packaging>
- <name>EXT_NAME configuration war</name>
- ...</programlisting>
-
- </step>
- <step
id="step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-step_5">
- <para>
- Remove references to the original project from the
<filename>rest-webapp/pom.xml</filename> file.
- </para>
-
-<programlisting language="XML" role="XML">...
-<parent>
- <groupId>org.myorg</groupId>
- <artifactId>EXT_NAME</artifactId>
- <version>1.0.0</version>
-</parent>
-<artifactId>EXT_NAME-rest-webapp</artifactId>
-<packaging>war</packaging>
-<name>EXT NAME Portal REST war</name>
-...</programlisting>
- <para>
- Remove or comment-out the
<parameter>finalName</parameter> tag from the build definition.
- </para>
-
- </step>
- <step
id="step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-step-Site_Publisher_Installation_Guide-Execution-Rename_project_in_the_POM_files-step_6">
- <para>
- Remove references to the original project from the
<filename>ear/pom.xml</filename> file.
- </para>
-
-<programlisting language="XML" role="XML">...
-<parent>
- <groupId>org.myorg</groupId>
- <artifactId>EXT_NAME</artifactId>
- <version>1.0.0</version>
-</parent>
-<artifactId>EXT_NAME-ear</artifactId>
-<packaging>ear</packaging>
-<name>EXT_NAME EAR for GateIn</name>
-...</programlisting>
- <para>
- Rename the <parameter>dependencies</parameter> to match
the renamed projects.
- </para>
-
-<programlisting language="XML" role="XML">...
-<dependencies>
-<dependency>
- <groupId>org.myorg</groupId>
- <artifactId>EXT_NAME-config</artifactId>
- <version>${project.version}</version>
-</dependency>
-...</programlisting>
- <para>
- Rename the artifacts in
<parameter>maven-ear-plugin</parameter> configuration.
- </para>
-
-<programlisting language="XML" role="XML">...
-<configuration>
- <displayName>EXT_NAME</displayName>
- <defaultLibBundleDir>lib</defaultLibBundleDir>
- <modules>
- <jarModule>
- <groupId>org.myorg</groupId>
- <artifactId>EXT_NAME-config</artifactId>
-
<includeInApplicationXml>true</includeInApplicationXml>
- </jarModule>
- <webModule>
- <groupId>org.myorg</groupId>
- <artifactId>EXT_NAME-webapp</artifactId>
- <contextRoot>EXT_NAME</contextRoot>
- <bundleFileName>EXT_NAME.war</bundleFileName>
- </webModule>
- <webModule>
- <groupId>org.myorg</groupId>
- <artifactId>EXT_NAME-rest-webapp</artifactId>
- <contextRoot>rest-EXT_NAME</contextRoot>
- <bundleFileName>rest-EXT_NAME.war</bundleFileName>
- </webModule>
- </modules>
-</configuration>
-...
-</programlisting>
- <para>
- Add the <parameter>finalName</parameter> tag to the build
element so the result EAR will be <filename>EXT_NAME.ear</filename>.
- </para>
-
-<programlisting language="XML" role="XML">...
-<build>
- <finalName>EXT_NAME</finalName>
- ...</programlisting>
-
- </step>
-
- </procedure>
-
-
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Renaming_Configuration_Files">
- <title>Renaming Configuration Files</title>
- <para>
- The <literal>ecmdemo</literal> string is present in the following
configuration files within the project:
- </para>
-
-<screen>EXT_NAME/
-├── pom.xml
-├── config
-│ └── src
-│ └── main
-│ └── resources
-│ └── conf
-│ └── configuration.xml
-├── webapp
-│ └── src
-│ └── main
-│ └── webapp
-│ └── WEB-INF
-│ ├── conf
-│ │ └── sample-portal
-│ │ ├── portal
-│ │ │ └── portal
-│ │ │ └── acme
-│ │ │ └── pages.xml
-│ │ └── wcm
-│ │ ├── artifacts
-│ │ │ └── site-resources
-│ │ │ └── newsletter
-│ │ │ └── newsletterBasicTemplate.xml
-│ │ └── friendly-configuration.xml
-│ ├── jboss-web.xml
-│ └── web.xml
-├── rest-webapp
-│ └── src
-│ └── main
-│ └── webapp
-│ └── WEB-INF
-│ ├── jboss-web.xml
-│ └── web.xml
-└── ear
- └── src
- └── main
- └── application
- ├── ecmdemo.xml
- └── META-INF
- └── gatein-jboss-beans.xml
-</screen>
- <para>
- To completely rename the extension project all occurences of the
<literal>ecmdemo</literal> string must be replaced with your
<replaceable>EXT_NAME</replaceable>.
- </para>
- <para>
- Additionally, the <filename>ecmdemo.xml</filename> file must be
renamed
<filename><replaceable>EXT_NAME</replaceable>.xml</filename>.
- </para>
-
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Deploy_the_application">
- <title>Deploy the application</title>
- <para>
- After the project is completely renamed, you must build it and deploy it00
into JBoss Enterprise Portal Platform portal.
- </para>
- <procedure>
- <step>
- <para>
- Build the application with the following commands:
- </para>
- <substeps>
- <step>
- <para>
- <command>cd
<replaceable>EXT_NAME</replaceable>/</command>
- </para>
-
- </step>
- <step>
- <para>
- <command>mvn clean install</command>
- </para>
-
- </step>
-
- </substeps>
- <para>
- The above commands will create an
<filename><replaceable>EXT_NAME</replaceable>.ear</filename> file
in a new <filename>ear/target/</filename> directory.
- </para>
-
- </step>
- <step>
- <para>
- Copy the
<filename><replaceable>EXT_NAME</replaceable>.ear</filename> to
the <filename>deploy</filename> directory of your JBoss Enterprise Portal
Platform profile:
- </para>
-
-<programlisting><command>cp
ear/target/<filename><replaceable>EXT_NAME</replaceable>.ear</filename>
<replaceable>JBOSS_HOME</replaceable>/jboss-as/server/<<replaceable>PROFILE</replaceable>>/deploy/</command></programlisting>
-
- </step>
- <step>
- <para>
- As the extension also creates a new portal container, a separate
datasource config file must be deployed as well.
- </para>
- <substeps>
- <step>
- <para>
- Copy the <filename>gatein-ds.xml</filename> file
from the
<filename>jboss-eppsp-<version>-exo-<version>-GA.zip</filename>
distribution package.
- </para>
-
- </step>
- <step>
- <para>
- Edit the file to replace instances of the
<emphasis>portal</emphasis> JNDI name with your
<replaceable>EXT_NAME</replaceable>.
- </para>
-
-<programlisting language="XML"
role="XML"><datasources>
-<no-tx-datasource>
- <jndi-name>gatein-idm_spdemo</jndi-name>
-
<connection-url>jdbc:hsqldb:${jboss.server.data.dir}${/}gatein${/}hypersonic${/}gatein-idm_spdemo-localDB</connection-url>
- ...
-</programlisting>
- <para>
-
- </para>
-
- </step>
-
- </substeps>
-
- </step>
- <step>
- <para>
- Ensure you have also deployed at least the
<filename>gatein-wcm-extension-<replaceable><version></replaceable>-GA.ear</filename>
and <filename>gatein-ds.xml</filename> artifacts from the Site Publisher
disribution package.
- </para>
- <para>
-
- </para>
- <para>
- Refer to the <emphasis
role="bold">Installation</emphasis> chapter of the Site Publisher
Installation Guide for more information about the other files in the distribution and
their deployment.
- </para>
-
- </step>
- <step>
- <para>
- Start the server using the configuration profile you deployed your
new portal to.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- For Linux (or other Unix-based) systems:
- </para>
-
-<programlisting><command>sh
<replaceable>JBOSS_HOME</replaceable>/jboss-as/bin/run.sh -c
<replaceable>EXT_NAME</replaceable></command></programlisting>
-
- </listitem>
- <listitem>
- <para>
- For Microsoft Windows systems:
- </para>
-
-<programlisting><command><replaceable>JBOSS_HOME</replaceable>/jboss-as/bin/run.bat
-c <replaceable>EXT_NAME</replaceable></command></programlisting>
-
- </listitem>
-
- </itemizedlist>
- <para>
- (The commands above assume that you have created a profile with the
same name as the portal you are creating)
- </para>
-
- </step>
- <step>
- <para>
- Access the new portal at <ulink type="http"
url="http://localhost:8080/EXT_NAME" />
- </para>
-
- </step>
-
- </procedure>
-
- <note>
- <title>Portal Content</title>
- <para>
- At this point the new portal container will have the same content as the
original <literal>ecmdemo</literal>. As a result, much of the web content
(stylesheets, links, etc.) will still use the <ulink type="http"
url="/ecmdemo" /> context and may not be displayed properly (unless the
original site is deployed as well).
- </para>
- <para>
- Also, as the the portals in <literal>ecmdemo</literal> use
separate <literal>SingleContentViewer</literal> portlets to display the
<guilabel>Login</guilabel>, <guilabel>Register</guilabel> and
<guilabel>Language</guilabel> links and not the
<literal>BannerPortlet</literal> (as they do in the default <ulink
type="http" url="/portal" /> container URL context), the links will
not work in your new portal context.
- </para>
-
- </note>
-
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Add_a_new_portalwebsite">
- <title>Add a new portal/website</title>
- <para>
- Within the <filename>webapp/WEB-INF/CONF</filename> directory is
the main configuration entry point for the portal container;
<filename>configuration.xml</filename>. This file imports all the required
configurations from the <filename>sample-portal</filename> subdirectory.
- </para>
-
-<screen>EXT_NAME/
-└── webapp
- └── src
- └── main
- └── webapp
- └── WEB-INF
- └── conf
- ├── configuration.xml
- └── sample-portal
- ├── portal
- │ └── portal-configuration.xml
- └── wcm
- └── ...
-</screen>
- <para>
- The <filename>configuration.xml</filename> file defines all the
portals and websites in the portal container with the
<literal>UserPortalConfigService</literal>.
- </para>
- <para>
- To add a new portal/website to the container follow the steps below:
- </para>
- <procedure
id="proc-Site_Publisher_Installation_Guide-Add_a_new_portalwebsite-Create_a_new_portal">
- <title>Create a new portal</title>
- <step>
- <para>
- Register the new site in the
<filename>portal-configuration.xml</filename> file:
- </para>
- <para>
- In this example the new site will be called <emphasis
role="bold">demo</emphasis>.
- </para>
-
-<programlisting language="XML"
role="XML"><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>demo</string>
- </value>
- <value>
- <string>classic</string>
- </value>
- <value>
- <string>acme</string>
- </value>
- </collection>
- </field>
- ...
-</object-param></programlisting>
-
- </step>
- <step>
- <para>
- Set the <emphasis role="bold">demo</emphasis>
portal as the default. JBoss Enterprise Portal Platform will then redirect to this portal
when users access the <ulink type="http" url="EXT_NAME/" /> URL
context.
- </para>
-
-<programlisting language="XML"
role="XML"><value-param>
- <name>default.portal</name>
- <description>The default portal for checking db is empty or
not</description>
- <value>demo</value>
-</value-param></programlisting>
-
- </step>
- <step>
- <para>
- Add the configuration of the portal layout, navigation and pages.
These configurations are set in <filename>portal.xml</filename>,
<filename>navigation.xml</filename> and
<filename>pages.xml</filename>, respectively.
- </para>
-
-<screen>EXT_NAME/
-└── webapp
- └── src
- └── main
- └── webapp
- └── WEB-INF
- └── conf
- └── sample-portal
- └── portal
- └── portal
- ├── acme
- │ ├── navigation.xml
- │ ├── pages.xml
- │ └── portal.xml
- ├── classic
- │ ├── navigation.xml
- │ ├── pages.xml
- │ └── portal.xml
- └── template
- └── acme
- ├── navigation.xml
- ├── pages.xml
- └── portal.xml
-
-</screen>
-
- </step>
-
- </procedure>
-
- <para>
- The most effective way to create a new portal configuration is to copy an
existing portal configuration (from the <emphasis
role="bold">Classic</emphasis> portal, for example) and modify it to
create a new empty portal.
- </para>
- <para>
- This process is explained in more detail in the next section.
- </para>
-
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Define_portal_layout">
- <title>Define portal layout</title>
- <procedure
id="proc-Site_Publisher_Installation_Guide-Define_portal_layout-Define_portal_layout">
- <title>Define portal layout</title>
- <step>
- <para>
- Create folder <emphasis
role="bold">demo</emphasis> in the
<filename>sample-portal/portal/portal/</filename> directory and copy the
<filename>portal.xml</filename> file from the <emphasis
role="bold">classic</emphasis> configuration.
- </para>
-
- </step>
- <step>
- <para>
- Edit the <filename>portal.xml</filename> file and change
the portal name in the <parameter>portal-name</parameter> element to
<emphasis role="bold">demo</emphasis> then replace the contents of
the <parameter>portal-layout</parameter> element with the following code:
- </para>
-
-<programlisting language="XML"
role="XML"><portal-layout>
-
- <portlet-application>
- <portlet>
- <application-ref>web</application-ref>
- <portlet-ref>BannerPortlet</portlet-ref>
- <preferences>
- <preference>
- <name>template</name>
-
<value>par:/groovy/groovy/webui/component/UIBannerPortlet.gtmpl</value>
- <read-only>false</read-only>
- </preference>
- </preferences>
- </portlet>
- <access-permissions>Everyone</access-permissions>
- <show-info-bar>false</show-info-bar>
- </portlet-application>
-
- <portlet-application>
- <portlet>
- <application-ref>web</application-ref>
- <portlet-ref>NavigationPortlet</portlet-ref>
- </portlet>
- <access-permissions>Everyone</access-permissions>
- <show-info-bar>false</show-info-bar>
- </portlet-application>
-
- <container id="MainColumn"
template="system:/groovy/portal/webui/container/UITableColumnContainer.gtmpl">
- <container id="PageColumn"
template="system:/groovy/portal/webui/container/UIContainer.gtmpl">
-
<access-permissions>Everyone</access-permissions>
- <page-body/>
- </container>
- <container id="SideColumn"
template="system:/groovy/portal/webui/container/UIContainer.gtmpl">
-
<access-permissions>Everyone</access-permissions>
- </container>
- </container>
-
- <portlet-application>
- <portlet>
- <application-ref>web</application-ref>
- <portlet-ref>FooterPortlet</portlet-ref>
- <preferences>
- <preference>
- <name>template</name>
-
<value>par:/groovy/groovy/webui/component/UIFooterPortlet.gtmpl</value>
- <read-only>false</read-only>
- </preference>
- </preferences>
- </portlet>
- <access-permissions>Everyone</access-permissions>
- <show-info-bar>false</show-info-bar>
- </portlet-application>
-
-</portal-layout></programlisting>
- <para>
- This will create a layout that contains:
- </para>
- <variablelist>
- <title></title>
- <varlistentry>
- <term>BannerPortlet</term>
- <listitem>
- <para>
- The <literal>BannerPortlet</literal> is a
default portlet which is used to display the website's banner and also the Login,
Register and Language quick-links on the front page.
- </para>
- <para>
- This portlet's stylesheet can be overridden and
customized to better suit your website's design.
- </para>
-
- </listitem>
-
- </varlistentry>
- <varlistentry>
- <term>NavigationPortlet</term>
- <listitem>
- <para>
- The <literal>NavigationPortlet</literal>
controls portal navigation.
- </para>
-
- </listitem>
-
- </varlistentry>
- <varlistentry>
- <term>MainColumn</term>
- <listitem>
- <para>
- The <literal>MainColumn</literal> container
is generated by <filename>UITableColumnContainer.gtmpl</filename> template.
- </para>
- <para>
- This template also contains:
- </para>
- <variablelist>
- <title></title>
- <varlistentry>
- <term>PageColumn</term>
- <listitem>
- <para>
- This container holds the <emphasis
role="bold">page-body</emphasis> element. During runtime this element
is replaced by the currently selected selected portal page.
- </para>
-
- </listitem>
-
- </varlistentry>
- <varlistentry>
- <term>SideColumn</term>
- <listitem>
- <para>
- This container displays the
<guilabel>Searchbox</guilabel> and other content elements required on every
portal page.
- </para>
-
- </listitem>
-
- </varlistentry>
-
- </variablelist>
-
- </listitem>
-
- </varlistentry>
- <varlistentry>
- <term>FooterPortlet</term>
- <listitem>
- <para>
- The <literal>FooterPortlet</literal> is a
default JBoss Enterprise Portal Platform portlet. It can be replaced with a custom
<literal>SingleContentViewer</literal> portlet.
- </para>
-
- </listitem>
-
- </varlistentry>
-
- </variablelist>
-
- </step>
-
- </procedure>
-
-
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Define_portal_navigation_and_pages">
- <title>Define portal navigation and pages</title>
- <para>
- It is recommended that portal creators use the
<filename>navigation.xml</filename> and
<filename>pages.xml</filename> files from the
<literal>Classic</literal> portal as templates.
- </para>
-<programlistingco>
- <areaspec>
- <area coords="21"
id="area-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Define_portal_navigation_and_pages-nav"
/>
- <area coords="22"
id="area-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Define_portal_navigation_and_pages-page"
/>
- </areaspec>
-<programlisting>EXT_NAME/
-└── webapp
- └── src
- └── main
- └── webapp
- └── WEB-INF
- └── conf
- └── sample-portal
- └── portal
- ├── portal
- │ ├── acme
- │ ├── navigation.xml
- │ ├── pages.xml
- │ └── portal.xml
- ├── classic
- │ ├── navigation.xml
- │ ├── pages.xml
- │ └── portal.xml
- └── template
- └── acme
- ├── navigation.xml
- ├── pages.xml
- └── portal.xml
-</programlisting>
- <calloutlist>
- <!--#-->
- <callout
arearefs="area-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Define_portal_navigation_and_pages-nav">
- <para>
- Edit the <filename>navigation.xml</filename> file and
customize the navigational structure of your website.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- Change page labels from
<parameter>#{portal.classic.*}</parameter> to
<parameter>#{portal.demo.*}</parameter>
- </para>
- <para>
- The <parameter>#{...}</parameter> notation means the
portal will look for a localized label rather than a hardcoded string.
- </para>
- </listitem>
- <listitem>
- <para>
- Change all page references from
<parameter>portal::classic::*</parameter> to
<parameter>portal::demo::*</parameter>.
- </para>
- </listitem>
- <listitem>
- <para>
- Add two new nodes: <literal>docs</literal> and
<literal>news</literal>. Other nodes remain as they are.
- </para>
- </listitem>
- </itemizedlist>
-<programlisting language="XML"
role="XML"><![CDATA[<node-navigation ...>
- <priority>1</priority>
- <page-nodes>
- <node>
- <uri>home</uri>
- <name>home</name>
- <label>#{portal.demo.home}</label>
- <visibility>DISPLAYED</visibility>
- <page-reference>portal::demo::homepage</page-reference>
- </node>
- <node>
- <uri>docs</uri>
- <name>docs</name>
- <label>#{portal.demo.docs}</label>
- <visibility>DISPLAYED</visibility>
- <page-reference>portal::demo::docs</page-reference>
- </node>
- <node>
- <uri>news</uri>
- <name>news</name>
- <label>#{portal.demo.news}</label>
- <visibility>DISPLAYED</visibility>
- <page-reference>portal::demo::news</page-reference>
- </node>
- <node>
- ...
- </node>
- ...
- </page-nodes>
-</node-navigation>]]></programlisting>
- </callout>
- <!--#-->
- <callout
arearefs="area-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Define_portal_navigation_and_pages-page">
- <para>
- Edit the <filename>pages.xml</filename> file to customize the
layout and content of particular pages.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- Remove the content configured for the classic website's
homepage by deleting the container <parameter>ClassicBody</parameter> from the
homepage definition in the page-set.
- </para>
- </listitem>
- <listitem>
- <para>
- Add empty pages <literal>docs</literal> and
<literal>news</literal>. Other nodes remain as they are.
- </para>
- </listitem>
- </itemizedlist>
- <programlisting language="XML"
role="XML"><![CDATA[<page-set ...>
- <page>
- <name>homepage</name>
- <title>Home Page</title>
- <access-permissions>Everyone</access-permissions>
- <edit-permission>*:/platform/administrators</edit-permission>
-
- <!-- deleted content from classic homepage -->
-
- </page>
- <page>
- <name>docs</name>
- <title>Documentation</title>
- <access-permissions>Everyone</access-permissions>
- <edit-permission>*:/platform/administrators</edit-permission>
-
- </page>
- <page>
- <name>news</name>
- <title>News</title>
- <access-permissions>Everyone</access-permissions>
- <edit-permission>*:/platform/administrators</edit-permission>
-
- </page>
- <page> ... </page>
- ...
- </page-set>]]></programlisting>
- </callout>
- </calloutlist>
-</programlistingco>
-
- <para>
- This will provide a working portal configuration for the new
<replaceable>demo</replaceable> portal. It defines a simple portal layout and
a basic navigation. The pages will be empty, however, until some webcontent is added to
the portal's JCR repository.
- </para>
- <para>
- Later chapters in this guide will discuss how to deploy content.
- </para>
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Localize_the_navigation">
- <title>Localize the navigation</title>
- <para>
- To localize navigation nodes;
- </para>
- <procedure>
- <step>
- <para>
- Browse to the
<filename>classes/locale/navigation/portal/</filename> folder and create an
XML file called
<filename>demo_<replaceable><locale></replaceable>.xml</filename>
(where <replaceable><locale></replaceable> is the desired
localization, <filename>demo_en.xml</filename> for example).
- </para>
- </step>
- <step>
- <para>
- Populate the file with:
- </para>
-<programlisting language="XML"
role="XML"><![CDATA[<bundle>
- <portal>
- <demo>
- <home>Home</home>
- <news>News</news>
- <docs>Documentation</docs>
- ...
- </demo>
- </portal>
-</bundle>]]></programlisting>
- </step>
- <step>
- <para>
- Register your localization in the
<filename>conf/sample-portlet/portal/resource-bundle-configuration.xml</filename>
file by adding the <parameter>locale.navigation.portal.demo</parameter> to the
<parameter>init.resources</parameter> and
<parameter>portal.resources.names</parameter> parameters.
- </para>
- </step>
- </procedure>
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Deploy_custom_content">
- <title>Deploy custom content</title>
- <para>
- All content managed by Site Publisher is stored in the portal JCR
repository. For more information, refer to the <emphasis
role="bold">JCR</emphasis> chapter of the JBoss Enterprise Portal
Platform Reference Guide at <ulink type="http"
url="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platf...;.
- </para>
- <para>
- Each node can be exported from the repository into an XML file and
imported back to an arbitrary location. The export/import functionality can be used via
the <application>ContentExplorer portlet</application> which is an integral
part of Site Publisher's User Interface.
- </para>
- <para>
- The content can also be imported by the
<application>WCMContentInitializerServices</application> which is used to
initialize content for the websites in the <emphasis
role="bold">ecmodemo</emphasis> project.
- </para>
- <para>
- The <application>TaxonomyPlugin</application> can be used to
deploy a custom taxonomy.
- </para>
- <para>
- Site Publisher enables customization of website stylesheets. To customize
the styles you can put the CSS files into the <filename>css</filename>
directory of the appropriate website's JCR repository.
- </para>
- <section>
- <title>Various web content</title>
- <para>
- Use the following files and locations in the following procedure
to deploy web content:
- </para>
-<programlisting>EXT_NAME/
-└── webapp
- ├── pom.xml
- └── src
- └── main
- └── webapp
- └── WEB-INF
- └── conf
- ├── configuration.xml
- └── sample-portal
- └── wcm
- ├── artifacts
- │ └── site-resources
- │ └── demo
- │ ├── Logo.xml
- │ └── ...
- └── deployment
- └── demo-deployment-configuration.xml
-</programlisting>
- <procedure
id="proc-Site_Publisher_Installation_Guide-Deploy_custom_content-Various_web_content">
- <title>Various web content</title>
- <step>
- <para>
- Build and deploy your application, then start the server.
Refer to <xref
linkend="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Deploy_the_application"/>
for information on how to do this.
- </para>
- </step>
- <step>
- <para>
- Access the custom portal container at <ulink
type="http" url="http://localhost:8080/EXT_NAME"></ulink>.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- The container will also contain the
<replaceable>EXT_NAME</replaceable> portal project.
- </para>
- </listitem>
- <listitem>
- <para>
- You will automatically be redirected to <ulink
type="http"
url="http://localhost:8080/EXT_NAME/public/demo"></ulink>.
- </para>
- </listitem>
- </itemizedlist>
- </step>
- <step>
- <para>
- Create, edit or upload content items using the
<application>ContentExplorer portlet</application>.
- </para>
- <itemizedlist>
- <listitem>
- <para>
- The portlet can be accessed via
<menuchoice><guimenu>Group</guimenu><guimenuitem>Content
Explorer</guimenuitem></menuchoice>.
- </para>
- </listitem>
- <listitem>
- <para>
- To add content to your portal repository, browse
to Sites Management / demo
- </para>
- </listitem>
- <listitem>
- <para>
- Previously exported content call also be imported
via <menuchoice><guimenu>System</guimenu><guimenuitem>Import
Node</guimenuitem></menuchoice>.
- </para>
- </listitem>
- </itemizedlist>
- </step>
- <step>
- <para>
- Use the
<application>ContentExplorer</application> portlet to export the content into
XML files
- </para>
- <itemizedlist>
- <listitem>
- <para>
- Browse to, and open, the the item you wish to
export and use the
<menuchoice><guimenu>System</guimenu><guimenuitem>Export
Node</guimenuitem></menuchoice>.
- </para>
- </listitem>
- <listitem>
- <para>
- Both singular items and whole directories can be
exported.
- </para>
- </listitem>
- <listitem>
- <para>
- Version history is not required in the export as
the <application>WCMContentInitializerService</application> cannot import
version information.
- </para>
- </listitem>
- </itemizedlist>
- </step>
- <step>
- <para>
- Place the exported XML files into a <emphasis
role="bold">demo</emphasis> directory in
<filename>webapp/WEB-INF/conf/sample-portal/wcm/artifacts/site-resources/</filename>
- </para>
- </step>
- <step>
- <para>
- Configure the
<application>WCMContentInitializerService</application> to feploy the content
to appropriate locations in the JCR.
- </para>
- <substeps>
- <step>
- <para>
- Navigate to the
<filename>/sample-portal/wcm/deployment/</filename> directory.
- </para>
- </step>
- <step>
- <para>
- Create a configuration file called
<filename>demo-deployment-configuration.xml</filename> by making a copy of the
<filename>classic-deployment-configuration.xml</filename>.
- </para>
- </step>
- <step>
- <para>
- Create an entry to import the
<filename>demo-deployment-configuration.xml</filename> file in the main
configuration <filename>WEB-INF/conf/configuration.xml</filename>file
- </para>
- </step>
- <step>
- <para>
- Edit the
<filename>demo-deployment-configuration.xml</filename> to configure
<application>WCMContentInitializer</application> and
<application>XMLDeploymentPlugin</application> to deploy your content items to
particular locations in your new portal's JCR repository.
- </para>
- <para>
- The
<filename>demo-deployment-configuration.xml</filename> contains a
configuration of the <application>XMLDeploymentPlugin</application> which has
several <application>DeploymentDescriptor</application> object init-params.
Each deployment descriptor represents a deployment of a single XML file to a particular
JCR location.
- </para>
- <para>
- The
<application>DeploymentDescriptor</application> param has the following
fields:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- The
<parameter>target</parameter> determines the location in the JCR repository to
which the content will be imported.
- </para>
- </listitem>
- <listitem>
- <para>
- The
<parameter>sourcePath</parameter> is the path to the XML file to import. In
this case the file is in the application as per <emphasis role="bold">Step
5</emphasis> above.
- </para>
- </listitem>
- <listitem>
- <para>
- The
<parameter>cleanupPublication</parameter> parameter is used as a workaround
for a known issue with webcontent that has <emphasis>Publication
State</emphasis> data not being successfully imported.
- </para>
- </listitem>
- </itemizedlist>
- </step>
- </substeps>
-<programlisting language="XML" role="XML"><![CDATA[...
-<external-component-plugins>
-
<target-component>org.exoplatform.services.deployment.WCMContentInitializerService</target-component>
- <component-plugin>
- ...
-
<type>org.exoplatform.services.deployment.plugins.XMLDeploymentPlugin</type>
- <init-params>
- <object-param>
- <name>Logo</name>
- ...
- <object
type="org.exoplatform.services.deployment.DeploymentDescriptor">
- <field name="target"> <!-- This is the target
location in the JCR to which the content will be imported during the extension's
startup. -->
- <object
type="org.exoplatform.services.deployment.DeploymentDescriptor$Target">
- <field
name="repository"><string>repository</string></field>
- <field
name="workspace"><string>collaboration</string></field>
- <field name="nodePath"><string>/sites
content/live/demo/medias/images</string></field>
- </object>
- </field>
- <field name="sourcePath">
-
<string>war:/conf/sample-portal/wcm/artifacts/site-resources/demo/Logo.xml</string>
<!-- previously exported JCR content -->
- </field>
- <field name="cleanupPublication">
- <boolean>true</boolean>
- </field>
- </object>
- </object-param>
- <object-param>
- ...
- </object-param>
- ...]]></programlisting>
- </step>
- <step>
- <para>
- Edit
<filename>/sample-portal/wcm/deployment/template-deployment-configuration.xml</filename>
file to disable deployment of template contents into the <emphasis
role="bold">demo</emphasis> portal by adding value
<literal>demo</literal> to the
<parameter>ignored.portals</parameter> list:
- </para>
-<programlisting language="XML"
role="XML"><![CDATA[<component>
-
<key>org.exoplatform.services.wcm.portal.artifacts.CreatePortalArtifactsService</key>
-
<type>org.exoplatform.services.wcm.portal.artifacts.CreatePortalArtifactsServiceImpl</type>
- <init-params>
- <values-param>
- <name>ignored.portals</name>
- <value>demo</value>
- ...]]></programlisting>
- </step>
- </procedure>
- </section>
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Taxonomies">
- <title>Taxonomies</title>
- <para>
-
- </para>
- <procedure>
- <step>
- <para>
-
- </para>
-
- </step>
-
- </procedure>
-
-
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Custom_website_stylesheet">
- <title>Custom website stylesheet</title>
- <para>
-
- </para>
- <procedure>
- <step>
- <para>
-
- </para>
-
- </step>
-
- </procedure>
-
-
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Searchbox_stylesheet">
- <title>Searchbox stylesheet</title>
- <para>
-
- </para>
- <procedure>
- <step>
- <para>
-
- </para>
-
- </step>
-
- </procedure>
-
-
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Configure_content_presentation_portlets">
- <title>Configure content presentation portlets</title>
- <procedure
id="proc-Site_Publisher_Installation_Guide-Configure_content_presentation_portlets-SingleContentViewer_portlet_preferences">
- <title>SingleContentViewer portlet preferences</title>
- <step>
- <para>
-
- </para>
-
- </step>
-
- </procedure>
-
-
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-ContentListViewer_portlet_preferences">
- <title>ContentListViewer portlet preferences</title>
- <para>
-
- </para>
- <procedure>
- <step>
- <para>
-
- </para>
-
- </step>
-
- </procedure>
-
-
- </section>
-
- <section
id="sect-Site_Publisher_Installation_Guide-Create_a_Site_Using_The_Demo-Other_configurations">
- <title>Other configurations</title>
- <procedure
id="proc-Site_Publisher_Installation_Guide-Other_configurations-Newsletter_configuration">
- <title>Newsletter configuration</title>
- <step>
- <para>
-
- </para>
-
- </step>
-
- </procedure>
-
-
- </section>
-
-
-</chapter>
-
Modified:
epp/docs/branches/5.2/Site_Publisher/Installation_Guide/en-US/Site_Publisher_Installation_Guide.xml
===================================================================
---
epp/docs/branches/5.2/Site_Publisher/Installation_Guide/en-US/Site_Publisher_Installation_Guide.xml 2011-12-05
04:34:52 UTC (rev 8192)
+++
epp/docs/branches/5.2/Site_Publisher/Installation_Guide/en-US/Site_Publisher_Installation_Guide.xml 2011-12-05
21:10:57 UTC (rev 8193)
@@ -4,12 +4,11 @@
%BOOK_ENTITIES;
]>
<book>
- <xi:include href="Book_Info.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Preface.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Introduction.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Installation.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Create_A_Site.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Revision_History.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
- <index />
+ <xi:include href="Book_Info.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Preface.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Introduction.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Installation.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Revision_History.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <index />
</book>