Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

ppi::html(3pm) [debian man page]

PPI::HTML(3pm)						User Contributed Perl Documentation					    PPI::HTML(3pm)

NAME

       PPI::HTML - Generate syntax-hightlighted HTML for Perl using PPI

SYNOPSIS

	 use PPI;
	 use PPI::HTML;

	 # Load your Perl file
	 my $Document = PPI::Document->load( 'script.pl' );

	 # Create a reusable syntax highlighter
	 my $Highlight = PPI::HTML->new( line_numbers => 1 );

	 # Spit out the HTML
	 print $Highlight->html( $Document );

DESCRIPTION

       PPI::HTML converts Perl documents into syntax highlighted HTML pages.

HISTORY

       PPI::HTML is the successor to the now-redundant PPI::Format::HTML.

       While early on it was thought that the same formatting code might be able to be used for a variety of different types of things (ANSI and
       HTML for example) later developments with the here-doc code and the need for independantly written serializers meant that this idea had to
       be discarded.

       In addition, the old module only made use of the Tokenizer, and had a pretty shit API to boot.

   API Overview
       The new module is much cleaner. Simply create an object with the options you want, pass PPI::Document objects to the "html" method, and you
       get strings of HTML that you can do whatever you want with.

METHODS

   new %args
       The "new" constructor takes a simple set of key/value pairs to define the formatting options for the HTML.

       page
	   Is the "page" option is enabled, the generator will wrap the generated HTML fragment in a basic but complete page.

       line_numbers
	   At the present time, the only option available. If set to true, line numbers are added to the output.

       colors | colours
	   For cases where you don't want to use an external stylesheet, you can provide "colors" as a hash reference where the keys are CSS
	   classes (generally matching the token name) and the values are colours.

	   This allows basic colouring without the need for a whole stylesheet.

       css The "css" option lets you provide a custom CSS::Tiny object containing any CSS you want to apply to the page (if you are using page
	   mode).

	   If both the "colors" and "css" options are used, the colour CSS entries will overwrite anything contained in the CSS::Tiny object. The
	   object will also be cloned if it to be modified, to prevent destroying any CSS objects passed in.

       Returns a new PPI::HTML object

   css
       The "css" accessor returns the CSS::Tiny object originally provided to the constructor.

   html $Document | $file | $source
       The main method for the class, the "html" method takes a single PPI::Document object, or anything that can be turned into a PPI::Document
       via its "new" method, and returns a string of HTML formatted based on the arguments given to the "PPI::HTML" constructor.

       Returns a string, or "undef" on error.

SUPPORT

       Bugs should always be submitted via the CPAN bug tracker

       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=PPI-HTML>

       For other issues, contact the maintainer

AUTHOR

       Adam Kennedy <adamk@cpan.org>

       Funding provided by The Perl Foundation

SEE ALSO

       <http://ali.as/>, PPI

COPYRIGHT

       Copyright 2005 - 2009 Adam Kennedy.

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

       The full text of the license can be found in the LICENSE file included with this module.

perl v5.10.1							    2009-11-16							    PPI::HTML(3pm)

Check Out this Related Man Page

PPI::Document::Normalized(3pm)				User Contributed Perl Documentation			    PPI::Document::Normalized(3pm)

NAME

       PPI::Document::Normalized - A normalized Perl Document

DESCRIPTION

       A "Normalized Document" object is the result of the normalization process contained in the PPI::Normal class. See the documentation for
       PPI::Normal for more information.

       The object contains a version stamp and function list for the version of PPI::Normal used to create it, and a processed and delinked
       PPI::Document object.

       Typically, the Document object will have been mangled by the normalization process in a way that would make it fatal to try to actually DO
       anything with it.

       Put simply, never use the Document object after normalization.  YOU HAVE BEEN WARNED!

       The object is designed the way it is to provide a bias towards false negatives. A comparison between two ::Normalized object will only
       return true if they were produced by the same version of PPI::Normal, with the same set of normalization functions (in the same order).

       You may get false negatives if you are caching objects across an upgrade.

       Please note that this is done for security purposes, as there are many cases in which low layer normalization is likely to be done as part
       of a code security process, and false positives could be highly dangerous.

METHODS

   new
       The "new" method is intended for use only by the PPI::Normal class, and to get ::Normalized objects, you are highly recommended to use
       either that module, or the "normalized" method of the PPI::Document object itself.

   version
       The "version" accessor returns the PPI::Normal version used to create the object.

   functions
       The "functions" accessor returns a reference to an array of the normalization functions (in order) that were called when creating the
       object.

   equal $Normalized
       The "equal" method is the primary comparison method, taking another PPI::Document::Normalized object, and checking for equivalence to it.

       The "==" operator is also overload to this method, so that you can do something like the following:

	 my $first  = PPI::Document->load('first.pl');
	 my $second = PPI::Document->load('second.pl');

	 if ( $first->normalized == $second->normalized ) {
	       print "The two documents are equivalent";
	 }

       Returns true if the normalized documents are equivalent, false if not, or "undef" if there is an error.

SUPPORT

       See the support section in the main module.

AUTHOR

       Adam Kennedy <adamk@cpan.org>

COPYRIGHT

       Copyright 2005 - 2011 Adam Kennedy.

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

       The full text of the license can be found in the LICENSE file included with this module.

perl v5.10.1							    2011-02-26					    PPI::Document::Normalized(3pm)
Man Page