org.howardism.ant
Interface Text2HTMLPlugin

All Known Implementing Classes:

DefaultPlugin, MarkdownPlugin, TextilePlugin

public interface Text2HTMLPlugin

This defines the plugin interface for template engine wrappers for the WebTemplate Ant task.

Method Summary

void	convert(java.io.File srcFile, java.io.File destFile) Converts a single text-formatted file to an HTML-formatted file.
void	setParent(org.apache.tools.ant.Task parent) Allows the Text2HTML task to pass the plugin a reference to the Parent (the caller) so that it can send it log messages.
void	setScript(java.lang.String script) Optionally called if there is a "script" parameter.

Method Detail

convert

public void convert(java.io.File srcFile,
                    java.io.File destFile)
             throws org.apache.tools.ant.BuildException

Converts a single text-formatted file to an HTML-formatted file.

The parameters include the source data file and the destination file where the resulting converted file will be written by this method.

Parameters:

srcFile - name of the input file.

destFile - name of the destination file.

Throws:

org.apache.tools.ant.BuildException

setParent

public void setParent(org.apache.tools.ant.Task parent)

Allows the Text2HTML task to pass the plugin a reference to the Parent (the caller) so that it can send it log messages.

Parameters:

parent -

setScript

public void setScript(java.lang.String script)

Optionally called if there is a "script" parameter.

Parameters:

script -