Module:Citation/CS1

<section begin=header />

<section end=header /> This module and associated sub-modules support the Citation Style 1 and Citation Style 2 citation templates. In general, it is not intended to be called directly, but is called by one of the core CS1 and CS2 templates. <section begin=module_components_table /> These files comprise the module support for CS1|2 citation templates:

CS1 | CS2 modules

live		sandbox		diff	description
	Module:Citation/CS1	Module:Citation/CS1/sandbox	[edit]	diff	Rendering and support functions
	Module:Citation/CS1/Configuration	Module:Citation/CS1/Configuration/sandbox	[edit]	diff	Translation tables; error and identifier handlers
	Module:Citation/CS1/Whitelist	Module:Citation/CS1/Whitelist/sandbox	[edit]	diff	List of active and deprecated CS1|2 parameters
	Module:Citation/CS1/Date validation	Module:Citation/CS1/Date validation/sandbox	[edit]	diff	Date format validation functions
	Module:Citation/CS1/Identifiers	Module:Citation/CS1/Identifiers/sandbox	[edit]	diff	Functions that support the named identifiers (ISBN, DOI, PMID, etc.)
	Module:Citation/CS1/Utilities	Module:Citation/CS1/Utilities/sandbox	[edit]	diff	Common functions and tables
	Module:Citation/CS1/COinS	Module:Citation/CS1/COinS/sandbox	[edit]	diff	Functions that render a CS1|2 template's metadata
	Module:Citation/CS1/styles.css	Module:Citation/CS1/sandbox/styles.css	[edit]	diff	CSS styles applied to the CS1|2 templates
	Module:Citation/CS1/Suggestions	Module:Citation/CS1/Suggestions/sandbox	[edit]	diff	List that maps common erroneous parameter names to valid parameter names

<section end=module_components_table />

Other documentation:

• Module talk:Citation/CS1/Feature requests
• Module talk:Citation/CS1/COinS
• Module:Cs1 documentation support – a set of functions (some experimental) that extract information from the module suite for the purpose of documenting CS1|2
  • Module:Citation/CS1/doc/Category list – lists of category names taken directly from Module:Citation/CS1/Configuration and Module:Citation/CS1/Configuration/sandbox

testcases

• Module:Citation/CS1/testcases (run)
• Module:Citation/CS1/testcases/errors (run) – error and maintenance messaging
• Module:Citation/CS1/testcases/dates (run) – date validation
• Module:Citation/CS1/testcases/identifiers (run) – identifiers
• Module:Citation/CS1/testcases/anchor (run) – CITEREF anchors

---

local p = {}

function anchorid(frame)
    local P1 = frame.args[1] or ""
    local P2 = frame.args[2] or ""
    local P3 = frame.args[3] or ""
    local P4 = frame.args[4] or ""
    local P5 = frame.args[5] or ""
    return "CITEREF" .. P1 .. P2 .. P3 .. P4 .. P5
end

function name(frame)
    local P1 = frame.args[1] or ""
    if ( frame.args[5] ~= nil) then
        return P1 .. " et al."
    else
        local P2 = frame.args[2] or ""
        local P3 = frame.args[3] or "" 
        local P4 = frame.args[4] or ""
        if ( frame.args[4] ~= nil ) then
            P4 = " & " .. P4
        end
        if ( frame.args[3] ~= nil ) then
            P3 = " & " .. P3
        end
        if ( frame.args[2] ~= nil ) then
            P2 = " & " .. P2
        end
        return P1 .. P2 .. P3 .. P4
    end 
end

function crossref(frame)
    local LB = frame.BracketLeft or ""
    local RB = frame.BracketRightt or ""
    local anchor = frame.ref or frame.Ref or anchorid(frame)
    local text = name(frame)
    local loc = frame.loc or ""
    local page = frame.p or frame.page or nil
    local pages = frame.pp or frame.pages or nil
    if ( page ~= nil ) then
        local pagesep = frame.PageSep or ""
        text = text .. pagesep .. page
    end
    if ( pages ~= nil ) then
        local pagessep = frame.PagesSep or ""
        text = text .. pagessep .. pages
    end        
    local ps = frame.Postscript or ""
    return LB .. "[[#" .. anchor .. "|" .. text .. "]]" .. RB .. ps
end

-- This is used by templates such as {{SfnRef}} to create the (encoded) anchor name for a Harvard cross-reference hyperlink.
function p.SFNID(frame)
    local pframe = frame:getParent()
    return anchorid(pframe)
end

-- This is used by templates such as {{Harvard citation}} to create the Harvard cross-reference text.
function p.Harvard(frame)
    local pframe = frame:getParent()
    return crossref(pframe)
end

-- This is used by templates such as {{sfn}} to create the entire cross-reference.
function p.sfn(frame)
    local pframe = frame:getParent()
    local content = crossref(pframe)
    local args = { name = anchorid(pframe) }
    return mw.text.tag({name = "ref", contents = content, params = args})
end

return p