ਮੌਡਿਊਲ:Category main article

This module produces hatnote saying "The main article for this category is x." It implements the {{Category main article}} template.

Use from wikitext

This module should usually be used via the {{Category main article}} template. However, it can also be used from #invoke with the syntax {{#invoke:Category main article|catMain|parameters}}. Please see the {{Category main article}} template documentation for available parameters.

Use from other Lua modules

Load the module:

local mCatMain = require('Module:Category main article')

You can then use the _catMain function like this:

mCatMain._catMain(options, ...)

options is an optional table that can be used to configure the function's output. There are two available options, "article" and "selfref".

• article - if this is set to false, "no", "n", "false", or 0, the module outputs "The main page" rather than "The main article". Use the code {article = false}.
• selfref - this is used when the output is a self-reference to Wikipedia. To set this option, use {selfref = true}. (See the {{selfref}} template for more details on self-references.)

The remaining arguments are page names to be turned into link(s) following the text "The main article for this category is". If no page names are specified, the current page name (minus the namespace name) is used for the first link.

Example 1

mCatMain._catMain(nil, 'Foo')

Produces:

<div class="hatnote relarticle mainarticle">The main article for this [[Help:Categories|category]] is '''[[Foo]]'''.</div>

Displays as:

ਇਸ ਸ਼੍ਰੇਣੀ ਲਈ ਮੁੱਖ ਲੇਖ Foo ਹੈ।

Example 2

mCatMain._catMain(nil, 'Foo', 'Bar', 'Baz')

Produces:

<div class="hatnote relarticle mainarticle">The main articles for this [[Help:Categories|category]] are '''[[Foo]]''', '''[[Bar]]''' and '''[[Baz]]'''.</div>

Displays as:

ਇਸ ਸ਼੍ਰੇਣੀ ਲਈ ਮੁੱਖ ਲੇਖ Foo, Bar ਅਤੇ Baz ਹਨ।

Example 3

mCatMain._catMain({article = false}, 'Foo')

Produces:

<div class="hatnote relarticle mainarticle">The main page for this [[Help:Categories|category]] is '''[[Foo]]'''.</div>

Displays as:

ਇਸ ਸ਼੍ਰੇਣੀ ਲਈ ਮੁੱਖ ਸਫ਼ਾ Foo ਹੈ।

Technical details

This module uses Module:Hatnote to format the hatnote text.

---

-- This module implements {{cat main}}.

local mHatnote = require('Module:Hatnote')
local mFormatLink = require('Module:Format link')
local yesno = require('Module:Yesno')
local mTableTools -- lazily initialise
local mArguments -- lazily initialise

local p = {}

function p.catMain(frame)
	mTableTools = require('Module:TableTools')
	mArguments = require('Module:Arguments')
	local args = mArguments.getArgs(frame, {wrappers = 'Template:Category main article'})
	local pages = mTableTools.compressSparseArray(args)
	local options = {
		article = args.article,
		selfref = args.selfref
	}
	return p._catMain(options, unpack(pages))
end

function p._catMain(options, ...)
	options = options or {}

	-- Get the links table.
	local links = mFormatLink.formatPages({}, {...})
	if not links[1] then
		local page = mw.title.getCurrentTitle().text
		links[1] = mFormatLink._formatLink{link = page}
	end
	for i, link in ipairs(links) do
		links[i] = string.format("'''%s'''", link)
	end

	-- Get the pagetype.
	local pages = {...}
	local pagetype 
	
	if options.article ~= nil then
		pagetype = yesno(options.article) ~= false and 'ਲੇਖ' or 'ਸਫ਼ਾ'
	elseif pages and pages[1] then
		local page = pages[1]:gsub("|.*","")
		pagetype = mw.title.new(page).namespace == 0 and "ਲੇਖ" or "ਸਫ਼ਾ"
	else
		pagetype = "ਲੇਖ"
	end

	-- Work out whether we need to be singular or plural.
	local stringToFormat
	if #links > 1 then
		stringToFormat = 'ਇਸ [[ਮਦਦ:ਸ਼੍ਰੇਣੀਆਂ|ਸ਼੍ਰੇਣੀ]] ਲਈ ਮੁੱਖ %s %s ਹਨ।'
	else
		stringToFormat = 'ਇਸ [[ਮਦਦ:ਸ਼੍ਰੇਣੀਆਂ|ਸ਼੍ਰੇਣੀ]] ਲਈ ਮੁੱਖ %s %s ਹੈ।'
	end

	-- Get the text.
	local text = string.format(
		stringToFormat,
		pagetype,
		mw.text.listToText(links)
	)
	
	-- Pass it through to Module:Hatnote.
	local hnOptions = {}
	hnOptions.selfref = options.selfref

	return mHatnote._hatnote(text, hnOptions)
end

return p