Author: psharples
Date: Mon Oct 15 08:53:25 2012
New Revision: 1398221
URL: http://svn.apache.org/viewvc?rev=1398221&view=rev
Log:
Added documentation for OMDL import/export features. See Rave-820.
Added:
rave/site/trunk/content/documentation/omdl-import-export.mdtext
Modified:
rave/site/trunk/content/documentation/index.mdtext
Modified: rave/site/trunk/content/documentation/index.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/documentation/index.mdtext?rev=1398221&r1=1398220&r2=1398221&view=diff
==============================================================================
--- rave/site/trunk/content/documentation/index.mdtext (original)
+++ rave/site/trunk/content/documentation/index.mdtext Mon Oct 15 08:53:25 2012
@@ -44,6 +44,7 @@ Notice: Licensed to the Apache Softwa
- [Enable CAPTCHA security for new account creation](captcha-enabling.html)
- [Manage Rave Static Resources (CSS,
JavaScript)](manage-static-resources.html)
- [Add a New Page Layout](add-page-template.html)
+ - [Import and Export pages using the OMDL format](omdl-import-export.html)
## Portal administration
- [Portal admin interface](admin-interface.html)
Added: rave/site/trunk/content/documentation/omdl-import-export.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/documentation/omdl-import-export.mdtext?rev=1398221&view=auto
==============================================================================
--- rave/site/trunk/content/documentation/omdl-import-export.mdtext (added)
+++ rave/site/trunk/content/documentation/omdl-import-export.mdtext Mon Oct 15
08:53:25 2012
@@ -0,0 +1,42 @@
+Title: Importing and Exporting pages using the OMDL format
+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.
+
+The [Open Mashup Description Language][1] is a specification designed to allow
the import and export of pages,
+layouts and widgets between different applications. The goal is to be able to
export page data from one application (such as Apache Rave)
+and then import that information into another application or portal. Please
read the specification for more information.
+
+## Enabling OMDL features in Raves user interface
+
+Rave supports both import and export of OMDL pages in an xml file format. To
access the user interface elements for this, you must
+first update the following setting found in portal.properties, and then
restart Rave.
+
+ portal.export.ui.enable=true
+
+This will add the import and export menu options.
+
+## Exporting a page
+
+From any existing page in Rave, click the page menu where you should see an
"Export page" option. Click this to download the current page as OMDL xml.
+
+## Importing a page
+
+Click the plus icon. (The icon appears next to your list of pages in Rave)
This should open a tabbed dialog box where you can add a new page as normal,
but also
+now choose to upload an OMDL xml file. (You can upload the page you previously
exported, to see the results) Once the page has been imported, you should
+see the same page view as the original with all of the widgets also visible.
+
+[1]: http://omdl.org
\ No newline at end of file
