cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwbro...@apache.org
Subject [45/46] docs commit: Merge branch 'mike-sierra/copy_edit' into master.
Date Wed, 12 Jun 2013 17:51:20 GMT
Merge branch 'mike-sierra/copy_edit' into master.

Conflicts:
	docs/en/edge/cordova/file/filewriter/filewriter.md


Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/459dba09
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/459dba09
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/459dba09

Branch: refs/heads/master
Commit: 459dba096c1c45815eeb4f9aebf054bc3fb31730
Parents: 3e06f38 bf39501
Author: Michael Brooks <michael@michaelbrooks.ca>
Authored: Wed Jun 12 10:47:59 2013 -0700
Committer: Michael Brooks <michael@michaelbrooks.ca>
Committed: Wed Jun 12 10:47:59 2013 -0700

----------------------------------------------------------------------
 .../accelerometer/acceleration/acceleration.md  |  16 +-
 .../accelerometer/accelerometer.clearWatch.md   |  23 +-
 .../accelerometer.getCurrentAcceleration.md     |  16 +-
 .../accelerometer.watchAcceleration.md          |  36 +--
 .../parameters/accelerometerOptions.md          |   2 +-
 .../parameters/accelerometerSuccess.md          |   2 +-
 docs/en/edge/cordova/camera/camera.cleanup.md   |   6 +-
 .../en/edge/cordova/camera/camera.getPicture.md |  32 +-
 .../camera/parameter/CameraPopoverHandle.md     |   2 +-
 .../camera/parameter/CameraPopoverOptions.md    |  38 +--
 .../cordova/camera/parameter/cameraError.md     |   2 +-
 .../cordova/camera/parameter/cameraOptions.md   |  24 +-
 .../cordova/camera/parameter/cameraSuccess.md   |   2 +-
 .../edge/cordova/compass/compass.clearWatch.md  |  20 +-
 .../compass/compass.getCurrentHeading.md        |  14 +-
 docs/en/edge/cordova/compass/compass.md         |   4 +-
 .../cordova/compass/compass.watchHeading.md     |  26 +-
 .../compass/compassError/compassError.md        |   6 +-
 .../compass/parameters/compassHeading.md        |  11 +-
 .../compass/parameters/compassOptions.md        |   4 +-
 .../compass/parameters/compassSuccess.md        |   2 +-
 .../edge/cordova/connection/connection.type.md  |  74 ++---
 .../en/edge/cordova/contacts/Contact/contact.md | 202 ++++++-------
 .../contacts/ContactAddress/contactaddress.md   | 122 ++++----
 .../contacts/ContactError/contactError.md       |   2 +-
 .../contacts/ContactField/contactfield.md       | 115 +++----
 .../ContactFindOptions/contactfindoptions.md    |  62 ++--
 .../cordova/contacts/ContactName/contactname.md |  95 +++---
 .../ContactOrganization/contactorganization.md  |  91 +++---
 .../en/edge/cordova/contacts/contacts.create.md |  12 +-
 docs/en/edge/cordova/contacts/contacts.find.md  |  95 +++---
 .../contacts/parameters/contactFindOptions.md   |   5 +-
 .../contacts/parameters/contactSuccess.md       |   2 +-
 docs/en/edge/cordova/device/device.cordova.md   |   7 +-
 docs/en/edge/cordova/device/device.model.md     |  11 +-
 docs/en/edge/cordova/device/device.name.md      |   9 +-
 docs/en/edge/cordova/device/device.platform.md  |   5 +-
 docs/en/edge/cordova/device/device.uuid.md      |   7 +-
 docs/en/edge/cordova/device/device.version.md   |   7 +-
 .../en/edge/cordova/events/events.backbutton.md |  19 +-
 .../cordova/events/events.batterycritical.md    |  36 +--
 .../en/edge/cordova/events/events.batterylow.md |  32 +-
 .../edge/cordova/events/events.batterystatus.md |  32 +-
 .../edge/cordova/events/events.deviceready.md   |  25 +-
 .../edge/cordova/events/events.endcallbutton.md |  12 +-
 .../en/edge/cordova/events/events.menubutton.md |  15 +-
 docs/en/edge/cordova/events/events.offline.md   |  29 +-
 docs/en/edge/cordova/events/events.online.md    |  29 +-
 docs/en/edge/cordova/events/events.pause.md     |  42 +--
 docs/en/edge/cordova/events/events.resume.md    |  41 ++-
 .../edge/cordova/events/events.searchbutton.md  |  17 +-
 .../cordova/events/events.startcallbutton.md    |  17 +-
 .../cordova/events/events.volumedownbutton.md   |  17 +-
 .../cordova/events/events.volumeupbutton.md     |  17 +-
 .../file/directoryentry/directoryentry.md       | 191 ++++++------
 .../file/directoryreader/directoryreader.md     |  11 +-
 docs/en/edge/cordova/file/file.md               |   2 +-
 .../en/edge/cordova/file/fileentry/fileentry.md | 130 ++++----
 .../en/edge/cordova/file/fileerror/fileerror.md |   8 +-
 docs/en/edge/cordova/file/fileobj/fileobj.md    |  27 +-
 .../edge/cordova/file/filereader/filereader.md  | 182 +++++------
 .../edge/cordova/file/filesystem/filesystem.md  |  47 +--
 .../cordova/file/filetransfer/filetransfer.md   | 159 +++++-----
 .../file/filetransfererror/filetransfererror.md |  14 +-
 .../file/fileuploadoptions/fileuploadoptions.md |  23 +-
 .../file/fileuploadresult/fileuploadresult.md   |  14 +-
 .../edge/cordova/file/filewriter/filewriter.md  | 162 +++++-----
 docs/en/edge/cordova/file/flags/flags.md        |   8 +-
 .../file/localfilesystem/localfilesystem.md     |  60 ++--
 docs/en/edge/cordova/file/metadata/metadata.md  |  20 +-
 .../geolocation/Coordinates/coordinates.md      |  29 +-
 .../cordova/geolocation/Position/position.md    |  41 ++-
 .../geolocation/PositionError/positionError.md  |  19 +-
 .../geolocation/geolocation.clearWatch.md       |  31 +-
 .../geolocation.getCurrentPosition.md           |  28 +-
 docs/en/edge/cordova/geolocation/geolocation.md |  17 +-
 .../geolocation/geolocation.watchPosition.md    |  31 +-
 .../parameters/geolocation.options.md           |  10 +-
 .../geolocation/parameters/geolocationError.md  |   5 +-
 .../parameters/geolocationSuccess.md            |   7 +-
 .../GlobalizationError/globalizationerror.md    |  27 +-
 .../globalization/globalization.dateToString.md |  42 +--
 .../globalization.getCurrencyPattern.md         |  73 +++--
 .../globalization/globalization.getDateNames.md |  53 ++--
 .../globalization.getDatePattern.md             |  59 ++--
 .../globalization.getFirstDayOfWeek.md          |  31 +-
 .../globalization.getLocaleName.md              |  26 +-
 .../globalization.getNumberPattern.md           |  91 +++---
 .../globalization.getPreferredLanguage.md       |  26 +-
 .../globalization.isDayLightSavingsTime.md      |  36 ++-
 .../edge/cordova/globalization/globalization.md |   6 +-
 .../globalization.numberToString.md             |  37 ++-
 .../globalization/globalization.stringToDate.md |  67 ++--
 .../globalization.stringToNumber.md             |  43 ++-
 .../edge/cordova/inappbrowser/inappbrowser.md   | 112 ++++---
 .../en/edge/cordova/inappbrowser/window.open.md |  56 ++--
 .../edge/cordova/media/MediaError/mediaError.md |  10 +-
 .../edge/cordova/media/Parameters/mediaError.md |   5 +-
 docs/en/edge/cordova/media/capture/CaptureCB.md |   7 +-
 .../edge/cordova/media/capture/CaptureError.md  |  12 +-
 .../cordova/media/capture/CaptureErrorCB.md     |   8 +-
 .../cordova/media/capture/ConfigurationData.md  |  20 +-
 .../media/capture/MediaFile.getFormatData.md    |  18 +-
 docs/en/edge/cordova/media/capture/MediaFile.md |  12 +-
 .../edge/cordova/media/capture/MediaFileData.md |  49 +--
 docs/en/edge/cordova/media/capture/capture.md   |  19 +-
 .../edge/cordova/media/capture/captureAudio.md  |  33 +-
 .../media/capture/captureAudioOptions.md        |  10 +-
 .../edge/cordova/media/capture/captureImage.md  |  42 ++-
 .../media/capture/captureImageOptions.md        |   4 +-
 .../edge/cordova/media/capture/captureVideo.md  |  45 +--
 .../media/capture/captureVideoOptions.md        |  11 +-
 .../cordova/media/media.getCurrentPosition.md   |  76 ++---
 docs/en/edge/cordova/media/media.getDuration.md |  66 ++--
 docs/en/edge/cordova/media/media.md             |  46 +--
 docs/en/edge/cordova/media/media.pause.md       |  45 ++-
 docs/en/edge/cordova/media/media.play.md        |  83 ++---
 docs/en/edge/cordova/media/media.release.md     |  52 ++--
 docs/en/edge/cordova/media/media.seekTo.md      |  96 +++---
 docs/en/edge/cordova/media/media.startRecord.md |  25 +-
 docs/en/edge/cordova/media/media.stop.md        |  36 +--
 docs/en/edge/cordova/media/media.stopRecord.md  |  20 +-
 .../cordova/notification/notification.alert.md  |  55 ++--
 .../cordova/notification/notification.beep.md   |  39 +--
 .../notification/notification.confirm.md        |  78 ++---
 .../edge/cordova/notification/notification.md   |  10 +-
 .../cordova/notification/notification.prompt.md |  35 +--
 .../notification/notification.vibrate.md        |  30 +-
 .../cordova/splashscreen/splashscreen.hide.md   |  17 +-
 .../edge/cordova/splashscreen/splashscreen.md   |  50 ++-
 .../cordova/splashscreen/splashscreen.show.md   |  10 +-
 .../edge/cordova/storage/database/database.md   |  99 +++---
 .../storage/localstorage/localstorage.md        |  57 ++--
 .../cordova/storage/parameters/display_name.md  |   2 +-
 docs/en/edge/cordova/storage/parameters/name.md |   2 +-
 docs/en/edge/cordova/storage/parameters/size.md |   2 +-
 .../edge/cordova/storage/sqlerror/sqlerror.md   |   5 +-
 .../storage/sqlresultset/sqlresultset.md        |  30 +-
 .../sqlresultsetrowlist/sqlresultsetrowlist.md  | 142 ++++-----
 .../storage/sqltransaction/sqltransaction.md    |  95 +++---
 docs/en/edge/cordova/storage/storage.md         |  11 +-
 .../cordova/storage/storage.opendatabase.md     |  17 +-
 docs/en/edge/guide/command-line/index.md        |   1 +
 docs/en/edge/guide/cordova-webview/ios.md       |   4 +-
 docs/en/edge/guide/getting-started/ios/index.md |   2 +-
 .../edge/guide/getting-started/tizen/index.md   |   2 +-
 .../getting-started/windows-phone-7/index.md    |   2 +-
 .../getting-started/windows-phone-8/index.md    |   1 -
 docs/en/edge/guide/overview/support.html        | 302 +++++++++++++++++++
 .../guide/plugin-development/android/index.md   |   2 +-
 .../en/edge/guide/upgrading/blackberry/index.md |   2 +-
 151 files changed, 3093 insertions(+), 2513 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/459dba09/docs/en/edge/cordova/file/filewriter/filewriter.md
----------------------------------------------------------------------
diff --cc docs/en/edge/cordova/file/filewriter/filewriter.md
index eac0a32,75e275b..2269c06
--- a/docs/en/edge/cordova/file/filewriter/filewriter.md
+++ b/docs/en/edge/cordova/file/filewriter/filewriter.md
@@@ -40,20 -42,26 +42,28 @@@ The following property is _not_ support
  Methods
  -------
  
- - __abort__: Aborts writing file.
- - __seek__: Moves the file pointer to the byte specified.
- - __truncate__: Shortens the file to the length specified.
+ - __abort__: Aborts writing the file.
+ - __seek__: Moves the file pointer to the specified byte.
+ - __truncate__: Shortens the file to the specified length.
 -- __write__: Writes data to the file with a UTF-8 encoding.
 +- __write__: Writes data to the file.
  
  Details
  -------
  
- The `FileWriter` object is a way to write files to the device file system (UTF-8 encoded).
 Users register their own event listeners to receive the writestart, progress, write, writeend,
error and abort events.
+ The `FileWriter` object offers a way to write UTF-8 encoded files to
+ the device file system.  Applications respond to `writestart`,
+ `progress`, `write`, `writeend`, `error`, and `abort` events.
  
- A FileWriter is created for a single file. You can use it to write to a file multiple times.
The FileWriter maintains the file's position and length attributes, so you can seek and write
anywhere in the file. By default, the FileWriter writes to the beginning of the file (will
overwrite existing data). Set the optional append boolean to true in the FileWriter's constructor
to begin writing to the end of the file.
+ Each `FileWriter` corresponds to a single file, to which data can be
+ written many times.  The `FileWriter` maintains the file's `position`
+ and `length` attributes, which allow the app to `seek` and `write`
+ anywhere in the file. By default, the `FileWriter` writes to the
+ beginning of the file, overwriting existing data. Set the optional
+ `append` boolean to `true` in the `FileWriter`'s constructor to
+ 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
  -------------------
  
