Help:Wiki markup

Wiki markup is the syntax and keywords used by the MediaWiki software to format a page. To learn how to see this markup and to save an edit, see: Help:Editing.

Section headings
The  through   markup are headings for the sections with which they are associated.
 * A single = is styled as the article title and should not be used within an article.
 * Headings are styled through CSS and add an  link.
 * Four or more headings cause a table of contents to be generated automatically.
 * Do not use any markup after the final heading markup – this will either break the heading, or will cause the heading to not be included in an edit summary.

And so on.

Wiki headings translate to HTML heading elements, through, styled as follows by default:

Templates: fake heading for use in documentation

Horizontal rule
The horizontal rule represents a paragraph-level thematic break. Do not use in article content.

HTML:

Table of contents
When a page has at least four headings, a table of contents (TOC) will automatically appear after the lead and before the first heading. The TOC can be controlled by magic words or templates:
 * forces the TOC to appear at the normal location regardless of the number of headings.
 * forces the TOC to appear at the point where the magic word is inserted instead of the normal location.
 * disables the TOC entirely.
 * TOC limit can be used to control the depth of subsections included in the TOC. This is useful where the TOC is long and unwieldy.
 * Category:TechInfoDepot table of contents templates contains a number of specialized TOC templates.

Line breaks
Line breaks or newlines are used to add whitespace between lines, such as separating paragraphs.
 * A line break that is visible in the content is inserted by pressing Return twice.
 * Pressing Return once will place a line break in the markup, but it will not show in the rendered content, except when using list markup.
 * Markup such as bold or italics will be terminated at a line break.

HTML: or

Templates:
 * break adds multiple line breaks.
 * crlf2 adds a true carriage return and line feed.
 * - adds a break with styling to clear floating elements.
 * plainlist creates an unbulleted list.

Indent text
Indentation is most commonly used on talk pages.

Templates: outdent, outdent2

Blockquote
When there is a need for separating a block of text. This is useful for (as the name says) inserting blocks of quoted (and cited) text.

Center text
Template center uses the same markup. To center a table, see Help:Table.

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.

Definition lists
To list terms and definitions, start a new line with a semicolon followed by the term. Then, type a colon followed by a definition.

Definition lists consist of group names corresponding to values. Group names (terms) are in bold. Values (definitions) are indented. Each group must include one or more definitions. For a single or first value, the  can be placed on the same line after   – but subsequent values must be placed on separate lines.

HTML: , 

Templates: defn

Retaining newlines and spaces
The MediaWiki software suppresses single newlines and converts lines starting with a space to preformatted text in a dashed box. HTML suppresses multiple spaces. It is often desirable to retain these elements for poems, lyrics, mottoes, oaths and the like. The Poem extension adds HTML-like  tags to maintain newlines and spaces. These tags may be used inside other tags such as . CSS styles may be applied to this tag, e.g.:.

Egyptian hieroglyphs
WikiHiero is a software extension that renders Egyptian hieroglyphs as PNG images using hiero tags.

Example:

Diacritical marks

 * See Help:Special characters.

Other punctuation, escaping special characters
The and  markup tags are also available. (For writing  "[", "{", "&", "}", "]" , for example.)

Subscripts and superscripts

 * The Manual of Style prefers the x1 format.
 * The latter methods of sub/superscripting cannot be used in the most general context, as they rely on Unicode support which may not be present on all users' machines. For the 1, 2, 3 superscripts, it is nevertheless preferred when possible (as with units of measurement) because most browsers have an easier time formatting lines with it.

Mathematical characters

 * See also WikiProject Mathematics and TeX.

Mathematical formulae

 * Formulae that include mathematical letters, like $x$, and operators like  should not use the plain letter  . See math font formatting. For a comprehensive set of symbols, and comparison between  tags and the math template see section TeX vs HTML.


 * The tag typesets using LaTeX markup, which may render as an image or as HTML, depending on environmental settings. The  tag is best for the complex formula on its own line in an image format. If you use this tag to put a formula in the line with text, put it in the nowrap template.


 * The math template uses HTML, and will size-match a serif font, and will also prevent line-wrap. All templates are sensitive to the  sign, so remember to replace   with   in template input. Use wikimarkup   and   inside the math template, as well other HTML entities. The math template is best for typeset formulas in line with the text.

Spacing in simple math formulae

 * Using   to prevent line break is not needed; the math template will prevent line breaks anyway; you can use if you need an explicit line break inside a formula.

Complicated formulae

 * See Help:Displaying a formula for how to use.
 * A formula displayed on a line by itself should probably be indented by using the colon character.

Free links
In TechInfoDepot and some other wikis, free links are used in wikitext markup to produce internal links between pages, as opposed to the concept of CamelCase for the same purpose, which was used in the early days of TechInfoDepot – see CamelCase and TechInfoDepot.

