You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by ta...@apache.org on 2009/02/24 00:30:25 UTC

svn commit: r747201 - in /portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01: first-steps.xml genapp.xml install-it.xml run-it.xml

Author: taylor
Date: Mon Feb 23 23:30:24 2009
New Revision: 747201

URL: http://svn.apache.org/viewvc?rev=747201&view=rev
Log:
svn

Added:
    portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/first-steps.xml   (with props)
    portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/genapp.xml   (with props)
    portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/install-it.xml   (with props)
    portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/run-it.xml   (with props)

Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/first-steps.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/first-steps.xml?rev=747201&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/first-steps.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/first-steps.xml Mon Feb 23 23:30:24 2009
@@ -0,0 +1,127 @@
+<?xml version="1.0"?>
+<!--
+	Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+	
+	http://www.apache.org/licenses/LICENSE-2.0
+	
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License.
+-->
+<document>
+	<properties>
+		<title>Eclipse and Ant - First Steps</title>
+		<subtitle>Custom Project First Steps</subtitle>
+		<authors>
+			<person name="David Sean Taylor" email="taylor@apache.org" />
+			<person name="David Dyer"
+				email="ddyer@artifact-software.com" />
+			<person name="Ron Wheeler"
+				email="rwheeler@artifact-software.com" />
+		</authors>
+	</properties>
+	<body>
+		<section name="Installing Java, Eclipse and Ant">
+			<p>
+				If you have not already done so, install
+				<a href="../references/java.html">Java</a>
+				,
+				<a href="../references/ant.html">Ant</a>
+				and
+				<a href="../references/eclipse.html">
+					Eclipse.
+					<a />
+				</a>
+			</p>
+		</section>
+		<section name='Download the JetExpress portal source'>
+			<div class="todo"><p>
+				You can download the JetExpress source code from
+				<a href="http://people.apache.org/~taylor/tutorial/">Tutorial Download Location</a>. Additionally, you will need to download a Jetspeed final release installer.
+			</p></div>
+			<p>The distribution kit is described in more detail in the <a href="../references/tutorial_distribution.html">Tutorial Distribution Kit</a> document.</p>
+			<p>
+				Once you have downloaded the distribution kit, expand the two projects: jetexpress, express-demo, directly into your Eclipse workspace.
+			</p>
+			<subsection name="Project Directory Structure">
+				<p>
+				The structure of the JetExpress project is described in
+					<a href='../references/project_directory.html'>
+						Project Directory Overview.
+					</a>
+					Take some time to familiarize yourself with the structure.
+				</p>
+			</subsection>
+		</section>
+		<section name='Creating the JetExpress Project in Eclipse'>
+			<p>
+				Once the project is installed on your disk, it can be
+				setup as an Eclipse Project by simply importing the project in place.
+			</p>
+
+			<p>
+				The project is now ready to build but still needs some
+				property changes before it can be deployed for testing on the
+				servlet engine.
+			</p>
+
+		</section>
+		<section name="Ant Targets for JetExpress">
+			<p>
+				When Ant is used to build a project in Eclipse, the
+				project must have a file called "build.xml" in the root
+				directory. This file contains the list of tasks that Ant
+				can execute. These are called "targets".
+			</p>
+			<p>
+				Before getting started with the tutorial, review the Ant
+				targets that are available in the
+				<a href='../references/ant_targets.html'>
+					JetExpress tutorial's build.xml file.:
+				</a>
+			</p>			
+		</section>
+		<section name='Ant Properties'>
+			<p>There are a few critical properties that must be configured.
+			See the reference 
+				<a href='../references/ant_targets.html#Build Properties'>build.properties</a> which are also discussed below.
+			</p>		
+		<subsection
+			name='Change the Jetspeed-2 Server (Tomcat) Location Property'>
+			<p>
+				JetExpress comes with a built-in servlet engine. When you run the installer, you can choose which
+				directory to install the servlet engine into. The installer will allow you to select a location to install
+				the JetExpress portal into. After running the installer, please remember the directory where you installed into.
+			    There are a few development-mode targets in Ant that need to know where Tomcat is installed. Set the property in your build.properties, for example:
+			</p>
+			<source>
+				<![CDATA[		
+app.server.home = /JetspeedTraining/servers/tomcat-express
+     ]]>
+			</source>
+		</subsection>
+		<subsection
+			name='Change the Jetspeed-2 Server (Tomcat) Location Property'>
+			<p>One of the resources downloaded is the Jetspeed 2.1.2 installer.
+			Please place the installer someplace on your file system, and then update the property:
+			</p>
+			<source>
+<![CDATA[		
+installer.src.jar = /JetspeedTraining/installers/jetspeed-2.1.1-dev-installer.jar
+   ]]>
+			</source>			
+			<p>
+				<a href='genapp.html'>Next</a>
+			</p>					
+		</subsection>		
+		</section>
+	</body>
+</document>
+

Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/first-steps.xml
------------------------------------------------------------------------------
    svn:keywords = Id

Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/genapp.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/genapp.xml?rev=747201&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/genapp.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/genapp.xml Mon Feb 23 23:30:24 2009
@@ -0,0 +1,67 @@
+<?xml version="1.0"?>
+<!--
+	Licensed to the Apache Software Foundation (ASF) under one or more
+	contributor license agreements.  See the NOTICE file distributed with
+	this work for additional information regarding copyright ownership.
+	The ASF licenses this file to You under the Apache License, Version 2.0
+	(the "License"); you may not use this file except in compliance with
+	the License.  You may obtain a copy of the License at
+	
+	http://www.apache.org/licenses/LICENSE-2.0
+	
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License.
+-->
+<document>
+	<properties>
+		<title>Generating a Jetspeed Custom Portal</title>
+		<subtitle>
+			Generating a Jetspeed Portal Custom Installer
+		</subtitle>
+		<authors>
+			<person name="David Sean Taylor" email="taylor@apache.org" />
+			<person name="David Dyer"
+				email="ddyer@artifact-software.com" />
+			<person name="Ron Wheeler"
+				email="rwheeler@artifact-software.com" />
+		</authors>
+	</properties>
+	<body>
+		<section name="Building the Installer for the First Time">
+			<p>
+				Now that you have configured the basic portal, we are
+				ready to build the portal installer. In the Navigator view,
+				right-click on the build.xml in the root of the project.
+				Select the "Run As", then "Build ...". Check to ensure
+				that
+				<em>create.installer</em>
+				is selected and click on the "Run" button.
+			</p>
+			<p>Or, you can switch over to the command line, goto the jetexpress directory, and type <b>ant create.installer</b>.
+			   There is also a <b>clean</b> target that should be used to clean out the previous build
+			</p>
+			<p>
+				Note that we are building a minimal deployment. The Min deployment
+				only creates a Jetspeed core portal and a Jetspeed Admin
+				portlet application (j2-admin). When the build process
+				completes, you should see the message
+				<b>BUILD SUCCESSFUL</b>
+				at the end of a large amount of build logging
+				information The portal is built into a temp directory
+				named
+				<i>target</i>
+				found directory under your
+				<i>jetexpress</i>
+				project directory.
+			</p>
+			<p>
+				<a href='first-steps.html'>Previous</a>
+				<a href='install-it.html'>Next</a>
+			</p>
+		</section>
+	</body>
+</document>
+

Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/genapp.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/genapp.xml
------------------------------------------------------------------------------
    svn:keywords = Id

Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/install-it.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/install-it.xml?rev=747201&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/install-it.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/install-it.xml Mon Feb 23 23:30:24 2009
@@ -0,0 +1,72 @@
+<?xml version="1.0"?>
+<!--
+	Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+	
+	http://www.apache.org/licenses/LICENSE-2.0
+	
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License.
+-->
+<document>
+	<properties>
+		<title>Build the Custom Portal</title>
+		<subtitle>Building a Custom Jetspeed Portal</subtitle>
+		<authors>
+			<person name="David Sean Taylor" email="taylor@apache.org" />
+			<person name="David Dyer"
+				email="ddyer@artifact-software.com" />
+			<person name="Ron Wheeler"
+				email="rwheeler@artifact-software.com" />
+		</authors>
+	</properties>
+	<body>
+		<section name="Running the Installer">
+		<p>After running the <b>create-installer</b> target successfully, we can now install your custom portal.
+		The installer will:
+		</p> 			
+			<ul>
+				<li>
+					deploys Jetspeed and the Tomcat application server.
+					If you are following the training material, the
+					Tomcat directory is located under
+					<i>/JetspeedTraining/tomcat-express/</i>
+				</li>
+				<li>
+					creates the Jetspeed core schema tables in the Derby
+					database
+				</li>
+				<li>
+					populates the database with a minimal set of portal
+					information, including default roles, groups,
+					profiles, and administrative users
+				</li>
+			</ul>
+		<p>To run the installer:</p>
+<source>
+<![CDATA[		
+cd dist
+java -jar jetexpress-installer.jar
+   ]]>
+</source>							
+			<p>Follow through the installation instructions. Feel free to use any database backend. However, if you are not using Derby,
+			it is up to you to provide the latest database driver</p>
+			<p>
+				Now that we've built and deployed the portal, lets start
+				up the application server...
+			</p>
+			<p>
+				<a href='genapp.html'>Previous</a>
+				<a href='run-it.html'>Next</a>
+			</p>
+		</section>
+	</body>
+</document>
+

Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/install-it.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/install-it.xml
------------------------------------------------------------------------------
    svn:keywords = Id

Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/run-it.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/run-it.xml?rev=747201&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/run-it.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/run-it.xml Mon Feb 23 23:30:24 2009
@@ -0,0 +1,76 @@
+<?xml version="1.0"?>
+<!--
+	Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+	
+	http://www.apache.org/licenses/LICENSE-2.0
+	
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License.
+-->
+<document>
+	<properties>
+		<title>Run the Custom Portal</title>
+		<subtitle>Running a Custom Jetspeed Portal</subtitle>
+		<authors>
+			<person name="David Sean Taylor" email="taylor@apache.org" />
+			<person name="David Dyer"
+				email="ddyer@artifact-software.com" />
+			<person name="Ron Wheeler"
+				email="rwheeler@artifact-software.com" />
+		</authors>
+	</properties>
+	<body>
+		<section name="Running a Custom Jetspeed Portal">
+			<p>
+				Running the portal is very straight forward. In this
+				tutorial we are running our Jetspeed portal in a Tomcat
+				application server. To start up the portal, go to the
+				command line and enter:
+			</p>
+			<source>
+				<![CDATA[
+cd tomcat-express
+cd bin
+# Windows
+catdebug 
+# Linux
+./catdebug.sh
+     ]]>
+			</source>
+			<p>
+				The first time we run the portal, its going to take a
+				minute or so to complete the initial deployment of the
+				portal and Admin portlet application.
+			</p>
+			<p>
+				Open up a browser and navigate to
+				<a href="http://localhost:8080/jetexpress/portal">
+					http://localhost:8080/jetexpress/portal
+				</a>
+			</p>
+			<p>
+				You should see the minimal core Jetspeed portal as shown
+				below. Login with the credentials
+				<b>admin/admin</b>
+				. You will be prompted to change the admin password. As
+				you can see, this is a boiler plate, minimal portal.
+				Press the Next button to get started on customizing
+				Jetspeed.
+			</p>
+			<p>
+				<a href='install-it.html'>Previous</a>
+				<a href='../02/customizing-overview.html'>Next</a>
+			</p>
+			<img src="../images/min-screenshot.png" />
+		</section>
+	</body>
+</document>
+

Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/run-it.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/01/run-it.xml
------------------------------------------------------------------------------
    svn:keywords = Id



---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org