Jump to content

Module:TrainingPages and Module:TrainingPages/sandbox: Difference between pages

(Difference between pages)
Page 1
Page 2
Content deleted Content added
m Made slight simplifications to code, and replaced quadruple spaces with tabs per mw:Manual:Coding conventions/Lua
 
/MORE/ mw.text.trimming. This is a bit of overkill (I think it's two separate solutions) because it's troublesome to test all the methods of adding whitespace to the links.
 
Line 4: Line 4:
function anonymize(name)
function anonymize(name)
return mw.ustring.gsub(name,"^"..mw.site.siteName,"Project") or name
return mw.ustring.gsub(name,"^"..mw.site.siteName,"Project") or name
end
end


function out(name)
function out(name)
return mw.ustring.gsub(name,"^Project",mw.site.siteName) or name
return mw.ustring.gsub(name,"^Project",mw.site.siteName) or name
end
end


function keyize(pagename)
function keyize(pagename)
-- there was a complaint about "_" breaking things. Do all lookups with _ in place of any space.
-- there was a complaint about "_" breaking things. Do all lookups with _ in place of any space.
-- also spaces in the index file (non-module) were causing trouble
-- also spaces in the index file (non-module) were causing trouble
pagename = mw.text.trim(pagename)
pagename = mw.text.trim(pagename)
pagename = mw.ustring.gsub(pagename, " ", "_")
pagename = mw.ustring.gsub(pagename, " ", "_")
pagename = mw.uri.decode(pagename)
pagename = mw.uri.decode(pagename)
pagename = anonymize(pagename)
pagename = anonymize(pagename)
return pagename
return pagename
end
end


function p.main(frame,displacement,varstoreturn)
function p.main(frame,displacement,varstoreturn)
local parent=frame.getParent(frame)
local parent=frame.getParent(frame)
local currentpage,indexmodule,defaultpage,noerr
local currentpage,indexmodule,defaultpage,noerr
---- args in the #invoke itself trump args in the parent frame
---- args in the #invoke itself trump args in the parent frame
currentpage = frame.args.page and mw.text.trim(frame.args.page)
currentpage = frame.args.page and mw.text.trim(frame.args.page)
defaultpage = frame.args.defaultpage and mw.text.trim(frame.args.defaultpage)
defaultpage = frame.args.defaultpage and mw.text.trim(frame.args.defaultpage)
indexmodule = frame.args.index and mw.text.trim(frame.args.index)
indexmodule = frame.args.index and mw.text.trim(frame.args.index)
displacement = displacement or frame.args.displacement -- can be passed from the other function names at the end
displacement = displacement or frame.args.displacement -- can be passed from the other function names at the end
noerr=frame.args.noerr -- used as boolean
noerr=frame.args.noerr -- used as boolean
anonymizereturn = frame.args.anonymize -- used as boolean
anonymizereturn = frame.args.anonymize -- used as boolean
---- args in the parent frame come next
---- args in the parent frame come next
if parent then
if parent then
currentpage=currentpage or (parent.args.page and mw.text.trim(parent.args.page))
currentpage=currentpage or (parent.args.page and mw.text.trim(parent.args.page))
indexmodule=indexmodule or (parent.args.index and mw.text.trim(parent.args.index)) -- index is a module return{'page1','page2', ...}
indexmodule=indexmodule or (parent.args.index and mw.text.trim(parent.args.index)) -- index is a module return{'page1','page2', ...}
defaultpage=defaultpage or (parent.args.defaultpage and mw.text.trim(parent.args.defaultpage))
defaultpage=defaultpage or (parent.args.defaultpage and mw.text.trim(parent.args.defaultpage))
noerr=noerr or parent.args.noerr
noerr=noerr or parent.args.noerr
anonymizereturn = anonymizereturn or parent.args.anonymize
anonymizereturn = anonymizereturn or parent.args.anonymize
end
end
---- default values if parameters aren't provided
---- default values if parameters aren't provided
defaultpage=defaultpage or "" -- don't know where to send people by default
defaultpage=defaultpage or "" -- don't know where to send people by default
if not(indexmodule) then
if not(indexmodule) then
return "[[Module:TrainingPages]] error:no index parameter specified"
return "[[Module:TrainingPages]] error:no index parameter specified"
end
end
if not(currentpage) then
if not(currentpage) then
local pp=mw.title.getCurrentTitle()
local pp=mw.title.getCurrentTitle()
if not pp then
if not pp then
if noerr then
if noerr then
return "","",""
return "","",""
else return "[[Module:TrainingPages]] error:failed to access getCurrentTitle" -- this shouldn't happen anyway, I don't think....
else return "[[Module:TrainingPages]] error:failed to access getCurrentTitle" -- this shouldn't happen anyway, I don't think....
end
end
end
end
currentpage=pp.fullText
currentpage=pp.fullText
end
end
currentpage=anonymize(currentpage) --- convert "Wikipedia:, "Meta:" etc. into "Project:
currentpage=anonymize(currentpage) --- convert "Wikipedia:, "Meta:" etc. into "Project:
local index={}
local index={}
if mw.ustring.sub(indexmodule,1,6)=="Module" then
if mw.ustring.sub(indexmodule,1,6)=="Module" then
---- get a table of the pages in order from indexmodule
---- get a table of the pages in order from indexmodule
index=mw.loadData(indexmodule)
index=mw.loadData(indexmodule)
else pp=mw.title.new(indexmodule)
else pp=mw.title.new(indexmodule)
if not pp then
if not pp then
if noerr then
if noerr then
return "","",""
return "","",""
else return "[[Module:TrainingPages]] error (''index'' parameter): failed to access mw.title.new("..tostring(indexmodule)..") to load the index file",false,false,true
else return "[[Module:TrainingPages]] error (''index'' parameter): failed to access mw.title.new("..tostring(indexmodule)..") to load the index file",false,false,true
end
end
end
end
local textindex=pp.getContent(pp)
local textindex=pp.getContent(pp)
if not textindex then
if not textindex then
if noerr then
if noerr then
return "","",""
return "","",""
else return "[[Module:TrainingPages]] error (''index'' parameter):failed to access mw.title.new("..indexmodule.."):getContent() to load the index data",false,false,true
else return "[[Module:TrainingPages]] error (''index'' parameter):failed to access mw.title.new("..indexmodule.."):getContent() to load the index data",false,false,true
end
end
end
end
prowl=mw.ustring.gmatch(textindex,"%[%[(.-)[%]|]") -- first half of any wikilink
prowl=mw.ustring.gmatch(textindex,"%[%[(.-)[%]|]") -- first half of any wikilink
index={}
index={}
repeat
repeat
link=prowl()
link=prowl()
if not(link) then break end
if not(link) then break end
link = mw.text.trim(link)
link = mw.text.trim(link)
if link~="" then table.insert(index,link) end
if link~="" then table.insert(index,link) end
until false
until false
end
end
displacement = displacement or 0 -- assume a null parameter is just display the same
displacement=displacement or 0 -- assume a null parameter is just display the same
---- set up the reverse lookup in lookup.
---- set up the reverse lookup in lookup.
---- it would be faster to set this up in the indexmodule
---- it would be faster to set this up in the indexmodule
---- but we don't want inconsistencies from user input!
---- but we don't want inconsistencies from user input!
local lookup={}
local lookup={}
local i=0
local i=0
repeat
repeat
i=i+1
i=i+1
local j=index[i]
local j=index[i]
if j then lookup[keyize(j)]=i else break end -- lookup["page name"] => page number
if j then lookup[keyize(j)]=i else break end -- lookup["page name"] => page number
until false
until false
--- get the page to return
--- get the page to return
local returnpage,currentpagenumber
local returnpage,currentpagenumber
if tonumber(currentpage) then
if tonumber(currentpage) then
currentpagenumber=tonumber(currentpage)
currentpagenumber=tonumber(currentpage)
returnpage=index[currentpagenumber+displacement] or defaultpage
returnpage=index[currentpagenumber+displacement] or defaultpage
elseif (lookup[keyize(currentpage)]) then
else if (lookup[keyize(currentpage)]) then
currentpagenumber=lookup[keyize(currentpage)]
currentpagenumber=lookup[keyize(currentpage)]
returnpage=index[currentpagenumber+displacement] or defaultpage
returnpage=index[currentpagenumber+displacement] or defaultpage
else returnpage=defaultpage
else returnpage=defaultpage
end
end
end
if anonymizereturn then
if anonymizereturn then
returnpage=anonymize(returnpage)
returnpage=anonymize(returnpage)
else
else
returnpage=out(returnpage)
returnpage=out(returnpage)
end
if returnpage then returnpage = mw.text.trim(returnpage) end
end
if returnpage then returnpage = mw.text.trim(returnpage) end
if not(varstoreturn) then return tostring(returnpage) else return tostring(returnpage),currentpagenumber,#index end
if not(varstoreturn) then return tostring(returnpage) else return tostring(returnpage),currentpagenumber,#index end
end
end
Line 119: Line 120:


function p.next_page(frame)
function p.next_page(frame)
local returnpage,pagenumber,totalpages,errcode=p.main(frame,1,true)
local returnpage,pagenumber,totalpages,errcode=p.main(frame,1,true)
return returnpage
return returnpage
end
end
p.next = p.next_page
p.next = p.next_page
Line 126: Line 127:
-- Same as above, but returns the previous page
-- Same as above, but returns the previous page
function p.last_page(frame)
function p.last_page(frame)
local returnpage,pagenumber,totalpages,errcode=p.main(frame,-1,true)
local returnpage,pagenumber,totalpages,errcode=p.main(frame,-1,true)
return returnpage
return returnpage
end
end
p.last = p.last_page
p.last = p.last_page
function p.page_number(frame)
function p.page_number(frame)
local returnpage,pagenumber,totalpages,errcode=p.main(frame,0,true)
local returnpage,pagenumber,totalpages,errcode=p.main(frame,0,true)
if errcode then return returnpage else return pagenumber end
if errcode then return returnpage else return pagenumber end
end
end
p.page = p.page_number
p.page = p.page_number


function p.total_pages(frame)
function p.total_pages(frame)
local returnpage,pagenumber,totalpages,errcode=p.main(frame,0,true)
local returnpage,pagenumber,totalpages,errcode=p.main(frame,0,true)
if errcode then return returnpage else return totalpages end
if errcode then return returnpage else return totalpages end
end
end
p.total = p.total_pages
p.total = p.total_pages