You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@cordova.apache.org by Michael Brooks <mi...@michaelbrooks.ca> on 2012/07/26 01:01:53 UTC

Plugin Documentation v2

Hello everyone,

For Cordova 2.0.0, we managed to document the plugin development processing
through a Echo Plugin example. It's a great start, but only the beginning.

At PhoneGap Day 2012 US, Don Coleman did a fantastic presentation on
PhoneGap (Cordova) Plugins [1]. Using his talk as a basis, we're looking
into expanding the plugin documentation. Currently, the Table of Contents
looks something like this:

Overview of Plugins
Plugin Spec
JavaScript
    - Lifecycle
    - API Reference
Native
    - Lifecycle
    - API reference
Echo plugin example and narrative
Best practices
    - Using require('...');
    - Writing Tests
    - Tagging to align with Cordova release
    - Naming Scheme


Don is creating issues to track each of these tasks and we'd like to see
everything but "Best Practices" make it in for Cordova 2.1.0. For the most
part, we can reuse the existing documentation, but each platform will need
to document the Native API for plugin development.

[1] http://don.github.com/phonegap-plugins/#1

Thoughts / complaints / enthusiasm?
Michael

Re: Plugin Documentation v2

Posted by Filip Maj <fi...@adobe.com>.

ENTHUSIASM!!!!

On 7/25/12 4:01 PM, "Michael Brooks" <mi...@michaelbrooks.ca> wrote:

>Hello everyone,
>
>For Cordova 2.0.0, we managed to document the plugin development
>processing
>through a Echo Plugin example. It's a great start, but only the beginning.
>
>At PhoneGap Day 2012 US, Don Coleman did a fantastic presentation on
>PhoneGap (Cordova) Plugins [1]. Using his talk as a basis, we're looking
>into expanding the plugin documentation. Currently, the Table of Contents
>looks something like this:
>
>Overview of Plugins
>Plugin Spec
>JavaScript
>    - Lifecycle
>    - API Reference
>Native
>    - Lifecycle
>    - API reference
>Echo plugin example and narrative
>Best practices
>    - Using require('...');
>    - Writing Tests
>    - Tagging to align with Cordova release
>    - Naming Scheme
>
>
>Don is creating issues to track each of these tasks and we'd like to see
>everything but "Best Practices" make it in for Cordova 2.1.0. For the most
>part, we can reuse the existing documentation, but each platform will need
>to document the Native API for plugin development.
>
>[1] http://don.github.com/phonegap-plugins/#1
>
>Thoughts / complaints / enthusiasm?
>Michael