info.bliki.wiki.model
Interface IConfiguration

All Known Subinterfaces:

IWikiModel

All Known Implementing Classes:

AbstractWikiModel, BBCodeModel, Configuration, WikiModel

public interface IConfiguration

Configuration interface for extensions similar to the Mediawiki HTML styled tag extension, template parser functions and interwiki links

See Also:

Configuration

Method Summary

SourceCodeFormatter	addCodeFormatter(java.lang.String key, SourceCodeFormatter value) Add a new source code formatter to the configuration
java.lang.String	addInterwikiLink(java.lang.String key, java.lang.String value) Add a new interwiki link to the configuration
ITemplateFunction	addTemplateFunction(java.lang.String key, ITemplateFunction value) Add a new interwiki link to the configuration
TagToken	addTokenTag(java.lang.String key, TagToken value) Add a new HTML styled tag to the configuration
java.util.Map<java.lang.String,SourceCodeFormatter>	getCodeFormatterMap() Get the source code formatter map of built-in source code formatters
java.util.Map<java.lang.String,java.lang.String>	getInterwikiMap() Get the interwiki links map for converting interwiki links into external URLs.
java.util.Map<java.lang.String,ITemplateFunction>	getTemplateMap() Get the template parser functions map of built-in template functions
java.util.Map<java.lang.String,TagToken>	getTokenMap() Get the HTML styled tag map for built-in tags

Method Detail

getInterwikiMap

java.util.Map<java.lang.String,java.lang.String> getInterwikiMap()

Get the interwiki links map for converting interwiki links into external URLs. Example: maps the interwiki shortcut "de" to "http://de.wikipedia.org/wiki/${title}"

Returns:

getTemplateMap

java.util.Map<java.lang.String,ITemplateFunction> getTemplateMap()

Get the template parser functions map of built-in template functions

Returns:

getTokenMap

java.util.Map<java.lang.String,TagToken> getTokenMap()

Get the HTML styled tag map for built-in tags

Returns:

addInterwikiLink

java.lang.String addInterwikiLink(java.lang.String key,
                                  java.lang.String value)

Add a new interwiki link to the configuration

Parameters:

key - the prefix used in the interwiki link (i.e. [[prefix:...]] )

value - the external link which should be generated from the interwiki link

Returns:

addTemplateFunction

ITemplateFunction addTemplateFunction(java.lang.String key,
                                      ITemplateFunction value)

Add a new interwiki link to the configuration

Parameters:

key -

value -

Returns:

addTokenTag

TagToken addTokenTag(java.lang.String key,
                     TagToken value)

Add a new HTML styled tag to the configuration

Parameters:

key -

value -

Returns:

getCodeFormatterMap

java.util.Map<java.lang.String,SourceCodeFormatter> getCodeFormatterMap()

Get the source code formatter map of built-in source code formatters

Returns:

addCodeFormatter

SourceCodeFormatter addCodeFormatter(java.lang.String key,
                                     SourceCodeFormatter value)

Add a new source code formatter to the configuration

Parameters:

key -

value -

Returns: