Modul:Hatnote

Belgekirina modulê[nîşan bide] [biguhêre] [dîrokê bibîne] [rojane bike]

This is a meta-module that provides various functions for makinghatnotes.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

The functions in this module cannot be used directly from #invoke, and must be used through templates instead. Please seeTemplate:HatnoteandTemplate:Format linkfor documentation.

Use from other Lua modules

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

mHatnote._hatnote(s,options)

Formats the stringsas a hatnote. This enclosessin the tags<div class= "hatnote" >...</div>.Options are provided in theoptionstable. 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 (seeTemplate:Selfref))

The CSS of the hatnote class is defined inModule:Hatnote/styles.css.

Example 1

mHatnote._hatnote('This is a hatnote.')

Produces: <div class= "hatnote" >This is a hatnote.</div>

Displays as:

This is a hatnote.

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:

This is a hatnote.

Find namespace id

mHatnote.findNamespaceId(link,removeColon)

Finds thenamespace idof the stringlink,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, setremoveColonto false.

Examples

mHatnote.findNamespaceId('Lion')→ 0

mHatnote.findNamespaceId('Category:Lions')→ 14

mHatnote.findNamespaceId(':Category:Lions')→ 14

mHatnote.findNamespaceId(':Category:Lions',false)→ 0 (the namespace is detected as ":Category", rather than "Category" )

Make wikitext error

mHatnote.makeWikitextError(msg,helpLink,addTrackingCategory)

Formats the stringmsgas a red wikitext error message, with optional link to a help pagehelpLink.Normally this function also addsKategorî:Hatnote templates with errors(0). To suppress categorization, passfalseas third parameter of the function (addTrackingCategory).

Examples:

mHatnote.makeWikitextError('an error has occurred')→

mHatnote.makeWikitextError('an error has occurred','Template:Example#Errors')→

Examples

For an example of how this module is used in other Lua modules, seeModule:Labelled list hatnote

Evbelgekirinali jorrasterastjiModul:Hatnote/belgetê wergirtin.(biguhêre|dîrokê bibîne)
Bikarhêner dikarin ceribandinên xwe yên vê modulê li ser rûpelên ceribandinê(biafirîne|bar bike)û testcases(biafirîne)pêk bînin.
Binrûpelên vê modulê nîşan bide.

--------------------------------------------------------------------------------
-- 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.checkType
localcheckTypeForNamedArg=libraryUtil.checkTypeForNamedArg
localmArguments-- lazily initialise [[Module:Arguments]]
localyesno-- lazily initialise [[Module:Yesno]]
localformatLink-- lazily initialise [[Module:Format link]]._formatLink

localp={}

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

localfunctiongetArgs(frame)
-- Fetches the arguments from the parent frame. Whitespace is trimmed and
-- blanks are removed.
mArguments=require('Module:Arguments')
returnmArguments.getArgs(frame,{parentOnly=true})
end

localfunctionremoveInitialColon(s)
-- Removes the initial colon from a string, if present.
returns:match('^:?(.*)')
end

functionp.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

functionp.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'cudakirin'
returnmw.ustring.format('%s (%s)',page,disambiguator)
end

functionp.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~=falsethen
link=removeInitialColon(link)
end
localnamespace=link:match('^(.-):')
ifnamespacethen
localnsTable=mw.site.namespaces[namespace]
ifnsTablethen
returnnsTable.id
end
end
return0
end

functionp.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.
localhelpText
ifhelpLinkthen
helpText=' ([['..helpLink..'|alîkarî]])'
else
helpText=''
end
-- Make the category text.
localcategory
ifnottitle.isTalkPage-- Don't categorise talk pages
andtitle.namespace~=2-- Don't categorise userspace
andyesno(addTrackingCategory)~=false-- Allow opting out
then
category='Şablonên Hatnote bi xeletî'
category=mw.ustring.format(
'[[%s:%s]]',
mw.site.namespaces[14].name,
category
)
else
category=''
end
returnmw.ustring.format(
'<strong class= "error" >Xeletî: %s%s.</strong>%s',
msg,
helpText,
category
)
end

localcurNs=mw.title.getCurrentTitle().namespace
p.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'ornil

functionp.quote(title)
--Wraps titles in quotation marks. If the title starts/ends with a quotation
--mark, kerns that side as with {{-'}}
localquotationMarks={
["'"]=true,[' "']=true,[' “']=true,["‘"]=true,['” ']=true,["’"]=true
}
localquoteLeft,quoteRight=-- Test if start/end are quotation marks
quotationMarks[string.sub(title,1,1)],
quotationMarks[string.sub(title,-1,-1)]
ifquoteLeftorquoteRightthen
title=mw.html.create("span"):wikitext(title)
end
ifquoteLeftthentitle:css("padding-left","0.15em")end
ifquoteRightthentitle:css("padding-right","0.15em")end
return' "'..tostring(title)..' "'
end

--------------------------------------------------------------------------------
-- Hatnote
--
-- Produces standard hatnote text. Implements the {{hatnote}} template.
--------------------------------------------------------------------------------

functionp.hatnote(frame)
localargs=getArgs(frame)
locals=args[1]
ifnotsthen
returnp.makeWikitextError(
'no text specified',
'Template:Hatnote#Errors',
args.category
)
end
returnp._hatnote(s,{
extraclasses=args.extraclasses,
selfref=args.selfref
})
end

functionp._hatnote(s,options)
checkType('_hatnote',1,s,'string')
checkType('_hatnote',2,options,'table',true)
options=optionsor{}
localinline=options.inline
localhatnote=mw.html.create(inline==1and'span'or'div')
localextraclasses
iftype(options.extraclasses)=='string'then
extraclasses=options.extraclasses
end

hatnote
: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)
end

returnp