Module:Page assessment: Difference between revisions

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

This module returns a page's assessment (class rating), by:

• Detecting non-existent pages (Needed class); or
• Detecting non-existent talk pages (Unassessed class); or
• Detecting redirects and disambiguation pages (Redirect or Disambig class); or
• Looking at the talk page for the value in the first |class= parameter; or
• Looking at the namespace of the page

Usage

text

Returns the class as text. {{#invoke:Page assessment|main|page name}}

Examples

{{#invoke:Page assessment|main|Wikipedia}} →

{{#invoke:Page assessment|main|Wiktionary}} →

{{#invoke:Page assessment|main|Wikt}} →

icon

Returns the class as an icon. {{#invoke:Page assessment|icon|page name}}

Examples

{{#invoke:Page assessment|icon|Wikipedia}} →

{{#invoke:Page assessment|icon|Wiktionary}} →

{{#invoke:Page assessment|icon|Wikt}} →

iconLink

Returns the class as an icon and a link to the page. {{#invoke:Page assessment|iconLink|page name}}

Examples

{{#invoke:Page assessment|iconLink|Wikipedia}} →

{{#invoke:Page assessment|iconLink|Wiktionary}} →

{{#invoke:Page assessment|iconLink|Wikt}} →

In other templates

The output can be passed into other templates or modules, for example to generate table cells:

{|class=wikitable
! Class !! Article
|-
{{class|{{#invoke:Page assessment|main|Wiktionary}}}}<td>[[Wiktionary]]</td>
|}

Class	Article
???	Wiktionary

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

require('Module:No globals')
local getArgs = require('Module:Arguments').getArgs
local mDisambiguation = require('Module:Disambiguation')
local p = {}
local util = {}
local classByNamespace = {
	[710] = "File", -- TimedText namespace
    [6]   = "File",
    [14]  = "Category",
    [100] = "Portal",
    [828] = "Template", -- Module namespace
    [10]  = "Template",
    [4]   = "Project", -- Wikipedia namespace
    [118] = "Draft",
    [108] = "Book",
    [0]   = "" -- Mainspace (leave unassessed)
}

--[[
Gets the wikitext of a page and its related talk or subject page (nil if it does
not exist)

@param {string} pageName
@returns {string|nil, string|nil} subject page wikitext, talk page wikitex
]]--
function util.getWikitext(pageName)
	local title = mw.title.new(pageName)
	if not title then
		return nil, nil
	end
	local subjectTitle = title.subjectPageTitle
	local talkpageTitle = title.talkPageTitle
	return subjectTitle:getContent(), talkpageTitle:getContent()
end

--[[
Checks if a page is a redirect without using the expensive mw.title.isRedirect

@param {string} wikitext - page wikitext, from mw.title:getContent()
@returns {boolean}
--]]
function util.isRedirect(wikitext)
	return string.match(
		wikitext,
		"^%s*#[Rr][Ee][Dd][Ii][Rr][Ee][Cc][Tt]"
	) and true or false
end
--[[
Creates a pattern for finding the value given to a parameter within any template
call.

@param {string} param
@returns {string} pattern
]]--
function util.paramValuePattern(param)
	return "{{[^}]*|%s*" .. param .. "%s*=([^|{}]+)"
end

--[[
Assigns a class rating based on namespace, for non-article pages

@param {string} pageName - name of page, or its talk page
@returns {string} class or empty string
]]--
function util.classByNamespace(pageName)
	local title = mw.title.new(pageName)
	if not title then return "" end
	local nsNumber = title.subjectPageTitle.namespace
	return classByNamespace[nsNumber] or "NA"
end

function p.class(pageName)
	local subjectWikitext, talkpageWikitext = util.getWikitext(pageName)
	if not subjectWikitext then -- page does not exist
		return "needed"
	elseif not subjectWikitext then -- talk page does not exist
		return "unassessed"
	elseif util.isRedirect(subjectWikitext) then
		return "redirect"
	elseif mDisambiguation.isDisambiguation(subjectWikitext) then
		return "disambig"
	else
		local classParam = mw.text.trim(
			mw.ustring.match(talkpageWikitext, "{{.-%|%s*class%s*=([^}%|]*)", 0) or ""
		)
		if classParam == "" then
			return util.classByNamespace(pageName)
		else
			return classParam
		end
	end
end

function p.main(frame)
	local args = getArgs(frame, {
		parentFirst = true
	})
	return p.class(args[1])
end

p.util = util
return p