Difference between revisions of "Template:TemplateBox"

From Multilingual Bookbinding Dictionary
Jump to navigation Jump to search
Template>Verdy p
(compress to save expansion cost)
 
m (1 revision imported)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
−
<includeonly>{{#invoke:Languages|autolang|base=TemplateBox/i18n
+
<includeonly>{{TemplateBox/{{Fallback|TemplateBox}}
−
|useargs=both
+
|1={{{1|}}}|1d={{{1d|}}}|1def={{{1def|}}}|1stat={{{1stat|}}}|2={{{2|}}}|2d={{{2d|}}}|2def={{{2def|}}}|2stat={{{2stat|}}}
−
|templateData={{#invoke:TemplateBox|templatedata}}
+
|3={{{3|}}}|3d={{{3d|}}}|3def={{{3def|}}}|3stat={{{3stat|}}}|4={{{4|}}}|4d={{{4d|}}}|4def={{{4def|}}}|4stat={{{4stat|}}}
−
|JSONFM={{#invoke:TemplateBox|templatedata|formatting=pretty}}
+
|5={{{5|}}}|5d={{{5d|}}}|5def={{{5def|}}}|5stat={{{5stat|}}}|6={{{6|}}}|6d={{{6d|}}}|6def={{{6def|}}}|6stat={{{6stat|}}}
−
|paramTable={{#invoke:TemplateBox|paramtable}}
+
|7={{{7|}}}|7d={{{7d|}}}|7def={{{7def|}}}|7stat={{{7stat|}}}|8={{{8|}}}|8d={{{8d|}}}|8def={{{8def|}}}|8stat={{{8stat|}}}
−
|usageSample={{#invoke:TemplateBox|usagesample}}
+
|9={{{9|}}}|9d={{{9d|}}}|9def={{{9def|}}}|9stat={{{9stat|}}}|10={{{10|}}}|10d={{{10d|}}}|10def={{{10def|}}}|10stat={{{10stat|}}}
−
|argCount={{#invoke:TemplateBox|argcount}}
+
|11={{{11|}}}|11d={{{11d|}}}|11def={{{11def|}}}|11stat={{{11stat|}}}|12={{{12|}}}|12d={{{12d|}}}|12def={{{12def|}}}|12stat={{{12stat|}}}
−
|desc={{#invoke:TemplateBox|description}}
+
|13={{{13|}}}|13d={{{13d|}}}|13def={{{13def|}}}|13stat={{{13stat|}}}|14={{{14|}}}|14d={{{14d|}}}|14def={{{14def|}}}|14stat={{{14stat|}}}
−
|templateDataInfo={{TemplateDataInfo/toggler}}
+
|15={{{15|}}}|15d={{{15d|}}}|15def={{{15def|}}}|15stat={{{15stat|}}}|16={{{16|}}}|16d={{{16d|}}}|16def={{{16def|}}}|16stat={{{16stat|}}}
−
|i18n-subpage={{#ifeq:{{{i18n-subpage|}}}|.
+
|17={{{17|}}}|17d={{{17d|}}}|17def={{{17def|}}}|17stat={{{17stat|}}}|18={{{18|}}}|18d={{{18d|}}}|18def={{{18def|}}}|18stat={{{18stat|}}}
−
  | Template:{{{name|{{BASEPAGENAME}}}}}
+
|19={{{19|}}}|19d={{{19d|}}}|19def={{{19def|}}}|19stat={{{19stat|}}}|20={{{20|}}}|20d={{{20d|}}}|20def={{{20def|}}}|20stat={{{20stat|}}}
−
  | Template:{{{name|{{BASEPAGENAME}}}}}/{{{i18n-subpage|i18n}}}
+
|21={{{21|}}}|21d={{{21d|}}}|21def={{{21def|}}}|21stat={{{21stat|}}}|22={{{22|}}}|22d={{{22d|}}}|22def={{{22def|}}}|22stat={{{22stat|}}}
−
  }}
+
|23={{{23|}}}|23d={{{23d|}}}|23def={{{23def|}}}|23stat={{{23stat|}}}|24={{{24|}}}|24d={{{24d|}}}|24def={{{24def|}}}|24stat={{{24stat|}}}
−
|usergroup={{lc:{{{usergroup|}}}}}
+
|25={{{25|}}}|25d={{{25d|}}}|25def={{{25def|}}}|25stat={{{25stat|}}}|26={{{26|}}}|26d={{{26d|}}}|26def={{{26def|}}}|26stat={{{26stat|}}}
−
|name={{{name|{{BASEPAGENAME}}}}}
+
|27={{{27|}}}|27d={{{27d|}}}|27def={{{27def|}}}|27stat={{{27stat|}}}|28={{{28|}}}|28d={{{28d|}}}|28def={{{28def|}}}|28stat={{{28stat|}}}
−
}}__NOEDITSECTION__<!--
+
|29={{{29|}}}|29d={{{29d|}}}|29def={{{29def|}}}|29stat={{{29stat|}}}|30={{{30|}}}|30d={{{30d|}}}|30def={{{30def|}}}|30stat={{{30stat|}}}
−
Auto-categorization by internationalisation approach
+
|name={{{name|}}}|desc={{{desc|}}}|namespace={{{namespace|}}}|usergroup={{lc:{{{usergroup|}}}}}|placement={{{placement|}}}|usage-notes={{{usage-notes|}}}|type={{{type|}}}|example={{{example|}}}|example2={{{example2|}}}|i18n-method={{{i18n-method|}}}|i18n-desc={{{i18n-desc|}}}|i18n-mediawiki-msg={{{i18n-mediawiki-msg|}}}|seealso={{{seealso|}}}|setscats={{{setscats|}}}|lines={{{lines|}}}|shorthand={{{shorthand|}}}|relieson={{{relieson|}}}|docsub-override={{{docsub-override|}}}|docsub-page={{{docsub-page|}}}|mustbesubst={{{mustbesubst|}}}
−
-->{{#ifeq:{{SUBPAGENAME}}|doc
+
}}</includeonly>__NOEDITSECTION__<noinclude>
−
| <!--Don't categorize documentation subpages-->
+
{{documentation}}
−
| {{#ifeq:{{NAMESPACE}}|Template
+
 
−
  | {{#switch:{{{i18n-method|}}}
+
</noinclude>
−
    |autotranslate=[[Category:Templates using Autotranslate for internationalisation]]
 
−
    |switch=[[Category:Templates using LangSwitch for internationalisation]]
 
−
    |custommediawiki-msg=[[Category:Templates using local MediaWiki messages for internationalisation]]
 
−
    |mediawiki-msg=[[Category:Templates using MediaWiki messages from translatewiki.net for internationalisation]]
 
−
    |ext.translate=[[Category:Templates using the Translate extension for internationalisation]]
 
−
    |-=[[Category:Templates not requiring internationalization]]
 
−
    |#default=[[Category:Templates using an unknown approach for internationalisation]]
 
−
  }}
 
−
  | <!--Don't categorise Creator templates-->
 
−
  }}
 
−
}}</includeonly><noinclude>{{Documentation}}</noinclude>
 

Latest revision as of 20:58, 13 September 2020

[edit] [[[:Template:Purge]]] Template-info.svg Template documentation
This documentation is transcluded from Template:TemplateBox/doc. (edit | history)


The template provides a uniform way to provide basic information about the use of a template.

Usage

{{TemplateBox
|1=
|1d=
|1def=
|1stat=
|name=
|desc=
|namespace=
|usergroup=
|placement=
|usage-notes=
|type=
|example=
|i18n-method=
|i18n-desc=
|i18n-mediawiki-msg=
|seealso=
|setscats=
|lines=
|shorthand=
|relieson=
|mustbesubst=
}}

Parameters

Parameter name Description Default value required or optional?

parameter #1 (1) parameter name (similarly 2, 3, …, up to 30) empty optional
1d description of the parameter (similarly 2d, 3d, …, up to 30d) empty optional
1def default value for the parameter (similarly 2def, 3def, …, up to 30def) empty optional
1stat status of the parameter (similarly 2stat, 3stat, …, up to 30stat); possible values:
required  
optional  
optional- 
optional and not present in the standard form
deprecated  
 optional optional
name name of the template (needed for viewing the documentation on another page than the template page, in particular for viewing the documentation page separately) {{PAGENAME}} required
desc description of what the template does empty required
namespace namespaces, the template is intended to be used in; possible values:
all
talks
contents
Main
Talk
User
User talk
Commons
Commons talk
File
File talk
MediaWiki
MediaWiki talk
Template
Template talk
Help
Help talk
Category
Category talk
Creator
Creator talk
Special

Any other values will show as “unknown”.

no namespace specified required
usergroup usergroup that is meant to use the template; possible values:
all
bot
administrator
admin
sysop
bureaucrat
crat
checkuser
licensereviewer
otrs
autoconfirmed
autopatrolled
filemover
oversight
patroller
rollbacker
steward
upwizcampeditors
 no user group specified required
placement placement on the page. Possible values:
top  
bottom  
licence  
source  
 empty optional
usage-notes notes about the correct usage of the template empty optional
type what type is the template (infobox, formatting, licence tag, …) empty optional
example example use (works with a single unnamed parameter only) empty optional
i18n-method method the localization is achieved by. Known values:
autotranslate 
using {{Autotranslate}} or applying a similar method
switch 
using {{LangSwitch}} in the template itself
- 
no localization needed
custommediawiki-msg 
using MediaWiki namespace messages
mediawiki-msg 
using MediaWiki namespace messages, translated on TranslateWiki
 empty optional
i18n-desc additional info about the localization empty optional
i18n-mediawiki-msg When using “mediawiki-msg” as method, optionally put the name of the message here. Falls back to:

Wm-license-{{lc:{{BASEPAGENAME}}}}-text

empty optional
seealso relevant links (put in a list of them) empty optional
setscats what categories are automatically set by the template (put in a linked list of them) one optional
lines are the parameters typically put into new lines or all on one line. Possible values:
multi 
multiple lines
one 
one line
 empty optional
shorthand shorthand for easy use (redirects to main template) empty optional
relieson list of templates on which the template's basic functionality relies empty optional
mustbesubst Set to "yes" (or any value) if the template must be substituted. This puts "subst:" into the template example under "usage". empty optional

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: all users

Placement:

in the '/doc' subpage of a template

Localization

English ∙

This template is localized through {{Autotranslate}}. The layout of the template can be found under Template:TemplateBox/layout.

To add your language to the list of languages supported by this template, please copy the code of Template:TemplateBox/en (or any other language version you prefer to translate) and replace the text strings in there (the form below can be used to create a translation, the English version is preloaded in the edit box). Please change the parameter lang from en (or whatever language you are translating) to the language code of your language.

<inputbox> type=create preload=Template:TemplateBox/en default=Template:TemplateBox/LANGCODE </inputbox>

Complications

( NOTE : the {{sed|1}} template links appears HERE : >>> ) Template:Sed

English: A complication is that the template suppresses section editing links on the whole page of the documented template, and also on its documentation page, even for paragraphs outside the part produced by this template TemplateBox. Template:Sed can be used (as is done here) to create an edit link anyway.

Template:Bar

Deutsch: Eine Schwierigkeit ist, dass die Vorlage eine Bearbeitung in den Abschnitten mittels des bekannten Links nicht zulässt. Dies betrifft sowohl die Vorlagenhauptseite als auch dessen Dokumentationsseite. Betroffen hiervon ist ebenso die dazu verwendete Vorlage „TemplateBox“. Mittels der Vorlage Template:Sed kann hier Abhilfe geschaffen werden, wie in diesem Abschnitt geschehen.
Français : Une autre complication est que le modèle de la section supprime l'édition de liens sur la page entière du modèle documenté, ainsi que sur sa page de documentation, même pour les paragraphes en dehors de la pièce produite par ce modèle TemplateBox. le modèle Template:Sed peut être utilisé (comme c'est le cas ici) pour créer quand même un lien modifier (edit).

Template:Pt


Retrieved from "https://www.digialcellulose.com/wiki/index.php?title=Template:TemplateBox&oldid=152815"