Wiki Markup Help

Table of Contents

Text Effects

You can change the formatting of words and sentence through Text effects.

SyntaxDescription
*strong*
Makes text strong.
_emphasis_
Makes text emphasis.
??citation??
Makes text in citation.
-strikethrough-
Makes text as strikethrough.
+inserted+
Makes text as inserted.
^superscript^
Makes text in superscript.
~subscript~
Makes text in subscript.
{{monospaced}}
Makes text as monospaced.
bq. This is block quoted text

To make an entire paragraph into a block quotation, place "bq. " before it.

Example:

This is block quoted text
{quote}
    This text is quotable
Sentence to be quoted {quote}

Quote a block of text that's longer than one paragraph.

Example:

This text is quotable
  Sentence to be quoted
{color:red}
    It is very important!
{color}

Changes the color of a block of text.

Example:

It is very important!

Headings

To create a header, place "hn. " at the start of the line, where n can be a number from 1-6.

Tables

Tables allow you to organize content in a rows and columns, with a header row if required.

SyntaxDescription
||heading 1||heading 2||heading 3||
|col A1|col A2|col A3|
|col B1|col B2|col B3|

Makes a table. Use double bars for a table heading row.

The code given here produces a table that looks like:

heading 1heading 2heading 3
col A1col A2col A3
col B1col B2col B3

Text Breaks

Most of the time, explicit paragraph breaks are not required - The wiki renderer will be able to paginate your paragraphs properly.

SyntaxDescription
(empty line)
Produces a new paragraph
\\
Creates a line break. Not often needed, most of the time the wiki renderer will guess new lines for you appropriately.
----
Creates a horizontal ruler.
---
Produces symbol.
--
Produces symbol.

Links

It helps you create links quickly.


SyntaxDescription
[#anchor]
[^attachment.ext]
Creates an internal hyperlink to the specified anchor or attachment. Appending the '#' sign followed by an anchor name will lead into a specific bookmarked point of the desired page. Having the '^' followed by the name of an attachment will lead into a link to the attachment of the current issue.
[http://qmetry.com]
[QMetry|http://qmetry.com] 

Creates a link to an external resource, special characters that come after the URL and are not part of it must be separated with a space.

The [] around external links are optional in the case you do not want to use any alias for the link.

Examples:

http://qmetry.com
QMetry

[mailto:support@qmetry.com]

Creates a link to an email address, complete with mail icon.

Example:

support@qmetry.com

[file:///c:/temp/test.txt]
[file:///d:/file/on/network/share.txt]

Creates a download link to a file on your computer or on a network share that you have mapped to a drive. To access the file, you must right click on the link and choose "Save Target As".

By default, this only works on Internet Explorer but can also be enabled in Firefox.

{anchor:anchorname}
Creates a bookmark anchor inside the page. You can then create links directly to that anchor. So the link [My Page#here] will link to wherever in "My Page" there is an {anchor:here} macro, and the link [#there] will link to wherever in the current page there is an {anchor:there} macro.
[~username]
Creates a link to the user profile page of a particular user, with a user icon and the user's full name.
[pagetitle] or [spacekey:pagetitle]Creates a link to the specified page in the desired space (or the confluence space associated with this JIRA project if you dont specify any space).


Lists

Lists allow you to present information as a series of ordered items.

SyntaxDescription
* some
* bullet
** indented
** bullets
* points

A bulleted list (must be in first column). Use more (**) for deeper indentations.

Example:

  • some
  • bullet
    • indented
    • bullets
  • points
- different
- bullet
- types

A list item (with -), several lines create a single list.

Example:

  • different
  • bullet
  • types
# a
# numbered
# list

A numbered list (must be in first column). Use more (##, ###) for deeper indentations.

Example:

  1. a
  2. numbered
  3. list

Images

Images can be embedded into a wiki renderable field from attached files or remote sources.

SyntaxDescription
!http://www.host.com/image.gif!
or
!attached-image.gif!

Inserts an image into the page.

If a fully qualified URL is given the image will be displayed from the remote source, otherwise an attached image file is displayed.

!image.jpg|thumbnail!

Insert a thumbnail of the image into the page (only works with images that are attached to the page).

!image.gif|align=right, vspace=4!

For any image, you can also specify attributes of the image tag as a comma separated list of name=value pairs like so.