You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/10/21 00:27:51 UTC
[31/78] [abbrv] [partial] docs commit: Making links in docs manual
instead of automatic.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/events/events.volumeupbutton.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/events/events.volumeupbutton.md b/www/docs/en/1.8.0/cordova/events/events.volumeupbutton.md
index 39c424c..f77cad4 100644
--- a/www/docs/en/1.8.0/cordova/events/events.volumeupbutton.md
+++ b/www/docs/en/1.8.0/cordova/events/events.volumeupbutton.md
@@ -32,14 +32,14 @@ Details
If you need to override the default volume up behaviour you can register an event listener for the 'volumeupbutton' event.
-Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova 'deviceready' event.
+Typically, you will want to attach an event listener with `document.addEventListener` once you receive the Cordova '[deviceready](events.deviceready.html)' event.
Supported Platforms
-------------------
- BlackBerry WebWorks (OS 5.0 and higher)
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
document.addEventListener("volumeupbutton", onVolumeUpKeyDown, false);
@@ -48,7 +48,7 @@ Quick Example
// Handle the volume up button
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/directoryentry/directoryentry.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/directoryentry/directoryentry.md b/www/docs/en/1.8.0/cordova/file/directoryentry/directoryentry.md
index 6bcedf1..895c644 100644
--- a/www/docs/en/1.8.0/cordova/file/directoryentry/directoryentry.md
+++ b/www/docs/en/1.8.0/cordova/file/directoryentry/directoryentry.md
@@ -49,7 +49,7 @@ The following methods can be invoked on a DirectoryEntry object:
- __toURL__: Return a URL that can be used to locate a directory.
- __remove__: Delete a directory. The directory must be empty.
- __getParent__: Look up the parent directory.
-- __createReader__: Create a new DirectoryReader that can read entries from a directory.
+- __createReader__: Create a new [DirectoryReader](../directoryreader/directoryreader.html) that can read entries from a directory.
- __getDirectory__: Create or look up a directory.
- __getFile__: Create or look up a file.
- __removeRecursively__: Delete a directory and all of its contents.
@@ -70,8 +70,8 @@ Look up metadata about a directory.
__Parameters:__
-- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is called with a [Metadata](../metadata/metadata.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the [Metadata](../metadata/metadata.html). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -134,7 +134,7 @@ __Parameters:__
- __parent__ - The parent directory to which to move the directory. _(DirectoryEntry)_
- __newName__ - The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
- __successCallback__ - A callback that is called with the DirectoryEntry object of the new directory. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to move the directory. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to move the directory. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -172,7 +172,7 @@ __Parameters:__
- __parent__ - The parent directory to which to copy the directory. _(DirectoryEntry)_
- __newName__ - The new name of the directory. Defaults to the current name if unspecified. _(DOMString)_
- __successCallback__ - A callback that is called with the DirectoryEntry object of the new directory. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the underlying directory. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the underlying directory. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -219,7 +219,7 @@ Deletes a directory. It is an error to attempt to:
__Parameters:__
- __successCallback__ - A callback that is called after the directory has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the directory. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the directory. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -243,7 +243,7 @@ Look up the parent DirectoryEntry containing the directory.
__Parameters:__
- __successCallback__ - A callback that is called with the directory's parent DirectoryEntry. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -262,7 +262,7 @@ __Quick Example__
createReader
------------
-Creates a new DirectoryReader to read entries in a directory.
+Creates a new [DirectoryReader](../directoryreader/directoryreader.html) to read entries in a directory.
__Quick Example__
@@ -282,7 +282,7 @@ __Parameters:__
- __path__ - The path to the directory to be looked up or created. Either an absolute path, or a relative path from this DirectoryEntry. _(DOMString)_
- __options__ - Options to specify whether the directory is created if it doesn't exist. _(Flags)_
- __successCallback__ - A callback that is invoked with a DirectoryEntry object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs creating or looking up the directory. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs creating or looking up the directory. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -309,8 +309,8 @@ __Parameters:__
- __path__ - The path to the file to be looked up or created. Either an absolute path, or a relative path from this DirectoryEntry. _(DOMString)_
- __options__ - Options to specify whether the file is created if it doesn't exist. _(Flags)_
-- __successCallback__ - A callback that is invoked with a FileEntry object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs creating or looking up the file. Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is invoked with a [FileEntry](../fileentry/fileentry.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs creating or looking up the file. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -338,7 +338,7 @@ be deleted. It is an error to attempt to:
__Parameters:__
- __successCallback__ - A callback that is called after the DirectoryEntry has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the DirectoryEntry. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the DirectoryEntry. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/directoryreader/directoryreader.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/directoryreader/directoryreader.md b/www/docs/en/1.8.0/cordova/file/directoryreader/directoryreader.md
index 72b6b10..facd75b 100644
--- a/www/docs/en/1.8.0/cordova/file/directoryreader/directoryreader.md
+++ b/www/docs/en/1.8.0/cordova/file/directoryreader/directoryreader.md
@@ -46,8 +46,8 @@ Read the entries in this directory.
__Parameters:__
-- __successCallback__ - A callback that is passed an array of FileEntry and DirectoryEntry objects. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the directory listing. Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is passed an array of [FileEntry](../fileentry/fileentry.html) and [DirectoryEntry](../directoryentry/directoryentry.html) objects. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the directory listing. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/file.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/file.md b/www/docs/en/1.8.0/cordova/file/file.md
index e56b420..008f78c 100644
--- a/www/docs/en/1.8.0/cordova/file/file.md
+++ b/www/docs/en/1.8.0/cordova/file/file.md
@@ -20,7 +20,7 @@ license: >
title: File
---
-File
+[File](fileobj/fileobj.html)
==========
> This API is based on the W3C [File API](http://www.w3.org/TR/FileAPI). An API to read, write and navigate file system hierarchies.
@@ -28,21 +28,21 @@ File
Objects
-------
-- DirectoryEntry
-- DirectoryReader
-- File
-- FileEntry
-- FileError
-- FileReader
-- FileSystem
-- FileTransfer
-- FileTransferError
-- FileUploadOptions
-- FileUploadResult
-- FileWriter
-- Flags
-- LocalFileSystem
-- Metadata
+- [DirectoryEntry](directoryentry/directoryentry.html)
+- [DirectoryReader](directoryreader/directoryreader.html)
+- [File](fileobj/fileobj.html)
+- [FileEntry](fileentry/fileentry.html)
+- [FileError](fileerror/fileerror.html)
+- [FileReader](filereader/filereader.html)
+- [FileSystem](filesystem/filesystem.html)
+- [FileTransfer](filetransfer/filetransfer.html)
+- [FileTransferError](filetransfererror/filetransfererror.html)
+- [FileUploadOptions](fileuploadoptions/fileuploadoptions.html)
+- [FileUploadResult](fileuploadresult/fileuploadresult.html)
+- [FileWriter](filewriter/filewriter.html)
+- [Flags](flags/flags.html)
+- [LocalFileSystem](localfilesystem/localfilesystem.html)
+- [Metadata](metadata/metadata.html)
Permissions
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/fileentry/fileentry.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/fileentry/fileentry.md b/www/docs/en/1.8.0/cordova/file/fileentry/fileentry.md
index d6823c7..3d74772 100644
--- a/www/docs/en/1.8.0/cordova/file/fileentry/fileentry.md
+++ b/www/docs/en/1.8.0/cordova/file/fileentry/fileentry.md
@@ -48,8 +48,8 @@ Methods
- __toURL__: Return a URL that can be used to locate a file.
- __remove__: Delete a file.
- __getParent__: Look up the parent directory.
-- __createWriter__: Creates a FileWriter object that can be used to write to a file.
-- __file__: Creates a File object containing file properties.
+- __createWriter__: Creates a [FileWriter](../filewriter/filewriter.html) object that can be used to write to a file.
+- __file__: Creates a [File](../fileobj/fileobj.html) object containing file properties.
Supported Platforms
@@ -68,8 +68,8 @@ Look up metadata about a file.
__Parameters:__
-- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is called with a [Metadata](../metadata/metadata.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the [Metadata](../metadata/metadata.html). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -131,7 +131,7 @@ __Parameters:__
- __parent__ - The parent directory to which to move the file. _(DirectoryEntry)_
- __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to move the file. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -166,7 +166,7 @@ __Parameters:__
- __parent__ - The parent directory to which to copy the file. _(DirectoryEntry)_
- __newName__ - The new name of the file. Defaults to the current name if unspecified. _(DOMString)_
- __successCallback__ - A callback that is called with the FileEntry object of the new file. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to copy the file. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -209,7 +209,7 @@ Deletes a file.
__Parameters:__
- __successCallback__ - A callback that is called after the file has been deleted. Invoked with no parameters. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a FileError object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to delete the file. Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -228,12 +228,12 @@ __Quick Example__
getParent
---------
-Look up the parent DirectoryEntry containing the file.
+Look up the parent [DirectoryEntry](../directoryentry/directoryentry.html) containing the file.
__Parameters:__
-- __successCallback__ - A callback that is called with the file's parent DirectoryEntry. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent DirectoryEntry. Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is called with the file's parent [DirectoryEntry](../directoryentry/directoryentry.html). _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when attempting to retrieve the parent [DirectoryEntry](../directoryentry/directoryentry.html). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -252,12 +252,12 @@ __Quick Example__
createWriter
------------
-Create a FileWriter object associated with the file that the FileEntry represents.
+Create a [FileWriter](../filewriter/filewriter.html) object associated with the file that the FileEntry represents.
__Parameters:__
-- __successCallback__ - A callback that is called with a FileWriter object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs while attempting to create the FileWriter. Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is called with a [FileWriter](../filewriter/filewriter.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs while attempting to create the [FileWriter](../filewriter/filewriter.html). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
@@ -276,12 +276,12 @@ __Quick Example__
file
----
-Return a File object that represents the current state of the file that this FileEntry represents.
+Return a [File](../fileobj/fileobj.html) object that represents the current state of the file that this FileEntry represents.
__Parameters:__
-- __successCallback__ - A callback that is called with a File object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs when creating the File object (e.g. the underlying file no longer exists). Invoked with a FileError object. _(Function)_
+- __successCallback__ - A callback that is called with a [File](../fileobj/fileobj.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs when creating the [File](../fileobj/fileobj.html) object (e.g. the underlying file no longer exists). Invoked with a [FileError](../fileerror/fileerror.html) object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/fileerror/fileerror.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/fileerror/fileerror.md b/www/docs/en/1.8.0/cordova/file/fileerror/fileerror.md
index dac6d35..3a4068c 100644
--- a/www/docs/en/1.8.0/cordova/file/fileerror/fileerror.md
+++ b/www/docs/en/1.8.0/cordova/file/fileerror/fileerror.md
@@ -23,7 +23,7 @@ title: FileError
FileError
========
-A 'FileError' object is set when an error occurs in any of the File API methods.
+A 'FileError' object is set when an error occurs in any of the [File](../fileobj/fileobj.html) API methods.
Properties
----------
@@ -49,4 +49,4 @@ Constants
Description
-----------
-The `FileError` object is the only parameter of any of the File API's error callbacks. Developers must read the code property to determine the type of error.
\ No newline at end of file
+The `FileError` object is the only parameter of any of the [File](../fileobj/fileobj.html) API's error callbacks. Developers must read the code property to determine the type of error.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/fileobj/fileobj.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/fileobj/fileobj.md b/www/docs/en/1.8.0/cordova/file/fileobj/fileobj.md
index 3dedfd3..d6ff638 100644
--- a/www/docs/en/1.8.0/cordova/file/fileobj/fileobj.md
+++ b/www/docs/en/1.8.0/cordova/file/fileobj/fileobj.md
@@ -37,7 +37,7 @@ Properties
Details
-------
-The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `FileEntry` object.
+The `File` object contains attributes of a single file. You can get an instance of a File object by calling the __file__ method of a `[FileEntry](../fileentry/fileentry.html)` object.
Supported Platforms
-------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/filereader/filereader.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/filereader/filereader.md b/www/docs/en/1.8.0/cordova/file/filereader/filereader.md
index 4add25d..95e7717 100644
--- a/www/docs/en/1.8.0/cordova/file/filereader/filereader.md
+++ b/www/docs/en/1.8.0/cordova/file/filereader/filereader.md
@@ -65,7 +65,7 @@ __Parameters:__
- file - the file object to read
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
function win(file) {
@@ -91,7 +91,7 @@ __Parameters:__
- file - the file object to read
- encoding - the encoding to use to encode the file's content. Default is UTF8.
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
function win(file) {
@@ -109,7 +109,7 @@ Quick Example
entry.file(win, fail);
-Abort Quick Example
+Abort Quick [Example](../../storage/storage.opendatabase.html)
-------------------
function win(file) {
@@ -128,7 +128,7 @@ Abort Quick Example
entry.file(win, fail);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -148,7 +148,7 @@ Full Example
// Cordova is ready
//
function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, gotFS, fail);
+ window.requestFileSystem([LocalFileSystem](../localfilesystem/localfilesystem.html).PERSISTENT, 0, gotFS, fail);
}
function gotFS(fileSystem) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/filesystem/filesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/filesystem/filesystem.md b/www/docs/en/1.8.0/cordova/file/filesystem/filesystem.md
index a472239..bebe628 100644
--- a/www/docs/en/1.8.0/cordova/file/filesystem/filesystem.md
+++ b/www/docs/en/1.8.0/cordova/file/filesystem/filesystem.md
@@ -34,7 +34,7 @@ Properties
Details
-------
-The `FileSystem` object represents information about the file system. The name of the file system will be unique across the list of exposed file systems. The root property contains a `DirectoryEntry` object which represents the root directory of the file system.
+The `FileSystem` object represents information about the file system. The name of the file system will be unique across the list of exposed file systems. The root property contains a `[DirectoryEntry](../directoryentry/directoryentry.html)` object which represents the root directory of the file system.
Supported Platforms
-------------------
@@ -44,7 +44,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-File System Quick Example
+[File](../fileobj/fileobj.html) System Quick [Example](../../storage/storage.opendatabase.html)
-------------------------
function onSuccess(fileSystem) {
@@ -53,9 +53,9 @@ File System Quick Example
}
// request the persistent file system
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, null);
+ window.requestFileSystem([LocalFileSystem](../localfilesystem/localfilesystem.html).PERSISTENT, 0, onSuccess, null);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -73,7 +73,7 @@ Full Example
// Cordova is ready
//
function onDeviceReady() {
- window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
+ window.requestFileSystem([LocalFileSystem](../localfilesystem/localfilesystem.html).PERSISTENT, 0, onFileSystemSuccess, fail);
}
function onFileSystemSuccess(fileSystem) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/filetransfer/filetransfer.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/filetransfer/filetransfer.md b/www/docs/en/1.8.0/cordova/file/filetransfer/filetransfer.md
index def53f4..366ec39 100644
--- a/www/docs/en/1.8.0/cordova/file/filetransfer/filetransfer.md
+++ b/www/docs/en/1.8.0/cordova/file/filetransfer/filetransfer.md
@@ -39,7 +39,7 @@ Methods
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 protocols are supported. Optional parameters can be specified by passing a FileUploadOptions object to the upload method. On successful upload, the success callback will be called with a FileUploadResult object. If an error occurs, the error callback will be invoked with a FileTransferError object.
+The `FileTransfer` object provides a way to upload files to a remote server using an HTTP multi-part POST request. Both HTTP and HTTPS protocols are supported. Optional parameters can be specified by passing a [FileUploadOptions](../fileuploadoptions/fileuploadoptions.html) object to the upload method. On successful upload, the success callback will be called with a [FileUploadResult](../fileuploadresult/fileuploadresult.html) object. If an error occurs, the error callback will be invoked with a [FileTransferError](../filetransfererror/filetransfererror.html) object.
It is also possible to download a file from remote and save it on the device (only iOS and Android).
Supported Platforms
@@ -57,8 +57,8 @@ __Parameters:__
- __filePath__ - Full path of the file on the device
- __server__ - URL of the server to receive the file
-- __successCallback__ - A callback that is called with a Metadata object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_
+- __successCallback__ - A callback that is called with a [Metadata](../metadata/metadata.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the [Metadata](../metadata/metadata.html). Invoked with a [FileTransferError](../filetransfererror/filetransfererror.html) object. _(Function)_
- __options__ - Optional parameters such as file name and mimetype
__Quick Example__
@@ -77,7 +77,7 @@ __Quick Example__
console.log("upload error target " + error.target);
}
- var options = new FileUploadOptions();
+ var options = new [FileUploadOptions](../fileuploadoptions/fileuploadoptions.html)();
options.fileKey="file";
options.fileName=fileURI.substr(fileURI.lastIndexOf('/')+1);
options.mimeType="text/plain";
@@ -162,8 +162,8 @@ __Parameters:__
- __source__ - URL of the server to receive the file
- __target__ - Full path of the file on the device
-- __successCallback__ - A callback that is called with a FileEntry object. _(Function)_
-- __errorCallback__ - A callback that is called if an error occurs retrieving the Metadata. Invoked with a FileTransferError object. _(Function)_
+- __successCallback__ - A callback that is called with a [FileEntry](../fileentry/fileentry.html) object. _(Function)_
+- __errorCallback__ - A callback that is called if an error occurs retrieving the [Metadata](../metadata/metadata.html). Invoked with a [FileTransferError](../filetransfererror/filetransfererror.html) object. _(Function)_
__Quick Example__
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/fileuploadoptions/fileuploadoptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/fileuploadoptions/fileuploadoptions.md b/www/docs/en/1.8.0/cordova/file/fileuploadoptions/fileuploadoptions.md
index dc6648e..f8a87ae 100644
--- a/www/docs/en/1.8.0/cordova/file/fileuploadoptions/fileuploadoptions.md
+++ b/www/docs/en/1.8.0/cordova/file/fileuploadoptions/fileuploadoptions.md
@@ -23,7 +23,7 @@ title: FileUploadOptions
FileUploadOptions
========
-A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
+A `FileUploadOptions` object can be passed to the [FileTransfer](../filetransfer/filetransfer.html) objects upload method in order to specify additional parameters to the upload script.
Properties
----------
@@ -38,7 +38,7 @@ Properties
Description
-----------
-A `FileUploadOptions` object can be passed to the FileTransfer objects upload method in order to specify additional parameters to the upload script.
+A `FileUploadOptions` object can be passed to the [FileTransfer](../filetransfer/filetransfer.html) objects upload method in order to specify additional parameters to the upload script.
iOS Quirk
---------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/fileuploadresult/fileuploadresult.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/fileuploadresult/fileuploadresult.md b/www/docs/en/1.8.0/cordova/file/fileuploadresult/fileuploadresult.md
index de8f5c7..19fd630 100644
--- a/www/docs/en/1.8.0/cordova/file/fileuploadresult/fileuploadresult.md
+++ b/www/docs/en/1.8.0/cordova/file/fileuploadresult/fileuploadresult.md
@@ -23,7 +23,7 @@ title: FileUploadResult
FileUploadResult
========
-A `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
+A `FileUploadResult` object is returned via the success callback of the [FileTransfer](../filetransfer/filetransfer.html) upload method.
Properties
----------
@@ -35,7 +35,7 @@ Properties
Description
-----------
-The `FileUploadResult` object is returned via the success callback of the FileTransfer upload method.
+The `FileUploadResult` object is returned via the success callback of the [FileTransfer](../filetransfer/filetransfer.html) upload method.
iOS Quirks
----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/filewriter/filewriter.md b/www/docs/en/1.8.0/cordova/file/filewriter/filewriter.md
index 6cbc2b7..bb457cc 100644
--- a/www/docs/en/1.8.0/cordova/file/filewriter/filewriter.md
+++ b/www/docs/en/1.8.0/cordova/file/filewriter/filewriter.md
@@ -63,7 +63,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Seek Quick Example
+Seek Quick [Example](../../storage/storage.opendatabase.html)
------------------------------
function win(writer) {
@@ -77,7 +77,7 @@ Seek Quick Example
entry.createWriter(win, fail);
-Truncate Quick Example
+Truncate Quick [Example](../../storage/storage.opendatabase.html)
--------------------------
function win(writer) {
@@ -90,7 +90,7 @@ Truncate Quick Example
entry.createWriter(win, fail);
-Write Quick Example
+Write Quick [Example](../../storage/storage.opendatabase.html)
-------------------
function win(writer) {
@@ -106,7 +106,7 @@ Write Quick Example
entry.createWriter(win, fail);
-Append Quick Example
+Append Quick [Example](../../storage/storage.opendatabase.html)
--------------------
function win(writer) {
@@ -123,7 +123,7 @@ Append Quick Example
entry.createWriter(win, fail);
-Abort Quick Example
+Abort Quick [Example](../../storage/storage.opendatabase.html)
-------------------
function win(writer) {
@@ -140,7 +140,7 @@ Abort Quick Example
entry.createWriter(win, fail);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
<html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/flags/flags.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/flags/flags.md b/www/docs/en/1.8.0/cordova/file/flags/flags.md
index 505b05c..4ce4be0 100644
--- a/www/docs/en/1.8.0/cordova/file/flags/flags.md
+++ b/www/docs/en/1.8.0/cordova/file/flags/flags.md
@@ -23,7 +23,7 @@ title: Flags
Flags
=====
-This object is used to supply arguments to the `DirectoryEntry` __getFile__ and __getDirectory__ methods, which look up or create files and directories, respectively.
+This object is used to supply arguments to the `[DirectoryEntry](../directoryentry/directoryentry.html)` __getFile__ and __getDirectory__ methods, which look up or create files and directories, respectively.
Properties
----------
@@ -39,7 +39,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// Get the data directory, creating it if it doesn't exist.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/localfilesystem/localfilesystem.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/localfilesystem/localfilesystem.md b/www/docs/en/1.8.0/cordova/file/localfilesystem/localfilesystem.md
index 8e11d44..1e7a5ae 100644
--- a/www/docs/en/1.8.0/cordova/file/localfilesystem/localfilesystem.md
+++ b/www/docs/en/1.8.0/cordova/file/localfilesystem/localfilesystem.md
@@ -29,7 +29,7 @@ Methods
----------
- __requestFileSystem:__ Requests a filesystem. _(Function)_
-- __resolveLocalFileSystemURI:__ Retrieve a DirectoryEntry or FileEntry using local URI. _(Function)_
+- __resolveLocalFileSystemURI:__ Retrieve a [DirectoryEntry](../directoryentry/directoryentry.html) or [FileEntry](../fileentry/fileentry.html) using local URI. _(Function)_
Constants
---------
@@ -50,7 +50,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Request File System Quick Example
+Request [File](../fileobj/fileobj.html) System Quick [Example](../../storage/storage.opendatabase.html)
---------------------------------
function onSuccess(fileSystem) {
@@ -60,7 +60,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](../fileobj/fileobj.html) System URI Quick [Example](../../storage/storage.opendatabase.html)
-------------------------------------------
function onSuccess(fileEntry) {
@@ -69,7 +69,7 @@ Resolve Local File System URI Quick Example
window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/file/metadata/metadata.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/file/metadata/metadata.md b/www/docs/en/1.8.0/cordova/file/metadata/metadata.md
index a4df999..3dda5b6 100644
--- a/www/docs/en/1.8.0/cordova/file/metadata/metadata.md
+++ b/www/docs/en/1.8.0/cordova/file/metadata/metadata.md
@@ -33,7 +33,7 @@ Properties
Details
-------
-The `Metadata` object represents information about the state of a file or directory. You can get an instance of a Metadata object by calling the __getMetadata__ method of a `DirectoryEntry` or `FileEntry` object.
+The `Metadata` object represents information about the state of a file or directory. You can get an instance of a Metadata object by calling the __getMetadata__ method of a `[DirectoryEntry](../directoryentry/directoryentry.html)` or `[FileEntry](../fileentry/fileentry.html)` object.
Supported Platforms
-------------------
@@ -43,7 +43,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
function win(metadata) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/geolocation/Coordinates/coordinates.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/Coordinates/coordinates.md b/www/docs/en/1.8.0/cordova/geolocation/Coordinates/coordinates.md
index 5c146a9..be33b4a 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/Coordinates/coordinates.md
+++ b/www/docs/en/1.8.0/cordova/geolocation/Coordinates/coordinates.md
@@ -39,7 +39,7 @@ Properties
Description
-----------
-The `Coordinates` object is created and populated by Cordova, and attached to the `Position` object. The `Position` object is then returned to the user through a callback function.
+The `Coordinates` object is created and populated by Cordova, and attached to the `[Position](../Position/position.html)` object. The `[Position](../Position/position.html)` object is then returned to the user through a callback function.
Supported Platforms
-------------------
@@ -51,7 +51,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -75,7 +75,7 @@ Quick Example
navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/geolocation/Position/position.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/Position/position.md b/www/docs/en/1.8.0/cordova/geolocation/Position/position.md
index 388ef67..0237612 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/Position/position.md
+++ b/www/docs/en/1.8.0/cordova/geolocation/Position/position.md
@@ -46,7 +46,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -71,7 +71,7 @@ Quick Example
navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -107,7 +107,7 @@ Full Example
position.timestamp + '<br />';
}
- // onError Callback receives a PositionError object
+ // onError Callback receives a [PositionError](../PositionError/positionError.html) object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/geolocation/PositionError/positionError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/PositionError/positionError.md b/www/docs/en/1.8.0/cordova/geolocation/PositionError/positionError.md
index 2f06723..db51351 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/PositionError/positionError.md
+++ b/www/docs/en/1.8.0/cordova/geolocation/PositionError/positionError.md
@@ -23,7 +23,7 @@ title: PositionError
PositionError
========
-A `PositionError` object is returned to the `geolocationError` callback when an error occurs.
+A `PositionError` object is returned to the `[geolocationError](../parameters/geolocationError.html)` callback when an error occurs.
Properties
----------
@@ -41,7 +41,7 @@ Constants
Description
-----------
-The `PositionError` object is returned to the user through the `geolocationError` callback function when an error occurs with geolocation.
+The `PositionError` object is returned to the user through the `[geolocationError](../parameters/geolocationError.html)` callback function when an error occurs with geolocation.
### `PositionError.PERMISSION_DENIED`
@@ -57,6 +57,6 @@ satellite fix.
### `PositionError.TIMEOUT`
Returned when the device was unable to retrieve a position within the
-time specified in the `geolocationOptions`' `timeout` property. When using
-in conjunction with `geolocation.watchPosition`, this error could be
-called into the `geolocationError` callback every `timeout` milliseconds.
+time specified in the `[geolocationOptions](../parameters/geolocation.options.html)`' `timeout` property. When using
+in conjunction with `[geolocation.watchPosition](../geolocation.watchPosition.html)`, this error could be
+called into the `[geolocationError](../parameters/geolocationError.html)` callback every `timeout` milliseconds.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/geolocation/geolocation.clearWatch.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/geolocation.clearWatch.md b/www/docs/en/1.8.0/cordova/geolocation/geolocation.clearWatch.md
index 27a2f63..3386270 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/geolocation.clearWatch.md
+++ b/www/docs/en/1.8.0/cordova/geolocation/geolocation.clearWatch.md
@@ -35,7 +35,7 @@ Parameters
Description
-----------
-`geolocation.clearWatch` stops watching changes to the device's location by clearing the `geolocation.watchPosition` referenced by `watchID`.
+`geolocation.clearWatch` stops watching changes to the device's location by clearing the `[geolocation.watchPosition](geolocation.watchPosition.html)` referenced by `watchID`.
Supported Platforms
-------------------
@@ -47,7 +47,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Options: watch for changes in position, and use the most
@@ -60,7 +60,7 @@ Quick Example
navigator.geolocation.clearWatch(watchID);
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -104,7 +104,7 @@ Full Example
}
}
- // onError Callback receives a PositionError object
+ // onError Callback receives a [PositionError](PositionError/positionError.html) object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/geolocation/geolocation.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/geolocation.getCurrentPosition.md b/www/docs/en/1.8.0/cordova/geolocation/geolocation.getCurrentPosition.md
index 3810bb1..756bfb1 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/geolocation.getCurrentPosition.md
+++ b/www/docs/en/1.8.0/cordova/geolocation/geolocation.getCurrentPosition.md
@@ -23,7 +23,7 @@ title: geolocation.getCurrentPosition
geolocation.getCurrentPosition
==============================
-Returns the device's current position as a `Position` object.
+Returns the device's current position as a `[Position](Position/position.html)` object.
navigator.geolocation.getCurrentPosition(geolocationSuccess,
[geolocationError],
@@ -39,7 +39,7 @@ Parameters
Description
-----------
-`geolocation.getCurrentPosition` is an asynchronous function. It returns the device's current position to the `geolocationSuccess` callback with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
+`geolocation.getCurrentPosition` is an asynchronous function. It returns the device's current position to the `[geolocationSuccess](parameters/geolocationSuccess.html)` callback with a `[Position](Position/position.html)` object as the parameter. If there is an error, the `[geolocationError](parameters/geolocationError.html)` callback is invoked with a `[PositionError](PositionError/positionError.html)` object.
Supported Platforms
@@ -52,7 +52,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -79,7 +79,7 @@ Quick Example
navigator.geolocation.getCurrentPosition(onSuccess, onError);
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -114,7 +114,7 @@ Full Example
'Timestamp: ' + position.timestamp + '<br />';
}
- // onError Callback receives a PositionError object
+ // onError Callback receives a [PositionError](PositionError/positionError.html) object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/geolocation.md b/www/docs/en/1.8.0/cordova/geolocation/geolocation.md
index 225a37f..72405ee 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/geolocation.md
+++ b/www/docs/en/1.8.0/cordova/geolocation/geolocation.md
@@ -32,24 +32,24 @@ This API is based on the [W3C Geolocation API Specification](http://dev.w3.org/g
Methods
-------
-- geolocation.getCurrentPosition
-- geolocation.watchPosition
-- geolocation.clearWatch
+- [geolocation.getCurrentPosition](geolocation.getCurrentPosition.html)
+- [geolocation.watchPosition](geolocation.watchPosition.html)
+- [geolocation.clearWatch](geolocation.clearWatch.html)
Arguments
---------
-- geolocationSuccess
-- geolocationError
-- geolocationOptions
+- [geolocationSuccess](parameters/geolocationSuccess.html)
+- [geolocationError](parameters/geolocationError.html)
+- [geolocationOptions](parameters/geolocation.options.html)
Objects (Read-Only)
-------------------
-- Position
-- PositionError
-- Coordinates
+- [Position](Position/position.html)
+- [PositionError](PositionError/positionError.html)
+- [Coordinates](Coordinates/coordinates.html)
Permissions
-----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/geolocation/geolocation.watchPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/geolocation.watchPosition.md b/www/docs/en/1.8.0/cordova/geolocation/geolocation.watchPosition.md
index 6e18f19..4912d78 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/geolocation.watchPosition.md
+++ b/www/docs/en/1.8.0/cordova/geolocation/geolocation.watchPosition.md
@@ -39,12 +39,12 @@ Parameters
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.
+- __String__: returns a watch id that references the watch position interval. The watch id should be used with `[geolocation.clearWatch](geolocation.clearWatch.html)` to stop watching for changes in position.
Description
-----------
-`geolocation.watchPosition` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `geolocationSuccess` callback is invoked with a `Position` object as the parameter. If there is an error, the `geolocationError` callback is invoked with a `PositionError` object.
+`geolocation.watchPosition` is an asynchronous function. It returns the device's current position when a change in position has been detected. When the device has retrieved a new location, the `[geolocationSuccess](parameters/geolocationSuccess.html)` callback is invoked with a `[Position](Position/position.html)` object as the parameter. If there is an error, the `[geolocationError](parameters/geolocationError.html)` callback is invoked with a `[PositionError](PositionError/positionError.html)` object.
Supported Platforms
-------------------
@@ -56,7 +56,7 @@ Supported Platforms
- Bada 1.2 & 2.x
- webOS
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// onSuccess Callback
@@ -82,7 +82,7 @@ Quick Example
var watchID = navigator.geolocation.watchPosition(onSuccess, onError, { timeout: 30000 });
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -116,7 +116,7 @@ Full Example
'<hr />' + element.innerHTML;
}
- // onError Callback receives a PositionError object
+ // onError Callback receives a [PositionError](PositionError/positionError.html) object
//
function onError(error) {
alert('code: ' + error.code + '\n' +
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocation.options.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocation.options.md b/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocation.options.md
index 65f3bd6..9af53c2 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocation.options.md
+++ b/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocation.options.md
@@ -24,15 +24,15 @@ geolocationOptions
==================
Optional parameters to customize the retrieval of the geolocation
-`Position`.
+`[Position](../Position/position.html)`.
{ maximumAge: 3000, timeout: 5000, enableHighAccuracy: true };
Options
-------
-- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt to retrieve a `Position` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_
-- __timeout:__ The maximum length of time (milliseconds) that is allowed to pass from the call to `geolocation.getCurrentPosition` or `geolocation.watchPosition` until the corresponding `geolocationSuccess` callback is invoked. If the `geolocationSuccess` callback is not invoked within this time, the `geolocationError` callback will be invoked with a `PositionError.TIMEOUT` error code. NOTE: when used in conjunction with `geolocation.watchPosition`, the `geolocationError` callback could be called on an interval every `timeout` milliseconds! _(Number)_
+- __enableHighAccuracy:__ Provides a hint that the application would like to receive the best possible results. By default, the device will attempt to retrieve a `[Position](../Position/position.html)` using network-based methods. Setting this property to `true` tells the framework to use more accurate methods, such as satellite positioning. _(Boolean)_
+- __timeout:__ The maximum length of time (milliseconds) that is allowed to pass from the call to `[geolocation.getCurrentPosition](../geolocation.getCurrentPosition.html)` or `[geolocation.watchPosition](../geolocation.watchPosition.html)` until the corresponding `[geolocationSuccess](geolocationSuccess.html)` callback is invoked. If the `[geolocationSuccess](geolocationSuccess.html)` callback is not invoked within this time, the `[geolocationError](geolocationError.html)` callback will be invoked with a `[PositionError](../PositionError/positionError.html).TIMEOUT` error code. NOTE: when used in conjunction with `[geolocation.watchPosition](../geolocation.watchPosition.html)`, the `[geolocationError](geolocationError.html)` callback could be called on an interval every `timeout` milliseconds! _(Number)_
- __maximumAge:__ Accept a cached position whose age is no greater than the specified time in milliseconds. _(Number)_
Android Quirks
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationError.md b/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationError.md
index 1cc1d9e..665914a 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationError.md
+++ b/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationError.md
@@ -32,4 +32,4 @@ The user's callback function that is called when there is an error for geolocati
Parameters
----------
-- __error:__ The error returned by the device. (`PositionError`)
+- __error:__ The error returned by the device. (`[PositionError](../PositionError/positionError.html)`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationSuccess.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationSuccess.md b/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationSuccess.md
index 6e6a063..fe96449 100644
--- a/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationSuccess.md
+++ b/www/docs/en/1.8.0/cordova/geolocation/parameters/geolocationSuccess.md
@@ -23,7 +23,7 @@ title: geolocationSuccess
geolocationSuccess
==================
-The user's callback function that is called when a geolocation position becomes available (when using with `geolocation.getCurrentPosition`), or when the position changes (when using with `geolocation.watchPosition`).
+The user's callback function that is called when a geolocation position becomes available (when using with `[geolocation.getCurrentPosition](../geolocation.getCurrentPosition.html)`), or when the position changes (when using with `[geolocation.watchPosition](../geolocation.watchPosition.html)`).
function(position) {
// Do something
@@ -32,9 +32,9 @@ The user's callback function that is called when a geolocation position becomes
Parameters
----------
-- __position:__ The geolocation position returned by the device. (`Position`)
+- __position:__ The geolocation position returned by the device. (`[Position](../Position/position.html)`)
-Example
+[Example](../../storage/storage.opendatabase.html)
-------
function geolocationSuccess(position) {
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/MediaError/mediaError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/MediaError/mediaError.md b/www/docs/en/1.8.0/cordova/media/MediaError/mediaError.md
index eb754bf..77e8375 100644
--- a/www/docs/en/1.8.0/cordova/media/MediaError/mediaError.md
+++ b/www/docs/en/1.8.0/cordova/media/MediaError/mediaError.md
@@ -23,7 +23,7 @@ title: MediaError
MediaError
==========
-A `MediaError` object is returned to the `mediaError` callback function when an error occurs.
+A `MediaError` object is returned to the `[mediaError](../Parameters/mediaError.html)` callback function when an error occurs.
Properties
----------
@@ -43,5 +43,5 @@ Constants
Description
-----------
-The `MediaError` object is returned to the user through the `mediaError` callback function when an error occurs.
+The `MediaError` object is returned to the user through the `[mediaError](../Parameters/mediaError.html)` callback function when an error occurs.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/Parameters/mediaError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/Parameters/mediaError.md b/www/docs/en/1.8.0/cordova/media/Parameters/mediaError.md
index 8132ca0..d4d330b 100644
--- a/www/docs/en/1.8.0/cordova/media/Parameters/mediaError.md
+++ b/www/docs/en/1.8.0/cordova/media/Parameters/mediaError.md
@@ -32,4 +32,4 @@ A user specified callback function that is invoked when there is an error in med
Parameters
----------
-- __error:__ The error returned by the device. (`MediaError`)
+- __error:__ The error returned by the device. (`[MediaError](../MediaError/mediaError.html)`)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/capture/CaptureCB.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/CaptureCB.md b/www/docs/en/1.8.0/cordova/media/capture/CaptureCB.md
index 4388e48..d0d3154 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/CaptureCB.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/CaptureCB.md
@@ -32,9 +32,9 @@ Description
This function is invoked after a successful capture operation has completed. This means a media file has been captured, and either the user has exited the media capture application, or the capture limit has been reached.
-Each MediaFile object describes a captured media file.
+Each [MediaFile](MediaFile.html) object describes a captured media file.
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// capture callback
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/capture/CaptureError.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/CaptureError.md b/www/docs/en/1.8.0/cordova/media/capture/CaptureError.md
index b41213d..884c309 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/CaptureError.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/CaptureError.md
@@ -33,8 +33,8 @@ Properties
Constants
---------
-- CaptureError.`CAPTURE_INTERNAL_ERR`: Camera or microphone failed to capture image or sound.
-- CaptureError.`CAPTURE_APPLICATION_BUSY`: Camera application or audio capture application is currently serving other capture request.
+- CaptureError.`CAPTURE_INTERNAL_ERR`: [Camera](../../camera/camera.html) or microphone failed to capture image or sound.
+- CaptureError.`CAPTURE_APPLICATION_BUSY`: [Camera](../../camera/camera.html) application or audio capture application is currently serving other capture request.
- CaptureError.`CAPTURE_INVALID_ARGUMENT`: Invalid use of the API (e.g. limit parameter has value less than one).
- CaptureError.`CAPTURE_NO_MEDIA_FILES`: User exited camera application or audio capture application before capturing anything.
- CaptureError.`CAPTURE_NOT_SUPPORTED`: The requested capture operation is not supported.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/capture/CaptureErrorCB.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/CaptureErrorCB.md b/www/docs/en/1.8.0/cordova/media/capture/CaptureErrorCB.md
index a5ca339..37381e5 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/CaptureErrorCB.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/CaptureErrorCB.md
@@ -32,9 +32,9 @@ Description
This function is invoked if an error occurs when trying to launch a media capture operation and the capture application is busy, if an error occurs while the capture operation is taking place, or if the capture operation has been canceled by the user before any media files have been captured.
-This function is invoked with a CaptureError object containing an appropriate error code.
+This function is invoked with a [CaptureError](CaptureError.html) object containing an appropriate error code.
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// capture error callback
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/capture/ConfigurationData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/ConfigurationData.md b/www/docs/en/1.8.0/cordova/media/capture/ConfigurationData.md
index 373a8fd..7459960 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/ConfigurationData.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/ConfigurationData.md
@@ -45,7 +45,7 @@ Properties
- __height:__ The height of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
- __width:__ The width of the image or video in pixels. In the case of a sound clip, this attribute has value 0. (Number)
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// retrieve supported image modes
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/capture/MediaFile.getFormatData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/MediaFile.getFormatData.md b/www/docs/en/1.8.0/cordova/media/capture/MediaFile.getFormatData.md
index 9ed744f..559e0d7 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/MediaFile.getFormatData.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/MediaFile.getFormatData.md
@@ -20,7 +20,7 @@ license: >
title: MediaFile.getFormatData
---
-MediaFile.getFormatData
+[MediaFile](MediaFile.html).getFormatData
=======================
> Retrieves format information about the media capture file.
@@ -33,7 +33,7 @@ MediaFile.getFormatData
Description
-----------
-This function asynchronously attempts to retrieve the format information for the media file. If successful, it invokes the MediaFileDataSuccessCB callback with a MediaFileData object. If the attempt fails, this function will invoke the MediaFileDataErrorCB callback.
+This function asynchronously attempts to retrieve the format information for the media file. If successful, it invokes the MediaFileDataSuccessCB callback with a [MediaFileData](MediaFileData.html) object. If the attempt fails, this function will invoke the MediaFileDataErrorCB callback.
Supported Platforms
-------------------
@@ -45,12 +45,12 @@ Supported Platforms
BlackBerry WebWorks Quirks
--------------------------
-There is no API that provides format information of media files. Therefore, all MediaFileData objects will be returned with default values. See MediaFileData documentation.
+There is no API that provides format information of media files. Therefore, all [MediaFileData](MediaFileData.html) objects will be returned with default values. See [MediaFileData](MediaFileData.html) documentation.
Android Quirks
--------------
-The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
+The API for retrieving media file format information is limited. Therefore, not all [MediaFileData](MediaFileData.html) properties are supported. See [MediaFileData](MediaFileData.html) documentation.
iOS Quirks
----------
-The API for retrieving media file format information is limited. Therefore, not all MediaFileData properties are supported. See MediaFileData documentation.
\ No newline at end of file
+The API for retrieving media file format information is limited. Therefore, not all [MediaFileData](MediaFileData.html) properties are supported. See [MediaFileData](MediaFileData.html) documentation.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/capture/MediaFileData.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/MediaFileData.md b/www/docs/en/1.8.0/cordova/media/capture/MediaFileData.md
index 7f20b3f..b0cf847 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/MediaFileData.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/MediaFileData.md
@@ -36,7 +36,7 @@ Properties
BlackBerry WebWorks Quirks
--------------------------
-There is no API that provides format information of media files. So the MediaFileData object returned by the MediaFile.getFormatData function will have the following default values:
+There is no API that provides format information of media files. So the MediaFileData object returned by the [MediaFile.getFormatData]([MediaFile](MediaFile.html).getFormatData.html) function will have the following default values:
- __codecs:__ Not supported. The attribute will always be null.
- __bitrate:__ Not supported. The attribute will always be 0.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/capture.md b/www/docs/en/1.8.0/cordova/media/capture/capture.md
index d40c9e1..7ee8bad 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/capture.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/capture.md
@@ -29,22 +29,22 @@ Objects
-------
- Capture
-- CaptureAudioOptions
-- CaptureImageOptions
-- CaptureVideoOptions
-- CaptureCB
-- CaptureErrorCB
-- ConfigurationData
-- MediaFile
-- MediaFileData
+- [CaptureAudioOptions](captureAudioOptions.html)
+- [CaptureImageOptions](captureImageOptions.html)
+- [CaptureVideoOptions](captureVideoOptions.html)
+- [CaptureCB](CaptureCB.html)
+- [CaptureErrorCB](CaptureErrorCB.html)
+- [ConfigurationData](ConfigurationData.html)
+- [MediaFile](MediaFile.html)
+- [MediaFileData](MediaFileData.html)
Methods
-------
-- capture.captureAudio
-- capture.captureImage
-- capture.captureVideo
-- MediaFile.getFormatData
+- [capture.captureAudio](captureAudio.html)
+- [capture.captureImage](captureImage.html)
+- [capture.captureVideo](captureVideo.html)
+- [MediaFile.getFormatData]([MediaFile](MediaFile.html).getFormatData.html)
Scope
-----
@@ -64,9 +64,9 @@ Properties
Methods
-------
-- capture.captureAudio: Launch the device audio recording application for recording audio clip(s).
-- capture.captureImage: Launch the device camera application for taking image(s).
-- capture.captureVideo: Launch the device video recorder application for recording video(s).
+- [capture.captureAudio](captureAudio.html): Launch the device audio recording application for recording audio clip(s).
+- [capture.captureImage](captureImage.html): Launch the device camera application for taking image(s).
+- [capture.captureVideo](captureVideo.html): Launch the device video recorder application for recording video(s).
Supported Platforms
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/captureAudio.md b/www/docs/en/1.8.0/cordova/media/capture/captureAudio.md
index 1cff61c..77292f3 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/captureAudio.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/captureAudio.md
@@ -26,7 +26,7 @@ capture.captureAudio
> Start the audio recorder application and return information about captured audio clip file(s).
navigator.device.capture.captureAudio(
- CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureAudioOptions options]
+ [CaptureCB](CaptureCB.html) captureSuccess, [CaptureErrorCB](CaptureErrorCB.html) captureError, [CaptureAudioOptions options]
);
Description
@@ -34,9 +34,9 @@ Description
This method starts an asynchronous operation to capture audio recordings using the device's default audio recording application. The operation allows the device user to capture multiple recordings in a single session.
-The capture operation ends when either the user exits the audio recording application, or the maximum number of recordings, specified by the __limit__ parameter in CaptureAudioOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user records a single audio clip.
+The capture operation ends when either the user exits the audio recording application, or the maximum number of recordings, specified by the __limit__ parameter in [CaptureAudioOptions](captureAudioOptions.html), has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user records a single audio clip.
-When the capture operation is finished, it will invoke the CaptureCB callback with an array of MediaFile objects describing each captured audio clip file. If the operation is terminated by the user before an audio clip is captured, the CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation is finished, it will invoke the [CaptureCB](CaptureCB.html) callback with an array of [MediaFile](MediaFile.html) objects describing each captured audio clip file. If the operation is terminated by the user before an audio clip is captured, the [CaptureErrorCB](CaptureErrorCB.html) callback will be invoked with a [CaptureError](CaptureError.html) object with the [CaptureError](CaptureError.html).`CAPTURE_NO_MEDIA_FILES` error code.
Supported Platforms
-------------------
@@ -46,7 +46,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// capture callback
@@ -66,7 +66,7 @@ Quick Example
// start audio capture
navigator.device.capture.captureAudio(captureSuccess, captureError, {limit:2});
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -130,7 +130,7 @@ Full Example
BlackBerry WebWorks Quirks
--------------------------
-- Cordova for BlackBerry WebWorks attempts to launch the __Voice Notes Recorder__ application, provided by RIM, to capture the audio recordings. The developer will receive a CaptureError.`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
+- Cordova for BlackBerry WebWorks attempts to launch the __Voice Notes Recorder__ application, provided by RIM, to capture the audio recordings. The developer will receive a [CaptureError](CaptureError.html).`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
iOS Quirks
----------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/capture/captureAudioOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/captureAudioOptions.md b/www/docs/en/1.8.0/cordova/media/capture/captureAudioOptions.md
index 8b273e5..336b0a4 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/captureAudioOptions.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/captureAudioOptions.md
@@ -32,7 +32,7 @@ Properties
- __duration:__ The maximum duration of an audio sound clip, in seconds.
- __mode:__ The selected audio mode. The value must match one of the elements in `capture.supportedAudioModes`.
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// limit capture operation to 3 media files, no longer than 10 seconds each
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/capture/captureImage.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/captureImage.md b/www/docs/en/1.8.0/cordova/media/capture/captureImage.md
index e12b1e2..7858be7 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/captureImage.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/captureImage.md
@@ -26,7 +26,7 @@ capture.captureImage
> Start the camera application and return information about captured image file(s).
navigator.device.capture.captureImage(
- CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureImageOptions options]
+ [CaptureCB](CaptureCB.html) captureSuccess, [CaptureErrorCB](CaptureErrorCB.html) captureError, [CaptureImageOptions options]
);
Description
@@ -34,9 +34,9 @@ Description
This method starts an asynchronous operation to capture images using the device camera application. The operation allows the device user to capture multiple images in a single session.
-The capture operation ends when either the user exits the camera application, or the maximum number of images, specified by the __limit__ parameter in CaptureImageOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user captures a single image.
+The capture operation ends when either the user exits the camera application, or the maximum number of images, specified by the __limit__ parameter in [CaptureImageOptions](captureImageOptions.html), has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user captures a single image.
-When the capture operation is finished, it will invoke the CaptureCB callback with an array of MediaFile objects describing each captured image file. If the operation is terminated by the user before an image is captured, the CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation is finished, it will invoke the [CaptureCB](CaptureCB.html) callback with an array of [MediaFile](MediaFile.html) objects describing each captured image file. If the operation is terminated by the user before an image is captured, the [CaptureErrorCB](CaptureErrorCB.html) callback will be invoked with a [CaptureError](CaptureError.html) object with the [CaptureError](CaptureError.html).`CAPTURE_NO_MEDIA_FILES` error code.
Supported Platforms
-------------------
@@ -52,7 +52,7 @@ Windows Phone 7 Quirks
Invoking the native camera application while your device is connected
via Zune will not work, and the error callback will be triggered.
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// capture callback
@@ -72,7 +72,7 @@ Quick Example
// start image capture
navigator.device.capture.captureImage(captureSuccess, captureError, {limit:2});
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/capture/captureImageOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/captureImageOptions.md b/www/docs/en/1.8.0/cordova/media/capture/captureImageOptions.md
index 13cf3c9..0cda7dd 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/captureImageOptions.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/captureImageOptions.md
@@ -31,7 +31,7 @@ Properties
- __limit:__ The maximum number of images the device user can capture in a single capture operation. The value must be greater than or equal to 1 (defaults to 1).
- __mode:__ The selected image mode. The value must match one of the elements in `capture.supportedImageModes`.
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// limit capture operation to 3 images
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/capture/captureVideo.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/captureVideo.md b/www/docs/en/1.8.0/cordova/media/capture/captureVideo.md
index b38f492..c0b84b4 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/captureVideo.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/captureVideo.md
@@ -26,7 +26,7 @@ capture.captureVideo
> Start the video recorder application and return information about captured video clip file(s).
navigator.device.capture.captureVideo(
- CaptureCB captureSuccess, CaptureErrorCB captureError, [CaptureVideoOptions options]
+ [CaptureCB](CaptureCB.html) captureSuccess, [CaptureErrorCB](CaptureErrorCB.html) captureError, [CaptureVideoOptions options]
);
Description
@@ -34,9 +34,9 @@ Description
This method starts an asynchronous operation to capture video recordings using the device video recording application. The operation allows the device user to capture multiple recordings in a single session.
-The capture operation ends when either the user exits the video recording application, or the maximum number of recordings, specified by the __limit__ parameter in CaptureVideoOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user records a single video clip.
+The capture operation ends when either the user exits the video recording application, or the maximum number of recordings, specified by the __limit__ parameter in [CaptureVideoOptions](captureVideoOptions.html), has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user records a single video clip.
-When the capture operation is finished, it will invoke the CaptureCB callback with an array of MediaFile objects describing each captured video clip file. If the operation is terminated by the user before an video clip is captured, the CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation is finished, it will invoke the [CaptureCB](CaptureCB.html) callback with an array of [MediaFile](MediaFile.html) objects describing each captured video clip file. If the operation is terminated by the user before an video clip is captured, the [CaptureErrorCB](CaptureErrorCB.html) callback will be invoked with a [CaptureError](CaptureError.html) object with the [CaptureError](CaptureError.html).`CAPTURE_NO_MEDIA_FILES` error code.
Supported Platforms
-------------------
@@ -46,7 +46,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// capture callback
@@ -66,7 +66,7 @@ Quick Example
// start video capture
navigator.device.capture.captureVideo(captureSuccess, captureError, {limit:2});
-Full Example
+Full [Example](../../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -130,4 +130,4 @@ Full Example
BlackBerry WebWorks Quirks
--------------------------
-- Cordova for BlackBerry WebWorks attempts to launch the __Video Recorder__ application, provided by RIM, to capture the video recordings. The developer will receive a CaptureError.`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
+- Cordova for BlackBerry WebWorks attempts to launch the __Video Recorder__ application, provided by RIM, to capture the video recordings. The developer will receive a [CaptureError](CaptureError.html).`CAPTURE_NOT_SUPPORTED` error code if the application is not installed on the device.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/capture/captureVideoOptions.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/capture/captureVideoOptions.md b/www/docs/en/1.8.0/cordova/media/capture/captureVideoOptions.md
index 64925d7..2ecc98d 100644
--- a/www/docs/en/1.8.0/cordova/media/capture/captureVideoOptions.md
+++ b/www/docs/en/1.8.0/cordova/media/capture/captureVideoOptions.md
@@ -32,7 +32,7 @@ Properties
- __duration:__ The maximum duration of a video clip, in seconds.
- __mode:__ The selected video capture mode. The value must match one of the elements in `capture.supportedVideoModes`.
-Quick Example
+Quick [Example](../../storage/storage.opendatabase.html)
-------------
// limit capture operation to 3 video clips
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/media.getCurrentPosition.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/media.getCurrentPosition.md b/www/docs/en/1.8.0/cordova/media/media.getCurrentPosition.md
index 1623df1..7b1af5a 100644
--- a/www/docs/en/1.8.0/cordova/media/media.getCurrentPosition.md
+++ b/www/docs/en/1.8.0/cordova/media/media.getCurrentPosition.md
@@ -36,7 +36,7 @@ Parameters
Description
-----------
-Function `media.getCurrentPosition` is an asynchronous function that returns the current position of the underlying audio file of a Media object. Also updates the ___position__ parameter within the Media object.
+Function `media.getCurrentPosition` is an asynchronous function that returns the current position of the underlying audio file of a [Media](media.html) object. Also updates the ___position__ parameter within the [Media](media.html) object.
Supported Platforms
-------------------
@@ -46,7 +46,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Audio player
@@ -71,7 +71,7 @@ Quick Example
}, 1000);
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/media.getDuration.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/media.getDuration.md b/www/docs/en/1.8.0/cordova/media/media.getDuration.md
index 8c7acfe..32d9701 100644
--- a/www/docs/en/1.8.0/cordova/media/media.getDuration.md
+++ b/www/docs/en/1.8.0/cordova/media/media.getDuration.md
@@ -41,7 +41,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Audio player
@@ -63,7 +63,7 @@ Quick Example
}, 100);
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/media.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/media.md b/www/docs/en/1.8.0/cordova/media/media.md
index 768755f..7b91578 100644
--- a/www/docs/en/1.8.0/cordova/media/media.md
+++ b/www/docs/en/1.8.0/cordova/media/media.md
@@ -41,15 +41,15 @@ Parameters
Methods
-------
-- media.getCurrentPosition: Returns the current position within an audio file.
-- media.getDuration: Returns the duration of an audio file.
-- media.play: Start or resume playing audio file.
-- media.pause: Pause playing audio file.
-- media.release: Releases the underlying OS'es audio resources.
-- media.seekTo: Moves the position within the audio file.
-- media.startRecord: Start recording audio file.
-- media.stopRecord: Stop recording audio file.
-- media.stop: Stop playing audio file.
+- [media.getCurrentPosition](media.getCurrentPosition.html): Returns the current position within an audio file.
+- [media.getDuration](media.getDuration.html): Returns the duration of an audio file.
+- [media.play](media.play.html): Start or [resume](../events/events.resume.html) playing audio file.
+- [media.pause](media.pause.html): Pause playing audio file.
+- [media.release](media.release.html): Releases the underlying OS'es audio resources.
+- [media.seekTo](media.seekTo.html): Moves the position within the audio file.
+- [media.startRecord](media.startRecord.html): Start recording audio file.
+- [media.stopRecord](media.stopRecord.html): Stop recording audio file.
+- [media.stop](media.stop.html): Stop playing audio file.
Additional ReadOnly Parameters
---------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/media.pause.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/media.pause.md b/www/docs/en/1.8.0/cordova/media/media.pause.md
index 7d6793f..84c8299 100644
--- a/www/docs/en/1.8.0/cordova/media/media.pause.md
+++ b/www/docs/en/1.8.0/cordova/media/media.pause.md
@@ -41,7 +41,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Play audio
@@ -68,7 +68,7 @@ Quick Example
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/media.play.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/media.play.md b/www/docs/en/1.8.0/cordova/media/media.play.md
index f2220a5..ac79c43 100644
--- a/www/docs/en/1.8.0/cordova/media/media.play.md
+++ b/www/docs/en/1.8.0/cordova/media/media.play.md
@@ -41,7 +41,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Play audio
@@ -63,7 +63,7 @@ Quick Example
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/media.release.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/media.release.md b/www/docs/en/1.8.0/cordova/media/media.release.md
index 48d0bb0..d4850d8 100644
--- a/www/docs/en/1.8.0/cordova/media/media.release.md
+++ b/www/docs/en/1.8.0/cordova/media/media.release.md
@@ -31,7 +31,7 @@ Releases the underlying operating systems audio resources.
Description
-----------
-Function `media.release` is a synchronous function that releases the underlying operating systems audio resources. This function is particularly important for Android as there are a finite amount of OpenCore instances for media playback. Developers should call the 'release' function when they no longer need the Media resource.
+Function `media.release` is a synchronous function that releases the underlying operating systems audio resources. This function is particularly important for Android as there are a finite amount of OpenCore instances for media playback. Developers should call the 'release' function when they no longer need the [Media](media.html) resource.
Supported Platforms
-------------------
@@ -41,7 +41,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Audio player
@@ -52,7 +52,7 @@ Quick Example
my_media.stop();
my_media.release();
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/media.seekTo.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/media.seekTo.md b/www/docs/en/1.8.0/cordova/media/media.seekTo.md
index 52b55ec..ac8c9a5 100644
--- a/www/docs/en/1.8.0/cordova/media/media.seekTo.md
+++ b/www/docs/en/1.8.0/cordova/media/media.seekTo.md
@@ -36,7 +36,7 @@ Parameters
Description
-----------
-Function `media.seekTo` is an asynchronous function that updates the current position of the underlying audio file of a Media object. Also updates the ___position__ parameter within the Media object.
+Function `media.seekTo` is an asynchronous function that updates the current position of the underlying audio file of a [Media](media.html) object. Also updates the ___position__ parameter within the [Media](media.html) object.
Supported Platforms
-------------------
@@ -46,7 +46,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Audio player
@@ -59,7 +59,7 @@ Quick Example
}, 5000);
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/c4881540/www/docs/en/1.8.0/cordova/media/media.startRecord.md
----------------------------------------------------------------------
diff --git a/www/docs/en/1.8.0/cordova/media/media.startRecord.md b/www/docs/en/1.8.0/cordova/media/media.startRecord.md
index 4b4a467..b14fd1e 100644
--- a/www/docs/en/1.8.0/cordova/media/media.startRecord.md
+++ b/www/docs/en/1.8.0/cordova/media/media.startRecord.md
@@ -41,7 +41,7 @@ Supported Platforms
- iOS
- Windows Phone 7 ( Mango )
-Quick Example
+Quick [Example](../storage/storage.opendatabase.html)
-------------
// Record audio
@@ -64,7 +64,7 @@ Quick Example
}
-Full Example
+Full [Example](../storage/storage.opendatabase.html)
------------
<!DOCTYPE html>
@@ -141,4 +141,4 @@ BlackBerry WebWorks Quirks
iOS Quirks
----------
-- The file to record to must already exist and should be of type .wav. The File API's can be used to create the file.
+- The file to record to must already exist and should be of type .wav. The [File](../file/fileobj/fileobj.html) API's can be used to create the file.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org