You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rave.apache.org by bu...@apache.org on 2013/01/02 08:17:00 UTC
svn commit: r844592 - in /websites/staging/rave/trunk/content: ./
documentation/rave-extensions.html ide-settings-and-debugging.html
images/screenshot_custom_project.png source.html
Author: buildbot
Date: Wed Jan 2 07:17:00 2013
New Revision: 844592
Log:
Staging update by buildbot for rave
Added:
websites/staging/rave/trunk/content/images/screenshot_custom_project.png (with props)
Modified:
websites/staging/rave/trunk/content/ (props changed)
websites/staging/rave/trunk/content/documentation/rave-extensions.html
websites/staging/rave/trunk/content/ide-settings-and-debugging.html
websites/staging/rave/trunk/content/source.html
Propchange: websites/staging/rave/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Jan 2 07:17:00 2013
@@ -1 +1 @@
-1424013
+1427690
Modified: websites/staging/rave/trunk/content/documentation/rave-extensions.html
==============================================================================
--- websites/staging/rave/trunk/content/documentation/rave-extensions.html (original)
+++ websites/staging/rave/trunk/content/documentation/rave-extensions.html Wed Jan 2 07:17:00 2013
@@ -68,42 +68,68 @@
<div id="content">
<h1 class="title">Extend Apache Rave to build your own portal</h1>
<p>One of the (main) goals of Apache Rave is to create an extendible platform. This document is to help Apache Rave users (developers) to customize Apache Rave based on needs.</p>
-<p>To get you started we have created a Sandbox and created a vanilla extension that shows how to implement CustomUserService and to personalize login page look and feel.
-The main objective of the vanilla extension is to provide reusable build environment with minimal required dependencies.
-Extension developers will be able to use the POM file provide and add additional project dependencies. </p>
+<p>To get you started we have created a Maven archetype that generates a Rave project. This project shows how to use a custom (Spring) component and to customize the look and feel.
+Extension developers will be able to use the POM file provide and add additional project dependencies.</p>
<h2 id="prerequisites">Prerequisites</h2>
-<p>The current version of Apache Rave must be in your local Maven repository. To do this, <a href="../source.html">check out Apache Rave from SVN</a> and build with "mvn clean install".</p>
-<h2 id="vanilla-extension-location">Vanilla Extension Location</h2>
-<div class="codehilite"><pre><span class="n">svn</span> <span class="n">co</span> <span class="n">http:</span><span class="sr">//s</span><span class="n">vn</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="sr">/repos/</span><span class="n">asf</span><span class="sr">/rave/s</span><span class="n">andbox</span><span class="sr">/rave-extensions/</span><span class="n">rave</span><span class="o">-</span><span class="n">vanilla</span><span class="o">-</span><span class="n">extension</span>
-<span class="n">cd</span> <span class="n">rave</span><span class="o">-</span><span class="n">vanilla</span><span class="o">-</span><span class="n">extension</span>
-<span class="n">mvn</span> <span class="n">clean</span> <span class="n">install</span>
+<ul>
+<li>Java SE 6 or higher</li>
+<li>Apache Maven 3+ (version 3.0.3 or later is <em>required</em>) <a href="http://maven.apache.org/download.html">Download</a> and <a href="http://maven.apache.org/download.html#Installation">install</a></li>
+</ul>
+<p>A Maven archetype will be available to generate a custom Rave project for the 0.19 release (January 2013) and future releases.
+You can also build this archetype from the latest (snapshot) code. To do this, <a href="../source.html">check out Apache Rave from SVN</a> and build with "mvn clean install".</p>
+<h2 id="generate-custom-rave-project">Generate custom Rave project</h2>
+<p>In your console or terminal navigate to the folder where you store your projects. The archetype will create the folder of the project inside this folder. Then type:</p>
+<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">archetype:generate</span> <span class="o">-</span><span class="n">DarchetypeGroupId</span><span class="o">=</span><span class="n">org</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">rave</span> <span class="o">-</span><span class="n">DarchetypeArtifactId</span><span class="o">=</span><span class="n">rave</span><span class="o">-</span><span class="n">custom</span><span class="o">-</span><span class="n">project</span><span class="o">-</span><span class="n">archetype</span>
+</pre></div>
-<span class="n">cd</span> <span class="n">rave</span><span class="o">-</span><span class="n">vanilla</span><span class="o">-</span><span class="n">extension</span><span class="o">-</span><span class="n">portal</span>
-<span class="n">mvn</span> <span class="n">cargo:start</span>
+
+<p>Maven will try to download the <code>rave-custom-project-archetype</code>. Then asks you to define the custom project's groupId, artifactId etc. The default values are:</p>
+<div class="codehilite"><pre><span class="err">groupId:</span> <span class="err">org.example</span>
+<span class="err">artifactId:</span> <span class="err">myraveproject</span>
+<span class="err">version:</span> <span class="err">1.01.00-SNAPSHOT</span>
+<span class="err">package:</span> <span class="err">org.example</span>
+<span class="err">projectName:</span> <span class="err">My</span> <span class="err">Rave</span> <span class="err">Project</span>
</pre></div>
-<p>or</p>
-<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">cargo:start</span> <span class="o">-</span><span class="n">f</span> <span class="n">rave</span><span class="o">-</span><span class="n">vanilla</span><span class="o">-</span><span class="n">extension</span><span class="o">-</span><span class="n">portal</span><span class="o">/</span><span class="n">pom</span><span class="o">.</span><span class="n">xml</span>
+<h3 id="run-the-project">Run the project</h3>
+<p>If you use the defaults, the project is called <code>myraveproject</code> and its portal module <code>myraveproject-portal</code></p>
+<div class="codehilite"><pre><span class="n">cd</span> <span class="n">myraveproject</span>
+<span class="n">mvn</span> <span class="n">install</span>
+
+<span class="n">cd</span> <span class="n">myraveproject</span><span class="o">-</span><span class="n">portal</span>
+<span class="n">mvn</span> <span class="n">cargo:run</span>
</pre></div>
-<h2 id="best-practices">Best Practices</h2>
-<ul>
-<li>Add new javascript functions to new file or copy existing functions to new file and customize them and change imports based on your need. Reason is, changes/fixes in rave libraries should come to your project.</li>
-<li>If you are are customizing css or adding new css methods add new files so that changes in default css files will come to your portal</li>
-<li>Report any bug or issue to <a href="https://issues.apache.org/jira/browse/RAVE">Apache Rave JIRA</a></li>
-</ul>
-<h2 id="customizations">Customizations</h2>
+<p>You can now navigate to the portal on http://localhost:8080</p>
+<h2 id="custom-project">Custom project</h2>
+<p>The project will have the following structure:</p>
+<p><img alt="Project structure" src="/images/screenshot_custom_project.png" /></p>
+<h3 id="customizations">Customizations</h3>
<ul>
<li>
-<p>User Service : Extension implements rave UserService interface as CustomUserService. To use CustomUserService for login you need to update
-Application Security context provided in ~/src/main/webapp/WEB-INF/applicationContext-security.xml and add name for customUserService. </p>
+<p>User Service : implements Rave UserService interface as CustomUserService. To use CustomUserService for
+ login a <code>customUserService</code> bean has been defined in the Application Security context provided in
+ <code>./myraveportal-portal/src/main/webapp/WEB-INF/applicationContext-security.xml</code>.</p>
</li>
<li>
-<p>Login page : This is just to demonstrate that if you have your own login page and style sheets you can copy them to right location and they will be
-included in portal war along with other portal files. If you will have the same files name as in portal war, they will be replaced with your version of files.</p>
+<p><a href="ldap-authentication.html">LDAP authentication</a> has been removed from the project by excluding its dependencies in
+ the pom.xml file and removing the LDAP configuration in <code>./myraveportal-portal/src/main/webapp/WEB-INF/applicationContext-security.xml</code>.</p>
</li>
+<li>
+<p>Look and feel : This is to demonstrate that your own look and feel can be given to the portal by adding styles to
+ <code>./myraveportal-portal/src/main/webapp/static/css/custom.css</code></p>
+</li>
+<li>
+<p>There is also a separate module to override the OpenSocial provider (Apache Shindig), but it builds the same configuration as the standard release.</p>
+</li>
+</ul>
+<h3 id="best-practices">Best Practices</h3>
+<ul>
+<li>Add new javascript functions to new file or copy existing functions to new file and customize them and change imports based on your need. Reason is, changes/fixes in rave libraries should come to your project.</li>
+<li>If you are are customizing css or adding new css methods add new files so that changes in default css files will come to your portal</li>
+<li>Report any bug or issue to <a href="https://issues.apache.org/jira/browse/RAVE">Apache Rave JIRA</a></li>
</ul>
</div>
Modified: websites/staging/rave/trunk/content/ide-settings-and-debugging.html
==============================================================================
--- websites/staging/rave/trunk/content/ide-settings-and-debugging.html (original)
+++ websites/staging/rave/trunk/content/ide-settings-and-debugging.html Wed Jan 2 07:17:00 2013
@@ -110,7 +110,7 @@ edit/build/deploy cycle.</p>
<h3 id="using-remote-debugging-and-the-eclipse-filesync-plugin">Using Remote debugging and the Eclipse FileSync plugin</h3>
<p>The OSS <a href="http://andrei.gmxhome.de/filesync/index.html">Eclipse FileSync</a> plugin can automatically synchronize (re)source changes
(e.g. .jsp, .css, .js) made in the Eclipse IDE directly to the runtime tomcat deployment
-started (separately) through maven cargo:start. And you can attach the Eclipse debugger
+started (separately) through maven cargo:run. And you can attach the Eclipse debugger
to the cargo started Tomcat instance (see above) as remote application on default port 8000.</p>
<p>The <a href="http://code.google.com/p/mavenfilesync/">maven-filesync-plugin</a> is pre-configured to generate default Eclipse FileSync
configurations for the rave-shindig and rave-portal projects, mapping their source folders
@@ -141,7 +141,7 @@ and then (re)import the Apache Rave proj
<li>Right click on the rave-shindig project and select Properties</li>
<li>Open the "Deployment Assembly" property</li>
<li>Press Add, select Directive Type "Folder", and select the
- target/rave-shindig-0.1-incubating-SNAPSHOT folder.
+ target/rave-shindig-<version>-SNAPSHOT folder.
(do a "mvn install" in rave-project first for this folder to be available)</li>
<li>configure the correct Context root paths for rave-portal
("portal") and rave-shindig ("/") in their Eclipse project
Added: websites/staging/rave/trunk/content/images/screenshot_custom_project.png
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/rave/trunk/content/images/screenshot_custom_project.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Modified: websites/staging/rave/trunk/content/source.html
==============================================================================
--- websites/staging/rave/trunk/content/source.html (original)
+++ websites/staging/rave/trunk/content/source.html Wed Jan 2 07:17:00 2013
@@ -112,11 +112,11 @@ you have to add these URLs in your proxy
<ul>
<li>
<p>navigate to the rave-portal subdirectory and invoke:</p>
-<p><code>mvn cargo:start</code></p>
+<p><code>mvn cargo:run</code></p>
<p><em>If you are behind a proxy, then you can specify it with the following command</em></p>
</li>
</ul>
-<p><em><code>mvn -Dcargo.args="-Dhttp.proxyHost=PROXYHOST -Dhttp.proxyPort=PROXYPORT -Dhttp.nonProxyHosts=NONPROXYHOST" cargo:start</code></em></p>
+<p><em><code>mvn -Dcargo.args="-Dhttp.proxyHost=PROXYHOST -Dhttp.proxyPort=PROXYPORT -Dhttp.nonProxyHosts=NONPROXYHOST" cargo:run</code></em></p>
<ul>
<li>open url http://localhost:8080/portal in a browser</li>
<li>press Ctrl-C in the console to stop Tomcat again</li>