PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

---

Parent package: Foswiki::Plugins::JQueryPlugin
Child packages:

More ...Less ...

internal package Foswiki::Plugins::JQueryPlugin::Plugin

abstract class for a jQuery plugin

ClassMethod new( $class, ... )

• $class: Plugin class
• ...: additional properties to be added to the object. i.e.
  • author => 'pluginAuthor' (default unknown)
  • debug => 0 or 1 (default $Foswiki::cfg{JQueryPlugin}{Debug})
  • dependencies => []
  • documentation => 'pluginDocumentation' (default JQuery<Name>)
  • homepage => 'pluginHomepage' (default unknown)
  • =javascript => []
  • name => 'pluginName' (default unknown)
  • puburl > 'pubUrl' (default /twiki_public/pub/System/JQueryPlugin/plugins/pluginname)
  • summary => 'pluginSummary' (default undefined)
  • tags => []
  • version => 'pluginVersion' (default unknown)

ClassMethod init( )

add jQuery plugin to web and make sure all its dependencies are fulfilled.

ClassMethod getSummary()

returns the summary text for this plugin. this is either the summary property of the class or the summary section of the plugin's documentation topic.