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::File(3)					User Contributed Perl Documentation				    PPI::Document::File(3)

NAME

       PPI::Document::File - A Perl Document located in a specific file

DESCRIPTION

       WARNING: This class is experimental, and may change without notice

       PPI::Document::File provides a PPI::Document subclass that represents a Perl document stored in a specific named file.

METHODS

   new
	 my $file = PPI::Document::File->new( 'Module.pm' );

       The "new" constructor works the same as for the regular one, except that the only params allowed is a file name. You cannot create an
       "anonymous" PPI::Document::File object, not can you create an empty one.

       Returns a new PPI::Document::File object, or "undef" on error.

   filename
       The "filename" accessor returns the name of the file in which the document is stored.

   save
	 # Save to the file we were loaded from
	 $file->save;

	 # Save a copy to somewhere else
	 $file->save( 'Module2.pm' );

       The "save" method works similarly to the one in the parent PPI::Document class, saving a copy of the document to a file.

       The difference with this subclass is that if "save" is not passed any filename, it will save it back to the file it was loaded from.

       Note: When saving to a different file, it is considered to be saving a copy and so the value returned by the "filename" accessor will stay
       the same, and not change to the new filename.

TO DO

       - May need to overload some methods to forcefully prevent Document objects becoming children of another Node.

SUPPORT

       See the support section in the main module.

AUTHOR

       Adam Kennedy <adamk@cpan.org>

COPYRIGHT

       Copyright 2001 - 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.18.2							    2011-02-25						    PPI::Document::File(3)
Man Page