CINXE.COM

<!DOCTYPE html> <html class="client-nojs vector-feature-language-in-header-enabled vector-feature-language-in-main-page-header-disabled vector-feature-sticky-header-disabled vector-feature-page-tools-pinned-disabled vector-feature-toc-pinned-clientpref-1 vector-feature-main-menu-pinned-disabled vector-feature-limited-width-clientpref-1 vector-feature-limited-width-content-enabled vector-feature-custom-font-size-clientpref-1 vector-feature-appearance-pinned-clientpref-1 vector-feature-night-mode-enabled skin-theme-clientpref-day vector-toc-available" lang="en" dir="ltr"> <head> <meta charset="UTF-8"> <title>Module:Cs1 documentation support - Wikipedia</title> <script>(function(){var className="client-js vector-feature-language-in-header-enabled vector-feature-language-in-main-page-header-disabled vector-feature-sticky-header-disabled vector-feature-page-tools-pinned-disabled vector-feature-toc-pinned-clientpref-1 vector-feature-main-menu-pinned-disabled vector-feature-limited-width-clientpref-1 vector-feature-limited-width-content-enabled vector-feature-custom-font-size-clientpref-1 vector-feature-appearance-pinned-clientpref-1 vector-feature-night-mode-enabled skin-theme-clientpref-day vector-toc-available";var cookie=document.cookie.match(/(?:^|; )enwikimwclientpreferences=([^;]+)/);if(cookie){cookie[1].split('%2C').forEach(function(pref){className=className.replace(new RegExp('(^| )'+pref.replace(/-clientpref-\w+$|[^\w-]+/g,'')+'-clientpref-\\w+( |$)'),'$1'+pref+'$2');});}document.documentElement.className=className;}());RLCONF={"wgBreakFrames":false,"wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgDefaultDateFormat":"dmy", "wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgRequestId":"ee49b088-af70-42b6-bb56-4e1e5be9246f","wgCanonicalNamespace":"Module","wgCanonicalSpecialPageName":false,"wgNamespaceNumber":828,"wgPageName":"Module:Cs1_documentation_support","wgTitle":"Cs1 documentation support","wgCurRevisionId":1258006783,"wgRevisionId":1258006783,"wgArticleId":59302137,"wgIsArticle":true,"wgIsRedirect":false,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":["Wikipedia semi-protected modules","Templates using TemplateStyles"],"wgPageViewLanguage":"en","wgPageContentLanguage":"en","wgPageContentModel":"Scribunto","wgRelevantPageName":"Module:Cs1_documentation_support","wgRelevantArticleId":59302137,"wgIsProbablyEditable":false,"wgRelevantPageIsProbablyEditable":false,"wgRestrictionEdit":["autoconfirmed"],"wgRestrictionMove":[],"wgNoticeProject":"wikipedia","wgCiteReferencePreviewsActive":false, "wgFlaggedRevsParams":{"tags":{"status":{"levels":1}}},"wgMediaViewerOnClick":true,"wgMediaViewerEnabledByDefault":true,"wgPopupsFlags":0,"wgVisualEditor":{"pageLanguageCode":"en","pageLanguageDir":"ltr","pageVariantFallbacks":"en"},"wgMFDisplayWikibaseDescriptions":{"search":true,"watchlist":true,"tagline":false,"nearby":true},"wgWMESchemaEditAttemptStepOversample":false,"wgWMEPageLength":70000,"wgRelatedArticlesCompat":[],"wgEditSubmitButtonLabelPublish":true,"wgULSPosition":"interlanguage","wgULSisCompactLinksEnabled":false,"wgVector2022LanguageInHeader":true,"wgULSisLanguageSelectorEmpty":false,"wgWikibaseItemId":"Q63283394","wgCheckUserClientHintsHeadersJsApi":["brands","architecture","bitness","fullVersionList","mobile","model","platform","platformVersion"],"GEHomepageSuggestedEditsEnableTopics":true,"wgGETopicsMatchModeEnabled":false,"wgGEStructuredTaskRejectionReasonTextInputEnabled":false,"wgGELevelingUpEnabledForUser":false};RLSTATE={"ext.globalCssJs.user.styles":"ready", "site.styles":"ready","user.styles":"ready","ext.globalCssJs.user":"ready","user":"ready","user.options":"loading","ext.pygments":"ready","skins.vector.search.codex.styles":"ready","skins.vector.styles":"ready","skins.vector.icons":"ready","ext.wikimediamessages.styles":"ready","ext.visualEditor.desktopArticleTarget.noscript":"ready","ext.uls.interlanguage":"ready","wikibase.client.init":"ready","ext.wikimediaBadges":"ready"};RLPAGEMODULES=["ext.pygments.view","site","mediawiki.page.ready","skins.vector.js","ext.centralNotice.geoIP","ext.centralNotice.startUp","ext.gadget.ReferenceTooltips","ext.gadget.switcher","ext.urlShortener.toolbar","ext.centralauth.centralautologin","mmv.bootstrap","ext.popups","ext.visualEditor.desktopArticleTarget.init","ext.visualEditor.targetLoader","ext.echo.centralauth","ext.eventLogging","ext.wikimediaEvents","ext.navigationTiming","ext.uls.interface","ext.cx.eventlogging.campaigns","wikibase.client.vector-2022","ext.checkUser.clientHints", "wikibase.sidebar.tracking"];</script> <script>(RLQ=window.RLQ||[]).push(function(){mw.loader.impl(function(){return["user.options@12s5i",function($,jQuery,require,module){mw.user.tokens.set({"patrolToken":"+\\","watchToken":"+\\","csrfToken":"+\\"}); }];});});</script> <link rel="stylesheet" href="/w/load.php?lang=en&modules=ext.pygments%2CwikimediaBadges%7Cext.uls.interlanguage%7Cext.visualEditor.desktopArticleTarget.noscript%7Cext.wikimediamessages.styles%7Cskins.vector.icons%2Cstyles%7Cskins.vector.search.codex.styles%7Cwikibase.client.init&only=styles&skin=vector-2022"> <script async="" src="/w/load.php?lang=en&modules=startup&only=scripts&raw=1&skin=vector-2022"></script> <meta name="ResourceLoaderDynamicStyles" content=""> <link rel="stylesheet" href="/w/load.php?lang=en&modules=site.styles&only=styles&skin=vector-2022"> <meta name="generator" content="MediaWiki 1.44.0-wmf.5"> <meta name="referrer" content="origin"> <meta name="referrer" content="origin-when-cross-origin"> <meta name="robots" content="max-image-preview:standard"> <meta name="format-detection" content="telephone=no"> <meta name="viewport" content="width=1120"> <meta property="og:title" content="Module:Cs1 documentation support - Wikipedia"> <meta property="og:type" content="website"> <link rel="preconnect" href="//upload.wikimedia.org"> <link rel="alternate" media="only screen and (max-width: 640px)" href="//en.m.wikipedia.org/wiki/Module:Cs1_documentation_support"> <link rel="apple-touch-icon" href="/static/apple-touch/wikipedia.png"> <link rel="icon" href="/static/favicon/wikipedia.ico"> <link rel="search" type="application/opensearchdescription+xml" href="/w/rest.php/v1/search" title="Wikipedia (en)"> <link rel="EditURI" type="application/rsd+xml" href="//en.wikipedia.org/w/api.php?action=rsd"> <link rel="canonical" href="https://en.wikipedia.org/wiki/Module:Cs1_documentation_support"> <link rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/deed.en"> <link rel="alternate" type="application/atom+xml" title="Wikipedia Atom feed" href="/w/index.php?title=Special:RecentChanges&feed=atom"> <link rel="dns-prefetch" href="//meta.wikimedia.org" /> <link rel="dns-prefetch" href="//login.wikimedia.org"> </head> <body class="skin--responsive skin-vector skin-vector-search-vue mediawiki ltr sitedir-ltr mw-hide-empty-elt ns-828 ns-subject page-Module_Cs1_documentation_support rootpage-Module_Cs1_documentation_support skin-vector-2022 action-view"><a class="mw-jump-link" href="#bodyContent">Jump to content</a> <div class="vector-header-container"> <header class="vector-header mw-header"> <div class="vector-header-start"> <nav class="vector-main-menu-landmark" aria-label="Site"> <div id="vector-main-menu-dropdown" class="vector-dropdown vector-main-menu-dropdown vector-button-flush-left vector-button-flush-right" > <input type="checkbox" id="vector-main-menu-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-main-menu-dropdown" class="vector-dropdown-checkbox " aria-label="Main menu" > <label id="vector-main-menu-dropdown-label" for="vector-main-menu-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Main menu </label> <div class="vector-dropdown-content"> <div id="vector-main-menu-unpinned-container" class="vector-unpinned-container"> <div id="vector-main-menu" class="vector-main-menu vector-pinnable-element"> <div class="vector-pinnable-header vector-main-menu-pinnable-header vector-pinnable-header-unpinned" data-feature-name="main-menu-pinned" data-pinnable-element-id="vector-main-menu" data-pinned-container-id="vector-main-menu-pinned-container" data-unpinned-container-id="vector-main-menu-unpinned-container" > <div class="vector-pinnable-header-label">Main menu</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-main-menu.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-main-menu.unpin">hide</button> </div> <div id="p-navigation" class="vector-menu mw-portlet mw-portlet-navigation" > <div class="vector-menu-heading"> Navigation </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-mainpage-description" class="mw-list-item"><a href="/wiki/Main_Page" title="Visit the main page [z]" accesskey="z">Main page</a></li><li id="n-contents" class="mw-list-item"><a href="/wiki/Wikipedia:Contents" title="Guides to browsing Wikipedia">Contents</a></li><li id="n-currentevents" class="mw-list-item"><a href="/wiki/Portal:Current_events" title="Articles related to current events">Current events</a></li><li id="n-randompage" class="mw-list-item"><a href="/wiki/Special:Random" title="Visit a randomly selected article [x]" accesskey="x">Random article</a></li><li id="n-aboutsite" class="mw-list-item"><a href="/wiki/Wikipedia:About" title="Learn about Wikipedia and how it works">About Wikipedia</a></li><li id="n-contactpage" class="mw-list-item"><a href="//en.wikipedia.org/wiki/Wikipedia:Contact_us" title="How to contact Wikipedia">Contact us</a></li> </ul> </div> </div> <div id="p-interaction" class="vector-menu mw-portlet mw-portlet-interaction" > <div class="vector-menu-heading"> Contribute </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-help" class="mw-list-item"><a href="/wiki/Help:Contents" title="Guidance on how to use and edit Wikipedia">Help</a></li><li id="n-introduction" class="mw-list-item"><a href="/wiki/Help:Introduction" title="Learn how to edit Wikipedia">Learn to edit</a></li><li id="n-portal" class="mw-list-item"><a href="/wiki/Wikipedia:Community_portal" title="The hub for editors">Community portal</a></li><li id="n-recentchanges" class="mw-list-item"><a href="/wiki/Special:RecentChanges" title="A list of recent changes to Wikipedia [r]" accesskey="r">Recent changes</a></li><li id="n-upload" class="mw-list-item"><a href="/wiki/Wikipedia:File_upload_wizard" title="Add images or other media for use on Wikipedia">Upload file</a></li> </ul> </div> </div> </div> </div> </div> </div> </nav> <a href="/wiki/Main_Page" class="mw-logo"> <img class="mw-logo-icon" src="/static/images/icons/wikipedia.png" alt="" aria-hidden="true" height="50" width="50"> <img class="mw-logo-wordmark" alt="Wikipedia" src="/static/images/mobile/copyright/wikipedia-wordmark-en.svg" style="width: 7.5em; height: 1.125em;"> <img class="mw-logo-tagline" alt="The Free Encyclopedia" src="/static/images/mobile/copyright/wikipedia-tagline-en.svg" width="117" height="13" style="width: 7.3125em; height: 0.8125em;"> </a> </div> <div class="vector-header-end"> <div id="p-search" role="search" class="vector-search-box-vue vector-search-box-collapses vector-search-box-show-thumbnail vector-search-box-auto-expand-width vector-search-box"> <a href="/wiki/Special:Search" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only search-toggle" title="Search Wikipedia [f]" accesskey="f"> Search </a> <div class="vector-typeahead-search-container"> <div class="cdx-typeahead-search cdx-typeahead-search--show-thumbnail cdx-typeahead-search--auto-expand-width"> <form action="/w/index.php" id="searchform" class="cdx-search-input cdx-search-input--has-end-button"> <div id="simpleSearch" class="cdx-search-input__input-wrapper" data-search-loc="header-moved"> <div class="cdx-text-input cdx-text-input--has-start-icon"> <input class="cdx-text-input__input" type="search" name="search" placeholder="Search Wikipedia" aria-label="Search Wikipedia" autocapitalize="sentences" title="Search Wikipedia [f]" accesskey="f" id="searchInput" > </div> <input type="hidden" name="title" value="Special:Search"> </div> <button class="cdx-button cdx-search-input__end-button">Search</button> </form> </div> </div> </div> <nav class="vector-user-links vector-user-links-wide" aria-label="Personal tools"> <div class="vector-user-links-main"> <div id="p-vector-user-menu-preferences" class="vector-menu mw-portlet emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> <div id="p-vector-user-menu-userpage" class="vector-menu mw-portlet emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> <nav class="vector-appearance-landmark" aria-label="Appearance"> <div id="vector-appearance-dropdown" class="vector-dropdown " title="Change the appearance of the page's font size, width, and color" > <input type="checkbox" id="vector-appearance-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-appearance-dropdown" class="vector-dropdown-checkbox " aria-label="Appearance" > <label id="vector-appearance-dropdown-label" for="vector-appearance-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Appearance </label> <div class="vector-dropdown-content"> <div id="vector-appearance-unpinned-container" class="vector-unpinned-container"> </div> </div> </div> </nav> <div id="p-vector-user-menu-notifications" class="vector-menu mw-portlet emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> <div id="p-vector-user-menu-overflow" class="vector-menu mw-portlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-sitesupport-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector?utm_source=donate&utm_medium=sidebar&utm_campaign=C13_en.wikipedia.org&uselang=en" class="">Donate</a> </li> <li id="pt-createaccount-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="/w/index.php?title=Special:CreateAccount&returnto=Module%3ACs1+documentation+support" title="You are encouraged to create an account and log in; however, it is not mandatory" class="">Create account</a> </li> <li id="pt-login-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="/w/index.php?title=Special:UserLogin&returnto=Module%3ACs1+documentation+support" title="You're encouraged to log in; however, it's not mandatory. [o]" accesskey="o" class="">Log in</a> </li> </ul> </div> </div> </div> <div id="vector-user-links-dropdown" class="vector-dropdown vector-user-menu vector-button-flush-right vector-user-menu-logged-out" title="Log in and more options" > <input type="checkbox" id="vector-user-links-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-user-links-dropdown" class="vector-dropdown-checkbox " aria-label="Personal tools" > <label id="vector-user-links-dropdown-label" for="vector-user-links-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Personal tools </label> <div class="vector-dropdown-content"> <div id="p-personal" class="vector-menu mw-portlet mw-portlet-personal user-links-collapsible-item" title="User menu" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-sitesupport" class="user-links-collapsible-item mw-list-item"><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector?utm_source=donate&utm_medium=sidebar&utm_campaign=C13_en.wikipedia.org&uselang=en">Donate</a></li><li id="pt-createaccount" class="user-links-collapsible-item mw-list-item"><a href="/w/index.php?title=Special:CreateAccount&returnto=Module%3ACs1+documentation+support" title="You are encouraged to create an account and log in; however, it is not mandatory"> Create account</a></li><li id="pt-login" class="user-links-collapsible-item mw-list-item"><a href="/w/index.php?title=Special:UserLogin&returnto=Module%3ACs1+documentation+support" title="You're encouraged to log in; however, it's not mandatory. [o]" accesskey="o"> Log in</a></li> </ul> </div> </div> <div id="p-user-menu-anon-editor" class="vector-menu mw-portlet mw-portlet-user-menu-anon-editor" > <div class="vector-menu-heading"> Pages for logged out editors <a href="/wiki/Help:Introduction" aria-label="Learn more about editing">learn more</a> </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-anoncontribs" class="mw-list-item"><a href="/wiki/Special:MyContributions" title="A list of edits made from this IP address [y]" accesskey="y">Contributions</a></li><li id="pt-anontalk" class="mw-list-item"><a href="/wiki/Special:MyTalk" title="Discussion about edits from this IP address [n]" accesskey="n">Talk</a></li> </ul> </div> </div> </div> </div> </nav> </div> </header> </div> <div class="mw-page-container"> <div class="mw-page-container-inner"> <div class="vector-sitenotice-container"> <div id="siteNotice"></div> </div> <div class="vector-column-start"> <div class="vector-main-menu-container"> <div id="mw-navigation"> <nav id="mw-panel" class="vector-main-menu-landmark" aria-label="Site"> <div id="vector-main-menu-pinned-container" class="vector-pinned-container"> </div> </nav> </div> </div> <div class="vector-sticky-pinned-container"> <nav id="mw-panel-toc" aria-label="Contents" data-event-name="ui.sidebar-toc" class="mw-table-of-contents-container vector-toc-landmark"> <div id="vector-toc-pinned-container" class="vector-pinned-container"> <div id="vector-toc" class="vector-toc vector-pinnable-element"> <div class="vector-pinnable-header vector-toc-pinnable-header vector-pinnable-header-pinned" data-feature-name="toc-pinned" data-pinnable-element-id="vector-toc" > <h2 class="vector-pinnable-header-label">Contents</h2> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-toc.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-toc.unpin">hide</button> </div> <ul class="vector-toc-contents" id="mw-panel-toc-list"> <li id="toc-mw-content-text" class="vector-toc-list-item vector-toc-level-1"> <a href="#" class="vector-toc-link"> <div class="vector-toc-text">(Top)</div> </a> </li> <li id="toc-Usage" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#Usage"> <div class="vector-toc-text"> 1 Usage </div> </a> <ul id="toc-Usage-sublist" class="vector-toc-list"> </ul> </li> </ul> </div> </div> </nav> </div> </div> <div class="mw-content-container"> <main id="content" class="mw-body"> <header class="mw-body-header vector-page-titlebar"> <nav aria-label="Contents" class="vector-toc-landmark"> <div id="vector-page-titlebar-toc" class="vector-dropdown vector-page-titlebar-toc vector-button-flush-left" > <input type="checkbox" id="vector-page-titlebar-toc-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-page-titlebar-toc" class="vector-dropdown-checkbox " aria-label="Toggle the table of contents" > <label id="vector-page-titlebar-toc-label" for="vector-page-titlebar-toc-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Toggle the table of contents </label> <div class="vector-dropdown-content"> <div id="vector-page-titlebar-toc-unpinned-container" class="vector-unpinned-container"> </div> </div> </div> </nav> <h1 id="firstHeading" class="firstHeading mw-first-heading">Module:Cs1 documentation support</h1> <div id="p-lang-btn" class="vector-dropdown mw-portlet mw-portlet-lang" > <input type="checkbox" id="p-lang-btn-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-p-lang-btn" class="vector-dropdown-checkbox mw-interlanguage-selector" aria-label="Go to an article in another language. Available in 35 languages" > <label id="p-lang-btn-label" for="p-lang-btn-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--action-progressive mw-portlet-lang-heading-35" aria-hidden="true" > 35 languages </label> <div class="vector-dropdown-content"> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li class="interlanguage-link interwiki-af mw-list-item"><a href="https://af.wikipedia.org/wiki/Module:Ondersteuning_vir_AS1-dokumentasie" title="Module:Ondersteuning vir AS1-dokumentasie – Afrikaans" lang="af" hreflang="af" data-title="Module:Ondersteuning vir AS1-dokumentasie" data-language-autonym="Afrikaans" data-language-local-name="Afrikaans" class="interlanguage-link-target">Afrikaans</a></li><li class="interlanguage-link interwiki-ab mw-list-item"><a href="https://ab.wikipedia.org/wiki/%D0%90%D0%BC%D0%BE%D0%B4%D1%83%D0%BB%D1%8C:Cs1_documentation_support" title="Амодуль:Cs1 documentation support – Abkhazian" lang="ab" hreflang="ab" data-title="Амодуль:Cs1 documentation support" data-language-autonym="Аԥсшәа" data-language-local-name="Abkhazian" class="interlanguage-link-target">Аԥсшәа</a></li><li class="interlanguage-link interwiki-ar mw-list-item"><a href="https://ar.wikipedia.org/wiki/%D9%88%D8%AD%D8%AF%D8%A9:Cs1_documentation_support" title="وحدة:Cs1 documentation support – Arabic" lang="ar" hreflang="ar" data-title="وحدة:Cs1 documentation support" data-language-autonym="العربية" data-language-local-name="Arabic" class="interlanguage-link-target">العربية</a></li><li class="interlanguage-link interwiki-av mw-list-item"><a href="https://av.wikipedia.org/wiki/%D0%9C%D0%BE%D0%B4%D1%83%D0%BB%D1%8C:Cs1_documentation_support" title="Модуль:Cs1 documentation support – Avaric" lang="av" hreflang="av" data-title="Модуль:Cs1 documentation support" data-language-autonym="Авар" data-language-local-name="Avaric" class="interlanguage-link-target">Авар</a></li><li class="interlanguage-link interwiki-azb mw-list-item"><a href="https://azb.wikipedia.org/wiki/%D9%85%D8%A7%DA%98%D9%88%D9%84:Cs1_documentation_support" title="ماژول:Cs1 documentation support – South Azerbaijani" lang="azb" hreflang="azb" data-title="ماژول:Cs1 documentation support" data-language-autonym="تۆرکجه" data-language-local-name="South Azerbaijani" class="interlanguage-link-target">تۆرکجه</a></li><li class="interlanguage-link interwiki-ban mw-list-item"><a href="https://ban.wikipedia.org/wiki/Modul:Cs1_documentation_support" title="Modul:Cs1 documentation support – Balinese" lang="ban" hreflang="ban" data-title="Modul:Cs1 documentation support" data-language-autonym="Basa Bali" data-language-local-name="Balinese" class="interlanguage-link-target">Basa Bali</a></li><li class="interlanguage-link interwiki-bn mw-list-item"><a href="https://bn.wikipedia.org/wiki/%E0%A6%AE%E0%A6%A1%E0%A6%BF%E0%A6%89%E0%A6%B2:Cs1_documentation_support" title="মডিউল:Cs1 documentation support – Bangla" lang="bn" hreflang="bn" data-title="মডিউল:Cs1 documentation support" data-language-autonym="বাংলা" data-language-local-name="Bangla" class="interlanguage-link-target">বাংলা</a></li><li class="interlanguage-link interwiki-da mw-list-item"><a href="https://da.wikipedia.org/wiki/Modul:Cs1_documentation_support" title="Modul:Cs1 documentation support – Danish" lang="da" hreflang="da" data-title="Modul:Cs1 documentation support" data-language-autonym="Dansk" data-language-local-name="Danish" class="interlanguage-link-target">Dansk</a></li><li class="interlanguage-link interwiki-et mw-list-item"><a href="https://et.wikipedia.org/wiki/Moodul:CS1_documentation_support" title="Moodul:CS1 documentation support – Estonian" lang="et" hreflang="et" data-title="Moodul:CS1 documentation support" data-language-autonym="Eesti" data-language-local-name="Estonian" class="interlanguage-link-target">Eesti</a></li><li class="interlanguage-link interwiki-gu mw-list-item"><a href="https://gu.wikipedia.org/wiki/%E0%AA%B5%E0%AA%BF%E0%AA%AD%E0%AA%BE%E0%AA%97:Cs1_documentation_support" title="વિભાગ:Cs1 documentation support – Gujarati" lang="gu" hreflang="gu" data-title="વિભાગ:Cs1 documentation support" data-language-autonym="ગુજરાતી" data-language-local-name="Gujarati" class="interlanguage-link-target">ગુજરાતી</a></li><li class="interlanguage-link interwiki-ilo mw-list-item"><a href="https://ilo.wikipedia.org/wiki/Modulo:Cs1_documentation_support" title="Modulo:Cs1 documentation support – Iloko" lang="ilo" hreflang="ilo" data-title="Modulo:Cs1 documentation support" data-language-autonym="Ilokano" data-language-local-name="Iloko" class="interlanguage-link-target">Ilokano</a></li><li class="interlanguage-link interwiki-he mw-list-item"><a href="https://he.wikipedia.org/wiki/%D7%99%D7%97%D7%99%D7%93%D7%94:Cs1_documentation_support" title="יחידה:Cs1 documentation support – Hebrew" lang="he" hreflang="he" data-title="יחידה:Cs1 documentation support" data-language-autonym="עברית" data-language-local-name="Hebrew" class="interlanguage-link-target">עברית</a></li><li class="interlanguage-link interwiki-ku mw-list-item"><a href="https://ku.wikipedia.org/wiki/Modul:Cs1_documentation_support" title="Modul:Cs1 documentation support – Kurdish" lang="ku" hreflang="ku" data-title="Modul:Cs1 documentation support" data-language-autonym="Kurdî" data-language-local-name="Kurdish" class="interlanguage-link-target">Kurdî</a></li><li class="interlanguage-link interwiki-lld mw-list-item"><a href="https://lld.wikipedia.org/wiki/Modulo:Cs1_documentation_support" title="Modulo:Cs1 documentation support – Ladin" lang="lld" hreflang="lld" data-title="Modulo:Cs1 documentation support" data-language-autonym="Ladin" data-language-local-name="Ladin" class="interlanguage-link-target">Ladin</a></li><li class="interlanguage-link interwiki-mk mw-list-item"><a href="https://mk.wikipedia.org/wiki/%D0%9C%D0%BE%D0%B4%D1%83%D0%BB:Cs1_documentation_support" title="Модул:Cs1 documentation support – Macedonian" lang="mk" hreflang="mk" data-title="Модул:Cs1 documentation support" data-language-autonym="Македонски" data-language-local-name="Macedonian" class="interlanguage-link-target">Македонски</a></li><li class="interlanguage-link interwiki-ml mw-list-item"><a href="https://ml.wikipedia.org/wiki/%E0%B4%98%E0%B4%9F%E0%B4%95%E0%B4%82:Cs1_documentation_support" title="ഘടകം:Cs1 documentation support – Malayalam" lang="ml" hreflang="ml" data-title="ഘടകം:Cs1 documentation support" data-language-autonym="മലയാളം" data-language-local-name="Malayalam" class="interlanguage-link-target">മലയാളം</a></li><li class="interlanguage-link interwiki-mt mw-list-item"><a href="https://mt.wikipedia.org/wiki/Module:Dokumentazzjoni_Appo%C4%A1%C4%A1_Cs1" title="Module:Dokumentazzjoni Appoġġ Cs1 – Maltese" lang="mt" hreflang="mt" data-title="Module:Dokumentazzjoni Appoġġ Cs1" data-language-autonym="Malti" data-language-local-name="Maltese" class="interlanguage-link-target">Malti</a></li><li class="interlanguage-link interwiki-ms mw-list-item"><a href="https://ms.wikipedia.org/wiki/Modul:Cs1_documentation_support" title="Modul:Cs1 documentation support – Malay" lang="ms" hreflang="ms" data-title="Modul:Cs1 documentation support" data-language-autonym="Bahasa Melayu" data-language-local-name="Malay" class="interlanguage-link-target">Bahasa Melayu</a></li><li class="interlanguage-link interwiki-ne mw-list-item"><a href="https://ne.wikipedia.org/wiki/%E0%A4%AE%E0%A5%8B%E0%A4%A1%E0%A5%8D%E0%A4%AF%E0%A5%81%E0%A4%B2:Cs1_documentation_support" title="मोड्युल:Cs1 documentation support – Nepali" lang="ne" hreflang="ne" data-title="मोड्युल:Cs1 documentation support" data-language-autonym="नेपाली" data-language-local-name="Nepali" class="interlanguage-link-target">नेपाली</a></li><li class="interlanguage-link interwiki-ja mw-list-item"><a href="https://ja.wikipedia.org/wiki/%E3%83%A2%E3%82%B8%E3%83%A5%E3%83%BC%E3%83%AB:Cs1_documentation_support" title="モジュール:Cs1 documentation support – Japanese" lang="ja" hreflang="ja" data-title="モジュール:Cs1 documentation support" data-language-autonym="日本語" data-language-local-name="Japanese" class="interlanguage-link-target">日本語</a></li><li class="interlanguage-link interwiki-no mw-list-item"><a href="https://no.wikipedia.org/wiki/Modul:Cs1_documentation_support" title="Modul:Cs1 documentation support – Norwegian Bokmål" lang="nb" hreflang="nb" data-title="Modul:Cs1 documentation support" data-language-autonym="Norsk bokmål" data-language-local-name="Norwegian Bokmål" class="interlanguage-link-target">Norsk bokmål</a></li><li class="interlanguage-link interwiki-or mw-list-item"><a href="https://or.wikipedia.org/wiki/%E0%AC%AE%E0%AC%A1%E0%AD%8D%E0%AD%9F%E0%AD%81%E0%AC%B2:Cs1_documentation_support" title="ମଡ୍ୟୁଲ:Cs1 documentation support – Odia" lang="or" hreflang="or" data-title="ମଡ୍ୟୁଲ:Cs1 documentation support" data-language-autonym="ଓଡ଼ିଆ" data-language-local-name="Odia" class="interlanguage-link-target">ଓଡ଼ିଆ</a></li><li class="interlanguage-link interwiki-pa mw-list-item"><a href="https://pa.wikipedia.org/wiki/%E0%A8%AE%E0%A9%8C%E0%A8%A1%E0%A8%BF%E0%A8%8A%E0%A8%B2:Cs1_documentation_support" title="ਮੌਡਿਊਲ:Cs1 documentation support – Punjabi" lang="pa" hreflang="pa" data-title="ਮੌਡਿਊਲ:Cs1 documentation support" data-language-autonym="ਪੰਜਾਬੀ" data-language-local-name="Punjabi" class="interlanguage-link-target">ਪੰਜਾਬੀ</a></li><li class="interlanguage-link interwiki-ps mw-list-item"><a href="https://ps.wikipedia.org/wiki/Module:Cs1_documentation_support" title="Module:Cs1 documentation support – Pashto" lang="ps" hreflang="ps" data-title="Module:Cs1 documentation support" data-language-autonym="پښتو" data-language-local-name="Pashto" class="interlanguage-link-target">پښتو</a></li><li class="interlanguage-link interwiki-km mw-list-item"><a href="https://km.wikipedia.org/wiki/Module:Cs1_documentation_support" title="Module:Cs1 documentation support – Khmer" lang="km" hreflang="km" data-title="Module:Cs1 documentation support" data-language-autonym="ភាសាខ្មែរ" data-language-local-name="Khmer" class="interlanguage-link-target">ភាសាខ្មែរ</a></li><li class="interlanguage-link interwiki-sq mw-list-item"><a href="https://sq.wikipedia.org/wiki/Moduli:CS1_documentation_support" title="Moduli:CS1 documentation support – Albanian" lang="sq" hreflang="sq" data-title="Moduli:CS1 documentation support" data-language-autonym="Shqip" data-language-local-name="Albanian" class="interlanguage-link-target">Shqip</a></li><li class="interlanguage-link interwiki-si mw-list-item"><a href="https://si.wikipedia.org/wiki/Module:Cs1_documentation_support" title="Module:Cs1 documentation support – Sinhala" lang="si" hreflang="si" data-title="Module:Cs1 documentation support" data-language-autonym="සිංහල" data-language-local-name="Sinhala" class="interlanguage-link-target">සිංහල</a></li><li class="interlanguage-link interwiki-simple mw-list-item"><a href="https://simple.wikipedia.org/wiki/Module:Cs1_documentation_support" title="Module:Cs1 documentation support – Simple English" lang="en-simple" hreflang="en-simple" data-title="Module:Cs1 documentation support" data-language-autonym="Simple English" data-language-local-name="Simple English" class="interlanguage-link-target">Simple English</a></li><li class="interlanguage-link interwiki-sl mw-list-item"><a href="https://sl.wikipedia.org/wiki/Modul:Cs1_documentation_support" title="Modul:Cs1 documentation support – Slovenian" lang="sl" hreflang="sl" data-title="Modul:Cs1 documentation support" data-language-autonym="Slovenščina" data-language-local-name="Slovenian" class="interlanguage-link-target">Slovenščina</a></li><li class="interlanguage-link interwiki-ckb mw-list-item"><a href="https://ckb.wikipedia.org/wiki/%D9%85%DB%86%D8%AF%DB%8C%D9%88%D9%88%D9%84:Cs1_documentation_support" title="مۆدیوول:Cs1 documentation support – Central Kurdish" lang="ckb" hreflang="ckb" data-title="مۆدیوول:Cs1 documentation support" data-language-autonym="کوردی" data-language-local-name="Central Kurdish" class="interlanguage-link-target">کوردی</a></li><li class="interlanguage-link interwiki-shn mw-list-item"><a href="https://shn.wikipedia.org/wiki/%E1%80%99%E1%80%B1%E1%82%83%E1%82%87%E1%81%B5%E1%80%BB%E1%80%B0%E1%80%B8:Cs1_documentation_support" title="မေႃႇၵျူး:Cs1 documentation support – Shan" lang="shn" hreflang="shn" data-title="မေႃႇၵျူး:Cs1 documentation support" data-language-autonym="ၽႃႇသႃႇတႆး " data-language-local-name="Shan" class="interlanguage-link-target">ၽႃႇသႃႇတႆး </a></li><li class="interlanguage-link interwiki-th mw-list-item"><a href="https://th.wikipedia.org/wiki/%E0%B8%A1%E0%B8%AD%E0%B8%94%E0%B8%B9%E0%B8%A5:Cs1_documentation_support" title="มอดูล:Cs1 documentation support – Thai" lang="th" hreflang="th" data-title="มอดูล:Cs1 documentation support" data-language-autonym="ไทย" data-language-local-name="Thai" class="interlanguage-link-target">ไทย</a></li><li class="interlanguage-link interwiki-uk mw-list-item"><a href="https://uk.wikipedia.org/wiki/%D0%9C%D0%BE%D0%B4%D1%83%D0%BB%D1%8C:Cs1_documentation_support" title="Модуль:Cs1 documentation support – Ukrainian" lang="uk" hreflang="uk" data-title="Модуль:Cs1 documentation support" data-language-autonym="Українська" data-language-local-name="Ukrainian" class="interlanguage-link-target">Українська</a></li><li class="interlanguage-link interwiki-ur mw-list-item"><a href="https://ur.wikipedia.org/wiki/%D9%85%D8%A7%DA%88%DB%8C%D9%88%D9%84:Cs1_documentation_support" title="ماڈیول:Cs1 documentation support – Urdu" lang="ur" hreflang="ur" data-title="ماڈیول:Cs1 documentation support" data-language-autonym="اردو" data-language-local-name="Urdu" class="interlanguage-link-target">اردو</a></li><li class="interlanguage-link interwiki-zh mw-list-item"><a href="https://zh.wikipedia.org/wiki/Module:Cs1_documentation_support" title="Module:Cs1 documentation support – Chinese" lang="zh" hreflang="zh" data-title="Module:Cs1 documentation support" data-language-autonym="中文" data-language-local-name="Chinese" class="interlanguage-link-target">中文</a></li> </ul> <div class="after-portlet after-portlet-lang"><a href="https://www.wikidata.org/wiki/Special:EntityPage/Q63283394#sitelinks-wikipedia" title="Edit interlanguage links" class="wbc-editpage">Edit links</a></div> </div> </div> </div> </header> <div class="vector-page-toolbar"> <div class="vector-page-toolbar-container"> <div id="left-navigation"> <nav aria-label="Namespaces"> <div id="p-associated-pages" class="vector-menu vector-menu-tabs mw-portlet mw-portlet-associated-pages" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-nstab-module" class="selected vector-tab-noicon mw-list-item"><a href="/wiki/Module:Cs1_documentation_support" title="View the module page [c]" accesskey="c">Module</a></li><li id="ca-talk" class="vector-tab-noicon mw-list-item"><a href="/wiki/Module_talk:Cs1_documentation_support" rel="discussion" class="mw-redirect" title="Discuss improvements to the content page [t]" accesskey="t">Talk</a></li> </ul> </div> </div> <div id="vector-variants-dropdown" class="vector-dropdown emptyPortlet" > <input type="checkbox" id="vector-variants-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-variants-dropdown" class="vector-dropdown-checkbox " aria-label="Change language variant" > <label id="vector-variants-dropdown-label" for="vector-variants-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet" aria-hidden="true" >English </label> <div class="vector-dropdown-content"> <div id="p-variants" class="vector-menu mw-portlet mw-portlet-variants emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> </div> </div> </nav> </div> <div id="right-navigation" class="vector-collapsible"> <nav aria-label="Views"> <div id="p-views" class="vector-menu vector-menu-tabs mw-portlet mw-portlet-views" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-view" class="selected vector-tab-noicon mw-list-item"><a href="/wiki/Module:Cs1_documentation_support">Read</a></li><li id="ca-viewsource" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=Module:Cs1_documentation_support&action=edit" title="This page is protected.
You can view its source [e]" accesskey="e">View source</a></li><li id="ca-history" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=Module:Cs1_documentation_support&action=history" title="Past revisions of this page [h]" accesskey="h">View history</a></li> </ul> </div> </div> </nav> <nav class="vector-page-tools-landmark" aria-label="Page tools"> <div id="vector-page-tools-dropdown" class="vector-dropdown vector-page-tools-dropdown" > <input type="checkbox" id="vector-page-tools-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-page-tools-dropdown" class="vector-dropdown-checkbox " aria-label="Tools" > <label id="vector-page-tools-dropdown-label" for="vector-page-tools-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet" aria-hidden="true" >Tools </label> <div class="vector-dropdown-content"> <div id="vector-page-tools-unpinned-container" class="vector-unpinned-container"> <div id="vector-page-tools" class="vector-page-tools vector-pinnable-element"> <div class="vector-pinnable-header vector-page-tools-pinnable-header vector-pinnable-header-unpinned" data-feature-name="page-tools-pinned" data-pinnable-element-id="vector-page-tools" data-pinned-container-id="vector-page-tools-pinned-container" data-unpinned-container-id="vector-page-tools-unpinned-container" > <div class="vector-pinnable-header-label">Tools</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-page-tools.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-page-tools.unpin">hide</button> </div> <div id="p-cactions" class="vector-menu mw-portlet mw-portlet-cactions emptyPortlet vector-has-collapsible-items" title="More options" > <div class="vector-menu-heading"> Actions </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-more-view" class="selected vector-more-collapsible-item mw-list-item"><a href="/wiki/Module:Cs1_documentation_support">Read</a></li><li id="ca-more-viewsource" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=Module:Cs1_documentation_support&action=edit">View source</a></li><li id="ca-more-history" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=Module:Cs1_documentation_support&action=history">View history</a></li> </ul> </div> </div> <div id="p-tb" class="vector-menu mw-portlet mw-portlet-tb" > <div class="vector-menu-heading"> General </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="t-whatlinkshere" class="mw-list-item"><a href="/wiki/Special:WhatLinksHere/Module:Cs1_documentation_support" title="List of all English Wikipedia pages containing links to this page [j]" accesskey="j">What links here</a></li><li id="t-recentchangeslinked" class="mw-list-item"><a href="/wiki/Special:RecentChangesLinked/Module:Cs1_documentation_support" rel="nofollow" title="Recent changes in pages linked from this page [k]" accesskey="k">Related changes</a></li><li id="t-upload" class="mw-list-item"><a href="/wiki/Wikipedia:File_Upload_Wizard" title="Upload files [u]" accesskey="u">Upload file</a></li><li id="t-specialpages" class="mw-list-item"><a href="/wiki/Special:SpecialPages" title="A list of all special pages [q]" accesskey="q">Special pages</a></li><li id="t-permalink" class="mw-list-item"><a href="/w/index.php?title=Module:Cs1_documentation_support&oldid=1258006783" title="Permanent link to this revision of this page">Permanent link</a></li><li id="t-info" class="mw-list-item"><a href="/w/index.php?title=Module:Cs1_documentation_support&action=info" title="More information about this page">Page information</a></li><li id="t-urlshortener" class="mw-list-item"><a href="/w/index.php?title=Special:UrlShortener&url=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FModule%3ACs1_documentation_support">Get shortened URL</a></li><li id="t-urlshortener-qrcode" class="mw-list-item"><a href="/w/index.php?title=Special:QrCode&url=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FModule%3ACs1_documentation_support">Download QR code</a></li> </ul> </div> </div> <div id="p-electronpdfservice-sidebar-portlet-heading" class="vector-menu mw-portlet mw-portlet-electronpdfservice-sidebar-portlet-heading" > <div class="vector-menu-heading"> Print/export </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="electron-print_pdf" class="mw-list-item"><a href="/w/index.php?title=Special:DownloadAsPdf&page=Module%3ACs1_documentation_support&action=show-download-screen">Download as PDF</a></li><li id="t-print" class="mw-list-item"><a href="javascript:print();" rel="alternate" title="Printable version of this page [p]" accesskey="p">Printable version</a></li> </ul> </div> </div> <div id="p-wikibase-otherprojects" class="vector-menu mw-portlet mw-portlet-wikibase-otherprojects" > <div class="vector-menu-heading"> In other projects </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="t-wikibase" class="wb-otherproject-link wb-otherproject-wikibase-dataitem mw-list-item"><a href="https://www.wikidata.org/wiki/Special:EntityPage/Q63283394" title="Structured data on this page hosted by Wikidata [g]" accesskey="g">Wikidata item</a></li> </ul> </div> </div> </div> </div> </div> </div> </nav> </div> </div> </div> <div class="vector-column-end"> <div class="vector-sticky-pinned-container"> <nav class="vector-page-tools-landmark" aria-label="Page tools"> <div id="vector-page-tools-pinned-container" class="vector-pinned-container"> </div> </nav> <nav class="vector-appearance-landmark" aria-label="Appearance"> <div id="vector-appearance-pinned-container" class="vector-pinned-container"> <div id="vector-appearance" class="vector-appearance vector-pinnable-element"> <div class="vector-pinnable-header vector-appearance-pinnable-header vector-pinnable-header-pinned" data-feature-name="appearance-pinned" data-pinnable-element-id="vector-appearance" data-pinned-container-id="vector-appearance-pinned-container" data-unpinned-container-id="vector-appearance-unpinned-container" > <div class="vector-pinnable-header-label">Appearance</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-appearance.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-appearance.unpin">hide</button> </div> </div> </div> </nav> </div> </div> <div id="bodyContent" class="vector-body" aria-labelledby="firstHeading" data-mw-ve-target-container> <div class="vector-body-before-content"> <div class="mw-indicators"> <div id="mw-indicator-pp-default" class="mw-indicator"><div class="mw-parser-output"><a href="/wiki/Wikipedia:Protection_policy#semi" title="This high-risk module is permanently semi-protected to prevent vandalism"><img alt="Permanently protected module" src="//upload.wikimedia.org/wikipedia/en/thumb/1/1b/Semi-protection-shackle.svg/20px-Semi-protection-shackle.svg.png" decoding="async" width="20" height="20" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/en/thumb/1/1b/Semi-protection-shackle.svg/30px-Semi-protection-shackle.svg.png 1.5x, //upload.wikimedia.org/wikipedia/en/thumb/1/1b/Semi-protection-shackle.svg/40px-Semi-protection-shackle.svg.png 2x" data-file-width="512" data-file-height="512" /></a></div></div> </div> <div id="siteSub" class="noprint">From Wikipedia, the free encyclopedia</div> </div> <div id="contentSub"><div id="mw-content-subtitle"></div></div> <div id="mw-content-text" class="mw-body-content"><div class="mw-content-ltr mw-parser-output" lang="en" dir="ltr"><style data-mw-deduplicate="TemplateStyles:r1237875617">.mw-parser-output .documentation,.mw-parser-output .documentation-metadata{border:1px solid #a2a9b1;background-color:#ecfcf4;clear:both}.mw-parser-output .documentation{margin:1em 0 0 0;padding:1em}.mw-parser-output .documentation-metadata{margin:0.2em 0;font-style:italic;padding:0.4em 1em}.mw-parser-output .documentation-startbox{padding-bottom:3px;border-bottom:1px solid #aaa;margin-bottom:1ex}.mw-parser-output .documentation-heading{font-weight:bold;font-size:125%}.mw-parser-output .documentation-clear{clear:both}.mw-parser-output .documentation-toolbar{font-style:normal;font-size:85%}@media screen{html.skin-theme-clientpref-night .mw-parser-output .documentation,html.skin-theme-clientpref-night .mw-parser-output .documentation-metadata{background-color:#0b1e1c}}@media screen and (prefers-color-scheme:dark){html.skin-theme-clientpref-os .mw-parser-output .documentation,html.skin-theme-clientpref-os .mw-parser-output .documentation-metadata{background-color:#0b1e1c}}</style><div class="documentation-container" role="complementary" aria-labelledby="documentation-heading"> <div class="documentation"> <div class="documentation-startbox"> <img alt="" src="//upload.wikimedia.org/wikipedia/commons/thumb/4/43/Test_Template_Info-Icon_-_Version_%282%29.svg/50px-Test_Template_Info-Icon_-_Version_%282%29.svg.png" decoding="async" width="50" height="22" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/4/43/Test_Template_Info-Icon_-_Version_%282%29.svg/75px-Test_Template_Info-Icon_-_Version_%282%29.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/4/43/Test_Template_Info-Icon_-_Version_%282%29.svg/100px-Test_Template_Info-Icon_-_Version_%282%29.svg.png 2x" data-file-width="1792" data-file-height="800" /> Module documentation[<a href="/wiki/Module:Cs1_documentation_support/doc" title="Module:Cs1 documentation support/doc">view</a>] [<a href="/wiki/Special:EditPage/Module:Cs1_documentation_support/doc" title="Special:EditPage/Module:Cs1 documentation support/doc">edit</a>] [<a href="/wiki/Special:PageHistory/Module:Cs1_documentation_support/doc" title="Special:PageHistory/Module:Cs1 documentation support/doc">history</a>] [<a href="/wiki/Special:Purge/Module:Cs1_documentation_support" title="Special:Purge/Module:Cs1 documentation support">purge</a>]</div> <style data-mw-deduplicate="TemplateStyles:r1238436933">.mw-parser-output .ombox{margin:4px 0;border-collapse:collapse;border:1px solid #a2a9b1;background-color:var(--background-color-neutral-subtle,#f8f9fa);box-sizing:border-box;color:var(--color-base,#202122)}.mw-parser-output .ombox.mbox-small{font-size:88%;line-height:1.25em}.mw-parser-output .ombox-speedy{border:2px solid #b32424;background-color:#fee7e6}.mw-parser-output .ombox-delete{border:2px solid #b32424}.mw-parser-output .ombox-content{border:1px solid #f28500}.mw-parser-output .ombox-style{border:1px solid #fc3}.mw-parser-output .ombox-move{border:1px solid #9932cc}.mw-parser-output .ombox-protection{border:2px solid #a2a9b1}.mw-parser-output .ombox .mbox-text{border:none;padding:0.25em 0.9em;width:100%}.mw-parser-output .ombox .mbox-image{border:none;padding:2px 0 2px 0.9em;text-align:center}.mw-parser-output .ombox .mbox-imageright{border:none;padding:2px 0.9em 2px 0;text-align:center}.mw-parser-output .ombox .mbox-empty-cell{border:none;padding:0;width:1px}.mw-parser-output .ombox .mbox-invalid-type{text-align:center}@media(min-width:720px){.mw-parser-output .ombox{margin:4px 10%}.mw-parser-output .ombox.mbox-small{clear:right;float:right;margin:4px 0 4px 1em;width:238px}}body.skin--responsive .mw-parser-output table.ombox img{max-width:none!important}@media screen{html.skin-theme-clientpref-night .mw-parser-output .ombox-speedy{background-color:#310402}}@media screen and (prefers-color-scheme:dark){html.skin-theme-clientpref-os .mw-parser-output .ombox-speedy{background-color:#310402}}</style><table class="plainlinks ombox mbox-small ombox-notice" role="presentation"><tbody><tr><td class="mbox-image"><img alt="" src="//upload.wikimedia.org/wikipedia/commons/thumb/c/cf/Lua-Logo.svg/30px-Lua-Logo.svg.png" decoding="async" width="30" height="30" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/c/cf/Lua-Logo.svg/45px-Lua-Logo.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/c/cf/Lua-Logo.svg/60px-Lua-Logo.svg.png 2x" data-file-width="947" data-file-height="947" /></td><td class="mbox-text">This module depends on the following other modules:<div><ul><li><a href="/wiki/Module:Citation/CS1/Configuration" title="Module:Citation/CS1/Configuration">Module:Citation/CS1/Configuration</a> (<a href="/wiki/Module:Citation/CS1/Configuration/sandbox" title="Module:Citation/CS1/Configuration/sandbox">sandbox</a>)</li><li><a href="/wiki/Module:Citation/CS1/Configuration/sandbox" title="Module:Citation/CS1/Configuration/sandbox">Module:Citation/CS1/Configuration/sandbox</a></li><li><a href="/wiki/Module:Arguments" title="Module:Arguments">Module:Arguments</a> (<a href="/wiki/Module:Arguments/sandbox" title="Module:Arguments/sandbox">sandbox</a>)</li></ul></div></td></tr></tbody></table> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238436933"><table class="plainlinks ombox mbox-small ombox-notice" role="presentation"><tbody><tr><td class="mbox-image"><a href="/wiki/File:Farm-Fresh_css_add.svg" class="mw-file-description"><img alt="CSS" src="//upload.wikimedia.org/wikipedia/commons/thumb/a/a6/Farm-Fresh_css_add.svg/32px-Farm-Fresh_css_add.svg.png" decoding="async" width="32" height="27" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/a/a6/Farm-Fresh_css_add.svg/48px-Farm-Fresh_css_add.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/a/a6/Farm-Fresh_css_add.svg/64px-Farm-Fresh_css_add.svg.png 2x" data-file-width="142" data-file-height="121" /></a></td><td class="mbox-text">This module uses <a href="https://www.mediawiki.org/wiki/Help:TemplateStyles" class="extiw" title="mw:Help:TemplateStyles">TemplateStyles</a>: <div><ul><li><a href="/wiki/Module:Citation/CS1/styles.css" title="Module:Citation/CS1/styles.css">Module:Citation/CS1/styles.css</a> (<a href="/wiki/Module:Citation/CS1/sandbox/styles.css" title="Module:Citation/CS1/sandbox/styles.css">sandbox</a>)</li><li><a href="/wiki/Template:Div_col/styles.css" title="Template:Div col/styles.css">Template:Div col/styles.css</a> (<a href="/wiki/Template:Div_col/sandbox/styles.css" title="Template:Div col/sandbox/styles.css">sandbox</a>)</li></ul></div></td></tr></tbody></table> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238436933"><table class="plainlinks ombox ombox-style" role="presentation"><tbody><tr><td class="mbox-image"><img alt="Warning" src="//upload.wikimedia.org/wikipedia/en/thumb/7/74/Ambox_warning_yellow.svg/40px-Ambox_warning_yellow.svg.png" decoding="async" width="40" height="35" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/en/thumb/7/74/Ambox_warning_yellow.svg/60px-Ambox_warning_yellow.svg.png 1.5x, //upload.wikimedia.org/wikipedia/en/thumb/7/74/Ambox_warning_yellow.svg/80px-Ambox_warning_yellow.svg.png 2x" data-file-width="386" data-file-height="334" /></td><td class="mbox-text">This Lua module is used on <a class="external text" href="https://linkcount.toolforge.org/?project=en.wikipedia.org&page=Module%3ACs1+documentation+support#transclusions">approximately 250 pages</a> and changes may be widely noticed. Test changes in the module's <a href="/wiki/Module:Cs1_documentation_support/sandbox" title="Module:Cs1 documentation support/sandbox">/sandbox</a> or <a href="/w/index.php?title=Module:Cs1_documentation_support/testcases&action=edit&redlink=1" class="new" title="Module:Cs1 documentation support/testcases (page does not exist)">/testcases</a> subpages, or in your own <a href="/wiki/Module:Sandbox" title="Module:Sandbox">module sandbox</a>. Consider discussing changes on the <a href="/wiki/Module_talk:Cs1_documentation_support" class="mw-redirect" title="Module talk:Cs1 documentation support">talk page</a> before implementing them.</td></tr></tbody></table> This module provides support for cs1|2 documentation by fetching data from the various modules, most notably <a href="/wiki/Module:Citation/CS1/Configuration" title="Module:Citation/CS1/Configuration">Module:Citation/CS1/Configuration</a> and rendering that data in a reader-accessible format. <div class="mw-heading mw-heading2"><h2 id="Usage">Usage</h2></div> <code>{{#invoke:Cs1 documentation support|function_name}}</code> <div class="documentation-clear"></div> </div> <div role="note" class="documentation-metadata plainlinks">The above <a href="/wiki/Wikipedia:Template_documentation" title="Wikipedia:Template documentation">documentation</a> is <a href="/wiki/Help:Transclusion" title="Help:Transclusion">transcluded</a> from <a href="/wiki/Module:Cs1_documentation_support/doc" title="Module:Cs1 documentation support/doc">Module:Cs1 documentation support/doc</a>. (<a href="/wiki/Special:EditPage/Module:Cs1_documentation_support/doc" title="Special:EditPage/Module:Cs1 documentation support/doc">edit</a> | <a href="/wiki/Special:PageHistory/Module:Cs1_documentation_support/doc" title="Special:PageHistory/Module:Cs1 documentation support/doc">history</a>) Editors can experiment in this module's <a href="/wiki/Module:Cs1_documentation_support/sandbox" title="Module:Cs1 documentation support/sandbox">sandbox</a> (<a href="/wiki/Special:EditPage/Module:Cs1_documentation_support/sandbox" title="Special:EditPage/Module:Cs1 documentation support/sandbox">edit</a> | <a class="external text" href="https://en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3ACs1+documentation+support&page2=Module%3ACs1+documentation+support%2Fsandbox">diff</a>) and testcases (<a class="external text" href="https://en.wikipedia.org/w/index.php?title=Module:Cs1_documentation_support/testcases&action=edit&preload=Template%3ADocumentation%2Fpreload-module-testcases">create</a>) pages. <a href="/wiki/Special:PrefixIndex/Module:Cs1_documentation_support/" title="Special:PrefixIndex/Module:Cs1 documentation support/">Subpages of this module</a>.</div></div> <div class="mw-highlight mw-highlight-lang-lua mw-content-ltr mw-highlight-lines" dir="ltr"><pre><a href="#L-1"></a>require('strict'); <a href="#L-2"></a>local getArgs = require ('Module:Arguments').getArgs; <a href="#L-3"></a> <a href="#L-4"></a>local cfg = mw.loadData ('Module:Citation/CS1/Configuration'); -- load the configuration module <a href="#L-5"></a>local whitelist = mw.loadData ('Module:Citation/CS1/Whitelist'); -- load the whitelist module <a href="#L-6"></a> <a href="#L-7"></a> <a href="#L-8"></a>local exclusion_lists = { -- TODO: move these tables into a separate ~/data module and mw.loadData() it <a href="#L-9"></a> ['cite book'] = { <a href="#L-10"></a> ['agency'] = true, <a href="#L-11"></a> ['air-date'] = true, <a href="#L-12"></a> ['arxiv'] = true, <a href="#L-13"></a> ['biorxiv'] = true, <a href="#L-14"></a> ['citeseerx'] = true, <a href="#L-15"></a> ['class'] = true, <a href="#L-16"></a> ['conference'] = true, <a href="#L-17"></a> ['conference-format'] = true, <a href="#L-18"></a> ['conference-url'] = true, <a href="#L-19"></a> ['degree'] = true, <a href="#L-20"></a> ['department'] = true, <a href="#L-21"></a> ['display-interviewers'] = true, <a href="#L-22"></a> ['docket'] = true, <a href="#L-23"></a> ['episode'] = true, <a href="#L-24"></a> ['interviewer#'] = true, <a href="#L-25"></a> ['interviewer-first#'] = true, <a href="#L-26"></a> ['interviewer-link#'] = true, <a href="#L-27"></a> ['interviewer-mask#'] = true, <a href="#L-28"></a> ['ismn'] = true, <a href="#L-29"></a> ['issn'] = true, <a href="#L-30"></a> ['issue'] = true, <a href="#L-31"></a> ['jfm'] = true, <a href="#L-32"></a> ['journal'] = true, <a href="#L-33"></a> ['jstor'] = true, <a href="#L-34"></a> ['mailinglist'] = true, <a href="#L-35"></a> ['message-id'] = true, <a href="#L-36"></a> ['minutes'] = true, <a href="#L-37"></a> ['MR'] = true, <a href="#L-38"></a> ['network'] = true, <a href="#L-39"></a> ['number'] = true, <a href="#L-40"></a> ['RFC'] = true, <a href="#L-41"></a> ['script-journal'] = true, <a href="#L-42"></a> ['season'] = true, <a href="#L-43"></a> ['section'] = true, <a href="#L-44"></a> ['sections'] = true, <a href="#L-45"></a> ['series-link'] = true, <a href="#L-46"></a> ['series-number'] = true, <a href="#L-47"></a> ['series-separator'] = true, <a href="#L-48"></a> ['sheet'] = true, <a href="#L-49"></a> ['sheets'] = true, <a href="#L-50"></a> ['SSRN'] = true, <a href="#L-51"></a> ['station'] = true, <a href="#L-52"></a> ['time'] = true, <a href="#L-53"></a> ['time-caption'] = true, <a href="#L-54"></a> ['trans-article'] = true, <a href="#L-55"></a> ['trans-journal'] = true, <a href="#L-56"></a> ['transcript'] = true, <a href="#L-57"></a> ['transcript-format'] = true, <a href="#L-58"></a> ['transcript-url'] = true, <a href="#L-59"></a> ['ZBL'] = true, <a href="#L-60"></a> }, <a href="#L-61"></a> ['cite journal'] = { <a href="#L-62"></a> ['agency'] = true, <a href="#L-63"></a> ['air-date'] = true, <a href="#L-64"></a> ['book-title'] = true, <a href="#L-65"></a> ['chapter'] = true, <a href="#L-66"></a> ['chapter-format'] = true, <a href="#L-67"></a> ['chapter-url'] = true, <a href="#L-68"></a> ['chapter-url-access'] = true, <a href="#L-69"></a> ['class'] = true, <a href="#L-70"></a> ['conference'] = true, <a href="#L-71"></a> ['conference-format'] = true, <a href="#L-72"></a> ['conference-url'] = true, <a href="#L-73"></a> ['contribution'] = true, <a href="#L-74"></a> ['contributor#'] = true, <a href="#L-75"></a> ['contributor-first#'] = true, <a href="#L-76"></a> ['contributor-link#'] = true, <a href="#L-77"></a> ['contributor-mask#'] = true, <a href="#L-78"></a> ['degree'] = true, <a href="#L-79"></a> ['department'] = true, <a href="#L-80"></a> ['display-interviewers'] = true, <a href="#L-81"></a> ['docket'] = true, <a href="#L-82"></a> ['edition'] = true, <a href="#L-83"></a> ['editor#'] = true, <a href="#L-84"></a> ['editor-first#'] = true, <a href="#L-85"></a> ['editor-link#'] = true, <a href="#L-86"></a> ['editor-mask#'] = true, <a href="#L-87"></a> ['editors'] = true, <a href="#L-88"></a> ['encyclopedia'] = true, <a href="#L-89"></a> ['episode'] = true, <a href="#L-90"></a> ['ignore-isbn-error'] = true, <a href="#L-91"></a> ['interviewer#'] = true, <a href="#L-92"></a> ['interviewer-first#'] = true, <a href="#L-93"></a> ['interviewer-link#'] = true, <a href="#L-94"></a> ['interviewer-mask#'] = true, <a href="#L-95"></a> ['isbn'] = true, <a href="#L-96"></a> ['ismn'] = true, <a href="#L-97"></a> ['LCCN'] = true, <a href="#L-98"></a> ['mailinglist'] = true, <a href="#L-99"></a> ['message-id'] = true, <a href="#L-100"></a> ['minutes'] = true, <a href="#L-101"></a> ['network'] = true, <a href="#L-102"></a> ['script-chapter'] = true, <a href="#L-103"></a> ['season'] = true, <a href="#L-104"></a> ['section'] = true, <a href="#L-105"></a> ['sections'] = true, <a href="#L-106"></a> ['series-link'] = true, <a href="#L-107"></a> ['series-number'] = true, <a href="#L-108"></a> ['series-separator'] = true, <a href="#L-109"></a> ['sheet'] = true, <a href="#L-110"></a> ['sheets'] = true, <a href="#L-111"></a> ['station'] = true, <a href="#L-112"></a> ['time'] = true, <a href="#L-113"></a> ['time-caption'] = true, <a href="#L-114"></a> ['trans-article'] = true, <a href="#L-115"></a> ['transcript'] = true, <a href="#L-116"></a> ['transcript-format'] = true, <a href="#L-117"></a> ['transcript-url'] = true, <a href="#L-118"></a> }, <a href="#L-119"></a> } <a href="#L-120"></a> <a href="#L-121"></a>--[[-------------------------< A D D _ T O _ L I S T >--------------------------------------------------------- <a href="#L-122"></a> <a href="#L-123"></a>adds code/name pair to code_list and name/code pair to name_list; code/name pairs in override_list replace those <a href="#L-124"></a>taken from the MediaWiki list; these are marked with a superscripted dagger. <a href="#L-125"></a> <a href="#L-126"></a>|script-<param>= lang codes always use override names so dagger is omitted <a href="#L-127"></a> <a href="#L-128"></a>]] <a href="#L-129"></a> <a href="#L-130"></a>local function add_to_list (code_list, name_list, override_list, code, name, dagger) <a href="#L-131"></a> if false == dagger then <a href="#L-132"></a> dagger = ''; -- no dagger for |script-<param>= codes and names <a href="#L-133"></a> else <a href="#L-134"></a> dagger = '†'; -- dagger for all other lists using override <a href="#L-135"></a> end <a href="#L-136"></a> <a href="#L-137"></a> if override_list[code] then -- look in the override table for this code <a href="#L-138"></a> code_list[code] = override_list[code] .. dagger; -- use the name from the override table; mark with dagger <a href="#L-139"></a> name_list[override_list[code]] = code .. dagger; <a href="#L-140"></a> else <a href="#L-141"></a> code_list[code] = name; -- use the MediaWiki name and code <a href="#L-142"></a> name_list[name] = code; <a href="#L-143"></a> end <a href="#L-144"></a>end <a href="#L-145"></a> <a href="#L-146"></a> <a href="#L-147"></a>--[[-------------------------< L I S T _ F O R M A T >--------------------------------------------------------- <a href="#L-148"></a> <a href="#L-149"></a>formats key/value pair into a string for rendering <a href="#L-150"></a> ['k'] = 'v' → k: v <a href="#L-151"></a> <a href="#L-152"></a>]] <a href="#L-153"></a> <a href="#L-154"></a>local function list_format (result, list) <a href="#L-155"></a> for k, v in pairs (list) do <a href="#L-156"></a> table.insert (result, k .. ': ' .. v); <a href="#L-157"></a> end <a href="#L-158"></a>end <a href="#L-159"></a> <a href="#L-160"></a> <a href="#L-161"></a>--[[-------------------------< L A N G _ L I S T E R >--------------------------------------------------------- <a href="#L-162"></a> <a href="#L-163"></a>Module entry point <a href="#L-164"></a> <a href="#L-165"></a>Crude documentation tool that returns one of several lists of language codes and names. <a href="#L-166"></a> <a href="#L-167"></a>Used in Template:Citation Style documentation/language/doc <a href="#L-168"></a> <a href="#L-169"></a>{{#invoke:cs1 documentation support|lang_lister|list=<selector>|lang=<code>}} <a href="#L-170"></a> <a href="#L-171"></a>where <selector> is one of the values: <a href="#L-172"></a> 2char – list of ISO 639-1 codes and names sorted by code <a href="#L-173"></a> 3char – list of ISO 639-2, -3 codes and names sorted by code <a href="#L-174"></a> ietf – list of IETF language tags and names sorted by tag <a href="#L-175"></a> ietf2 – list of ISO 639-1 based IETF language tags and names sorted by tag <a href="#L-176"></a> ietf3 – list of list of ISO 639-2, -3 based IETF language tags and names sorted by tag <a href="#L-177"></a> name – list of language names and codes sorted by name <a href="#L-178"></a> all - list all language codes/tags and names sorted by code/tag <a href="#L-179"></a> <a href="#L-180"></a>where <code> is a MediaWiki supported 2, 3, or ietf-like language code; because of fall-back, language names may <a href="#L-181"></a>be the English-language names. <a href="#L-182"></a> <a href="#L-183"></a> <a href="#L-184"></a>]] <a href="#L-185"></a> <a href="#L-186"></a>local function lang_lister (frame) <a href="#L-187"></a> local lang = (frame.args.lang and '' ~= frame.args.lang) and frame.args.lang or mw.getContentLanguage():getCode() <a href="#L-188"></a> local source_list = mw.language.fetchLanguageNames(lang, 'all'); <a href="#L-189"></a> local override = cfg.lang_tag_remap; <a href="#L-190"></a> local code_1_list={}; <a href="#L-191"></a> local code_2_list={}; <a href="#L-192"></a> local ietf_list={}; <a href="#L-193"></a> local ietf_list2={}; <a href="#L-194"></a> local ietf_list3={}; <a href="#L-195"></a> local name_list={}; <a href="#L-196"></a> <a href="#L-197"></a> if not ({['2char']=true, ['3char']=true, ['ietf']=true, ['ietf2']=true, ['ietf3']=true, ['name']=true, ['all']=true})[frame.args.list] then <a href="#L-198"></a> return 'unknown list selector: ' .. frame.args.list .. ''; <a href="#L-199"></a> end <a href="#L-200"></a> <a href="#L-201"></a> for code, name in pairs (source_list) do <a href="#L-202"></a> if 'all' == frame.args.list then <a href="#L-203"></a> add_to_list (code_1_list, name_list, override, code, name); -- use the code_1_list because why not? <a href="#L-204"></a> elseif 2 == code:len() then <a href="#L-205"></a> add_to_list (code_1_list, name_list, override, code, name); <a href="#L-206"></a> elseif 3 == code:len() then <a href="#L-207"></a> add_to_list (code_2_list, name_list, override, code, name); <a href="#L-208"></a> elseif code:match ('^%a%a%-.+') then -- ietf with 2-character language tag <a href="#L-209"></a> add_to_list (ietf_list, name_list, override, code, name); -- add to main ietf list for |list=ietf <a href="#L-210"></a> add_to_list (ietf_list2, name_list, override, code, name); -- add to ietf2 list <a href="#L-211"></a> elseif code:match ('^%a%a%a%-.+') then -- ietf with 3-character language tag <a href="#L-212"></a> add_to_list (ietf_list, name_list, override, code, name); -- add to main ietf list for |list=ietf <a href="#L-213"></a> add_to_list (ietf_list3, name_list, override, code, name); -- add to ietf3 list <a href="#L-214"></a> end <a href="#L-215"></a> end <a href="#L-216"></a> <a href="#L-217"></a> local result = {}; <a href="#L-218"></a> local out = {}; <a href="#L-219"></a> <a href="#L-220"></a> if '2char' == frame.args.list or 'all' == frame.args.list then -- iso 639-1 <a href="#L-221"></a> list_format (result, code_1_list); <a href="#L-222"></a> elseif '3char' == frame.args.list then -- iso 639-2, 3 <a href="#L-223"></a> list_format (result, code_2_list); <a href="#L-224"></a> elseif 'ietf' == frame.args.list then -- all ietf tags <a href="#L-225"></a> list_format (result, ietf_list); <a href="#L-226"></a> elseif 'ietf2' == frame.args.list then -- 2-character ietf tags <a href="#L-227"></a> list_format (result, ietf_list2); <a href="#L-228"></a> elseif 'ietf3' == frame.args.list then -- 3 character ietf tags <a href="#L-229"></a> list_format (result, ietf_list3); <a href="#L-230"></a> else --must be 'name' <a href="#L-231"></a> list_format (result, name_list); <a href="#L-232"></a> end <a href="#L-233"></a> <a href="#L-234"></a> local templatestyles = frame:extensionTag{ <a href="#L-235"></a> name = 'templatestyles', args = { src = "Div col/styles.css" } <a href="#L-236"></a> } <a href="#L-237"></a> <a href="#L-238"></a> table.sort (result); <a href="#L-239"></a> table.insert (result, 1, templatestyles .. '<div class="div-col" style="column-width:16em">'); <a href="#L-240"></a> table.insert (out, table.concat (result, '\n*')); <a href="#L-241"></a> table.insert (out, '</div>'); <a href="#L-242"></a> <a href="#L-243"></a> return table.concat (out, '\n'); <a href="#L-244"></a>end <a href="#L-245"></a> <a href="#L-246"></a> <a href="#L-247"></a>--[[--------------------------< S C R I P T _ L A N G _ L I S T E R >------------------------------------------ <a href="#L-248"></a> <a href="#L-249"></a>Module entry point <a href="#L-250"></a> <a href="#L-251"></a>Crude documentation tool that returns list of language codes and names supported by the various |script-<param>= parameters. <a href="#L-252"></a> <a href="#L-253"></a>used in Help:CS1 errors <a href="#L-254"></a> <a href="#L-255"></a>{{#invoke:cs1 documentation support|script_lang_lister}} <a href="#L-256"></a> <a href="#L-257"></a>]] <a href="#L-258"></a> <a href="#L-259"></a>local function script_lang_lister (frame) <a href="#L-260"></a> local lang_code_src = cfg.script_lang_codes ; -- get list of allowed script language codes <a href="#L-261"></a> local override = cfg.lang_tag_remap; <a href="#L-262"></a> local this_wiki_lang = mw.language.getContentLanguage().code; -- get this wiki's language <a href="#L-263"></a> <a href="#L-264"></a> local code_list = {}; -- interim list of aliases <a href="#L-265"></a> local name_list={}; -- not used; defined here so that we can reuse add_to_list() <a href="#L-266"></a> local out = {}; -- final output (for now an unordered list) <a href="#L-267"></a> <a href="#L-268"></a> for _, code in ipairs (lang_code_src) do -- loop through the list of codes <a href="#L-269"></a> local name = mw.language.fetchLanguageName (code, this_wiki_lang); -- get the language name associated with this code <a href="#L-270"></a> add_to_list (code_list, name_list, override, code, name, false); -- name_list{} not used but provided so that we can reuse add_to_list(); don't add superscript dagger <a href="#L-271"></a> end <a href="#L-272"></a> <a href="#L-273"></a> local result = {}; <a href="#L-274"></a> local out = {}; <a href="#L-275"></a> <a href="#L-276"></a> list_format (result, code_list); <a href="#L-277"></a> <a href="#L-278"></a> local templatestyles = frame:extensionTag{ <a href="#L-279"></a> name = 'templatestyles', args = { src = "Div col/styles.css" } <a href="#L-280"></a> } <a href="#L-281"></a> <a href="#L-282"></a> table.sort (result); <a href="#L-283"></a> table.insert (result, 1, templatestyles .. '<div class="div-col" style="column-width:16em">'); <a href="#L-284"></a> table.insert (out, table.concat (result, '\n*')); <a href="#L-285"></a> table.insert (out, '</div>'); <a href="#L-286"></a> <a href="#L-287"></a> return table.concat (out, '\n'); <a href="#L-288"></a>end <a href="#L-289"></a> <a href="#L-290"></a> <a href="#L-291"></a>--[[--------------------------< A L I A S _ L I S T E R >------------------------------------------------------ <a href="#L-292"></a> <a href="#L-293"></a>experimental code that lists parameters and their aliases. Perhaps basis for some sort of documentation? <a href="#L-294"></a> <a href="#L-295"></a>{{#invoke:cs1 documentation support|alias_lister}} <a href="#L-296"></a> <a href="#L-297"></a>]] <a href="#L-298"></a> <a href="#L-299"></a>local function alias_lister () <a href="#L-300"></a> local alias_src = cfg.aliases; -- get master list of aliases <a href="#L-301"></a> local key; -- key for k/v in a new table <a href="#L-302"></a> local list = {}; -- interim list of aliases <a href="#L-303"></a> local out = {}; -- final output (for now an unordered list) <a href="#L-304"></a> <a href="#L-305"></a> for _, aliases in pairs (alias_src) do -- loop throu the master list of aliases <a href="#L-306"></a> if 'table' == type (aliases) then -- table only when there are aliases <a href="#L-307"></a> for i, alias in ipairs (aliases) do -- loop through all of the aliases <a href="#L-308"></a> if 1 == i then -- first 'alias' is the canonical parameter name <a href="#L-309"></a> key = alias; -- so it becomes the key in list <a href="#L-310"></a> else <a href="#L-311"></a> list[key] = list[key] and (list[key] .. ', ' .. alias) or alias; -- make comma-separated list of aliases <a href="#L-312"></a> list[alias] = 'see ' .. key; -- make a back reference from this alias to the canonical parameter <a href="#L-313"></a> end <a href="#L-314"></a> end <a href="#L-315"></a> end <a href="#L-316"></a> end <a href="#L-317"></a> <a href="#L-318"></a> for k, v in pairs (list) do -- loop through the list to make a simple unordered list <a href="#L-319"></a> table.insert (out, table.concat ({'*', k, ': ', v})); <a href="#L-320"></a> end <a href="#L-321"></a> <a href="#L-322"></a> table.sort (out); -- sort it <a href="#L-323"></a> return table.concat (out, '\010'); -- concatenate with \n <a href="#L-324"></a>-- return (mw.dumpObject (list)) <a href="#L-325"></a>end <a href="#L-326"></a> <a href="#L-327"></a> <a href="#L-328"></a>--[[--------------------------< C A N O N I C A L _ P A R A M _ L I S T E R >---------------------------------- <a href="#L-329"></a> <a href="#L-330"></a>experimental code that lists canonical parameter names. Perhaps basis for some sort of documentation? <a href="#L-331"></a> <a href="#L-332"></a>returns a comma separated, alpha sorted, list of the canonical parameters. If given a template name, excludes <a href="#L-333"></a>parameters listed in that template's exclusion_list[<template>]{} table (if a table has been defined). <a href="#L-334"></a> <a href="#L-335"></a>{{#invoke:cs1 documentation support|canonical_param_lister|<template>}} <a href="#L-336"></a> <a href="#L-337"></a>]] <a href="#L-338"></a> <a href="#L-339"></a>local function canonical_param_lister (frame) <a href="#L-340"></a> local template = frame.args[1]; <a href="#L-341"></a> if '' == template then <a href="#L-342"></a> template = nil; <a href="#L-343"></a> end <a href="#L-344"></a> <a href="#L-345"></a> if template then <a href="#L-346"></a> template = mw.text.trim (template:lower()); <a href="#L-347"></a> end <a href="#L-348"></a> <a href="#L-349"></a> local alias_src = cfg.aliases; -- get master list of aliases <a href="#L-350"></a> local id_src = cfg.id_handlers; -- get master list of identifiers <a href="#L-351"></a> <a href="#L-352"></a> local list = {}; -- interim list of aliases <a href="#L-353"></a> local out = {}; -- final output (for now an unordered list) <a href="#L-354"></a> <a href="#L-355"></a> for _, aliases in pairs (alias_src) do -- loop through the master list of aliases <a href="#L-356"></a> local name; <a href="#L-357"></a> if 'table' == type (aliases) then -- table only when there are aliases <a href="#L-358"></a> name = aliases[1]; -- first member of an aliases table is declared canonical <a href="#L-359"></a> else <a href="#L-360"></a> name = aliases; -- for those parameters that do not have any aliases, the parameter is declared canonical <a href="#L-361"></a> end <a href="#L-362"></a> <a href="#L-363"></a> if not template then -- no template name, add this parameter <a href="#L-364"></a> table.insert (list, name); <a href="#L-365"></a> elseif not exclusion_lists[template] then -- template name but no exclusion list <a href="#L-366"></a> table.insert (list, name); <a href="#L-367"></a> elseif not exclusion_lists[template][name] then -- template name and exclusion list but name not in list <a href="#L-368"></a> table.insert (list, name); <a href="#L-369"></a> end <a href="#L-370"></a> end <a href="#L-371"></a> <a href="#L-372"></a> for k, ids in pairs (id_src) do -- spin through the list of identifiers <a href="#L-373"></a> local name = id_src[k].parameters[1]; -- get the first (left-most) parameter name <a href="#L-374"></a> local access = id_src[k].custom_access; -- get the access-icon parameter if it exists for this identifier <a href="#L-375"></a> if not template then -- no template name <a href="#L-376"></a> table.insert (list, name); -- add this parameter <a href="#L-377"></a> if access then <a href="#L-378"></a> table.insert (list, access); -- add this access-icon parameter <a href="#L-379"></a> end <a href="#L-380"></a> elseif not exclusion_lists[template] then -- template name but no exclusion list <a href="#L-381"></a> table.insert (list, name); <a href="#L-382"></a> if access then <a href="#L-383"></a> table.insert (list, access); <a href="#L-384"></a> end <a href="#L-385"></a> elseif not exclusion_lists[template][name] then -- template name and exclusion list but name not in list <a href="#L-386"></a> table.insert (list, name); <a href="#L-387"></a> if access then <a href="#L-388"></a> table.insert (list, access); <a href="#L-389"></a> end <a href="#L-390"></a> end <a href="#L-391"></a> end <a href="#L-392"></a> <a href="#L-393"></a> for _, param in ipairs (list) do -- loop through the list to make a simple unordered list <a href="#L-394"></a> table.insert (out, table.concat ({'*', param})); <a href="#L-395"></a> end <a href="#L-396"></a> <a href="#L-397"></a> local function comp( a, b ) -- used in following table.sort() <a href="#L-398"></a> return a:lower() < b:lower(); <a href="#L-399"></a> end <a href="#L-400"></a> <a href="#L-401"></a> table.sort (out, comp); -- sort the list <a href="#L-402"></a> return table.concat (out, '\010'); -- concatenate with \n <a href="#L-403"></a>-- return (mw.dumpObject (list)) <a href="#L-404"></a>end <a href="#L-405"></a> <a href="#L-406"></a> <a href="#L-407"></a>--[[--------------------------< C A N O N I C A L _ N A M E _ G E T >------------------------------------------ <a href="#L-408"></a> <a href="#L-409"></a>returns first (canonical) name when metaparameter is assigned a table of names <a href="#L-410"></a>returns name when metaparameter is assigned a single name <a href="#L-411"></a>returns empty string when metaparameter name not found in alias_src{}, id_src{}, or id_src[meta].custom_access <a href="#L-412"></a> <a href="#L-413"></a>metaparameter <metaparam> is the key in Module:Citation/CS1 aliases{} table or id_handlers{} table. Because access-icon <a href="#L-414"></a>don't have <metaparam> keys, per se, we create pseudo <metaparam> keys by appending 'access' to the identifier <metaparam>: <a href="#L-415"></a> the <metaparam> for |doi-access= is, for the purposes of this function, DOIaccess, etc <a href="#L-416"></a> <a href="#L-417"></a>Some lists of aliases might be better served when a particular alias is identified as the canonical alias for a <a href="#L-418"></a>particular use case. If, for example, <metaparam> Perodical lists: <a href="#L-419"></a> 'journal', 'magazine', 'newspaper', 'periodical', 'website', 'work' <a href="#L-420"></a>that order works fine for {{cite journal}} documentation but doesn't work so well for {{cite magazine}}, {{cite news}}, <a href="#L-421"></a>or {{cite web}}. So, for using this function to document {{cite magazine}} the returned value should be the <a href="#L-422"></a>parameter best suited for that template so we can specify magazine in the override (frame.args[2]) <a href="#L-423"></a> <a href="#L-424"></a>While for this function, it would be just as simple to not use the function, this mechanism is implemented here <a href="#L-425"></a>to match similar functionality in alias_names_get() (there are slight differences) <a href="#L-426"></a> <override> must exist in the alias list <a href="#L-427"></a> does not apply to the access icon parameters (ignored - these have no aliases) <a href="#L-428"></a> <a href="#L-429"></a>(and which would be best for {{cite news}}? |newspaper= or |work=? can't solve all of the worlds problems at once). <a href="#L-430"></a> <a href="#L-431"></a>output format is controlled by |format= <a href="#L-432"></a> plain - renders in plain text in a tag; may have id attribute <a href="#L-433"></a> para - renders as it would in {{para|<param>}} <a href="#L-434"></a> <a href="#L-435"></a>{{#invoke:cs1 documentation support|canonical_name_get|<metaparam>|<override>|id=<attribute>|format=[plain|para]}} <a href="#L-436"></a> <a href="#L-437"></a>]] <a href="#L-438"></a> <a href="#L-439"></a>local function canonical_name_get (frame) <a href="#L-440"></a> local alias_src = cfg.aliases; -- get master list of aliases <a href="#L-441"></a> local id_src = cfg.id_handlers; -- get master list of identifiers <a href="#L-442"></a> local args = getArgs (frame); <a href="#L-443"></a> <a href="#L-444"></a> local name; <a href="#L-445"></a> local meta = args[1] <a href="#L-446"></a> local override = args[2]; <a href="#L-447"></a> <a href="#L-448"></a> local access; -- for id-access parameters <a href="#L-449"></a> if meta:match ('^(%u+)access') then -- the metaparameter (which is not used in ~/Configuration) is id_handlers key concatenated with access: BIBCODEaccess <a href="#L-450"></a> meta, access = meta:gsub ('^(%u+)access', '%1'); -- strip 'access' text from meta and use returned count value as a flag <a href="#L-451"></a> end <a href="#L-452"></a> <a href="#L-453"></a> if alias_src[meta] then <a href="#L-454"></a> name = alias_src[meta]; -- name is a string or a table <a href="#L-455"></a> if 'table' == type (name) then -- table only when there are aliases <a href="#L-456"></a> if not override then <a href="#L-457"></a> name = name[1]; -- first member of an aliases table is declared canonical <a href="#L-458"></a> else <a href="#L-459"></a> for _, v in ipairs (name) do -- here when override is set; spin throu the aliases to make sure override matches alias in table <a href="#L-460"></a> if v == override then <a href="#L-461"></a> name = v; -- declare override to be the canonical param for this use case <a href="#L-462"></a> break; <a href="#L-463"></a> end <a href="#L-464"></a> end <a href="#L-465"></a> end <a href="#L-466"></a> end <a href="#L-467"></a> <a href="#L-468"></a> elseif id_src[meta]then -- if there is an id handler <a href="#L-469"></a> if access then -- and if this is a request for the handler's custom access parameter <a href="#L-470"></a> if id_src[meta].custom_access then -- if there is a custom access parameter <a href="#L-471"></a> name = id_src[meta].custom_access; -- use it <a href="#L-472"></a> else <a href="#L-473"></a> return ''; -- nope, return empty string <a href="#L-474"></a> end <a href="#L-475"></a> else <a href="#L-476"></a> if not override then <a href="#L-477"></a> name = id_src[meta].parameters[1]; -- get canonical id handler parameter <a href="#L-478"></a> else <a href="#L-479"></a> for _, v in ipairs (id_src[meta].parameters) do -- here when override is set; spin throu the aliases to make sure override matches alias in table <a href="#L-480"></a> if v == override then <a href="#L-481"></a> name = v; -- declare override to be the canonical param for this use case <a href="#L-482"></a> break; <a href="#L-483"></a> end <a href="#L-484"></a> end <a href="#L-485"></a> end <a href="#L-486"></a> end <a href="#L-487"></a> else <a href="#L-488"></a> return ''; -- metaparameter not specified, or no such metaparameter <a href="#L-489"></a> end <a href="#L-490"></a> <a href="#L-491"></a> if 'plain' == args.format then -- format and return the output <a href="#L-492"></a> if args.id then <a href="#L-493"></a> return string.format ('%s', args.id, name); -- plain text with id attribute <a href="#L-494"></a> else <a href="#L-495"></a> return name; -- plain text <a href="#L-496"></a> end <a href="#L-497"></a> elseif 'para' == args.format then <a href="#L-498"></a> return string.format ('<code class="nowrap">|%s=</code>', name); -- same as {{para|<param>}} <a href="#L-499"></a> end <a href="#L-500"></a> <a href="#L-501"></a> return string.format ('%s', args.id or '', name); -- because {{csdoc}} bolds param names <a href="#L-502"></a>end <a href="#L-503"></a> <a href="#L-504"></a> <a href="#L-505"></a>--[[--------------------------< A L I A S _ N A M E S _ G E T >------------------------------------------------ <a href="#L-506"></a> <a href="#L-507"></a>returns list of aliases for metaparameter <metaparam> <a href="#L-508"></a>returns empty string when there are no aliases <a href="#L-509"></a>returns empty string when <metaparam> name not found in alias_src{} or id_src{}; access icon parameters have no aliases so ignored <a href="#L-510"></a> <a href="#L-511"></a>metaparameter <metaparam> is the key in Module:Citation/CS1 aliases{} table or id_handlers{} table. <a href="#L-512"></a> <a href="#L-513"></a>Some lists of aliases might be better served when a particular alias is identified as the canonical alias for a <a href="#L-514"></a>particular use case. If, for example, <metaparam> Perodical lists: <a href="#L-515"></a> 'journal', 'magazine', 'newspaper', 'periodical', 'website', 'work' <a href="#L-516"></a>that order works fine for {{cite journal}} documentation but doesn't work so well for {{cite magazine}}, {{cite news}}, <a href="#L-517"></a>or {{cite web}}. So, for using this function to document {{cite magazine}} the returned value should be the <a href="#L-518"></a>aliases that are not best suited for that template so we can specify magazine in the override (frame.args[2]) <a href="#L-519"></a>to be the canonical parameter so it won't be listed with the rest of the aliases (normal canonical journal will be) <a href="#L-520"></a> <a href="#L-521"></a> <override> must exist in the alias list except: <a href="#L-522"></a> when <override> value is 'all', returns the canonical parameter plus all of the aliases <a href="#L-523"></a> <a href="#L-524"></a>output format is controlled by |format= <a href="#L-525"></a> plain - renders in plain text in a tag; may have id attribute <a href="#L-526"></a> para - renders as it would in {{para|<param>}} <a href="#L-527"></a> when not specified, refurns the default bold format used for {{csdoc}} <a href="#L-528"></a> <a href="#L-529"></a>{{#invoke:cs1 documentation support|alias_name_get|<metaparam>|<override>|format=[plain|para]}} <a href="#L-530"></a> <a href="#L-531"></a>]] <a href="#L-532"></a> <a href="#L-533"></a>local function alias_names_get (frame) <a href="#L-534"></a> local alias_src = cfg.aliases; -- get master list of aliases <a href="#L-535"></a> local id_src = cfg.id_handlers; -- get master list of identifiers <a href="#L-536"></a> local args = getArgs (frame); <a href="#L-537"></a> <a href="#L-538"></a> local meta = args[1]; <a href="#L-539"></a> local override = args[2]; <a href="#L-540"></a> <a href="#L-541"></a> local out = {}; <a href="#L-542"></a> local source; -- selected parameter or id aliases list <a href="#L-543"></a> local aliases; <a href="#L-544"></a> <a href="#L-545"></a> source = alias_src[meta] or (id_src[meta] and id_src[meta].parameters); <a href="#L-546"></a> if not source then <a href="#L-547"></a> if meta:match ('%u+access') then <a href="#L-548"></a> return 'no' == args.none and '' or 'none'; -- custom access parameters don't have aliases <a href="#L-549"></a> else <a href="#L-550"></a> return ''; -- no such meta <a href="#L-551"></a> end <a href="#L-552"></a> elseif not source[2] then -- id_source[meta] is always a table; if no second member, no aliases <a href="#L-553"></a> return 'no' == args.none and '' or 'none'; <a href="#L-554"></a> end <a href="#L-555"></a> <a href="#L-556"></a> if not override then <a href="#L-557"></a> aliases = source; -- normal skip-canonical param case <a href="#L-558"></a> else <a href="#L-559"></a> local flag = 'all' == override and true or nil; -- so that we know that <override> parameter is a valid alias; spoof when override == 'all' <a href="#L-560"></a> aliases = {[1] = ''}; -- spoof to push alias_src[meta][1] and id_src[meta][1] into aliases[2] <a href="#L-561"></a> for _, v in ipairs (source) do -- here when override is set; spin through the aliases to make sure override matches alias in table <a href="#L-562"></a> if v ~= override then <a href="#L-563"></a> table.insert (aliases, v); -- add all but overridden param to the the aliases list for this use case <a href="#L-564"></a> else <a href="#L-565"></a> flag = true; -- set the flag so we know that <override> is a valid alias <a href="#L-566"></a> end <a href="#L-567"></a> end <a href="#L-568"></a> if not flag then <a href="#L-569"></a> aliases = {} -- unset the table as error indicator <a href="#L-570"></a> end <a href="#L-571"></a> end <a href="#L-572"></a> <a href="#L-573"></a> if 'table' == type (aliases) then -- table only when there are aliases <a href="#L-574"></a> for i, alias in ipairs (aliases) do <a href="#L-575"></a> if 1 ~= i then -- aliases[1] is the canonical name; don't include it <a href="#L-576"></a> if 'plain' == args.format then -- format and return the output <a href="#L-577"></a> table.insert (out, alias); -- plain text <a href="#L-578"></a> elseif 'para' == args.format then <a href="#L-579"></a> table.insert (out, string.format ('<code class="nowrap">|%s=</code>', alias)); -- same as {{para|<param>}} <a href="#L-580"></a> else <a href="#L-581"></a> table.insert (out, string.format ("'''%s'''", alias)); -- because csdoc bolds param names <a href="#L-582"></a> end <a href="#L-583"></a> end <a href="#L-584"></a> end <a href="#L-585"></a> <a href="#L-586"></a> return table.concat (out, ', '); -- make pretty list and quit <a href="#L-587"></a> end <a href="#L-588"></a> <a href="#L-589"></a> return 'no' == args.none and '' or 'none'; -- no metaparameter with that name or no aliases <a href="#L-590"></a>end <a href="#L-591"></a> <a href="#L-592"></a> <a href="#L-593"></a>--[[-------------------------------------------------------------- <a href="#L-594"></a> <a href="#L-595"></a>fetch the title of the current page; if it is a preprint template, return true; empty string else <a href="#L-596"></a> <a href="#L-597"></a>]] <a href="#L-598"></a> <a href="#L-599"></a>local book_cite_templates = { <a href="#L-600"></a> ['citation'] = true, <a href="#L-601"></a> ['cite book'] = true, <a href="#L-602"></a> } <a href="#L-603"></a> <a href="#L-604"></a>local function is_book_cite_template () <a href="#L-605"></a> local title = mw.title.getCurrentTitle().rootText; -- get title of current page without namespace and without sub-pages; from Template:Cite book/new -> Cite book <a href="#L-606"></a> <a href="#L-607"></a> title = title and title:lower() or ''; <a href="#L-608"></a> return book_cite_templates[title] or ''; <a href="#L-609"></a>end <a href="#L-610"></a> <a href="#L-611"></a> <a href="#L-612"></a>--[[------------------------------------------------------ <a href="#L-613"></a> <a href="#L-614"></a>fetch the title of the current page; if it is a preprint template, return true; empty string else <a href="#L-615"></a> <a href="#L-616"></a>]] <a href="#L-617"></a> <a href="#L-618"></a>local limited_param_templates = { -- if ever there is a need to fetch info from ~/Whitelist then <a href="#L-619"></a> ['cite arxiv'] = true, -- this list could also be fetched from there <a href="#L-620"></a> ['cite biorxiv'] = true, <a href="#L-621"></a> ['citeseerx'] = true, <a href="#L-622"></a> ['ssrn'] = true, <a href="#L-623"></a> } <a href="#L-624"></a> <a href="#L-625"></a>local function is_limited_param_template () <a href="#L-626"></a> local title = mw.title.getCurrentTitle().rootText; -- get title of current page without namespace and without sub-pages; from Template:Cite book/new -> Cite book <a href="#L-627"></a> <a href="#L-628"></a> title = title and title:lower() or ''; <a href="#L-629"></a> return limited_param_templates[title] or ''; <a href="#L-630"></a>end <a href="#L-631"></a> <a href="#L-632"></a> <a href="#L-633"></a>--[[--------------------------< H E A D E R _ M A K E >-------------------------------------------------------- <a href="#L-634"></a> <a href="#L-635"></a>makes a section header from <header_text> and <level>; <level> defaults to 2; cannot be less than 2 <a href="#L-636"></a> <a href="#L-637"></a>]] <a href="#L-638"></a> <a href="#L-639"></a>local function _header_make (args) <a href="#L-640"></a> if not args[1] then <a href="#L-641"></a> return ''; -- no header text <a href="#L-642"></a> end <a href="#L-643"></a> <a href="#L-644"></a> local level = args[2] and tonumber (args[2]) or 2; <a href="#L-645"></a> <a href="#L-646"></a> level = string.rep ('=', level); <a href="#L-647"></a> return level .. args[1] .. level; <a href="#L-648"></a>end <a href="#L-649"></a> <a href="#L-650"></a> <a href="#L-651"></a>--[[--------------------------< H E A D E R _ M A K E >-------------------------------------------------------- <a href="#L-652"></a> <a href="#L-653"></a>Entry from an {{#invoke:}} <a href="#L-654"></a>makes a section header from <header_text> and <level>; <level> defaults to 2; cannot be less than 2 <a href="#L-655"></a> <a href="#L-656"></a>]] <a href="#L-657"></a> <a href="#L-658"></a>local function header_make (frame) <a href="#L-659"></a> local args = getArgs (frame); <a href="#L-660"></a> return _header_make (args); <a href="#L-661"></a>end <a href="#L-662"></a> <a href="#L-663"></a> <a href="#L-664"></a>--[[------------------------------------------------------------------------------ <a href="#L-665"></a> <a href="#L-666"></a>return the limit values for named identifier parameters that have <id> limits (pmc, pmid, ssrn, s2cid, oclc, osti, rfc); the return <a href="#L-667"></a>value used in template documentation and error message help-text <a href="#L-668"></a> <a href="#L-669"></a>{{#invoke:Cs1 documentation support|id_limits_get|<id>}} <a href="#L-670"></a> <a href="#L-671"></a>]] <a href="#L-672"></a> <a href="#L-673"></a>local function id_limits_get (frame) <a href="#L-674"></a> local args = getArgs (frame); <a href="#L-675"></a> local handlers = cfg.id_handlers; -- get id_handlers {} table from ~/Configuration <a href="#L-676"></a> <a href="#L-677"></a> return args[1] and handlers[args[1]:upper()].id_limit or ('No limit defined for identifier: ' .. (args[1] or '<unknown name>') .. ''); <a href="#L-678"></a>end <a href="#L-679"></a> <a href="#L-680"></a> <a href="#L-681"></a>--[[--------------------------< C A T _ L I N K _ M A K E >---------------------------------------------------- <a href="#L-682"></a>]] <a href="#L-683"></a> <a href="#L-684"></a>local function cat_link_make (cat) <a href="#L-685"></a> return table.concat ({'[[:Category:', cat, ']]'}); <a href="#L-686"></a>end <a href="#L-687"></a> <a href="#L-688"></a> <a href="#L-689"></a>--[[--------------------------< S C R I P T _ C A T _ L I S T E R >-------------------------------------------- <a href="#L-690"></a> <a href="#L-691"></a>utility function to get script-language categories <a href="#L-692"></a> <a href="#L-693"></a>]] <a href="#L-694"></a> <a href="#L-695"></a>local lang_list_t = mw.language.fetchLanguageNames ('en', 'all'); <a href="#L-696"></a> <a href="#L-697"></a>local function script_cat_lister (script_lang_codes_t, lang_tag_remap_t, cats_list_t) <a href="#L-698"></a> for _, lang_code in ipairs (script_lang_codes_t) do <a href="#L-699"></a> local lang_name = lang_tag_remap_t[lang_code] or lang_list_t[lang_code]; -- use remap table to get Bengali instead of Bangla and the like; else use standard MediaWiki names <a href="#L-700"></a> local cat = 'CS1 uses ' .. lang_name .. '-language script (' .. lang_code .. ')'; -- build a category name <a href="#L-701"></a> cats_list_t[cat] = 1; -- and save it <a href="#L-702"></a> end <a href="#L-703"></a>end <a href="#L-704"></a> <a href="#L-705"></a> <a href="#L-706"></a>--[[--------------------------< C S 1 _ C A T _ L I S T E R >-------------------------------------------------- <a href="#L-707"></a> <a href="#L-708"></a>This is a crude tool that reads the category names from Module:Citation/CS1/Configuration, makes links of them, <a href="#L-709"></a>and then lists them in sorted lists. A couple of parameters control the rendering of the output: <a href="#L-710"></a> |select= -- (required) takes one of three values: error, maint, prop <a href="#L-711"></a> |sandbox= -- takes one value: no <a href="#L-712"></a> |hdr-lvl= -- base header level (number of == that make a header); default:2 min:2 <a href="#L-713"></a> <a href="#L-714"></a>This tool will automatically attempt to load a sandbox version of ~/Configuration if one exists. <a href="#L-715"></a>Setting |sandbox=no will defeat this. <a href="#L-716"></a> <a href="#L-717"></a>{{#invoke:cs1 documentation support|cat_lister|select=<error|maint|prop>|sandbox=<no>}} <a href="#L-718"></a> <a href="#L-719"></a>]] <a href="#L-720"></a> <a href="#L-721"></a>local function cat_lister (frame) <a href="#L-722"></a> local args = getArgs (frame); <a href="#L-723"></a> <a href="#L-724"></a> local list_live_cats = {}; -- list of live categories <a href="#L-725"></a> local list_sbox_cats = {}; -- list of sandbox categories <a href="#L-726"></a> <a href="#L-727"></a> local live_sbox_out = {} -- list of categories that are common to live and sandbox modules <a href="#L-728"></a> local live_not_in_sbox_out = {} -- list of categories in live but not sandbox <a href="#L-729"></a> local sbox_not_in_live_out = {} -- list of categories in sandbox but not live <a href="#L-730"></a> <a href="#L-731"></a> local out = {}; -- final output assembled here <a href="#L-732"></a> <a href="#L-733"></a> local sandbox; -- boolean; true: evaluate the sandbox module <a href="#L-734"></a> local hdr_lvl; -- <a href="#L-735"></a> <a href="#L-736"></a> local sb_cfg; <a href="#L-737"></a> local sandbox, sb_cfg = pcall (mw.loadData, 'Module:Citation/CS1/Configuration/sandbox'); -- get sandbox configuration <a href="#L-738"></a> <a href="#L-739"></a> local cat; <a href="#L-740"></a> <a href="#L-741"></a> local select = args.select; <a href="#L-742"></a> if 'no' == args.sandbox then -- list sandbox? <a href="#L-743"></a> sandbox = false; -- no, live only <a href="#L-744"></a> end <a href="#L-745"></a> if hdr_lvl then -- if set and <a href="#L-746"></a> if tonumber (hdr_lvl) then -- can be converted to number <a href="#L-747"></a> if 2 > tonumber (hdr_lvl) then -- min is 2 <a href="#L-748"></a> hdr_lvl = 2; -- so set to min <a href="#L-749"></a> end <a href="#L-750"></a> else -- can't be converted <a href="#L-751"></a> hdr_lvl = 2; -- so default to min <a href="#L-752"></a> end <a href="#L-753"></a> else <a href="#L-754"></a> hdr_lvl = 2; -- not set so default to min <a href="#L-755"></a> end <a href="#L-756"></a> <a href="#L-757"></a> if 'error' == select or 'maint' == select then -- error and main categorys handling different from poperties cats <a href="#L-758"></a> for _, t in pairs (cfg.error_conditions) do -- get the live module's categories <a href="#L-759"></a> if ('error' == select and t.message) or ('maint' == select and not t.message) then <a href="#L-760"></a> cat = t.category:gsub ('|(.*)$', ''); -- strip sort key if any <a href="#L-761"></a> list_live_cats[cat] = 1; -- add to the list <a href="#L-762"></a> end <a href="#L-763"></a> end <a href="#L-764"></a> <a href="#L-765"></a> if sandbox then -- if ~/sandbox module exists and |sandbox= not set to 'no' <a href="#L-766"></a> for _, t in pairs (sb_cfg.error_conditions) do -- get the sandbox module's categories <a href="#L-767"></a> if ('error' == select and t.message) or ('maint' == select and not t.message) then <a href="#L-768"></a> cat = t.category:gsub ('|(.*)$', ''); -- strip sort key if any <a href="#L-769"></a> list_sbox_cats[cat] = 1; -- add to the list <a href="#L-770"></a> end <a href="#L-771"></a> end <a href="#L-772"></a> end <a href="#L-773"></a> <a href="#L-774"></a> elseif 'prop' == select then -- prop cats <a href="#L-775"></a> for _, cat in pairs (cfg.prop_cats) do -- get the live module's categories <a href="#L-776"></a> cat = cat:gsub ('|(.*)$', ''); -- strip sort key if any <a href="#L-777"></a> list_live_cats[cat] = 1; -- add to the list <a href="#L-778"></a> end <a href="#L-779"></a> <a href="#L-780"></a> script_cat_lister (cfg.script_lang_codes, cfg.lang_tag_remap, list_live_cats); -- get live module's foriegn language script cats <a href="#L-781"></a> <a href="#L-782"></a> if sandbox then -- if ~/sandbox module exists and |sandbox= not set to 'no' <a href="#L-783"></a> for _, cat in pairs (sb_cfg.prop_cats) do -- get the sandbox module's categories <a href="#L-784"></a> cat = cat:gsub ('|(.*)$', ''); -- strip sort key if any <a href="#L-785"></a> list_sbox_cats[cat] = 1; -- add to the list <a href="#L-786"></a> end <a href="#L-787"></a> <a href="#L-788"></a> script_cat_lister (sb_cfg.script_lang_codes, sb_cfg.lang_tag_remap, list_sbox_cats); -- get sandbox module's foriegn language script cats <a href="#L-789"></a> end <a href="#L-790"></a> else <a href="#L-791"></a> return 'error: unknown selector: ' .. select .. '' <a href="#L-792"></a> end <a href="#L-793"></a> <a href="#L-794"></a> for k, _ in pairs (list_live_cats) do -- separate live/sbox common cats from cats not in sbox <a href="#L-795"></a> if not list_sbox_cats[k] and sandbox then <a href="#L-796"></a> table.insert (live_not_in_sbox_out, cat_link_make (k)); -- in live but not in sbox <a href="#L-797"></a> else <a href="#L-798"></a> table.insert (live_sbox_out, cat_link_make (k)); -- in both live and sbox <a href="#L-799"></a> end <a href="#L-800"></a> end <a href="#L-801"></a> <a href="#L-802"></a> for k, _ in pairs (list_sbox_cats) do -- separate sbox/live common cats from cats not in live <a href="#L-803"></a> if not list_live_cats[k] then <a href="#L-804"></a> table.insert (sbox_not_in_live_out, cat_link_make (k)); -- in sbox but not in live <a href="#L-805"></a> end <a href="#L-806"></a> end <a href="#L-807"></a> <a href="#L-808"></a> local function comp (a, b) -- local function for case-agnostic category name sorting <a href="#L-809"></a> return a:lower() < b:lower(); <a href="#L-810"></a> end <a href="#L-811"></a> <a href="#L-812"></a> local header; -- initialize section header with name of selected category list <a href="#L-813"></a> if 'error' == select then <a href="#L-814"></a> header = 'error'; <a href="#L-815"></a> elseif 'maint' == select then <a href="#L-816"></a> header = 'maintenance'; <a href="#L-817"></a> else <a href="#L-818"></a> header = 'properties'; <a href="#L-819"></a> end <a href="#L-820"></a> <a href="#L-821"></a> header = table.concat ({ -- build the main header <a href="#L-822"></a> 'Live ', -- always include this <a href="#L-823"></a> ((sandbox and 'and sandbox ') or ''), -- if sandbox evaluated, mention that <a href="#L-824"></a> header, -- add the list name <a href="#L-825"></a> ' categories (', -- finish the name and add <a href="#L-826"></a> #live_sbox_out, -- count of categories listed <a href="#L-827"></a> ')' -- close <a href="#L-828"></a> }) <a href="#L-829"></a> <a href="#L-830"></a> local templatestyles = frame:extensionTag{ <a href="#L-831"></a> name = 'templatestyles', args = { src = "Div col/styles.css" } <a href="#L-832"></a> } <a href="#L-833"></a> <a href="#L-834"></a> header = table.concat ({ -- make a useable header <a href="#L-835"></a> _header_make ({header, hdr_lvl}), <a href="#L-836"></a> '\n' .. templatestyles .. '<div class="div-col">' -- opening <div> for columns <a href="#L-837"></a> }); <a href="#L-838"></a> <a href="#L-839"></a> table.sort (live_sbox_out, comp); -- sort case agnostic acsending <a href="#L-840"></a> table.insert (live_sbox_out, 1, header); -- insert the header at the top <a href="#L-841"></a> table.insert (out, table.concat (live_sbox_out, '\n*')); -- make a big string of unordered list markup <a href="#L-842"></a> table.insert (out, '</div>\n'); -- close the </div> and add new line so the next header works <a href="#L-843"></a> <a href="#L-844"></a> if 0 ~= #live_not_in_sbox_out then -- when there is something in the table <a href="#L-845"></a> header = table.concat ({ -- build header for subsection <a href="#L-846"></a> 'In live but not in sandbox (', <a href="#L-847"></a> #live_not_in_sbox_out, <a href="#L-848"></a> ')' <a href="#L-849"></a> }); <a href="#L-850"></a> <a href="#L-851"></a> header = table.concat ({ -- make a useable header <a href="#L-852"></a> _header_make ({header, hdr_lvl+1}), <a href="#L-853"></a> '\n' .. templatestyles .. '<div class="div-col">' <a href="#L-854"></a> }); <a href="#L-855"></a> <a href="#L-856"></a> table.sort (live_not_in_sbox_out, comp); <a href="#L-857"></a> table.insert (live_not_in_sbox_out, 1, header); <a href="#L-858"></a> table.insert (out, table.concat (live_not_in_sbox_out, '\n*')); <a href="#L-859"></a> table.insert (out, '</div>\n'); <a href="#L-860"></a> end <a href="#L-861"></a> <a href="#L-862"></a> if 0 ~= #sbox_not_in_live_out then -- when there is something in the table <a href="#L-863"></a> header = table.concat ({ -- build header for subsection <a href="#L-864"></a> 'In sandbox but not in live (', <a href="#L-865"></a> #sbox_not_in_live_out, <a href="#L-866"></a> ')' <a href="#L-867"></a> }); <a href="#L-868"></a> <a href="#L-869"></a> header = table.concat ({ -- make a useable header <a href="#L-870"></a> _header_make ({header, hdr_lvl+1}), <a href="#L-871"></a> '\n' .. templatestyles .. '<div class="div-col">' <a href="#L-872"></a> }); <a href="#L-873"></a> <a href="#L-874"></a> table.sort (sbox_not_in_live_out, comp); <a href="#L-875"></a> table.insert (sbox_not_in_live_out, 1, header); <a href="#L-876"></a> table.insert (out, table.concat (sbox_not_in_live_out, '\n*')); <a href="#L-877"></a> table.insert (out, '</div>\n'); <a href="#L-878"></a> end <a href="#L-879"></a> <a href="#L-880"></a> return table.concat (out); -- concat into a huge string and done <a href="#L-881"></a>end <a href="#L-882"></a> <a href="#L-883"></a> <a href="#L-884"></a>--[=[--------------------------< H E L P _ T E X T _ C A T S >-------------------------------------------------- <a href="#L-885"></a> <a href="#L-886"></a>To create category links at the bottom of each error help text section and on the individual error category pages; <a href="#L-887"></a>fetches category names from ~/Configuration; replaces this: <a href="#L-888"></a> {{#ifeq:{{FULLPAGENAME}}|Category:CS1 errors: bioRxiv|Category:CS1 errors: bioRxiv|[[:Category:CS1 errors: bioRxiv]]}} <a href="#L-889"></a>with this: <a href="#L-890"></a> {{#invoke:Cs1 documentation support|help_text_cats|err_bad_biorxiv}} <a href="#L-891"></a>where {{{1}}} is the error_conditions key from Module:Citation/CS1/Configuration <a href="#L-892"></a> <a href="#L-893"></a>add |pages=yes to append the number of pages in the category <a href="#L-894"></a> <a href="#L-895"></a>]=] <a href="#L-896"></a> <a href="#L-897"></a>local function help_text_cats (frame) <a href="#L-898"></a> local args_t = getArgs (frame); <a href="#L-899"></a> local error_conditions_t = cfg.error_conditions; -- get the table of error conditions <a href="#L-900"></a> local replacements_t = {}; -- table to hold replacement parameters for $1 etc placeholders in category names <a href="#L-901"></a> for k, v in pairs (args_t) do -- look for |$1=<replacement> parameters <a href="#L-902"></a> if 'string' == type (k) and k:match ('^$%d+$') then -- if found <a href="#L-903"></a> replacements_t[k] = v; -- save key and value <a href="#L-904"></a> end <a href="#L-905"></a> end <a href="#L-906"></a> <a href="#L-907"></a> if args_t[1] and error_conditions_t[args_t[1]] then -- must have error_condition key and it must exist <a href="#L-908"></a> local error_cat = error_conditions_t[args_t[1]].category; -- get error category from cs1|2 configuration <a href="#L-909"></a> if error_cat:match ('$%d') then -- look for placeholders in <error_cat> <a href="#L-910"></a> error_cat = error_cat:gsub ('$%d', replacements_t) -- replace place holders with matching value from replacements_t <a href="#L-911"></a> end <a href="#L-912"></a> <a href="#L-913"></a> local title_obj = mw.title.getCurrentTitle(); -- get a title object for the currently displayed page <a href="#L-914"></a> local name_space = title_obj.nsText; <a href="#L-915"></a> if ('Category' == name_space) and (error_cat == title_obj.text) then -- if this is the category page for the error message <a href="#L-916"></a> return table.concat ({'Category:', error_cat}); -- no link; just category name <a href="#L-917"></a> else -- here when currently displayed page is other than the error message category <a href="#L-918"></a> local pages = ''; -- default empty strin for concatenation <a href="#L-919"></a> if 'yes' == args_t.pages then -- if we should display category page count: TODO: do we need to keep this? <a href="#L-920"></a> pages = mw.site.stats.pagesInCategory (error_cat, 'all'); -- get category page count <a href="#L-921"></a> pages = table.concat ({' (', mw.language.getContentLanguage():formatNum (pages), ' page', (1 == pages) and ')' or 's)'}); -- make renderable text <a href="#L-922"></a> end <a href="#L-923"></a> return table.concat ({'[[:Category:', error_cat, ']]', pages}); -- link to category with or without page count <a href="#L-924"></a> end <a href="#L-925"></a> else <a href="#L-926"></a> return 'unknown error_conditions key: ' .. (args_t[1] or 'key missing') .. ''; <a href="#L-927"></a> end <a href="#L-928"></a>end <a href="#L-929"></a> <a href="#L-930"></a> <a href="#L-931"></a>--[[--------------------------< H E L P _ T E X T _ E R R O R _ M E S S A G E >-------------------------------- <a href="#L-932"></a> <a href="#L-933"></a>to render help text example error messages <a href="#L-934"></a> {{#invoke:Cs1 documentation support|help_text_error_messages|err_bad_biorxiv}} <a href="#L-935"></a> <a href="#L-936"></a>assign a single underscore to any of the |$n= parameters to insert an empty string in the error message: <a href="#L-937"></a> {{#invoke:Cs1 documentation support|help_text_error_messages|err_bad_issn|$1=_}} -> Check |issn= value <a href="#L-938"></a> {{#invoke:Cs1 documentation support|help_text_error_messages|err_bad_issn|$1=e}} -> Check |eissn= value <a href="#L-939"></a> <a href="#L-940"></a>error message is rendered at 120% font size; to specify another font size use |size=; must include unit specifier (%, em, etc) <a href="#L-941"></a> <a href="#L-942"></a>]] <a href="#L-943"></a> <a href="#L-944"></a>local function help_text_error_messages (frame) <a href="#L-945"></a> local args_t = getArgs (frame); <a href="#L-946"></a> local error_conditions = mw.loadData ('Module:Citation/CS1/Configuration').error_conditions; <a href="#L-947"></a>-- local span_o = ''; <a href="#L-948"></a> local span_o = ' .. ((args_t.size and args_t.size) or '120%') .. '">'; <a href="#L-949"></a> local span_c = ''; <a href="#L-950"></a> <a href="#L-951"></a> local message; <a href="#L-952"></a> local out = {}; -- output goes here <a href="#L-953"></a> <a href="#L-954"></a> if args_t[1] and error_conditions[args_t[1]] then -- must have error_condition key and it must exist <a href="#L-955"></a> message = error_conditions[args_t[1]].message; <a href="#L-956"></a> local i=1; <a href="#L-957"></a> local count; <a href="#L-958"></a> local rep; <a href="#L-959"></a> repeat <a href="#L-960"></a> rep = '$'..i <a href="#L-961"></a> args_t[rep] = args_t[rep] and args_t[rep]:gsub ('^%s*_%s*$', '') or nil; -- replace empty string marker with actual empty string <a href="#L-962"></a> message, count = message:gsub (rep, args_t[rep] or rep) <a href="#L-963"></a> i = i + 1; <a href="#L-964"></a> until (0 == count); <a href="#L-965"></a> <a href="#L-966"></a> table.insert (out, span_o); <a href="#L-967"></a> table.insert (out, message); <a href="#L-968"></a> table.insert (out, span_c); <a href="#L-969"></a> else <a href="#L-970"></a> return 'unknown error_conditions key: ' .. (args_t[1] or 'key missing') .. ''; <a href="#L-971"></a> end <a href="#L-972"></a> <a href="#L-973"></a> local out_str = table.concat (out); <a href="#L-974"></a> return table.concat ({frame:extensionTag ('templatestyles', '', {src='Module:Citation/CS1/styles.css'}), out_str}); <a href="#L-975"></a>end <a href="#L-976"></a> <a href="#L-977"></a> <a href="#L-978"></a>--[[--------------------------< T E M P L A T E S _ T >-------------------------------------------------------- <a href="#L-979"></a> <a href="#L-980"></a>This table is a k/v table of sequence tables. The keys in this table are collapsed lowercase form of the cs1|2 <a href="#L-981"></a>template names ({{ROOTPAGENAME}}): <a href="#L-982"></a> Template:Cite AV media -> citeavmedia <a href="#L-983"></a> <a href="#L-984"></a>Each subsequence table holds: <a href="#L-985"></a> [1] documentation page where the TemplateData json is stored ({{cite book}} is the oddball) <a href="#L-986"></a> [2] key to 'preprint_arguments_t' and unique_arguments_t' tables in Module:Citation/CS1/Whitelist; these keys <a href="#L-987"></a> dictate which of the basic or limited arguments and numbered arguments tables will be used to validate <a href="#L-988"></a> the content of the TemplateData <a href="#L-989"></a> <a href="#L-990"></a>]] <a href="#L-991"></a> <a href="#L-992"></a>local templates_t = { <a href="#L-993"></a> citearxiv = {'Template:Cite_arXiv/doc', 'arxiv'}, -- preprint arguments <a href="#L-994"></a> citeavmedia = {'Template:Cite AV media/doc', 'audio-visual'}, -- unique arguments <a href="#L-995"></a> citeavmedianotes = {'Template:Cite AV media notes/doc'}, -- no template data <a href="#L-996"></a> citebiorxiv = {'Template:Cite bioRxiv/doc', 'biorxiv'}, -- preprint arguments <a href="#L-997"></a> citebook = {'Template:Cite book/TemplateData'}, <a href="#L-998"></a> citeciteseerx = {'Template:Cite CiteSeerX/doc', 'citeseerx'}, -- no template data; preprint uses limited arguments <a href="#L-999"></a> citeconference = {'Template:Cite conference/doc', 'conference'}, -- unique arguments <a href="#L-1000"></a> citedocument = {'Template:Cite document/doc', 'document'}, -- special case; uses whitelist.document_parameters_t <a href="#L-1001"></a> citeencyclopedia = {'Template:Cite encyclopedia/doc'}, <a href="#L-1002"></a> citeepisode = {'Template:Cite episode/doc', 'episode'}, -- unique arguments <a href="#L-1003"></a> citeinterview = {'Template:Cite interview/doc'}, <a href="#L-1004"></a> citejournal = {'Template:Cite journal/doc'}, <a href="#L-1005"></a> citemagazine = {'Template:Cite magazine/doc'}, <a href="#L-1006"></a> citemailinglist = {'Template:Cite mailing list/doc', 'mailinglist'}, -- unique arguments -- no template data <a href="#L-1007"></a> citemap = {'Template:Cite map/TemplateData', 'map'}, -- unique arguments <a href="#L-1008"></a> citemedrxiv = {'Template:Cite medRxiv/doc', 'medrxiv'}, -- preprint arguments <a href="#L-1009"></a> citenews = {'Template:Cite news/doc'}, <a href="#L-1010"></a> citenewsgroup = {'Template:Cite newsgroup/doc', 'newsgroup'}, -- unique arguments <a href="#L-1011"></a> citepodcast = {'Template:Cite podcast/doc'}, <a href="#L-1012"></a> citepressrelease = {'Template:Cite press release/doc'}, <a href="#L-1013"></a> citereport = {'Template:Cite report/doc', 'report'}, -- unique arguments <a href="#L-1014"></a> citeserial = {'Template:Cite serial/doc', 'serial'}, -- unique arguments -- no template data <a href="#L-1015"></a> citesign = {'Template:Cite sign/doc'}, <a href="#L-1016"></a> citespeech = {'Template:Cite speech/doc', 'speech'}, -- unique arguments -- no template data <a href="#L-1017"></a> citessrn = {'Template:Cite SSRN/doc', 'ssrn'}, -- preprint arguments -- no template data <a href="#L-1018"></a> citetechreport = {'Template:Cite techreport/doc'}, <a href="#L-1019"></a> citethesis = {'Template:Cite thesis/doc', 'thesis'}, -- unique arguments <a href="#L-1020"></a> citeweb = {'Template:Cite web/doc'}, <a href="#L-1021"></a> citation = {'Template:Citation/doc'}, <a href="#L-1022"></a> } <a href="#L-1023"></a> <a href="#L-1024"></a> <a href="#L-1025"></a>--[[--------------------------< N O _ P A G E _ T E M P L A T E S _ T >---------------------------------------- <a href="#L-1026"></a> <a href="#L-1027"></a> <a href="#L-1028"></a>]] <a href="#L-1029"></a> <a href="#L-1030"></a>local no_page_templates_t = {}; <a href="#L-1031"></a> <a href="#L-1032"></a> <a href="#L-1033"></a>--[[---------------------------------------------------------------- <a href="#L-1034"></a> <a href="#L-1035"></a>a table of the identifier aliases <a href="#L-1036"></a> <a href="#L-1037"></a>]] <a href="#L-1038"></a> <a href="#L-1039"></a>local identifier_aliases_t = {} <a href="#L-1040"></a>for identifier, handler in pairs (cfg.id_handlers) do -- for each identifier <a href="#L-1041"></a> local aliases_t = {}; -- create a table <a href="#L-1042"></a> for _, alias in ipairs (handler.parameters) do -- get the alaises <a href="#L-1043"></a> aliases_t[alias] = true; -- and add them to the table in a form that mimics the whitelist tables <a href="#L-1044"></a> end <a href="#L-1045"></a> identifier_aliases_t[identifier:lower()] = aliases_t; -- add new table to the identifier aliases table; use lowercase identifier base name for the key <a href="#L-1046"></a>end <a href="#L-1047"></a> <a href="#L-1048"></a> <a href="#L-1049"></a>--[[--------------------------< T E M P L A T E _ D A T A _ J S O N _ G E T >---------------------------------- <a href="#L-1050"></a> <a href="#L-1051"></a>get template doc page content and extract the content of the TemplateData tags (case insensitive) <a href="#L-1052"></a> <a href="#L-1053"></a><template> is the canonical name of the template doc page (with namespace) that holds the template data; usually <a href="#L-1054"></a>Template:Cite xxx/doc (except Template:Cite book/TemplateData) <a href="#L-1055"></a> <a href="#L-1056"></a>]] <a href="#L-1057"></a> <a href="#L-1058"></a>local function template_data_json_get (template) <a href="#L-1059"></a> local json = mw.title.new (template):getContent() or ''; -- get the content of the article or ''; new pages edited w/ve do not have 'content' until saved; ve does not preview; phab:T221625 <a href="#L-1060"></a> json = json:match ('<[Tt]emplate[Dd]ata>(.-)</[Tt]emplate[Dd]ata>'); -- remove everything exept the content of the TemplatData tags <a href="#L-1061"></a> return json and mw.text.jsonDecode (json); -- decode the json string and return as a table; nil if not found <a href="#L-1062"></a>end <a href="#L-1063"></a> <a href="#L-1064"></a> <a href="#L-1065"></a>--[[--------------------------< V A L I D A T E _ D O C U M E N T _ P A R A M >-------------------------------- <a href="#L-1066"></a> <a href="#L-1067"></a>looks for <param> (can be the canonical parameter name or can be an alias) in whitelist.document_parameters_t. <a href="#L-1068"></a>When found, returns true; nil else <a href="#L-1069"></a> <a href="#L-1070"></a><param> is the parameter's name as listed in the TemplateData <a href="#L-1071"></a> <a href="#L-1072"></a>]] <a href="#L-1073"></a> <a href="#L-1074"></a>local function validate_document_param (param) <a href="#L-1075"></a> if true == whitelist.document_parameters_t[param] then <a href="#L-1076"></a> return true; <a href="#L-1077"></a> end <a href="#L-1078"></a>end <a href="#L-1079"></a> <a href="#L-1080"></a> <a href="#L-1081"></a>--[[--------------------------< V A L I D A T E _ U N I Q U E _ P A R A M >------------------------------------ <a href="#L-1082"></a> <a href="#L-1083"></a>looks for <param> (can be the canonical parameter name or can be an alias) in whitelist.basic_arguments{} and if <a href="#L-1084"></a>necessary in whitelist.numbered_arguments{}. When found, returns true; nil else <a href="#L-1085"></a> <a href="#L-1086"></a><param> is the parameter's name as listed in the TemplateData <a href="#L-1087"></a> <a href="#L-1088"></a>]] <a href="#L-1089"></a> <a href="#L-1090"></a>local function validate_basic_param (param) <a href="#L-1091"></a> if true == whitelist.common_parameters_t[param] then <a href="#L-1092"></a> return true; <a href="#L-1093"></a> end <a href="#L-1094"></a>end <a href="#L-1095"></a> <a href="#L-1096"></a> <a href="#L-1097"></a>--[[--------------------------< V A L I D A T E _ P R E P R I N T _ P A R A M >-------------------------------- <a href="#L-1098"></a> <a href="#L-1099"></a>looks for <param> (can be the canonical parameter name or can be an alias) in whitelist.preprint_arguments_t{} or <a href="#L-1100"></a>whitelist.limited_basic_arguments{} or whitelist.limited_numbered_arguments{}. When found, returns true; nil else <a href="#L-1101"></a> <a href="#L-1102"></a><param> is the parameter's name as listed in the TemplateData <a href="#L-1103"></a><key> is key neccessary to look in the appropriate subtable of whitelist.preprint_arguments_t{} <a href="#L-1104"></a> <a href="#L-1105"></a>]] <a href="#L-1106"></a> <a href="#L-1107"></a>local function validate_preprint_param (param, key) <a href="#L-1108"></a> if true == whitelist.preprint_arguments_t[key][param] or <a href="#L-1109"></a> true == whitelist.limited_parameters_t[param] then <a href="#L-1110"></a>-- true == whitelist.limited_basic_arguments_t[param] or <a href="#L-1111"></a>-- true == whitelist.limited_numbered_arguments_t[param] then <a href="#L-1112"></a> return true; <a href="#L-1113"></a> end <a href="#L-1114"></a>end <a href="#L-1115"></a> <a href="#L-1116"></a> <a href="#L-1117"></a>--[[--------------------------< V A L I D A T E _ U N I Q U E _ P A R A M >------------------------------------ <a href="#L-1118"></a> <a href="#L-1119"></a>looks for <param> (can be the canonical parameter name or can be an alias) in whitelist.unique_arguments_t{} or <a href="#L-1120"></a>whitelist.basic_arguments{} or whitelist.numbered_arguments{}. When found, returns true; nil else <a href="#L-1121"></a> <a href="#L-1122"></a><param> is the parameter's name as listed in the TemplateData <a href="#L-1123"></a><key> is key neccessary to look in the appropriate subtable of whitelist.unique_arguments_t{} <a href="#L-1124"></a> <a href="#L-1125"></a>]] <a href="#L-1126"></a> <a href="#L-1127"></a>local function validate_unique_param (param, key, cfg_aliases_t) <a href="#L-1128"></a> if true == whitelist.unique_arguments_t[key][param] or true == validate_basic_param (param) then <a href="#L-1129"></a> return true; <a href="#L-1130"></a> end <a href="#L-1131"></a>end <a href="#L-1132"></a> <a href="#L-1133"></a> <a href="#L-1134"></a>--[[--------------------------< V A L I D A T E _ I D _ P A R A M >-------------------------------------------- <a href="#L-1135"></a> <a href="#L-1136"></a>looks for <param> <alias> in identifier_aliases_t{}. When found, returns true; nil else <a href="#L-1137"></a> <a href="#L-1138"></a><param> is the parameter's name as listed in the TemplateData <a href="#L-1139"></a><alias> is the alias that we're looking for <a href="#L-1140"></a> <a href="#L-1141"></a>]] <a href="#L-1142"></a> <a href="#L-1143"></a>local function validate_id_alias (param, alias) <a href="#L-1144"></a> return identifier_aliases_t[param] and identifier_aliases_t[param][alias]; <a href="#L-1145"></a>end <a href="#L-1146"></a> <a href="#L-1147"></a> <a href="#L-1148"></a>--[[--------------------------------------------------------------------------- <a href="#L-1149"></a> <a href="#L-1150"></a> <a href="#L-1151"></a>]] <a href="#L-1152"></a> <a href="#L-1153"></a>local function param_error_msg (param) <a href="#L-1154"></a> return '|' .. param .. '= is not a valid parameter'; <a href="#L-1155"></a>end <a href="#L-1156"></a> <a href="#L-1157"></a> <a href="#L-1158"></a>--[[--------------------------< D U P _ A L I A S _ E R R O R_ M S G >----------------------------------------- <a href="#L-1159"></a> <a href="#L-1160"></a> <a href="#L-1161"></a>]] <a href="#L-1162"></a> <a href="#L-1163"></a>local function dup_alias_error_msg (param, alias) <a href="#L-1164"></a> return '|' .. param .. '= has duplicate aliases: |' .. alias .. '='; <a href="#L-1165"></a>end <a href="#L-1166"></a> <a href="#L-1167"></a> <a href="#L-1168"></a>--[[--------------------------< D U P _ A L I A S E S _ C H E C K >-------------------------------------------- <a href="#L-1169"></a> <a href="#L-1170"></a>create an associative array of <param> aliases. if <alias> already present in <aliases_t> add an error message <a href="#L-1171"></a>to <out> <a href="#L-1172"></a> <a href="#L-1173"></a>]] <a href="#L-1174"></a> <a href="#L-1175"></a>local function dup_aliases_check (param, alias, aliases_t, out_t) <a href="#L-1176"></a> if not aliases_t[alias] then <a href="#L-1177"></a> aliases_t[alias] = true; <a href="#L-1178"></a> else <a href="#L-1179"></a> table.insert (out_t, dup_alias_error_msg (param, alias)); <a href="#L-1180"></a> end <a href="#L-1181"></a>end <a href="#L-1182"></a> <a href="#L-1183"></a> <a href="#L-1184"></a>--[[--------------------------< A L I A S _ E R R O R_ M S G >------------------------------------------------- <a href="#L-1185"></a> <a href="#L-1186"></a> <a href="#L-1187"></a>]] <a href="#L-1188"></a> <a href="#L-1189"></a>local function alias_error_msg (param, alias) <a href="#L-1190"></a> return '<code style="color: inherit; background: inherit; border: none; padding: inherit">|' .. alias .. '=</code> is not a valid alias of: <code style="color: inherit; background: inherit; border: none; padding: inherit">|' .. param .. '=</code>'; <a href="#L-1191"></a>end <a href="#L-1192"></a> <a href="#L-1193"></a> <a href="#L-1194"></a>--[[--------------------------< C F G _ A L I A S E S _ T _ M A K E >------------------------------------------ <a href="#L-1195"></a> <a href="#L-1196"></a>convert this from cfg.aliases{}: <a href="#L-1197"></a> ['AccessDate'] = {'access-date', 'accessdate'} <a href="#L-1198"></a> <a href="#L-1199"></a>to this in out_t{} <a href="#L-1200"></a> ['access-date'] = 'AccessDate', <a href="#L-1201"></a> ['accessdate'] = 'AccessDate', <a href="#L-1202"></a> <a href="#L-1203"></a>to test if |accessdate= is an aliases of |access-date=: <a href="#L-1204"></a> if out_t['access-date'] == out_t['accessdate'] <a href="#L-1205"></a>]] <a href="#L-1206"></a> <a href="#L-1207"></a>local function cfg_aliasts_t_make () <a href="#L-1208"></a> local out_t = {}; <a href="#L-1209"></a> for meta, params_t in pairs (cfg.aliases) do <a href="#L-1210"></a> if 'table' == type (params_t) then -- metaparameters that are assigned string values do not have aliases <a href="#L-1211"></a> for _, param in ipairs (params_t) do -- for each alias <a href="#L-1212"></a> param = param:gsub ('#', ''); -- get rid of enumerators <a href="#L-1213"></a> out_t[param] = meta; -- add it to the output table <a href="#L-1214"></a> end <a href="#L-1215"></a> end <a href="#L-1216"></a> end <a href="#L-1217"></a>--error (mw.dumpObject (out_t)) <a href="#L-1218"></a> return out_t; <a href="#L-1219"></a>end <a href="#L-1220"></a> <a href="#L-1221"></a> <a href="#L-1222"></a>--[[--------------------------< T E M P L A T E _ D A T A _ V A L I D A T E >---------------------------------- <a href="#L-1223"></a> <a href="#L-1224"></a>compairs parameter names listed in a cs1|2 template's TemplateData structure (everything between <TemplateData> <a href="#L-1225"></a>and </TemplateData> tag case insensitive). Returns error messages when errors found, empty string else. <a href="#L-1226"></a> <a href="#L-1227"></a> {{#invoke:Cs1 documentation support|template_data_validate|{{ROOTPAGENAME}}}} <a href="#L-1228"></a> <a href="#L-1229"></a>When called from a different page: <a href="#L-1230"></a> {{#invoke:cs1 documentation support|template_data_validate|<canonical template name>}} <a href="#L-1231"></a>where the <canonical template name> is the template's canonical name with or without namespace and or subpages <a href="#L-1232"></a> <a href="#L-1233"></a>]] <a href="#L-1234"></a> <a href="#L-1235"></a>local function template_data_validate (frame) <a href="#L-1236"></a> local args_t = getArgs (frame); <a href="#L-1237"></a> <a href="#L-1238"></a> if not args_t[1] then <a href="#L-1239"></a> return 'Error: cs1|2 template name required'; <a href="#L-1240"></a> end <a href="#L-1241"></a> <a href="#L-1242"></a> local template_idx = args_t[1]:lower():match ('cit[ae][^/]+'); -- args_t[1] has something <a href="#L-1243"></a> if not template_idx then -- but if not a cs1|2 template abandon with error message <a href="#L-1244"></a> return 'Error: cs1|2 template name required'; <a href="#L-1245"></a> else <a href="#L-1246"></a> template_idx = template_idx:gsub (' ', ''); -- is what appears to be a cs1|2 template so strip spaces <a href="#L-1247"></a> end <a href="#L-1248"></a> <a href="#L-1249"></a> local cfg_aliases_t = cfg_aliasts_t_make (); <a href="#L-1250"></a> <a href="#L-1251"></a> local template_t = templates_t[template_idx]; <a href="#L-1252"></a> local out = {}; <a href="#L-1253"></a> <a href="#L-1254"></a> local template_doc = template_t[1]; <a href="#L-1255"></a> local json_t = template_data_json_get (template_doc); <a href="#L-1256"></a> <a href="#L-1257"></a> if not json_t then <a href="#L-1258"></a> table.insert (out, 'Error: can\'t find TemplateData'); <a href="#L-1259"></a> else <a href="#L-1260"></a> for param, param_t in pairs (json_t['params']) do <a href="#L-1261"></a> local param_i; -- this will be the parameter name that gets validated <a href="#L-1262"></a> if param:find ('[Ss]2[Cc][Ii][Dd]') then -- |s2cid*= parameters are not enumerated ... <a href="#L-1263"></a> param_i = param; -- ... so don't convert the '2' to '#' <a href="#L-1264"></a> else <a href="#L-1265"></a> param_i = param:gsub ('%d+', '#'); -- for enumerated parameters, convert the enumerator digits to a single '#' character; all others unmolested <a href="#L-1266"></a> end <a href="#L-1267"></a> <a href="#L-1268"></a> local param_is_valid; -- boolean true when param is valid; nil else <a href="#L-1269"></a> if template_t[2] then -- if template is a preprint or uses unique parameters of 'document' parameters <a href="#L-1270"></a> if 'document' == template_t[2] then -- if a {{cite document}} template <a href="#L-1271"></a> param_is_valid = validate_document_param (param_i, template_t[2]); <a href="#L-1272"></a> if param_is_valid then <a href="#L-1273"></a> local aliases_t = {}; -- used by dup_aliases_check <a href="#L-1274"></a> if param_t['aliases'] then <a href="#L-1275"></a> for _, alias in ipairs (param_t['aliases']) do <a href="#L-1276"></a> dup_aliases_check (param, alias, aliases_t, out); <a href="#L-1277"></a> local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerator digits to a single '#' character <a href="#L-1278"></a> if not validate_document_param (alias_i, template_t[2]) then -- is 'alias' a known parameter? <a href="#L-1279"></a> table.insert (out, alias_error_msg (param, alias)); -- may be known but is not supported <a href="#L-1280"></a> elseif cfg_aliases_t[param_i:gsub ('#', '')] ~= cfg_aliases_t[alias_i:gsub ('#', '')] then -- is 'alias' known to be an alias of 'param'? <a href="#L-1281"></a> table.insert (out, alias_error_msg (param, alias)); <a href="#L-1282"></a> end <a href="#L-1283"></a> end <a href="#L-1284"></a> end <a href="#L-1285"></a> else -- here when param not valid preprint param <a href="#L-1286"></a> table.insert (out, param_error_msg (param)) <a href="#L-1287"></a> end <a href="#L-1288"></a> elseif whitelist.preprint_arguments_t[template_t[2]] then -- if a preprint template <a href="#L-1289"></a> param_is_valid = validate_preprint_param (param_i, template_t[2]); <a href="#L-1290"></a> if param_is_valid then <a href="#L-1291"></a> local aliases_t = {}; -- used by dup_aliases_check <a href="#L-1292"></a> if param_t['aliases'] then <a href="#L-1293"></a> for _, alias in ipairs (param_t['aliases']) do <a href="#L-1294"></a> dup_aliases_check (param, alias, aliases_t, out); <a href="#L-1295"></a> local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerator digits to a single '#' character <a href="#L-1296"></a> if not validate_preprint_param (alias_i, template_t[2]) then -- is 'alias' a known parameter? <a href="#L-1297"></a> table.insert (out, alias_error_msg (param, alias)); -- may be known but is not supported <a href="#L-1298"></a> elseif cfg_aliases_t[param_i:gsub ('#', '')] ~= cfg_aliases_t[alias_i:gsub ('#', '')] then -- is 'alias' known to be an alias of 'param'? <a href="#L-1299"></a> table.insert (out, alias_error_msg (param, alias)); <a href="#L-1300"></a> end <a href="#L-1301"></a> end <a href="#L-1302"></a> end <a href="#L-1303"></a> else -- here when param not valid preprint param <a href="#L-1304"></a> table.insert (out, param_error_msg (param)) <a href="#L-1305"></a> end <a href="#L-1306"></a> elseif whitelist.unique_arguments_t[template_t[2]] then -- if a unique parameters template <a href="#L-1307"></a> param_is_valid = validate_unique_param (param_i, template_t[2]); <a href="#L-1308"></a> if param_is_valid then <a href="#L-1309"></a> local aliases_t = {}; -- used by dup_aliases_check <a href="#L-1310"></a> if param_t['aliases'] then <a href="#L-1311"></a> for _, alias in ipairs (param_t['aliases']) do <a href="#L-1312"></a> dup_aliases_check (param, alias, aliases_t, out); <a href="#L-1313"></a> local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerate digits to a single '#' character <a href="#L-1314"></a> if not validate_unique_param (alias_i, template_t[2]) then -- is 'alias' a known parameter? <a href="#L-1315"></a> table.insert (out, alias_error_msg (param, alias)); <a href="#L-1316"></a> elseif cfg_aliases_t[param_i:gsub ('#', '')] ~= cfg_aliases_t[alias_i:gsub ('#', '')] then -- is 'alias' known to be an alias of 'param'? <a href="#L-1317"></a> table.insert (out, alias_error_msg (param, alias)); <a href="#L-1318"></a> end <a href="#L-1319"></a> end <a href="#L-1320"></a> end <a href="#L-1321"></a> else -- here when param not valid unique parameter <a href="#L-1322"></a> table.insert (out, param_error_msg (param)) <a href="#L-1323"></a> end <a href="#L-1324"></a> else -- should never be here if coder is doing the right thing ... <a href="#L-1325"></a> table.insert (out, 'internal error: unexpected keyword in templates_t: ' .. template_t[2]); <a href="#L-1326"></a> break; <a href="#L-1327"></a> end <a href="#L-1328"></a> else -- here when not unique or preprint <a href="#L-1329"></a> param_is_valid = validate_basic_param (param_i); <a href="#L-1330"></a> if param_is_valid then <a href="#L-1331"></a> local aliases_t = {}; -- used by dup_aliases_check <a href="#L-1332"></a> if param_t['aliases'] then <a href="#L-1333"></a> for _, alias in ipairs (param_t['aliases']) do <a href="#L-1334"></a> dup_aliases_check (param, alias, aliases_t, out) <a href="#L-1335"></a> local alias_i = alias:gsub ('%d+', '#'); -- in case an enumerated parameter, convert the enumerate digits to a single '#' character <a href="#L-1336"></a> if not validate_basic_param (alias_i) and not validate_id_alias (param, alias) then -- for isbn13 (while still supported) must not mask the digits <a href="#L-1337"></a> table.insert (out, alias_error_msg (param, alias)); <a href="#L-1338"></a> elseif cfg_aliases_t[param_i:gsub ('#', '')] ~= cfg_aliases_t[alias_i:gsub ('#', '')] then -- is 'alias' known to be an alias of 'param'? <a href="#L-1339"></a> table.insert (out, alias_error_msg (param, alias)); <a href="#L-1340"></a> end <a href="#L-1341"></a> end <a href="#L-1342"></a> end <a href="#L-1343"></a> else -- here when param not valid <a href="#L-1344"></a> table.insert (out, param_error_msg (param)) <a href="#L-1345"></a> end <a href="#L-1346"></a> end <a href="#L-1347"></a> end <a href="#L-1348"></a> end <a href="#L-1349"></a> <a href="#L-1350"></a>---------- this emits errors when page/pages/at listed in templatedata of templates that don't support those parameters ---------- <a href="#L-1351"></a>-- if json_t then <a href="#L-1352"></a>-- if ({['citeavmedia']=true, ['citeepisode']=true, ['citemailinglist']=true, ['citenewsgroup']=true, ['citepodcast']=true, ['citeserial']=true, ['citesign']=true, ['citespeech']=true})[template_idx] then <a href="#L-1353"></a>-- local insource_params_t = {}; -- build sequence of pagination params not supported by these templates <a href="#L-1354"></a>-- for _, meta_param in ipairs ({'At', 'Page', 'Pages', 'QuotePage', 'QuotePages'}) do <a href="#L-1355"></a>-- if 'table' == type (cfg.aliases[meta_param]) then <a href="#L-1356"></a>-- for _, alias in ipairs (cfg.aliases[meta_param]) do -- metaparameter is a sequence <a href="#L-1357"></a>-- table.insert (insource_params_t, alias); -- add the aliases from the metaparameter sequence to the table <a href="#L-1358"></a>-- end <a href="#L-1359"></a>-- else -- metaparameter is plain text <a href="#L-1360"></a>-- table.insert (insource_params_t, cfg.aliases[meta_param]); -- add the alias to the table <a href="#L-1361"></a>-- end <a href="#L-1362"></a>-- end <a href="#L-1363"></a>-- <a href="#L-1364"></a>-- for _, param in ipairs (insource_params_t) do <a href="#L-1365"></a>-- if json_t.params[param] then <a href="#L-1366"></a>-- table.insert (out, param_error_msg (param)); -- error; this parameter not supported by this template <a href="#L-1367"></a>-- end <a href="#L-1368"></a>-- end <a href="#L-1369"></a>-- end <a href="#L-1370"></a>-- end <a href="#L-1371"></a>---------- end page/pages/at error detection ---------- <a href="#L-1372"></a> <a href="#L-1373"></a> if 0 ~= #out then <a href="#L-1374"></a> table.sort (out); <a href="#L-1375"></a> out[1] = '*' .. out[1]; -- add a splat to the first error message <a href="#L-1376"></a> <a href="#L-1377"></a>-- return table.concat ({'[[' .. template_doc .. ']] TemplateData has errors:<div style="color:#d33; font-style: normal">\n', table.concat (out, '\n*'), '</div>'}); <a href="#L-1378"></a> return table.concat ({ <a href="#L-1379"></a> '[[Template:' .. args_t[1] .. ']] uses ', <a href="#L-1380"></a> whitelist.preprint_arguments_t[template_t[2]] and 'preprint and limited parameter sets' or (whitelist.unique_arguments_t[template_t[2]] and 'unique and standard parameter sets' or 'standard parameter set'), <a href="#L-1381"></a> '; TemplateData has errors:\n', <a href="#L-1382"></a> '<div style="color:#d33; font-style: normal">\n', table.concat (out, '\n*'), '</div>' <a href="#L-1383"></a> }); <a href="#L-1384"></a> else <a href="#L-1385"></a> return; -- no errors detected; return nothing <a href="#L-1386"></a> end <a href="#L-1387"></a>end <a href="#L-1388"></a> <a href="#L-1389"></a> <a href="#L-1390"></a>--[[--------------------------< E R R O R _ C A T _ P A G E _ T A L L Y >-------------------------------------- <a href="#L-1391"></a> <a href="#L-1392"></a>loop through Module:Citation/CS1/Configuration error_conditions {} fetching error category names. For each error <a href="#L-1393"></a>category add the number of pages in the category to the tally. Render the number when done. <a href="#L-1394"></a> <a href="#L-1395"></a>{{#invoke:cs1 documentation support|error_cat_page_tally}} <a href="#L-1396"></a> <a href="#L-1397"></a>]] <a href="#L-1398"></a> <a href="#L-1399"></a>local function error_cat_page_tally () <a href="#L-1400"></a> local error_conditions_t = cfg.error_conditions; -- get the table of error conditions <a href="#L-1401"></a> local tally = 0; <a href="#L-1402"></a> local cat_t = {}; -- some error message share a category; save tallied cats here so we don't recount the already counted <a href="#L-1403"></a> local i = 0; -- number of categories <a href="#L-1404"></a> <a href="#L-1405"></a> for k, v_t in pairs (error_conditions_t) do <a href="#L-1406"></a> if k:match ('^err') then <a href="#L-1407"></a> if not cat_t[v_t.category] then <a href="#L-1408"></a> cat_t[v_t.category] = true; <a href="#L-1409"></a> tally = tally + mw.site.stats.pagesInCategory (v_t.category, 'pages'); -- get category page count; ignore subcats and files <a href="#L-1410"></a> i = i + 1; <a href="#L-1411"></a> end <a href="#L-1412"></a> end <a href="#L-1413"></a> end <a href="#L-1414"></a> <a href="#L-1415"></a> return mw.language.getContentLanguage():formatNum (tally) <a href="#L-1416"></a>end <a href="#L-1417"></a> <a href="#L-1418"></a> <a href="#L-1419"></a>--[[--------------------------< M A I N T _ C A T _ P A G E _ T A L L Y >-------------------------------------- <a href="#L-1420"></a> <a href="#L-1421"></a>loop through Module:Citation/CS1/Configuration error_conditions {} fetching error category names. For each error <a href="#L-1422"></a>category add the number of pages in the category to the tally. Render the number when done. <a href="#L-1423"></a> <a href="#L-1424"></a>{{#invoke:cs1 documentation support|maint_cat_page_tally}} <a href="#L-1425"></a> <a href="#L-1426"></a>Dynamic subcats of CS1 maint: DOI inactive not counted because these names come and go as time goes by. <a href="#L-1427"></a> <a href="#L-1428"></a>]] <a href="#L-1429"></a> <a href="#L-1430"></a>local function maint_cat_page_tally () <a href="#L-1431"></a> local error_conditions_t = cfg.error_conditions; -- get the table of error conditions <a href="#L-1432"></a> local tally = 0; <a href="#L-1433"></a> local cat_t = {}; -- some error message share a category; save tallied cats here so we don't recount the already counted <a href="#L-1434"></a> local i = 0; -- number of categories <a href="#L-1435"></a> <a href="#L-1436"></a> for k, v_t in pairs (error_conditions_t) do <a href="#L-1437"></a> if not k:match ('^err') then -- if not an error key its a maint key <a href="#L-1438"></a> if not cat_t[v_t.category] then <a href="#L-1439"></a> cat_t[v_t.category] = true; <a href="#L-1440"></a> if 'maint_mult_names' == k or 'maint_numeric_names' == k then <a href="#L-1441"></a> local special_case_translation_t = cfg.special_case_translation; <a href="#L-1442"></a> for _, name in ipairs ({'AuthorList', 'ContributorList', 'EditorList', 'InterviewerList', 'TranslatorList'}) do <a href="#L-1443"></a> local cat_name = v_t.category:gsub ('$1', special_case_translation_t[name]); -- replace $1 with translated list name <a href="#L-1444"></a> tally = tally + mw.site.stats.pagesInCategory (cat_name, 'pages'); -- get category page count; ignore subcats and files <a href="#L-1445"></a> i = i + 1; <a href="#L-1446"></a> end <a href="#L-1447"></a> else <a href="#L-1448"></a> tally = tally + mw.site.stats.pagesInCategory (v_t.category, 'pages'); -- get category page count; ignore subcats and files <a href="#L-1449"></a> i = i + 1; <a href="#L-1450"></a> end <a href="#L-1451"></a> end <a href="#L-1452"></a> end <a href="#L-1453"></a> end <a href="#L-1454"></a> <a href="#L-1455"></a> return mw.language.getContentLanguage():formatNum (tally) <a href="#L-1456"></a>end <a href="#L-1457"></a> <a href="#L-1458"></a> <a href="#L-1459"></a>--[[-------------------------------------------- <a href="#L-1460"></a> <a href="#L-1461"></a>For use in the Help:CS1 error §Notes <a href="#L-1462"></a> <a href="#L-1463"></a>Get namespace names and identifiers from MediaWiki. Make a human readable list of namespace names and identifiers <a href="#L-1464"></a>that cs1|2 does not categorize. <a href="#L-1465"></a> <a href="#L-1466"></a>{{#invoke:cs1 documentation support|uncategorized_namespace_lister}} <a href="#L-1467"></a> <a href="#L-1468"></a>For convenience, <a href="#L-1469"></a>{{#invoke:cs1 documentation support|uncategorized_namespace_lister|all=<anything>}} <a href="#L-1470"></a> <a href="#L-1471"></a>returns a list of all namespace names and identifiers used on the current wiki. Any namespace with an <a href="#L-1472"></a>identifier less than 1, currently Mainspace (0), Special (-1), and Media (-2), is excluded from the list. <a href="#L-1473"></a> <a href="#L-1474"></a>]] <a href="#L-1475"></a> <a href="#L-1476"></a>local function uncategorized_namespace_lister (frame) <a href="#L-1477"></a> local list_t = {}; <a href="#L-1478"></a> local function compare (a, b) -- local function to sort namespaces numerically by the identifiers <a href="#L-1479"></a> local a_num = tonumber (a:match ('%d+')); -- get identifiers and convert to numbers <a href="#L-1480"></a> local b_num = tonumber (b:match ('%d+')); <a href="#L-1481"></a> return a_num < b_num; -- do the comparison <a href="#L-1482"></a> end <a href="#L-1483"></a> <a href="#L-1484"></a> for i, _ in pairs (mw.site.namespaces) do -- for each namespace in the table <a href="#L-1485"></a> if '' == frame.args.all or not frame.args.all then -- when |all= not set, make a list of uncategorized namespaces <a href="#L-1486"></a> if cfg.uncategorized_namespaces[i] then -- if the identifier is listed in our uncategorized namespace list <a href="#L-1487"></a> table.insert (list_t, table.concat ({mw.site.namespaces[i].name, ' (', i, ')'})) -- add name and identifier to our local list <a href="#L-1488"></a> end <a href="#L-1489"></a> elseif 0 < i then -- |all=<anything>: all namespace names and identifiers; ignore identifiers less than 1 <a href="#L-1490"></a> table.insert (list_t, table.concat ({'*', mw.site.namespaces[i].name, ' (', i, ')'})) -- add name and identifier as an unordered list item <a href="#L-1491"></a> end <a href="#L-1492"></a> end <a href="#L-1493"></a> <a href="#L-1494"></a> table.sort (list_t, compare); -- ascending numerical sort by identifier <a href="#L-1495"></a> <a href="#L-1496"></a> if not frame.args.all then -- when |all= not set, format list of uncategorized namespaces and identifiers <a href="#L-1497"></a> list_t[#list_t] = 'and ' .. list_t[#list_t]; -- add 'and ' to the last name/identifier pair <a href="#L-1498"></a> return table.concat (list_t, ', '); -- make a big string and done <a href="#L-1499"></a> else -- make list of all namespaces and identifiers <a href="#L-1500"></a> return table.concat (list_t, '\n'); -- make a big string and done <a href="#L-1501"></a> end <a href="#L-1502"></a>end <a href="#L-1503"></a> <a href="#L-1504"></a> <a href="#L-1505"></a>--[[--------------------------< S I N G L E _ L T R _ 2 N D _ L V L _ D O M A I N _ L I S T E R >------------- <a href="#L-1506"></a> <a href="#L-1507"></a>for Help:CS1_errors#bad_url, list the supported top level domains that support single-letter 2nd level names <a href="#L-1508"></a> <a href="#L-1509"></a> {{#invoke:Module:cs1 documentation support|single_ltr_2nd_lvl_domain_lister}} <a href="#L-1510"></a> <a href="#L-1511"></a>]] <a href="#L-1512"></a> <a href="#L-1513"></a>local function single_ltr_2nd_lvl_domain_lister () <a href="#L-1514"></a> local out_t = {}; -- output goes here <a href="#L-1515"></a> for _, tld in ipairs (cfg.single_letter_2nd_lvl_domains_t) do -- fetch each tld <a href="#L-1516"></a> table.insert (out_t, '.' .. tld); -- prefix with a dot and save in out_t{} <a href="#L-1517"></a> end <a href="#L-1518"></a> return table.concat (out_t, ', '); -- make a big string and done <a href="#L-1519"></a>end <a href="#L-1520"></a> <a href="#L-1521"></a> <a href="#L-1522"></a>--[[--------------------------< C O D E _ N A M E _ P A I R _ E X I S T S >---------------------------------------- <a href="#L-1523"></a> <a href="#L-1524"></a>Returns language code if pair exists, nil if either code doesn't exist or the name doesn't match. <a href="#L-1525"></a>Intended for use by Template:CS1 language sources/core <a href="#L-1526"></a> <a href="#L-1527"></a>args[1] is language code <a href="#L-1528"></a>args[2] is language name <a href="#L-1529"></a> <a href="#L-1530"></a>]] <a href="#L-1531"></a> <a href="#L-1532"></a>local function code_name_pair_exists(frame) <a href="#L-1533"></a> local wiki_language = mw.getContentLanguage():getCode() <a href="#L-1534"></a> local source_list = mw.language.fetchLanguageNames(wiki_language, 'all'); <a href="#L-1535"></a> local code_list = {}; <a href="#L-1536"></a> local name_list = {}; <a href="#L-1537"></a> local override = cfg.lang_tag_remap; <a href="#L-1538"></a> <a href="#L-1539"></a> for code, name in pairs(source_list) do <a href="#L-1540"></a> add_to_list(code_list, name_list, override, code, name); <a href="#L-1541"></a> end <a href="#L-1542"></a> <a href="#L-1543"></a> local args = getArgs(frame); <a href="#L-1544"></a> local language_code = args[1] <a href="#L-1545"></a> local language_name = args[2] <a href="#L-1546"></a> -- Check if the language code exists and the corresponding name matches <a href="#L-1547"></a> if code_list[language_code] == language_name then <a href="#L-1548"></a> -- Both code and name are a valid pair <a href="#L-1549"></a> return language_code <a href="#L-1550"></a> else <a href="#L-1551"></a> -- Either code doesn't exist or the name doesn't match <a href="#L-1552"></a> return nil <a href="#L-1553"></a> end <a href="#L-1554"></a>end <a href="#L-1555"></a> <a href="#L-1556"></a> <a href="#L-1557"></a>--[[--------------------------< E X P O R T E D F U N C T I O N S >------------------------------------------ <a href="#L-1558"></a>]] <a href="#L-1559"></a> <a href="#L-1560"></a>return { <a href="#L-1561"></a> alias_lister = alias_lister, <a href="#L-1562"></a> alias_names_get = alias_names_get, <a href="#L-1563"></a> canonical_param_lister = canonical_param_lister, <a href="#L-1564"></a> canonical_name_get = canonical_name_get, <a href="#L-1565"></a> cat_lister = cat_lister, <a href="#L-1566"></a> code_name_pair_exists = code_name_pair_exists, <a href="#L-1567"></a> error_cat_page_tally = error_cat_page_tally, <a href="#L-1568"></a> header_make = header_make, <a href="#L-1569"></a> help_text_cats = help_text_cats, <a href="#L-1570"></a> help_text_error_messages = help_text_error_messages, <a href="#L-1571"></a> id_limits_get = id_limits_get, <a href="#L-1572"></a> is_book_cite_template = is_book_cite_template, <a href="#L-1573"></a> is_limited_param_template = is_limited_param_template, <a href="#L-1574"></a> lang_lister = lang_lister, <a href="#L-1575"></a> maint_cat_page_tally = maint_cat_page_tally, <a href="#L-1576"></a> script_lang_lister = script_lang_lister, <a href="#L-1577"></a> single_ltr_2nd_lvl_domain_lister = single_ltr_2nd_lvl_domain_lister, <a href="#L-1578"></a> template_data_validate = template_data_validate, <a href="#L-1579"></a> uncategorized_namespace_lister = uncategorized_namespace_lister, <a href="#L-1580"></a> }; </pre></div>   </div><noscript><img src="https://login.wikimedia.org/wiki/Special:CentralAutoLogin/start?type=1x1&useformat=desktop" alt="" width="1" height="1" style="border: none; position: absolute;"></noscript> <div class="printfooter" data-nosnippet="">Retrieved from "<a dir="ltr" href="https://en.wikipedia.org/w/index.php?title=Module:Cs1_documentation_support&oldid=1258006783">https://en.wikipedia.org/w/index.php?title=Module:Cs1_documentation_support&oldid=1258006783</a>"</div></div> <div id="catlinks" class="catlinks catlinks-allhidden" data-mw="interface"><div id="mw-hidden-catlinks" class="mw-hidden-catlinks mw-hidden-cats-hidden">Hidden categories: <ul><li><a href="/wiki/Category:Wikipedia_semi-protected_modules" title="Category:Wikipedia semi-protected modules">Wikipedia semi-protected modules</a></li><li><a href="/wiki/Category:Templates_using_TemplateStyles" title="Category:Templates using TemplateStyles">Templates using TemplateStyles</a></li></ul></div></div> </div> </main> </div> <div class="mw-footer-container"> <footer id="footer" class="mw-footer" > <ul id="footer-info"> <li id="footer-info-lastmod"> This page was last edited on 17 November 2024, at 17:29 (UTC).</li> <li id="footer-info-copyright">Text is available under the <a href="/wiki/Wikipedia:Text_of_the_Creative_Commons_Attribution-ShareAlike_4.0_International_License" title="Wikipedia:Text of the Creative Commons Attribution-ShareAlike 4.0 International License">Creative Commons Attribution-ShareAlike 4.0 License</a>; additional terms may apply. By using this site, you agree to the <a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Terms_of_Use" class="extiw" title="foundation:Special:MyLanguage/Policy:Terms of Use">Terms of Use</a> and <a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Privacy_policy" class="extiw" title="foundation:Special:MyLanguage/Policy:Privacy policy">Privacy Policy</a>. Wikipedia® is a registered trademark of the <a rel="nofollow" class="external text" href="https://wikimediafoundation.org/">Wikimedia Foundation, Inc.</a>, a non-profit organization.</li> </ul> <ul id="footer-places"> <li id="footer-places-privacy"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Privacy_policy">Privacy policy</a></li> <li id="footer-places-about"><a href="/wiki/Wikipedia:About">About Wikipedia</a></li> <li id="footer-places-disclaimers"><a href="/wiki/Wikipedia:General_disclaimer">Disclaimers</a></li> <li id="footer-places-contact"><a href="//en.wikipedia.org/wiki/Wikipedia:Contact_us">Contact Wikipedia</a></li> <li id="footer-places-wm-codeofconduct"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Universal_Code_of_Conduct">Code of Conduct</a></li> <li id="footer-places-developers"><a href="https://developer.wikimedia.org">Developers</a></li> <li id="footer-places-statslink"><a href="https://stats.wikimedia.org/#/en.wikipedia.org">Statistics</a></li> <li id="footer-places-cookiestatement"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Cookie_statement">Cookie statement</a></li> <li id="footer-places-mobileview"><a href="//en.m.wikipedia.org/w/index.php?title=Module:Cs1_documentation_support&mobileaction=toggle_view_mobile" class="noprint stopMobileRedirectToggle">Mobile view</a></li> </ul> <ul id="footer-icons" class="noprint"> <li id="footer-copyrightico"><a href="https://wikimediafoundation.org/" class="cdx-button cdx-button--fake-button cdx-button--size-large cdx-button--fake-button--enabled"><img src="/static/images/footer/wikimedia-button.svg" width="84" height="29" alt="Wikimedia Foundation" loading="lazy"></a></li> <li id="footer-poweredbyico"><a href="https://www.mediawiki.org/" class="cdx-button cdx-button--fake-button cdx-button--size-large cdx-button--fake-button--enabled"><img src="/w/resources/assets/poweredby_mediawiki.svg" alt="Powered by MediaWiki" width="88" height="31" loading="lazy"></a></li> </ul> </footer> </div> </div> </div> <div class="vector-settings" id="p-dock-bottom"> <ul></ul> </div><script>(RLQ=window.RLQ||[]).push(function(){mw.config.set({"wgHostname":"mw-web.codfw.main-7fc47fc68d-4vvcr","wgBackendResponseTime":551,"wgPageParseReport":{"limitreport":{"cputime":"0.171","walltime":"0.225","ppvisitednodes":{"value":107,"limit":1000000},"postexpandincludesize":{"value":10202,"limit":2097152},"templateargumentsize":{"value":3,"limit":2097152},"expansiondepth":{"value":6,"limit":100},"expensivefunctioncount":{"value":12,"limit":500},"unstrip-depth":{"value":0,"limit":20},"unstrip-size":{"value":5975,"limit":5000000},"entityaccesscount":{"value":0,"limit":400},"timingprofile":["100.00% 85.044 1 Module:Cs1_documentation_support/doc","100.00% 85.044 1 -total"," 48.17% 40.970 1 Template:Lua"," 19.45% 16.543 1 Template:High-use"," 18.93% 16.095 1 Template:Uses_TemplateStyles"]},"scribunto":{"limitreport-timeusage":{"value":"0.127","limit":"10.000"},"limitreport-memusage":{"value":3176888,"limit":52428800}},"cachereport":{"origin":"mw-web.codfw.main-7fc47fc68d-4vvcr","timestamp":"20241128201541","ttl":2592000,"transientcontent":false}}});});</script> </body> </html>