Kwiki::DatedAnnounce - Create a date sensitive section of output

Kwiki-DatedAnnounce documentation Contained in the Kwiki-DatedAnnounce distribution.

Index

Code Index:

NAME

Top

Kwiki::DatedAnnounce - Create a date sensitive section of output

SYNOPSIS

Top

 $ cd /path/to/kwiki
 $ kwiki -install Kwiki::DatedAnnounce

DESCRIPTION

Top

This module allows you to wrap a section of wikitext to be displayed only after a certain time for an optional number of seconds. For example:

    .dated
    datespec: 1095056602 172800

    Hello, it's around Monday, September 13, 2004.
    .dated

datespec is two numbers representing the number of seconds since the epoch and a duration in seconds. Duration defaults to zero if none is provided. Zero means infinite duration. If the time of the current display is within the window described by the datespec, the content will be displayed.

CREDITS

Top

This was my first plugin, trying to figure out what was going on. I've pulled it out of the dusty corners to make it go with Kwiki::Test

AUTHORS

Top

Chris Dent <cdent@burningchrome.com>

Based on Ian Langworth's Kwiki::VimMode

SEE ALSO

Top

Kwiki

COPYRIGHT AND LICENSE

Top

Copyright (C) 2005 by Chris Dent

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Kwiki-DatedAnnounce documentation Contained in the Kwiki-DatedAnnounce distribution. 
package Kwiki::DatedAnnounce;
use strict;
use warnings;
use Kwiki::Plugin '-Base';
use Kwiki::Installer '-base';

our $VERSION = 0.01;

const class_title => 'Dated Announced';
const class_id => 'dated_announce';
const css_file => 'dated_announce.css';

sub register {
    my $registry = shift;
    $registry->add(wafl => dated => 'Kwiki::DatedAnnounce::Wafl');
}

package Kwiki::DatedAnnounce::Wafl;
use base 'Spoon::Formatter::WaflBlock';

sub to_html {
    my $string = $self->block_text;
    chomp $string;
    # XXX datespec should be better than epoch
    $string =~ s/^ datespec: \s* (\w+) \s* (\w+) \s* \n+//sx;

    my $datespec = $1 || 0;
    my $duration = $2 || 0;
    my $now = time;
    
    if (($now >= $datespec) &&
        (($duration == 0) || ($now <= $datespec + $duration))) {
           return "<div class='dated'>\n" .
                  $self->hub->formatter->text_to_html($string) .
                  "</div>\n";
    } else {
        return "\n";
    }
}

package Kwiki::DatedAnnounce;
1;

__DATA__


__css/dated_announce.css__
div.dated { background: #dddddd; }