Module:Other uses

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

This module produces an "other uses" hatnote for linking to disambiguation pages. It implements the {{other uses}} template.

Usage from wikitext

otheruses()

The otheruses() function directly implements {{other uses}} and probably shouldn't be used anywhere else.

otherX()

The otherX() function allows direct implementation of templates that differ from {{other uses}} in only phrasing. For example, where {{other uses}} is phrased with "other uses", {{other places}} is phrased with "other places with the same name" and can be implemented using otherX(), which takes the custom phrasing as its parameter at the module invocation. {{other places}} in particular could be implemented with this wikitext:

{{#invoke:other uses|otherX|places with the same name}}

Note that the leading "other" is automatically supplied; if a template would not use this phrasing, it should not use otherX().

Usage from Lua

To use this module from Lua, first load the module:

local mOtheruses = require('Module:Other uses')

The module functions can then be used through the _otheruses() function:

mOtheruses._otheruses(args, options)

Parameters of _otheruses()

args

A table containing strings of link text, without brackets. For example, {"PAGE1", "PAGE2#SECTION", "PAGE3|LABEL"}. Make sure that there are no gaps or nil values, as that can confuse the mw.text.listToText() function the module uses. If in doubt, use compressSparseArray() from Module:TableTools. This may be empty or nil.

options

A table containing a number of optional named values; you must supply at least one of options.defaultPage or options.title; in most cases setting the latter to mw.title.getCurrentTitle().prefixedText is advisable. The following options are supported:

• defaultPage: String; completely overrides the linked page when no arguments are supplied
• title: String; sets the title used before the "(disambiguation)" suffix.
• disambiguator: String; replaces "disambiguation" in the suffix
• otherText: String; replaces "uses" in "other uses"

The above documentation is transcluded from Module:Other uses/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.

local mHatnote = require('Module:Hatnote')
local mArguments --initialize lazily
local mTableTools --initialize lazily
local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType

local p = {}

--Produces standard {{other uses}} implementation
function p.otheruses(frame)
	mArguments = require('Module:Arguments')
	mTableTools = require('Module:TableTools')
	local args = mTableTools.compressSparseArray(mArguments.getArgs(frame))
	local title = frame:getParent():getTitle()
	return p._otheruses(args, {title=title})
end

--Main generator
--Two parameters, args and options, each tables:
--  * args: can be empty or nil, in which case the defaults kick in.
--    Otherwise assumed to be a table of unbracketed page strings, no table gaps
--  * options: must not be nil; it must have in a "defaultPage" or "title" option,
--    since this function doesn't use a frame object to do the defaulting itself.
--    Summary of options available:
--      * defaultPage: sets full default "other uses" target; overrides title and disambiguator
--      * title: sets title assumed that gets the suffix added
--      * disambiguator: sets default text appearing in parens, defaults to "disambiguation"
--      * otherText: allows setting more "other" options, defaults to "uses"
function p._otheruses(args, options)
	checkType('_otheruses', 1, args, 'table', true)
	if not args then args = {} end
	checkType('_otheruses', 2, options, 'table')
	if not (options.defaultPage or options.title) then
		error('No default title data provided in "_otheruses" options table', 2)
	end
	if #args == 0 then
		args = {
			options.defaultPage or
			(options.title .. '  (' .. (options.disambiguator or 'disambiguation') .. ')')
		}
	end
	local forOther = 'For other ' .. (options.otherText or 'uses') .. ', '
	local see = 'see ' .. mw.text.listToText(mHatnote.formatPages(unpack(args))) .. "."
	local text = forOther .. see
	
	return mHatnote._hatnote(text)
end

return p