View source for Template:Hatnote group/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Lua|Module:Hatnote group}}

This template applies [[Module:Hatnote group]] to merge hatnotes it is given as input; this has the net effect of making them formatted inline relative to one another. For example:

<pre><nowiki>
{{about|USE1||PAGE1}}
{{redirect|REDIRECT|USE2|PAGE2}}
</nowiki></pre>

would normally display as:

{{about|USE1||PAGE1}}
{{redirect|REDIRECT|USE2|PAGE2}}

but, when wrapped in this template:

<pre><nowiki>
{{hatnote group|
{{about|USE1||PAGE1}}
{{redirect|REDIRECT|USE2|PAGE2}}
}}
</nowiki></pre>

displays as

{{hatnote group|
{{about|USE1||PAGE1}}
{{redirect|REDIRECT|USE2|PAGE2}}
}}

Technically, it changes the hatnotes by converting their <code><nowiki>div</nowiki></code> wrappers into <code><nowiki>span</nowiki></code>s, wrapping the group in a new hatnote <code>div</code>, and migrating classes appropriately. Classes are migrated to the appropriate <code>span</code>, unless every hatnote in the group includes that class, in which case the class will be migrated to the new <code>div</code> wrapper. For example:

<pre><nowiki>
{{hatnote|extraclasses=example demonstration |Hatnote 1}}
{{hatnote|extraclasses=example |Hatnote 2}}
{{hatnote|extraclasses=example |Hatnote 3}}
</nowiki></pre>

would normally be rendered to:

<pre><nowiki>
<div role="note" class="hatnote navigation-not-searchable example demonstration">Hatnote 1</div>
<div role="note" class="hatnote navigation-not-searchable example">Hatnote 2</div>
<div role="note" class="hatnote navigation-not-searchable example">Hatnote 3</div>
</nowiki></pre>

but, when wrapped in this template, becomes:

<pre><nowiki>
<div role="note" class="hatnote navigation-not-searchable example">
<span class="demonstration">Hatnote 1</span> 
<span>Hatnote 2</span> 
<span>Hatnote 3</span> 
</div>
</nowiki></pre>


<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Hatnote templates| ]]
}}</includeonly>
{{format TemplateData|JSON={
	"params": {
		"1": {
			"label": "Hatnote group content",
			"description": "Two or more hatnote template invocations, and nothing else.",
			"type": "string",
			"required": true
		}
	},
	"description": "Groups multiple hatnotes onto a single line.",
	"paramOrder": ["1"],
	"format": "{{_|\n_=_\n}}"
}
}}