From: octo Date: Sat, 16 Apr 2005 08:07:44 +0000 (+0000) Subject: Added POD to Onis::Html X-Git-Tag: Release-0.8.0~15 X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=c90451bd43b653503cddf07047ab72c25f826b65;p=onis.git Added POD to Onis::Html --- diff --git a/lib/Onis/Config.pm b/lib/Onis/Config.pm index e03d2a3..5ec2cc6 100644 --- a/lib/Onis/Config.pm +++ b/lib/Onis/Config.pm @@ -73,7 +73,7 @@ commas: our $config = {}; -my $VERSION = '$Id: Config.pm,v 1.10 2004/09/16 10:30:00 octo Exp $'; +my $VERSION = '$Id$'; print STDERR $/, __FILE__, ": $VERSION" if ($::DEBUG); return (1); diff --git a/lib/Onis/Html.pm b/lib/Onis/Html.pm index 077138d..5a06e2f 100644 --- a/lib/Onis/Html.pm +++ b/lib/Onis/Html.pm @@ -8,15 +8,31 @@ use Onis::Config qw/get_config/; use Onis::Language qw/translate/; use Onis::Data::Core qw#get_channel get_total_lines#; +=head1 NAME + +Onis::Html - Low level page generation stuff.. + +=cut + @Onis::Html::EXPORT_OK = qw/open_file close_file get_filehandle html_escape/; @Onis::Html::ISA = ('Exporter'); our $fh; our $time_start = time (); -our $WANT_COLOR = 0; -our $PUBLIC_PAGE = 1; +=head1 CONFIGURATION OPTIONS + +=over 4 +=item B: I; + +Wether or not to print the color codes (introduced by mIRC, used by idiots and +ignored by the rest) in the generated HTML-file. Of course this defaults to not +print the codes.. + +=cut + +our $WantColor = 0; if (get_config ('color_codes')) { my $temp = get_config ('color_codes'); @@ -24,34 +40,110 @@ if (get_config ('color_codes')) or ($temp eq 'yes') or ($temp eq 'on')) { - $WANT_COLOR = 1; + $WantColor = 1; } } + +=item B: I; + +Wether or not this is a public page. Public pages may be linked on the onis +homepage at some point in the fututre.. + +=cut + +our $PublicPage = 1; if (get_config ('public_page')) { my $temp = get_config ('public_page'); if ($temp =~ m/false|off|no/i) { - $PUBLIC_PAGE = 0; + $PublicPage = 0; } } +=item B: I; + +Sets the stylesheet to use. This is included in the HTML-file as-is, so you +have to take care of absolute/relative paths yourself.. + +=cut + +our $Stylesheet = 'style.css'; +if (get_config ('stylesheet')) +{ + $Stylesheet = get_config ('stylesheet'); +} + +=item B: I; + +Sets the encoding to include in the HTML-file. If you don't know what this is, +don't change it.. + +=cut + +our $Encoding = 'iso-8859-1'; +if (get_config ('encoding')) +{ + $Encoding = get_config ('encoding'); +} + +=item B: I; + +Sets the user that created the page. Defaults to the environment variable +B or "onis", if it is not set. + +=cut + +our $User = 'onis'; +if (get_config ('user')) +{ + $User = get_config ('user'); +} +elsif (defined ($ENV{'USER'})) +{ + $User = $ENV{'USER'}; +} + +=back + +=cut + # `orange' is not a plain html name. # The color we want is #FFA500 our @mirc_colors = qw/white black navy green red maroon purple orange yellow lime teal aqua blue fuchsia gray silver/; -my $VERSION = '$Id: Html.pm,v 1.20 2004/09/16 10:30:20 octo Exp $'; +my $VERSION = '$Id$'; print STDERR $/, __FILE__, ": $VERSION" if ($::DEBUG); return (1); +=head1 EXPORTED FUNCTIONS + +=over 4 + +=item B () + +Returns the filehandle of the output file or undef, if B has not +been called yet. + +=cut + sub get_filehandle { return ($fh); } +=item B (I<$filename>) + +Opens the file I<$filename> if no file is open at this point. The file is +exclusively locked and the filehandle stored in the module. The HTML-header is +printed to the file and the filehandle is returned. You can get another +reference by calling B. + +=cut + sub open_file { my $file = shift; @@ -87,28 +179,6 @@ sub print_head my $generated_time = scalar (localtime ($time_start)); my $trans; - my $stylesheet = 'style.css'; - if (get_config ('stylesheet')) - { - $stylesheet = get_config ('stylesheet'); - } - - my $encoding = 'iso-8859-1'; - if (get_config ('encoding')) - { - $encoding = get_config ('encoding'); - } - - my $user = 'onis'; - if (get_config ('user')) - { - $user = get_config ('user'); - } - elsif (defined ($ENV{'USER'})) - { - $user = $ENV{'USER'}; - } - my $channel = get_channel (); my @images = get_config ('horizontal_images'); @@ -118,11 +188,11 @@ sub print_head } $trans = translate ('%s statistics created by %s'); - my $title = sprintf ($trans, $channel, $user); + my $title = sprintf ($trans, $channel, $User); print $fh < + @@ -130,7 +200,7 @@ sub print_head $title - + @@ -139,7 +209,7 @@ sub print_head EOF $trans = translate ('%s stats by %s'); - $title = sprintf ($trans, $channel, $user); + $title = sprintf ($trans, $channel, $User); $trans = translate ('Statistics generated on %s'); my $time_msg = sprintf ($trans, $generated_time); @@ -162,11 +232,14 @@ EOF EOF } -# this routine adds a box to the end of the html- -# page with onis' homepage URL, the author's name -# and email-address. Feel free to uncomment the -# creation of this box if it's appereance nags -# you.. +=item B () + +Closes the previously opened file. Before it does that though it writed the +HTML-footer which contains some information about onis and closes all HTML-tags +opened by B. + +=cut + sub close_file { my $runtime = time () - $time_start; @@ -202,7 +275,7 @@ EOF printf $fh ($stats, $lines_this_time, $runtime, $lps, $total_lines); print $fh qq#\n \n \n #; printf $fh ($by, '2000-2005', 'Florian octo Forster <octo@nospam.verplant.org>'); - print $fh qq## if ($PUBLIC_PAGE); + print $fh qq## if ($PublicPage); print $fh "
\n "; printf $fh ($link, sprintf (qq#%s#, $hp)); @@ -217,6 +290,10 @@ EOF EOF } +=back + +=cut + sub html_escape { my @retval = (); @@ -297,7 +374,7 @@ sub escape_normal $text =~ s/Ö/\Ü/g; $text =~ s/ß/\ß/g; - if ($WANT_COLOR) + if ($WantColor) { $text = find_colors ($text); } @@ -429,3 +506,9 @@ sub find_colors return ($string); } + +=head1 AUTHOR + +Florian octo Forster Eocto at verplant.orgE + +=cut