purplecabbage / phonegap-plugins

Plugins for use with PhoneGap.
975 stars 3.83k forks source link

Lack of documentation #1

Open timrogers opened 13 years ago

timrogers commented 13 years ago

Any change that we could have a quick piece of documentation in the readme file so us PhoneGappers can find out how to use this plugin? And perhaps a small overview of the plugin's functionality.

mweimerskirch commented 13 years ago

Which plugin do you mean? There are several and most are IMHO sufficiently documented.

The installation procedure is always the same: copy the .h and .m files to the "Plugins" directory, copy the .js file to the "www" directory. Link the .js file from a HTML file and start using it.

Inside your own code you call the plugin methods with "window.plugins.PLUGINNAME.METHODNAME(PARAMETERS);". e.g "window.plugins.clipboardPlugin.setText("text");" Have a look at the actual .js file you want to use to see what methods are available.

timrogers commented 13 years ago

I was specifically referring to ChildBrowser. I managed to discover that the .h and .m files had to go into Plugins, but that could maybe be included in the readme. I'm not trying to be difficult, but I feel it would be of help to new users.

ghost commented 13 years ago

I'd like to know exactly how do I include AsyncSocket.h/.m in my PhoneGap project. I'm still unfamiliar with Xcode and really need some help. I imagine it's pretty simple.

Thanks in advance for any help. I'll appreciate it.

awallner commented 13 years ago

I wasted an hour with this, hopefully this helps someone else: 1) mkdir Plugins 2) copy .h and .m files to Plugins 3) copy .js file to www 4) in Xcode, right click Plugins directory, Add existing file, select .h/.m file, check 'Create Folder Reference for any added folders', click Add 5) in your html file, include the plugin js file after phonegap.js call plugin function, eg Screenshot.prototype.saveScreenshot Note: calling window.plugins.Screenshot... (as suggested above) didn't work for me

nelga commented 13 years ago

Hi,

Just wondering if anyone could point me in the direction of a tutorial/demo on how to include and use the Native Controls for iPhone?

Trying to create a tabbar & navigation bar (with back and info buttons) so that I can ditch iscroll (too buggy).

Many thanks!

npalmqvist commented 13 years ago

Hi! Thanks for these great plugins, but I also think there is a lack of documentation. I would like to request further information about the MapKit plugin, the example just don't cover it all in my opinion. What I would like to know is how to add multiple pins to a map from an external file (JSON) and if there's a way to add pins without moving/recentering the map when doing it and without replacing previous placed pins.

Thanks

atkinson commented 13 years ago

iphone / NativeControls appears to have zero documentation.

MindSculpt commented 12 years ago

I have been able to implement this, however the ad count is changing but no actual ads are showing up (just get a black box). Does this mean that there are no ads to be served, or am I missing something else (ie some setting in the Apple Dev center to enable iAds)?