Difference between revisions of "Template:Api help"
Jump to navigation
Jump to search
Template documentation
Joelmartin (talk | contribs) m (1 revision imported) |
Joelmartin (talk | contribs) m (Text replacement - "</>" to "") |
||
(5 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<noinclude> | <noinclude> | ||
− | + | ||
</noinclude> | </noinclude> | ||
− | {{#switch: | + | {{#switch: |
| = | | = | ||
<hr/>{{ombox | <hr/>{{ombox | ||
|image=[[File:Tools clipart.png|20px]] | |image=[[File:Tools clipart.png|20px]] | ||
− | | text= | + | | text= The following documentation is the output of <tvar|special>[[Special:ApiHelp/{{{1|}}}]], automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org). |
}} | }} | ||
<includeonly><!-- | <includeonly><!-- | ||
Line 17: | Line 17: | ||
{{Documentation|content= | {{Documentation|content= | ||
− | + | ||
− | + | ||
This transcludes Special:ApiHelp/''module-name'' and explains what's going on. | This transcludes Special:ApiHelp/''module-name'' and explains what's going on. | ||
− | == Usage == | + | == Usage == |
− | + | ||
; 1 | ; 1 | ||
− | : | + | : module name. No leading space. You can reference query submodules by ''module''+''submodule'' |
+ | |||
+ | |||
+ | == Sample == | ||
− | |||
− | |||
− | |||
<code><nowiki>{{Api help|query+extracts}}</nowiki></code> produces | <code><nowiki>{{Api help|query+extracts}}</nowiki></code> produces | ||
---- | ---- | ||
{{Api help|query+extracts}} | {{Api help|query+extracts}} | ||
---- | ---- | ||
− | {{Note|1= | + | {{Note|1= You can't transclude the help of multiple API modules at once}} |
}} | }} | ||
− | [[Category:API templates | + | [[Category:API templates|{{PAGENAME}}]] |
</noinclude> | </noinclude> |
Latest revision as of 15:40, 21 December 2019
![]() | The following documentation is the output of <tvar |

This transcludes Special:ApiHelp/module-name and explains what's going on.
Usage
- 1
- module name. No leading space. You can reference query submodules by module+submodule
Sample
{{Api help|query+extracts}}
produces
![]() | The following documentation is the output of <tvar |
Module "query+extracts" not found.
You can't transclude the help of multiple API modules at once