org.ceryle.wiki.plugin
Class IncludeDoc

java.lang.Object
  org.ceryle.wiki.plugin.IncludeDoc

All Implemented Interfaces:

WikiPlugin

public class IncludeDoc
extends Object
implements WikiPlugin

Plugin for including the content of an XNode supplied by an XML database.

Parameters:

cid='collectionID'

The ID of the database collection.

nid='nodeID'

The ID of the document within collection cid.

xid='xnode:uri'"

If neither the cid or nid are supplied, the URL of the document within collection can be supplied directly xid. If this parameter is supplied, the cid and nid are ignored.

meta='all' | DC.name | DCTERMS.name

Returns either all available metadata, or the specified "DC."- or "DCTERM."-prefixed value.

Depending on the MIME type of the XNode content, this returns the content processed as either text, wiki text, HTML, or XHTML. Other formats currently return an error message. If the MIME type is text/wiki the content will be fed through the JSPWiki renderer prior to being returned.

Author:

Murray Altheim

Field Summary

static String	DOES_NOT_EXIST The default text used to indicate that the page specified as a parameter does not exist.
static String	META_ALL
static String	NO_LINK_TEXT The default text used to indicate that there are no links for a given page.
static String	PARAM_CID
static String	PARAM_META
static String	PARAM_NID
static String	PARAM_XID
static boolean	TEXT_WRAP_PRE When true, text documents are wrapped with a <pre> element.

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

CORE_PLUGINS_RESOURCEBUNDLE

Constructor Summary

IncludeDoc()

Method Summary

String

execute(WikiContext context, Map params)

Methods inherited from class java.lang.Object

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

Field Detail

NO_LINK_TEXT

public static String NO_LINK_TEXT

The default text used to indicate that there are no links for a given page.

DOES_NOT_EXIST

public static String DOES_NOT_EXIST

The default text used to indicate that the page specified as a parameter does not exist.

PARAM_CID

public static final String PARAM_CID

See Also:

Constant Field Values

PARAM_NID

public static final String PARAM_NID

See Also:

Constant Field Values

PARAM_XID

public static final String PARAM_XID

See Also:

Constant Field Values

PARAM_META

public static final String PARAM_META

See Also:

Constant Field Values

META_ALL

public static final String META_ALL

See Also:

Constant Field Values

TEXT_WRAP_PRE

public static boolean TEXT_WRAP_PRE

When true, text documents are wrapped with a <pre> element.

Constructor Detail

IncludeDoc

public IncludeDoc()

Method Detail

execute

public String execute(WikiContext context,
                      Map params)
               throws PluginException

Specified by:

execute in interface WikiPlugin

Throws:

PluginException