All Versions
Crucible 4.2 DocumentationCrucible 4.1 Documentation
Crucible 4.0 Documentation
More...
Crucible supports Wiki Markup text formatting in comments and review descriptions.
The text markup notation on this page is a reference showing the available formatting commands.
When using FishEye, you can also render Wiki Markup in commit messages.
Notation |
Description |
|---|---|
|
Biggest Text |
|
Bigger heading |
|
Big heading |
|
Normal heading |
|
Small heading |
|
Smallest heading |
Text effects are used to change the formatting of words and sentences.
Notation |
Description |
|---|---|
*bold* |
Makes text appear bold. |
_italic_ |
Makes text appear in italics. |
+underline+ |
Makes text appear underlined. |
??citation?? |
Makes text appear in citation form. |
-strikethrough- |
Makes text appear struck through. |
^superscript^ |
Makes text appear in superscript. |
~subscript~ |
Makes text appear in subscript. |
{{monospaced}}
|
Placing double curly-brackets around text makes it appear |
|
To make an entire paragraph into a block quotation, place "bq. " before it.
|
{quote} |
Quote a block of text that's longer than one paragraph.
|
{color:red} |
Changes the color of a block of text. |
Wiki Markup allows you to insert breaks or different kinds of hyphens and dashes.
Notation |
Description |
|---|---|
(empty line) |
Produces a new paragraph |
\\ |
Creates a line break. |
---- |
Creates a horizontal ruler. |
--- |
Produces em dash — symbol. |
-- |
Produces en dash – symbol. |
Creating links is easy with Wiki Markup.
Notation |
Description |
|---|---|
[Crucible Review CR-FE-100|CR-FE-100] |
Creates a link to a Crucible review or FishEye artifact using the internal key reference for the item. |
[Atlassian Crucible|http://atlassian.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. External links are denoted with an arrow icon.
|
[mailto:mail@example.com] |
Creates a link to an email address. |
[file:///c:/temp/foo.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". |
{anchor:anchorname} |
Creates a bookmark anchor inside the page. You can then create links directly to that anchor. So a link like this: [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. |
Lists allow you to present information as a series of ordered items. Use asterisks * for bulleted lists and hash symbols # for numbered lists.
Notation |
Description |
|---|---|
* A bulleted list |
Examples:
|
Images can be referenced from remote sources only.
Notation |
Description |
|---|---|
!http://www.host.com/image.gif! |
The image will be displayed from the remote source. |
!http://www.host.com/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 as shown in this example. |
Tables allow you to organise content in a rows and columns, with a header row if required.
Notation |
Description |
|---|---|
||heading 1||heading 2||heading 3|| |
Makes a table. Use double bars for a table heading row. |
The code above produces a table that looks like this:
heading 1 |
heading 2 |
heading 3 |
|---|---|---|
col A1 |
col A2 |
col A3 |
col B1 |
col B2 |
col B3 |
This section covers panels, code windows and showing plain text with no formatting.
Notation |
Description |
|---|---|
{noformat} |
Makes a preformatted block of text with no syntax highlighting. All the optional parameters of the {noformat} macro are valid for the {panel} macro as well.
This is a no-formatted piece of text, so *no* _formatting_ is done here. |
{panel} |
Embraces a block of text within a fully customizable panel. The optional parameters you can define are as follows.
|
{code}code goes here{code} |
The code macro displays a preformatted block for showing code with syntax highlighting. All the optional parameters of the {panel} macro are valid for {code}. The default language is Java but you can specify JavaScript, ActionScript, XML or SQL. Bar.java // Some comments here
public String getFoo()
{
return foo;
}
<test> <another tag="attribute"/> </test> |
Emoticons and often-used images can be easily embedded with the following Wiki Markup Syntax:
Notation |
Description |
|---|---|
\X |
Escape special character X (i.e. {) |
:), :( |
Graphical emoticons (smileys): |
Notation |
:) |
:( |
:P |
:D |
;) |
(y) |
(n) |
(i) |
(/) |
(x) |
(!) |
Image |
|
|
|
|
|
|
|
|
|
|
|
Notation |
(+) |
(-) |
(?) |
(on) |
(off) |
(*) |
(*r) |
(*g) |
(*b) |
(*y) |
Image |
|
|
|
|
|
|
|
|
|
|