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/08/15 20:05:19 UTC
docs commit: [doc] Mirror edge to 3.0.0.
Updated Branches:
refs/heads/master b77b91d80 -> d3ec7fe6b
[doc] Mirror edge to 3.0.0.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/d3ec7fe6
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/d3ec7fe6
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/d3ec7fe6
Branch: refs/heads/master
Commit: d3ec7fe6b07a68748d3e84e62e0bd9c6af619d6e
Parents: b77b91d
Author: Michael Brooks <mi...@michaelbrooks.ca>
Authored: Wed Aug 14 10:56:16 2013 -0700
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Wed Aug 14 10:56:16 2013 -0700
----------------------------------------------------------------------
docs/en/3.0.0/cordova/camera/camera.md | 12 ++++++++-
.../cordova/camera/parameter/cameraOptions.md | 4 +--
.../ContactFindOptions/contactfindoptions.md | 2 +-
docs/en/3.0.0/cordova/contacts/contacts.md | 17 +++++++++++-
.../file/directoryentry/directoryentry.md | 4 +--
docs/en/3.0.0/cordova/file/file.md | 5 ++++
.../3.0.0/cordova/file/fileentry/fileentry.md | 4 +--
.../cordova/file/filetransfer/filetransfer.md | 4 +--
.../en/3.0.0/cordova/geolocation/geolocation.md | 15 ++++++++++-
.../3.0.0/cordova/media/capture/CaptureError.md | 2 +-
.../cordova/media/capture/MediaFileData.md | 2 +-
docs/en/3.0.0/cordova/media/capture/capture.md | 15 ++++++++++-
docs/en/3.0.0/guide/appdev/privacy/index.md | 27 ++++++++++++--------
docs/en/3.0.0/guide/appdev/whitelist/index.md | 4 +--
docs/en/3.0.0/guide/overview/index.md | 4 +--
docs/en/3.0.0/guide/platforms/android/config.md | 6 ++---
docs/en/3.0.0/guide/platforms/android/plugin.md | 2 +-
docs/en/3.0.0/guide/platforms/ios/config.md | 12 ++++-----
docs/en/3.0.0/guide/platforms/ios/plugin.md | 4 +--
docs/en/3.0.0/guide/platforms/ios/webview.md | 20 +++++++--------
docs/en/3.0.0/guide/platforms/win8/index.md | 10 ++++----
docs/en/3.0.0/guide/platforms/wp7/index.md | 6 ++---
docs/en/3.0.0/guide/platforms/wp8/index.md | 10 ++++----
docs/en/3.0.0/plugin_ref/spec.md | 2 +-
24 files changed, 128 insertions(+), 65 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/cordova/camera/camera.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/camera/camera.md b/docs/en/3.0.0/cordova/camera/camera.md
index 3e944c8..6317d3d 100644
--- a/docs/en/3.0.0/cordova/camera/camera.md
+++ b/docs/en/3.0.0/cordova/camera/camera.md
@@ -22,7 +22,17 @@ Camera
> The `camera` object provides access to the device's default camera application.
-**Important privacy note:** Collection and use of images from a device's camera raises important privacy issues. Your app's privacy policy should discuss how the app uses the camera and whether the images recorded are shared with any other parties. In addition, if the app's use of the camera is not apparent in the user interface, you should provide a just-in-time notice prior to your app accessing the camera (if the device operating system doesn't do so already). That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for "OK" and "No Thanks"). For more information, please see the Privacy Guide.
+__Important privacy note:__ Collection and use of images from a
+device's camera raises important privacy issues. Your app's privacy
+policy should discuss how the app uses the camera and whether the
+images recorded are shared with any other parties. In addition, if
+the app's use of the camera is not apparent in the user interface, you
+should provide a just-in-time notice prior to your app accessing the
+camera (if the device operating system doesn't do so already). That
+notice should provide the same information noted above, as well as
+obtaining the user's permission (e.g., by presenting choices for
+__OK__ and __No Thanks__). For more information, please see the
+Privacy Guide.
Methods
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/cordova/camera/parameter/cameraOptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/camera/parameter/cameraOptions.md b/docs/en/3.0.0/cordova/camera/parameter/cameraOptions.md
index f428459..778bd8a 100644
--- a/docs/en/3.0.0/cordova/camera/parameter/cameraOptions.md
+++ b/docs/en/3.0.0/cordova/camera/parameter/cameraOptions.md
@@ -42,7 +42,7 @@ Options
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 (e.g. assets-library:// on iOS or content:// on Android)
+ 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 `navigator.camera.PictureSourceType` _(Number)_
@@ -105,7 +105,7 @@ BlackBerry Quirks
- 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.
+- 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.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/contacts/ContactFindOptions/contactfindoptions.md b/docs/en/3.0.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
index 7cd76dc..4ea4a24 100644
--- a/docs/en/3.0.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
+++ b/docs/en/3.0.0/cordova/contacts/ContactFindOptions/contactfindoptions.md
@@ -27,7 +27,7 @@ Properties
- __filter__: The search string used to find contacts. _(DOMString)_ (Default: `""`)
-- __multiple__: Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: false)
+- __multiple__: Determines if the find operation returns multiple contacts. _(Boolean)_ (Default: `false`)
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/cordova/contacts/contacts.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/contacts/contacts.md b/docs/en/3.0.0/cordova/contacts/contacts.md
index 9bfb848..578e577 100644
--- a/docs/en/3.0.0/cordova/contacts/contacts.md
+++ b/docs/en/3.0.0/cordova/contacts/contacts.md
@@ -22,7 +22,22 @@ Contacts
> The `contacts` object provides access to the device contacts database.
-**Important privacy note:** Collection and use of contact data raises important privacy issues. Your app's privacy policy should discuss how the app uses contact data and whether it is shared with any other parties. Contact information is considered sensitive because it reveals the people with whom a person communicates. Therefore, in addition to your app's privacy policy, you should strongly consider providing a just-in-time notice prior to your app accessing or using contact data (if the device operating system doesn't do so already). That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for "OK" and "No Thanks"). Note that some app marketplaces may require your app to provide just-in-time notice and obtain permission from the user prior to accessing contact data. A clear and easy to understand user experience surrounding the use of contact data will help avoid user confusion and perceived misuse o
f contact data. For more information, please see the Privacy Guide.
+__Important privacy note:__ Collection and use of contact data raises
+important privacy issues. Your app's privacy policy should discuss
+how the app uses contact data and whether it is shared with any other
+parties. Contact information is considered sensitive because it
+reveals the people with whom a person communicates. Therefore, in
+addition to your app's privacy policy, you should strongly consider
+providing a just-in-time notice prior to your app accessing or using
+contact data (if the device operating system doesn't do so
+already). That notice should provide the same information noted above,
+as well as obtaining the user's permission (e.g., by presenting
+choices for __OK__ and __No Thanks__). Note that some app
+marketplaces may require your app to provide just-in-time notice and
+obtain permission from the user prior to accessing contact data. A
+clear and easy-to-understand user experience surrounding the use of
+contact data will help avoid user confusion and perceived misuse of
+contact data. For more information, please see the Privacy Guide.
Methods
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/directoryentry/directoryentry.md b/docs/en/3.0.0/cordova/file/directoryentry/directoryentry.md
index cb4c6e6..3c8cbe8 100644
--- a/docs/en/3.0.0/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/3.0.0/cordova/file/directoryentry/directoryentry.md
@@ -27,9 +27,9 @@ specification.
Properties
----------
-- __isFile__: Always false. _(boolean)_
+- __isFile__: Always `false`. _(boolean)_
-- __isDirectory__: Always true. _(boolean)_
+- __isDirectory__: Always `true`. _(boolean)_
- __name__: The name of the `DirectoryEntry`, excluding the path leading to it. _(DOMString)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/cordova/file/file.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/file.md b/docs/en/3.0.0/cordova/file/file.md
index 64ad381..96f31f1 100644
--- a/docs/en/3.0.0/cordova/file/file.md
+++ b/docs/en/3.0.0/cordova/file/file.md
@@ -49,6 +49,11 @@ Interface, to add or remove this feature for a project:
$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git
$ cordova plugin rm org.apache.cordova.core.file
+
+To use the file-transfer plugin you must add that separately.
+
+ $ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer.git
+ $ cordova plugin rm org.apache.cordova.core.file-transfer
These commands apply to all targeted platforms, but modify the
platform-specific configuration settings described below:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/fileentry/fileentry.md b/docs/en/3.0.0/cordova/file/fileentry/fileentry.md
index 357ec46..fb158f0 100644
--- a/docs/en/3.0.0/cordova/file/fileentry/fileentry.md
+++ b/docs/en/3.0.0/cordova/file/fileentry/fileentry.md
@@ -27,9 +27,9 @@ specification.
Properties
----------
-- __isFile__: Always true. _(boolean)_
+- __isFile__: Always `true`. _(boolean)_
-- __isDirectory__: Always false. _(boolean)_
+- __isDirectory__: Always `false`. _(boolean)_
- __name__: The name of the `FileEntry`, excluding the path leading to it. _(DOMString)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md b/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md
index 7db3932..1ef635b 100644
--- a/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md
+++ b/docs/en/3.0.0/cordova/file/filetransfer/filetransfer.md
@@ -74,7 +74,7 @@ __Parameters:__
- __options__: Optional parameters such as file name and mimetype.
-- __trustAllHosts__: Optional parameter, defaults to `false`. If set to true, it accepts all security certificates. This is useful since Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS. _(boolean)_
+- __trustAllHosts__: Optional parameter, defaults to `false`. If set to `true`, it accepts all security certificates. This is useful since Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS. _(boolean)_
__Quick Example__
@@ -305,4 +305,4 @@ __Example__
fileTransfer.download(...); // or fileTransfer.upload(...);
__Quirks__
-- On both Android an iOS, lengthComputable is false for downloads that use gzip encoding.
+- On both Android an iOS, lengthComputable is `false` for downloads that use gzip encoding.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/geolocation/geolocation.md b/docs/en/3.0.0/cordova/geolocation/geolocation.md
index 4b657c7..40cce81 100644
--- a/docs/en/3.0.0/cordova/geolocation/geolocation.md
+++ b/docs/en/3.0.0/cordova/geolocation/geolocation.md
@@ -33,7 +33,20 @@ This API is based on the
[W3C Geolocation API Specification](http://dev.w3.org/geo/api/spec-source.html),
and only executes on devices that don't already provide an implementation.
-**Important privacy note:** Collection and use of geolocation data raises important privacy issues. Your app's privacy policy should discuss how the app uses geolocation data, whether it is shared with any other parties, and the level of precision of the data (for example, coarse, fine, ZIP code level, etc.). Geolocation data is generally considered sensitive because it can reveal a person's whereabouts and, if stored, the history of his or her travels. Therefore, in addition to your app's privacy policy, you should strongly consider providing a just-in-time notice prior to your app accessing geolocation data (if the device operating system doesn't do so already). That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for "OK" and "No Thanks"). For more information, please see the Privacy Guide.
+__Important privacy note:__ Collection and use of geolocation data
+raises important privacy issues. Your app's privacy policy should
+discuss how the app uses geolocation data, whether it is shared with
+any other parties, and the level of precision of the data (for
+example, coarse, fine, ZIP code level, etc.). Geolocation data is
+generally considered sensitive because it can reveal a person's
+whereabouts and, if stored, the history of his or her travels.
+Therefore, in addition to your app's privacy policy, you should
+strongly consider providing a just-in-time notice prior to your app
+accessing geolocation data (if the device operating system doesn't do
+so already). That notice should provide the same information noted
+above, as well as obtaining the user's permission (e.g., by presenting
+choices for __OK__ and __No Thanks__). For more information, please
+see the Privacy Guide.
Methods
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/CaptureError.md b/docs/en/3.0.0/cordova/media/capture/CaptureError.md
index a532ab9..faebdde 100644
--- a/docs/en/3.0.0/cordova/media/capture/CaptureError.md
+++ b/docs/en/3.0.0/cordova/media/capture/CaptureError.md
@@ -34,7 +34,7 @@ Constants
- `CaptureError.CAPTURE_APPLICATION_BUSY`: The camera or audio capture application is currently serving another capture request.
-- `CaptureError.CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. the value of `limit` is less than one).
+- `CaptureError.CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g., the value of `limit` is less than one).
- `CaptureError.CAPTURE_NO_MEDIA_FILES`: The user exits the camera or audio capture application before capturing anything.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/MediaFileData.md b/docs/en/3.0.0/cordova/media/capture/MediaFileData.md
index 35ef16a..e2dc88b 100644
--- a/docs/en/3.0.0/cordova/media/capture/MediaFileData.md
+++ b/docs/en/3.0.0/cordova/media/capture/MediaFileData.md
@@ -70,7 +70,7 @@ iOS Quirks
----------
Supports the following `MediaFileData` properties:
-- __codecs__: Not supported, and returns null.
+- __codecs__: Not supported, and returns `null`.
- __bitrate__: Supported on iOS4 devices for audio only. Returns zero for images and videos.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/cordova/media/capture/capture.md b/docs/en/3.0.0/cordova/media/capture/capture.md
index d645063..23ff2fa 100644
--- a/docs/en/3.0.0/cordova/media/capture/capture.md
+++ b/docs/en/3.0.0/cordova/media/capture/capture.md
@@ -22,7 +22,20 @@ Capture
> Provides access to the device's audio, image, and video capture capabilities.
-**Important privacy note:** Collection and use of images, video, or audio from the device's camera or microphone raises important privacy issues. Your app's privacy policy should discuss how the app uses such sensors and whether the data recorded is shared with any other parties. In addition, if the app's use of the camera or microphone is not apparent in the user interface, you should provide a just-in-time notice prior to your app accessing the camera or microphone (if the device operating system doesn't do so already). That notice should provide the same information noted above, as well as obtaining the user's permission (e.g., by presenting choices for "OK" and "No Thanks"). Note that some app marketplaces may require your app to provide just-in-time notice and obtain permission from the user prior to accessing the camera or microphone. For more information, please see the Privacy Guide.
+__Important privacy note:__ Collection and use of images, video, or
+audio from the device's camera or microphone raises important privacy
+issues. Your app's privacy policy should discuss how the app uses
+such sensors and whether the data recorded is shared with any other
+parties. In addition, if the app's use of the camera or microphone is
+not apparent in the user interface, you should provide a just-in-time
+notice prior to your app accessing the camera or microphone (if the
+device operating system doesn't do so already). That notice should
+provide the same information noted above, as well as obtaining the
+user's permission (e.g., by presenting choices for __OK__ and __No
+Thanks__). Note that some app marketplaces may require your app to
+provide just-in-time notice and obtain permission from the user prior
+to accessing the camera or microphone. For more information, please
+see the Privacy Guide.
Objects
-------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/guide/appdev/privacy/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/appdev/privacy/index.md b/docs/en/3.0.0/guide/appdev/privacy/index.md
index 7603e08..601ee38 100644
--- a/docs/en/3.0.0/guide/appdev/privacy/index.md
+++ b/docs/en/3.0.0/guide/appdev/privacy/index.md
@@ -19,11 +19,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
# Privacy Guide
-Mobile privacy is a critical issue that every app developer must address. Your users expect that their private information will be collected and treated appropriately by your app. Also, there are an increasing number of jurisdictions that now have legal requirements regarding mobile privacy practices.
-
-This guide on mobile app privacy should be considered a "primer" addressing some the most significant issues. It outlines some broadly accepted best practices and provides references to other more detailed guides and references.
-
-* **Privacy Policy**: You app should include a privacy policy that
+Mobile privacy is a critical issue that every app developer must
+address. Your users expect that their private information will be
+collected and treated appropriately by your app. Also, there are an
+increasing number of jurisdictions that now have legal requirements
+regarding mobile privacy practices.
+
+This guide on mobile app privacy should be considered a _primer_
+addressing some the most significant issues. It outlines some broadly
+accepted best practices and provides references to other more detailed
+guides and references.
+
+* __Privacy Policy__: You app should include a privacy policy that
addresses topics such as what kind of information your app collects
from or about your users, how that information is used, with whom it
is shared, and how users can make privacy-related choices within the
@@ -33,14 +40,14 @@ This guide on mobile app privacy should be considered a "primer" addressing some
the app marketplace. In addition, you should make your privacy
policy available within the app itself. The limited size of mobile
device displays creates challenges for displaying privacy policies
- to users. Consider developing a "short form" of the policy that
+ to users. Consider developing a _short form_ of the policy that
includes the most important information, and then provide a link to
the "long form" policy for those interested in more details. Several
groups are attempting to develop icon-based standards for
communicating privacy practices, which you may want to consider once
these standards mature.
-* **Collection of sensitive information**: An app's collection of
+* __Collection of sensitive information__: An app's collection of
sensitive personal information raises important privacy concerns.
Examples of sensitive personal information include financial
information, health information, and information from or about
@@ -61,7 +68,7 @@ This guide on mobile app privacy should be considered a "primer" addressing some
dialog box text to clarify how the app uses and, if applicable,
shares such information.
-* **Avoiding user surprise**: If your app collects or uses information
+* __Avoiding user surprise__: If your app collects or uses information
in a way that may be surprising to users in light of the primary
purpose of your app (for example, a music player that accesses
stored pictures), you should take similar steps as with the
@@ -70,7 +77,7 @@ This guide on mobile app privacy should be considered a "primer" addressing some
user about the collection or use of that information and, if
appropriate, provide a corresponding privacy control.
-* **Third party data collection or sharing**: If you app collects
+* __Third party data collection or sharing__: If you app collects
information that is provided to another company--such as a social
networking platform or an ad network (for example, if your app
displays advertising)--you should inform your users of that
@@ -79,7 +86,7 @@ This guide on mobile app privacy should be considered a "primer" addressing some
offer your users the ability to control or opt-out of such
collection or sharing.
-* **Collection limitation and security**: Your users entrust your app
+* __Collection limitation and security__: Your users entrust your app
with their information and they expect that you will take
appropriate security precautions to protect it. One of the best ways
to avoid security compromises of personal information is not to
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/guide/appdev/whitelist/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/appdev/whitelist/index.md b/docs/en/3.0.0/guide/appdev/whitelist/index.md
index 6307b3f..b08bb2f 100644
--- a/docs/en/3.0.0/guide/appdev/whitelist/index.md
+++ b/docs/en/3.0.0/guide/appdev/whitelist/index.md
@@ -45,11 +45,11 @@ Access to the subdomain [maps.google.com][4]:
http://maps.google.com
-Access to all the subdomains on [google.com][2] (e.g. [mail.google.com][5] and [docs.google.com][6]):
+Access to all the subdomains on [google.com][2] (e.g., [mail.google.com][5] and [docs.google.com][6]):
http://*.google.com
-Access to all domains (e.g. [google.com][2] and [developer.mozilla.org][7]):
+Access to all domains (e.g., [google.com][2] and [developer.mozilla.org][7]):
*
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/guide/overview/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/overview/index.md b/docs/en/3.0.0/guide/overview/index.md
index 5bd470f..75a5e25 100644
--- a/docs/en/3.0.0/guide/overview/index.md
+++ b/docs/en/3.0.0/guide/overview/index.md
@@ -286,8 +286,8 @@ CLI's shorthand stubs.)
<td data-col="blackberry" class="y"></td>
<td data-col="blackberry10" class="y"></td>
<td data-col="ios" class="y"></td>
- <td data-col="winphone7" class="p">(no FileTransfer)</td>
- <td data-col="winphone8" class="p">(no FileTransfer)</td>
+ <td data-col="winphone7" class="p">no FileTransfer</td>
+ <td data-col="winphone8" class="p">no FileTransfer</td>
<td data-col="win8" class="y"></td>
<td data-col="tizen" class="n"></td>
</tr>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/guide/platforms/android/config.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/config.md b/docs/en/3.0.0/guide/platforms/android/config.md
index d3e710c..6368f83 100644
--- a/docs/en/3.0.0/guide/platforms/android/config.md
+++ b/docs/en/3.0.0/guide/platforms/android/config.md
@@ -27,7 +27,7 @@ across the application, and per CordovaWebView instance.
Various other preferences (as `<preference>` tags) default on not
breaking existing apps. The available preferences are:
-* `useBrowserHistory` (boolean, defaults to `true`): set to false if you
+* `useBrowserHistory` (boolean, defaults to `true`): set to `false` if you
want to use the history shim that was used to work around the
hashtag error present in Android 3.x prior to the history fix.
(Note: This setting will be deprecated in April 2013)
@@ -39,12 +39,12 @@ breaking existing apps. The available preferences are:
sub-pages. The value's format is _Title, Message_
* `errorUrl`: Set the error page for your application. Should be
- located in your Android project in file://android_asset/www/
+ located in your Android project in `file://android_asset/www/`
* `backgroundColor`: Set the background color for your application.
Supports a four-byte hex value, with the first byte representing
alpha value, and the following three bytes with standard RGB
- values. (i.e. 0x00000000 = Black)
+ values. For example, `0x00000000` is black.
* `loadUrlTimeoutValue`: How much time Cordova should wait before
throwing a timeout error on the application.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/guide/platforms/android/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/android/plugin.md b/docs/en/3.0.0/guide/platforms/android/plugin.md
index b9a9966..c31c495 100644
--- a/docs/en/3.0.0/guide/platforms/android/plugin.md
+++ b/docs/en/3.0.0/guide/platforms/android/plugin.md
@@ -172,7 +172,7 @@ Let's take a look at the code. The necessary `imports` are at
the top. Our class extends from `CordovaPlugin`. We override the
execute() method in order to recieve messages from exec(). Our method
first compares against `action`: this plugin only supports one action,
-the `echo` action. Any other action returns false, which results in an
+the `echo` action. Any other action returns `false`, which results in an
error of type `INVALID_ACTION`, which translates into an error
callback invocation on the JavaScript side. Next, we grab the echo
string using the `getString` method on our `args`, telling it we want
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/guide/platforms/ios/config.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/ios/config.md b/docs/en/3.0.0/guide/platforms/ios/config.md
index 4b0a36d..d3f6e38 100644
--- a/docs/en/3.0.0/guide/platforms/ios/config.md
+++ b/docs/en/3.0.0/guide/platforms/ios/config.md
@@ -36,26 +36,26 @@ existing apps. The available preferences are:
spinning throbber in the status/battery bar, valid values are
`whiteLarge`, `white`, and `gray`.
-* `EnableLocation` (boolean, defaults to `false`): set to true, to
+* `EnableLocation` (boolean, defaults to `false`): set to `true`, to
initialize the Geolocation plugin at start-up (so the fix on your
- location can be more accurate) **DEPRECATED**: please set the
+ location can be more accurate) __DEPRECATED__: please set the
`onload` attribute of the `Geolocation` plugin to `true`
instead.
-* `EnableViewportScale` (boolean, defaults to `false`): set to true to
+* `EnableViewportScale` (boolean, defaults to `false`): set to `true` to
prevent viewport scaling through a meta tag.
-* `AutoHideSplashScreen` (boolean, defaults to `true`): set to false to
+* `AutoHideSplashScreen` (boolean, defaults to `true`): set to `false` to
control when the splashscreen is hidden through a JavaScript API.
-* `FadeSplashScreen` (boolean, defaults to `true`): set to false to
+* `FadeSplashScreen` (boolean, defaults to `true`): set to `false` to
prevent the splash-screen to fade in and out when showing or hiding
it.
* `FadeSplashScreenDuration` (float, defaults to 2): The splash-screen
Fade duration in seconds.
-* `ShowSplashScreenSpinner` (boolean, defaults to `true`): set to false
+* `ShowSplashScreenSpinner` (boolean, defaults to `true`): set to `false`
to hide the splash-screen spinner.
* `MediaPlaybackRequiresUserAction` (boolean, defaults to `false`): set
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/guide/platforms/ios/plugin.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/ios/plugin.md b/docs/en/3.0.0/guide/platforms/ios/plugin.md
index 404cb13..541e4f9 100644
--- a/docs/en/3.0.0/guide/platforms/ios/plugin.md
+++ b/docs/en/3.0.0/guide/platforms/ios/plugin.md
@@ -63,7 +63,7 @@ referenced by a call from JavaScript, unless `<param>` with an `onload`
There is _no_ designated initializer for plugins. Instead, plugins
should use the `pluginInitialize` method for their start-up logic.
-Plugins with long-running requests, background activity (e.g. playing
+Plugins with long-running requests, background activity (e.g., playing
media), listeners or internal state should implement the `onReset`
method and stop or clean up those activities. This method is run when
the `UIWebView` navigates to a new page or refreshes, which reloads
@@ -110,7 +110,7 @@ callback does not fire.
* `messageAsArrayBuffer` expects `NSData*` and converts to an `ArrayBuffer` for your JavaScript callback (and `ArrayBuffers` sent to a plugin from JavaScript are converted to `NSData*`).
* `messageAsMultipart` expects an `NSArray*` containing any of the other supported types, and sends the whole array as the `arguments` to your JavaScript callback.
- * Quirk: this is not just syntactic sugar (though it is sweet). This way, all of the arguments are serialized or deserialized as necessary. e.g. it is safe to return `NSData*` as multipart, but not as `Array`/`Dictionary`.
+ * Quirk: this is not just syntactic sugar (though it is sweet). This way, all of the arguments are serialized or deserialized as necessary. E.g., it is safe to return `NSData*` as multipart, but not as `Array`/`Dictionary`.
## Echo Plugin iOS Plugin
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/guide/platforms/ios/webview.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/ios/webview.md b/docs/en/3.0.0/guide/platforms/ios/webview.md
index 31998f8..c95b069 100644
--- a/docs/en/3.0.0/guide/platforms/ios/webview.md
+++ b/docs/en/3.0.0/guide/platforms/ios/webview.md
@@ -80,26 +80,26 @@ based Cleaver implementation.
MobileCoreServices.framework
CoreMedia.framework
-16. Expand **Target Dependencies**, the top box labeled like this if you have multiple boxes!
+16. Expand __Target Dependencies__, the top box labeled like this if you have multiple boxes!
-17. Select the **+** button, and add the `CordovaLib` build product.
+17. Select the __+__ button, and add the `CordovaLib` build product.
-18. Expand **Link Binaries with Libraries**, the top box labeled like
+18. Expand __Link Binaries with Libraries__, the top box labeled like
this if you have multiple boxes!
-19. Select the **+** button, and add `libCordova.a`.
+19. Select the __+__ button, and add `libCordova.a`.
-20. Set the Xcode preference **Xcode Preferences → Locations → Derived Data → Advanced...** to **Unique**.
+20. Set the Xcode preference __Xcode Preferences → Locations → Derived Data → Advanced...__ to __Unique__.
-21. Select the **project icon** in the Project Navigator, select your **Target**, then select the **Build Settings** tab.
+21. Select the __project icon__ in the Project Navigator, select your __Target__, then select the __Build Settings__ tab.
-22. Search for **Header Search Paths**. For that setting, add these three values below (with quotes):
+22. Search for __Header Search Paths__. For that setting, add these three values below (with quotes):
"$(TARGET_BUILD_DIR)/usr/local/lib/include"
"$(OBJROOT)/UninstalledProducts/include"
"$(BUILT_PRODUCTS_DIR)"
- With Cordova 2.1.0, `CordovaLib` has been upgraded to use **Automatic Reference Counting (ARC)**. You don't need to upgrade to **ARC** to use CordovaLib, but if you want to upgrade your project to use **ARC**, please use the Xcode migration wizard from the menu: **Edit → Refactor → Convert to Objective-C ARC...**, **de-select libCordova.a**, then run the wizard to completion.
+ With Cordova 2.1.0, `CordovaLib` has been upgraded to use __Automatic Reference Counting (ARC)__. You don't need to upgrade to __ARC__ to use CordovaLib, but if you want to upgrade your project to use __ARC__, please use the Xcode migration wizard from the menu: __Edit → Refactor → Convert to Objective-C ARC...__, __de-select libCordova.a__, then run the wizard to completion.
## Using CDVViewController in your code
@@ -107,7 +107,7 @@ based Cleaver implementation.
#import <Cordova/CDVViewController.h>
-2. Instantiate a new `CDVViewController`, and retain it somewhere (e.g. to a property in your class):
+2. Instantiate a new `CDVViewController`, and retain it somewhere (e.g., to a property in your class):
CDVViewController* viewController = [CDVViewController new];
@@ -127,7 +127,7 @@ based Cleaver implementation.
viewController.useSplashScreen = YES;
-6. Set the **view frame** (always set this as the last property):
+6. Set the __view frame__ (always set this as the last property):
viewController.view.frame = CGRectMake(0, 0, 320, 480);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/guide/platforms/win8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/win8/index.md b/docs/en/3.0.0/guide/platforms/win8/index.md
index 452e048..193aad9 100644
--- a/docs/en/3.0.0/guide/platforms/win8/index.md
+++ b/docs/en/3.0.0/guide/platforms/win8/index.md
@@ -45,7 +45,7 @@ Follow the instructions [here](http://www.windowsstore.com/) to submit your apps
## 2. Install SDK + Cordova
-- Set up your preferred variant of Visual Studio 2012. All of the product's paid versions (Professional, etc.) let you build Windows Store apps. You need **Express for Windows 8** to build Windows Store apps using the [Express editions](http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-products).
+- Set up your preferred variant of Visual Studio 2012. All of the product's paid versions (Professional, etc.) let you build Windows Store apps. You need __Express for Windows 8__ to build Windows Store apps using the [Express editions](http://www.microsoft.com/visualstudio/eng/products/visual-studio-express-products).
- Download and extract the latest copy of [Cordova](http://phonegap.com/download). You will be working in the `lib\windows-8` subfolder.
@@ -55,17 +55,17 @@ You can already build Windows 8 apps using the _HTML/JavaScript track_
available in Windows Store apps. Use Cordova in Windows Store apps to
expose the same APIs as on other Cordova-supported platforms.
-- Open Visual Studio 2012 and choose **New Project**.
+- Open Visual Studio 2012 and choose __New Project__.
-- Select **Installed → Template → Other Languages → JavaScript → Windows Store** from the tree, and then **Blank App** from the projects list. Enter whatever project name you like, such as `CordovaWin8Foo` as in this example.
+- Select __Installed → Template → Other Languages → JavaScript → Windows Store__ from the tree, and then __Blank App__ from the projects list. Enter whatever project name you like, such as `CordovaWin8Foo` as in this example.
-- Microsoft continues to use `default.html` as the default home page, but most web developers use `index.html`. (Plus it's likely that in the other platform variants of your project you are using `index.html` as the name of your default page.) To fix this, in Solution Explorer rename the `default.html` file to `index.html`. Then double-click the `package.appxmanifest` file and change the **Start page** value to `index.html`.
+- Microsoft continues to use `default.html` as the default home page, but most web developers use `index.html`. (Plus it's likely that in the other platform variants of your project you are using `index.html` as the name of your default page.) To fix this, in Solution Explorer rename the `default.html` file to `index.html`. Then double-click the `package.appxmanifest` file and change the __Start page__ value to `index.html`.
-- To include `cordova.js` in your project, right-click on the `js` directory in Solution Explorer and select **Add → New Item**. Locate the `cordova.js` file in the `lib\windows-8` directory noted above.
+- To include `cordova.js` in your project, right-click on the `js` directory in Solution Explorer and select __Add → New Item__. Locate the `cordova.js` file in the `lib\windows-8` directory noted above.
- Edit the code for `index.html`. Add a reference to `cordova.js`. You can do this manually, or by dragging the file from Solution Explorer.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/guide/platforms/wp7/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/wp7/index.md b/docs/en/3.0.0/guide/platforms/wp7/index.md
index f9851eb..55f3c7c 100644
--- a/docs/en/3.0.0/guide/platforms/wp7/index.md
+++ b/docs/en/3.0.0/guide/platforms/wp7/index.md
@@ -74,9 +74,9 @@ Run the script :
## 3. Set up New Project
-- Open Visual Studio Express for Windows Phone and choose **New Project**.
+- Open Visual Studio Express for Windows Phone and choose __New Project__.
-- Select **CordovaWP7**. (The version number is displayed in the template description.)
+- Select __CordovaWP7__. (The version number is displayed in the template description.)
- Give the project a name, and select __OK__.
@@ -98,7 +98,7 @@ In order to test your application on a device, the device must be registered. Cl
- In Visual Studio, select 'Device' from the top drop-down menu.
-- Press the green **play** button next to the main drop-down menu to start debugging, or type __F5__.
+- Press the green __play__ button next to the main drop-down menu to start debugging, or type __F5__.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/guide/platforms/wp8/index.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/guide/platforms/wp8/index.md b/docs/en/3.0.0/guide/platforms/wp8/index.md
index 13ef628..4579f09 100644
--- a/docs/en/3.0.0/guide/platforms/wp8/index.md
+++ b/docs/en/3.0.0/guide/platforms/wp8/index.md
@@ -91,9 +91,9 @@ Run the script :
## 3. Set up New Project
-- Open Visual Studio Express for Windows Phone and choose **New Project**.
+- Open Visual Studio Express for Windows Phone and choose __New Project__.
-- Select **CordovaWP8**. (The version number is displayed in the template description.)
+- Select __CordovaWP8__. (The version number is displayed in the template description.)
- Give the project a name, and select __OK__.
@@ -111,9 +111,9 @@ Run the script :
## 5. Build and Deploy to Emulator
-- Make sure **Windows Phone Emulator** is selected in the main drop-down menu.
+- Make sure __Windows Phone Emulator__ is selected in the main drop-down menu.
-- Press the green **play** button next to the drop-down menu to start debugging, or type __F5__.
+- Press the green __play__ button next to the drop-down menu to start debugging, or type __F5__.
@@ -125,7 +125,7 @@ In order to test your application on a device, the device must be registered. Cl
- In Visual Studio, select 'Device' from the top drop-down menu.
-- Press the green **play** button next to the main drop-down menu to start debugging, or type __F5__.
+- Press the green __play__ button next to the main drop-down menu to start debugging, or type __F5__.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d3ec7fe6/docs/en/3.0.0/plugin_ref/spec.md
----------------------------------------------------------------------
diff --git a/docs/en/3.0.0/plugin_ref/spec.md b/docs/en/3.0.0/plugin_ref/spec.md
index 685998d..d6d2ee8 100644
--- a/docs/en/3.0.0/plugin_ref/spec.md
+++ b/docs/en/3.0.0/plugin_ref/spec.md
@@ -471,7 +471,7 @@ require extra steps that can't be easily automated or are beyond
plugman's scope. Examples:
<info>
- You need to install **Google Play Services** from the `Android Extras` section using the Android SDK manager (run `android`).
+ You need to install __Google Play Services__ from the `Android Extras` section using the Android SDK manager (run `android`).
You need to add the following line to your `local.properties`