info.bliki.wiki.template

Interface ITemplateFunction

All Known Implementing Classes:

AbstractTemplateFunction, Allmacros, Anchorencode, DollarContext, Expr, FormatDate, Formatnum, Fullurl, If, Ifeq, Iferror, Ifexist, Ifexpr, Invoke, LC, LCFirst, Localurl, NS, NSE, Padleft, Padright, Plural, Safesubst, Subst, Switch, Tag, Time, Titleparts, UC, UCFirst, URLEncode

public interface ITemplateFunction

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

Method Summary

Modifier and Type	Method and Description
String	getFunctionDoc() Return a short description of the implemented template function
String	parseFunction(List<String> parts, IWikiModel model, char[] src, int beginIndex, int endIndex, boolean isSubst) Parse a template function (like for example {{ #if: ...

Method Detail

parseFunction

String parseFunction(List<String> parts,
                     IWikiModel model,
                     char[] src,
                     int beginIndex,
                     int endIndex,
                     boolean isSubst)
              throws IOException

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:

parts - the parser function arguments (extracted from the wiki text by splitting the string at the pipe symbol ´|´)

model - the wiki model

src - the array of the current Wikipedia source text.

beginIndex - the beginning index, inclusive.

endIndex - the ending index, exclusive.

isSubst - if true the template function was called from subst or safesubst function and the arguments of the function are typically not parsed recursively.

Returns:

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

Throws:

IOException

See Also:

TemplateParser#parseTemplate(StringBuffer)

getFunctionDoc

String getFunctionDoc()

Return a short description of the implemented template function

Returns: