ツールバーのカスタマイズ id172FB00L0V6
デフォルトでは、Web エディタには、DITA エディタに必要な最も一般的な編集機能が付属しています。 エディターでは、リストタイプ \(番号付きまたは箇条書き\)の要素の挿入、相互参照、コンテンツ参照、テーブル、段落、文字の書式設定などの機能を使用できます。 これらの基本要素に加えて、Web エディターをカスタマイズして、オーサリング環境で使用する要素を挿入できます。
Web エディタのツールバーをカスタマイズする方法は 2 つあります。
-
ツールバーへの新しい機能の追加
-
ツールバーから既存の機能を削除します
ツールバーでの機能の追加
Web エディターへの機能の追加には、主に 2 つのタスクが必要です。ui_config.json ファイルへの機能のアイコンの追加と、JavaScriptへのバックグラウンド機能の追加です。
Web エディターのツールバーに機能を追加するには、以下の手順を実行します。
-
UI 設定ファイルをダウンロードするには、管理者としてAdobe Experience Managerにログインします。
-
上部の「Adobe Experience Manager」リンクをクリックし、「ツール」を選択します。
-
ツールのリストから「ガイド」を選択し、「フォルダープロファイル」をクリックします。
-
グローバルプロファイル タイルをクリックします。
-
「XML エディター設定」タブを選択し、上部の「編集 アイコンをクリックします
-
ダウンロード アイコンをクリックして、ui_config.json ファイルをローカルシステムにダウンロードします。 その後、ファイルに変更を加えて、同じものをアップロードできます。
-
ui_config.json
ファイルのツールバーセクションに新しいフィーチャーの定義を追加します。 ファイルを保存してアップロードします。通常は、新しいツールバーボタン グループを作成し、そのグループに 1 つまたは複数のツールバーボタンを追加します。 または、既存のツールバーグループ内に新しいツールバーボタンを追加できます。 新しいツールバーグループを作成するには、次の詳細が必要です。
タイプ:
type
値としてblockGroup
を指定します。 この値は、1 つまたは複数のツールバーグループを含むブロック グループを作成していることを示しています。エクストラクラス: クラスまたはクラスの名前(スペース区切り)。
items: ツールバーですべてのグループの定義を指定します。 各グループには、1 つまたは複数のツールバーアイコンを含めることができます。 ツールバーグループ内でアイコンを定義するには、
items
ールバー内でtype
属性を再度定義し、その値をbuttonGroup
に設定する必要があります。extraclass
プロパティに 1 つ以上のクラス名を指定します。label
プロパティでフィーチャー名を指定します。ui_config.json
ファイルの次のスニペットは、メインのツールバーブロックの定義と、buttonGroup
の定義を示しています。code language-none ``` "ツールバー": { "type": "blockGroup", "extraclass": "ツールバー操作", "items": [ { "type": "buttonGroup", "extraclass": "left-controls", "label": "Left Controls", "items": [ ```
items
コレクション内で、1 つ以上のツールバーアイコンの定義を指定する必要があります。ツールバーアイコンを追加するには、次のプロパティを定義する必要があります。
タイプ:
type
値としてbutton
を指定します。 この値は、ツールバーボタンを追加していることを示します。アイコン: ツールバーで使用する Coral アイコンの名前を指定します。
バリアント:
variant
値としてquiet
を指定します。タイトル: アイコンのツールチップを指定します。
クリック時: フィーチャーに定義したコマンド名をJavaScript ファイルで指定します。 コマンドに入力パラメーターが必要な場合は、コマンド名を次のように指定します。
code language-none ```Javascript "on-click": {"name": "AUTHOR_INSERT_ELEMENT", "args": "simpletable"} ```
表示/非表示:
show
プロパティを定義する場合は、アイコンを表示するモードを指定します。 使用可能な値は、-@isAuthorMode
、@isSourceMode
、@isPreviewMode
、true
\(すべてのモードで表示\)、またはfalse
\(すべてのモードで非表示\)です。show
の代わりに、hide
プロパティを定義することもできます。 使用できる値は、プロパティの場合と同じshow
すが、指定したモードではアイコンが表示されないという違いしかありません。次の例では、ツールバーの「バージョンを表示」アイコンをクリックしたときに表示されるAEM Guidesのバージョン番号を示しています。
JavaScript ファイルに次のコードを追加します。
code language-javascript $(document).ready(setTimeout(function() { fmxml.commandHandler.subscribe({ key: 'user.alert', next: function() { alert("AEM Guides version x.x") } }) }, 1000))
この機能を ui_config.json ファイルに次のように追加します。
code language-javascript "type": "button", "icon": "alert","variant": "quiet","title": "About AEM Guides","show": "true","on-click": "user.alert"
-
clientlib フォルダーを作成し、JavaScriptをこのフォルダーに追加します。
-
apps.fmdita.xml_editor.page_overrides の値を割り当てて、clientlib フォルダーのカテゴリプロパティを更新します。
-
ui_config.json ファイルを保存し、web エディターをリロードします。
ツールバーからフィーチャを削除する
現在 Web エディタで使用できるすべての機能を提供したくない場合があります。その場合は、Web エディタのツールバーから不要な機能を削除できます。
ツールバーから不要な機能を削除するには、次の手順を実行します。
-
UI 設定ファイルをダウンロードするには、管理者としてAdobe Experience Managerにログインします。
-
上部の「Adobe Experience Manager」リンクをクリックし、「ツール」を選択します。
-
ツールのリストから「ガイド」を選択し、「フォルダープロファイル」をクリックします。
-
グローバルプロファイル タイルをクリックします。
-
「XML エディター設定」タブを選択し、上部の「編集 アイコンをクリックします
-
ダウンロード アイコンをクリックして、ui_config.json ファイルをローカルシステムにダウンロードします。 その後、ファイルに変更を加えて、同じものをアップロードできます。
ui_config.json
ファイルには次の 3 つのセクションがあります。-
ツールバー: このセクションには、番号付きリストの挿入/削除、\(file\)閉じる、保存、コメントなど、エディターのツールバーで使用できるすべての機能の定義が含まれます。
-
ショートカット: このセクションでは、エディタの特定の機能に割り当てられたキーボード ショートカットの定義について説明します。
-
テンプレート: このセクションには、文書で使用できる DITA エレメントの構造が事前に定義されています。 既定では、[ テンプレート ] セクションには、段落、簡易テーブル、テーブル、および本文の各要素に対するテンプレート定義が含まれています。 目的の要素に対して有効な XML 構造を追加することで、任意の要素のテンプレート定義を作成できます。 例えば、リスト内の新しい
li
要素ごとにp
要素を追加する場合は、「テンプレート」セクションの最後に次のコードを追加して、これを行うことができます。
code language-css "li": "<li><p></p></li>"
-
-
ツールバーセクションから、ユーザーに公開しない機能のエントリを削除します。
-
ui_config.json ファイルを保存し、web エディターをリロードします。
親トピック: Web エディタのカスタマイズ