Difference between revisions of "Template:API-head"

From RobotX
Jump to navigation Jump to search
Mediawiki>Shirayuki
m
 
m (Undo revision 10248 by Joelmartin (talk))
Tag: Undo
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
<languages/>
+
 
</noinclude>{{#switch:<translate></translate>
+
</noinclude>{{#switch:
 
| =
 
| =
 
<table {{Databox-layout|style=margin:{{dir|{{pagelang}}|5px 12px 5px 0|5px 0 5px 12px}};}}><tr>
 
<table {{Databox-layout|style=margin:{{dir|{{pagelang}}|5px 12px 5px 0|5px 0 5px 12px}};}}><tr>
 
<th {{Databox-head}}>{{{module|{{BASEPAGENAME}}}}}</th>
 
<th {{Databox-head}}>{{{module|{{BASEPAGENAME}}}}}</th>
 
</tr><tr>
 
</tr><tr>
<td colspan="2" style="text-align:center; padding:0.3em; font-style:italic">{{{description|}}}{{#switch: {{{generator|}}} |#default=<br /><small><translate><!--T:1--> This module cannot be used as a <tvar|generator>{{ll|API:generator|nsp=0}}</>.</translate></small>|yes=<br /><small><translate><!--T:2--> This module can be used as a <tvar|generator>{{ll|API:generator|nsp=0}}</>.</translate></small>}}</td>
+
<td colspan="2" style="text-align:center; padding:0.3em; font-style:italic">{{{description|}}}{{#switch: {{{generator|}}} |#default=<br /><small> This module cannot be used as a <tvar|generator>{{ll|API:generator|nsp=0}}.</small>|yes=<br /><small> This module can be used as a <tvar|generator>{{ll|API:generator|nsp=0}}.</small>}}</td>
 
</tr><tr>
 
</tr><tr>
<th><translate><!--T:3--> Prefix</translate></th>
+
<th> Prefix</th>
<td>{{#switch: {{lc:{{{prefix|none}}}}} |none=''<translate><!--T:4--> none</translate>'' |#default={{{prefix}}} }}</td>
+
<td>{{#switch: {{lc:{{{prefix|none}}}}} |none='' none'' |#default={{{prefix}}} }}</td>
 
</tr><tr>
 
</tr><tr>
<th><translate><!--T:5--> Required rights</translate></th>
+
<th> Required rights</th>
<td>{{#switch: {{lc:{{{rrights|none}}}}} |none=''<translate><!--T:6--> none</translate>'' |#default={{{rrights}}} }}</td>
+
<td>{{#switch: {{lc:{{{rrights|none}}}}} |none='' none'' |#default={{{rrights}}} }}</td>
 
</tr><tr>
 
</tr><tr>
<th><translate><!--T:7--> Post only?</translate></th>
+
<th> Post only?</th>
<td>{{#switch: {{lc:{{{postonly|no}}}}} |no=<translate><!--T:8--> No</translate> |#default=<translate><!--T:9--> Yes</translate> }}</td>
+
<td>{{#switch: {{lc:{{{postonly|no}}}}} |no= No |#default= Yes }}</td>
 
</tr><tr>
 
</tr><tr>
<th><translate><!--T:12--> Generated help</translate></th>
+
<th> Generated help</th>
<td>[//{{{site|www.mediawiki.org}}}/w/api.php?action=help&modules={{#ifeq: {{lc:{{{query|{{{generator|}}}}}}}} | yes |query+}}{{lc:{{{module|{{IfNotTranslation|{{PAGENAMEE}}|{{BASEPAGENAMEE}}}}}}}}} <translate><!--T:13--> Current</translate>]</td>
+
<td>[//{{{site|www.mediawiki.org}}}/w/api.php?action=help&modules={{#ifeq: {{lc:{{{query|{{{generator|}}}}}}}} | yes |query+}}{{lc:{{{module|{{IfNotTranslation|{{PAGENAMEE}}|{{BASEPAGENAMEE}}}}}}}}} Current]</td>
 
{{#if:{{{version|}}}|
 
{{#if:{{{version|}}}|
 
</tr><tr>
 
</tr><tr>
<th><translate><!--T:14--> Version added</translate></th>
+
<th> Version added</th>
 
<td>{{MW version|version={{{version|?}}}|compact=yes|comment=and after}}</td>
 
<td>{{MW version|version={{{version|?}}}|compact=yes|comment=and after}}</td>
 
}}
 
}}
Line 27: Line 27:
 
{{#ifeq:{{{templatemode|}}}|nocat|
 
{{#ifeq:{{{templatemode|}}}|nocat|
 
   |{{#ifeq:{{{generator|}}}|yes
 
   |{{#ifeq:{{{generator|}}}|yes
     |[[Category:MediaWiki API generators{{#translation:}}]]}}
+
     |[[Category:MediaWiki API generators]]}}
 
}}</includeonly>
 
}}</includeonly>
 
| #default=
 
| #default=
Line 34: Line 34:
 
{{Documentation|content=
 
{{Documentation|content=
  
<translate>
+
 
== Usage == <!--T:10-->
+
== Usage ==  
</translate>
+
 
 
{{clear}}
 
{{clear}}
 
Displays a box providing more information about an API module.
 
Displays a box providing more information about an API module.
  
 
See also {{tl|ApiEx}} which transcludes the generated API documentation
 
See also {{tl|ApiEx}} which transcludes the generated API documentation
<translate>
+
 
== Examples == <!--T:11-->
+
== Examples ==  
</translate>
+
 
 
{{API-head|templatemode=nocat
 
{{API-head|templatemode=nocat
 
|version=1.11
 
|version=1.11
Line 85: Line 85:
 
{{clear}}
 
{{clear}}
 
}}
 
}}
[[Category:API templates{{#translation:}}]]
+
[[Category:API templates]]
 
</noinclude>
 
</noinclude>

Latest revision as of 17:13, 21 December 2019


Template documentation

Usage

Displays a box providing more information about an API module.

See also {{ApiEx}} which transcludes the generated API documentation

Examples

{{API-head
|version=1.11
|prefix=sr
|rrights=None
|postonly=No
|description=Perform a full text search
|generator=yes
}}
{{API-head
|module=edit
|version=1.13
|prefix=
|rrights=edit
|postonly=Yes
|description=
|query=no
}}