cgi::pretty(3pm) [osx man page]

CGI::Pretty(3pm)					 Perl Programmers Reference Guide					  CGI::Pretty(3pm)

NAME

       CGI::Pretty - module to produce nicely formatted HTML code

SYNOPSIS

	   use CGI::Pretty qw( :html3 );

	   # Print a table with a single data element
	   print table( TR( td( "foo" ) ) );

DESCRIPTION

       CGI::Pretty is a module that derives from CGI.  It's sole function is to allow users of CGI to output nicely formatted HTML code.

       When using the CGI module, the following code:
	   print table( TR( td( "foo" ) ) );

       produces the following output:
	   <TABLE><TR><TD>foo</TD></TR></TABLE>

       If a user were to create a table consisting of many rows and many columns, the resultant HTML code would be quite difficult to read since
       it has no carriage returns or indentation.

       CGI::Pretty fixes this problem.	What it does is add a carriage return and indentation to the HTML code so that one can easily read it.

	   print table( TR( td( "foo" ) ) );

       now produces the following output:
	   <TABLE>
	      <TR>
		 <TD>foo</TD>
	      </TR>
	   </TABLE>

   Recommendation for when to use CGI::Pretty
       CGI::Pretty is far slower than using CGI.pm directly. A benchmark showed that it could be about 10 times slower. Adding newlines and spaces
       may alter the rendered appearance of HTML. Also, the extra newlines and spaces also make the file size larger, making the files take longer
       to download.

       With all those considerations, it is recommended that CGI::Pretty be used primarily for debugging.

   Tags that won't be formatted
       The following tags are not formatted: <a>, <pre>, <code>, <script>, <textarea>, and <td>.  If these tags were formatted, the user would see
       the extra indentation on the web browser causing the page to look different than what would be expected.  If you wish to add more tags to
       the list of tags that are not to be touched, push them onto the @AS_IS array:

	   push @CGI::Pretty::AS_IS,qw(XMP);

   Customizing the Indenting
       If you wish to have your own personal style of indenting, you can change the $INDENT variable:

	   $CGI::Pretty::INDENT = "		";

       would cause the indents to be two tabs.

       Similarly, if you wish to have more space between lines, you may change the $LINEBREAK variable:

	   $CGI::Pretty::LINEBREAK = "

";

       would create two carriage returns between lines.

       If you decide you want to use the regular CGI indenting, you can easily do the following:

	   $CGI::Pretty::INDENT = $CGI::Pretty::LINEBREAK = "";

AUTHOR

       Brian Paulsen <Brian@ThePaulsens.com>, with minor modifications by Lincoln Stein <lstein@cshl.org> for incorporation into the CGI.pm
       distribution.

       Copyright 1999, Brian Paulsen.  All rights reserved.

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

       Bug reports and comments to Brian@ThePaulsens.com.  You can also write to lstein@cshl.org, but this code looks pretty hairy to me and I'm
       not sure I understand it!

SEE ALSO

       CGI

perl v5.16.2							    2012-10-11							  CGI::Pretty(3pm)

Check Out this Related Man Page

CGI::Emulate::PSGI(3pm) 				User Contributed Perl Documentation				   CGI::Emulate::PSGI(3pm)

NAME

       CGI::Emulate::PSGI - PSGI adapter for CGI

SYNOPSIS

	   my $app = CGI::Emulate::PSGI->handler(sub {
	       # Existing CGI code
	   });

DESCRIPTION

       This module allows an application designed for the CGI environment to run in a PSGI environment, and thus on any of the backends that PSGI
       supports.

       It works by translating the environment provided by the PSGI specification to one expected by the CGI specification. Likewise, it captures
       output as it would be prepared for the CGI standard, and translates it to the format expected for the PSGI standard using CGI::Parse::PSGI
       module.

CGI.pm
       If your application uses CGI, be sure to cleanup the global variables in the handler loop yourself, so:

	   my $app = CGI::Emulate::PSGI->handler(sub {
	       use CGI;
	       CGI::initialize_globals();
	       my $q = CGI->new;
	       # ...
	   });

       Otherwise previous request variables will be reused in the new requests.

       Alternatively, you can install and use CGI::Compile from CPAN and compiles your existing CGI scripts into a sub that is perfectly ready to
       be converted to PSGI application using this module.

	 my $sub = CGI::Compile->compile("/path/to/script.cgi");
	 my $app = CGI::Emulate::PSGI->handler($sub);

       This will take care of assigning an unique namespace for each script etc. See CGI::Compile for details.

       You can also consider using CGI::PSGI but that would require you to slightly change your code from:

	 my $q = CGI->new;
	 # ...
	 print $q->header, $output;

       into:

	 use CGI::PSGI;

	 my $app = sub {
	     my $env = shift;
	     my $q = CGI::PSGI->new($env);
	     # ...
	     return [ $q->psgi_header, [ $output ] ];
	 };

       See CGI::PSGI for details.

METHODS

       handler
	     my $app = CGI::Emulate::PSGI->handler($code);

	   Creates a PSGI application code reference out of CGI code reference.

       emulate_environment
	     my %env = CGI::Emulate::PSGI->emulate_environment($env);

	   Creates an environment hash out of PSGI environment hash. If your code or framework just needs an environment variable emulation, use
	   this method like:

	     local %ENV = (%ENV, CGI::Emulate::PSGI->emulate_environment($env));
	     # run your application

	   If you use "handler" method to create a PSGI environment hash, this is automatically called in the created application.

AUTHOR

       Tokuhiro Matsuno <tokuhirom@cpan.org>

       Tatsuhiko Miyagawa

COPYRIGHT AND LICENSE

       Copyright (c) 2009-2010 by tokuhirom.

       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.

SEE ALSO

       PSGI CGI::Compile CGI::PSGI Plack CGI::Parse::PSGI

perl v5.14.2							    2012-03-18						   CGI::Emulate::PSGI(3pm)

Linux and UNIX Man Pages

cgi::pretty(3pm) [osx man page]

Check Out this Related Man Page