Vikipedio:Lua/Moduloj/Ŝablono:LuaModuleDoc

El Vikipedio, la libera enciklopedio
Salti al navigilo Salti al serĉilo
Ŝablona programado Diskutoj Lua Testoj Subpaĝoj
Modulo Esperanto English Deutsch

Modulo: Dokumentado

Ŝ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

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


Ĝeneralaj atentigoj pri la enplektado de moduloj

Enplektado okazas ĉiam en la formato

{{#invoke: Ŝablono:LuaModuleDoc | Funkcionomo | valoro1 | valoro2 | nomoX=valoro … }}

La parametroj povas esti nomitaj aŭ nenomitaj kiel ĉe ŝablonoj.

Se nekonata signoĉeno venas de ekstere (kiel ŝablonaj parametroj), ĉiam estu laborata kun la formo 1=valoro.

Pliajn informojn vi trovos sur Helpo:Lua.