Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Module:Hatnote list/doc: Difference between revisions

From Poets.Wiki
Created page with "<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see Wikipedia:Wikidata) --> {{used in system|in MediaWiki:Wantedpages-summary}} {{Lua|Module:Format link|Module:Hatnote|Module:Arguments}} == 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><now..."
 
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{wikipedia|page name}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{used in system|in [[MediaWiki:Wantedpages-summary]]}}
{{Lua|Module:Format link|Module:Hatnote|Module:Arguments}}
{{Lua|Module:Format link|Module:Hatnote|Module:Arguments}}
== Usage from wikitext ==
== 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.:
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}}
*<code><nowiki>{{hatnote|PREFIX POSTFIX}}</nowiki></code> → {{hatnote|PREFIX POSTFIX}}


== Usage from Lua ==
== Usage from Lua ==
Line 19: Line 19:


===forSee===
===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]].
<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.
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.





Latest revision as of 08:25, 14 April 2025

This page uses Creative Commons Licensed content from Wikipedia (view authors).

Usage from wikitext

This module is not designed be used directly from wikitext even though forSee does take an initial frame argument and could potentially be used from wikitext, e.g.:

  • {{hatnote|PREFIX POSTFIX}}

Usage from Lua

To call the module, use

local mHatList = require('Module:Hatnote list')

or similar, then access its methods through the mHatList variable (or whatever was used).

andList

andList takes a list in table form, and returns

Cite error: Closing </ref> missing for <ref> tag</ref>a string with the list separated with "and" and commas as appropriate.

orList

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

forSee

_forSee 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 "For X, see [[Y]]" sentences. The links are formatted using the methods from Module:Hatnote.

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