HTML::WikiConverter::WebApp(3)

NAME
HTML::WikiConverter::WebApp - Web interface to HTML::WikiConverter

SYNOPSIS
Inside the index.cgi instance script (which is included with this distribution):

  #!/usr/bin/perl
  use HTML::WikiConverter::WebApp;

  my %config = (
    template_path => '/path/to/web/templates',
  );

  HTML::WikiConverter::WebApp->new( PARAMS => \%config )->run;

DESCRIPTION
This module provides a CGI::Application interface to HTML::WikiConverter and all installed dialect modules.

Refer to the INSTALL file for installation instructions.

QUERY PARAMETERS
This application accepts a number of query parameters to control its behavior. The most basic is the run mode parameter, "m". This application can be in one of two run modes: "new" or "convert". (These correspond to the new_page() and output_page() methods, respectively.) "new" causes a new page to be displayed, while "convert" displays the results of html-to-wiki conversion.

Additional query parameters can be passed independent of run mode:

•   source_type

    One of "raw_html", "from_uri", or "sample_html".

•   dialect

    Any installed dialect, eg "MediaWiki".

•   base_uri

    Base URL to be used for converting relative links to absolute ones.

•   wiki_uri

    Template for wiki URLs. When scanning the HTML source, if a URL (as in an "a href" or "img src" attribute value) is found matching this template, it will be treated to a link to a wiki article/image. Consult "ATTRIBUTES" in HTML::WikiConverter for more information.

    Note that this is a bit less flexible than using the "wiki_uri" attribute directly in HTML::WikiConverter. That attribute allows multiple templates, allows coderefs, and regexps, etc. This option only accepts a single scalar representing a very simple wiki URL template.

•   show_parsed_html

    If enabled, an additional textarea containing the parsed HTML will be displayed.

•   escape_entities

    If enabled, unsafe HTML entities ("<", ">", and "&") will be encoded using HTML::Entities.

•   format

    One of "html" or "xml". Determines the type of output displayed by this application.

METHODS

  setup
Sets up the app for CGI::Application.

  new_page
Corresponds to the "new" run mode. Returns a blank form. If arguments are available on the CGI query string, these are used as default values for the form fields.

  output_page
Corresponds to the "convert" run mode. Same as new_page() but returns the wiki markup for the provided html as well.

  load_template
Loads the specified HTML::Template template.

  display_error
Error-catching method called by CGI::Application if a run mode fails for any reason. Displays a basic form with a styled error message up top.

AUTHOR
David J. Iberri, "<diberri at cpan.org>"

BUGS
Please report any bugs or feature requests to "bug-html-wikiconverter at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=HTML-WikiConverter>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT
You can find documentation for this module with the perldoc command.

  perldoc HTML::WikiConverter::WebApp

You can also look for information at:

•   AnnoCPAN: Annotated CPAN documentation

    <http://annocpan.org/dist/HTML-WikiConverter-WebApp>

•   CPAN Ratings

    <http://cpanratings.perl.org/d/HTML-WikiConverter-WebApp>

•   RT: CPAN's request tracker

    <http://rt.cpan.org/NoAuth/Bugs.html?Dist=HTML-WikiConverter-WebApp>

•   Search CPAN

    <http://search.cpan.org/dist/HTML-WikiConverter-WebApp>

COPYRIGHT & LICENSE
Copyright (c) David J. Iberri, all rights reserved.

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