WikiStream Module
 | Allow converting from one wiki format to another |
| Type | Other |
| Category | |
| Developed by | |
| Active Installs | 2 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Standard |
Table of contents
Description
Framework providing tools to convert from one wiki source to another wiki target being files, remote instance or pretty much anything else.
Architecture
The idea behind WikiStream is to make filters communicate with each other using common "events", much like XWiki Rendering framework but more generic.
There is no defined set of events at WikiStream API level, each filter can declare a set of supported events by implementing corresponding interfaces. Proxy helpers are provided to make easy for filters that might have different set of supported events to communicate with each other. Some well known events can be found in https://github.com/xwiki/xwiki-platform/tree/master/xwiki-platform-core/xwiki-platform-wikistream/xwiki-platform-wikistream-events modules. See Filter Module for more about filters in general.
The main WikiStream extensions points are the two following kind of modules:
- org.xwiki.wikistream.output.OutputWikiStreamFactory: which is responsible for converting WikiStream event into the format this module has been written for (a XAR package, database documents, etc.)
- org.xwiki.wikistream.input.InputWikiStreamFactory which is responsible for parsing/reading an input and generate WikiStream events for it
UI
WikiStream framework can be manipulated using WikiStream application.
