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 D65151745B for ; Thu, 10 Sep 2015 21:28:03 +0000 (UTC) Received: (qmail 23145 invoked by uid 500); 10 Sep 2015 21:28:02 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 23089 invoked by uid 500); 10 Sep 2015 21:28:02 -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 21533 invoked by uid 99); 10 Sep 2015 21:28:01 -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; Thu, 10 Sep 2015 21:28:01 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id BACFEE1086; Thu, 10 Sep 2015 21:28:01 +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: Thu, 10 Sep 2015 21:28:27 -0000 Message-Id: <6c14678a333f4e5e86cf87bf83e88a21@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [27/51] [partial] docs commit: Solidifying 'automatic' links. http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/contacts/ContactName/contactname.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/contacts/ContactName/contactname.md b/www/docs/en/1.6.0/cordova/contacts/ContactName/contactname.md index c6107f1..96eb4e7 100644 --- a/www/docs/en/1.6.0/cordova/contacts/ContactName/contactname.md +++ b/www/docs/en/1.6.0/cordova/contacts/ContactName/contactname.md @@ -18,10 +18,10 @@ license: > under the License. --- -ContactName +ContactName =========== -Contains name properties of a `Contact` object. +Contains name properties of a `Contact` object. Properties ---------- @@ -36,7 +36,7 @@ Properties Details ------- -The `ContactName` object stores name properties of a contact. +The `ContactName` object stores name properties of a contact. Supported Platforms ------------------- @@ -45,7 +45,7 @@ Supported Platforms - BlackBerry WebWorks (OS 5.0 and higher) - iOS -Quick Example +Quick Example ------------- function onSuccess(contacts) { @@ -59,37 +59,37 @@ Quick Example } }; - function onError(contactError) { + function onError(contactError) { alert('onError!'); }; - var options = new ContactFindOptions(); + var options = new ContactFindOptions(); options.filter=""; filter = ["displayName","name"]; - navigator.contacts.find(filter, onSuccess, onError, options); + navigator.contacts.find(filter, onSuccess, onError, options); -Full Example +Full Example ------------ - Contact Example + <a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a> -

Example

Find Contacts

Example

Find Contacts

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/contacts/ContactOrganization/contactorganization.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/contacts/ContactOrganization/contactorganization.md b/www/docs/en/1.6.0/cordova/contacts/ContactOrganization/contactorganization.md index f99ff2c..d01da0e 100644 --- a/www/docs/en/1.6.0/cordova/contacts/ContactOrganization/contactorganization.md +++ b/www/docs/en/1.6.0/cordova/contacts/ContactOrganization/contactorganization.md @@ -18,14 +18,14 @@ license: > under the License. --- -ContactOrganization +ContactOrganization =================== -Contains organization properties of a `Contact` object. +Contains organization properties of a `Contact` object. Properties ---------- -- __pref:__ Set to `true` if this `ContactOrganization` contains the user's preferred value. _(boolean)_ +- __pref:__ Set to `true` if this `ContactOrganization` contains the user's preferred value. _(boolean)_ - __type:__ A string that tells you what type of field this is (example: 'home'). _(DOMString) - __name:__ The name of the organization. _(DOMString)_ - __department:__ The department the contract works for. _(DOMString)_ @@ -34,7 +34,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` object stores one or more `ContactOrganization` objects in an array. Supported Platforms ------------------- @@ -43,7 +43,7 @@ Supported Platforms - BlackBerry WebWorks (OS 5.0 and higher) - iOS -Quick Example +Quick Example ------------- function onSuccess(contacts) { @@ -58,37 +58,37 @@ Quick Example } }; - function onError(contactError) { + function onError(contactError) { alert('onError!'); }; - var options = new ContactFindOptions(); + var options = new ContactFindOptions(); options.filter=""; filter = ["displayName","organizations"]; - navigator.contacts.find(filter, onSuccess, onError, options); + navigator.contacts.find(filter, onSuccess, onError, options); -Full Example +Full Example ------------ - Contact Example + <a href="../Contact/contact.html">Contact</a> <a href="../../storage/storage.opendatabase.html">Example</a> -

Example

Find Contacts

Example

Find Contacts

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/contacts/contacts.create.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/contacts/contacts.create.md b/www/docs/en/1.6.0/cordova/contacts/contacts.create.md index 2a14af0..2911abe 100644 --- a/www/docs/en/1.6.0/cordova/contacts/contacts.create.md +++ b/www/docs/en/1.6.0/cordova/contacts/contacts.create.md @@ -21,16 +21,16 @@ license: > contacts.create =============== -Returns a new Contact object. +Returns a new Contact 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` 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 object to the device contacts database. To persist the Contact object to the device, invoke the `Contact.save` method. Supported Platforms ------------------- @@ -39,39 +39,39 @@ Supported Platforms - BlackBerry WebWorks (OS 5.0 and higher) - iOS -Quick Example +Quick Example ------------- - var myContact = navigator.contacts.create({"displayName": "Test User"}); + var myContact = navigator.contacts.create({"displayName": "Test User"}); -Full Example +Full Example ------------ - Contact Example + <a href="Contact/contact.html">Contact</a> <a href="../storage/storage.opendatabase.html">Example</a> -

Example

Create Contact

Example

Create Contact

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/contacts/contacts.find.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/contacts/contacts.find.md b/www/docs/en/1.6.0/cordova/contacts/contacts.find.md index 8af46ae..7ab7197 100644 --- a/www/docs/en/1.6.0/cordova/contacts/contacts.find.md +++ b/www/docs/en/1.6.0/cordova/contacts/contacts.find.md @@ -21,26 +21,26 @@ license: > 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` objects, each containing the fields specified. - navigator.contacts.find(contactFields, contactSuccess, contactError, contactFindOptions); + 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` objects. The resulting objects are passed to the `contactSuccess` 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` 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. -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. +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] -- __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] +- __contactFields:__ Contact fields to be used as search qualifier. Only these fields will have values in the resulting `Contact` 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] Supported Platforms ------------------- @@ -49,43 +49,43 @@ Supported Platforms - BlackBerry WebWorks (OS 5.0 and higher) - iOS -Quick Example +Quick Example ------------- function onSuccess(contacts) { alert('Found ' + contacts.length + ' contacts.'); }; - function onError(contactError) { + function onError(contactError) { alert('onError!'); }; // find all contacts with 'Bob' in any name field - var options = new ContactFindOptions(); + var options = new ContactFindOptions(); options.filter="Bob"; var fields = ["displayName", "name"]; navigator.contacts.find(fields, onSuccess, onError, options); -Full Example +Full Example ------------ - Contact Example + <a href="Contact/contact.html">Contact</a> <a href="../storage/storage.opendatabase.html">Example</a> -

Example

Find Contacts

Example

Find Contacts

http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/contacts/contacts.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/contacts/contacts.md b/www/docs/en/1.6.0/cordova/contacts/contacts.md index 03eb3d8..554a82d 100644 --- a/www/docs/en/1.6.0/cordova/contacts/contacts.md +++ b/www/docs/en/1.6.0/cordova/contacts/contacts.md @@ -18,7 +18,7 @@ license: > under the License. --- -Contacts +Contacts ======== > The `contacts` object provides access to the device contacts database. @@ -26,24 +26,24 @@ Contacts Methods ------- -- contacts.create -- contacts.find +- contacts.create +- contacts.find Arguments --------- -- contactFields -- contactSuccess -- contactError -- contactFindOptions +- contactFields +- contactSuccess +- contactError +- contactFindOptions Objects ------- -- Contact -- ContactName -- ContactField -- ContactAddress -- ContactOrganization -- ContactFindOptions -- ContactError \ No newline at end of file +- Contact +- ContactName +- ContactField +- ContactAddress +- ContactOrganization +- ContactFindOptions +- ContactError \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/contacts/parameters/contactFields.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/contacts/parameters/contactFields.md b/www/docs/en/1.6.0/cordova/contacts/parameters/contactFields.md index 1951960..487c226 100644 --- a/www/docs/en/1.6.0/cordova/contacts/parameters/contactFields.md +++ b/www/docs/en/1.6.0/cordova/contacts/parameters/contactFields.md @@ -21,6 +21,6 @@ license: > 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` method. Use this parameter to specify which fields should be included in the `Contact` objects resulting from a find operation. ["name", "phoneNumbers", "emails"] http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/contacts/parameters/contactFindOptions.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/contacts/parameters/contactFindOptions.md b/www/docs/en/1.6.0/cordova/contacts/parameters/contactFindOptions.md index f2f3e12..9d92f9c 100644 --- a/www/docs/en/1.6.0/cordova/contacts/parameters/contactFindOptions.md +++ b/www/docs/en/1.6.0/cordova/contacts/parameters/contactFindOptions.md @@ -21,7 +21,7 @@ license: > 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` 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/89392fa8/www/docs/en/1.6.0/cordova/contacts/parameters/contactSuccess.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/contacts/parameters/contactSuccess.md b/www/docs/en/1.6.0/cordova/contacts/parameters/contactSuccess.md index 925105f..0394b6d 100644 --- a/www/docs/en/1.6.0/cordova/contacts/parameters/contactSuccess.md +++ b/www/docs/en/1.6.0/cordova/contacts/parameters/contactSuccess.md @@ -21,7 +21,7 @@ license: > contactSuccess ============== -Success callback function that provides the `Contact` array resulting from a `contacts.find` operation. +Success callback function that provides the `Contact` array resulting from a `contacts.find` operation. function(contacts) { // Do something @@ -30,9 +30,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`) -Example +Example ------- function contactSuccess(contacts) { http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/device/device.cordova.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/device/device.cordova.md b/www/docs/en/1.6.0/cordova/device/device.cordova.md index bf2c657..7dd62fa 100644 --- a/www/docs/en/1.6.0/cordova/device/device.cordova.md +++ b/www/docs/en/1.6.0/cordova/device/device.cordova.md @@ -38,36 +38,36 @@ Supported Platforms - iPhone - Windows Phone 7 ( Mango ) -Quick Example +Quick Example ------------- var name = device.cordova; -Full Example +Full Example ------------ - Device Properties Example + <a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a> http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/device/device.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/device/device.md b/www/docs/en/1.6.0/cordova/device/device.md index 6a5f11a..40cd569 100644 --- a/www/docs/en/1.6.0/cordova/device/device.md +++ b/www/docs/en/1.6.0/cordova/device/device.md @@ -26,11 +26,11 @@ Device Properties ---------- -- device.name -- device.cordova -- device.platform -- device.uuid -- device.version +- device.name +- device.cordova +- device.platform +- device.uuid +- device.version Variable Scope -------------- @@ -39,5 +39,5 @@ Since `device` is assigned to the `window` object, it is implicitly in the globa // These reference the same `device` // - var phoneName = window.device.name; - var phoneName = device.name; \ No newline at end of file + var phoneName = window.device.name; + var phoneName = device.name; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/device/device.name.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/device/device.name.md b/www/docs/en/1.6.0/cordova/device/device.name.md index 3a71d7b..a5fadc1 100644 --- a/www/docs/en/1.6.0/cordova/device/device.name.md +++ b/www/docs/en/1.6.0/cordova/device/device.name.md @@ -38,7 +38,7 @@ Supported Platforms - iPhone - Windows Phone 7 ( Mango ) -Quick Example +Quick Example ------------- // Android: Nexus One returns "Passion" (Nexus One code name) @@ -48,31 +48,31 @@ Quick Example // var name = device.name; -Full Example +Full Example ------------ - Device Properties Example + <a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a> @@ -93,7 +93,7 @@ Android Quirks iPhone Quirks ------------- -- Gets the [device's custom name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UIDevice_Class/Reference/UIDevice.html#//apple_ref/doc/uid/TP40006902-CH3-SW13) instead of the [device model name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UIDevice_Class/Reference/UIDevice.html#//apple_ref/doc/uid/TP40006902-CH3-SW1). +- Gets the [device's custom name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UIDevice_Class/Reference/UIDevice.html#//apple_ref/doc/uid/TP40006902-CH3-SW13) instead of the [device model name](http://developer.apple.com/iphone/library/documentation/uikit/reference/UIDevice_Class/Reference/UIDevice.html#//apple_ref/doc/uid/TP40006902-CH3-SW1). - The custom name is set by the owner in iTunes. - e.g. "Joe's iPhone" http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/device/device.platform.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/device/device.platform.md b/www/docs/en/1.6.0/cordova/device/device.platform.md index 5b76f57..753618c 100644 --- a/www/docs/en/1.6.0/cordova/device/device.platform.md +++ b/www/docs/en/1.6.0/cordova/device/device.platform.md @@ -33,7 +33,7 @@ Supported Platforms - iPhone - Windows Phone 7 ( Mango ) -Quick Example +Quick Example ------------- // Depending on the device, a few examples are: @@ -44,31 +44,31 @@ Quick Example // - "WinCE" var devicePlatform = device.platform; -Full Example +Full Example ------------ - Device Properties Example + <a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a> @@ -86,7 +86,7 @@ All devices return `iPhone` as the platform. This is inaccurate because Apple ha BlackBerry Quirks ----------------- -Devices may return the device platform version instead of the platform name. For example, the Storm2 9550 would return '2.13.0.95' or similar. +Devices may return the device platform version instead of the platform name. For example, the Storm2 9550 would return '2.13.0.95' or similar. Windows Phone 7 Quirks ----------------- http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/device/device.uuid.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/device/device.uuid.md b/www/docs/en/1.6.0/cordova/device/device.uuid.md index 06a9bff..c3e4bae 100644 --- a/www/docs/en/1.6.0/cordova/device/device.uuid.md +++ b/www/docs/en/1.6.0/cordova/device/device.uuid.md @@ -38,7 +38,7 @@ Supported Platforms - iPhone - Windows Phone 7 ( Mango ) -Quick Example +Quick Example ------------- // Android: Returns a random 64-bit integer (as a string, again!) @@ -47,7 +47,7 @@ Quick Example // BlackBerry: Returns the PIN number of the device // This is a nine-digit unique integer (as a string, though!) // - // iPhone: (Paraphrased from the UIDevice Class documentation) + // iPhone: (Paraphrased from the UIDevice Class documentation) // Returns a string of hash values created from multiple hardware identifies. // It is guaranteed to be unique for every device and cannot be tied // to the user account. @@ -56,31 +56,31 @@ Quick Example // var deviceID = device.uuid; -Full Example +Full Example ------------ - Device Properties Example + <a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a> http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/device/device.version.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/device/device.version.md b/www/docs/en/1.6.0/cordova/device/device.version.md index fbc3fd2..33fcd18 100644 --- a/www/docs/en/1.6.0/cordova/device/device.version.md +++ b/www/docs/en/1.6.0/cordova/device/device.version.md @@ -33,7 +33,7 @@ Supported Platforms - iPhone - Windows Phone 7 ( Mango ) -Quick Example +Quick Example ------------- // Android: Froyo OS would return "2.2" @@ -47,31 +47,31 @@ Quick Example // Windows Phone 7: returns current OS version number, ex. on Mango returns 7.10.7720 var deviceVersion = device.version; -Full Example +Full Example ------------ - Device Properties Example + <a href="device.html">Device</a> Properties <a href="../storage/storage.opendatabase.html">Example</a> http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/89392fa8/www/docs/en/1.6.0/cordova/events/events.backbutton.md ---------------------------------------------------------------------- diff --git a/www/docs/en/1.6.0/cordova/events/events.backbutton.md b/www/docs/en/1.6.0/cordova/events/events.backbutton.md index 2b0f419..37ad02e 100644 --- a/www/docs/en/1.6.0/cordova/events/events.backbutton.md +++ b/www/docs/en/1.6.0/cordova/events/events.backbutton.md @@ -30,7 +30,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' event. Supported Platforms ------------------- @@ -39,7 +39,7 @@ Supported Platforms - BlackBerry WebWorks (OS 5.0 and higher) - Windows Phone 7 ( Mango ) -Quick Example +Quick Example ------------- document.addEventListener("backbutton", onBackKeyDown, false); @@ -48,30 +48,30 @@ Quick Example // Handle the back button } -Full Example +Full Example ------------ - Cordova Back Button Example + Cordova Back Button <a href="../storage/storage.opendatabase.html">Example</a>