Help:HTML in wikitext#rp, rt, ruby

{{Redirect|WP:HTML|general information about the default markup language on Wikipedia|Wikipedia:HTML5}}{{For|wikitext equivalents to HTML tags|Help:Wikitext}}{{Locutions pages header}}

The MediaWiki software, which drives Wikipedia, allows the use of a subset of HTML 5 elements, or tags and their attributes, for presentation formatting.{{r|sanitizer}} However, most HTML functionality can be replicated using equivalent wiki markup or templates. These alternatives are generally preferred within articles because they are often simpler for most editors to use and less intrusive in the editing interface. Wikipedia's Manual of Style recommends when and where these alternatives should be used. (See Help:Wikitext for wikitext equivalents to HTML tags not otherwise discussed below.)

HTML can also be useful outside articles, such as for formatting within templates. For assistance with using Cascading Style Sheets on Wikipedia, see Help:Cascading Style Sheets.

Some tags that resemble HTML are actually MediaWiki parser and extension tags, and so are actually wiki markup. HTML included in pages can be validated for HTML5 compliance by using validation. Note that some elements and attributes supported by MediaWiki and browsers have been deprecated by HTML5 and should no longer be used.{{TOC limit|3}}

Tutorials

This help page gives only an overview of allowed markup. For further assistance and detailed specifications:

