info.bliki.wiki.template.extension
Class Allmacros

java.lang.Object
  extended by info.bliki.wiki.template.AbstractTemplateFunction
      extended by info.bliki.wiki.template.extension.Allmacros
All Implemented Interfaces:
ITemplateFunction

public class Allmacros
extends AbstractTemplateFunction

A template parser function for {{ #all_macros: ... }} syntax. The function lists all available template functions documentation. To show the documentation of a function, the ITemplateFunction#getFunctionDoc() must be implemented. This function isn't included in the default parser functions map. Use Configuration.addTemplateFunction("#all_macros", Allmacros.CONST) to add the template to your configuration.


Field Summary
static ITemplateFunction CONST
           
 
Constructor Summary
Allmacros()
           
 
Method Summary
 java.lang.String getFunctionDoc()
          Return a short description of the implemented template function
 java.lang.String parseFunction(java.util.List<java.lang.String> parts, IWikiModel model, char[] src, int beginIndex, int endIndex)
          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.
 
Methods inherited from class info.bliki.wiki.template.AbstractTemplateFunction
parse, parseFunction
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONST

public static final ITemplateFunction CONST
Constructor Detail

Allmacros

public Allmacros()
Method Detail

getFunctionDoc

public java.lang.String getFunctionDoc()
Description copied from interface: ITemplateFunction
Return a short description of the implemented template function

Specified by:
getFunctionDoc in interface ITemplateFunction
Overrides:
getFunctionDoc in class AbstractTemplateFunction
Returns:

parseFunction

public java.lang.String parseFunction(java.util.List<java.lang.String> parts,
                                      IWikiModel model,
                                      char[] src,
                                      int beginIndex,
                                      int endIndex)
                               throws java.io.IOException
Description copied from interface: ITemplateFunction
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.

Specified by:
parseFunction in interface ITemplateFunction
Specified by:
parseFunction in class AbstractTemplateFunction
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.
Returns:
the result string of this template function or null if the parsing fails or isn't valid
Throws:
java.io.IOException
See Also:
TemplateParser#parseTemplate(StringBuffer)


Copyright © 2012 Java Wikipedia API (Bliki engine). All Rights Reserved.