Difference between revisions of "Template:Documentation/preload-module-doc"

From blackwiki
Jump to navigation Jump to search
test>Incnis Mrsi
(Created page with '<noinclude>{{ombox|image=128px |text=The stuff below is a mediawikiwiki:Manual:Creating_pages_with_preloaded_text|preloaded templat...')
 
m (11 revisions imported)
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<noinclude>{{ombox|image=[[Image:Template-info.png|128px]]
+
<noinclude>{{Ombox |style=margin-bottom:2.0em; |image=[[File:Template-info.png|128px|alt=|link=]] |text=The text below is a [[mw:Manual:Creating pages with preloaded text|preloaded template]] for module documentation pages. It is not actual documentation.}}</noinclude>{{tl|Module rating |<!-- Values:  pre-alpha • alpha • beta • release • protected  --  If a rating not needed/relevant, delete this template call -->}}
|text=The stuff below is a [[mediawikiwiki:Manual:Creating_pages_with_preloaded_text|preloaded template]] for modules’ documentation pages. It is not an actual documentation.}}
+
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
</noinclude>
 
{{module rating|alpha}}<!-- delete if this is not desirable -->
 
 
 
The module “{{BASEPAGENAME}}” contains (specify) available calls that make so and such.
 
 
 
 
== Usage ==
 
== Usage ==
  
&#123;{#invoke:{{BASEPAGENAME}}|''function_name''<!-- fill an actual name -->|…}}
+
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''function_name''}}</code>
 
 
== Parameters ==
 
 
 
The text below assumes that functions are declared as
 
function p.''function_name''( frame )
 
<!-- delete this paragraph, it is indended for the module’s author, not a user -->
 
 
 
* Positional parameters – the value of frame.args[1] is passed after ''function name'' and vertical bar, the value of frame.args[2] is passed after the value of frame.args[1] and vertical bar, and so on.<!-- rewrite the item -->
 
* Named parameters (specify them) – the same ''name''=''value'' syntax as in MediaWiki templates, are accessible inside the function as frame.args["''name''"].<!-- rewrite or delete the item -->
 
  
== Examples ==
+
<include<includeonly></includeonly>only>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
{{Further|Module:{{BASEPAGENAME}}/testcases}}<!-- delete if you do not intend to create the red-linked page -->
+
<!-- Categories below this line, please; interwikis at Wikidata -->
  
{<includeonly>{</includeonly>#invoke: {{BASEPAGENAME}} | main | test }}
+
}}</include<includeonly></includeonly>only>

Latest revision as of 10:24, 7 September 2020

{{Module rating }}

Usage

{{#invoke:Documentation|function_name}}

<includeonly></includeonly>