Ricardo SIGNES > Pod-Elemental-Transfomer-VimHTML > Pod::Elemental::Transformer::VimHTML

Download:
Pod-Elemental-Transfomer-VimHTML-0.093581.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.093581   Source  

NAME ^

Pod::Elemental::Transformer::VimHTML - convert "=begin vim" regions to colorized XHTML with Vim

VERSION ^

version 0.093581

DESCRIPTION ^

This transformer, based on Pod::Elemental::Transformer::SynHi, looks for regions like this:

  =begin vim lisp

    (map (stuff (lisp-has-lots-of '(,parens right))))

  =end vim

...into syntax-highlighted HTML that I can't really usefully represent here. It uses Text::VimColor, so you can read more about the kind of HTML it will produce, there. The parameter after "=begin vim" is used as the filetype.

This form is also accepted, in a verbatim paragraph:

  #!vim lisp
  (map (stuff (lisp-has-lots-of '(,parens right))))

In the above example, the shebang-like line will be stripped. The filetype parameter is mandatory.

The format_name attribute may be supplied during the construction of the transformer to look for a region other than vim.

AUTHOR ^

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by Ricardo SIGNES.

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

syntax highlighting: