new

  my $wc = new HTML::WikiConverter( dialect => $dialect, %attrs );

Returns a converter for the specified wiki dialect. Croaks if $dialect is not provided or its dialect module is not installed on your system. Additional attributes may be specified in %attrs; see "ATTRIBUTES" for a complete list.

html2wiki

  $wiki = $wc->html2wiki( $html, %attrs );
  $wiki = $wc->html2wiki( html => $html, %attrs );
  $wiki = $wc->html2wiki( file => $file, %attrs );
  $wiki = $wc->html2wiki( uri => $uri, %attrs );

Converts HTML source to wiki markup for the current dialect. Accepts either an HTML string $html, an file $file, or a URI <$uri> to read from.

Attributes assigned in %attrs (see "ATTRIBUTES") will augment or override previously assigned attributes for the duration of the "html2wiki()" call.

elem_search_lineage

  my $ancestor = $wc->elem_search_lineage( $node, \%rules );

Searches the lineage of $node and returns the first ancestor node that has rules matching those specified in %rules, or "undef" if no matching node is found.

For example, to find out whether $node has an ancestor with rules matching "{ block =>1 }", one could use:

  if( $wc->elem_search_lineage( $node, { block => 1 } ) ) {
    # do something
  }

given_html

  my $html = $wc->given_html;

Returns the HTML passed to or fetched (ie, from a file or URI) by the last "html2wiki()" method call. Useful for debugging.

parsed_html

  my $parsed_html = $wc->parsed_html;

Returns a string containing the post-processed HTML from the last "html2wiki" call. Post-processing includes parsing by HTML::TreeBuilder, CSS normalization by HTML::WikiConverter::Normalizer, and calls to the "preprocess" and "preprocess_tree" dialect methods.

available_dialects

  my @dialects = HTML::WikiConverter->available_dialects;

Returns a list of all available dialects by searching the directories in @INC for "HTML::WikiConverter::" modules.

rules_for_tag

  my $rules = $wc->rules_for_tag( $tag );

Returns the rules that will be used for converting elements of the given tag. Follows "alias" references. Note that the rules used for a particular tag may depend on the current set of attributes being used.

base_uri

dialect

encoding

escape_entities

p_strict

passthrough_naked_tags

preprocess

slurp

strip_empty_tags

strip_tags

user_agent

wiki_uri

If "wiki_uri" is a string, it is interpreted as a URI template, and it will be assumed that URIs to wiki pages are created by joining "wiki_uri" with the wiki page title. For example, the English Wikipedia might use "http://en.wikipedia.org/wiki/" as the value of "wiki_uri". Ward's wiki might use "http://c2.com/cgi/wiki?". These examples use an absolute "wiki_uri", but a relative URI can be used as well; an absolute URI will be created based on the value of "base_uri". For example, the Wikipedia example above can be rewritten using "base_uri" of "http://en.wikipedia.org" and a "wiki_uri" of "/wiki/".

"wiki_uri" can also be a regexp that matches URIs to wiki pages and also extracts the page title from them. For example, the English Wikipedia might use "qr~http://en\.wikipedia\.org/w/index\.php\?title\=([^&]+)~".

"wiki_uri" can also be a coderef that takes the current "HTML::WikiConverter" object and a URI object. It should return the title of the wiki page extracted from the URI, or "undef" if the URI doesn't represent a link to a wiki page.

As mentioned above, the "wiki_uri" attribute can either take a single URI/regexp/coderef element or it may be assigned a reference to an array of any number of these elements. This is useful for wikis that have different ways of creating links to wiki pages. For example, the English Wikipedia might use:

  my $wc = new HTML::WikiConverter(
    dialect => 'MediaWiki',
    wiki_uri => [
      'http://en.wikipiedia.org/wiki/',
      sub { pop->query_param('title') } # requires URI::QueryParam
    ]
  );

wrap_in_html