Merge pull request phonegap#903 from guidosabatini/master

devgeeks · devgeeks · commit cf0ac33c90c4 · 2012-11-22T14:16:38.000-08:00
Readme files correction for both platforms plugins
diff --git a/Android/EmailComposerWithAttachments/readme.md b/Android/EmailComposerWithAttachments/readme.md
@@ -3,25 +3,29 @@
 - Place the EmailComposer.js file somewhere in your www folder, and include it from your html.
 
 - Add the plugin to your config.xml file in this way:
+
 	<plugin name="EmailComposer" value="org.apache.cordova.EmailComposer"/>
 
 Callable interface:
-	window.plugins.emailComposer.showEmailComposerWithCallback(<callback>,<subject>,<body>,<toRecipients>,<ccRecipients>,<bccRecipients>,<isHtml>,<attachments>);
+
+	window.plugins.emailComposer.showEmailComposerWithCallback(callback,subject,body,toRecipients,ccRecipients,bccRecipients,isHtml,attachments);
 
 or
-	window.plugins.emailComposer.showEmailComposer(<subject>,<body>,<toRecipients>,<ccRecipients>,<bccRecipients>,<isHtml>,<attachments>);
+
+	window.plugins.emailComposer.showEmailComposer(subject,body,toRecipients,ccRecipients,bccRecipients,isHtml,attachments);
 
 **ATTENTION:** the callback will never be triggered, it's here only for consistency with the iOS plugin
 
 **Parameters:**
-- <callback>: never used
-- <subject>: a string representing the subject of the email; can be null
-- <body>: a string representing the email body (could be HTML code, in this case set <isHtml> to **true**); can be null
-- <toRecipients>: a js array containing all the email addresses for TO field; can be null/empty
-- <ccRecipients>: a js array containing all the email addresses for CC field; can be null/empty
-- <bccRecipients>: a js array containing all the email addresses for BCC field; can be null/empty
-- <isHtml>: a bool value indicating if the body is HTML or plain text
-- <attachments>: a js array containing all full paths to the files you want to attach; can be null/empty
+- callback: never used
+- subject: a string representing the subject of the email; can be null
+- body: a string representing the email body (could be HTML code, in this case set **isHtml** to **true**); can be null
+- toRecipients: a js array containing all the email addresses for TO field; can be null/empty
+- ccRecipients: a js array containing all the email addresses for CC field; can be null/empty
+- bccRecipients: a js array containing all the email addresses for BCC field; can be null/empty
+- isHtml: a bool value indicating if the body is HTML or plain text
+- attachments: a js array containing all full paths to the files you want to attach; can be null/empty
 
 **Example**
+
 	window.plugins.emailComposer.showEmailComposerWithCallback(null,"Look at this photo","Take a look at <b>this<b/>:",["example@email.com", "johndoe@email.org"],[],[],true,["_complete_path/image.jpg", "_other_complete_path/file.zip"]);
diff --git a/iOS/EmailComposerWithAttachments/readme.md b/iOS/EmailComposerWithAttachments/readme.md
@@ -1,12 +1,17 @@
 This is a modification of the EmailComposer iOS plugin made by **Randy McMillan**
 In this version of the plugin, you can attach images and PDF files to emails. A little refactoring was made.
 It is compliant with Cordova 2.2.0 standard (new CDVInvokedUrlCommand parameter sent to native methods). If you want to use the plugin with an older version of Cordova you must comment the method
+
 	showEmailComposer:(CDVInvokedUrlCommand*)command;
+	
 and uncomment the method
+
 	showEmailComposer:(NSMutableArray*)arguments withDict:(NSMutableDictionary*)options;
+	
 both in EmailComposer.h and EmailComposer.m files
 
 **IMPORTANT:** You will need to add MessageUI.framework to your project if it is not already included.
+
 **IMPORTANT:** by now, you can attach only PDF and IMAGES (the latter will be convertend in PNG format)
 
 - Add the EmailComposer.h EmailComposer.m  files to your Plugins Folder.
@@ -16,22 +21,25 @@ both in EmailComposer.h and EmailComposer.m files
 - Add to Cordova.plist Plugins: key **EmailComposer** value **EmailComposer**
 
 Callable interface:
-	window.plugins.emailComposer.showEmailComposerWithCallback(<callback>,<subject>,<body>,<toRecipients>,<ccRecipients>,<bccRecipients>,<isHtml>,<attachments>);
+
+	window.plugins.emailComposer.showEmailComposerWithCallback(callback,subject,body,toRecipients,ccRecipients,bccRecipients,isHtml,attachments);
 
 or
-	window.plugins.emailComposer.showEmailComposer(<subject>,<body>,<toRecipients>,<ccRecipients>,<bccRecipients>,<isHtml>,<attachments>);
+
+	window.plugins.emailComposer.showEmailComposer(subject,body,toRecipients,ccRecipients,bccRecipients,isHtml,attachments);
 
 **Parameters:**
-- <callback>: a js function that will receive return parameter from the plugin
-- <subject>: a string representing the subject of the email; can be null
-- <body>: a string representing the email body (could be HTML code, in this case set <isHtml> to **true**); can be null
-- <toRecipients>: a js array containing all the email addresses for TO field; can be null/empty
-- <ccRecipients>: a js array containing all the email addresses for CC field; can be null/empty
-- <bccRecipients>: a js array containing all the email addresses for BCC field; can be null/empty
-- <isHtml>: a bool value indicating if the body is HTML or plain text
-- <attachments>: a js array containing all full paths to the files you want to attach; can be null/empty
+- callback: a js function that will receive return parameter from the plugin
+- subject: a string representing the subject of the email; can be null
+- body: a string representing the email body (could be HTML code, in this case set **isHtml** to **true**); can be null
+- toRecipients: a js array containing all the email addresses for TO field; can be null/empty
+- ccRecipients: a js array containing all the email addresses for CC field; can be null/empty
+- bccRecipients: a js array containing all the email addresses for BCC field; can be null/empty
+- isHtml: a bool value indicating if the body is HTML or plain text
+- attachments: a js array containing all full paths to the files you want to attach; can be null/empty
 
 **Example**
+
 	window.plugins.emailComposer.showEmailComposerWithCallback(function(result){console.log(result);},"Look at this photo","Take a look at <b>this<b/>:",["example@email.com", "johndoe@email.org"],[],[],true,["_complete_path/image.jpg"]);
 
 **Return values**
