Sí keldu fyri Module:Details/doc

This module produces a "for more details on this topic" link. It implements the {{tl|details}} template.

== Use from wikitext ==

This module cannot be used directly from #invoke. Instead, it can only be used through the {{tl|details}} template. Please see the template page for documentation.

== Use from other Lua modules ==

Load the module:

<syntaxhighlight lang="lua">
local mDetails = require('Module:Details')
</syntaxhighlight>

You can then use the _details function like this:

<syntaxhighlight lang="lua">
mDetails._details(page, topic, options)
</syntaxhighlight>

The <var>page</var> variable is the page to be linked to, and is required. The page name can include a section link if desired. If the page includes a section link, it is automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''.

The <var>topic</var> variable is a description of the topic, and is optional. The default topic value is "this topic".

The <var>options</var> table can be used to configure the function's output. At current, the only option available is "selfref", which is used when the output is a self-reference to Wikipedia. to set this option, use {{code|1={selfref = true}|2=lua}}. (See the {{tl|selfref}} template for more details on self-references.)

; Example 1
<syntaxhighlight lang="lua">
mDetails._details('Carbon dioxide data')
</syntaxhighlight>
Produces:
:<code><nowiki><div class="hatnote boilerplate seealso">For more details on this topic, see [[Carbon dioxide data]].</div></nowiki></code>
Displays as:
{{details|Carbon dioxide data}}

; Example 2
<syntaxhighlight lang="lua">
mDetails._details('Carbon dioxide data', 'the physical properties of carbon dioxide')
</syntaxhighlight>
Produces:
:<code><nowiki><div class="hatnote boilerplate seealso">For more details on the physical properties of carbon dioxide, see [[Carbon dioxide data]].</div></nowiki></code>
Displays as:
{{details|Carbon dioxide data|the physical properties of carbon dioxide}}

; Example 3
<syntaxhighlight lang="lua">
mDetails._details('Lua programming on Wikipedia', 'Wikipedia:Lua', {selfref = true})
</syntaxhighlight>
Produces:
:<code><nowiki><div class="hatnote selfref">For more details on Lua programming on Wikipedia, see [[Wikipedia:Lua]].</div></nowiki></code>
Displays as:
{{details|Wikipedia:Lua|Lua programming on Wikipedia|selfref=true}}

== Technical details ==

This module uses [[Module:Hatnote]] to format the hatnote text and [[Module:Arguments]] to fetch the arguments from wikitext.

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories go here and interwikis go in Wikidata. -->

}}</includeonly>