RogueScholar: Remove Sandbox other template

2022-09-02T08:15:47Z

Remove Sandbox other template

← Older revision		Revision as of 08:15, 2 September 2022
Line 24:		Line 24:

	== Example ==		== Example ==
	* {{Tlx\|Hatnote\|Example hatnote text}} → {{Hatnote\|Example hatnote text}}		* {{Tlx\|Hatnote\|Example hatnote text}}
			:('''↓''' which outputs '''↓''')<br />

			{{Hatnote\|Example hatnote text}}

	== Errors ==		== Errors ==
Line 42:		Line 45:
	* <pre style="max-width: 40vmax;"><div class="hatnote" style="font-style: italic; margin-left: 1.6em;">Hatnote text</div></pre><includeonly>		* <pre style="max-width: 40vmax;"><div class="hatnote" style="font-style: italic; margin-left: 1.6em;">Hatnote text</div></pre><includeonly>

	~~{{Sandbox other\|\|~~
	[[Category:Hatnote templates\| ]]		[[Category:Hatnote templates\| ]]</includeonly>
	}}</includeonly>

RogueScholar: Create template documentation

2022-09-02T08:11:32Z

Create template documentation

New page

{{Documentation subpage}}
This template produces formatted text in a manner consistent with the guidelines for a '''[[wikipedia:WP:HATNOTE|hatnote]]''', as described in the Wikipedia Manual of Style. In its basic form, it is invoked like this:<br />

{{Tlx|Hatnote|Use at the tops of pages and directly under section headers to preemptively answer a reader's questions before they continue onto the text below.}} (↓ Output below. ↓)
{{Hatnote|Use at the tops of pages and directly under section headers to preemptively answer a reader's questions before they continue onto the text below.}}

== Function ==
This template is primarily used to add a correctly formatted ''hatnote'' to a page. Often, but not always, this is a ''disambiguation link'' at the top of article pages. It places HTML {{Tag|div}} tags around the text entered as its only unnamed parameter, which applies standardized formatting suitable to these use cases (contents are indented off the left page margin and italicized); it also isolates the contained code to make sure that it is interpreted correctly.

The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal [[wikipedia:Wikipedia:Cheatsheet|wikitext markup]].

== Usage ==
=== Basic syntax ===
{{Tlx|Hatnote|''Example text''}}

=== Full syntax ===
{{Tlx|Hatnote|2=text=''Example text''|3=class=''extra classes''|4=style=''extra inline CSS styles''}}

=== Parameters ===
This template accepts the following parameters:
* {{Para|1}}} or {{Para|text}} – The hatnote text (required)
* {{Para|class}} – Any extra CSS classes to be added, for example, the {{Tl|See also}} template adds the classes {{Para|class|boilerplate seealso}}.
* {{Para|style}} – Any extra inline CSS definitions you wish to be assigned to the {{Tag|div}} tags. This is often used to perform additional manipulations to the hatnote text, such as changing its size or color.

== Example ==
* {{Tlx|Hatnote|Example hatnote text}} → {{Hatnote|Example hatnote text}}

== Errors ==
If no hatnote text is supplied, the template will output the following message:
* {{Hatnote}}

If you see this error message, it is for one of three reasons:
# No parameters were specified (the template code was simply "{{Tlx|Hatnote}}"; you must supply text for it to display.
# Some parameters were specified, but the hatnote text wasn't included. For example, {{Tlx|Hatnote|class=seealso}} will produce this error. Again, you must give it some text to display as an unnamed parameter.
# The hatnote text was specified, but that text contains an equality sign (<samp>=</samp>). The equality sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code {{Tlx|Hatnote|2=2+2=4}} will produce this error. To work around this, you can specify the alias for the unnamed parameter, which in this case is {{Para|text}}, and place your hatnote text there. Your invocation would then look like this: {{Tlx|Hatnote|2=text=2+2=4}}

If you see this error message and are unsure of what to do, please post a message on [[Template talk:Hatnote]] and someone should be able to help you.

== Technical details ==
The HTML code produced by this template looks like this:

* <pre style="max-width: 40vmax;"><div class="hatnote" style="font-style: italic; margin-left: 1.6em;">Hatnote text</div></pre><includeonly>

{{Sandbox other||
[[Category:Hatnote templates| ]]
}}</includeonly>

Template:Hatnote/doc - Revision history

RogueScholar: Remove Sandbox other template

RogueScholar: Create template documentation