You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/08/02 00:17:47 UTC
svn commit: r1509456 [21/21] - in /cordova/site/public/docs: en/1.5.0/
en/1.5.0rc1/ en/1.6.0/ en/1.6.0rc1/ en/1.6.1/ en/1.7.0/ en/1.7.0rc1/
en/1.8.0/ en/1.8.0rc1/ en/1.8.1/ en/1.9.0/ en/1.9.0rc1/ en/2.0.0/
en/2.0.0rc1/ en/2.1.0/ en/2.1.0rc1/ en/2.1.0rc...
Modified: cordova/site/public/docs/en/edge/plugin_ref_spec.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/edge/plugin_ref_spec.md.html?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/en/edge/plugin_ref_spec.md.html (original)
+++ cordova/site/public/docs/en/edge/plugin_ref_spec.md.html Thu Aug 1 22:17:43 2013
@@ -82,17 +82,32 @@
<div id="subheader">
<h1>Plugin Specification</h1>
<small><select><option value="Plugin%2520Specification">Plugin Specification</option>
-<option value="Plugin%20Specification_plugin_element">Â Â Â Â Â Â - <plugin> element</option>
-<option value="Plugin%20Specification_engines_and_engine_elements">Â Â Â Â Â Â - <engines> and <engine> elements</option>
-<option value="Plugin%20Specification_name_element">Â Â Â Â Â Â - <name> element</option>
-<option value="Plugin%20Specification_asset_element">Â Â Â Â Â Â - <asset> element</option>
-<option value="Plugin%20Specification_js_module_element">Â Â Â Â Â Â - <js-module> element</option>
+<option value="Plugin%20Specification_plugin_element">Â Â Â Â Â Â -
+<plugin> element</option>
+<option value="Plugin%20Specification_engines_and_engine_elements">Â Â Â Â Â Â -
+<engines> and <engine> elements</option>
+<option value="Plugin%20Specification_name_element">Â Â Â Â Â Â -
+<name> element</option>
+<option value="Plugin%20Specification_description_element">Â Â Â Â Â Â -
+<description> element</option>
+<option value="Plugin%20Specification_author_element">Â Â Â Â Â Â -
+<author> element</option>
+<option value="Plugin%20Specification_keywords_element">Â Â Â Â Â Â -
+<keywords> element</option>
+<option value="Plugin%20Specification_license_element">Â Â Â Â Â Â -
+<license> element</option>
+<option value="Plugin%20Specification_asset_element">Â Â Â Â Â Â -
+<asset> element</option>
+<option value="Plugin%20Specification_js_module_element">Â Â Â Â Â Â -
+<js-module> element</option>
<option value="Plugin%20Specification_dependency">Â Â Â Â Â Â - <dependency></option>
<option value="Plugin%20Specification_platform">Â Â Â Â Â Â - <platform></option>
<option value="Plugin%20Specification_source_file">Â Â Â Â Â Â - <source-file></option>
<option value="Plugin%20Specification_config_file">Â Â Â Â Â Â - <config-file></option>
<option value="Plugin%20Specification_plugins_plist">Â Â Â Â Â Â - <plugins-plist></option>
-<option value="Plugin%20Specification_resource_file_and_header_file">Â Â Â Â Â Â - <resource-file> and <header-file></option>
+<option value="Plugin%20Specification_resource_file_and_header_file">Â Â Â Â Â Â -
+<resource-file> and <header-file>
+</option>
<option value="Plugin%20Specification_lib_file">Â Â Â Â Â Â - <lib-file></option>
<option value="Plugin%20Specification_framework">Â Â Â Â Â Â - <framework></option>
<option value="Plugin%20Specification_info">Â Â Â Â Â Â - <info></option>
@@ -107,7 +122,6 @@
<li><a href="guide_overview_index.md.html#Overview">Overview</a></li>
<li><a href="guide_cli_index.md.html#The%20Command-line%20Interface">The Command-line Interface</a></li>
<li><a href="guide_platforms_index.md.html#Platform%20Guides">Platform Guides</a></li>
-<li><a href="index.md.html#Guides">Guides</a></li>
<li><a href="config_ref_index.md.html#Configuration%20Reference">Configuration Reference</a></li>
<li><a href="guide_hybrid_webviews_index.md.html#Embedding%20WebViews">Embedding WebViews</a></li>
<li><a href="guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
@@ -155,7 +169,8 @@ structure of the plugin.</p>
</code></pre>
<h2>
-<a name="Plugin%20Specification_plugin_element"><plugin> element</a>
+<a name="Plugin%20Specification_plugin_element">
+<plugin> element</a>
</h2>
<p>The <code>plugin</code> element is the plugin manifest's top-level element. It
@@ -175,11 +190,13 @@ A reverse-domain style identifier for th
A version number for the plugin, that matches the following
major-minor-patch style regular expression:</p>
-<p>^\d+[.]\d+[.]\d+$</p>
+<pre class="prettyprint"><code>^\d+[.]\d+[.]\d+$
+</code></pre>
</li>
</ul>
<h2>
-<a name="Plugin%20Specification_engines_and_engine_elements"><engines> and <engine> elements</a>
+<a name="Plugin%20Specification_engines_and_engine_elements">
+<engines> and <engine> elements</a>
</h2>
<p>The child elements of the <code><engines></code> element specify versions of
@@ -196,7 +213,7 @@ Apache Cordova-based frameworks that thi
version string should match a major-minor-patch string conforming to
the regular expression:</p>
-<pre class="prettyprint"><code>^\d+[.]\d+[.]\d+$
+<pre class="prettyprint"><code> ^\d+[.]\d+[.]\d+$
</code></pre>
<p>Engine elements may also specify fuzzy matches to avoid repetition,
@@ -217,7 +234,8 @@ project does not meet the engine's const
the specified cordova project directory blindly.</p>
<h2>
-<a name="Plugin%20Specification_name_element"><name> element</a>
+<a name="Plugin%20Specification_name_element">
+<name> element</a>
</h2>
<p>A human-readable name for the plugin, whose text content contains the
@@ -229,7 +247,52 @@ name of the plugin. For example:</p>
<p>This element does not (yet) handle localization.</p>
<h2>
-<a name="Plugin%20Specification_asset_element"><asset> element</a>
+<a name="Plugin%20Specification_description_element">
+<description> element</a>
+</h2>
+
+<p>A human-readable description for the plugin. The text content of the element contains
+the description of the plugin. An example:</p>
+
+<pre class="prettyprint"><code><description>Foo plugin description</description>
+</code></pre>
+
+<p>This element does not (yet) handle localization.</p>
+
+<h2>
+<a name="Plugin%20Specification_author_element">
+<author> element</a>
+</h2>
+
+<p>Plugin author name. The text content of the element contains
+the name of the plugin author. An example:</p>
+
+<pre class="prettyprint"><code><author>Foo plugin description</author>
+</code></pre>
+
+<h2>
+<a name="Plugin%20Specification_keywords_element">
+<keywords> element</a>
+</h2>
+
+<p>Plugin keywords. The text content of the element contains comma separated keywords to describe the plugin. An example:</p>
+
+<pre class="prettyprint"><code><keywords>foo,bar</keywords>
+</code></pre>
+
+<h2>
+<a name="Plugin%20Specification_license_element">
+<license> element</a>
+</h2>
+
+<p>Plugin license. The text content of the element contains the plugin license. An example:</p>
+
+<pre class="prettyprint"><code><license>Apache 2.0 License</license>
+</code></pre>
+
+<h2>
+<a name="Plugin%20Specification_asset_element">
+<asset> element</a>
</h2>
<p>One or more elements listing the files or directories to be copied
@@ -271,7 +334,8 @@ code.</p>
</li>
</ul>
<h2>
-<a name="Plugin%20Specification_js_module_element"><js-module> element</a>
+<a name="Plugin%20Specification_js_module_element">
+<js-module> element</a>
</h2>
<p>Most plugins include one or more JavaScript files. Each <code><js-module></code>
@@ -311,16 +375,16 @@ above, with an <code>id</code> of <code>
<p>Three tags are allowed within <code><js-module></code>:</p>
<ul>
-<li><p><code><clobbers target="some.value" /></code> indicates that the
+<li><p><code><clobbers target="some.value"/></code> indicates that the
<code>module.exports</code> is inserted into the <code>window</code> object as
<code>window.some.value</code>. You can have as many <code><clobbers></code> as you
like. Any object not available on <code>window</code> is created.</p></li>
-<li><p><code><merges target="some.value" /></code> indicates that the module
+<li><p><code><merges target="some.value"/></code> indicates that the module
should be merged with any existing value at <code>window.some.value</code>.
If any key already exists, the module's version overrides the
original. You can have as many <code><merges></code> as you like. Any
object not available on <code>window</code> is created.</p></li>
-<li><p><code><runs /></code> means that your code should be specified with
+<li><p><code><runs/></code> means that your code should be specified with
<code>cordova.require</code>, but not installed on the <code>window</code>
object. This is useful when initializing the module, attaching
event handlers or otherwise. You can only have up to one
@@ -553,7 +617,9 @@ file in an iOS Cordova project. For exam
</code></pre>
<h2>
-<a name="Plugin%20Specification_resource_file_and_header_file"><resource-file> and <header-file></a>
+<a name="Plugin%20Specification_resource_file_and_header_file">
+<resource-file> and <header-file>
+</a>
</h2>
<p>Like source files, but specifically for platforms such as iOS that
Modified: cordova/site/public/docs/jp/1.7.0/index.css
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/jp/1.7.0/index.css?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/jp/1.7.0/index.css (original)
+++ cordova/site/public/docs/jp/1.7.0/index.css Thu Aug 1 22:17:43 2013
@@ -412,7 +412,6 @@ Assumes table is 2D grid, with single TH
.compat .n::before { content: "\2718"; margin-right: 6px; }
.compat .p { background-color: gold; }
-.compat .p::before { content: "(partial)"; }
.compat .u { background-color: #dddddd; }
Modified: cordova/site/public/docs/jp/1.8.1/index.css
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/jp/1.8.1/index.css?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/jp/1.8.1/index.css (original)
+++ cordova/site/public/docs/jp/1.8.1/index.css Thu Aug 1 22:17:43 2013
@@ -412,7 +412,6 @@ Assumes table is 2D grid, with single TH
.compat .n::before { content: "\2718"; margin-right: 6px; }
.compat .p { background-color: gold; }
-.compat .p::before { content: "(partial)"; }
.compat .u { background-color: #dddddd; }
Modified: cordova/site/public/docs/jp/1.9.0/index.css
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/jp/1.9.0/index.css?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/jp/1.9.0/index.css (original)
+++ cordova/site/public/docs/jp/1.9.0/index.css Thu Aug 1 22:17:43 2013
@@ -412,7 +412,6 @@ Assumes table is 2D grid, with single TH
.compat .n::before { content: "\2718"; margin-right: 6px; }
.compat .p { background-color: gold; }
-.compat .p::before { content: "(partial)"; }
.compat .u { background-color: #dddddd; }
Modified: cordova/site/public/docs/jp/2.0.0/index.css
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/jp/2.0.0/index.css?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/jp/2.0.0/index.css (original)
+++ cordova/site/public/docs/jp/2.0.0/index.css Thu Aug 1 22:17:43 2013
@@ -412,7 +412,6 @@ Assumes table is 2D grid, with single TH
.compat .n::before { content: "\2718"; margin-right: 6px; }
.compat .p { background-color: gold; }
-.compat .p::before { content: "(partial)"; }
.compat .u { background-color: #dddddd; }
Modified: cordova/site/public/docs/jp/2.1.0/index.css
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/jp/2.1.0/index.css?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/jp/2.1.0/index.css (original)
+++ cordova/site/public/docs/jp/2.1.0/index.css Thu Aug 1 22:17:43 2013
@@ -412,7 +412,6 @@ Assumes table is 2D grid, with single TH
.compat .n::before { content: "\2718"; margin-right: 6px; }
.compat .p { background-color: gold; }
-.compat .p::before { content: "(partial)"; }
.compat .u { background-color: #dddddd; }
Modified: cordova/site/public/docs/jp/2.2.0/index.css
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/jp/2.2.0/index.css?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/jp/2.2.0/index.css (original)
+++ cordova/site/public/docs/jp/2.2.0/index.css Thu Aug 1 22:17:43 2013
@@ -412,7 +412,6 @@ Assumes table is 2D grid, with single TH
.compat .n::before { content: "\2718"; margin-right: 6px; }
.compat .p { background-color: gold; }
-.compat .p::before { content: "(partial)"; }
.compat .u { background-color: #dddddd; }
Modified: cordova/site/public/docs/kr/2.0.0/index.css
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/kr/2.0.0/index.css?rev=1509456&r1=1509455&r2=1509456&view=diff
==============================================================================
--- cordova/site/public/docs/kr/2.0.0/index.css (original)
+++ cordova/site/public/docs/kr/2.0.0/index.css Thu Aug 1 22:17:43 2013
@@ -412,7 +412,6 @@ Assumes table is 2D grid, with single TH
.compat .n::before { content: "\2718"; margin-right: 6px; }
.compat .p { background-color: gold; }
-.compat .p::before { content: "(partial)"; }
.compat .u { background-color: #dddddd; }