Difference between revisions of "Template:API-editnotice/en"
Jump to navigation
Jump to search
Template documentation
Joelmartin (talk | contribs) m (Text replacement - "<tvar|(.*)>" to "") |
Joelmartin (talk | contribs) m (Undo revision 9661 by Joelmartin (talk)) Tag: Undo |
||
| Line 1: | Line 1: | ||
| + | <noinclude> | ||
| − | + | </noinclude>{{#switch: | |
| − | {{#switch: | ||
| = | | = | ||
| − | + | <div class="toccolours"> | |
| − | + | <div style="text-align:center; font-size:larger; font-weight:bold">Creating a new API documentation page<hr /></div> | |
; MW version | ; MW version | ||
: Since which MediaWiki version is this api (sub)module available? ([[Release notes]]) | : Since which MediaWiki version is this api (sub)module available? ([[Release notes]]) | ||
| Line 15: | Line 15: | ||
; Example(s): | ; Example(s): | ||
; Categories: | ; Categories: | ||
| − | + | </div> | |
{{Note|1=You should consider using {{tl|Api help}} to transclude API documentation generated by Special:ApiHelp/''module-name'', instead of writing duplicate documentation for parameters, examples, etc. ([[phab:T89318]])}} | {{Note|1=You should consider using {{tl|Api help}} to transclude API documentation generated by Special:ApiHelp/''module-name'', instead of writing duplicate documentation for parameters, examples, etc. ([[phab:T89318]])}} | ||
| #default= | | #default= | ||
{{#invoke:Template translation|renderTranslatedTemplate|template=Template:API-editnotice|noshift=1|uselang={{int:lang}}}} | {{#invoke:Template translation|renderTranslatedTemplate|template=Template:API-editnotice|noshift=1|uselang={{int:lang}}}} | ||
| − | + | }}<noinclude> | |
{{Documentation|content= | {{Documentation|content= | ||
| Line 26: | Line 26: | ||
}} | }} | ||
[[Category:API templates|{{PAGENAME}}]] | [[Category:API templates|{{PAGENAME}}]] | ||
| + | </noinclude> | ||
Latest revision as of 17:35, 21 December 2019
Creating a new API documentation page
- MW version
- Since which MediaWiki version is this api (sub)module available? (Release notes)
- API-head
- What's the prefix? Does this module require any rights or is it available to all anonymous users? Does it have to be POST'ed?
- Description
- Describe the module briefly in one or two sentences.
- Parameters
- Error Codes
- Example(s)
- Categories
You should consider using {{Api help}} to transclude API documentation generated by Special:ApiHelp/module-name, instead of writing duplicate documentation for parameters, examples, etc. (phab:T89318)
Template documentationTemplate:API-addnew uses this to guide a wiki editor creating a new API page.