In TechInfoDepot's markup language, you create free links by putting double square brackets around text designating the title of the page you want to link to. Thus,  will be rendered as Texas. Optionally, you can use a vertical bar (|) to customize the link title. For example, typing  will produce Lone Star State, a link that is displayed as " Lone Star State " but in fact links to Texas.

Link to another wiki article

 * Internally, the first letter of the target page is automatically capitalized and spaces are represented as underscores (typing an underscore in the link has the same effect as typing a space, but is not recommended).
 * Thus the link hereafter is to the Web address, which is the TechInfoDepot article with the name "Public transport". See also Canonicalization.
 * A red link is a page that doesn't exist yet; it can be created by clicking on the link.
 * A link to its own page will appear only as bold text.

Renamed link

 * Same target, different name.
 * The target ("piped") text must be placed first, then the text to be displayed second.

Automatically rename links

 * Simply typing the pipe character (|) after a link will automatically rename the link in certain circumstances. The next time you open the edit box you will see the expanded piped link. When previewing your edits, you will not see the expanded form until you press Save and Edit again. The same applies to links to sections within the same page.
 * See Pipe trick for details.

Blend link

 * Endings are blended into the link.
 * Exception: a trailing apostrophe (') and any characters following the apostrophe are not blended.
 * Preferred style is to use this instead of a piped link, if possible.
 * Blending can be suppressed by using the tag, which may be desirable in some instances.

Link to a section of a page

 * The part after the hash sign (#) must match a section heading on the page. Matches must be exact in terms of spelling, case, and punctuation. Links to non-existent sections are not broken; they are treated as links to the beginning of the page.
 * Include "| link title" to create a stylish (piped) link title.
 * If sections have the same title, add a number to link to any but the first. goes to the third section named "Example section". You can use the pipe and retype the section title to display the text without the # symbol.

Create page link

 * To create a new page:
 * Create a link to it on some other (related) page.
 * Save that page.
 * Click on the link you just made. The new page will open for editing.
 * For more information, see starting an article and check out TechInfoDepot's naming conventions.
 * Please do not create a new article without linking to it from at least one other article.

Redirects

 * Redirect one article title to another by placing a directive like the one shown to the right on the first line of the article (such as at a page titled "USA").
 * It is possible to redirect to a section. For example, a redirect to United States will redirect to the History section of the United States page, if it exists.

Link to the same article in another language (interlanguage links)

 * To link to a corresponding page in another language, use the form:.
 * It is recommended interlanguage links be placed at the very end of the article.
 * Interlanguage links are not visible within the formatted article, but instead appear as language links on the sidebar (to the left) under the menu section "languages".


 * NOTE: To create an inline link (a clickable link within the text) to any foreign language article, see Help:Interlanguage links and consider the usage notes.

Interwiki link

 * Link to any page on other Wikimedia wikis.
 * Note that interwiki links use the internal link style.
 * See Interwiki_map for the list of shortcuts; if the site you want to link to is not on the list, use an external link (see hereafter).
 * See also Wikimedia sister projects.

Categories

 * To put an article in a category, place a link like  into the article. As with interlanguage links, placing these links at the end of the article is recommended.
 * To link to a category page without putting the article into the category, use a colon prefix (":Category") in the link.

"As of" tag

 * "As of" tags generate phrases like "As of April 2009" or "as of April 2009", and categorize info that will need updating. For an explanation of the parameters see template documentation.

Media link

 * To include links to non image uploads such as sounds, use a "media" link. For images, see next section.
 * Some uploaded sounds are listed at Sound.

Book sources

 * Link to books using their ISBN, which creates a link to Special:BookSources. This is preferred to linking to a specific online bookstore, because it gives the reader a choice of vendors. However, if one bookstore or online service provides additional free information, such as table of contents or excerpts from the text, then a link to that source will aid the user and is recommended. ISBN links do not need any extra markup, provided you use one of the indicated formats.
 * To create a link to Special:BookSources using alternative text (e.g. the book's title), use the internal link style with the appropriate namespace.

RFC number

 * Link to an Internet Engineering Task Force Request for Comments (RFC).

Pronunciation aids
It is often desirable to provide an aid to pronunciation for a word. The IPAc-en and Respell templates can be of assistance.

Refer to TechInfoDepot:Manual of Style (pronunciation) for more information.

Musical notation
Musical notation is added by using the p extension tag. For example:

Images
Only images that have been uploaded to TechInfoDepot can be used. To upload images, use the upload page. You can find the uploaded image on the image list.

See the TechInfoDepot's image use policy as a guideline used on TechInfoDepot.

For further help on images, including some more versatile abilities, see the picture tutorial.

Tables
There are two ways to build tables:
 * In special wiki-markup (see Help:Table).
 * Using HTML elements:, , or.

See also When tables are appropriate.

References and citing sources
Making a reference citing a printed or online source can be accomplished by using the  tags. Inside these tags details about the reference are added.

Details about the citation can be provided using a structure provided by various templates; the table below lists some typical citation components.

Templates and transcluding pages
Examples for templates:, $2x &amp;times; 4y &amp;divide; 6z + 8 &amp;minus; y/z^{2} = 0$, ,

Templates are segments of wiki markup that are meant to be copied automatically ("transcluded") into a page. You add them by putting the template's name in. It is also possible to transclude other pages by using.

There are three pairs of tags that can be used in wikitext to control how transclusion affects parts of a template or article. They determine whether or not wikitext renders, either in its own article, which we will call "here", or in another article where it is transcluded, which we will call "there". There can be several such section "elements". Also, they can be nested. All possible renderings are achievable. For example, to render there one or more sections of the page here use   tags. To append text there, wrap the addition in   tags before, within, or after the section. To omit portions of the section, nest   tags within it.
 *  :  the content will not be rendered there. These tags have no effect here.
 *  :  the content will render only there, and  will not render here (like invisible ink made visible by means of transclusion).
 *  :  the content will render here and will render there, but it will only render there what is between these tags.

If a page is transcluded without transclusion markup, it may cause an unintentional categorization. Any page transcluding it will contain the same category as the original page. Wrap the category markup with   tags to prevent incorrect categorization.

Some templates take parameters, as well, which you separate with the pipe character.

Signing comments

 * The character tilde (~) is used when adding a comment to a Talk page.
 * Your username provides a link to your user page.

Linking to old revisions of pages, diffs, and specific history pages

 * External link function is mainly used for these.
 * Open an old revision or diff and copy the URL from the address bar, pasting it where you want it.


 * For an old revision, you can also use a permalink. Though here only the main text is guaranteed to be retained (images and templates will be shown as they are today, not as they were at the time).

User edits

 * Link to a user's Contributions page.

Show deleted or inserted text

 * When editing regular TechInfoDepot articles, just make your changes and do not mark them up in any special way.
 * When editing your own previous remarks in talk pages, it is sometimes appropriate to mark up deleted or inserted content.
 * To indicate deleted content use .
 * To indicate inserted content use .

Limiting formatting / escaping wiki markup
A few different kinds of formatting will tell the wiki to display things as you typed them – what you see is what you get!

Nowiki
 and tags stop parsing of wiki markup, except HTML character entity references (e.g. for special characters). Unlike, "nowiki" doesn't change formatting.

An example of <nowiki ></nowiki>:

(However in this particular case probably you prefer to create a link as cite book, or  prints .)

A singular can be used to break wikimarkup.


 * Markup such as *, #, ; and : only and always take effect at the beginning of a line. A  before the markup will cause the characters to not parse as markup.
 * An internal link immediately followed by characters are blended to form a single link. Where this is not desired, add a after the link.
 * HTML(-like) tags can be stopped parsing by inserting after the opening angle bracket..

If you want to write tags, tag template is handy. E.g. prints <nowiki ></nowiki>.

HTML entities

and parse HTML entities. If you want to escape this, replace  with.

Use in templates

When used in a template, simply does not work as you may expect.
 * Including immediately acts upon the enclosed markup. Attempting to escape or transclude the brackets causes  to not work at all.
 * Using #tag:nowiki works, but has major limitations:
 * Templates, parameters, parser functions, and parser magic such as signatures are parsed, not nowikied.
 * Included tags will expose the strip markers.

Pre
is a parser tag that emulates the HTML tag. It defines preformatted text that is displayed in a fixed-width font and is enclosed in a dashed box. HTML and wiki markups are escaped and spaces and line breaks are preserved, but HTML entities are parsed.

formatted text does not wrap, thus text may extend past the browser window:

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

To resolve this, may use CSS styling to add wrapping or a horizontal scrollbar:
 * Wrapping:
 * Scroll bar:

Alternatively, consider using pre2 template or p.

Invisible text (comments)
It's uncommon – but on occasion acceptable for notes to other editors – to add a hidden comment within the text of an article. These comments are only visible when editing or viewing the source of a page. Most comments should go on the appropriate Talk page. The format is to surround the hidden text with " " and " " and may cover several lines, e.g.:

Another way to include a comment in the wiki markup uses the Void template, which can be abbreviated as ^. This template "expands" to the empty string, generating no HTML output; it is visible only to people editing the wiki source. Thus operates similarly to the comment. The main difference is that the template version can be nested, while attempting to nest HTML comments produces odd results.

Variables
 is the number of pages in the main namespace which contain a link and are not a redirect. This includes full articles, stubs containing a link, and disambiguation pages.

' is the genitive (possessive) grammatical form of the month name, as used in some languages but not in English; ' is the nominative (subject) form, as usually seen in English.

In languages where it makes a difference, you can use constructs like  to convert a word from the nominative case to some other case. For example,  means the same as.

HTML
Many HTML tags can be used in wiki markup. You can check your HTML by using markup validation.