Difference between revisions of "Module:Page"

From blackwiki
Jump to navigation Jump to search
blackwiki>Liangent
m (36 revisions imported)
 
(21 intermediate revisions by 7 users not shown)
Line 1: Line 1:
---- This module is meant to allow the goodies listed in
+
local callAssert = require('Module:CallAssert')
---- http://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Title_objects
 
---- to be accessed by people who don't want to program a Lua module.
 
---- Usage is:  {{#invoke:Page|(function)|parameters}}
 
---- (function) is one of the function names from the table above:
 
---- id, interwiki, namespace, fragment, nsText, subjectNsText, text, prefixedText, fullText ...
 
  
---- parameters are:
+
local function main(frame, field)
---- page = (name of page to load; leave blank to call mw.title.getCurrentTitle()
+
local args, pargs = frame.args, ( frame:getParent() or {} ).args or {}
----    this is "text" passed to mw.title.new or "title" passed to mw.title.makeTitle
+
local makeTitle=args.makeTitle or pargs.makeTitle
---- makeTitle = nonblank to call mw.title.makeTitle otherwise mw.title.new is called
+
local namespace=args.namespace or pargs.namespace or ""
---- namespace = (parameter passed to new/makeTitle)
+
local fragment=args.fragment or pargs.fragment or ""
---- fragment = (parameter passed to makeTitle)
+
local interwiki=args.interwiki or pargs.interwiki or ""
---- interwiki = (parameter passed to makeTitle)
+
local page=args.page or args[1] or pargs.page or pargs[1] or ""
---- p1 = first parameter passed to functions within the title object
+
local id= tonumber( args.id or pargs.id )
---- p2 = second parameter " " " "
+
local pn = {}
---- p3 etc. (for inNamespaces)
+
local title -- holds the result of the mw.title.xxx call
  
 +
for i = 1,9 do pn[i] = args['p'..i] or pargs['p'..i] end
 +
if not id and not mw.ustring.match( page, '%S' ) then page = nil end
  
 +
if id then
 +
title = callAssert(mw.title.new, 'mw.title.new', id)
 +
elseif not page then
 +
title = callAssert(mw.title.getCurrentTitle, 'getCurrentTitle')
 +
elseif makeTitle then
 +
title = callAssert(mw.title.makeTitle, 'makeTitle', namespace, page, fragment, interwiki)
 +
else
 +
title = callAssert(mw.title.new, 'mw.title.new', page, namespace)
 +
end
  
---- Sorry, getContents doesn't work for many applications because all templates are destroyed.  It does work on plain text though.
+
local result = title[field]
 +
if type(result) == "function" then
 +
result = result(title, unpack(pn))
 +
end
  
local p = {}
+
return tostring(result or "")
 
 
function p.main(frame)
 
    local args=frame.args
 
    local parent=frame.getParent(frame)
 
    local pargs={}
 
    if parent then pargs=parent.args end
 
    local makeTitle=args.makeTitle or pargs.makeTitle or ""
 
    local namespace=args.namespace or pargs.namespace or ""
 
    local fragment=args.fragment or pargs.fragment or ""
 
    local interwiki=args.interwiki or pargs.interwiki or ""
 
    local p1 = args.p1 or pargs.p1 or ""
 
    local p2 = args.p2 or pargs.p2 or ""
 
    local p3 = args.p3 or pargs.p3 or ""
 
    local p4 = args.p4 or pargs.p4 or ""
 
    local p5 = args.p5 or pargs.p5 or ""
 
    local p6 = args.p6 or pargs.p6 or ""
 
    local p7 = args.p7 or pargs.p7 or ""
 
    local p8 = args.p8 or pargs.p8 or ""
 
    local p9 = args.p9 or pargs.p9 or ""
 
    local nowiki = args.nowiki or pargs.nowiki or false
 
    local page=args.page or pargs.page or args[1] or pargs[1]
 
    if page=="" then page=nil end
 
    local title -- holds the result of the mw.title.xxx call
 
    if not(page) then
 
        title=mw.title.getCurrentTitle()
 
        if not(title) then return "error: failed to getCurrentTitle()" end
 
    else if makeTitle then
 
            title=mw.title.makeTitle(namespace,page,fragment,interwiki)
 
            if not (title) then return "error: failed to makeTitle(" .. namespace .. "," .. page .. "," .. fragment .. "," .. interwiki .. ")" end
 
        else if id then
 
                title=mw.title.new(id)
 
                if not (title) then return "error: failed to mw.title.new(" .. id .. ")" end
 
            else
 
                title=mw.title.new(page,namespace)
 
                if not (title) then return "error: failed to mw.title.new(" .. page .. "," .. namespace .. ")" end
 
            end -- if id
 
        end -- if makeTitle
 
    end -- if not(page)
 
    local result=title[field]
 
    if type(result)=="function" then
 
        if nowiki then
 
            return "<pre><nowiki>" .. tostring(result(title,p1,p2,p3,p4,p5,p6,p7,p8,p9)).. [[</nowiki></pre>]] -- I *think* these are all page:x() calls
 
        else return result(title,p1,p2,p3,p4,p5,p6,p7,p8,p9)
 
        end
 
    else return tostring(result) -- note that nil values will be returned as "nil", not ""
 
    end
 
 
end
 
end
  
 +
-- handle all errors in main
 +
main = require('Module:Protect')(main)
  
function p.id(frame)
+
local p = {}
    field="id"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
  
function p.interwiki(frame)
+
-- main function does all the work
    field="interwiki"
+
local meta = {}
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
+
function meta.__index(self, key)
 +
return function(frame)
 +
return main(frame, key)
 +
end
 
end
 
end
 +
setmetatable(p, meta)
  
function p.namespace(frame)
+
function p.getContent(frame)
    field="namespace"
+
local args, pargs = frame.args, ( frame:getParent() or {} ).args or {}
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
+
local fmt = args.as or pargs.as or "pre"
end
+
local text = main(frame, "getContent")
 
 
function p.fragment(frame)
 
    field="fragment"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.nsText(frame)
 
    field="nsText"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.subjectNsText(frame)
 
    field="subjectNsText"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.text(frame)
 
    field="text"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.prefixedText(frame)
 
    field="prefixedText"
 
    return p.main(frame)
 
end
 
 
 
function p.fullText(frame)
 
    field="fullText"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.rootText(frame)
 
    field="rootText"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.baseText(frame)
 
    field="baseText"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.subpageText(frame)
 
    field="subpageText"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.canTalk(frame)
 
    field="canTalk"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.exists(frame)
 
    field="exists"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
  
function p.fileExists(frame)
+
fmt = mw.text.split( fmt, ", ?" )
    field="fileExists"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
  
function p.isContentPage(frame)
+
for _, how in ipairs( fmt ) do
    field="isContentPage"
+
if how == "pre" then
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
+
text = table.concat{ "<pre>", text, "</pre>" }
end
+
elseif how == "expand" then
 +
text = frame:preprocess(text)
 +
elseif how == "nowiki" then
 +
text = mw.text.nowiki(text)
 +
end
 +
end
  
function p.isExternal(frame)
+
return text
    field="isExternal"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.isLocal(frame)
 
    field="isLocal"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.isRedirect(frame)
 
    field="isRedirect"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.isSpecialPage(frame)
 
    field="isSpecialPage"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.isSubpage(frame)
 
    field="isSubpage"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.isTalkPage(frame)
 
    field="isTalkPage"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.isSubpageOf(frame)
 
    field="isSubpageOf"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.inNamespace(frame)
 
    field="inNamespace"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.inNamespaces(frame)
 
    field="inNamespaces"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.hasSubjectNamespace(frame)
 
    field="hasSubjectNamespace"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.contentModel(frame)
 
    field="contentModel"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.basePageTitle(frame)
 
    field="basePageTitle"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.rootPageTitle(frame)
 
    field="rootPageTitle"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.talkPageTitle(frame)
 
    field="talkPageTitle"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.subjectPageTitle(frame)
 
    field="subjectPageTitle"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.subPageTitle(frame)
 
    field="subPageTitle"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.partialUrl(frame)
 
    field="partialUrl"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.fullUrl(frame)
 
    field="fullUrl"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.localUrl(frame)
 
    field="localUrl"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.canonicalUrl(frame)
 
    field="canonicalUrl"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
end
 
 
 
function p.getContent(frame)
 
    field="getContent"
 
    return p.main(frame) -- I ''think'' that frame, field automatically is available to p.main
 
 
end
 
end
  
 
return p
 
return p

Latest revision as of 08:20, 27 September 2020

This module is meant to allow the goodies listed in Script error: No such module "Section link". to be accessed by people who do not want to write a Lua module.

Usage is: {{#invoke:Page|function|parameters}}

Functions

In the usage above, function is one of the following fields or functions for title objects:

  • id: The page_id. 0 if the page does not exist.
  • interwiki: The interwiki prefix, or the empty string if none.
  • namespace: The namespace number.
  • fragment: The fragment, or the empty string. May be assigned.
  • nsText: The text of the namespace for the page.
  • subjectNsText: The text of the subject namespace for the page.
  • text: The title of the page, without the namespace or interwiki prefixes.
  • prefixedText: The title of the page, with the namespace and interwiki prefixes.
  • fullText: The title of the page, with the namespace and interwiki prefixes and the fragment.
  • rootText: If this is a subpage, the title of the root page without prefixes. Otherwise, the same as title.text.
  • baseText: If this is a subpage, the title of the page it is a subpage of without prefixes. Otherwise, the same as title.text.
  • subpageText: If this is a subpage, just the subpage name. Otherwise, the same as title.text.
  • canTalk: Whether the page for this title could have a talk page.
  • exists: Whether the page exists. Alias for fileExists for Media-namespace titles.
  • fileExists: Whether the file exists. For File- and Media-namespace titles, this is expensive.
  • isContentPage: Whether this title is in a content namespace.
  • isExternal: Whether this title has an interwiki prefix.
  • isLocal: Whether this title is in this project. For example, on the English Wikipedia, any other Wikipedia is considered "local" while Wiktionary and such are not.
  • isRedirect: Whether this is the title for a page that is a redirect.
  • isSpecialPage: Whether this is the title for a possible special page (i.e. a page in the Special: namespace).
  • isSubpage: Whether this title is a subpage of some other title.
  • isTalkPage: Whether this is a title for a talk page.
  • isSubpageOf( title2 ): Whether this title is a subpage of the given title.
  • inNamespace( ns ): Whether this title is in the given namespace. Namespaces may be specified by anything that is a key found in mw.site.namespaces.
  • inNamespaces( ... ): Whether this title is in any of the given namespaces. Namespaces may be specified by anything that is a key found in mw.site.namespaces.
  • hasSubjectNamespace( ns ): Whether this title's subject namespace is in the given namespace. Namespaces may be specified by anything that is a key found in mw.site.namespaces.
  • contentModel: The content model for this title, as a string.
  • basePageTitle: The same as mw.title.makeTitle( title.namespace, title.baseText ).
  • rootPageTitle: The same as mw.title.makeTitle( title.namespace, title.rootText ).
  • talkPageTitle: The same as mw.title.makeTitle( mw.site.namespaces[title.namespace].talk.id, title.text ), or nil if this title cannot have a talk page.
  • subjectPageTitle: The same as mw.title.makeTitle( mw.site.namespaces[title.namespace].subject.id, title.text ).
  • subPageTitle( text ): The same as mw.title.makeTitle( title.namespace, title.text .. '/' .. text ).
  • partialUrl(): Returns title.text encoded as it would be in a URL.
  • fullUrl( query, proto ): Returns the full URL (with optional query table/string) for this title. proto may be specified to control the scheme of the resulting url: "http", "https", "relative" (the default), or "canonical".
  • localUrl( query ): Returns the local URL (with optional query table/string) for this title.
  • canonicalUrl( query ): Returns the canonical URL (with optional query table/string) for this title.
  • getContent(): Returns the (unparsed) content of the page, or nil if there is no page.

Parameters

Page selection

  • id = Page ID of the page to load and evaluate. If this parameter is specified, then other page selection parameters are ignored.
  • page = name of the page to load and evaluate. This is parameter "text" passed to mw.title.new or "title" passed to mw.title.makeTitle in the Mediawiki documentation.
    • Leave page blank to call mw.title.getCurrentTitle() and thus default to the page presently being viewed.
  • makeTitle = Set this to any nonblank value to call mw.title.makeTitle. Otherwise mw.title.new is called. The functions available for these and for getCurrentTitle() are generally (exactly?) the same.
  • namespace = This parameter is passed to new/makeTitle to define what page to open.
  • fragment = This parameter is passed to makeTitle per the MediaWiki documentation.
  • interwiki = This parameter is passed to makeTitle per the MediaWiki documentation.

Title object function parameters

  • p1 is the first parameter passed to the functions within the title object.
    • "title2" for isSubPageOf
    • "ns" for inNamespace
    • (first parameter) of inNameSpaces
    • "ns" for hasSubjectNamespace
    • "text" for subpageTitle
    • "query" for fullUrl, localUrl, canonicalUrl
  • p2 is the second parameter passed to the functions within the title object.
    • (second parameter) of inNameSpaces
    • "proto" for fullUrl
  • p3 to p9 are collected and passed to the functions, but should only affect inNamespaces.

Postprocessing

  • as = Changes how contents of a page is returned when function getContent() is called.
    • "pre" (default) to wrap the page's content inside <pre></pre>.
    • "nowiki" to wrap the page's content inside <nowiki></nowiki>
    • "expand" to expand the page's content
    • "raw" (or any other unrecognized value) to return the page content without any wrapping

local callAssert = require('Module:CallAssert')

local function main(frame, field)
	local args, pargs = frame.args, ( frame:getParent() or {} ).args or {}
	local makeTitle=args.makeTitle or pargs.makeTitle
	local namespace=args.namespace or pargs.namespace or ""
	local fragment=args.fragment or pargs.fragment or ""
	local interwiki=args.interwiki or pargs.interwiki or ""
	local page=args.page or args[1] or pargs.page or pargs[1] or ""
	local id= tonumber( args.id or pargs.id )
	local pn = {}
	local title -- holds the result of the mw.title.xxx call

	for i = 1,9 do pn[i] = args['p'..i] or pargs['p'..i] end
	if not id and not mw.ustring.match( page, '%S' ) then page = nil end

	if id then
		title = callAssert(mw.title.new, 'mw.title.new', id)
	elseif not page then
		title = callAssert(mw.title.getCurrentTitle, 'getCurrentTitle')
	elseif makeTitle then
		title = callAssert(mw.title.makeTitle, 'makeTitle', namespace, page, fragment, interwiki)
	else
		title = callAssert(mw.title.new, 'mw.title.new', page, namespace)
	end

	local result = title[field]
	if type(result) == "function" then
		result = result(title, unpack(pn))
	end

	return tostring(result or "")
end

-- handle all errors in main
main = require('Module:Protect')(main)

local p = {}

-- main function does all the work
local meta = {}
function meta.__index(self, key)
	return function(frame)
		return main(frame, key)
	end
end
setmetatable(p, meta)

function p.getContent(frame)
	local args, pargs = frame.args, ( frame:getParent() or {} ).args or {}
	local fmt = args.as or pargs.as or "pre"
	local text = main(frame, "getContent")

	fmt = mw.text.split( fmt, ", ?" )

	for _, how in ipairs( fmt ) do
		if how == "pre" then
			text = table.concat{ "<pre>", text, "</pre>" }
		elseif how == "expand" then
			text = frame:preprocess(text)
		elseif how == "nowiki" then
			text = mw.text.nowiki(text)
		end
	end

	return text
end

return p