Mudanças

Ir para navegação Ir para pesquisar

Módulo:Hatnote list/doc

1 939 bytes adicionados, 09h23min de 18 de dezembro de 2019
Criação da Documentação do Módulo Hatnote list.
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{high-risk| 705000+ }}
{{used in system|in [[MediaWiki:Wantedpages-summary]]}}

== Usage from wikitext ==
This module is not designed be used directly from wikitext even though <code>forSee</code> does take an initial <code>frame</code> argument and could potentially be used from wikitext, e.g.:
*<code><nowiki>{{hatnote|PREFIX {{#invoke:Hatnote list|forSee|{{tl|For}}|Module:For|{{tl|About}}|Module:About}} POSTFIX}}</nowiki></code> → {{hatnote|PREFIX {{#invoke:Hatnote list|forSee|{{tl|For}}|Module:For|{{tl|About}}|Module:About}} POSTFIX}}

== Usage from Lua ==

To call the module, use <source lang="lua">local mHatList = require('Module:Hatnote list')</source> or similar, then access its methods through the <code>mHatList</code> variable (or whatever was used).

===andList===
<code>andList</code> takes a list in table form, and returns a string with the list separated with "and" and commas as appropriate.

===orList===
<code>orList</code> takes a list in table form, and returns a string with the list separated with "or" and commas as appropriate.

===forSee===
<code>_forSee</code> takes three arguments: a table of trimmed arguments with blanks removed, a "from" number with the index to start at, and an options table, and returns a string with a number of "<code><nowiki>For X, see [[Y]]</nowiki></code>" sentences. The links are formatted using the methods from [[Module:Hatnote]].

As a convenience, the <code>forSee</code> method (without the leading underscore) takes the same arguments except with a frame instead of an args table, using <code>getArgs()</code> from [[Module:Arguments]] to preprocess the arguments.


<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Hatnote modules| ]]
}}</includeonly>

Menu de navegação