Package org.olat.modules.wiki

Overview of the GUI part of the integrated wiki engine

See:
Description

Interface Summary

WikiContainer	Description: Conjuction between a wiki implementation and the wikiMarkupComponent.
WikiSecurityCallback	Description: callback for security calls.

Class Summary

BreadCrumbController	Description: Keeps track of a list of visited elements like links.
Crumb	Description: Element of @see org.olat.modules.wiki.BreadCrumbController
MediaFileElement	Description: Keeps metadata (author, deletion date...) of an media file used in the wiki like an image
MediaFilesTableModel	Description: Generates an table containing media files in the wiki.
Wiki	Description: Abstract model of a single Wiki where a wikiWord is unique and used as a key to get it's content.
WikiArticleSearchForm	Description: Provides a search text input field
WikiEditArticleForm	Description: Form for editing a textfield with wiki content inside
WikiForumCallback	Description: Security callback for enabling disabling some functions in the forums used in the wiki
WikiMainController	Description: This controller creates the whole GUI for a wiki with a tabbed pane contaning an article view, per page forum view, edit pane and versioning pane.
WikiManager	Description: This class handles several wiki's by storing them in a cache and also creates a new wikis.
WikiPage	Description: Data object for a single wiki page with metadata.
WikiPageChangeOrCreateNotificationHandler	Description: To inform users whether a page has been recently changed or created user can subscribe a wiki a this class evaluates whether something new is available or not.
WikiPageChangeOrCreateNotificationsUpgrade	Description: update the publisher to business path
WikiPageComparator	This comparator is intended to compare two wiki pages by their page name.
WikiPageSort	Description: Class to sort wiki pages either by alphabetical order or by modification time order
WikiSecurityCallbackImpl	Initial Date: Nov 28, 2006
WikiToCPExport	Description: To generate an snapshot of the current wiki users can export it in an offlinereadeble html export.
WikiToZipUtils	Description: pack whole wiki with unparsed syntax files into zip for export
WikiUnitTest	Description: TODO: guido Class Description for WikiUnitTest

Package org.olat.modules.wiki Description

Overview of the GUI part of the integrated wiki engine

Introduction

The modules wiki package contains the code for creating, editing, viewing and persisting a wiki. Wiki's are repository entries or collaboration tools entries when used in a private learngroup environnement. The persistence is done through the filesystem. You will find the files of a wiki in one of the following locations

• olatdata/bcroot/repository
• olatdata/bcroot/cts/wikis

By opening on of the locations you will find the following strcture:

• media: Contains the media files like images, pdf's used in this wiki. Each file has it's own metadata file xyz.metadata
• versions: Contains the version history of an wiki article, each time a change is saved a version file gets created
• wiki: Contains the recent wiki articles and for each article also a java properties file containing metadata

The filenames are somehow cryptic. They are generated by converting the wiki article name into an base64 string and removing the "/" which is also an element of the base64 encoding. This makes it save for a filesystem even if an article name contains special characters or utf-8 chars. By enabling the debug mode for the wiki class (see administration tab in the browser) you can see the mapping of a wikiword to an base64 id by clicking the "a-z" link inside the wiki.

Class description

• WikiMainController.java: Entry point for creation of an wiki and all of it's grafical stuff
• Wiki.java: Provides logic for handling a single wiki
• WikiManager.java: aggregates all wiki's present in the system and provides functions for caching, persisting, loading of a wiki

Wikisyntax to html

The parser for the wiki (mediawiki) syntax is not located in the package. @see org.olat.core.gui.components.wikiToHtml.