Author: carlucci
Date: Wed Oct 10 16:24:37 2012
New Revision: 1396672
URL: http://svn.apache.org/viewvc?rev=1396672&view=rev
Log:
CMS commit to rave by carlucci
Added:
rave/site/trunk/content/documentation/add-page-template.mdtext (with
props)
Added: rave/site/trunk/content/documentation/add-page-template.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/documentation/add-page-template.mdtext?rev=1396672&view=auto
==============================================================================
--- rave/site/trunk/content/documentation/add-page-template.mdtext (added)
+++ rave/site/trunk/content/documentation/add-page-template.mdtext Wed Oct 10
16:24:37 2012
@@ -0,0 +1,53 @@
+Title: Adding a New Page Layout for Widgets
+Notice: 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.
+
+## Adding a New Page Layout for Widgets
+
+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.
+
+
+1) Add a new JSP fragment to:
+
+ rave-portal-resources > src > main > webapp > WEB-INF > jsp > layouts
+
+ - This fragment should outline the region structure of your layout in HTML
+
+2) Insert a new record into the PAGE_LAYOUT table which corresponds to your
new layout.
+
+ - **entity_id:** the primary key value of the record
+ - **code:** should match the file name of your JSP layout fragment, minus
the ".jsp"
+ - **number_of_regions:** the number of regions your JSP layout fragment has
that can contain widgets
+ - **render_sequence:** the order in which this layout option will appear to
the user in the add page or edit page dialogs
+ - **user_selectable:**
+ - *true*: if you want the user to be able to select this layout in the
add/edit page dialogs
+ - *false*: if you do not want the user to be able to select this layout
for a user page
+
+3) Add a new property to the messages.properties bundle for your layout:
+
+
+ page.general.addpage.layout.<layout code>=<Human Readable Value>
+
+
+
+ *example:* page.general.addpage.layout.columns_10=Ten Columns
+
+
+4) Rebuild and deploy Rave
+
+ - Your new layout should appear in the "Select Page Layout" list when adding
or editing a page
+
\ No newline at end of file
Propchange: rave/site/trunk/content/documentation/add-page-template.mdtext
------------------------------------------------------------------------------
svn:eol-style = native
