@mattab opened this Issue on July 6th 2008 Owner

It's hard to write a good developer documentation. Examples are easier to understand and to maintain. We will write a number of plugins, that each uses one feature of Piwik:

  • ExampleDBAccess
  • ExampleFeedburner
  • ExampleWidget
  • ExampleEditMenu
  • Other features to cover in example plugins: API, plotting data, recording new data in new db table, running tests, using a config file, using the "option" mechanism, etc.

Then we would:

  • build a wiki page listing all the Example plugins
  • print their quick description
  • link to their source code

Examples of other open source project plugin documentation
* writing a plugin http://codex.wordpress.org/Writing_a_Plugin
* plugin api http://codex.wordpress.org/Plugin_API
* mediawiki plugin hooks http://www.mediawiki.org/wiki/Manual:Hooks

Ideas of simple useful plugins

  • "You have X websites and Y users registered in Piwik. You are using Piwik A.B version."
  • "Featured user" that randomly picks a use case from our use case base.
  • "Piwik has been downloaded N times."

Technical notes:
* content loaded from piwik.org via highly cached proxy pages
* if piwik.org is down, should not affect loading time of dashboard
* have one widget for general purpose content (Piwik has been downloaded X times)

@gka commented on August 18th 2010 Member

I added two new widgets in changeset 2958

  • "You have X websites and Y users registered in Piwik. You are using Piwik A.B version."
  • "Piwik has been downloaded N times."

They demonstrate simple database queries and a remote API call to demo.piwik.org (via jquery ajax request). Both widgets use templates.

@halfdan commented on August 18th 2010 Member

greg: You forgot to check in the en.php - both widgets appear but their translations are missing.

@mattab commented on November 23rd 2010 Owner

We should also have the documentation point to ExampleUI plugin

@mattab commented on November 23rd 2010 Owner

It would be nice to document how plugins can create new sections in the config file.

Something like this (but finding a way not to call the __destruct would be better)

$config = Zend_Registry::get('config');
$config->MobileAnalytics = array("TeraWurflURL"=>"unconfigured");

I'm not sure why it wasn't working before, but this works great now.

TeraWurflURL = "unconfigured"
@robocoder commented on November 24th 2010 Contributor

Agree. Planning a cleaner config writer should already be in #1713.

@mattab commented on November 24th 2010 Owner

Also, while writing dev doc, I recommend going through the config.ini.php settings to find out which ones could be of interest to the Piwik plugin developer (I'm thinking eg. disable_merged_assets, track_visits_inside_piwik_ui, alwaysarchive* etc.)

@julienmoumne commented on February 11th 2011 Member

The new general layout of the documentation is now in place (piwik.org/docs).

Plugin guides are part of the new organization but are yet to be written. The proposed list is :

Development Guides
Basic architecture
Adding a widget
Use Smarty templates
Accessing the database
Editing the menu
Using Piwik's API
Plotting Data
Recording new Data
Adding options in config.ini

@julienmoumne commented on March 4th 2011 Member

Should include guide :
Internationalization and localization
See forum post

@mattab commented on March 11th 2013 Owner

Mostly we have such simple plugins now. The docs are still missing but will be covered in separate plugin. For latest docs on plugin development see: http://new.piwik.org/docs/plugins/

This Issue was closed on March 11th 2013
Powered by GitHub Issue Mirror