Markdown

Markdown ウィジェットは、Markdown の書式設定を適用したテキストの表示をサポートします。ウィジェットの高度な機能を使用すると、テキストへの帰属情報の付与、引用、ユーザーによるタグ付けなどの追加のワークフローを有効にできます。

Markdown ウィジェットを設定するモジュールビルダーは、次の機能を使用できます。

• 太字、斜体、取り消し線、ハイライトなどの基本的な Markdown のテキスト書式設定
• 見出し、テーブル、ブロックのスタイル、コードのスタイル、URL などの高度な Markdown の書式設定

次のスクリーンショットは、オブジェクトへの参照を含む、設定済みの Markdown ウィジェットの例です。オントロジーのオブジェクトへの参照が関連付けられたアンカーテキストには下線が表示され、選択できます。

• 特定のハイライトされたアンカーテキストからオントロジーのオブジェクトへの埋め込み参照
• 特定のハイライトされたアンカーテキストから、クリック時に Workshop イベントをトリガー

次の例は、注釈オブジェクトを表示する設定済みの Markdown ウィジェットです。埋め込みオブジェクトに対して、次のユーザーインタラクションが設定されています。

• テキストの特定の部分に注釈オブジェクトを表示
• 表示された注釈オブジェクトから、クリック時に Workshop のアクションとイベントをトリガー
• テキストの特定の部分に新しい注釈オブジェクトを作成

設定オプション

次のスクリーンショットは、未設定の Markdown ウィジェットの初期状態と、その初期設定パネルを示しています。

Markdown ウィジェットの主な設定オプションは次のとおりです。

• 入力データ：テキスト/変数

  • テキスト： テキストの選択肢を選択した場合、ビルダーは表示したい入力 Markdown テキストを設定パネルに直接入力できます。
  • 変数： 変数の選択肢を選択した場合、表示する入力 Markdown テキストとして文字列変数を選択できます。

• 表示オプション：

  • タグタイプの設定

    • 標準： このオプションはデフォルトで有効になっており、標準の Markdown の書式設定で入力を表示します。
    • インライン参照： 有効にすると、オントロジーのオブジェクトへの参照と、クリック時の Workshop イベントをテキストに埋め込めます。これは Markdown 構文のカスタム拡張機能です。詳しくは、後述のインライン参照セクションを参照してください。
    • 注釈： 有効にすると、テキストに埋め込まれた注釈オブジェクトの表示、既存の注釈オブジェクトに対するユーザーインタラクション、およびウィジェットを使用した新しい注釈オブジェクトの作成が可能になります。詳しくは、後述の注釈セクションを参照してください。

  • 等幅フォントを有効にする： ウィジェット内のテキストを等幅フォントで表示するかどうかを切り替えます。

  • スクロールを有効にする： ウィジェットのスクロールを有効にするかどうかを切り替えます。

  • 長い単語の折り返しを許可する： ウィジェットの幅を超える、区切りのない長い文字列（長い URL など）の折り返しを有効にするかどうかを切り替えます。有効にすると、このような文字列はウィジェットからはみ出す代わりに次の行に折り返されます。新しいウィジェットではデフォルトで有効になっています。

  • 改行を反映する： Markdown ソース内の単一の改行をどのように表示するかを切り替えます。有効にすると、ソース内の単一の改行によって、表示される出力で新しい行が始まります。新しいウィジェットではデフォルトで有効になっています。無効にすると、標準の Markdown の表示に従い、単一の改行はスペースに置き換えられます。

  • 文字揃え： ウィジェット内に表示される Markdown コンテンツの配置を設定します。左寄せ（デフォルト）、センター、または右を選択します。

    Markdown のテーブル構文で明示的に定義された列ごとの配置（たとえば、| :---: |）は、ウィジェットレベルの文字揃えの設定より優先されます。選択した配置にかかわらず、コードブロックは左寄せで全幅のまま表示されます。

• ユーザーのテキスト選択：

  • ユーザーが選択した生のテキストを出力する： ユーザーが選択したテキストを生の Markdown 文字列として出力します。
    • 選択されたテキスト： ユーザーが選択したテキストを生の Markdown として含む、出力された文字列変数です。
  • ユーザーが選択したインデックスを出力する： ユーザーが選択したテキストの開始インデックスと終了インデックスを数値変数として出力します。
    • 選択開始インデックス： ユーザーが選択したテキストの開始インデックスを含む数値出力変数です。
    • 選択終了インデックス： ユーザーが選択したテキストの終了インデックスを含む数値出力変数です。

