info.bliki.wiki.template
Interface ITemplateFunction

All Known Implementing Classes:

AbstractTemplateFunction, If, Ifeq

public interface ITemplateFunction

Interface for a template parser function (i.e. {{ #if: ... }} )

Method Summary

java.lang.String	getFunctionDoc() Return a short description of the implemented template function
java.lang.String	parseFunction(char[] src, int beginIndex, int endIndex, IWikiModel model) Parse a template function (like for example {{ #if: ... }}) The result is also a text string in Wikipedia syntax notation which will be parsed again (recursively) in the TemplateParser step.

Method Detail

parseFunction

java.lang.String parseFunction(char[] src,
                               int beginIndex,
                               int endIndex,
                               IWikiModel model)

Parse a template function (like for example {{ #if: ... }}) The result is also a text string in Wikipedia syntax notation which will be parsed again (recursively) in the TemplateParser step.

Parameters:

src - the array of the current Wikipedia source text

beginIndex - the beginning index, inclusive.

endIndex - the ending index, exclusive.

model - the wiki model

Returns:

the result string of this template function or null if the parsing fails or isn't valid

See Also:

TemplateParser#parseTemplate(StringBuffer)

getFunctionDoc

java.lang.String getFunctionDoc()

Return a short description of the implemented template function

Returns: