پودمان:Hatnote list

----------------------------------------------------------------------------------                           Module:Hatnote list                              ----                                                                            ---- This module produces and formats lists for use in hatnotes. In particular, ---- it implements the for-see list, i.e. lists of "For X, see Y" statements,   ---- as used in {{about}}, {{redirect}}, and their variants. Also introduced    ---- are andList & orList helpers for formatting lists with those conjunctions. ----------------------------------------------------------------------------------local mArguments --initialize lazilylocal mFormatLink = require('Module:Format link')local mHatnote = require('Module:Hatnote')local libraryUtil = require('libraryUtil')local checkType = libraryUtil.checkTypelocal p = {}---------------------------------------------------------------------------------- List stringification helper functions---- These functions are used for stringifying lists, usually page lists inside-- the "Y" portion of "For X, see Y" for-see items.----------------------------------------------------------------------------------default options table used across the list stringification functionslocal stringifyListDefaultOptions = {conjunction = "و",separator = "،",altSeparator = "؛",space = " ",formatted = false}--Searches display text onlylocal function searchDisp(haystack, needle)return mw.ustring.find(mw.ustring.sub(haystack, (mw.ustring.find(haystack, '|') or 0) + 1), needle)end-- Stringifies a list generically; probably shouldn't be used directlylocal function stringifyList(list, options)-- Type-checks, defaults, and a shortcutcheckType("stringifyList", 1, list, "table")if #list == 0 then return nil endcheckType("stringifyList", 2, options, "table", true)options = options or {}for k, v in pairs(stringifyListDefaultOptions) doif options[k] == nil then options[k] = v endendlocal s = options.space-- Format the list if requestedif options.formatted thenlist = mFormatLink.formatPages({categorizeMissing = mHatnote.missingTargetCat}, list)end-- Set the separator; if any item contains it, use the alternate separatorlocal separator = options.separatorfor k, v in pairs(list) doif searchDisp(v, separator) thenseparator = options.altSeparatorbreakendend-- Set the conjunction, apply Oxford comma, and force a comma if #1 has "§"local conjunction = s .. options.conjunction .. sif #list == 2 and searchDisp(list[1], "§") or #list > 2 thenconjunction = separator .. conjunctionend-- Return the formatted stringreturn mw.text.listToText(list, separator .. s, conjunction)end--DRY functionfunction p.conjList (conj, list, fmt)return stringifyList(list, {conjunction = conj, formatted = fmt})end-- Stringifies lists with "and" or "or"function p.andList (...) return p.conjList("و", ...) endfunction p.orList (...) return p.conjList("یا", ...) end---------------------------------------------------------------------------------- For see---- Makes a "For X, see [[Y]]." list from raw parameters. Intended for the-- {{about}} and {{redirect}} templates and their variants.----------------------------------------------------------------------------------default options table used across the forSee family of functionslocal forSeeDefaultOptions = {andKeyword = 'و',title = mw.title.getCurrentTitle().text,otherText = 'دیگر کاربردها',forSeeForm = 'برای %s، %s را ببینید.',}--Collapses duplicate punctuationlocal function punctuationCollapse (text)local replacements = {["%.%.$"] = ".",["%؟%.$"] = "؟",["%!%.$"] = "!",["%.%]%]%.$"] = ".]]",["%؟%]%]%.$"] = "؟]]",["%!%]%]%.$"] = "!]]"}for k, v in pairs(replacements) do text = mw.ustring.gsub(text, k, v) endreturn textend-- Structures arguments into a table for stringification, & optionsfunction p.forSeeArgsToTable (args, from, options)-- Type-checks and defaultscheckType("forSeeArgsToTable", 1, args, 'table')checkType("forSeeArgsToTable", 2, from, 'number', true)from = from or 1checkType("forSeeArgsToTable", 3, options, 'table', true)options = options or {}for k, v in pairs(forSeeDefaultOptions) doif options[k] == nil then options[k] = v endend-- maxArg's gotten manually because getArgs() and table.maxn aren't friendslocal maxArg = 0for k, v in pairs(args) doif type(k) == 'number' and k > maxArg then maxArg = k endend-- Structure the data out from the parameter list:-- * forTable is the wrapper table, with forRow rows-- * Rows are tables of a "use" string & a "pages" table of pagename strings-- * Blanks are left empty for defaulting elsewhere, but can terminate listlocal forTable = {}local i = fromlocal terminated = false-- If there is extra text, and no arguments are given, give nil value-- to not produce default of "For other uses, see foo (disambiguation)"if options.extratext and i > maxArg then return nil end-- Loop to generate rowsrepeat-- New empty rowlocal forRow = {}-- On blank use, assume list's ended & break at end of this loopforRow.use = args[i]if not args[i] then terminated = true end-- New empty list of pagesforRow.pages = {}-- Insert first pages item if presenttable.insert(forRow.pages, args[i + 1])-- If the param after next is "and", do inner loop to collect params-- until the "and"'s stop. Blanks are ignored: "1|and||and|3" → {1, 3}while args[i + 2] == options.andKeyword doif args[i + 3] then table.insert(forRow.pages, args[i + 3])end-- Increment to next "and"i = i + 2end-- Increment to next usei = i + 2-- Append the rowtable.insert(forTable, forRow)until terminated or i > maxArgreturn forTableend-- Stringifies a table as formatted by forSeeArgsToTablefunction p.forSeeTableToString (forSeeTable, options)-- Type-checks and defaultscheckType("forSeeTableToString", 1, forSeeTable, "table", true)checkType("forSeeTableToString", 2, options, "table", true)options = options or {}for k, v in pairs(forSeeDefaultOptions) doif options[k] == nil then options[k] = v endend-- Stringify each for-see item into a listlocal strList = {}if forSeeTable thenfor k, v in pairs(forSeeTable) dolocal useStr = v.use or options.otherTextlocal pagesStr =p.andList(v.pages, true) ormFormatLink._formatLink{categorizeMissing = mHatnote.missingTargetCat,link = mHatnote.disambiguate(options.title)}local forSeeStr = mw.ustring.format(options.forSeeForm, useStr, pagesStr)forSeeStr = punctuationCollapse(forSeeStr)table.insert(strList, forSeeStr)endendif options.extratext then table.insert(strList, punctuationCollapse(options.extratext..'.')) end-- Return the concatenated listreturn table.concat(strList, ' ')end-- Produces a "For X, see [[Y]]" string from arguments. Expects index gaps-- but not blank/whitespace values. Ignores named args and args < "from".function p._forSee (args, from, options)local forSeeTable = p.forSeeArgsToTable(args, from, options)return p.forSeeTableToString(forSeeTable, options)end-- As _forSee, but uses the frame.function p.forSee (frame, from, options)mArguments = require('Module:Arguments')return p._forSee(mArguments.getArgs(frame), from, options)endreturn p