CINXE.COM

<!DOCTYPE html> <html class="client-nojs vector-feature-language-in-header-enabled vector-feature-language-in-main-page-header-disabled vector-feature-sticky-header-disabled vector-feature-page-tools-pinned-disabled vector-feature-toc-pinned-clientpref-1 vector-feature-main-menu-pinned-disabled vector-feature-limited-width-clientpref-1 vector-feature-limited-width-content-enabled vector-feature-custom-font-size-clientpref-1 vector-feature-appearance-pinned-clientpref-1 vector-feature-night-mode-disabled skin-theme-clientpref-day vector-toc-available" lang="en" dir="ltr"> <head> <meta charset="UTF-8"> <title>Module:module documentation - Wiktionary, the free dictionary</title> <script>(function(){var className="client-js vector-feature-language-in-header-enabled vector-feature-language-in-main-page-header-disabled vector-feature-sticky-header-disabled vector-feature-page-tools-pinned-disabled vector-feature-toc-pinned-clientpref-1 vector-feature-main-menu-pinned-disabled vector-feature-limited-width-clientpref-1 vector-feature-limited-width-content-enabled vector-feature-custom-font-size-clientpref-1 vector-feature-appearance-pinned-clientpref-1 vector-feature-night-mode-disabled skin-theme-clientpref-day vector-toc-available";var cookie=document.cookie.match(/(?:^|; )enwiktionarymwclientpreferences=([^;]+)/);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":"95a6a488-6de0-4f69-bcba-768bab0ffe97","wgCanonicalNamespace":"Module","wgCanonicalSpecialPageName":false,"wgNamespaceNumber":828,"wgPageName":"Module:module_documentation","wgTitle":"module documentation","wgCurRevisionId":81398980,"wgRevisionId":81398980,"wgArticleId":9276047,"wgIsArticle":true,"wgIsRedirect":false,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":["Documentation modules"],"wgPageViewLanguage":"en","wgPageContentLanguage":"en","wgPageContentModel":"Scribunto","wgRelevantPageName":"Module:module_documentation","wgRelevantArticleId":9276047,"wgIsProbablyEditable":true,"wgRelevantPageIsProbablyEditable":true,"wgRestrictionEdit":[],"wgRestrictionMove":[],"wgNoticeProject":"wiktionary","wgCiteReferencePreviewsActive":true,"wgMediaViewerOnClick":true,"wgMediaViewerEnabledByDefault":true,"wgVisualEditor" :{"pageLanguageCode":"en","pageLanguageDir":"ltr","pageVariantFallbacks":"en"},"wgMFDisplayWikibaseDescriptions":{"search":true,"watchlist":true,"tagline":false,"nearby":true},"wgWMESchemaEditAttemptStepOversample":false,"wgWMEPageLength":10000,"wgEditSubmitButtonLabelPublish":true,"wgULSPosition":"interlanguage","wgULSisCompactLinksEnabled":false,"wgVector2022LanguageInHeader":true,"wgULSisLanguageSelectorEmpty":false,"wgWikibaseItemId":"Q117474698","wgCheckUserClientHintsHeadersJsApi":["brands","architecture","bitness","fullVersionList","mobile","model","platform","platformVersion"]};RLSTATE={"ext.gadget.LanguagesAndScripts":"ready","ext.gadget.Palette":"ready","ext.gadget.Site":"ready","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.LegacyScripts","ext.gadget.DocTabs","ext.gadget.RevdelInfo","ext.gadget.PagePreviews","ext.gadget.Edittools","ext.gadget.defaultVisibilityToggles","ext.gadget.UnsupportedTitles","ext.gadget.WiktGadgetPrefs","ext.urlShortener.toolbar","ext.centralauth.centralautologin","ext.visualEditor.desktopArticleTarget.init","ext.visualEditor.targetLoader","ext.echo.centralauth","ext.eventLogging","ext.wikimediaEvents","ext.navigationTiming","ext.uls.interface","wikibase.client.vector-2022","ext.checkUser.clientHints","wikibase.sidebar.tracking"];</script> <script>(RLQ=window.RLQ||[]).push(function(){mw.loader.impl(function(){return["user.options@12s5i",function($,jQuery,require,module){mw.user.tokens.set({"patrolToken":"+\\","watchToken":"+\\","csrfToken":"+\\"}); }];});});</script> <link rel="stylesheet" href="/w/load.php?lang=en&modules=ext.pygments%2CwikimediaBadges%7Cext.uls.interlanguage%7Cext.visualEditor.desktopArticleTarget.noscript%7Cext.wikimediamessages.styles%7Cskins.vector.icons%2Cstyles%7Cskins.vector.search.codex.styles%7Cwikibase.client.init&only=styles&skin=vector-2022"> <script async="" src="/w/load.php?lang=en&modules=startup&only=scripts&raw=1&skin=vector-2022"></script> <meta name="ResourceLoaderDynamicStyles" content=""> <link rel="stylesheet" href="/w/load.php?lang=en&modules=ext.gadget.LanguagesAndScripts%2CPalette%2CSite&only=styles&skin=vector-2022"> <link rel="stylesheet" href="/w/load.php?lang=en&modules=site.styles&only=styles&skin=vector-2022"> <meta name="generator" content="MediaWiki 1.44.0-wmf.5"> <meta name="referrer" content="origin"> <meta name="referrer" content="origin-when-cross-origin"> <meta name="robots" content="max-image-preview:standard"> <meta name="format-detection" content="telephone=no"> <meta name="viewport" content="width=1120"> <meta property="og:site_name" content="Wiktionary"> <meta property="og:title" content="Module:module documentation - Wiktionary, the free dictionary"> <meta property="og:type" content="website"> <link rel="alternate" media="only screen and (max-width: 640px)" href="//en.m.wiktionary.org/wiki/Module:module_documentation"> <link rel="alternate" type="application/x-wiki" title="Edit" href="/w/index.php?title=Module:module_documentation&action=edit"> <link rel="apple-touch-icon" href="/static/apple-touch/wiktionary/en.png"> <link rel="icon" href="/static/favicon/wiktionary/en.ico"> <link rel="search" type="application/opensearchdescription+xml" href="/w/rest.php/v1/search" title="Wiktionary (en)"> <link rel="EditURI" type="application/rsd+xml" href="//en.wiktionary.org/w/api.php?action=rsd"> <link rel="canonical" href="https://en.wiktionary.org/wiki/Module:module_documentation"> <link rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/deed.en"> <link rel="alternate" type="application/atom+xml" title="Wiktionary 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_module_documentation rootpage-Module_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" > <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-text" class="mw-list-item"><a href="/wiki/Wiktionary:Main_Page">Main Page</a></li><li id="n-portal" class="mw-list-item"><a href="/wiki/Wiktionary:Community_portal" title="About the project, what you can do, where to find things">Community portal</a></li><li id="n-requestedarticles" class="mw-list-item"><a href="/wiki/Wiktionary:Requested_entries">Requested entries</a></li><li id="n-recentchanges" class="mw-list-item"><a href="/wiki/Special:RecentChanges" title="A list of recent changes in the wiki [r]" accesskey="r">Recent changes</a></li><li id="n-randompage" class="mw-list-item"><a href="/wiki/Special:Random" title="Load a random page [x]" accesskey="x">Random entry</a></li><li id="n-help" class="mw-list-item"><a href="https://en.wiktionary.org/wiki/Help:Contents" title="The place to find out">Help</a></li><li id="n-Glossary" class="mw-list-item"><a href="/wiki/Appendix:Glossary">Glossary</a></li><li id="n-contact" class="mw-list-item"><a href="/wiki/Wiktionary:Contact_us">Contact us</a></li> </ul> </div> </div> </div> </div> </div> </div> </nav> <a href="/wiki/Wiktionary:Main_Page" class="mw-logo"> <img class="mw-logo-icon" src="/static/images/icons/enwiktionary.svg" alt="" aria-hidden="true" height="50" width="50"> <img class="mw-logo-wordmark" alt="Wiktionary" src="/static/images/mobile/copyright/wiktionary-wordmark-en.svg" style="width: 6.6875em; height: 1.1875em;"> <img class="mw-logo-tagline" alt="The Free Dictionary" src="/static/images/mobile/copyright/wiktionary-tagline-en.svg" width="110" height="15" style="width: 6.875em; height: 0.9375em;"> </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 Wiktionary [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 Wiktionary" aria-label="Search Wiktionary" autocapitalize="none" title="Search Wiktionary [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="//donate.wikimedia.org/wiki/Special:FundraiserRedirector?utm_source=donate&utm_medium=sidebar&utm_campaign=C13_en.wiktionary.org&uselang=en" class="">Donations</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%3Amodule+documentation" 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%3Amodule+documentation" title="You are encouraged to log in; however, it is 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="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="//donate.wikimedia.org/wiki/Special:FundraiserRedirector?utm_source=donate&utm_medium=sidebar&utm_campaign=C13_en.wiktionary.org&uselang=en">Donations</a></li><li id="pt-createaccount" class="user-links-collapsible-item mw-list-item"><a href="/w/index.php?title=Special:CreateAccount&returnto=Module%3Amodule+documentation" 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%3Amodule+documentation" title="You are encouraged to log in; however, it is 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">Beginning</div> </a> </li> <li id="toc-export.show" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#export.show"> <div class="vector-toc-text"> 1 export.show </div> </a> <ul id="toc-export.show-sublist" class="vector-toc-list"> </ul> </li> </ul> </div> </div> </nav> </div> </div> <div class="mw-content-container"> <main id="content" class="mw-body"> <header class="mw-body-header vector-page-titlebar"> <nav aria-label="Contents" class="vector-toc-landmark"> <div id="vector-page-titlebar-toc" class="vector-dropdown vector-page-titlebar-toc vector-button-flush-left" > <input type="checkbox" id="vector-page-titlebar-toc-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-page-titlebar-toc" class="vector-dropdown-checkbox " aria-label="Toggle the table of contents" > <label id="vector-page-titlebar-toc-label" for="vector-page-titlebar-toc-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Toggle the table of contents </label> <div class="vector-dropdown-content"> <div id="vector-page-titlebar-toc-unpinned-container" class="vector-unpinned-container"> </div> </div> </div> </nav> <h1 id="firstHeading" class="firstHeading mw-first-heading">Module:module documentation</h1> <div id="p-lang-btn" class="vector-dropdown mw-portlet mw-portlet-lang" > <input type="checkbox" id="p-lang-btn-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-p-lang-btn" class="vector-dropdown-checkbox mw-interlanguage-selector" aria-label="Go to an article in another language. Available in 9 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-9" aria-hidden="true" > 9 languages </label> <div class="vector-dropdown-content"> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li class="interlanguage-link interwiki-ko mw-list-item"><a href="https://ko.wiktionary.org/wiki/%EB%AA%A8%EB%93%88:module_documentation" title="모듈:module documentation – Korean" lang="ko" hreflang="ko" data-title="모듈:module documentation" data-language-autonym="한국어" data-language-local-name="Korean" class="interlanguage-link-target">한국어</a></li><li class="interlanguage-link interwiki-ky mw-list-item"><a href="https://ky.wiktionary.org/wiki/%D0%9C%D0%BE%D0%B4%D1%83%D0%BB%D1%8C:module_documentation" title="Модуль:module documentation – Kyrgyz" lang="ky" hreflang="ky" data-title="Модуль:module documentation" data-language-autonym="Кыргызча" data-language-local-name="Kyrgyz" class="interlanguage-link-target">Кыргызча</a></li><li class="interlanguage-link interwiki-mnw mw-list-item"><a href="https://mnw.wiktionary.org/wiki/%E1%80%99%E1%80%9D%E1%80%BA%E1%80%82%E1%80%BB%E1%80%B0:module_documentation" title="မဝ်ဂျူ:module documentation – Mon" lang="mnw" hreflang="mnw" data-title="မဝ်ဂျူ:module documentation" data-language-autonym="ဘာသာမန်" data-language-local-name="Mon" class="interlanguage-link-target">ဘာသာမန်</a></li><li class="interlanguage-link interwiki-ms mw-list-item"><a href="https://ms.wiktionary.org/wiki/Modul:module_documentation" title="Modul:module documentation – Malay" lang="ms" hreflang="ms" data-title="Modul:module documentation" data-language-autonym="Bahasa Melayu" data-language-local-name="Malay" class="interlanguage-link-target">Bahasa Melayu</a></li><li class="interlanguage-link interwiki-uz mw-list-item"><a href="https://uz.wiktionary.org/wiki/Modul:module_documentation" title="Modul:module documentation – Uzbek" lang="uz" hreflang="uz" data-title="Modul:module documentation" data-language-autonym="Oʻzbekcha / ўзбекча" data-language-local-name="Uzbek" class="interlanguage-link-target">Oʻzbekcha / ўзбекча</a></li><li class="interlanguage-link interwiki-pa mw-list-item"><a href="https://pa.wiktionary.org/wiki/%E0%A8%AE%E0%A9%8C%E0%A8%A1%E0%A8%BF%E0%A8%8A%E0%A8%B2:module_documentation" title="ਮੌਡਿਊਲ:module documentation – Punjabi" lang="pa" hreflang="pa" data-title="ਮੌਡਿਊਲ:module documentation" data-language-autonym="ਪੰਜਾਬੀ" data-language-local-name="Punjabi" class="interlanguage-link-target">ਪੰਜਾਬੀ</a></li><li class="interlanguage-link interwiki-si mw-list-item"><a href="https://si.wiktionary.org/wiki/Module:module_documentation" title="Module:module documentation – Sinhala" lang="si" hreflang="si" data-title="Module:module documentation" data-language-autonym="සිංහල" data-language-local-name="Sinhala" class="interlanguage-link-target">සිංහල</a></li><li class="interlanguage-link interwiki-simple mw-list-item"><a href="https://simple.wiktionary.org/wiki/Module:module_documentation" title="Module:module documentation – Simple English" lang="en-simple" hreflang="en-simple" data-title="Module:module documentation" data-language-autonym="Simple English" data-language-local-name="Simple English" class="interlanguage-link-target">Simple English</a></li><li class="interlanguage-link interwiki-shn mw-list-item"><a href="https://shn.wiktionary.org/wiki/%E1%80%99%E1%80%B1%E1%82%83%E1%82%87%E1%81%B5%E1%80%BB%E1%80%B0%E1%80%B8:module_documentation" title="မေႃႇၵျူး:module documentation – Shan" lang="shn" hreflang="shn" data-title="မေႃႇၵျူး:module documentation" data-language-autonym="ၽႃႇသႃႇတႆး " data-language-local-name="Shan" class="interlanguage-link-target">ၽႃႇသႃႇတႆး </a></li> </ul> <div class="after-portlet after-portlet-lang"><a href="https://www.wikidata.org/wiki/Special:EntityPage/Q117474698#sitelinks-wiktionary" title="Edit interlanguage links" class="wbc-editpage">Edit links</a></div> </div> </div> </div> </header> <div class="vector-page-toolbar"> <div class="vector-page-toolbar-container"> <div id="left-navigation"> <nav aria-label="Namespaces"> <div id="p-associated-pages" class="vector-menu vector-menu-tabs mw-portlet mw-portlet-associated-pages" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-nstab-module" class="selected vector-tab-noicon mw-list-item"><a href="/wiki/Module:module_documentation" 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:module_documentation" rel="discussion" title="Discussion about the content page [t]" accesskey="t">Discussion</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:module_documentation">Read</a></li><li id="ca-edit" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=Module:module_documentation&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:module_documentation&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:module_documentation">Read</a></li><li id="ca-more-edit" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=Module:module_documentation&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:module_documentation&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:module_documentation" title="A list of all wiki pages that link here [j]" accesskey="j">What links here</a></li><li id="t-recentchangeslinked" class="mw-list-item"><a href="/wiki/Special:RecentChangesLinked/Module:module_documentation" 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="//commons.wikimedia.org/wiki/Special:UploadWizard?uselang=en" title="Upload files [u]" accesskey="u">Upload file</a></li><li id="t-specialpages" class="mw-list-item"><a href="/wiki/Special:SpecialPages" title="A list of all special pages [q]" accesskey="q">Special pages</a></li><li id="t-permalink" class="mw-list-item"><a href="/w/index.php?title=Module:module_documentation&oldid=81398980" 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:module_documentation&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.wiktionary.org%2Fwiki%2FModule%3Amodule_documentation">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.wiktionary.org%2Fwiki%2FModule%3Amodule_documentation">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%3Amodule_documentation&action=show-download-screen">Download as PDF</a></li><li id="t-print" class="mw-list-item"><a href="javascript:print();" rel="alternate" title="Printable version of this page [p]" accesskey="p">Printable version</a></li> </ul> </div> </div> <div id="p-wikibase-otherprojects" class="vector-menu mw-portlet mw-portlet-wikibase-otherprojects" > <div class="vector-menu-heading"> In other projects </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="t-wikibase" class="wb-otherproject-link wb-otherproject-wikibase-dataitem mw-list-item"><a href="https://www.wikidata.org/wiki/Special:EntityPage/Q117474698" title="Link to connected data repository item [g]" accesskey="g">Wikidata item</a></li> </ul> </div> </div> </div> </div> </div> </div> </nav> </div> </div> </div> <div class="vector-column-end"> <div class="vector-sticky-pinned-container"> <nav class="vector-page-tools-landmark" aria-label="Page tools"> <div id="vector-page-tools-pinned-container" class="vector-pinned-container"> </div> </nav> <nav class="vector-appearance-landmark" aria-label="Appearance"> <div id="vector-appearance-pinned-container" class="vector-pinned-container"> <div id="vector-appearance" class="vector-appearance vector-pinnable-element"> <div class="vector-pinnable-header vector-appearance-pinnable-header vector-pinnable-header-pinned" data-feature-name="appearance-pinned" data-pinnable-element-id="vector-appearance" data-pinned-container-id="vector-appearance-pinned-container" data-unpinned-container-id="vector-appearance-unpinned-container" > <div class="vector-pinnable-header-label">Appearance</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-appearance.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-appearance.unpin">hide</button> </div> </div> </div> </nav> </div> </div> <div id="bodyContent" class="vector-body" aria-labelledby="firstHeading" data-mw-ve-target-container> <div class="vector-body-before-content"> <div class="mw-indicators"> </div> <div id="siteSub" class="noprint">From Wiktionary, the free dictionary</div> </div> <div id="contentSub"><div id="mw-content-subtitle"></div></div> <div id="mw-content-text" class="mw-body-content"><div class="mw-content-ltr mw-parser-output" lang="en" dir="ltr"><div class="documentation" style="display:block; clear:both"> <hr /> <dl class="plainlinks" style="font-size: smaller;"><dd>The following <a href="/wiki/Help:Documenting_templates_and_modules" title="Help:Documenting templates and modules">documentation</a> is located at <a href="/wiki/Module:module_documentation/documentation" title="Module:module documentation/documentation">Module:module documentation/documentation</a>. [<a class="external text" href="https://en.wiktionary.org/w/index.php?title=Module:module_documentation/documentation&action=edit">edit</a>]</dd><dd> Useful links: <a href="/wiki/Special:PrefixIndex/Module:module_documentation/" title="Special:PrefixIndex/Module:module documentation/">subpage list</a> • <a class="external text" href="https://en.wiktionary.org/w/index.php?title=Special%3AWhatLinksHere%2FModule%3Amodule_documentation&hideredirs=1&hidetrans=1">links</a> • <a class="external text" href="https://en.wiktionary.org/w/index.php?title=Special%3AWhatLinksHere%2FModule%3Amodule_documentation&hidelinks=1&hideredirs=1">transclusions</a> • <a href="/w/index.php?title=Module:module_documentation/testcases&action=edit&redlink=1" class="new" title="Module:module documentation/testcases (page does not exist)">testcases</a> • <a href="/w/index.php?title=Module:module_documentation/sandbox&action=edit&redlink=1" class="new" title="Module:module documentation/sandbox (page does not exist)">sandbox</a></dd></dl> This module automatically generates documentation for other modules. It fetches in-line comments in Lua code and converts them into a form that can be used on a documentation page via <code style="white-space:pre-wrap">{{<a href="/wiki/Template:module_documentation#top" title="Template:module documentation">module documentation</a>}}</code>. In fact, this module's documentation is an example of it in action! It's helpful to do documentation this way, as it means function/method documentation is available in two places: at the top of the module page (as conventional Wikitext), and above the function itself (as a Lua comment). Each suits a different kind of editing style, and doing it this way keeps them synchronised. A section of documentation is given using Lua's multi-line comment syntax, which looks something like this: <code class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr">--[==[ ... ]==]</code>. The number of equal signs should normally be two in order for the documentation to be properly snarfed by <code style="white-space:pre-wrap">{{<a href="/wiki/Template:module_documentation#top" title="Template:module documentation">module documentation</a>}}</code>. The following conventions can be used inside of the documentation: <ol><li>Long lines (both in regular paragraphs and in list items) can be broken by newlines optionally followed by spaces or tabs (especially useful in lists, to make the raw comment more readable). In such a case, the newline is converted to a space. Use two newlines in a row to break paragraphs. In general, it's recommended to break lines after at most 120 characters, to facilitate reading the raw comment.</li> <li>Template calls (using two braces) can be inserted literally and will be expanded.</li> <li>Single braces can be used to surround literal text, and will automatically be syntax-highlighted as Lua code. Nested braces inside of this literal text will be properly handled as long as they're balanced. If the first character of the literal text is itelf a brace, put a space before it (but not at the end), and it will be ignored.</li> <li>Backquotes can be used to surround literal text, which will be displayed using <code class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr"><code>...</code></code>. The stuff inside of backquotes cannot contain a backquote (except for double-backquoted placeholder variable names) or extend to multiple lines.</li> <li>Double backquotes can be used to surround placeholder variable names, which will be displayed using <code class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr"><var>...</var></code>. The stuff inside of backquotes can only contain letters, numbers, underscores, hyphens and periods. Normally, such placeholders should be displayed in a monospace font, as if surrounded by <code class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr"><code>...</code></code>. This effect can be achieved by using triple backquotes, which effectively uses the double-backquote syntax inside the single-backquote syntax.</li></ol> Certain special directives can follow the opening multiline comment indicator, if placed on the same line as the indicator. In particular, the following directives are currently recognized: <ul><li>The directive <code>intro:</code> by itself signals introductory text, which will be placed at the beginning, prior to function documentation. This is useful to give a general introduction/overview of the module.</li> <li>The directive <code>func: export.<var>function</var>(<var>arg1</var>, <var>arg2</var>, ...)</code> can be used when documenting a function declared in a nonstandard way (e.g. through a metatable, through an anonymous or locally-declared function assigned to the <code>export</code> table, etc.). The directive indicates the desired way for the function to appear, and the remainder of the comment describes the function's operation, as usual.</li></ul> <div class="mw-heading mw-heading2"><h2 id="export.show">export.show</h2>[<a href="/w/index.php?title=Module:module_documentation&action=edit&section=1" title="Edit section: export.show">edit</a>]</div> <code class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr">function export.show(frame)</code> The main entrypoint for <code style="white-space:pre-wrap">{{<a href="/wiki/Template:module_documentation#top" title="Template:module documentation">module documentation</a>}}</code>. The frame object can contain 3 optional arguments: <ul><li><code>|comment_level=</code>: The number of equals signs (=) a given section uses. Default: 2 (i.e. <code class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr">--[==[ ... (comment block) ]==]</code>) <dl><dd>e.g. The value 4 means <code class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr">--[====[ ... (comment block) ]====]</code>.</dd></dl></li> <li><code>|section_level=</code>: The header level used for each function/method. Default: 2 (i.e. L2: <code class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr">== ... ==</code>).</li> <li><code>|identifier=</code>: A Lua string pattern. Only the comments of functions whose names match this pattern are used. When not given, all function are accepted. <dl><dd>This is useful when giving object methods, using a pattern such as <code class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr">^object_name:</code>.</dd></dl></li></ul> </div> <div class="mw-highlight mw-highlight-lang-lua mw-content-ltr mw-highlight-lines" dir="ltr"><pre><a href="#L-1"></a>local m_str_utils = require("Module:string utilities") <a href="#L-2"></a> <a href="#L-3"></a>local codepoint = m_str_utils.codepoint <a href="#L-4"></a>local concat = table.concat <a href="#L-5"></a>local insert = table.insert <a href="#L-6"></a>local u = m_str_utils.char <a href="#L-7"></a>local rsplit = m_str_utils.split <a href="#L-8"></a> <a href="#L-9"></a>local export = {} <a href="#L-10"></a> <a href="#L-11"></a>--[===[ intro: <a href="#L-12"></a>This module automatically generates documentation for other modules. It fetches in-line comments in Lua code and <a href="#L-13"></a>converts them into a form that can be used on a documentation page via {{tl|module documentation}}. In fact, this <a href="#L-14"></a>module's documentation is an example of it in action! <a href="#L-15"></a> <a href="#L-16"></a>It's helpful to do documentation this way, as it means function/method documentation is available in two places: <a href="#L-17"></a>at the top of the module page (as conventional Wikitext), and above the function itself (as a Lua comment). Each <a href="#L-18"></a>suits a different kind of editing style, and doing it this way keeps them synchronised. <a href="#L-19"></a> <a href="#L-20"></a>A section of documentation is given using Lua's multi-line comment syntax, which looks something like this: <a href="#L-21"></a>{--[==[ ... ]==]}. The number of equal signs should normally be two in order for the documentation to be properly <a href="#L-22"></a>snarfed by {{tl|module documentation}}. The following conventions can be used inside of the documentation: <a href="#L-23"></a># Long lines (both in regular paragraphs and in list items) can be broken by newlines optionally followed by spaces <a href="#L-24"></a> or tabs (especially useful in lists, to make the raw comment more readable). In such a case, the newline is converted <a href="#L-25"></a> to a space. Use two newlines in a row to break paragraphs. In general, it's recommended to break lines after at most <a href="#L-26"></a> 120 characters, to facilitate reading the raw comment. <a href="#L-27"></a># Template calls (using two braces) can be inserted literally and will be expanded. <a href="#L-28"></a># Single braces can be used to surround literal text, and will automatically be syntax-highlighted as Lua code. Nested <a href="#L-29"></a> braces inside of this literal text will be properly handled as long as they're balanced. If the first character of the <a href="#L-30"></a> literal text is itelf a brace, put a space before it (but not at the end), and it will be ignored. <a href="#L-31"></a># Backquotes can be used to surround literal text, which will be displayed using {<code>...</code>}. The stuff inside of <a href="#L-32"></a> backquotes cannot contain a backquote (except for double-backquoted placeholder variable names) or extend to multiple <a href="#L-33"></a> lines. <a href="#L-34"></a># Double backquotes can be used to surround placeholder variable names, which will be displayed using {<var>...</var>}. <a href="#L-35"></a> The stuff inside of backquotes can only contain letters, numbers, underscores, hyphens and periods. Normally, such <a href="#L-36"></a> placeholders should be displayed in a monospace font, as if surrounded by {<code>...</code>}. This effect can be <a href="#L-37"></a> achieved by using triple backquotes, which effectively uses the double-backquote syntax inside the single-backquote <a href="#L-38"></a> syntax. <a href="#L-39"></a> <a href="#L-40"></a>Certain special directives can follow the opening multiline comment indicator, if placed on the same line as the <a href="#L-41"></a>indicator. In particular, the following directives are currently recognized: <a href="#L-42"></a> <a href="#L-43"></a>* The directive `intro:` by itself signals introductory text, which will be placed at the beginning, prior to function <a href="#L-44"></a> documentation. This is useful to give a general introduction/overview of the module. <a href="#L-45"></a>* The directive `func: export.<var>function</var>(<var>arg1</var>, <var>arg2</var>, ...)` can be used when documenting a <a href="#L-46"></a> function declared in a nonstandard way (e.g. through a metatable, through an anonymous or locally-declared function <a href="#L-47"></a> assigned to the `export` table, etc.). The directive indicates the desired way for the function to appear, and the <a href="#L-48"></a> remainder of the comment describes the function's operation, as usual. <a href="#L-49"></a>]===] <a href="#L-50"></a> <a href="#L-51"></a>local TEMP_LEFT_BRACE = u(0xFFF0) <a href="#L-52"></a>local TEMP_NEWLINE = u(0xFFF1) <a href="#L-53"></a> <a href="#L-54"></a>local function format_doc(str) <a href="#L-55"></a> local code_blocks = {} <a href="#L-56"></a> local code_blocks_i = 0 <a href="#L-57"></a> local private_use_start = 0x100000 <a href="#L-58"></a> local subbed_str = (str <a href="#L-59"></a> -- Multiline literal text between backquotes; you can't use <pre> or <syntaxhighlight> because that <a href="#L-60"></a> -- disables Wikitext parsing for <var>...</var>, italics, ... etc. Instead use the trick of <a href="#L-61"></a> -- putting a space at the beginning of each line, which yields monospace text without disabling Wikitext <a href="#L-62"></a> -- interpretation. <a href="#L-63"></a> :gsub("```(.-)```", function(inside) <a href="#L-64"></a> return inside <a href="#L-65"></a> -- placeholder variable names between double backquotes; we need to repeat this here to avoid <a href="#L-66"></a> -- the following pattern for single backquotes from clobbering double backquotes <a href="#L-67"></a> :gsub("``([A-Za-z0-9_%-. ]+)``", "<var>%1</var>") <a href="#L-68"></a> -- single backquotes undo monospacing <a href="#L-69"></a> :gsub("`([^`\n]+)`", '%1') <a href="#L-70"></a> -- text on the first line should be monospaced <a href="#L-71"></a> :gsub("^([^\n])", " %1") <a href="#L-72"></a> -- text after a newline should be monospaced, and temp-escape the newline so later replacements <a href="#L-73"></a> -- to join continued lines in a paragraph don't take effect <a href="#L-74"></a> :gsub("\n", TEMP_NEWLINE .. " ") <a href="#L-75"></a> -- escape { so it won't be interpreted as a code block <a href="#L-76"></a> :gsub("{", TEMP_LEFT_BRACE) <a href="#L-77"></a> end) <a href="#L-78"></a> :gsub("``([A-Za-z0-9_%-. ]+)``", "<var>%1</var>") -- placeholder variable names between double backquotes <a href="#L-79"></a> :gsub("`([^`\n]+)`", function(inside) -- literal text between backquotes, set using <code>...</code> <a href="#L-80"></a> -- Escape { so it won't be interpreted as a code block. <a href="#L-81"></a> inside = inside:gsub("{", TEMP_LEFT_BRACE) <a href="#L-82"></a> return "<code>" .. inside .. "</code>" <a href="#L-83"></a> end) <a href="#L-84"></a> -- {} blocks: blocks of code <a href="#L-85"></a> -- Escape to avoid removing line breaks. <a href="#L-86"></a> :gsub("%b{}", function(m0) <a href="#L-87"></a> local next_char = m0:sub(2, 2) <a href="#L-88"></a> if next_char == "|" then <a href="#L-89"></a> -- Wikitable; don't try to parse it as code. But we do want to parse special syntax in them (in <a href="#L-90"></a> -- particular {...} syntax for embedded code snippets), and if we return nil that won't happen. <a href="#L-91"></a> -- Instead, we call format_doc() recursively on the innards. <a href="#L-92"></a> return "{" .. format_doc(m0:sub(2, -2)) .. "}" <a href="#L-93"></a> end <a href="#L-94"></a> if next_char == "{" and m0:sub(-2, -2) == "}" then return nil end <a href="#L-95"></a> local text = "<syntaxhighlight lang=lua" .. (m0:match("\n") and "" or " inline") .. ">" .. m0:sub(2, -2):gsub("^ +", "") .. "</syntaxhighlight>" <a href="#L-96"></a> -- Prevent any further processing by storing the desired text into the `code_blocks` array and replacing <a href="#L-97"></a> -- the whole thing with a single private-use-area character. <a href="#L-98"></a> code_blocks_i = code_blocks_i + 1 <a href="#L-99"></a> code_blocks[code_blocks_i] = text <a href="#L-100"></a> return u(private_use_start + code_blocks_i) <a href="#L-101"></a> end) <a href="#L-102"></a> -- undo escaping of left brace to prevent code block interpretation <a href="#L-103"></a> :gsub(TEMP_LEFT_BRACE, "{") <a href="#L-104"></a> -- Join continued lines in a paragraph. We don't want to do that if there are two newlines in a row, <a href="#L-105"></a> -- and not if the second line begins with whitespace or a certain special characters (#, * or : indicating <a href="#L-106"></a> -- a list item; | indicating a wikitable item; semicolon for bolded items). <a href="#L-107"></a> :gsub("([^\n])\n[ \t]*([^ \t\n#*:;|])", "%1 %2") <a href="#L-108"></a> -- Repeat the previous in case of a single-character line (admittedly rare). <a href="#L-109"></a> :gsub("([^\n])\n[ \t]*([^ \t\n#*:;|])", "%1 %2") <a href="#L-110"></a> :gsub("\n[ \t]+%f[*#:;]", "\n") -- remove indentation for list items <a href="#L-111"></a> :gsub("%f[\n,{]\n%f[^\n*#:;]", "\n\n") -- wiki newlines <a href="#L-112"></a> :gsub("(\n[ *#:]*)(|?[_%w]+=?):", "%1<code>%2</code>:") -- parameter names <a href="#L-113"></a> -- double-underline to indicate types (displayed as italicized underlined) <a href="#L-114"></a> :gsub("__(.-)__", function(inside) <a href="#L-115"></a> return "" .. inside .. "" <a href="#L-116"></a> end) <a href="#L-117"></a> -- undo escaping of newline to prevent joining of continued lines <a href="#L-118"></a> :gsub(TEMP_NEWLINE, "\n")) <a href="#L-119"></a> <a href="#L-120"></a> -- Put <code>...</code> around <var>...</var> invocations that don't already occur inside of <a href="#L-121"></a> -- <code>...</code> blocks. <a href="#L-122"></a> local split_on_code = rsplit(subbed_str, "(<code>.-</code>)") <a href="#L-123"></a> for i = 1, #split_on_code, 2 do <a href="#L-124"></a> split_on_code[i] = split_on_code[i]:gsub("(<var>.-</var>)", "<code>%1</code>") <a href="#L-125"></a> end <a href="#L-126"></a> subbed_str = concat(split_on_code) <a href="#L-127"></a> return (subbed_str <a href="#L-128"></a> -- Undo code-block stashing. <a href="#L-129"></a> :gsub("\244[\128-\191][\128-\191][\128-\191]", function(char) <a href="#L-130"></a> return code_blocks[codepoint(char) - private_use_start] <a href="#L-131"></a> end)) <a href="#L-132"></a>end <a href="#L-133"></a> <a href="#L-134"></a>--[===[ <a href="#L-135"></a>The main entrypoint for {{tl|module documentation}}. The frame object can contain 3 optional arguments: <a href="#L-136"></a>* |comment_level=: The number of equals signs (=) a given section uses. Default: 2 (i.e. {--[==[ ... (comment block) ]==]}) <a href="#L-137"></a>*: e.g. The value 4 means {--[====[ ... (comment block) ]====]}. <a href="#L-138"></a>* |section_level=: The header level used for each function/method. Default: 2 (i.e. L2: {== ... ==}). <a href="#L-139"></a>* |identifier=: A Lua string pattern. Only the comments of functions whose names match this pattern are used. When not given, all function are accepted. <a href="#L-140"></a>*: This is useful when giving object methods, using a pattern such as {^object_name:}. <a href="#L-141"></a>]===] <a href="#L-142"></a>function export.show(frame) <a href="#L-143"></a> local args = frame:getParent().args or {} <a href="#L-144"></a> <a href="#L-145"></a> local comment_level = tonumber(args["comment_level"]) or 2 <a href="#L-146"></a> local function make_comment_pattern(typeid) <a href="#L-147"></a> if typeid then <a href="#L-148"></a> typeid = "%s*" .. typeid <a href="#L-149"></a> else <a href="#L-150"></a> typeid = "" <a href="#L-151"></a> end <a href="#L-152"></a> return "%-%-%[" .. ("="):rep(comment_level) .. "%[" .. typeid .. "\n?(.-)[\t\n]*]" .. ("="):rep(comment_level) .. "]()" <a href="#L-153"></a> end <a href="#L-154"></a> local fn_comment_pattern = make_comment_pattern(nil) <a href="#L-155"></a> local intro_comment_pattern = make_comment_pattern("intro:") <a href="#L-156"></a> local metafunc_comment_pattern = make_comment_pattern("func:%s*(([^\n(]+)[^\n)]+%))") <a href="#L-157"></a> local section_mark = ("="):rep(tonumber(args["section_level"]) or 2) <a href="#L-158"></a> local pattern_identifier = args["identifier"] or "" <a href="#L-159"></a> <a href="#L-160"></a> local mod_title = mw.title.getCurrentTitle() <a href="#L-161"></a> if mod_title.text:match("/documentation$") then return "(The generated documentation is located at the module page.)" end <a href="#L-162"></a> local mod_text = mod_title:getContent() <a href="#L-163"></a> if not mod_text then return "(The module page does not exist now.)" end <a href="#L-164"></a> <a href="#L-165"></a> -- This contains function and intro documentation. Each element is a two-element list of {POSITION, DOCS} specifying <a href="#L-166"></a> -- the generated documentation for a function and the character position in the file where it was found (for sorting <a href="#L-167"></a> -- purposes). <a href="#L-168"></a> local docs <a href="#L-169"></a> <a href="#L-170"></a> local intro_comment = mod_text:match("^.-" .. intro_comment_pattern) <a href="#L-171"></a> if intro_comment then <a href="#L-172"></a> docs = { {1, format_doc(intro_comment) }} <a href="#L-173"></a> else <a href="#L-174"></a> docs = {} <a href="#L-175"></a> end <a href="#L-176"></a> <a href="#L-177"></a> -- Look for actual functions. <a href="#L-178"></a> for p0, f, fn in mod_text:gmatch("()\n[ \t]*function +(([^\n(]+)[^\n)]+%))") do <a href="#L-179"></a> if fn:match(pattern_identifier) then <a href="#L-180"></a> local c = mod_text:sub(1, p0 - 1):match("^.*" .. fn_comment_pattern .. "%s*$") <a href="#L-181"></a> insert(docs, {p0, section_mark .. fn .. section_mark .. "\n\n" .. "<syntaxhighlight lang=lua inline>function " .. <a href="#L-182"></a> f .. "</syntaxhighlight>\n\n" .. format_doc(c or <a href="#L-183"></a> 'This function lacks documentation. Please add a description of its usages, inputs and outputs, ' .. <a href="#L-184"></a> "or its difference from similar functions, or make it local to remove it from the function list." .. <a href="#L-185"></a> "[[Category:Templates and modules needing documentation]]")}) <a href="#L-186"></a> end <a href="#L-187"></a> end <a href="#L-188"></a> <a href="#L-189"></a> -- Now look for comments with the function declaration inside them (used for metatable functions etc.). <a href="#L-190"></a> for p0, f, fn, comment in mod_text:gmatch("()" .. metafunc_comment_pattern) do <a href="#L-191"></a> insert(docs, {p0, section_mark .. fn .. section_mark .. "\n\n" .. "<syntaxhighlight lang=lua inline>function " .. f .. "</syntaxhighlight>\n\n" .. format_doc(comment)}) <a href="#L-192"></a> end <a href="#L-193"></a> <a href="#L-194"></a> table.sort(docs, function(a, b) return a[1] < b[1] end) <a href="#L-195"></a> <a href="#L-196"></a> local chunks = {} <a href="#L-197"></a> for i, decl in ipairs(docs) do <a href="#L-198"></a> insert(chunks, decl[2]) <a href="#L-199"></a> end <a href="#L-200"></a> <a href="#L-201"></a> return frame:preprocess(concat(chunks, "\n\n")) <a href="#L-202"></a>end <a href="#L-203"></a> <a href="#L-204"></a>return export </pre></div>   </div><noscript><img src="https://login.wikimedia.org/wiki/Special:CentralAutoLogin/start?type=1x1&useformat=desktop" alt="" width="1" height="1" style="border: none; position: absolute;"></noscript> <div class="printfooter" data-nosnippet="">Retrieved from "<a dir="ltr" href="https://en.wiktionary.org/w/index.php?title=Module:module_documentation&oldid=81398980">https://en.wiktionary.org/w/index.php?title=Module:module_documentation&oldid=81398980</a>"</div></div> <div id="catlinks" class="catlinks" data-mw="interface"><div id="mw-normal-catlinks" class="mw-normal-catlinks"><a href="/wiki/Special:Categories" title="Special:Categories">Category</a>: <ul><li><a href="/wiki/Category:Documentation_modules" title="Category:Documentation modules">Documentation modules</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 27 August 2024, at 14:42.</li> <li id="footer-info-copyright">Definitions and other text are available under the <a rel="nofollow" class="external text" href="//creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike License</a>; additional terms may apply. By using this site, you agree to the <a class="external text" href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Terms_of_Use">Terms of Use</a> and <a class="external text" href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Privacy_policy">Privacy Policy.</a></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/Wiktionary:About">About Wiktionary</a></li> <li id="footer-places-disclaimers"><a href="/wiki/Wiktionary:General_disclaimer">Disclaimers</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.wiktionary.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.wiktionary.org/w/index.php?title=Module:module_documentation&mobileaction=toggle_view_mobile" class="noprint stopMobileRedirectToggle">Mobile view</a></li> </ul> <ul id="footer-icons" class="noprint"> <li id="footer-copyrightico"><a href="https://wikimediafoundation.org/" class="cdx-button cdx-button--fake-button cdx-button--size-large cdx-button--fake-button--enabled"><img src="/static/images/footer/wikimedia-button.svg" width="84" height="29" alt="Wikimedia Foundation" loading="lazy"></a></li> <li id="footer-poweredbyico"><a href="https://www.mediawiki.org/" class="cdx-button cdx-button--fake-button cdx-button--size-large cdx-button--fake-button--enabled"><img src="/w/resources/assets/poweredby_mediawiki.svg" alt="Powered by MediaWiki" width="88" height="31" loading="lazy"></a></li> </ul> </footer> </div> </div> </div> <div class="vector-settings" id="p-dock-bottom"> <ul></ul> </div><script>(RLQ=window.RLQ||[]).push(function(){mw.config.set({"wgHostname":"mw-web.codfw.main-7fc47fc68d-wpmxs","wgBackendResponseTime":328,"wgPageParseReport":{"limitreport":{"cputime":"0.074","walltime":"0.172","ppvisitednodes":{"value":76,"limit":1000000},"postexpandincludesize":{"value":21070,"limit":2097152},"templateargumentsize":{"value":0,"limit":2097152},"expansiondepth":{"value":7,"limit":100},"expensivefunctioncount":{"value":12,"limit":500},"unstrip-depth":{"value":0,"limit":20},"unstrip-size":{"value":1798,"limit":5000000},"entityaccesscount":{"value":0,"limit":400},"timingprofile":["100.00% 161.151 1 Template:documentation","100.00% 161.151 1 -total"," 66.13% 106.568 1 Template:module_documentation"," 16.55% 26.669 3 Template:tl"," 3.53% 5.685 1 Template:module_cat"]},"scribunto":{"limitreport-timeusage":{"value":"0.053","limit":"10.000"},"limitreport-memusage":{"value":1843525,"limit":104857600}},"cachereport":{"origin":"mw-web.codfw.main-7fc47fc68d-wpmxs","timestamp":"20241128171434","ttl":2592000,"transientcontent":false}}});});</script> </body> </html>