org.ceryle.wiki.plugin.transclude
Class TranscludePlugin

java.lang.Object
  org.ceryle.wiki.plugin.transclude.TranscludePlugin

All Implemented Interfaces:

WikiPlugin

Direct Known Subclasses:

Transclude

public class TranscludePlugin
extends Object
implements WikiPlugin

Similar to the InsertPage plugin but across wiki-sites via XML-RPC. NOTE: This works best between JSPWiki based wiki's! We retrieve the wiki-text for the foreign page, unless their wiki markup matches what the JSPWiki's JSPWikiMarkupParser expects you will have to set the translate parameter to false. Parameters:

• page = name of page, may be able to provide interwikilink syntax.
• xmlrpc = url to foreign wiki's RPC interface. This parameter is optional if you provide an interwiki link as the page parameter AND the RPC url is guessable from the interwiki link. If the url cannot be guessed or the guess turns out to be wrong, then this parameter is required.
• cache = a number of seconds for which a cache of the transcluded page is to be considered valid, default is 30. This exists just to keep server loads in check.
• translate = true or false, default is true. Should we attempt to translate the retrieved wiki text into html or simple enclose it in a <pre> section. If false, the raw wiki text is preserved (a <pre> tag surrounds the foreign material and it is word wrapped at around 80 charaters to keep from having to side-scroll).

TODO: TranscludePlugin uses a caching mechanism, we need some sort of reaper on it eventually. Not a big problem as there are not that many transclusions. Also self-referring plugins would be BAD!

Author:

Murray Altheim, John Volkar (john.volkar at gmail.com)

Field Summary

Fields inherited from interface com.ecyrd.jspwiki.plugin.WikiPlugin

CORE_PLUGINS_RESOURCEBUNDLE

Constructor Summary

TranscludePlugin()

Method Summary

String

execute(WikiContext context, Map paramMap)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TranscludePlugin

public TranscludePlugin()

Method Detail

execute

public String execute(WikiContext context,
                      Map paramMap)

Specified by:

execute in interface WikiPlugin

See Also:

WikiPlugin.execute(com.ecyrd.jspwiki.WikiContext, java.util.Map)