The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Konstrukt::Doc::ApplicationPlugins - Use existing application plugins to integrate complex functionality into your website in an instant

DESCRIPTION

I will only give a brief overview of some of the existing "high level" plugins. For more detailed information about all of the plugins and their configuration take a look at the manual pages of each plugin.

These "high level" plugins represent complex applications that can be easily and seamlessly integrated into your web site.

There are also "low level" plugins, which perform rather basic tasks and will be used to add some logic to the presentation/templates.

If the existing plugins don't offer the funktionality you need, you usually would implement your own application logic as a plugin.

"HIGH LEVEL" PLUGINS: APPLICATIONS

Almost any "high level" plugin currently uses a (MySQL) DBI backend and some templates for the output.

The table definitions as well as the default templates are stored at the end of each plugin module and can be automatically created for your website using the autoinstallation feature.

You can adjust the path to the templates and the database settings as described in the plugin and backend module documentation.

This is just a very short introduction into the described plugins and you are encouraged to take a closer look at the specific documentation for each plugin, which is linked for each plugin.

blog

blog: Konstrukt blogging engine. A simple blog plugin offering wiki markup, tagging and RSS-export.

Usage:

        <& blog / &>
        

bookmarks

bookmarks: Bookmark management (for registered users). Bookmarks can be organized by registered users in a folder structure. Private and public bookmarks. Public ones can be viewed by every visitor.

Usage:

        <& bookmarks / &>

Result:

A tree of the bookmarks.

browserstats

browserstats: Browser statistics plugin.

Usage:

        <!-- add browser request to the db -->
        <& browserstats / &>

or

        <!-- display the overall top browsers -->
        <& browserstats show="all" / &>

or

        <!-- display the top browsers grouped by year -->
        <!-- month and day will also work, if the data is stored in such a fine granularity -->
        <!-- the display aggregation should not be finer than the setting browserstats/aggregate -->
        <& browserstats show="year" / &>
        

Result:

A table displaying the statistics, if the attribute show is set. Nothing otherwise.

calendar

calendar: Management of private and public calendar items (for registered users). Including RSS-export

Usage:

        <& calendar / &>
        

errors

errors: Display the error messages that occured during the page processing.

Usage:

        <& errors / &>

Result:

A list of the errors, that occurred during the processing of the file, if any.

guestbook

guestbook: Konstrukt guestbook. Plain simple guestbook with multipage view and admin features.

Usage:

        <& guestbook / &>

hitstats

hitstats: Hit statistics plugin. Collect and display/sort/order hit statistics.

Usage:

        <!-- count hit. use the current filename as title -->
        <& hitstats / &>
        
        <!-- display the overall top sites -->
        <& hitstats show="all" / &>
        
        <!-- many more options. see plugin doc -->

log

log: Konstrukt logging facilities. Log important web site events like user registration.

Usage:

        <!-- add a log entry.
             key1-5 are optional. -->
        <& log
        action="put" 
      type="login"
      description="user 'foo' logged in"
      key1="some additional info"
      key2="some additional info"
      key3="some additional info"
      key4="some additional info"
      key5="some additional info"
   / &>
   
   <!-- display log entries -->
   <& log
      type="log type"
      keycount="number of additional keys to display"
      orderby="column"
      limit="42"
   / &>

usermanagement

usermanagement: User management. Extensible with plugins. Current plugins are basic, level and personal, which provide basic user management (register, login, ...), user level management (for access control) and personal data (name, email, ...).

Usage:

        <!-- example for a page for basic user management -->
        <& usermanagement::basic show="login, register, sendpass, changepass" / &>
        
        <!-- user level management -->
        <!-- Show the level of the current user. May be useful in conditional templates. -->
        <& usermanagement::level show="level" / &>
        <!-- Show a list of all users and forms to change each user's level -->
        <& usermanagement::level show="users" / &>
        
        <!-- personal info/management -->
        <& usermanagement plugin="personal" / &>

wiki

wiki: Plugin to convert wiki markup and manage wiki content. Extensible with plugins for markup and content. Currently supports articles, images and files as content. You may also be interested in the syntax reference.

Usage:

        <& wiki &>
        = Headline
        
        some text
        <& / &>
        
        <& wiki page="FooBar" / &>

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

Next: Konstrukt::Doc::CreatingPlugins

Previous: Konstrukt::Doc::FunctionPlugins

Parent: Konstrukt::Doc

See also: Konstrukt::Doc::PluginList