Wikipedia:Lua/Modul/Vorlage:LuaModuleDoc/en

Vorlagen- programmierung	Diskussionen	Lua						Unterseiten
		Modul	Deutsch	English	Esperanto	Dolnoserbski	Hornjoserbsce	Modul:	WP:Lua

Vorlage:LuaModuleDoc – Module for support of Template:LuaModuleDoc, and doing the major work of Lua module documentation.

On all the related documentation pages Template:LuaModuleDoc is transcluded. That one provides the project and language specific adaptions.

The first (three) optional template parameters also pass through some page specific adaptions, if necessary.

Functions for templates

nav

Generate linkbox text.

On the central documentation page also
- transclusion of first detected language version
- transclusion of assistance for template transclusion (if not noHint)
- category, with sort code (if not noCat).

Parameters:

langsRequest

(optional; for the current page)

Space separated list of explicitly requested language codes.

noCat: (optional; for the current page; any non-empty value); Suppress categorisation of base documentation page.
noHint: (optional; for the current page; any non-empty value); Suppress assistance for template transclusion after base documentation.
categoryDocs: Title of existing category for base documentation.
langsDefault: Space separated list of general language codes.
nsDocs: Number of namespace for documentation pages.
pageDocRoot: Title of base documentation page.
pageErr: Name of page for error message display.
pageNav: Name of page for navigation box.
pageTemplateInsert: Name of page for template transclusion assistance.
subTest: Name of subpage for tests.; Might be provided with uppercase letters; will be searched in lowercase as well.; Default: Test

Projekt-Konfiguration
Parameter	deutschsprachige Wikipedia
categoryDocs	`Wikipedia:Lua/Modul`
categoryWikiData	`Wikipedia:Lua/Modul/Global via WikiData`
categoryWikiDataChild	`Wikipedia:Lua/Modul/Global via WikiData/Kind`
categoryWikiDataParent	`Wikipedia:Lua/Modul/Global via WikiData/Mutter`
categoryWikiDataReplication	`Wikipedia:Lua/Modul/Global via WikiData/Abgleich`
langsDefault	`de en`
langsMore	`dsb eo fr hsb`
nsDocs	`4`
pageDocRoot	`Lua/Modul`
pageErr	`Wikipedia:Lua/Modul-Navigationsfehler`
pageNav	`Vorlage:LuaModuleDoc/Navigation`
pageTemplateInsert	`Wikipedia:Lua/Vorlagenprogrammierung`
preloadCentral	`Vorlage:LuaModuleDoc/preload-central`
preloadRedir	`Vorlage:LuaModuleDoc/preload-redir`
subTest	`Test`
templateGlobal	`LuaModuleDoc/Global`

Import the following pages into your project (this keeps version history and credits):
- Modul:Vorlage:LuaModuleDoc and rename as appropriate
- Modul:LuaWiki
- Template:LuaModuleDoc
Create files similar to the following, translate and adapt as you like:
Edit your version of Template:LuaModuleDoc and adjust the settings to your needs.
Create description page for categoryDocs if you want to categorize.