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/07/30 20:02:27 UTC

[4/5] docs commit: [CB-3818] clarify diff storage specs; no plugin access

[CB-3818] clarify diff storage specs; no plugin access


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

Branch: refs/heads/master
Commit: 0929908011e88d471cd37fe6c470a2e9f7e46720
Parents: 8cb8b7c
Author: Mike Sierra <le...@gmail.com>
Authored: Tue Jul 30 12:36:54 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Tue Jul 30 11:02:07 2013 -0700

----------------------------------------------------------------------
 .../storage/localstorage/localstorage.md        | 16 +++++----
 docs/en/edge/cordova/storage/storage.md         | 36 +++++++++++++-------
 2 files changed, 34 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/09299080/docs/en/edge/cordova/storage/localstorage/localstorage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/localstorage/localstorage.md b/docs/en/edge/cordova/storage/localstorage/localstorage.md
index 8428966..66b3562 100644
--- a/docs/en/edge/cordova/storage/localstorage/localstorage.md
+++ b/docs/en/edge/cordova/storage/localstorage/localstorage.md
@@ -20,9 +20,11 @@ license: Licensed to the Apache Software Foundation (ASF) under one
 localStorage
 ===============
 
-Provides access to a [W3C Storage interface](http://dev.w3.org/html5/webstorage/#the-localstorage-attribute)
+Provides access to the W3C's
+[Web Storage interface](http://dev.w3.org/html5/webstorage/#the-localstorage-attribute)
 
-    var storage = window.localStorage;
+    var permanentStorage = window.localStorage;
+    var tempStorage = window.sessionStorage;
 
 Methods
 -------
@@ -40,10 +42,12 @@ Methods
 Details
 -----------
 
-The `window.localStorage` interface is based on the W3C Web Storage
-interface.  An app can use it to save persistent data using key-value
-pairs.  The `window.sessionStorage` interface works the same way, but
-all data is cleared each time the app closes.
+The `window.localStorage` interface implements the W3C's [Web Storage
+interface](http://dev.w3.org/html5/webstorage/).  An app can use it to
+save persistent data using key-value pairs.  The
+`window.sessionStorage` interface works the same way in every respect,
+except that all data is cleared each time the app closes. Each
+database provides a separate namespace.
 
 Supported Platforms
 -------------------

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/09299080/docs/en/edge/cordova/storage/storage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/storage/storage.md b/docs/en/edge/cordova/storage/storage.md
index 02d1fa4..0e93244 100644
--- a/docs/en/edge/cordova/storage/storage.md
+++ b/docs/en/edge/cordova/storage/storage.md
@@ -22,12 +22,22 @@ Storage
 
 > Provides access to the device's storage options.
 
-This API is based on the [W3C Web SQL Database
-Specification](http://dev.w3.org/html5/webdatabase/) and [W3C Web
-Storage API Specification](http://dev.w3.org/html5/webstorage/). Some
-devices already provide an implementation of these specifications, in
-which case the built-in support applies.  Cordova's implementation
-offers compatible support for those that don't.
+This API offers storage options based on two different W3C
+specifications:
+
+* The
+  [Web Storage API Specification](http://dev.w3.org/html5/webstorage/)
+  allows you to access data via simple key/value pairs.  See the
+  section on localStorage for complete details on this interface.
+
+* The
+  [Web SQL Database Specification](http://dev.w3.org/html5/webdatabase/)
+  offers more full-featured database tables accessed via SQL queries.
+  A summary of this interface appears immediately below.
+
+Cordova provides access to both interfaces for the minority of devices
+that don't already support them. Otherwise the built-in
+implementations apply.
 
 Methods
 -------
@@ -50,10 +60,17 @@ Objects
 - SQLResultSet
 - SQLResultSetRowList
 - SQLError
-- localStorage
 
 ## Accessing the Feature
 
+As of version 3.0, access to Storage APIs is built into Cordova, and
+does not require using the CLI to add plugins as described in The
+Command-line Interface.
+
+If you are using the older set of Cordova tools that precede the CLI,
+the following platform-specific configuration settings are still
+required:
+
 * Android (in `app/res/xml/config.xml`)
 
         <feature name="Storage">
@@ -64,8 +81,3 @@ Objects
 
         <feature id="blackberry.widgetcache" required="true" version="1.0.0.0" />
 
-* iOS (no special permissions required)
-
-* Windows Phone (no special permissions required)
-
-* Tizen (no special permissions required)