モジュール:Footnotesのソースを表示

●モジュール ●ノート ●閲覧 ●ソースを閲覧 ●履歴表示ツール操作 ●閲覧 ●ソースを閲覧 ●履歴表示全般 ●リンク元 ●関連ページの更新状況 ●ファイルをアップロード ●特別ページ ●ページ情報 ●短縮URLを取得する ●QRコードをダウンロード ●ウィキデータ項目表示 ← モジュール:Footnotes あなたには﹁このページの編集﹂を行う権限がありません。理由は以下の通りです: このページは保護されています。 ●Wikipedia:拡張半保護の方針に基づき拡張半保護されているため、アカウント作成後ある程度期間が経過しある程度の編集経験を持つ利用者以外の方は編集できません。 ●このページに変更を加えたい場合はノートページで{{拡張半保護編集依頼}}をご利用ください。 ●保護の経緯およびその期間はこのページの保護記録で確認できます。 ●このページのノートで保護について議論が行われていることがありますので、ご参照願います。
このページのソースの閲覧やコピーができます。
require('strict');
local getArgs = require ('Module:Arguments').getArgs;


--[[--------------------------< A R G S _ D E F A U L T >------------------------------------------------------

a table to specify initial values.

]]

local args_default = {
 bracket_left = '',
 bracket_right = '',
 bracket_year_left = '',
 bracket_year_right = '',
 postscript = '',
 page = '',
 pages = '',
 location = '',
 page_sep = ", p.&nbsp;",
 pages_sep = ", pp.&nbsp;",
 ref = '',
 template = 'harv',               -- if template name not provided in {{#invoke:}} use this
 };


--[[--------------------------< I S _ Y E A R >----------------------------------------------------------------

evaluates param to see if it is one of these forms with or without lowercase letter disambiguator:
 YYYY
 n.d.
 nd 
 c. YYYY
 YYYY–YYYY (separator is endash)
 YYYY–YY  (separator is endash)

return true when param has a recognized form; false else

]]

local patterns_date= {
 '^%d%d%d%d?%l?$',
 '^n%.d%.%l?$',
 '^nd%l?$',
 '^c%. %d%d%d%d?%l?$',
 '^%d%d%d%d–%d%d%d%d%l?$',
 '^%d%d%d%d–%d%d%l?$',
 }

local function is_year (param, args)
 args.year = '';                -- used for harv error; 
 
 for _, pattern in ipairs (patterns_date) do
  if mw.ustring.match (param, pattern) then
   args.year = param;             -- used for harv error; 
   return true;
  end
 end
end


--[[--------------------------< C O R E >----------------------------------------------------------------------

returns an anchor link (CITEREF) formed from one to four author names, year, and insource location (|p=, |pp=, loc=)

]]

local function core( args )
 local result;
 local err_msg = ''

 if args.P5 ~= '' then
  if is_year (args.P5, args) then
   result = table.concat ({args.P1, ' et al. ', args.bracket_year_left, args.P5, args.bracket_year_right});
  else
   args.P5 = '';              -- when P5 not a year don't include in anchor
   result = table.concat ({args.P1, ' et al.'});      -- and don't render it
  end

 elseif args.P4 ~= '' then
  if is_year (args.P4, args) then
   result = table.concat ({args.P1, ', ', args.P2, ' &amp; ', args.P3, ' ', args.bracket_year_left, args.P4, args.bracket_year_right}); -- three names and a year
  else
   result = table.concat ({args.P1, ' et al.'});      -- four names
  end

 elseif args.P3 ~= '' then
  if is_year (args.P3, args) then
   result = table.concat ({args.P1, ' &amp; ', args.P2, ' ', args.bracket_year_left, args.P3, args.bracket_year_right}); -- two names and a year
  else
   result = table.concat ({args.P1, ', ', args.P2, ' ', ' &amp; ', args.P3}); -- three names
  end
   
 elseif args.P2 ~= '' then
  if is_year (args.P2, args) then
   result = table.concat ({args.P1, ' ', args.bracket_year_left, args.P2, args.bracket_year_right}); -- one name and year
  else
   result = table.concat ({args.P1, ' &amp; ', args.P2});    -- two names
  end
  
 else
  result = args.P1;              -- one name
 end
                    -- when author-date result ends with a dot (typically when the last positional parameter holds 'n.d.')
                    -- and when no in-source location (no |p=, |pp=, or |loc=)
                    -- and when the first or only character in args.postscript is a dot
                    -- remove the author-date result trailing dot
                    -- the author-date result trailing dot will be replaced later with the content of args.postscript (usually a dot)
 if ('.' == result:sub(-1)) and ('.' == args.postscript:sub(<span class="ltr">1</span>)) and ('' == args.page) and ('' == args.pages) and ('' == args.location) then
  result = result:gsub ('%.$', '');
 end
 
 if args.ref ~= 'none' then
  local anchor_id;
  if args.ref ~= '' then
   anchor_id = mw.uri.anchorEncode (args.ref);
   err_msg = '';
   result = table.concat ({'[[#', anchor_id, '|', result, ']]'});
  else
   anchor_id = mw.uri.anchorEncode (table.concat ({'CITEREF', args.P1, args.P2, args.P3, args.P4, args.P5}));
   err_msg = '';
   result = table.concat ({'[[#', anchor_id, '|', result, ']]'});
  end
 end

 if args.page ~= '' then
  result = table.concat ({result, args.page_sep, args.page});
 elseif args.pages ~= ''then
  result = table.concat ({result, args.pages_sep, args.pages});
 end      

 if args.location ~= '' then
  result = table.concat ({result, ', ', args.location});
 end

 result = table.concat ({args.bracket_left, result, args.bracket_right, args.postscript}):gsub ('%s+', ' ');  -- strip redundant spaces
 return result .. err_msg;
end


--[[--------------------------< H Y P H E N _ T O _ D A S H >--------------------------------------------------

Converts a hyphen to a dash under certain conditions.  The hyphen must separate
like items; unlike items are returned unmodified.  These forms are modified:
 letter - letter (A - B)
 digit - digit (4-5)
 digit separator digit - digit separator digit (4.1-4.5 or 4-1-4-5)
 letterdigit - letterdigit (A1-A5) (an optional separator between letter and
  digit is supported – a.1-a.5 or a-1-a-5)
 digitletter - digitletter (5a - 5d) (an optional separator between letter and
  digit is supported – 5.a-5.d or 5-a-5-d)

any other forms are returned unmodified.

str may be a comma- or semicolon-separated list

This code copied from Module:Citation/CS1.  The only modification is to require Module:Citation/CS1/Utilities
so that it has access to the functions is_set() and has_accept_as_written()

]]

local function hyphen_to_dash( str )
 local utilities = require ('Module:Citation/CS1/Utilities');    -- only modification so that this function has access to is_set() and has_accept_as_written()

 if not utilities.is_set (str) then
  return str;
 end

 local accept; -- Boolean

 str = str:gsub ('&[<span class="ltr">nm</span>]dash;', {['&ndash;'] = '–', ['&mdash;'] = '—'});  -- replace &mdash; and &ndash; entities with their characters; semicolon mucks up the text.split
 str = str:gsub ('&#45;', '-'); -- replace HTML numeric entity with hyphen character

 str = str:gsub ('&nbsp;', ' '); -- replace &nbsp; entity with generic keyboard space character
 
 local out = {};
 local list = mw.text.split (str, '%s*[,;]%s*');        -- split str at comma or semicolon separators if there are any

 for _, item in ipairs (list) do            -- for each item in the list
  item, accept = utilities.has_accept_as_written (item);     -- remove accept-this-as-written markup when it wraps all of item
  if not accept and mw.ustring.match (item, '^%w*[%.%-]?%w+%s*[%-–—]%s*%w*[%.%-]?%w+$') then -- if a hyphenated range or has endash or emdash separators
   if item:match ('^%a+[%.%-]?%d+%s*%-%s*%a+[%.%-]?%d+$') or   -- letterdigit hyphen letterdigit (optional separator between letter and digit)
    item:match ('^%d+[%.%-]?%a+%s*%-%s*%d+[%.%-]?%a+$') or   -- digitletter hyphen digitletter (optional separator between digit and letter)
    item:match ('^%d+[%.%-]%d+%s*%-%s*%d+[%.%-]%d+$') or   -- digit separator digit hyphen digit separator digit
    item:match ('^%d+%s*%-%s*%d+$') or        -- digit hyphen digit
    item:match ('^%a+%s*%-%s*%a+$') then       -- letter hyphen letter
     item = item:gsub ('(%w*[%.%-]?%w+)%s*%-%s*(%w*[%.%-]?%w+)', '%1–%2'); -- replace hyphen, remove extraneous space characters
   else
    item = mw.ustring.gsub (item, '%s*[–—]%s*', '–');    -- for endash or emdash separated ranges, replace em with en, remove extraneous whitespace
   end
  end
  table.insert (out, item);            -- add the (possibly modified) item to the output table
 end

 local temp_str = '';              -- concatenate the output table into a comma separated string
 temp_str, accept = utilities.has_accept_as_written (table.concat (out, ', ')); -- remove accept-this-as-written markup when it wraps all of concatenated out
 if accept then
  temp_str = utilities.has_accept_as_written (str);      -- when global markup removed, return original str; do it this way to suppress boolean second return value
  return temp_str;
 else
  return temp_str;              -- else, return assembled temp_str
 end
end


--[[--------------------------< A R G S  _ F E T C H >---------------------------------------------------------

Because all of the templates share a common set of parameters, a single common function to fetch those parameters
from frame and parent frame.

]]

local function args_fetch (frame, ps)
 local args = args_default;             -- create a copy of the default table
 local pframe = frame:getParent();           -- point to the template's parameter table

 for k, v in pairs (frame.args) do           -- override defaults with values provided in the #invoke: if any
  args[<span class="ltr">k</span>] = v;    
 end
 
 args.postscript = pframe.args.postscript or pframe.args.ps or ps;
 if 'none' == args.postscript then
  args.postscript = '';
 end
 args.page = pframe.args.p or pframe.args.page or '';
 args.pages = pframe.args.pp or pframe.args.pages or '';
 args.pages = ('' ~= args.pages) and hyphen_to_dash (args.pages) or '';
 args.location = pframe.args.loc or '';
 args.ref = pframe.args.ref or pframe.args.Ref or '';
 args.refname = pframe.args.refname or '';
 args.ignore = ('yes' == pframe.args['ignore-false-positive']) or ('yes' == pframe.args['ignore-err']);

 for i, v in ipairs ({'P1', 'P2', 'P3', 'P4', 'P5'}) do      -- loop through the five positional parameters and trim if set else empty string
  args[<span class="ltr">v</span>] = (pframe.args[<span class="ltr">i</span>] and mw.text.trim (pframe.args[<span class="ltr">i</span>])) or '';
 end

 if args.P5 and not is_year (args.P5, args) then
  local i = 6;               -- initialize the indexer to the sixth positional parameter
  while pframe.args[<span class="ltr">i</span>] do             -- in case there are too many authors loop through the authors looking for a year
   local v = mw.text.trim (pframe.args[<span class="ltr">i</span>]);       -- trim
   if is_year (v, args) then           -- if a year
    args.P5 = v;             -- overwrite whatever was in args.P5 with year
    break;               -- and abandon the search
   end
   i = i + 1;               -- bump the indexer
  end
 end
 return args;
end


--[[--------------------------< H A R V A R D _ C I T A T I O N >----------------------------------------------

common entry point for:
 {{harvard citation}} aka {{harv}}
 {{Harvard citation no brackets}} aka {{harvnb}}
 {{harvcol}}
 {{harvcolnb}}
 {{harvcoltxt}}
 {{Harvard citation text}} aka {{harvtxt}}
 {{Harvp}}

Distinguishing features (brackets and page separators) are specified in this module's {{#invoke}} in the respective templates.

]]

local function harvard_citation (frame)
 local args = args_fetch (frame, '');          -- get the template and invoke parameters; default postscript is empty string

 return core (args);
end


--[[--------------------------< S T R I P _ U R L >------------------------------------------------------------

used by sfn() and sfnm().  This function fixes an issue with reference tooltip gadget where the tooltip is not displayed
when an insource locator (|p=, |pp=, |loc=) has an external wikilink that contains a # character

strip uri-reserved characters from urls in |p=, |pp-, and |loc= parameters  The researved characters are:
 !#$&'()*+,/:;=?@[]
 
]]

local function strip_url (pages)
 local escaped_uri;
 if not pages or ('' == pages) then
  return pages;
 end
 
 for uri in pages:gmatch ('%[(%a[%w%+%.%-]*://%S+)') do      -- for each external link get the uri
  escaped_uri = uri:gsub ("([%(%)%.%%%+%-%*%?%[%^%$%]])", "%%%1" );  -- save a copy with lua pattern characters escaped
  uri = uri:gsub ("[!#%$&'%(%)%*%+,/:;=%?@%[%]%.%%]", '');    -- remove reserved characters and '%' because '%20' (space character) is a lua 'invalid capture index'
  pages = pages:gsub (escaped_uri, uri, 1);        -- replace original uri with the stripped version
 end
 
 return pages;
end


--[[--------------------------< S F N >------------------------------------------------------------------------

entry point for {{sfn}} and {{sfnp}}

]]

local function sfn (frame)
 local args = args_fetch (frame, '.');          -- get the template and invoke parameters; default postscript is a dot

 local result = core (args);             -- go make a CITEREF anchor
                    -- put it all together and then strip redundant spaces
 local name;

 if args.refname == '' then
  name = "FOOTNOTE" .. args.P1 .. args.P2 .. args.P3 .. args.P4 .. args.P5 .. args.page .. args.pages .. args.location;

  name = mw.uri.anchorEncode(name);
 else
  name = "FOOTNOTE" .. args.refname;
 end

 return frame:extensionTag ({name='ref', args={name=name}, content=result}); 

 
end


--[[--------------------------< S F N M >----------------------------------------------------------------------

common entry point for {{sfnm}} and {{sfnmp}}

Distinguishing features (brackets) are specified in this module's {{#invoke}} in the respective templates.

]]

local function sfnm (frame)
 local args = args_default;             -- create a copy of the default table
 local pframe = frame:getParent();           -- point to the template's parameter table
 
 local n = 1;                -- index of source; this is the 'n' in na1, ny, etc
 local first_pnum = 1;              -- first of a pair of positional parameters
 local second_pnum = 2;              -- second of a pair of positional parameters

 local last_ps = 0;               -- index of the last source with |nps= set
 local last_index = 0;              -- index of the last source; these used to determine which of |ps= or |nps= will terminate the whole rendering

 local out = {};                -- table to hold rendered sources
 local footnote = {'FOOTNOTE'};            -- all author, date, insource location stuff becomes part of the reference's footnote id; added as we go

 for k, v in pairs (frame.args) do           -- override defaults with values provided in the #invoke: if any
  args[<span class="ltr">k</span>] = v;    
 end
 
 while true do
  if not pframe.args[table.concat ({n, 'a1'})] and not pframe.args[first_pnum] then
   break;                -- no na1 or matching positional parameter so done
  end
  
  if pframe.args[table.concat ({n, 'a1'})] then       -- does this source use named parameters?
   for _, v in ipairs ({'P1', 'P2', 'P3', 'P4', 'P5'}) do    -- initialize for this source
    args[<span class="ltr">v</span>] = '';
   end

   for i, v in ipairs ({'P1', 'P2', 'P3', 'P4', 'P5'}) do    -- extract author and year parameters for this source
    args[<span class="ltr">v</span>] = pframe.args[table.concat ({n, 'a', i})] or '';  -- attempt to assign author name
    if '' == args[<span class="ltr">v</span>] then           -- when there wasn't an author name
     args[<span class="ltr">v</span>] = pframe.args[table.concat ({n, 'y'})] or '';  -- attempt to assign year
     break;              -- done with author/date for this source
    end
   end

  else                 -- this source uses positional parameters
   args.P1 = mw.text.trim (pframe.args[first_pnum]);     -- yes, only one author supported
   args.P2 = (pframe.args[second_pnum] and mw.text.trim (pframe.args[second_pnum])) or ''; -- when positional author, year must also be positional

   for _, v in ipairs ({'P3', 'P4', 'P5'}) do       -- blank the rest of these for this source
    args[<span class="ltr">v</span>] = '';
   end

   first_pnum = first_pnum + 2;          -- source must use positional author and positional year
   second_pnum = first_pnum + 1;          -- bump these for possible next positional source
  end
  
  args.postscript = pframe.args[table.concat ({n, 'ps'})] or '';
  if 'none' == args.postscript then          -- this for compatibility with other footnote templates; does nothing
   args.postscript = '';
  end

  args.ref = pframe.args[table.concat ({n, 'ref'})] or '';    -- alternate reference for this source

  args.page = pframe.args[table.concat ({n, 'p'})] or '';     -- insource locations for this source
  args.pages = pframe.args[table.concat ({n, 'pp'})] or '';
  args.pages = ('' ~= args.pages) and hyphen_to_dash (args.pages) or '';
  args.location = pframe.args[table.concat ({n, 'loc'})] or '';
  args.ignore = ('yes' == pframe.args[table.concat ({n, 'ignore-false-positive'})]) or ('yes' == pframe.args[table.concat ({n, 'ignore-err'})]);

  table.insert (out, core (args));          -- save the rendering of this source
  
  for k, v in ipairs ({'P1', 'P2', 'P3', 'P4', 'P5'}) do     -- create the FOOTNOTE id
   if '' ~= args[<span class="ltr">v</span>] then
    table.insert (footnote, args[<span class="ltr">v</span>]);
   end
  end
  for k, v in ipairs ({'page', 'pages', 'location'}) do     -- these done separately so that we can strip uri-reserved characters from extlinked page numbers 
   if '' ~= args[<span class="ltr">v</span>] then
    table.insert (footnote, strip_url (args[<span class="ltr">v</span>]))
   end
  end
  
  last_index = n;               -- flags used to select terminal postscript from nps or from end_ps
  if '' ~= args.postscript then       
   last_ps = n;
  end
  
  n = n+1;                -- bump for the next one
 end
 
 local name = table.concat (footnote):gsub ('%s+', ' ');      -- put the footnote together and strip redundant space
 
 args.end_ps = pframe.args.postscript or pframe.args.ps or '.';    -- this is the postscript for the whole not for the individual sources
 if 'none' == args.end_ps then            -- not an original sfnm parameter value; added for compatibility with other footnote templates
  args.end_ps = '';
 end

 local result = table.concat ({table.concat (out, '; '), (last_index == last_ps) and '' or  args.end_ps});
 return frame:extensionTag ({name='ref', args={name=name}, content=result});
end


--[[--------------------------< S F N R E F >------------------------------------------------------------------

implements {{sfnref}}

]]

local function sfnref (frame)
 local args = getArgs (frame);
 local out = {};
 
 for i=1, 5 do                -- get the first five args if there are five args
  if args[<span class="ltr">i</span>] then
   out[<span class="ltr">i</span>] = args[<span class="ltr">i</span>];
  else
   break;                -- less than 5 args break out
  end
 end
 
 if 5 == #out then               -- when we have seen five args there may bemore
  local i = 6;               -- initialize the indexer to the sixth positional parameter
  while args[<span class="ltr">i</span>] do              -- in case there are too many authors loop through the authors looking for a year
   if is_year (args[<span class="ltr">i</span>], args) then          -- if a year
    out[<span class="ltr">5</span>] = args[<span class="ltr">i</span>];            -- overwrite whatever was in args[<span class="ltr">5</span>] with year
    break;               -- and abandon the search
   end
   i = i + 1;               -- bump the indexer
  end
 end
 
 return mw.uri.anchorEncode ('CITEREF' .. table.concat (out));
end


--[[--------------------------< E X P O R T E D   F U N C T I O N S >------------------------------------------
]]

return {
 harvard_citation = harvard_citation,
 sfn = sfn,
 sfnm = sfnm,
 sfnref = sfnref,
 };