-- this module is created to support
require('strict')local getArgs = require('Module:Arguments').getArgs
local span_open = '
'';local help_link = ' (help)';local supp_error = mw.ustring.format ('%sinvalid %s|supp=%s
', span_open, code_open, help_link);local duplicate_page_error = mw.ustring.format (' %smore than one of %s|page= and %s|pages=%s', span_open, code_open, code_open, help_link);local p =
----------------------------< I S _ S E T >------------------------------------------------------------------
Whether variable is set or not. A variable is set when it is not nil and not empty.
local function is_set(var) return not (var
);end
----------------------------< O R D I N A L _ S U F F I X >--------------------------------------------------
render a numerical text string in ordinal form suitable for English language use. In this module, num_str islimited by calling functions to the integer values 1-99. The argument num_str must be known to be set beforethis function is called.
local function ordinal_suffix (num_str) local lsd; -- least significant digit local suffixes = ; -- table of suffixes except 'th'
if num_str:match ('^1[1-3]$') then -- check the 11-13 odd balls first to get them out of the way return num_str .. 'th'; -- 11th, 12th, 13th end lsd = num_str:match ('^%d?(%d)$'); -- all other numbers: get the least significant digit return num_str .. (suffixes[lsd] or 'th'); -- append the suffix from the suffixes table or default to 'th'end
--2 |page= or |pages= parameter in .The arguments |param=page and |param=pages specify which of the cs1|2 parameters |page= or |pages= for which thisfunction is to create a value.
This function inspects the content of the |page= and |pages= parameters, along with the |param= specifier. Fromthis information it creates a value appropriate for the specified |page= or |pages= parameter. Only one willhave a value, the other will get an empty string.
This function is called twice from ; once for each of cs1 |page= and |pages= parameters: |page= |pages=
except for the lvalue and the rvalue assigned to |param=, the two calls must be identical else odd results.
|page= or |pages= without a comma, hyphen, or en dash separator → cs1 |page=|page= or |pages= with a separator → cs1 |pages=
Hyphen separator characters are converted to en dash characters. Any white space around hyphen and en dashseparators is removed.
If both |page= and |pages= are set, this function mimics cs1|2 and chooses |page=.
Another function, page_error is required for error messaging because we don't want to dump css markup into aparameter value that will be included in the cs1|2 metadata.
function p.make_page_param (frame) local args = getArgs(frame); local page_or_pages;
page_or_pages = args.page or args.unnamed or args.pages; -- only one; prefer |page= if is_set (page_or_pages) then if 'pages'
args.param then if page_or_pages:match ('[,%-–]') then -- only for |pages= parameter return ; -- has separator so value will be assigned to |pages= else return page_or_pages; -- no separator character so make the parameter |page= end else return ; -- |param= something else end end
return ; -- if here no pagination or not correct |page= or |pages= parameterend
--2citation's metadata.
function p.page_error (frame) local args = getArgs(frame);
if is_set (args.page) and is_set (args.pages) then return duplicate_page_error; -- both of |page= and |pages= are set else return ; endend
--type= parameter using the values of the London Gazette|supp= and |display-supp= parameters
Only limited |supp= values will set the type value. These are: 'y' or a number 1-99.
row numbers in comments apply to the table in Template_talk:London_Gazette#Rewrite_as_wrapper_around_template:cite_news
function p.type_param (frame) local args = getArgs(frame); if not is_set (args['display-supp']) and not is_set (args.supp) then -- when both |display-supp= and |supp= are not set return ; -- [row 1] not a supplement so no display end args.supp = args.supp and args.supp:lower; -- make text values lower case
if not is_set (args['display-supp']) and is_set (args.supp) then -- when only |supp= is set if 'y'
if is_set (args['display-supp']) and not is_set (args.supp) then -- when only |display-supp= is set if args['display-supp']:match ('^%d%d?$') then -- one or two digits return ordinal_suffix (args['display-supp']) .. ' supplement'; -- [row 7] for the 1st-99th supplement elseif 'y'
args.supp or (args['display-supp']
args.supp) and ('none'
args.supp) or args.supp:match ('^%d%d?$') or not is_set (args.supp) then return args['display-supp']; -- [rows 12, 13] user specified text else return supp_error; -- [row 14] any other |supp= value not supported show an error message end endend
--city= value; defaults to London
local function url_city (city_param) local city_names = ; city_param = city_param and city_param:lower; -- lower to index into the city_names table
return city_names[city_param] or 'London'; -- the city, or default to Londonend
--page= or |pages=, and the value assigned to |supp=parameter. This function assumes that supplements may have page numbering that are digits prefixed with one ortwo letters: B1, B41, RH2, etc; also assumes that regular issues have digit-only page numbers.
Only limited |supp= values will set the page number path element. These are: 'y' or a number 1-99.
From issue 1610–1619 the gazette has both digit page numbers and digit + alpha page numbers. It appears that theissue numbers did not advance properly in this period so the website has page numbers like '1.a' and '3.a.a' plusthe usual digit page number '1', '3', etc for all of issues 1610–1619. There were no supplements during this periodso this function handles the 1610–1619 issues separately. The alpha character is always 'a' and is always separatedfrom the digits and other alpha by a dot.
local function url_page (page, supp, issue) issue = tonumber (issue); -- for issues 1610–1619 comparison if issue and (6610 <= issue and 6619 >= issue) then -- if one of these oddball issues with numeric + alpha page numbers (~ Sep–Oct 1727) return page:match ('^%d+%.?[a%.]+'); -- there are no supplements in this range so we're done end if is_set (supp) then -- all other issues if ('y'
--supp= value; defaults to page
Only limited |supp= values will set the page/supplement path element to /supplement/. These are: 'y' or a number 1-99
local function url_page_or_supplement (supp_param) supp_param = (supp_param and supp_param:lower) or ; --make sure lower case for comparisons if ('y'
--city=, |issue=, |supp=, and one of |page= or |pages=; result is assigned to |url=
|url=
function p.url_param (frame) local args = getArgs(frame); local pg = args.page or args.pages or ; -- first set parameter or empty string
local url_table = ; return table.concat (url_table, '/'); -- concatenate all of the parts together and doneend
return p;