com.liferay.portlet.wiki.engines
Interface WikiEngine

All Known Implementing Classes:

CreoleWikiEngine, HtmlEngine, JSPWikiEngine, MediaWikiEngine, TextEngine

public interface WikiEngine

Method Summary

abstract String	convert(WikiPage page, PortletURL viewPageURL, PortletURL editPageURL, String attachmentURLPrefix) Returns the content of the given page converted to HTML using the view and edit URLs to build links.
abstract Map<String,Boolean>	getOutgoingLinks(WikiPage page) Returns a map of the links included in the given page.
abstract void	setInterWikiConfiguration(String interWikiConfiguration) Set the configuration to support quick links to other wikis.
abstract void	setMainConfiguration(String mainConfiguration) Sets the main wiki configuration as a String.
abstract boolean	validate(long nodeId, String content) Returns true if the content of a wiki page for this engine is valid.

Method Detail

convert

String convert(WikiPage page,
               PortletURL viewPageURL,
               PortletURL editPageURL,
               String attachmentURLPrefix)
               throws PageContentException

Returns the content of the given page converted to HTML using the view and edit URLs to build links.

Parameters:

page - the wiki page

viewPageURL - the URL to view the page

editPageURL - the URL to edit the page

attachmentURLPrefix - the URL prefix to use for attachments to the page

Returns:

the content of the given page converted to HTML

Throws:

PageContentException - if a page content exception occurred

getOutgoingLinks

Map<String,Boolean> getOutgoingLinks(WikiPage page)
                                     throws PageContentException

Returns a map of the links included in the given page. The key of each map entry is the title of the linked page. The value is a Boolean object that indicates if the linked page exists or not.

Parameters:

page - the page

Returns:

a map of links included in the given page

Throws:

PageContentException - if a page content exception occurred

setInterWikiConfiguration

void setInterWikiConfiguration(String interWikiConfiguration)

Set the configuration to support quick links to other wikis. The format of the configuration is specific to the wiki engine.

Parameters:

interWikiConfiguration - the configuration to support quick links to other wikis

setMainConfiguration

void setMainConfiguration(String mainConfiguration)

Sets the main wiki configuration as a String. The format of the configuration is specific to the wiki engine.

Parameters:

mainConfiguration - the main configuration of the wiki engine

validate

boolean validate(long nodeId,
                 String content)

Returns true if the content of a wiki page for this engine is valid.

Parameters:

nodeId - the ID of the wiki page node

content - the page content

Returns:

true if the content of a wiki page for this engine is valid; false otherwise