MediaWiki extensions manual

ModDoc Release status: experimentalCategory:Experimental extensions
Implementation	API Category:API extensions
Description	Provides Lua documentation for Scribunto.
Author(s)	John Erling Blad (Jebladtalk)
Compatibility policy	Master maintains backward compatibility.Category:Extensions with master compatibility policy
MediaWiki	Category:Extensions without MediaWiki version
Database changes	No
License	GNU General Public License 2.0 or later
Download	GitHub: project page git repository URL [help ] commit history Note: No localisation updates are provided by translatewiki.net . Category:Extensions in GitHub version control README, LDoc
Hooks used ScribuntoExternalLibraryPaths Category:ScribuntoExternalLibraryPaths extensions
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.

• 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 file:

  wfLoadExtension( 'ModDoc' );
  

• Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage

For further help, see the generated ModDoc documentation.

Development

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

See also

• Scribunto
• Lua reference manual
• Glossary

External links

• Fandom: Module:Docbunto (similar, but not identical)