Module:TrainingPages

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

This module is intended to accept the name of a page (defaulting to the page currently being displayed), look it up in an index of pages, step forward or backward by some number of pages (usually 1), and give back the name of the page at that position.

Use {{#invoke:TrainingPages|function|parameters}} to invoke. For example:

{{#invoke:TrainingPages|last_page|index=Wikipedia:Training/For students/Editing module index|page=Wikipedia:Training/For students/Where to get help|defaultpage=Wikipedia:Training/header}} yields:

Functions

The available functions are:

• next_page: the next page on the index list
• last_page: the preceding page on the index list
• page_number: the number the page indicated is in the list
• total_pages: the total number of pages in the index
• main: allows you to flip forward or backward an arbitrary number of pages

Parameters

(All parameters are available to every function, except displacement which only matters for main)

• page is the page you are starting from (the one you're looking up in the index)
  • if page is blank or omitted, the mw.title.getCurrentTitle() function is used to locate the current page. (So far as I know, this is always the page that matters, the one everything ultimately gets transcluded to, not the template or module)
  • if page is a number and doesn't contain any text, the page that number of positions down in the index will be the base page used. With "main" and no displacement set, this returns the name of page#N. Otherwise you can have it return some number of pages off from that number, or the default page, as it would if the name of the page in that position had been entered as text.
• defaultpage is the page to be returned if there is no next page, previous page, or page displaced by n in the index. Can be blank, in which case the module output will be blank if this happens.
• index is the name of the index module with the list of all the pages. The pages should be in a list from beginning to end. There are three ways to format this:
  • Index can be in module space (e.g. Module:TrainingPages/default index) in which case they must consist of return {'Name of first page','Name of second page','Name of third page' ... etc.}.
  • Index can be in some other space, not in module format, in which case it need merely contain a list of Wikilinks in double square brackets. Everything outside the brackets is ignored, and every link in double square brackets is counted. The only limitation is that in this version anything in double square brackets is taken as a link, even if nowiki applies or it is in other brackets or has a newline in it or something that prevents it from appearing as a proper link. You can put a pair of nowiki or noninclude tags between the two opening square brackets as a kludge to avoid having this happen, if need be.
  • (If omitted, the index still defaults to Module:TrainingPages/default index, so common tasks might be added to it. However, no provision has been made to prevent from paging from one set into another, so unless this only sees use in one consistent overall set of trainingpages that is a bad idea unless upgraded.)
• displacement specifies how many pages to go forward or back in the main module.
• noerr suppresses error messages if the index file can't be found; an empty string is returned.
• anonymize - any nonblank value causes project specific pages (Wikipedia:) to be returned as Project:

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

--The purpose of this module is to take a list of page names and page numbers that define a module of one of the [[Wikipedia:Training]] series, and use it to determine the next and previous page to link to 

local p = {}

-- Return the next page, used like: {{#invoke:TrainingPages| next_page | currentpage=Wikipedia:Training/Foo/Bar | {{listofpages}} }}
function p.main(frame,displacement)
    local parent=frame.getParent(frame)
    local currentpage,indexmodule,defaultpage
    ---- args in the #invoke itself trump args in the parent frame
    currentpage = frame.args.page
    defaultpage = frame.args.defaultpage
    indexmodule = frame.args.index
    displacement = displacement or frame.args.displacement -- can get from function name
    ---- args in the parent frame come next
    if parent then
        currentpage=currentpage or parent.args.page
        indexmodule=indexmodule or parent.args.index -- index is a module return{'page1','page2', ...}
        defaultpage=defaultpage or parent.args.defaultpage
        end
    ---- default values if parameters aren't provided
    defaultpage=defaultpage or "" -- don't know where to send people by default
    indexmodule=indexmodule or "Module:TrainingPages/default index" -- example given in Lua:Requests
    if not(currentpage) then
        local pp=mw.title.getCurrentTitle()
        assert(pp,"failed to access getCurrentTitle")
        currentpage=pp.fullText
    end
    local index={}
    if mw.ustring.sub(indexmodule,1,6)=="Module" then
        ---- get a table of the pages in order from indexmodule
        index=mw.loadData(indexmodule)
    else pp=mw.title.new(indexmodule)
        assert(pp,"failed to access mw.title.new("..indexmodule..") to load the index")
        local textindex=pp.getContent(pp)
        prowl=mw.ustring.gmatch(textindex,"([%^%$%(%)%%%.%[%]%*%+%-%?])","%%1") -- escape all special characters
        prowl=mw.ustring.gmatch(textindex,"<nowiki>(.-)</nowiki>")
        repeat
            local nw=prowl()
            if not(nw) then break end
            local nn=mw.ustring.gsub(nw,"%%%[%%%[","")
            textindex=mw.ustring.gsub(textindex,nw,nn)
        until false
        prowl=mw.ustring.gmatch(textindex,"%[%[(.-)[%]|]") -- first half of any wikilink
        index={}
        repeat
            local link=prowl()
            if not(link) then break end
            if link~="" then table.insert(index,link) end
        until false
    end
    displacement=displacement or 0 -- assume a null parameter is just display the same
    ---- set up the reverse lookup in lookup.
    ---- it would be faster to set this up in the indexmodule
    ---- but we don't want inconsistencies from user input!
    local lookup={}
    local i=0
    repeat
        i=i+1
        local j=index[i]
        if j then lookup[mw.uri.decode(j)]=i else break end -- lookup["page name"] => page number
    until false
    --- get the page to return
    local returnpage
    if (lookup[mw.uri.decode(currentpage)]) then
        returnpage=index[lookup[currentpage]+displacement] or defaultpage
    else returnpage=defaultpage
    end
    return tostring(returnpage)
end

function p.next_page(frame)
    return p.main(frame,1)
end

function p.last_page(frame)
    return p.main(frame,-1)
end

return p