レンダラーの設定

Renderers are configured on a per field basis. To configure a renderer for a particular field, see Specifying field behavior. Note that you can configure the same field differently for different projects and work types — see Associating field behavior with work types.

レンダラーは Jira プラグインとして実装されます。つまり、Jira 内で簡単に追加または削除できます。これには、開発可能な任意のカスタムレンダラーも含まれます。

レンダラーの設定前に、以下の「Jira アプリケーションに関する情報」をお読みください。

始める前に: Jira 管理者グローバル権限を持つユーザーとしてログインする必要があります。

レンダリング可能なフィールド

Jira アプリケーション内のフィールドはレンダリング可能なフィールドとなる可能性があります。ただし、これはテキストベースのフィールド (既定のテキストレンダラーおよび Wiki スタイルレンダラーの場合) や複数選択フィールド (オートコンプリートレンダラーや選択リストレンダラーの場合) の場合にのみ意味を成します。次の図は、標準でレンダリング可能な Jira フィールドを示しています。

レンダラーのタイプ

Jira には次のレンダラーが付属しています。

• テキスト フィールドの場合: Wiki スタイル レンダラーと初期設定のテキスト レンダラー

• 複数選択フィールドの場合: オートコンプリート レンダラーと選択リスト レンダラー

既定のテキストレンダラー

初期設定のテキスト レンダラーは、次のようなその他の自動リンク機能によって、フィールドの内容をプレーン テキストとしてレンダリングします。

コンテンツ	説明	サンプル
Jira work items	If the text contains text that resolves to a Jira work item key, an HTML link will be generated, pointing to that work item.
Web リンク	テキストに Web サイト上の Web ページを解決するテキストが含まれている場合、その Web リンクを示す HTML リンクが生成されます。

既定のテキストレンダラープラグインは、システムが正しく機能するために必要なため、無効化できません。後から無効化するレンダラーを使用するようテキストフィールドを設定した場合、既定のテキストレンダラーを使用するようフィールドが元に戻されます。

Wiki スタイルレンダラー

Wiki スタイルレンダラーを使用すると、ユーザーは Wiki マークアップを入力し、HTML コンテンツを生成できます。

このレンダラーは Confluence Wiki レンダラーエンジンを使用しているため、Confluence Wiki 記法を使用します。Confluence 記法は学びやすく、以下が可能です。

• 斜体、太字、下線付きテキスト

• 複数レベルの見出しでドキュメントを整理する

• 箇条書き、番号付け、テーブル、引用

• 画像、スクリーンショット、絵文字

• マクロによる強力なアプリケーション
  完全な表記ガイドについては、こちらをご参照ください。

一部のフィールドでは、さらにフィールド動作設定の有効化が必要な場合があります。「フィールド動作の指定」をご参照ください。

Wiki スタイルレンダラーのマクロサポート

Wiki スタイルレンダラーは、Confluence と同じ方法でプラグ可能なマクロをサポートしています。マクロは Wiki マークアップ言語を示す、簡単で強力な拡張子を提供します。JIRA には多数のマクロが付属しています。

Jira と Confluence でマクロを共有することができますが、Confluence マクロの多くは Confluence アプリケーションに固有なため、Jira 内では動作しません。たとえば、Confluence の「children」マクロは、ページの子どページすべてへのリンクを表示します。Jira には「ページ」の概念がないため、このマクロは Jira では動作しません。

オートコンプリート レンダラーおよび選択リスト レンダラー

オートコンプリートレンダラーと選択リストレンダラーを使用すると、テキストの入力を開始後、オートコンプリートが行われるか、オプションのドロップダウンリストから選択できます。

Jira オペレーションに関する情報

The fact that Jira allows you to configure different renderers across different projects/work types for the same field has implications for bulk operations. Also, since the wiki style renderer inherently creates HTML as its end product, there are implications as to how this will behave when work item data is viewed outside Jira's web front-end.

一括移動

When performing a bulk move operation you can either move work items to an environment (project/work type) where the renderer types for the fields are the same or where they will be different.

レンダラーのタイプが同じ場合

If the renderer types for where you are moving to are the same then you will not notice any changes to the way the work item data is displayed once the move has occurred and the move operation will not prompt you with any warnings.

レンダラーのタイプが異なる場合

When bulk moving work items to an environment (project/work type) that has a different renderer type defined for one of the fields being affected by the move, if any of the work items have a non empty value associated with the field, the move operation will present you with a warning so that you are aware of the change. The warning does not affect the move operation in any way but it is there to alert you to the fact that the moved work items' affected fields may look different in their new project/work type.

一括編集

一括編集操作を実行する際、一括編集可能なレンダリング可能フィールドは、テキストフィールドのインスタンスと、フリーテキストフィールド (無制限のテキスト) カスタムフィールドです。一括編集操作では、説明、環境、またはコメントフィールドの一括編集を行うことはできません。

You will only be allowed to bulk edit a renderable field if all the work items selected for edit use the same renderer type. If the renderer type differs for any of the selected work items you will be presented with an error message.

This is best illustrated with an example. Let's say you have two global custom fields, 'Custom text area' and 'Custom text field', whose types are as their names imply. Let's say you have project 'A' which is configured to use the wiki style renderer for both of the fields. Let's say you also have a project 'B' which is configured to use the default text renderer for the 'Custom text area' field and the wiki style renderer for the 'Custom text field'. Let's also say that you have one work item in each project. If you were to perform a bulk edit operation on the two work items in these projects, you will be presented with the following:

メール通知

JIRA では、電子メール通知に関係した拡張設定を使用でき、HTML とテキストの 2 種類の電子メールを送信できます。詳細については、「通知スキームの作成」および「電子メール通知の設定」を参照してください。

HTML メール

When using the Atlassian wiki renderer, the rendered content (i.e. exactly what you see on the 'View work item' page) will be sent out in the emails. This will create emails which are as rich as the content makes it. If using the wiki style renderer, this is the preferred type of email since it is a real representation of the wiki markup.

テキストメール

アトラシアン Wiki レンダラーを使用すると、Wiki スタイル レンダラーを使用するテキスト メールのフィールドに実際の Wiki マークアップ (レンダリングされていない) が表示されます。これは明らかに、マークアップのレンダリングされていないバージョンよりも読みやすくなりますが、マークアップの構文は非常にシンプルなため、テキストは読みやすいままとなります。

Excel ビュー

Jira allows the All work view to be exported to an Excel spreadsheet. If any of the fields being exported to Excel are using the wiki style renderer, the value exported to the cell in Excel will be the original wiki markup. Attempting to display complex HTML within a cell in Excel adds rows and columns that make using the data for formulas very difficult.

レンダリングされたいない Wiki マークアップは、Wiki スタイル レンダラーを使用する Excel セルのフィールドに表示されます。

RSS/XML ビュー

Jira allows the All work view to be exported to RSS/XML. If a field is using the default text renderer its values will be exported in a CDATA section within the generated XML. If a field is using the wiki style renderer, its rendered value will be XML escaped and included in the generated XML. If the XML view is being used as an RSS feed, most RSS readers will render the generated HTML so you will see the rich content within your RSS reader.

このビューで生の値 (レンダリングされていない) のフィードを使用したい場合、追加のパラメーター 'rssMode=raw' を送信できます。元のリンクが次のようになった場合:

次に、CDATA 内に配置された生データを持たせる URL は次のようになります。

レンダリング可能なカスタムフィールドの既定の値を編集する

When editing a renderable custom field's default value, even if it is only ever configured to use the wiki style renderer you will not be presented with the edit and preview options. Unfortunately, in this context, it is not possible to tell which renderer should be used for editing. However, if you enter a default value using wiki markup, then this will render correctly in environments (project/work type) where the field has been configured to use the wiki style renderer.

レンダラーの設定

フィールドにレンダラーを適用する

特定のフィールドのレンダラーを有効化するには、フィールド構成を編集し、フィールドに適切なレンダラーを選択します。詳細については、「フィールド動作の指定」をご参照ください。

レンダラープラグインの有効化

Jira 内のレンダラーは Jira プラグインとして実装されます。Wiki スタイル レンダラーが使用するマクロも、Jira プラグインとして実装されます。プラグインの一般的な情報については「Jira プラグイン ガイド」をご確認ください。

Note that plugins are configured at an instance-wide level — it is not possible to configure plugins at a project/work type level.

レンダラープラグインの設定

レンダラーおよびそれらの依存コンポーネントは、既定テキストレンダラーを除き、次のように有効化/無効化できます。

1. > [アプリ] の順に選択します。

2. 「アドオンを検索」画面に、Atlassian Marketplace で利用可能なアドオンが表示されます。[アドオンを管理] を選択して、Jira インスタンスに現在インストールされているプラグインを表示します。

3. 「アドオンの管理」を選択して「レンダラー」を検索し、次のようにシステムアドオンをフィルターします。

この画面には、Jira 内で設定されているすべてのレンダラーが表示されます。

• [無効化] を選択して、Jira のインスタンス全体のレンダラーを無効にします。

無効化されたレンダラーを使用するよう設定されているフィールドがあれば、既定のテキストレンダラーに戻されます。フィールドを編集し用とすると、利用できないレンダラーを使用するよう設定していることを示す警告メッセージが表示されます。

レンダラーが無効になっていると、フィールドのレンダラーを変更する際にレンダラーを選択できません。レンダラーを有効にするには [有効化] を選択します。レンダラーを有効/無効にしてもフィールド構成のレンダラー設定には影響しないため、データに影響を与えずにレンダラーを無効にしてから再度有効にできます。

Wiki スタイルレンダラーのマクロプラグインを設定する

Wiki スタイルレンダラーによって使用されるマクロは、次のように有効化/無効化できます。

1. > [アプリ] の順に選択します。

2. 「アドオンを検索」画面に、Atlassian Marketplace で利用可能なアドオンが表示されます。[アドオンを管理] を選択して、Jira インスタンスに現在インストールされているプラグインを表示します。

3. 「アドオンの管理」を選択して「レンダラー」を検索し、システムアドオンをフィルターします。

4. [Wiki レンダラー マクロ プラグイン] を展開して、次を表示します。

この画面から、Jira 内で設定されているすべてのマクロを見ることができます。マクロが無効化されている場合、それは Wiki レンダラーで使用できません。使用する追加のマクロをデプロイする場合、それを Wiki レンダラーで使用するには、ここで有効化されている必要があります。プラグインの記述の詳細については、「マクロの記述」のドキュメントをお読みください。