|
||||||||||
| PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES | |||||||||
See:
Description
| Class Summary | |
|---|---|
| ErrorEvent | Description: Event that gets fired when an Error occurs, like an wiki link which contains bad characters |
| FilterUtil | Description: Util method for setting the first letter of an wiki word to upperchase. |
| OlatWikiDataHandler | Implementation of the Datahandler Interface from the jamwiki engine. |
| RequestImageEvent | Description: Event that gets fired if an image should be displayed in a wiki page |
| RequestMediaEvent | Description: Event that gets fired if an media file like an e.g. |
| RequestNewPageEvent | Description: A click on a wiki topic that not yet exists fires this event, that says that a user want to create this page. |
| RequestPageEvent | Description: A click on a wiki topic that exists fires this event, that says that a user wants to view this page. |
| StaticExportWikiDataHandler | Description: Implementation of the jamwiki datahander for static export purpose. |
| WikiMarkupComponent | Description: This component renders a string containing media wiki syntax to html for a reference of the media wiki syntax see: http://meta.wikimedia.org/wiki/Help:Editing |
| WikiMarkupRenderer | Description: render part of the component, where the html output surrounding the transformed wiki syntax gets added |
This component renders wikisyntax (mediawiki) to html. It's used by the olat internal wiki but could be used on other places as well where you like to render wikisyntax to html (arbitrary textfields)
The parser for the wiki (mediawiki) syntax is from a other open source project called: Jamwiki.org. The source of the parser is located it the webapp/lib directory
Usage: To include the component see the following code snipplet. You create an component and pass a name an OlatRescourcable object and a size of the output div. You register your Contriller by adding a listener. If you like your component to display images you need an seession based mapper. Mappers (global or user session style: @see org.olat.core.dispatcher.mapper.Mapper) generate URI's that reference static content like images. To finally display your component add it to a container like a VelocityContainer.
wikiArticleComp = new WikiMarkupComponent("wikiArticle", ores, 300);
wikiArticleComp.addListener(this);
wikiArticleComp.setImageMapperUri(ureq, wikiContainer);
articleContent.put("wikiArticle", wikiArticleComp);
If your syntax contains links in wiki syntax like [[wikiword]] or [[Image:test.jpg]] then events are genereted that can be processed in your controller
|
||||||||||
| PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES | |||||||||