テキスト整形のルール (Backlog記法)

 

課題へのリンク

課題キーを直接書くか、あるいは課題キーを2重かっこで囲むことで、他の課題へのリンクを作成できます。

入力文字の例

これはどうやら[[BLG-104]]と同じ現象のようです。[[BLG-87]]も合わせて参照してください。

結果

これはどうやらBLG-104と同じ現象のようです。BLG-87も合わせて参照してください。

URLへのリンク

URLを2重かっこで囲むことで、URLへのリンクを作成できます。

入力文字の例

このバグについては、このページ [[https://backlog.com/ja/]] が参考になります。
このバグについては、このページ [[Backlog>https://backlog.com/ja/]] が参考になります。
このバグについては、このページ [[Backlog:https://backlog.com/ja/]] が参考になります。

結果

このバグについては、このページ https://backlog.com/ja/ が参考になります。
このバグについては、このページ Backlog が参考になります。
このバグについては、このページ Backlog が参考になります。

見出し

「*(アスタリスク)」から始まる行は見出しとして見なされます。

入力文字の例

* 見出し1
** 見出し2
*** 見出し3

結果

見出し | プロジェクト管理ツールBacklog

箇条書き

「-(ハイフン)」から始まる行は箇条書きとして見なされます。

「+(プラス)」から始まる行は番号付きの箇条書きとして見なされます。

入力文字の例

箇条書き

- 箇条書き1
- 箇条書き2
-- 箇条書き2-1
--- 箇条書き2-1-1

番号つき箇条書き

+ 箇条書き1
+ 箇条書き2
+ 箇条書き3

結果

箇条書き | プロジェクト管理ツールBacklog

チェックリスト

課題詳細の入力画面にて、リスト記法の先頭を「 [ ] 」または「 [x] 」で開始すると、チェックボックス付きのリストに変換されます。

また、変換されたチェックボックスで、チェックを入れたり外したりすると、課題が更新されます。

チェックリストは課題詳細のみで使用できます。

入力文字の例

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

結果

太字、斜体文字、打ち消し、色

「''」で囲まれた文字は太字、「'''」で囲まれた文字は斜体文字、「%%」で囲まれた文字は打ち消しになります。

文字色を指定したり、文字の背景色を指定することもできます。

入力文字の例

これは''太字''です。
これは'''斜体文字'''です。
これは%%打ち消し%%です。
これは&color(red) { 赤 }です。
これは&color(#ffffff, #8abe00) { 背景色 }です。

結果

太字・斜体・打ち消し | プロジェクト管理ツールBacklog

行頭から「|」で区切ることで表を作成することができます。

行の最後に「h」をつけると、その行がヘッダー行になります。

また、セルの先頭に「~」をつけると、そのセルがヘッダー行になります。

入力文字の例

ヘッダーなし

| ホスト名 | IPアドレス   |     備考      |
| sun        | 192.168.100.1   |                  |
| earth     | 192.168.100.2   |                  |
| moon    | 192.168.100.20 | 予備機です |

ヘッダーあり(h)

| ホスト名 | IPアドレス   |     備考      |h
| sun        | 192.168.100.1   |                  |
| earth     | 192.168.100.2   |                  |
| moon    | 192.168.100.20 | 予備機です |

ヘッダーあり(~)

|~ ホスト名 | IPアドレス   |     備考      |
|~ sun        | 192.168.100.1   |                  |
|~ earth     | 192.168.100.2   |                  |
|~ moon    | 192.168.100.20 | 予備機です |

結果

表 | プロジェクト管理ツールBacklog

引用文

「>」から始まる行は引用文として見なされます。
また、「{quote}」から「{/quote}」に囲まれた文字も引用文として見なされます。

入力文字の例

>引用した内容です。
>引用した内容です。

{quote}
引用した内容です。
{/quote}

結果

引用文 | プロジェクト管理ツールBacklog

コードマクロ

「{code:java}」から「{/code}」に囲まれた文字はjavaコードになります。Eclipseの標準文字色で表示されます。

「{code:cs}」から「{/code}」に囲まれた文字はC#コードになります。VisualC#.NETの標準文字色で表示されます。

「{code}」から「{/code}」に囲まれた文字はなんらかコードとみなして、汎用的な色付けが行われて表示されます。

入力文字の例

javaコード

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

C#コード

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

結果

javaコード

javaコード

C#コード

C#コード

特殊な文字のエスケープ

「\\(¥¥)」を特殊な文字の前に書くことで、そのまま文字を出力することが可能です。

入力文字の例

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

結果

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

Wiki添付ファイルへのリンク

Wikiページに添付されたファイルへのリンクを挿入できます。

通常はツールバーを利用して挿入しますので、記法を意識する必要はありません。

入力文字の例

#attach(sample.zip:11)

結果

sample.zip

Wiki添付ファイル画像の表示

Wikiページに添付された画像ファイルを挿入できます。

通常はツールバーを利用して挿入しますので、記法を意識する必要はありません。

入力文字の例

#image(11)

結果

Wiki添付ファイル画像の縮小表示

Wikiページに添付された画像ファイルのサムネイルを挿入できます。

通常はツールバーを利用して挿入しますので、記法を意識する必要はありません。

なお、画像ファイルのサイズが 200KB 未満の場合に使用できます。

入力文字の例

#thumbnail(11)

結果

Subversionリビジョンへのリンク

「#rev(リビジョン番号)」と記述するとSubversionのリビジョン詳細へのリンクを挿入できます。

入力文字の例

#rev(11)

結果

r11

目次

「#contents」と記述すると見出しに基づいて目次を作成します。

入力文字の例

#contents

結果

箇条書き | プロジェクト管理ツールBacklog

改行

「&br;」と記述するとその場所で改行されます。

入力文字の例

>aaa&br;bbb

結果

aaa
bbb