Author: buildbot
Date: Wed Oct 10 16:24:40 2012
New Revision: 834698
Log:
Staging update by buildbot for rave
Added:
websites/staging/rave/trunk/content/documentation/add-page-template.html
Modified:
websites/staging/rave/trunk/content/ (props changed)
Propchange: websites/staging/rave/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Oct 10 16:24:40 2012
@@ -1 +1 @@
-1396603
+1396672
Added: websites/staging/rave/trunk/content/documentation/add-page-template.html
==============================================================================
--- websites/staging/rave/trunk/content/documentation/add-page-template.html
(added)
+++ websites/staging/rave/trunk/content/documentation/add-page-template.html
Wed Oct 10 16:24:40 2012
@@ -0,0 +1,128 @@
+<!doctype html>
+<html>
+<head>
+ <meta charset="UTF-8"/>
+<!--
+
+ 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.
+-->
+ <link rel="shortcut icon" href="/images/RAVE-favicon.ico"
type="image/x-icon"/>
+ <link rel="stylesheet" href="//www.google.com/cse/style/look/default.css"/>
+ <link href="/css/rave.css" rel="stylesheet"/>
+ <title>Adding a New Page Layout for Widgets</title>
+</head>
+
+<body>
+ <div id="banner">
+ <img id="logo" alt="Apache Rave"
src="/images/RAVE-logo_main-logo-small.png"/>
+ </div>
+
+ <div id="navigation">
+ <div id="cse-search-form">Loading <!-- Placeholder for Google Search Form
--></div>
+ <h1 id="general">General</h1>
+<ul>
+<li><a href="/index.html">About</a></li>
+<li><a href="/documentation/index.html">Documentation</a></li>
+<li><a href="/downloads.html">Downloads</a></li>
+<li><a href="/license.html">License</a></li>
+</ul>
+<h1 id="community">Community</h1>
+<ul>
+<li><a href="/get-involved.html">Get Involved</a></li>
+<li><a href="/mailing-lists.html">Mailing Lists</a></li>
+<li><a href="/people.html">People</a></li>
+<li><a href="http://wiki.apache.org/rave/";>Wiki</a></li>
+</ul>
+<h1 id="development">Development</h1>
+<ul>
+<li><a href="/source.html">Getting Started</a></li>
+<li><a href="/ide-settings-and-debugging.html">IDE Settings and
debugging</a></li>
+<li><a href="/release-management.html">Release Management</a></li>
+<li><a href="/issue-management.html">Issue Tracker</a></li>
+<li><a href="https://builds.apache.org/hudson/view/M-R/view/Rave/";>Continuous
Integration</a></li>
+<li><a href="https://analysis.apache.org/dashboard/index/58996";>Sonar
Dashboard</a></li>
+<li><a href="/edit-website.html">Website</a></li>
+</ul>
+<h1 id="asf">ASF</h1>
+<ul>
+<li><a href="http://www.apache.org";>Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html";>Become a
Sponsor</a></li>
+<li><a href="http://www.apache.org/security/";>Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">Adding a New Page Layout for Widgets</h1>
+ <h2 id="adding-a-new-page-layout-for-widgets">Adding a New Page Layout for
Widgets</h2>
+<p>If you want to add a new page layout to Rave on which to render widgets,
here are the steps that currently need to be performed. This is an area that
could be improved in the Rave architecture.</p>
+<p>1) Add a new JSP fragment to:</p>
+<div class="codehilite"><pre><span class="n">rave</span><span
class="o">-</span><span class="n">portal</span><span class="o">-</span><span
class="n">resources</span> <span class="o">></span> <span
class="n">src</span> <span class="o">></span> <span class="n">main</span>
<span class="o">></span> <span class="n">webapp</span> <span
class="o">></span> <span class="n">WEB</span><span class="o">-</span><span
class="n">INF</span> <span class="o">></span> <span class="n">jsp</span>
<span class="o">></span> <span class="n">layouts</span>
+</pre></div>
+
+
+<ul>
+<li>This fragment should outline the region structure of your layout in
HTML</li>
+</ul>
+<p>2) Insert a new record into the PAGE_LAYOUT table which corresponds to your
new layout.</p>
+<ul>
+<li><strong>entity_id:</strong> the primary key value of the record</li>
+<li><strong>code:</strong> should match the file name of your JSP layout
fragment, minus the ".jsp"</li>
+<li><strong>number_of_regions:</strong> the number of regions your JSP layout
fragment has that can contain widgets</li>
+<li><strong>render_sequence:</strong> the order in which this layout option
will appear to the user in the add page or edit page dialogs</li>
+<li><strong>user_selectable:</strong> <ul>
+<li><em>true</em>: if you want the user to be able to select this layout in
the add/edit page dialogs </li>
+<li><em>false</em>: if you do not want the user to be able to select this
layout for a user page</li>
+</ul>
+</li>
+</ul>
+<p>3) Add a new property to the messages.properties bundle for your layout:</p>
+<div class="codehilite"><pre><span class="n">page</span><span
class="o">.</span><span class="n">general</span><span class="o">.</span><span
class="n">addpage</span><span class="o">.</span><span
class="n">layout</span><span class="o">.<</span><span
class="n">layout</span> <span class="n">code</span><span
class="o">>=<</span><span class="n">Human</span> <span
class="n">Readable</span> <span class="n">Value</span><span
class="o">></span>
+</pre></div>
+
+
+<p><em>example:</em> page.general.addpage.layout.columns_10=Ten Columns</p>
+<p>4) Rebuild and deploy Rave</p>
+<ul>
+<li>Your new layout should appear in the "Select Page Layout" list when adding
or editing a page</li>
+</ul>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2012 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache
License, Version 2.0</a>.
+ <br />
+ Apache Rave, Apache, the Apache feather logo, and the Apache Rave
project logos are trademarks of The Apache Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks
of their respective owners.
+ </p>
+ </div>
+ </div>
+ <script src="//www.google.com/jsapi"></script>
+ <script>
+ google.load('search', '1', {language : 'en'});
+ google.setOnLoadCallback(function() {
+ var customSearchOptions = {}; var customSearchControl = new
google.search.CustomSearchControl(
+ '009412755592933514871:wrsgblows4o', customSearchOptions);
+
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
+ var options = new google.search.DrawOptions();
+
options.enableSearchboxOnly("http://www.google.com/cse?cx=009412755592933514871:wrsgblows4o";);
+ customSearchControl.draw('cse-search-form', options);
+ }, true);
+ </script>
+</body>
+</html>
