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/06/12 19:50:55 UTC
[20/46] docs commit: edits up to pause event
edits up to pause event
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/909bb286
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/909bb286
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/909bb286
Branch: refs/heads/master
Commit: 909bb286019838a559de6489e99f4a56e5cc7698
Parents: 6899777
Author: Mike Sierra <le...@gmail.com>
Authored: Wed May 15 12:58:05 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Wed May 15 12:58:05 2013 -0400
----------------------------------------------------------------------
docs/en/edge/cordova/events/events.backbutton.md | 2 +-
docs/en/edge/cordova/events/events.menubutton.md | 5 ++---
docs/en/edge/cordova/events/events.offline.md | 13 +++++++------
docs/en/edge/cordova/events/events.online.md | 14 ++++++++------
docs/en/edge/cordova/events/events.pause.md | 4 +++-
docs/en/edge/cordova/events/events.searchbutton.md | 2 +-
docs/en/edge/cordova/events/events.startcallbutton.md | 2 +-
.../en/edge/cordova/events/events.volumedownbutton.md | 2 +-
docs/en/edge/cordova/events/events.volumeupbutton.md | 3 ++-
.../cordova/file/directoryentry/directoryentry.md | 2 +-
docs/en/edge/cordova/file/fileentry/fileentry.md | 2 +-
docs/en/edge/cordova/file/filereader/filereader.md | 2 +-
docs/en/edge/cordova/file/filewriter/filewriter.md | 2 +-
.../edge/cordova/storage/localstorage/localstorage.md | 2 +-
14 files changed, 31 insertions(+), 26 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.backbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.backbutton.md b/docs/en/edge/cordova/events/events.backbutton.md
index 2041c96..46e6d84 100644
--- a/docs/en/edge/cordova/events/events.backbutton.md
+++ b/docs/en/edge/cordova/events/events.backbutton.md
@@ -31,7 +31,7 @@ To override the default back-button behavior, register an event
listener for the `backbutton` event, typically by calling
`document.addEventListener` once you receive the Cordova `deviceready`
event. It is no longer necessary to call any other method to override
-the back-button behaviour.
+the back-button behavior.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.menubutton.md b/docs/en/edge/cordova/events/events.menubutton.md
index 3f47e4f..661502f 100644
--- a/docs/en/edge/cordova/events/events.menubutton.md
+++ b/docs/en/edge/cordova/events/events.menubutton.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -27,8 +27,7 @@ The event fires when the user presses the menu button.
Details
-------
-If you need to override the default menu button behaviour you can
-register an event listener for the 'menubutton' event.
+Applying an event handler overrides the default menu button behavior.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.offline.md b/docs/en/edge/cordova/events/events.offline.md
index 19f47e5..62d41cb 100644
--- a/docs/en/edge/cordova/events/events.offline.md
+++ b/docs/en/edge/cordova/events/events.offline.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,14 +20,15 @@ license: Licensed to the Apache Software Foundation (ASF) under one
offline
===========
-This event fires when a Cordova application is offline (not connected to the Internet).
+The event fires when an application goes offline, and the device is
+not connected to the Internet.
document.addEventListener("offline", yourCallbackFunction, false);
Details
-------
-When the application's network connection changes to being offline, the offline event is fired.
+The event fires when the network connection is lost.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
@@ -91,12 +92,12 @@ Full Example
iOS Quirks
--------------------------
-During initial startup, the first offline event (if applicable) will take at least a second to fire.
+During initial startup, the first offline event (if applicable) takes at least a second to fire.
Windows Phone 7 Quirks
--------------------------
-When running in the Emulator, the connection.status of the device is always unknown, and this event will NOT fire.
+When running in the Emulator, the `connection.status` is always unknown, so this event does _not_ fire.
Windows Phone 8 Quirks
--------------------------
-Emulator reports connection type as Cellular, and it will not change, so events will NOT fire.
+The Emulator reports the connection type as `Cellular`, which does not change, so the event does _not_ fire.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.online.md b/docs/en/edge/cordova/events/events.online.md
index 20c4b52..7c49990 100644
--- a/docs/en/edge/cordova/events/events.online.md
+++ b/docs/en/edge/cordova/events/events.online.md
@@ -1,5 +1,5 @@
---
-license: Licensed to the Apache Software Foundation (ASF) under one
+ license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
@@ -20,14 +20,16 @@ license: Licensed to the Apache Software Foundation (ASF) under one
online
===========
-This event fires when a Cordova application is online (connected to the Internet).
+This event fires when a Cordova application goes online, and the
+device becomes connected to the Internet.
document.addEventListener("online", yourCallbackFunction, false);
Details
-------
-When the application's network connection changes to being online, the online event is fired.
+When the application's network connection changes to being online, the
+online event is fired.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
@@ -91,12 +93,12 @@ Full Example
iOS Quirks
--------------------------
-During initial startup, the first online event (if applicable) will take at least a second to fire.
+During initial startup, the first `online` event (if applicable) takes at least a second to fire.
Windows Phone 7 Quirks
--------------------------
-When running in the Emulator, the connection.status of the device is always unknown, and this event will NOT fire.
+When running in the Emulator, the `connection.status` is always unknown, so this event will _not_ fire.
Windows Phone 8 Quirks
--------------------------
-Emulator reports connection type as Cellular, and it will not change, so events will NOT fire.
+The Emulator reports the connection type as `Cellular`, which does not change, so events will _not_ fire.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.pause.md b/docs/en/edge/cordova/events/events.pause.md
index c30f847..3a5604d 100644
--- a/docs/en/edge/cordova/events/events.pause.md
+++ b/docs/en/edge/cordova/events/events.pause.md
@@ -27,7 +27,9 @@ This event fires when a Cordova application is put into the background.
Details
-------
-Cordova consists of two code bases: native and JavaScript. While the native code puts the application into the background the pause event is fired.
+Cordova consists of two code bases: native and JavaScript. When the
+native code puts the application into the background, the pause event
+fires.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.searchbutton.md b/docs/en/edge/cordova/events/events.searchbutton.md
index ba6cfe6..12b09b8 100644
--- a/docs/en/edge/cordova/events/events.searchbutton.md
+++ b/docs/en/edge/cordova/events/events.searchbutton.md
@@ -27,7 +27,7 @@ This event fires when the user presses the search button on Android.
Details
-------
-If you need to override the default search button behaviour on Android you can register an event listener for the 'searchbutton' event.
+If you need to override the default search button behavior on Android you can register an event listener for the 'searchbutton' event.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.startcallbutton.md b/docs/en/edge/cordova/events/events.startcallbutton.md
index 8369aeb..ca6ac46 100644
--- a/docs/en/edge/cordova/events/events.startcallbutton.md
+++ b/docs/en/edge/cordova/events/events.startcallbutton.md
@@ -27,7 +27,7 @@ This event fires when the user presses the start call button.
Details
-------
-If you need to override the default start call behaviour you can register an event listener for the 'startcallbutton' event.
+If you need to override the default start call behavior you can register an event listener for the 'startcallbutton' event.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.volumedownbutton.md b/docs/en/edge/cordova/events/events.volumedownbutton.md
index 46a151d..09c9d64 100644
--- a/docs/en/edge/cordova/events/events.volumedownbutton.md
+++ b/docs/en/edge/cordova/events/events.volumedownbutton.md
@@ -27,7 +27,7 @@ This event fires when the user presses the volume down button.
Details
-------
-If you need to override the default volume down behaviour you can register an event listener for the 'volumedownbutton' event.
+If you need to override the default volume down behavior you can register an event listener for the 'volumedownbutton' event.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.volumeupbutton.md b/docs/en/edge/cordova/events/events.volumeupbutton.md
index afac44e..1016303 100644
--- a/docs/en/edge/cordova/events/events.volumeupbutton.md
+++ b/docs/en/edge/cordova/events/events.volumeupbutton.md
@@ -27,7 +27,8 @@ This event fires when the user presses the volume up button.
Details
-------
-If you need to override the default volume up behaviour you can register an event listener for the 'volumeupbutton' event.
+If you need to override the default volume up behavior you can
+register an event listener for the 'volumeupbutton' event.
Applications typically should use `document.addEventListener` to
attach an event listener once the Cordova `deviceready` event fires.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryentry/directoryentry.md b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
index 24d2967..b7d4da8 100644
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@ -109,7 +109,7 @@ __Quick Example__
entry.setMetadata(success, fail, { "com.apple.MobileBackup": 1});
__iOS Quirk__
-- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to NOT enable the directory to be backed up by iCloud. Set the value to **0** to re-enable the directory to be backed up by iCloud.
+- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to _not_ enable the directory to be backed up by iCloud. Set the value to **0** to re-enable the directory to be backed up by iCloud.
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileentry/fileentry.md b/docs/en/edge/cordova/file/fileentry/fileentry.md
index b329d0c..b67bee2 100644
--- a/docs/en/edge/cordova/file/fileentry/fileentry.md
+++ b/docs/en/edge/cordova/file/fileentry/fileentry.md
@@ -105,7 +105,7 @@ __Quick Example__
entry.setMetadata(success, fail, { "com.apple.MobileBackup": 1});
__iOS Quirk__
-- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to NOT enable the file to be backed up by iCloud. Set the value to **0** to re-enable the file to be backed up by iCloud.
+- only the **"com.apple.MobileBackup"** extended attribute is supported. Set the value to **1** to _not_ enable the file to be backed up by iCloud. Set the value to **0** to re-enable the file to be backed up by iCloud.
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filereader/filereader.md b/docs/en/edge/cordova/file/filereader/filereader.md
index b06976c..3d44f20 100644
--- a/docs/en/edge/cordova/file/filereader/filereader.md
+++ b/docs/en/edge/cordova/file/filereader/filereader.md
@@ -29,7 +29,7 @@ Properties
- __result:__ The contents of the file that has been read. _(DOMString)_
- __error:__ An object containing errors. _(FileError)_
- __onloadstart:__ Called when the read starts. . _(Function)_
-- __onprogress:__ Called while reading the file, reports progress (progess.loaded/progress.total). _(Function)_ -NOT SUPPORTED
+- __onprogress:__ Called while reading the file, reports progress (progess.loaded/progress.total). _(Function)_ -_not_ SUPPORTED
- __onload:__ Called when the read has successfully completed. _(Function)_
- __onabort:__ Called when the read has been aborted. For instance, by invoking the abort() method. _(Function)_
- __onerror:__ Called when the read has failed. _(Function)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/docs/en/edge/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filewriter/filewriter.md b/docs/en/edge/cordova/file/filewriter/filewriter.md
index 704347b..fd62f5f 100644
--- a/docs/en/edge/cordova/file/filewriter/filewriter.md
+++ b/docs/en/edge/cordova/file/filewriter/filewriter.md
@@ -31,7 +31,7 @@ Properties
- __position:__ The current position of the file pointer. _(long)_
- __error:__ An object containing errors. _(FileError)_
- __onwritestart:__ Called when the write starts. . _(Function)_
-- __onprogress:__ Called while writing the file, reports progress (progress.loaded/progress.total). _(Function)_ -NOT SUPPORTED
+- __onprogress:__ Called while writing the file, reports progress (progress.loaded/progress.total). _(Function)_ -_not_ SUPPORTED
- __onwrite:__ Called when the request has completed successfully. _(Function)_
- __onabort:__ Called when the write has been aborted. For instance, by invoking the abort() method. _(Function)_
- __onerror:__ Called when the write has failed. _(Function)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/909bb286/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 837302b..df95ad2 100644
--- a/docs/en/edge/cordova/storage/localstorage/localstorage.md
+++ b/docs/en/edge/cordova/storage/localstorage/localstorage.md
@@ -117,4 +117,4 @@ Full Example
Windows Phone 7 Quirks
-------------
-- dot notation is NOT available on Windows Phone 7. Be sure to use : window.localStorage.setItem/getItem, and not the w3 spec defined calls to window.localStorage.someKey = 'someValue';
+- dot notation is _not_ available on Windows Phone 7. Be sure to use : window.localStorage.setItem/getItem, and not the w3 spec defined calls to window.localStorage.someKey = 'someValue';