Module:Details

Module documentation[view] [edit] [history] [purge]

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

Use from wikitext

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

Use from other Lua modules

Load the module:

local mDetails = require('Module:Details')

You can then use the _details function like this:

mDetails._details(page, topic, options)

The page 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 topic variable is a description of the topic, and is optional. The default topic value is "this topic".

The options 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 WikiDevi. to set this option, use {selfref = true}. (See the {{selfref}} template for more details on self-references.)

Example 1

mDetails._details('Carbon dioxide data')

Produces:

<div class="hatnote boilerplate seealso">For more details on this topic, see [[Carbon dioxide data]].</div>

Displays as:

For more details on this topic, see Carbon dioxide data.

Example 2

mDetails._details('Carbon dioxide data', 'the physical properties of carbon dioxide')

Produces:

<div class="hatnote boilerplate seealso">For more details on the physical properties of carbon dioxide, see [[Carbon dioxide data]].</div>

Displays as:

For more details on the physical properties of carbon dioxide, see Carbon dioxide data.

Example 3

mDetails._details('Lua programming on WikiDevi', 'WikiDevi:Lua', {selfref = true})

Produces:

<div class="hatnote selfref">For more details on Lua programming on WikiDevi, see [[WikiDevi:Lua]].</div>

Displays as:

For more details on Lua programming on WikiDevi, see WikiDevi:Lua.

Technical details

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

--[[
-- This module produces a "For more details on this topic" link. It implements
-- the {{details}} template.
--]]

local mHatnote = require('Module:Hatnote')
local mArguments -- lazily initialise

local p = {}

function p.details(frame)
	mArguments = require('Module:Arguments')
	local args = mArguments.getArgs(frame, {parentOnly = true})
	local page = args[1]
	local topic = args[2]
	if not page then
		return mHatnote.makeWikitextError(
			'no page name specified',
			'Template:Details#Errors',
			args.category
		)
	end
	local options = {
		selfref = args.selfref,
	}
	return p._details(page, topic, options)
end

function p._details(page, topic, options)
	page = mHatnote._formatLink(page)
	topic = topic or 'this topic'
	local text = string.format('For more details on %s, see %s.', topic, page)
	options = options or {}
	options.extraclasses = 'boilerplate seealso'
	return mHatnote._hatnote(text, options)
end

return p