@@@ -92,63 -99,38 +106,59 @@@ Truncate Quick Exampl
      entry.createWriter(win, fail);
  
  Write Quick Example
- -------------------	
+ -------------------
  
- 	function win(writer) {
- 		writer.onwrite = function(evt) {
-         	console.log("write success");
+     function win(writer) {
+         writer.onwrite = function(evt) {
+             console.log("write success");
          };
- 		writer.write("some sample text");
- 	};
+         writer.write("some sample text");
+     };
+ 
+     var fail = function(evt) {
+         console.log(error.code);
+     };
  
- 	var fail = function(evt) {
-     	console.log(error.code);
- 	};
- 	
      entry.createWriter(win, fail);
  
 +Binary Write Quick Example
 +--------------------------
 +
 +    function win(writer) {
 +        var data = new ArrayBuffer(5),
 +            dataView = new Int8Array(data);
 +        for (i=0; i < 5; i++) {
 +            dataView[i] = i;
 +        }
 +        writer.onwrite = function(evt) {
 +            console.log("write success");
 +        };
 +        writer.write(data);
 +    };
 +
 +    var fail = function(evt) {
 +        console.log(error.code);
 +    };
 +
 +    entry.createWriter(win, fail);
 +
  Append Quick Example
- --------------------	
+ --------------------
  
- 	function win(writer) {
- 		writer.onwrite = function(evt) {
-         	console.log("write success");
-         };
-         writer.seek(writer.length);
- 		writer.write("appended text");
- 	};
+     function win(writer) {
+         writer.onwrite = function(evt) {
+         console.log("write success");
+     };
+     writer.seek(writer.length);
+         writer.write("appended text");
+     };
+ 
+     var fail = function(evt) {
+         console.log(error.code);
+     };
  
- 	var fail = function(evt) {
-     	console.log(error.code);
- 	};
- 	
      entry.createWriter(win, fail);
- 	
+ 
  Abort Quick Example
  -------------------
  


Mime
View raw message