検索結果マクロ
検索結果マクロは、マクロ パラメーターで指定した検索語に基づいて Confluence サイトを検索し、wiki ページ゙に結果を表示します。
検索結果マクロの使用
ページに検索結果マクロを追加するには:
- Confluence のエディタで、[挿入] > [その他のマクロ] を選択します。
- 対象のマクロを見つけて、選択します。
オートコンプリートでマクロエントリを高速化: タイプ{とマクロ名の先頭には、提案したマクロの一覧を表示します。詳細は、こちらを参照ください。リンク、ファイル、マクロ、メンションのオートコンプリート
既存のマクロを編集する方法: マクロのプレースホルダをクリックして、[編集] を選択します。マクロのパラメータが編集可能な場合、マクロのダイアログ ウィンドウが開きます。
パラメーター
パラメーターは、マクロ出力の内容や形式を制御するために設定できるオプションです。Confluence の保存形式または wiki マークアップで使用されるパラメータ名がマクロ ブラウザで使用されるラベルと異なる場合、以下の一覧に括弧付きで表示されます (example
)。
パラメーター | 既定 | 説明 |
---|---|---|
検索語 | なし | このマクロが結果の生成に使用する検索語です。 詳細については、Confluence 検索構文 のドキュメントをご覧ください。 |
結果の最大数 | 10 | 表示される検索結果数の制限を設定します。 |
このスペース キーに制限する | すべて | スペース名を入力してスペースを検索するか、検索するスペースのキーを指定します。キーは大文字と小文字を区別します。 |
コンテンツ タイプ | すべて | コンテンツ タイプを指定します。コンテンツ タイプには次があります。page、comment、blogpost、attachment、userinfo (ユーザー プロファイルのコンテンツのみ) および spacedesc (スペース説明のコンテンツのみ)。 |
最終更新日 | すべて | 期間を週、日、時間および/あるいは分単位で指定し、その時間枠内に変更されたコンテンツを表示します。 使用できる値は次のとおりです。
例:
メモ:
|
このユーザ名だけを表示 | すべて | Confluence ユーザーのユーザー名を指定し、そのユーザーによって作成または更新されたコンテンツのみを表示します。 |
注意
権限: 検索結果マクロを含むページをユーザーが表示すると、検索結果にはユーザーが「表示」権限を持つページおよびその他のコンテンツ タイプのみが表示されます。
コードの例
次の例は、Confluence ページの基本的なマークアップを調べたり、編集したりする上級ユーザー向けに提供されています。
マクロ名: search
マクロ本文: なし。
保存形式の例
<ac:structured-macro ac:name="search">
<ac:parameter ac:name="lastModified">3w</ac:parameter>
<ac:parameter ac:name="query">choc</ac:parameter>
<ac:parameter ac:name="contributor">
<ri:user ri:userkey="1235678912345678912345678912345"/>
</ac:parameter>
<ac:parameter ac:name="maxLimit">10</ac:parameter>
<ac:parameter ac:name="type">page</ac:parameter>
<ac:parameter ac:name="spacekey">
<ri:space ri:space-key="ss"/>
</ac:parameter>
</ac:structured-macro>
Wiki マークアップの例
{search:lastModified=3w|query=choc|contributor=admin|maxLimit=10|type=page|spacekey=ds}