Catrone3: Created page with "{{Lua|Module:Text}} ''`Format TemplateData`''' – Module with auxilary functions for template documentation, especially by TemplateData. Core functionality is improved presentation on documentation pages. TOC == Functions for templates == === Details === ; f : Improve TemplateData-presentation; used in Template:Format TemplateData : ''Parameters of template transclusion environment (all optional):''
::; 1 ::: JSON s..."

2024-07-08T02:43:32Z

Created page with "{{Lua|Module:Text}} ''<code>Format TemplateData</code>''' – Module with auxilary functions for template documentation, especially by TemplateData. Core functionality is improved presentation on documentation pages. __TOC__ == Functions for templates == === Details === ; f : Improve TemplateData-presentation; used in Template:Format TemplateData : ''Parameters of template transclusion environment (all optional):''<section begin="templatePar" /> ::; 1 ::: JSON s..."

New page

{{Lua|Module:Text}}
''<code>Format TemplateData</code>''' – Module with auxilary functions for template documentation, especially by TemplateData.

Core functionality is improved presentation on documentation pages.

__TOC__

== Functions for templates ==

=== Details ===
; f
: Improve TemplateData-presentation; used in [[Template:Format TemplateData]]
: ''Parameters of template transclusion environment (all optional):''<section begin="templatePar" />
::; 1
::: JSON string or <code><templatedata></code> object
::; JSON
::: JSON string
::: (precedes '''1''')
::: Transition from <code><templatedata></code> objects with pipe symbols needs special attention: Pipes are to be represented as <code><nowiki>{{!}}</nowiki></code>, on double curly brackets one should be encoded by HTML entity.
::; TOC
::: <code>1</code> – Insert table of contents after general purpose descriptions; but before parameter list, if present
::; lang
::: Language code according to ISO 639 etc.
::; lazy
::: <code>1</code> – Presentation only, do not generate an effective data block
::: For general method descriptions.
::; debug
::: <code>1</code> – developer mode
::; source
::: <code>1</code> – show effective JSON source text (after template expansion) for debugging<section end="templatePar" />
: ''Parameters of'' <code>#invoke</code> ''for particular project adaption (all optional):''
::; lang
::: Language code according to ISO 639 etc.
::; debug
::: Development mode, if provided and not equal <code>0</code>
::; cat
::: Title of a maintenance category on invalid parameter value etc.
::: '''Deprecated''' – use [[#config|configuration module]]
::; docpageCreate
::: Pattern for creation of subpage names; <code>%s/Doku</code>
::: '''Deprecated''' – use [[#config|configuration module]]
::; docpageDetect
::: Pattern for recognition of subpage names; <code>/Doku$</code>
::: '''Deprecated''' – use [[#config|configuration module]]
::; msgDescMiss
::: Localisation: complaint text on missing <code>description</code>
::: '''Deprecated''' – use [[#config|configuration module]]
: ''Returns:'' HTML code; and/or error message, probably with <code>class="error"</code>
; failsafe {{Anker|failsafe}}
: Version management

== Functions for Lua modules (API) ==

Some functions described above can be used by other modules:
<syntaxhighlight lang="lua">
local lucky, TemplateData = pcall( require, "Modul:Format TemplateData" )
if type( TemplateData ) == "table" then
TemplateData = TemplateData.TemplateData()
else
-- failure; TemplateData is the error message
return "<span class='error'>" .. TemplateData .. "</span>"
end
</syntaxhighlight>

; TemplateData.[[#failsafe|failsafe]](atleast)
:# atleast<br />''optional''<br />''nil'' or minimal version request or <code>"wikidata"</code>
: Returns: ''string'' or ''false''
; TemplateData.getPlainJSON(adapt)
: Reduce enhanced JSON information to MediaWiki JSON
:# adapt<br /> ''string'', with JSON (enhanced)
: Returns: ''string'', with JSON (MediaWiki )
; TemplateData.test(adapt, arglist)
: Simulation of template functionality
:# adapt<br /> ''table'', <code>#invoke</code> parameters
:# arglist<br /> ''table'', template parameters
: Returns: ''string''

== Usage ==
Currently focussing on one template only:
* [[Template:Format TemplateData]]

== Dependencies ==
* [[Module:Text|Text]]

== Configuration ==
A local module [[Module:Format TemplateData/config]], if present, facilitates adaptions to the local project.

A ''table'' is expected via <code>mw.loadData</code>. The following entries are optional components:
; catProblem
: Title of a maintenance category on invalid parameter value etc.
; classNoNumTOC
: Name of class for the table of contents; especially to suppress numbering.
: <code>nonumtoc</code>
; classTable
: ''table'' with classes for the table of parameters.
: <code>{ "wikitable" }</code>
; cssParams
: ''table'' with CSS assignments for formatting of single parameters
; cssParWrap
: ''table'' with CSS assignments for formatting of the entire parameter table
; docpageCreate
: Pattern for creation of subpage names; <code>%s/Doku</code>
: <code>%s/Doku</code>
; docpageDetect
: Pattern for recognition of subpage names; <code>/Doku$</code>
: <code>/Doku$</code>
; help*********
: Link targets for context sensitive help on details
; helpBoolean
; helpContent
; helpDate
; helpFile
; helpFormat
: Link target on help about wikitext transclusion layout
; helpLine
; helpNumber
; helpPage
; helpString
; helpTemplate
; helpURL
; helpUser
; msgDescMiss
: Localisation: complaint text on missing <code>description</code>
; permit
: ''table'' with specification of properties for a single parameter; components:
:; boole
:: ''table'' with specification for ''boolean'' presentation
:: Two components <code>true</code> and <code>false</code> – each one ''table'':
::; css
::: ''table'' with CSS for this explanation of the value
::; lead
::: <code>true</code> – show explanation for <code>0</code> or <code>1</code> respectively preceding the value
::: <code>false</code> – show explanation for <code>0</code> or <code>1</code> respectively following the value
::; show
::: explanation; ''string'' or <code>false</code> to suppress
:; css
:: ''table'' with specifications for rendering of the parameter table; components:
::; tablehead
::: ''table'' with CSS for table head
::; required
::: ''table'' with CSS for <code>required</code>
::; suggested
::: ''table'' with CSS for <code>suggested</code>
::; optional
::: ''table'' with CSS for <code>optional</code>
::; deprecated
::: ''table'' with CSS for <code>deprecated</code>

Module:Format TemplateData/doc - Revision history