Extension:PerlDoc
From MediaWiki.org
|
PerlDoc Release status: beta |
|
|---|---|
| Implementation | Tag |
| Description | Display perl documentation for an extension installed on your system. |
| Author(s) | CybersprocketTalk |
| Last version | 0.1 (2008-01-09) |
| MediaWiki | 1.6 |
| License | No license specified |
| Download | PerlDoc.php Change Log |
| Example | PerlDoc |
|
Check usage (experimental) |
|
Contents |
[edit] What can this extension do?
This MediaWiki extension will display Perl Documentation in your wiki page for any perl module you have installed on your system.
[edit] Usage
Replace Postgres::Handler with the installed Perl module you wish to report on. Perl modules can be be found on CPAN and can be installed on your Linux box using the shell command:
cpan -i Postgres::Handler
[edit] PerlDoc
[edit] Examples
<perldoc>Postgres::Handler</perldoc>
[edit] Parameters
- Between the brackets: enter the name of an installed perl module
- format: any format supported by perldoc on your system
- the default format is html
[edit] Download instructions
Get the code here: PerlDoc.php
Save the file on your server here: $IP/extension/ExtensionName/ExtensionName.php. Note: $IP stands for the root directory of your MediaWiki installation, the same directory that holds LocalSettings.php.
[edit] Installation
To install this extension, add the following to LocalSettings.php:
require_once("$IP/extensions/PerlDoc/PerlDoc.php");
