テキスト入力記法

TestRail の一部のフィールドでは、リッチテキスト フォーマットが利用できます。TestRail では、Markdown という簡単に習得できる構文を使用して、リッチテキスト フォーマットを使用できます。

たとえば、単語を斜体にするには、 *this* のようにアスタリスクで囲みます。同様に、単語を太字にするには、2 つのアスタリスクで囲みます。

リストの作成、リンクの追加、コード ブロック、ヘッダー、画像の配置など、さまざまな構文要素があります。使用可能な構文オプションの一覧と使用方法の例については、以下を参照してください。

構文リファレンスと強調表示は、 Stack Overflow に倣っています。

斜体と太字

単語を強調する方法は複数あります。

コードと整形済みテキスト

コード ブロックを作成するには、スペース 4 つでインデントします。

テキストはタグで囲まれ、等幅の書体で表示されます。先頭の 4 つのスペースは削除されますが、他のすべての空白は保持されます。

コード ブロック内では Markdown または HTML は無効です。そのため、コード ブロックは Markdown または HTML 構文のサンプルを表示するのに便利です。

コード ブロックをテキスト ブロックに埋め込む場合、前後に空白行が必要です。

コード スパン

インラインコードスパンを示すにはバッククオートを使用します。

(たいていのキーボードでは、バッククオート キーは左上にあります。)

コード ブロックと同様に、コード スパンも等幅フォントで表示されます。スパン内では Markdown と HTML は機能しません。

リンク

リンクを記述する方法は 2 つあります。2 番目の方法のほうが可読性に優れています。

リンク定義は、ドキュメントの任意の場所に置くことができます。使用する場所の前でも後でもかまいません。

ヘッダー

最上位レベルのヘッダーを作成するには、アンダーライン テキストを使用します。

= または – 記号の数は考慮されません。1 つだけでも構いません。しかし、テキストの下線として十分な数を使用すると、プレーン テキストでもタイトルが見やすくなります。

下位レベルのヘッダーにはハッシュを使用します。

最後の ＃ 文字はオプションです。

水平区切り

1 行にハイフン、アスタリスク、アンダースコアだけを 3 つ以上置くと水平区切りを挿入できます。

文字の間にスペースを入れることもできます。

これらのサンプルはすべて同じ表示結果になります。

単純なリスト

箇条書きリスト:

番号付きリスト:

一行空きリスト:

ブロック引用

ブロック引用はインデントされます。

画像

画像はリンクと同じですが、前に感嘆符 (!) が付きます。

角括弧内の単語は、ブラウザーが画像を表示できない場合に表示される代替テキストです。スクリーン読み上げソフトウェアへの対応として、必ず意味のある代替テキストを設定してください。

テーブル

TestRail 5.0 以降が必要です。テーブルは次のようにフォーマットします。

最初の行は、テーブル ヘッダーと列の配置を指定します。配置は、それぞれのヘッダー セルの先頭/末尾にあるコロン文字によって決まります。以下の配置がサポートされています。

テーブル セル自体は、一部のリッチテキスト フォーマットだけをサポートします。次の機能がテーブル セル内でサポートされています。

• • コード スパン（固定フォント フォーマット用）
  • リンク

高度なリスト

他の Markdown ブロックをリストに入れることができます。ネスト レベルごとに 4 つのスペースでインデントします。

高度なブロック引用

他の Markdown ブロックをブロック引用に入れることができます。 > に続けてスペースを追加します。