Module:About

Template documentation follows
Note: the template above may sometimes be partially or fully invisible.
Visit Module:About/doc to edit this documentation. (How does this work?)

This template is imported from Module:About on Wikipedia.

This template is imported from the English Wikipedia. Although the visual appearance might be different, the functionality is identical. Please refer to the Module:About page on Wikipedia for detailed documentation.

{{About}} is a commonly used hatnote template, and should be placed at the top of an article, linking the reader to other articles with similar titles or concepts that they may have been seeking instead.

TemplateData

This template is a hatnote in the format "This page is about … For other uses …".

Template parameters[Edit template data]

Parameter		Description	Type	Status
Page description	1	What the page this template is placed on is about ("This page is about …")	String	required
Other page 1 description	2	What the first other page is about. If unused or blank, defaults to "For other uses".	String	suggested
Other page 1 title	3	The title of the first other page. If unused, defaults to "[page title] (disambiguation)".	Page name	suggested
Other page 2 description	4	What the second other page is about.	String	optional
Other page 2 title	5	The title of the second other page. If unused or blank and parameter 4 exists, defaults to "[page title] (disambiguation)".	Page name	optional
Other page 3 description	6	What the third other page is about.	String	optional
Other page 3 title	7	The title of the third other page. If unused or blank and parameter 6 exists, defaults to "[page title] (disambiguation)".	Page name	optional
Other page 4 description	8	What the fourth other page is about.	String	optional
Other page 4 title	9	The title of the fourth other page. If unused or blank and parameter 8 exists, defaults to "[page title] (disambiguation)".	Page name	optional
section	section	Pass "yes" in this parameter to get wording appropriate for use at the top of a section. Auto value yes	String	optional
Custom text	text	Text to be appended to the end.	String	optional

This template is imported from Module:About on Wikipedia.

This template is imported from the English Wikipedia. Although the visual appearance might be different, the functionality is identical. Please refer to the Module:About page on Wikipedia for detailed documentation.

Module:Hatnote implements the {{about}} template.

---

local mArguments --initialize lazily
local mHatnote = require('Module:Hatnote')
local mHatList = require('Module:Hatnote list')
local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType
local p = {}

function p.about (frame)
	-- A passthrough that gets args from the frame and all
	mArguments = require('Module:Arguments')
	args = mArguments.getArgs(frame)
	return p._about(args)
end


function p._about (args, options)
	-- Produces "about" hatnote.

	-- Type checks and defaults
	checkType('_about', 1, args, 'table', true)
	args = args or {}
	checkType('_about', 2, options, 'table', true)
	options = options or {}
	local defaultOptions = {
		aboutForm = 'This %s is about %s. ',
		PageType = require('Module:Pagetype').main(),
		namespace = mw.title.getCurrentTitle().namespace,
		otherText = nil, --included for complete list
		sectionString = 'section'
	}
	for k, v in pairs(defaultOptions) do
		if options[k] == nil then options[k] = v end
	end

	-- Set initial "about" string
	local pageType = (args.section and options.sectionString) or options.PageType
	local about = ''
	if args[1] then
		about = string.format(options.aboutForm, pageType, args[1])
	end
	
	--Allow passing through certain options
	local fsOptions = {
		otherText = options.otherText,
		extratext = args.text
	}
	local hnOptions = {
		selfref = args.selfref,
		icon = 'WikimediaUI-ArticleDisambiguation-ltr.svg'
	}

	-- Set for-see list
	local forSee = mHatList._forSee(args, 2, fsOptions)

	-- Concatenate and return
	return mHatnote._hatnote(about .. forSee, hnOptions)
end

return p