View source for Template:Em/doc

{{Documentation subpage}}
{{for|the em dash template|Template:Em dash}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->

==Purpose==
The {{tnull|em}} and {{tnull|strong}} templates makes it faster and easier to apply [[w:en:HTML|HTML]]'s {{tag|em}} {{em|emphasis}} and {{tag|strong}} {{strong|strong emphasis}} markup (respectively) to text, and more importantly to indicate to human and bot editors they should not use <code><nowiki>''...''</nowiki></code> or {{tag|i}} typographic italicization, or <code><nowiki>'''...'''</nowiki></code> or {{tag|b}} typographical boldfacing (respectively) to replace the intentional and semantically meaningful {{tag|em|o}} or {{tag|strong|o}}.  Emphasis is usually rendered visually in an italic (oblique a.k.a. slanted) typeface by default on graphical browsers, and strong emphasis by boldface, but can be parsed and acted upon in customizable ways with style sheets, apps, and text-to-speech screen readers. It is said to be [[w:en:Semantic HTML|semantic markup]], i.e. markup that conveys meaning or context, not just visual appearance.

Simple italicizing and boldfacing is purely typographic and is semantically meaningless. Non-semantic italics are most often used for titles of publications (books, films, albums, etc.), foreign words and phrases, [[w:en:Words as words|words as words]] (when quotation marks are not used for that purpose), names of ships, [[w:en:Binomial nomenclature|scientific names of organisms]] and other cases where stylistic conventions demand italics, but they convey no sense of emphasis.  Similarly, non-semantic boldface is conventionally used for things like section headings, table headers, and other circumstances where a thicker font is desired, without indicating that anything is being contextually {{strong|stressed}} (like the word "stressed" in this sentence). The average reader, and average editor, do not and need not care about this distinction most of the time, but it can be important and editors who understand it can use this template as a baseline insurance against accidental or careless replacement by bots and human editors.

==Usage==
: {{tnull|em|<var>text to be emphasized</var>}}
or, if the text to be emphasized contains an equals sign:
: {{tnull|em|'''1{{=}}'''<var>text to be emphasized</var>}}

These both render as:
: {{em|text to be emphasized}}

This template puts intentional and explicit {{tag|em}} (emphasis) [X]HTML markup around the text provided as the first parameter. It is safest to always use the {{para|1}} syntax.

The {{tnull|strong}} version of the template works the same way.

===Optional parameters===
Advanced HTML values can be passed through the template to the HTML code:
* {{para|role}} takes a WAI-ARIA role; adds <code>role="<var>rolename</var>"</code> to the HTML code
* {{para|class}} takes a class name (or multiple class names, separated by spaces); adds <code>class="<var>classname[s]</var>"</code> to the HTML code
* {{para|style}} takes inline CSS input; adds <code>style="<var>CSS directive[s]</var>"</code> to the HTML code
* {{para|id}} takes a valid, unique HTML id (must begin with an alphabetic letter); adds <code>id="<var>name</var>"</code> to the HTML code
* {{para|title}} takes text, which cannot be marked up in any way, and displays it as a pop-up "tooltip" (in most browsers) when the cursor hovers over the span

===Use cases===
{{See also|w:en:Wikipedia:WikiProject Usability/Scannability}}
This template is made to [[:wikt:emphasis|mildly emphasize]] (or in the case of {{tnull|strong}} more strongly emphasize) an important word or phrase in a passage, in a way that is (unlike simply italicizing or bolding it) [[w:en:Semantic markup|semantically meaningful markup]]. With this technique, the emphasized text stands out from the rest of the nearby text in most if not all visual browsers and some text-to-speech screen readers (which usually ignore purely typographic italicization), without strongly affecting scannability. It can also be parsed by user agents and other software as definitively indicating emphasis, not just some typographic boldface effect for appearance's sake. It should therefore only be used sparingly in articles, to highlight something being stressed (e.g., to represent strong vocal emphasis). Example:

* "<code><nowiki>Contrary to reports, she was {{em|not}} dead after all.</nowiki></code>"<br />"Contrary to reports, she was {{em|not}} dead after all."

{{tnull|Em}} is also occasionally used for disambiguation, e.g. between two adjacent but different uses of the same word or homonym ("What it {{em|is}} is a kind of custard."), but this usage is not often encyclopedic and can (when not found in a direct quotation) usually be rewritten to avoid the awkward construction.

{{tnull|Strong}} emphasis should be used even more sparingly, and on this site is primarily for use in user space and in internal notices/warnings.

==When this template should not be used==
Because {{tnull|em}} and {{tnull|strong}} are strictly for semantic (meaningful) emphasis, they should not be used for layout, typography conventions (titles, foreign words, headings, etc.), and other cases that are not true emphasis. In these different cases, italics wikicode <code><nowiki>''...''</nowiki></code> (which resolves to {{tag|i}} in the browser or other user agent; similarly with <code><nowiki>'''...'''</nowiki></code> and {{tag|b}}) should be used instead (or special markup for a particular case, such as {{tlx|var|...}} or {{tag|var}} for variables in computer science and mathematics – also usually rendered as italic in graphical browsers).  The templates should also not be used when the text to which one would be applied is already italicized/boldfaced for some other reason (e.g., it is part of a italic book title or is a boldfaced table header). In cases where emphasis is needed within such a context, {{tlx|strong}} inside the italic passage, or {{tlx|em}} inside the boldfaced one.  Usually avoid using either template in non-quoted sentences that end in an exclamation point, which is already emphasis enough. And it is usually excessive to use either template on terms that are already wikilinked, since the link markup acts as a form of emphasis itself.

*"''The New York Times'' is an American daily newspaper." This example should use <code><nowiki>''The New York Times''</nowiki></code> – just plain italics.
<!--

<!--
== See also ==
* {{tlx|Strong}} – for bold rather than italic semantic emphasis
-->
<includeonly>
<!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Commons semantic markup templates]]
</includeonly>