Author image Johan Vromans
and 1 contributors

NAME

Comics::Plugin::Base -- Base class for Plugins.

SYNOPSIS

This base class is only used indirectly via the Fetchers.

DESCRIPTION

The Plugin Base class provides tools for Plugins.

CONSTRUCTOR

register( { ... } )

Registers the plugin to the aggregator.

The method takes a hash ref with arguments. What arguments are possible depends on the plugin's Fetcher type. See the documentation of the Fetchers for more info.

As of API 1.1, the preferred way of specifying the data is by using package variables. These will be transferred to the hash using introspection.

Common arguments are:

name

The full name of this comic, e.g. "Fokke en Sukke".

url

The url of this comic's home page.

tag

A short identifier for this comic. This will be automatically provided if not specified.

The tag is used to generate file names for images and HTML fragments.

METHODS

html

Generates an HTML fragment for a fetched image.

html

Generates a tag (identifier) from the name of the plugin.