Source

bloodhound-trac / doc / api / trac_wiki_api.rst

Full commit

:mod:`trac.wiki.api` -- The Wiki API

Interfaces

The wiki module presents several possibilities of extension, for interacting with the Wiki application and also for extending the Wiki syntax.

First, components can be notified of the changes happening in the wiki.

Components can also interfere with the changes, before or after they're made.

Then, the Wiki syntax itself can be extended. The first and less intrusive way is to provide new Wiki macros or Wiki processors. Those are basically the same thing, as they're implemented using the following interface. The difference comes from the invocation syntax used in the Wiki markup, which manifests itself in the args parameter of :meth:`IWikiMacroProvider.expand_macro`.

The Wiki syntax can also be extended by introducing new markup.

The Wiki System

The wiki system provide an access to all the pages.

Other Functions