Module:Hatnote/sandbox
 | This is the module sandbox page for Module:Hatnote (diff). See also the companion subpage for test cases (run). |
.svg/60px-Test_Template_Info-Icon_-_Version_(2).svg.png){kind=icon}
 | This Lua module is used in MediaWiki:Wantedpages-summary, and on approximately 2,020,000 pages, or roughly 3% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
 | This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
 | This module depends on the following other modules: |
 | This module uses TemplateStyles: |
This is a meta-module that provides various functions for making hatnotes. It implements the {{hatnote}} template, for use in hatnotes at the top of pages. It also contains a number of helper functions for use in other Lua hatnote modules.
Use from wikitext
[edit]The functions in this module cannot be used directly from #invoke, and must be used through templates instead. Please see Template:Hatnote and Template:Format link for documentation.
Use from other Lua modules
[edit]To load this module from another Lua module, use the following code.
localmHatnote=require('Module:Hatnote')You can then use the functions as documented below.
Hatnote
[edit]mHatnote._hatnote(s,options)Formats the string s as a hatnote. This encloses s in the tags <div class="hatnote">...</div>. Options are provided in the options table. Options include:
- options.extraclasses - a string of extra classes to provide
- options.selfref - if this is not nil or false, adds the class "selfref", used to denote self-references to Wikipedia (see Template:Selfref))
The CSS of the hatnote class is defined in Module:Hatnote/styles.css.
- Example 1
mHatnote._hatnote('This is a hatnote.')Produces: <div class="hatnote">This is a hatnote.</div>
Displays as:
- Example 2
mHatnote._hatnote('This is a hatnote.',{extraclasses='boilerplate seealso',selfref=true})Produces: <div class="hatnote boilerplate seealso selfref">This is a hatnote.</div>
Displayed as:
Find namespace id
[edit]mHatnote.findNamespaceId(link,removeColon)Finds the namespace id of the string link, which should be a valid page name, with or without the section name. This function will not work if the page name is enclosed with square brackets. When trying to parse the namespace name, colons are removed from the start of the link by default. This is helpful if users have specified colons when they are not strictly necessary. If you do not need to check for initial colons, set removeColon to false.
- Examples
mHatnote.findNamespaceId('Lion')→ 0mHatnote.findNamespaceId('Category:Lions')→ 14mHatnote.findNamespaceId(':Category:Lions')→ 14mHatnote.findNamespaceId(':Category:Lions',false)→ 0 (the namespace is detected as ":Category", rather than "Category")
Make wikitext error
[edit]mHatnote.makeWikitextError(msg,helpLink,addTrackingCategory)Formats the string msg as a red wikitext error message, with optional link to a help page helpLink. Normally this function also adds Category:Hatnote templates with errors (0). To suppress categorization, pass false as third parameter of the function (addTrackingCategory).
Examples:
mHatnote.makeWikitextError('an error has occurred')→ Error: an error has occurred.mHatnote.makeWikitextError('an error has occurred','Template:Example#Errors')→ Error: an error has occurred (help).
Examples
[edit]For an example of how this module is used in other Lua modules, see Module:Labelled list hatnote
---------------------------------------------------------------------------------- Module:Hatnote ---- ---- This module produces hatnote links and links to related articles. It ---- implements the {{hatnote}} and {{format link}} meta-templates and includes ---- helper functions for other Lua hatnote modules. ----------------------------------------------------------------------------------locallibraryUtil=require('libraryUtil')localcheckType=libraryUtil.checkTypelocalcheckTypeForNamedArg=libraryUtil.checkTypeForNamedArglocalmArguments-- lazily initialise [[Module:Arguments]]localyesno-- lazily initialise [[Module:Yesno]]localformatLink-- lazily initialise [[Module:Format link]] ._formatLinklocalp={}---------------------------------------------------------------------------------- Helper functions--------------------------------------------------------------------------------localcurNs=mw.title.getCurrentTitle().namespacep.missingTargetCat=--Default missing target category, exported for use in related modules((curNs==0)or(curNs==14))and'Articles with hatnote templates targeting a nonexistent page'ornillocalfunctiongetArgs(frame)-- Fetches the arguments from the parent frame. Whitespace is trimmed and-- blanks are removed.mArguments=require('Module:Arguments')returnmArguments.getArgs(frame,{parentOnly=true})endlocalfunctionremoveInitialColon(s)-- Removes the initial colon from a string, if present.returns:match('^:?(.*)')endfunctionp.findNamespaceId(link,removeColon)-- Finds the namespace id (namespace number) of a link or a pagename. This-- function will not work if the link is enclosed in double brackets. Colons-- are trimmed from the start of the link by default. To skip colon-- trimming, set the removeColon parameter to false.checkType('findNamespaceId',1,link,'string')checkType('findNamespaceId',2,removeColon,'boolean',true)ifremoveColon~=falsethenlink=removeInitialColon(link)endlocalnamespace=link:match('^(.-):')ifnamespacethenlocalnsTable=mw.site.namespaces[namespace]ifnsTablethenreturnnsTable.idendendreturn0endfunctionp.makeWikitextError(msg,helpLink,addTrackingCategory,title)-- Formats an error message to be returned to wikitext. If-- addTrackingCategory is not false after being returned from-- [[Module:Yesno]], and if we are not on a talk page, a tracking category-- is added.checkType('makeWikitextError',1,msg,'string')checkType('makeWikitextError',2,helpLink,'string',true)yesno=require('Module:Yesno')title=titleormw.title.getCurrentTitle()-- Make the help link text.localhelpTextifhelpLinkthenhelpText=' ([['..helpLink..'|help]])'elsehelpText=''end-- Make the category text.localcategoryifnottitle.isTalkPage-- Don't categorise talk pagesandtitle.namespace~=2-- Don't categorise userspaceandyesno(addTrackingCategory)~=false-- Allow opting outthencategory='Hatnote templates with errors'category=mw.ustring.format('[[%s:%s]]',mw.site.namespaces[14].name,category)elsecategory=''endreturnmw.ustring.format('<strong class="error">Error: %s%s.</strong>%s',msg,helpText,category)endfunctionp.disambiguate(page,disambiguator)-- Formats a page title with a disambiguation parenthetical,-- i.e. "Example" → "Example (disambiguation)".checkType('disambiguate',1,page,'string')checkType('disambiguate',2,disambiguator,'string',true)disambiguator=disambiguatoror'disambiguation'returnmw.ustring.format('%s (%s)',page,disambiguator)endfunctionp.defaultClasses(inline)-- Provides the default hatnote classes as a space-separated string; useful-- for hatnote-manipulation modules like [[Module:Hatnote group]].return(inline==1and'hatnote-inline'or'hatnote')..' '..'navigation-not-searchable'end---------------------------------------------------------------------------------- Hatnote---- Produces standard hatnote text. Implements the {{hatnote}} template.--------------------------------------------------------------------------------functionp.hatnote(frame)localargs=getArgs(frame)locals=args[1]ifnotsthenreturnp.makeWikitextError('no text specified','Template:Hatnote#Errors',args.category)endreturnp._hatnote(s,{extraclasses=args.extraclasses,selfref=args.selfref})endfunctionp._hatnote(s,options)checkType('_hatnote',1,s,'string')checkType('_hatnote',2,options,'table',true)options=optionsor{}localinline=options.inlinelocalhatnote=mw.html.create(inline==1and'span'or'div')localextraclassesiftype(options.extraclasses)=='string'thenextraclasses=options.extraclassesendhatnote:attr('role','note'):addClass(p.defaultClasses(inline)):addClass(extraclasses):addClass(options.selfrefand'selfref'ornil):wikitext(s)returnmw.getCurrentFrame():extensionTag{name='templatestyles',args={src='Module:Hatnote/styles.css'}}..tostring(hatnote)endreturnp