模組:Citation

可在模組:Citation/doc建立此模組的說明文件

----------------------------------------------------------------------- Module:Citation - Lua module for Citation auxiliary templates----------------------------------------------------------------------- For the {{citation}} formatting functions, see: Module:Citation/CS1--                               (see NOTES at bottom)--require "mw.text"local z = {    wikitext = require("Module:Wikitext"),    extensiontags = {        nowiki = true,        ref = true,        gallery = true,        pre = true,        source = true,        categorytree = true,        charinsert = true,        hiero = true,        imagemap = true,        inputbox = true,        math = true,        poem = true,        ref = true,        references = true,        syntaxhighlight = true,        timeline = true,    }}function trim( str )    if str == nil then        return nil;    end    return str:match( "^%s*(.-)%s*$" );endfunction hideinprint(content)    return contentendfunction onlyinprint(content)    return ""end-- This returns a string with HTML character entities for wikitext markup characters.function wikiescape(text)    text = text:gsub( '[&\'%[%]{|}]', {                ['&'] = '&#38;',                ["'"] = '&#39;',                ['['] = '&#91;',                [']'] = '&#93;',            ['{'] = '&#123;',            ['|'] = '&#124;',            ['}'] = '&#125;' } );    return text;endfunction createTag(t, frame)    local name = t.name or "!-- --"    local content = t.contents or ""    local attrs = {}    if ( z.extensiontags[name] ) then        -- We have to preprocess these, so that they are properly turned into so-called "strip markers" in the generated wikitext.        if ( not frame ) then error ("Please supply an extra frame argument to the createTag() function.") end        local params = {}        for n,v in pairs(t.params) do            table.insert(params, "|" .. n .. "=" .. v)        end        return frame:preprocess("{{#tag:" .. name .. "|" .. content .. table.concat(params) .. "}}")    else           for n,v in pairs(t.params) do            if (v) then                table.insert(attrs, n .. "=\"" .. wikiescape(v) .. "\"")            else                table.insert(attrs, n)            end        end        if ("" == content) then            return "<" .. name .. " " .. table.concat(attrs, " ") .. "/>"        else            return "<" .. name .. " " .. table.concat(attrs, " ") .. ">" .. content .. "</" .. name .. ">"        end    endend--[[This is a clone of mw.text.nowiki.  When the mw.text library is installed,this can be replaced by a call to that library. ]]function nowiki( s )    -- string.gsub is safe here, because we're only caring about ASCII chars    s = string.gsub( s, '["&\'<=>%[%]{|}]', {        ['"'] = '&#34;',        ['&'] = '&#38;',        ["'"] = '&#39;',        ['<'] = '&#60;',        ['='] = '&#61;',        ['>'] = '&#62;',        ['['] = '&#91;',        [']'] = '&#93;',        ['{'] = '&#123;',        ['|'] = '&#124;',        ['}'] = '&#125;',    } )    s = string.sub( string.gsub( '\n' .. s, '\n[#*:;]', {        ["\n#"] = "\n&#35;",        ["\n*"] = "\n&#42;",        ["\n:"] = "\n&#58;",        ["\n;"] = "\n&#59;",    } ), 2 )    s = string.gsub( s, '://', '&#58;//' )    s = string.gsub( s, 'ISBN ', 'ISBN&#32;' )    s = string.gsub( s, 'RFC ', 'RFC&#32;' )    return sendfunction externallinkid(args)    local sep = args.separator or "&nbsp;"    args.suffix = args.suffix or ""    local url_string = args.id    if args.encode == true or args.encode == nil then        url_string = mw.uri.encode( url_string );    end        local t0 = onlyinprint(args.label .. sep .. args.id)    local t1 = hideinprint("[[" .. args.link .. "|" .. args.label .. "]]" .. sep .. "[" .. args.prefix .. url_string .. args.suffix .. " " .. nowiki(args.id) .. "]")        return t0 .. t1endfunction doi(id, inactive, nocat)    local cat = ""    local text;    if ( inactive ~= nil ) then         text = "[[Digital object identifier|doi]]:" .. id;        cat = cat .. "[[Category:Pages with DOIs inactive since " .. selectyear(inactive) .. "]]"        inactive = " (inactive " .. inactive .. ")"     else         text = externallinkid({link="Digital object identifier",label="doi",prefix="http://dx.doi.org/",id=id,separator=":"})        inactive = ""     end    if ( string.sub(id,1,3) ~= "10." ) then        cat = cat .. "[[Category:Pages with DOI errors]]" .. '<span class="error"> Bad DOI (expected "10." prefix) in code number</span>'    end    if ( nocat and nocat ~= "" ) then cat = "" end    return text .. inactive .. cat    endfunction selectyear( str )    local lang = mw.getContentLanguage();    local good, result;    good, result = pcall( lang.formatDate, lang, 'Y', str )    if good then         return result;    else        return '';    endendfunction anchorid(label, args)    local P1 = trim(args[1]) or ""    local P2 = trim(args[2]) or ""    local P3 = trim(args[3]) or ""    local P4 = trim(args[4]) or ""    local P5 = trim(args[5]) or ""    local anchor = P1 .. P2 .. P3 .. P4 .. P5;    if anchor ~= '' then  -- See bug description in Citation/CS1        anchor = mw.uri.anchorEncode( anchor );    end        return label .. anchorendfunction refid(label, args)    local p = args.p or ""    local pp = args.pp or ""    local loc = args.loc or ""    return anchorid(label, args) .. p .. pp .. loc    endfunction name(args)    local P1 = trim(args[1]) or ""    if ( args[5] ~= nil) then        return P1 .. " et al."    else        local P2 = trim(args[2]) or ""        local P3 = trim(args[3]) or ""         local P4 = trim(args[4]) or ""        if ( args[4] ~= nil ) then            P4 = " " .. P4            P3 = " &amp; " .. P3            P2 = ", " .. P2        elseif ( args[3] ~= nil ) then            P3 = " " .. P3            P2 = " &amp; " .. P2        elseif ( args[2] ~= nil ) then            P2 = " " .. P2                    end        return P1 .. P2 .. P3 .. P4    end endfunction crossref(frame, label, args)    local config = frame.args -- the arguments passed BY the template, in the wikitext of the template itself    local LB = config.BracketLeft or ""    local RB = config.BracketRight or ""    local anchor = args.ref or args.Ref or anchorid( label, args)    local text = name(args)    local loc = args.loc    local page    local pages = args.pp or args.pages    if pages == nil or pages == '' then        page = args.p or args.page;    end     if nil == loc then loc = "" else loc = " " .. loc end    if ( page ~= nil ) then        local pagesep = config.PageSep or ", p.&nbsp;"        loc = loc .. pagesep .. page    end    if ( pages ~= nil ) then        local pagessep = config.PagesSep or ", pp.&nbsp;"        loc = loc .. pagessep .. pages    end            local pagename = args.pagename or ""    local ps = args.Postscript or ""    return LB .. "[[" .. pagename .. "#" .. anchor .. "|" .. text .. "]]" .. loc .. RB .. psendfunction r0(frame, name, group, page)    if ( name == nil ) then return "" end    if ( group == nil ) then group = "" end    local p = ""    if ( page ~= nil ) then         local contents = ":" .. page        p = createTag({name="sup",contents=contents,params={class="reference",style="white-space:nowrap;"}})     end    return createTag({name="ref",contents="",params={name=name,group=group}}, frame) .. pendfunction reflist0(frame, config, args)    local contents = args.refs or ""    local liststyle = args.liststyle    local count = args[1]    local width = args.colwidth    local group = args.group or config.default_group    if ( nil == tonumber(count) and nil == width ) then         width = count        count = nil    end    if ( nil == liststyle ) then        if ( "upper-alpha" == group or "lower-alpha" == group or "upper-roman" == group or "lower-roman" == group or "upper-greek" == group or "lower-greek" == group ) then            liststyle = group        else            liststyle = config.default_liststyle        end    end    local params = {}    params.class = "reflist"        params.style = z.wikitext.liststyle(liststyle)    if ( nil ~= count ) then                params.class = params.class .. " references-column-count references-column-count-" .. count        params.style = params.style .. " " .. z.wikitext.columncountstyle(count)    end        if ( nil ~= width ) then        params.class = params.class .. " references-column-width"        params.style = params.style .. " " .. z.wikitext.columnwidthstyle(width)    end    local references = createTag({name="references",contents=contents,params={group=group}}, frame)    return createTag({name="div",contents=references,params=params})endfunction refbegin0(frame, config, args)    local liststyle = args.liststyle    local indent = args.indent    local indentsize = args.indentsize    local count = args[1]    local width = args.colwidth    if ( nil == tonumber(count) and nil == width ) then         width = count        count = nil    end    if ( nil == liststyle ) then        if ( "upper-alpha" == group or "lower-alpha" == group or "upper-roman" == group or "lower-roman" == group or "upper-greek" == group or "lower-greek" == group ) then            liststyle = group        else            liststyle = config.default_liststyle        end    end    local params = {}    params.class = "refbegin"    params.style = z.wikitext.liststyle(liststyle)    if ( nil ~= count ) then                params.class = params.class .. " references-column-count references-column-count-" .. count        params.style = params.style .. " " .. z.wikitext.columncountstyle(count)    end        if ( nil ~= width ) then        params.class = params.class .. " references-column-width"        params.style = params.style .. " " .. z.wikitext.columnwidthstyle(width)    end    local dlopen    if ( nil ~= indent ) then        dlopen = z.wikitext.OpenHTMLTag({name="dl",params={style="text-indent: -" .. (indentsize or "3.2") .. "em;"}})    else        dlopen = ""    end    return z.wikitext.OpenHTMLTag({name="div",params=params}) .. dlopenendfunction refend0(frame, config, args)    local indent = args.indent    local dlclose    if ( nil ~= indent ) then        dlclose = "</dl>"    else        dlclose = ""    end    return dlclose .. "</div>"end-- This is used by {{doi}} to create DOI links in the style used in citations.function z.doi(frame)    local pframe = frame:getParent()    local id = pframe.args.id or pframe.args[1] or ""    return doi(id)end-- This is used by {{ISSN}} to create ISSN links in the style used in citations.function z.ISSN(frame)    local pframe = frame:getParent()    local Name = pframe.args[1] or ""    return hideinprint("[[International Standard Serial Number|ISSN]]&nbsp;[http://www.worldcat.org/search?fq=x0:jrnl&q=n2:" .. Name .. " " .. Name .. "]")end-- This is used by templates such as {{SfnRef}} to create the (encoded) anchor name for a Harvard cross-reference hyperlink.function z.SFNID(frame)    local pframe = frame:getParent()    return anchorid('FOOTNOTE', pframe.args)end-- This is used by templates such as {{Harvard citation}} to create the Harvard cross-reference text.function z.Harvard(frame)    local pframe = frame:getParent()    return crossref(frame, pframe.args)end-- This is used by templates such as {{sfn}} to create the entire cross-reference.function z.sfn(frame)    local pframe = frame:getParent()    pframe.args.Postscript = pframe.args.postscript or pframe.args.ps or ".";        local content = crossref(frame, 'CITEREF', pframe.args)    local args = { name = refid( 'FOOTNOTE', pframe.args) }    return createTag({name = "ref", contents = content, params = args}, frame)end-- This is used by template {{r}}.function z.r(frame)    local pframe = frame:getParent()    local config = frame.args -- the arguments passed BY the template, in the wikitext of the template itself    local args = pframe.args -- the arguments passed TO the template, in the wikitext that instantiates the template    args.page1 = args.page1 or args.page    local text = ""    -- This would be shorter using ipairs(), but that doesn't work on an arguments table supplied to a template.    local index = 1    while args[index] ~= nil do        local arg = args[index]        local t = r0(frame, arg, args.group, args["page" .. index])        text = text .. t        index = index + 1    end    return textend-- This is used by template {{ref label}}.function z.reflabel(frame)    local pframe = frame:getParent()    local config = frame.args -- the arguments passed BY the template, in the wikitext of the template itself    local args = pframe.args -- the arguments passed TO the template, in the wikitext that instantiates the template    local P1 = args[1] or ""    local P2 = args[2] or ""    local P3 = args[3] or ""    local id = nil    local contents = "[[#endnote_" .. P1 .. P3 .. "|&#91;" .. P2 .. "&#93;]]"    local params = {}    params.class="reference"    if ( args.noid == nil or args.noid == "" ) then params.id = "ref_" .. P1 .. P3 end    return createTag({name="sup",contents=contents,params=params})end-- This is used by template {{note label}}.function z.notelabel(frame)    local pframe = frame:getParent()    local config = frame.args -- the arguments passed BY the template, in the wikitext of the template itself    local args = pframe.args -- the arguments passed TO the template, in the wikitext that instantiates the template    local id = args[1] or ""    local arrow = args[3] or ""    local postscript = args[4] or ""    local contents     if arrow ~= "" then        local sup_arrow = createTag({name="sup",contents=arrow,params={}})        contents = "[[#ref_" .. id .. arrow .. "|<b>" .. sup_arrow .. "</b>]]" .. postscript        if "none" == arrow then arrow = "^" end -- Change this AFTER using it in the ID parameter and the contents.    else        contents = (args[2] or "") .. postscript    end    local params = { class="citation wikicite" }    if id ~= "" and ( args.noid == nil or args.noid == "" ) then         params.id = mw.uri.anchorEncode("endnote_" .. id .. arrow)    end    return createTag({name="span",contents=contents,params=params})end-- This is used by templates {{reflist}} and {{notelist}}.function z.reflist(frame)    local pframe = frame:getParent()    local config = frame.args -- the arguments passed BY the template, in the wikitext of the template itself    local args = pframe.args -- the arguments passed TO the template, in the wikitext that instantiates the template    return reflist0(frame, config, args)end-- This is used by template {{refbegin}}.function z.refbegin(frame)    local pframe = frame:getParent()    local config = frame.args -- the arguments passed BY the template, in the wikitext of the template itself    local args = pframe.args -- the arguments passed TO the template, in the wikitext that instantiates the template    return refbegin0(frame, config, args)end-- This is used by template {{refend}}.function z.refend(frame)    local pframe = frame:getParent()    local config = frame.args -- the arguments passed BY the template, in the wikitext of the template itself    local args = pframe.args -- the arguments passed TO the template, in the wikitext that instantiates the template    return refend0(frame, config, args)end-- This is used by template {{efn}}.function z.efn(frame)    local pframe = frame:getParent()    local config = frame.args -- the arguments passed BY the template, in the wikitext of the template itself    local args = pframe.args -- the arguments passed TO the template, in the wikitext that instantiates the template    return createTag({name="ref",contents=(args[1] or ""),params={name=args.name,group=config.default_group}}, frame)endreturn z-----------------------------------------------------------------------NOTES---- NOTE A1: This Lua module was originally designed to handle a mix--      of citation styles, crossing Vancouver style with Wikipedia's--      local Citation Style 1 (CS1) from {Template:Citation/core}.--      However, the conflicting positions of parameters, scattered--      in twisted locations across this module, led to a separate--      variation just to untangle the CS1 format of citations.---- NOTE D2: The placement of dots and other separators between the--      displayed parameters has been a continual headache, to keep--      coordinated with the data in parentheses "(data)". There--      has been a need to pre-check for the existence of related--      options, to keep from putting double-dots ".." in some cases.--      In particular, the omission of the "title=" parameter has led--      to several cases of a spurious dot ". ." because the original--      design had treated the title as a mandatory parameter.----------------------------------------------------------------------------HISTORY:--26Dec2015 copied from en.wikipedia.org.----End