You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/06/12 19:51:04 UTC
[29/46] docs commit: glob API
glob API
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/f4bf4426
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/f4bf4426
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/f4bf4426
Branch: refs/heads/master
Commit: f4bf44267d2ad2b99431bd0447d8577d2024b327
Parents: 9dcee9b
Author: Mike Sierra <le...@gmail.com>
Authored: Fri May 17 11:47:07 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Fri May 17 11:47:07 2013 -0400
----------------------------------------------------------------------
.../file/directoryentry/directoryentry.md | 2 +-
.../geolocation.getCurrentPosition.md | 2 +-
.../parameters/geolocation.options.md | 2 +-
.../GlobalizationError/globalizationerror.md | 7 +--
.../globalization/globalization.dateToString.md | 6 +--
.../globalization.getCurrencyPattern.md | 13 +++--
.../globalization/globalization.getDateNames.md | 28 +++++++----
.../globalization.getDatePattern.md | 33 ++++++++-----
.../globalization.getFirstDayOfWeek.md | 17 +++++--
.../globalization.getLocaleName.md | 14 ++++--
.../globalization.getNumberPattern.md | 50 +++++++++++---------
.../globalization.getPreferredLanguage.md | 14 ++++--
.../globalization.isDayLightSavingsTime.md | 18 +++++--
.../edge/cordova/globalization/globalization.md | 8 ++--
.../globalization.numberToString.md | 19 ++++++--
.../globalization/globalization.stringToDate.md | 33 ++++++++-----
.../globalization.stringToNumber.md | 25 +++++++---
17 files changed, 184 insertions(+), 107 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryentry/directoryentry.md b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
index c5d87cd..661768d 100644
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@ -333,7 +333,7 @@ __Parameters:__
- __path__: The path to the file to be looked up or created. Either an absolute path, or a relative path from this `DirectoryEntry`. _(DOMString)_
- __options__: Options to specify whether the file is created if it doesn't exist. _(Flags)_
-- __successCallback__: A callback that is invoked with a `FileEntry` object. _(Function)_
+- __successCallback__: A callback that is passed a `FileEntry` object. _(Function)_
- __errorCallback__: A callback that is called if an error occurs when creating or looking up the file. Invoked with a `FileError` object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
index cc10464..96c8be1 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -39,7 +39,7 @@ Description
`geolocation.getCurrentPosition` is an asynchronous function. It
returns the device's current position to the `geolocationSuccess`
callback with a `Position` object as the parameter. If there is an
-error, the `geolocationError` callback is invoked with a
+error, the `geolocationError` callback is passed a
`PositionError` object.
Supported Platforms
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
index d4754e5..ff4d540 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
@@ -29,7 +29,7 @@ Options
-------
- __enableHighAccuracy__: Provides a hint that the application needs the best possible results. By default, the device attempts to retrieve a `Position` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_
-- __timeout__: The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback is invoked. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback is invoked with a `PositionError.TIMEOUT` error code. (Note that when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds!) _(Number)_
+- __timeout__: The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback is invoked. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback is passed a `PositionError.TIMEOUT` error code. (Note that when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds!) _(Number)_
- __maximumAge__: Accept a cached position whose age is no greater than the specified time in milliseconds. _(Number)_
Android Quirks
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
index e9cec1e..d5af9a9 100644
--- a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
+++ b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -30,7 +30,7 @@ Properties
- GlobalizationError.FORMATTING\_ERROR: 1
- GlobalizationError.PARSING\_ERROR: 2
- GlobalizationError.PATTERN\_ERROR: 3
-- __message__: A text message that includes the error explanation and/or details (`String`)
+- __message__: A text message that includes the error's explanation and/or details (`String`)
Description
-----------
@@ -47,7 +47,8 @@ Supported Platforms
Quick Example
-------------
-When the following error callback is invoked, it should display a popup dialog with the text similar to "code: 3" and "message: ".
+When the following error callback executes, it displays a
+popup dialog with the text similar to `code: 3` and `message:`
function errorCallback(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.dateToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.dateToString.md b/docs/en/edge/cordova/globalization/globalization.dateToString.md
index 9dd0e71..9c0c403 100644
--- a/docs/en/edge/cordova/globalization/globalization.dateToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.dateToString.md
@@ -54,9 +54,9 @@ Supported Platforms
Quick Example
-------------
-If the browser is set to the `en\_US` locale, this should display a
-popup dialog with text similar to `date: 9/25/2012 4:21PM` using the
-default options:
+If the browser is set to the `en\_US` locale, this displays a popup
+dialog with text similar to `date: 9/25/2012 4:21PM` using the default
+options:
navigator.globalization.dateToString(
new Date(),
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
index 724c43c..35bb96e 100644
--- a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -42,9 +42,8 @@ The inbound `currencyCode` parameter should be a `String` of one of
the ISO 4217 currency codes, for example 'USD'.
If there is an error obtaining the pattern, then the `errorCallback`
-is invoked with a `GlobalizationError` object as a parameter. The
-expected code for this error is
-`GlobalizationError.FORMATTING\_ERROR`.
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.FORMATTING\_ERROR`.
Supported Platforms
-------------------
@@ -56,9 +55,9 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the `en\_US` locale and the selected currency
-is United States Dollars, this example should display a popup dialog with text
-similar to the results that follow:
+When the browser is set to the `en\_US` locale and the selected
+currency is United States Dollars, this example displays a popup
+dialog with text similar to the results that follow:
navigator.globalization.getCurrencyPattern(
'USD',
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDateNames.md b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
index 70b7552..656be1d 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDateNames.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,22 +20,30 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.getDateNames
===========
-Returns an array of either the names of the months or days of the week according to the client's user preferences and calendar.
+Returns an array of the names of the months or days of the week,
+depending on the client's user preferences and calendar.
navigator.globalization.getDateNames(successCallback, errorCallback, options);
Description
-----------
-It returns the array of names to the `successCallback` with a properties object as a parameter. That object should have a `value` property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.
+Returns the array of names to the `successCallback` with a
+`properties` object as a parameter. That object contains a `value`
+property with an `Array` of `String` values. The array features names
+starting from either the first month in the year or the first day of
+the week, depending on the option selected.
+
+If there is an error obtaining the names, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
-If there is an error obtaining the names, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
+The `options` parameter is optional, and its default values are:
-`options.type` can be 'narrow', or 'wide'.
-`options.item` can be 'months', or 'days'.
+ {type:'wide', item:'months'}
-The default options are `{type:'wide', item:'months'}`.
-The options parameter is optional.
+The value of `options.type` can be `narrow` or `wide`.
+The value of `options.item` can be `months` or `days`.
Supported Platforms
-------------------
@@ -48,7 +56,9 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a series of 12 popup dialogs, one per month, with text similar to "month: January"
+When the browser is set to the `en\_US` locale, this example displays
+a series of twelve popup dialogs, one per month, with text similar to
+`month: January`:
navigator.globalization.getDateNames(
function (names) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
index 2662634..5a07c55 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,27 +20,33 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.getDatePattern
===========
-Returns a pattern string to format and parse dates according to the client's user preferences.
+Returns a pattern string to format and parse dates according to the
+client's user preferences.
navigator.globalization.getDatePattern(successCallback, errorCallback, options);
Description
-----------
-It returns the pattern to the `successCallback` with a properties object as a parameter. That object should have the following properties:
+Returns the pattern to the `successCallback`. The object passed in as
+a parameter contains the following properties:
- __pattern__: The date and time pattern to format and parse dates. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_
- __timezone__: The abbreviated name of the time zone on the client. _(String)_
- __utc\_offset__: The current difference in seconds between the client's time zone and coordinated universal time. _(Number)_
- __dst\_offset__: The current daylight saving time offset in seconds between the client's non-daylight saving's time zone and the client's daylight saving's time zone. _(Number)_
-If there is an error obtaining the pattern, then the `errorCallback` is invokedwith a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.PATTERN\_ERROR`.
+If there is an error obtaining the pattern, the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.PATTERN\_ERROR`.
+
+The `options` parameter is optional, and defaults to the following values:
-`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
-`options.selector` can be 'date', 'time' or 'date and time'.
+ {formatLength:'short', selector:'date and time'}
-The default options are `{formatLength:'short', selector:'date and time'}`.
-The options parameter is optional.
+The `options.formatLength` can be `short`, `medium`, `long`, or
+`full`. The `options.selector` can be `date`, `time` or `date and
+time`.
Supported Platforms
-------------------
@@ -53,7 +59,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "pattern: M/d/yyyy h:mm a".
+When the browser is set to the `en\_US` locale, this example displays
+a popup dialog with text such as `pattern: M/d/yyyy h:mm a`:
function checkDatePattern() {
navigator.globalization.getDatePattern(
@@ -91,8 +98,8 @@ Full Example
Windows Phone 8 Quirks
--------------
-- `formatLength` option supports only short and full values.
-- `pattern` property for `date and time` pattern returns only full datetime format.
-- `timezone` property returns full time zone name
-- `dst_offset` returned property is not supported and always returns zero.
+- The `formatLength` supports only `short` and `full` values.
+- The `pattern` for `date and time` pattern returns only full datetime format.
+- The `timezone` returns the full time zone name.
+- The `dst_offset` property is not supported, and always returns zero.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
index ff8856a..49f9156 100644
--- a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
+++ b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,16 +20,22 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.getFirstDayOfWeek
===========
-Returns the first day of the week according to the client's user preferences and calendar.
+Returns the first day of the week according to the client's user
+preferences and calendar.
navigator.globalization.getFirstDayOfWeek(successCallback, errorCallback);
Description
-----------
-The days of the week are numbered starting from 1 where 1 is considered to be Sunday. It returns the day to the `successCallback` with a properties object as a parameter. That object should have a `value` property with a Number value.
+The days of the week are numbered starting from 1, where 1 is assumed
+to be Sunday. Returns the day to the `successCallback` with a
+`properties` object as a parameter. That object should have a `value`
+property with a `Number` value.
-If there is an error obtaining the pattern, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
+If there is an error obtaining the pattern, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
Supported Platforms
-------------------
@@ -42,7 +48,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "day: 1".
+When the browser is set to the `en\_US` locale, this displays a
+popup dialog with text similar to `day: 1`.
navigator.globalization.getFirstDayOfWeek(
function (day) {alert('day: ' + day.value + '\n');},
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
index 952b153..fbe0689 100644
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -28,10 +28,13 @@ Get the string identifier for the client's current locale setting.
Description
-----------
-It returns the locale identifier string to the `successCallback` with a
-properties object as a parameter. That object should have a `value` property with a String value.
+Returns the locale identifier string to the `successCallback` with a
+`properties` object as a parameter. That object should have a `value`
+property with a `String` value.
-If there is an error getting the locale, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
+If there is an error getting the locale, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
Supported Platforms
-------------------
@@ -44,7 +47,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with the text "locale: en\_US".
+When the browser is set to the `en\_US` locale, this displays a popup
+dialog with the text `locale: en\_US`.
navigator.globalization.getLocaleName(
function (locale) {alert('locale: ' + locale.value + '\n');},
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
index 56bcc6f..8d81f57 100644
--- a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,10 +27,11 @@ Returns a pattern string to format and parse numbers according to the client's u
Description
-----------
-It returns the pattern to the `successCallback` with a properties object as a parameter. That object should have the following properties:
+Returns the pattern to the `successCallback` with a `properties` object
+as a parameter. That object contains the following properties:
- __pattern__: The number pattern to format and parse numbers. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_
-- __symbol__: The symbol to be used when formatting and parsing e.g., percent or currency symbol. _(String)_
+- __symbol__: The symbol to use when formatting and parsing, such as a percent or currency symbol. _(String)_
- __fraction__: The number of fractional digits to use when parsing and formatting numbers. _(Number)_
- __rounding__: The rounding increment to use when parsing and formatting. _(Number)_
- __positive__: The symbol to use for positive numbers when parsing and formatting. _(String)_
@@ -38,10 +39,16 @@ It returns the pattern to the `successCallback` with a properties object as a pa
- __decimal__: The decimal symbol to use for parsing and formatting. _(String)_
- __grouping__: The grouping symbol to use for parsing and formatting. _(String)_
-If there is an error obtaining the pattern, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.PATTERN\_ERROR`.
+If there is an error obtaining the pattern, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.PATTERN\_ERROR`.
+
+The `options` parameter is optional, and default values are:
+
+ {type:'decimal'}
+
+The `options.type` can be `decimal`, `percent`, or `currency`.
-`options.type` can be 'decimal', 'percent', or 'currency'.
-The default options are `{type:'decimal'}`. The `options` parameter is optional.
Supported Platforms
-------------------
@@ -54,18 +61,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with text similar to:
-
- pattern: #,##0.###
- symbol: .
- fraction: 0
- rounding: 0
- positive:
- negative: -
- decimal: .
- grouping: ,
-
-.
+When the browser is set to the `en\_US` locale, this should display a
+popup dialog with text similar to the results that follow:
navigator.globalization.getNumberPattern(
function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
@@ -80,6 +77,17 @@ When the browser is set to the en\_US locale, this should display a popup dialog
{type:'decimal'}
);
+Results:
+
+ pattern: #,##0.###
+ symbol: .
+ fraction: 0
+ rounding: 0
+ positive:
+ negative: -
+ decimal: .
+ grouping: ,
+
Full Example
------------
@@ -114,7 +122,5 @@ Full Example
Windows Phone 8 Quirks
----------------
-- `pattern` property is not supported; empty string is always returned.
-- `fraction` property is not supported; zero is always returned.
-
-
+- The `pattern` property is not supported, and retuens an empty string.
+- The `fraction` property is not supported, and returns zero.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
index a436f9f..7370832 100644
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -28,10 +28,13 @@ Get the string identifier for the client's current language.
Description
-----------
-It returns the language identifier string to the `successCallback` with a
-properties object as a parameter. That object should have a `value` property with a String value.
+Returns the language identifier string to the `successCallback` with a
+`properties` object as a parameter. That object should have a `value`
+property with a `String` value.
-If there is an error getting the language, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
+If there is an error getting the language, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
Supported Platforms
-------------------
@@ -44,7 +47,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with the text "language: English".
+When the browser is set to the `en\_US` locale, this should display a
+popup dialog with the text `language: English`:
navigator.globalization.getPreferredLanguage(
function (language) {alert('language: ' + language.value + '\n');},
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
index e01b226..e6541cf 100644
--- a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
+++ b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,18 +20,24 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.isDayLightSavingsTime
===========
-Returns whether daylight savings time is in effect for a given date using the client's time zone and calendar.
+Indicates whether daylight savings time is in effect for a given date
+using the client's time zone and calendar.
navigator.globalization.isDayLightSavingsTime(date, successCallback, errorCallback);
Description
-----------
-It returns whether or not daylight savings time is in effect to the `successCallback` with a properties object as a parameter. That object should have a `dst` property with a Boolean value. The value 'true' indicates that daylight savings time is in effect for the given date, and 'false' indicates that it is not.
+Indicates whether or not daylight savings time is in effect to the
+`successCallback` with a `properties` object as a parameter. That object
+should have a `dst` property with a `Boolean` value. A `true` value
+indicates that daylight savings time is in effect for the given date,
+and `false` indicates that it is not.
The inbound parameter `date` should be of type `Date`.
-If there is an error reading the date, then the `errorCallback` is invoked. The expected code for this error is `GlobalizationError.UNKNOWN\_ERROR`.
+If there is an error reading the date, then the `errorCallback`
+executes. The error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
Supported Platforms
-------------------
@@ -44,7 +50,9 @@ Supported Platforms
Quick Example
-------------
-In the case during the summer when the browser is set to a DST-enabled timezone, this should display a popup dialog with text similar to "dst: true".
+During the summer, and if the browser is set to a DST-enabled
+timezone, this should display a popup dialog with text similar to
+`dst: true`:
navigator.globalization.isDayLightSavingsTime(
new Date(),
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.md b/docs/en/edge/cordova/globalization/globalization.md
index dacf13f..b473ec9 100644
--- a/docs/en/edge/cordova/globalization/globalization.md
+++ b/docs/en/edge/cordova/globalization/globalization.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,7 +20,8 @@ license: Licensed to the Apache Software Foundation (ASF) under one
Globalization
======
-The `globalization` object obtains information and performs operations specific to the user's locale and timezone.
+Obtains information and performs operations specific to the user's
+locale and timezone.
Objects
-------
@@ -46,7 +47,8 @@ Methods
Variable Scope
--------------
-The `globalization` object is a child of the `navigator` object, and therefore has global scope.
+The `globalization` object is a child of the `navigator` object, and
+therefore has global scope.
// The global globalization object
var globalization = navigator.globalization;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.numberToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.numberToString.md b/docs/en/edge/cordova/globalization/globalization.numberToString.md
index ed61012..a049999 100644
--- a/docs/en/edge/cordova/globalization/globalization.numberToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.numberToString.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -27,11 +27,19 @@ Returns a number formatted as a string according to the client's user preference
Description
-----------
-It returns the formatted number string to the `successCallback` with a properties object as a parameter. That object should have a `value` property with a String value.
+Returns the formatted number string to the `successCallback` with a
+`properties` object as a parameter. That object should have a `value`
+property with a `String` value.
+
+If there is an error formatting the number, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.FORMATTING\_ERROR`.
+
+The `options` parameter is optional, and its default values are:
-If there is an error formatting the number, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.FORMATTING\_ERROR`.
+ {type:'decimal'}
-`options.type` can be 'decimal', 'percent', or 'currency'. The default options are `{type:'decimal'}`. The `options` parameter is optional.
+The `options.type` can be 'decimal', 'percent', or 'currency'.
Supported Platforms
-------------------
@@ -44,7 +52,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "number: 3.142"
+When the browser is set to the `en\_US` locale, this displays a popup
+dialog with text similar to `number: 3.142`:
navigator.globalization.numberToString(
3.1415926,
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.stringToDate.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToDate.md b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
index 29d8e39..65c0c95 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToDate.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,16 +20,17 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.stringToDate
===========
-Parses a date formatted as a string according to the client's user
-preferences and calendar using the time zone of the client and returns
-the corresponding date object.
+Parses a date formatted as a string, according to the client's user
+preferences and calendar using the time zone of the client, and
+returns the corresponding date object.
navigator.globalization.stringToDate(dateString, successCallback, errorCallback, options);
Description
-----------
-It returns the date to the success callback with a properties object as a parameter. That object should have the following properties:
+Returns the date to the success callback with a `properties` object as
+a parameter. That object should have the following properties:
- __year__: The four digit year. _(Number)_
- __month__: The month from (0 - 11). _(Number)_
@@ -41,13 +42,18 @@ It returns the date to the success callback with a properties object as a parame
The inbound `dateString` parameter should be of type `String`.
-`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
-`options.selector` can be 'date', 'time' or 'date and time'.
+The `options` parameter is optional, and defaults to the following
+values:
+
+ {formatLength:'short', selector:'date and time'}
-The default options are `{formatLength:'short', selector:'date and time'}`.
-The options parameter is optional.
+The `options.formatLength` can be `short`, `medium`, `long`, or
+`full`. The `options.selector` can be `date`, `time` or `date and
+time`.
-If there is an error parsing the date string, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.PARSING\_ERROR`.
+If there is an error parsing the date string, then the `errorCallback`
+executes with a `GlobalizationError` object as a parameter. The
+error's expected code is `GlobalizationError.PARSING\_ERROR`.
Supported Platforms
-------------------
@@ -60,7 +66,10 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "month:8 day:25 year:2012". Note that the month integer is one less than the string, as the month integer represents an index.
+When the browser is set to the `en\_US` locale, this displays a
+popup dialog with text similar to `month:8 day:25 year:2012`. Note
+that the month integer is one less than the string, as the month
+integer represents an array index.
navigator.globalization.stringToDate(
'9/25/2012',
@@ -102,4 +111,4 @@ Full Example
Windows Phone 8 Quirks
------------------
-- `formatLength` option supports only short and full values
+- The `formatLength` option supports only `short` and `full` values.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/f4bf4426/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
index d6ecb19..90313c1 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
@@ -1,4 +1,4 @@
----
+---
license: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -20,19 +20,29 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.stringToNumber
===========
-Parses a number formatted as a string according to the client's user preferences and returns the corresponding number.
+Parses a number formatted as a string according to the client's user
+preferences and returns the corresponding number.
navigator.globalization.stringToNumber(string, successCallback, errorCallback, options);
Description
-----------
-It returns the number to the `successCallback` with a properties object as a parameter. That object should have a `value` property with a Number value.
+Returns the number to the `successCallback` with a `properties` object
+as a parameter. That object should have a `value` property with a
+`Number` value.
+
+If there is an error parsing the number string, then the
+`errorCallback` executes with a `GlobalizationError` object as a
+parameter. The error's expected code is
+`GlobalizationError.PARSING\_ERROR`.
+
+The `options` parameter is optional, and defaults to the following
+values:
-If there is an error parsing the number string, then the `errorCallback` is invoked with a `GlobalizationError` object as a parameter. The expected code for this error is `GlobalizationError.PARSING\_ERROR`.
+ {type:'decimal'}
-`options.type` can be 'decimal', 'percent', or 'currency'.
-The default options are `{type:'decimal'}`. The `options` parameter is optional.
+The `options.type` can be `decimal`, `percent`, or `currency`.
Supported Platforms
-------------------
@@ -45,7 +55,8 @@ Supported Platforms
Quick Example
-------------
-When the browser is set to the en\_US locale, this should display a popup dialog with text similar to "number: 1234.56".
+When the browser is set to the `en\_US` locale, this should display a
+popup dialog with text similar to `number: 1234.56`:
navigator.globalization.stringToNumber(
'1234.56',