Documentation for Crucible 2.10.x. Documentation for other versions is available too.

Skip to end of metadata
Go to start of metadata

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.

(info) When using FishEye, you can also render Wiki Markup in commit messages.

Headings

Notation

Description


h1.Biggest heading


Turns text into a heading at size 1.

Biggest Text


h2.Bigger heading


Turns text into a heading at size 2.

Bigger heading


h3.Big heading


Turns text into a heading at size 3.

Big heading


h4.Normal heading


Turns text into a heading at size 4.

Normal heading


h5.Small heading


Turns text into a heading at size 5.

Small heading


h6.Smallest heading


Turns text into a heading at size 6.

Smallest heading

Text Effects

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 monospaced.


bq. Block Quote

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

Example:

Some block quoted text

{quote}
here is quoteable
content to be quoted
{quote}

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

Example:

here is quoteable
content to be quoted

{color:red}
look ma, red text!
{color}

Changes the color of a block of text.

Example: look ma, red text!

 

Text Breaks

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.

Examples:

[mailto:mail@example.com]

Creates a link to an email address.
Example:
mail@example.com

[file:///c:/temp/foo.txt]
[file:///z:/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".

{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

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
* Second item
** indented item 1
** indented item 2

# A numbered list
# Second item
## indented item 1
## indented item 2

Examples:

  • A bulleted list
  • Second item
    • indented item 1
    • indented item 2
  1. A numbered list
  2. Second item
    1. indented item 1
    2. indented item 2

Images

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

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||
|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 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

Advanced Formatting

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.
Example:

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.

  • title: Title of the panel
  • borderStyle: The style of the border this panel uses (solid, dashed and other valid CSS border styles)
  • borderColor: The color of the border this panel uses
  • borderWidth: The width of the border this panel uses
  • bgColor: The background color of this panel
  • titleBGColor: The background color of the title section of this panel
    Examples:

    Some text in a basic panel

    My Title

    Some text with a title

{code}code goes here{code}

{code:title=Bar.java|borderStyle=solid}
// Some comments here
public String getFoo()
{
return foo;
}
{code}

{code:xml}
<test>
<another tag="attribute"/>
</test>
{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.

Examples:

Java with a title bar:

Bar.java


A basic display with XML code:

Miscellaneous Markup Features

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): (smile), (sad) .

Notation

:)

:(

:P

:D

;)

(y)

(n)

(i)

(/)

(x)

(!)

Image

(smile)

(sad)

(tongue)

(big grin)

(wink)

(thumbs up)

(thumbs down)

(info)

(tick)

(error)

(warning)

Notation

(+)

(-)

(?)

(on)

(off)

(*)

(*r)

(*g)

(*b)

(*y)

Image

(plus)

(minus)

(question)

(lightbulb)

(grey lightbulb)

(star)

(red star)

(green star)

(blue star)

(star)

  • No labels

3 Comments

  1. Anonymous

    Is it posible to create additional syntax highlighting for languagues not on the list?

    Our code is on visual basic.net and although the code is colored by fisheye, our crucible comments can't be highlighted.

    1. Displaying Source Code

      VB .net source code can be shown like this:

      {code:vbnet}
      rem some code here
      {code}
      

      See https://marketplace.atlassian.com/plugins/jira.plugin.syntaxhighlighter.macro.syntaxplugin for more information.

  2. Anonymous

    Is it possible to tag a person:

    example:

    I agree with

    <opening syntax to tagging a person>Nam of the person<closing the syntax> regarding the concept on bla bla...