CINXE.COM

<!DOCTYPE html> <html class="client-nojs vector-feature-language-in-header-enabled vector-feature-language-in-main-page-header-disabled vector-feature-sticky-header-disabled vector-feature-page-tools-pinned-disabled vector-feature-toc-pinned-clientpref-1 vector-feature-main-menu-pinned-disabled vector-feature-limited-width-clientpref-1 vector-feature-limited-width-content-enabled vector-feature-custom-font-size-clientpref-1 vector-feature-appearance-pinned-clientpref-1 vector-feature-night-mode-enabled skin-theme-clientpref-day vector-toc-available" lang="en" dir="ltr"> <head> <meta charset="UTF-8"> <title>Module:WPSHIPS utilities - Wikipedia</title> <script>(function(){var className="client-js vector-feature-language-in-header-enabled vector-feature-language-in-main-page-header-disabled vector-feature-sticky-header-disabled vector-feature-page-tools-pinned-disabled vector-feature-toc-pinned-clientpref-1 vector-feature-main-menu-pinned-disabled vector-feature-limited-width-clientpref-1 vector-feature-limited-width-content-enabled vector-feature-custom-font-size-clientpref-1 vector-feature-appearance-pinned-clientpref-1 vector-feature-night-mode-enabled skin-theme-clientpref-day vector-toc-available";var cookie=document.cookie.match(/(?:^|; )enwikimwclientpreferences=([^;]+)/);if(cookie){cookie[1].split('%2C').forEach(function(pref){className=className.replace(new RegExp('(^| )'+pref.replace(/-clientpref-\w+$|[^\w-]+/g,'')+'-clientpref-\\w+( |$)'),'$1'+pref+'$2');});}document.documentElement.className=className;}());RLCONF={"wgBreakFrames":false,"wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgDefaultDateFormat":"dmy", "wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgRequestId":"51e7da63-b932-446a-b0ff-d70c86d4ce24","wgCanonicalNamespace":"Module","wgCanonicalSpecialPageName":false,"wgNamespaceNumber":828,"wgPageName":"Module:WPSHIPS_utilities","wgTitle":"WPSHIPS utilities","wgCurRevisionId":1252707104,"wgRevisionId":1252707104,"wgArticleId":47747387,"wgIsArticle":true,"wgIsRedirect":false,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":["Wikipedia fully protected modules"],"wgPageViewLanguage":"en","wgPageContentLanguage":"en","wgPageContentModel":"Scribunto","wgRelevantPageName":"Module:WPSHIPS_utilities","wgRelevantArticleId":47747387,"wgIsProbablyEditable":false,"wgRelevantPageIsProbablyEditable":false,"wgRestrictionEdit":["templateeditor"],"wgRestrictionMove":["templateeditor"],"wgNoticeProject":"wikipedia","wgCiteReferencePreviewsActive":false,"wgFlaggedRevsParams":{"tags":{"status":{ "levels":1}}},"wgMediaViewerOnClick":true,"wgMediaViewerEnabledByDefault":true,"wgPopupsFlags":0,"wgVisualEditor":{"pageLanguageCode":"en","pageLanguageDir":"ltr","pageVariantFallbacks":"en"},"wgMFDisplayWikibaseDescriptions":{"search":true,"watchlist":true,"tagline":false,"nearby":true},"wgWMESchemaEditAttemptStepOversample":false,"wgWMEPageLength":60000,"wgRelatedArticlesCompat":[],"wgCentralAuthMobileDomain":false,"wgEditSubmitButtonLabelPublish":true,"wgULSPosition":"interlanguage","wgULSisCompactLinksEnabled":false,"wgVector2022LanguageInHeader":true,"wgULSisLanguageSelectorEmpty":false,"wgWikibaseItemId":"Q21546112","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","mediawiki.toc","skins.vector.js","ext.centralNotice.geoIP","ext.centralNotice.startUp","ext.gadget.ReferenceTooltips","ext.gadget.switcher","ext.urlShortener.toolbar","ext.centralauth.centralautologin","mmv.bootstrap","ext.popups","ext.visualEditor.desktopArticleTarget.init","ext.visualEditor.targetLoader","ext.echo.centralauth","ext.eventLogging","ext.wikimediaEvents","ext.navigationTiming","ext.uls.interface","ext.cx.eventlogging.campaigns","wikibase.client.vector-2022","ext.checkUser.clientHints" ,"wikibase.sidebar.tracking"];</script> <script>(RLQ=window.RLQ||[]).push(function(){mw.loader.impl(function(){return["user.options@12s5i",function($,jQuery,require,module){mw.user.tokens.set({"patrolToken":"+\\","watchToken":"+\\","csrfToken":"+\\"}); }];});});</script> <link rel="stylesheet" href="/w/load.php?lang=en&modules=ext.pygments%2CwikimediaBadges%7Cext.uls.interlanguage%7Cext.visualEditor.desktopArticleTarget.noscript%7Cext.wikimediamessages.styles%7Cskins.vector.icons%2Cstyles%7Cskins.vector.search.codex.styles%7Cwikibase.client.init&only=styles&skin=vector-2022"> <script async="" src="/w/load.php?lang=en&modules=startup&only=scripts&raw=1&skin=vector-2022"></script> <meta name="ResourceLoaderDynamicStyles" content=""> <link rel="stylesheet" href="/w/load.php?lang=en&modules=site.styles&only=styles&skin=vector-2022"> <meta name="generator" content="MediaWiki 1.44.0-wmf.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="Module:WPSHIPS utilities - Wikipedia"> <meta property="og:type" content="website"> <link rel="preconnect" href="//upload.wikimedia.org"> <link rel="alternate" media="only screen and (max-width: 640px)" href="//en.m.wikipedia.org/wiki/Module:WPSHIPS_utilities"> <link rel="apple-touch-icon" href="/static/apple-touch/wikipedia.png"> <link rel="icon" href="/static/favicon/wikipedia.ico"> <link rel="search" type="application/opensearchdescription+xml" href="/w/rest.php/v1/search" title="Wikipedia (en)"> <link rel="EditURI" type="application/rsd+xml" href="//en.wikipedia.org/w/api.php?action=rsd"> <link rel="canonical" href="https://en.wikipedia.org/wiki/Module:WPSHIPS_utilities"> <link rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/deed.en"> <link rel="alternate" type="application/atom+xml" title="Wikipedia Atom feed" href="/w/index.php?title=Special:RecentChanges&feed=atom"> <link rel="dns-prefetch" href="//meta.wikimedia.org" /> <link rel="dns-prefetch" href="//login.wikimedia.org"> </head> <body class="skin--responsive skin-vector skin-vector-search-vue mediawiki ltr sitedir-ltr mw-hide-empty-elt ns-828 ns-subject page-Module_WPSHIPS_utilities rootpage-Module_WPSHIPS_utilities skin-vector-2022 action-view"><a class="mw-jump-link" href="#bodyContent">Jump to content</a> <div class="vector-header-container"> <header class="vector-header mw-header"> <div class="vector-header-start"> <nav class="vector-main-menu-landmark" aria-label="Site"> <div id="vector-main-menu-dropdown" class="vector-dropdown vector-main-menu-dropdown vector-button-flush-left vector-button-flush-right" > <input type="checkbox" id="vector-main-menu-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-main-menu-dropdown" class="vector-dropdown-checkbox " aria-label="Main menu" > <label id="vector-main-menu-dropdown-label" for="vector-main-menu-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Main menu </label> <div class="vector-dropdown-content"> <div id="vector-main-menu-unpinned-container" class="vector-unpinned-container"> <div id="vector-main-menu" class="vector-main-menu vector-pinnable-element"> <div class="vector-pinnable-header vector-main-menu-pinnable-header vector-pinnable-header-unpinned" data-feature-name="main-menu-pinned" data-pinnable-element-id="vector-main-menu" data-pinned-container-id="vector-main-menu-pinned-container" data-unpinned-container-id="vector-main-menu-unpinned-container" > <div class="vector-pinnable-header-label">Main menu</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-main-menu.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-main-menu.unpin">hide</button> </div> <div id="p-navigation" class="vector-menu mw-portlet mw-portlet-navigation" > <div class="vector-menu-heading"> Navigation </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-mainpage-description" class="mw-list-item"><a href="/wiki/Main_Page" title="Visit the main page [z]" accesskey="z">Main page</a></li><li id="n-contents" class="mw-list-item"><a href="/wiki/Wikipedia:Contents" title="Guides to browsing Wikipedia">Contents</a></li><li id="n-currentevents" class="mw-list-item"><a href="/wiki/Portal:Current_events" title="Articles related to current events">Current events</a></li><li id="n-randompage" class="mw-list-item"><a href="/wiki/Special:Random" title="Visit a randomly selected article [x]" accesskey="x">Random article</a></li><li id="n-aboutsite" class="mw-list-item"><a href="/wiki/Wikipedia:About" title="Learn about Wikipedia and how it works">About Wikipedia</a></li><li id="n-contactpage" class="mw-list-item"><a href="//en.wikipedia.org/wiki/Wikipedia:Contact_us" title="How to contact Wikipedia">Contact us</a></li> </ul> </div> </div> <div id="p-interaction" class="vector-menu mw-portlet mw-portlet-interaction" > <div class="vector-menu-heading"> Contribute </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-help" class="mw-list-item"><a href="/wiki/Help:Contents" title="Guidance on how to use and edit Wikipedia">Help</a></li><li id="n-introduction" class="mw-list-item"><a href="/wiki/Help:Introduction" title="Learn how to edit Wikipedia">Learn to edit</a></li><li id="n-portal" class="mw-list-item"><a href="/wiki/Wikipedia:Community_portal" title="The hub for editors">Community portal</a></li><li id="n-recentchanges" class="mw-list-item"><a href="/wiki/Special:RecentChanges" title="A list of recent changes to Wikipedia [r]" accesskey="r">Recent changes</a></li><li id="n-upload" class="mw-list-item"><a href="/wiki/Wikipedia:File_upload_wizard" title="Add images or other media for use on Wikipedia">Upload file</a></li> </ul> </div> </div> </div> </div> </div> </div> </nav> <a href="/wiki/Main_Page" class="mw-logo"> <img class="mw-logo-icon" src="/static/images/icons/wikipedia.png" alt="" aria-hidden="true" height="50" width="50"> <img class="mw-logo-wordmark" alt="Wikipedia" src="/static/images/mobile/copyright/wikipedia-wordmark-en.svg" style="width: 7.5em; height: 1.125em;"> <img class="mw-logo-tagline" alt="The Free Encyclopedia" src="/static/images/mobile/copyright/wikipedia-tagline-en.svg" width="117" height="13" style="width: 7.3125em; height: 0.8125em;"> </a> </div> <div class="vector-header-end"> <div id="p-search" role="search" class="vector-search-box-vue vector-search-box-collapses vector-search-box-show-thumbnail vector-search-box-auto-expand-width vector-search-box"> <a href="/wiki/Special:Search" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only search-toggle" title="Search Wikipedia [f]" accesskey="f"> Search </a> <div class="vector-typeahead-search-container"> <div class="cdx-typeahead-search cdx-typeahead-search--show-thumbnail cdx-typeahead-search--auto-expand-width"> <form action="/w/index.php" id="searchform" class="cdx-search-input cdx-search-input--has-end-button"> <div id="simpleSearch" class="cdx-search-input__input-wrapper" data-search-loc="header-moved"> <div class="cdx-text-input cdx-text-input--has-start-icon"> <input class="cdx-text-input__input" type="search" name="search" placeholder="Search Wikipedia" aria-label="Search Wikipedia" autocapitalize="sentences" title="Search Wikipedia [f]" accesskey="f" id="searchInput" > </div> <input type="hidden" name="title" value="Special:Search"> </div> <button class="cdx-button cdx-search-input__end-button">Search</button> </form> </div> </div> </div> <nav class="vector-user-links vector-user-links-wide" aria-label="Personal tools"> <div class="vector-user-links-main"> <div id="p-vector-user-menu-preferences" class="vector-menu mw-portlet emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> <div id="p-vector-user-menu-userpage" class="vector-menu mw-portlet emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> <nav class="vector-appearance-landmark" aria-label="Appearance"> <div id="vector-appearance-dropdown" class="vector-dropdown " title="Change the appearance of the page's font size, width, and color" > <input type="checkbox" id="vector-appearance-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-appearance-dropdown" class="vector-dropdown-checkbox " aria-label="Appearance" > <label id="vector-appearance-dropdown-label" for="vector-appearance-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Appearance </label> <div class="vector-dropdown-content"> <div id="vector-appearance-unpinned-container" class="vector-unpinned-container"> </div> </div> </div> </nav> <div id="p-vector-user-menu-notifications" class="vector-menu mw-portlet emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> <div id="p-vector-user-menu-overflow" class="vector-menu mw-portlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-sitesupport-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector?utm_source=donate&utm_medium=sidebar&utm_campaign=C13_en.wikipedia.org&uselang=en" class="">Donate</a> </li> <li id="pt-createaccount-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="/w/index.php?title=Special:CreateAccount&returnto=Module%3AWPSHIPS+utilities" title="You are encouraged to create an account and log in; however, it is not mandatory" class="">Create account</a> </li> <li id="pt-login-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="/w/index.php?title=Special:UserLogin&returnto=Module%3AWPSHIPS+utilities" title="You're encouraged to log in; however, it's not mandatory. [o]" accesskey="o" class="">Log in</a> </li> </ul> </div> </div> </div> <div id="vector-user-links-dropdown" class="vector-dropdown vector-user-menu vector-button-flush-right vector-user-menu-logged-out" title="Log in and more options" > <input type="checkbox" id="vector-user-links-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-user-links-dropdown" class="vector-dropdown-checkbox " aria-label="Personal tools" > <label id="vector-user-links-dropdown-label" for="vector-user-links-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Personal tools </label> <div class="vector-dropdown-content"> <div id="p-personal" class="vector-menu mw-portlet mw-portlet-personal user-links-collapsible-item" title="User menu" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-sitesupport" class="user-links-collapsible-item mw-list-item"><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector?utm_source=donate&utm_medium=sidebar&utm_campaign=C13_en.wikipedia.org&uselang=en">Donate</a></li><li id="pt-createaccount" class="user-links-collapsible-item mw-list-item"><a href="/w/index.php?title=Special:CreateAccount&returnto=Module%3AWPSHIPS+utilities" title="You are encouraged to create an account and log in; however, it is not mandatory"> Create account</a></li><li id="pt-login" class="user-links-collapsible-item mw-list-item"><a href="/w/index.php?title=Special:UserLogin&returnto=Module%3AWPSHIPS+utilities" title="You're encouraged to log in; however, it's not mandatory. [o]" accesskey="o"> Log in</a></li> </ul> </div> </div> <div id="p-user-menu-anon-editor" class="vector-menu mw-portlet mw-portlet-user-menu-anon-editor" > <div class="vector-menu-heading"> Pages for logged out editors <a href="/wiki/Help:Introduction" aria-label="Learn more about editing">learn more</a> </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-anoncontribs" class="mw-list-item"><a href="/wiki/Special:MyContributions" title="A list of edits made from this IP address [y]" accesskey="y">Contributions</a></li><li id="pt-anontalk" class="mw-list-item"><a href="/wiki/Special:MyTalk" title="Discussion about edits from this IP address [n]" accesskey="n">Talk</a></li> </ul> </div> </div> </div> </div> </nav> </div> </header> </div> <div class="mw-page-container"> <div class="mw-page-container-inner"> <div class="vector-sitenotice-container"> <div id="siteNotice"></div> </div> <div class="vector-column-start"> <div class="vector-main-menu-container"> <div id="mw-navigation"> <nav id="mw-panel" class="vector-main-menu-landmark" aria-label="Site"> <div id="vector-main-menu-pinned-container" class="vector-pinned-container"> </div> </nav> </div> </div> <div class="vector-sticky-pinned-container"> <nav id="mw-panel-toc" aria-label="Contents" data-event-name="ui.sidebar-toc" class="mw-table-of-contents-container vector-toc-landmark"> <div id="vector-toc-pinned-container" class="vector-pinned-container"> <div id="vector-toc" class="vector-toc vector-pinnable-element"> <div class="vector-pinnable-header vector-toc-pinnable-header vector-pinnable-header-pinned" data-feature-name="toc-pinned" data-pinnable-element-id="vector-toc" > <h2 class="vector-pinnable-header-label">Contents</h2> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-toc.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-toc.unpin">hide</button> </div> <ul class="vector-toc-contents" id="mw-panel-toc-list"> <li id="toc-mw-content-text" class="vector-toc-list-item vector-toc-level-1"> <a href="#" class="vector-toc-link"> <div class="vector-toc-text">(Top)</div> </a> </li> <li id="toc-ship_name_format" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#ship_name_format"> <div class="vector-toc-text"> 1 ship_name_format </div> </a> <button aria-controls="toc-ship_name_format-sublist" class="cdx-button cdx-button--weight-quiet cdx-button--icon-only vector-toc-toggle"> Toggle ship_name_format subsection </button> <ul id="toc-ship_name_format-sublist" class="vector-toc-list"> <li id="toc-Lists" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Lists"> <div class="vector-toc-text"> 1.1 Lists </div> </a> <ul id="toc-Lists-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Usage" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Usage"> <div class="vector-toc-text"> 1.2 Usage </div> </a> <ul id="toc-Usage-sublist" class="vector-toc-list"> <li id="toc-Parameters" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Parameters"> <div class="vector-toc-text"> 1.2.1 Parameters </div> </a> <ul id="toc-Parameters-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Wrapper_template" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Wrapper_template"> <div class="vector-toc-text"> 1.2.2 Wrapper template </div> </a> <ul id="toc-Wrapper_template-sublist" class="vector-toc-list"> </ul> </li> </ul> </li> </ul> </li> <li id="toc-wpsu.navsource()" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#wpsu.navsource()"> <div class="vector-toc-text"> 2 wpsu.navsource() </div> </a> <ul id="toc-wpsu.navsource()-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-wpsu.hnsa()" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#wpsu.hnsa()"> <div class="vector-toc-text"> 3 wpsu.hnsa() </div> </a> <ul id="toc-wpsu.hnsa()-sublist" class="vector-toc-list"> </ul> </li> </ul> </div> </div> </nav> </div> </div> <div class="mw-content-container"> <main id="content" class="mw-body"> <header class="mw-body-header vector-page-titlebar"> <nav aria-label="Contents" class="vector-toc-landmark"> <div id="vector-page-titlebar-toc" class="vector-dropdown vector-page-titlebar-toc vector-button-flush-left" > <input type="checkbox" id="vector-page-titlebar-toc-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-page-titlebar-toc" class="vector-dropdown-checkbox " aria-label="Toggle the table of contents" > <label id="vector-page-titlebar-toc-label" for="vector-page-titlebar-toc-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Toggle the table of contents </label> <div class="vector-dropdown-content"> <div id="vector-page-titlebar-toc-unpinned-container" class="vector-unpinned-container"> </div> </div> </div> </nav> <h1 id="firstHeading" class="firstHeading mw-first-heading">Module:WPSHIPS utilities</h1> <div id="p-lang-btn" class="vector-dropdown mw-portlet mw-portlet-lang" > <input type="checkbox" id="p-lang-btn-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-p-lang-btn" class="vector-dropdown-checkbox mw-interlanguage-selector" aria-label="Go to an article in another language. Available in 29 languages" > <label id="p-lang-btn-label" for="p-lang-btn-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--action-progressive mw-portlet-lang-heading-29" aria-hidden="true" > 29 languages </label> <div class="vector-dropdown-content"> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li class="interlanguage-link interwiki-ar mw-list-item"><a href="https://ar.wikipedia.org/wiki/%D9%88%D8%AD%D8%AF%D8%A9:WPSHIPS_utilities" title="وحدة:WPSHIPS utilities – Arabic" lang="ar" hreflang="ar" data-title="وحدة:WPSHIPS utilities" data-language-autonym="العربية" data-language-local-name="Arabic" class="interlanguage-link-target">العربية</a></li><li class="interlanguage-link interwiki-ast mw-list-item"><a href="https://ast.wikipedia.org/wiki/M%C3%B3dulu:WPSHIPS_utilities" title="Módulu:WPSHIPS utilities – Asturian" lang="ast" hreflang="ast" data-title="Módulu:WPSHIPS utilities" data-language-autonym="Asturianu" data-language-local-name="Asturian" class="interlanguage-link-target">Asturianu</a></li><li class="interlanguage-link interwiki-azb mw-list-item"><a href="https://azb.wikipedia.org/wiki/%D9%85%D8%A7%DA%98%D9%88%D9%84:WPSHIPS_utilities" title="ماژول:WPSHIPS utilities – South Azerbaijani" lang="azb" hreflang="azb" data-title="ماژول:WPSHIPS utilities" data-language-autonym="تۆرکجه" data-language-local-name="South Azerbaijani" class="interlanguage-link-target">تۆرکجه</a></li><li class="interlanguage-link interwiki-ban mw-list-item"><a href="https://ban.wikipedia.org/wiki/Modul:WPSHIPS_utilities" title="Modul:WPSHIPS utilities – Balinese" lang="ban" hreflang="ban" data-title="Modul:WPSHIPS utilities" data-language-autonym="Basa Bali" data-language-local-name="Balinese" class="interlanguage-link-target">Basa Bali</a></li><li class="interlanguage-link interwiki-bn mw-list-item"><a href="https://bn.wikipedia.org/wiki/%E0%A6%AE%E0%A6%A1%E0%A6%BF%E0%A6%89%E0%A6%B2:WPSHIPS_utilities" title="মডিউল:WPSHIPS utilities – Bangla" lang="bn" hreflang="bn" data-title="মডিউল:WPSHIPS utilities" data-language-autonym="বাংলা" data-language-local-name="Bangla" class="interlanguage-link-target">বাংলা</a></li><li class="interlanguage-link interwiki-bh mw-list-item"><a href="https://bh.wikipedia.org/wiki/Module:WPSHIPS_utilities" title="Module:WPSHIPS utilities – Bhojpuri" lang="bh" hreflang="bh" data-title="Module:WPSHIPS utilities" data-language-autonym="भोजपुरी" data-language-local-name="Bhojpuri" class="interlanguage-link-target">भोजपुरी</a></li><li class="interlanguage-link interwiki-bcl mw-list-item"><a href="https://bcl.wikipedia.org/wiki/Module:WPSHIPS_utilities" title="Module:WPSHIPS utilities – Central Bikol" lang="bcl" hreflang="bcl" data-title="Module:WPSHIPS utilities" data-language-autonym="Bikol Central" data-language-local-name="Central Bikol" class="interlanguage-link-target">Bikol Central</a></li><li class="interlanguage-link interwiki-fa mw-list-item"><a href="https://fa.wikipedia.org/wiki/%D9%BE%D9%88%D8%AF%D9%85%D8%A7%D9%86:WPSHIPS_utilities" title="پودمان:WPSHIPS utilities – Persian" lang="fa" hreflang="fa" data-title="پودمان:WPSHIPS utilities" data-language-autonym="فارسی" data-language-local-name="Persian" class="interlanguage-link-target">فارسی</a></li><li class="interlanguage-link interwiki-ko mw-list-item"><a href="https://ko.wikipedia.org/wiki/%EB%AA%A8%EB%93%88:WPSHIPS_utilities" title="모듈:WPSHIPS utilities – Korean" lang="ko" hreflang="ko" data-title="모듈:WPSHIPS utilities" data-language-autonym="한국어" data-language-local-name="Korean" class="interlanguage-link-target">한국어</a></li><li class="interlanguage-link interwiki-ha mw-list-item"><a href="https://ha.wikipedia.org/wiki/Module:WPSHIPS_utilities" title="Module:WPSHIPS utilities – Hausa" lang="ha" hreflang="ha" data-title="Module:WPSHIPS utilities" data-language-autonym="Hausa" data-language-local-name="Hausa" class="interlanguage-link-target">Hausa</a></li><li class="interlanguage-link interwiki-hy mw-list-item"><a href="https://hy.wikipedia.org/wiki/%D5%84%D5%B8%D5%A4%D5%B8%D6%82%D5%AC:WPSHIPS_utilities" title="Մոդուլ:WPSHIPS utilities – Armenian" lang="hy" hreflang="hy" data-title="Մոդուլ:WPSHIPS utilities" data-language-autonym="Հայերեն" data-language-local-name="Armenian" class="interlanguage-link-target">Հայերեն</a></li><li class="interlanguage-link interwiki-id mw-list-item"><a href="https://id.wikipedia.org/wiki/Modul:WPSHIPS_utilities" title="Modul:WPSHIPS utilities – Indonesian" lang="id" hreflang="id" data-title="Modul:WPSHIPS utilities" data-language-autonym="Bahasa Indonesia" data-language-local-name="Indonesian" class="interlanguage-link-target">Bahasa Indonesia</a></li><li class="interlanguage-link interwiki-jv mw-list-item"><a href="https://jv.wikipedia.org/wiki/Modhul:WPSHIPS_utilities" title="Modhul:WPSHIPS utilities – Javanese" lang="jv" hreflang="jv" data-title="Modhul:WPSHIPS utilities" data-language-autonym="Jawa" data-language-local-name="Javanese" class="interlanguage-link-target">Jawa</a></li><li class="interlanguage-link interwiki-ml mw-list-item"><a href="https://ml.wikipedia.org/wiki/%E0%B4%98%E0%B4%9F%E0%B4%95%E0%B4%82:WPSHIPS_utilities" title="ഘടകം:WPSHIPS utilities – Malayalam" lang="ml" hreflang="ml" data-title="ഘടകം:WPSHIPS utilities" data-language-autonym="മലയാളം" data-language-local-name="Malayalam" class="interlanguage-link-target">മലയാളം</a></li><li class="interlanguage-link interwiki-mr mw-list-item"><a href="https://mr.wikipedia.org/wiki/%E0%A4%B5%E0%A4%BF%E0%A4%AD%E0%A4%BE%E0%A4%97:WPSHIPS_utilities" title="विभाग:WPSHIPS utilities – Marathi" lang="mr" hreflang="mr" data-title="विभाग:WPSHIPS utilities" data-language-autonym="मराठी" data-language-local-name="Marathi" class="interlanguage-link-target">मराठी</a></li><li class="interlanguage-link interwiki-ms mw-list-item"><a href="https://ms.wikipedia.org/wiki/Modul:WPSHIPS_utilities" title="Modul:WPSHIPS utilities – Malay" lang="ms" hreflang="ms" data-title="Modul:WPSHIPS utilities" data-language-autonym="Bahasa Melayu" data-language-local-name="Malay" class="interlanguage-link-target">Bahasa Melayu</a></li><li class="interlanguage-link interwiki-my mw-list-item"><a href="https://my.wikipedia.org/wiki/%E1%80%99%E1%80%B1%E1%80%AC%E1%80%BA%E1%80%82%E1%80%BB%E1%80%B0%E1%80%B8:WPSHIPS_utilities" title="မော်ဂျူး:WPSHIPS utilities – Burmese" lang="my" hreflang="my" data-title="မော်ဂျူး:WPSHIPS utilities" data-language-autonym="မြန်မာဘာသာ" data-language-local-name="Burmese" class="interlanguage-link-target">မြန်မာဘာသာ</a></li><li class="interlanguage-link interwiki-ja mw-list-item"><a href="https://ja.wikipedia.org/wiki/%E3%83%A2%E3%82%B8%E3%83%A5%E3%83%BC%E3%83%AB:WPSHIPS_utilities" title="モジュール:WPSHIPS utilities – Japanese" lang="ja" hreflang="ja" data-title="モジュール:WPSHIPS utilities" data-language-autonym="日本語" data-language-local-name="Japanese" class="interlanguage-link-target">日本語</a></li><li class="interlanguage-link interwiki-or mw-list-item"><a href="https://or.wikipedia.org/wiki/%E0%AC%AE%E0%AC%A1%E0%AD%8D%E0%AD%9F%E0%AD%81%E0%AC%B2:WPSHIPS_utilities" title="ମଡ୍ୟୁଲ:WPSHIPS utilities – Odia" lang="or" hreflang="or" data-title="ମଡ୍ୟୁଲ:WPSHIPS utilities" data-language-autonym="ଓଡ଼ିଆ" data-language-local-name="Odia" class="interlanguage-link-target">ଓଡ଼ିଆ</a></li><li class="interlanguage-link interwiki-sco mw-list-item"><a href="https://sco.wikipedia.org/wiki/Module:WPSHIPS_utilities" title="Module:WPSHIPS utilities – Scots" lang="sco" hreflang="sco" data-title="Module:WPSHIPS utilities" data-language-autonym="Scots" data-language-local-name="Scots" class="interlanguage-link-target">Scots</a></li><li class="interlanguage-link interwiki-si mw-list-item"><a href="https://si.wikipedia.org/wiki/Module:WPSHIPS_utilities" title="Module:WPSHIPS utilities – Sinhala" lang="si" hreflang="si" data-title="Module:WPSHIPS utilities" data-language-autonym="සිංහල" data-language-local-name="Sinhala" class="interlanguage-link-target">සිංහල</a></li><li class="interlanguage-link interwiki-simple mw-list-item"><a href="https://simple.wikipedia.org/wiki/Module:WPSHIPS_utilities" title="Module:WPSHIPS utilities – Simple English" lang="en-simple" hreflang="en-simple" data-title="Module:WPSHIPS utilities" data-language-autonym="Simple English" data-language-local-name="Simple English" class="interlanguage-link-target">Simple English</a></li><li class="interlanguage-link interwiki-ckb mw-list-item"><a href="https://ckb.wikipedia.org/wiki/%D9%85%DB%86%D8%AF%DB%8C%D9%88%D9%88%D9%84:WPSHIPS_utilities" title="مۆدیوول:WPSHIPS utilities – Central Kurdish" lang="ckb" hreflang="ckb" data-title="مۆدیوول:WPSHIPS utilities" data-language-autonym="کوردی" data-language-local-name="Central Kurdish" class="interlanguage-link-target">کوردی</a></li><li class="interlanguage-link interwiki-sr mw-list-item"><a href="https://sr.wikipedia.org/wiki/%D0%9C%D0%BE%D0%B4%D1%83%D0%BB:WPSHIPS_utilities" title="Модул:WPSHIPS utilities – Serbian" lang="sr" hreflang="sr" data-title="Модул:WPSHIPS utilities" data-language-autonym="Српски / srpski" data-language-local-name="Serbian" class="interlanguage-link-target">Српски / srpski</a></li><li class="interlanguage-link interwiki-th mw-list-item"><a href="https://th.wikipedia.org/wiki/%E0%B8%A1%E0%B8%AD%E0%B8%94%E0%B8%B9%E0%B8%A5:WPSHIPS_utilities" title="มอดูล:WPSHIPS utilities – Thai" lang="th" hreflang="th" data-title="มอดูล:WPSHIPS utilities" data-language-autonym="ไทย" data-language-local-name="Thai" class="interlanguage-link-target">ไทย</a></li><li class="interlanguage-link interwiki-uk mw-list-item"><a href="https://uk.wikipedia.org/wiki/%D0%9C%D0%BE%D0%B4%D1%83%D0%BB%D1%8C:WPSHIPS_utilities" title="Модуль:WPSHIPS utilities – Ukrainian" lang="uk" hreflang="uk" data-title="Модуль:WPSHIPS utilities" data-language-autonym="Українська" data-language-local-name="Ukrainian" class="interlanguage-link-target">Українська</a></li><li class="interlanguage-link interwiki-ur mw-list-item"><a href="https://ur.wikipedia.org/wiki/%D9%85%D8%A7%DA%88%DB%8C%D9%88%D9%84:WPSHIPS_utilities" title="ماڈیول:WPSHIPS utilities – Urdu" lang="ur" hreflang="ur" data-title="ماڈیول:WPSHIPS utilities" data-language-autonym="اردو" data-language-local-name="Urdu" class="interlanguage-link-target">اردو</a></li><li class="interlanguage-link interwiki-vi mw-list-item"><a href="https://vi.wikipedia.org/wiki/M%C3%B4_%C4%91un:WPSHIPS_utilities" title="Mô đun:WPSHIPS utilities – Vietnamese" lang="vi" hreflang="vi" data-title="Mô đun:WPSHIPS utilities" data-language-autonym="Tiếng Việt" data-language-local-name="Vietnamese" class="interlanguage-link-target">Tiếng Việt</a></li><li class="interlanguage-link interwiki-zh mw-list-item"><a href="https://zh.wikipedia.org/wiki/Module:WPSHIPS_utilities" title="Module:WPSHIPS utilities – Chinese" lang="zh" hreflang="zh" data-title="Module:WPSHIPS utilities" data-language-autonym="中文" data-language-local-name="Chinese" class="interlanguage-link-target">中文</a></li> </ul> <div class="after-portlet after-portlet-lang"><a href="https://www.wikidata.org/wiki/Special:EntityPage/Q21546112#sitelinks-wikipedia" title="Edit interlanguage links" class="wbc-editpage">Edit links</a></div> </div> </div> </div> </header> <div class="vector-page-toolbar"> <div class="vector-page-toolbar-container"> <div id="left-navigation"> <nav aria-label="Namespaces"> <div id="p-associated-pages" class="vector-menu vector-menu-tabs mw-portlet mw-portlet-associated-pages" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-nstab-module" class="selected vector-tab-noicon mw-list-item"><a href="/wiki/Module:WPSHIPS_utilities" title="View the module page [c]" accesskey="c">Module</a></li><li id="ca-talk" class="vector-tab-noicon mw-list-item"><a href="/wiki/Module_talk:WPSHIPS_utilities" rel="discussion" title="Discuss improvements to the content page [t]" accesskey="t">Talk</a></li> </ul> </div> </div> <div id="vector-variants-dropdown" class="vector-dropdown emptyPortlet" > <input type="checkbox" id="vector-variants-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-variants-dropdown" class="vector-dropdown-checkbox " aria-label="Change language variant" > <label id="vector-variants-dropdown-label" for="vector-variants-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet" aria-hidden="true" >English </label> <div class="vector-dropdown-content"> <div id="p-variants" class="vector-menu mw-portlet mw-portlet-variants emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> </div> </div> </nav> </div> <div id="right-navigation" class="vector-collapsible"> <nav aria-label="Views"> <div id="p-views" class="vector-menu vector-menu-tabs mw-portlet mw-portlet-views" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-view" class="selected vector-tab-noicon mw-list-item"><a href="/wiki/Module:WPSHIPS_utilities">Read</a></li><li id="ca-viewsource" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=Module:WPSHIPS_utilities&action=edit" title="This page is protected.
You can view its source [e]" accesskey="e">View source</a></li><li id="ca-history" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=Module:WPSHIPS_utilities&action=history" title="Past revisions of this page [h]" accesskey="h">View history</a></li> </ul> </div> </div> </nav> <nav class="vector-page-tools-landmark" aria-label="Page tools"> <div id="vector-page-tools-dropdown" class="vector-dropdown vector-page-tools-dropdown" > <input type="checkbox" id="vector-page-tools-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-page-tools-dropdown" class="vector-dropdown-checkbox " aria-label="Tools" > <label id="vector-page-tools-dropdown-label" for="vector-page-tools-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet" aria-hidden="true" >Tools </label> <div class="vector-dropdown-content"> <div id="vector-page-tools-unpinned-container" class="vector-unpinned-container"> <div id="vector-page-tools" class="vector-page-tools vector-pinnable-element"> <div class="vector-pinnable-header vector-page-tools-pinnable-header vector-pinnable-header-unpinned" data-feature-name="page-tools-pinned" data-pinnable-element-id="vector-page-tools" data-pinned-container-id="vector-page-tools-pinned-container" data-unpinned-container-id="vector-page-tools-unpinned-container" > <div class="vector-pinnable-header-label">Tools</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-page-tools.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-page-tools.unpin">hide</button> </div> <div id="p-cactions" class="vector-menu mw-portlet mw-portlet-cactions emptyPortlet vector-has-collapsible-items" title="More options" > <div class="vector-menu-heading"> Actions </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-more-view" class="selected vector-more-collapsible-item mw-list-item"><a href="/wiki/Module:WPSHIPS_utilities">Read</a></li><li id="ca-more-viewsource" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=Module:WPSHIPS_utilities&action=edit">View source</a></li><li id="ca-more-history" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=Module:WPSHIPS_utilities&action=history">View history</a></li> </ul> </div> </div> <div id="p-tb" class="vector-menu mw-portlet mw-portlet-tb" > <div class="vector-menu-heading"> General </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="t-whatlinkshere" class="mw-list-item"><a href="/wiki/Special:WhatLinksHere/Module:WPSHIPS_utilities" title="List of all English Wikipedia pages containing links to this page [j]" accesskey="j">What links here</a></li><li id="t-recentchangeslinked" class="mw-list-item"><a href="/wiki/Special:RecentChangesLinked/Module:WPSHIPS_utilities" rel="nofollow" title="Recent changes in pages linked from this page [k]" accesskey="k">Related changes</a></li><li id="t-upload" class="mw-list-item"><a href="/wiki/Wikipedia:File_Upload_Wizard" title="Upload files [u]" accesskey="u">Upload file</a></li><li id="t-specialpages" class="mw-list-item"><a href="/wiki/Special:SpecialPages" title="A list of all special pages [q]" accesskey="q">Special pages</a></li><li id="t-permalink" class="mw-list-item"><a href="/w/index.php?title=Module:WPSHIPS_utilities&oldid=1252707104" title="Permanent link to this revision of this page">Permanent link</a></li><li id="t-info" class="mw-list-item"><a href="/w/index.php?title=Module:WPSHIPS_utilities&action=info" title="More information about this page">Page information</a></li><li id="t-urlshortener" class="mw-list-item"><a href="/w/index.php?title=Special:UrlShortener&url=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FModule%3AWPSHIPS_utilities">Get shortened URL</a></li><li id="t-urlshortener-qrcode" class="mw-list-item"><a href="/w/index.php?title=Special:QrCode&url=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FModule%3AWPSHIPS_utilities">Download QR code</a></li> </ul> </div> </div> <div id="p-electronpdfservice-sidebar-portlet-heading" class="vector-menu mw-portlet mw-portlet-electronpdfservice-sidebar-portlet-heading" > <div class="vector-menu-heading"> Print/export </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="electron-print_pdf" class="mw-list-item"><a href="/w/index.php?title=Special:DownloadAsPdf&page=Module%3AWPSHIPS_utilities&action=show-download-screen">Download as PDF</a></li><li id="t-print" class="mw-list-item"><a href="javascript:print();" rel="alternate" title="Printable version of this page [p]" accesskey="p">Printable version</a></li> </ul> </div> </div> <div id="p-wikibase-otherprojects" class="vector-menu mw-portlet mw-portlet-wikibase-otherprojects" > <div class="vector-menu-heading"> In other projects </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="t-wikibase" class="wb-otherproject-link wb-otherproject-wikibase-dataitem mw-list-item"><a href="https://www.wikidata.org/wiki/Special:EntityPage/Q21546112" title="Structured data on this page hosted by Wikidata [g]" accesskey="g">Wikidata item</a></li> </ul> </div> </div> </div> </div> </div> </div> </nav> </div> </div> </div> <div class="vector-column-end"> <div class="vector-sticky-pinned-container"> <nav class="vector-page-tools-landmark" aria-label="Page tools"> <div id="vector-page-tools-pinned-container" class="vector-pinned-container"> </div> </nav> <nav class="vector-appearance-landmark" aria-label="Appearance"> <div id="vector-appearance-pinned-container" class="vector-pinned-container"> <div id="vector-appearance" class="vector-appearance vector-pinnable-element"> <div class="vector-pinnable-header vector-appearance-pinnable-header vector-pinnable-header-pinned" data-feature-name="appearance-pinned" data-pinnable-element-id="vector-appearance" data-pinned-container-id="vector-appearance-pinned-container" data-unpinned-container-id="vector-appearance-unpinned-container" > <div class="vector-pinnable-header-label">Appearance</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-appearance.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-appearance.unpin">hide</button> </div> </div> </div> </nav> </div> </div> <div id="bodyContent" class="vector-body" aria-labelledby="firstHeading" data-mw-ve-target-container> <div class="vector-body-before-content"> <div class="mw-indicators"> <div id="mw-indicator-pp-default" class="mw-indicator"><div class="mw-parser-output"><a href="/wiki/Wikipedia:Protection_policy#full" title="This high-risk module is permanently protected to prevent vandalism"><img alt="Permanently protected module" src="//upload.wikimedia.org/wikipedia/en/thumb/4/44/Full-protection-shackle.svg/20px-Full-protection-shackle.svg.png" decoding="async" width="20" height="20" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/en/thumb/4/44/Full-protection-shackle.svg/30px-Full-protection-shackle.svg.png 1.5x, //upload.wikimedia.org/wikipedia/en/thumb/4/44/Full-protection-shackle.svg/40px-Full-protection-shackle.svg.png 2x" data-file-width="512" data-file-height="512" /></a></div></div> </div> <div id="siteSub" class="noprint">From Wikipedia, the free encyclopedia</div> </div> <div id="contentSub"><div id="mw-content-subtitle"></div></div> <div id="mw-content-text" class="mw-body-content"><div class="mw-content-ltr mw-parser-output" lang="en" dir="ltr"><style data-mw-deduplicate="TemplateStyles:r1237875617">.mw-parser-output .documentation,.mw-parser-output .documentation-metadata{border:1px solid #a2a9b1;background-color:#ecfcf4;clear:both}.mw-parser-output .documentation{margin:1em 0 0 0;padding:1em}.mw-parser-output .documentation-metadata{margin:0.2em 0;font-style:italic;padding:0.4em 1em}.mw-parser-output .documentation-startbox{padding-bottom:3px;border-bottom:1px solid #aaa;margin-bottom:1ex}.mw-parser-output .documentation-heading{font-weight:bold;font-size:125%}.mw-parser-output .documentation-clear{clear:both}.mw-parser-output .documentation-toolbar{font-style:normal;font-size:85%}@media screen{html.skin-theme-clientpref-night .mw-parser-output .documentation,html.skin-theme-clientpref-night .mw-parser-output .documentation-metadata{background-color:#0b1e1c}}@media screen and (prefers-color-scheme:dark){html.skin-theme-clientpref-os .mw-parser-output .documentation,html.skin-theme-clientpref-os .mw-parser-output .documentation-metadata{background-color:#0b1e1c}}</style><div class="documentation-container" role="complementary" aria-labelledby="documentation-heading"> <div class="documentation"> <div class="documentation-startbox"> <img alt="" src="//upload.wikimedia.org/wikipedia/commons/thumb/4/43/Test_Template_Info-Icon_-_Version_%282%29.svg/50px-Test_Template_Info-Icon_-_Version_%282%29.svg.png" decoding="async" width="50" height="22" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/4/43/Test_Template_Info-Icon_-_Version_%282%29.svg/75px-Test_Template_Info-Icon_-_Version_%282%29.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/4/43/Test_Template_Info-Icon_-_Version_%282%29.svg/100px-Test_Template_Info-Icon_-_Version_%282%29.svg.png 2x" data-file-width="1792" data-file-height="800" /> Module documentation[<a href="/wiki/Module:WPSHIPS_utilities/doc" title="Module:WPSHIPS utilities/doc">view</a>] [<a href="/wiki/Special:EditPage/Module:WPSHIPS_utilities/doc" title="Special:EditPage/Module:WPSHIPS utilities/doc">edit</a>] [<a href="/wiki/Special:PageHistory/Module:WPSHIPS_utilities/doc" title="Special:PageHistory/Module:WPSHIPS utilities/doc">history</a>] [<a href="/wiki/Special:Purge/Module:WPSHIPS_utilities" title="Special:Purge/Module:WPSHIPS utilities">purge</a>]</div> <style data-mw-deduplicate="TemplateStyles:r1238436933">.mw-parser-output .ombox{margin:4px 0;border-collapse:collapse;border:1px solid #a2a9b1;background-color:var(--background-color-neutral-subtle,#f8f9fa);box-sizing:border-box;color:var(--color-base,#202122)}.mw-parser-output .ombox.mbox-small{font-size:88%;line-height:1.25em}.mw-parser-output .ombox-speedy{border:2px solid #b32424;background-color:#fee7e6}.mw-parser-output .ombox-delete{border:2px solid #b32424}.mw-parser-output .ombox-content{border:1px solid #f28500}.mw-parser-output .ombox-style{border:1px solid #fc3}.mw-parser-output .ombox-move{border:1px solid #9932cc}.mw-parser-output .ombox-protection{border:2px solid #a2a9b1}.mw-parser-output .ombox .mbox-text{border:none;padding:0.25em 0.9em;width:100%}.mw-parser-output .ombox .mbox-image{border:none;padding:2px 0 2px 0.9em;text-align:center}.mw-parser-output .ombox .mbox-imageright{border:none;padding:2px 0.9em 2px 0;text-align:center}.mw-parser-output .ombox .mbox-empty-cell{border:none;padding:0;width:1px}.mw-parser-output .ombox .mbox-invalid-type{text-align:center}@media(min-width:720px){.mw-parser-output .ombox{margin:4px 10%}.mw-parser-output .ombox.mbox-small{clear:right;float:right;margin:4px 0 4px 1em;width:238px}}body.skin--responsive .mw-parser-output table.ombox img{max-width:none!important}@media screen{html.skin-theme-clientpref-night .mw-parser-output .ombox-speedy{background-color:#310402}}@media screen and (prefers-color-scheme:dark){html.skin-theme-clientpref-os .mw-parser-output .ombox-speedy{background-color:#310402}}</style><table class="plainlinks ombox ombox-style" role="presentation"><tbody><tr><td class="mbox-image"><img alt="Warning" src="//upload.wikimedia.org/wikipedia/en/thumb/7/74/Ambox_warning_yellow.svg/40px-Ambox_warning_yellow.svg.png" decoding="async" width="40" height="35" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/en/thumb/7/74/Ambox_warning_yellow.svg/60px-Ambox_warning_yellow.svg.png 1.5x, //upload.wikimedia.org/wikipedia/en/thumb/7/74/Ambox_warning_yellow.svg/80px-Ambox_warning_yellow.svg.png 2x" data-file-width="386" data-file-height="334" /></td><td class="mbox-text">This Lua module is used on <a class="external text" href="https://linkcount.toolforge.org/?project=en.wikipedia.org&page=Module%3AWPSHIPS+utilities#transclusions">approximately 98,000 pages</a> and changes may be widely noticed. Test changes in the module's <a href="/wiki/Module:WPSHIPS_utilities/sandbox" title="Module:WPSHIPS utilities/sandbox">/sandbox</a> or <a href="/w/index.php?title=Module:WPSHIPS_utilities/testcases&action=edit&redlink=1" class="new" title="Module:WPSHIPS utilities/testcases (page does not exist)">/testcases</a> subpages, or in your own <a href="/wiki/Module:Sandbox" title="Module:Sandbox">module sandbox</a>. Consider discussing changes on the <a href="/wiki/Module_talk:WPSHIPS_utilities" title="Module talk:WPSHIPS utilities">talk page</a> before implementing them.</td></tr></tbody></table> <meta property="mw:PageProp/toc" /> <div class="mw-heading mw-heading2"><h2 id="ship_name_format">ship_name_format</h2></div> This function attempts to apply appropriate formatting to unformatted ship names. The formats supported are: <ol><li><(prefix)> <name> <(disambiguator)> where: <ul><li><(prefix)> (optional) – one from a list of defined prefixes commonly used for ships (ARA, HMS, USS, etc.); rendered in upright font</li> <li><name> – the ship's proper name; rendered in italic font</li> <li><(disambiguator)> (optional) – typically the ship's <a href="/wiki/Hull_number" title="Hull number">hull</a> or <a href="/wiki/Pennant_number" title="Pennant number">pennant number</a>, or other disambiguator; always contained in parentheses; rendered in upright font</li></ul></li> <li><name> <(disambiguator)> where: <ul><li><name> – the ship's proper name; rendered in italic font</li> <li><(disambiguator)> (required) – the ship's <a href="/wiki/Hull_number" title="Hull number">hull</a> or <a href="/wiki/Pennant_number" title="Pennant number">pennant number</a> or a recognized ship-type descriptor; always contained in parentheses; rendered in upright font <ul><li>hull and pennant numbers take two basic forms <ul><li>uppercase letters, possibly followed by a space or hyphen, followed by digits (SSBN-659, R07, ON 688)</li> <li>digits, possibly followed by a space or hyphen, followed by uppercase letters (401B)</li></ul></li></ul></li></ul></li> <li><nationality> <ship type> <name> <(disambiguator)> where: <ul><li><nationality> – one- or two- word nation name in adjectival form (Dutch, East Timorese, French, Ottoman, etc.); rendered in upright font</li> <li><ship type> – one from a list of one- to four-word phrases that describes a ship's type (<a href="/wiki/Aviso" title="Aviso">aviso</a>, <a href="/wiki/Brig_sloop" class="mw-redirect" title="Brig sloop">brig sloop</a>, <a href="/wiki/Landing_ship_medium" class="mw-redirect" title="Landing ship medium">landing ship medium</a>, <a href="/wiki/Ship_of_the_line" title="Ship of the line">ship of the line</a>); rendered in upright font</li> <li><name> – the ship's proper name; rendered in italic font</li> <li><(disambiguator)> (optional) – typically the ship's hull or pennant number, or other disambiguator; always contained in parentheses; rendered in upright font</li></ul></li></ol> The function will also attempt to render ship-class names when the name is in the form: <ul><li><name>-class <ship type> where: <ul><li><name> – the class' proper name; rendered in italic font according to the setting of <code class="tpl-para" style="word-break:break-word;">|sclass=</code></li> <li><ship type> – a phrase that describes a ship's type; rendered in upright font</li></ul></li></ul> <div class="mw-heading mw-heading3"><h3 id="Lists">Lists</h3></div> The function relies on three lists to accomplish its task. These lists are: <ol><li><code>ship_prefix_list</code> – a list of commonly used ship prefixes initially taken from <code>{{<a href="/w/index.php?title=Template:Ship_prefix&action=edit&redlink=1" class="new" title="Template:Ship prefix (page does not exist)">ship prefix</a>}}</code>; these are usually, but not always wholly uppercase</li> <li><code>nationality_list</code> – a list of nation names in their adjectival form; these are always capitalized; always one or two words</li> <li><code>ship_type_list</code> – a list ship-type descriptor phrases; these are usually, but not always wholly lowercase; always one to two words</li></ol> To add to any of these lists, the form is: <dl><dd><code>['addition'] = true,</code></dd></dl> the trailing comma is important. See the instructions that accompany each list for limitations and implementation details. <div class="mw-heading mw-heading3"><h3 id="Usage">Usage</h3></div> The minimal form is: <dl><dd><code>{{#invoke:WPSHIPS_utilities|ship_name_format|name=}}</code></dd></dl> <div class="mw-heading mw-heading4"><h4 id="Parameters">Parameters</h4></div> The function requires one parameter and supports several optional parameters. <dl><dd>|name= – (required) the name to format</dd> <dd>|dab=none – for use with <code class="tpl-para" style="word-break:break-word;">|infobox caption=nodab</code> in <code>{{<a href="/wiki/Template:Infobox_ship_begin" title="Template:Infobox ship begin">infobox ship begin</a>}}</code>, excludes a disambiguator from the formatted name</dd> <dd>|sclass=2 – for use with <code>{{DISPLAYTITLE}}</code> and with <code class="tpl-para" style="word-break:break-word;">|infobox caption=yes</code> or <code class="tpl-para" style="word-break:break-word;">|infobox caption=nodab</code> in <code>{{infobox ship begin}}</code>, when the class is not named for a member of the class; causes the class name to be rendered in upright font</dd> <dd>|adj=off – for use in ship-class articles with <code class="tpl-para" style="word-break:break-word;">|infobox caption=yes</code> or <code class="tpl-para" style="word-break:break-word;">|infobox caption=nodab</code> in <code>{{infobox ship begin}}</code>, formats the class name in its noun form and excludes the ship type phrase and disambiguator</dd> <dd>|showerrs=yes – debug tool; not currently supported in any templates;</dd></dl> <div class="mw-heading mw-heading4"><h4 id="Wrapper_template">Wrapper template</h4></div> <ul><li>{{<a href="/wiki/Template:Ship_name_format" title="Template:Ship name format">Ship name format</a>}} is a wrapper template to make it easier for editors to label ships in the main body of articles or as input to templates or modules. It supports the same parameters as the module.</li> <li>In most cases, {{<a href="/wiki/Template:Ship" title="Template:Ship">ship</a>}} is preferred over using this wrapper template or this module.</li> <li>It is useful to set the DISPLAYTITLE of redirects, disambiguation pages, or other pages named after ships which do not use one of the other "ships" templates such as {{<a href="/wiki/Template:Infobox_ship_begin" title="Template:Infobox ship begin">Infobox ship begin</a>}} to do this. Example: <code>{{DISPLAYTITLE:{{ship_name_format|name={{FULLPAGENAME}}}}}}</code></li> <li>Other templates and modules should not transclude this template, instead they should call the module directly.</li> <li>Wikipedia pages should not transclude this template many times, as it may cause the page to exceed Wikipedia's <a href="/wiki/Wikipedia:Template_limits" class="mw-redirect" title="Wikipedia:Template limits">template limits</a>. Those pages should invoke the module directly.</li></ul> <div class="mw-heading mw-heading2"><h2 id="wpsu.navsource()">wpsu.navsource()</h2></div> This function is the driver for <code>{{<a href="/wiki/Template:Navsource" title="Template:Navsource">navsource</a>}}</code>. The function assembles an external wikilink from known fragments and positional parameter <code>{{{1}}}</code>. A ship name provided in positional parameter <code>{{{2}}}</code> is formatted using <code>ship_name_format()</code>. New with this implementation of <code>{{navsource}}</code> is the addition of <code class="tpl-para" style="word-break:break-word;">|showerrs=</code>. The <code>{{#invoke:}}</code> in the template defaults to <code class="tpl-para" style="word-break:break-word;">|showerrs=yes</code> which can be overridden by setting <code class="tpl-para" style="word-break:break-word;">|showerrs=no</code> in the template. <div class="mw-heading mw-heading2"><h2 id="wpsu.hnsa()">wpsu.hnsa()</h2></div> Similar to <code>{{<a href="/wiki/Template:Navsource" title="Template:Navsource">navsource</a>}}</code>, this code supports <code>{{<a href="/wiki/Template:Hnsa" class="mw-redirect" title="Template:Hnsa">hnsa</a>}}</code> by attempting to construct a link to a ship article at the Historic Naval Ships Association website. The template has the form: <dl><dd><code>{{hnsa|<page>|<name>}}</code></dd></dl> where: <dl><dd><page> is the name of the page from the url <code>http://hnsa.org/hnsa-ships/<page></code></dd> <dd><name> (optional) is the name of the ship; if left blank, the template uses the current page title; if a ship name, it is formatted using <code>do_ship_name_format()</code></dd></dl> from which this code produces: <dl><dd><code>[http://hnsa.org/hnsa-ships/<page> <name>] at Historic Naval Ships Association</code></dd></dl> <div class="documentation-clear"></div> </div> <div role="note" class="documentation-metadata plainlinks">The above <a href="/wiki/Wikipedia:Template_documentation" title="Wikipedia:Template documentation">documentation</a> is <a href="/wiki/Help:Transclusion" title="Help:Transclusion">transcluded</a> from <a href="/wiki/Module:WPSHIPS_utilities/doc" title="Module:WPSHIPS utilities/doc">Module:WPSHIPS utilities/doc</a>. (<a href="/wiki/Special:EditPage/Module:WPSHIPS_utilities/doc" title="Special:EditPage/Module:WPSHIPS utilities/doc">edit</a> | <a href="/wiki/Special:PageHistory/Module:WPSHIPS_utilities/doc" title="Special:PageHistory/Module:WPSHIPS utilities/doc">history</a>) Editors can experiment in this module's <a href="/wiki/Module:WPSHIPS_utilities/sandbox" title="Module:WPSHIPS utilities/sandbox">sandbox</a> (<a href="/wiki/Special:EditPage/Module:WPSHIPS_utilities/sandbox" title="Special:EditPage/Module:WPSHIPS utilities/sandbox">edit</a> | <a class="external text" href="https://en.wikipedia.org/w/index.php?title=Special%3AComparePages&page1=Module%3AWPSHIPS+utilities&page2=Module%3AWPSHIPS+utilities%2Fsandbox">diff</a>) and testcases (<a class="external text" href="https://en.wikipedia.org/w/index.php?title=Module:WPSHIPS_utilities/testcases&action=edit&preload=Template%3ADocumentation%2Fpreload-module-testcases">create</a>) pages. <a href="/wiki/Special:PrefixIndex/Module:WPSHIPS_utilities/" title="Special:PrefixIndex/Module:WPSHIPS utilities/">Subpages of this module</a>.</div></div> <div class="mw-highlight mw-highlight-lang-lua mw-content-ltr mw-highlight-lines" dir="ltr"><pre><a href="#L-1"></a>require('strict') <a href="#L-2"></a>local get_args = require ('Module:Arguments').getArgs; <a href="#L-3"></a>local styles = require ('Module:WPMILHIST Infobox style'); -- infobox css <a href="#L-4"></a>local data = mw.loadData ('Module:WPSHIPS utilities/data'); <a href="#L-5"></a>local namespace = mw.title.getCurrentTitle().namespace; -- used for categorization <a href="#L-6"></a> <a href="#L-7"></a> <a href="#L-8"></a>--[[--------------------------< E R R O R _ M A P _ T >-------------------------------------------------------- <a href="#L-9"></a>]] <a href="#L-10"></a> <a href="#L-11"></a>local error_map_t = { -- [1] is error message; [2] is error category <a href="#L-12"></a> synonymous = {'has synonymous parameter', 'Category:Pages using infobox ship with synonymous parameters'}; <a href="#L-13"></a> missing = {'missing required parameter: %s', 'Category:WPSHIPS: sclass and sclass2 errors'}, <a href="#L-14"></a> format = {'invalid format code: %s. Should be 0–5, or blank', 'Category:WPSHIPS: sclass and sclass2 errors'}, <a href="#L-15"></a> missing_name = {'missing name', 'Category:WPSHIPS: Template Ship parameter errors'}, <a href="#L-16"></a> missing_dab = {'missing disambiguator', 'Category:WPSHIPS: Template Ship parameter errors'}, <a href="#L-17"></a> missing_prefix = {'missing prefix', 'Category:WPSHIPS: Template Ship parameter errors'}, <a href="#L-18"></a> invalid_control = {'invalid control parameter: %s', 'Category:WPSHIPS: Template Ship parameter errors'}, <a href="#L-19"></a> } <a href="#L-20"></a> <a href="#L-21"></a> <a href="#L-22"></a>--[[--------------------------< E R R O R _ M S G _ M A K E >-------------------------------------------------- <a href="#L-23"></a> <a href="#L-24"></a>assembles an error message from message text and category in <error_map_t>. creates a help link to the category <a href="#L-25"></a>page; categorizes only main and template namespaces. <a href="#L-26"></a> <a href="#L-27"></a><no_cat> disables categorization for those templates that support it; to disable categorization set <no_cat> true <a href="#L-28"></a> <a href="#L-29"></a>]] <a href="#L-30"></a> <a href="#L-31"></a>local function error_msg_make (msg_idx, template, detail, no_cat, link_template_name) <a href="#L-32"></a> local out = {}; <a href="#L-33"></a> local category; <a href="#L-34"></a> <a href="#L-35"></a> table.insert (out, '\"font-size: 100%; font-style: normal;\" class=\"error\">Error: '); --TODO: simplify? <a href="#L-36"></a> if template then <a href="#L-37"></a> if link_template_name then <a href="#L-38"></a> table.insert (out, table.concat ({'{{[[Template:', template, '|', template, ']]}} '})); <a href="#L-39"></a> else <a href="#L-40"></a> table.insert (out, table.concat ({'{{', template, '}} '})); -- TODO: get template names for synonymous parameter errors <a href="#L-41"></a> end <a href="#L-42"></a> end <a href="#L-43"></a> table.insert (out, string.format (error_map_t[msg_idx][1], detail)); -- build error message from base + <detail> <a href="#L-44"></a> table.insert (out, table.concat ({' ([[:', error_map_t[msg_idx][2], '|help]])'})); -- help text on category pages; TODO: help text on template pages also? <a href="#L-45"></a> table.insert (out, ''); <a href="#L-46"></a> <a href="#L-47"></a> if (0 == namespace or 10 == namespace) and not no_cat then -- categorize in article space (and template space to take care of broken usages) <a href="#L-48"></a> table.insert (out, table.concat ({'[[', error_map_t[msg_idx][2], ']]'})); <a href="#L-49"></a> end <a href="#L-50"></a> <a href="#L-51"></a> return table.concat (out); -- make a big string and done <a href="#L-52"></a>end <a href="#L-53"></a> <a href="#L-54"></a> <a href="#L-55"></a>--[[-------------------------------------------------------------------------------------------- <a href="#L-56"></a> <a href="#L-57"></a>Returns true if argument is set; false otherwise. Argument is 'set' when it exists (not nil) or when it is not an empty string. <a href="#L-58"></a> <a href="#L-59"></a>]] <a href="#L-60"></a> <a href="#L-61"></a>local function is_set( var ) <a href="#L-62"></a> return not (var == nil or var == ''); <a href="#L-63"></a>end <a href="#L-64"></a> <a href="#L-65"></a> <a href="#L-66"></a>--[[--------------------------< S I Z E O F _ S H I P _ T Y P E >---------------------------------------------- <a href="#L-67"></a> <a href="#L-68"></a>Returns the size in words of ship type. Inputs are the fragment table, the number of elements in the fragment table, <a href="#L-69"></a>and the number of words that make up nationality. <a href="#L-70"></a> <a href="#L-71"></a>The number of fragments (words) in a ship name dictate the possible sizes of ship type. If nationality takes one fragment, <a href="#L-72"></a>and ship type takes four fragments, then the minimum number of fragments in a composite ship name is: <a href="#L-73"></a> 5 = 1 (nationality) + 3 (ship type) + 1 (ship name) (same as 4 fragments (words) after nationality) <a href="#L-74"></a> <a href="#L-75"></a>This function starts at the longest possible series of fragments that might be ship type. This order is important becuase <a href="#L-76"></a>some ship types might begin with similar fragments: 'ship' and 'ship of the line'. Starting with the least possible <a href="#L-77"></a>series of fragments (1) would find 'ship' and make 'of the line' part of the italicized name. <a href="#L-78"></a> <a href="#L-79"></a>Returns 0 if there is no recognizable ship type. <a href="#L-80"></a> <a href="#L-81"></a>]] <a href="#L-82"></a> <a href="#L-83"></a>local function sizeof_ship_type (frag, frag_len, nat_len) <a href="#L-84"></a> local ship_type; <a href="#L-85"></a> <a href="#L-86"></a> if 5 <= (frag_len - nat_len) then -- must have at least five fragments after nationality for four-word ship type <a href="#L-87"></a> ship_type = table.concat (frag, ' ', nat_len+1, nat_len+4); -- four-word ship type <a href="#L-88"></a> if data.ship_type_t[ship_type] then <a href="#L-89"></a> return 4; <a href="#L-90"></a> end <a href="#L-91"></a> end <a href="#L-92"></a> if 4 <= (frag_len - nat_len) then -- must have at least four fragments after nationality for three-word ship type <a href="#L-93"></a> ship_type = table.concat (frag, ' ', nat_len+1, nat_len+3); -- three-word ship type <a href="#L-94"></a> if data.ship_type_t[ship_type] then <a href="#L-95"></a> return 3; <a href="#L-96"></a> end <a href="#L-97"></a> end <a href="#L-98"></a> if 3 <= (frag_len - nat_len) then -- must have at least three fragments after nationality for two-word ship type <a href="#L-99"></a> ship_type = table.concat (frag, ' ', nat_len+1, nat_len+2); -- two-word ship type <a href="#L-100"></a> if data.ship_type_t[ship_type] then <a href="#L-101"></a> return 2; <a href="#L-102"></a> end <a href="#L-103"></a> end <a href="#L-104"></a> if 2 <= (frag_len - nat_len) then -- must have at least two fragments after nationality for one-word ship type <a href="#L-105"></a> if data.ship_type_t[frag[nat_len+1]] then -- one-word ship type <a href="#L-106"></a> return 1; <a href="#L-107"></a> end <a href="#L-108"></a> end <a href="#L-109"></a> return 0; -- no recognizable ship type <a href="#L-110"></a>end <a href="#L-111"></a> <a href="#L-112"></a>--[[--------------------------< S I Z E O F _ N A T I O N A L I T Y >------------------------------------------ <a href="#L-113"></a> <a href="#L-114"></a>This function the size (in words) of the nationality from the fragments table. Nationality may be one or two <a href="#L-115"></a>words that occupy the first one or two positions in the table. <a href="#L-116"></a> <a href="#L-117"></a>Returns the number of words that identify the nationality: <a href="#L-118"></a> 1 for French or German, etc. <a href="#L-119"></a> 2 for United States; <a href="#L-120"></a> 0 when table doesn't have a recognizable nationality <a href="#L-121"></a> <a href="#L-122"></a>]] <a href="#L-123"></a> <a href="#L-124"></a>local function sizeof_nationality (frag, frag_len) <a href="#L-125"></a> local nat = ''; <a href="#L-126"></a> <a href="#L-127"></a> if not data.nationality_t [frag[1]] then -- if not a one-word nationality <a href="#L-128"></a> if 2 <= frag_len - 2 then -- must have at least two fragments after nationality for minimal ship type and name <a href="#L-129"></a> nat = table.concat (frag, ' ', 1, 2); <a href="#L-130"></a> if data.nationality_t [nat] then -- is it a two-word nationality? <a href="#L-131"></a> return 2; -- yes <a href="#L-132"></a> else <a href="#L-133"></a> return 0; -- no <a href="#L-134"></a> end <a href="#L-135"></a> end <a href="#L-136"></a> return 0; -- not one-word and not enough fragments for two-word <a href="#L-137"></a> end <a href="#L-138"></a> return 1; -- one-word nationality <a href="#L-139"></a>end <a href="#L-140"></a> <a href="#L-141"></a> <a href="#L-142"></a>--[[-------------------------< D O _ S H I P _ N A M E _ F O R M A T >----------------------------------------- <a href="#L-143"></a> <a href="#L-144"></a>This function applies correct styling to ship and ship-class names. These names are, for example, ship-article titles <a href="#L-145"></a>used by templates {{navsource}}, {{Infobox ship begin}}, where the article title is to be rendered with proper <a href="#L-146"></a>styling. <a href="#L-147"></a> <a href="#L-148"></a>This function requires one argument: <a href="#L-149"></a> |name= (required): a name is required; if missing or empty, this function returns an error message (may or may not be visible depending on where it is used) <a href="#L-150"></a> used in {{infobox ship begin}} to provide a value for {{DISPLAYTITLE:}} and to provide a value for |infobox caption= <a href="#L-151"></a> {{#invoke:WPSHIPS_utilities|ship_name_format|name={{PAGENAME}}}} <a href="#L-152"></a>Optional arguments to support {{infobox ship begin}}: <a href="#L-153"></a> |dab=none – displays ship name without parenthetical disambiguator; use when |infobox caption=nodab <a href="#L-154"></a> |sclass=2 – for ship classes only; displays class name without italics (parameter name is loosely similar to {{slcass2}} which does the same thing); use when |infobox caption=class <a href="#L-155"></a> |adj=off – for ship classes only; displays class name as a noun (no hyphen, no ship type); use when |infobox caption=class <a href="#L-156"></a> <a href="#L-157"></a>Arguments are passed in a table. <a href="#L-158"></a> <a href="#L-159"></a>to call this function locally: <a href="#L-160"></a> do_ship_name_format ({['name=name'], ['dab']=dab, ['sclass']=sclass, ['adj']=adj, ['showerrs']=showerrs}) or <a href="#L-161"></a> args = {['name=name'], ['dab']=dab, ['sclass']=sclass, ['adj']=adj, ['showerrs']=showerrs}; <a href="#L-162"></a> do_ship_name_format (args) <a href="#L-163"></a> <a href="#L-164"></a>The function returns the formatted name or, if unable to format the name, the original name and an unformatted error message. <a href="#L-165"></a> <a href="#L-166"></a>]] <a href="#L-167"></a> <a href="#L-168"></a>local function do_ship_name_format (args) <a href="#L-169"></a> local name_sans_dab; -- the ship or class name without a trailing parenthetical dab <a href="#L-170"></a> local dab; -- the dab stripped from the name <a href="#L-171"></a> local fragments = {}; -- a table of words that make up name_sans_dab <a href="#L-172"></a> local ship_type; -- a word or phrase that describes a ship <a href="#L-173"></a> local type_len; -- the number of words that describe a ship <a href="#L-174"></a> local nat_len; -- the number of words used to specify a ship's nationality <a href="#L-175"></a> local name = ''; -- the reassembles and formatted ship name <a href="#L-176"></a> local error_msg = ''; -- a repository for error messages if any <a href="#L-177"></a> <a href="#L-178"></a>-- args.name = mw.text.decode (args.name); -- replace html entities in title with their characters; doesn't work for &amp; and &#38; in prefix <a href="#L-179"></a> args.name = args.name:gsub ("&#39;", "\'"); -- replace html appostrophe with the character <a href="#L-180"></a>-- args.name = args.name:gsub ("&amp;", "&"); <a href="#L-181"></a>-- args.name = args.name:gsub ("&#38;", "&"); <a href="#L-182"></a>-- args.name = args.name:gsub ("&amp;", "&#38;"); <a href="#L-183"></a> <a href="#L-184"></a> <a href="#L-185"></a> if args.name:match ('.+%-class%s+%a+') then -- if a ship-class <a href="#L-186"></a> fragments = mw.text.split (args.name, '-class' ); -- split at -class <a href="#L-187"></a> if '2' == args.sclass then -- for DISPLAYTITLE and infobox caption when class not named for a member of the class <a href="#L-188"></a> if 'off' == args.adj then <a href="#L-189"></a> return fragments[1] .. ' class'; -- for infobox caption do noun form <name> class (no hyphen, no ship type) <a href="#L-190"></a> end <a href="#L-191"></a> return args.name; -- nothing to do so return original unformatted name <a href="#L-192"></a> end <a href="#L-193"></a> if 'off' == args.adj then <a href="#L-194"></a> return "''" .. fragments[1] .. "'' class"; -- for infobox caption do noun form <name> class (no hyphen, no ship type) <a href="#L-195"></a> end <a href="#L-196"></a> return "''" .. fragments[1] .. "''-class" .. fragments[2]; -- and return formatted adjectival name <a href="#L-197"></a> end <a href="#L-198"></a> -- not a ship class so try to format a ship name <a href="#L-199"></a> name_sans_dab, dab = args.name:match('^(.+)%s+(%b())%s*$'); -- split name into name_sans_dab and dab <a href="#L-200"></a> if is_set (dab) then <a href="#L-201"></a> dab = ' ' .. dab; -- insert a space for later reassembly <a href="#L-202"></a> else <a href="#L-203"></a> name_sans_dab = args.name; -- because without a dab, the string.match returns nil <a href="#L-204"></a> dab = ''; -- empty string for concatenation <a href="#L-205"></a> end <a href="#L-206"></a> <a href="#L-207"></a> fragments = mw.text.split (name_sans_dab, '%s' ); -- split into a table of separate words <a href="#L-208"></a> <a href="#L-209"></a> nat_len = sizeof_nationality (fragments, #fragments); -- get the number of words in the ship's nationality <a href="#L-210"></a> if 0 < nat_len then -- if not zero we have a valid nationality <a href="#L-211"></a> type_len = sizeof_ship_type (fragments, #fragments, nat_len); -- get the number of words in the ship type <a href="#L-212"></a> if 0 < type_len then -- if not zero, ship type is valid; nationality and type not italics, the rest is name <a href="#L-213"></a> name = "''" .. table.concat (fragments, ' ', nat_len + type_len + 1) .. "''"; -- format name <a href="#L-214"></a> if 'none' == args.dab then -- for |infobox caption=nodab <a href="#L-215"></a> return name; -- return the formatted name without the nationality or ship type or dab <a href="#L-216"></a> end <a href="#L-217"></a> name = table.concat (fragments, ' ', 1, nat_len + type_len) .. " " .. name; -- assemble everything but dab <a href="#L-218"></a> else <a href="#L-219"></a> error_msg = ' unrecognized ship type;'; -- valid nationality, invalid ship type <a href="#L-220"></a> end <a href="#L-221"></a> elseif data.ship_prefix_t[fragments[1]] then -- if the first fragment is a ship prefix <a href="#L-222"></a> name = table.remove (fragments, 1); -- fetch it from the table <a href="#L-223"></a> name = name .. " ''" .. table.concat (fragments, ' ') .. "''"; -- assemble formatted name <a href="#L-224"></a> else <a href="#L-225"></a> error_msg = ' no nationality or prefix;'; -- invalid nationality and first word in ship name not a valid prefix <a href="#L-226"></a> end <a href="#L-227"></a> <a href="#L-228"></a> if is_set (name) then -- name will be set if we were able to format it <a href="#L-229"></a> if 'none' == args.dab then -- for |infobox caption=nodab <a href="#L-230"></a> return name; -- return the formatted name without the dab <a href="#L-231"></a> end <a href="#L-232"></a> return name .. dab; -- return the formatted name with the dab <a href="#L-233"></a> end <a href="#L-234"></a> <a href="#L-235"></a> if is_set (dab) then <a href="#L-236"></a> if dab:match ('%(%u+[%- ]?%d+%)') or -- one or more uppercase letters, optional space or hyphen, one or more digits <a href="#L-237"></a> dab:match ('%(%d+[%- ]?%u+%)') or -- one or more digits, optional space or hyphen, one or more uppercase letters <a href="#L-238"></a> dab:match ('%(%u[%u%-]*%-%d+%)') or -- one or more uppercase letters with hyphens, a hyphen, one or more digits (e.g., T-AO-157) <a href="#L-239"></a> dab:match ('%([12]%d%d%d%)') then -- four digits representing year in the range 1000–2999 <a href="#L-240"></a> name = "''" .. table.concat (fragments, ' ') .. "''"; -- format the name <a href="#L-241"></a> if 'none' == args.dab then -- for |infobox caption=nodab <a href="#L-242"></a> return name; -- return the formatted name without the dab <a href="#L-243"></a> end <a href="#L-244"></a> return name .. dab; -- return the formatted name with the dab <a href="#L-245"></a> end <a href="#L-246"></a> -- last chance, is there a ship type in the dab? <a href="#L-247"></a> for key, _ in pairs (data.ship_type_t) do -- spin through the ship type list and see if there is a ship type (key) in the dab <a href="#L-248"></a> if dab:find ('%f[%a]' .. key .. '%f[^%a]') then -- avoid matches that are not whole word <a href="#L-249"></a> name = "''" .. table.concat (fragments, ' ') .. "''"; -- format the name <a href="#L-250"></a> if 'none' == args.dab then -- for |infobox caption=nodab <a href="#L-251"></a> return name; -- return the formatted name without the dab <a href="#L-252"></a> end <a href="#L-253"></a> return name .. dab; -- return the formatted name with the dab <a href="#L-254"></a> end <a href="#L-255"></a> end <a href="#L-256"></a> error_msg = error_msg .. ' no ship type in dab;'; <a href="#L-257"></a> <a href="#L-258"></a> if 'none' == args.dab then -- for |infobox caption=nodab <a href="#L-259"></a> return table.concat (fragments, ' '), error_msg; -- return the unformatted name without the dab, and an error message <a href="#L-260"></a> end <a href="#L-261"></a> end <a href="#L-262"></a> <a href="#L-263"></a> return args.name, error_msg; -- return original un-formatted name with unformatted error message if any <a href="#L-264"></a>end <a href="#L-265"></a> <a href="#L-266"></a> <a href="#L-267"></a>--[[-------------------------< S H I P _ N A M E _ F O R M A T >----------------------------------------------- <a href="#L-268"></a> <a href="#L-269"></a>This function is the external interface to do_ship_name_format(). <a href="#L-270"></a> <a href="#L-271"></a>The function requires one parameter: <a href="#L-272"></a> |name= (required): a name is required; if missing or empty, this function returns an error message (may or may not be visible depending on where it is used) <a href="#L-273"></a> used in {{infobox ship begin}} to provide a value for {{DISPLAYTITLE:}} and to provide a value for |infobox caption= <a href="#L-274"></a> {{#invoke:WPSHIPS_utilities|ship_name_format|name={{PAGENAME}}}} <a href="#L-275"></a>Optional parameters to support {{infobox ship begin}}: <a href="#L-276"></a> |dab=none – displays ship name without parenthetical disambiguator; use when |infobox caption=nodab <a href="#L-277"></a> |sclass=2 – for ship classes only; displays class name without italics (parameter name is loosely similar to {{slcass2}} which does the same thing); use when |infobox caption=class <a href="#L-278"></a> |adj=off – for ship classes only; displays class name as a noun (no hyphen, no ship type); use when |infobox caption=class <a href="#L-279"></a>Other optional parameters: <a href="#L-280"></a> |showerrs=yes – marginally useful; can display error messages if the module invocation is not buried in a template <a href="#L-281"></a> <a href="#L-282"></a>Values from the above parameters are placed in a table and that table passed as an argument in the call to do_ship_name_format(). <a href="#L-283"></a> <a href="#L-284"></a>do_ship_name_format() returns two strings: a name and an error message. If do_ship_name_format() could format the name, it returns the formatted name and <a href="#L-285"></a>an empty string for the error message. If it could not format the name, do_ship_name_format() returns the original name and an error message. <a href="#L-286"></a> <a href="#L-287"></a>Formatting of the error message, in response to |showerrs=yes is the responsibility of the calling function. <a href="#L-288"></a> <a href="#L-289"></a>]] <a href="#L-290"></a> <a href="#L-291"></a>local function ship_name_format(frame) <a href="#L-292"></a> local name = ''; -- destination of the formatted ship name <a href="#L-293"></a> local error_msg = ''; -- destination of any error message <a href="#L-294"></a> <a href="#L-295"></a> if not is_set (frame.args.name) then -- if a ship name not provided <a href="#L-296"></a> if 'yes' == frame.args.showerrs then -- and we're supposed to show errors <a href="#L-297"></a> error_msg = 'Empty name'; -- return an empty string error message if there is no name <a href="#L-298"></a> end <a href="#L-299"></a> else <a href="#L-300"></a> name, error_msg = do_ship_name_format (frame.args); -- get formatted name and error message <a href="#L-301"></a> if is_set (error_msg) and 'yes' == frame.args.showerrs then -- if appropriate, show error message <a href="#L-302"></a> error_msg = '' .. error_msg .. ''; <a href="#L-303"></a> else <a href="#L-304"></a> error_msg = ''; -- for concatenation <a href="#L-305"></a> end <a href="#L-306"></a> end <a href="#L-307"></a> <a href="#L-308"></a> return name .. error_msg; -- return name and error message <a href="#L-309"></a>end <a href="#L-310"></a> <a href="#L-311"></a> <a href="#L-312"></a>--[[--------------------------< H N S A >---------------------------------------------------------------------- <a href="#L-313"></a> <a href="#L-314"></a>Similar to {{navsource}}, this code supports {{hnsa}} by attempting to construct a link to a ship article at the <a href="#L-315"></a>the Historic Nava Ships Association website. <a href="#L-316"></a> <a href="#L-317"></a>The template has the form: <a href="#L-318"></a> {{hnsa|<page>|<name>}} <a href="#L-319"></a>where: <a href="#L-320"></a> <page> is the name of the page at http://hnsa.org/hnsa-ships/<page> <a href="#L-321"></a> <name> (optional) is the name of the ship; if left blank, the template uses the current page title; if a ship name, it is formatted <a href="#L-322"></a>from which this code produces: <a href="#L-323"></a> [http://hnsa.org/hnsa-ships/<page> <name>] at Historic Naval Ships Association <a href="#L-324"></a> <a href="#L-325"></a>]] <a href="#L-326"></a> <a href="#L-327"></a>local function hnsa (frame) <a href="#L-328"></a> local pframe = frame:getParent() -- get arguments from calling template frame <a href="#L-329"></a> local ship_name = ''; <a href="#L-330"></a> local error_msg = ''; <a href="#L-331"></a> local article_title = mw.title.getCurrentTitle().text; -- fetch the article title <a href="#L-332"></a> <a href="#L-333"></a> if not is_set (pframe.args[1]) then <a href="#L-334"></a> return 'missing hsna page'; <a href="#L-335"></a> end <a href="#L-336"></a> <a href="#L-337"></a> local fmt_params = {['name']='', ['showerrs']=nil}; <a href="#L-338"></a> <a href="#L-339"></a> if is_set (pframe.args.showerrs) then -- if showerrs set in template, override showerrs in #invoke: <a href="#L-340"></a> fmt_params.showerrs = pframe.args.showerrs; -- template value <a href="#L-341"></a> else <a href="#L-342"></a> fmt_params.showerrs = frame.args.showerrs; -- invoke value <a href="#L-343"></a> end <a href="#L-344"></a> <a href="#L-345"></a> if is_set (pframe.args[2]) then <a href="#L-346"></a> fmt_params.name = pframe.args[2]; <a href="#L-347"></a> else <a href="#L-348"></a> fmt_params.name = article_title; -- use article title <a href="#L-349"></a> end <a href="#L-350"></a> <a href="#L-351"></a> ship_name, error_msg = do_ship_name_format (fmt_params); <a href="#L-352"></a> <a href="#L-353"></a> if is_set (error_msg) and is_set (pframe.args[2]) then -- if unable to format the name <a href="#L-354"></a> local escaped_name = pframe.args[2]:gsub("([%(%)%.%-])", "%%%1"); -- escape some of the Lua magic characters <a href="#L-355"></a> if pframe.args[2] == article_title or -- is name same as article title? <a href="#L-356"></a> nil ~= article_title:find ('%f[%a]' .. escaped_name .. '%f[%s]') or -- is name a word or words substring of article title? <a href="#L-357"></a> nil ~= article_title:find ('%f[%a]' .. escaped_name .. '$') then -- is name a word or words substring that ends article title? <a href="#L-358"></a> ship_name = "''" .. pframe.args[2] .. "''"; -- non-standard 'name'; perhaps just the name without prefix and dab; <a href="#L-359"></a> error_msg = ''; -- unset because we think we have a name <a href="#L-360"></a> end <a href="#L-361"></a> end <a href="#L-362"></a> if is_set (error_msg) and 'yes' == fmt_params.showerrs then <a href="#L-363"></a> error_msg = '' .. error_msg .. ''; <a href="#L-364"></a> else <a href="#L-365"></a> error_msg = ''; -- unset so it doesn't diplay <a href="#L-366"></a> end <a href="#L-367"></a> <a href="#L-368"></a> local output = { <a href="#L-369"></a> '[http://www.hnsa.org/hnsa-ships/', <a href="#L-370"></a> pframe.args[1], <a href="#L-371"></a> '/ ', <a href="#L-372"></a> ship_name, <a href="#L-373"></a> '] at Historic Naval Ships Association', <a href="#L-374"></a> error_msg, <a href="#L-375"></a> } <a href="#L-376"></a> <a href="#L-377"></a> return table.concat (output); <a href="#L-378"></a>end <a href="#L-379"></a> <a href="#L-380"></a> <a href="#L-381"></a>--[[--------------------------< N A V S O U R C E >------------------------------------------------------------ <a href="#L-382"></a> <a href="#L-383"></a>This version of the template {{navsource}} was added as a test vehicle for do_ship_name_format(). <a href="#L-384"></a> <a href="#L-385"></a>]] <a href="#L-386"></a> <a href="#L-387"></a>local function navsource (frame) <a href="#L-388"></a> local pframe = frame:getParent() -- get arguments from calling template frame <a href="#L-389"></a> local ship_name = ''; <a href="#L-390"></a> local error_msg = ''; <a href="#L-391"></a> local article_title = mw.title.getCurrentTitle().text; -- fetch the article title <a href="#L-392"></a> <a href="#L-393"></a> if not is_set (pframe.args[1]) then <a href="#L-394"></a> return 'missing navsource URLcode'; <a href="#L-395"></a> end <a href="#L-396"></a> <a href="#L-397"></a> local fmt_params = {['name']='', ['showerrs']=nil}; <a href="#L-398"></a> <a href="#L-399"></a> if is_set (pframe.args.showerrs) then -- if showerrs set in template, override showerrs in #invoke: <a href="#L-400"></a> fmt_params.showerrs = pframe.args.showerrs; -- template value <a href="#L-401"></a> else <a href="#L-402"></a> fmt_params.showerrs = frame.args.showerrs; -- invoke value <a href="#L-403"></a> end <a href="#L-404"></a> <a href="#L-405"></a> if is_set (pframe.args[2]) then <a href="#L-406"></a> fmt_params.name = pframe.args[2]; <a href="#L-407"></a> else <a href="#L-408"></a> fmt_params.name = article_title; -- use article title <a href="#L-409"></a> end <a href="#L-410"></a> <a href="#L-411"></a> ship_name, error_msg = do_ship_name_format (fmt_params); <a href="#L-412"></a> <a href="#L-413"></a> if is_set (error_msg) and is_set (pframe.args[2]) then -- if unable to format the name <a href="#L-414"></a> local escaped_name = pframe.args[2]:gsub("([%(%)%.%-])", "%%%1"); -- escape some of the Lua magic characters <a href="#L-415"></a> if pframe.args[2] == article_title or -- is name same as article title? <a href="#L-416"></a> nil ~= article_title:find ('%f[%a]' .. escaped_name .. '%f[%s]') or -- is name a word or words substring of article title? <a href="#L-417"></a> nil ~= article_title:find ('%f[%a]' .. escaped_name .. '$') then -- is name a word or words substring that ends article title? <a href="#L-418"></a> ship_name = "''" .. pframe.args[2] .. "''"; -- non-standard 'name'; perhaps just the name without prefix and dab; <a href="#L-419"></a> error_msg = ''; -- unset because we think we have a name <a href="#L-420"></a> end <a href="#L-421"></a> end <a href="#L-422"></a> if is_set (error_msg) and 'yes' == fmt_params.showerrs then <a href="#L-423"></a> error_msg = '' .. error_msg .. ''; <a href="#L-424"></a> else <a href="#L-425"></a> error_msg = ''; -- unset so it doesn't diplay <a href="#L-426"></a> end <a href="#L-427"></a> <a href="#L-428"></a> local output = { <a href="#L-429"></a> '[http://www.navsource.org/archives/', <a href="#L-430"></a> pframe.args[1], <a href="#L-431"></a> '.htm Photo gallery] of ', <a href="#L-432"></a> ship_name, <a href="#L-433"></a> ' at NavSource Naval History', <a href="#L-434"></a> error_msg, <a href="#L-435"></a> } <a href="#L-436"></a> <a href="#L-437"></a> return table.concat (output); <a href="#L-438"></a>end <a href="#L-439"></a> <a href="#L-440"></a> <a href="#L-441"></a>--[[--------------------------< _ S H I P >-------------------------------------------------------------------- <a href="#L-442"></a> <a href="#L-443"></a>This is a possible replacement for the template {{ship}}. It has better error detection and handling. <a href="#L-444"></a> <a href="#L-445"></a>]] <a href="#L-446"></a> <a href="#L-447"></a>local function _ship (prefix, name, dab, control, unlinked_prefix, unlinked_whole, template, no_cat) <a href="#L-448"></a> local error_msg = ''; <a href="#L-449"></a> local category = ''; <a href="#L-450"></a> <a href="#L-451"></a> if not is_set (control) then <a href="#L-452"></a> control = ''; -- if not provided, ensure that control is empty string for comparisons <a href="#L-453"></a> elseif control:find ('%-') then -- shortcut for |link=no when using a format control parameter ...|SSBN-659|-6}} same as ...|SSBN-659|6|link=no}} <a href="#L-454"></a> unlinked_whole = true; -- set the unlinked flag <a href="#L-455"></a> control = control:match ('%d'); -- strip out the hyphen <a href="#L-456"></a> end <a href="#L-457"></a> <a href="#L-458"></a> -- dispose of error conditions straight away <a href="#L-459"></a> if not is_set (name) then -- this is the only required parameter <a href="#L-460"></a> error_msg = error_msg_make ('missing_name', template, '', no_cat, true); <a href="#L-461"></a> elseif not is_set (dab) and ('1' == control or '3' == control or '5' == control) then -- dab required when control value set to expect it <a href="#L-462"></a> error_msg = error_msg_make ('missing_dab', template, '', no_cat, true); <a href="#L-463"></a> elseif not is_set (prefix) and ('5' == control or '6' == control) then -- prefix required when control value set to expect it <a href="#L-464"></a> error_msg = error_msg_make ('missing_prefix', template, '', no_cat, true); <a href="#L-465"></a> elseif '4' == control then -- displaying only the prefix <a href="#L-466"></a> error_msg = error_msg_make ('invalid_control', template, control, no_cat, true); <a href="#L-467"></a> elseif is_set (control) then <a href="#L-468"></a> if ('number' ~= type (tonumber (control))) or (1 ~= control:len()) or (1 > tonumber (control) or 6 < tonumber (control)) then -- control must be a single-digit number 1 through 6 <a href="#L-469"></a> error_msg = error_msg_make ('invalid_control', template, control, no_cat, true); <a href="#L-470"></a> end <a href="#L-471"></a> elseif not is_set (prefix) and unlinked_prefix then -- prefix required when |up=yes <a href="#L-472"></a> error_msg = error_msg_make ('missing_prefix', template, '', no_cat, true); <a href="#L-473"></a> end <a href="#L-474"></a> <a href="#L-475"></a> if is_set (error_msg) then <a href="#L-476"></a> return error_msg; <a href="#L-477"></a> end <a href="#L-478"></a> <a href="#L-479"></a> local link_name; <a href="#L-480"></a> local link = ''; <a href="#L-481"></a> <a href="#L-482"></a> if is_set (prefix) then <a href="#L-483"></a> link = prefix .. ' ' .. name; -- begin assembling the article name (link) portion of the wikilink <a href="#L-484"></a> else <a href="#L-485"></a> link = name; <a href="#L-486"></a> end <a href="#L-487"></a> <a href="#L-488"></a> if is_set (dab) then <a href="#L-489"></a> link = link .. ' (' .. dab .. ')'; -- wrap dab in parentheses <a href="#L-490"></a> end <a href="#L-491"></a> <a href="#L-492"></a> local target_object = mw.title.new (link).redirectTarget; -- if <link> points to a redirect <a href="#L-493"></a> if target_object then <a href="#L-494"></a> link = target_object.fullText; -- get the target title to avoid linking through the redirect <a href="#L-495"></a> end <a href="#L-496"></a> <a href="#L-497"></a> name = "''" .. name .. "''"; -- name is always italicized so do it now <a href="#L-498"></a> <a href="#L-499"></a> if '1' == control then <a href="#L-500"></a> link_name = dab; -- special case when displaying only the dab, don't wrap in parentheses <a href="#L-501"></a> end <a href="#L-502"></a> <a href="#L-503"></a> if is_set (dab) then -- for all other cases that display dab <a href="#L-504"></a> if '5' == control then <a href="#L-505"></a> dab = "&nbsp;\'\'" .. dab .. "\'\'"; -- for prefix with dab display HMS A1. italicize the dab <a href="#L-506"></a> else <a href="#L-507"></a> dab = '&nbsp;(' .. dab .. ')'; -- except for dab-only, all others display with parentheses <a href="#L-508"></a> end <a href="#L-509"></a> end <a href="#L-510"></a> <a href="#L-511"></a> if not is_set (control) then -- when control not set: prefix, name, and dab <a href="#L-512"></a> if is_set (prefix) then <a href="#L-513"></a> link_name = prefix .. '&nbsp;' .. name .. dab; <a href="#L-514"></a> else <a href="#L-515"></a> link_name = name .. dab; <a href="#L-516"></a> end <a href="#L-517"></a> else -- when control is not 1 or none <a href="#L-518"></a> if '2' == control then -- name only <a href="#L-519"></a> link_name = name; <a href="#L-520"></a> elseif '3' == control then -- name and dab <a href="#L-521"></a> link_name = name .. dab; <a href="#L-522"></a> elseif '5' == control then -- prefix and dab <a href="#L-523"></a> link_name = prefix .. dab; <a href="#L-524"></a> elseif '6' == control then -- prefix and name <a href="#L-525"></a> link_name = prefix .. '&nbsp;' .. name; <a href="#L-526"></a> end <a href="#L-527"></a> end <a href="#L-528"></a> <a href="#L-529"></a> if '5' ~= control and'6' ~= control and is_set (control) then <a href="#L-530"></a> unlinked_prefix = false; -- no prefix so don't try to unlink it <a href="#L-531"></a> end <a href="#L-532"></a> <a href="#L-533"></a> if unlinked_whole then <a href="#L-534"></a> return link_name; -- no linking desired so done <a href="#L-535"></a> elseif unlinked_prefix and is_set (prefix) then -- when there is a prefix to unlink <a href="#L-536"></a> link_name = link_name:gsub ('^.-&nbsp;', '', 1); -- remove the prefix and nbsp <a href="#L-537"></a> return prefix .. '&nbsp;[[' .. link .. '|' .. link_name .. ']]'; -- add prefix and nbsp to front and done <a href="#L-538"></a> else <a href="#L-539"></a> return '[[' .. link .. '|' .. link_name .. ']]'; -- construct the wikilink and done <a href="#L-540"></a> end <a href="#L-541"></a>end <a href="#L-542"></a> <a href="#L-543"></a> <a href="#L-544"></a>--[[--------------------------< S H I P >---------------------------------------------------------------------- <a href="#L-545"></a> <a href="#L-546"></a>This is a possible replacement for the template {{ship}}. It has better error detection and handling. <a href="#L-547"></a> <a href="#L-548"></a>This function is the externally accessible entry point for template {{ship}}, {{HMS}}, {{USS}}, etc <a href="#L-549"></a> <a href="#L-550"></a>{{#invoke:WPSHIPS_utilities|ship|_template=<template name>}} <a href="#L-551"></a> <a href="#L-552"></a>{{#invoke:WPSHIPS_utilities|ship_pre|prefix=<prefix>|_template=<template name>}} <a href="#L-553"></a> <a href="#L-554"></a>Parameters in the module frame are: <a href="#L-555"></a> there are no module frame parameters <a href="#L-556"></a> <a href="#L-557"></a>Parameters in the template frame are: <a href="#L-558"></a> {{{1|}}} – prefix (HMS, USS, Japanese submarine, etc) <a href="#L-559"></a> {{{2|}}} – ship's name (required) <a href="#L-560"></a> {{{3|}}} – disambiguator (year, hull or pennant number, etc) <a href="#L-561"></a> {{{4|}}} – format control (1, 2, 3, 5, 6; 4 not allowed) <a href="#L-562"></a> |wl= – when set to 'no', rendering is not wikilinked <a href="#L-563"></a> |up= – when set to 'yes' prefix (if rendered) is not linked <a href="#L-564"></a> <a href="#L-565"></a>]] <a href="#L-566"></a> <a href="#L-567"></a>local function ship (frame) -- this version not supported from the template yet <a href="#L-568"></a> local args_t = get_args (frame); <a href="#L-569"></a> <a href="#L-570"></a> local prefix = args_t[1] or ''; -- fetch positional parameters into named variables for readability <a href="#L-571"></a> local name = args_t[2] or ''; -- stripped of leading and trailing whitespace <a href="#L-572"></a> local dab = args_t[3] or ''; -- empty positional parameters are nil so convert nil to empty string <a href="#L-573"></a> local control = args_t[4]; <a href="#L-574"></a> local unlinked_prefix = 'yes' == args_t.up; -- make boolean: true when |up=yes <a href="#L-575"></a> local unlinked_whole = 'no' == args_t.wl; -- make boolean: true when |wl=no <a href="#L-576"></a> local no_cat = 'yes' == args_t['no-tracking']; -- make boolean: true when |no-tracking=yes <a href="#L-577"></a> <a href="#L-578"></a> return _ship (prefix, name, dab, control, unlinked_prefix, unlinked_whole, 'Ship', no_cat); <a href="#L-579"></a>end <a href="#L-580"></a> <a href="#L-581"></a> <a href="#L-582"></a>--[[--------------------------< S H I P _ P R E F I X _ T E M P L A T E S >------------------------------------ <a href="#L-583"></a> <a href="#L-584"></a>This is a possible replacement for the template prefix templates {{USS}}, {{HMS}}, etc. It has better error <a href="#L-585"></a>detection and handling. <a href="#L-586"></a> <a href="#L-587"></a>This function is the externally accessible entry point for those templates <a href="#L-588"></a> <a href="#L-589"></a>{{#invoke:WPSHIPS_utilities|ship_prefix_templates|prefix=<prefix>|template=<template name>}} <a href="#L-590"></a> <a href="#L-591"></a>Parameters in the module frame are: <a href="#L-592"></a> |_prefix= – (required) _prefix (HMS, USS, Japanese submarine, etc) <a href="#L-593"></a> |_template= template name for error messages; optional when |prefix= same as template name <a href="#L-594"></a> <a href="#L-595"></a>Parameters in the template frame are: <a href="#L-596"></a> {{{1|}}} – ship's name (required) <a href="#L-597"></a> {{{2|}}} – disambiguator (year, hull or pennant number, etc) <a href="#L-598"></a> {{{3|}}} – format control (1, 2, 3, 5, 6; 4 not allowed) <a href="#L-599"></a> |wl= – when set to 'no', rendering is not wikilinked <a href="#L-600"></a> |up= – when set to 'yes' prefix (if rendered) is not linked <a href="#L-601"></a> <a href="#L-602"></a>]] <a href="#L-603"></a> <a href="#L-604"></a>local function ship_prefix_templates (frame) -- this version not supported from the templates yet <a href="#L-605"></a> local args_t = get_args (frame); <a href="#L-606"></a> <a href="#L-607"></a> local prefix = args_t.prefix or ''; -- fetch positional parameters into named variables for readability <a href="#L-608"></a> local name = args_t[1] or ''; -- stripped of leading and trailing whitespace <a href="#L-609"></a> local dab = args_t[2] or ''; -- empty positional parameters are nil so convert nil to empty string <a href="#L-610"></a> local control = args_t[3]; <a href="#L-611"></a> local unlinked_prefix = 'yes' == args_t.up; -- make boolean: true when |up=yes <a href="#L-612"></a> local unlinked_whole = 'no' == args_t.wl; -- make boolean: true when |wl=no <a href="#L-613"></a> local no_cat = 'yes' == args_t['no-tracking']; -- make boolean: true when |no-tracking=yes <a href="#L-614"></a> <a href="#L-615"></a> return _ship (prefix, name, dab, control, unlinked_prefix, unlinked_whole, args_t.template_name or prefix, no_cat); <a href="#L-616"></a>end <a href="#L-617"></a> <a href="#L-618"></a> <a href="#L-619"></a>--[[--------------------------< L I S T _ E R R O R >---------------------------------------------------------- <a href="#L-620"></a> <a href="#L-621"></a>Assembles an error message, the original parameter value and, if appropriate a category. The error message precedes <a href="#L-622"></a>the existing value of the parameter. If the first non-whitespace character in the parameter is a '*', set prefix to <a href="#L-623"></a>a '*' and sep to '\n'. For line-break lists, set prefix to empty string and sep to ' '. <a href="#L-624"></a> <a href="#L-625"></a>Category is appended to the end of the returned value only for pages in article space. <a href="#L-626"></a> <a href="#L-627"></a>Inputs: <a href="#L-628"></a> prefix – a string of characters that precede the error message span; typically '' and '*' <a href="#L-629"></a> message – the error message to be displayed; goes inside the span <a href="#L-630"></a> sep – a string of characters that separates the span from the parameter value; typically '\n' and ' ' <a href="#L-631"></a> param_val – the unmodified parameter value <a href="#L-632"></a> showerrs – a boolean, true to display the error message text <a href="#L-633"></a> <a href="#L-634"></a>]] <a href="#L-635"></a> <a href="#L-636"></a>local function list_error (prefix, message, sep, param_val, showerrs) <a href="#L-637"></a> local err_msg = '%slist error: %s ([[:Category:WPSHIPS:Infobox list errors|help]])%s%s%s'; <a href="#L-638"></a> local category = ''; <a href="#L-639"></a> <a href="#L-640"></a> if 0 == mw.title.getCurrentTitle().namespace then -- only categorize pages in article space <a href="#L-641"></a> category = '[[Category:WPSHIPS:Infobox list errors]]'; <a href="#L-642"></a> end <a href="#L-643"></a> if true == showerrs then <a href="#L-644"></a> return string.format (err_msg, prefix, message, sep, param_val, category); -- put it all together <a href="#L-645"></a> else <a href="#L-646"></a> return param_val .. category; <a href="#L-647"></a> end <a href="#L-648"></a>end <a href="#L-649"></a> <a href="#L-650"></a> <a href="#L-651"></a>--[[-------------------------------------------------------------------------- <a href="#L-652"></a> <a href="#L-653"></a>Mediawiki:Common.css imposes limitations on plain, unbulleted lists. The template {{plainlist}} does not render this correctly: <a href="#L-654"></a>{{plainlist| <a href="#L-655"></a>*Item 1 <a href="#L-656"></a>*Item 2 <a href="#L-657"></a>**Item 2a <a href="#L-658"></a>***Item 2a1 <a href="#L-659"></a>**Item 2b <a href="#L-660"></a>*Item 3}} <a href="#L-661"></a>The above renders without proper indents for items marked ** and ***. <a href="#L-662"></a> <a href="#L-663"></a>If the list is not wrapped in {{plainlist}} then the above list is rendered with bullets which is contrary to the Infobox ship usage guide. <a href="#L-664"></a> <a href="#L-665"></a>This code translates a bulleted list into an html unordered list: <a href="#L-666"></a> <a href="#L-667"></a><ul style="list-style:none; margin:0;"> <a href="#L-668"></a> <li>Name 1</li> <a href="#L-669"></a> <li>Name 2</li> <a href="#L-670"></a> <ul style="list-style:none"> <a href="#L-671"></a> <li>Subname 2a</li> <a href="#L-672"></a> <ul style="list-style:none"> <a href="#L-673"></a> <li>Subname 2a1</li> <a href="#L-674"></a> </ul> <a href="#L-675"></a> <li>Subname 2b</li> <a href="#L-676"></a> </ul> <a href="#L-677"></a> <li>Name 3</li> <a href="#L-678"></a></ul> <a href="#L-679"></a> <a href="#L-680"></a>There are rules: <a href="#L-681"></a> 1. The parameter value must begin with a splat but may have leading and trailing whitespace. <a href="#L-682"></a> 2. Each list item after the first must begin on a new line just as is required by normal bulleted lists. <a href="#L-683"></a> 3. When adding a sublevel, the number of splats may increase by one and never more. This is illegal: <a href="#L-684"></a> *item <a href="#L-685"></a> ***item <a href="#L-686"></a>When any of these rules are violated, unbulleted_list() returns the original text and adds the article <a href="#L-687"></a>to Category:WPSHIPS:Infobox list errors. Error messaging in this function is somewhat sketchy so they are <a href="#L-688"></a>disabled. After initial adoption, better error messaging could/should be implemented. <a href="#L-689"></a> <a href="#L-690"></a>This function receives the content of one parameter: <a href="#L-691"></a> {{#invoke:WPSHIPS utilities|unbulleted_list|{{{param|}}}}} <a href="#L-692"></a> <a href="#L-693"></a>]] <a href="#L-694"></a> <a href="#L-695"></a>local function _unbulleted_list (param) <a href="#L-696"></a> local showerrs = true; -- set to false to hide error messages <a href="#L-697"></a> local List_item_otag = '<li style="padding-left: .4em; text-indent: -.4em;">'; -- hanging indent markup; everything moves right with padding-left; first line moved left by neg indent <a href="#L-698"></a> <a href="#L-699"></a> if nil == param:match ('^%s*%*') then -- parameter value must begin with a splat (ignoring leading white space) <a href="#L-700"></a> if param:match ('<[%s/]*[Bb][Rr][%s/]*>') then -- if the parameter value has a list using variants of tag <a href="#L-701"></a> return list_error ('', '&lt;br /> list', ' ', param, showerrs); -- return an error message with maintenance category <a href="#L-702"></a> elseif param:match ('<div style="clear:') then <a href="#L-703"></a> return list_error ('', '{{clear}} list', ' ', param, showerrs); -- return an error message with maintenance category <a href="#L-704"></a> elseif param:match ('.+\n%*') then -- if the parameter value has text followed by an unordered list <a href="#L-705"></a> return list_error ('', 'mixed text and list', ' ', param, showerrs); -- return an error message with maintenance category <a href="#L-706"></a> end <a href="#L-707"></a> return param; -- return the parameter as is <a href="#L-708"></a> end <a href="#L-709"></a> <a href="#L-710"></a> local item_table = mw.text.split (mw.text.trim (param), '\n'); -- trim white space from end then make a table of bulleted items by splitting on newlines <a href="#L-711"></a> if 1 == #item_table then -- if only one bulleted item, no need for a list <a href="#L-712"></a> return (item_table[1]:gsub ('^%*%s*', '')); -- trim off the splat and any following white space and done <a href="#L-713"></a> end <a href="#L-714"></a> <a href="#L-715"></a> if item_table[1]:match ('^%*%*+') then -- if first list item uses more than one splat, that's an error <a href="#L-716"></a> return list_error ('*', 'too many * at start of list', '\n', param, showerrs); -- return an error message with maintenance category <a href="#L-717"></a> end <a href="#L-718"></a> <a href="#L-719"></a> local html_table = {}; -- table to hold the html output <a href="#L-720"></a> local level = 1; -- used to indicate when a new <ul> is required <a href="#L-721"></a> local splats = 0; -- number of splats that start each item in the list <a href="#L-722"></a> local item = ''; -- the item text <a href="#L-723"></a> <a href="#L-724"></a> table.insert (html_table, '<ul style="list-style:none; margin:0;">') -- this for first <ul> tag; sets no bullets and no indent <a href="#L-725"></a> <a href="#L-726"></a> for _,v in ipairs (item_table) do <a href="#L-727"></a> splats, item = v:match ('(%*+)%s*(.*)'); -- split the item into splats and item text <a href="#L-728"></a> if nil == splats then -- nil if there is an extra line between items <a href="#L-729"></a> return list_error ('*', 'list item missing markup', '\n', param, showerrs); -- return an error message with maintenance category <a href="#L-730"></a> elseif '' == item then <a href="#L-731"></a> return list_error ('*', 'empty list item', '\n', param, showerrs); -- return an error message with maintenance category <a href="#L-732"></a> elseif item:match ('^[;:]') then -- if the list item is mixed unordered list / description list markup (*:) <a href="#L-733"></a> return list_error ('*', 'mixed list type', '\n', param, showerrs); -- return an error message with maintenance category <a href="#L-734"></a> end <a href="#L-735"></a> <a href="#L-736"></a> splats = splats:len(); -- change string of splats into a number indicating how many splats there are <a href="#L-737"></a> <a href="#L-738"></a> if splats == level then -- if at the same level as previous item <a href="#L-739"></a> table.insert (html_table, List_item_otag .. item .. '</li>'); <a href="#L-740"></a> elseif splats == level + 1 then -- number of splats can only increase by one <a href="#L-741"></a> level = splats; -- record the new level <a href="#L-742"></a> table.insert (html_table, '<ul style="list-style: none">'); -- add a new sublist <a href="#L-743"></a> table.insert (html_table, List_item_otag .. item .. '</li>'); -- and the item <a href="#L-744"></a> elseif splats < level then -- from three splats to one splat for example <a href="#L-745"></a> while splats < level do <a href="#L-746"></a> table.insert (html_table, '</ul>'); -- close each sub <ul> until level and splats match <a href="#L-747"></a> level = level - 1; <a href="#L-748"></a> end <a href="#L-749"></a> table.insert (html_table, List_item_otag .. item .. '</li>'); -- add the item <a href="#L-750"></a> else -- jumping more than one level up – one splat to three splats for example – is an error <a href="#L-751"></a> return list_error ('*', 'too many asterisks', '\n', param, showerrs); -- return an error message with maintenance category <a href="#L-752"></a> end <a href="#L-753"></a> end <a href="#L-754"></a> <a href="#L-755"></a> while 0 < level do <a href="#L-756"></a> table.insert (html_table, '</ul>'); -- close each <ul> until level counted down to zero <a href="#L-757"></a> level = level - 1; <a href="#L-758"></a> end <a href="#L-759"></a> <a href="#L-760"></a> return table.concat (html_table, '\n'); -- return the list as a string <a href="#L-761"></a>end <a href="#L-762"></a> <a href="#L-763"></a> <a href="#L-764"></a>--[[-------------------------------------------------------------------------- <a href="#L-765"></a> <a href="#L-766"></a>external entry point <a href="#L-767"></a> <a href="#L-768"></a>]] <a href="#L-769"></a> <a href="#L-770"></a>local function unbulleted_list (frame) <a href="#L-771"></a> return _unbulleted_list (frame.args[1]) <a href="#L-772"></a>end <a href="#L-773"></a> <a href="#L-774"></a> <a href="#L-775"></a>--[=[-------------------------< _I N F O B O X _ S H I P _ F L A G >-------------------------------------------- <a href="#L-776"></a> <a href="#L-777"></a>Output of {{shipboxflag|USA}}: <a href="#L-778"></a> [[File:Flag of the United States.svg|100x35px|alt=|link=]] <a href="#L-779"></a> <a href="#L-780"></a>Image syntax: <a href="#L-781"></a> [[File:Name|Type|Border|Location|Alignment|Size|link=Link|alt=Alt|Caption]] <a href="#L-782"></a> <a href="#L-783"></a>This function standardizes the size of flag images in the infobox ship career header by simply overwriting the Size <a href="#L-784"></a>parameter value in the Image wikilink with |100x28px. This size leave a 1px gap between the top and bottom of the flag image and <a href="#L-785"></a>the header edge. A similar left-side gap of 2px is supplied by {{infobox ship career}}. <a href="#L-786"></a> <a href="#L-787"></a>]=] <a href="#L-788"></a> <a href="#L-789"></a>local function _infobox_ship_flag (image) <a href="#L-790"></a> if image:match ('|[%s%dx]+px%s*') then -- is there a size positional parameter? <a href="#L-791"></a> image = image:gsub('|[%s%dx]+px%s*', '%|100x28px'); -- overwrite it with |100x28px <a href="#L-792"></a> else <a href="#L-793"></a> return 'malformed flag image' <a href="#L-794"></a> end <a href="#L-795"></a> return image; -- return the modified image <a href="#L-796"></a>end <a href="#L-797"></a> <a href="#L-798"></a> <a href="#L-799"></a>--[=[--------------------------------------------------------------------- <a href="#L-800"></a> <a href="#L-801"></a>external entry point <a href="#L-802"></a> <a href="#L-803"></a>]=] <a href="#L-804"></a> <a href="#L-805"></a>local function infobox_ship_flag (frame) <a href="#L-806"></a> if not is_set (frame.args[1]) then -- if |Ship flag= not set <a href="#L-807"></a> return ''; -- return empty string <a href="#L-808"></a> end <a href="#L-809"></a> <a href="#L-810"></a> return _infobox_ship_flag (frame.args[1]); -- return the modified image <a href="#L-811"></a>end <a href="#L-812"></a> <a href="#L-813"></a> <a href="#L-814"></a>--[=[-------------------------< C I T E _ D A N F S _ T I T L E >---------------------------------------------- <a href="#L-815"></a> <a href="#L-816"></a>This function attempts to render a DANFS article title in more or less proper (per Wikipedia) format for the <a href="#L-817"></a>template {{cite danfs}}. DANFS titles typically take one of four forms: <a href="#L-818"></a> <ship name> <disambiguator> <hull number> <a href="#L-819"></a> <ship name> <hull number> <a href="#L-820"></a> <ship name> <disambiguator> <a href="#L-821"></a> <ship name> <a href="#L-822"></a> <a href="#L-823"></a>Here, we extract the various parts, italicize the ship name and reassemble for use by the cite danfs |title= parameter. <a href="#L-824"></a>To call this function: <a href="#L-825"></a> |title={{#invoke:WPSHIPS utilities|cite_danfs_title|{{{title}}}}} <a href="#L-826"></a> <a href="#L-827"></a>]=] <a href="#L-828"></a> <a href="#L-829"></a>local function cite_danfs_title (frame) <a href="#L-830"></a> local name; <a href="#L-831"></a> local disambiguator; <a href="#L-832"></a> local hullnum; <a href="#L-833"></a> <a href="#L-834"></a> if not is_set (frame.args[1]) then -- if |title= not set <a href="#L-835"></a> return ''; -- return empty string <a href="#L-836"></a> end <a href="#L-837"></a> <a href="#L-838"></a> name, disambiguator, hullnum = frame.args[1]:match ('(.-)( [XVI]+)( %([^%)]+%))$'); <a href="#L-839"></a> if not (name and disambiguator and hullnum) then <a href="#L-840"></a> disambiguator = ''; -- empty string for concatenation <a href="#L-841"></a> name, hullnum = frame.args[1]:match ('(.-)( %([^%)]+%))$'); <a href="#L-842"></a> if not (name and hullnum) then <a href="#L-843"></a> hullnum = ''; -- empty string for concatenation <a href="#L-844"></a> name, disambiguator = frame.args[1]:match ('(.-)( [XVI]+)$'); <a href="#L-845"></a> if not (name and disambiguator) then <a href="#L-846"></a> disambiguator = ''; <a href="#L-847"></a> name = frame.args[1]; -- just a name or something we don't recognize <a href="#L-848"></a> end <a href="#L-849"></a> end <a href="#L-850"></a> end <a href="#L-851"></a> <a href="#L-852"></a> return table.concat ({"''", name, "''", disambiguator, hullnum}); -- reassemble and done <a href="#L-853"></a>end <a href="#L-854"></a> <a href="#L-855"></a> <a href="#L-856"></a>--[[--------------------------< S Y N O N Y M _ C H E C K >---------------------------------------------------- <a href="#L-857"></a> <a href="#L-858"></a>support function for infoboxen functions <a href="#L-859"></a> <a href="#L-860"></a>there are a handful of infoboxen parameters that are synonymous pairs. This function is called to see if both <a href="#L-861"></a>of the parameters in a synonymous pair have been assigned a value. When both have assigned values, each gets an <a href="#L-862"></a>error message appended to it. Most of the synonymous pairs are UK Emglish v US English so the variable names <a href="#L-863"></a> <a href="#L-864"></a><args_t> table of template parameters and values <a href="#L-865"></a><uk_param> UK English parameter name <a href="#L-866"></a><us_param> US English parameter name <a href="#L-867"></a><error_flag> boolean that this function sets true when both of a pair are set; controls addition of maint category <a href="#L-868"></a> <a href="#L-869"></a>]] <a href="#L-870"></a> <a href="#L-871"></a>local function synonym_check (args_t, uk_param, us_param, error_flag) <a href="#L-872"></a> if args_t[uk_param] and args_t[us_param] then <a href="#L-873"></a> <a href="#L-874"></a> args_t[uk_param] = args_t[uk_param] .. error_msg_make ('synonymous'); -- both are set so append error message with category <a href="#L-875"></a> args_t[us_param] = args_t[us_param] .. error_msg_make ('synonymous', nil, nil, true); -- but append error message without category <a href="#L-876"></a> return true; -- inform the calling function that it needs to emit maint category <a href="#L-877"></a> end <a href="#L-878"></a> return error_flag; -- no match so return unmodified <error_flag> <a href="#L-879"></a>end <a href="#L-880"></a> <a href="#L-881"></a>--[[--------------------------< L I N E _ I T E M S >---------------------------------------------------------- <a href="#L-882"></a> <a href="#L-883"></a>support function for infoboxen functions <a href="#L-884"></a> <a href="#L-885"></a>This function handles all infobox ship parameters that are 'line items' (label followed by value) because all <a href="#L-886"></a>of these sorts of parameters are rendered with exacty the same formatting. <a href="#L-887"></a> <a href="#L-888"></a>params_t{} is a table of tables where the params_t{} keys are the template's parameter names. The params_t{} <a href="#L-889"></a>values are sequences where [1] is an index number that defines where in the rendering the label/value pair is <a href="#L-890"></a>positioned and [2] is the label that will be rendered when the parameter has a value. <a href="#L-891"></a> <a href="#L-892"></a>This indexing is used because params_t{} is not a sequence and because pairs() does not necessarily return the <a href="#L-893"></a>'next' k/v pair. <a href="#L-894"></a> <a href="#L-895"></a>This function spins through params_t{} and writes html for parameters that have assigned values into temp_t{} <a href="#L-896"></a>according to the 'index' value in the associated sequance table. When parameters are missing or empty, this <a href="#L-897"></a>function writes an empty string into the associated location in lines_t{} so that lines_t{} can be concatenated <a href="#L-898"></a>into a string value that is returned to the calling function. <a href="#L-899"></a> <a href="#L-900"></a>args_t is the arguments table from the template frame. <a href="#L-901"></a> <a href="#L-902"></a>]] <a href="#L-903"></a> <a href="#L-904"></a>local function line_items (args_t, params_t) <a href="#L-905"></a> local lines_t = {}; -- a sequence table of rendered label/value html lines; one for each key in params_t{} <a href="#L-906"></a> <a href="#L-907"></a> for k, v in pairs (params_t) do -- k is templat e parameter name; v is a sequence table with index and associated label <a href="#L-908"></a> local temp_t = {} -- initialize/reinitialize for next line item <a href="#L-909"></a> if not args_t[k] then -- if no assigned value then <a href="#L-910"></a> lines_t[v[1]] = ''; -- set to empty string for concatenation <a href="#L-911"></a> else <a href="#L-912"></a> table.insert (temp_t, '<tr style="vertical-align:top;"><td style="font-weight: bold">'); -- open the line item row and cell <a href="#L-913"></a> table.insert (temp_t, v[2]); -- add parameter's label text <a href="#L-914"></a> table.insert (temp_t, '</td><td>'); -- close that cell and open the parameter value cell <a href="#L-915"></a> table.insert (temp_t, _unbulleted_list (args_t[k])); -- add the parameter's value; formatted as unordered list if appropriate <a href="#L-916"></a> table.insert (temp_t, '</td></tr>\n'); -- close that cell and this row <a href="#L-917"></a> end <a href="#L-918"></a> lines_t[v[1]] = table.concat (temp_t); -- concatenate and put the line item in the lines sequence table at the index position <a href="#L-919"></a> end <a href="#L-920"></a> <a href="#L-921"></a> return table.concat (lines_t); -- make a big string of line items and done <a href="#L-922"></a> <a href="#L-923"></a>end <a href="#L-924"></a> <a href="#L-925"></a> <a href="#L-926"></a>--[[------------------------------------------------------------ <a href="#L-927"></a> <a href="#L-928"></a>temporary(?) code to add Category:WPSHIPS: articles with empty infobox templates when empty infobox templates <a href="#L-929"></a>are encountered. A template is empty when no parameters have assigned values or when the only parameter with an <a href="#L-930"></a>assigned value is |Hide header= <a href="#L-931"></a> <a href="#L-932"></a>when 'empty', returns the category name; nil else <a href="#L-933"></a> <a href="#L-934"></a>]] <a href="#L-935"></a> <a href="#L-936"></a>local function is_empty_ibox_template (args_t) <a href="#L-937"></a> local i = 0; <a href="#L-938"></a> for k, v in pairs (args_t) do <a href="#L-939"></a> i = i + 1; <a href="#L-940"></a> end <a href="#L-941"></a> if ((1 == i) and args_t['Hide header']) or (0 == i) then <a href="#L-942"></a> return '[[Category:WPSHIPS: articles with empty infobox templates]]'; <a href="#L-943"></a> end <a href="#L-944"></a>end <a href="#L-945"></a> <a href="#L-946"></a> <a href="#L-947"></a>--[[------------------------------------------------------------------ <a href="#L-948"></a> <a href="#L-949"></a>implements {{Infobox ship career}} <a href="#L-950"></a> <a href="#L-951"></a>{{#invoke:WPSHIPS utilities|infobox_ship_career}} <a href="#L-952"></a> <a href="#L-953"></a>]] <a href="#L-954"></a> <a href="#L-955"></a>local function infobox_ship_career (frame) <a href="#L-956"></a> local args_t = get_args (frame); -- get a table of all parameters in the template call <a href="#L-957"></a> <a href="#L-958"></a> local err_cat = is_empty_ibox_template (args_t); -- look for and identify empty templates <a href="#L-959"></a> if err_cat then <a href="#L-960"></a> return err_cat; -- template is empty so return the category and done <a href="#L-961"></a> end <a href="#L-962"></a> <a href="#L-963"></a> local html_out_t = {}; -- html table text goes here <a href="#L-964"></a> local error_flag = false; -- controls emission of maint category when synonymous parameters are both set <a href="#L-965"></a> <a href="#L-966"></a> args_t['Hide header'] = args_t['Hide header'] and args_t['Hide header']:lower(); -- set to lowercase if set <a href="#L-967"></a> <a href="#L-968"></a> error_flag = synonym_check (args_t, 'Ship stricken', 'Ship struck', error_flag); -- error if both synonymous parameters set <a href="#L-969"></a> error_flag = synonym_check (args_t, 'Ship honours', 'Ship honors', error_flag); <a href="#L-970"></a> <a href="#L-971"></a> if 'yes' ~= args_t['Hide header'] then -- |Hide header=yes then no header <a href="#L-972"></a> if not ('title' == args_t['Hide header']) then -- |Hide header=title then no title bar <a href="#L-973"></a> table.insert (html_out_t, '<tr><th colspan="2" '); <a href="#L-974"></a> table.insert (html_out_t, styles.header_bar); -- style from WPMILHIST <a href="#L-975"></a> table.insert (html_out_t, '>History</th></tr>\n'); <a href="#L-976"></a> end <a href="#L-977"></a> <a href="#L-978"></a> if args_t['Ship country'] and args_t['Ship flag'] then <a href="#L-979"></a> table.insert (html_out_t, '<tr><th height="30" colspan="2" style="background-color:#B0C4DE;text-align:left;padding-left:2px;vertical-align:middle;font-size:110%;">'); <a href="#L-980"></a> table.insert (html_out_t, _infobox_ship_flag (args_t['Ship flag'])); <a href="#L-981"></a> table.insert (html_out_t, ''); <a href="#L-982"></a> table.insert (html_out_t, args_t['Ship country']); <a href="#L-983"></a> table.insert (html_out_t, ''); <a href="#L-984"></a> table.insert (html_out_t, '</th></tr>\n'); <a href="#L-985"></a> elseif args_t['Ship country'] then <a href="#L-986"></a> table.insert (html_out_t, '<tr><th height="30" colspan="2" style="background-color:#B0C4DE;text-align:center;vertical-align:middle;font-size:110%;">'); <a href="#L-987"></a> table.insert (html_out_t, args_t['Ship country']); <a href="#L-988"></a> table.insert (html_out_t, '</th></tr>\n'); <a href="#L-989"></a> elseif args_t['Ship flag'] then <a href="#L-990"></a> table.insert (html_out_t, '<tr><th height="30" colspan="2" style="background-color:#B0C4DE;padding-left:2px;">'); <a href="#L-991"></a> table.insert (html_out_t, _infobox_ship_flag (args_t['Ship flag'])); <a href="#L-992"></a> table.insert (html_out_t, '</th></tr>\n'); <a href="#L-993"></a> end <a href="#L-994"></a> end <a href="#L-995"></a> <a href="#L-996"></a> table.insert (html_out_t, line_items (args_t, data.infobox_career_params_t)); -- add all of the rest of the template's html <a href="#L-997"></a> <a href="#L-998"></a>--mw.logObject (table.concat (html_out_t)); <a href="#L-999"></a> return table.concat (html_out_t); -- make a big string and done <a href="#L-1000"></a>end <a href="#L-1001"></a> <a href="#L-1002"></a> <a href="#L-1003"></a>--[[------------------------------------------------ <a href="#L-1004"></a> <a href="#L-1005"></a>implements {{Infobox ship characteristics}} <a href="#L-1006"></a> <a href="#L-1007"></a>{{#invoke:WPSHIPS utilities|infobox_ship_characteristics}} <a href="#L-1008"></a> <a href="#L-1009"></a>]] <a href="#L-1010"></a> <a href="#L-1011"></a>local function infobox_ship_characteristics (frame) <a href="#L-1012"></a> local args_t = get_args (frame); -- get a table of all parameters in the template call <a href="#L-1013"></a> <a href="#L-1014"></a> local err_cat = is_empty_ibox_template (args_t); -- look for and identify empty templates <a href="#L-1015"></a> if err_cat then <a href="#L-1016"></a> return err_cat; -- template is empty so return the category and done <a href="#L-1017"></a> end <a href="#L-1018"></a> <a href="#L-1019"></a> local html_out_t = {}; -- html table text goes here <a href="#L-1020"></a> local error_flag = false; -- controls emission of maint category when synonymous parameters are both set <a href="#L-1021"></a> <a href="#L-1022"></a> args_t['Hide header'] = args_t['Hide header'] and args_t['Hide header']:lower(); -- set to lowercase if set <a href="#L-1023"></a> <a href="#L-1024"></a> error_flag = synonym_check (args_t, 'Ship armour', 'Ship armor', error_flag); -- error if both synonymous parameters set <a href="#L-1025"></a> error_flag = synonym_check (args_t, 'Ship draught', 'Ship draft', error_flag); <a href="#L-1026"></a> <a href="#L-1027"></a> if 'yes' ~= args_t['Hide header'] then -- |Hide header=yes then no header <a href="#L-1028"></a> table.insert (html_out_t, '<tr><th colspan="2" '); <a href="#L-1029"></a> table.insert (html_out_t, styles.header_bar); -- style from WPMILHIST <a href="#L-1030"></a> table.insert (html_out_t, '>General characteristics'); <a href="#L-1031"></a> if args_t['Header caption'] then <a href="#L-1032"></a> table.insert (html_out_t, ' '); <a href="#L-1033"></a> table.insert (html_out_t, args_t['Header caption']); <a href="#L-1034"></a> end <a href="#L-1035"></a> table.insert (html_out_t, '</th></tr>\n'); <a href="#L-1036"></a> end <a href="#L-1037"></a> <a href="#L-1038"></a> table.insert (html_out_t, line_items (args_t, data.infobox_characteristics_params_t)); -- add all of the rest of the template's html <a href="#L-1039"></a> <a href="#L-1040"></a>--mw.logObject (table.concat (html_out_t)); <a href="#L-1041"></a> return table.concat (html_out_t); -- make a big string and done <a href="#L-1042"></a>end <a href="#L-1043"></a> <a href="#L-1044"></a> <a href="#L-1045"></a>--[[-------------------------------------------------- <a href="#L-1046"></a> <a href="#L-1047"></a>implements {{Infobox ship class overview}} <a href="#L-1048"></a> <a href="#L-1049"></a>{{#invoke:WPSHIPS utilities|infobox_ship_class_overview}} <a href="#L-1050"></a> <a href="#L-1051"></a>]] <a href="#L-1052"></a> <a href="#L-1053"></a>local function infobox_ship_class_overview (frame) <a href="#L-1054"></a> local args_t = get_args (frame); -- get a table of all parameters in the template call <a href="#L-1055"></a> <a href="#L-1056"></a> local err_cat = is_empty_ibox_template (args_t); -- look for and identify empty templates <a href="#L-1057"></a> if err_cat then <a href="#L-1058"></a> return err_cat; -- template is empty so return the category and done <a href="#L-1059"></a> end <a href="#L-1060"></a> <a href="#L-1061"></a> local html_out_t = {}; -- html table text goes here <a href="#L-1062"></a> <a href="#L-1063"></a> args_t['Hide header'] = args_t['Hide header'] and args_t['Hide header']:lower(); <a href="#L-1064"></a> <a href="#L-1065"></a> if 'yes' ~= args_t['Hide header'] then -- |Hide header=yes then no header <a href="#L-1066"></a> table.insert (html_out_t, '<tr><th colspan="2" '); <a href="#L-1067"></a> table.insert (html_out_t, styles.header_bar); -- style from WPMILHIST <a href="#L-1068"></a> table.insert (html_out_t, '>Class overview</th></tr>\n'); <a href="#L-1069"></a> end <a href="#L-1070"></a> <a href="#L-1071"></a> table.insert (html_out_t, line_items (args_t, data.infobox_class_overview_params_t)); -- add all of the rest of the template's html <a href="#L-1072"></a> <a href="#L-1073"></a>--mw.logObject (table.concat (html_out_t)); <a href="#L-1074"></a> return table.concat (html_out_t); -- make a big string and done <a href="#L-1075"></a>end <a href="#L-1076"></a> <a href="#L-1077"></a> <a href="#L-1078"></a>--[[---------------------------------------------------------------- <a href="#L-1079"></a> <a href="#L-1080"></a>validate cite plimsoll |filename=<filename> <a href="#L-1081"></a> <a href="#L-1082"></a><filename> format is: YYvssss.pdf where <a href="#L-1083"></a> YY - least significant two digits of four-digit first year in a two-year range <a href="#L-1084"></a> 30 -> 1930–1931 <a href="#L-1085"></a> allowed values are all integers between and including 30–45 <a href="#L-1086"></a> v - a single lowercase letter 'a' or 'b' <a href="#L-1087"></a> 'a' -> volume I <a href="#L-1088"></a> 'b' -> volume II <a href="#L-1089"></a> ssss - scan number begins with 0001 <a href="#L-1090"></a> odd numbered scans have English headings <a href="#L-1091"></a> even numbered scans have French headings <a href="#L-1092"></a> <a href="#L-1093"></a> {{#invoke:WPSHIPS utilities|is_plimsoll_filename|{{{filename}}}}} <a href="#L-1094"></a> <a href="#L-1095"></a>]] <a href="#L-1096"></a> <a href="#L-1097"></a>local function is_plimsoll_filename (frame) <a href="#L-1098"></a> local args_t = get_args (frame); -- get a table of all parameters in the invoke <a href="#L-1099"></a> <a href="#L-1100"></a> local year, volume, scan; <a href="#L-1101"></a> if args_t[1] then -- this to avoid script errors when args_t[1] missing <a href="#L-1102"></a> year, volume, scan = args_t[1]:match ('(%d%d)(%l)(%d%d%d%d)%.[Pp][Dd][Ff]'); -- get the various parts <a href="#L-1103"></a> end <a href="#L-1104"></a> if not year then return nil end -- nil when no match so we're done <a href="#L-1105"></a> year = tonumber (year); <a href="#L-1106"></a> scan = tonumber (scan); <a href="#L-1107"></a> if (30 > year) or (45 < year) then return nil end <a href="#L-1108"></a> if not (('a' == volume) or ('b' == volume)) then return nil end <a href="#L-1109"></a> if (1 > scan) then return nil end <a href="#L-1110"></a> <a href="#L-1111"></a> return true; <a href="#L-1112"></a>end <a href="#L-1113"></a> <a href="#L-1114"></a> <a href="#L-1115"></a>--[[--------------------------< S E T _ P L I M S O L L _ D A T E >-------------------------------------------- <a href="#L-1116"></a> <a href="#L-1117"></a>create two-year range from first two digits in |filename=<filename> <a href="#L-1118"></a> 30 -> 1930–1931 <a href="#L-1119"></a> <a href="#L-1120"></a> {{#invoke:WPSHIPS utilities|set_plimsoll_date|{{{filename}}}}} <a href="#L-1121"></a> <a href="#L-1122"></a>]] <a href="#L-1123"></a> <a href="#L-1124"></a>local function set_plimsoll_date (frame) <a href="#L-1125"></a> local args_t = get_args (frame); -- get a table of all parameters in the invoke <a href="#L-1126"></a> <a href="#L-1127"></a> if not args_t[1] then <a href="#L-1128"></a> return nil; <a href="#L-1129"></a> end <a href="#L-1130"></a> <a href="#L-1131"></a> local year = args_t[1]:match ('(%d%d)%l%d%d%d%d'); -- get the intial year <a href="#L-1132"></a> <a href="#L-1133"></a> year = 1900 + tonumber (year); -- make it a four-digit year <a href="#L-1134"></a> return string.format ('%d–%d', year, year + 1); -- and then add one for the second year in the range <a href="#L-1135"></a>end <a href="#L-1136"></a> <a href="#L-1137"></a> <a href="#L-1138"></a>--[[--------------------------< S E T _ P L I M S O L L _ S U B T I T L E >-----------------------------------1 <a href="#L-1139"></a> <a href="#L-1140"></a>used in {{cite plimsoll}} <a href="#L-1141"></a> <a href="#L-1142"></a>return appropriate subtitle string given |subtitle=<keyword> <a href="#L-1143"></a> <a href="#L-1144"></a> {{#invoke:WPSHIPS utilities|set_plimsoll_subtitle|{{{subtitle}}}}} <a href="#L-1145"></a> <a href="#L-1146"></a>]] <a href="#L-1147"></a> <a href="#L-1148"></a>local function set_plimsoll_subtitle (frame) <a href="#L-1149"></a> local subtitle = get_args (frame)[1]; -- get the subtitle parameter <a href="#L-1150"></a> <a href="#L-1151"></a> if not subtitle then <a href="#L-1152"></a> return nil; <a href="#L-1153"></a> end <a href="#L-1154"></a> <a href="#L-1155"></a> if not data.subtitles_t[subtitle] then <a href="#L-1156"></a> return '&#58; ' .. subtitle; -- not predefined so return whatever |subtitle= holds with leading ': ' <a href="#L-1157"></a> end <a href="#L-1158"></a> <a href="#L-1159"></a> return '&#58; ' .. data.subtitles_t[subtitle]; -- return predefined subtitle with leading ': ' <a href="#L-1160"></a>end <a href="#L-1161"></a> <a href="#L-1162"></a> <a href="#L-1163"></a>--[[--------------------------< S E T _ P L I M S O L L _ U R L >---------------------------------------------- <a href="#L-1164"></a> <a href="#L-1165"></a>create plimsoll url from |filename=<filename> <a href="#L-1166"></a> <a href="#L-1167"></a> {{#invoke:WPSHIPS utilities|set_plimsoll_url|{{{filename}}}}} <a href="#L-1168"></a> <a href="#L-1169"></a>]] <a href="#L-1170"></a> <a href="#L-1171"></a>local function set_plimsoll_url (frame) <a href="#L-1172"></a> local args_t = get_args (frame); -- get a table of all parameters in the invoke <a href="#L-1173"></a> <a href="#L-1174"></a> if args_t[1] then <a href="#L-1175"></a> return string.format ('https://plimsoll.southampton.gov.uk/shipdata/pdfs/%s/%s', <a href="#L-1176"></a> args_t[1]:match ('(%d%d)%l%d%d%d%d'), -- get the year path portion from <filename> <a href="#L-1177"></a> args_t[1]); -- append <filename> onto the end, and done <a href="#L-1178"></a> end <a href="#L-1179"></a>end <a href="#L-1180"></a> <a href="#L-1181"></a> <a href="#L-1182"></a>--[[--------------------------< S C L A S S >------------------------------------------------------------------ <a href="#L-1183"></a> <a href="#L-1184"></a>implements {{sclass}} and {{sclass2}} <a href="#L-1185"></a> <a href="#L-1186"></a>{{#invoke:WPSHIPS utilities|sclass}} <a href="#L-1187"></a> <a href="#L-1188"></a>]] <a href="#L-1189"></a> <a href="#L-1190"></a>local function sclass (frame) <a href="#L-1191"></a> local args_t = get_args (frame); <a href="#L-1192"></a> local parent = frame:getParent(); <a href="#L-1193"></a> local template = parent:getTitle():gsub ('^Template:', ''):lower(); -- get the name of the template that called this module (includes namespace so strip that) <a href="#L-1194"></a> <a href="#L-1195"></a> local class_name = args_t[1]; -- names to make it easier to understand <a href="#L-1196"></a> local ship_type = args_t[2]; <a href="#L-1197"></a> local format = args_t[3]; <a href="#L-1198"></a> local ship_type_dab = args_t[4]; <a href="#L-1199"></a> local class_name_dab = args_t[5]; <a href="#L-1200"></a> local no_cat = 'yes' == args_t['no-cat']; -- make a boolean <a href="#L-1201"></a> <a href="#L-1202"></a> if not class_name then -- when omitted, abandon with error message <a href="#L-1203"></a> return error_msg_make ('missing', template, 'class name', no_cat); <a href="#L-1204"></a> end <a href="#L-1205"></a> <a href="#L-1206"></a> if not ship_type then -- when omitted, abandon with error message <a href="#L-1207"></a> return error_msg_make ('missing', template, 'ship type', no_cat); <a href="#L-1208"></a> end <a href="#L-1209"></a> <a href="#L-1210"></a> if format then <a href="#L-1211"></a> if tonumber (format) then -- if <format> has a value that is a number <a href="#L-1212"></a> format = tonumber (format); -- make it a number for comparisons <a href="#L-1213"></a> if 5 < format then -- is <format> outside of allowed range <a href="#L-1214"></a> return error_msg_make ('format', template, format, no_cat); <a href="#L-1215"></a> end <a href="#L-1216"></a> else -- <format> could not be converted to a number <a href="#L-1217"></a> return error_msg_make ('format', template, format, no_cat); <a href="#L-1218"></a> end <a href="#L-1219"></a> end <a href="#L-1220"></a> <a href="#L-1221"></a> local out_t = {}; -- output goes here <a href="#L-1222"></a> table.insert (out_t, '[['); -- open the wikilink <a href="#L-1223"></a> table.insert (out_t, class_name); -- build the wikilink to the class article <a href="#L-1224"></a> table.insert (out_t, '-class '); <a href="#L-1225"></a> table.insert (out_t, ship_type); -- add ship type <a href="#L-1226"></a> if class_name_dab then -- when class article is disambiguated <a href="#L-1227"></a> table.insert (out_t, ' ('); -- add the disambiguator <a href="#L-1228"></a> table.insert (out_t, class_name_dab); <a href="#L-1229"></a> table.insert (out_t, ')'); <a href="#L-1230"></a> end <a href="#L-1231"></a> table.insert (out_t, '|'); <a href="#L-1232"></a> if 'sclass' == template:gsub ('/sandbox', '') then -- strip '/sandbox' if present; class named for a member of the class <a href="#L-1233"></a> table.insert (out_t, '\'\''); -- class name is italicized <a href="#L-1234"></a> table.insert (out_t, class_name); <a href="#L-1235"></a> table.insert (out_t, '\'\''); <a href="#L-1236"></a> else <a href="#L-1237"></a> table.insert (out_t, class_name); -- class name is a common attribute; plain text <a href="#L-1238"></a> end <a href="#L-1239"></a> <a href="#L-1240"></a> if not format or (3 == format) then -- when format is omitted, same as format #3 <a href="#L-1241"></a> table.insert (out_t, '-class]] [['); -- open ship-type wikilink <a href="#L-1242"></a> if ship_type_dab then -- when ship-type article is disambiguated <a href="#L-1243"></a> table.insert (out_t, ship_type); -- add ship type <a href="#L-1244"></a> table.insert (out_t, ' ('); -- and the disambiguator <a href="#L-1245"></a> table.insert (out_t, ship_type_dab); <a href="#L-1246"></a> table.insert (out_t, ')|'); -- dab is not displayed so insert a pipe and <a href="#L-1247"></a> end <a href="#L-1248"></a> table.insert (out_t, ship_type); -- add ship type <a href="#L-1249"></a> table.insert (out_t, ']]'); -- close ship-type wikilink <a href="#L-1250"></a> end <a href="#L-1251"></a> <a href="#L-1252"></a> if 0 == format then -- no separate ship-type wikilink <a href="#L-1253"></a> table.insert (out_t, '-class]]'); <a href="#L-1254"></a> end <a href="#L-1255"></a> <a href="#L-1256"></a> if 1 == format then -- no separate ship-type wikilink <a href="#L-1257"></a> table.insert (out_t, '-class '); <a href="#L-1258"></a> table.insert (out_t, ship_type); <a href="#L-1259"></a> table.insert (out_t, ']]'); <a href="#L-1260"></a> end <a href="#L-1261"></a> <a href="#L-1262"></a> if 2 == format then -- ship-type is not wikilinked <a href="#L-1263"></a> table.insert (out_t, '-class]] '); <a href="#L-1264"></a> table.insert (out_t, ship_type); <a href="#L-1265"></a> end <a href="#L-1266"></a> <a href="#L-1267"></a> if 4 == format then -- noun form; no ship type <a href="#L-1268"></a> table.insert (out_t, ' class]]'); <a href="#L-1269"></a> end <a href="#L-1270"></a> <a href="#L-1271"></a> if 5 == format then -- class name only; no '-class' annotation <a href="#L-1272"></a> table.insert (out_t, ']]'); <a href="#L-1273"></a> end <a href="#L-1274"></a> <a href="#L-1275"></a> return table.concat (out_t); <a href="#L-1276"></a>end <a href="#L-1277"></a> <a href="#L-1278"></a> <a href="#L-1279"></a>--[[--------------------------< E X P O R T S >---------------------------------------------------------------- <a href="#L-1280"></a>]] <a href="#L-1281"></a> <a href="#L-1282"></a>return { <a href="#L-1283"></a> cite_danfs_title = cite_danfs_title, -- external entry points for templates and invokes <a href="#L-1284"></a> hnsa = hnsa, <a href="#L-1285"></a> infobox_ship_career = infobox_ship_career, <a href="#L-1286"></a> infobox_ship_characteristics = infobox_ship_characteristics, <a href="#L-1287"></a> infobox_ship_class_overview = infobox_ship_class_overview, <a href="#L-1288"></a> infobox_ship_flag = infobox_ship_flag, <a href="#L-1289"></a> is_plimsoll_filename = is_plimsoll_filename, <a href="#L-1290"></a> navsource = navsource, <a href="#L-1291"></a> sclass = sclass, <a href="#L-1292"></a> set_plimsoll_subtitle = set_plimsoll_subtitle, <a href="#L-1293"></a> set_plimsoll_date = set_plimsoll_date, <a href="#L-1294"></a> set_plimsoll_url = set_plimsoll_url, <a href="#L-1295"></a> ship = ship, -- experiment <a href="#L-1296"></a> ship_prefix_templates = ship_prefix_templates, -- experiment <a href="#L-1297"></a> ship_name_format = ship_name_format, <a href="#L-1298"></a> unbulleted_list = unbulleted_list, <a href="#L-1299"></a> <a href="#L-1300"></a> _infobox_ship_flag = _infobox_ship_flag, -- external entry points from another module <a href="#L-1301"></a> _ship_name_format = do_ship_name_format, <a href="#L-1302"></a> _synonym_check = synonym_check, <a href="#L-1303"></a> _unbulleted_list = _unbulleted_list, <a href="#L-1304"></a> } </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="">Retrieved from "<a dir="ltr" href="https://en.wikipedia.org/w/index.php?title=Module:WPSHIPS_utilities&oldid=1252707104">https://en.wikipedia.org/w/index.php?title=Module:WPSHIPS_utilities&oldid=1252707104</a>"</div></div> <div id="catlinks" class="catlinks catlinks-allhidden" data-mw="interface"><div id="mw-hidden-catlinks" class="mw-hidden-catlinks mw-hidden-cats-hidden">Hidden category: <ul><li><a href="/wiki/Category:Wikipedia_fully_protected_modules" title="Category:Wikipedia fully protected modules">Wikipedia fully protected modules</a></li></ul></div></div> </div> </main> </div> <div class="mw-footer-container"> <footer id="footer" class="mw-footer" > <ul id="footer-info"> <li id="footer-info-lastmod"> This page was last edited on 22 October 2024, at 16:15 (UTC).</li> <li id="footer-info-copyright">Text is available under the <a href="/wiki/Wikipedia:Text_of_the_Creative_Commons_Attribution-ShareAlike_4.0_International_License" title="Wikipedia:Text of the Creative Commons Attribution-ShareAlike 4.0 International License">Creative Commons Attribution-ShareAlike 4.0 License</a>; additional terms may apply. By using this site, you agree to the <a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Terms_of_Use" class="extiw" title="foundation:Special:MyLanguage/Policy:Terms of Use">Terms of Use</a> and <a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Privacy_policy" class="extiw" title="foundation:Special:MyLanguage/Policy:Privacy policy">Privacy Policy</a>. Wikipedia® is a registered trademark of the <a rel="nofollow" class="external text" href="https://wikimediafoundation.org/">Wikimedia Foundation, Inc.</a>, a non-profit organization.</li> </ul> <ul id="footer-places"> <li id="footer-places-privacy"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Privacy_policy">Privacy policy</a></li> <li id="footer-places-about"><a href="/wiki/Wikipedia:About">About Wikipedia</a></li> <li id="footer-places-disclaimers"><a href="/wiki/Wikipedia:General_disclaimer">Disclaimers</a></li> <li id="footer-places-contact"><a href="//en.wikipedia.org/wiki/Wikipedia:Contact_us">Contact Wikipedia</a></li> <li id="footer-places-wm-codeofconduct"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Universal_Code_of_Conduct">Code of Conduct</a></li> <li id="footer-places-developers"><a href="https://developer.wikimedia.org">Developers</a></li> <li id="footer-places-statslink"><a href="https://stats.wikimedia.org/#/en.wikipedia.org">Statistics</a></li> <li id="footer-places-cookiestatement"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Cookie_statement">Cookie statement</a></li> <li id="footer-places-mobileview"><a href="//en.m.wikipedia.org/w/index.php?title=Module:WPSHIPS_utilities&mobileaction=toggle_view_mobile" class="noprint stopMobileRedirectToggle">Mobile view</a></li> </ul> <ul id="footer-icons" class="noprint"> <li id="footer-copyrightico"><a href="https://wikimediafoundation.org/" class="cdx-button cdx-button--fake-button cdx-button--size-large cdx-button--fake-button--enabled"><img src="/static/images/footer/wikimedia-button.svg" width="84" height="29" alt="Wikimedia Foundation" loading="lazy"></a></li> <li id="footer-poweredbyico"><a href="https://www.mediawiki.org/" class="cdx-button cdx-button--fake-button cdx-button--size-large cdx-button--fake-button--enabled"><img src="/w/resources/assets/poweredby_mediawiki.svg" alt="Powered by MediaWiki" width="88" height="31" loading="lazy"></a></li> </ul> </footer> </div> </div> </div> <div class="vector-settings" id="p-dock-bottom"> <ul></ul> </div><script>(RLQ=window.RLQ||[]).push(function(){mw.config.set({"wgHostname":"mw-web.codfw.main-57488d5c7d-6v6z6","wgBackendResponseTime":313,"wgPageParseReport":{"limitreport":{"cputime":"0.099","walltime":"0.143","ppvisitednodes":{"value":406,"limit":1000000},"postexpandincludesize":{"value":22529,"limit":2097152},"templateargumentsize":{"value":384,"limit":2097152},"expansiondepth":{"value":6,"limit":100},"expensivefunctioncount":{"value":4,"limit":500},"unstrip-depth":{"value":0,"limit":20},"unstrip-size":{"value":3031,"limit":5000000},"entityaccesscount":{"value":0,"limit":400},"timingprofile":["100.00% 60.683 1 Module:WPSHIPS_utilities/doc","100.00% 60.683 1 -total"," 57.10% 34.647 1 Template:High-use"," 12.57% 7.629 5 Template:Tlx"," 7.30% 4.431 3 Template:Tld"," 5.57% 3.378 3 Template:Tl"," 5.47% 3.319 9 Template:Para"," 1.72% 1.045 6 Template:Nowrap"]},"scribunto":{"limitreport-timeusage":{"value":"0.058","limit":"10.000"},"limitreport-memusage":{"value":2059655,"limit":52428800}},"cachereport":{"origin":"mw-web.codfw.main-57488d5c7d-6v6z6","timestamp":"20241128025020","ttl":2592000,"transientcontent":false}}});});</script> </body> </html>