Text formatting syntax for plans

You can use text formatting syntax for editing plan overviews and additional pages. Formatting includes bold text, bullets and numbered lists, tables, and links to work items and external Web sites. You can also add color to the foreground (text) and background of the page. When viewing pages in edit mode, you can add or download attachments. By default, additional pages include two image attachments: Complete and In Progress.

To use formatting syntax for plans, switch the plan to edit mode by clicking edit. To use content assistance options for editing, press Ctrl + Spacebar. The plan editor uses WikiCreole wiki editing syntax (http://www.wikicreole.org/). Table 1 identifies a quick reference for some syntax and its output. For more detail, see the version specifications at WikiCreole.

Table 1. Text formatting syntax for plans
Source Syntax Formatted Text Output
//italics// italics
**bold** bold
* Bullet list
* Second item
** Sub item
  • Bullet list
  • Second item
    - Sub item

# Numbered list
# Second item
## Sub item
Numbered list
__Underlined__ text (double underscore character, before and after the text) Underlined text
--strikethrough text--
strikethrough text
Link to a Web page:
[[http://www.example.com|Example Web Page]]
Example Web Page
= Main Heading
== Large heading
=== Medium heading
==== Small heading
Headings
No
linebreak!
No linebreak!
Force\\line break

Force
line break

Horizontal line:
----

Horizontal line:
_____________________________________________

{{image.jpg|title}}
Note: The use of a title is optional.
image
title
Build a table with "|" separators. Designate the header row with "=" in each cell. Add a line break in a cell with "\\".
|=Heading Col 1 |=Heading Col 2         |
|Cell 1.1       |Two lines\\in Cell 1.2 |
|Cell 2.1       |Cell 2.2               |
table
To include characters used in the wiki syntax in its source format without rendering the formatted output, enclose the text with three brackets:
{{{
==[[Nowiki]] //**don't**format//
}}}

==[[Nowiki]] //**don't**format//

You use an escape character (~) to indicate that the following character has no wiki syntax meaning; for example:

~= Not A Heading

= Not A Heading
You can drag a work item to the page (while it is in edit mode) to create a link to the work item. The resulting syntax specifies the work item type and its ID.

[[Defect 54321 |${summary} (${id})]]

work item type with its ID
You can type a work item type and its ID and optionally specify custom text for the link.

[[Task 43210 | Custom link]]

text with link to work item
red##This is red foreground##
colorize text
##This is blue background##blue
colorize text background
<<<xhtml
Embed XHTML code on the page. My list:<br/>
<ul>
  <li>Item 1</li>
	<li>Item 2</li>
</ul>
>>>
Embed XHTML code on the page. My list:
  • Item 1
  • Item 2

Feedback

Did this help? You can provide feedback at Jazz.net (registration required): Comment in the forums or submit a bug