NAME

IkiWiki::Plugin::syntax::base - Base class for the IkiWiki::Plugin::syntax

VERSION

This documentation refers to IkiWiki::Plugin::syntax::base version 0.1

SYNOPSIS

        package IkiWiki::Plugin::syntax::MyEngine;
    use base qw(IkiWiki::Plugin::syntax::base);

    ...

    1;
    

DESCRIPTION

This module provides a base class for build specialized interfaces to external syntax highlight engines.

SUBROUTINES/METHODS

new( )

Build a new object and initialize his attributes.

Accept the following parameters:

engine

reset_engine( )

    $engine->reset_engine();

This method initialize the syntax highlight engine.

plugin_info( )

Return a hash with information about the syntax highlight module's capabilities.

syntax_highlight( )

This method produces a HTML text with the original source and the CSS tags.

configure( )

parse_and_html( )

normalize_tags( )

to_number_lines( )

to_bar_lines( )

can_syntax_from( )

detect_language( )

fail_response( )

logging( )

plugin_info( )

DIAGNOSTICS

A list of every error and warning message that the module can generate.

BUGS AND LIMITATIONS

There are no known bugs in this module. Please report problems to the author. Patches are welcome.

AUTHOR

Víctor Moral <victor@taquiones.net>

LICENSE AND COPYRIGHT

Copyright (c) 2008 "Víctor Moral" <victor@taquiones.net>

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 US

cpanm IkiWiki::Plugin::syntax

perl -MCPAN -e shell
install IkiWiki::Plugin::syntax