Wikivoyage:Wiki markup

From Wikivoyage
Jump to: navigation, search

Wikivoyage uses a special code called Wiki markup for formatting the text and images in an article. The Wiki markup used while editing a page will determine how the text looks and what links and images are in the page.

When editing Wikivoyage articles, try to follow the conventions in the Manual of style. These are guidelines for making a "good" Wikivoyage article; if you don't quite get all of them, then just do what you can, and someone else will come through and clean up your work after you're done.

Text formatting[edit]

To get this output... ...use this markup.

Bold text is surrounded by three apostrophes.

'''Bold text''' is surrounded by three apostrophes.

Italic text is surrounded by two apostrophes.

''Italic text'' is surrounded by two apostrophes.

For a bullet-point list, put each list item on its own line, with a star in front of it:

  • Winken
  • Blinken
  • Nod

For a bullet-point list, put each list item on its own line, with a star in front of it:

*Winken
*Blinken
*Nod

A numbered list is similar to a bullet-point list, but each item starts with a hash symbol instead:

  1. Tinker
  2. Evers
  3. Chance

A numbered list is similar to a bullet-point list, but each item starts with a hash symbol sign instead:

#Tinker
#Evers
#Chance

Making links[edit]

To get this output... ...use this markup.

You can link to an article like Main Page by adding the article title with two square brackets around it.

You can link to an article like [[Main Page]] by adding the article title with two square brackets around it.

You can give the link alternate text, like go to the main page, by adding a vertical bar after the title, and then the text you want to use.

You can give the link alternate text, like [[Main Page|go to the main page]], by adding a vertical bar after the title, and then the text you want to use.

Links in different namespaces, like Project:FAQ or User:EvanProdromou, work the same way.

Links in different namespaces, like [[Project:FAQ]] or [[User:EvanProdromou]], work the same way.

Using a vertical bar at the end of the link (but before the closing brackets) will hide the namespace, like FAQ or EvanProdromou.

Using a vertical bar at the end of the link (but before the closing brackets) will hide the namespace, like [[Project:FAQ|]] or [[User:EvanProdromou|]].

It's OK to put in links to a page that doesn't exist yet.

It's OK to put in links to [[a page that doesn't exist yet]].

Putting a URL like http://www.google.com/ into text makes it into a clickable external hyperlink automatically.

Putting a URL like http://www.google.com/ into text makes it into a clickable external hyperlink automatically.

You can give an external hyperlink more readable and helpful text like Google, by using a single square bracket, the URL, a space, your chosen text, and a closing square bracket.

You can give an external hyperlink more readable and helpful text like [http://www.google.com/ Google], by using a single square bracket, the URL, a space, your chosen text, and a closing square bracket.

Special links[edit]

Links to articles on the same topic in some special namespaces appear, not in the article itself, but in the "Related sites" and "In other languages" sidebars. These links go at the end of the article, in this order:

  • Links to other language versions of Wikivoyage have the format [[xx:Article]], where "xx" is the code for the language being linked to.
  • Links to Wikipedia have the format [[Wikipedia:Article]].
  • Links to DMOZ have the format [[Dmoz:Article]].

Listings[edit]

Content in the special tags <see>...</see>, <do>...</do>, <eat>...</eat>, <drink>...</drink>, <sleep>...</sleep>, <listing>...</listing> is automatically formatted into a listing for an attraction, activity, restaurant, bar or accommodation. These listings can be automatically added and edited by pointing and clicking, and you should generally not need to touch their contents in the page editor; see Project:Listings for details.

Templates[edit]

Text enclosed in curly brackets {{}} is used to insert the contents of templates into text. For example, {{warningbox|Don't go here}} produces the following:

Travel Warning WARNING: Don't go here

See Project:Template index for a full list.

Tables[edit]

Think twice before you add a table to Wikivoyage: many things like complicated transport schedules go out of date pretty much instantly and are thus better not added. But if you insist, here's how they work:

{|
table start -- add class="wikitable" to make the lines between table cells visible
|+
table caption, optional; only between table start and first table row
|-
table row, optional on first row -- wiki engine assumes the first row
! 
table header cell, optional. Consecutive table header cells may be added on same line separated by double marks (!!) or start on new lines, each with its own single mark (!).
|
table data cell, required! Consecutive table data cells may be added on same line separated by double marks (||) or start on new lines, each with its own single mark (|).
|}
table end

So, for example, this:

{| class="wikitable"
|+ Caption
! Header 1 !! Header 2
|-
| Cell 1 || Cell 2
|}

Looks like this:

Caption
Header 1 Header 2
Cell 1 Cell 2

Comments[edit]

Text enclosed between the special comment characters <!-- and --> is not displayed. This can be used to leave instructions or warnings visible only when editing the page, but should be used sparingly.

See also[edit]