CINXE.COM

<!DOCTYPE html> <html class="client-nojs vector-feature-language-in-header-enabled vector-feature-language-in-main-page-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-sticky-header-enabled vector-toc-available" lang="en" dir="ltr"> <head> <meta charset="UTF-8"> <title>Module:Documentation/sandbox - Wikipedia</title> <script>(function(){var className="client-js vector-feature-language-in-header-enabled vector-feature-language-in-main-page-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-sticky-header-enabled 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":"9737c705-8e31-4378-839c-5c855264697d","wgCanonicalNamespace":"Module","wgCanonicalSpecialPageName":false,"wgNamespaceNumber":828,"wgPageName":"Module:Documentation/sandbox","wgTitle":"Documentation/sandbox","wgCurRevisionId":1263392455,"wgRevisionId":1263392455,"wgArticleId":41798483,"wgIsArticle":true,"wgIsRedirect":false,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":["Module sandboxes"],"wgPageViewLanguage":"en","wgPageContentLanguage":"en","wgPageContentModel":"Scribunto","wgRelevantPageName":"Module:Documentation/sandbox","wgRelevantArticleId":41798483,"wgIsProbablyEditable":true,"wgRelevantPageIsProbablyEditable":true,"wgRestrictionEdit":[],"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":40000,"wgEditSubmitButtonLabelPublish":true,"wgULSPosition":"interlanguage","wgULSisCompactLinksEnabled":false,"wgVector2022LanguageInHeader":true,"wgULSisLanguageSelectorEmpty":false,"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","ext.checkUser.clientHints"];</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.17"> <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:Documentation/sandbox - 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:Documentation/sandbox"> <link rel="alternate" type="application/x-wiki" title="Edit this page" href="/w/index.php?title=Module:Documentation/sandbox&action=edit"> <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:Documentation/sandbox"> <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 mw-editable page-Module_Documentation_sandbox rootpage-Module_Documentation 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" title="Main menu" > <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><li id="n-specialpages" class="mw-list-item"><a href="/wiki/Special:SpecialPages">Special pages</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/?wmf_source=donate&wmf_medium=sidebar&wmf_campaign=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%3ADocumentation%2Fsandbox" 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%3ADocumentation%2Fsandbox" 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/?wmf_source=donate&wmf_medium=sidebar&wmf_campaign=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%3ADocumentation%2Fsandbox" 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%3ADocumentation%2Fsandbox" 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-Normal_usage" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#Normal_usage"> <div class="vector-toc-text"> 1 Normal usage </div> </a> <ul id="toc-Normal_usage-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Use_in_other_modules" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#Use_in_other_modules"> <div class="vector-toc-text"> 2 Use in other modules </div> </a> <ul id="toc-Use_in_other_modules-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Porting_to_other_wikis" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#Porting_to_other_wikis"> <div class="vector-toc-text"> 3 Porting to other wikis </div> </a> <ul id="toc-Porting_to_other_wikis-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" title="Table of Contents" > <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:Documentation/sandbox</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="This article exist only in this language. Add the article for other 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-0" aria-hidden="true" > Add languages </label> <div class="vector-dropdown-content"> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> <div class="after-portlet after-portlet-lang"><a href="https://www.wikidata.org/wiki/Special:NewItem?site=enwiki&page=Module%3ADocumentation%2Fsandbox" title="Add interlanguage links" class="wbc-editpage">Add 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:Documentation/sandbox" 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:Documentation/sandbox" 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:Documentation/sandbox">Read</a></li><li id="ca-edit" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=Module:Documentation/sandbox&action=edit" title="Edit this page [e]" accesskey="e">Edit</a></li><li id="ca-history" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=Module:Documentation/sandbox&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:Documentation/sandbox">Read</a></li><li id="ca-more-edit" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=Module:Documentation/sandbox&action=edit" title="Edit this page [e]" accesskey="e">Edit</a></li><li id="ca-more-history" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=Module:Documentation/sandbox&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:Documentation/sandbox" 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:Documentation/sandbox" 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="//en.wikipedia.org/wiki/Wikipedia:File_Upload_Wizard" title="Upload files [u]" accesskey="u">Upload file</a></li><li id="t-permalink" class="mw-list-item"><a href="/w/index.php?title=Module:Documentation/sandbox&oldid=1263392455" 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:Documentation/sandbox&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%3ADocumentation%2Fsandbox">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%3ADocumentation%2Fsandbox">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%3ADocumentation%2Fsandbox&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 emptyPortlet" > <div class="vector-menu-heading"> In other projects </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </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> <div id="siteSub" class="noprint">From Wikipedia, the free encyclopedia</div> </div> <div id="contentSub"><div id="mw-content-subtitle"><div class="subpages">< <bdi dir="ltr"><a href="/wiki/Module:Documentation" title="Module:Documentation">Module:Documentation</a></bdi></div></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:r1277038544">.mw-parser-output .documentation,.mw-parser-output .documentation-metadata{border:1px solid var(--border-color-base,#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 var(--border-color-base,#a2a9b1);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-clear"></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 ombox-notice" role="presentation"><tbody><tr><td class="mbox-image"><img alt="" src="//upload.wikimedia.org/wikipedia/commons/thumb/8/88/Sandbox.svg/50px-Sandbox.svg.png" decoding="async" width="50" height="33" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/8/88/Sandbox.svg/75px-Sandbox.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/8/88/Sandbox.svg/100px-Sandbox.svg.png 2x" data-file-width="650" data-file-height="424" /></td><td class="mbox-text">This is the <a href="/wiki/Wikipedia:Template_test_cases" class="mw-redirect" title="Wikipedia:Template test cases">module sandbox</a> page for <a href="/wiki/Module:Documentation" title="Module:Documentation">Module:Documentation</a> (<a class="external text" href="https://en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3ADocumentation&page2=Module%3ADocumentation%2Fsandbox">diff</a>). See also the companion subpage for <a href="/wiki/Module:Documentation/testcases" title="Module:Documentation/testcases">test cases</a> (<a href="/wiki/Module_talk:Documentation/testcases" title="Module talk:Documentation/testcases">run</a>).</td></tr></tbody></table><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:Documentation/doc" title="Module:Documentation/doc">view</a>] [<a href="/wiki/Special:EditPage/Module:Documentation/doc" title="Special:EditPage/Module:Documentation/doc">edit</a>] [<a href="/wiki/Special:PageHistory/Module:Documentation/doc" title="Special:PageHistory/Module:Documentation/doc">history</a>] [<a href="/wiki/Special:Purge/Module:Documentation/sandbox" title="Special:Purge/Module:Documentation/sandbox">purge</a>]</div> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238436933"><table class="plainlinks ombox ombox-content" role="presentation"><tbody><tr><td class="mbox-image"><img alt="Warning" src="//upload.wikimedia.org/wikipedia/en/thumb/b/b4/Ambox_important.svg/40px-Ambox_important.svg.png" decoding="async" width="40" height="40" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/en/thumb/b/b4/Ambox_important.svg/60px-Ambox_important.svg.png 1.5x, //upload.wikimedia.org/wikipedia/en/thumb/b/b4/Ambox_important.svg/80px-Ambox_important.svg.png 2x" data-file-width="40" data-file-height="40" /></td><td class="mbox-text">This Lua module is used in <a href="/wiki/MediaWiki:Scribunto-doc-page-show" title="MediaWiki:Scribunto-doc-page-show">MediaWiki:Scribunto-doc-page-show</a>, in <a href="/wiki/MediaWiki:Scribunto-doc-page-does-not-exist" title="MediaWiki:Scribunto-doc-page-does-not-exist">MediaWiki:Scribunto-doc-page-does-not-exist</a>, and on <a class="external text" href="https://linkcount.toolforge.org/?project=en.wikipedia.org&page=Module%3ADocumentation#transclusions">approximately 181,000 pages</a>. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's <a class="mw-selflink selflink">/sandbox</a> or <a href="/wiki/Module:Documentation/testcases" title="Module:Documentation/testcases">/testcases</a> subpages, or in your own <a href="/wiki/Module:Sandbox" title="Module:Sandbox">module sandbox</a>. The tested changes can be added to this page in a single edit. Please discuss changes on the <a href="/wiki/Module_talk:Documentation" class="mw-redirect" title="Module talk:Documentation">talk page</a> before implementing them.</td></tr></tbody></table> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r1238436933"><table class="plainlinks ombox ombox-notice" role="presentation"><tbody><tr><td class="mbox-image"><img alt="Protected" src="//upload.wikimedia.org/wikipedia/en/thumb/5/53/Template-protection-shackle.svg/40px-Template-protection-shackle.svg.png" decoding="async" width="40" height="40" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/en/thumb/5/53/Template-protection-shackle.svg/60px-Template-protection-shackle.svg.png 1.5x, //upload.wikimedia.org/wikipedia/en/thumb/5/53/Template-protection-shackle.svg/80px-Template-protection-shackle.svg.png 2x" data-file-width="512" data-file-height="512" /></td><td class="mbox-text">This module is <a href="/wiki/Category:Modules_subject_to_page_protection" title="Category:Modules subject to page protection">subject to page protection</a>. It is a <a href="/wiki/Wikipedia:High-risk_templates" title="Wikipedia:High-risk templates">highly visible module</a> in use by a very large number of pages, or is <a href="/wiki/Wikipedia:Substitution" title="Wikipedia:Substitution">substituted</a> very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is <a href="/wiki/Wikipedia:Protection_policy" title="Wikipedia:Protection policy">protected</a> from editing.</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"><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:Documentation/config" title="Module:Documentation/config">Module:Documentation/config</a> (<a href="/wiki/Module:Documentation/config/sandbox" title="Module:Documentation/config/sandbox">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><li><a href="/wiki/Module:Message_box" title="Module:Message box">Module:Message box</a> (<a href="/wiki/Module:Message_box/sandbox" title="Module:Message box/sandbox">sandbox</a>)</li><li><a href="/wiki/Module:Module_wikitext" title="Module:Module wikitext">Module:Module wikitext</a> (<a href="/wiki/Module:Module_wikitext/sandbox" title="Module:Module wikitext/sandbox">sandbox</a>)</li><li><a href="/wiki/Module:Protection_banner" title="Module:Protection banner">Module:Protection banner</a> (<a href="/wiki/Module:Protection_banner/sandbox" title="Module:Protection banner/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:Documentation/styles.css" title="Module:Documentation/styles.css">Module:Documentation/styles.css</a> (<a href="/wiki/Module:Documentation/sandbox/styles.css" title="Module:Documentation/sandbox/styles.css">sandbox</a>)</li></ul></div></td></tr></tbody></table> This module displays a green box containing documentation for <a href="/wiki/Help:Template" title="Help:Template">templates</a>, <a href="/wiki/Wikipedia:Lua" title="Wikipedia:Lua">Lua modules</a>, or other pages. The {{<a href="/wiki/Template:Documentation" title="Template:Documentation">documentation</a>}} template invokes it. <div class="mw-heading mw-heading2"><h2 id="Normal_usage">Normal usage</h2>[<a href="/w/index.php?title=Module:Documentation/doc&action=edit&section=T-1" title="Edit section: Normal usage">edit</a>]</div> For most uses, you should use the {{<a href="/wiki/Template:Documentation" title="Template:Documentation">documentation</a>}} template; please see that template's page for its usage instructions and parameters. <div class="mw-heading mw-heading2"><h2 id="Use_in_other_modules">Use in other modules</h2>[<a href="/w/index.php?title=Module:Documentation/doc&action=edit&section=T-2" title="Edit section: Use in other modules">edit</a>]</div> To use this module from another Lua module, first load it with <code>require</code>: <div class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr"><pre>local documentation = require('Module:Documentation').main </pre></div> Then you can simply call it using a table of arguments. <div class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr"><pre>documentation{content = 'Some documentation', ['link box'] = 'My custom link box'} </pre></div> Please refer to the <a href="/wiki/Template:Documentation/doc" title="Template:Documentation/doc">template documentation</a> for usage instructions and a list of parameters. <div class="mw-heading mw-heading2"><h2 id="Porting_to_other_wikis">Porting to other wikis</h2>[<a href="/w/index.php?title=Module:Documentation/doc&action=edit&section=T-3" title="Edit section: Porting to other wikis">edit</a>]</div> The module has a configuration file at <a href="/wiki/Module:Documentation/config" title="Module:Documentation/config">Module:Documentation/config</a> which is intended to allow easy translation and porting to other wikis. Please see the code comments in the config page for instructions. If you have any questions, or you need a feature which is not currently implemented, please leave a message at <a class="external text" href="https://en.wikipedia.org/wiki/Template_talk:Documentation">Template talk:Documentation</a> to get the attention of a developer. The messages that need to be customized to display a documentation template/module at the top of module pages are <a href="/wiki/MediaWiki:Scribunto-doc-page-show" title="MediaWiki:Scribunto-doc-page-show">MediaWiki:Scribunto-doc-page-show</a> and <a href="/wiki/MediaWiki:Scribunto-doc-page-does-not-exist" title="MediaWiki:Scribunto-doc-page-does-not-exist">MediaWiki:Scribunto-doc-page-does-not-exist</a>. <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:Documentation/doc" title="Module:Documentation/doc">Module:Documentation/doc</a>. (<a href="/wiki/Special:EditPage/Module:Documentation/doc" title="Special:EditPage/Module:Documentation/doc">edit</a> | <a href="/wiki/Special:PageHistory/Module:Documentation/doc" title="Special:PageHistory/Module:Documentation/doc">history</a>) Editors can experiment in this module's <a class="mw-selflink selflink">sandbox</a> (<a href="/wiki/Special:EditPage/Module:Documentation/sandbox" title="Special:EditPage/Module:Documentation/sandbox">edit</a> | <a class="external text" href="https://en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3ADocumentation&page2=Module%3ADocumentation%2Fsandbox">diff</a>) and <a href="/wiki/Module:Documentation/testcases" title="Module:Documentation/testcases">testcases</a> (<a href="/wiki/Special:EditPage/Module:Documentation/testcases" title="Special:EditPage/Module:Documentation/testcases">edit</a> | <a href="/wiki/Module_talk:Documentation/testcases" title="Module talk:Documentation/testcases">run</a>) pages. Add categories to the <a href="/wiki/Module:Documentation/doc" title="Module:Documentation/doc">/doc</a> subpage. <a href="/wiki/Special:PrefixIndex/Module:Documentation/" title="Special:PrefixIndex/Module:Documentation/">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>--- This module implements {{tl|documentation}}. <a href="#L-2"></a>-- <a href="#L-3"></a>-- @module documentation <a href="#L-4"></a>-- @alias p <a href="#L-5"></a>-- @require Module:Arguments <a href="#L-6"></a>-- @require Module:Module_wikitext <a href="#L-7"></a>-- @require Module:Docbunto <a href="#L-8"></a>-- @require Module:Protection_banner <a href="#L-9"></a>-- @release stable <a href="#L-10"></a>-- <nowiki> <a href="#L-11"></a> <a href="#L-12"></a>-- Get required modules. <a href="#L-13"></a>local getArgs = require('Module:Arguments').getArgs <a href="#L-14"></a> <a href="#L-15"></a>-- Get the config table. <a href="#L-16"></a>local cfg = mw.loadData('Module:Documentation/config/sandbox') <a href="#L-17"></a> <a href="#L-18"></a>local p = {} <a href="#L-19"></a> <a href="#L-20"></a>-- Often-used functions. <a href="#L-21"></a>local ugsub = mw.ustring.gsub <a href="#L-22"></a>local format = mw.ustring.format <a href="#L-23"></a> <a href="#L-24"></a>-- Helper functions <a href="#L-25"></a> <a href="#L-26"></a>---------------------------------------------------------------------------- <a href="#L-27"></a>-- Gets a message for a specified page. <a href="#L-28"></a>-- @function message <a href="#L-29"></a>-- @param {string} cfgKey the key which the message belongs to <a href="#L-30"></a>-- @param {valArray} valArray the array which contains these messages <a href="#L-31"></a>-- @param {expectType} the type to expect for the message <a href="#L-32"></a>-- @return {string} string corresponding to message <a href="#L-33"></a>---------------------------------------------------------------------------- <a href="#L-34"></a>local function message(cfgKey, valArray, expectType) <a href="#L-35"></a> --[[ <a href="#L-36"></a> -- Gets a message from the cfg table and formats it if appropriate. <a href="#L-37"></a> -- The function raises an error if the value from the cfg table is not <a href="#L-38"></a> -- of the type expectType. The default type for expectType is 'string'. <a href="#L-39"></a> -- If the table valArray is present, strings such as $1, $2 etc. in the <a href="#L-40"></a> -- message are substituted with values from the table keys [1], [2] etc. <a href="#L-41"></a> -- For example, if the message "foo-message" had the value 'Foo $2 bar $1.', <a href="#L-42"></a> -- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz." <a href="#L-43"></a> --]] <a href="#L-44"></a> local msg = cfg[cfgKey] <a href="#L-45"></a> expectType = expectType or 'string' <a href="#L-46"></a> if type(msg) ~= expectType then <a href="#L-47"></a> error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2) <a href="#L-48"></a> end <a href="#L-49"></a> if not valArray then <a href="#L-50"></a> return msg <a href="#L-51"></a> end <a href="#L-52"></a> <a href="#L-53"></a> local function getMessageVal(match) <a href="#L-54"></a> match = tonumber(match) <a href="#L-55"></a> return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4) <a href="#L-56"></a> end <a href="#L-57"></a> <a href="#L-58"></a> return ugsub(msg, '$([1-9][0-9]*)', getMessageVal) <a href="#L-59"></a>end <a href="#L-60"></a> <a href="#L-61"></a>p.message = message <a href="#L-62"></a> <a href="#L-63"></a>local function makeWikilink(page, display) <a href="#L-64"></a> if display then <a href="#L-65"></a> return format('[[%s|%s]]', page, display) <a href="#L-66"></a> else <a href="#L-67"></a> return format('[[%s]]', page) <a href="#L-68"></a> end <a href="#L-69"></a>end <a href="#L-70"></a> <a href="#L-71"></a>p.makeWikilink = makeWikilink <a href="#L-72"></a> <a href="#L-73"></a>local function makeCategoryLink(cat, sort) <a href="#L-74"></a> local catns = mw.site.namespaces[14].name <a href="#L-75"></a> return makeWikilink(catns .. ':' .. cat, sort) <a href="#L-76"></a>end <a href="#L-77"></a> <a href="#L-78"></a>p.makeCategoryLink = makeCategoryLink <a href="#L-79"></a> <a href="#L-80"></a>local function makeUrlLink(url, display) <a href="#L-81"></a> return format('[%s %s]', url, display) <a href="#L-82"></a>end <a href="#L-83"></a> <a href="#L-84"></a>p.makeUrlLink = makeUrlLink <a href="#L-85"></a> <a href="#L-86"></a>local function makeToolbar(...) <a href="#L-87"></a> local ret = {} <a href="#L-88"></a> local lim = select('#', ...) <a href="#L-89"></a> if lim < 1 then <a href="#L-90"></a> return nil <a href="#L-91"></a> end <a href="#L-92"></a> for i = 1, lim do <a href="#L-93"></a> ret[#ret + 1] = select(i, ...) <a href="#L-94"></a> end <a href="#L-95"></a> -- 'documentation-toolbar' <a href="#L-96"></a> return format( <a href="#L-97"></a> '(%s)', <a href="#L-98"></a> message('toolbar-class'), <a href="#L-99"></a> table.concat(ret, ' &#124; ') <a href="#L-100"></a> ) <a href="#L-101"></a>end <a href="#L-102"></a> <a href="#L-103"></a>p.makeToolbar = makeToolbar <a href="#L-104"></a> <a href="#L-105"></a>---------------------------------------------------------------------------- <a href="#L-106"></a>-- Argument processing <a href="#L-107"></a>---------------------------------------------------------------------------- <a href="#L-108"></a> <a href="#L-109"></a>local function makeInvokeFunc(funcName) <a href="#L-110"></a> return function (frame) <a href="#L-111"></a> local args = getArgs(frame, { <a href="#L-112"></a> valueFunc = function (key, value) <a href="#L-113"></a> if type(value) == 'string' then <a href="#L-114"></a> value = value:match('^%s*(.-)%s*$') -- Remove whitespace. <a href="#L-115"></a> if key == 'heading' or value ~= '' then <a href="#L-116"></a> return value <a href="#L-117"></a> else <a href="#L-118"></a> return nil <a href="#L-119"></a> end <a href="#L-120"></a> else <a href="#L-121"></a> return value <a href="#L-122"></a> end <a href="#L-123"></a> end <a href="#L-124"></a> }) <a href="#L-125"></a> return p[funcName](args) <a href="#L-126"></a> end <a href="#L-127"></a>end <a href="#L-128"></a> <a href="#L-129"></a>---------------------------------------------------------------------------- <a href="#L-130"></a>-- Entry points <a href="#L-131"></a>---------------------------------------------------------------------------- <a href="#L-132"></a> <a href="#L-133"></a>p.nonexistent = makeInvokeFunc('_nonexistent') <a href="#L-134"></a> <a href="#L-135"></a>function p._nonexistent(args) <a href="#L-136"></a> if mw.title.getCurrentTitle().subpageText == 'testcases' then <a href="#L-137"></a> return mw.getCurrentFrame():expandTemplate{title = 'module test cases notice'} <a href="#L-138"></a> else <a href="#L-139"></a> return p._main(args) <a href="#L-140"></a> end <a href="#L-141"></a>end <a href="#L-142"></a> <a href="#L-143"></a>p.main = makeInvokeFunc('_main') <a href="#L-144"></a> <a href="#L-145"></a>--[[ <a href="#L-146"></a>-- This function defines logic flow for the module. <a href="#L-147"></a>-- @function p._main <a href="#L-148"></a>-- @param {table} args - table of arguments passed by the user <a href="#L-149"></a>-- @return {string} wikitext markup corresponding to the documentation <a href="#L-150"></a>--]] <a href="#L-151"></a>function p._main(args) <a href="#L-152"></a> local env = p.getEnvironment(args) <a href="#L-153"></a> local content = p._content(args, env) <a href="#L-154"></a> local root = mw.html.create() <a href="#L-155"></a> root <a href="#L-156"></a> :wikitext(p._getModuleWikitext(args, env)) <a href="#L-157"></a> :wikitext(p.protectionTemplate(env)) <a href="#L-158"></a> :wikitext(p.sandboxNotice(args, env)) <a href="#L-159"></a> :tag('div') <a href="#L-160"></a> -- 'documentation-container' <a href="#L-161"></a> :addClass(message('container')) <a href="#L-162"></a> :attr('role', 'complementary') <a href="#L-163"></a> :attr('aria-labelledby', args.heading ~= '' and 'documentation-heading' or nil) <a href="#L-164"></a> :attr('aria-label', args.heading == '' and 'Documentation' or nil) <a href="#L-165"></a> :newline() <a href="#L-166"></a> :tag('div') <a href="#L-167"></a> -- 'documentation' <a href="#L-168"></a> :addClass(message('main-div-classes')) <a href="#L-169"></a> :newline() <a href="#L-170"></a> :wikitext(p._startBox(args, env)) <a href="#L-171"></a> :wikitext(mw.getCurrentFrame():expandTemplate{ title ="TOC right" }) <a href="#L-172"></a> :wikitext(content) <a href="#L-173"></a> :tag('div') <a href="#L-174"></a> -- 'documentation-clear' <a href="#L-175"></a> :addClass(message('clear')) <a href="#L-176"></a> :done() <a href="#L-177"></a> :newline() <a href="#L-178"></a> :done() <a href="#L-179"></a> :wikitext(p._endBox(args, env)) <a href="#L-180"></a> :done() <a href="#L-181"></a> :wikitext(p.addTrackingCategories(env)) <a href="#L-182"></a> <a href="#L-183"></a> -- 'Module:Documentation/styles.css' <a href="#L-184"></a> return mw.getCurrentFrame():extensionTag ( <a href="#L-185"></a> 'templatestyles', '', {src=cfg['templatestyles'] <a href="#L-186"></a> }) .. tostring(root) <a href="#L-187"></a>end <a href="#L-188"></a> <a href="#L-189"></a>---------------------------------------------------------------------------- <a href="#L-190"></a>-- Environment settings <a href="#L-191"></a>---------------------------------------------------------------------------- <a href="#L-192"></a> <a href="#L-193"></a>--- Returns a table with information about the environment, including title <a href="#L-194"></a>-- objects and other namespace- or path-related data. <a href="#L-195"></a>-- @function p.getEnvironment <a href="#L-196"></a>-- @param {table} args table of arguments passed by the user <a href="#L-197"></a>-- @return {table} env the environment <a href="#L-198"></a>function p.getEnvironment(args) <a href="#L-199"></a> -- Title objects include: <a href="#L-200"></a> -- env.title - the page we are making documentation for (usually the current title) <a href="#L-201"></a> -- env.templateTitle - the template (or module, file, etc.) <a href="#L-202"></a> -- env.docTitle - the /doc subpage. <a href="#L-203"></a> -- env.sandboxTitle - the /sandbox subpage. <a href="#L-204"></a> -- env.testcasesTitle - the /testcases subpage. <a href="#L-205"></a> -- <a href="#L-206"></a> -- Data includes: <a href="#L-207"></a> -- env.protectionLevels - the protection levels table of the title object. <a href="#L-208"></a> -- env.subjectSpace - the number of the title's subject namespace. <a href="#L-209"></a> -- env.docSpace - the number of the namespace the title puts its documentation in. <a href="#L-210"></a> -- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace. <a href="#L-211"></a> -- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template. <a href="#L-212"></a> -- <a href="#L-213"></a> -- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value <a href="#L-214"></a> -- returned will be nil. <a href="#L-215"></a> local env, envFuncs = {}, {} <a href="#L-216"></a> <a href="#L-217"></a> -- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value <a href="#L-218"></a> -- returned by that function is memoized in the env table so that we don't call any of the functions <a href="#L-219"></a> -- more than once. (Nils won't be memoized.) <a href="#L-220"></a> setmetatable(env, { <a href="#L-221"></a> __index = function (t, key) <a href="#L-222"></a> local envFunc = envFuncs[key] <a href="#L-223"></a> if envFunc then <a href="#L-224"></a> local success, val = pcall(envFunc) <a href="#L-225"></a> if success then <a href="#L-226"></a> env[key] = val -- Memoise the value. <a href="#L-227"></a> return val <a href="#L-228"></a> end <a href="#L-229"></a> end <a href="#L-230"></a> return nil <a href="#L-231"></a> end <a href="#L-232"></a> }) <a href="#L-233"></a> <a href="#L-234"></a> function envFuncs.title() <a href="#L-235"></a> -- The title object for the current page, or a test page passed with args.page. <a href="#L-236"></a> local title <a href="#L-237"></a> local titleArg = args.page <a href="#L-238"></a> if titleArg then <a href="#L-239"></a> title = mw.title.new(titleArg) <a href="#L-240"></a> else <a href="#L-241"></a> title = mw.title.getCurrentTitle() <a href="#L-242"></a> end <a href="#L-243"></a> return title <a href="#L-244"></a> end <a href="#L-245"></a> <a href="#L-246"></a> function envFuncs.templateTitle() <a href="#L-247"></a> --[[ <a href="#L-248"></a> -- The template (or module, etc.) title object. <a href="#L-249"></a> -- Messages: <a href="#L-250"></a> -- 'sandbox-subpage' --> 'sandbox' <a href="#L-251"></a> -- 'testcases-subpage' --> 'testcases' <a href="#L-252"></a> --]] <a href="#L-253"></a> local subjectSpace = env.subjectSpace <a href="#L-254"></a> local title = env.title <a href="#L-255"></a> local subpage = title.subpageText <a href="#L-256"></a> if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') or subpage == message('doc-subpage') then <a href="#L-257"></a> return mw.title.makeTitle(subjectSpace, title.baseText) <a href="#L-258"></a> else <a href="#L-259"></a> return mw.title.makeTitle(subjectSpace, title.text) <a href="#L-260"></a> end <a href="#L-261"></a> end <a href="#L-262"></a> <a href="#L-263"></a> function envFuncs.docTitle() <a href="#L-264"></a> --[[ <a href="#L-265"></a> -- Title object of the /doc subpage. <a href="#L-266"></a> -- Messages: <a href="#L-267"></a> -- 'doc-subpage' --> 'doc' <a href="#L-268"></a> --]] <a href="#L-269"></a> local title = env.title <a href="#L-270"></a> local docname = args[1] -- User-specified doc page. <a href="#L-271"></a> local docpage <a href="#L-272"></a> if docname then <a href="#L-273"></a> docpage = docname <a href="#L-274"></a> else <a href="#L-275"></a> docpage = env.docpageBase .. '/' .. message('doc-subpage') <a href="#L-276"></a> end <a href="#L-277"></a> return mw.title.new(docpage) <a href="#L-278"></a> end <a href="#L-279"></a> <a href="#L-280"></a> function envFuncs.sandboxTitle() <a href="#L-281"></a> --[[ <a href="#L-282"></a> -- Title object for the /sandbox subpage. <a href="#L-283"></a> -- Messages: <a href="#L-284"></a> -- 'sandbox-subpage' --> 'sandbox' <a href="#L-285"></a> --]] <a href="#L-286"></a> return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage')) <a href="#L-287"></a> end <a href="#L-288"></a> <a href="#L-289"></a> function envFuncs.testcasesTitle() <a href="#L-290"></a> --[[ <a href="#L-291"></a> -- Title object for the /testcases subpage. <a href="#L-292"></a> -- Messages: <a href="#L-293"></a> -- 'testcases-subpage' --> 'testcases' <a href="#L-294"></a> --]] <a href="#L-295"></a> return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage')) <a href="#L-296"></a> end <a href="#L-297"></a> <a href="#L-298"></a> function envFuncs.protectionLevels() <a href="#L-299"></a> -- The protection levels table of the title object. <a href="#L-300"></a> return env.title.protectionLevels <a href="#L-301"></a> end <a href="#L-302"></a> <a href="#L-303"></a> function envFuncs.subjectSpace() <a href="#L-304"></a> -- The subject namespace number. <a href="#L-305"></a> return mw.site.namespaces[env.title.namespace].subject.id <a href="#L-306"></a> end <a href="#L-307"></a> <a href="#L-308"></a> function envFuncs.docSpace() <a href="#L-309"></a> -- The documentation namespace number. For most namespaces this is the <a href="#L-310"></a> -- same as the subject namespace. However, pages in the Article, File, <a href="#L-311"></a> -- MediaWiki or Category namespaces must have their /doc, /sandbox and <a href="#L-312"></a> -- /testcases pages in talk space. <a href="#L-313"></a> local subjectSpace = env.subjectSpace <a href="#L-314"></a> if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then <a href="#L-315"></a> return subjectSpace + 1 <a href="#L-316"></a> else <a href="#L-317"></a> return subjectSpace <a href="#L-318"></a> end <a href="#L-319"></a> end <a href="#L-320"></a> <a href="#L-321"></a> function envFuncs.docpageBase() <a href="#L-322"></a> -- The base page of the /doc, /sandbox, and /testcases subpages. <a href="#L-323"></a> -- For some namespaces this is the talk page, rather than the template page. <a href="#L-324"></a> local templateTitle = env.templateTitle <a href="#L-325"></a> local docSpace = env.docSpace <a href="#L-326"></a> local docSpaceText = mw.site.namespaces[docSpace].name <a href="#L-327"></a> -- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon. <a href="#L-328"></a> return docSpaceText .. ':' .. templateTitle.text <a href="#L-329"></a> end <a href="#L-330"></a> <a href="#L-331"></a> function envFuncs.compareUrl() <a href="#L-332"></a> -- Diff link between the sandbox and the main template using [[Special:ComparePages]]. <a href="#L-333"></a> local templateTitle = env.templateTitle <a href="#L-334"></a> local sandboxTitle = env.sandboxTitle <a href="#L-335"></a> if templateTitle.exists and sandboxTitle.exists then <a href="#L-336"></a> local compareUrl = mw.uri.canonicalUrl( <a href="#L-337"></a> 'Special:ComparePages', <a href="#L-338"></a> { page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText} <a href="#L-339"></a> ) <a href="#L-340"></a> return tostring(compareUrl) <a href="#L-341"></a> else <a href="#L-342"></a> return nil <a href="#L-343"></a> end <a href="#L-344"></a> end <a href="#L-345"></a> <a href="#L-346"></a> function envFuncs.luaAutodoc() <a href="#L-347"></a> -- the autodoc of Lua pages <a href="#L-348"></a> if env.templateTitle.namespace ~= 828 then return '' end <a href="#L-349"></a> local success, docbuntoContent = pcall(require("Module:Docbunto").main, <a href="#L-350"></a> {env.templateTitle.text, autodoc = true}) <a href="#L-351"></a> if success then <a href="#L-352"></a> return docbuntoContent <a href="#L-353"></a> end <a href="#L-354"></a> return '' <a href="#L-355"></a> end <a href="#L-356"></a> <a href="#L-357"></a> return env <a href="#L-358"></a>end <a href="#L-359"></a> <a href="#L-360"></a>---------------------------------------------------------------------------- <a href="#L-361"></a>-- Auxiliary templates <a href="#L-362"></a>---------------------------------------------------------------------------- <a href="#L-363"></a> <a href="#L-364"></a>p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext') <a href="#L-365"></a> <a href="#L-366"></a>function p._getModuleWikitext(args, env) <a href="#L-367"></a> local currentTitle = mw.title.getCurrentTitle() <a href="#L-368"></a> if currentTitle.contentModel ~= 'Scribunto' then return end <a href="#L-369"></a> pcall(require, currentTitle.prefixedText) -- if it fails, we don't care <a href="#L-370"></a> local moduleWikitext = package.loaded["Module:Module wikitext"] <a href="#L-371"></a> if moduleWikitext then <a href="#L-372"></a> return moduleWikitext.main() <a href="#L-373"></a> end <a href="#L-374"></a>end <a href="#L-375"></a> <a href="#L-376"></a>--- Generates a sandbox notice for display above sandbox pages. <a href="#L-377"></a>-- @function p.sandboxNotice <a href="#L-378"></a>-- @param {table} args a table of arguments passed by the user <a href="#L-379"></a>-- @param {table} env environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-380"></a>-- @return {string} wikitext wikitext corresponding to the sandbox notice <a href="#L-381"></a>function p.sandboxNotice(args, env) <a href="#L-382"></a> -- Messages: <a href="#L-383"></a> -- 'sandbox-notice-image' --> '[[File:Sandbox.svg|50px|alt=|link=]]' <a href="#L-384"></a> -- 'sandbox-notice-blurb' --> 'This is the $1 for $2.' <a href="#L-385"></a> -- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).' <a href="#L-386"></a> -- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page' <a href="#L-387"></a> -- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page' <a href="#L-388"></a> -- 'sandbox-notice-pagetype-other' --> 'sandbox page' <a href="#L-389"></a> -- 'sandbox-notice-compare-link-display' --> 'diff' <a href="#L-390"></a> -- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.' <a href="#L-391"></a> -- 'sandbox-notice-testcases-link-display' --> 'test cases' <a href="#L-392"></a> -- 'sandbox-category' --> 'Template sandboxes' <a href="#L-393"></a> -- 'module-sandbox-category' --> 'Module sandboxes' <a href="#L-394"></a> -- 'other-sandbox-category' --> 'Sandboxes outside of template or module namespace' <a href="#L-395"></a> local title = env.title <a href="#L-396"></a> local sandboxTitle = env.sandboxTitle <a href="#L-397"></a> local templateTitle = env.templateTitle <a href="#L-398"></a> local subjectSpace = env.subjectSpace <a href="#L-399"></a> if not (subjectSpace and title and sandboxTitle and templateTitle <a href="#L-400"></a> and mw.title.equals(title, sandboxTitle)) then <a href="#L-401"></a> return nil <a href="#L-402"></a> end <a href="#L-403"></a> -- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text". <a href="#L-404"></a> local omargs = {} <a href="#L-405"></a> omargs.image = message('sandbox-notice-image') <a href="#L-406"></a> -- Get the text. We start with the opening blurb, which is something like <a href="#L-407"></a> -- "This is the template sandbox for [[Template:Foo]] (diff)." <a href="#L-408"></a> local text = '__EXPECTUNUSEDTEMPLATE__' <a href="#L-409"></a> local pagetype, sandboxCat <a href="#L-410"></a> if subjectSpace == 10 then <a href="#L-411"></a> pagetype = message('sandbox-notice-pagetype-template') <a href="#L-412"></a> sandboxCat = message('sandbox-category') <a href="#L-413"></a> elseif subjectSpace == 828 then <a href="#L-414"></a> pagetype = message('sandbox-notice-pagetype-module') <a href="#L-415"></a> sandboxCat = message('module-sandbox-category') <a href="#L-416"></a> else <a href="#L-417"></a> pagetype = message('sandbox-notice-pagetype-other') <a href="#L-418"></a> sandboxCat = message('other-sandbox-category') <a href="#L-419"></a> end <a href="#L-420"></a> local templateLink = makeWikilink(templateTitle.prefixedText) <a href="#L-421"></a> local compareUrl = env.compareUrl <a href="#L-422"></a> if compareUrl then <a href="#L-423"></a> local compareDisplay = message('sandbox-notice-compare-link-display') <a href="#L-424"></a> local compareLink = makeUrlLink(compareUrl, compareDisplay) <a href="#L-425"></a> text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink}) <a href="#L-426"></a> else <a href="#L-427"></a> text = text .. message('sandbox-notice-blurb', {pagetype, templateLink}) <a href="#L-428"></a> end <a href="#L-429"></a> -- Get the test cases page blurb if the page exists. This is something like <a href="#L-430"></a> -- "See also the companion subpage for [[Template:Foo/testcases|test cases]]." <a href="#L-431"></a> local testcasesTitle = env.testcasesTitle <a href="#L-432"></a> if testcasesTitle and testcasesTitle.exists then <a href="#L-433"></a> if testcasesTitle.contentModel == "Scribunto" then <a href="#L-434"></a> local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display') <a href="#L-435"></a> local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display') <a href="#L-436"></a> local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay) <a href="#L-437"></a> local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay) <a href="#L-438"></a> text = text .. ' ' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink}) <a href="#L-439"></a> else <a href="#L-440"></a> local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display') <a href="#L-441"></a> local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay) <a href="#L-442"></a> text = text .. ' ' .. message('sandbox-notice-testcases-blurb', {testcasesLink}) <a href="#L-443"></a> end <a href="#L-444"></a> end <a href="#L-445"></a> <a href="#L-446"></a> -- Add the sandbox to the sandbox category. <a href="#L-447"></a> omargs.text = text .. makeCategoryLink(sandboxCat) <a href="#L-448"></a> <a href="#L-449"></a> -- 'documentation-clear' <a href="#L-450"></a> return '<div class="' .. message('clear') .. '"></div>' <a href="#L-451"></a> .. require('Module:Message box').main('ombox', omargs) <a href="#L-452"></a>end <a href="#L-453"></a> <a href="#L-454"></a>-- Generates the padlock icon in the top right. <a href="#L-455"></a>-- @function p.protectionTemplate <a href="#L-456"></a>-- @param {table} env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-457"></a>-- @return {string} wikitext - wikitext corresponding to the protection template <a href="#L-458"></a>function p.protectionTemplate(env) <a href="#L-459"></a> -- Messages: <a href="#L-460"></a> -- 'protection-template' --> 'pp-template' <a href="#L-461"></a> -- 'protection-template-args' --> {docusage = 'yes'} <a href="#L-462"></a> local protectionLevels = env.protectionLevels <a href="#L-463"></a> if not protectionLevels then <a href="#L-464"></a> return nil <a href="#L-465"></a> end <a href="#L-466"></a> local editProt = protectionLevels.edit and protectionLevels.edit[1] <a href="#L-467"></a> local moveProt = protectionLevels.move and protectionLevels.move[1] <a href="#L-468"></a> if editProt then <a href="#L-469"></a> -- The page is edit-protected. <a href="#L-470"></a> return require('Module:Protection banner')._main{ <a href="#L-471"></a> message('protection-reason-edit'), small = true <a href="#L-472"></a> } <a href="#L-473"></a> elseif moveProt and moveProt ~= 'autoconfirmed' then <a href="#L-474"></a> -- The page is move-protected but not edit-protected. Exclude move <a href="#L-475"></a> -- protection with the level "autoconfirmed", as this is equivalent to <a href="#L-476"></a> -- no move protection at all. <a href="#L-477"></a> return require('Module:Protection banner')._main{ <a href="#L-478"></a> action = 'move', small = true <a href="#L-479"></a> } <a href="#L-480"></a> else <a href="#L-481"></a> return nil <a href="#L-482"></a> end <a href="#L-483"></a>end <a href="#L-484"></a> <a href="#L-485"></a>---------------------------------------------------------------------------- <a href="#L-486"></a>-- Start box <a href="#L-487"></a>---------------------------------------------------------------------------- <a href="#L-488"></a> <a href="#L-489"></a>p.startBox = makeInvokeFunc('_startBox') <a href="#L-490"></a> <a href="#L-491"></a> <a href="#L-492"></a>--- This function generates the start box. <a href="#L-493"></a>-- @function p._startBox <a href="#L-494"></a>-- @param {table} args a table of arguments passed by the user <a href="#L-495"></a>-- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-496"></a>-- @return {string} startBox the text corresponding to the start box. <a href="#L-497"></a>function p._startBox(args, env) <a href="#L-498"></a> -- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make <a href="#L-499"></a> -- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox <a href="#L-500"></a> -- which generate the box HTML. <a href="#L-501"></a> env = env or p.getEnvironment(args) <a href="#L-502"></a> local links <a href="#L-503"></a> local content = args.content <a href="#L-504"></a> if not content or args[1] then <a href="#L-505"></a> -- No need to include the links if the documentation is on the template page itself. <a href="#L-506"></a> local linksData = p.makeStartBoxLinksData(args, env) <a href="#L-507"></a> if linksData then <a href="#L-508"></a> links = p.renderStartBoxLinks(linksData) <a href="#L-509"></a> end <a href="#L-510"></a> end <a href="#L-511"></a> -- Generate the start box html. <a href="#L-512"></a> local data = p.makeStartBoxData(args, env, links) <a href="#L-513"></a> if data then <a href="#L-514"></a> return p.renderStartBox(data) <a href="#L-515"></a> else <a href="#L-516"></a> -- User specified no heading. <a href="#L-517"></a> return nil <a href="#L-518"></a> end <a href="#L-519"></a>end <a href="#L-520"></a> <a href="#L-521"></a>--- Does initial processing of data to make the [view] [edit] [history] [purge] links. <a href="#L-522"></a>-- @function p.makeStartBoxLinksData <a href="#L-523"></a>-- @param {table} args - a table of arguments passed by the user <a href="#L-524"></a>-- @param {table} env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-525"></a>-- @return {table} data - data for the links <a href="#L-526"></a>function p.makeStartBoxLinksData(args, env) <a href="#L-527"></a> -- Messages: <a href="#L-528"></a> -- 'view-link-display' --> 'view' <a href="#L-529"></a> -- 'edit-link-display' --> 'edit' <a href="#L-530"></a> -- 'history-link-display' --> 'history' <a href="#L-531"></a> -- 'purge-link-display' --> 'purge' <a href="#L-532"></a> -- 'module-preload' --> 'Template:Documentation/preload-module-doc' <a href="#L-533"></a> -- 'docpage-preload' --> 'Template:Documentation/preload' <a href="#L-534"></a> -- 'create-link-display' --> 'create' <a href="#L-535"></a> local subjectSpace = env.subjectSpace <a href="#L-536"></a> local title = env.title <a href="#L-537"></a> local docTitle = env.docTitle <a href="#L-538"></a> if not title or not docTitle then <a href="#L-539"></a> return nil <a href="#L-540"></a> end <a href="#L-541"></a> if docTitle.isRedirect then <a href="#L-542"></a> docTitle = docTitle.redirectTarget <a href="#L-543"></a> end <a href="#L-544"></a> <a href="#L-545"></a> -- Create link if /doc doesn't exist. <a href="#L-546"></a> local preload = args.preload <a href="#L-547"></a> if not preload then <a href="#L-548"></a> if subjectSpace == 828 then -- Module namespace <a href="#L-549"></a> preload = message('module-preload') <a href="#L-550"></a> else <a href="#L-551"></a> preload = message('docpage-preload') <a href="#L-552"></a> end <a href="#L-553"></a> end <a href="#L-554"></a> <a href="#L-555"></a> return { <a href="#L-556"></a> title = title, <a href="#L-557"></a> docTitle = docTitle, <a href="#L-558"></a> luaAutodoc = env.luaAutodoc, <a href="#L-559"></a> -- View, display, edit, and purge links if /doc exists. <a href="#L-560"></a> viewLinkDisplay = message('view-link-display'), <a href="#L-561"></a> editLinkDisplay = message('edit-link-display'), <a href="#L-562"></a> historyLinkDisplay = message('history-link-display'), <a href="#L-563"></a> purgeLinkDisplay = message('purge-link-display'), <a href="#L-564"></a> overrideLinkDisplay = message('override-link-display'), <a href="#L-565"></a> preload = preload, <a href="#L-566"></a> createLinkDisplay = message('create-link-display') <a href="#L-567"></a> } <a href="#L-568"></a>end <a href="#L-569"></a> <a href="#L-570"></a>--- Generates the [view][edit][history][purge] or [create][purge] links from the data table. <a href="#L-571"></a>-- @function p.renderStartBoxLinks <a href="#L-572"></a>-- @param {table} data - a table of data generated by p.makeStartBoxLinksData <a href="#L-573"></a>-- @return {string} wikitext - the wikitext of the links <a href="#L-574"></a>function p.renderStartBoxLinks(data) <a href="#L-575"></a> local docTitle = data.docTitle <a href="#L-576"></a> -- yes, we do intend to purge the template page on which the documentation appears <a href="#L-577"></a> local purgeLink = makeWikilink("Special:Purge/" .. data.title.prefixedText, data.purgeLinkDisplay) <a href="#L-578"></a> <a href="#L-579"></a> if docTitle.exists and (docTitle:getContent() ~= '' or data.luaAutodoc == '') then <a href="#L-580"></a> local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay) <a href="#L-581"></a> local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, data.editLinkDisplay) <a href="#L-582"></a> local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, data.historyLinkDisplay) <a href="#L-583"></a> return "&#91;" .. viewLink .. "&#93; &#91;" .. editLink .. "&#93; &#91;" .. historyLink .. "&#93; &#91;" .. purgeLink .. "&#93;" <a href="#L-584"></a> elseif data.luaAutodoc ~= '' then <a href="#L-585"></a> local overrideLink = makeUrlLink(docTitle:canonicalUrl{action = 'edit', preload = data.preload}, data.overrideLinkDisplay) <a href="#L-586"></a> return "&#91;" .. overrideLink .. "&#93; &#91;" .. purgeLink .. "&#93;" <a href="#L-587"></a> else <a href="#L-588"></a> local createLink = makeUrlLink(docTitle:canonicalUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay) <a href="#L-589"></a> return "&#91;" .. createLink .. "&#93; &#91;" .. purgeLink .. "&#93;" <a href="#L-590"></a> end <a href="#L-591"></a> return ret <a href="#L-592"></a>end <a href="#L-593"></a> <a href="#L-594"></a> <a href="#L-595"></a>--- Does initial processing of data to pass to the start-box render function, p.renderStartBox. <a href="#L-596"></a>-- @function p.makeStartBoxData <a href="#L-597"></a>-- @param {table} args - a table of arguments passed by the user <a href="#L-598"></a>-- @param {table} env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-599"></a>-- @param {table} links - a string containing the [view][edit][history][purge] links - could be nil if there's an error. <a href="#L-600"></a>-- @return {table} data - data corresponding to the start box <a href="#L-601"></a>function p.makeStartBoxData(args, env, links) <a href="#L-602"></a> -- Messages: <a href="#L-603"></a> -- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]' <a href="#L-604"></a> -- 'template-namespace-heading' --> 'Template documentation' <a href="#L-605"></a> -- 'module-namespace-heading' --> 'Module documentation' <a href="#L-606"></a> -- 'file-namespace-heading' --> 'Summary' <a href="#L-607"></a> -- 'other-namespaces-heading' --> 'Documentation' <a href="#L-608"></a> -- 'testcases-create-link-display' --> 'create' <a href="#L-609"></a> local subjectSpace = env.subjectSpace <a href="#L-610"></a> if not subjectSpace then <a href="#L-611"></a> -- Default to an "other namespaces" namespace, so that we get at least some output <a href="#L-612"></a> -- if an error occurs. <a href="#L-613"></a> subjectSpace = 2 <a href="#L-614"></a> end <a href="#L-615"></a> local data = {} <a href="#L-616"></a> <a href="#L-617"></a> -- Heading <a href="#L-618"></a> local heading = args.heading -- Blank values are not removed. <a href="#L-619"></a> if heading == '' then <a href="#L-620"></a> -- Don't display the start box if the heading arg is defined but blank. <a href="#L-621"></a> return nil <a href="#L-622"></a> end <a href="#L-623"></a> if heading then <a href="#L-624"></a> data.heading = heading <a href="#L-625"></a> elseif subjectSpace == 10 then -- Template namespace <a href="#L-626"></a> data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading') <a href="#L-627"></a> elseif subjectSpace == 828 then -- Module namespace <a href="#L-628"></a> if (not env.docTitle.exists or env.docTitle:getContent() == '') and env.luaAutodoc ~= '' then <a href="#L-629"></a> data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-autodoc-heading') <a href="#L-630"></a> else <a href="#L-631"></a> data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading') <a href="#L-632"></a> end <a href="#L-633"></a> elseif subjectSpace == 6 then -- File namespace <a href="#L-634"></a> data.heading = message('file-namespace-heading') <a href="#L-635"></a> else <a href="#L-636"></a> data.heading = message('other-namespaces-heading') <a href="#L-637"></a> end <a href="#L-638"></a> <a href="#L-639"></a> -- Heading CSS <a href="#L-640"></a> local headingStyle = args['heading-style'] <a href="#L-641"></a> if headingStyle then <a href="#L-642"></a> data.headingStyleText = headingStyle <a href="#L-643"></a> else <a href="#L-644"></a> -- 'documentation-heading' <a href="#L-645"></a> data.headingClass = message('main-div-heading-class') <a href="#L-646"></a> end <a href="#L-647"></a> <a href="#L-648"></a> -- Data for the [view][edit][history][purge] or [create] links. <a href="#L-649"></a> if links then <a href="#L-650"></a> -- 'mw-editsection-like plainlinks' <a href="#L-651"></a> data.linksClass = message('start-box-link-classes') <a href="#L-652"></a> data.links = links <a href="#L-653"></a> end <a href="#L-654"></a> <a href="#L-655"></a> return data <a href="#L-656"></a>end <a href="#L-657"></a> <a href="#L-658"></a>--- Renders the start box html. <a href="#L-659"></a>-- @function p.renderStartBox <a href="#L-660"></a>-- @param {table} data - a table of data generated by p.makeStartBoxData. <a href="#L-661"></a>-- @return {string} html - HTML corresponding to the start box <a href="#L-662"></a>function p.renderStartBox(data) <a href="#L-663"></a> local sbox = mw.html.create('div') <a href="#L-664"></a> sbox <a href="#L-665"></a> -- 'documentation-startbox' <a href="#L-666"></a> :addClass(message('start-box-class')) <a href="#L-667"></a> :newline() <a href="#L-668"></a> :tag('span') <a href="#L-669"></a> :addClass(data.headingClass) <a href="#L-670"></a> :attr('id', 'documentation-heading') <a href="#L-671"></a> :cssText(data.headingStyleText) <a href="#L-672"></a> :wikitext(data.heading) <a href="#L-673"></a> local links = data.links <a href="#L-674"></a> if links then <a href="#L-675"></a> sbox:tag('span') <a href="#L-676"></a> :addClass(data.linksClass) <a href="#L-677"></a> :attr('id', data.linksId) <a href="#L-678"></a> :wikitext(links) <a href="#L-679"></a> end <a href="#L-680"></a> return tostring(sbox) <a href="#L-681"></a>end <a href="#L-682"></a> <a href="#L-683"></a>---------------------------------------------------------------------------- <a href="#L-684"></a>-- Documentation content <a href="#L-685"></a>---------------------------------------------------------------------------- <a href="#L-686"></a> <a href="#L-687"></a>p.content = makeInvokeFunc('_content') <a href="#L-688"></a> <a href="#L-689"></a>--- Displays the documentation contents <a href="#L-690"></a>-- @function p._content <a href="#L-691"></a>-- @param {table} args - a table of arguments passed by the user <a href="#L-692"></a>-- @param {table} env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-693"></a>-- @return {string} content - the content of the documentation <a href="#L-694"></a>function p._content(args, env) <a href="#L-695"></a> env = env or p.getEnvironment(args) <a href="#L-696"></a> local docTitle = env.docTitle <a href="#L-697"></a> local content = args.content <a href="#L-698"></a> if not content and docTitle and docTitle.exists then <a href="#L-699"></a> content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText} <a href="#L-700"></a> end <a href="#L-701"></a> <a href="#L-702"></a> if content == nil or content == '' then <a href="#L-703"></a> content = env.luaAutodoc <a href="#L-704"></a> end <a href="#L-705"></a> <a href="#L-706"></a> -- The line breaks below are necessary so that "=== Headings ===" at the start and end <a href="#L-707"></a> -- of docs are interpreted correctly. <a href="#L-708"></a> return content and '\n' .. content .. '\n' or '' <a href="#L-709"></a>end <a href="#L-710"></a> <a href="#L-711"></a>p.contentTitle = makeInvokeFunc('_contentTitle') <a href="#L-712"></a> <a href="#L-713"></a>function p._contentTitle(args, env) <a href="#L-714"></a> env = env or p.getEnvironment(args) <a href="#L-715"></a> local docTitle = env.docTitle <a href="#L-716"></a> if not args.content and docTitle and docTitle.exists then <a href="#L-717"></a> return docTitle.prefixedText <a href="#L-718"></a> else <a href="#L-719"></a> return '' <a href="#L-720"></a> end <a href="#L-721"></a>end <a href="#L-722"></a> <a href="#L-723"></a>---------------------------------------------------------------------------- <a href="#L-724"></a>-- End box <a href="#L-725"></a>---------------------------------------------------------------------------- <a href="#L-726"></a> <a href="#L-727"></a>p.endBox = makeInvokeFunc('_endBox') <a href="#L-728"></a> <a href="#L-729"></a>--- This function generates the end box (also known as the link box). <a href="#L-730"></a>-- @function p._endBox <a href="#L-731"></a>-- @param {table} args - a table of arguments passed by the user <a href="#L-732"></a>-- @param {table} env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-733"></a>-- @return {string} wikitext - text corresponding to the endbox <a href="#L-734"></a>function p._endBox(args, env) <a href="#L-735"></a> <a href="#L-736"></a> -- Get environment data. <a href="#L-737"></a> env = env or p.getEnvironment(args) <a href="#L-738"></a> local subjectSpace = env.subjectSpace <a href="#L-739"></a> local docTitle = env.docTitle <a href="#L-740"></a> if not subjectSpace or not docTitle then <a href="#L-741"></a> return nil <a href="#L-742"></a> end <a href="#L-743"></a> <a href="#L-744"></a> -- Check whether we should output the end box at all. Add the end <a href="#L-745"></a> -- box by default if the documentation exists or if we are in the <a href="#L-746"></a> -- user, module or template namespaces. <a href="#L-747"></a> local linkBox = args['link box'] <a href="#L-748"></a> if linkBox == 'off' <a href="#L-749"></a> or not ( <a href="#L-750"></a> docTitle.exists <a href="#L-751"></a> or subjectSpace == 2 <a href="#L-752"></a> or subjectSpace == 828 <a href="#L-753"></a> or subjectSpace == 10 <a href="#L-754"></a> ) <a href="#L-755"></a> then <a href="#L-756"></a> return nil <a href="#L-757"></a> end <a href="#L-758"></a> <a href="#L-759"></a> -- Assemble the link box. <a href="#L-760"></a> local text = '' <a href="#L-761"></a> if linkBox then <a href="#L-762"></a> text = text .. linkBox <a href="#L-763"></a> else <a href="#L-764"></a> text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]." <a href="#L-765"></a> if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then <a href="#L-766"></a> -- We are in the user, template or module namespaces. <a href="#L-767"></a> -- Add sandbox and testcases links. <a href="#L-768"></a> -- "Editors can experiment in this template's sandbox and testcases pages." <a href="#L-769"></a> text = text .. (p.makeExperimentBlurb(args, env) or '') .. ' ' <a href="#L-770"></a> if not args.content and not args[1] then <a href="#L-771"></a> -- "Please add categories to the /doc subpage." <a href="#L-772"></a> -- Don't show this message with inline docs or with an explicitly specified doc page, <a href="#L-773"></a> -- as then it is unclear where to add the categories. <a href="#L-774"></a> text = text .. (p.makeCategoriesBlurb(args, env) or '') <a href="#L-775"></a> end <a href="#L-776"></a> text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template" <a href="#L-777"></a> end <a href="#L-778"></a> end <a href="#L-779"></a> <a href="#L-780"></a> local box = mw.html.create('div') <a href="#L-781"></a> -- 'documentation-metadata' <a href="#L-782"></a> box:attr('role', 'note') <a href="#L-783"></a> :addClass(message('end-box-class')) <a href="#L-784"></a> -- 'plainlinks' <a href="#L-785"></a> :addClass(message('end-box-plainlinks')) <a href="#L-786"></a> :wikitext(text) <a href="#L-787"></a> :done() <a href="#L-788"></a> <a href="#L-789"></a> return '\n' .. tostring(box) <a href="#L-790"></a>end <a href="#L-791"></a> <a href="#L-792"></a>--- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)". <a href="#L-793"></a>-- @function p.makeDocPageBlurb <a href="#L-794"></a>-- @param {table} args - a table of arguments passed by the user <a href="#L-795"></a>-- @param {table} env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-796"></a>-- @return {string} wikitext - the doc page blurb <a href="#L-797"></a>function p.makeDocPageBlurb(args, env) <a href="#L-798"></a> -- Messages: <a href="#L-799"></a> -- 'edit-link-display' --> 'edit' <a href="#L-800"></a> -- 'history-link-display' --> 'history' <a href="#L-801"></a> -- 'transcluded-from-blurb' --> <a href="#L-802"></a> -- 'The above [[Wikipedia:Template documentation|documentation]] <a href="#L-803"></a> -- is [[Help:Transclusion|transcluded]] from $1.' <a href="#L-804"></a> -- 'module-preload' --> 'Template:Documentation/preload-module-doc' <a href="#L-805"></a> -- 'create-link-display' --> 'create' <a href="#L-806"></a> -- 'create-module-doc-blurb' --> <a href="#L-807"></a> -- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].' <a href="#L-808"></a> local docTitle = env.docTitle <a href="#L-809"></a> if not docTitle then <a href="#L-810"></a> return nil <a href="#L-811"></a> end <a href="#L-812"></a> if docTitle.exists then <a href="#L-813"></a> -- /doc exists; link to it. <a href="#L-814"></a> local docLink = makeWikilink(docTitle.prefixedText) <a href="#L-815"></a> local editDisplay = message('edit-link-display') <a href="#L-816"></a> local editLink = makeWikilink("Special:EditPage/" .. docTitle.prefixedText, editDisplay) <a href="#L-817"></a> local historyDisplay = message('history-link-display') <a href="#L-818"></a> local historyLink = makeWikilink("Special:PageHistory/" .. docTitle.prefixedText, historyDisplay) <a href="#L-819"></a> return message('transcluded-from-blurb', {docLink}) <a href="#L-820"></a> .. ' ' <a href="#L-821"></a> .. makeToolbar(editLink, historyLink) <a href="#L-822"></a> .. ' ' <a href="#L-823"></a> elseif env.subjectSpace == 828 then <a href="#L-824"></a> -- /doc does not exist; ask to create it. <a href="#L-825"></a> local createUrl = docTitle:canonicalUrl{action = 'edit', preload = message('module-preload')} <a href="#L-826"></a> local createDisplay = message('create-link-display') <a href="#L-827"></a> local createLink = makeUrlLink(createUrl, createDisplay) <a href="#L-828"></a> return message('create-module-doc-blurb', {createLink}) <a href="#L-829"></a> .. ' ' <a href="#L-830"></a> end <a href="#L-831"></a>end <a href="#L-832"></a> <a href="#L-833"></a>--- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages." <a href="#L-834"></a>-- @function p.makeExperimentBlurb <a href="#L-835"></a>-- @param {table} args - a table of arguments passed by the user <a href="#L-836"></a>-- @param {table} env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-837"></a>-- @return {string} wikitext - the experiment blurb <a href="#L-838"></a>function p.makeExperimentBlurb(args, env) <a href="#L-839"></a> -- Messages: <a href="#L-840"></a> -- 'sandbox-link-display' --> 'sandbox' <a href="#L-841"></a> -- 'sandbox-edit-link-display' --> 'edit' <a href="#L-842"></a> -- 'compare-link-display' --> 'diff' <a href="#L-843"></a> -- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox' <a href="#L-844"></a> -- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox' <a href="#L-845"></a> -- 'sandbox-create-link-display' --> 'create' <a href="#L-846"></a> -- 'mirror-edit-summary' --> 'Create sandbox version of $1' <a href="#L-847"></a> -- 'mirror-link-display' --> 'mirror' <a href="#L-848"></a> -- 'mirror-link-preload' --> 'Template:Documentation/mirror' <a href="#L-849"></a> -- 'sandbox-link-display' --> 'sandbox' <a href="#L-850"></a> -- 'testcases-link-display' --> 'testcases' <a href="#L-851"></a> -- 'testcases-edit-link-display'--> 'edit' <a href="#L-852"></a> -- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox' <a href="#L-853"></a> -- 'testcases-create-link-display' --> 'create' <a href="#L-854"></a> -- 'testcases-link-display' --> 'testcases' <a href="#L-855"></a> -- 'testcases-edit-link-display' --> 'edit' <a href="#L-856"></a> -- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases' <a href="#L-857"></a> -- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases' <a href="#L-858"></a> -- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.' <a href="#L-859"></a> -- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.' <a href="#L-860"></a> local subjectSpace = env.subjectSpace <a href="#L-861"></a> local templateTitle = env.templateTitle <a href="#L-862"></a> local sandboxTitle = env.sandboxTitle <a href="#L-863"></a> local testcasesTitle = env.testcasesTitle <a href="#L-864"></a> local templatePage = templateTitle.prefixedText <a href="#L-865"></a> if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then <a href="#L-866"></a> return nil <a href="#L-867"></a> end <a href="#L-868"></a> -- Make links. <a href="#L-869"></a> local sandboxLinks, testcasesLinks <a href="#L-870"></a> if sandboxTitle.exists then <a href="#L-871"></a> local sandboxPage = sandboxTitle.prefixedText <a href="#L-872"></a> local sandboxDisplay = message('sandbox-link-display') <a href="#L-873"></a> local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay) <a href="#L-874"></a> local sandboxEditDisplay = message('sandbox-edit-link-display') <a href="#L-875"></a> local sandboxEditLink = makeWikilink("Special:EditPage/" .. sandboxPage, sandboxEditDisplay) <a href="#L-876"></a> local compareUrl = env.compareUrl <a href="#L-877"></a> local compareLink <a href="#L-878"></a> if compareUrl then <a href="#L-879"></a> local compareDisplay = message('compare-link-display') <a href="#L-880"></a> compareLink = makeUrlLink(compareUrl, compareDisplay) <a href="#L-881"></a> end <a href="#L-882"></a> sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink) <a href="#L-883"></a> else <a href="#L-884"></a> local sandboxPreload <a href="#L-885"></a> if subjectSpace == 828 then <a href="#L-886"></a> sandboxPreload = message('module-sandbox-preload') <a href="#L-887"></a> else <a href="#L-888"></a> sandboxPreload = message('template-sandbox-preload') <a href="#L-889"></a> end <a href="#L-890"></a> local sandboxCreateUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = sandboxPreload} <a href="#L-891"></a> local sandboxCreateDisplay = message('sandbox-create-link-display') <a href="#L-892"></a> local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay) <a href="#L-893"></a> local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)}) <a href="#L-894"></a> local mirrorPreload = message('mirror-link-preload') <a href="#L-895"></a> local mirrorUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary} <a href="#L-896"></a> if subjectSpace == 828 then <a href="#L-897"></a> mirrorUrl = sandboxTitle:canonicalUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary} <a href="#L-898"></a> end <a href="#L-899"></a> local mirrorDisplay = message('mirror-link-display') <a href="#L-900"></a> local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay) <a href="#L-901"></a> sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink) <a href="#L-902"></a> end <a href="#L-903"></a> if testcasesTitle.exists then <a href="#L-904"></a> local testcasesPage = testcasesTitle.prefixedText <a href="#L-905"></a> local testcasesDisplay = message('testcases-link-display') <a href="#L-906"></a> local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay) <a href="#L-907"></a> local testcasesEditUrl = testcasesTitle:canonicalUrl{action = 'edit'} <a href="#L-908"></a> local testcasesEditDisplay = message('testcases-edit-link-display') <a href="#L-909"></a> local testcasesEditLink = makeWikilink("Special:EditPage/" .. testcasesPage, testcasesEditDisplay) <a href="#L-910"></a> -- for Modules, add testcases run link if exists <a href="#L-911"></a> if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then <a href="#L-912"></a> local testcasesRunLinkDisplay = message('testcases-run-link-display') <a href="#L-913"></a> local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay) <a href="#L-914"></a> testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink) <a href="#L-915"></a> else <a href="#L-916"></a> testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink) <a href="#L-917"></a> end <a href="#L-918"></a> else <a href="#L-919"></a> local testcasesPreload <a href="#L-920"></a> if subjectSpace == 828 then <a href="#L-921"></a> testcasesPreload = message('module-testcases-preload') <a href="#L-922"></a> else <a href="#L-923"></a> testcasesPreload = message('template-testcases-preload') <a href="#L-924"></a> end <a href="#L-925"></a> local testcasesCreateUrl = testcasesTitle:canonicalUrl{action = 'edit', preload = testcasesPreload} <a href="#L-926"></a> local testcasesCreateDisplay = message('testcases-create-link-display') <a href="#L-927"></a> local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay) <a href="#L-928"></a> testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink) <a href="#L-929"></a> end <a href="#L-930"></a> local messageName <a href="#L-931"></a> if subjectSpace == 828 then <a href="#L-932"></a> messageName = 'experiment-blurb-module' <a href="#L-933"></a> else <a href="#L-934"></a> messageName = 'experiment-blurb-template' <a href="#L-935"></a> end <a href="#L-936"></a> return message(messageName, {sandboxLinks, testcasesLinks}) <a href="#L-937"></a>end <a href="#L-938"></a> <a href="#L-939"></a>--- Generates the text "Please add categories to the /doc subpage." <a href="#L-940"></a>-- @function p.makeCategoriesBlurb <a href="#L-941"></a>-- @param {table} args - a table of arguments passed by the user <a href="#L-942"></a>-- @param {table} env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-943"></a>-- @return {string} wikitext - the text of the blurb <a href="#L-944"></a>function p.makeCategoriesBlurb(args, env) <a href="#L-945"></a> -- Messages: <a href="#L-946"></a> -- 'doc-link-display' --> '/doc' <a href="#L-947"></a> -- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.' <a href="#L-948"></a> local docTitle = env.docTitle <a href="#L-949"></a> if not docTitle then <a href="#L-950"></a> return nil <a href="#L-951"></a> end <a href="#L-952"></a> local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display')) <a href="#L-953"></a> return message('add-categories-blurb', {docPathLink}) <a href="#L-954"></a>end <a href="#L-955"></a> <a href="#L-956"></a>--- Generates the "Subpages of this template" link. <a href="#L-957"></a>-- @function p.makeSubpagesBlurb <a href="#L-958"></a>-- @param {table} args - a table of arguments passed by the user <a href="#L-959"></a>-- @param {table} env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-960"></a>-- @return {string} wikitext - the text of the blurb <a href="#L-961"></a>function p.makeSubpagesBlurb(args, env) <a href="#L-962"></a> -- Messages: <a href="#L-963"></a> -- 'template-pagetype' --> 'template' <a href="#L-964"></a> -- 'module-pagetype' --> 'module' <a href="#L-965"></a> -- 'default-pagetype' --> 'page' <a href="#L-966"></a> -- 'subpages-link-display' --> 'Subpages of this $1' <a href="#L-967"></a> local subjectSpace = env.subjectSpace <a href="#L-968"></a> local templateTitle = env.templateTitle <a href="#L-969"></a> if not subjectSpace or not templateTitle then <a href="#L-970"></a> return nil <a href="#L-971"></a> end <a href="#L-972"></a> local pagetype <a href="#L-973"></a> if subjectSpace == 10 then <a href="#L-974"></a> pagetype = message('template-pagetype') <a href="#L-975"></a> elseif subjectSpace == 828 then <a href="#L-976"></a> pagetype = message('module-pagetype') <a href="#L-977"></a> else <a href="#L-978"></a> pagetype = message('default-pagetype') <a href="#L-979"></a> end <a href="#L-980"></a> local subpagesLink = makeWikilink( <a href="#L-981"></a> 'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/', <a href="#L-982"></a> message('subpages-link-display', {pagetype}) <a href="#L-983"></a> ) <a href="#L-984"></a> return message('subpages-blurb', {subpagesLink}) <a href="#L-985"></a>end <a href="#L-986"></a> <a href="#L-987"></a>---------------------------------------------------------------------------- <a href="#L-988"></a>-- Tracking categories <a href="#L-989"></a>---------------------------------------------------------------------------- <a href="#L-990"></a> <a href="#L-991"></a>--- Check if {{tl|documentation}} is transcluded on a /doc or /testcases page. <a href="#L-992"></a>-- @function p.addTrackingCategories <a href="#L-993"></a>-- @param {table} env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-994"></a>-- @return {string} wikitext - the wikitext for the tracking categories <a href="#L-995"></a>function p.addTrackingCategories(env) <a href="#L-996"></a> -- Messages: <a href="#L-997"></a> -- 'display-strange-usage-category' --> true <a href="#L-998"></a> -- 'doc-subpage' --> 'doc' <a href="#L-999"></a> -- 'testcases-subpage' --> 'testcases' <a href="#L-1000"></a> -- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage' <a href="#L-1001"></a> -- <a href="#L-1002"></a> -- /testcases pages in the module namespace are not categorised, as they may have <a href="#L-1003"></a> -- {{tl|documentation}} transcluded automatically. <a href="#L-1004"></a> local title = env.title <a href="#L-1005"></a> local subjectSpace = env.subjectSpace <a href="#L-1006"></a> if not title or not subjectSpace then <a href="#L-1007"></a> return nil <a href="#L-1008"></a> end <a href="#L-1009"></a> local subpage = title.subpageText <a href="#L-1010"></a> if message('display-strange-usage-category', nil, 'boolean') <a href="#L-1011"></a> and ( <a href="#L-1012"></a> subpage == message('doc-subpage') <a href="#L-1013"></a> or subjectSpace ~= 828 and subpage == message('testcases-subpage') <a href="#L-1014"></a> ) <a href="#L-1015"></a> then <a href="#L-1016"></a> return makeCategoryLink(message('strange-usage-category')) <a href="#L-1017"></a> end <a href="#L-1018"></a> return '' <a href="#L-1019"></a>end <a href="#L-1020"></a> <a href="#L-1021"></a>return p </pre></div>   </div><noscript><img src="https://login.wikimedia.org/wiki/Special:CentralAutoLogin/start?useformat=desktop&type=1x1&usesul3=0" 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:Documentation/sandbox&oldid=1263392455">https://en.wikipedia.org/w/index.php?title=Module:Documentation/sandbox&oldid=1263392455</a>"</div></div> <div id="catlinks" class="catlinks" data-mw="interface"><div id="mw-normal-catlinks" class="mw-normal-catlinks"><a href="/wiki/Help:Category" title="Help:Category">Category</a>: <ul><li><a href="/wiki/Category:Module_sandboxes" title="Category:Module sandboxes">Module sandboxes</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 16 December 2024, at 11:51 (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:Documentation/sandbox&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"><picture><source media="(min-width: 500px)" srcset="/static/images/footer/wikimedia-button.svg" width="84" height="29"><img src="/static/images/footer/wikimedia.svg" width="25" height="25" alt="Wikimedia Foundation" lang="en" loading="lazy"></picture></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"><picture><source media="(min-width: 500px)" srcset="/w/resources/assets/poweredby_mediawiki.svg" width="88" height="31"><img src="/w/resources/assets/mediawiki_compact.svg" alt="Powered by MediaWiki" width="25" height="25" loading="lazy"></picture></a></li> </ul> </footer> </div> </div> </div> <div class="vector-header-container vector-sticky-header-container"> <div id="vector-sticky-header" class="vector-sticky-header"> <div class="vector-sticky-header-start"> <div class="vector-sticky-header-icon-start vector-button-flush-left vector-button-flush-right" aria-hidden="true"> <button class="cdx-button cdx-button--weight-quiet cdx-button--icon-only vector-sticky-header-search-toggle" tabindex="-1" data-event-name="ui.vector-sticky-search-form.icon"> Search </button> </div> <div role="search" class="vector-search-box-vue vector-search-box-show-thumbnail vector-search-box"> <div class="vector-typeahead-search-container"> <div class="cdx-typeahead-search cdx-typeahead-search--show-thumbnail"> <form action="/w/index.php" id="vector-sticky-search-form" class="cdx-search-input cdx-search-input--has-end-button"> <div 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"> </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> <div class="vector-sticky-header-context-bar"> <nav aria-label="Contents" class="vector-toc-landmark"> <div id="vector-sticky-header-toc" class="vector-dropdown mw-portlet mw-portlet-sticky-header-toc vector-sticky-header-toc vector-button-flush-left" > <input type="checkbox" id="vector-sticky-header-toc-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-sticky-header-toc" class="vector-dropdown-checkbox " aria-label="Toggle the table of contents" > <label id="vector-sticky-header-toc-label" for="vector-sticky-header-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-sticky-header-toc-unpinned-container" class="vector-unpinned-container"> </div> </div> </div> </nav> <div class="vector-sticky-header-context-bar-primary" aria-hidden="true" >Module:Documentation/sandbox</div> </div> </div> <div class="vector-sticky-header-end" aria-hidden="true"> <div class="vector-sticky-header-icons"> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only" id="ca-talk-sticky-header" tabindex="-1" data-event-name="talk-sticky-header"> </a> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only" id="ca-subject-sticky-header" tabindex="-1" data-event-name="subject-sticky-header"> </a> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only" id="ca-history-sticky-header" tabindex="-1" data-event-name="history-sticky-header"> </a> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only mw-watchlink" id="ca-watchstar-sticky-header" tabindex="-1" data-event-name="watch-sticky-header"> </a> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only" id="ca-edit-sticky-header" tabindex="-1" data-event-name="wikitext-edit-sticky-header"> </a> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only" id="ca-ve-edit-sticky-header" tabindex="-1" data-event-name="ve-edit-sticky-header"> </a> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only" id="ca-viewsource-sticky-header" tabindex="-1" data-event-name="ve-edit-protected-sticky-header"> </a> </div> <div class="vector-sticky-header-buttons"> <button class="cdx-button cdx-button--weight-quiet mw-interlanguage-selector" id="p-lang-btn-sticky-header" tabindex="-1" data-event-name="ui.dropdown-p-lang-btn-sticky-header"> Add languages </button> <a href="#" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--action-progressive" id="ca-addsection-sticky-header" tabindex="-1" data-event-name="addsection-sticky-header"> Add topic </a> </div> <div class="vector-sticky-header-icon-end"> <div class="vector-user-links"> </div> </div> </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-d8647bfd6-srpwp","wgBackendResponseTime":357,"wgPageParseReport":{"limitreport":{"cputime":"0.101","walltime":"0.204","ppvisitednodes":{"value":275,"limit":1000000},"postexpandincludesize":{"value":21013,"limit":2097152},"templateargumentsize":{"value":945,"limit":2097152},"expansiondepth":{"value":20,"limit":100},"expensivefunctioncount":{"value":15,"limit":500},"unstrip-depth":{"value":0,"limit":20},"unstrip-size":{"value":10224,"limit":5000000},"entityaccesscount":{"value":0,"limit":400},"timingprofile":["100.00% 123.893 1 Module:Documentation/doc","100.00% 123.893 1 -total"," 62.08% 76.908 1 Template:Used_in_system"," 16.02% 19.850 1 Template:Module_rating"," 13.65% 16.910 1 Template:Module_other"," 11.55% 14.309 1 Template:Ombox"," 8.99% 11.143 1 Template:Uses_TemplateStyles"," 7.95% 9.851 1 Template:Lua"," 4.43% 5.483 1 Template:Sandbox_other"," 4.15% 5.147 1 Template:FULLBASEPAGENAME"]},"scribunto":{"limitreport-timeusage":{"value":"0.057","limit":"10.000"},"limitreport-memusage":{"value":1853481,"limit":52428800}},"cachereport":{"origin":"mw-web.codfw.main-d8647bfd6-srpwp","timestamp":"20250223205852","ttl":2592000,"transientcontent":false}}});});</script> </body> </html>