Vikipedio:Lua/Moduloj/Ŝablono:LuaModuleDoc/en

Aldoni ligilojn
El Vikipedio, la libera enciklopedio
Ŝablona programado Diskutoj Lua Testoj Subpaĝoj
Modulo Esperanto English Deutsch

Modulo: Dokumentado

Ŝablono: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.

template Functions for templates[redakti fonton]

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:
langRequest
(optional; for the current page)
Space separated list of explicitly requested language codes.
  • If not provided, show all from standard: langsDefault.
  • If defined, prepend all existing from langsDefault.
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 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.

Ŝablono:LuaModuleDoc – Modulo, kiu faras la ĉefan laboron por la dokumentado de Lua-moduloj.

La Ŝablono:LuaModuleDoc estas enplektata sur la koncernaj dokumentadaj paĝoj. Ĝi liveras la (ĉi tie esperantan) adaptiĝon al la projekto.

  • Krome estas transdonataj la unuaj (tri) parametroj kun nedeviga eksplikita indiko de la lingvo kaj aliaj paĝospecifaj apartaĵoj.

Funkcioj por ŝablonoj[redakti fonton]

nav
Generi ligilkestan tekston.
  • Sur la centra paĝo de dokumentado ankaŭ:
    • Enplekto de la unua ekzistanta lingva versio,
    • Enplekto de la helpaj informoj por la ŝablona enplekto (se ne noHint),
    • Kategoriigo (se ne noCat).
Parametroj:
langRequest
(nedeviga; por la aktuala paĝo)
Per spacoj disigita listo de la esplicite dezirataj lingvokodoj
  • Se ne donita, tiam ĉiam el la normo montri: langsDefault
  • Se donita, tiam ĉiujn ekzistantajn el langsDefault antaŭmeti
noCat
(nedeviga; por la aktuala paĝo, ev. ne malplena valoro)
Kategoriigon de la baza dokumentado malebligi
noHint
(nedeviga; por la aktuala paĝo, ev. ne malplena valoro)
Montrado de la normaj atentigoj laŭ la baza dokumentado pri ŝablona enplektado malebligi
categoryDocs
Titolo de la kategorio por la baza dokumentado
langsDefault
Per spacoj disigita listo de la laŭnormaj lingvokodoj
nsDocs
Numero de la nomspaco por la dokumentadaj paĝoj
pageDocRoot
Paĝotitolo de la baza paĝo por la dokumentadoj paĝoj
pageErr
Paĝonomo por la surekranigo de erarmesaĝoj
pageNav
Paĝonomo por la navigada kesto
pageTemplateInsert
Paĝonomo por la helpoinformoj pri ŝablona enplektado


Usage[redakti fonton]

Nowhere than by Template:LuaModuleDoc.

Dependencies[redakti fonton]

Origin[redakti fonton]

Elŝutita el "https://eo.wikipedia.org/w/index.php?title=Vikipedio:Lua/Moduloj/Ŝablono:LuaModuleDoc/en&oldid=5867217"