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="arz" dir="rtl"> <head> <meta charset="UTF-8"> <title>وحدة:توثيق - ويكيبيديا</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(/(?:^|; )arzwikimwclientpreferences=([^;]+)/);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":[".\t,",".\t,"],"wgDigitTransformTable":[ "0\t1\t2\t3\t4\t5\t6\t7\t8\t9","0\t1\t2\t3\t4\t5\t6\t7\t8\t9"],"wgDefaultDateFormat":"dmy","wgMonthNames":["","يناير","فبراير","مارس","ابريل","مايو","يونيه","يوليه","اغسطس","سبتمبر","اكتوبر","نوفمبر","ديسمبر"],"wgRequestId":"7f95faf6-7f27-4ce1-996b-3ace80b8be87","wgCanonicalNamespace":"Module","wgCanonicalSpecialPageName":false,"wgNamespaceNumber":828,"wgPageName":"وحدة:توثيق","wgTitle":"توثيق","wgCurRevisionId":10564171,"wgRevisionId":10564171,"wgArticleId":189570,"wgIsArticle":true,"wgIsRedirect":false,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":[],"wgPageViewLanguage":"arz","wgPageContentLanguage":"arz","wgPageContentModel":"Scribunto","wgRelevantPageName":"وحدة:توثيق","wgRelevantArticleId":189570,"wgIsProbablyEditable":true,"wgRelevantPageIsProbablyEditable":true,"wgRestrictionEdit":[],"wgRestrictionMove":[],"wgNoticeProject":"wikipedia","wgCiteReferencePreviewsActive": true,"wgMediaViewerOnClick":true,"wgMediaViewerEnabledByDefault":true,"wgPopupsFlags":0,"wgVisualEditor":{"pageLanguageCode":"en","pageLanguageDir":"ltr","pageVariantFallbacks":"en"},"wgMFDisplayWikibaseDescriptions":{"search":true,"watchlist":true,"tagline":true,"nearby":true},"wgWMESchemaEditAttemptStepOversample":false,"wgWMEPageLength":40000,"wgRelatedArticlesCompat":[],"wgCentralAuthMobileDomain":false,"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.urlShortener.toolbar","ext.centralauth.centralautologin","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=arz&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=arz&modules=startup&only=scripts&raw=1&skin=vector-2022"></script> <meta name="ResourceLoaderDynamicStyles" content=""> <link rel="stylesheet" href="/w/load.php?lang=arz&modules=site.styles&only=styles&skin=vector-2022"> <meta name="generator" content="MediaWiki 1.44.0-wmf.4"> <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="وحدة:توثيق - ويكيبيديا"> <meta property="og:type" content="website"> <link rel="alternate" media="only screen and (max-width: 640px)" href="//arz.m.wikipedia.org/wiki/%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82"> <link rel="alternate" type="application/x-wiki" title="تعديل" href="/w/index.php?title=%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82&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="ويكيبيديا (arz)"> <link rel="EditURI" type="application/rsd+xml" href="//arz.wikipedia.org/w/api.php?action=rsd"> <link rel="canonical" href="https://arz.wikipedia.org/wiki/%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82"> <link rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/deed.arz"> <link rel="alternate" type="application/atom+xml" title="ويكيبيديا Atom feed" href="/w/index.php?title=%D8%AE%D8%A7%D8%B5:%D8%A7%D8%AE%D8%B1_%D8%AA%D8%B9%D8%AF%D9%8A%D9%84%D8%A7%D8%AA&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 rtl sitedir-rtl mw-hide-empty-elt ns-828 ns-subject mw-editable page-وحدة_توثيق rootpage-وحدة_توثيق skin-vector-2022 action-view"><a class="mw-jump-link" href="#bodyContent">انتقل إلى المحتوى</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="الموقع"> <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="القائمة الرئيسية" > <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" > القائمة الرئيسية </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">القائمة الرئيسية</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-main-menu.pin">انقل للشريط الجانبي</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-main-menu.unpin">أخف</button> </div> <div id="p-navigation" class="vector-menu mw-portlet mw-portlet-navigation" > <div class="vector-menu-heading"> استكشاف </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-mainpage-description" class="mw-list-item"><a href="/wiki/%D8%A7%D9%84%D8%B5%D9%81%D8%AD%D9%87_%D8%A7%D9%84%D8%B1%D8%A6%D9%8A%D8%B3%D9%8A%D9%87" title="زور الصفحه الرئيسيه [z]" accesskey="z">الصفحه الرئيسيه</a></li><li id="n-portalcategory" class="mw-list-item"><a href="/wiki/%D8%AA%D8%B5%D9%86%D9%8A%D9%81:%D8%A8%D9%88%D8%A7%D8%A8%D8%A7%D8%AA">بوابات ويكيبيديا مصرى</a></li><li id="n-recentchanges" class="mw-list-item"><a href="/wiki/%D8%AE%D8%A7%D8%B5:%D8%A7%D8%AE%D8%B1_%D8%AA%D8%B9%D8%AF%D9%8A%D9%84%D8%A7%D8%AA" title="ليستة التعديلات الاخرانيه فى الويكى [r]" accesskey="r">اخر التعديلات</a></li><li id="n-randompage" class="mw-list-item"><a href="/wiki/%D8%AE%D8%A7%D8%B5:%D8%B9%D8%B4%D9%88%D8%A7%D8%A6%D9%89" title="لوّد صفحه عشوائيه [x]" accesskey="x">صفحة عشوائيه</a></li><li id="n-help" class="mw-list-item"><a href="/wiki/%D9%85%D8%B3%D8%A7%D8%B9%D8%AF%D8%A9:%D9%85%D8%AD%D8%AA%D9%88%D9%8A%D8%A7%D8%AA" title="لو محتاج مساعده بص هنا">مساعده</a></li> </ul> </div> </div> <div id="p-contacting" class="vector-menu mw-portlet mw-portlet-contacting" > <div class="vector-menu-heading"> تواصل </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-villagepump" class="mw-list-item"><a href="/wiki/%D9%88%D9%8A%D9%83%D9%8A%D8%A8%D9%8A%D8%AF%D9%8A%D8%A7:%D8%B5%D8%A7%D9%84%D9%88%D9%86_%D8%A7%D9%84%D9%85%D9%86%D8%A7%D9%82%D8%B4%D9%87">صالون المناقشه</a></li><li id="n-manualofstyle" class="mw-list-item"><a href="/wiki/%D9%88%D9%8A%D9%83%D9%8A%D8%A8%D9%8A%D8%AF%D9%8A%D8%A7:%D8%B7%D8%B1%D9%8A%D9%82%D8%A9_%D8%A7%D9%84%D9%83%D8%AA%D8%A7%D8%A8%D9%87">طريقة الكتابه</a></li><li id="n-currentevents" class="mw-list-item"><a href="/wiki/%D9%88%D9%8A%D9%83%D9%8A%D8%A8%D9%8A%D8%AF%D9%8A%D8%A7:%D8%A7%D8%AD%D8%AF%D8%A7%D8%AB_%D8%AF%D9%84%D9%88%D9%82%D8%AA%D9%89" title="شوف معلومات على الاحداث اللى بتحصل دلوقتى">احداث دلوقتى</a></li> </ul> </div> </div> </div> </div> </div> </div> </nav> <a href="/wiki/%D8%A7%D9%84%D8%B5%D9%81%D8%AD%D9%87_%D8%A7%D9%84%D8%B1%D8%A6%D9%8A%D8%B3%D9%8A%D9%87" 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="ويكيبيديا" src="/static/images/mobile/copyright/wikipedia-wordmark-ar.svg" style="width: 7.125em; height: 2em;"> <img class="mw-logo-tagline" alt="" src="/static/images/mobile/copyright/wikipedia-tagline-arz.svg" width="66" height="11" style="width: 4.125em; height: 0.6875em;"> </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/%D8%AE%D8%A7%D8%B5:%D8%AA%D8%AF%D9%88%D9%8A%D8%B1" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only search-toggle" title="دور فى ويكيبيديا [f]" accesskey="f"> تدوير </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="تدوير ويكيبيديا" aria-label="تدوير ويكيبيديا" autocapitalize="sentences" title="دور فى ويكيبيديا [f]" accesskey="f" id="searchInput" > </div> <input type="hidden" name="title" value="خاص:تدوير"> </div> <button class="cdx-button cdx-search-input__end-button">تدوير</button> </form> </div> </div> </div> <nav class="vector-user-links vector-user-links-wide" aria-label="ادوات شخصيه"> <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="المظهر"> <div id="vector-appearance-dropdown" class="vector-dropdown " title="تغيير مظهر الصفحة، حجم الخط، العرض واللون" > <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="المظهر" > <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" > المظهر </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_arz.wikipedia.org&uselang=arz" class="">التبرعات</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=%D8%AE%D8%A7%D8%B5:%D8%A7%D8%A8%D8%AA%D8%AF%D9%89_%D8%AD%D8%B3%D8%A7%D8%A8&returnto=%D9%88%D8%AD%D8%AF%D8%A9%3A%D8%AA%D9%88%D8%AB%D9%8A%D9%82" title="نشجعك على عمل حساب وتسجيل دخولك; لكنه مش ضروري" class="">افتح حساب</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=%D8%AE%D8%A7%D8%B5:%D8%AF%D8%AE%D9%88%D9%84_%D8%A7%D9%84%D9%8A%D9%88%D8%B2%D8%B1&returnto=%D9%88%D8%AD%D8%AF%D8%A9%3A%D8%AA%D9%88%D8%AB%D9%8A%D9%82" title="يستحسن تسجل دخولك; لكن, ده مش اجبارى [o]" accesskey="o" class="">دخول</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="المزيد من الخيارات" > <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="ادوات شخصيه" > <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" > ادوات شخصيه </label> <div class="vector-dropdown-content"> <div id="p-personal" class="vector-menu mw-portlet mw-portlet-personal" title="قائمة المستخدم" > <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_arz.wikipedia.org&uselang=arz">التبرعات</a></li><li id="pt-contribute" class="mw-list-item"><a href="/wiki/%D8%AE%D8%A7%D8%B5:%D8%B3%D8%A7%D9%87%D9%85"> ساهم</a></li><li id="pt-createaccount" class="user-links-collapsible-item mw-list-item"><a href="/w/index.php?title=%D8%AE%D8%A7%D8%B5:%D8%A7%D8%A8%D8%AA%D8%AF%D9%89_%D8%AD%D8%B3%D8%A7%D8%A8&returnto=%D9%88%D8%AD%D8%AF%D8%A9%3A%D8%AA%D9%88%D8%AB%D9%8A%D9%82" title="نشجعك على عمل حساب وتسجيل دخولك; لكنه مش ضروري"> افتح حساب</a></li><li id="pt-login" class="user-links-collapsible-item mw-list-item"><a href="/w/index.php?title=%D8%AE%D8%A7%D8%B5:%D8%AF%D8%AE%D9%88%D9%84_%D8%A7%D9%84%D9%8A%D9%88%D8%B2%D8%B1&returnto=%D9%88%D8%AD%D8%AF%D8%A9%3A%D8%AA%D9%88%D8%AB%D9%8A%D9%82" title="يستحسن تسجل دخولك; لكن, ده مش اجبارى [o]" accesskey="o"> دخول</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"> صفحات للمحررين الذين سجَّلوا خروجهم <a href="/wiki/%D9%85%D8%B3%D8%A7%D8%B9%D8%AF%D8%A9:%D9%85%D9%82%D8%AF%D9%85%D8%A9" aria-label="تعلَّم المزيد بخصوص التحرير">تعلَّم المزيد</a> </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-anontalk" class="mw-list-item"><a href="/wiki/%D8%AE%D8%A7%D8%B5:%D9%85%D9%86%D8%A7%D9%82%D8%B4%D8%AA%D9%89" title="نقاش حوالين التعديلات من عنوان الأيبى دا [n]" accesskey="n">المناقشة مع عنوان الأيبى دا</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="الموقع"> <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="المحتويات" 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">المحتويات</h2> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-toc.pin">انقل للشريط الجانبي</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-toc.unpin">أخف</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">المقدمة</div> </a> </li> <li id="toc-الاستخدام_في_الوحدات_التانيه" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#الاستخدام_في_الوحدات_التانيه"> <div class="vector-toc-text"> 1 الاستخدام في الوحدات التانيه </div> </a> <ul id="toc-الاستخدام_في_الوحدات_التانيه-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="المحتويات" 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="تبديل عرض جدول المحتويات" > <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" > تبديل عرض جدول المحتويات </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">وحدة:توثيق</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="هذه المقالة تتواجد فقط في هذه اللغة. أضفها إلى اللغات الأخرى." > <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" > أضف لغات </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=arzwiki&page=%D9%88%D8%AD%D8%AF%D8%A9%3A%D8%AA%D9%88%D8%AB%D9%8A%D9%82" title="إضافة وصلات بين اللغات" class="wbc-editpage">ضيف لينكات</a></div> </div> </div> </div> </header> <div class="vector-page-toolbar"> <div class="vector-page-toolbar-container"> <div id="left-navigation"> <nav aria-label="النطاقات"> <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/%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82" title="عرض صفحة الوحدة [c]" accesskey="c">وحدة</a></li><li id="ca-talk" class="new vector-tab-noicon mw-list-item"><a href="/w/index.php?title=%D9%86%D9%82%D8%A7%D8%B4_%D8%A7%D9%84%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82&action=edit&redlink=1" rel="discussion" class="new" title="مناقشة صفحة الموضوع (الصفحه مالهاش وجود) [t]" accesskey="t">مناقشه</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="غيّر لهجة اللغة" > <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="مناظر"> <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/%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82">قرايه</a></li><li id="ca-edit" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82&action=edit" title="عدل الكود المصدري لهذه الصفحة [e]" accesskey="e">مصدر التعديل</a></li><li id="ca-history" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82&action=history" title="نسخ قديمه من الصفحه دى [h]" accesskey="h">استعراض التاريخ</a></li> </ul> </div> </div> </nav> <nav class="vector-page-tools-landmark" aria-label="أدوات الصفحة"> <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="علبة العده" > <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" >علبة العده </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">أدوات</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-page-tools.pin">انقل للشريط الجانبي</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-page-tools.unpin">أخف</button> </div> <div id="p-cactions" class="vector-menu mw-portlet mw-portlet-cactions emptyPortlet vector-has-collapsible-items" title="المزيد من الخيارات" > <div class="vector-menu-heading"> إجراءات </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/%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82">قرايه</a></li><li id="ca-more-edit" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82&action=edit" title="عدل الكود المصدري لهذه الصفحة [e]" accesskey="e">مصدر التعديل</a></li><li id="ca-more-history" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82&action=history">استعراض التاريخ</a></li> </ul> </div> </div> <div id="p-tb" class="vector-menu mw-portlet mw-portlet-tb" > <div class="vector-menu-heading"> عام </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="t-whatlinkshere" class="mw-list-item"><a href="/wiki/%D8%AE%D8%A7%D8%B5:%D8%A7%D9%8A%D9%87_%D8%A8%D9%8A%D9%88%D8%B5%D9%84_%D9%87%D9%86%D8%A7/%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82" title="ليستة كل الصفح اللى بتوصل هنا [j]" accesskey="j">ايه بيوصل هنا</a></li><li id="t-recentchangeslinked" class="mw-list-item"><a href="/wiki/%D8%AE%D8%A7%D8%B5:%D8%A7%D8%AC%D8%AF%D8%AF_%D8%A7%D9%84%D8%AA%D8%BA%D9%8A%D9%8A%D8%B1%D8%A7%D8%AA_%D8%A7%D9%84%D9%84%D9%89_%D9%85%D8%B9%D9%85%D9%88%D9%84_%D9%84%D9%8A%D9%87%D8%A7_%D9%84%D9%8A%D9%86%D9%83/%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82" rel="nofollow" title="اخر التغييرات فى صفح معمول ليها لينك من الصفحه دى [k]" accesskey="k">تعديلات ليها علاقه</a></li><li id="t-upload" class="mw-list-item"><a href="//commons.wikimedia.org/wiki/Special:UploadWizard?uselang=arz" title="ارفع فايلات (upload files) [u]" accesskey="u">ارفع فايل (upload file)</a></li><li id="t-specialpages" class="mw-list-item"><a href="/wiki/%D8%AE%D8%A7%D8%B5:%D8%B5%D9%81%D8%AD_%D9%85%D8%AE%D8%B5%D9%88%D8%B5%D9%87" title="ليستة كل الصفح المخصوصه [q]" accesskey="q">صفح مخصوصه</a></li><li id="t-permalink" class="mw-list-item"><a href="/w/index.php?title=%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82&oldid=10564171" title="لينك دايم للنسخه دى من الصفحه">لينك دايم</a></li><li id="t-info" class="mw-list-item"><a href="/w/index.php?title=%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82&action=info" title="المزيد من المعلومات عن هذه الصفحة">معلومات عن الصفحه</a></li><li id="t-urlshortener" class="mw-list-item"><a href="/w/index.php?title=%D8%AE%D8%A7%D8%B5:%D8%AA%D9%82%D8%B5%D9%8A%D8%B1_%D8%A7%D9%84%D9%85%D8%B3%D8%A7%D8%B1&url=https%3A%2F%2Farz.wikipedia.org%2Fwiki%2F%25D9%2588%25D8%25AD%25D8%25AF%25D8%25A9%3A%25D8%25AA%25D9%2588%25D8%25AB%25D9%258A%25D9%2582">احصل على مسار مختصر</a></li><li id="t-urlshortener-qrcode" class="mw-list-item"><a href="/w/index.php?title=%D8%AE%D8%A7%D8%B5:QrCode&url=https%3A%2F%2Farz.wikipedia.org%2Fwiki%2F%25D9%2588%25D8%25AD%25D8%25AF%25D8%25A9%3A%25D8%25AA%25D9%2588%25D8%25AB%25D9%258A%25D9%2582">تنزيل رمز الاستجابة السريعة</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"> طباعة/تصدير </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=%D8%AE%D8%A7%D8%B5:DownloadAsPdf&page=%D9%88%D8%AD%D8%AF%D8%A9%3A%D8%AA%D9%88%D8%AB%D9%8A%D9%82&action=show-download-screen">تحميل بصيغة المستندات المنقولة</a></li><li id="t-print" class="mw-list-item"><a href="javascript:print();" rel="alternate" title="نسخه تنفع تتطبع للصفحه دى [p]" accesskey="p">نسخه للطبع</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"> مشاريع تانيه </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="أدوات الصفحة"> <div id="vector-page-tools-pinned-container" class="vector-pinned-container"> </div> </nav> <nav class="vector-appearance-landmark" aria-label="المظهر"> <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">المظهر</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-appearance.pin">انقل للشريط الجانبي</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-appearance.unpin">أخف</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">من ويكيبيديا، الموسوعه الحره</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-rtl mw-parser-output" lang="arz" dir="rtl">تعرض هذه الوحدة مربع أزرق يحتوي صفحاات توثيق وثائق ل <a href="/w/index.php?title=%D9%88%D8%A8:%D9%82%D9%88%D8%A7%D9%84%D8%A8&action=edit&redlink=1" class="new" title="وب:قوالب (الصفحه مالهاش وجود)">القوالب</a>، و <a href="/w/index.php?title=%D9%88%D8%A8:%D9%88%D8%AD%D8%AF%D8%A9&action=edit&redlink=1" class="new" title="وب:وحدة (الصفحه مالهاش وجود)">وحدات لوا</a>، أو صفحات أخرى، يتم تشغيل الوحدة عادة باستخدام قالب {{<a href="/wiki/%D9%82%D8%A7%D9%84%D8%A8:%D8%AA%D9%88%D8%AB%D9%8A%D9%82" title="قالب:توثيق">توثيق</a>}}. <div class="mw-heading mw-heading2"><h2 id="الاستخدام_في_الوحدات_التانيه">الاستخدام في الوحدات التانيه</h2>[<a href="/w/index.php?title=%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82/%D8%B4%D8%B1%D8%AD&action=edit&section=T-1" title="تعديل جزء : الاستخدام في الوحدات التانيه">تعديل</a>]</div> يمكن استخدام هذه الوحدة من وحدة لوا أخرى، عبر <code>require</code> كالتالي: <div class="mw-highlight mw-highlight-lang-lua mw-content-ltr" dir="ltr"><pre>local documentation = require('Module:توثيق').main </pre></div> ثم يمكنك ببساطة استدعاؤه باستخدام. <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> يرجى الرجوع إلى <a href="/wiki/%D9%82%D8%A7%D9%84%D8%A8:%D8%AA%D9%88%D8%AB%D9%8A%D9%82/%D8%B4%D8%B1%D8%AD" class="mw-redirect" title="قالب:توثيق/شرح">توثيق القالب</a> لتعليمات الاستخدام وقائمة الوسائط. <hr /><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 {{documentation}}. <a href="#L-2"></a> <a href="#L-3"></a>-- Get required modules. <a href="#L-4"></a>local getArgs = require('Module:Arguments').getArgs <a href="#L-5"></a>local messageBox = require('Module:Message box') <a href="#L-6"></a> <a href="#L-7"></a>-- Get the config table. <a href="#L-8"></a>local cfg = mw.loadData('وحدة:توثيق/ضبط') <a href="#L-9"></a> <a href="#L-10"></a>local p = {} <a href="#L-11"></a> <a href="#L-12"></a>-- Often-used functions. <a href="#L-13"></a>local ugsub = mw.ustring.gsub <a href="#L-14"></a> <a href="#L-15"></a>---------------------------------------------------------------------------- <a href="#L-16"></a>-- Helper functions <a href="#L-17"></a>-- <a href="#L-18"></a>-- These are defined as local functions, but are made available in the p <a href="#L-19"></a>-- table for testing purposes. <a href="#L-20"></a>---------------------------------------------------------------------------- <a href="#L-21"></a> <a href="#L-22"></a>local function message(cfgKey, valArray, expectType) <a href="#L-23"></a> --[[ <a href="#L-24"></a> -- Gets a message from the cfg table and formats it if appropriate. <a href="#L-25"></a> -- The function raises an error if the value from the cfg table is not <a href="#L-26"></a> -- of the type expectType. The default type for expectType is 'string'. <a href="#L-27"></a> -- If the table valArray is present, strings such as $1, $2 etc. in the <a href="#L-28"></a> -- message are substituted with values from the table keys [1], [2] etc. <a href="#L-29"></a> -- For example, if the message "foo-message" had the value 'Foo $2 bar $1.', <a href="#L-30"></a> -- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz." <a href="#L-31"></a> --]] <a href="#L-32"></a> local msg = cfg[cfgKey] <a href="#L-33"></a> expectType = expectType or 'string' <a href="#L-34"></a> if type(msg) ~= expectType then <a href="#L-35"></a> error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2) <a href="#L-36"></a> end <a href="#L-37"></a> if not valArray then <a href="#L-38"></a> return msg <a href="#L-39"></a> end <a href="#L-40"></a> <a href="#L-41"></a> local function getMessageVal(match) <a href="#L-42"></a> match = tonumber(match) <a href="#L-43"></a> return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4) <a href="#L-44"></a> end <a href="#L-45"></a> <a href="#L-46"></a> local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal) <a href="#L-47"></a> return ret <a href="#L-48"></a>end <a href="#L-49"></a> <a href="#L-50"></a>p.message = message <a href="#L-51"></a> <a href="#L-52"></a>local function makeWikilink(page, display) <a href="#L-53"></a> if display then <a href="#L-54"></a> return mw.ustring.format('[[%s|%s]]', page, display) <a href="#L-55"></a> else <a href="#L-56"></a> return mw.ustring.format('[[%s]]', page) <a href="#L-57"></a> end <a href="#L-58"></a>end <a href="#L-59"></a> <a href="#L-60"></a>p.makeWikilink = makeWikilink <a href="#L-61"></a> <a href="#L-62"></a>local function makeCategoryLink(cat, sort) <a href="#L-63"></a> local catns = mw.site.namespaces[14].name <a href="#L-64"></a> return makeWikilink(catns .. ':' .. cat, sort) <a href="#L-65"></a>end <a href="#L-66"></a> <a href="#L-67"></a>p.makeCategoryLink = makeCategoryLink <a href="#L-68"></a> <a href="#L-69"></a>local function makeUrlLink(url, display) <a href="#L-70"></a> return mw.ustring.format('[%s %s]', url, display) <a href="#L-71"></a>end <a href="#L-72"></a> <a href="#L-73"></a>p.makeUrlLink = makeUrlLink <a href="#L-74"></a> <a href="#L-75"></a>local function makeToolbar(...) <a href="#L-76"></a> local ret = {} <a href="#L-77"></a> local lim = select('#', ...) <a href="#L-78"></a> if lim < 1 then <a href="#L-79"></a> return nil <a href="#L-80"></a> end <a href="#L-81"></a> for i = 1, lim do <a href="#L-82"></a> ret[#ret + 1] = select(i, ...) <a href="#L-83"></a> end <a href="#L-84"></a> return '(' .. table.concat(ret, ' &#124; ') .. ')' <a href="#L-85"></a>end <a href="#L-86"></a> <a href="#L-87"></a>p.makeToolbar = makeToolbar <a href="#L-88"></a> <a href="#L-89"></a>---------------------------------------------------------------------------- <a href="#L-90"></a>-- Argument processing <a href="#L-91"></a>---------------------------------------------------------------------------- <a href="#L-92"></a> <a href="#L-93"></a>local function makeInvokeFunc(funcName) <a href="#L-94"></a> return function (frame) <a href="#L-95"></a> local args = getArgs(frame, { <a href="#L-96"></a> valueFunc = function (key, value) <a href="#L-97"></a> if type(value) == 'string' then <a href="#L-98"></a> value = value:match('^%s*(.-)%s*$') -- Remove whitespace. <a href="#L-99"></a> if key == 'heading' or value ~= '' then <a href="#L-100"></a> return value <a href="#L-101"></a> else <a href="#L-102"></a> return nil <a href="#L-103"></a> end <a href="#L-104"></a> else <a href="#L-105"></a> return value <a href="#L-106"></a> end <a href="#L-107"></a> end <a href="#L-108"></a> }) <a href="#L-109"></a> return p[funcName](args) <a href="#L-110"></a> end <a href="#L-111"></a>end <a href="#L-112"></a> <a href="#L-113"></a>---------------------------------------------------------------------------- <a href="#L-114"></a>-- Main function <a href="#L-115"></a>---------------------------------------------------------------------------- <a href="#L-116"></a> <a href="#L-117"></a>p.main = makeInvokeFunc('_main') <a href="#L-118"></a> <a href="#L-119"></a>function p._main(args) <a href="#L-120"></a> --[[ <a href="#L-121"></a> -- This function defines logic flow for the module. <a href="#L-122"></a> -- @args - table of arguments passed by the user <a href="#L-123"></a> -- <a href="#L-124"></a> -- Messages: <a href="#L-125"></a> -- 'main-div-id' --> 'template-documentation' <a href="#L-126"></a> -- 'main-div-classes' --> 'template-documentation iezoomfix' <a href="#L-127"></a> --]] <a href="#L-128"></a> local env = p.getEnvironment(args) <a href="#L-129"></a> local root = mw.html.create() <a href="#L-130"></a> root <a href="#L-131"></a> :wikitext(p.protectionTemplate(env)) <a href="#L-132"></a> :wikitext(p.sandboxNotice(args, env)) <a href="#L-133"></a> -- This div tag is from {{documentation/start box}}, but moving it here <a href="#L-134"></a> -- so that we don't have to worry about unclosed tags. <a href="#L-135"></a> :tag('div') <a href="#L-136"></a> :attr('id', message('main-div-id')) <a href="#L-137"></a> :addClass(message('main-div-classes')) <a href="#L-138"></a> :newline() <a href="#L-139"></a> :wikitext(p._startBox(args, env)) <a href="#L-140"></a> :wikitext(p._content(args, env)) <a href="#L-141"></a> :tag('div') <a href="#L-142"></a> :css('clear', 'both') -- So right or left floating items don't stick out of the doc box. <a href="#L-143"></a> :newline() <a href="#L-144"></a> :done() <a href="#L-145"></a> :done() <a href="#L-146"></a> :wikitext(p._endBox(args, env)) <a href="#L-147"></a> :wikitext(p.addTrackingCategories(env)) <a href="#L-148"></a> return tostring(root) <a href="#L-149"></a>end <a href="#L-150"></a> <a href="#L-151"></a>---------------------------------------------------------------------------- <a href="#L-152"></a>-- Environment settings <a href="#L-153"></a>---------------------------------------------------------------------------- <a href="#L-154"></a> <a href="#L-155"></a>function p.getEnvironment(args) <a href="#L-156"></a> --[[ <a href="#L-157"></a> -- Returns a table with information about the environment, including title objects and other namespace- or <a href="#L-158"></a> -- path-related data. <a href="#L-159"></a> -- @args - table of arguments passed by the user <a href="#L-160"></a> -- <a href="#L-161"></a> -- Title objects include: <a href="#L-162"></a> -- env.title - the page we are making documentation for (usually the current title) <a href="#L-163"></a> -- env.templateTitle - the template (or module, file, etc.) <a href="#L-164"></a> -- env.docTitle - the /doc subpage. <a href="#L-165"></a> -- env.sandboxTitle - the /sandbox subpage. <a href="#L-166"></a> -- env.testcasesTitle - the /testcases subpage. <a href="#L-167"></a> -- env.printTitle - the print version of the template, located at the /Print subpage. <a href="#L-168"></a> -- <a href="#L-169"></a> -- Data includes: <a href="#L-170"></a> -- env.protectionLevels - the protection levels table of the title object. <a href="#L-171"></a> -- env.subjectSpace - the number of the title's subject namespace. <a href="#L-172"></a> -- env.docSpace - the number of the namespace the title puts its documentation in. <a href="#L-173"></a> -- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace. <a href="#L-174"></a> -- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template. <a href="#L-175"></a> -- <a href="#L-176"></a> -- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value <a href="#L-177"></a> -- returned will be nil. <a href="#L-178"></a> --]] <a href="#L-179"></a> <a href="#L-180"></a> local env, envFuncs = {}, {} <a href="#L-181"></a> <a href="#L-182"></a> -- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value <a href="#L-183"></a> -- returned by that function is memoized in the env table so that we don't call any of the functions <a href="#L-184"></a> -- more than once. (Nils won't be memoized.) <a href="#L-185"></a> setmetatable(env, { <a href="#L-186"></a> __index = function (t, key) <a href="#L-187"></a> local envFunc = envFuncs[key] <a href="#L-188"></a> if envFunc then <a href="#L-189"></a> local success, val = pcall(envFunc) <a href="#L-190"></a> if success then <a href="#L-191"></a> env[key] = val -- Memoise the value. <a href="#L-192"></a> return val <a href="#L-193"></a> end <a href="#L-194"></a> end <a href="#L-195"></a> return nil <a href="#L-196"></a> end <a href="#L-197"></a> }) <a href="#L-198"></a> <a href="#L-199"></a> function envFuncs.title() <a href="#L-200"></a> -- The title object for the current page, or a test page passed with args.page. <a href="#L-201"></a> local title <a href="#L-202"></a> local titleArg = args.page <a href="#L-203"></a> if titleArg then <a href="#L-204"></a> title = mw.title.new(titleArg) <a href="#L-205"></a> else <a href="#L-206"></a> title = mw.title.getCurrentTitle() <a href="#L-207"></a> end <a href="#L-208"></a> return title <a href="#L-209"></a> end <a href="#L-210"></a> <a href="#L-211"></a> function envFuncs.templateTitle() <a href="#L-212"></a> --[[ <a href="#L-213"></a> -- The template (or module, etc.) title object. <a href="#L-214"></a> -- Messages: <a href="#L-215"></a> -- 'sandbox-subpage' --> 'sandbox' <a href="#L-216"></a> -- 'testcases-subpage' --> 'testcases' <a href="#L-217"></a> --]] <a href="#L-218"></a> local subjectSpace = env.subjectSpace <a href="#L-219"></a> local title = env.title <a href="#L-220"></a> local subpage = title.subpageText <a href="#L-221"></a> if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then <a href="#L-222"></a> return mw.title.makeTitle(subjectSpace, title.baseText) <a href="#L-223"></a> else <a href="#L-224"></a> return mw.title.makeTitle(subjectSpace, title.text) <a href="#L-225"></a> end <a href="#L-226"></a> end <a href="#L-227"></a> <a href="#L-228"></a> function envFuncs.docTitle() <a href="#L-229"></a> --[[ <a href="#L-230"></a> -- Title object of the /doc subpage. <a href="#L-231"></a> -- Messages: <a href="#L-232"></a> -- 'doc-subpage' --> 'doc' <a href="#L-233"></a> --]] <a href="#L-234"></a> local title = env.title <a href="#L-235"></a> local docname = args[1] -- User-specified doc page. <a href="#L-236"></a> local docpage <a href="#L-237"></a> if docname then <a href="#L-238"></a> docpage = docname <a href="#L-239"></a> else <a href="#L-240"></a> docpage = env.docpageBase .. '/' .. message('doc-subpage') <a href="#L-241"></a> end <a href="#L-242"></a> return mw.title.new(docpage) <a href="#L-243"></a> end <a href="#L-244"></a> <a href="#L-245"></a> function envFuncs.sandboxTitle() <a href="#L-246"></a> --[[ <a href="#L-247"></a> -- Title object for the /sandbox subpage. <a href="#L-248"></a> -- Messages: <a href="#L-249"></a> -- 'sandbox-subpage' --> 'sandbox' <a href="#L-250"></a> --]] <a href="#L-251"></a> return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage')) <a href="#L-252"></a> end <a href="#L-253"></a> <a href="#L-254"></a> function envFuncs.testcasesTitle() <a href="#L-255"></a> --[[ <a href="#L-256"></a> -- Title object for the /testcases subpage. <a href="#L-257"></a> -- Messages: <a href="#L-258"></a> -- 'testcases-subpage' --> 'testcases' <a href="#L-259"></a> --]] <a href="#L-260"></a> return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage')) <a href="#L-261"></a> end <a href="#L-262"></a> <a href="#L-263"></a> function envFuncs.printTitle() <a href="#L-264"></a> --[[ <a href="#L-265"></a> -- Title object for the /Print subpage. <a href="#L-266"></a> -- Messages: <a href="#L-267"></a> -- 'print-subpage' --> 'Print' <a href="#L-268"></a> --]] <a href="#L-269"></a> return env.templateTitle:subPageTitle(message('print-subpage')) <a href="#L-270"></a> end <a href="#L-271"></a> <a href="#L-272"></a> function envFuncs.protectionLevels() <a href="#L-273"></a> -- The protection levels table of the title object. <a href="#L-274"></a> return env.title.protectionLevels <a href="#L-275"></a> end <a href="#L-276"></a> <a href="#L-277"></a> function envFuncs.subjectSpace() <a href="#L-278"></a> -- The subject namespace number. <a href="#L-279"></a> return mw.site.namespaces[env.title.namespace].subject.id <a href="#L-280"></a> end <a href="#L-281"></a> <a href="#L-282"></a> function envFuncs.docSpace() <a href="#L-283"></a> -- The documentation namespace number. For most namespaces this is the same as the <a href="#L-284"></a> -- subject namespace. However, pages in the Article, File, MediaWiki or Category <a href="#L-285"></a> -- namespaces must have their /doc, /sandbox and /testcases pages in talk space. <a href="#L-286"></a> local subjectSpace = env.subjectSpace <a href="#L-287"></a> if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then <a href="#L-288"></a> return subjectSpace + 1 <a href="#L-289"></a> else <a href="#L-290"></a> return subjectSpace <a href="#L-291"></a> end <a href="#L-292"></a> end <a href="#L-293"></a> <a href="#L-294"></a> function envFuncs.docpageBase() <a href="#L-295"></a> -- The base page of the /doc, /sandbox, and /testcases subpages. <a href="#L-296"></a> -- For some namespaces this is the talk page, rather than the template page. <a href="#L-297"></a> local templateTitle = env.templateTitle <a href="#L-298"></a> local docSpace = env.docSpace <a href="#L-299"></a> local docSpaceText = mw.site.namespaces[docSpace].name <a href="#L-300"></a> -- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon. <a href="#L-301"></a> return docSpaceText .. ':' .. templateTitle.text <a href="#L-302"></a> end <a href="#L-303"></a> <a href="#L-304"></a> function envFuncs.compareUrl() <a href="#L-305"></a> -- Diff link between the sandbox and the main template using [[Special:ComparePages]]. <a href="#L-306"></a> local templateTitle = env.templateTitle <a href="#L-307"></a> local sandboxTitle = env.sandboxTitle <a href="#L-308"></a> if templateTitle.exists and sandboxTitle.exists then <a href="#L-309"></a> local compareUrl = mw.uri.fullUrl( <a href="#L-310"></a> 'Special:ComparePages', <a href="#L-311"></a> {page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText} <a href="#L-312"></a> ) <a href="#L-313"></a> return tostring(compareUrl) <a href="#L-314"></a> else <a href="#L-315"></a> return nil <a href="#L-316"></a> end <a href="#L-317"></a> end <a href="#L-318"></a> <a href="#L-319"></a> return env <a href="#L-320"></a>end <a href="#L-321"></a> <a href="#L-322"></a>---------------------------------------------------------------------------- <a href="#L-323"></a>-- Auxiliary templates <a href="#L-324"></a>---------------------------------------------------------------------------- <a href="#L-325"></a> <a href="#L-326"></a>function p.sandboxNotice(args, env) <a href="#L-327"></a> --[=[ <a href="#L-328"></a> -- Generates a sandbox notice for display above sandbox pages. <a href="#L-329"></a> -- @args - a table of arguments passed by the user <a href="#L-330"></a> -- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-331"></a> -- <a href="#L-332"></a> -- Messages: <a href="#L-333"></a> -- 'sandbox-notice-image' --> '[[ملف:Sandbox - OpenClipart.svg|50px|alt=|link=]]' <a href="#L-334"></a> -- 'sandbox-notice-blurb' --> 'This is the $1 for $2.' <a href="#L-335"></a> -- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).' <a href="#L-336"></a> -- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page' <a href="#L-337"></a> -- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page' <a href="#L-338"></a> -- 'sandbox-notice-pagetype-other' --> 'sandbox page' <a href="#L-339"></a> -- 'sandbox-notice-compare-link-display' --> 'diff' <a href="#L-340"></a> -- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.' <a href="#L-341"></a> -- 'sandbox-notice-testcases-link-display' --> 'test cases' <a href="#L-342"></a> -- 'sandbox-category' --> 'Template sandboxes' <a href="#L-343"></a> --]=] <a href="#L-344"></a> local title = env.title <a href="#L-345"></a> local sandboxTitle = env.sandboxTitle <a href="#L-346"></a> local templateTitle = env.templateTitle <a href="#L-347"></a> local subjectSpace = env.subjectSpace <a href="#L-348"></a> if not (subjectSpace and title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then <a href="#L-349"></a> return nil <a href="#L-350"></a> end <a href="#L-351"></a> -- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text". <a href="#L-352"></a> local omargs = {} <a href="#L-353"></a> omargs.image = message('sandbox-notice-image') <a href="#L-354"></a> -- Get the text. We start with the opening blurb, which is something like <a href="#L-355"></a> -- "This is the template sandbox for [[قالب:Foo]] (diff)." <a href="#L-356"></a> local text = '' <a href="#L-357"></a> local pagetype <a href="#L-358"></a> if subjectSpace == 10 then <a href="#L-359"></a> pagetype = message('sandbox-notice-pagetype-template') <a href="#L-360"></a> elseif subjectSpace == 828 then <a href="#L-361"></a> pagetype = message('sandbox-notice-pagetype-module') <a href="#L-362"></a> else <a href="#L-363"></a> pagetype = message('sandbox-notice-pagetype-other') <a href="#L-364"></a> end <a href="#L-365"></a> local templateLink = makeWikilink(templateTitle.prefixedText) <a href="#L-366"></a> local compareUrl = env.compareUrl <a href="#L-367"></a> if compareUrl then <a href="#L-368"></a> local compareDisplay = message('sandbox-notice-compare-link-display') <a href="#L-369"></a> local compareLink = makeUrlLink(compareUrl, compareDisplay) <a href="#L-370"></a> text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink}) <a href="#L-371"></a> else <a href="#L-372"></a> text = text .. message('sandbox-notice-blurb', {pagetype, templateLink}) <a href="#L-373"></a> end <a href="#L-374"></a> -- Get the test cases page blurb if the page exists. This is something like <a href="#L-375"></a> -- "See also the companion subpage for [[قالب:Foo/testcases|test cases]]." <a href="#L-376"></a> local testcasesTitle = env.testcasesTitle <a href="#L-377"></a> if testcasesTitle and testcasesTitle.exists then <a href="#L-378"></a> if testcasesTitle.namespace == mw.site.namespaces.Module.id then <a href="#L-379"></a> local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display') <a href="#L-380"></a> local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display') <a href="#L-381"></a> local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay) <a href="#L-382"></a> local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay) <a href="#L-383"></a> text = text .. ' ' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink}) <a href="#L-384"></a> else <a href="#L-385"></a> local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display') <a href="#L-386"></a> local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay) <a href="#L-387"></a> text = text .. ' ' .. message('sandbox-notice-testcases-blurb', {testcasesLink}) <a href="#L-388"></a> end <a href="#L-389"></a> end <a href="#L-390"></a> -- Add the sandbox to the sandbox category. <a href="#L-391"></a> text = text .. makeCategoryLink(message('sandbox-category')) <a href="#L-392"></a> omargs.text = text <a href="#L-393"></a> local ret = '<div style="clear: both;"></div>' <a href="#L-394"></a> ret = ret .. messageBox.main('ombox', omargs) <a href="#L-395"></a> return ret <a href="#L-396"></a>end <a href="#L-397"></a> <a href="#L-398"></a>function p.protectionTemplate(env) <a href="#L-399"></a> -- Generates the padlock icon in the top right. <a href="#L-400"></a> -- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-401"></a> -- Messages: <a href="#L-402"></a> -- 'protection-template' --> 'pp-template' <a href="#L-403"></a> -- 'protection-template-args' --> {docusage = 'yes'} <a href="#L-404"></a> local protectionLevels, mProtectionBanner <a href="#L-405"></a> local title = env.title <a href="#L-406"></a> protectionLevels = env.protectionLevels <a href="#L-407"></a> if not protectionLevels then <a href="#L-408"></a> return nil <a href="#L-409"></a> end <a href="#L-410"></a> local editProt = protectionLevels.edit and protectionLevels.edit[1] <a href="#L-411"></a> local moveProt = protectionLevels.move and protectionLevels.move[1] <a href="#L-412"></a> if editProt then <a href="#L-413"></a> -- The page is edit-protected. <a href="#L-414"></a> mProtectionBanner = require('Module:Protection banner') <a href="#L-415"></a> local reason = message('protection-reason-edit') <a href="#L-416"></a> return mProtectionBanner._main{reason, small = true} <a href="#L-417"></a> elseif moveProt and moveProt ~= 'autoconfirmed' then <a href="#L-418"></a> -- The page is move-protected but not edit-protected. Exclude move <a href="#L-419"></a> -- protection with the level "autoconfirmed", as this is equivalent to <a href="#L-420"></a> -- no move protection at all. <a href="#L-421"></a> mProtectionBanner = require('Module:Protection banner') <a href="#L-422"></a> return mProtectionBanner._main{action = 'move', small = true} <a href="#L-423"></a> else <a href="#L-424"></a> return nil <a href="#L-425"></a> end <a href="#L-426"></a>end <a href="#L-427"></a> <a href="#L-428"></a>---------------------------------------------------------------------------- <a href="#L-429"></a>-- Start box <a href="#L-430"></a>---------------------------------------------------------------------------- <a href="#L-431"></a> <a href="#L-432"></a>p.startBox = makeInvokeFunc('_startBox') <a href="#L-433"></a> <a href="#L-434"></a>function p._startBox(args, env) <a href="#L-435"></a> --[[ <a href="#L-436"></a> -- This function generates the start box. <a href="#L-437"></a> -- @args - a table of arguments passed by the user <a href="#L-438"></a> -- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-439"></a> -- <a href="#L-440"></a> -- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make <a href="#L-441"></a> -- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox <a href="#L-442"></a> -- which generate the box HTML. <a href="#L-443"></a> --]] <a href="#L-444"></a> env = env or p.getEnvironment(args) <a href="#L-445"></a> local links <a href="#L-446"></a> local content = args.content <a href="#L-447"></a> if not content then <a href="#L-448"></a> -- No need to include the links if the documentation is on the template page itself. <a href="#L-449"></a> local linksData = p.makeStartBoxLinksData(args, env) <a href="#L-450"></a> if linksData then <a href="#L-451"></a> links = p.renderStartBoxLinks(linksData) <a href="#L-452"></a> end <a href="#L-453"></a> end <a href="#L-454"></a> -- Generate the start box html. <a href="#L-455"></a> local data = p.makeStartBoxData(args, env, links) <a href="#L-456"></a> if data then <a href="#L-457"></a> return p.renderStartBox(data) <a href="#L-458"></a> else <a href="#L-459"></a> -- User specified no heading. <a href="#L-460"></a> return nil <a href="#L-461"></a> end <a href="#L-462"></a>end <a href="#L-463"></a> <a href="#L-464"></a>function p.makeStartBoxLinksData(args, env) <a href="#L-465"></a> --[[ <a href="#L-466"></a> -- Does initial processing of data to make the [view] [edit] [history] [purge] links. <a href="#L-467"></a> -- @args - a table of arguments passed by the user <a href="#L-468"></a> -- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-469"></a> -- <a href="#L-470"></a> -- Messages: <a href="#L-471"></a> -- 'view-link-display' --> 'view' <a href="#L-472"></a> -- 'edit-link-display' --> 'edit' <a href="#L-473"></a> -- 'history-link-display' --> 'history' <a href="#L-474"></a> -- 'purge-link-display' --> 'purge' <a href="#L-475"></a> -- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace' <a href="#L-476"></a> -- 'module-preload' --> 'Template:Documentation/preload-module-doc' <a href="#L-477"></a> -- 'docpage-preload' --> 'Template:Documentation/preload' <a href="#L-478"></a> -- 'create-link-display' --> 'create' <a href="#L-479"></a> --]] <a href="#L-480"></a> local subjectSpace = env.subjectSpace <a href="#L-481"></a> local title = env.title <a href="#L-482"></a> local docTitle = env.docTitle <a href="#L-483"></a> if not title or not docTitle then <a href="#L-484"></a> return nil <a href="#L-485"></a> end <a href="#L-486"></a> <a href="#L-487"></a> local data = {} <a href="#L-488"></a> data.title = title <a href="#L-489"></a> data.docTitle = docTitle <a href="#L-490"></a> -- View, display, edit, and purge links if /doc exists. <a href="#L-491"></a> data.viewLinkDisplay = message('view-link-display') <a href="#L-492"></a> data.editLinkDisplay = message('edit-link-display') <a href="#L-493"></a> data.historyLinkDisplay = message('history-link-display') <a href="#L-494"></a> data.purgeLinkDisplay = message('purge-link-display') <a href="#L-495"></a> data.usageLinkDisplay = message('usage-link-display') <a href="#L-496"></a> data.TemplateUsage = message('template-usage') <a href="#L-497"></a> -- Create link if /doc doesn't exist. <a href="#L-498"></a> local preload = args.preload <a href="#L-499"></a> if not preload then <a href="#L-500"></a> if subjectSpace == 6 then -- File namespace <a href="#L-501"></a> preload = message('file-docpage-preload') <a href="#L-502"></a> elseif subjectSpace == 828 then -- Module namespace <a href="#L-503"></a> preload = message('module-preload') <a href="#L-504"></a> else <a href="#L-505"></a> preload = message('docpage-preload') <a href="#L-506"></a> end <a href="#L-507"></a> end <a href="#L-508"></a> data.preload = preload <a href="#L-509"></a> data.createLinkDisplay = message('create-link-display') <a href="#L-510"></a> return data <a href="#L-511"></a>end <a href="#L-512"></a> <a href="#L-513"></a>function p.renderStartBoxLinks(data) <a href="#L-514"></a> --[[ <a href="#L-515"></a> -- Generates the [view][edit][history][purge] or [create] links from the data table. <a href="#L-516"></a> -- @data - a table of data generated by p.makeStartBoxLinksData <a href="#L-517"></a> --]] <a href="#L-518"></a> <a href="#L-519"></a> local function escapeBrackets(s) <a href="#L-520"></a> -- Escapes square brackets with HTML entities. <a href="#L-521"></a> s = s:gsub('%[', '&#91;') -- Replace square brackets with HTML entities. <a href="#L-522"></a> s = s:gsub('%]', '&#93;') <a href="#L-523"></a> return s <a href="#L-524"></a> end <a href="#L-525"></a> <a href="#L-526"></a> local ret <a href="#L-527"></a> local docTitle = data.docTitle <a href="#L-528"></a> local title = data.title <a href="#L-529"></a> --mw.log(title.text ) <a href="#L-530"></a> local usageUrl = "http://tools.wmflabs.org/templatecount/index.php?lang=ar&namespace=" .. title.namespace .. "&name=" .. mw.uri.encode( title.text , 'PATH') <a href="#L-531"></a> local usageLink = makeUrlLink(usageUrl , data.usageLinkDisplay) <a href="#L-532"></a> local templates_use_module = "//ar.wikipedia.org/w/index.php?title=خاص:بحث&fulltext=Search&ns10=1&search=insource%3A%2F(invoke%7Cاستدعاء)%3A" .. mw.uri.encode( title.text , 'PATH') .. "%5C%7C%2F" <a href="#L-533"></a> local usageLink = makeUrlLink(usageUrl , data.usageLinkDisplay) <a href="#L-534"></a> local templates_use_moduleLink = makeUrlLink(templates_use_module , data.TemplateUsage) <a href="#L-535"></a> if docTitle.exists then <a href="#L-536"></a> local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay) <a href="#L-537"></a> local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay) <a href="#L-538"></a> local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay) <a href="#L-539"></a> local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay) <a href="#L-540"></a> ret = '[%s] [%s] [%s] [%s] [%s]' <a href="#L-541"></a> ret = escapeBrackets(ret) <a href="#L-542"></a> ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink , usageLink) <a href="#L-543"></a> if title.namespace == 828 then <a href="#L-544"></a> ret = '[%s] [%s] [%s] [%s] [%s] [%s]' <a href="#L-545"></a> ret = escapeBrackets(ret) <a href="#L-546"></a> ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink , usageLink , templates_use_moduleLink) <a href="#L-547"></a> end <a href="#L-548"></a> else <a href="#L-549"></a> local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay) <a href="#L-550"></a> ret = '[%s] [%s]' <a href="#L-551"></a> ret = escapeBrackets(ret) <a href="#L-552"></a> ret = mw.ustring.format(ret, createLink , usageLink) <a href="#L-553"></a> if title.namespace == 828 then <a href="#L-554"></a> ret = '[%s] [%s] [%s]' <a href="#L-555"></a> ret = escapeBrackets(ret) <a href="#L-556"></a> ret = mw.ustring.format(ret, createLink , usageLink, templates_use_moduleLink) <a href="#L-557"></a> end <a href="#L-558"></a> end <a href="#L-559"></a> return ret <a href="#L-560"></a>end <a href="#L-561"></a> <a href="#L-562"></a>function p.makeStartBoxData(args, env, links) <a href="#L-563"></a> --[=[ <a href="#L-564"></a> -- Does initial processing of data to pass to the start-box render function, p.renderStartBox. <a href="#L-565"></a> -- @args - a table of arguments passed by the user <a href="#L-566"></a> -- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-567"></a> -- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error. <a href="#L-568"></a> -- <a href="#L-569"></a> -- Messages: <a href="#L-570"></a> -- 'documentation-icon-wikitext' --> '[[ملف:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]' <a href="#L-571"></a> -- 'template-namespace-heading' --> 'Template documentation' <a href="#L-572"></a> -- 'module-namespace-heading' --> 'Module documentation' <a href="#L-573"></a> -- 'file-namespace-heading' --> 'Summary' <a href="#L-574"></a> -- 'other-namespaces-heading' --> 'Documentation' <a href="#L-575"></a> -- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks' <a href="#L-576"></a> -- 'start-box-link-id' --> 'doc_editlinks' <a href="#L-577"></a> -- 'testcases-create-link-display' --> 'create' <a href="#L-578"></a> --]=] <a href="#L-579"></a> local subjectSpace = env.subjectSpace <a href="#L-580"></a> if not subjectSpace then <a href="#L-581"></a> -- Default to an "other namespaces" namespace, so that we get at least some output <a href="#L-582"></a> -- if an error occurs. <a href="#L-583"></a> subjectSpace = 2 <a href="#L-584"></a> end <a href="#L-585"></a> local data = {} <a href="#L-586"></a> <a href="#L-587"></a> -- Heading <a href="#L-588"></a> local heading = args.heading -- Blank values are not removed. <a href="#L-589"></a> if heading == '' then <a href="#L-590"></a> -- Don't display the start box if the heading arg is defined but blank. <a href="#L-591"></a> return nil <a href="#L-592"></a> end <a href="#L-593"></a> if heading then <a href="#L-594"></a> data.heading = heading <a href="#L-595"></a> elseif subjectSpace == 10 then -- Template namespace <a href="#L-596"></a> data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading') <a href="#L-597"></a> elseif subjectSpace == 828 then -- Module namespace <a href="#L-598"></a> data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading') <a href="#L-599"></a> elseif subjectSpace == 6 then -- File namespace <a href="#L-600"></a> data.heading = message('file-namespace-heading') <a href="#L-601"></a> else <a href="#L-602"></a> data.heading = message('other-namespaces-heading') <a href="#L-603"></a> end <a href="#L-604"></a> <a href="#L-605"></a> -- Heading CSS <a href="#L-606"></a> local headingStyle = args['heading-style'] <a href="#L-607"></a> if headingStyle then <a href="#L-608"></a> data.headingStyleText = headingStyle <a href="#L-609"></a> elseif subjectSpace == 10 then <a href="#L-610"></a> -- We are in the template or template talk namespaces. <a href="#L-611"></a> data.headingFontWeight = 'bold' <a href="#L-612"></a> data.headingFontSize = '125%' <a href="#L-613"></a> else <a href="#L-614"></a> data.headingFontSize = '150%' <a href="#L-615"></a> end <a href="#L-616"></a> <a href="#L-617"></a> -- Data for the [view][edit][history][purge] or [create] links. <a href="#L-618"></a> if links then <a href="#L-619"></a> data.linksClass = message('start-box-linkclasses') <a href="#L-620"></a> data.linksId = message('start-box-link-id') <a href="#L-621"></a> data.links = links <a href="#L-622"></a> end <a href="#L-623"></a> <a href="#L-624"></a> return data <a href="#L-625"></a>end <a href="#L-626"></a> <a href="#L-627"></a>function p.renderStartBox(data) <a href="#L-628"></a> -- Renders the start box html. <a href="#L-629"></a> -- @data - a table of data generated by p.makeStartBoxData. <a href="#L-630"></a> local sbox = mw.html.create('div') <a href="#L-631"></a> sbox <a href="#L-632"></a> :css('padding-bottom', '3px') <a href="#L-633"></a> :css('border-bottom', '1px solid #aaa') <a href="#L-634"></a> :css('margin-bottom', '1ex') <a href="#L-635"></a> :newline() <a href="#L-636"></a> :tag('span') <a href="#L-637"></a> :cssText(data.headingStyleText) <a href="#L-638"></a> :css('font-weight', data.headingFontWeight) <a href="#L-639"></a> :css('font-size', data.headingFontSize) <a href="#L-640"></a> :wikitext(data.heading) <a href="#L-641"></a> local links = data.links <a href="#L-642"></a> if links then <a href="#L-643"></a> sbox:tag('span') <a href="#L-644"></a> :addClass(data.linksClass) <a href="#L-645"></a> :attr('id', data.linksId) <a href="#L-646"></a> :wikitext(links) <a href="#L-647"></a> end <a href="#L-648"></a> return tostring(sbox) <a href="#L-649"></a>end <a href="#L-650"></a> <a href="#L-651"></a>---------------------------------------------------------------------------- <a href="#L-652"></a>-- Documentation content <a href="#L-653"></a>---------------------------------------------------------------------------- <a href="#L-654"></a> <a href="#L-655"></a>p.content = makeInvokeFunc('_content') <a href="#L-656"></a> <a href="#L-657"></a>function p._content(args, env) <a href="#L-658"></a> -- Displays the documentation contents <a href="#L-659"></a> -- @args - a table of arguments passed by the user <a href="#L-660"></a> -- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-661"></a> env = env or p.getEnvironment(args) <a href="#L-662"></a> local docTitle = env.docTitle <a href="#L-663"></a> local content = args.content or args["محتوى"] <a href="#L-664"></a> if not content and docTitle and docTitle.exists then <a href="#L-665"></a> content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText} <a href="#L-666"></a> end <a href="#L-667"></a> if not content or content == "" then <a href="#L-668"></a> --mw.log("no content " .. docTitle.namespace) <a href="#L-669"></a> if docTitle.namespace == 10 then -- only on template <a href="#L-670"></a> content = mw.getCurrentFrame():expandTemplate{title = "قالب:توثيق/تلقائي", args = {lab = "1" }} <a href="#L-671"></a> end <a href="#L-672"></a> end <a href="#L-673"></a> -- The line breaks below are necessary so that "=== Headings ===" at the start and end <a href="#L-674"></a> -- of docs are interpreted correctly. <a href="#L-675"></a> return '\n' .. (content or '') .. '\n' <a href="#L-676"></a>end <a href="#L-677"></a> <a href="#L-678"></a>p.contentTitle = makeInvokeFunc('_contentTitle') <a href="#L-679"></a> <a href="#L-680"></a>function p._contentTitle(args, env) <a href="#L-681"></a> env = env or p.getEnvironment(args) <a href="#L-682"></a> local docTitle = env.docTitle <a href="#L-683"></a> if not args.content and docTitle and docTitle.exists then <a href="#L-684"></a> return docTitle.prefixedText <a href="#L-685"></a> else <a href="#L-686"></a> return '' <a href="#L-687"></a> end <a href="#L-688"></a>end <a href="#L-689"></a> <a href="#L-690"></a>---------------------------------------------------------------------------- <a href="#L-691"></a>-- End box <a href="#L-692"></a>---------------------------------------------------------------------------- <a href="#L-693"></a> <a href="#L-694"></a>p.endBox = makeInvokeFunc('_endBox') <a href="#L-695"></a> <a href="#L-696"></a>function p._endBox(args, env) <a href="#L-697"></a> --[=[ <a href="#L-698"></a> -- This function generates the end box (also known as the link box). <a href="#L-699"></a> -- @args - a table of arguments passed by the user <a href="#L-700"></a> -- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-701"></a> -- <a href="#L-702"></a> -- Messages: <a href="#L-703"></a> -- 'fmbox-id' --> 'documentation-meta-data' <a href="#L-704"></a> -- 'fmbox-style' --> 'background-color: #ecfcf4' <a href="#L-705"></a> -- 'fmbox-textstyle' --> 'font-style: italic' <a href="#L-706"></a> -- <a href="#L-707"></a> -- The HTML is generated by the {{fmbox}} template, courtesy of [[Module:Message box]]. <a href="#L-708"></a> --]=] <a href="#L-709"></a> <a href="#L-710"></a> -- Get environment data. <a href="#L-711"></a> env = env or p.getEnvironment(args) <a href="#L-712"></a> local subjectSpace = env.subjectSpace <a href="#L-713"></a> local docTitle = env.docTitle <a href="#L-714"></a> if not subjectSpace or not docTitle then <a href="#L-715"></a> return nil <a href="#L-716"></a> end <a href="#L-717"></a> <a href="#L-718"></a> -- Check whether we should output the end box at all. Add the end <a href="#L-719"></a> -- box by default if the documentation exists or if we are in the <a href="#L-720"></a> -- user, module or template namespaces. <a href="#L-721"></a> local linkBox = args['link box'] <a href="#L-722"></a> if linkBox == 'off' <a href="#L-723"></a> or not ( <a href="#L-724"></a> docTitle.exists <a href="#L-725"></a> or subjectSpace == 2 <a href="#L-726"></a> or subjectSpace == 828 <a href="#L-727"></a> or subjectSpace == 10 <a href="#L-728"></a> ) <a href="#L-729"></a> then <a href="#L-730"></a> return nil <a href="#L-731"></a> end <a href="#L-732"></a> <a href="#L-733"></a> -- Assemble the arguments for {{fmbox}}. <a href="#L-734"></a> local fmargs = {} <a href="#L-735"></a> fmargs.id = message('fmbox-id') -- Sets 'documentation-meta-data' <a href="#L-736"></a> fmargs.image = 'none' <a href="#L-737"></a> fmargs.style = message('fmbox-style') -- Sets 'background-color: #ecfcf4' <a href="#L-738"></a> fmargs.textstyle = message('fmbox-textstyle') -- 'font-style: italic;' <a href="#L-739"></a> <a href="#L-740"></a> -- Assemble the fmbox text field. <a href="#L-741"></a> local text = '' <a href="#L-742"></a> if linkBox then <a href="#L-743"></a> text = text .. linkBox <a href="#L-744"></a> else <a href="#L-745"></a> text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]." <a href="#L-746"></a> if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then <a href="#L-747"></a> -- We are in the user, template or module namespaces. <a href="#L-748"></a> -- Add sandbox and testcases links. <a href="#L-749"></a> -- "Editors can experiment in this template's sandbox and testcases pages." <a href="#L-750"></a> text = text .. (p.makeExperimentBlurb(args, env) or '') <a href="#L-751"></a> text = text .. ' ' <a href="#L-752"></a> if not args.content and not args[1] then <a href="#L-753"></a> -- "Please add categories to the /doc subpage." <a href="#L-754"></a> -- Don't show this message with inline docs or with an explicitly specified doc page, <a href="#L-755"></a> -- as then it is unclear where to add the categories. <a href="#L-756"></a> text = text .. (p.makeCategoriesBlurb(args, env) or '') <a href="#L-757"></a> end <a href="#L-758"></a> text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template" <a href="#L-759"></a> local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates. <a href="#L-760"></a> if printBlurb then <a href="#L-761"></a> text = text .. ' ' .. printBlurb <a href="#L-762"></a> end <a href="#L-763"></a> end <a href="#L-764"></a> end <a href="#L-765"></a> fmargs.text = text <a href="#L-766"></a> <a href="#L-767"></a> return messageBox.main('fmbox', fmargs) <a href="#L-768"></a>end <a href="#L-769"></a> <a href="#L-770"></a>function p.makeDocPageBlurb(args, env) <a href="#L-771"></a> --[=[ <a href="#L-772"></a> -- Makes the blurb "This documentation is transcluded from [[قالب:Foo]] (edit, history)". <a href="#L-773"></a> -- @args - a table of arguments passed by the user <a href="#L-774"></a> -- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-775"></a> -- <a href="#L-776"></a> -- Messages: <a href="#L-777"></a> -- 'edit-link-display' --> 'edit' <a href="#L-778"></a> -- 'history-link-display' --> 'history' <a href="#L-779"></a> -- 'transcluded-from-blurb' --> <a href="#L-780"></a> -- 'The above [[Wikipedia:Template documentation|documentation]] <a href="#L-781"></a> -- is [[Wikipedia:Transclusion|transcluded]] from $1.' <a href="#L-782"></a> -- 'module-preload' --> 'Template:Documentation/preload-module-doc' <a href="#L-783"></a> -- 'create-link-display' --> 'create' <a href="#L-784"></a> -- 'create-module-doc-blurb' --> <a href="#L-785"></a> -- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].' <a href="#L-786"></a> --]=] <a href="#L-787"></a> local docTitle = env.docTitle <a href="#L-788"></a> if not docTitle then <a href="#L-789"></a> return nil <a href="#L-790"></a> end <a href="#L-791"></a> local ret <a href="#L-792"></a> if docTitle.exists then <a href="#L-793"></a> -- /doc exists; link to it. <a href="#L-794"></a> local docLink = makeWikilink(docTitle.prefixedText) <a href="#L-795"></a> local editUrl = docTitle:fullUrl{action = 'edit'} <a href="#L-796"></a> local editDisplay = message('edit-link-display') <a href="#L-797"></a> local editLink = makeUrlLink(editUrl, editDisplay) <a href="#L-798"></a> local historyUrl = docTitle:fullUrl{action = 'history'} <a href="#L-799"></a> local historyDisplay = message('history-link-display') <a href="#L-800"></a> local historyLink = makeUrlLink(historyUrl, historyDisplay) <a href="#L-801"></a> ret = message('transcluded-from-blurb', {docLink}) <a href="#L-802"></a> .. ' ' <a href="#L-803"></a> .. makeToolbar(editLink, historyLink) <a href="#L-804"></a> .. ' ' <a href="#L-805"></a> elseif env.subjectSpace == 828 then <a href="#L-806"></a> -- /doc does not exist; ask to create it. <a href="#L-807"></a> local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')} <a href="#L-808"></a> local createDisplay = message('create-link-display') <a href="#L-809"></a> local createLink = makeUrlLink(createUrl, createDisplay) <a href="#L-810"></a> ret = message('create-module-doc-blurb', {createLink}) <a href="#L-811"></a> .. ' ' <a href="#L-812"></a> end <a href="#L-813"></a> return ret <a href="#L-814"></a>end <a href="#L-815"></a> <a href="#L-816"></a>function p.makeExperimentBlurb(args, env) <a href="#L-817"></a> --[[ <a href="#L-818"></a> -- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages." <a href="#L-819"></a> -- @args - a table of arguments passed by the user <a href="#L-820"></a> -- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-821"></a> -- <a href="#L-822"></a> -- Messages: <a href="#L-823"></a> -- 'sandbox-link-display' --> 'sandbox' <a href="#L-824"></a> -- 'sandbox-edit-link-display' --> 'edit' <a href="#L-825"></a> -- 'compare-link-display' --> 'diff' <a href="#L-826"></a> -- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox' <a href="#L-827"></a> -- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox' <a href="#L-828"></a> -- 'sandbox-create-link-display' --> 'create' <a href="#L-829"></a> -- 'mirror-edit-summary' --> 'Create sandbox version of $1' <a href="#L-830"></a> -- 'mirror-link-display' --> 'mirror' <a href="#L-831"></a> -- 'mirror-link-preload' --> 'Template:Documentation/mirror' <a href="#L-832"></a> -- 'sandbox-link-display' --> 'sandbox' <a href="#L-833"></a> -- 'testcases-link-display' --> 'testcases' <a href="#L-834"></a> -- 'testcases-edit-link-display'--> 'edit' <a href="#L-835"></a> -- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox' <a href="#L-836"></a> -- 'testcases-create-link-display' --> 'create' <a href="#L-837"></a> -- 'testcases-link-display' --> 'testcases' <a href="#L-838"></a> -- 'testcases-edit-link-display' --> 'edit' <a href="#L-839"></a> -- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases' <a href="#L-840"></a> -- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases' <a href="#L-841"></a> -- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.' <a href="#L-842"></a> -- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.' <a href="#L-843"></a> --]] <a href="#L-844"></a> local subjectSpace = env.subjectSpace <a href="#L-845"></a> local templateTitle = env.templateTitle <a href="#L-846"></a> local sandboxTitle = env.sandboxTitle <a href="#L-847"></a> local testcasesTitle = env.testcasesTitle <a href="#L-848"></a> local templatePage = templateTitle.prefixedText <a href="#L-849"></a> if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then <a href="#L-850"></a> return nil <a href="#L-851"></a> end <a href="#L-852"></a> -- Make links. <a href="#L-853"></a> local sandboxLinks, testcasesLinks <a href="#L-854"></a> if sandboxTitle and sandboxTitle.exists then <a href="#L-855"></a> local sandboxPage = sandboxTitle.prefixedText <a href="#L-856"></a> local sandboxDisplay = message('sandbox-link-display') <a href="#L-857"></a> local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay) <a href="#L-858"></a> local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'} <a href="#L-859"></a> local sandboxEditDisplay = message('sandbox-edit-link-display') <a href="#L-860"></a> local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay) <a href="#L-861"></a> local compareUrl = env.compareUrl <a href="#L-862"></a> local compareLink <a href="#L-863"></a> if compareUrl then <a href="#L-864"></a> local compareDisplay = message('compare-link-display') <a href="#L-865"></a> compareLink = makeUrlLink(compareUrl, compareDisplay) <a href="#L-866"></a> end <a href="#L-867"></a> sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink) <a href="#L-868"></a> else <a href="#L-869"></a> local sandboxPreload <a href="#L-870"></a> if subjectSpace == 828 then <a href="#L-871"></a> sandboxPreload = message('module-sandbox-preload') <a href="#L-872"></a> else <a href="#L-873"></a> sandboxPreload = message('template-sandbox-preload') <a href="#L-874"></a> end <a href="#L-875"></a> local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload} <a href="#L-876"></a> local sandboxCreateDisplay = message('sandbox-create-link-display') <a href="#L-877"></a> local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay) <a href="#L-878"></a> local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)}) <a href="#L-879"></a> local mirrorPreload = message('mirror-link-preload') <a href="#L-880"></a> local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary} <a href="#L-881"></a> if subjectSpace == 828 then <a href="#L-882"></a> mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary} <a href="#L-883"></a> end <a href="#L-884"></a> local mirrorDisplay = message('mirror-link-display') <a href="#L-885"></a> local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay) <a href="#L-886"></a> sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink) <a href="#L-887"></a> end <a href="#L-888"></a> if testcasesTitle.exists then <a href="#L-889"></a> local testcasesPage = testcasesTitle.prefixedText <a href="#L-890"></a> local testcasesDisplay = message('testcases-link-display') <a href="#L-891"></a> local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay) <a href="#L-892"></a> local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'} <a href="#L-893"></a> local testcasesEditDisplay = message('testcases-edit-link-display') <a href="#L-894"></a> local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay) <a href="#L-895"></a> -- for Modules, add testcases run link if exists <a href="#L-896"></a> if subjectSpace == 828 and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then <a href="#L-897"></a> local testcasesRunLinkDisplay = message('testcases-run-link-display') <a href="#L-898"></a> local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay) <a href="#L-899"></a> testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink) <a href="#L-900"></a> else <a href="#L-901"></a> testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink) <a href="#L-902"></a> end <a href="#L-903"></a> else <a href="#L-904"></a> local testcasesPreload <a href="#L-905"></a> if subjectSpace == 828 then <a href="#L-906"></a> testcasesPreload = message('module-testcases-preload') <a href="#L-907"></a> else <a href="#L-908"></a> testcasesPreload = message('template-testcases-preload') <a href="#L-909"></a> end <a href="#L-910"></a> local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload} <a href="#L-911"></a> local testcasesCreateDisplay = message('testcases-create-link-display') <a href="#L-912"></a> local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay) <a href="#L-913"></a> testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink) <a href="#L-914"></a> end <a href="#L-915"></a> local messageName <a href="#L-916"></a> if subjectSpace == 828 then <a href="#L-917"></a> messageName = 'experiment-blurb-module' <a href="#L-918"></a> else <a href="#L-919"></a> messageName = 'experiment-blurb-template' <a href="#L-920"></a> end <a href="#L-921"></a> return message(messageName, {sandboxLinks, testcasesLinks}) <a href="#L-922"></a>end <a href="#L-923"></a> <a href="#L-924"></a>function p.makeCategoriesBlurb(args, env) <a href="#L-925"></a> --[[ <a href="#L-926"></a> -- Generates the text "Please add categories to the /doc subpage." <a href="#L-927"></a> -- @args - a table of arguments passed by the user <a href="#L-928"></a> -- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-929"></a> -- Messages: <a href="#L-930"></a> -- 'doc-link-display' --> '/doc' <a href="#L-931"></a> -- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.' <a href="#L-932"></a> --]] <a href="#L-933"></a> local docTitle = env.docTitle <a href="#L-934"></a> if not docTitle then <a href="#L-935"></a> return nil <a href="#L-936"></a> end <a href="#L-937"></a> local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display')) <a href="#L-938"></a> return message('add-categories-blurb', {docPathLink}) <a href="#L-939"></a>end <a href="#L-940"></a> <a href="#L-941"></a>function p.makeSubpagesBlurb(args, env) <a href="#L-942"></a> --[[ <a href="#L-943"></a> -- Generates the "Subpages of this template" link. <a href="#L-944"></a> -- @args - a table of arguments passed by the user <a href="#L-945"></a> -- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-946"></a> <a href="#L-947"></a> -- Messages: <a href="#L-948"></a> -- 'template-pagetype' --> 'template' <a href="#L-949"></a> -- 'module-pagetype' --> 'module' <a href="#L-950"></a> -- 'default-pagetype' --> 'page' <a href="#L-951"></a> -- 'subpages-link-display' --> 'Subpages of this $1' <a href="#L-952"></a> --]] <a href="#L-953"></a> local subjectSpace = env.subjectSpace <a href="#L-954"></a> local templateTitle = env.templateTitle <a href="#L-955"></a> if not subjectSpace or not templateTitle then <a href="#L-956"></a> return nil <a href="#L-957"></a> end <a href="#L-958"></a> local pagetype <a href="#L-959"></a> if subjectSpace == 10 then <a href="#L-960"></a> pagetype = message('template-pagetype') <a href="#L-961"></a> elseif subjectSpace == 828 then <a href="#L-962"></a> pagetype = message('module-pagetype') <a href="#L-963"></a> else <a href="#L-964"></a> pagetype = message('default-pagetype') <a href="#L-965"></a> end <a href="#L-966"></a> local subpagesLink = makeWikilink( <a href="#L-967"></a> 'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/', <a href="#L-968"></a> message('subpages-link-display', {pagetype}) <a href="#L-969"></a> ) <a href="#L-970"></a> return message('subpages-blurb', {subpagesLink}) <a href="#L-971"></a>end <a href="#L-972"></a> <a href="#L-973"></a>function p.makePrintBlurb(args, env) <a href="#L-974"></a> --[=[ <a href="#L-975"></a> -- Generates the blurb displayed when there is a print version of the template available. <a href="#L-976"></a> -- @args - a table of arguments passed by the user <a href="#L-977"></a> -- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-978"></a> -- <a href="#L-979"></a> -- Messages: <a href="#L-980"></a> -- 'print-link-display' --> '/Print' <a href="#L-981"></a> -- 'print-blurb' --> 'A [[مساعدة:Books/for experts#Improving the book layout|print version]]' <a href="#L-982"></a> -- .. ' of this template exists at $1.' <a href="#L-983"></a> -- .. ' If you make a change to this template, please update the print version as well.' <a href="#L-984"></a> -- 'display-print-category' --> true <a href="#L-985"></a> -- 'print-category' --> 'Templates with print versions' <a href="#L-986"></a> --]=] <a href="#L-987"></a> local printTitle = env.printTitle <a href="#L-988"></a> if not printTitle then <a href="#L-989"></a> return nil <a href="#L-990"></a> end <a href="#L-991"></a> local ret <a href="#L-992"></a> if printTitle.exists then <a href="#L-993"></a> local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display')) <a href="#L-994"></a> ret = message('print-blurb', {printLink}) <a href="#L-995"></a> local displayPrintCategory = message('display-print-category', nil, 'boolean') <a href="#L-996"></a> if displayPrintCategory then <a href="#L-997"></a> ret = ret .. makeCategoryLink(message('print-category')) <a href="#L-998"></a> end <a href="#L-999"></a> end <a href="#L-1000"></a> return ret <a href="#L-1001"></a>end <a href="#L-1002"></a> <a href="#L-1003"></a>---------------------------------------------------------------------------- <a href="#L-1004"></a>-- Tracking categories <a href="#L-1005"></a>---------------------------------------------------------------------------- <a href="#L-1006"></a> <a href="#L-1007"></a>function p.addTrackingCategories(env) <a href="#L-1008"></a> --[[ <a href="#L-1009"></a> -- Check if {{documentation}} is transcluded on a /doc or /testcases page. <a href="#L-1010"></a> -- @env - environment table containing title objects, etc., generated with p.getEnvironment <a href="#L-1011"></a> <a href="#L-1012"></a> -- Messages: <a href="#L-1013"></a> -- 'display-strange-usage-category' --> true <a href="#L-1014"></a> -- 'doc-subpage' --> 'doc' <a href="#L-1015"></a> -- 'testcases-subpage' --> 'testcases' <a href="#L-1016"></a> -- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage' <a href="#L-1017"></a> -- <a href="#L-1018"></a> -- /testcases pages in the module namespace are not categorised, as they may have <a href="#L-1019"></a> -- {{documentation}} transcluded automatically. <a href="#L-1020"></a> --]] <a href="#L-1021"></a> local title = env.title <a href="#L-1022"></a> local subjectSpace = env.subjectSpace <a href="#L-1023"></a> if not title or not subjectSpace then <a href="#L-1024"></a> return nil <a href="#L-1025"></a> end <a href="#L-1026"></a> local subpage = title.subpageText <a href="#L-1027"></a> local ret = '' <a href="#L-1028"></a> if message('display-strange-usage-category', nil, 'boolean') <a href="#L-1029"></a> and ( <a href="#L-1030"></a> subpage == message('doc-subpage') <a href="#L-1031"></a> or subjectSpace ~= 828 and subpage == message('testcases-subpage') <a href="#L-1032"></a> ) <a href="#L-1033"></a> then <a href="#L-1034"></a> ret = ret .. makeCategoryLink(message('strange-usage-category')) <a href="#L-1035"></a> end <a href="#L-1036"></a> return ret <a href="#L-1037"></a>end <a href="#L-1038"></a> <a href="#L-1039"></a>return p </pre></div>   </div><noscript><img src="https://login.wikimedia.org/wiki/Special:CentralAutoLogin/start?type=1x1" alt="" width="1" height="1" style="border: none; position: absolute;"></noscript> <div class="printfooter" data-nosnippet="">اتجابت من "<a dir="ltr" href="https://arz.wikipedia.org/w/index.php?title=وحدة:توثيق&oldid=10564171">https://arz.wikipedia.org/w/index.php?title=وحدة:توثيق&oldid=10564171</a>"</div></div> <div id="catlinks" class="catlinks catlinks-allhidden" data-mw="interface"></div> </div> </main> </div> <div class="mw-footer-container"> <footer id="footer" class="mw-footer" > <ul id="footer-info"> <li id="footer-info-lastmod"> الصفحه دى اتعدلت اخر مره فى 30 اغسطس 2024,‏ 20:47.</li> <li id="footer-info-copyright">النصوص متوفرة تحت <a rel="nofollow" class="external text" href="https://creativecommons.org/licenses/by-sa/4.0/">رخصة التشارك الإبداع العزو/المشاركة بالمثل</a>; ممكن تطبيق شروط إضافية. بص على <a class="external text" href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Terms_of_Use">شروط الاستخدام</a> للتفاصيل.</li> </ul> <ul id="footer-places"> <li id="footer-places-privacy"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Privacy_policy/ar">بوليسة الخصوصيه</a></li> <li id="footer-places-about"><a href="/wiki/%D9%88%D9%8A%D9%83%D9%8A%D8%A8%D9%8A%D8%AF%D9%8A%D8%A7:%D9%85%D8%B9%D9%84%D9%88%D9%85%D8%A7%D8%AA_%D8%B9%D9%86">عن ويكيبيديا</a></li> <li id="footer-places-disclaimers"><a href="/wiki/%D9%88%D9%8A%D9%83%D9%8A%D8%A8%D9%8A%D8%AF%D9%8A%D8%A7:%D8%AA%D9%86%D8%A7%D8%B2%D9%84_%D8%B9%D9%86_%D9%85%D8%B3%D8%A6%D9%88%D9%84%D9%8A%D9%87_%D8%B9%D9%85%D9%88%D9%85%D9%89">تنازل عن مسئوليه</a></li> <li id="footer-places-wm-codeofconduct"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Universal_Code_of_Conduct">القواعد السلوكية</a></li> <li id="footer-places-developers"><a href="https://developer.wikimedia.org">مطورين</a></li> <li id="footer-places-statslink"><a href="https://stats.wikimedia.org/#/arz.wikipedia.org">احصائيات</a></li> <li id="footer-places-cookiestatement"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Cookie_statement">بيان الكوكيز</a></li> <li id="footer-places-mobileview"><a href="//arz.m.wikipedia.org/w/index.php?title=%D9%88%D8%AD%D8%AF%D8%A9:%D8%AA%D9%88%D8%AB%D9%8A%D9%82&mobileaction=toggle_view_mobile" class="noprint stopMobileRedirectToggle">نسخة المحمول</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-5767f597fb-q8lrg","wgBackendResponseTime":309,"wgPageParseReport":{"limitreport":{"cputime":"0.012","walltime":"0.042","ppvisitednodes":{"value":29,"limit":1000000},"postexpandincludesize":{"value":852,"limit":2097152},"templateargumentsize":{"value":40,"limit":2097152},"expansiondepth":{"value":6,"limit":100},"expensivefunctioncount":{"value":3,"limit":500},"unstrip-depth":{"value":0,"limit":20},"unstrip-size":{"value":939,"limit":5000000},"entityaccesscount":{"value":0,"limit":400},"timingprofile":["100.00% 34.447 1 -total","100.00% 34.447 1 وحدة:توثيق/شرح"," 10.10% 3.479 1 قالب:قا"]},"cachereport":{"origin":"mw-web.codfw.main-5767f597fb-q8lrg","timestamp":"20241127230424","ttl":2592000,"transientcontent":false}}});});</script> </body> </html>