You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ra...@apache.org on 2016/05/16 21:17:45 UTC
svn commit: r1744142 [3/9] - in /cordova/site/public: ./ docs/en/6.x/
docs/en/6.x/config_ref/ docs/en/6.x/cordova/events/
docs/en/6.x/cordova/storage/ docs/en/6.x/guide/platforms/win8/
docs/en/6.x/plugin_ref/ docs/en/6.x/reference/cordova-cli/ docs/en/...
Modified: cordova/site/public/docs/en/6.x/cordova/events/events.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/6.x/cordova/events/events.html?rev=1744142&r1=1744141&r2=1744142&view=diff
==============================================================================
--- cordova/site/public/docs/en/6.x/cordova/events/events.html (original)
+++ cordova/site/public/docs/en/6.x/cordova/events/events.html Mon May 16 21:17:45 2016
@@ -2892,6 +2892,21 @@ back-button behavior.</p>
<span class="c1">// Handle the back button</span>
<span class="p">}</span>
</code></pre></div>
+<h3>Windows Quirks</h3>
+
+<p>Throw an error in a <code>backbutton</code> callback to force the default behavior, which is an app exit:</p>
+<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="nb">document</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span><span class="s1">'backbutton'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">evt</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nx">cordova</span><span class="p">.</span><span class="nx">platformId</span> <span class="o">!==</span> <span class="s1">'windows'</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">return</span><span class="p">;</span>
+ <span class="p">}</span>
+
+ <span class="k">if</span> <span class="p">(</span><span class="nb">window</span><span class="p">.</span><span class="nx">location</span><span class="p">.</span><span class="nx">href</span> <span class="o">!==</span> <span class="nx">firstPageUrl</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nb">window</span><span class="p">.</span><span class="nx">history</span><span class="p">.</span><span class="nx">back</span><span class="p">();</span>
+ <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
+ <span class="k">throw</span> <span class="k">new</span> <span class="nb">Error</span><span class="p">(</span><span class="s1">'Exit'</span><span class="p">);</span> <span class="c1">// This will suspend the app</span>
+ <span class="p">}</span>
+<span class="p">},</span> <span class="kc">false</span><span class="p">);</span>
+</code></pre></div>
<h2>menubutton</h2>
<p>The event fires when the user presses the menu button. Applying an event handler
Modified: cordova/site/public/docs/en/6.x/cordova/storage/storage.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/6.x/cordova/storage/storage.html?rev=1744142&r1=1744141&r2=1744142&view=diff
==============================================================================
--- cordova/site/public/docs/en/6.x/cordova/storage/storage.html (original)
+++ cordova/site/public/docs/en/6.x/cordova/storage/storage.html Mon May 16 21:17:45 2016
@@ -2904,12 +2904,10 @@ The main differences are:</p>
<p>It is available in the following variations:</p>
<ul>
-<li><strong><a href="https://github.com/litehelpers/Cordova-sqlite-storage/blob/core-master/README.md">cordova-sqlite-storage</a></strong> - core version that relies
-on native SQLite implementation. As such, it is only available for iOS
-and Android platforms.</li>
-<li><strong><a href="https://github.com/litehelpers/cordova-sqlite-ext/blob/ext-master/README.md">cordova-sqlite-ext</a></strong> - extended version with additional
-features including support for Windows and REGEXP support on Android and iOS.</li>
-<li><strong><a href="https://github.com/litehelpers/Cordova-sqlite-enterprise-free/blob/evfree-ext-rc/README.md">cordova-sqlite-evfree</a></strong> - similar to <em>cordova-sqlite-ext</em>
+<li><strong><a href="https://github.com/litehelpers/Cordova-sqlite-storage#readme">cordova-sqlite-storage</a></strong> - core version that includes its own sqlite3 implementation. It supports iOS, Android & Windows platforms.</li>
+<li><strong><a href="https://github.com/litehelpers/cordova-sqlite-ext#readme">cordova-sqlite-ext</a></strong> - extended version with additional
+features including REGEXP support on Android and iOS.</li>
+<li><strong><a href="https://github.com/litehelpers/Cordova-sqlite-enterprise-free#readme">cordova-sqlite-evfree</a></strong> - similar to <em>cordova-sqlite-ext</em>
but with improved memory handling. Available under GPL v3 or commercial license.</li>
</ul>
Modified: cordova/site/public/docs/en/6.x/guide/platforms/win8/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/6.x/guide/platforms/win8/index.html?rev=1744142&r1=1744141&r2=1744142&view=diff
==============================================================================
--- cordova/site/public/docs/en/6.x/guide/platforms/win8/index.html (original)
+++ cordova/site/public/docs/en/6.x/guide/platforms/win8/index.html Mon May 16 21:17:45 2016
@@ -2703,11 +2703,9 @@ Windows development environment on a Mac
<a href="http://www.visualstudio.com/downloads">Visual Studio</a> matching the version
requirements listed above.</p>
-<p><br/><p align="center"><img src="/static/img/guide/platforms/win8/win8_installSDK.png" /></p><br/></p>
+<p>The tools and SDKs for the target Windows platforms (UWP, 8.1, etc.) must also be selected in the installer. They can be found under the "Windows and Web Development" heading.</p>
-<p>For Windows 10, the Visual Studio installer has an option to install tools to
-build Universal Windows Apps. You must ensure that this option is selected
-when installing to install the required SDK.</p>
+<p><br/><p align="center"><img src="/static/img/guide/platforms/win8/win8_installTools.png" /></p><br/></p>
<h2>Project Configuration</h2>
Modified: cordova/site/public/docs/en/6.x/guide/platforms/win8/plugin.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/6.x/guide/platforms/win8/plugin.html?rev=1744142&r1=1744141&r2=1744142&view=diff
==============================================================================
--- cordova/site/public/docs/en/6.x/guide/platforms/win8/plugin.html (original)
+++ cordova/site/public/docs/en/6.x/guide/platforms/win8/plugin.html Mon May 16 21:17:45 2016
@@ -2693,7 +2693,7 @@ a Windows Store app for Windows 8.1 phon
</code></pre></div>
<p>The <code>echoplugin.js</code> file will forward the <code>echo</code> function call to this proxy through the <code>cordova.exec</code> command and execute this implementation.</p>
-<p>The plugin.xml file will have the settings required for our plugin. In this case, we want to add our <code>echoplugin.js</code> file in the <code>www</code> directory and the <code>echopluginProxy.js</code> file inside the <code>windows</code> source code of our application. Details of these elements can be found in the <a href="../../plugin_ref/spec.html">Plugin.xml</a> reference.</p>
+<p>The plugin.xml file will have the settings required for our plugin. In this case, we want to add our <code>echoplugin.js</code> file in the <code>www</code> directory and the <code>echopluginProxy.js</code> file inside the <code>windows</code> source code of our application. Details of these elements can be found in the <a href="../../../plugin_ref/spec.html">Plugin.xml</a> reference.</p>
<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span>
<span class="nt"><plugin</span> <span class="na">xmlns=</span><span class="s">"http://apache.org/cordova/ns/plugins/1.0"</span>
<span class="na">id=</span><span class="s">"echoplugin"</span>
Modified: cordova/site/public/docs/en/6.x/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/6.x/index.html?rev=1744142&r1=1744141&r2=1744142&view=diff
==============================================================================
--- cordova/site/public/docs/en/6.x/index.html (original)
+++ cordova/site/public/docs/en/6.x/index.html Mon May 16 21:17:45 2016
@@ -2665,7 +2665,7 @@
<li>
<h2><a href="config_ref/images.html">Customize icons</a></h2>
- <span class="summary">Learn how to customize icons for your Cordova app.</span>
+ <span class="summary">Learn how to customize icons for your Cordova application.</span>
</li>
Modified: cordova/site/public/docs/en/6.x/plugin_ref/plugman.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/6.x/plugin_ref/plugman.html?rev=1744142&r1=1744141&r2=1744142&view=diff
==============================================================================
--- cordova/site/public/docs/en/6.x/plugin_ref/plugman.html (original)
+++ cordova/site/public/docs/en/6.x/plugin_ref/plugman.html Mon May 16 21:17:45 2016
@@ -2694,7 +2694,7 @@ listed on the Platform guides page.</p>
<h2>Adding a Plugin</h2>
<p>Once you have installed Plugman and have created a Cordova project, you can start adding plugins to the platform with:</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="gp">$ </span>plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin <name|url|path> <span class="o">[</span>--plugins_dir <directory>] <span class="o">[</span>--www <directory>] <span class="o">[</span>--variable <name><span class="o">=</span><value> <span class="o">[</span>--variable <name><span class="o">=</span><value> ...]]
+<div class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="gp">$ </span>plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin <name|url|path> <span class="o">[</span>--plugins_dir <directory>] <span class="o">[</span>--www <directory>] <span class="o">[</span>--variable <name><span class="o">=</span><value> <span class="o">[</span>--variable <name><span class="o">=</span><value> ...]]
</code></pre></div>
<p>Using minimum parameters, this command installs a plugin into a cordova project. You must specify a platform and cordova project location for that platform. You also must specify a plugin, with the different <code>--plugin</code> parameter forms being:</p>
@@ -2714,8 +2714,8 @@ listed on the Platform guides page.</p>
<h2>Remove a Plugin</h2>
-<p>To uninstall a plugin, you simply pass the <code>--uninstall</code> flag and provide the plugin ID.</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="gp">$ </span>plugman --uninstall --platform <ios|android|blackberry10|wp8> --project <directory> --plugin <id> <span class="o">[</span>--www <directory>] <span class="o">[</span>--plugins_dir <directory>]
+<p>To uninstall a plugin, you simply pass the <code>uninstall</code> command and provide the plugin ID.</p>
+<div class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="gp">$ </span>plugman uninstall --platform <ios|android|blackberry10|wp8> --project <directory> --plugin <id> <span class="o">[</span>--www <directory>] <span class="o">[</span>--plugins_dir <directory>]
</code></pre></div>
<h2>Help Commands</h2>
@@ -2767,58 +2767,58 @@ platform, and reference the platform'
<ul>
<li><p>cordova-plugin-battery-status</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-battery-status
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-battery-status
</code></pre></div></li>
<li><p>cordova-plugin-camera</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-camera
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-camera
</code></pre></div></li>
<li><p>cordova-plugin-console</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-console
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-console
</code></pre></div></li>
<li><p>cordova-plugin-contacts</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-contacts
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-contacts
</code></pre></div></li>
<li><p>cordova-plugin-device</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-device
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-device
</code></pre></div></li>
<li><p>cordova-plugin-device-motion (accelerometer)</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-device-motion
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-device-motion
</code></pre></div></li>
<li><p>cordova-plugin-device-orientation (compass)</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-device-orientation
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-device-orientation
</code></pre></div></li>
<li><p>cordova-plugin-dialogs</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-dialogs
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-dialogs
</code></pre></div></li>
<li><p>cordova-plugin-file</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-file
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-file
</code></pre></div></li>
<li><p>cordova-plugin-file-transfer</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-file-transfer
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-file-transfer
</code></pre></div></li>
<li><p>cordova-plugin-geolocation</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-geolocation
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-geolocation
</code></pre></div></li>
<li><p>cordova-plugin-globalization</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-globalization
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-globalization
</code></pre></div></li>
<li><p>cordova-plugin-inappbrowser</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-inappbrowser
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-inappbrowser
</code></pre></div></li>
<li><p>cordova-plugin-media</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-media
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-media
</code></pre></div></li>
<li><p>cordova-plugin-media-capture</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-media-capture
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-media-capture
</code></pre></div></li>
<li><p>cordova-plugin-network-information</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-network-information
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-network-information
</code></pre></div></li>
<li><p>cordova-plugin-splashscreen</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-splashscreen
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-splashscreen
</code></pre></div></li>
<li><p>cordova-plugin-vibration</p>
-<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-vibration
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">plugman install --platform <ios|android|blackberry10|wp8> --project <directory> --plugin cordova-plugin-vibration
</code></pre></div></li>
</ul>
Modified: cordova/site/public/docs/en/6.x/plugin_ref/spec.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/6.x/plugin_ref/spec.html?rev=1744142&r1=1744141&r2=1744142&view=diff
==============================================================================
--- cordova/site/public/docs/en/6.x/plugin_ref/spec.html (original)
+++ cordova/site/public/docs/en/6.x/plugin_ref/spec.html Mon May 16 21:17:45 2016
@@ -2651,7 +2651,7 @@
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -2688,7 +2688,7 @@ for more information</p>
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -2717,21 +2717,21 @@ for more information</p>
</code></pre></div>
<p>Engine elements may also specify fuzzy matches using '>', '>=' etc. to avoid repetition, and to reduce maintenance when the underlying platform is updated.</p>
<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><engines></span>
- <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"cordova-android"</span> <span class="na">version=</span><span class="s">">=1.8.0"</span> <span class="nt">/></span>
+ <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"cordova-android"</span> <span class="na">version=</span><span class="s">"&gt;=1.8.0"</span> <span class="nt">/></span>
<span class="nt"></engines></span>
</code></pre></div>
<p>The <code><engine></code> tags also has default support for all of the main platforms Cordova exists on. Specifying the cordova engine tag means that all versions of Cordova on any platform must satisfy the engine version attribute. You may also list specific platforms and their versions in order to override the catch-all cordova engine:</p>
<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><engines></span>
- <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"cordova"</span> <span class="na">version=</span><span class="s">">=1.7.0"</span> <span class="nt">/></span>
- <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"cordova-android"</span> <span class="na">version=</span><span class="s">">=1.8.0"</span> <span class="nt">/></span>
- <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"cordova-ios"</span> <span class="na">version=</span><span class="s">">=1.7.1"</span> <span class="nt">/></span>
+ <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"cordova"</span> <span class="na">version=</span><span class="s">"&gt;=1.7.0"</span> <span class="nt">/></span>
+ <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"cordova-android"</span> <span class="na">version=</span><span class="s">"&gt;=1.8.0"</span> <span class="nt">/></span>
+ <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"cordova-ios"</span> <span class="na">version=</span><span class="s">"&gt;=1.7.1"</span> <span class="nt">/></span>
<span class="nt"></engines></span>
</code></pre></div>
<p>Custom frameworks example:</p>
<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><engines></span>
<span class="nt"><engine</span> <span class="na">name=</span><span class="s">"my_custom_framework"</span> <span class="na">version=</span><span class="s">"1.0.0"</span> <span class="na">platform=</span><span class="s">"android"</span> <span class="na">scriptSrc=</span><span class="s">"path_to_my_custom_framework_version"</span><span class="nt">/></span>
- <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"another_framework"</span> <span class="na">version=</span><span class="s">">0.2.0"</span> <span class="na">platform=</span><span class="s">"ios|android"</span> <span class="na">scriptSrc=</span><span class="s">"path_to_another_framework_version"</span><span class="nt">/></span>
- <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"even_more_framework"</span> <span class="na">version=</span><span class="s">">=2.2.0"</span> <span class="na">platform=</span><span class="s">"*"</span> <span class="na">scriptSrc=</span><span class="s">"path_to_even_more_framework_version"</span><span class="nt">/></span>
+ <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"another_framework"</span> <span class="na">version=</span><span class="s">"&gt;0.2.0"</span> <span class="na">platform=</span><span class="s">"ios|android"</span> <span class="na">scriptSrc=</span><span class="s">"path_to_another_framework_version"</span><span class="nt">/></span>
+ <span class="nt"><engine</span> <span class="na">name=</span><span class="s">"even_more_framework"</span> <span class="na">version=</span><span class="s">"&gt;=2.2.0"</span> <span class="na">platform=</span><span class="s">"*"</span> <span class="na">scriptSrc=</span><span class="s">"path_to_even_more_framework_version"</span><span class="nt">/></span>
<span class="nt"></engines></span>
</code></pre></div>
<h2>name</h2>
@@ -2775,7 +2775,7 @@ for more information</p>
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -2804,7 +2804,7 @@ for more information</p>
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -2833,7 +2833,7 @@ like. Any object not available on <code>
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -2856,7 +2856,7 @@ like. Any object not available on <code>
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -2888,7 +2888,7 @@ like. Any object not available on <code>
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -2924,7 +2924,7 @@ like. Any object not available on <code>
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -2945,7 +2945,7 @@ like. Any object not available on <code>
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -2958,12 +2958,12 @@ like. Any object not available on <code>
<td>A directory into which the files should be copied, relative to the root of the Cordova project. In practice, this is most important for Java-based platforms, where a file in the <code>com.alunny.foo</code> package must be located within the <code>com/alunny/foo</code> directory. For platforms where the source directory is not important, this attribute should be omitted.</td>
</tr>
<tr>
-<td>framework(boolean)</td>
-<td><em>Default: false</em> <br/> <mark>iOS</mark> <br/> If set to true, also adds the specified file as a framework to the project.</td>
+<td>framework(boolean) <br/> <mark>iOS</mark></td>
+<td><em>Default: false</em> <br/> If set to true, also adds the specified file as a framework to the project.</td>
</tr>
<tr>
-<td>compiler-flags(string)</td>
-<td><mark>iOS</mark> <br/> If set, assigns the specified compiler flags for the particular source file.</td>
+<td>compiler-flags(string) <br/> <mark>iOS</mark></td>
+<td>If set, assigns the specified compiler flags for the particular source file.</td>
</tr>
</tbody></table>
@@ -2981,7 +2981,7 @@ like. Any object not available on <code>
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -3006,7 +3006,7 @@ like. Any object not available on <code>
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -3019,16 +3019,16 @@ like. Any object not available on <code>
<td>Path to where the file will be copied in your directory.</td>
</tr>
<tr>
-<td>arch(string)</td>
-<td><mark>windows</mark> <br/> Allowed values: <code>x86</code>, <code>x64</code> or <code>ARM</code>. <br/> Indicates that the file should only be included when building for the specified architecture.</td>
+<td>arch(string) <br/> <mark>windows</mark></td>
+<td>Allowed values: <code>x86</code>, <code>x64</code> or <code>ARM</code>. <br/> Indicates that the file should only be included when building for the specified architecture.</td>
</tr>
<tr>
-<td>device-target</td>
-<td><mark>windows</mark> <br/> Allowed values: <code>win</code> (or <code>windows</code>), <code>phone</code> or <code>all</code>. <br/> Indicates that the file should only be included when building for the specified target device type.</td>
+<td>device-target <br/> <mark>windows</mark></td>
+<td>Allowed values: <code>win</code> (or <code>windows</code>), <code>phone</code> or <code>all</code>. <br/> Indicates that the file should only be included when building for the specified target device type.</td>
</tr>
<tr>
-<td>versions</td>
-<td><mark>windows</mark> <br/> Indicates that the file should only be included when building for versions that match the specified version string. Value can be any valid node semantic version range string.</td>
+<td>versions <br/> <mark>windows</mark></td>
+<td>Indicates that the file should only be included when building for versions that match the specified version string. Value can be any valid node semantic version range string.</td>
</tr>
</tbody></table>
@@ -3048,7 +3048,7 @@ The <code>config-file</code> element onl
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -3065,12 +3065,12 @@ The <code>config-file</code> element onl
<td>A prioritized list of accepted siblings after which to add the XML snippet. Useful for specifying changes in files which require strict ordering of XML elements like <a href="http://msdn.microsoft.com/en-us/library/windowsphone/develop/ff769509%28v=vs.105%29.aspx#BKMK_EXTENSIONSelement">this</a>.</td>
</tr>
<tr>
-<td>device-target(string)</td>
-<td><mark>windows</mark> <br/> Allowed values: <code>win</code>, <code>phone</code>, <code>all</code>. <br/> Applicable when affecting the meta-name <code>package.appxmanifest</code>, this attribute indicates that the file should only be modified when building for the specified target device type.</td>
+<td>device-target(string) <br/> <mark>windows</mark></td>
+<td>Allowed values: <code>win</code>, <code>phone</code>, <code>all</code>. <br/> Applicable when affecting the meta-name <code>package.appxmanifest</code>, this attribute indicates that the file should only be modified when building for the specified target device type.</td>
</tr>
<tr>
-<td>versions(string)</td>
-<td><mark>windows</mark> <br/> Applicable when affecting the meta-name <code>package.appxmanifest</code>, this attribute indicates that app manifests for specific Windows versions should only be altered for versions that match the specified version string. Value can be any valid node semantic version range string.</td>
+<td>versions(string) <br/> <mark>windows</mark></td>
+<td>Applicable when affecting the meta-name <code>package.appxmanifest</code>, this attribute indicates that app manifests for specific Windows versions should only be altered for versions that match the specified version string. Value can be any valid node semantic version range string.</td>
</tr>
</tbody></table>
@@ -3095,11 +3095,11 @@ The <code>config-file</code> element onl
<span class="nt"></config-file></span>
</code></pre></div>
<p>For windows-specific attributes:</p>
-<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><config-file</span> <span class="na">target=</span><span class="s">"package.appxmanifest"</span> <span class="na">parent=</span><span class="s">"/Package/Capabilities"</span> <span class="na">versions=</span><span class="s">"<8.1.0"</span><span class="nt">></span>
+<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><config-file</span> <span class="na">target=</span><span class="s">"package.appxmanifest"</span> <span class="na">parent=</span><span class="s">"/Package/Capabilities"</span> <span class="na">versions=</span><span class="s">"&lt;8.1.0"</span><span class="nt">></span>
<span class="nt"><Capability</span> <span class="na">Name=</span><span class="s">"picturesLibrary"</span> <span class="nt">/></span>
<span class="nt"><DeviceCapability</span> <span class="na">Name=</span><span class="s">"webcam"</span> <span class="nt">/></span>
<span class="nt"></config-file></span>
-<span class="nt"><config-file</span> <span class="na">target=</span><span class="s">"package.appxmanifest"</span> <span class="na">parent=</span><span class="s">"/Package/Capabilities"</span> <span class="na">versions=</span><span class="s">">=8.1.0"</span> <span class="na">device-target=</span><span class="s">"phone"</span><span class="nt">></span>
+<span class="nt"><config-file</span> <span class="na">target=</span><span class="s">"package.appxmanifest"</span> <span class="na">parent=</span><span class="s">"/Package/Capabilities"</span> <span class="na">versions=</span><span class="s">"&gt;=8.1.0"</span> <span class="na">device-target=</span><span class="s">"phone"</span><span class="nt">></span>
<span class="nt"><DeviceCapability</span> <span class="na">Name=</span><span class="s">"webcam"</span> <span class="nt">/></span>
<span class="nt"></config-file></span>
</code></pre></div>
@@ -3118,7 +3118,7 @@ The <code>config-file</code> element onl
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -3131,12 +3131,12 @@ The <code>config-file</code> element onl
<td>The architecture for which the <code>.so</code> file has been built, either <code>device</code> or <code>simulator</code>. <br/> For Windows, it indicates that the <code><SDKReference></code> should only be included when building for the specified architecture. Supported values are <code>x86</code>, <code>x64</code> or <code>ARM</code>.</td>
</tr>
<tr>
-<td>device-target(string)</td>
-<td><mark>windows</mark> <br/> Allowed values: <code>win</code> (or <code>windows</code>), <code>phone</code> or <code>all</code>. <br/> Indicates that the <code><SDKReference></code> should only be included when building for the specified target device type.</td>
+<td>device-target(string) <br/> <mark>windows</mark></td>
+<td>Allowed values: <code>win</code> (or <code>windows</code>), <code>phone</code> or <code>all</code>. <br/> Indicates that the <code><SDKReference></code> should only be included when building for the specified target device type.</td>
</tr>
<tr>
-<td>versions(string)</td>
-<td><mark>windows</mark> <br/> Indicates that the <code><SDKReference></code> should only be included when building for versions that match the specified version string. Value can be any valid node semantic version range string.</td>
+<td>versions(string) <br/> <mark>windows</mark></td>
+<td>Indicates that the <code><SDKReference></code> should only be included when building for versions that match the specified version string. Value can be any valid node semantic version range string.</td>
</tr>
</tbody></table>
@@ -3146,7 +3146,7 @@ The <code>config-file</code> element onl
</code></pre></div>
<p>For Windows:</p>
<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><lib-file</span> <span class="na">src=</span><span class="s">"Microsoft.WinJS.2.0, Version=1.0"</span> <span class="na">arch=</span><span class="s">"x86"</span> <span class="nt">/></span>
-<span class="nt"><lib-file</span> <span class="na">src=</span><span class="s">"Microsoft.WinJS.2.0, Version=1.0"</span> <span class="na">versions=</span><span class="s">">=8.1"</span> <span class="nt">/></span>
+<span class="nt"><lib-file</span> <span class="na">src=</span><span class="s">"Microsoft.WinJS.2.0, Version=1.0"</span> <span class="na">versions=</span><span class="s">"&gt;=8.1"</span> <span class="nt">/></span>
<span class="nt"><lib-file</span> <span class="na">src=</span><span class="s">"Microsoft.WinJS.2.0, Version=1.0"</span> <span class="na">target=</span><span class="s">"phone"</span> <span class="nt">/></span>
<span class="nt"><lib-file</span> <span class="na">src=</span><span class="s">"Microsoft.WinJS.2.0, Version=1.0"</span> <span class="na">target=</span><span class="s">"win"</span> <span class="na">versions=</span><span class="s">"8.0"</span> <span class="na">arch=</span><span class="s">"x86"</span> <span class="nt">/></span>
</code></pre></div>
@@ -3156,7 +3156,7 @@ The <code>config-file</code> element onl
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
@@ -3181,20 +3181,20 @@ The <code>config-file</code> element onl
<td><em>Default: .</em> <br/> Sets the relative path to the directory containing the sub-project to which to add the reference. The default, <code>.</code>, implies the application project.</td>
</tr>
<tr>
-<td>arch(string)</td>
-<td><mark>windows</mark> <br/> Allowed values: <code>x86</code>, <code>x64</code> or <code>ARM</code>. <br/> Indicates that the framework should only be included when building for the specified architecture.</td>
+<td>arch(string) <br/> <mark>windows</mark></td>
+<td>Allowed values: <code>x86</code>, <code>x64</code> or <code>ARM</code>. <br/> Indicates that the framework should only be included when building for the specified architecture.</td>
</tr>
<tr>
-<td>device-target(string)</td>
-<td><mark>windows</mark> <br/> Allowed values: <code>win</code> (or <code>windows</code>), <code>phone</code> or <code>all</code>. <br/> Indicates that the framework should only be included when building for the specified target device type.</td>
+<td>device-target(string) <br/> <mark>windows</mark></td>
+<td>Allowed values: <code>win</code> (or <code>windows</code>), <code>phone</code> or <code>all</code>. <br/> Indicates that the framework should only be included when building for the specified target device type.</td>
</tr>
<tr>
-<td>versions(string)</td>
-<td><mark>windows</mark> <br/> Indicates that the framework should only be included when building for versions that match the specified version string. Value can be any valid node semantic version range string.</td>
+<td>versions(string) <br/> <mark>windows</mark></td>
+<td>Indicates that the framework should only be included when building for versions that match the specified version string. Value can be any valid node semantic version range string.</td>
</tr>
<tr>
-<td>target-dir(string)</td>
-<td><mark>windows</mark> <br/> Indicates a subdirectory into which the framework should be copied. In practice, this is most important when plugin contains different framework versions for different chip architectures or device targets, but which have the same name. This allows you to specify different subfolders for each framework version so that they don't overlap each other.</td>
+<td>target-dir(string) <br/> <mark>windows</mark></td>
+<td>Indicates a subdirectory into which the framework should be copied. In practice, this is most important when plugin contains different framework versions for different chip architectures or device targets, but which have the same name. This allows you to specify different subfolders for each framework version so that they don't overlap each other.</td>
</tr>
</tbody></table>
@@ -3221,12 +3221,12 @@ The <code>config-file</code> element onl
</code></pre></div>
<p>Examples of using these Windows specific attributes:</p>
<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><framework</span> <span class="na">src=</span><span class="s">"src/windows/example.dll"</span> <span class="na">arch=</span><span class="s">"x64"</span> <span class="nt">/></span>
-<span class="nt"><framework</span> <span class="na">src=</span><span class="s">"src/windows/example.dll"</span> <span class="na">versions=</span><span class="s">">=8.0"</span> <span class="nt">/></span>
+<span class="nt"><framework</span> <span class="na">src=</span><span class="s">"src/windows/example.dll"</span> <span class="na">versions=</span><span class="s">"&gt;=8.0"</span> <span class="nt">/></span>
<span class="nt"><framework</span> <span class="na">src=</span><span class="s">"src/windows/example.vcxproj"</span> <span class="na">type=</span><span class="s">"projectReference"</span> <span class="na">target=</span><span class="s">"win"</span> <span class="nt">/></span>
<span class="nt"><framework</span> <span class="na">src=</span><span class="s">"src/windows/example.vcxproj"</span> <span class="na">type=</span><span class="s">"projectReference"</span> <span class="na">target=</span><span class="s">"all"</span> <span class="na">versions=</span><span class="s">"8.1"</span> <span class="na">arch=</span><span class="s">"x86"</span> <span class="nt">/></span>
<span class="nt"><framework</span> <span class="na">src=</span><span class="s">"src/windows/example.dll"</span> <span class="na">target-dir=</span><span class="s">"bin/x64"</span> <span class="na">arch=</span><span class="s">"x64"</span> <span class="na">custom=</span><span class="s">"true"</span><span class="nt">/></span>
</code></pre></div>
-info</h2>
+<h2>info</h2>
<p>Additional information provided to users. This is useful when you require extra steps that can't be easily automated or are beyond the CLI's scope. The contents of this tag gets printed out when the CLI installs the plugin.</p>
@@ -3265,17 +3265,18 @@ android.library.reference.1=PATH_TO_ANDR
<p>As seen in the previous section, sometimes plugin might require user to specify values for their variables. To make those variable mandatory, the <code><platform></code> tag needs to contain
a <code><preference></code> tag.
-The CLI checks that these required preferences are passed in. If not, it should warn the user how to pass the variable in and exit with a non-zero code.</p>
+The CLI checks that these required preferences are passed in. If not, it should warn the user how to pass the variable in and exit with a non-zero code.
+Preferences can be referenced elsewhere in <code>plugin.xml</code> using the syntax <code>$PREFERENCE_NAME</code>.</p>
<table><thead>
<tr>
-<th>Attributes(type)</th>
+<th>Attributes(type) <br/> <span class="sub-header">Only for platform:</span></th>
<th>Description</th>
</tr>
</thead><tbody>
<tr>
<td>name(string)</td>
-<td><em>Required</em> <br/> Name of the variable.</td>
+<td><em>Required</em> <br/> Name of the variable. Can only contain capital letters, digits, and underscores.</td>
</tr>
<tr>
<td>default(string)</td>
@@ -3284,7 +3285,14 @@ The CLI checks that these required prefe
</tbody></table>
<p>Example:</p>
-<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><preference</span> <span class="na">name=</span><span class="s">"API_KEY"</span> <span class="na">default=</span><span class="s">"default-value"</span> <span class="nt">/></span>
+<div class="highlight"><pre><code class="language-xml" data-lang="xml"><span class="nt"><preference</span> <span class="na">name=</span><span class="s">"MY_CUSTOM_STRING"</span> <span class="na">default=</span><span class="s">"default-value"</span> <span class="nt">/></span>
+
+<span class="c"><!--
+ The preference may be referenced elsewhere in plugin.xml like so:
+--></span>
+<span class="nt"><config-file</span> <span class="na">target=</span><span class="s">"./res/values/strings.xml"</span> <span class="na">parent=</span><span class="s">"/resources"</span><span class="nt">></span>
+ <span class="nt"><string</span> <span class="na">name=</span><span class="s">"custom"</span><span class="nt">></span>$MY_CUSTOM_STRING<span class="nt"></string></span>
+<span class="nt"></config-file></span>
</code></pre></div>
</div>
Modified: cordova/site/public/docs/en/6.x/reference/cordova-cli/index.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/6.x/reference/cordova-cli/index.html?rev=1744142&r1=1744141&r2=1744142&view=diff
==============================================================================
--- cordova/site/public/docs/en/6.x/reference/cordova-cli/index.html (original)
+++ cordova/site/public/docs/en/6.x/reference/cordova-cli/index.html Mon May 16 21:17:45 2016
@@ -2695,6 +2695,10 @@
<td>help <command></td>
<td>Get help for a command</td>
</tr>
+<tr>
+<td>telemetry</td>
+<td>Turn telemetry collection on or off</td>
+</tr>
</tbody></table>
<h2>Project Command List</h2>
@@ -2771,6 +2775,10 @@
<td>--nohooks</td>
<td>Suppress executing hooks (taking RegExp hook patterns as parameters)</td>
</tr>
+<tr>
+<td>--no-telemetry</td>
+<td>Disable telemetry collection for the current command.</td>
+</tr>
</tbody></table>
<h2>Platform-specific options</h2>
@@ -2786,8 +2794,12 @@ cordova create myApp com.myCompany.myApp
cd myApp
# Add camera plugin to the project and remember that in config.xml
cordova plugin add cordova-plugin-camera --save
+# Add camera plugin to the project and remember that in config.xml. Use npm install to fetch.
+cordova plugin add cordova-plugin-camera --save --fetch
# Add android platform to the project and remember that in config.xml
cordova platform add android --save
+# Add android platform to the project and remember that in config.xml. Use npm install to fetch.
+cordova platform add android --save --fetch
# Check to see if your system is configured for building android platform.
cordova requirements android
# Build the android and emit verbose logs.
@@ -2856,7 +2868,7 @@ cordova build android --release -- --key
<h3>Directory structure</h3>
-<p>A Cordova application created with <code>cordova-cli</code> will have the following directory structure:</p>
+<p>Cordova CLI works with the following directory structure:</p>
<div class="highlight"><pre><code class="language-" data-lang="">myapp/
|-- config.xml
|-- hooks/
@@ -2934,11 +2946,12 @@ www/
<h3>Syntax</h3>
<div class="highlight"><pre><code class="language-bash" data-lang="bash">cordova <span class="o">{</span>platform | platforms<span class="o">}</span> <span class="o">[</span>
- add <platform-spec> <span class="o">[</span>...] <span class="o">{</span>--save | <span class="nv">link</span><span class="o">=</span><path> <span class="o">}</span> |
- <span class="o">{</span>remove | rm<span class="o">}</span> platform <span class="o">[</span>...] |
+ add <platform-spec> <span class="o">[</span>...] <span class="o">{</span>--save | <span class="nv">link</span><span class="o">=</span><path> | --fetch <span class="o">}</span> |
+ <span class="o">{</span>remove | rm<span class="o">}</span> platform <span class="o">[</span>...] <span class="o">{</span>--save | --fetch<span class="o">}</span>|
<span class="o">{</span>list | ls<span class="o">}</span> |
check |
- save <span class="o">]</span>
+ save |
+ update <span class="o">]</span>
</code></pre></div>
<table><thead>
<tr>
@@ -2963,6 +2976,11 @@ www/
<td>When <code><platform-spec></code> is a local path, links the platform library directly instead of making a copy of it (support varies by platform; useful for platform development)</td>
</tr>
<tr>
+<td></td>
+<td>--fetch</td>
+<td>Fetches the platform using <code>npm install</code> and stores it into the apps <code>node_modules</code> directory</td>
+</tr>
+<tr>
<td>remove <code><platform></code> [...]</td>
<td></td>
<td>Remove specified platforms</td>
@@ -2973,6 +2991,11 @@ www/
<td>Delete specified platforms from <code>config.xml</code> after removing them</td>
</tr>
<tr>
+<td></td>
+<td>--fetch</td>
+<td>Removes the platform using <code>npm uninstall</code> and removes it from the apps <code>node_modules</code> directory</td>
+</tr>
+<tr>
<td>update <code>platform</code> [...]</td>
<td></td>
<td>Update specified platforms</td>
@@ -2983,6 +3006,11 @@ www/
<td>Updates the version specified in <code>config.xml</code></td>
</tr>
<tr>
+<td></td>
+<td>--fetch</td>
+<td>Fetches the platform using <code>npm install</code> and stores it into the apps <code>node_modules</code> directory</td>
+</tr>
+<tr>
<td>list</td>
<td></td>
<td>List all installed and available platforms</td>
@@ -3058,6 +3086,10 @@ www/
<li><p>Add pinned version of the <code>android</code> and <code>ios</code> platform and save the downloaded version to <code>config.xml</code>:</p>
<div class="highlight"><pre><code class="language-" data-lang="">cordova platform add android ios --save
</code></pre></div></li>
+<li><p>Add pinned version of the <code>android</code> and <code>ios</code> platform and save the downloaded version to <code>config.xml</code>. Install
+to the project using <code>npm install</code> and store it in the apps <code>node_modules</code> directory:</p>
+<div class="highlight"><pre><code class="language-" data-lang="">cordova platform add android ios --save --fetch
+</code></pre></div></li>
<li><p>Add <code>android</code> platform with <a href="http://semver.org/">semver</a> version ^5.0.0 and save it to <code>config.xml</code>:</p>
<div class="highlight"><pre><code class="language-" data-lang="">cordova platform add android@^5.0.0 --save
</code></pre></div></li>
@@ -3073,6 +3105,10 @@ www/
<li><p>Remove <code>android</code> platform from the project and from <code>config.xml</code>:</p>
<div class="highlight"><pre><code class="language-" data-lang="">cordova platform rm android --save
</code></pre></div></li>
+<li><p>Remove <code>android</code> platform from the project and from <code>config.xml</code>. Run <code>npm uninstall</code> to remove it
+from the <code>node_modules</code> directory.</p>
+<div class="highlight"><pre><code class="language-" data-lang="">cordova platform rm android --save --fetch
+</code></pre></div></li>
<li><p>List available and installed platforms with version numbers. This is useful to find version numbers when reporting issues:</p>
<div class="highlight"><pre><code class="language-" data-lang="">cordova platform ls
</code></pre></div></li>
@@ -3089,8 +3125,8 @@ www/
<h3>Syntax</h3>
<div class="highlight"><pre><code class="language-bash" data-lang="bash">cordova <span class="o">{</span>plugin | plugins<span class="o">}</span> <span class="o">[</span>
- add <plugin-spec> <span class="o">[</span>..] <span class="o">{</span>--searchpath<span class="o">=</span><directory> | --noregistry | --link | --save | --browserify | --force<span class="o">}</span> |
- <span class="o">{</span>remove | rm<span class="o">}</span> <span class="o">{</span><pluginid> | <name><span class="o">}</span> --save |
+ add <plugin-spec> <span class="o">[</span>..] <span class="o">{</span>--searchpath<span class="o">=</span><directory> | --noregistry | --link | --save | --browserify | --force | --fetch<span class="o">}</span> |
+ <span class="o">{</span>remove | rm<span class="o">}</span> <span class="o">{</span><pluginid> | <name><span class="o">}</span> --save --fetch |
<span class="o">{</span>list | ls<span class="o">}</span> |
search <span class="o">[</span><keyword>] |
save |
@@ -3111,7 +3147,7 @@ www/
<tr>
<td></td>
<td>--searchpath <code><directory></code></td>
-<td>When looking up plugins by ID, look in this directory and each of its subdirectories before hitting the registry. Multiple search paths can be specified. Use ':' as a separator in *nix based systems and ';' for Windows.</td>
+<td>When looking up plugins by ID, look in this directory and each of its subdirectories before hitting the registry. Multiple search paths can be specified. Use ':' as a separator in <code>*nix</code> based systems and ';' for Windows.</td>
</tr>
<tr>
<td></td>
@@ -3139,6 +3175,11 @@ www/
<td><em>Introduced in version 6.1.</em> Forces copying source files from the plugin even if the same file already exists in the target directory.</td>
</tr>
<tr>
+<td></td>
+<td>--fetch</td>
+<td>Fetches the plugin using <code>npm install</code> and stores it into the apps <code>node_modules</code> directory</td>
+</tr>
+<tr>
<td>remove `<pluginid></td>
<td><name>` [...]</td>
<td></td>
@@ -3149,6 +3190,11 @@ www/
<td>Remove the specified plugin from config.xml</td>
</tr>
<tr>
+<td></td>
+<td>--fetch</td>
+<td>Removes the plugin using <code>npm uninstall</code> and removes it from the apps <code>node_modules</code> directory</td>
+</tr>
+<tr>
<td>list</td>
<td></td>
<td>List currently installed plugins</td>
@@ -3168,7 +3214,7 @@ www/
<h3>Plugin-spec</h3>
<p>There are a number of ways to specify a plugin:</p>
-<div class="highlight"><pre><code class="language-" data-lang=""><plugin-spec> : pluginID[@version]|directory|url[#commit-ish][:subdir]
+<div class="highlight"><pre><code class="language-" data-lang=""><plugin-spec> : [@scope/]pluginID[@version]|directory|url[#commit-ish][:subdir]
</code></pre></div>
<table><thead>
<tr>
@@ -3177,6 +3223,10 @@ www/
</tr>
</thead><tbody>
<tr>
+<td>scope</td>
+<td>Scope of plugin published as a <a href="https://docs.npmjs.com/misc/scope">scoped npm package</a></td>
+</tr>
+<tr>
<td>plugin</td>
<td>Plugin id (id of plugin in npm registry or in --searchPath)</td>
</tr>
@@ -3198,7 +3248,7 @@ www/
</tr>
<tr>
<td>subdir</td>
-<td>Sub-directory to find plugin.xml for the specified plugin.</td>
+<td>Sub-directory to find plugin.xml for the specified plugin. (Doesn't work with <code>--fetch</code> option)</td>
</tr>
</tbody></table>
@@ -3223,6 +3273,9 @@ based on the following criteria (listed
<li><p>Add <code>cordova-plugin-camera</code> with <a href="http://semver.org/">semver</a> version ^2.0.0 and save it to <code>config.xml</code>:</p>
<div class="highlight"><pre><code class="language-" data-lang="">cordova plugin add cordova-plugin-camera@^2.0.0 --save
</code></pre></div></li>
+<li><p>Add <code>cordova-plugin-camera</code> with <a href="http://semver.org/">semver</a> version ^2.0.0 and <code>npm install</code> it. It will be stored in the <code>node_modules</code> directory:</p>
+<div class="highlight"><pre><code class="language-" data-lang="">cordova plugin add cordova-plugin-camera@^2.0.0 --fetch
+</code></pre></div></li>
<li><p>Clone the specified git repo, checkout to tag <code>2.1.0</code>, look for plugin.xml in the <code>plugin</code> directory, and add it to the project. Save the <code>plugin-spec</code> to <code>config.xml</code>:</p>
<div class="highlight"><pre><code class="language-" data-lang="">cordova plugin add https://github.com/apache/cordova-plugin-camera.git#2.1.0:plugin --save
</code></pre></div></li>
@@ -3235,6 +3288,9 @@ based on the following criteria (listed
<li><p>Remove the plugin from the project and the <code>config.xml</code>:</p>
<div class="highlight"><pre><code class="language-" data-lang="">cordova plugin rm camera --save
</code></pre></div></li>
+<li><p>Remove the plugin from the project and <code>npm uninstall</code> it. Removes it from the <code>node_modules</code> directory:</p>
+<div class="highlight"><pre><code class="language-" data-lang="">cordova plugin rm camera --fetch
+</code></pre></div></li>
<li><p>List all plugins installed in the project:</p>
<div class="highlight"><pre><code class="language-" data-lang="">cordova plugin ls
</code></pre></div></li>
@@ -3249,7 +3305,7 @@ copies plugin files for specified platfo
<h3>Syntax</h3>
<div class="highlight"><pre><code class="language-" data-lang="">cordova prepare [<platform> [..]]
- [--browserify]
+ [--browserify | --fetch]
</code></pre></div>
<h3>Options</h3>
@@ -3267,6 +3323,10 @@ copies plugin files for specified platfo
<td>--browserify</td>
<td>Compile plugin JS at build time using browserify instead of runtime.</td>
</tr>
+<tr>
+<td>--fetch</td>
+<td>When restoring plugins or platforms, fetch will <code>npm install</code> the missing modules.</td>
+</tr>
</tbody></table>
<h2>cordova compile command</h2>
@@ -3499,6 +3559,45 @@ base of your project.</p>
<h3>Syntax</h3>
<div class="highlight"><pre><code class="language-" data-lang="">cordova serve [port]
</code></pre></div>
+<h2>cordova telemetry command</h2>
+
+<h3>Synopsis</h3>
+
+<p>Turns telemetry collection on or off.</p>
+
+<h3>Syntax</h3>
+<div class="highlight"><pre><code class="language-" data-lang="">cordova telemetry [STATE]
+</code></pre></div>
+<table><thead>
+<tr>
+<th>Option</th>
+<th>Description</th>
+</tr>
+</thead><tbody>
+<tr>
+<td>on</td>
+<td>Turn telemetry collection on.</td>
+</tr>
+<tr>
+<td>off</td>
+<td>Turn telemetry collection off.</td>
+</tr>
+</tbody></table>
+
+<h3>Details</h3>
+
+<p>A timed prompt asking the user to opt-in or out is displayed the first time cordova is run.
+ It lasts for 30 seconds, after which the user is automatically opted-out if he doesn't provide any answer.
+ In CI environments, the <code>CI</code> environment variable can be set, which will prevent the prompt from showing up.
+ Telemetry collection can also be turned off on a single command by using the <code>--no-telemetry</code> flag.</p>
+
+<h3>Examples</h3>
+<div class="highlight"><pre><code class="language-" data-lang="">cordova telemetry on
+cordova telemetry off
+cordova build --no-telemetry
+</code></pre></div>
+<p>For details, see our privacy notice: https://cordova.apache.org/privacy</p>
+
<h2>cordova help command</h2>
<h3>Synopsis</h3>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org