cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwbro...@apache.org
Subject [7/8] docs commit: [CB-3962] strip unnecessary C-heads; tune up storage section
Date Thu, 07 Nov 2013 21:08:50 GMT
[CB-3962] strip unnecessary C-heads; tune up storage section


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

Branch: refs/heads/master
Commit: 014fd2384ab27d131bbfc14e8e46e4b399f8609c
Parents: fcd6ee1
Author: Mike Sierra <msierra@adobe.com>
Authored: Wed Nov 6 11:47:13 2013 -0500
Committer: Michael Brooks <michael@michaelbrooks.ca>
Committed: Thu Nov 7 13:07:18 2013 -0800

----------------------------------------------------------------------
 docs/en/edge/cordova/storage/storage.md         | 38 ++++++++++----------
 .../edge/guide/platforms/android/upgrading.md   | 21 +++++------
 .../guide/platforms/blackberry/upgrading.md     |  2 +-
 .../guide/platforms/blackberry10/upgrading.md   |  8 ++---
 docs/en/edge/guide/platforms/ios/upgrading.md   |  4 +--
 5 files changed, 33 insertions(+), 40 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/014fd238/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 62ff508..f17a6bd 100644
--- a/docs/en/edge/cordova/storage/storage.md
+++ b/docs/en/edge/cordova/storage/storage.md
@@ -21,33 +21,29 @@ license: Licensed to the Apache Software Foundation (ASF) under one
 
 > An overview of storage options for Cordova.
 
