Note: An alternative skin, TW4MW (work in progress), is available from the user preferences.
Dev:Server Adaptor Mechanism
TiddlyWiki Community Wiki
As of TiddlyWiki v2.4.1, there is a BaseAdaptor class which provides much of the basic functionality. The current documentation has not been updated to reflect this yet.
Server adaptors are designed to use a familiar model akin to a device driver, adapting a standardized interface to whatever is required by the underlying server: WebDAV, ZiddlyWiki, MediaWiki, Socialtext or HTML scraping.
Many server architectures are REST based, and TiddlyWiki server adaptors are particularly easy to create for common REST patterns. It is also possible to create TiddlyWiki server adaptors for servers with an XML-RPC interface.
Server adaptors are registered by name in the global object config.adaptors. Each entry is a reference to an object constructor for that type of server adaptor. The adaptor object must implement the following methods:
Additionally the adaptor may implement the following methods:
- Adaptor.getWorkspaceList (required to support the Import Tiddlers UseCase)
- Adaptor.getTiddlerList (required to support the Import Tiddlers UseCase)
- Adaptor.putTiddler (required to support the Sync UseCase)
- Adaptor.getTiddlerRevision
- Adaptor.getTiddlerRevisionList
The adaptor object is used through the life of a connection to a server; see ServerAdaptorConcepts for details. Many of the methods use an AsynchronousPattern of callbacks to deliver their results.
Custom formatters for the WikifierFormatterMechanism are often used alongside server adaptors to allow TiddlyWiki to display content in the native format of a server.
