incubator-wookie-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scot...@apache.org
Subject svn commit: r1101963 - /incubator/wookie/site/trunk/content/wookie/docs/developer/features.mdtext
Date Wed, 11 May 2011 16:41:21 GMT
Author: scottbw
Date: Wed May 11 16:41:21 2011
New Revision: 1101963

URL: http://svn.apache.org/viewvc?rev=1101963&view=rev
Log:
Added documentation for features

Added:
    incubator/wookie/site/trunk/content/wookie/docs/developer/features.mdtext   (with props)

Added: incubator/wookie/site/trunk/content/wookie/docs/developer/features.mdtext
URL: http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/developer/features.mdtext?rev=1101963&view=auto
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/developer/features.mdtext (added)
+++ incubator/wookie/site/trunk/content/wookie/docs/developer/features.mdtext Wed May 11 16:41:21
2011
@@ -0,0 +1,40 @@
+Title: Features
+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.
+
+Features are used to add extra capability to Wookie widgets at runtime. Features typically
inject scripts and stylesheets into widgets when they are viewed in the browser, for example
to give access to a particular API or feature.
+
+To create a feature:
+
+1. Create a new directory in the Wookie /features directory for your feature
+2. Create any JavaScript (.js) or Stylesheet (.css) files you need in this directory
+3. Create a file called features.xml with the structure defined below.
+
+# Features.xml
+
+A features.xml file must have `<feature>` as its root element, must contain a single
`<name>` child element, and can have any number of `<script>` and `<stylesheet>`
child elements.
+
+The `<name>` element should contain an IRI identifying the feature - this is used to
match against the `<feature>` element found in a widget's config.xml file.
+
+
+The `<script>` and `<stylesheet>` elements should contain a `src` attribute with
the filename to load. This must be relative to the folder for the feature - typically this
is just the filename but you can also store CSS and JS files in subfolders within your feature
directory if you wish.
+
+#Installing features
+
+By default Wookie will look in its /features directory on launch and load any features it
finds.
+
+(There is currently no way to dynamically load a feature while Wookie is still running)
\ No newline at end of file

Propchange: incubator/wookie/site/trunk/content/wookie/docs/developer/features.mdtext
------------------------------------------------------------------------------
    svn:eol-style = native



Mime
View raw message