-There are several storage APIs that are available to Cordova applications. 
+Several storage APIs are available for Cordova applications. 
 See
 [html5rocks](http://www.html5rocks.com/en/features/storage).
 for a more complete overview and examples.
 
 ## LocalStorage
 
-This API is provided by the underlying WebView implementations. It provides
-synchronous key/value pair storage. Refer to [the spec](http://www.w3.org/TR/webstorage/)
for more details.
+Also known as _web storage_, _simple storage_, or by its alternate
+_session storage_ interface, this API provides synchronous key/value
+pair storage, and is available in underlying WebView implementations.
+Refer to [the W3C spec](http://www.w3.org/TR/webstorage/) for details.
 
-### Platform Support
-
-- All of them :)
-
-### Windows Phone 7 Quirks
-
-Dot notation is _not_ available on Windows Phone 7. Be sure to use
-`setItem` or `getItem`, rather than accessing keys directly from the
-storage object, such as `window.localStorage.someKey`.
+__Windows Phone 7 Quirk__: Dot notation is _not_ available, so be sure
+to use `setItem` or `getItem` rather than access keys directly from
+the storage object, as in `window.localStorage.someKey`.
 
 ## WebSQL
 
-This API is provided by the underlying WebView.
+This API is available in the underlying WebView.
 The [Web SQL Database Specification](http://dev.w3.org/html5/webdatabase/)
 offers more full-featured database tables accessed via SQL queries.
 
-### Platform Support
+The following platforms support WebSQL:
 
 - Android
 - BlackBerry 10
@@ -56,15 +52,19 @@ offers more full-featured database tables accessed via SQL queries.
 
 ## IndexedDB
 
-This API is provided by the underlying WebView.
-[Indexed DB](http://www.w3.org/TR/IndexedDB/) offers more features than LocalStorage but
fewer than WebSQL.
+This API is available in the underlying WebView.
+[Indexed DB](http://www.w3.org/TR/IndexedDB/) offers more features
+than LocalStorage but fewer than WebSQL.
 
-### Platform Support
+The following platforms support IndexedDB:
 
 - Windows Phone 8
 - BlackBerry 10
 
 ## Plugin-Based Options
 
-* Most notably, the File API.
-* More storage options exist through [Cordova plugins](http://plugins.cordova.io/).
+In addition to the storage APIs listed above, the File API allows you
+to cache data on the local file system.  Other
+[Cordova plugins](http://plugins.cordova.io/) provide similar storage
+options.
+

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/014fd238/docs/en/edge/guide/platforms/android/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/android/upgrading.md b/docs/en/edge/guide/platforms/android/upgrading.md
index e29ff27..db8f1ed 100644
--- a/docs/en/edge/guide/platforms/android/upgrading.md
+++ b/docs/en/edge/guide/platforms/android/upgrading.md
@@ -229,12 +229,9 @@ Run `bin/update <project>` with the project path listed in the
Cordova Source di
 
 6. Copy the `res/xml/config.xml` to match `framework/res/xml/config.xml`.
 
-### Notes About the 2.0.0 Release
-
-The `config.xml` file will replace `cordova.xml` and `plugins.xml`.
-This new file is a combination of the previous two.  However, the old
-files are deprecated, and while currently still work, will cease
-working in a future release.
+In the 2.0.0 release, the `config.xml` file combines and replaces
+`cordova.xml` and `plugins.xml`.  The old files are deprecated, and
+while they still work in 2.0.0, will stop working in a future release.
 
 ## Upgrade to 1.9.0 from 1.8.1
 
@@ -250,13 +247,11 @@ working in a future release.
 
 6. Update `res/xml/plugins.xml` to match `framework/res/xml/plugins.xml`.
 
-### Notes About 1.9.0 Release
-
-Due to the introduction of the `CordovaWebView`, third-Party plugins
-may not work.  These plugins need to get a context from the
-`CordovaInterface` using `getContext()` or `getActivity()`.  If you
-are not an experienced Android developer, please contact the plugin
-maintainer and add this task to their bug tracker.
+Due to the introduction of the `CordovaWebView` in the 1.9.0 release,
+third-Party plugins may not work.  These plugins need to get a context
+from the `CordovaInterface` using `getContext()` or `getActivity()`.
+If you are not an experienced Android developer, please contact the
+plugin maintainer and add this task to their bug tracker.
 
 ## Upgrade to 1.8.0 from 1.8.0
 

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/014fd238/docs/en/edge/guide/platforms/blackberry/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/blackberry/upgrading.md b/docs/en/edge/guide/platforms/blackberry/upgrading.md
index 6ac33ac..c72231c 100644
--- a/docs/en/edge/guide/platforms/blackberry/upgrading.md
+++ b/docs/en/edge/guide/platforms/blackberry/upgrading.md
@@ -41,7 +41,7 @@ BlackBerry 10:
 
 6. Update the Cordova script reference in your `www/index.html` file (and any other files
that contain the script reference) to point to the new `cordova.js` file.
 
-### BlackBerryOS/Playbook
+For BlackBerryOS/Playbook:
 
 1. Download and extract the Cordova 2.9.0 source to a permanent location on your hard drive,
for example to `~/Cordova-2.9.0`.
 

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/014fd238/docs/en/edge/guide/platforms/blackberry10/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/blackberry10/upgrading.md b/docs/en/edge/guide/platforms/blackberry10/upgrading.md
index 6892155..9124c0f 100644
--- a/docs/en/edge/guide/platforms/blackberry10/upgrading.md
+++ b/docs/en/edge/guide/platforms/blackberry10/upgrading.md
@@ -76,7 +76,7 @@ Please note that the CLI supports the BlackBerry10 platform exclusively.
For Pla
 
 ## Upgrading 2.8.0 Projects to 2.9.0
 
-BlackBerry 10:
+For BlackBerry 10:
 
 1. Download and extract the Cordova 2.9.0 source to a permanent directory location on your
hard drive, for example to `~/Cordova-2.9.0`.
 
@@ -90,7 +90,7 @@ BlackBerry 10:
 
 6. Update the Cordova script reference in your `www/index.html` file (and any other files
that contain the script reference) to point to the new `cordova.js` file.
 
-### BlackBerryOS/Playbook
+For BlackBerryOS/Playbook:
 
 1. Download and extract the Cordova 2.9.0 source to a permanent directory location on your
hard drive, for example to `~/Cordova-2.9.0`.
 
@@ -112,8 +112,6 @@ BlackBerry 10:
 
 ## Upgrading 2.7.0 Projects to 2.8.0
 
-BlackBerry 10:
-
 BlackBerry 10 uses the new CLI tooling and manages core APIs as plugins. The instructions
migrate your project to a new project, rather than updating an existing project, due to the
complexity of updating an old project.
 Also note that the cordova js script file is now called 'cordova.js' and no longer contains
a version string.
 
@@ -129,7 +127,7 @@ Also note that the cordova js script file is now called 'cordova.js' and
no long
 
 6. Update the Cordova script reference in your `www/index.html` file (and any other files
that contain the script reference) to point to the new `cordova.js` file.
 
-BlackBerryOS/Playbook:
+For BlackBerryOS/Playbook:
 
 1. Download and extract the Cordova 2.8.0 source to a permanent directory location on your
hard drive, for example to `~/Cordova-2.8.0`.
 

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/014fd238/docs/en/edge/guide/platforms/ios/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/guide/platforms/ios/upgrading.md b/docs/en/edge/guide/platforms/ios/upgrading.md
index 0a83aeb..8acd150 100644
--- a/docs/en/edge/guide/platforms/ios/upgrading.md
+++ b/docs/en/edge/guide/platforms/ios/upgrading.md
@@ -41,7 +41,7 @@ For CLI projects:
 
 2. Run `cordova platform update ios`
         
-### iOS 7 Issues
+iOS 7 Issues:
 
 1. Remove `width=device-width, height=device-height` from the
    `index.html` file's `viewport` `meta` tag. (See [the relevent
@@ -50,7 +50,7 @@ For CLI projects:
 2. Update your media, media-capture and splashscreen core plugins for
    iOS 7 support.
 
-### Xcode 5 Issues
+Xcode 5 Issues:
 
 1. Update your Project Settings if Xcode 5 prompts you to do so (in the Issues Navigator).
 


Mime
View raw message