NAME

remoteMoin -- some XML-RPC plugins for MoinMoin for an improved XML-RPC access


SYNOPSIS

deletePageWithAttributes(pagename, attributes)

putPageWithAttributes(pagename, pagetext, attributes)

getRecentChangesWithAttributes(date, pagenames)

getPageInfoVersionWithAttributes(pagename, rev)

renamePageWithAttributes(fromname, toname, attributes)


DESCRIPTION

deletePageWithAttributes

Deletes a page in the Wiki.

pagename is the name of the page to delete. Value is a string (Unicode or UTF-8).

attributes are arbitrary attributes for the deletion. comment is used here. See Attributes for a description.

Returns True if the operation succeeded or throws a Fault.

putPageWithAttributes

Puts a new text for a page to the Wiki.

pagename is the name of the page to write. Value is a string (Unicode or UTF-8).

pagetext is the new text for the page. Value is a string (Unicode or UTF-8).

attributes are arbitrary attributes. comment and minoredit are used here. See Attributes for a description.

Returns True if the operation succeeded or throws a Fault.

getRecentChangesWithAttributes

Gets information about recent changes in the Wiki with extended attribute values.

date is the date since when recent changes will be returned. Value is a xmlrpclib.DateTime in UTC.

pagenames is a list of page names for which recent changes will be returned. Value is a list of strings (Unicode or UTF-8). An empty list gets recent changes for all readable pages in the Wiki.

Returns a list of results reflecting the recent changes for each of the arguments. Each result is either a Fault or an Attributes list listing all the changes since date. A list of Attributes is sorted with the most recent entry first and may be empty for unchanged pages. If pagenames was empty there is a list with a single result. A Fault may indicate a non-existing or unreadable page.

An Attributes list contains name, lastModified, author, version, comment, action, extra and renameOrResurrect.

getPageInfoVersionWithAttributes

Gets information about a given page revision in the Wiki with extended attribute values.

pagename is the name of the page to get information for. Value is a string (Unicode or UTF-8).

rev is the revision to get information for. If value is 0 the most recent version is used. Value is an int.

Returns Attributes of this page containing name, lastModified, author, version, comment, action, extra, renameOrResurrect, and delete. renamedFrom is returned if renameOrResurrect is True and it is actually a rename.

renamePageWithAttributes

Renames a page in the Wiki.

fromname is the original name of the page to rename. Value is a string (Unicode or UTF-8).

toname is the new name of the page to rename. Value is a string (Unicode or UTF-8).

attributes are arbitrary attributes for the rename. comment is used here. See Attributes for a description.

Returns True if the operation succeeded or throws a Fault.

Attributes

This is a structure of attributes according to http://www.jspwiki.org/Wiki.jsp?page=WikiRPCInterface2#section-WikiRPCInterface2-NewFunctionsInAPIV2 (in the description of putPage). These attributes are known and used by this definition:

name

The name of a page. Value is a string (Unicode or UTF-8).

lastModified

The modification date of a change. Value is a xmlrpclib.DateTime.

author

The author of a change. Value is a xmlrpclib.DateTime.

version

The version a change creates. Starts with 1 for the first version and is incremented by one for each change. Value is an int.

comment

The comment for a change. Value is a string (Unicode or UTF-8).

minoredit

If a change is marked as a minor edit. Value is a xmlrpclib.Boolean.

The following are extensions:

action

The name of the action leading up to this change in the edit-log. Value is a string.

This can be used to recognize special changes and act accordingly.

extra

The extra field for this change in the edit-log. Value is a string (Unicode or UTF-8).

The meaning of this field depends on action.

renameOrResurrect

If a change is marked as a rename or as a page resurrection. Value is a xmlrpclib.Boolean.

renamedFrom

If a version is marked as a renameOrResurrect and it is actually a rename this gives the old name of the page. Value is a string (Unicode or UTF-8).

delete

If a change is marked as a deletion. Value is a xmlrpclib.Boolean.


INSTALLATION

Simply put the *.py files of the plugins to MoinMoin's plugin/xmlrpc directory.


SEE ALSO

moinupdate uses a couple of these plugins if they are present. See

        http://www.merten-home.de/FreeSoftware/moinupdate/


AUTHOR

Stefan Merten <smerten@oekonux.de>


LICENSE

These plugins are licensed under the terms of the GPL. See

        http://www.gnu.org/licenses/gpl.txt


AVAILABILTY

See

        http://www.merten-home.de/FreeSoftware/remoteMoin/


BUGS

Reverts are shown specially by the history functions but are not yet supported here.