debian man page for syntax::highlight::engine::simple::html

Syntax::Highlight::Engine::Simple::HTML(3pm)		User Contributed Perl Documentation	      Syntax::Highlight::Engine::Simple::HTML(3pm)

NAME
       Syntax::Highlight::Engine::Simple::HTML - (EXPERIMENTAL)HTML code highlighting class

VERSION
       This document describes Syntax::Highlight::Engine::Simple::HTML version 0.2

SYNOPSIS
       Constructor

	       use Syntax::Highlight::Engine::Simple::HTML;

	       $highlighter =
		       Syntax::Highlight::Engine::Simple::HTML->new();

	       or

	       use Syntax::Highlight::Engine::Simple;

	       $highlighter =
		       Syntax::Highlight::Engine::Simple->new(type => 'HTML');

       Highlighting stage

	       $highlighter->doStr(
		       str => $str,
		       tab_width => 4);

	       $highlighter->doFile(
		       file => $name,
		       tab_width => 4,
		       encode => 'utf8');

DESCRIPTION
       This is a subclass of Syntax::Highlight::Engine::Simple.

       A working example of This module is at bellow.

       http://jamadam.com/dev/cpan/demo/Syntax/Highlight/Engine/Simple/

INTERFACE
   new
       type
	   File type. This argument causes specific subclass to be loaded.

   setParams
       html_escape_code_ref
	   HTML escape code ref. Default subroutine escapes 3 characters '&', '<' and '>'.

   appendSyntax
       Append syntax by giving a hash.

	       $highlighter->setSyntax(
		   syntax => {
		       class => 'quote',
		       regexp => "'.*?'",
		       container => 'comment',
		   }
	       );

   doStr
       Highlighting strings.

	       $highlighter->doStr(
		   str => $str,
		   tab_width => 4
	       );

       str String.

       tab_width
	   Tab width for tab-space conversion. -1 for disable it. -1 is the default.

   doFile
       Highlighting files.

	       $highlighter->doStr(
		   file => $name,
		   tab_width => 4,
		   encode => 'utf8'
	       );

       file
	   File name.

       tab_width
	   Tab width for tab-space conversion. -1 to disable it. -1 is the default.

       encode
	   Set the encoding of file. utf8 is the default.

   array2regexp
       This is a utility method for converting string array to regular expression.

   getClassNames
       Returns the class names in array.

   setSyntax
       This is a method for initializing the syntax. It is called by the constructor so you may not have to call it manually.

Example
       Here is a sample of CSS.

	       pre.program_code span.keyword {color: #00f}
	       pre.program_code span.keyword2 {color: #808}
	       pre.program_code span.number {color: #f00}
	       pre.program_code span.identifier {color: #a66}
	       pre.program_code span.function {color: #a66; text-decoration: underline}
	       pre.program_code span.method {color: #a66; text-decoration: underline}
	       pre.program_code span.variable {color: #f80}
	       pre.program_code span.statement {color: #00f}
	       pre.program_code span.comment {color: #080}
	       pre.program_code span.perlpod {color: #080}
	       pre.program_code span.quote {color: #a66}
	       pre.program_code span.wquote {color: #600}
	       pre.program_code span.value {color: #a66}
	       pre.program_code span.regexp_statement {background: #ffa}
	       pre.program_code span.tag {color: #00f}
	       pre.program_code span.url {color: #00f; text-decoration: underline}

DIAGNOSTICS
       "doStr method got undefined value"
       "File open failed"

CONFIGURATION AND ENVIRONMENT
       Syntax::Highlight::Engine::Simple::HTML requires no configuration files or environment variables. Specific language syntax can be defined
       with subclasses and loaded in the constructor if you give it the type argument.

DEPENDENCIES
       UNIVERSAL::require
       Syntax::Highlight::Engine::Simple

INCOMPATIBILITIES
       None reported.

BUGS AND LIMITATIONS
       No bugs have been reported.

       Please report any bugs or feature requests to "bug-syntax-highlight-engine-Simple@rt.cpan.org", or through the web interface at
       <http://rt.cpan.org>.

SEE ALSO
       Syntax::Highlight::Engine::Simple

AUTHOR
       Sugama Keita  "<sugama@jamadam.com>"

LICENCE AND COPYRIGHT
       Copyright (c) 2008, Sugama Keita "<sugama@jamadam.com>". All rights reserved.

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

DISCLAIMER OF WARRANTY
       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
       WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
       EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
       THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF
       ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
       REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
       CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
       RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

perl v5.10.0							    2009-06-06			      Syntax::Highlight::Engine::Simple::HTML(3pm)