構文の例

サポートされている Markdown 構文の例を以下に示します。ハイライト構文 ==text== とタスクリストは、一般的な Markdown 実装では標準ではありませんが、サポートされています。サポートされている Markdown 構文と対応する例を次のテーブルに示します。

Markdown は、レベル1からレベル6までの見出しをサポートしています。

テーブル

ハイフンの行でヘッダー行と本文行を区切ります。列ごとの配置を設定するには、区切り行にコロンを追加します。

Copied!
1
2
3
4
| Left aligned | Centered | Right aligned |
| :----------- | :------: | ------------: |
| Row 1        | Data 1   | 1.00          |
| Row 2        | Data 2   | 22.50         |

テーブル構文で定義された列ごとの配置は、ウィジェットレベルの文字揃え設定よりも優先されます。

コードブロック

コードブロックを3つのバッククォートで囲みます。構文の強調表示を有効にするには、開始側のバッククォートの後に言語識別子を追加します。

Copied!
1
2
3
4
```python
def get_flight_delay(alert_id):
    return alerts[alert_id].delay_minutes
```

テキストのハイライト

==text== 構文は、単一の固定されたハイライト色を適用します。この色は Markdown 構文から変更できません。ハイライト色を設定する属性、パラメーター、代替構文はないため、==text== は常にデフォルトの色で表示されます。

ウィジェットは HTML を表示しないため、<mark style="background-color: blue">text</mark> のようなインラインスタイルでも色は変更されません。代わりに、そのままのテキストとして表示されます。制限事項を参照してください。

ほかの色でハイライトを表示するには、次のいずれかの設定ベースのオプションを使用します。色は Markdown テキストではなく、ウィジェットの設定パネルで設定します。

• インライン参照プロパティ： 参照されるオブジェクトタイプごとにハイライト色を設定します。ハイライトされるテキストがオントロジーのオブジェクトに対応する場合に、このオプションを使用します。インライン参照プロパティを参照してください。
• 注釈： 注釈レイヤーごとにハイライト色を設定します。ハイライトされるテキストが注釈オブジェクトに保存された開始インデックスと終了インデックスによって定義される場合、またはユーザーが自分でハイライトを作成する必要がある場合に、このオプションを使用します。注釈を参照してください。

インライン参照プロパティは、静的に定義された色、書式設定が構成されたオントロジープロパティから継承される色、またはオブジェクトのプロパティ値に基づく条件付き書式設定ルールをサポートしています。注釈は、静的に定義された色または条件付き書式設定ルールをサポートしています。条件付き書式設定では、同じオブジェクトタイプまたは注釈レイヤーのオブジェクトに異なる色を表示できます。

組み合わせた例

次の Markdown 入力は、上記の構文の種類をいくつか組み合わせたものです。表示結果を確認するには、Markdown ウィジェットのテキスト入力に貼り付けます。

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Flight delay summary

## Status

Newark airport has **two high-priority delays** and ==one unresolved alert==.
The *estimated* recovery time is ~~90 minutes~~ 45 minutes.

| Alert  | Delay (minutes) | Status      |
| :----- | --------------: | :---------: |
| A00150 |              45 | Unresolved  |
| A00182 |              20 | Resolved    |

> Delay figures are refreshed every 15 minutes.

### Follow-up items

- [x] Notify the gate agents
- [ ] Update the passenger notice board
  - [ ] Terminal A
  - [ ] Terminal B