[https://developer.mozilla.org/en-US/docs/Learn/HTML HTML5 Introduction] at developer.mozilla.org
[https://www.w3schools.com/html/default.asp HTML5 Introduction] at w3schools.com

Attributes

HTML attributes provide additional information about an element and are always specified in the start tag. They are formatted as a name/value pair like name="value".

Global attributes apply to all tags. Attributes not listed here are not allowed by MediaWiki{{r|sanitizer}}:

class: one or more classifications to which the element belongs. See Wikipedia:Catalogue of CSS classes.
dir: text direction— "ltr" (left-to-right), "rtl" (right-to-left) or "auto".
id: unique identifier for the element.
lang: primary language for the contents of the element per BCP 47.
style: applies CSS styling to the contents of the element.
title: advisory information associated with the element.

HTML5 microdata attributes apply to all tags:{{r|html5microdata}}

Any attribute beginning with data-
itemid
itemprop
itemref
itemscope
itemtype

Other tags such as {{tag|table|o}} support specific attributes – these are listed in the appropriate section.

{{markup

|This is red text.

|2=This is red text.

}}

The MediaWiki {{sanitizer.php}} does some cleanup on attributes. A best practice is to use the proper syntax.

Discards attributes not on a whitelist for the given element.
Turns broken or invalid entities into plaintext.
Double-quotes all attribute values.
Attributes without values are given the name as value.
Double attributes are discarded.
Unsafe style attributes are discarded.
Prepends space if there are attributes.

Elements

These HTML elements are supported by the MediaWiki software. This section gives a brief overview of the HTML element, an example, relevant wikimarkup and templates.

= Basic =

== h1, h2, h3, h4, h5, h6 ==

The {{tag|h1}} through {{tag|h6}} tags are headings for the sections with which they are associated. {{tag|h1|o}} is used for the article title. Headings are styled through CSS and added to the page's table of contents.

{{markup

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

|{{fakeheading|sub=1|Heading 1}}

}}

Wikimarkup: surround the text with the appropriate number of equal signs. Headers formatted with wikimarkup add an [edit] link.

{{markup

|= Heading 1 =

Heading 2

= Heading 3 =

== Heading 4 ==

=== Heading 5 ===

==== Heading 6 ====

|{{fake heading|sub=1|Heading 1}}

}}

Templates: {{tlx|fake heading}} for use in documentation

== p ==

{{tag|p}} tag places content into a separate paragraph.

{{markup

HyperText Markup Language

}}

Wikimarkup: Separate paragraphs by a single blank line.

{{markup

|HyperText Markup Language

HyperText Markup Language

|HyperText Markup Language

HyperText Markup Language

}}

{{tag|p}} is especially useful in lists, for list items with multiple paragraphs:

{{markup|

This is a paragraph.
This is another paragraph in the same item.
This is a different item.

This is a paragraph.
This is another paragraph in the same item.
This is a different item.}}

Note that the closing tag {{tag|p|c}} is not strictly necessary for MediaWiki installations that output HTML 5 (such as Wikipedia).

== br ==

{{see|Help:Line-break handling#<br>| Wikipedia:Don't use line breaks}}

{{tag|br|o}} inserts a line break. See H:BR for the other 4 versions that the MediaWiki software converts to {{tag|br|s}} in the HTML that browsers read.

{{markup

|HyperText
Markup Language

}}

Templates:

{{tlx|break}} adds multiple line breaks.
{{tlx|crlf2}} adds a true carriage return and line feed.
{{tlx|clear}} adds a break with styling to clear floating elements.
{{tlx|plainlist}} creates an unbulleted list.

== hr ==

{{tag|hr|o}} or {{tag|hr|s}} represents a paragraph-level thematic break and presents as a horizontal rule.

{{markup

}}

Wikimarkup: use ----

{{markup

|----

|{{crlf2}}

----

}}

Templates: {{tlx|hr}}

== Comments ==

{{tag|!--}} formats the enclosed text as a hidden comment.

{{markup

|HyperText

}}

Be careful with spacing around comments. Surrounding a comment with blank lines will result in a blank paragraph, perceived as an extra two blank lines:

{{markup|Content line 1

Content line 2|Content line 1

Content line 2}}

= Formatting =

== abbr ==

{{tag|abbr}} creates a tooltip to define an abbreviation or acronym that is displayed on mouse-over.

{{markup

|HTML

|2=HTML

}}

Templates: {{tlx|abbr}}

== b ==

{{tag|b}} formats text stylistically offset from other text (bold) without conveying extra importance.

{{markup

|HyperText Markup Language

}}

Wikimarkup: Use ''' to open and close bold text.

{{markup

|HyperText Markup Language

}}

== bdi ==

{{tag|bdi}} isolates the content from the surrounding text-direction settings.

{{markup

|اليمين إلى اليسارleft to right

}}

Support: Firefox, Chrome

== bdo ==

{{tag|bdo}} specifies the text direction.

Attributes and values:

dir – Specifies the text direction.
ltr
rtl

{{markup

|1=HyperText Markup Language

|2=HyperText Markup Language

}}

== blockquote ==

{{tag|blockquote}} presents text in an offset block.

{{markup

HyperText Markup Language

}}

Templates: {{tlx|quote}}; supports pre-formatted attribution and source parameters. For other specialized quotation templates, see :Category:Quotation templates.

== cite ==

{{tag|cite}} contains the title of a work. This is a new definition in HTML5— in the previous XML implementation {{tag|cite|o}} was used to contain a citation or a reference to other sources. No formatting is applied when this tag is used.

{{markup

|HyperText Markup Language

}}

{{tag|cite}} is generally not used directly in Wikipedia articles, and is often misused; see Wikipedia:HTML 5#cite for replacement instructions.

== code ==

{{tag|code}} formats a section of computer code. Styled with CSS through {{MediaWiki source|mediawiki.skinning/elements.less}} as a black monospaced typeface with a grey background (#F8F9FA) and border (#EAECF0).

{{markup

|use this code

|col2=Renders asFor the table cell a white background color was chosen here for a better display of the light gray background.

|col2style=background-color:#fff;

}}

Templates: {{tlx|code}} uses {{xtag|syntaxhighlight}}. See the "See also" section at the template page for additional code-markup templates.

See {{section link||samp}} and {{section link||kbd}} on this page for semantic markup of output and input, respectively.

== data ==

{{tag|data}} formats a machine-readable version of contents.

{{markup

|HTML for Dummies

|2=HTML for Dummies

}}

Attributes: value

== del ==

{{tag|del}} formats deleted text.

{{markup

|~~HyperText Markup Language~~

}}

== dfn ==

{{tag|dfn}} is used for indicating the defining instance of a term.

{{markup

|Definition

}}

Templates: {{tlx|dfn}}

== em ==

{{tag|em}} represents a span of text with emphatic stress (i.e. semantic emphasis). In most browsers, it renders as italic.

{{markup

|HyperText Markup Language

}}

Templates: {{tlx|em}}

== i ==

{{tag|i}} represents a span of text offset from its surrounding content without conveying any extra emphasis or importance, and for which the conventional typographic presentation is italic text.

{{markup

|HyperText Markup Language

}}

Wikimarkup: Use '' to open and close italic text.

{{markup

|HyperText Markup Language

}}

== ins ==

{{tag|ins}} indicates a range of text that has been added. Styled as underlined text. Used on talk pages to indicate refactored text; see WP:REDACT.

{{markup

|HyperText Markup Language

}}

== kbd ==

{{tag|kbd}} indicates user input such as keyboard input or voice commands (but no {{kbd|gray background}} as with the template {{tlx|kbd}}).

{{markup

|Press Enter

}}

Templates:

{{tlx|kbd}} applies monospace styling, and a light-grey background to distinguish from code ({{tag|code|o}}) and output ({{tag|samp|o}} or {{tlx|samp}}).
{{tlx|key press}} renders illustrated keys and keystrokes.

== mark ==

{{tag|mark}} represents a run of text in one document marked or highlighted for reference purposes, due to its relevance in another context. Marked text is formatted with a yellow background by default.

{{markup

|HyperText Markup Language

|4=HyperText Markup Language

}}

Support: Not supported by Internet Explorer 8 and below.

== pre ==

{{tag|pre}} element represents a block of preformatted text. In MediaWiki, {{xtag|pre}} is actually a parser tag and not HTML, but the function is the same. It also prevents the parsing of templates.

{{markup

HyperText Markup Language

|col2=Renders as

|col2style=background-color:#fff

HyperText Markup Language

}}

=== HTML entities ===

{{tag|pre|o}} parses HTML entities. If you want to escape this, replace & with &, or use {{xtag|syntaxhighlight|params = lang="text"}} instead.

{{markup

&amp;

|col2=Renders as

|col2style=background-color:#fff

&lt;

&amp;amp;


&amp;

&amp;lt;


&lt;

}}

Templates:

{{tlx|pre}} wraps text that overflows the page.

== q ==

{{tag|q}} is used to mark a short quotation. There has been very little implementation of this element in Wikipedia yet.

{{markup

|HyperText Markup Language

}}

MOS:QUOTATIONS says Wikipedia should instead use "", {{tl|quote}}, or

.

== rp, rt, ruby ==

{{tag|ruby}} marks spans of phrasing content with ruby annotations.

{{tag|rt}} marks the ruby text component of a ruby annotation; the ruby text shows in a reduced size over top of the normal characters.
{{tag|rp}} is used to provide parentheses around a ruby text component of a ruby annotation, to be shown by user agents that don't support ruby annotations.

Browsers that do not support ruby characters will show the ruby text in normal size, enclosed in parentheses and after the normal content.

{{markup

東(とう)

京(きょう)

東(とう)

京(きょう)

}}

Templates:

{{tlx|ruby}}
{{tlx|ruby-ja}} for Japanese
{{tlx|Ruby-zh-p}} for Chinese pinyin
{{tlx|Ruby-zh-b}} for Chinese bopomofo

== s ==

{{tag|s}} is used to indicate inline content that is no longer accurate or relevant and that has been struck from the page. It is not appropriate when indicating document edits; to mark a span of text as having been removed from a document, use {{tag|del|o}}.

{{markup

|~~HyperText Markup Language~~

}}

Templates: {{tlx|strikethrough}} (for inline content), {{tlx|strikethroughdiv}} (for block content)

== samp ==

{{tag|samp}} indicates sample output from a program or computing system. Examples include: output of a program, script, or Wikipedia template; status displays or audio announcements made by an app or device; file system directory listings and samples from them, such as paths and file names.

{{markup

|sample output: HTML

}}

Templates: {{tlx|samp}} applies monospace styling, and gives the text in dark grey to distinguish from code ({{tag|code|o}}) and input ({{tag|kbd|o}} or {{tlx|kbd}}).

== small ==

{{tag|small}} format small text.

{{markup

|HyperText Markup Language

}}

Templates:

{{tlx|small}} uses {{tag|span|o|params=style="font-size:85%;"}}. {{tlx|small}} is recommended over {{tag|small|o}} since {{tag|small}} has a semantic meaning that is for fine print, whereas {{tlx|small}} is purely stylistic.

== strong ==

{{tag|strong}} formats a span of text with strong importance or unusual emphasis; in most browsers it renders as boldface. This should generally not be used in Wikipedia articles, per WP:Neutral point of view policy. See MOS:BOLD on use of this element and other boldfacing. Most semantic emphasis, including in quoted material, should be rendered with the {{tag|em|o}} element.

{{markup

|HyperText Markup Language

}}

Templates: {{tlx|strong}}

== sub ==

{{tag|sub}} formats a span of text as a subscript.

{{markup

|HyperText _{Markup Language}

}}

Templates:{{hlist|

| {{tlx|sub}} ({{sub|subscript}} text)

| {{tlx|subsub}} ({{subsub|subscript subscript}} text)

| {{tlx|ssub}} ({{ssub|subscript, small}} text)

| {{tlx|sup}}{{nbsp}}({{sup|superscript}} text)

| {{tlx|su}} ({{su|p=superscript|b=subscript}} text)

| {{tlx|sup sub}} (text{{sup sub|sup|sub}})

| {{tlx|e}} (1.23{{e|4}})

|style=line-height:2.5

|indent=3}}

== sup ==

{{tag|sup}} formats a span of text as a superscript.

{{markup

|HyperText ^{Markup Language}

}}

Templates:

{{tlx|sub}} ({{sub|subscript}} text)
{{tlx|subsub}} ({{subsub|subscript subscript}} text)
{{tlx|ssub}} ({{ssub|subscript, small}} text)
{{tlx|sup}} ({{sup|superscript}} text)
{{tlx|su}} ({{su|p=superscript|b=subscript}} text)
{{tlx|sup sub}} (text{{sup sub|sup|sub}})
{{tlx|e}} (1.23{{e|4}})

== time ==

{{tag|time}} defines either a time (24 hour clock), or a date in the Gregorian calendar, optionally with a time and a time-zone offset.

{{markup

|10:00

}}

Attributes: datetime

Support: Not supported by Internet Explorer 8 and below.

== u ==

{{tag|u}} represents a span of text offset from its surrounding content without conveying any extra emphasis or importance, and for which the conventional typographic presentation is underlining; for example, a span of text in Chinese that is a proper name (a Chinese proper name mark), or span of text that is known to be misspelled.

{{tag|u|o}} was presentational element of HTML that was originally used to underline text; this usage was deprecated in HTML4 in favor of the CSS style {text-decoration: underline}.{{cite web |url=https://developer.mozilla.org/en-US/docs/Web/HTML/Element/u |title=<u>: The Unarticulated Annotation (Underline) element | date = 1 August 2020 |access-date= 9 October 2020 | website= mozilla.org}} In HTML5, the tag reappeared but its meaning was changed significantly: it now "represents a span of inline text which should be rendered in a way that indicates that it has a non-textual annotation". This facility is intended for example to provide a red wavy line underline to flag spelling errors at input time but which are not to be embedded in any stored file (unlike an emphasis mark, which would be).

{{markup

|HyperText Markup Language

}}

Templates: {{tlx|underline}} (which supplies the recommended CSS style)

== var ==

{{tag|var}} formats text in italics to indicate a variable in a mathematical expression or programming context, or placeholder text that the reader is meant to mentally replace with some other literal value.

{{markup

|1=

E=mc² (c is a constant not a variable)
{{TemplateName|parameter=value}}
If A then B

|2=

E=mc² (c is a constant not a variable)
{{TemplateName{{!}}parameter=value}}
If A then B

}}

Templates:

{{tlx|var}}
{{tlx|varserif}} formatted in italic serif to differentiate characters

== wbr ==

{{tag|wbr|o}} is a word break opportunity; that is, it specifies where it would be OK to add a line-break where a word is too long, or it is perceived that the browser will break a line at the wrong place.

{{markup

|Now is the time to become a power editor, by learning HyperText Markup Language

}}

As the browser window is adjusted narrower, the second example wraps between Hyper and Text.

= Lists =

Do not leave blank lines between items in a list unless there is a reason to do so, since this causes the MediaWiki software to interpret each item as beginning a new list.

== dl, dt, dd ==

{{tag|dl}}, {{tag|dt}} and {{tag|dd}} are used to create a description list (formerly definition list) with terms and descriptions. Terms are displayed in bold and descriptions are indented. Each term must include one or more descriptions.

{{markup

Term: Definition 1; Definition 2

Term: Definition 1; Definition 2

}}

Wikimarkup: {{tag|dt|o}} is created using ; while automatically enclosed in {{tag|dl}}. {{tag|dd|o}} is created using : for each value. For a single or first value the : can be placed on the same line after ; where subsequent values must be placed on separate lines.

{{markup

|; Term

: Definition 1

: Definition 2

Term: Definition 1; Definition 2

}}

Templates: {{tlx|defn}}

== ol, ul, li ==

{{tag|ol}} represents an ordered list; {{tag|ul}} represents an unordered list; {{tag|li}} represents a list item within either type of list.

{{markup

Item 1

Item 2

Item 1

Item 2

Item 1

Item 2

Item 1

Item 2

}}

Wikimarkup: use * for items in an unordered list and # for ordered lists.

{{markup

|1=# Item 1

Item 2

|2=

Item 1
Item 2

|3=* Item 1

Item 2

|4=

Item 1
Item 2

}}

Templates: for a variety of specialized uses, see :Category:List formatting and function templates.

= Containers =

== div ==

{{tag|div}} is a generic container for flow content that displays as a block element.

{{markup

|HyperText

Markup

Language

|HyperText

Markup

Language

}}

== span ==

{{tag|span}} is a container for flow content that displays as an inline element.

{{markup

|HyperText Markup Language

}}

= Tables =

== table, td, tr ==

{{tag|table}} defines a table.

{{tag|tr}} defines a table row.
{{tag|td}} defines a data cell with contents that may include text, links, images, lists, forms, other tables, etc.

{{markup

data

|2=

data

}}

Attributes:

{{tag|table|o}}:
: Allowed but not recommended: border="" and border="1"
: Allowed but obsolete: border (with a non-empty value different from "1"), align, bgcolor, cellpadding, cellspacing, frame, rules, summary, width
{{tag|td|o}}: colspan, headers, rowspan
: Allowed but obsolete: abbr, align, axis, bgcolor, scope, height, nowrap, valign, width

== th ==

{{tag|th}} defines a table header; styled as centered and bold.

{{markup

Header	Header
data	data

|2=

Header	Header
data	data

}}

Attributes:

{{tag|th|o}}: colspan, headers, rowspan, scope
: Allowed but obsolete: abbr, align, axis, bgcolor, height, nowrap, valign, width

== caption ==

{{tag|caption}} adds a caption to a table.

{{markup

Caption
data	data

|2=

Caption
data	data

}}

Attributes:

{{tag|caption|o}}:
: Allowed but obsolete: align

== thead, tfoot, tbody ==

{{tag|thead|o}}, {{tag|tfoot|o}} and {{tag|tbody|o}} are not supported, but are automatically generated when the page is rendered.

Obsolete/deprecated elements

These elements are now obsolete and either deprecated or removed in HTML5, although they are still supported by browsers. Their use should be avoided on Wikipedia. These tags either have an alternate tag or a template that replaces their function with CSS; the tags are being replaced by editors on pages throughout Wikipedia (see Wikipedia:Linter for more details). See {{slink|Wikipedia:HTML5#Obsolete elements and attributes}} for more details on obsolete HTML parts and their replacements.

= center =

{{dc|{{tag|center}} (obsolete)}} was used to center text elements.

Templates: {{tlx|center}} uses CSS.

= font =

{{dc|{{tag|font}} (obsolete)}} was used to set the font size, font face and color of text.

Templates: {{tlx|font}} uses CSS.

= rb =

{{dc|{{tag|rb}} (obsolete)}} was used to mark base text in a ruby annotation.

For replacements, see: Help:HTML in wikitext#rp, rt, ruby

= strike =

{{dc|{{tag|strike}} (obsolete)}} formatted strike-through characters; use {{tag|s}} or {{tag|del}} instead, depending on the context.

= tt =

{{dc|{{tag|tt}} (obsolete)}} formatted text in a fixed-width font. Use {{tag|code|o}}, {{tag|kbd|o}}, {{tag|var|o}}, or {{tag|samp|o}} instead, depending on the context.

Templates: {{tlx|mono}} uses CSS.

Unsupported elements

These elements are not supported, but have equivalent wiki markup. Attempting to use any element not whitelisted by {{sanitizer.php}} will result in the markup showing as plain text.

= a =

{{tag|a|o}} is used to create links. Use the wikimarkup for internal/intrawiki links and interwiki links, and [ ] for external links.

= input =

{{tag|input|o}} is used to create forms. The {{xtag|inputbox}} extension tag is used to create a text box with a button.

HTML Tidy

HTML Tidy is an outdated HTML4 library{{vague|upstream is now HTML5}} that is slated for removal. Tidy parses the MediaWiki output and cleans it up to increase the likelihood that valid HTML4 is rendered. For example, with Tidy enabled, {{tag|br|o}}, {{tag|br|c}}, {{tag|br/|o}}, {{tag|br.|o}} all rendered as {{tag|br|s}}. Tidy is not enabled for MediaWiki interface pages. Tidy was never perfect and has been known to introduce errors.

Exceptions

In some pages in the MediaWiki namespace, typically the short messages like button labels, HTML is not parsed, and tags will be exposed.

User and sitewide CSS and JavaScript pages are interpreted as if inside a {{tag|pre|o}} block. See Help:User style.

Validation

The MediaWiki software attempts to fix HTML errors, but it does not catch all of them. Where HTML is used, it is helpful to verify it with the W3C Markup Validation Service.

Parser and extension tags

References

{{reflist|refs=

{{cite web |title=HTML5: A vocabulary and associated APIs for HTML and XHTML: Obsolete Features |work=W3C |date=31 July 2014 |url=http://www.w3.org/TR/html5/obsolete.html}}

Allowable elements and attributes are defined in the {{sanitizer.php}} module.

{{cite web |title=The microdata model |work=HTML Living Standard |url=http://www.whatwg.org/specs/web-apps/current-work/multipage/microdata.html#the-microdata-model}}

}}

External links

HTML 4.01 specification: [http://www.w3.org/TR/html401/index/elements.html elements] | [http://www.w3.org/TR/html401/index/attributes.html attributes]
HTML 5.2 specification: [https://www.w3.org/TR/html5/fullindex.html#index-elements elements] | [https://www.w3.org/TR/html5/fullindex.html#attributes-table attributes]

Category:Wikipedia editor help