cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From marc...@apache.org
Subject docs commit: CB-6926 Clarify some misconceptions
Date Wed, 11 Jun 2014 21:15:55 GMT
Repository: cordova-docs
Updated Branches:
  refs/heads/master 1d5a84c0c -> 3062fdeac


CB-6926 Clarify some misconceptions

- Cordova does not provide any UI widgets or MV* frameworks
- plugins should have a unified JS interface
- no plugins are present in a newly-created project
- HTML5 app assets usually are local to the device instead of served remotely


Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/3062fdea
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/3062fdea
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/3062fdea

Branch: refs/heads/master
Commit: 3062fdeac44f1991d443cc48c46c1a804d6a0416
Parents: 1d5a84c
Author: Marcel Kinard <cmarcelk@gmail.com>
Authored: Wed Jun 11 17:14:15 2014 -0400
Committer: Marcel Kinard <cmarcelk@gmail.com>
Committed: Wed Jun 11 17:15:44 2014 -0400

----------------------------------------------------------------------
 docs/en/edge/guide/cli/index.md            |  8 +++++++-
 docs/en/edge/guide/hybrid/plugins/index.md |  7 +++++--
 docs/en/edge/guide/overview/index.md       | 20 +++++++++++++++-----
 3 files changed, 27 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3062fdea/docs/en/edge/guide/cli/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/cli/index.md b/docs/en/edge/guide/cli/index.md
index 23ef79c..dd35d24 100644
--- a/docs/en/edge/guide/cli/index.md
+++ b/docs/en/edge/guide/cli/index.md
@@ -303,7 +303,13 @@ example when designing a hybrid app that mixes a Cordova WebView with
 native components. (See Embedding WebViews and [Plugin Development
 Guide](guide_hybrid_plugins_index.md.html#Plugin%20Development%20Guide) for details.)  More
commonly, you would add a plugin to enable
 one of Cordova's basic device-level features
-detailed in the API Reference. A list of these plugins, including
+detailed in the API Reference. 
+
+As of version 3.0, when you create a Cordova project it does not have any
+plugins present. This is the new default behavior. Any plugins you desire,
+even the core plugins, must be explicitly added.
+
+A list of these plugins, including
 additional third-party plugins provided by the community, can be found
 in the registry at
 [plugins.cordova.io](http://plugins.cordova.io/). You can use

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3062fdea/docs/en/edge/guide/hybrid/plugins/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/hybrid/plugins/index.md b/docs/en/edge/guide/hybrid/plugins/index.md
index 6ab6b02..525d7cc 100644
--- a/docs/en/edge/guide/hybrid/plugins/index.md
+++ b/docs/en/edge/guide/hybrid/plugins/index.md
@@ -29,8 +29,11 @@ NFC communication, or to tailor calendar interfaces. There is a
 [registry](http://plugins.cordova.io) of available plugins.
 
 Plugins comprise a single JavaScript interface along with
-corresponding native code libraries for each supported platform.  This
-section steps through a simple _echo_ plugin that passes a string from
+corresponding native code libraries for each supported platform.  In essence
+this hides the various native code implementations behind a common
+JavaScript interface.
+
+This section steps through a simple _echo_ plugin that passes a string from
 JavaScript to the native platform and back, one that you can use as a
 model to build far more complex features.  This section discusses the
 basic plugin structure and the outward-facing JavaScript interface.

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/3062fdea/docs/en/edge/guide/overview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/overview/index.md b/docs/en/edge/guide/overview/index.md
index d995897..3b9828f 100644
--- a/docs/en/edge/guide/overview/index.md
+++ b/docs/en/edge/guide/overview/index.md
@@ -39,7 +39,7 @@ Use Apache Cordova if you are:
   distribution in various app store portals.
 
 * a mobile developer interested in mixing native application
-  components with a _WebView_ (browser window) that can access
+  components with a _WebView_ (special browser window) that can access
   device-level APIs, or if you want to develop a plugin interface
   between native and WebView components.
 
@@ -52,8 +52,8 @@ adheres to the W3C's
 [Packaged Web App](http://www.w3.org/TR/widgets/),
 or _widget_, specification.
 
-The application itself is implemented as a web page, named
-_index.html_ by default, that references whatever CSS, JavaScript,
+The application itself is implemented as a web page, by default a local
+file named _index.html_, that references whatever CSS, JavaScript,
 images, media files, or other resources are necessary for it to run.
 The app executes as a _WebView_ within the native application wrapper,
 which you distribute to app stores.
@@ -65,7 +65,8 @@ application components. (See Embedding WebViews for details.)
 
 A _plugin_ interface is available for Cordova and native components to
 communicate with each other. This enables you to invoke native code
-from JavaScript. As of version 3.0, plugins provide
+from JavaScript. Ideally, the JavaScript APIs to that native code are
+consistent across multiple device platforms. As of version 3.0, plugins provide
 bindings to standard device APIs.  Third-party plugins provide
 additional bindings to features not necessarily available on all
 platforms. You can find these third-party plugins in the
@@ -74,13 +75,22 @@ application. You can also develop your own plugins, as described in the
 Plugin Development Guide. Plugins may be necessary, for example, to
 communicate between Cordova and custom native components.
 
+__NOTE__: As of version 3.0, when you create a Cordova project it does not have
+any plugins present. This is the new default behavior. Any plugins you
+desire, even the core plugins, must be explicitly added.
+
+Cordova does not provide any UI widgets or MV* frameworks. Cordova provides
+only the runtime in which those can execute. If you wish to use UI widgets
+and/or an MV* framework, you will need to select those and include them in
+your application yourself as third-party material.
+
 ## Development Paths
 
 As of version 3.0, you can use two basic workflows to create a mobile
 app. While you can often use either workflow to accomplish the same
 task, they each offer advantages:
 
-- __Cross-platform workflow__: Use this workflow if you want your app
+- __Cross-platform (CLI) workflow__: Use this workflow if you want your app
   to run on as many different mobile operating systems as possible,
   with little need for platform-specific development.  This workflow
   centers around the `cordova` utility, otherwise known as the Cordova


Mime
View raw message