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:02 UTC
[27/46] docs commit: amidst globalization api
amidst globalization 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/e2d7868b
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
Branch: refs/heads/master
Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
Parents: d9648d0
Author: Mike Sierra <le...@gmail.com>
Authored: Fri May 17 09:17:27 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Fri May 17 09:17:27 2013 -0400
----------------------------------------------------------------------
.../GlobalizationError/globalizationerror.md | 10 +++---
.../globalization/globalization.dateToString.md | 33 +++++++++++---------
.../globalization.getCurrencyPattern.md | 21 +++++++------
.../globalization/globalization.getDateNames.md | 6 ++--
.../globalization.getDatePattern.md | 6 ++--
.../globalization.getFirstDayOfWeek.md | 6 ++--
.../globalization.getLocaleName.md | 6 ++--
.../globalization.getNumberPattern.md | 6 ++--
.../globalization.getPreferredLanguage.md | 6 ++--
.../globalization.isDayLightSavingsTime.md | 6 ++--
.../globalization.numberToString.md | 6 ++--
.../globalization/globalization.stringToDate.md | 4 +--
.../globalization.stringToNumber.md | 6 ++--
13 files changed, 63 insertions(+), 59 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/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 d5d3942..e9cec1e 100644
--- a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
+++ b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
@@ -49,7 +49,7 @@ Quick Example
When the following error callback is invoked, it should display a popup dialog with the text similar to "code: 3" and "message: ".
- function errorCB(error) {
+ function errorCallback(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
};
@@ -64,13 +64,13 @@ Full Example
<script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script>
<script type="text/javascript" charset="utf-8">
- function successCB(date) {
+ function successCallback(date) {
alert('month:' + date.month +
' day:' + date.day +
' year:' + date.year + '\n');
}
- function errorCB(error) {
+ function errorCallback(error) {
alert('code: ' + error.code + '\n' +
'message: ' + error.message + '\n');
};
@@ -78,8 +78,8 @@ Full Example
function checkError() {
navigator.globalization.stringToDate(
'notADate',
- successCB,
- errorCB,
+ successCallback,
+ errorCallback,
{selector:'foobar'}
);
}
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/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 80192ea..9dd0e71 100644
--- a/docs/en/edge/cordova/globalization/globalization.dateToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.dateToString.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
@@ -22,26 +22,26 @@ globalization.dateToString
Returns a date formatted as a string according to the client's locale and timezone.
- navigator.globalization.dateToString(date, successCB, errorCB, options);
+ navigator.globalization.dateToString(date, successCallback, errorCallback, options);
Description
-----------
-It returns the formatted date string to the successCB callback with a
-properties object as a parameter. That object should have a `value`
-property with a `String` value.
+Returns the formatted date `String` via a `value` property accessible
+from the object passed as a parameter to the `successCallback`.
The inbound `date` parameter should be of type `Date`.
-If there is an error formatting the date, then the `errorCB` callback is
-invoked with a `GlobalizationError` object as a parameter. The expected
-code for this error is `GlobalizationError.FORMATTING\_ERROR`.
+If there is an error formatting the date, 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:
-The `options.formatLength` can be 'short', 'medium', 'long', or 'full'.
-The `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
-------------------
@@ -54,11 +54,13 @@ Supported Platforms
Quick Example
-------------
-In the case when 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 should display a
+popup dialog with text similar to `date: 9/25/2012 4:21PM` using the
+default options:
navigator.globalization.dateToString(
new Date(),
- function (date) {alert('date:' + date.value + '\n');},
+ function (date) {alert('date: ' + date.value + '\n');},
function () {alert('Error getting dateString\n');},
{formatLength:'short', selector:'date and time'}
);
@@ -90,4 +92,5 @@ 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/e2d7868b/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 4762698..968a940 100644
--- a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
@@ -20,26 +20,27 @@ license: Licensed to the Apache Software Foundation (ASF) under one
globalization.getCurrencyPattern
===========
-Returns a pattern string for formatting and parsing currency values according
+Returns a pattern string to format and parse currency values according
to the client's user preferences and ISO 4217 currency code.
- navigator.globalization.getCurrencyPattern(currencyCode, successCB, errorCB);
+ navigator.globalization.getCurrencyPattern(currencyCode, successCallback, errorCallback);
Description
-----------
-It returns the pattern to the successCB callback 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 should have the following properties:
-- pattern {String}: The currency pattern for formatting and parsing currency values. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
-- code {String}: The ISO 4217 currency code for the pattern.
-- fraction {Number}: The number of fractional digits to use when parsing and formatting currency.
-- rounding {Number}: The rounding increment to use when parsing and formatting.
-- decimal: {String}: The decimal symbol to use for parsing and formatting.
-- grouping: {String}: The grouping symbol to use for parsing and formatting.
+- __pattern__ {String}: The currency pattern for formatting and parsing currency values. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
+- __code__ {String}: The ISO 4217 currency code for the pattern.
+- __fraction__ {Number}: The number of fractional digits to use when parsing and formatting currency.
+- __rounding__ {Number}: The rounding increment to use when parsing and formatting.
+- __decimal__: {String}: The decimal symbol to use for parsing and formatting.
+- __grouping__: {String}: The grouping symbol to use for parsing and formatting.
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 errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+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.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/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 aa6f89a..fceaf64 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDateNames.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
@@ -22,14 +22,14 @@ 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.
- navigator.globalization.getDateNames(successCB, errorCB, options);
+ navigator.globalization.getDateNames(successCallback, errorCallback, options);
Description
-----------
-It returns the array of names to the successCB callback 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.
+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.
-If there is an error obtaining the names, then the errorCB callback 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 names, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
`options.type` can be 'narrow', or 'wide'.
`options.item` can be 'months', or 'days'.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/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 3c43674..03ae3c7 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
@@ -22,19 +22,19 @@ globalization.getDatePattern
Returns a pattern string for formatting and parsing dates according to the client's user preferences.
- navigator.globalization.getDatePattern(successCB, errorCB, options);
+ navigator.globalization.getDatePattern(successCallback, errorCallback, options);
Description
-----------
-It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:
+It returns the pattern to the `successCallback` with a properties object as a parameter. That object should have the following properties:
- pattern {String}: The date and time pattern for formatting and parsing dates. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
- timezone {String}: The abbreviated name of the time zone on the client
- utc\_offset {Number}: The current difference in seconds between the client's time zone and coordinated universal time.
- dst\_offset {Number}: 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.
-If there is an error obtaining the pattern, then the errorCB callback 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, then the `errorCallback` is invokedwith a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN\_ERROR.
`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
`options.selector` can be 'date', 'time' or 'date and time'.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/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 15f02e0..84b23eb 100644
--- a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
+++ b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -22,14 +22,14 @@ globalization.getFirstDayOfWeek
Returns the first day of the week according to the client's user preferences and calendar.
- navigator.globalization.getFirstDayOfWeek(successCB, errorCB);
+ 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 successCB callback 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 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.
-If there is an error obtaining the pattern, then the errorCB callback 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` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/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 d07939a..6f23bc6 100644
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
@@ -22,16 +22,16 @@ globalization.getLocaleName
Get the string identifier for the client's current locale setting.
- navigator.globalization.getLocaleName(successCB, errorCB);
+ navigator.globalization.getLocaleName(successCallback, errorCallback);
Description
-----------
-It returns the locale identifier string to the successCB callback with a
+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.
-If there is an error getting the locale, then the errorCB callback 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` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/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 be73239..0af8331 100644
--- a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
@@ -22,12 +22,12 @@ globalization.getNumberPattern
Returns a pattern string for formatting and parsing numbers according to the client's user preferences.
- navigator.globalization.getNumberPattern(successCB, errorCB, options);
+ navigator.globalization.getNumberPattern(successCallback, errorCallback, options);
Description
-----------
-It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:
+It returns the pattern to the `successCallback` with a properties object as a parameter. That object should have the following properties:
- pattern {String}: The number pattern for formatting and parsing numbers. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>
- symbol {String}: The symbol to be used when formatting and parsing e.g., percent or currency symbol.
@@ -38,7 +38,7 @@ It returns the pattern to the successCB callback with a properties object as a p
- decimal: {String}: The decimal symbol to use for parsing and formatting.
- grouping: {String}: The grouping symbol to use for parsing and formatting.
-If there is an error obtaining the pattern, then the errorCB callback 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` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN\_ERROR.
`options.type` can be 'decimal', 'percent', or 'currency'.
The default options are `{type:'decimal'}`. The `options` parameter is optional.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/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 8110432..a92a9b3 100644
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
@@ -22,16 +22,16 @@ globalization.getPreferredLanguage
Get the string identifier for the client's current language.
- navigator.globalization.getPreferredLanguage(successCB, errorCB);
+ navigator.globalization.getPreferredLanguage(successCallback, errorCallback);
Description
-----------
-It returns the language identifier string to the successCB callback with a
+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.
-If there is an error getting the language, then the errorCB callback 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` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/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 537339d..5d2b701 100644
--- a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
+++ b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
@@ -22,16 +22,16 @@ globalization.isDayLightSavingsTime
Returns whether daylight savings time is in effect for a given date using the client's time zone and calendar.
- navigator.globalization.isDayLightSavingsTime(date, successCB, errorCB);
+ navigator.globalization.isDayLightSavingsTime(date, successCallback, errorCallback);
Description
-----------
-It returns whether or not daylight savings time is in effect to the successCB callback 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.
+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.
The inbound parameter `date` should be of type `Date`.
-If there is an error reading the date, then the errorCB callback is invoked. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
+If there is an error reading the date, then the `errorCallback` is invoked. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/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 c0c9e48..74e6ce9 100644
--- a/docs/en/edge/cordova/globalization/globalization.numberToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.numberToString.md
@@ -22,14 +22,14 @@ globalization.numberToString
Returns a number formatted as a string according to the client's user preferences.
- navigator.globalization.numberToString(number, successCB, errorCB, options);
+ navigator.globalization.numberToString(number, successCallback, errorCallback, options);
Description
-----------
-It returns the formatted number string to the successCB callback with a properties object as a parameter. That object should have a `value` property with a String value.
+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.
-If there is an error formatting the number, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+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.
`options.type` can be 'decimal', 'percent', or 'currency'. The default options are `{type:'decimal'}`. The `options` parameter is optional.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/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 fde3847..6849d0a 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToDate.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToDate.md
@@ -24,7 +24,7 @@ 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, successCB, errorCB, options);
+ navigator.globalization.stringToDate(dateString, successCallback, errorCallback, options);
Description
-----------
@@ -47,7 +47,7 @@ The inbound `dateString` parameter should be of type `String`.
The default options are `{formatLength:'short', selector:'date and time'}`.
The options parameter is optional.
-If there is an error parsing the date string, then the errorCB callback 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` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/e2d7868b/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 b0a2627..7928e6c 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
@@ -22,14 +22,14 @@ globalization.stringToNumber
Parses a number formatted as a string according to the client's user preferences and returns the corresponding number.
- navigator.globalization.stringToNumber(string, successCB, errorCB, options);
+ navigator.globalization.stringToNumber(string, successCallback, errorCallback, options);
Description
-----------
-It returns the number to the successCB callback with a properties object as a parameter. That object should have a `value` property with a Number value.
+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.
-If there is an error parsing the number string, then the errorCB callback 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 number string, then the `errorCallback` is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR.
`options.type` can be 'decimal', 'percent', or 'currency'.
The default options are `{type:'decimal'}`. The `options` parameter is optional.
Re: [27/46] docs commit: amidst globalization api
Posted by Michael Brooks <mi...@michaelbrooks.ca>.
The three main points are:
- any features of joDoc [1]
- autolink any text that match a <h1> or <h2>
- automatically replace "x.x.x" pattern with the latest version.
[1] https://github.com/davebalmer/joDoc/wiki
On Fri, Jun 14, 2013 at 5:48 PM, Marcel Kinard <cm...@gmail.com> wrote:
>
> On Jun 13, 2013, at 3:53 PM, Michael Sierra <ms...@adobe.com> wrote:
>
> > Are automatic doc-generation tools doc'ed anywhere? E.g., the
> conversion of heading text to live links? Granted it's not intrinsic to
> content, but potentially affects how you might structure it.
>
> Not doc'ed in our repo, that I'm aware of. This is the only thing I've
> been able to find:
> https://github.com/davebalmer/joDoc/wiki
> https://github.com/davebalmer/joDoc/blob/master/TOC.mdown
>
> @mwbrooks, any other hints?
>
> -- Marcel Kinard
Re: [27/46] docs commit: amidst globalization api
Posted by Marcel Kinard <cm...@gmail.com>.
On Jun 13, 2013, at 3:53 PM, Michael Sierra <ms...@adobe.com> wrote:
> Are automatic doc-generation tools doc'ed anywhere? E.g., the conversion of heading text to live links? Granted it's not intrinsic to content, but potentially affects how you might structure it.
Not doc'ed in our repo, that I'm aware of. This is the only thing I've been able to find:
https://github.com/davebalmer/joDoc/wiki
https://github.com/davebalmer/joDoc/blob/master/TOC.mdown
@mwbrooks, any other hints?
-- Marcel Kinard
RE: [27/46] docs commit: amidst globalization api
Posted by Michael Sierra <ms...@adobe.com>.
That's already in place, with a reference in the top-level README.md. Thanks. I'd keep it out of the README, though, as too much info.
Are automatic doc-generation tools doc'ed anywhere? E.g., the conversion of heading text to live links? Granted it's not intrinsic to content, but potentially affects how you might structure it.
--Mike Sierra
________________________________________
From: Marcel Kinard [cmarcelk@gmail.com]
Sent: Wednesday, June 12, 2013 5:32 PM
To: dev@cordova.apache.org
Subject: Fwd: [27/46] docs commit: amidst globalization api
Mike, how about adding a reference to STYLESHEET.md in README.md, so people looking at README.md see the great style guidelines you authored? Or perhaps even collapse STYLESHEET.md into README.md so it's all inline in the README.
-- Marcel Kinard
Begin forwarded message:
> From: Marcel Kinard <cm...@gmail.com>
> Subject: Re: [27/46] docs commit: amidst globalization api
> Date: June 12, 2013 4:54:31 PM EDT
> To: "dev@cordova.apache.org" <de...@cordova.apache.org>
>
> Lots of files being touched, but no Jira reference. Mike, in the future could you add a Jira reference to the commit message, per "About Commit Messages" in http://wiki.apache.org/cordova/ContributorWorkflow
>
> After reading for a while, looks like you are a copy editor, and doing some very nice cleanup in the docs, including the new style guide.
>
> -- Marcel Kinard
>
> On Jun 12, 2013, at 1:51 PM, mwbrooks@apache.org wrote:
>
>> amidst globalization 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/e2d7868b
>> Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
>> Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
>>
>> Branch: refs/heads/master
>> Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
>> Parents: d9648d0
>> Author: Mike Sierra <le...@gmail.com>
>> Authored: Fri May 17 09:17:27 2013 -0400
>> Committer: Mike Sierra <le...@gmail.com>
>> Committed: Fri May 17 09:17:27 2013 -0400
>>
>> ----------------------------------------------------------------------
>> .../GlobalizationError/globalizationerror.md | 10 +++---
>> .../globalization/globalization.dateToString.md | 33 +++++++++++---------
>> .../globalization.getCurrencyPattern.md | 21 +++++++------
>> .../globalization/globalization.getDateNames.md | 6 ++--
>> .../globalization.getDatePattern.md | 6 ++--
>> .../globalization.getFirstDayOfWeek.md | 6 ++--
>> .../globalization.getLocaleName.md | 6 ++--
>> .../globalization.getNumberPattern.md | 6 ++--
>> .../globalization.getPreferredLanguage.md | 6 ++--
>> .../globalization.isDayLightSavingsTime.md | 6 ++--
>> .../globalization.numberToString.md | 6 ++--
>> .../globalization/globalization.stringToDate.md | 4 +--
>> .../globalization.stringToNumber.md | 6 ++--
>> 13 files changed, 63 insertions(+), 59 deletions(-)
>> ----------------------------------------------------------------------
>
Fwd: [27/46] docs commit: amidst globalization api
Posted by Marcel Kinard <cm...@gmail.com>.
Mike, how about adding a reference to STYLESHEET.md in README.md, so people looking at README.md see the great style guidelines you authored? Or perhaps even collapse STYLESHEET.md into README.md so it's all inline in the README.
-- Marcel Kinard
Begin forwarded message:
> From: Marcel Kinard <cm...@gmail.com>
> Subject: Re: [27/46] docs commit: amidst globalization api
> Date: June 12, 2013 4:54:31 PM EDT
> To: "dev@cordova.apache.org" <de...@cordova.apache.org>
>
> Lots of files being touched, but no Jira reference. Mike, in the future could you add a Jira reference to the commit message, per "About Commit Messages" in http://wiki.apache.org/cordova/ContributorWorkflow
>
> After reading for a while, looks like you are a copy editor, and doing some very nice cleanup in the docs, including the new style guide.
>
> -- Marcel Kinard
>
> On Jun 12, 2013, at 1:51 PM, mwbrooks@apache.org wrote:
>
>> amidst globalization 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/e2d7868b
>> Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
>> Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
>>
>> Branch: refs/heads/master
>> Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
>> Parents: d9648d0
>> Author: Mike Sierra <le...@gmail.com>
>> Authored: Fri May 17 09:17:27 2013 -0400
>> Committer: Mike Sierra <le...@gmail.com>
>> Committed: Fri May 17 09:17:27 2013 -0400
>>
>> ----------------------------------------------------------------------
>> .../GlobalizationError/globalizationerror.md | 10 +++---
>> .../globalization/globalization.dateToString.md | 33 +++++++++++---------
>> .../globalization.getCurrencyPattern.md | 21 +++++++------
>> .../globalization/globalization.getDateNames.md | 6 ++--
>> .../globalization.getDatePattern.md | 6 ++--
>> .../globalization.getFirstDayOfWeek.md | 6 ++--
>> .../globalization.getLocaleName.md | 6 ++--
>> .../globalization.getNumberPattern.md | 6 ++--
>> .../globalization.getPreferredLanguage.md | 6 ++--
>> .../globalization.isDayLightSavingsTime.md | 6 ++--
>> .../globalization.numberToString.md | 6 ++--
>> .../globalization/globalization.stringToDate.md | 4 +--
>> .../globalization.stringToNumber.md | 6 ++--
>> 13 files changed, 63 insertions(+), 59 deletions(-)
>> ----------------------------------------------------------------------
>
RE: [27/46] docs commit: amidst globalization api
Posted by Michael Sierra <ms...@adobe.com>.
Sure, sorry for the volume. Am working on improving doc, and needed to bring it up to a certain baseline. Will punch in a few JIRAs to clarify plans going forward, and to help organize existing doc bugs.
--Mike Sierra
________________________________________
From: Marcel Kinard [cmarcelk@gmail.com]
Sent: Wednesday, June 12, 2013 4:54 PM
To: dev@cordova.apache.org
Subject: Re: [27/46] docs commit: amidst globalization api
Lots of files being touched, but no Jira reference. Mike, in the future could you add a Jira reference to the commit message, per "About Commit Messages" in http://wiki.apache.org/cordova/ContributorWorkflow
After reading for a while, looks like you are a copy editor, and doing some very nice cleanup in the docs, including the new style guide.
-- Marcel Kinard
On Jun 12, 2013, at 1:51 PM, mwbrooks@apache.org wrote:
> amidst globalization 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/e2d7868b
> Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
> Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
>
> Branch: refs/heads/master
> Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
> Parents: d9648d0
> Author: Mike Sierra <le...@gmail.com>
> Authored: Fri May 17 09:17:27 2013 -0400
> Committer: Mike Sierra <le...@gmail.com>
> Committed: Fri May 17 09:17:27 2013 -0400
>
> ----------------------------------------------------------------------
> .../GlobalizationError/globalizationerror.md | 10 +++---
> .../globalization/globalization.dateToString.md | 33 +++++++++++---------
> .../globalization.getCurrencyPattern.md | 21 +++++++------
> .../globalization/globalization.getDateNames.md | 6 ++--
> .../globalization.getDatePattern.md | 6 ++--
> .../globalization.getFirstDayOfWeek.md | 6 ++--
> .../globalization.getLocaleName.md | 6 ++--
> .../globalization.getNumberPattern.md | 6 ++--
> .../globalization.getPreferredLanguage.md | 6 ++--
> .../globalization.isDayLightSavingsTime.md | 6 ++--
> .../globalization.numberToString.md | 6 ++--
> .../globalization/globalization.stringToDate.md | 4 +--
> .../globalization.stringToNumber.md | 6 ++--
> 13 files changed, 63 insertions(+), 59 deletions(-)
> ----------------------------------------------------------------------
Re: [27/46] docs commit: amidst globalization api
Posted by Marcel Kinard <cm...@gmail.com>.
Lots of files being touched, but no Jira reference. Mike, in the future could you add a Jira reference to the commit message, per "About Commit Messages" in http://wiki.apache.org/cordova/ContributorWorkflow
After reading for a while, looks like you are a copy editor, and doing some very nice cleanup in the docs, including the new style guide.
-- Marcel Kinard
On Jun 12, 2013, at 1:51 PM, mwbrooks@apache.org wrote:
> amidst globalization 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/e2d7868b
> Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/e2d7868b
> Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/e2d7868b
>
> Branch: refs/heads/master
> Commit: e2d7868ba4dde9f465cc084ba03d4d8f7469cfe2
> Parents: d9648d0
> Author: Mike Sierra <le...@gmail.com>
> Authored: Fri May 17 09:17:27 2013 -0400
> Committer: Mike Sierra <le...@gmail.com>
> Committed: Fri May 17 09:17:27 2013 -0400
>
> ----------------------------------------------------------------------
> .../GlobalizationError/globalizationerror.md | 10 +++---
> .../globalization/globalization.dateToString.md | 33 +++++++++++---------
> .../globalization.getCurrencyPattern.md | 21 +++++++------
> .../globalization/globalization.getDateNames.md | 6 ++--
> .../globalization.getDatePattern.md | 6 ++--
> .../globalization.getFirstDayOfWeek.md | 6 ++--
> .../globalization.getLocaleName.md | 6 ++--
> .../globalization.getNumberPattern.md | 6 ++--
> .../globalization.getPreferredLanguage.md | 6 ++--
> .../globalization.isDayLightSavingsTime.md | 6 ++--
> .../globalization.numberToString.md | 6 ++--
> .../globalization/globalization.stringToDate.md | 4 +--
> .../globalization.stringToNumber.md | 6 ++--
> 13 files changed, 63 insertions(+), 59 deletions(-)
> ----------------------------------------------------------------------