Extension:ModDoc

From mediawiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
ModDoc
Release status: experimental
Wikimedia Technical Conference191113 - 50.jpg
Implementation API
Description Provides Lua documentation for Scribunto.
Author(s)
Compatibility policy Master maintains backwards compatibility.
MediaWiki 1.36 Not formally tested
MediaWiki 1.34 Not formally tested
MediaWiki 1.32 Not formally tested
Database changes No
License GNU General Public License 2.0 or later
Download
README, LDoc
Translate the ModDoc extension

Check usage and version matrix.

This extension is a reimplementation of w:Module:LuaDoc, and is still under development!

ModDoc provides a framework for Lua documentation.

Installation[edit]

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

  • Download and place the file(s) in a directory called ModDoc in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'ModDoc' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage[edit]

For further help, see the generated ModDoc documentation.

Development[edit]

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

See also[edit]

External links[edit]