You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/08/15 22:50:52 UTC
[2/3] mark headings inline to make it easier to grep & such
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/events/events.deviceready.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.deviceready.md b/docs/en/edge/cordova/events/events.deviceready.md
index fb27d17..69fdc6a 100644
--- a/docs/en/edge/cordova/events/events.deviceready.md
+++ b/docs/en/edge/cordova/events/events.deviceready.md
@@ -17,15 +17,13 @@
under the License.
---
-deviceready
-===========
+# deviceready
The event fires when Cordova is fully loaded.
document.addEventListener("deviceready", yourCallbackFunction, false);
-Details
--------
+## Details
This event is essential to any application. It signals that Cordova's
device APIs have loaded and are ready to access.
@@ -45,8 +43,7 @@ The `deviceready` event behaves somewhat differently from others. Any
event handler registered after the `deviceready` event fires has its
callback function called immediately.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -55,8 +52,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
document.addEventListener("deviceready", onDeviceReady, false);
@@ -64,8 +60,7 @@ Quick Example
// Now safe to use device APIs
}
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/events/events.endcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.endcallbutton.md b/docs/en/edge/cordova/events/events.endcallbutton.md
index c5d4577..dde9ec1 100644
--- a/docs/en/edge/cordova/events/events.endcallbutton.md
+++ b/docs/en/edge/cordova/events/events.endcallbutton.md
@@ -17,28 +17,24 @@
under the License.
---
-endcallbutton
-===========
+# endcallbutton
This event fires when the user presses the end call button.
document.addEventListener("endcallbutton", yourCallbackFunction, false);
-Details
--------
+## Details
The event overrides the default end call behavior.
Applications typically should use `document.addEventListener` to
attach an event listener once the `deviceready` event fires.
-Supported Platforms
--------------------
+## Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
--------------
+## Quick Example
document.addEventListener("endcallbutton", onEndCallKeyDown, false);
@@ -46,8 +42,7 @@ Quick Example
// Handle the end call button
}
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/events/events.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.md b/docs/en/edge/cordova/events/events.md
index e159ba8..39fe1a2 100644
--- a/docs/en/edge/cordova/events/events.md
+++ b/docs/en/edge/cordova/events/events.md
@@ -17,13 +17,11 @@
under the License.
---
-Events
-======
+# Events
> Cordova lifecycle events.
-Event Types
------------
+## Event Types
- deviceready
- pause
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/events/events.menubutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.menubutton.md b/docs/en/edge/cordova/events/events.menubutton.md
index 88c2922..4a7cf76 100644
--- a/docs/en/edge/cordova/events/events.menubutton.md
+++ b/docs/en/edge/cordova/events/events.menubutton.md
@@ -17,29 +17,25 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-menubutton
-===========
+# menubutton
The event fires when the user presses the menu button.
document.addEventListener("menubutton", yourCallbackFunction, false);
-Details
--------
+## Details
Applying an event handler overrides the default menu button behavior.
Applications typically should use `document.addEventListener` to
attach an event listener once the `deviceready` event fires.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
--------------
+## Quick Example
document.addEventListener("menubutton", onMenuKeyDown, false);
@@ -47,8 +43,7 @@ Quick Example
// Handle the back button
}
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/events/events.offline.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.offline.md b/docs/en/edge/cordova/events/events.offline.md
index fc75044..950ec19 100644
--- a/docs/en/edge/cordova/events/events.offline.md
+++ b/docs/en/edge/cordova/events/events.offline.md
@@ -17,16 +17,14 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-offline
-===========
+# offline
The event fires when an application goes offline, and the device is
not connected to the Internet.
document.addEventListener("offline", yourCallbackFunction, false);
-Details
--------
+## Details
The `offline` event fires when a previously connected device loses a
network connection so that an application can no longer access the
@@ -37,8 +35,7 @@ value.
Applications typically should use `document.addEventListener` to
attach an event listener once the `deviceready` event fires.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -47,8 +44,7 @@ Supported Platforms
- Tizen
- Windows 8
-Quick Example
--------------
+## Quick Example
document.addEventListener("offline", onOffline, false);
@@ -56,8 +52,7 @@ Quick Example
// Handle the offline event
}
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -90,14 +85,14 @@ Full Example
</body>
</html>
-iOS Quirks
---------------------------
+## iOS Quirks
+
During initial startup, the first offline event (if applicable) takes at least a second to fire.
-Windows Phone 7 Quirks
---------------------------
+## Windows Phone 7 Quirks
+
When running in the Emulator, the `connection.status` is always unknown, so this event does _not_ fire.
-Windows Phone 8 Quirks
---------------------------
+## Windows Phone 8 Quirks
+
The Emulator reports the connection type as `Cellular`, which does not change, so the event does _not_ fire.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/events/events.online.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.online.md b/docs/en/edge/cordova/events/events.online.md
index 0827219..a3aac71 100644
--- a/docs/en/edge/cordova/events/events.online.md
+++ b/docs/en/edge/cordova/events/events.online.md
@@ -17,16 +17,14 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-online
-===========
+# online
This event fires when an application goes online, and the device
becomes connected to the Internet.
document.addEventListener("online", yourCallbackFunction, false);
-Details
--------
+## Details
The `online` event fires when a previously unconnected device receives
a network connection to allow an application access to the Internet.
@@ -36,8 +34,7 @@ when the value of `connection.type` becomes `NONE`.
Applications typically should use `document.addEventListener` to
attach an event listener once the `deviceready` event fires.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -46,8 +43,7 @@ Supported Platforms
- Tizen
- Windows 8
-Quick Example
--------------
+## Quick Example
document.addEventListener("online", onOnline, false);
@@ -55,8 +51,7 @@ Quick Example
// Handle the online event
}
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -89,17 +84,16 @@ Full Example
</body>
</html>
-iOS Quirks
---------------------------
+## iOS Quirks
During initial startup, the first `online` event (if applicable) takes
at least a second to fire, prior to which `connection.type` is
`UNKNOWN`.
-Windows Phone 7 Quirks
---------------------------
+## Windows Phone 7 Quirks
+
When running in the Emulator, the `connection.status` is always unknown, so this event will _not_ fire.
-Windows Phone 8 Quirks
---------------------------
+## Windows Phone 8 Quirks
+
The Emulator reports the connection type as `Cellular`, which does not change, so events will _not_ fire.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/events/events.pause.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.pause.md b/docs/en/edge/cordova/events/events.pause.md
index 3cf7e30..6e499c4 100644
--- a/docs/en/edge/cordova/events/events.pause.md
+++ b/docs/en/edge/cordova/events/events.pause.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-pause
-===========
+# pause
The event fires when an application is put into the background.
document.addEventListener("pause", yourCallbackFunction, false);
-Details
--------
+## Details
The `pause` event fires when the native platform puts the application
into the background, typically when the user switches to a different
@@ -34,8 +32,7 @@ application.
Applications typically should use `document.addEventListener` to
attach an event listener once the `deviceready` event fires.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -43,8 +40,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
document.addEventListener("pause", onPause, false);
@@ -52,8 +48,7 @@ Quick Example
// Handle the pause event
}
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -86,8 +81,7 @@ Full Example
</body>
</html>
-iOS Quirks
---------------------------
+## iOS Quirks
In the `pause` handler, any calls to the Cordova API or to native
plugins that go through Objective-C do not work, along with any
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/events/events.resume.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.resume.md b/docs/en/edge/cordova/events/events.resume.md
index fe07593..97d2ceb 100644
--- a/docs/en/edge/cordova/events/events.resume.md
+++ b/docs/en/edge/cordova/events/events.resume.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-resume
-===========
+# resume
The event fires when an application is retrieved from the background.
document.addEventListener("resume", yourCallbackFunction, false);
-Details
--------
+## Details
The `resume` event fires when the native platform pulls the
application out from the background.
@@ -33,8 +31,7 @@ application out from the background.
Applications typically should use `document.addEventListener` to
attach an event listener once the `deviceready` event fires.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -42,8 +39,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
document.addEventListener("resume", onResume, false);
@@ -51,8 +47,7 @@ Quick Example
// Handle the resume event
}
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -85,8 +80,7 @@ Full Example
</body>
</html>
-iOS Quirks
---------------------------
+## iOS Quirks
Any interactive functions called from a `pause` event handler execute
later when the app resumes, as signaled by the `resume` event. These
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/events/events.searchbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.searchbutton.md b/docs/en/edge/cordova/events/events.searchbutton.md
index 8c8c1e8..bdde91e 100644
--- a/docs/en/edge/cordova/events/events.searchbutton.md
+++ b/docs/en/edge/cordova/events/events.searchbutton.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-searchbutton
-===========
+# searchbutton
The event fires when the user presses the search button on Android.
document.addEventListener("searchbutton", yourCallbackFunction, false);
-Details
--------
+## Details
If you need to override the default search button behavior on Android
you can register an event listener for the 'searchbutton' event.
@@ -33,13 +31,11 @@ you can register an event listener for the 'searchbutton' event.
Applications typically should use `document.addEventListener` to
attach an event listener once the `deviceready` event fires.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
-Quick Example
--------------
+## Quick Example
document.addEventListener("searchbutton", onSearchKeyDown, false);
@@ -47,8 +43,7 @@ Quick Example
// Handle the search button
}
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/events/events.startcallbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.startcallbutton.md b/docs/en/edge/cordova/events/events.startcallbutton.md
index 4183277..8db28ae 100644
--- a/docs/en/edge/cordova/events/events.startcallbutton.md
+++ b/docs/en/edge/cordova/events/events.startcallbutton.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-startcallbutton
-===========
+# startcallbutton
The event fires when the user presses the start call button.
document.addEventListener("startcallbutton", yourCallbackFunction, false);
-Details
--------
+## Details
If you need to override the default start call behavior you can
register an event listener for the `startcallbutton` event.
@@ -33,13 +31,11 @@ register an event listener for the `startcallbutton` event.
Applications typically should use `document.addEventListener` to
attach an event listener once the `deviceready` event fires.
-Supported Platforms
--------------------
+## Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
--------------
+## Quick Example
document.addEventListener("startcallbutton", onStartCallKeyDown, false);
@@ -47,8 +43,7 @@ Quick Example
// Handle the start call button
}
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/events/events.volumedownbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.volumedownbutton.md b/docs/en/edge/cordova/events/events.volumedownbutton.md
index 843a6ef..229b9cc 100644
--- a/docs/en/edge/cordova/events/events.volumedownbutton.md
+++ b/docs/en/edge/cordova/events/events.volumedownbutton.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-volumedownbutton
-===========
+# volumedownbutton
The event fires when the user presses the volume down button.
document.addEventListener("volumedownbutton", yourCallbackFunction, false);
-Details
--------
+## Details
If you need to override the default volume down behavior you can
register an event listener for the `volumedownbutton` event.
@@ -33,13 +31,11 @@ register an event listener for the `volumedownbutton` event.
Applications typically should use `document.addEventListener` to
attach an event listener once the `deviceready` event fires.
-Supported Platforms
--------------------
+## Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
--------------
+## Quick Example
document.addEventListener("volumedownbutton", onVolumeDownKeyDown, false);
@@ -47,8 +43,7 @@ Quick Example
// Handle the volume down button
}
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/events/events.volumeupbutton.md b/docs/en/edge/cordova/events/events.volumeupbutton.md
index 82fd996..5c48ff9 100644
--- a/docs/en/edge/cordova/events/events.volumeupbutton.md
+++ b/docs/en/edge/cordova/events/events.volumeupbutton.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-volumeupbutton
-===========
+# volumeupbutton
The event fires when the user presses the volume up button.
document.addEventListener("volumeupbutton", yourCallbackFunction, false);
-Details
--------
+## Details
If you need to override the default volume up behavior you can
register an event listener for the `volumeupbutton` event.
@@ -33,13 +31,11 @@ register an event listener for the `volumeupbutton` event.
Applications typically should use `document.addEventListener` to
attach an event listener once the `deviceready` event fires.
-Supported Platforms
--------------------
+## Supported Platforms
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
--------------
+## Quick Example
document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false);
@@ -47,8 +43,7 @@ Quick Example
// Handle the volume up button
}
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 3c8cbe8..f9d5ff7 100644
--- a/docs/en/edge/cordova/file/directoryentry/directoryentry.md
+++ b/docs/en/edge/cordova/file/directoryentry/directoryentry.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-DirectoryEntry
-==============
+# DirectoryEntry
This object represents a directory on a file system, as defined by the
[W3C Directories and Systems](http://www.w3.org/TR/file-system-api/)
specification.
-Properties
-----------
+## Properties
- __isFile__: Always `false`. _(boolean)_
@@ -40,8 +38,7 @@ but is _not_ supported:
- __filesystem__: The file system on which the `DirectoryEntry` resides. _(FileSystem)_
-Methods
--------
+## Methods
The following methods can be invoked on a `DirectoryEntry` object:
@@ -67,8 +64,7 @@ The following methods can be invoked on a `DirectoryEntry` object:
- __removeRecursively__: Delete a directory and all of its contents.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -76,8 +72,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-getMetadata
------------
+## getMetadata
Look up metadata about a directory.
@@ -100,8 +95,7 @@ __Quick Example__
// Request the metadata object for this entry
entry.getMetadata(success, fail);
-setMetadata
-----------------
+## setMetadata
Sets a directory's extended attributes, or metadata. _Currently works
only on iOS._
@@ -164,8 +158,7 @@ __Quick Example__
setFolderMetadata(LocalFileSystem.PERSISTENT, "Backups", "com.apple.MobileBackup", 1);
-moveTo
-------
+## moveTo
Move a directory to a different location on the file system. An error results if the app attempts to:
@@ -210,8 +203,7 @@ __Quick Example__
entry.moveTo(parentEntry, newName, success, fail);
}
-copyTo
-------
+## copyTo
Copy a directory to a different location on the file system. An error results if the app attempts to:
@@ -251,8 +243,7 @@ __Quick Example__
entry.copyTo(parentEntry, newName, success, fail);
}
-toURL
------
+## toURL
Returns a URL that can be used to locate the directory.
@@ -262,8 +253,7 @@ __Quick Example__
var dirURL = entry.toURL();
console.log(dirURL);
-remove
-------
+## remove
Deletes a directory. An error results if the app attempts to:
@@ -290,8 +280,7 @@ __Quick Example__
// remove this directory
entry.remove(success, fail);
-getParent
----------
+## getParent
Look up the parent `DirectoryEntry` containing the directory.
@@ -314,8 +303,7 @@ __Quick Example__
// Get the parent DirectoryEntry
entry.getParent(success, fail);
-createReader
-------------
+## createReader
Creates a new DirectoryReader to read entries in a directory.
@@ -324,8 +312,7 @@ __Quick Example__
// create a directory reader
var directoryReader = entry.createReader();
-getDirectory
-------------
+## getDirectory
Creates or looks up an existing directory. An error results if the app attempts to:
@@ -354,8 +341,7 @@ __Quick Example__
// Retrieve an existing directory, or create it if it does not already exist
entry.getDirectory("newDir", {create: true, exclusive: false}, success, fail);
-getFile
--------
+## getFile
Creates or looks up a file. An error results if the app attempts to:
@@ -384,8 +370,7 @@ __Quick Example__
// Retrieve an existing file, or create it if it does not exist
entry.getFile("newFile.txt", {create: true, exclusive: false}, success, fail);
-removeRecursively
------------------
+## removeRecursively
Deletes a directory and all of its contents. In the event of an error (such as trying to delete
a directory containing a file that cannot be removed), some of the contents of the directory may
@@ -412,8 +397,7 @@ __Quick Example__
// remove the directory and all it's contents
entry.removeRecursively(success, fail);
-BlackBerry Quirks
------------------
+## BlackBerry Quirks
May fail with a `ControlledAccessException` in the following cases:
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/directoryreader/directoryreader.md b/docs/en/edge/cordova/file/directoryreader/directoryreader.md
index 8146726..a13cb02 100644
--- a/docs/en/edge/cordova/file/directoryreader/directoryreader.md
+++ b/docs/en/edge/cordova/file/directoryreader/directoryreader.md
@@ -17,21 +17,18 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-DirectoryReader
-===============
+# DirectoryReader
An object that lists files and directories within a directory, as
defined in the
[W3C Directories and Systems](http://www.w3.org/TR/file-system-api/)
specification.
-Methods
--------
+## Methods
- __readEntries__: Read the entries in a directory.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -39,8 +36,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-readEntries
------------
+## readEntries
Read the entries in this directory.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/file.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/file.md b/docs/en/edge/cordova/file/file.md
index 96f31f1..34dfd8c 100644
--- a/docs/en/edge/cordova/file/file.md
+++ b/docs/en/edge/cordova/file/file.md
@@ -17,13 +17,11 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-File
-==========
+# File
> An API to read, write and navigate file system hierarchies, based on the [W3C File API](http://www.w3.org/TR/FileAPI).
-Objects
--------
+## Objects
- DirectoryEntry
- DirectoryReader
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileentry/fileentry.md b/docs/en/edge/cordova/file/fileentry/fileentry.md
index fb158f0..37c22c6 100644
--- a/docs/en/edge/cordova/file/fileentry/fileentry.md
+++ b/docs/en/edge/cordova/file/fileentry/fileentry.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-FileEntry
-==========
+# FileEntry
Represents a file on a file system, as defined in the
[W3C Directories and Systems](http://www.w3.org/TR/file-system-api/)
specification.
-Properties
-----------
+## Properties
- __isFile__: Always `true`. _(boolean)_
@@ -40,8 +38,7 @@ but is _not_ supported:
- __filesystem__: The file system on which the `FileEntry` resides. _(FileSystem)_
-Methods
--------
+## Methods
- __getMetadata__: Look up metadata about a file.
@@ -61,8 +58,7 @@ Methods
- __file__: Creates a `File` object containing file properties.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -70,8 +66,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-getMetadata
-----------------
+## getMetadata
Look up metadata about a file.
@@ -94,8 +89,7 @@ __Quick Example__
// Request the metadata object for this entry
entry.getMetadata(success, fail);
-setMetadata
-----------------
+## setMetadata
Set metadata on a file.
@@ -161,8 +155,7 @@ __Quick Example__
setFileMetadata(LocalFileSystem.PERSISTENT, "Backups/sqlite.db", "com.apple.MobileBackup", 1);
-moveTo
-------
+## moveTo
Move a file to a different location on the file system. An error
results if the app attempts to:
@@ -203,8 +196,7 @@ __Quick Example__
entry.moveTo(parentEntry, "newFile.txt", success, fail);
}
-copyTo
-------
+## copyTo
Copy a file to a new location on the file system. An error results if
the app attempts to:
@@ -240,8 +232,7 @@ __Quick Example__
entry.copyTo(parentEntry, "file.copy", success, fail);
}
-toURL
------
+## toURL
Returns a URL that can be used to locate the file.
@@ -251,8 +242,7 @@ __Quick Example__
var fileURL = entry.toURL();
console.log(fileURL);
-remove
-------
+## remove
Deletes a file.
@@ -275,8 +265,7 @@ __Quick Example__
// remove the file
entry.remove(success, fail);
-getParent
----------
+## getParent
Look up the parent `DirectoryEntry` containing the file.
@@ -299,8 +288,7 @@ __Quick Example__
// Get the parent DirectoryEntry
entry.getParent(success, fail);
-createWriter
-------------
+## createWriter
Create a `FileWriter` object associated with the file represented by the `FileEntry`.
@@ -323,8 +311,7 @@ __Quick Example__
// create a FileWriter to write to the file
entry.createWriter(success, fail);
-file
-----
+## file
Return a `File` object that represents the current state of the file
that this `FileEntry` represents.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileerror/fileerror.md b/docs/en/edge/cordova/file/fileerror/fileerror.md
index 1d7f39f..47add3f 100644
--- a/docs/en/edge/cordova/file/fileerror/fileerror.md
+++ b/docs/en/edge/cordova/file/fileerror/fileerror.md
@@ -17,18 +17,15 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-FileError
-========
+# FileError
A `FileError` object is set when an error occurs in any of the File API methods.
-Properties
-----------
+## Properties
- __code__: One of the predefined error codes listed below.
-Constants
----------
+## Constants
- `FileError.NOT_FOUND_ERR`
- `FileError.SECURITY_ERR`
@@ -43,8 +40,7 @@ Constants
- `FileError.TYPE_MISMATCH_ERR`
- `FileError.PATH_EXISTS_ERR`
-Description
------------
+## Description
The `FileError` object is the only parameter provided to any of the
File API's error callbacks. To determine the type of error, compare
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileobj/fileobj.md b/docs/en/edge/cordova/file/fileobj/fileobj.md
index e1216c4..93d0622 100644
--- a/docs/en/edge/cordova/file/fileobj/fileobj.md
+++ b/docs/en/edge/cordova/file/fileobj/fileobj.md
@@ -17,13 +17,11 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-File
-====
+# File
This object contains attributes of a single file.
-Properties
-----------
+## Properties
- __name__: The name of the file. _(DOMString)_
@@ -35,20 +33,17 @@ Properties
- __size__: The size of the file in bytes. _(long)_
-Methods
--------
+## Methods
- __slice__: Select only a portion of the file to be read.
-Details
--------
+## Details
The `File` object contains attributes of a single file. You can get
an instance of a `File` object by calling a `FileEntry` object's
`file()` method.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -56,8 +51,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-slice
---------------
+## slice
Return a new `File` object, for which `FileReader` returns only the
specified portion of the file. Negative values for `start` or `end`
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filereader/filereader.md b/docs/en/edge/cordova/file/filereader/filereader.md
index 412e935..98371c3 100644
--- a/docs/en/edge/cordova/file/filereader/filereader.md
+++ b/docs/en/edge/cordova/file/filereader/filereader.md
@@ -17,13 +17,11 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-FileReader
-==========
+# FileReader
The `FileReader` allows basic access to a file.
-Properties
-----------
+## Properties
- __readyState__: One of the reader's three possible states, either `EMPTY`, `LOADING` or `DONE`.
@@ -45,8 +43,7 @@ __NOTE:__ The following porperty is not supported:
- __onprogress__: Called while reading the file, reporting progress in terms of `progress.loaded`/`progress.total`. _(Function)_
-Methods
--------
+## Methods
- __abort__: Aborts reading file.
@@ -58,16 +55,14 @@ Methods
- __readAsArrayBuffer__: Reads file as an `ArrayBuffer`.
-Details
--------
+## Details
The `FileReader` object offers a way to read files from the device's
file system. Files can be read as text or as a base64 data-encoded
string. Event listeners receive the `loadstart`, `progress`, `load`,
`loadend`, `error`, and `abort` events.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -75,15 +70,13 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Read As Data URL
-----------------
+## Read As Data URL
__Parameters:__
- __file__: the file object to read.
-Quick Example
--------------
+## Quick Example
function win(file) {
var reader = new FileReader();
@@ -100,8 +93,7 @@ Quick Example
entry.file(win, fail);
-Read As Text
-------------
+## Read As Text
__Parameters:__
@@ -109,8 +101,7 @@ __Parameters:__
- __encoding__: the encoding to use to encode the file's content. Default is UTF8.
-Quick Example
--------------
+## Quick Example
function win(file) {
var reader = new FileReader();
@@ -127,8 +118,7 @@ Quick Example
entry.file(win, fail);
-Abort Quick Example
--------------------
+## Abort Quick Example
function win(file) {
var reader = new FileReader();
@@ -146,8 +136,7 @@ Abort Quick Example
entry.file(win, fail);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -210,13 +199,11 @@ Full Example
</body>
</html>
-iOS Quirks
-----------
+## iOS Quirks
- The __encoding__ parameter is not supported, and UTF8 encoding is always in effect.
-Read As Binary String
----------------------
+## Read As Binary String
Currently supported on iOS and Android only.
@@ -224,8 +211,7 @@ __Parameters:__
- __file__: the file object to read.
-Quick Example
--------------
+## Quick Example
function win(file) {
var reader = new FileReader();
@@ -242,8 +228,7 @@ Quick Example
entry.file(win, fail);
-Read As Array Buffer
---------------------
+## Read As Array Buffer
Currently supported on iOS and Android only.
@@ -251,8 +236,7 @@ __Parameters:__
- __file__: the file object to read.
-Quick Example
--------------
+## Quick Example
function win(file) {
var reader = new FileReader();
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filesystem/filesystem.md b/docs/en/edge/cordova/file/filesystem/filesystem.md
index 2367d2d..2357a24 100644
--- a/docs/en/edge/cordova/file/filesystem/filesystem.md
+++ b/docs/en/edge/cordova/file/filesystem/filesystem.md
@@ -17,28 +17,24 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-FileSystem
-==========
+# FileSystem
This object represents a file system.
-Properties
-----------
+## Properties
- __name__: The name of the file system. _(DOMString)_
- __root__: The root directory of the file system. _(DirectoryEntry)_
-Details
--------
+## Details
The `FileSystem` object represents information about the file system.
The name of the file system is unique across the list of exposed
file systems. The root property contains a `DirectoryEntry` object
that represents the file system's root directory.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -46,8 +42,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-File System Quick Example
--------------------------
+## File System Quick Example
function onSuccess(fileSystem) {
console.log(fileSystem.name);
@@ -57,8 +52,7 @@ File System Quick Example
// request the persistent file system
window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, null);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfer/filetransfer.md b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
index 1ef635b..568f49a 100644
--- a/docs/en/edge/cordova/file/filetransfer/filetransfer.md
+++ b/docs/en/edge/cordova/file/filetransfer/filetransfer.md
@@ -17,19 +17,16 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-FileTransfer
-==========
+# FileTransfer
The `FileTransfer` object allows you to upload or download files to
and from a server.
-Properties
-----------
+## Properties
- __onprogress__: Called with a `ProgressEvent` whenever a new chunk of data is transferred. _(Function)_
-Methods
--------
+## Methods
- __upload__: sends a file to a server.
@@ -37,8 +34,7 @@ Methods
- __abort__: Aborts an in-progress transfer.
-Details
--------
+## Details
The `FileTransfer` object provides a way to upload files to a remote
server using an HTTP multi-part POST request. Both HTTP and HTTPS
@@ -50,8 +46,7 @@ passed to the error callback. It is also possible (only on iOS and
Android) to download a file from a remote server and save it on the
device.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -59,8 +54,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-upload
---------------
+## upload
__Parameters:__
@@ -206,8 +200,7 @@ __Android Quirks__
Set the `chunkedMode` option to `false` to prevent problems uploading
to a Nginx server.
-download
---------------
+## download
__Parameters:__
@@ -249,8 +242,7 @@ __Quick Example__
}
);
-abort
---------------
+## abort
Aborts an in-progress transfer. The onerror callback is passed a FileTransferError object which has an error code of FileTransferError.ABORT_ERR.
@@ -283,8 +275,7 @@ __Quick Example__
ft.upload(fileURI, encodeURI("http://some.server.com/upload.php"), win, fail, options);
ft.abort();
-onprogress
---------------
+## onprogress
Called with a ProgressEvent whenever a new chunk of data is transferred.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md b/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
index a3cba30..d9ac430 100644
--- a/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
+++ b/docs/en/edge/cordova/file/filetransfererror/filetransfererror.md
@@ -17,13 +17,11 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-FileTransferError
-========
+# FileTransferError
A `FileTransferError` object is passed to an error callback when an error occurs.
-Properties
-----------
+## Properties
- __code__: One of the predefined error codes listed below. (Number)
@@ -33,16 +31,14 @@ Properties
- __http_status__: HTTP status code. This attribute is only available when a response code is received from the HTTP connection. (Number)
-Constants
----------
+## Constants
- `FileTransferError.FILE_NOT_FOUND_ERR`
- `FileTransferError.INVALID_URL_ERR`
- `FileTransferError.CONNECTION_ERR`
- `FileTransferError.ABORT_ERR`
-Description
------------
+## Description
The `FileTransferError` object is passed to the error callback when an
error occurs when uploading or downloading a file.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md b/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
index 0aea57e..1510f80 100644
--- a/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/docs/en/edge/cordova/file/fileuploadoptions/fileuploadoptions.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-FileUploadOptions
-========
+# FileUploadOptions
A `FileUploadOptions` object can be passed to the `FileTransfer`
object's `upload()` method to specify additional parameters to the
upload script.
-Properties
-----------
+## Properties
- __fileKey__: The name of the form element. Defaults to `file`. (DOMString)
@@ -39,14 +37,12 @@ Properties
- __headers__: A map of header name/header values. Use an array to specify more than one value. (Object)
-Description
------------
+## Description
A `FileUploadOptions` object can be passed to the `FileTransfer`
object's `upload()` method to specify additional parameters to the
upload script.
-WP7 Quirk
----------
+## WP7 Quirk
- __chunkedMode:__: Ignored on WP7.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md b/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
index f24d9c5..0972856 100644
--- a/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
+++ b/docs/en/edge/cordova/file/fileuploadresult/fileuploadresult.md
@@ -17,14 +17,12 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-FileUploadResult
-========
+# FileUploadResult
A `FileUploadResult` object is passed to the success callback of the
`FileTransfer` object's `upload()` method.
-Properties
-----------
+## Properties
- __bytesSent__: The number of bytes sent to the server as part of the upload. (long)
@@ -32,13 +30,11 @@ Properties
- __response__: The HTTP response returned by the server. (DOMString)
-Description
------------
+## Description
The `FileUploadResult` object is returned via the success callback of
the `FileTransfer` object's `upload()` method.
-iOS Quirks
-----------
+## iOS Quirks
- Does not support `responseCode` or `bytesSent`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/filewriter/filewriter.md b/docs/en/edge/cordova/file/filewriter/filewriter.md
index 4af7f7d..c2e2184 100644
--- a/docs/en/edge/cordova/file/filewriter/filewriter.md
+++ b/docs/en/edge/cordova/file/filewriter/filewriter.md
@@ -17,13 +17,11 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-FileWriter
-==========
+# FileWriter
As object that allows you to create and write data to a file.
-Properties
-----------
+## Properties
- __readyState__: One of the three possible states, either `INIT`, `WRITING`, or `DONE`.
@@ -48,8 +46,7 @@ Properties
The following property is _not_ supported:
- __onprogress__: Called while writing the file, reporting progress in terms of `progress.loaded`/`progress.total`. _(Function)_
-Methods
--------
+## Methods
- __abort__: Aborts writing the file.
@@ -59,8 +56,7 @@ Methods
- __write__: Writes data to the file.
-Details
--------
+## Details
The `FileWriter` object offers a way to write UTF-8 encoded files to
the device file system. Applications respond to `writestart`,
@@ -76,8 +72,7 @@ write to the end of the file.
Text data is supported by all platforms listed below. Text is encoded as UTF-8 before being written to the filesystem. Some platforms also support binary data, which can be passed in as either an ArrayBuffer or a Blob.
-Supported Platforms
--------------------
+## Supported Platforms
Text and Binary Support:
@@ -90,8 +85,7 @@ Text-only Support:
- Windows Phone 7 and 8
- Windows 8
-Seek Quick Example
-------------------------------
+## Seek Quick Example
function win(writer) {
// fast forwards file pointer to end of file
@@ -104,8 +98,7 @@ Seek Quick Example
entry.createWriter(win, fail);
-Truncate Quick Example
---------------------------
+## Truncate Quick Example
function win(writer) {
writer.truncate(10);
@@ -117,8 +110,7 @@ Truncate Quick Example
entry.createWriter(win, fail);
-Write Quick Example
--------------------
+## Write Quick Example
function win(writer) {
writer.onwrite = function(evt) {
@@ -133,8 +125,7 @@ Write Quick Example
entry.createWriter(win, fail);
-Binary Write Quick Example
---------------------------
+## Binary Write Quick Example
function win(writer) {
var data = new ArrayBuffer(5),
@@ -154,8 +145,7 @@ Binary Write Quick Example
entry.createWriter(win, fail);
-Append Quick Example
---------------------
+## Append Quick Example
function win(writer) {
writer.onwrite = function(evt) {
@@ -171,8 +161,7 @@ Append Quick Example
entry.createWriter(win, fail);
-Abort Quick Example
--------------------
+## Abort Quick Example
function win(writer) {
writer.onwrite = function(evt) {
@@ -188,8 +177,8 @@ Abort Quick Example
entry.createWriter(win, fail);
-Full Example
-------------
+## Full Example
+
<!DOCTYPE html>
<html>
<head>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/flags/flags.md b/docs/en/edge/cordova/file/flags/flags.md
index 9303dd6..8cbd91e 100644
--- a/docs/en/edge/cordova/file/flags/flags.md
+++ b/docs/en/edge/cordova/file/flags/flags.md
@@ -17,22 +17,19 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-Flags
-=====
+# Flags
Supplies arguments to the `DirectoryEntry` object's `getFile()` and
`getDirectory()` methods, which look up or create files and
directories, respectively.
-Properties
-----------
+## Properties
- __create__: Indicates that the file or directory should be created if it does not already exist. _(boolean)_
- __exclusive__: Has has no effect by itself, but when used with `create` causes the file or directory creation to fail if the target path already exists. _(boolean)_
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -40,8 +37,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// Get the data directory, creating it if it doesn't exist.
dataDir = fileSystem.root.getDirectory("data", {create: true});
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
index 67bcee2..d559e6f 100644
--- a/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
+++ b/docs/en/edge/cordova/file/localfilesystem/localfilesystem.md
@@ -17,32 +17,27 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-LocalFileSystem
-===============
+# LocalFileSystem
This object provides a way to obtain root file systems.
-Methods
-----------
+## Methods
- __requestFileSystem__: Requests a filesystem. _(Function)_
- __resolveLocalFileSystemURI__: Retrieve a `DirectoryEntry` or `FileEntry` using local URI. _(Function)_
-Constants
----------
+## Constants
- `LocalFileSystem.PERSISTENT`: Used for storage that should not be removed by the user agent without application or user permission.
- `LocalFileSystem.TEMPORARY`: Used for storage with no guarantee of persistence.
-Details
--------
+## Details
The `LocalFileSystem` object methods are defined on the `window` object.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -50,8 +45,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Request File System Quick Example
----------------------------------
+## Request File System Quick Example
function onSuccess(fileSystem) {
console.log(fileSystem.name);
@@ -60,8 +54,7 @@ Request File System Quick Example
// request the persistent file system
window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError);
-Resolve Local File System URI Quick Example
--------------------------------------------
+## Resolve Local File System URI Quick Example
function onSuccess(fileEntry) {
console.log(fileEntry.name);
@@ -69,8 +62,7 @@ Resolve Local File System URI Quick Example
window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/file/metadata/metadata.md b/docs/en/edge/cordova/file/metadata/metadata.md
index bfa3a46..f56a60c 100644
--- a/docs/en/edge/cordova/file/metadata/metadata.md
+++ b/docs/en/edge/cordova/file/metadata/metadata.md
@@ -17,25 +17,21 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-Metadata
-==========
+# Metadata
An interface that supplies information about the state of a file or directory.
-Properties
-----------
+## Properties
- __modificationTime__: The time when the file or directory was last modified. _(Date)_
-Details
--------
+## Details
The `Metadata` object represents information about the state of a file
or directory. Calling a `DirectoryEntry` or `FileEntry` object's
`getMetadata()` method results in a `Metadata` instance.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -43,8 +39,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
function win(metadata) {
console.log("Last Modified: " + metadata.modificationTime);
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
index 4b39428..f9d0a50 100644
--- a/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
+++ b/docs/en/edge/cordova/geolocation/Coordinates/coordinates.md
@@ -17,13 +17,11 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-Coordinates
-===========
+# Coordinates
A set of properties that describe the geographic coordinates of a position.
-Properties
-----------
+## Properties
* __latitude__: Latitude in decimal degrees. _(Number)_
@@ -39,14 +37,12 @@ Properties
* __speed__: Current ground speed of the device, specified in meters per second. _(Number)_
-Description
------------
+## Description
The `Coordinates` object is attached to the `Position` object that is
available to callback functions in requests for the current position.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -55,8 +51,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// onSuccess Callback
//
@@ -79,8 +74,7 @@ Quick Example
navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
@@ -126,7 +120,6 @@ Full Example
</body>
</html>
-Android Quirks
--------------
+## Android Quirks
__altitudeAccuracy__: Not supported by Android devices, returning `null`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/Position/position.md b/docs/en/edge/cordova/geolocation/Position/position.md
index 61178e2..0262723 100644
--- a/docs/en/edge/cordova/geolocation/Position/position.md
+++ b/docs/en/edge/cordova/geolocation/Position/position.md
@@ -17,25 +17,21 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-Position
-========
+# Position
Contains `Position` coordinates and timestamp, created by the geolocation API.
-Properties
-----------
+## Properties
- __coords__: A set of geographic coordinates. _(Coordinates)_
- __timestamp__: Creation timestamp for `coords`. _(Date)_
-Description
------------
+## Description
The `Position` object is created and populated by Cordova, and returned to the user through a callback function.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -44,8 +40,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// onSuccess Callback
//
@@ -69,8 +64,7 @@ Quick Example
navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/PositionError/positionError.md b/docs/en/edge/cordova/geolocation/PositionError/positionError.md
index 9ba183e..f2181bc 100755
--- a/docs/en/edge/cordova/geolocation/PositionError/positionError.md
+++ b/docs/en/edge/cordova/geolocation/PositionError/positionError.md
@@ -17,27 +17,23 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-PositionError
-========
+# PositionError
A `PositionError` object is passed to the `geolocationError` callback when an error occurs.
-Properties
-----------
+## Properties
- __code__: One of the predefined error codes listed below.
- __message__: Error message describing the details of the error encountered.
-Constants
----------
+## Constants
- `PositionError.PERMISSION_DENIED`
- `PositionError.POSITION_UNAVAILABLE`
- `PositionError.TIMEOUT`
-Description
------------
+## Description
The `PositionError` object is passed to the `geolocationError`
callback function when an error occurs with geolocation.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md b/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
index 0e41801..2cf134c 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.clearWatch.md
@@ -17,28 +17,24 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-geolocation.clearWatch
-======================
+# geolocation.clearWatch
Stop watching for changes to the device's location referenced by the
`watchID` parameter.
navigator.geolocation.clearWatch(watchID);
-Parameters
-----------
+## Parameters
- __watchID__: The id of the `watchPosition` interval to clear. (String)
-Description
------------
+## Description
The `geolocation.clearWatch` stops watching changes to the device's
location by clearing the `geolocation.watchPosition` referenced by
`watchID`.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -47,8 +43,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// Options: watch for changes in position, and use the most
// accurate position acquisition method available.
@@ -59,8 +54,7 @@ Quick Example
navigator.geolocation.clearWatch(watchID);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 e5a5ed8..31a30fe 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-geolocation.getCurrentPosition
-==============================
+# geolocation.getCurrentPosition
Returns the device's current position as a `Position` object.
@@ -26,8 +25,7 @@ Returns the device's current position as a `Position` object.
[geolocationError],
[geolocationOptions]);
-Parameters
-----------
+## Parameters
- __geolocationSuccess__: The callback that is passed the current position.
@@ -35,8 +33,7 @@ Parameters
- __geolocationOptions__: _(Optional)_ The geolocation options.
-Description
------------
+## Description
`geolocation.getCurrentPosition` is an asynchronous function. It
returns the device's current position to the `geolocationSuccess`
@@ -44,8 +41,7 @@ callback with a `Position` object as the parameter. If there is an
error, the `geolocationError` callback is passed a
`PositionError` object.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -54,8 +50,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// onSuccess Callback
// This method accepts a Position object, which contains the
@@ -81,8 +76,7 @@ Quick Example
navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.md b/docs/en/edge/cordova/geolocation/geolocation.md
index 40cce81..7ce4b22 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.md
@@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-Geolocation
-===========
+# Geolocation
> The `geolocation` object provides access to location data based on the device's GPS sensor or inferred from network signals.
@@ -48,22 +47,19 @@ above, as well as obtaining the user's permission (e.g., by presenting
choices for __OK__ and __No Thanks__). For more information, please
see the Privacy Guide.
-Methods
--------
+## Methods
- geolocation.getCurrentPosition
- geolocation.watchPosition
- geolocation.clearWatch
-Arguments
----------
+## Arguments
- geolocationSuccess
- geolocationError
- geolocationOptions
-Objects (Read-Only)
--------------------
+## Objects (Read-Only)
- Position
- PositionError
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
index c1e4119..1ecbde1 100644
--- a/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
+++ b/docs/en/edge/cordova/geolocation/geolocation.watchPosition.md
@@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-geolocation.watchPosition
-=========================
+# geolocation.watchPosition
Watches for changes to the device's current position.
@@ -26,8 +25,7 @@ Watches for changes to the device's current position.
[geolocationError],
[geolocationOptions]);
-Parameters
-----------
+## Parameters
- __geolocationSuccess__: The callback that is passed the current position.
@@ -35,13 +33,11 @@ Parameters
- __geolocationOptions__: (Optional) The geolocation options.
-Returns
--------
+## Returns
- __String__: returns a watch id that references the watch position interval. The watch id should be used with `geolocation.clearWatch` to stop watching for changes in position.
-Description
------------
+## Description
`geolocation.watchPosition` is an asynchronous function. It returns
the device's current position when a change in position is detected.
@@ -50,8 +46,7 @@ callback executes with a `Position` object as the parameter. If
there is an error, the `geolocationError` callback executes with a
`PositionError` object as the parameter.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
@@ -60,8 +55,7 @@ Supported Platforms
- Windows Phone 7 and 8
- Windows 8
-Quick Example
--------------
+## Quick Example
// onSuccess Callback
// This method accepts a `Position` object, which contains
@@ -85,8 +79,7 @@ Quick Example
//
var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 });
-Full Example
-------------
+## Full Example
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 107009d..b338e08 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocation.options.md
@@ -17,16 +17,14 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-geolocationOptions
-==================
+# geolocationOptions
Optional parameters to customize the retrieval of the geolocation
`Position`.
{ maximumAge: 3000, timeout: 5000, enableHighAccuracy: true };
-Options
--------
+## 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)_
@@ -34,8 +32,7 @@ Options
- __maximumAge__: Accept a cached position whose age is no greater than the specified time in milliseconds. _(Number)_
-Android Quirks
---------------
+## Android Quirks
Android 2.x emulators do not return a geolocation result unless the `enableHighAccuracy` option is set to `true`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocationError.md b/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
index c087165..c968208 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocationError.md
@@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-geolocationError
-================
+# geolocationError
The user's callback function that executes when there is an error for
geolocation functions.
@@ -27,7 +26,6 @@ geolocation functions.
// Handle the error
}
-Parameters
-----------
+## Parameters
- __error__: The error returned by the device. _(PositionError)_
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md b/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
index 8df414a..116b493 100644
--- a/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
+++ b/docs/en/edge/cordova/geolocation/parameters/geolocationSuccess.md
@@ -17,8 +17,7 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-geolocationSuccess
-==================
+# geolocationSuccess
The user's callback function that executes when a geolocation position
becomes available (when called from `geolocation.getCurrentPosition`),
@@ -29,13 +28,11 @@ or when the position changes (when called from
// Do something
}
-Parameters
-----------
+## Parameters
- __position__: The geolocation position returned by the device. _(Position)_
-Example
--------
+## Example
function geolocationSuccess(position) {
alert('Latitude: ' + position.coords.latitude + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 ca1f189..32f207c 100644
--- a/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
+++ b/docs/en/edge/cordova/globalization/GlobalizationError/globalizationerror.md
@@ -17,13 +17,11 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-GlobalizationError
-============
+# GlobalizationError
An object representing a error from the Globalization API.
-Properties
-----------
+## Properties
- __code__: One of the following codes representing the error type _(Number)_
- GlobalizationError.UNKNOWN\_ERROR: 0
@@ -32,20 +30,17 @@ Properties
- GlobalizationError.PATTERN\_ERROR: 3
- __message__: A text message that includes the error's explanation and/or details _(String)_
-Description
------------
+## Description
This object is created and populated by Cordova, and returned to a callback in the case of an error.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick Example
--------------
+## Quick Example
When the following error callback executes, it displays a
popup dialog with the text similar to `code: 3` and `message:`
@@ -55,8 +50,7 @@ popup dialog with the text similar to `code: 3` and `message:`
'message: ' + error.message + '\n');
};
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 a4e5649..f1ae915 100644
--- a/docs/en/edge/cordova/globalization/globalization.dateToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.dateToString.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-globalization.dateToString
-===========
+# globalization.dateToString
Returns a date formatted as a string according to the client's locale and timezone.
navigator.globalization.dateToString(date, successCallback, errorCallback, options);
-Description
------------
+## Description
Returns the formatted date `String` via a `value` property accessible
from the object passed as a parameter to the `successCallback`.
@@ -44,16 +42,14 @@ The `options.formatLength` can be `short`, `medium`, `long`, or `full`.
The `options.selector` can be `date`, `time` or `date and time`.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
- Windows Phone 8
-Quick Example
--------------
+## Quick Example
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
@@ -66,8 +62,7 @@ options:
{ formatLength: 'short', selector: 'date and time' }
);
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML>
<html>
@@ -91,7 +86,6 @@ Full Example
</body>
</html>
-Windows Phone 8 Quirks
---------------
+## Windows Phone 8 Quirks
- The `formatLength` option supports only `short` and `full` values.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 cad69c5..7abceda 100644
--- a/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getCurrencyPattern.md
@@ -17,16 +17,14 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-globalization.getCurrencyPattern
-===========
+# globalization.getCurrencyPattern
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, successCallback, errorCallback);
-Description
------------
+## Description
Returns the pattern to the `successCallback` with a `properties` object
as a parameter. That object should contain the following properties:
@@ -50,15 +48,13 @@ 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.FORMATTING\_ERROR`.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
-Quick Example
--------------
+## Quick Example
When the browser is set to the `en\_US` locale and the selected
currency is United States Dollars, this example displays a popup
@@ -86,8 +82,7 @@ Expected result:
decimal: .
grouping: ,
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 0227e9c..bcbe7bd 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDateNames.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
@@ -17,16 +17,14 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-globalization.getDateNames
-===========
+# globalization.getDateNames
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
------------
+## Description
Returns the array of names to the `successCallback` with a
`properties` object as a parameter. That object contains a `value`
@@ -46,16 +44,14 @@ The value of `options.type` can be `narrow` or `wide`.
The value of `options.item` can be `months` or `days`.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
- Windows Phone 8
-Quick Example
--------------
+## Quick Example
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
@@ -71,8 +67,7 @@ a series of twelve popup dialogs, one per month, with text similar to
{ type: 'wide', item: 'months' }
);
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 b7c6dde..880945a 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDatePattern.md
@@ -17,16 +17,14 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-globalization.getDatePattern
-===========
+# globalization.getDatePattern
Returns a pattern string to format and parse dates according to the
client's user preferences.
navigator.globalization.getDatePattern(successCallback, errorCallback, options);
-Description
------------
+## Description
Returns the pattern to the `successCallback`. The object passed in as
a parameter contains the following properties:
@@ -51,16 +49,14 @@ The `options.formatLength` can be `short`, `medium`, `long`, or
`full`. The `options.selector` can be `date`, `time` or `date and
time`.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
- Windows Phone 8
-Quick Example
--------------
+## Quick Example
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`:
@@ -73,8 +69,7 @@ a popup dialog with text such as `pattern: M/d/yyyy h:mm a`:
);
}
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML>
<html>
@@ -98,8 +93,7 @@ Full Example
</body>
</html>
-Windows Phone 8 Quirks
---------------
+## Windows Phone 8 Quirks
- The `formatLength` supports only `short` and `full` values.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 2440ff0..62b7fe7 100644
--- a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
+++ b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -17,16 +17,14 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-globalization.getFirstDayOfWeek
-===========
+# globalization.getFirstDayOfWeek
Returns the first day of the week according to the client's user
preferences and calendar.
navigator.globalization.getFirstDayOfWeek(successCallback, errorCallback);
-Description
------------
+## Description
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
@@ -37,16 +35,14 @@ 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
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
- Windows Phone 8
-Quick Example
--------------
+## Quick Example
When the browser is set to the `en\_US` locale, this displays a
popup dialog with text similar to `day: 1`.
@@ -56,8 +52,7 @@ popup dialog with text similar to `day: 1`.
function () {alert('Error getting day\n');}
);
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 276e38d..ba9fcf3 100644
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-globalization.getLocaleName
-===========
+# globalization.getLocaleName
Get the string identifier for the client's current locale setting.
navigator.globalization.getLocaleName(successCallback, errorCallback);
-Description
------------
+## Description
Returns the locale identifier string to the `successCallback` with a
`properties` object as a parameter. That object should have a `value`
@@ -35,16 +33,14 @@ 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
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
- Windows Phone 8
-Quick Example
--------------
+## Quick Example
When the browser is set to the `en\_US` locale, this displays a popup
dialog with the text `locale: en\_US`.
@@ -54,8 +50,7 @@ dialog with the text `locale: en\_US`.
function () {alert('Error getting locale\n');}
);
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML>
<html>
@@ -77,7 +72,6 @@ Full Example
</body>
</html>
-Windows Phone 8 Quirks
----------------------
+## Windows Phone 8 Quirks
- Returns the two-letter code defined in ISO 3166 for the current country/region.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 54777ed..b9e91ca 100644
--- a/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
+++ b/docs/en/edge/cordova/globalization/globalization.getNumberPattern.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-globalization.getNumberPattern
-===========
+# globalization.getNumberPattern
Returns a pattern string to format and parse numbers according to the client's user preferences.
navigator.globalization.getNumberPattern(successCallback, errorCallback, options);
-Description
------------
+## Description
Returns the pattern to the `successCallback` with a `properties` object
as a parameter. That object contains the following properties:
@@ -56,16 +54,14 @@ The `options` parameter is optional, and default values are:
The `options.type` can be `decimal`, `percent`, or `currency`.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
- Windows Phone 8
-Quick Example
--------------
+## Quick Example
When the browser is set to the `en\_US` locale, this should display a
popup dialog with text similar to the results that follow:
@@ -94,8 +90,7 @@ Results:
decimal: .
grouping: ,
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML>
<html>
@@ -126,8 +121,7 @@ Full Example
</body>
</html>
-Windows Phone 8 Quirks
-----------------
+## Windows Phone 8 Quirks
- The `pattern` property is not supported, and retuens an empty string.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 60fb856..c4911a6 100644
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-globalization.getPreferredLanguage
-===========
+# globalization.getPreferredLanguage
Get the string identifier for the client's current language.
navigator.globalization.getPreferredLanguage(successCallback, errorCallback);
-Description
------------
+## Description
Returns the language identifier string to the `successCallback` with a
`properties` object as a parameter. That object should have a `value`
@@ -35,16 +33,14 @@ 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
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
- Windows Phone 8
-Quick Example
--------------
+## Quick Example
When the browser is set to the `en\_US` locale, this should display a
popup dialog with the text `language: English`:
@@ -54,8 +50,7 @@ popup dialog with the text `language: English`:
function () {alert('Error getting language\n');}
);
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML>
<html>
@@ -77,7 +72,6 @@ Full Example
</body>
</html>
-Windows Phone 8 Quirks
--------
+## Windows Phone 8 Quirks
- Returns the ISO 639-1 two-letter code for the current language.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 161f36d..eb5393e 100644
--- a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
+++ b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
@@ -17,16 +17,14 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-globalization.isDayLightSavingsTime
-===========
+# globalization.isDayLightSavingsTime
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
------------
+## Description
Indicates whether or not daylight savings time is in effect to the
`successCallback` with a `properties` object as a parameter. That object
@@ -39,16 +37,14 @@ The inbound parameter `date` should be of type `Date`.
If there is an error reading the date, then the `errorCallback`
executes. The error's expected code is `GlobalizationError.UNKNOWN\_ERROR`.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
- Windows Phone 8
-Quick Example
--------------
+## Quick Example
During the summer, and if the browser is set to a DST-enabled
timezone, this should display a popup dialog with text similar to
@@ -60,8 +56,7 @@ timezone, this should display a popup dialog with text similar to
function () {alert('Error getting names\n');}
);
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 7d7309c..bcc1366 100644
--- a/docs/en/edge/cordova/globalization/globalization.md
+++ b/docs/en/edge/cordova/globalization/globalization.md
@@ -17,19 +17,16 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-Globalization
-======
+# Globalization
Obtains information and performs operations specific to the user's
locale and timezone.
-Objects
--------
+## Objects
- GlobalizationError
-Methods
--------
+## Methods
- globalization.getPreferredLanguage
- globalization.getLocaleName
@@ -44,8 +41,7 @@ Methods
- globalization.getNumberPattern
- globalization.getCurrencyPattern
-Variable Scope
---------------
+## Variable Scope
The `globalization` object is a child of the `navigator` object, and
therefore has global scope.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/76ef2fb7/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 84d5b37..f9fce83 100644
--- a/docs/en/edge/cordova/globalization/globalization.numberToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.numberToString.md
@@ -17,15 +17,13 @@ license: Licensed to the Apache Software Foundation (ASF) under one
under the License.
---
-globalization.numberToString
-===========
+# globalization.numberToString
Returns a number formatted as a string according to the client's user preferences.
navigator.globalization.numberToString(number, successCallback, errorCallback, options);
-Description
------------
+## Description
Returns the formatted number string to the `successCallback` with a
`properties` object as a parameter. That object should have a `value`
@@ -41,16 +39,14 @@ The `options` parameter is optional, and its default values are:
The `options.type` can be 'decimal', 'percent', or 'currency'.
-Supported Platforms
--------------------
+## Supported Platforms
- Android
- BlackBerry WebWorks (OS 5.0 and higher)
- iOS
- Windows Phone 8
-Quick Example
--------------
+## Quick Example
When the browser is set to the `en\_US` locale, this displays a popup
dialog with text similar to `number: 3.142`:
@@ -62,8 +58,7 @@ dialog with text similar to `number: 3.142`:
{type:'decimal'}
);
-Full Example
-------------
+## Full Example
<!DOCTYPE HTML>
<html>