---README for "gethtml" plugin version 0.0.1---

This plugin will retrieve a web page, filter the content with a regular expression
and display the result on a topic page.

Note: JDK 1.4 is required (because of the regular expression stuff).

---Installation---
Put gethtml.zip in your {wikihome}/plugins directory and restart the webapp context or the server.

---Usage example---
In a topic enter:
[<gethtml>]
url:{...url to ask...}
regex:{...regular expression...}
param:{...regex parameters...}
keep:{...time to cache this page...}
{...formatting...}
[</gethtml>]

---The parameters---
url: (required)
Enter the full url to ask.

regex: (required)
Enter the regular expression. Look at
http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html
for all the options you have

param: (optional)
Parameters for the regular expression. You can use the constants
defined in
http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html#field_summary

keep: (optional)
The plugin can cache the page for some time. You can either enter the time in
minutes or you can enter a time plus a unit. Supported units are "m" (minutes),
"h" (hours), "d" (days).

formatting: (optional)
If no formatting is given, the last regex-group will be printed. If a format is
given (using HTML), use $1, $2, ... to replace the regex groups.

---Example 1---
Print the latest wiki version number but keep the information cached for
two days.

[<gethtml>]
url:http://veryquickwiki.croninsolutions.com/downloads.html
regex:Latest stable release: ([^<]*)
keep:2d
[</gethtml>]


---Example 2---
Print the changes in the latest wiki version and keep the information
cached for 8 hours. Since the information stretches over several lines,
we have to use the regex parameter DOTALL (so that the dot includes
newline). Since the result is not formatted, we have to use <pre></pre>.

[<gethtml>]
url:http://veryquickwiki.croninsolutions.com/whatsnew.txt
regex:.\..\..(.*?).\..\..
param:DOTALL
keep:8h
Changes in the latest wiki version:<pre>$1</pre>
[</gethtml>]