関連ラベル マクロ
関連ラベル マクロを追加すると、ユーザーにサイト内の関連コンテンツをナビゲートする方法を提供できます。
このマクロは、ページに共通して含まれるラベルを検索することで機能します。現在のページで使用されているラベルを取得し、そのラベルを使用するほかのページを探し、さらに、それらのページで見つかった他のラベルを一覧表示します。
このマクロは以下の場合に適しています。
- ナレッジベース記事
- プロセスや手順に関するドキュメント
基本的に、サイト内の関連ページのマップが必要なあらゆる状況に適しています。この一覧は、時間の経過とともにページでラベルが追加または削除されると、自動的に更新されます。
スクリーンショット: ナレッジベースの関連記事にユーザーを誘導する関連ラベル マクロ。
このマクロをページに追加する
関連ラベル マクロをページに追加するには:
- エディタのツールバーで、[挿入]> [その他のマクロ] を選択します。
- [Confluence コンテンツ] カテゴリから [関連ラベル] を選択します。
- マクロで検索する特定のラベルを入力するか、空白のままにしてページのすべてのラベルを使用します。
- [挿入] をクリックします。
その後、ページを公開するとマクロの動作を確認できます。
スクリーンショット: マクロ ブラウザでの関連ラベル マクロの設定。
マクロ パラメーターを変更する
マクロ パラメーターは、マクロの動作を変えるために使用します。
マクロ パラメーターを変更するには、次の手順を実行します。
- エディタでマクロのプレースホルダーをクリックし、[編集] を選択します。
- 必要に応じてパラメーターを更新し、[挿入] を選択します。
このマクロで使用できるパラメーターの一覧は、次のとおりです。
パラメーター | 既定 | 説明 |
---|---|---|
これらのラベルだけを表示 | なし | 関連ラベルを表示するラベルを指定します。例: |
Confluence の保存形式または wiki マークアップで使用されるパラメーター名がマクロ ブラウザで使用されるラベルと異なる場合、以下の一覧に括弧付きで表示されます (example
)。
このマクロを追加するその他の方法
手入力でこのマクロを追加する
Wiki マークアップを使用してこのマクロを追加する
これは、エディタ外部 (スペースのサイドバー、ヘッダー、フッターのカスタム コンテンツなど) でマクロを追加する場合に便利です。
マクロ名: related-labels
マクロ本文: なし。
{related-labels:labels=choc,cake}