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/11 02:11:18 UTC
[7/8] docs commit: Update documentation with standard STYLESHEET
guide.
Update documentation with standard STYLESHEET guide.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/39353f45
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/39353f45
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/39353f45
Branch: refs/heads/master
Commit: 39353f45763e799fd8fc9cf9827afa7215028108
Parents: ef7308b
Author: Mike Sierra <le...@gmail.com>
Authored: Wed Apr 24 12:30:40 2013 -0400
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Mon Jun 10 16:47:17 2013 -0700
----------------------------------------------------------------------
README.md | 4 +
STYLESHEET.md | 139 ++++++++
.../accelerometer/acceleration/acceleration.md | 8 +-
.../accelerometer/accelerometer.clearWatch.md | 8 +-
.../accelerometer.getCurrentAcceleration.md | 17 +-
.../edge/cordova/accelerometer/accelerometer.md | 4 +-
.../accelerometer.watchAcceleration.md | 30 +-
.../parameters/accelerometerError.md | 4 +-
.../parameters/accelerometerOptions.md | 6 +-
.../parameters/accelerometerSuccess.md | 6 +-
docs/en/edge/cordova/camera/camera.cleanup.md | 14 +-
.../en/edge/cordova/camera/camera.getPicture.md | 76 +++--
docs/en/edge/cordova/camera/camera.md | 2 +-
.../camera/parameter/CameraPopoverHandle.md | 4 +-
.../camera/parameter/CameraPopoverOptions.md | 27 +-
.../cordova/camera/parameter/cameraError.md | 4 +-
.../cordova/camera/parameter/cameraOptions.md | 49 ++-
.../cordova/camera/parameter/cameraSuccess.md | 6 +-
.../edge/cordova/compass/compass.clearWatch.md | 5 +-
.../cordova/compass/compass.clearWatchFilter.md | 4 +-
.../compass/compass.getCurrentHeading.md | 11 +-
docs/en/edge/cordova/compass/compass.md | 2 +-
.../cordova/compass/compass.watchHeading.md | 40 ++-
.../compass/compass.watchHeadingFilter.md | 2 +-
.../compass/compassError/compassError.md | 5 +-
.../cordova/compass/parameters/compassError.md | 4 +-
.../compass/parameters/compassHeading.md | 18 +-
.../compass/parameters/compassOptions.md | 10 +-
.../compass/parameters/compassSuccess.md | 5 +-
docs/en/edge/cordova/connection/connection.md | 6 +-
.../edge/cordova/connection/connection.type.md | 20 +-
.../en/edge/cordova/contacts/Contact/contact.md | 85 ++---
.../contacts/ContactAddress/contactaddress.md | 50 +--
.../contacts/ContactError/contactError.md | 7 +-
.../contacts/ContactField/contactfield.md | 41 ++-
.../ContactFindOptions/contactfindoptions.md | 10 +-
.../cordova/contacts/ContactName/contactname.md | 56 ++--
.../ContactOrganization/contactorganization.md | 44 +--
.../en/edge/cordova/contacts/contacts.create.md | 7 +-
docs/en/edge/cordova/contacts/contacts.find.md | 34 +-
docs/en/edge/cordova/contacts/contacts.md | 2 +-
.../cordova/contacts/parameters/contactError.md | 4 +-
.../contacts/parameters/contactFields.md | 4 +-
.../contacts/parameters/contactFindOptions.md | 17 +-
.../contacts/parameters/contactSuccess.md | 9 +-
docs/en/edge/cordova/device/device.cordova.md | 12 +-
docs/en/edge/cordova/device/device.md | 2 +-
docs/en/edge/cordova/device/device.model.md | 29 +-
docs/en/edge/cordova/device/device.name.md | 32 +-
docs/en/edge/cordova/device/device.platform.md | 21 +-
docs/en/edge/cordova/device/device.uuid.md | 30 +-
docs/en/edge/cordova/device/device.version.md | 12 +-
.../en/edge/cordova/events/events.backbutton.md | 12 +-
.../cordova/events/events.batterycritical.md | 24 +-
.../en/edge/cordova/events/events.batterylow.md | 23 +-
.../edge/cordova/events/events.batterystatus.md | 29 +-
.../edge/cordova/events/events.deviceready.md | 21 +-
.../edge/cordova/events/events.endcallbutton.md | 9 +-
docs/en/edge/cordova/events/events.md | 2 +-
.../en/edge/cordova/events/events.menubutton.md | 8 +-
docs/en/edge/cordova/events/events.offline.md | 7 +-
docs/en/edge/cordova/events/events.online.md | 7 +-
docs/en/edge/cordova/events/events.pause.md | 13 +-
docs/en/edge/cordova/events/events.resume.md | 19 +-
.../edge/cordova/events/events.searchbutton.md | 5 +-
.../cordova/events/events.startcallbutton.md | 5 +-
.../cordova/events/events.volumedownbutton.md | 5 +-
.../cordova/events/events.volumeupbutton.md | 5 +-
.../file/directoryentry/directoryentry.md | 16 +-
.../file/directoryreader/directoryreader.md | 3 +-
.../en/edge/cordova/file/fileentry/fileentry.md | 16 +-
.../en/edge/cordova/file/fileerror/fileerror.md | 4 +-
docs/en/edge/cordova/file/fileobj/fileobj.md | 1 -
.../edge/cordova/file/filereader/filereader.md | 8 +-
.../cordova/file/filetransfer/filetransfer.md | 16 +-
.../file/fileuploadoptions/fileuploadoptions.md | 3 +-
.../file/fileuploadresult/fileuploadresult.md | 2 +-
.../edge/cordova/file/filewriter/filewriter.md | 4 +-
.../file/localfilesystem/localfilesystem.md | 1 -
.../geolocation/Coordinates/coordinates.md | 4 +-
.../cordova/geolocation/Position/position.md | 2 +-
.../geolocation/geolocation.clearWatch.md | 5 +-
.../geolocation.getCurrentPosition.md | 5 +-
docs/en/edge/cordova/geolocation/geolocation.md | 1 -
.../geolocation/geolocation.watchPosition.md | 1 -
.../GlobalizationError/globalizationerror.md | 2 +-
.../globalization/globalization.dateToString.md | 4 +-
.../globalization.getCurrencyPattern.md | 3 +-
.../globalization/globalization.getDateNames.md | 2 -
.../globalization.getFirstDayOfWeek.md | 1 -
.../globalization.getLocaleName.md | 4 +-
.../globalization.getNumberPattern.md | 3 +-
.../globalization.getPreferredLanguage.md | 2 -
.../globalization/globalization.stringToDate.md | 6 +-
.../globalization.stringToNumber.md | 2 -
.../edge/cordova/inappbrowser/inappbrowser.md | 5 +-
.../en/edge/cordova/inappbrowser/window.open.md | 6 +-
.../edge/cordova/media/MediaError/mediaError.md | 1 -
docs/en/edge/cordova/media/capture/CaptureCB.md | 2 +-
.../edge/cordova/media/capture/CaptureError.md | 2 +-
.../cordova/media/capture/ConfigurationData.md | 7 +-
.../media/capture/MediaFile.getFormatData.md | 6 +-
.../edge/cordova/media/capture/MediaFileData.md | 10 +-
docs/en/edge/cordova/media/capture/capture.md | 3 +-
.../edge/cordova/media/capture/captureAudio.md | 10 +-
.../edge/cordova/media/capture/captureImage.md | 13 +-
.../edge/cordova/media/capture/captureVideo.md | 12 +-
.../cordova/media/media.getCurrentPosition.md | 13 +-
docs/en/edge/cordova/media/media.getDuration.md | 12 +-
docs/en/edge/cordova/media/media.md | 3 +-
docs/en/edge/cordova/media/media.pause.md | 14 +-
docs/en/edge/cordova/media/media.play.md | 13 +-
docs/en/edge/cordova/media/media.release.md | 11 +-
docs/en/edge/cordova/media/media.seekTo.md | 12 +-
docs/en/edge/cordova/media/media.startRecord.md | 12 +-
docs/en/edge/cordova/media/media.stop.md | 13 +-
docs/en/edge/cordova/media/media.stopRecord.md | 12 +-
.../cordova/notification/notification.beep.md | 2 +-
.../notification/notification.confirm.md | 1 -
.../edge/cordova/splashscreen/splashscreen.md | 2 -
.../edge/cordova/storage/database/database.md | 6 +-
.../storage/localstorage/localstorage.md | 3 +-
.../storage/sqlresultset/sqlresultset.md | 6 +-
.../sqlresultsetrowlist/sqlresultsetrowlist.md | 2 +-
.../storage/sqltransaction/sqltransaction.md | 4 +-
docs/en/edge/guide/command-line/index.md | 81 +++--
docs/en/edge/guide/cordova-webview/android.md | 54 +--
docs/en/edge/guide/cordova-webview/index.md | 4 +-
docs/en/edge/guide/cordova-webview/ios.md | 69 ++--
.../edge/guide/getting-started/android/index.md | 81 +++--
.../en/edge/guide/getting-started/bada/index.md | 51 ++-
.../guide/getting-started/blackberry/index.md | 42 +--
docs/en/edge/guide/getting-started/index.md | 4 +-
docs/en/edge/guide/getting-started/ios/index.md | 180 +++++-----
.../edge/guide/getting-started/symbian/index.md | 21 +-
.../edge/guide/getting-started/tizen/index.md | 27 +-
.../edge/guide/getting-started/webos/index.md | 20 +-
.../guide/getting-started/windows-8/index.md | 33 +-
.../getting-started/windows-phone-7/index.md | 56 ++--
.../getting-started/windows-phone-8/index.md | 80 ++---
docs/en/edge/guide/overview/apis.md | 25 ++
docs/en/edge/guide/overview/index.md | 50 +++
docs/en/edge/guide/overview/primer.md | 22 ++
docs/en/edge/guide/overview/support.html | 302 +++++++++++++++++
docs/en/edge/guide/overview/support.md | 324 ++++++++++++++++++
.../guide/plugin-development/android/index.md | 72 ++--
.../edge/guide/plugin-development/bada/index.md | 14 +-
.../plugin-development/blackberry/index.md | 113 ++++---
docs/en/edge/guide/plugin-development/index.md | 56 ++--
.../edge/guide/plugin-development/ios/index.md | 89 +++--
.../plugin-development/windows-phone/index.md | 39 ++-
.../guide/project-settings/android/index.md | 4 +-
.../edge/guide/project-settings/bada/index.md | 4 +-
.../guide/project-settings/blackberry/index.md | 8 +-
.../guide/project-settings/firefoxos/index.md | 2 +-
docs/en/edge/guide/project-settings/index.md | 19 +-
.../en/edge/guide/project-settings/ios/index.md | 4 +-
.../edge/guide/project-settings/webos/index.md | 4 +-
.../guide/project-settings/windows8/index.md | 2 +-
.../en/edge/guide/project-settings/wp7/index.md | 4 +-
.../en/edge/guide/project-settings/wp8/index.md | 2 +-
docs/en/edge/guide/upgrading/android/index.md | 16 -
docs/en/edge/guide/upgrading/bada/index.md | 11 +-
.../en/edge/guide/upgrading/blackberry/index.md | 9 +-
docs/en/edge/guide/upgrading/index.md | 2 -
docs/en/edge/guide/upgrading/ios/index.md | 335 +++++++++----------
docs/en/edge/guide/upgrading/webos/index.md | 6 +-
.../edge/guide/upgrading/windows-phone/index.md | 2 -
docs/en/edge/guide/whitelist/index.md | 36 +-
169 files changed, 2452 insertions(+), 1508 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 3bcd4e0..dc736e4 100644
--- a/README.md
+++ b/README.md
@@ -82,6 +82,10 @@ __5. Customizing HTML template__
Each language can override the default template in `template/docs/LANGUAGE`.
+### Editorial Guidelines
+
+Please see the `STYLESHEET.md` file for guildelines on language and usage.
+
Generating the Documentation
----------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/STYLESHEET.md
----------------------------------------------------------------------
diff --git a/STYLESHEET.md b/STYLESHEET.md
new file mode 100644
index 0000000..c2e8170
--- /dev/null
+++ b/STYLESHEET.md
@@ -0,0 +1,139 @@
+---
+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
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+---
+
+# Style Sheet
+
+Before adding or editing documentation, please review these basic
+editorial guidelines.
+
+## In-line Font Formatting
+
+* Use `monospace` for all-purpose nouns used in programming, e.g.: API
+ interfaces, methods, properties, literal values, Unix commands, etc.
+
+* Use __bold__ for on-screen items, such as the names of menu items,
+ buttons, and check boxes.
+
+* Use _italics_ for emphasis, pathnames, filenames, simple
+ mathematical expressions, variable items (e.g., _x_/_y_
+ coordinates).
+
+* Do _not_ use ALL CAPS for emphasis. (Exception: in commented code)
+
+* Do _not_ use "quote characters" to deliniate in-line text unless
+ required as part of a value. E.g., not OK to refer to the
+ "text-align" property. OK to set the CSS `text-align` property to
+ `left`, and the `content` property to `"This is some text."`
+ (Exception: within code comments)
+
+* Do not combine in-line formatting such as _`monospace italic`_.
+
+## Language
+
+* Use present tense. "This happens," not "this will happen." (Future
+ tense sounds like a tenuous prediction.)
+
+* Passive voice is to be avoided. E.g., "the pause event fires
+ when..." rather than "the pause event is fired when..."
+
+* Prefer action verbs over weak verbs like "is" or "has."
+
+* Minimize verbs ending with "ing": "This is necessary to provide...",
+ not "This is necessary for providing..."
+
+* Do not drop articles: "In the Bada IDE", not "In Bada IDE"
+
+* Possessives are OK: "the device's home screen" rather than clumsier:
+ "the home screen of the device"
+
+* Hyphenate adjective phrases: "command-line tools", but not when it's
+ a noun, as in "the command line."
+
+* Use serial comma: this, that, and the other.
+
+* Do not start a sentence with a lowercase member name.
+
+* Do not refer to "I," the author of the documentation, as in "What I
+ am going to show you now." Likewise avoid "we," as in "We see
+ that..."
+
+* OK to refer to "you," the developer, but it should be minimized.
+ E.g., instead of "...for which you need to invoke the `Contact.save`
+ method", try "...for which the `Contact.save` method is required."
+
+## Usage
+
+* "User" may refer to the end user, not to the application's
+ developer. Refer to plural "users" as "they" to avoid singular
+ he/she pronoun problems.
+
+* 'Directory', not 'folder'; may be exceptions in some GUI contexts
+
+* 'Press' a button on the screen; 'type' a key; do not 'hit' either.
+
+* 'Set up' as verb, 'setup' as noun.
+
+* 'Handheld' not 'hand held'
+
+* 'JavaScript' (but lowercase when MIME type)
+
+* Remove superfluous "navigate to" wherever possible, unless you need
+ to `cd` to a particular directory to launch a command. Instead of
+ "Navigate to the D directory and edit the F file," prefer: "Edit the
+ _D/F_ file."
+
+* An XML/HTML 'element' rather than 'tag'
+
+* It's a "method" when called on an object. Refer to "function" only
+ when unspecified, e.g. a "callback function" may also be implemented
+ as an object method.
+
+* Use parentheses when referring to `method()` and `function()` names.
+ (Exception: when assigning a reference to the object rather than
+ calling it as a method.)
+
+## Punctuation
+
+* Append colon to text that introduces a code snippet, image, or
+ procedure listing.
+
+* Use `&rarr;` arrow entities (→) for hierarchical menus or
+ sequences of nested dialog boxes.
+
+* Add periods at end of bullet items when they consist of complete
+ sentences. No periods when bullets are sentence fragments. However,
+ bullet lists should be internally consistent.
+
+## Miscellaneous
+
+* For procedure lists, don't break out separate items for (1) do this,
+ followed by (2) this describes what just happened. Prefer (1) Do
+ this. It does so-and-so, which you might see in some result. (2) Do
+ that...
+
+* Bold & all-cap __NOTE:__, with colon inside, always at the start of
+ a paragraph, never mid-paragraph. Do not incorporate font change
+ into sentences as in "__Note__ that..." but OK to start a sentence:
+ "Note that..." when the information is less consequential.
+
+* As an alternative to __NOTE:__, use __WARNING:__ for serious
+ matters, or __TIP:__ to pass along useful tricks or context.
+
+* Use titles in link text, never 'click here'
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
index 9b81fe8..1a2b8e8 100644
--- a/docs/en/edge/cordova/accelerometer/acceleration/acceleration.md
+++ b/docs/en/edge/cordova/accelerometer/acceleration/acceleration.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
@@ -33,7 +33,10 @@ Properties
Description
-----------
-This object is created and populated by Cordova, and returned by an `Accelerometer` method. The x, y, z acceleration values include the effect of gravity (9.81 m/s^2), so at when a device is lying flat on a table facing up, the value returned should be x=0, y=0, z=9.81.
+This object is created and populated by Cordova, and returned by an
+`Accelerometer` method. Acceleration values include the effect of
+gravity (9.81 m/s^2), so that when a device lies flat and facing up,
+_x_, _y_, and _z_ values returned should be `0`, `0`, and `9.81`.
Supported Platforms
-------------------
@@ -47,7 +50,6 @@ Supported Platforms
- Tizen
- Windows 8
-
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
index 54e34fe..148dbce 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.clearWatch.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,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
accelerometer.clearWatch
========================
-Stop watching the `Acceleration` referenced by the watch ID parameter.
+Stop watching the `Acceleration` referenced by the `watchID` parameter.
navigator.accelerometer.clearWatch(watchID);
@@ -88,14 +88,14 @@ Full Example
watchID = null;
}
}
-
+
// onSuccess: Get a snapshot of the current acceleration
//
function onSuccess(acceleration) {
var element = document.getElementById('accelerometer');
element.innerHTML = 'Acceleration X: ' + acceleration.x + '<br />' +
'Acceleration Y: ' + acceleration.y + '<br />' +
- 'Acceleration Z: ' + acceleration.z + '<br />' +
+ 'Acceleration Z: ' + acceleration.z + '<br />' +
'Timestamp: ' + acceleration.timestamp + '<br />';
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
index ba2c701..8f0b0f5 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.getCurrentAcceleration.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,16 +20,19 @@ license: Licensed to the Apache Software Foundation (ASF) under one
accelerometer.getCurrentAcceleration
====================================
-Get the current acceleration along the x, y, and z axis.
+Get the current acceleration along the _x_, _y_, and _z_ axes.
navigator.accelerometer.getCurrentAcceleration(accelerometerSuccess, accelerometerError);
Description
-----------
-The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current device orientation. The accelerometer can detect 3D movement along the x, y, and z axis.
+The accelerometer is a motion sensor that detects the change (_delta_)
+in movement relative to the current device orientation, in three
+dimensions along the _x_, _y_, and _z_ axis.
-The acceleration is returned using the `accelerometerSuccess` callback function.
+These acceleration values are returned to the `accelerometerSuccess`
+callback function.
Supported Platforms
-------------------
@@ -101,10 +104,10 @@ Full Example
<p>getCurrentAcceleration</p>
</body>
</html>
-
+
iPhone Quirks
-------------
-- iPhone doesn't have the concept of getting the current acceleration at any given point.
+- iPhone doesn't recognize the concept of getting the current acceleration at any given point.
- You must watch the acceleration and capture the data at given time intervals.
-- Thus, the `getCurrentAcceleration` function will give you the last value reported from a Cordova `watchAccelerometer` call.
+- Thus, the `getCurrentAcceleration` function yields the last value reported from a Cordova `watchAccelerometer` call.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/accelerometer/accelerometer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.md b/docs/en/edge/cordova/accelerometer/accelerometer.md
index 3f68d04..c578dbf 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.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,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Accelerometer
=============
-> Captures device motion in the x, y, and z direction.
+> Captures device motion in the _x_, _y_, and _z_ direction.
Methods
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
index 985105a..7f117d6 100644
--- a/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.md
+++ b/docs/en/edge/cordova/accelerometer/accelerometer.watchAcceleration.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,20 +20,28 @@ license: Licensed to the Apache Software Foundation (ASF) under one
accelerometer.watchAcceleration
===============================
-At a regular interval, get the acceleration along the x, y, and z axis.
+At a regular interval, get the acceleration along the _x_, _y_, and _z_ axis.
var watchID = navigator.accelerometer.watchAcceleration(accelerometerSuccess,
accelerometerError,
[accelerometerOptions]);
-
+
Description
-----------
-The accelerometer is a motion sensor that detects the change (delta) in movement relative to the current position. The accelerometer can detect 3D movement along the x, y, and z axis.
+The accelerometer is a motion sensor that detects the change (delta)
+in movement relative to the current position. The accelerometer can
+detect 3D movement along the _x_, _y_, and _z_ axis.
-The `accelerometer.watchAcceleration` gets the device's current acceleration at a regular interval. Each time the `Acceleration` is retrieved, the `accelerometerSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `acceleratorOptions` object.
+The `accelerometer.watchAcceleration` method retrieves the device's
+current `Acceleration` at a regular interval, executing the
+`accelerometerSuccess` callback function each time. Specify the
+interval in milliseconds via the `acceleratorOptions` object's
+`frequency` parameter.
-The returned watch ID references the accelerometer watch interval. The watch ID can be used with `accelerometer.clearWatch` to stop watching the accelerometer.
+The returned watch ID references the accelerometer's watch interval,
+and can be used with `accelerometer.clearWatch` to stop watching the
+accelerometer.
Supported Platforms
-------------------
@@ -129,10 +137,12 @@ Full Example
<div id="accelerometer">Waiting for accelerometer...</div>
</body>
</html>
-
+
iPhone Quirks
-------------
-- At the interval requested, Cordova will call the success callback function and pass the accelerometer results.
-- However, in requests to the device Cordova restricts the interval to minimum of every 40ms and a maximum of every 1000ms.
- - For example, if you request an interval of 3 seconds (3000ms), Cordova will request an interval of 1 second from the device but invoke the success callback at the requested interval of 3 seconds.
+- Cordova calls the success callback function at the interval
+ requested, but restricts the range of requests to the device between
+ 40ms and 1000ms. For example, if you request an interval of 3
+ seconds, (3000ms), Cordova requests data from the device every 1
+ second, but only executes the success callback every 3 seconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md b/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
index c908c16..5faf51e 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerError.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
@@ -24,4 +24,4 @@ onError callback function for acceleration functions.
function() {
// Handle the error
- }
\ No newline at end of file
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md b/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
index 197f416..f52c045 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerOptions.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,9 +20,9 @@ license: Licensed to the Apache Software Foundation (ASF) under one
accelerometerOptions
====================
-An optional parameter to customize the retrieval of the accelerometer.
+An optional parameter to customize the retrieval of accelerometer values.
Options
-------
-- __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
\ No newline at end of file
+- __frequency:__ How often to retrieve the `Acceleration` in milliseconds. _(Number)_ (Default: 10000)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md b/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
index 277fca8..9cdcdf7 100644
--- a/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.md
+++ b/docs/en/edge/cordova/accelerometer/parameters/accelerometerSuccess.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,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
accelerometerSuccess
====================
-onSuccess callback function that provides the Acceleration information.
+onSuccess callback function that provides the `Acceleration` information.
function(acceleration) {
// Do something
@@ -39,4 +39,4 @@ Example
'Acceleration Y: ' + acceleration.y + '\n' +
'Acceleration Z: ' + acceleration.z + '\n' +
'Timestamp: ' + acceleration.timestamp + '\n');
- };
\ No newline at end of file
+ };
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/camera/camera.cleanup.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.cleanup.md b/docs/en/edge/cordova/camera/camera.cleanup.md
index fbf9e13..5d5e700 100644
--- a/docs/en/edge/cordova/camera/camera.cleanup.md
+++ b/docs/en/edge/cordova/camera/camera.cleanup.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,26 +20,28 @@ license: Licensed to the Apache Software Foundation (ASF) under one
camera.cleanup
=================
-Cleans up the image files that were taken by the camera, that were stored in a temporary storage location.
+Cleans up the photos taken by the camera and made available in a
+temporary storage location.
navigator.camera.cleanup( cameraSuccess, cameraError );
Description
-----------
-Cleans up the image files stored in the temporary storage location, when the function `camera.getPicture` is used with `Camera.sourceType = Camera.PictureSourceType.CAMERA` and `Camera.destinationType = Camera.DestinationType.FILE_URI`
-
+Cleans up the image files stored in the temporary storage location
+after calling `camera.getPicture`. Applies only when the value of
+`Camera.sourceType` equals `Camera.PictureSourceType.CAMERA` and the
+`Camera.destinationType` equals `Camera.DestinationType.FILE_URI`.
Supported Platforms
-------------------
- iOS
-
Example
-------------
- navigator.camera.cleanup(onSuccess, onFail);
+ navigator.camera.cleanup(onSuccess, onFail);
function onSuccess() {
console.log("Camera cleanup success.")
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/camera/camera.getPicture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.getPicture.md b/docs/en/edge/cordova/camera/camera.getPicture.md
index 181bb87..a27aace 100644
--- a/docs/en/edge/cordova/camera/camera.getPicture.md
+++ b/docs/en/edge/cordova/camera/camera.getPicture.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,31 +20,49 @@ license: Licensed to the Apache Software Foundation (ASF) under one
camera.getPicture
=================
-Takes a photo using the camera or retrieves a photo from the device's album.
-The image is passed to the success callback as a base64 encoded `String` or as the URI of an image file.
-The method itself returns a CameraPopoverHandle object, which can be used to reposition the file selection popover.
+Takes a photo using the camera, or retrieves a photo from the device's
+image gallery. The image is passed to the success callback as a
+base64-encoded `String`, or as the URI for the image file. The method
+itself returns a `CameraPopoverHandle` object that can be used to
+reposition the file selection popover.
navigator.camera.getPicture( cameraSuccess, cameraError, [ cameraOptions ] );
Description
-----------
-Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `Camera.sourceType = Camera.PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your application is restored.
+The `camera.getPicture` function opens the device's default camera
+application that allows the user to take a picture. This behavior
+occurs by default, when `Camera.sourceType` equals
+`Camera.PictureSourceType.CAMERA`. Once the photo is taken, the
+camera application closes and the application is restored.
-If `Camera.sourceType = Camera.PictureSourceType.PHOTOLIBRARY` or `Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a photo chooser dialog is shown, from which a photo from the album can be selected. A `CameraPopoverHandle` object, which can be used to reposition the photo chooser dialog (eg. when the device orientation changes) is returned by `camera.getPicture`.
+If `Camera.sourceType` is `Camera.PictureSourceType.PHOTOLIBRARY` or
+`Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a dialog displays
+that allows users to select an existing image. The
+`camera.getPicture` function returns a `CameraPopoverHandle` object,
+which can be used to reposition the image selection dialog, for
+example, when the device orientation changes.
-The return value will be sent to the `cameraSuccess` function, in one of the following formats, depending on the `cameraOptions` you specify:
+The return value is sent to the `cameraSuccess` callback function, in
+one of the following formats, depending on the specified
+`cameraOptions`:
-- A `String` containing the Base64 encoded photo image.
+- A `String` containing the base64-encoded photo image.
- A `String` representing the image file location on local storage (default).
-You can do whatever you want with the encoded image or URI, for example:
+You can do whatever you want with the encoded image or URI, for
+example:
-- Render the image in an `<img>` tag _(see example below)_
+- Render the image in an `<img>` tag, as in the example below
- Save the data locally (`LocalStorage`, [Lawnchair](http://brianleroux.github.com/lawnchair/), etc)
- Post the data to a remote server
-__Note:__ The image quality of pictures taken using the camera on newer devices is quite good, and images from the Photo Album will not be downscaled to a lower quality, even if a quality parameter is specified. ___Encoding such images using Base64 has caused memory issues on many newer devices. Therefore, using FILE\_URI as the 'Camera.destinationType' is highly recommended.___
+**NOTE:** Photo resolution on newer devices is quite good. Photos
+selected from the device's gallery are not downscaled to a lower
+quality, even if a `quality` parameter is specified. To avoid common
+memory problems, set `Camera.destinationType` to `FILE_URI` rather
+than `DATA_URL`.
Supported Platforms
-------------------
@@ -61,9 +79,12 @@ Supported Platforms
iOS Quirks
----------
-Including a JavaScript alert() in either of the callback functions can cause problems. Wrap the alert in a setTimeout() to allow the iOS image picker or popover to fully close before the alert is displayed:
+Including a JavaScript `alert()` in either of the callback functions
+can cause problems. Wrap the alert within a `setTimeout()` to allow
+the iOS image picker or popover to fully close before the alert
+displays:
- setTimeout(function() {
+ setTimeout(function() {
// do your thing here!
}, 0);
@@ -71,21 +92,23 @@ Windows Phone 7 Quirks
----------------------
Invoking the native camera application while your device is connected
-via Zune will not work, and the error callback will be triggered.
+via Zune does not work, and triggers an error callback.
Tizen Quirks
----------------------
-Only 'destinationType: Camera.DestinationType.FILE_URI' and 'sourceType: Camera.PictureSourceType.PHOTOLIBRARY' are supported.
+Tizen only supports a `destinationType` of
+`Camera.DestinationType.FILE_URI` and a `sourceType` of
+`Camera.PictureSourceType.PHOTOLIBRARY`.
Quick Example
-------------
-Take photo and retrieve Base64-encoded image:
+Take a photo and retrieve it as a base64-encoded image:
navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
destinationType: Camera.DestinationType.DATA_URL
- });
+ });
function onSuccess(imageData) {
var image = document.getElementById('myImage');
@@ -96,10 +119,10 @@ Take photo and retrieve Base64-encoded image:
alert('Failed because: ' + message);
}
-Take photo and retrieve image file location:
+Take a photo and retrieve the image's file location:
- navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
- destinationType: Camera.DestinationType.FILE_URI });
+ navigator.camera.getPicture(onSuccess, onFail, { quality: 50,
+ destinationType: Camera.DestinationType.FILE_URI });
function onSuccess(imageURI) {
var image = document.getElementById('myImage');
@@ -110,7 +133,6 @@ Take photo and retrieve image file location:
alert('Failed because: ' + message);
}
-
Full Example
------------
@@ -123,7 +145,7 @@ Full Example
<script type="text/javascript" charset="utf-8">
var pictureSource; // picture source
- var destinationType; // sets the format of returned value
+ var destinationType; // sets the format of returned value
// Wait for Cordova to connect with the device
//
@@ -139,7 +161,7 @@ Full Example
// Called when a photo is successfully retrieved
//
function onPhotoDataSuccess(imageData) {
- // Uncomment to view the base64 encoded image data
+ // Uncomment to view the base64-encoded image data
// console.log(imageData);
// Get image handle
@@ -159,7 +181,7 @@ Full Example
// Called when a photo is successfully retrieved
//
function onPhotoURISuccess(imageURI) {
- // Uncomment to view the image file URI
+ // Uncomment to view the image file URI
// console.log(imageURI);
// Get image handle
@@ -187,7 +209,7 @@ Full Example
// A button will call this function
//
function capturePhotoEdit() {
- // Take picture using device camera, allow edit, and retrieve image as base64-encoded string
+ // Take picture using device camera, allow edit, and retrieve image as base64-encoded string
navigator.camera.getPicture(onPhotoDataSuccess, onFail, { quality: 20, allowEdit: true,
destinationType: destinationType.DATA_URL });
}
@@ -196,13 +218,13 @@ Full Example
//
function getPhoto(source) {
// Retrieve image file location from specified source
- navigator.camera.getPicture(onPhotoURISuccess, onFail, { quality: 50,
+ navigator.camera.getPicture(onPhotoURISuccess, onFail, { quality: 50,
destinationType: destinationType.FILE_URI,
sourceType: source });
}
// Called if something bad happens.
- //
+ //
function onFail(message) {
alert('Failed because: ' + message);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/camera.md b/docs/en/edge/cordova/camera/camera.md
index 5ec1f4e..103a7a8 100644
--- a/docs/en/edge/cordova/camera/camera.md
+++ b/docs/en/edge/cordova/camera/camera.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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md b/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
index 94ab149..180e83f 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverHandle.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
@@ -38,7 +38,7 @@ setPosition
Set the position of the popover.
__Parameters:__
-- cameraPopoverOptions - the CameraPopoverOptions specifying the new position
+- `cameraPopoverOptions`: the `CameraPopoverOptions` that specify the new position
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
index 6314e8a..25118c2 100644
--- a/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/CameraPopoverOptions.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,9 +20,11 @@ license: Licensed to the Apache Software Foundation (ASF) under one
CameraPopoverOptions
====================
-Parameters only used by iOS to specify the anchor element location and arrow direction of popover used on iPad when selecting images from the library or album.
+iOS-only parameters that specify the anchor element location and arrow
+direction of the popover when selecting images from an iPad's library
+or album.
- { x : 0,
+ { x : 0,
y : 32,
width : 320,
height : 480,
@@ -32,16 +34,16 @@ Parameters only used by iOS to specify the anchor element location and arrow dir
CameraPopoverOptions
--------------------
-- __x:__ x pixel coordinate of element on the screen to anchor popover onto. (`Number`)
+- __x:__ x pixel coordinate of screen element onto which to anchor the popover. (`Number`)
-- __y:__ y pixel coordinate of element on the screen to anchor popover onto. (`Number`)
+- __y:__ y pixel coordinate of screen element onto which to anchor the popover. (`Number`)
-- __width:__ width, in pixels, of the element on the screen to anchor popover onto. (`Number`)
+- __width:__ width, in pixels, of the screen element onto which to anchor the popover. (`Number`)
-- __height:__ height, in pixels, of the element on the screen to anchor popover onto. (`Number`)
+- __height:__ height, in pixels, of the screen element onto which to anchor the popover. (`Number`)
+
+- __arrowDir:__ Direction the arrow on the popover should point. Defined in `Camera.PopoverArrowDirection` (`Number`)
-- __arrowDir:__ Direction the arrow on the popover should point. Defined in Camera.PopoverArrowDirection (`Number`)
-
Camera.PopoverArrowDirection = {
ARROW_UP : 1, // matches iOS UIPopoverArrowDirection constants
ARROW_DOWN : 2,
@@ -49,8 +51,11 @@ CameraPopoverOptions
ARROW_RIGHT : 8,
ARROW_ANY : 15
};
-
-Note that the size of the popover may change to adjust to the direction of the arrow and orientation of the screen. Make sure to account for orientation changes when specifying the anchor element location.
+
+Note that the size of the popover may change to adjust to the
+direction of the arrow and orientation of the screen. Make sure to
+account for orientation changes when specifying the anchor element
+location.
Quick Example
-------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/camera/parameter/cameraError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraError.md b/docs/en/edge/cordova/camera/parameter/cameraError.md
index 7ee091b..1460a8e 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraError.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraError.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
@@ -29,4 +29,4 @@ onError callback function that provides an error message.
Parameters
----------
-- __message:__ The message is provided by the device's native code. (`String`)
\ No newline at end of file
+- __message:__ The message is provided by the device's native code. (`String`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraOptions.md b/docs/en/edge/cordova/camera/parameter/cameraOptions.md
index 9059536..0414446 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraOptions.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraOptions.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
@@ -37,15 +37,15 @@ Options
- __quality:__ Quality of saved image. Range is [0, 100]. (`Number`)
-- __destinationType:__ Choose the format of the return value. Defined in navigator.camera.DestinationType (`Number`)
+- __destinationType:__ Choose the format of the return value. Defined in `navigator.camera.DestinationType` (`Number`)
Camera.DestinationType = {
- DATA_URL : 0, // Return image as base64 encoded string
- FILE_URI : 1, // Return image file URI
- NATIVE_URI : 2 // Return image native URI (eg. assets-library:// on iOS or content:// on Android)
+ DATA_URL : 0, // Return image as base64-encoded string
+ FILE_URI : 1, // Return image file URI
+ NATIVE_URI : 2 // Return image native URI (e.g. assets-library:// on iOS or content:// on Android)
};
-- __sourceType:__ Set the source of the picture. Defined in nagivator.camera.PictureSourceType (`Number`)
+- __sourceType:__ Set the source of the picture. Defined in `navigator.camera.PictureSourceType` (`Number`)
Camera.PictureSourceType = {
PHOTOLIBRARY : 0,
@@ -55,39 +55,39 @@ Options
- __allowEdit:__ Allow simple editing of image before selection. (`Boolean`)
-- __encodingType:__ Choose the encoding of the returned image file. Defined in navigator.camera.EncodingType (`Number`)
+- __encodingType:__ Choose the returned image file's encoding. Defined in `navigator.camera.EncodingType` (`Number`)
Camera.EncodingType = {
JPEG : 0, // Return JPEG encoded image
PNG : 1 // Return PNG encoded image
};
-- __targetWidth:__ Width in pixels to scale image. Must be used with targetHeight. Aspect ratio is maintained. (`Number`)
-- __targetHeight:__ Height in pixels to scale image. Must be used with targetWidth. Aspect ratio is maintained. (`Number`)
+- __targetWidth:__ Width in pixels to scale image. Must be used with __targetHeight__. Aspect ratio remains constant. (`Number`)
+- __targetHeight:__ Height in pixels to scale image. Must be used with __targetWidth__. Aspect ratio remains constant. (`Number`)
-- __mediaType:__ Set the type of media to select from. Only works when PictureSourceType is PHOTOLIBRARY or SAVEDPHOTOALBUM. Defined in nagivator.camera.MediaType (`Number`)
+- __mediaType:__ Set the type of media to select from. Only works when `PictureSourceType` is `PHOTOLIBRARY` or `SAVEDPHOTOALBUM`. Defined in `nagivator.camera.MediaType` (`Number`)
Camera.MediaType = {
- PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
- VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI
- ALLMEDIA : 2 // allow selection from all media types
+ PICTURE: 0, // allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType
+ VIDEO: 1, // allow selection of video only, WILL ALWAYS RETURN FILE_URI
+ ALLMEDIA : 2 // allow selection from all media types
};
- __correctOrientation:__ Rotate the image to correct for the orientation of the device during capture. (`Boolean`)
- __saveToPhotoAlbum:__ Save the image to the photo album on the device after capture. (`Boolean`)
-- __popoverOptions:__ iOS only options to specify popover location in iPad. Defined in CameraPopoverOptions.
-- __cameraDirection:__ Choose the camera to use (front- or back-facing). Defined in navigator.camera.Direction (`Number`)
+- __popoverOptions:__ iOS-only options that specify popover location in iPad. Defined in `CameraPopoverOptions`.
+- __cameraDirection:__ Choose the camera to use (front- or back-facing). Defined in `navigator.camera.Direction` (`Number`)
Camera.Direction = {
- BACK : 0, // Use the back-facing camera
- FRONT : 1 // Use the front-facing camera
+ BACK : 0, // Use the back-facing camera
+ FRONT : 1 // Use the front-facing camera
};
Android Quirks
--------------
- Ignores the `allowEdit` parameter.
-- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album.
+- `Camera.PictureSourceType.PHOTOLIBRARY` and `Camera.PictureSourceType.SAVEDPHOTOALBUM` both display the same photo album.
BlackBerry Quirks
-----------------
@@ -95,9 +95,9 @@ BlackBerry Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- Application must have key injection permissions to close native Camera application after photo is taken.
-- Using Large image sizes may result in inability to encode image on later model devices with high resolution cameras (e.g. Torch 9800).
-- Camera.MediaType is not supported.
+- Application must have key injection permissions to close the native Camera application after the user snaps the photo.
+- Using large image sizes may result in the inability to encode images on later-model devices (e.g. Torch 9800) that feature high-resolution cameras.
+- `Camera.MediaType` is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `cameraDirection` parameter.
@@ -107,7 +107,7 @@ webOS Quirks
- Ignores the `quality` parameter.
- Ignores the `sourceType` parameter.
- Ignores the `allowEdit` parameter.
-- Camera.MediaType is not supported.
+- `Camera.MediaType` is not supported.
- Ignores the `correctOrientation` parameter.
- Ignores the `saveToPhotoAlbum` parameter.
- Ignores the `cameraDirection` parameter.
@@ -115,9 +115,8 @@ webOS Quirks
iOS Quirks
--------------
-- Set `quality` below 50 to avoid memory error on some devices.
-- When `destinationType.FILE_URI` is used, photos are saved in the application's temporary directory.
-- Images saved to the photo album using the `saveToPhotoAlbum` parameter does not contain the same image metadata as compared to the image returned from camera.getPicture. For example, the image saved to the photo album does not contain any GPS metadata.
+- Set `quality` below 50 to avoid memory errors on some devices.
+- When using `destinationType.FILE_URI`, photos are saved in the application's temporary directory. You may delete the contents of this directory using the `navigator.fileMgr` APIs if storage space is a concern.
Windows Phone 7 and 8 Quirks
--------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/camera/parameter/cameraSuccess.md b/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
index 773fba4..ab213c6 100644
--- a/docs/en/edge/cordova/camera/parameter/cameraSuccess.md
+++ b/docs/en/edge/cordova/camera/parameter/cameraSuccess.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
@@ -29,7 +29,7 @@ onSuccess callback function that provides the image data.
Parameters
----------
-- __imageData:__ Base64 encoding of the image data, OR the image file URI, depending on `cameraOptions` used. (`String`)
+- __imageData:__ Base64 encoding of the image data, _or_ the image file URI, depending on `cameraOptions` in effect. (`String`)
Example
-------
@@ -39,4 +39,4 @@ Example
function cameraCallback(imageData) {
var image = document.getElementById('myImage');
image.src = "data:image/jpeg;base64," + imageData;
- }
\ No newline at end of file
+ }
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/compass/compass.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.clearWatch.md b/docs/en/edge/cordova/compass/compass.clearWatch.md
index b36846a..839c0e0 100755
--- a/docs/en/edge/cordova/compass/compass.clearWatch.md
+++ b/docs/en/edge/cordova/compass/compass.clearWatch.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
@@ -45,7 +45,7 @@ Quick Example
// ... later on ...
navigator.compass.clearWatch(watchID);
-
+
Full Example
------------
@@ -102,7 +102,6 @@ Full Example
alert('Compass error: ' + compassError.code);
}
-
</script>
</head>
<body>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.clearWatchFilter.md b/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
index 8c92c03..92b7c9c 100644
--- a/docs/en/edge/cordova/compass/compass.clearWatchFilter.md
+++ b/docs/en/edge/cordova/compass/compass.clearWatchFilter.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,4 +20,4 @@ license: Licensed to the Apache Software Foundation (ASF) under one
compass.clearWatchFilter
========================
-No longer supported as of 1.6. See `compass.clearWatch`.
\ No newline at end of file
+No longer supported as of 1.6. See `compass.clearWatch`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md b/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
index 30cde63..b1c08f5 100755
--- a/docs/en/edge/cordova/compass/compass.getCurrentHeading.md
+++ b/docs/en/edge/cordova/compass/compass.getCurrentHeading.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,9 +27,12 @@ Get the current compass heading.
Description
-----------
-The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
+The compass is a sensor that detects the direction or heading that the
+device is pointed. It measures the heading in degrees from 0 to
+359.99.
-The compass heading information is returned via a CompassHeading object using the `compassSuccess` callback function.
+The compass heading information is returned via a `CompassHeading`
+object using the `compassSuccess` callback function.
Supported Platforms
-------------------
@@ -95,4 +98,4 @@ Full Example
<p>getCurrentHeading</p>
</body>
</html>
-
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/compass/compass.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.md b/docs/en/edge/cordova/compass/compass.md
index d85be8c..7797f10 100755
--- a/docs/en/edge/cordova/compass/compass.md
+++ b/docs/en/edge/cordova/compass/compass.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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/compass/compass.watchHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeading.md b/docs/en/edge/cordova/compass/compass.watchHeading.md
index f7661d8..0f7c0b2 100755
--- a/docs/en/edge/cordova/compass/compass.watchHeading.md
+++ b/docs/en/edge/cordova/compass/compass.watchHeading.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
@@ -23,28 +23,34 @@ compass.watchHeading
At a regular interval, get the compass heading in degrees.
var watchID = navigator.compass.watchHeading(compassSuccess, compassError, [compassOptions]);
-
+
Description
-----------
-The compass is a sensor that detects the direction or heading that the device is pointed. It measures the heading in degrees from 0 to 359.99.
+The compass is a sensor that detects the direction or heading that the
+device is pointed. It measures the heading in degrees from 0 to
+359.99.
-The `compass.watchHeading` gets the device's current heading at a regular interval. Each time the heading is retrieved, the `headingSuccess` callback function is executed. Specify the interval in milliseconds via the `frequency` parameter in the `compassOptions` object.
+The `compass.watchHeading` gets the device's current heading at a
+regular interval. Each time the heading is retrieved, the
+`headingSuccess` callback function is executed. Specify the interval
+in milliseconds via the `frequency` parameter in the `compassOptions`
+object.
-The returned watch ID references references the compass watch interval. The watch ID can be used with `compass.clearWatch` to stop watching the compass.
+The returned watch ID references the compass watch interval. The watch
+ID can be used with `compass.clearWatch` to stop watching the compass.
Supported Platforms
-------------------
- Android
- iPhone
-- Windows Phone 7 and 8 ( if available in hardware )
+- Windows Phone 7 and 8 (if available in hardware)
- Bada 1.2 & 2.x
- webOS
- Tizen
- Windows 8
-
Quick Example
-------------
@@ -125,10 +131,22 @@ Full Example
<button onclick="stopWatch();">Stop Watching</button>
</body>
</html>
-
+
iOS Quirks
--------------
-In iOS `compass.watchHeading` can also get the device's current heading when it changes by a specified number of degrees. Each time the heading changes by the specified number of degrees or more, the `headingSuccess` callback function is called. Specify the degrees of change via the `filter` parameter in the `compassOptions` object. Clear the watch as normal by passing the returned watch ID to `compass.clearWatch`. This functionality replaces the previously separate, iOS only functions, watchHeadingFilter and clearWatchFilter, which were removed in 1.6.
-
-In iOS only one watchHeading can be in effect at one time. If a watchHeading via filter is in effect, calling getCurrentHeading or watchHeading will use the existing filter value for specifying heading changes. On iOS watching heading changes via a filter is more efficient than via time.
+In iOS `compass.watchHeading` can also get the device's current
+heading when it changes by a specified number of degrees. Each time
+the heading changes by the specified number of degrees or more, the
+`headingSuccess` callback function is called. Specify the degrees of
+change via the `filter` parameter in the `compassOptions` object.
+Clear the watch as usual by passing the returned watch ID to
+`compass.clearWatch`. This functionality replaces the previously
+separate, iOS-only `watchHeadingFilter` and `clearWatchFilter`
+functions, which were removed in version 1.6.
+
+Only one `watchHeading` can be in effect at one time in iOS. If a
+`watchHeading` uses a filter, calling `getCurrentHeading` or
+`watchHeading` uses the existing filter value to specify heading
+changes. Watching heading changes with a filter is more efficient than
+with time intervals.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md b/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
index 6a0283f..f64c2c7 100644
--- a/docs/en/edge/cordova/compass/compass.watchHeadingFilter.md
+++ b/docs/en/edge/cordova/compass/compass.watchHeadingFilter.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
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/compass/compassError/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/compassError/compassError.md b/docs/en/edge/cordova/compass/compassError/compassError.md
index 989b4dc..c8850b7 100644
--- a/docs/en/edge/cordova/compass/compassError/compassError.md
+++ b/docs/en/edge/cordova/compass/compassError/compassError.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
@@ -29,7 +29,7 @@ Properties
Constants
---------
-- `CompassError.COMPASS_INTERNAL_ERR`
+- `CompassError.COMPASS_INTERNAL_ERR`
- `CompassError.COMPASS_NOT_SUPPORTED`
Description
@@ -37,4 +37,3 @@ Description
The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs.
-
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/compass/parameters/compassError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassError.md b/docs/en/edge/cordova/compass/parameters/compassError.md
index 67023ec..7a8fe49 100755
--- a/docs/en/edge/cordova/compass/parameters/compassError.md
+++ b/docs/en/edge/cordova/compass/parameters/compassError.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,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
compassError
==========
-onError callback function for compass functions.
+onError callback function for compass functions.
Example
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/compass/parameters/compassHeading.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassHeading.md b/docs/en/edge/cordova/compass/parameters/compassHeading.md
index 935ea06..dc15e5c 100644
--- a/docs/en/edge/cordova/compass/parameters/compassHeading.md
+++ b/docs/en/edge/cordova/compass/parameters/compassHeading.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,29 +20,27 @@ license: Licensed to the Apache Software Foundation (ASF) under one
compassHeading
==========
-A `CompassHeading` object is returned to the `compassSuccess` callback function when an error occurs.
+A `CompassHeading` object is returned to the `compassSuccess` callback function.
Properties
----------
- __magneticHeading:__ The heading in degrees from 0 - 359.99 at a single moment in time. _(Number)_
-- __trueHeading:__ The heading relative to the geographic North Pole in degrees 0 - 359.99 at a single moment in time. A negative value indicates that the true heading could not be determined. _(Number)_
+- __trueHeading:__ The heading relative to the geographic North Pole in degrees 0 - 359.99 at a single moment in time. A negative value indicates that the true heading cannot be determined. _(Number)_
- __headingAccuracy:__ The deviation in degrees between the reported heading and the true heading. _(Number)_
- __timestamp:__ The time at which this heading was determined. _(milliseconds)_
Description
-----------
-The `CompassHeading` object is returned to the user through the `compassSuccess` callback function.
+The `CompassHeading` object is returned to the `compassSuccess` callback function.
Android Quirks
--------------
-- trueHeading is not supported. It will report the same value as magneticHeading
-- headingAccuracy will always be 0 as there is no difference between the magneticHeading and trueHeading on Android.
+- `trueHeading` is not supported, but reports the same value as `magneticHeading`
+- `headingAccuracy` is always 0 because there is no difference between the `magneticHeading` and `trueHeading`.
iOS Quirks
----------
-- trueHeading is only returned when location services are running via `navigator.geolocation.watchLocation()`
-- For iOS > 4 devices, if the device is rotated and the app supports that orientation, the heading values will be reported
-back with respect to the current orientation.
-
+- `trueHeading` is only returned when location services are enabled via `navigator.geolocation.watchLocation()`
+- For iOS > 4 devices, heading factors in the device's current orientation, not in reference to its absolute position, for apps that supports that orientation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/compass/parameters/compassOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassOptions.md b/docs/en/edge/cordova/compass/parameters/compassOptions.md
index d271a6d..62e84a3 100755
--- a/docs/en/edge/cordova/compass/parameters/compassOptions.md
+++ b/docs/en/edge/cordova/compass/parameters/compassOptions.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
@@ -30,16 +30,16 @@ Options
Android Quirks
______________
-- filter is not supported.
+- `filter` is not supported.
Windows Phone 7 and 8 Quirks
--------------
-- filter is not supported.
+- `filter` is not supported.
Bada Quirks
-----------
-- filter is not supported.
+- `filter` is not supported.
Tizen Quirks
-----------
-- filter is not supported.
+- `filter` is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/compass/parameters/compassSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/compass/parameters/compassSuccess.md b/docs/en/edge/cordova/compass/parameters/compassSuccess.md
index 1b0fc9c..9f4daf0 100644
--- a/docs/en/edge/cordova/compass/parameters/compassSuccess.md
+++ b/docs/en/edge/cordova/compass/parameters/compassSuccess.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,7 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
compassSuccess
==============
-onSuccess callback function that provides the compass heading information via a compassHeading object.
+onSuccess callback function that provides the compass heading information via a `compassHeading` object.
function(heading) {
// Do something
@@ -29,7 +29,6 @@ onSuccess callback function that provides the compass heading information via a
Parameters
----------
-
- __heading:__ The heading information. _(compassHeading)_
Example
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/connection/connection.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/connection/connection.md b/docs/en/edge/cordova/connection/connection.md
index ebecd12..bb773e9 100644
--- a/docs/en/edge/cordova/connection/connection.md
+++ b/docs/en/edge/cordova/connection/connection.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,9 +20,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Connection
==========
-> The `connection` object gives access to the device's cellular and wifi connection information.
-
-This object is exposed as `navigator.connection`.
+> The `connection` object, exposed via `navigator.connection`, provides information about the device's cellular and wifi connection.
Properties
----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/39353f45/docs/en/edge/cordova/connection/connection.type.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/connection/connection.type.md b/docs/en/edge/cordova/connection/connection.type.md
index c18e58b..89bffbe 100644
--- a/docs/en/edge/cordova/connection/connection.type.md
+++ b/docs/en/edge/cordova/connection/connection.type.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,12 +20,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
connection.type
===================
-Checks the active network connection that is being used.
+Checks the currently active network connection.
Description
-----------
-This property is a fast way to determine the device's network connection state, and type of connection.
+This property offers a fast way to determine the device's network
+connection state, and type of connection.
Supported Platforms
-------------------
@@ -72,7 +73,7 @@ Full Example
<script type="text/javascript" charset="utf-8">
// Wait for Cordova to load
- //
+ //
document.addEventListener("deviceready", onDeviceReady, false);
// Cordova is loaded and it is now safe to make calls Cordova methods
@@ -106,11 +107,12 @@ Full Example
API Change
----------
-Before Cordova 2.3.0, the Connection object existed at: `navigator.network.connection`.
-
-To match the spec, this was changed to `navigator.connection` in 2.3.0.
-`navigator.network.connection` still exists, but is now deprecated and will be removed in a future release.
+Prior to Cordova 2.3.0, the `Connection` object was accessed via
+`navigator.network.connection`. It was changed to
+`navigator.connection` in 2.3.0 to match the W3C specification. It's
+still available at its original location, but is deprecated and will
+eventually be removed.
iOS Quirks
----------
@@ -121,7 +123,7 @@ iOS Quirks
Bada Quirks
-----------
-- Bada can only detect a WiFi or cellular connection.
+- Bada can only distinguish a WiFi and cellular connection.
- `navigator.connection.type` is set to `Connection.CELL_2G` for all cellular data.
webOS Quirks