Module:Hatnote/doc: Difference between revisions

Content deleted Content added
add hatnote function
add rellink and examples
Line 22:
 
Formats the string <var>s</var> as a hatnote. This encloses <var>s</var> in the tags {{tag|div|params=class="dablink"}}. The CSS of the dablink class is defined in [[MediaWiki:Common.css]].
 
; Example
 
<source lang="lua">
mHatnote._hatnote('This is a hatnote.')
</source>
 
Produces:
{{tag|div|content=This is a hatnote.|params=class="dablink"}}
 
Displays as:
{{hatnote|This is a hatnote.}}
 
=== Rellink ===
 
<source lang="lua">
mHatnote._rellink(s, extraclasses)
</source>
 
Formats the string <var>s</var> as a "related articles" link. This encloses <var>s</var> in the tags {{tag|div|params=class="rellink"}}. The CSS of the dablink class is defined in [[MediaWiki:Common.css]]. Extra classes can be added as the string <var>extraclasses</var>.
 
; Example 1
 
<source lang="lua">
mHatnote._rellink('This is a related article link.')
</source>
 
Produces:
{{tag|div|content=This is a related article link.|params=class="rellink"}}
 
Displays as:
{{rellink|This is a related article link.}}
 
; Example 1
 
<source lang="lua">
mHatnote._rellink('This is a related article link.')
</source>
 
Produces:
{{tag|div|content=This is a related article link.|params=class="rellink"}}
 
Displays as:
{{rellink|This is a related article link.}}
 
; Example 2
 
<source lang="lua">
mHatnote._rellink('This is a related article link.', 'boilerplate seealso')
</source>
 
Produces:
{{tag|div|content=This is a related article link.|params=class="rellink boilerplate seealso"}}
 
Displayed as:
{{rellink|This is a related article link.|extraclasses=boilerplate seealso}}
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||