Extension:DocProc

From MediaWiki.org

Jump to: navigation, search
Manual on MediaWiki Extensions
List of MediaWiki Extensions
DocProc

Release status: beta
Implementation Tag
Description
Author(s) user:jldupont
Version See SVN
MediaWiki tested on 1.10 but probably works with a earlier versions
Download SVN

Contents

[edit] Purpose

Serves to document markup/magic words whilst still executing them as per required.

[edit] Features

  • Documents all wikitext types by enclosing the said wikitext in either 'code' or 'pre' tags
  • Executes the passed wikitext as per usual processing flow
  • Secure: only predefined HTML documentation tags can be specified
    • Currently, only the 'pre' and 'code' tags are supported

[edit] Usage

Let's say one wants to document & still execute the following wikitext:

<docproc tag=code>{{CURRENTTIME}}</docproc>10:23
Here the wikitext magic word CURRENTTIME would be executed and the result would be presented next to the 'documented' wikitext enclosed inside a 'code' section.

[edit] Target Application

The envisaged target application for this extension is to document wikitext that produces no direct user visible results.

[edit] Dependancy

[edit] Installation

To install independantly from BizzWiki:

  • Download 'ExtensionClass' extension
  • Apply the following changes to 'LocalSettings.php'
require('extensions/ExtensionClass.php');
require('extensions/DocProc/DocProc.php');

[edit] See also

This extension is part of the BizzWiki platform.

Retrieved from "http://www.mediawiki.org/wiki/Extension:DocProc"
Personal tools