Rule to formatting texts (Backlog)

Link to issues

Entering the whole key for the issue or issue keys with 2 brackets in the front and the back will link to the issue.

Example

This seems to be the same phenomenon as we saw in [[BLG-104]].
Please refer BLG-87 also.

Result

This seems to be the same phenomenon as we saw in BLG-104. Please refer BLG-87 also.

Link to the URL

Double brackets around the URL create a link to the URL.

Example

This website https://nulab.com/ is useful to solve this bug.
This website [[Backlog>https://nulab.com/backlog/]] is useful to solve this bug.
This website [[Backlog:https://nulab.com/backlog/]] is useful to solve this bug.

Result

This website https://nulab.com/backlog/ is useful to solve this bug. This website Backlog is useful to solve this bug. This website Backlog is useful to solve this bug.

Header

The lines start with * (asterisk) are considered as the header.

Example

* Header1
** Header2
*** Header3

Result

Bulleted List

The lines start with - (hyphen) are considered as the bulleted list. The lines start with + (plus) are considered as the numbered list.

Example

Bulleted List
- Item-A
- Item-B
-- Item-B-1
--- Item-B-2-a

numbered list
+ Item-A
+ Item-B
+ Item-C

Result

Checklist (issue description only)

In your list, add [ ] or [x] after the dash to convert it to a list of check boxes. Issues are updated when you (un)select a check box.

Example

- [ ] Item-A
- [x] Item-B
-- [ ] Item-B-1
--- [ ] Item-B-2-a

Result

Bold, Italic, Strike, Color

The words bracketed with '' (2 single quotes) will be bold, ''' (3 single quotes) will be italic and %% (percent signs) will be strike. You can change the color of texts and backgrounds.

Example

This is ''Bold''.
This is '''Italic'''.
This is %%Strike%%.
This text is in &color(red) {red}.
This text is on a &color(#ffffff, #8abe00) { background }.

Result

This is Bold.

This is Italic.

This is Strike.

This text is in red.

This text is on a background.

Table

By separating phrases by | (vertical bar), a table can be inserted. Row with h in the end becomes a header. If you put ~ (tilde) before the phrases, the column becomes a header.

Example

Without header
|Host Name|IP address |Note |
|sun |192.168.100.1 | |
|earth |192.168.100.2 | |
|moon |192.168.100.20|spare system|

With header (h)
|Host Name|IP address |Note |h
|sun |192.168.100.1 | |
|earth |192.168.100.2 | |
|moon |192.168.100.20|spare system|

With header (~)
|~Host Name|IP address |Note |
|~sun |192.168.100.1 | |
|~earth |192.168.100.2 | |
|~moon |192.168.100.20|spare system|

Result

Quote

The lines start with > (greater than sign) are considered as a quote. {quote} and {/quote} around the text create a quote.

Example

> This phrase is a quotation.
> This phrase is a quotation.

{quote}
This phrase is a quotation.
{/quote}

Result

Code Macro

The words bracketed with {code:java} and {/code} are considered as java code. They will be displayed in the default color of Eclipse. The words bracketed with {code:cs} and {/code} are considered as C# code. They will be displayed in the default color of VisualC#.NET. The words bracketed with {code} and {/code} are considered as a kind of code. They will be displayed in the general-purpose color.

Example

Java code
{code:java}
package helloworld;
public class Hello {
  public String sayHello {
    return "Hello";
  }
}
{/code}

C# code
{code:cs}
using System;
public class Hello {
  public String sayHello {
    return "Hello";
  }
}
{/code}

Result

Escape text formatting

Insert \\ (¥¥) before a text to prevent text formatting.

Example

\\%\\%Not Striked\\%\\%
\\\\Home\hoge\hoge2

Result

%%Not Striked%%

\\Home\hoge\hoge2

Links to issues and Wikis

To create a link to another issue in the same Space, simply put the issue key or enclose it in double [[]] (square brackets). For the Wiki, the name of the Wiki page needs to be enclosed in double [[]] (square brackets).

Example

This seems to be the same phenomenon as we saw in [[BLG-104]]. 
Please refer BLG-87 also.
Check out [[Home]] at first.

Result

This seems to be the same phenomenon as we saw in BLG-104. Please refer BLG-87 also. Check out Home at first.

Links to Subversion revisions

Insert a link to the Subversion's revision details by putting # (hash), "rev" and revision number enclosed in () (round brackets) together.

Example

#rev(11)

Result

Links to Git revisions

# (hash) with rev(repository:revision) translates into a link to the Git's revision details.

Example

#rev(app:abcdefg)

Result

Links to a file attached on Wiki

You can insert links to the attached files on Wiki. Usually the link is inserted through the toolbar on the Wiki's editing page, so you don't need to memorize this formatting rule.

Example

#attach(sample.zip:11)

Result

Showing attached file image on Wiki

You can insert an image file that has been attached to Wiki. Usually the link is inserted through the toolbar on the Wiki's editing page, so you don't need to memorize this formatting rule.

Example

#image(11)

Result

Show Thumbnail of Attached File in Wiki

You can insert a thumbnail of the image file that has been attached to Wiki. Usually the link is inserted by the toolbar, so you don't need to memorize how. This feature is available when the size of the image is less than 200KB.

Example

#thumbnail(11)

Result

Link to Subversion Revision Index

The link to Subversion revision details can be inserted when you type #rev(revision number).

Example

#rev(11)

Result

Index

If you type #contents, Backlog automatically creates an index of the headers.

Example

#contents

Result

Break

If you type &br;, a break will be inserted.

Example

aaa&br;bbb

Result