Extension:ModDoc

From Linux Web Expert

MediaWiki extensions manual
ModDoc
Release status: experimental
File:Wikimedia Technical Conference191113 - 50.jpg
Implementation API
Description Provides Lua documentation for Scribunto.
Author(s)
  • John Erling Blad (Jebladtalk)
Compatibility policy Master maintains backward compatibility.
MediaWiki
Database changes No
License GNU General Public License 2.0 or later
Download
README, LDoc
Quarterly downloads Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Public wikis using Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Translate the ModDoc extension
This extension is a reimplementation of w:Module:LuaDoc, and is still under development!

ModDoc provides a framework for Lua documentation.

Installation

ModDoc depends on modules from the LuaLexer (still pending) and Scribunto extensions.

  • <translate> Download and place the file(s) in a directory called <tvar name=name>ModDoc</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
  • <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
    wfLoadExtension( 'ModDoc' );
    
  • File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Usage

For further help, see the generated ModDoc documentation.

Development

For recreating the Vagrant-based development environment, see ModDoc: Topics/Vagrant.

See also

External links