svn commit: r788435 - /myfaces/portlet-bridge/core/trunk/src/site/apt/index.apt.vm

[mf...@apache.org]

Author: mfreedman
Date: Thu Jun 25 17:04:13 2009
New Revision: 788435

URL: http://svn.apache.org/viewvc?rev=788435&view=rev
Log:
Updated site documentation.

Modified:
    myfaces/portlet-bridge/core/trunk/src/site/apt/index.apt.vm

Modified: myfaces/portlet-bridge/core/trunk/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/myfaces/portlet-bridge/core/trunk/src/site/apt/index.apt.vm?rev=788435&r1=788434&r2=788435&view=diff
==============================================================================
--- myfaces/portlet-bridge/core/trunk/src/site/apt/index.apt.vm (original)
+++ myfaces/portlet-bridge/core/trunk/src/site/apt/index.apt.vm Thu Jun 25 17:04:13 2009
@@ -1,27 +1,31 @@
- ~~ 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.
- 
- ~~ Note: See documentation on http://maven.apache.org/guides/mini/guide-apt-format.html
-
- ----------------------
- ${project.name}
- ----------------------
-
-Introduction
-
-  This is the ${project.name} ${projectSeries} Project.  This is the current reference implementation for
-  "${specName}".
-  
-  The currently released version is {{{downloads.html} ${project.name} 1.0.0-beta}}.
+ ~~ 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.
+ 
+ ~~ Note: See documentation on http://maven.apache.org/guides/mini/guide-apt-format.html
+
+ ----------------------
+ ${project.name}
+ ----------------------
+
+Introduction
+
+  The ${project.name} ${projectSeries} Project provides the reference implementation for "${specName}".
+  It allows one to publish a JavaServer Faces application as a portlet in a Portlet 1.0 compatible
+  environment.  
+  
+  The currently released version is {{{downloads.html} ${project.name} 1.0.0-beta}}.
+
+  For information on using the bridge with an existing application, consult the {{{http://wiki.apache.org/myfaces/PortletBridge} wiki}}.
+  To try it out, run the sample included in the distribution or download and tweek the Mojarra (Faces RI) samples as described in this wiki page.