Thomas Wittek > Konstrukt > Konstrukt::Plugin::wiki::markup::link::image

Download:
konstrukt/Konstrukt-0.5-beta13.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

NAME ^

Konstrukt::Plugin::wiki::markup::link::image - Plugin to handle (internal and external) images

SYNOPSIS ^

See "SYNOPSIS" in Konstrukt::Plugin::wiki::markup::linkplugin.

DESCRIPTION ^

This one will be responsible for all internal and external image links.

Internal images will be displayed on the page with a default width of 180px. They will link to a page with the full sized image.

External images will just be linked and not displayed unless you define a parameter to show them.

Note that the filename of internal images will be normalized. All characters but letters, numbers, parenthesis and dots will be replaced by underscores.

EXAMPLE ^

Internal images

        inline image: image:foo.jpg
        explicit image with alternative text: [[image:foo bar baz|alternative text (default = image name)]]
        explicit image with specified width: [[image:foo|200px]]
        
        Parameter reference:
        left: align the image on the left side
        right: align the image on the right side
        center: centered alignment of the image
        123px: width in pixels
        thumb: alias for 100px width
        text at the end: caption text (also alt-text)
        
        Default alignment: No special alignment, but may be overridden by the
        template/stylesheet. 

External images (.gif, .jpg, .png)

        implicit image: http://foo.bar/baz.gif
        explicit image: [[http://foo.bar/baz bar foo.jpg|link text]]
        explicit image displayed on the page: [[http://foo.bar/baz bar foo.jpg|embed|link text]]
        
        When an explicit image is displayed using the embed parameter the parameters
        available for internal images will also work.

METHODS ^

matching_regexps()

See "matching_regexps" in Konstrukt::Plugin::wiki::markup::linkplugin for a description.

init

Initialization.

install

Installs the templates.

Parameters:

none

handle()

See "handle" in Konstrukt::Plugin::wiki::markup::linkplugin for a description.

Parameters:

execute_again

Yep, will return template nodes.

prepare

Won't do anything in the prepare run.

Parameters:

execute

Here we will decide which link should be returned in dependence of the existance of the image.

Parameters:

AUTHOR ^

Copyright 2006 Thomas Wittek (mail at gedankenkonstrukt dot de). All rights reserved.

This document is free software. It is distributed under the same terms as Perl itself.

SEE ALSO ^

Konstrukt::Plugin::wiki

syntax highlighting: