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


IkiWiki-Plugin-syntax documentation  | view source Contained in the IkiWiki-Plugin-syntax distribution.

Index


NAME

Top

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

VERSION

Top

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

SYNOPSIS

Top

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

DESCRIPTION

Top

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

SUBROUTINES/METHODS

Top

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

Top

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

CONFIGURATION AND ENVIRONMENT

Top

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

Top

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

Top

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

Top

There are no known bugs in this module. Please report problems to <Maintainer name(s)> (<contact address>). Patches are welcome.

AUTHOR

Top

Víctor Moral <victor@taquiones.net>

LICENSE AND COPYRIGHT

Top


IkiWiki-Plugin-syntax documentation  | view source Contained in the IkiWiki-Plugin-syntax distribution.