Return-Path: X-Original-To: apmail-cordova-commits-archive@www.apache.org Delivered-To: apmail-cordova-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 47B1818492 for ; Mon, 19 Oct 2015 19:00:27 +0000 (UTC) Received: (qmail 70072 invoked by uid 500); 19 Oct 2015 19:00:27 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 69974 invoked by uid 500); 19 Oct 2015 19:00:26 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 68995 invoked by uid 99); 19 Oct 2015 19:00:26 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 19 Oct 2015 19:00:26 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 343A5E0419; Mon, 19 Oct 2015 19:00:26 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: dblotsky@apache.org To: commits@cordova.apache.org Date: Mon, 19 Oct 2015 19:00:37 -0000 Message-Id: <92726e3fafb94c3abcaca35896fd7554@git.apache.org> In-Reply-To: <901c529765dd4c46bce3e929249e1827@git.apache.org> References: <901c529765dd4c46bce3e929249e1827@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [13/52] [partial] docs commit: Making links in docs manual instead of automatic. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/camera/camera.getPicture.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/camera/camera.getPicture.md b/www/docs/en/2.4.0/cordova/camera/camera.getPicture.md index 9fba3e3..8ddd29c 100644 --- a/www/docs/en/2.4.0/cordova/camera/camera.getPicture.md +++ b/www/docs/en/2.4.0/cordova/camera/camera.getPicture.md @@ -30,11 +30,11 @@ Takes a photo using the camera or retrieves a photo from the device's album. Th 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. +Function `camera.getPicture` opens the device's default camera application so that the user can take a picture (if `[Camera](camera.html).sourceType = [Camera](camera.html).PictureSourceType.CAMERA`, which is the default). Once the photo is taken, the camera application closes and your 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. +If `[Camera](camera.html).sourceType = [Camera](camera.html).PictureSourceType.PHOTOLIBRARY` or `[Camera](camera.html).PictureSourceType.SAVEDPHOTOALBUM`, then a photo chooser dialog is shown, from which a photo from the album can be selected. -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 will be sent to the `[cameraSuccess](parameter/cameraSuccess.html)` function, in one of the following formats, depending on the `[cameraOptions](parameter/cameraOptions.html)` you specify: - A `String` containing the Base64 encoded photo image. - A `String` representing the image file location on local storage (default). @@ -45,7 +45,7 @@ You can do whatever you want with the encoded image or URI, for example: - 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:__ 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](camera.html).destinationType' is highly recommended.___ Supported Platforms ------------------- @@ -62,7 +62,7 @@ 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 in a setTimeout() to allow the iOS image picker or popover to fully [close](../inappbrowser/inappbrowser.html) before the alert is displayed: setTimeout(function() { // do your thing here! @@ -77,9 +77,9 @@ via Zune will not work, and the error callback will be triggered. Tizen Quirks ---------------------- -Only 'destinationType: Camera.DestinationType.FILE_URI' and 'sourceType: Camera.PictureSourceType.PHOTOLIBRARY' are supported. +Only 'destinationType: [Camera](camera.html).DestinationType.FILE_URI' and 'sourceType: [Camera](camera.html).PictureSourceType.PHOTOLIBRARY' are supported. -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- Take photo and retrieve Base64-encoded image: @@ -112,7 +112,7 @@ Take photo and retrieve image file location: } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/camera/camera.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/camera/camera.md b/www/docs/en/2.4.0/cordova/camera/camera.md index 4feb3e5..1064ac1 100644 --- a/www/docs/en/2.4.0/cordova/camera/camera.md +++ b/www/docs/en/2.4.0/cordova/camera/camera.md @@ -28,8 +28,8 @@ Camera Methods ------- -- camera.getPicture -- camera.cleanup +- [camera.getPicture](camera.getPicture.html) +- [camera.cleanup](camera.cleanup.html) Permissions ----------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/camera/parameter/CameraPopoverOptions.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/camera/parameter/CameraPopoverOptions.md b/www/docs/en/2.4.0/cordova/camera/parameter/CameraPopoverOptions.md index 139fa44..c6518f3 100644 --- a/www/docs/en/2.4.0/cordova/camera/parameter/CameraPopoverOptions.md +++ b/www/docs/en/2.4.0/cordova/camera/parameter/CameraPopoverOptions.md @@ -43,7 +43,7 @@ CameraPopoverOptions - __height:__ height, in pixels, of the element on the screen to anchor popover onto. (`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](../camera.html).PopoverArrowDirection (`Number`) Camera.PopoverArrowDirection = { ARROW_UP : 1, // matches iOS UIPopoverArrowDirection constants @@ -55,7 +55,7 @@ CameraPopoverOptions 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 +Quick [Example](../../storage/storage.opendatabase.html) ------------- var popover = new CameraPopoverOptions(300,300,100,100,Camera.PopoverArrowDirection.ARROW_ANY); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/camera/parameter/cameraOptions.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/camera/parameter/cameraOptions.md b/www/docs/en/2.4.0/cordova/camera/parameter/cameraOptions.md index f6f757d..af1cc51 100644 --- a/www/docs/en/2.4.0/cordova/camera/parameter/cameraOptions.md +++ b/www/docs/en/2.4.0/cordova/camera/parameter/cameraOptions.md @@ -77,13 +77,13 @@ Options - __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 +- __popoverOptions:__ iOS only options to specify popover location in iPad. Defined in [CameraPopoverOptions](CameraPopoverOptions.html) Android Quirks -------------- - Ignores the `allowEdit` parameter. -- Camera.PictureSourceType.PHOTOLIBRARY and Camera.PictureSourceType.SAVEDPHOTOALBUM both display the same photo album. +- [Camera](../camera.html).PictureSourceType.PHOTOLIBRARY and [Camera](../camera.html).PictureSourceType.SAVEDPHOTOALBUM both display the same photo album. BlackBerry Quirks ----------------- @@ -91,9 +91,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. +- Application must have key injection permissions to [close](../../inappbrowser/inappbrowser.html) native [Camera](../camera.html) 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. +- [Camera](../camera.html).MediaType is not supported. - Ignores the `correctOrientation` parameter. webOS Quirks @@ -102,7 +102,7 @@ webOS Quirks - Ignores the `quality` parameter. - Ignores the `sourceType` parameter. - Ignores the `allowEdit` parameter. -- Camera.MediaType is not supported. +- [Camera](../camera.html).MediaType is not supported. - Ignores the `correctOrientation` parameter. - Ignores the `saveToPhotoAlbum` parameter. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/camera/parameter/cameraSuccess.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/camera/parameter/cameraSuccess.md b/www/docs/en/2.4.0/cordova/camera/parameter/cameraSuccess.md index d8e58ca..5b58248 100644 --- a/www/docs/en/2.4.0/cordova/camera/parameter/cameraSuccess.md +++ b/www/docs/en/2.4.0/cordova/camera/parameter/cameraSuccess.md @@ -32,9 +32,9 @@ 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](cameraOptions.html)` used. (`String`) -Example +[Example](../../storage/storage.opendatabase.html) ------- // Show image http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/compass/compass.clearWatch.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/compass/compass.clearWatch.md b/www/docs/en/2.4.0/cordova/compass/compass.clearWatch.md index 87ba551..d597bcf 100644 --- a/www/docs/en/2.4.0/cordova/compass/compass.clearWatch.md +++ b/www/docs/en/2.4.0/cordova/compass/compass.clearWatch.md @@ -27,7 +27,7 @@ Stop watching the compass referenced by the watch ID parameter. navigator.compass.clearWatch(watchID); -- __watchID__: The ID returned by `compass.watchHeading`. +- __watchID__: The ID returned by `[compass.watchHeading](compass.watchHeading.html)`. Supported Platforms ------------------- @@ -40,7 +40,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- var watchID = navigator.compass.watchHeading(onSuccess, onError, options); @@ -49,7 +49,7 @@ Quick Example navigator.compass.clearWatch(watchID); -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/compass/compass.clearWatchFilter.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/compass/compass.clearWatchFilter.md b/www/docs/en/2.4.0/cordova/compass/compass.clearWatchFilter.md index 3d509d8..214eb1e 100644 --- a/www/docs/en/2.4.0/cordova/compass/compass.clearWatchFilter.md +++ b/www/docs/en/2.4.0/cordova/compass/compass.clearWatchFilter.md @@ -23,4 +23,4 @@ title: compass.clearWatchFilter 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](compass.clearWatch.html)`. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/compass/compass.getCurrentHeading.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/compass/compass.getCurrentHeading.md b/www/docs/en/2.4.0/cordova/compass/compass.getCurrentHeading.md index 0a2f35a..b8740b4 100644 --- a/www/docs/en/2.4.0/cordova/compass/compass.getCurrentHeading.md +++ b/www/docs/en/2.4.0/cordova/compass/compass.getCurrentHeading.md @@ -32,7 +32,7 @@ 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 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](parameters/compassSuccess.html)` callback function. Supported Platforms ------------------- @@ -45,7 +45,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- function onSuccess(heading) { @@ -58,7 +58,7 @@ Quick Example navigator.compass.getCurrentHeading(onSuccess, onError); -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/compass/compass.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/compass/compass.md b/www/docs/en/2.4.0/cordova/compass/compass.md index b53282f..bf5dc47 100644 --- a/www/docs/en/2.4.0/cordova/compass/compass.md +++ b/www/docs/en/2.4.0/cordova/compass/compass.md @@ -28,19 +28,19 @@ Compass Methods ------- -- compass.getCurrentHeading -- compass.watchHeading -- compass.clearWatch -- compass.watchHeadingFilter (obsolete) +- [compass.getCurrentHeading](compass.getCurrentHeading.html) +- [compass.watchHeading](compass.watchHeading.html) +- [compass.clearWatch](compass.clearWatch.html) +- [compass.watchHeadingFilter](compass.watchHeadingFilter.html) (obsolete) - compass.clearWatchFilter (obsolete) Arguments --------- -- compassSuccess -- compassError -- compassOptions -- compassHeading +- [compassSuccess](parameters/compassSuccess.html) +- [compassError](parameters/compassError.html) +- [compassOptions](parameters/compassOptions.html) +- [compassHeading](parameters/compassHeading.html) Permissions ----------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/compass/compass.watchHeading.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/compass/compass.watchHeading.md b/www/docs/en/2.4.0/cordova/compass/compass.watchHeading.md index 4101307..9bb8414 100644 --- a/www/docs/en/2.4.0/cordova/compass/compass.watchHeading.md +++ b/www/docs/en/2.4.0/cordova/compass/compass.watchHeading.md @@ -32,9 +32,9 @@ 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.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](parameters/compassOptions.html)` 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 references the compass watch interval. The watch ID can be used with `[compass.clearWatch](compass.clearWatch.html)` to stop watching the compass. Supported Platforms ------------------- @@ -48,7 +48,7 @@ Supported Platforms - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- function onSuccess(heading) { @@ -64,7 +64,7 @@ Quick Example var watchID = navigator.compass.watchHeading(onSuccess, onError, options); -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ @@ -132,6 +132,6 @@ Full Example 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 `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](parameters/compassOptions.html)` object. Clear the watch as normal by passing the returned watch ID to `[compass.clearWatch](compass.clearWatch.html)`. 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. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/compass/compass.watchHeadingFilter.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/compass/compass.watchHeadingFilter.md b/www/docs/en/2.4.0/cordova/compass/compass.watchHeadingFilter.md index d3531cf..b2aaebe 100644 --- a/www/docs/en/2.4.0/cordova/compass/compass.watchHeadingFilter.md +++ b/www/docs/en/2.4.0/cordova/compass/compass.watchHeadingFilter.md @@ -23,4 +23,4 @@ title: compass.watchHeadingFilter compass.watchHeadingFilter ========================== -No longer supported as of 1.6, see `compass.watchHeading` for equivalent functionality. +No longer supported as of 1.6, see `[compass.watchHeading](compass.watchHeading.html)` for equivalent functionality. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/compass/compassError/compassError.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/compass/compassError/compassError.md b/www/docs/en/2.4.0/cordova/compass/compassError/compassError.md index 25a2547..254f12b 100644 --- a/www/docs/en/2.4.0/cordova/compass/compassError/compassError.md +++ b/www/docs/en/2.4.0/cordova/compass/compassError/compassError.md @@ -23,7 +23,7 @@ title: CompassError CompassError ========== -A `CompassError` object is returned to the `compassError` callback function when an error occurs. +A `CompassError` object is returned to the `[compassError](../parameters/compassError.html)` callback function when an error occurs. Properties ---------- @@ -38,6 +38,6 @@ Constants Description ----------- -The `CompassError` object is returned to the user through the `compassError` callback function when an error occurs. +The `CompassError` object is returned to the user through the `[compassError](../parameters/compassError.html)` callback function when an error occurs. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/compass/parameters/compassError.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/compass/parameters/compassError.md b/www/docs/en/2.4.0/cordova/compass/parameters/compassError.md index fc209a5..facf067 100644 --- a/www/docs/en/2.4.0/cordova/compass/parameters/compassError.md +++ b/www/docs/en/2.4.0/cordova/compass/parameters/compassError.md @@ -25,7 +25,7 @@ compassError onError callback function for compass functions. -Example +[Example](../../storage/storage.opendatabase.html) ------- function(CompassError) { http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/compass/parameters/compassHeading.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/compass/parameters/compassHeading.md b/www/docs/en/2.4.0/cordova/compass/parameters/compassHeading.md index 1743f37..1d2bddc 100644 --- a/www/docs/en/2.4.0/cordova/compass/parameters/compassHeading.md +++ b/www/docs/en/2.4.0/cordova/compass/parameters/compassHeading.md @@ -23,7 +23,7 @@ title: compassHeading compassHeading ========== -A `CompassHeading` object is returned to the `compassSuccess` callback function when an error occurs. +A `CompassHeading` object is returned to the `[compassSuccess](compassSuccess.html)` callback function when an error occurs. Properties ---------- @@ -35,7 +35,7 @@ Properties Description ----------- -The `CompassHeading` object is returned to the user through the `compassSuccess` callback function. +The `CompassHeading` object is returned to the user through the `[compassSuccess](compassSuccess.html)` callback function. Android Quirks -------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/compass/parameters/compassSuccess.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/compass/parameters/compassSuccess.md b/www/docs/en/2.4.0/cordova/compass/parameters/compassSuccess.md index 43ece54..597fe5a 100644 --- a/www/docs/en/2.4.0/cordova/compass/parameters/compassSuccess.md +++ b/www/docs/en/2.4.0/cordova/compass/parameters/compassSuccess.md @@ -23,7 +23,7 @@ title: compassSuccess 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](compassHeading.html) object. function(heading) { // Do something @@ -35,7 +35,7 @@ Parameters - __heading:__ The heading information. _(compassHeading)_ -Example +[Example](../../storage/storage.opendatabase.html) ------- function onSuccess(heading) { http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/connection/connection.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/connection/connection.md b/www/docs/en/2.4.0/cordova/connection/connection.md index 20f58dd..b6e14bd 100644 --- a/www/docs/en/2.4.0/cordova/connection/connection.md +++ b/www/docs/en/2.4.0/cordova/connection/connection.md @@ -30,7 +30,7 @@ This object is exposed as `navigator.connection`. Properties ---------- -- connection.type +- [connection.type](connection.type.html) Constants --------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/connection/connection.type.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/connection/connection.type.md b/www/docs/en/2.4.0/cordova/connection/connection.type.md index 79cfc94..e09472b 100644 --- a/www/docs/en/2.4.0/cordova/connection/connection.type.md +++ b/www/docs/en/2.4.0/cordova/connection/connection.type.md @@ -42,7 +42,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- function checkConnection() { @@ -62,7 +62,7 @@ Quick Example checkConnection(); -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ @@ -95,7 +95,7 @@ Full Example states[Connection.CELL_4G] = 'Cell 4G connection'; states[Connection.NONE] = 'No network connection'; - alert('Connection type: ' + states[networkState]); + alert('[Connection](connection.html) type: ' + states[networkState]); } @@ -107,7 +107,7 @@ Full Example API Change ---------- -Before Cordova 2.3.0, the Connection object existed at: `navigator.network.connection`. +Before Cordova 2.3.0, the [Connection](connection.html) object existed at: `navigator.network.connection`. To match the spec, this was changed to `navigator.connection` in 2.3.0. @@ -133,7 +133,7 @@ webOS Quirks Windows Phone Quirks -------------------- -- When running in the emulator, always detects `navigator.connection.type` as `Connection.UNKNOWN`. +- When running in the emulator, always detects `navigator.connection.type` as `[Connection](connection.html).UNKNOWN`. Tizen Quirks -------------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/contacts/Contact/contact.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/contacts/Contact/contact.md b/www/docs/en/2.4.0/cordova/contacts/Contact/contact.md index 8af0447..55d47a8 100644 --- a/www/docs/en/2.4.0/cordova/contacts/Contact/contact.md +++ b/www/docs/en/2.4.0/cordova/contacts/Contact/contact.md @@ -47,14 +47,14 @@ Methods ------- - __clone__: Returns a new Contact object that is a deep copy of the calling object, with the id property set to `null`. -- __remove__: Removes the contact from the device contacts database. An error callback is called with a `ContactError` object if the removal is unsuccessful. +- __remove__: Removes the contact from the device contacts database. An error callback is called with a `[ContactError](../ContactError/contactError.html)` object if the removal is unsuccessful. - __save__: Saves a new contact to the device contacts database, or updates an existing contact if a contact with the same __id__ already exists. Details ------- -The `Contact` object represents a user contact. Contacts can be created, saved to, or removed from the device contacts database. Contacts can also be retrieved (individually or in bulk) from the database by invoking the `contacts.find` method. +The `Contact` object represents a user contact. [Contacts](../contacts.html) can be created, saved to, or removed from the device contacts database. [Contacts](../contacts.html) can also be retrieved (individually or in bulk) from the database by invoking the `[contacts.find](../contacts.find.html)` method. _Note: Not all of the above contact fields are supported on every device platform. Please check each platform's Quirks section for information about which fields are supported._ @@ -68,7 +68,7 @@ Supported Platforms - Bada 1.2 & 2.0 - Windows 8 -Save Quick Example +Save Quick [Example](../../storage/storage.opendatabase.html) ------------------ function onSuccess(contact) { @@ -76,7 +76,7 @@ Save Quick Example }; function onError(contactError) { - alert("Error = " + contactError.code); + alert("Error = " + [contactError](../parameters/contactError.html).code); }; // create a new contact object @@ -85,7 +85,7 @@ Save Quick Example contact.nickname = "Plumber"; //specify both to support all devices // populate some fields - var name = new ContactName(); + var name = new [ContactName](../ContactName/contactname.html)(); name.givenName = "Jane"; name.familyName = "Doe"; contact.name = name; @@ -93,7 +93,7 @@ Save Quick Example // save to device contact.save(onSuccess,onError); -Clone Quick Example +Clone Quick [Example](../../storage/storage.opendatabase.html) ------------------- // clone the contact object @@ -102,7 +102,7 @@ Clone Quick Example console.log("Original contact name = " + contact.name.givenName); console.log("Cloned contact name = " + clone.name.givenName); -Remove Quick Example +Remove Quick [Example](../../storage/storage.opendatabase.html) -------------------- function onSuccess() { @@ -116,7 +116,7 @@ Remove Quick Example // remove the contact from the device contact.remove(onSuccess,onError); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ @@ -138,7 +138,7 @@ Full Example var contact = navigator.contacts.create(); contact.displayName = "Plumber"; contact.nickname = "Plumber"; //specify both to support all devices - var name = new ContactName(); + var name = new [ContactName](../ContactName/contactname.html)(); name.givenName = "Jane"; name.familyName = "Doe"; contact.name = name; @@ -165,7 +165,7 @@ Full Example // onSaveError: Failed to get the contacts // function onSaveError(contactError) { - alert("Error = " + contactError.code); + alert("Error = " + [contactError](../parameters/contactError.html).code); } // onRemoveSuccess: Get a snapshot of the current contacts @@ -177,7 +177,7 @@ Full Example // onRemoveError: Failed to get the contacts // function onRemoveError(contactError) { - alert("Error = " + contactError.code); + alert("Error = " + [contactError](../parameters/contactError.html).code); } @@ -211,16 +211,16 @@ BlackBerry WebWorks (OS 5.0 and higher) Quirks iOS Quirks ---------- -- __displayName:__ This property is not supported by iOS and will be returned as `null` unless there is no ContactName specified. If there is no ContactName, then composite name, __nickname__ or "" is returned for __displayName__, respectively. +- __displayName:__ This property is not supported by iOS and will be returned as `null` unless there is no [ContactName](../ContactName/contactname.html) specified. If there is no [ContactName](../ContactName/contactname.html), then composite name, __nickname__ or "" is returned for __displayName__, respectively. - __birthday:__ For input, this property must be provided as a JavaScript Date object. It is returned as a JavaScript Date object. -- __photos:__ Returned Photo is stored in the application's temporary directory and a File URL to photo is returned. Contents of temporary folder is deleted when application exits. +- __photos:__ Returned Photo is stored in the application's temporary directory and a [File](../../file/fileobj/fileobj.html) URL to photo is returned. Contents of temporary folder is deleted when application exits. - __categories:__ This property is not currently supported and will always be returned as `null`. Windows Phone 7 and 8 Quirks ----------- - __displayName:__ When creating a contact, the value provided for the display name parameter differs from the display name retrieved when finding the contact. -- __urls:__ When creating a contact, user inputs multiple web addresses in the url field and saves the contact. While pulling the information during the contact search url field do not show up multiple web addresses +- __urls:__ When creating a contact, user inputs multiple web addresses in the url field and saves the contact. While pulling the information during the contact search url field do not [show](../../splashscreen/splashscreen.show.html) up multiple web addresses - __phoneNumbers:__ _pref_ is not supported, _type_ is not supported in a _find_ operation, only supports one phoneNumber of each _type_ - __emails:__ _pref_ is not supported, home and personal points to same email entry, supports only one entry for each _type_ - __addresses:__ supports only _type_ of work, home/personal, _type_ home and personal points to same address entry, supports only one entry for each _type_ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/contacts/ContactAddress/contactaddress.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/contacts/ContactAddress/contactaddress.md b/www/docs/en/2.4.0/cordova/contacts/ContactAddress/contactaddress.md index d711367..627719c 100644 --- a/www/docs/en/2.4.0/cordova/contacts/ContactAddress/contactaddress.md +++ b/www/docs/en/2.4.0/cordova/contacts/ContactAddress/contactaddress.md @@ -23,7 +23,7 @@ title: ContactAddress ContactAddress ============== -Contains address properties for a `Contact` object. +Contains address properties for a `[Contact](../Contact/contact.html)` object. Properties ---------- @@ -39,7 +39,7 @@ Properties Details ------- -The `ContactAddress` object stores the properties of a single address of a contact. A `Contact` object can have one or more addresses in a `ContactAddress[]` array. +The `ContactAddress` object stores the properties of a single address of a contact. A `[Contact](../Contact/contact.html)` object can have one or more addresses in a `ContactAddress[]` array. Supported Platforms ------------------- @@ -51,7 +51,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../../storage/storage.opendatabase.html) ------------- // display the address information for all contacts @@ -80,7 +80,7 @@ Quick Example var filter = ["displayName","addresses"]; navigator.contacts.find(filter, onSuccess, onError, options); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ @@ -99,7 +99,7 @@ Full Example // function onDeviceReady() { // find all contacts - var options = new ContactFindOptions(); + var options = new [ContactFindOptions](../ContactFindOptions/contactfindoptions.html)(); options.filter=""; var filter = ["displayName","addresses"]; navigator.contacts.find(filter, onSuccess, onError, options); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/contacts/ContactError/contactError.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/contacts/ContactError/contactError.md b/www/docs/en/2.4.0/cordova/contacts/ContactError/contactError.md index 0c6d3c4..bb2ae8a 100644 --- a/www/docs/en/2.4.0/cordova/contacts/ContactError/contactError.md +++ b/www/docs/en/2.4.0/cordova/contacts/ContactError/contactError.md @@ -23,7 +23,7 @@ title: ContactError ContactError ======== -A `ContactError` object is returned to the `contactError` callback when an error occurs. +A `ContactError` object is returned to the `[contactError](../parameters/contactError.html)` callback when an error occurs. Properties ---------- @@ -44,5 +44,5 @@ Constants Description ----------- -The `ContactError` object is returned to the user through the `contactError` callback function when an error occurs. +The `ContactError` object is returned to the user through the `[contactError](../parameters/contactError.html)` callback function when an error occurs. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/contacts/ContactField/contactfield.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/contacts/ContactField/contactfield.md b/www/docs/en/2.4.0/cordova/contacts/ContactField/contactfield.md index ea00f86..ea6ceb4 100644 --- a/www/docs/en/2.4.0/cordova/contacts/ContactField/contactfield.md +++ b/www/docs/en/2.4.0/cordova/contacts/ContactField/contactfield.md @@ -23,7 +23,7 @@ title: ContactField ContactField ============ -Supports generic fields in a `Contact` object. Some properties that are stored as `ContactField` objects include email addresses, phone numbers, and urls. +Supports generic fields in a `[Contact](../Contact/contact.html)` object. Some properties that are stored as `ContactField` objects include email addresses, phone numbers, and urls. Properties ---------- @@ -35,9 +35,9 @@ Properties Details ------- -The `ContactField` object is a reusable component that is used to support contact fields in a generic fashion. Each `ContactField` object contains a value property, a type property, and a pref property. A `Contact` object stores several properties in `ContactField[]` arrays, such as phone numbers and email addresses. +The `ContactField` object is a reusable component that is used to support contact fields in a generic fashion. Each `ContactField` object contains a value property, a type property, and a pref property. A `[Contact](../Contact/contact.html)` object stores several properties in `ContactField[]` arrays, such as phone numbers and email addresses. -In most instances, there are no pre-determined values for the __type__ attribute of a `ContactField` object. For example, a phone number can have __type__ values of 'home', 'work', 'mobile', 'iPhone', or any other value that is supported by the contact database on a particular device platform. However, in the case of the `Contact` __photos__ field, Cordova makes use of the __type__ field to indicate the format of the returned image. Cordova will return __type: 'url'__ when the __value__ attribute contains a URL to the photo image, or __type: 'base64'__ when the returned __value__ attribute contains a Base64 encoded image string. +In most instances, there are no pre-determined values for the __type__ attribute of a `ContactField` object. For example, a phone number can have __type__ values of 'home', 'work', 'mobile', 'iPhone', or any other value that is supported by the contact database on a particular device platform. However, in the case of the `[Contact](../Contact/contact.html)` __photos__ field, Cordova makes use of the __type__ field to indicate the format of the returned image. Cordova will return __type: 'url'__ when the __value__ attribute contains a URL to the photo image, or __type: 'base64'__ when the returned __value__ attribute contains a Base64 encoded image string. Supported Platforms ------------------- @@ -49,7 +49,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../../storage/storage.opendatabase.html) ------------- // create a new contact @@ -65,7 +65,7 @@ Quick Example // save the contact contact.save(); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ @@ -97,7 +97,7 @@ Full Example contact.save(); // search contacts, returning display name and phone numbers - var options = new ContactFindOptions(); + var options = new [ContactFindOptions](../ContactFindOptions/contactfindoptions.html)(); options.filter=""; filter = ["displayName","phoneNumbers"]; navigator.contacts.find(filter, onSuccess, onError, options); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/contacts/ContactFindOptions/contactfindoptions.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/contacts/ContactFindOptions/contactfindoptions.md b/www/docs/en/2.4.0/cordova/contacts/ContactFindOptions/contactfindoptions.md index 657b430..df0dc5a 100644 --- a/www/docs/en/2.4.0/cordova/contacts/ContactFindOptions/contactfindoptions.md +++ b/www/docs/en/2.4.0/cordova/contacts/ContactFindOptions/contactfindoptions.md @@ -23,7 +23,7 @@ title: ContactFindOptions ContactFindOptions ================== -Contains properties that can be used to filter the results of a `contacts.find` operation. +Contains properties that can be used to filter the results of a `[contacts.find](../contacts.find.html)` operation. Properties ---------- @@ -42,7 +42,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../../storage/storage.opendatabase.html) ------------- // success callback @@ -66,7 +66,7 @@ Quick Example // find contacts navigator.contacts.find(filter, onSuccess, onError, options); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/contacts/ContactName/contactname.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/contacts/ContactName/contactname.md b/www/docs/en/2.4.0/cordova/contacts/ContactName/contactname.md index 85f3950..0d8e1d0 100644 --- a/www/docs/en/2.4.0/cordova/contacts/ContactName/contactname.md +++ b/www/docs/en/2.4.0/cordova/contacts/ContactName/contactname.md @@ -23,7 +23,7 @@ title: ContactName ContactName =========== -Contains name properties of a `Contact` object. +Contains name properties of a `[Contact](../Contact/contact.html)` object. Properties ---------- @@ -50,7 +50,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../../storage/storage.opendatabase.html) ------------- function onSuccess(contacts) { @@ -73,7 +73,7 @@ Quick Example filter = ["displayName","name"]; navigator.contacts.find(filter, onSuccess, onError, options); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ @@ -91,7 +91,7 @@ Full Example // Cordova is ready // function onDeviceReady() { - var options = new ContactFindOptions(); + var options = new [ContactFindOptions](../ContactFindOptions/contactfindoptions.html)(); options.filter=""; filter = ["displayName","name"]; navigator.contacts.find(filter, onSuccess, onError, options); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/contacts/ContactOrganization/contactorganization.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/contacts/ContactOrganization/contactorganization.md b/www/docs/en/2.4.0/cordova/contacts/ContactOrganization/contactorganization.md index f5d7ee1..12c8938 100644 --- a/www/docs/en/2.4.0/cordova/contacts/ContactOrganization/contactorganization.md +++ b/www/docs/en/2.4.0/cordova/contacts/ContactOrganization/contactorganization.md @@ -23,7 +23,7 @@ title: ContactOrganization ContactOrganization =================== -Contains organization properties of a `Contact` object. +Contains organization properties of a `[Contact](../Contact/contact.html)` object. Properties ---------- @@ -36,7 +36,7 @@ Properties Details ------- -The `ContactOrganization` object stores a contact's organization properties. A `Contact` object stores one or more `ContactOrganization` objects in an array. +The `ContactOrganization` object stores a contact's organization properties. A `[Contact](../Contact/contact.html)` object stores one or more `ContactOrganization` objects in an array. Supported Platforms ------------------- @@ -48,7 +48,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../../storage/storage.opendatabase.html) ------------- function onSuccess(contacts) { @@ -72,7 +72,7 @@ Quick Example filter = ["displayName","organizations"]; navigator.contacts.find(filter, onSuccess, onError, options); -Full Example +Full [Example](../../storage/storage.opendatabase.html) ------------ @@ -90,7 +90,7 @@ Full Example // Cordova is ready // function onDeviceReady() { - var options = new ContactFindOptions(); + var options = new [ContactFindOptions](../ContactFindOptions/contactfindoptions.html)(); options.filter=""; filter = ["displayName","organizations"]; navigator.contacts.find(filter, onSuccess, onError, options); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/contacts/contacts.create.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/contacts/contacts.create.md b/www/docs/en/2.4.0/cordova/contacts/contacts.create.md index 8609019..71e9808 100644 --- a/www/docs/en/2.4.0/cordova/contacts/contacts.create.md +++ b/www/docs/en/2.4.0/cordova/contacts/contacts.create.md @@ -23,16 +23,16 @@ title: contacts.create contacts.create =============== -Returns a new Contact object. +Returns a new [Contact](Contact/contact.html) object. var contact = navigator.contacts.create(properties); Description ----------- -contacts.create is a synchronous function that returns a new `Contact` object. +contacts.create is a synchronous function that returns a new `[Contact](Contact/contact.html)` object. -This method does not persist the Contact object to the device contacts database. To persist the Contact object to the device, invoke the `Contact.save` method. +This method does not persist the [Contact](Contact/contact.html) object to the device contacts database. To persist the [Contact](Contact/contact.html) object to the device, invoke the `[Contact](Contact/contact.html).save` method. Supported Platforms ------------------- @@ -43,12 +43,12 @@ Supported Platforms - Windows Phone 7 and 8 - Bada 1.2 & 2.0 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- var myContact = navigator.contacts.create({"displayName": "Test User"}); -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/contacts/contacts.find.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/contacts/contacts.find.md b/www/docs/en/2.4.0/cordova/contacts/contacts.find.md index 56a6038..5143dc6 100644 --- a/www/docs/en/2.4.0/cordova/contacts/contacts.find.md +++ b/www/docs/en/2.4.0/cordova/contacts/contacts.find.md @@ -23,23 +23,23 @@ title: contacts.find contacts.find ============= -Queries the device contacts database and returns one or more `Contact` objects, each containing the fields specified. +Queries the device contacts database and returns one or more `[Contact](Contact/contact.html)` objects, each containing the fields specified. navigator.contacts.find(contactFields, contactSuccess, contactError, contactFindOptions); Description ----------- -contacts.find is an asynchronous function that queries the device contacts database and returns an array of `Contact` objects. The resulting objects are passed to the `contactSuccess` callback function specified by the __contactSuccess__ parameter. +contacts.find is an asynchronous function that queries the device contacts database and returns an array of `[Contact](Contact/contact.html)` objects. The resulting objects are passed to the `[contactSuccess](parameters/contactSuccess.html)` callback function specified by the __contactSuccess__ parameter. -Users must specify the contact fields to be used as a search qualifier in the __contactFields__ parameter. Only the fields specified in the __contactFields__ parameter will be returned as properties of the `Contact` objects that are passed to the __contactSuccess__ callback function. A zero-length __contactFields__ parameter will result in an array of `Contact` objects with only the `id` property populated. A __contactFields__ value of ["*"] will return all contact fields. +Users must specify the contact fields to be used as a search qualifier in the __contactFields__ parameter. Only the fields specified in the __contactFields__ parameter will be returned as properties of the `[Contact](Contact/contact.html)` objects that are passed to the __contactSuccess__ callback function. A zero-length __contactFields__ parameter will result in an array of `[Contact](Contact/contact.html)` objects with only the `id` property populated. A __contactFields__ value of ["*"] will return all contact fields. The __contactFindOptions.filter__ string can be used as a search filter when querying the contacts database. If provided, a case-insensitive, partial value match is applied to each field specified in the __contactFields__ parameter. If a match is found in a comparison with _any_ of the specified fields, the contact is returned. Parameters ---------- -- __contactFields:__ Contact fields to be used as search qualifier. Only these fields will have values in the resulting `Contact` objects. _(DOMString[])_ [Required] +- __contactFields:__ [Contact](Contact/contact.html) fields to be used as search qualifier. Only these fields will have values in the resulting `[Contact](Contact/contact.html)` objects. _(DOMString[])_ [Required] - __contactSuccess:__ Success callback function that is invoked with the contacts returned from the contacts database. [Required] - __contactError:__ Error callback function. Invoked when error occurs. [Optional] - __contactFindOptions:__ Search options to filter contacts. [Optional] @@ -54,7 +54,7 @@ Supported Platforms - Bada 1.2 & 2.0 - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- function onSuccess(contacts) { @@ -72,7 +72,7 @@ Quick Example var fields = ["displayName", "name"]; navigator.contacts.find(fields, onSuccess, onError, options); -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ @@ -91,7 +91,7 @@ Full Example // function onDeviceReady() { // find all contacts with 'Bob' in any name field - var options = new ContactFindOptions(); + var options = new [ContactFindOptions](ContactFindOptions/contactfindoptions.html)(); options.filter="Bob"; var fields = ["displayName", "name"]; navigator.contacts.find(fields, onSuccess, onError, options); http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/contacts/contacts.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/contacts/contacts.md b/www/docs/en/2.4.0/cordova/contacts/contacts.md index 38fb2dc..f23887e 100644 --- a/www/docs/en/2.4.0/cordova/contacts/contacts.md +++ b/www/docs/en/2.4.0/cordova/contacts/contacts.md @@ -28,27 +28,27 @@ Contacts Methods ------- -- contacts.create -- contacts.find +- [contacts.create](contacts.create.html) +- [contacts.find](contacts.find.html) Arguments --------- -- contactFields -- contactSuccess -- contactError -- contactFindOptions +- [contactFields](parameters/contactFields.html) +- [contactSuccess](parameters/contactSuccess.html) +- [contactError](parameters/contactError.html) +- [contactFindOptions](parameters/contactFindOptions.html) Objects ------- -- Contact -- ContactName -- ContactField -- ContactAddress -- ContactOrganization -- ContactFindOptions -- ContactError +- [Contact](Contact/contact.html) +- [ContactName](ContactName/contactname.html) +- [ContactField](ContactField/contactfield.html) +- [ContactAddress](ContactAddress/contactaddress.html) +- [ContactOrganization](ContactOrganization/contactorganization.html) +- [ContactFindOptions](ContactFindOptions/contactfindoptions.html) +- [ContactError](ContactError/contactError.html) Permissions ----------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/contacts/parameters/contactFields.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/contacts/parameters/contactFields.md b/www/docs/en/2.4.0/cordova/contacts/parameters/contactFields.md index ae27dd7..368541b 100644 --- a/www/docs/en/2.4.0/cordova/contacts/parameters/contactFields.md +++ b/www/docs/en/2.4.0/cordova/contacts/parameters/contactFields.md @@ -23,6 +23,6 @@ title: contactFields contactFields ============= -Required parameter of the `contacts.find` method. Use this parameter to specify which fields should be included in the `Contact` objects resulting from a find operation. +Required parameter of the `[contacts.find](../contacts.find.html)` method. Use this parameter to specify which fields should be included in the `[Contact](../Contact/contact.html)` objects resulting from a find operation. ["name", "phoneNumbers", "emails"] http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/contacts/parameters/contactFindOptions.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/contacts/parameters/contactFindOptions.md b/www/docs/en/2.4.0/cordova/contacts/parameters/contactFindOptions.md index b166110..9459ec4 100644 --- a/www/docs/en/2.4.0/cordova/contacts/parameters/contactFindOptions.md +++ b/www/docs/en/2.4.0/cordova/contacts/parameters/contactFindOptions.md @@ -23,7 +23,7 @@ title: contactFindOptions contactFindOptions ================== -Optional parameter of the `contacts.find` method. Use this parameter to filter the contacts returned from the contacts database. +Optional parameter of the `[contacts.find](../contacts.find.html)` method. Use this parameter to filter the contacts returned from the contacts database. { filter: "", http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/contacts/parameters/contactSuccess.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/contacts/parameters/contactSuccess.md b/www/docs/en/2.4.0/cordova/contacts/parameters/contactSuccess.md index 22137b6..6b5204c 100644 --- a/www/docs/en/2.4.0/cordova/contacts/parameters/contactSuccess.md +++ b/www/docs/en/2.4.0/cordova/contacts/parameters/contactSuccess.md @@ -23,7 +23,7 @@ title: contactSuccess contactSuccess ============== -Success callback function that provides the `Contact` array resulting from a `contacts.find` operation. +Success callback function that provides the `[Contact](../Contact/contact.html)` array resulting from a `[contacts.find](../contacts.find.html)` operation. function(contacts) { // Do something @@ -32,9 +32,9 @@ Success callback function that provides the `Contact` array resulting from a `co Parameters ---------- -- __contacts:__ The contact array resulting from a find operation. (`Contact`) +- __contacts:__ The contact array resulting from a find operation. (`[Contact](../Contact/contact.html)`) -Example +[Example](../../storage/storage.opendatabase.html) ------- function contactSuccess(contacts) { http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/device/device.cordova.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/device/device.cordova.md b/www/docs/en/2.4.0/cordova/device/device.cordova.md index cadd5ae..eb3aebc 100644 --- a/www/docs/en/2.4.0/cordova/device/device.cordova.md +++ b/www/docs/en/2.4.0/cordova/device/device.cordova.md @@ -43,12 +43,12 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- var name = device.cordova; -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/device/device.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/device/device.md b/www/docs/en/2.4.0/cordova/device/device.md index 3e50ace..5c97373 100644 --- a/www/docs/en/2.4.0/cordova/device/device.md +++ b/www/docs/en/2.4.0/cordova/device/device.md @@ -28,12 +28,12 @@ Device Properties ---------- -- device.name -- device.cordova -- device.platform -- device.uuid -- device.version -- device.model +- [device.name](device.name.html) +- [device.cordova](device.cordova.html) +- [device.platform](device.platform.html) +- [device.uuid](device.uuid.html) +- [device.version](device.version.html) +- [device.model](device.model.html) Variable Scope -------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/device/device.model.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/device/device.model.md b/www/docs/en/2.4.0/cordova/device/device.model.md index 6bc875f..8dbbd4d 100644 --- a/www/docs/en/2.4.0/cordova/device/device.model.md +++ b/www/docs/en/2.4.0/cordova/device/device.model.md @@ -44,7 +44,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- // Android: Nexus One returns "Passion" (Nexus One code name) @@ -54,7 +54,7 @@ Quick Example // var model = device.model; -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/device/device.name.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/device/device.name.md b/www/docs/en/2.4.0/cordova/device/device.name.md index b76c55c..4fbc67a 100644 --- a/www/docs/en/2.4.0/cordova/device/device.name.md +++ b/www/docs/en/2.4.0/cordova/device/device.name.md @@ -22,7 +22,7 @@ title: device.name device.name =========== -WARNING: device.name is deprecated as of version 2.3.0, use device.model instead +WARNING: device.name is deprecated as of version 2.3.0, use [device.model](device.model.html) instead Get the device's model name. @@ -45,7 +45,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- // Android: Nexus One returns "Passion" (Nexus One code name) @@ -55,7 +55,7 @@ Quick Example // var name = device.name; -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ @@ -109,4 +109,4 @@ Bada Quirks Tizen Quirks ----------- -- returns the device model assigned by the vendor. For example 'TIZEN' +- returns the [device.model](device.model.html) assigned by the vendor. For example 'TIZEN' http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/device/device.platform.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/device/device.platform.md b/www/docs/en/2.4.0/cordova/device/device.platform.md index 4c0f123..cdf89da 100644 --- a/www/docs/en/2.4.0/cordova/device/device.platform.md +++ b/www/docs/en/2.4.0/cordova/device/device.platform.md @@ -39,7 +39,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- // Depending on the device, a few examples are: @@ -51,7 +51,7 @@ Quick Example // - "Tizen" var devicePlatform = device.platform; -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/device/device.uuid.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/device/device.uuid.md b/www/docs/en/2.4.0/cordova/device/device.uuid.md index adf3997..072af66 100644 --- a/www/docs/en/2.4.0/cordova/device/device.uuid.md +++ b/www/docs/en/2.4.0/cordova/device/device.uuid.md @@ -44,7 +44,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- // Android: Returns a random 64-bit integer (as a string, again!) @@ -66,7 +66,7 @@ Quick Example // unique to every GSM and UMTS mobile phone. var deviceID = device.uuid; -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/device/device.version.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/device/device.version.md b/www/docs/en/2.4.0/cordova/device/device.version.md index 77eda1c..9dead54 100644 --- a/www/docs/en/2.4.0/cordova/device/device.version.md +++ b/www/docs/en/2.4.0/cordova/device/device.version.md @@ -39,7 +39,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- // Android: Froyo OS would return "2.2" @@ -55,7 +55,7 @@ Quick Example // Tizen: returns "TIZEN_20120425_2" var deviceVersion = device.version; -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/events/events.backbutton.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/events/events.backbutton.md b/www/docs/en/2.4.0/cordova/events/events.backbutton.md index 4ed7c20..1ce1698 100644 --- a/www/docs/en/2.4.0/cordova/events/events.backbutton.md +++ b/www/docs/en/2.4.0/cordova/events/events.backbutton.md @@ -32,7 +32,7 @@ Details If you need to override the default back button behaviour you can register an event listener for the 'backbutton' event. It is no longer necessary to call any other method to over ride the back button behaviour. Now, you only need to register an event listener for 'backbutton'. -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. +Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -41,7 +41,7 @@ Supported Platforms - BlackBerry WebWorks (OS 5.0 and higher) - Windows Phone 7 and 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("backbutton", onBackKeyDown, false); @@ -50,7 +50,7 @@ Quick Example // Handle the back button } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/events/events.batterycritical.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/events/events.batterycritical.md b/www/docs/en/2.4.0/cordova/events/events.batterycritical.md index 55f8971..3240c0e 100644 --- a/www/docs/en/2.4.0/cordova/events/events.batterycritical.md +++ b/www/docs/en/2.4.0/cordova/events/events.batterycritical.md @@ -37,7 +37,7 @@ The batterycritical handler will be called with an object that contains two prop - __level:__ The percentage of battery (0-100). _(Number)_ - __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_ -Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event. +Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -47,7 +47,7 @@ Supported Platforms - BlackBerry WebWorks (OS 5.0 and higher) - Tizen -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- window.addEventListener("batterycritical", onBatteryCritical, false); @@ -57,7 +57,7 @@ Quick Example alert("Battery Level Critical " + info.level + "%\nRecharge Soon!"); } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/events/events.batterylow.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/events/events.batterylow.md b/www/docs/en/2.4.0/cordova/events/events.batterylow.md index cbbae27..a039fa5 100644 --- a/www/docs/en/2.4.0/cordova/events/events.batterylow.md +++ b/www/docs/en/2.4.0/cordova/events/events.batterylow.md @@ -37,7 +37,7 @@ The batterylow handler will be called with an object that contains two propertie - __level:__ The percentage of battery (0-100). _(Number)_ - __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_ -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. +Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -47,7 +47,7 @@ Supported Platforms - BlackBerry WebWorks (OS 5.0 and higher) - Tizen -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- window.addEventListener("batterylow", onBatteryLow, false); @@ -57,7 +57,7 @@ Quick Example alert("Battery Level Low " + info.level + "%"); } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/events/events.batterystatus.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/events/events.batterystatus.md b/www/docs/en/2.4.0/cordova/events/events.batterystatus.md index 46f2051..50c4cc8 100644 --- a/www/docs/en/2.4.0/cordova/events/events.batterystatus.md +++ b/www/docs/en/2.4.0/cordova/events/events.batterystatus.md @@ -37,7 +37,7 @@ The battery status handler will be called with an object that contains two prope - __level:__ The percentage of battery (0-100). _(Number)_ - __isPlugged:__ A boolean that represents whether or not the device is plugged in or not. _(Boolean)_ -Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova 'deviceready' event. +Typically, you will want to attach an event listener with `window.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -55,7 +55,7 @@ The `level` property is unavailable as Windows Phone 7 does not provide native APIs for determining battery level. The `isPlugged` parameter _is_ supported. -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- window.addEventListener("batterystatus", onBatteryStatus, false); @@ -65,7 +65,7 @@ Quick Example console.log("Level: " + info.level + " isPlugged: " + info.isPlugged); } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/events/events.deviceready.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/events/events.deviceready.md b/www/docs/en/2.4.0/cordova/events/events.deviceready.md index dfb8280..bdf374f 100644 --- a/www/docs/en/2.4.0/cordova/events/events.deviceready.md +++ b/www/docs/en/2.4.0/cordova/events/events.deviceready.md @@ -51,7 +51,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("deviceready", onDeviceReady, false); @@ -60,7 +60,7 @@ Quick Example // Now safe to use the Cordova API } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/events/events.endcallbutton.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/events/events.endcallbutton.md b/www/docs/en/2.4.0/cordova/events/events.endcallbutton.md index 2163115..fdf47bd 100644 --- a/www/docs/en/2.4.0/cordova/events/events.endcallbutton.md +++ b/www/docs/en/2.4.0/cordova/events/events.endcallbutton.md @@ -32,14 +32,14 @@ Details If you need to override the default end call behaviour you can register an event listener for the 'endcallbutton' event. -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. +Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- - BlackBerry WebWorks (OS 5.0 and higher) -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("endcallbutton", onEndCallKeyDown, false); @@ -48,7 +48,7 @@ Quick Example // Handle the end call button } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/events/events.online.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/events/events.online.md b/www/docs/en/2.4.0/cordova/events/events.online.md index 247ff34..0a0d6e0 100644 --- a/www/docs/en/2.4.0/cordova/events/events.online.md +++ b/www/docs/en/2.4.0/cordova/events/events.online.md @@ -32,7 +32,7 @@ Details When the application's network connection changes to being online, the online event is fired. -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. +Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -44,7 +44,7 @@ Supported Platforms - Tizen - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("online", onOnline, false); @@ -53,7 +53,7 @@ Quick Example // Handle the online event } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/events/events.pause.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/events/events.pause.md b/www/docs/en/2.4.0/cordova/events/events.pause.md index 377f352..a2d0282 100644 --- a/www/docs/en/2.4.0/cordova/events/events.pause.md +++ b/www/docs/en/2.4.0/cordova/events/events.pause.md @@ -32,7 +32,7 @@ Details Cordova consists of two code bases: native and JavaScript. While the native code puts the application into the background the pause event is fired. -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. +Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -43,7 +43,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("pause", onPause, false); @@ -52,7 +52,7 @@ Quick Example // Handle the pause event } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/events/events.resume.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/events/events.resume.md b/www/docs/en/2.4.0/cordova/events/events.resume.md index a5f8308..9be4e62 100644 --- a/www/docs/en/2.4.0/cordova/events/events.resume.md +++ b/www/docs/en/2.4.0/cordova/events/events.resume.md @@ -32,7 +32,7 @@ Details Cordova consists of two code bases: native and JavaScript. While the native code pulls the application from the background the resume event is fired. -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. +Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- @@ -43,7 +43,7 @@ Supported Platforms - Windows Phone 7 and 8 - Windows 8 -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("resume", onResume, false); @@ -52,7 +52,7 @@ Quick Example // Handle the resume event } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------ http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76d1ffce/www/docs/en/2.4.0/cordova/events/events.searchbutton.md ---------------------------------------------------------------------- diff --git a/www/docs/en/2.4.0/cordova/events/events.searchbutton.md b/www/docs/en/2.4.0/cordova/events/events.searchbutton.md index ef2cce6..08488c6 100644 --- a/www/docs/en/2.4.0/cordova/events/events.searchbutton.md +++ b/www/docs/en/2.4.0/cordova/events/events.searchbutton.md @@ -32,14 +32,14 @@ Details If you need to override the default search button behaviour on Android you can register an event listener for the 'searchbutton' event. -Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event. +Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event. Supported Platforms ------------------- - Android -Quick Example +Quick [Example](../storage/storage.opendatabase.html) ------------- document.addEventListener("searchbutton", onSearchKeyDown, false); @@ -48,7 +48,7 @@ Quick Example // Handle the search button } -Full Example +Full [Example](../storage/storage.opendatabase.html) ------------