Refer to the `flight-alert` object type for the full schema, or see the
[status page](https://palantir.com) for live updates.

---

Markdown ウィジェット内のオブジェクト参照

インライン参照

高度な機能として、Markdown ウィジェットでは、作成者が Markdown テキストの一部（「アンカー」）にタグを付け、そのアンカーを使用して特定のオントロジーオブジェクトにリンクしたり、Workshop のクリック時イベントをトリガーしたりできます。

アンカーを作成するための形式は次のとおりです。

Copied!
1
:objectreference[$text_to_display]{objectType="$object_type_id" primaryKey="$object_primary_key"}

次の例では、文中で2個の Flight Alerts オブジェクトを参照しています。まず、ユーザーの画面に表示される最終的な状態を確認します。注：以下で参照されている Flight Alert オブジェクトは、ユーザーがそれぞれ個別に選択でき、選択すると Markdown ウィジェットの出力である選択されたオブジェクトセットに含まれます。

上記の表示に使用する Markdown 入力は次のとおりです。

Newark airport has __*rarely*__ seen flight issues in May, but there were two high-priority delays: :objectreference[Alert A00150]{objectType="flight-alert" primaryKey="A00150"} and :objectreference[Alert A00182]{objectType="flight-alert" primaryKey="A00182"}

作成者は、上記の Markdown 入力の構文に加えて、オブジェクト参照に関する次のオプションも設定できます。

• 選択されたオブジェクトセット： オブジェクト参照の使用に必須です。これは Markdown ウィジェットの出力オブジェクトセットです。ユーザーが Markdown ウィジェット内のオブジェクト参照を選択すると、そのオブジェクトがこのオブジェクトセット変数に出力されます。
• オブジェクトタイプ： オブジェクト参照の使用に必須です。作成者は、Markdown ウィジェット内で参照するすべてのオブジェクトタイプを選択する必要があります。オブジェクトタイプを追加すると、内部の設定パネルで条件付き書式設定ルールも設定できます。Markdown ウィジェット内で参照されていても、このリストで設定されていないオブジェクトタイプのオブジェクト参照は、Markdown ウィジェットに表示されません。
  • Object type: 色とイベントのオプションをさらに設定するオブジェクトタイプを指定します。
  • ハイライト色： 固定の色を選択するか、オントロジーの書式設定を持つプロパティから色を継承するか、色を決定するカスタムルールを定義します。
  • 選択時のイベントをオーバーライド： 指定したオブジェクトタイプに対してトリガーする Workshop イベントを設定します。これらのイベントは、ほかの選択時イベントをオーバーライドします。
• 選択時の動作： Markdown ウィジェット内の選択時の動作を制御します。
  • ハイライトなしを選択した場合、Markdown ウィジェット内でオブジェクト参照を選択しても、選択状態にはなりません。
  • 最後に選択した項目をハイライトを選択した場合、Markdown ウィジェット内でオブジェクト参照を選択すると、最後に選択したアンカーテキストがハイライトされます。
  • 選択された参照をハイライトを選択した場合、Markdown ウィジェット内のハイライトは、選択されたオブジェクトセットの内容に基づきます。このオプションは、Markdown 内のオブジェクト参照が別のウィジェットのオブジェクトと1対1で対応し、両方のウィジェットの選択されたオブジェクトセットが同じ場合に最適です。
• 選択時のイベント： このオプションでは、モジュール作成者が、Markdown ウィジェット内でオブジェクト参照を選択したときにトリガーする Workshop イベントを設定できます（たとえば、より詳細な Object View を含むドロワーを表示するイベント）。

:objectreference レンダラーは、objectType 属性と primaryKey 属性を使用して参照を解決します。ハイライト色は構文には含まれず、一致するオブジェクトタイプに設定されたハイライト色から決まります。2つの参照を異なる2色の固定色で表示するには、次の例のように、異なる2個のオブジェクトタイプを参照し、それぞれに異なるハイライト色を設定します。

Copied!
1
2
3
Two delays were reported at :objectreference[Newark]{objectType="airport" primaryKey="EWR"}:
:objectreference[Alert A00150]{objectType="flight-alert" primaryKey="A00150"} and
:objectreference[Alert A00182]{objectType="flight-alert" primaryKey="A00182"}.

上記の入力では、airport の参照と2つの flight-alert の参照は、それぞれのオブジェクトタイプに設定されたハイライト色で表示されます。構文自体に色の属性を追加しても効果はなく、オブジェクトタイプに記載されていないオブジェクトタイプへの参照はプレーンテキストとして表示されます。

同じオブジェクトタイプでも、オブジェクトごとに色を変えることができます。これを行うには、オブジェクトタイプのハイライト色を、書式設定済みのオントロジープロパティから継承するように設定するか、プロパティ値に基づく条件付き書式設定ルールを定義します。

Markdown 内のオブジェクト参照には、標準の Markdown 書式設定も適用できます。以下のスクリーンショットには、オブジェクトを埋め込んだ見出しやテーブルなど、さまざまな Markdown 書式設定の例が含まれています。

注釈

注釈オプションを使用すると、Markdown ウィジェットでテキスト上に注釈オブジェクトを表示できます。このオプションでは、ユーザーがテキストの選択部分に新しい注釈オブジェクトを作成したり、表示されている注釈オブジェクトに対してアクションやイベントを実行したりすることで、ウィジェット内のテキストを操作することもできます。

注釈オブジェクトは、0始まりの数値インデックスを使用して選択されたテキストを記録します。テキスト選択の開始位置と終了位置を表す際に、開始インデックスはその位置を含み、終了インデックスはその位置を含みません。Markdown ウィジェットの注釈は、現在、負のインデックスに対応していません。

注釈オプションを選択すると、次の設定が利用可能になります。

• 既存の注釈を表示 個別の注釈オブジェクトレイヤーを設定して、ウィジェット内にさまざまな注釈を表示します。
  • 注釈の入力
    • 名前： ウィジェット設定で注釈レイヤーの名前を設定します。
    • 注釈オブジェクトセット： 表示する注釈オブジェクトタイプを含むオブジェクトセットを指定します。
    • 開始インデックス： 注釈の開始インデックス（この値を含む）を表す数値オブジェクトプロパティを設定します。
    • 終了インデックス： 注釈の終了インデックス（この値を含まない）を表す数値オブジェクトプロパティを設定します。
  • 既存の注釈とのインタラクション
    • 選択された注釈： 現在選択されている注釈オブジェクトを含むオブジェクトセットです。
    • 選択時のイベント： 注釈オブジェクトの選択時にトリガーするイベントを設定します。
    • ツールチップに表示するプロパティ： 注釈オブジェクトのホバー時ツールチップに表示するオブジェクトプロパティを指定します。
    • ホバー時のインタラクション： 注釈オブジェクトのホバー時ツールチップに表示する、アクションやイベントなどのホバー時のインタラクションを設定します。
      • アイコン： ホバー時のインタラクションに表示するアイコンを設定します。
      • タイトル： ホバー時のインタラクションに表示するタイトルを設定します。タイトルは、インタラクションのアイコンにカーソルを置くと表示されます。
      • インタラクション： 注釈オブジェクトに対してトリガーできるアクションまたはイベントを設定します。
        • カーソルが置かれたオブジェクト： カーソルが置かれた注釈オブジェクトを参照するために使用できる、特別なアクションパラメーター値です。
  • 注釈の表示オプション
    • ハイライト色： 注釈の表示に使用する色を設定します。カスタム色を固定で定義するか、条件付き書式設定ルールを設定できます。
    • 注釈の書式設定： 注釈の表示方法を設定します。選択肢には、色付きのハイライト、実線または破線の下線、注釈に対するハイライトと下線の両方が含まれます。
• アクションまたはイベントで注釈を作成： ウィジェット内でテキストをハイライトしたときに、新しい注釈オブジェクトを作成するアクションまたはイベントを設定します。
  • アイコン： テキストのハイライト時に表示するアイコンを設定します。
  • タイトル： テキストのハイライト時に表示するタイトルを設定します。タイトルは、アイコンにカーソルを置くと表示されます。
  • インタラクション： ハイライトされたテキストに対してトリガーできるアクションまたはイベントを設定します。
    • ハイライトされたテキスト： ウィジェット内でハイライトされたテキストを参照するために使用できる、特別なアクションパラメーター値です。

制限事項

Markdown ウィジェットは HTML の表示に対応していません。Markdown ウィジェットに入力された HTML は、テキストとして表示されます。これにはインラインスタイルも含まれるため、HTML を使用して表示出力の色、フォント、間隔を制御することはできません。

==text== ハイライト構文は、Markdown から変更できない単一の固定色を適用します。色付きのハイライトは、代わりにウィジェットの設定パネルでオブジェクトタイプまたは注釈レイヤーに設定します。テキストのハイライトを参照してください。