Víctor Moral > IkiWiki-Plugin-syntax-0.25 > IkiWiki::Plugin::syntax::Vim

Download:
IkiWiki-Plugin-syntax-0.25.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.2   Source  

NAME ^

IkiWiki::Plugin::syntax::Vim - Uses Text::VimColor for syntax highlight in IkiWiki

VERSION ^

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

SYNOPSIS ^

This module is used internally for IkiWiki::Plugin::syntax.

DESCRIPTION ^

See the IkiWiki::Plugin::syntax for examples of use.

SUBROUTINES/METHODS ^

can_syntax_from( language|filename|content => value )

Return a true value if the module can work with the parameters passed to.

proposed

Check if Vim has a syntax file for the proposed language.

filename

Check if Vim has a syntax file for the filename extension.

contents

Check if Vim can determine the source language.

parse_and_html( )

Do the real work of parse the source and htmlized using the Vim editor and the Text::VimColor module.

build_plugin_info( )

Returns a hash with information about the plugin capabilities.

DIAGNOSTICS ^

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

CONFIGURATION AND ENVIRONMENT ^

A full explanation of any configuration system(s) used by the module, including the names and locations of any configuration files, and the meaning of any environment variables or properties that can be set. These descriptions must also include details of any configuration language used.

DEPENDENCIES ^

A list of all the other modules that this module relies upon, including any restrictions on versions, and an indication of whether these required modules are part of the standard Perl distribution, part of the module's distribution, or must be installed separately.

INCOMPATIBILITIES ^

A list of any modules that this module cannot be used in conjunction with. This may be due to name conflicts in the interface, or competition for system or program resources, or due to internal limitations of Perl (for example, many modules that use source code filters are mutually incompatible).

BUGS AND LIMITATIONS ^

There are no known bugs in this module. Please report problems to <Maintainer name(s)> (<contact address>). 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

syntax highlighting: