View source for Template:Scribunto/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
== Usage ==
This helps with the creation of doc pages for Lua metamodules that reference the {{Scribunto}} or specific function within it.

<pre>
{{scribunto
|<!--anchor-->
|<!--link text-->
}}
</pre>

If an anchor is provided, the link will be wrapped in {{tag|code}}. For example:{{demo|<nowiki>{{scribunto|mw.html.create}}</nowiki>|br=produces this link:&nbsp;}}

{{demo|<nowiki>{{scribunto|HTML_library|mw.html}}</nowiki>|br=produces this link:&nbsp;}}

=== Advanced ===
===={{para|self}} and {{para|args}}====
{{seealso2|{{t|Luaself}}}}
You may also use {{para|self|<nowiki>{{PAGENAME}}</nowiki>}} to reference your own functions and {{para|args}} to specify args, like so:{{demo|<nowiki>{{scribunto|self=Buffer/doc|:_all|args=...}}</nowiki>|br=produces this link:&nbsp;}}

If the first char {{luaref|string.match|matches|plain=y}} the pattern {{code|^[:%.]}} then title specified by {{para|self}} will be inserted in front, minus any subpages, unless {{luaref|escape|plain=y}}d with the {{code|\}} char:
{{demo|<nowiki>{{scribunto|self=Example\/testcases/doc|.test1|args=string}}</nowiki>|br=produces:&nbsp;}}
=====no 'main'=====
If your module has no "main" method (e.g. [[Module:Buffer]]), you can pass the escape char {{code|\}} as the first char in the function name to make a self-reference:{{demo|<nowiki>{{scribunto|self=Buffer/doc|\|args=...}}</nowiki>|br=produces:&nbsp;}}'

If the second parameter contains {{code|***}}, then the first param will be substituted (or the self-reference, as applicable): {{demo|<nowiki>{{scribunto|self=Buffer|\|require('Module:***')|args=...}}</nowiki>|br=0}}

===={{para|args2}} and {{para|args3}}====
Use to specify up to 3 argument variations.{{demo|<nowiki>{{scribunto|table.insert|args=table, value|args2=table, pos, value}}</nowiki>|br=0}}

===={{para|plain}}====
If set to anything, the result will no longer be wrapped in {{tag|code}}.

==See also==
*{{t|{{BASEPAGENAME}}/helper}} and {{t|{{BASEPAGENAME}}/helper2}}, two helper templates.  These should not be called directly.
*{{t|Luaself}}, a wrapper template that makes Lua self-references easier.
*[[Module:Buffer/doc]], an example of a doc that uses this
*{{t|Lua}}
*[[:Category:Lua metamodules]]

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Documentation see also templates]]
[[Category:Module documentation pages|*]]
}}</includeonly>