ケースコメント形式 (Markdown)

更新 -

概要

  • 基本のテキスト形式 (太字、斜体、順序なしリスト/箇条書き、H1 および H2) は、ポータルのケース管理でコメントを作成する時にメニューバーに表示されます。プレーンテキストのコメントは引き続きサポートされます。
  • 最終形式で作成される前に、プレビュー機能を利用して表示することができます。
  • 自動リンク機能は、ケース番号と Bugzilla で使用できます。
    これは、marked.js Markdown ライブラリーを使用して実行できます。ドキュメント [1]、デモ [2]、および GitHub [3] ページを参照してください。
  • 追加の形式は、適切なマークダウン構文を入力するとサポートされます。一部の一般的な例は、「一部の一般的な構文例」のセクションに記載されています。marked.js は CommonMark [4] をサポートします。これらのリンクは対応する仕様向けであり、それらの構文の使用方法に関する追加情報を提供します。

詳細情報

ケースコメントを作成するユーザーは、以下のような基本的な形式を利用できます。

  • 太字
  • 斜体
  • 順序なしリスト (箇条書き)
  • H1 および H2

ポータルのケース管理では、ケースコメントの作成時に、これらの形式オプションをメニューバーで利用できます。プレーンテキストのコメントは引き続きサポートされます。コメントとコメント履歴はプレーンテキスト形式になります。

この機能に対応するために、marked.js と呼ばれる Markdown ライブラリーを使用しています。marked.js のドキュメントについては [1] を参照してください。インタラクティブなデモページは [2] を、GitHub ページは [3] を参照してください。

ケースコメントペインの「Markdown」ツールバー機能に加えて、適切な構文 (または「Markdown 言語」) を含めることで、より高度な Markdown 機能を適用することができます。marked.js は CommonMark [4] および GitHub [5] Markdown 構文をサポートします。これらのリンクは、Markdown 構文の使用方法の詳細を説明する各仕様ドキュメントへのリンクになります。

一部の一般的な構文例

太字

**This is bold**

斜体

_This is Italics_

順序付きリスト

1. This
2. Is
3. An
4. Ordered
5. List

順序なしリスト

- This
- Is
- An
- Unordered 
- List

H1、H2、H3 など

# This is h1 text
## This is h2 text
### This is h3 text 

バックティックコード

`10 print “HELLO”`
`20 GOTO 10`

マルチラインコード

~~~
10 PRINT "HELLO"
20 GOTO 10
~~~

マルチラインコードは、以下のように ~ の代わりにバックティックを 3 つ使用することもできます。

```
10 PRINT “HELLO”
20 GOTO 10
```

URL

[Text to turn into a link\](URL of page you want to link to)
For example:
[What is an sosreport and how to create one in Red Hat Enterprise Linux?](https://access.redhat.com/solutions/3592)

References

[1] marked.js documentation - https://markedjs.org
[2] marked.js demo - https://marked.js.org/demo/
[3] marked.js GitHub - https://github.com/markedjs/marked
[4] CommonMark - https://spec.commonmark.org/
[5] GitHub Markdown - https://github.github.com/gfm/