Extension:VersaComment

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
VersaComment

Release status: stable

Description
Author(s) Jean-Lou Dupont
Last version 1.0.0
MediaWiki tested on 1.11
License No license specified
Download SVN
See SVN

Check usage (experimental)

Contents

[edit] Purpose

Provides a means of including wikitext content which is visible on one site but removed on another.

[edit] Example

Suppose one has an extension which provides extended parser functionality. The extension's description must be published on MediaWiki and on the target site (i.e. the site where the extension is used); it is quite possible that MediaWiki won't provide the said extension so including some live examples on the description page would prove difficult. The said live examples can thus be enclosed with the special markers provided by this extension whilst providing transparent support on MediaWiki.org.

[edit] Usage

Just include the comments to be displayed between the <!--{{ }}--> markers.

[edit] Dependencies


[edit] Installation

See the Mediawiki Extension table entry "download" above.[1]

[edit] LocalSettings.php

Extension:ExtensionManager: See footnote[2]

require_once( "$IP/extensions/VersaComment/VersaComment.php" );
  • Since this Extensions is depending on StubManager, add the line after the StubManager include, or else your Wiki won't work.

[edit] PEAR

PEAR is a repository of PHP software code.

pear channel-discover mediawiki.googlecode.com/svn
  • Install extension through PEAR:
pear install mediawiki/VersaComment
  • Add the following to LocalSettings.php[2][3]:
require 'MediaWiki/VersaComment/VersaComment.php';
  • Note that the required version of PEAR must be respected. Currently, the minimum version of PEAR usable with this channel is v1.6.2. Perform the following command to upgrade to the latest version of PEAR:
pear upgrade pear

[edit] Upgrades through PEAR

Sometimes, it is necessary to clear PEAR's cache in order to perform upgrades.

pear clear-cache

or use the force method:

pear upgrade --force mediawiki/VersaComment

[edit] PEAR Web Frontend

For easier remote package management, PEAR Frontend WEB can be installed. Installation notes can be found here. An example of the WEB frontend is available here.

[edit] RSS feed

To keep up-to-date with this channel, use the following RSS feed__Rss2.jpg.

[edit] Notes

[edit] Other Extensions From the same author

Consult User Jldupont's page.


  1. The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
  2. 2.0 2.1 2.2 Extension:ExtensionManager does not require any modification to LocalSettings.php because ExtensionManager includes the extension.
    Note that if PHP code caching is in place (e.g. APC, eAccelerator), then to successfully complete the installation a cache flush might be needed.
  3. Modifications to LocalSettings.php is only necessary if not using Extension:ExtensionManager

[edit] History

Release Notes
1.0.0 Initial Release
Personal tools
Namespaces
Variants
Actions
Site
Support
Download
Development
Communication
Print/export
Toolbox