Chirpy! 0.3 API Documentation
Chirpy::UI::WebApp - User interface class to use Chirpy! as a Web application
Apart from a proper Chirpy! installation, this module requires the following Perl modules:
HTML::Template HTTP::Date URI::Escape
This module uses the following values from your configuration file:
The name of the site's webmaster.
The e-mail address of the site's webmaster.
The base URL of the web site, i.e. the path to index.cgi, without the trailing forward slash.
The base URL of the path where resources, i.e. publicly available files used by the output pages, are stored, again without the trailing forward slash.
The identifier of the theme to use.
The name of the file that contains the welcome message to display on the home page. Use a path name relative to the base path defined in the
When cookies are set, these two values are used to limit them to the correct domain name and path. For example, if your QDB is located at http://www.mysite.com/myname/qdb, you would enter
To keep track of users' actions, sessions are used. These are kept around for a while if the user is inactive. This value sets how long they should be saved. You can use a number for the expiry time in seconds, or use a number directly followed by one of these suffixes to indicate time units:
m: minutes h: hours d: days M: months y: years
This format was borrowed from CGI.pm.
If you run Chirpy! on an Apache web server that has the
mod_rewritemodule installed, you can set this value to 1 to make URLs short, pretty and easy to remember.
Set this value to 1 to enable the RSS and Atom feeds the module offers.
Apply gzip compression on output if possible.
The captcha provider to use. Either
GD_SecurityImage, depending on which of the corresponding modules are available. Note that captcha providers may offer additional configuration; see Chirpy::UI::WebApp::Captcha::Authen_Captcha and Chirpy::UI::WebApp::Captcha::GD_SecurityImage. If this parameter is not set, captchas will be disabled.
The physical path to the directory where public captcha data is to be stored.
The URL to the captcha path.
The number of seconds between the moment when the captcha was generated and the moment when its code expires.
Automatically turn hyperlinks and e-mail addresses in quotes into hyperlinks.
This module uses the following strings from your locale. Please make sure they are present before using the module.
Brief description of what the start page does, for tooltips and such.
Abbreviated version of Start Page, e.g. Home, for use in compact menus.
Brief description of what a link to the quote is for, for tooltips and such.
Translation of Next Page, for multi-page quote lists.
Translation of Previous Page, for multi-page quote lists.
Translation of Current Page, for a link to the current page in the event log viewer.
Text stating that the page was generated by Chirpy! and informing the user of the number of milliseconds used to do so.
%1%is replaced with the Chirpy! product name and version, linked to the Chirpy! web site,
%2%with the number of milliseconds (without a unit).
Text stating that the page was generated by Chirpy!.
%1%is replaced with the string Chirpy!, possibly with formatting.
Message explaining to the user that, if he would like to modify or remove a quote, the links to do so are available from the quote list.
Question confirming the removal of a quote by entering its ID and stressing that this is not a recommended action.
Message explaining to the user that, if he would like to modify or remove a news item, the links to do so are available from the list of recent news items on the start page.
Message explaining that the session information cookie that Chirpy! tried to store was not accepted by the user's browser and suggesting that he try again after reviewing his cookie settings.
Error message explaining that the connection has timed out while attempting to rate the quote, and asking the user to try again.
The label text for the field where the user fills in the captcha code.
The alternate text for the captcha image.
The title for the tag cloud's slider label, i.e. "Minimum Quotes" followed by a colon.
The prefix for the "Top Quote" microsummary, i.e. "Top Quote" followed by a colon.
The prefix for the "Bottom Quote" microsummary, i.e. "Bottom Quote" followed by a colon.
The prefix for the "Latest Quote" microsummary, i.e. "Latest Quote" followed by a colon.
The prefix for the "Latest Unmoderated Quote" microsummary, i.e. "Latest Unmoderated Quote" followed by a colon.
Split into smaller modules, expose more methods, tons of optimizations.
Tim De Pauw <firstname.lastname@example.org>
Copyright 2005-2007 Tim De Pauw. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.