進行中の作業

We are adding the details for each macro in turn. They are not all here yet. See CONF-24972 - Getting issue details... STATUS .

This page is an extension of the page about the Confluence storage format. This page describes the XML used to define specific Confluence macros – those that are shipped with Confluence. For each macro, we define the macro name, parameter names, and accepted parameter values.

This information is intended for advanced users who need to interpret and edit the underlying markup for a Confluence page.

アンカー マクロ

Allows you to link to a specific part of a page.

Macro name: anchor

マクロ本体: なし。

パラメーター名必須既定パラメーターの説明と指定可能な値

default-parameter

(Unnamed in wiki markup)

はい(なし)The name of the anchor.

例: 

<ac:macro ac:name="anchor">
  <ac:default-parameter>here</ac:default-parameter>
</ac:macro>

On this page:

関連ページ

Attachments macro

Displays a list of attachments on a given page.

Macro name: attachments

マクロ本体: なし。

パラメーター名必須既定パラメーターの説明と指定可能な値
oldいいえfalse

利用可能な値:

  • false - Displays only the latest version of each attachment.
  • true – Displays all versions of each attachment, including the old versions.
patternsいいえ(なし)

正規表現をコンマ区切りで表示した一覧。ファイル名を条件として添付ファイルをフィルターにかけるために使用します。パラメーターの値は正規表現でなければならないことに注意してください。例:

  • "jpg" のファイル拡張子を検索するには「.*jpg」を使用します (「*.jpg」ではありません )。
  • 「jpg」または「png」で終わるファイル名を検索するには、「.*jpg」、「.*png」を使用します。

Here is a tutorial on regular expressions.

sortByいいえdate

利用可能な値:

  • date
  • size
  • name
pageいいえThe page on which the macro exists.Page name, used to display attachments from another page.
sortOrderいいえ

The default sort order is determined by the sortBy type:

  • Reverse chronological for 'date'.
  • Largest to smallest for 'size'.
  • Alphabetical for 'name'.

利用可能な値:

  • ascending
  • descending
labelsいいえ(なし)A comma-separated list of labels. Confluence will show only attachments that have all the labels specified. (The match is an AND, not an OR.)
uploadいいえfalseDetermines whether the list of attachments will include options allowing users to browse for, and attach, new files.

例: 

<ac:macro ac:name="attachments">
  <ac:parameter ac:name="old">false</ac:parameter>
  <ac:parameter ac:name="patterns">.*png,.*jpg</ac:parameter>
  <ac:parameter ac:name="sortBy">name</ac:parameter>
  <ac:parameter ac:name="page">My page about chocolate</ac:parameter>
  <ac:parameter ac:name="sortOrder">descending</ac:parameter>
  <ac:parameter ac:name="labels">chocolate,cookies</ac:parameter>
  <ac:parameter ac:name="upload">false</ac:parameter>
</ac:macro>

Blog Posts macro

Lists the most recent news items in the space.

Macro name: blog-posts

マクロ本体: なし。

パラメーター名必須既定パラメーターの説明と指定可能な値
contentいいえentire

利用可能な値:

  • entire – Display the whole content of each blog post.
  • excerpts – Display a short extract from each blog post. If the post contains an Excerpt macro, the Blog Posts macro will display the content defined in the Excerpt macro. If the post does not contain an Excerpt macro, the Blog Posts macro will display the first few sentences of the post.
  • titles – Display a list of blog posts, showing titles only.
spacesいいえ@self

One or more space keys, separated by a comma or a space.

  • 特定のスペースのコンテンツを除外するには、スペース キーのすぐ前にマイナス記号 (-) を追加します。例: スペース キーを -BADSPACE と指定すると、BADSPACE に含まれないコンテンツのみを取得できます。
  • 特定のスペースのコンテンツのみを指定するには、スペース キーのすぐ前にプラス記号 (+) を追加します。例: スペース キーを +GOODSPACE と指定すると、GOODSPACE のコンテンツのみを取得できます (各コンテンツ項目は 1 つのスペースにのみ所属するため、このオプションが有効な麺は少ないことにご注意ください。1 つのスペース キーの前にプラス記号を設定してほかのスペース キーを一覧に追加した場合、追加したスペース キーは無視されます)。

特別な値:

  • @self — 現在のスペース。
  • @personal — All personal spaces.
  • @global — All site spaces.
  • @favorite — The spaces you have marked as favourite.
  • @favourite — 上記の @favorite と同様。
  • @all — Confluence サイトのすべてのスペース。
  • * — 上記の @all と同様。

個人用スペースを指定する場合、~jbloggs や ~jbloggs@example.com のように、ユーザー名の前にチルダ (~) 記号をつける必要があることにご注意ください。

authorいいえ(なし)One or more usernames, separated by commas.
timeいいえ(なし)利用可能な値:
  • m — 分
  • h — Hours
  • d — Days
  • w — 週

例:

  • time=12h – Display blog posts created in the last twelve hours.
  • time=7d  – Display blog posts created in the last seven days.
reverseいいえfalseA value of true changes the sort order.
sortいいえcreation

利用可能な値:

  • タイトル — タイトルのアルファベット順で並べ替え
  • 作成日 - コンテンツが追加された日付で並べ替え。
  • 更新日 - コンテンツが最後に更新された日付で並べ替え。

maxいいえ15The maximum number of results to be displayed.
labelいいえ(なし)

One or more label values, separated by a comma or a space.

  • To exclude content which matches a given label, put a minus sign (-) immediately in front of that label value. For example: If you specify a label value of -badpage you will get only content which is not labelled with 'badpage'.
  • 特定のラベル値を持つ結果のみを指定するには、ラベル値のすぐ前にプラス記号 (+) を追加します。例: ラベル値を +superpage,+goodpage と指定すると、少なくとも "superpage" と "goodpage" の 2 つのラベルを持つコンテンツのみを取得できます。

例: 

<ac:macro ac:name="blog-posts">
  <ac:parameter ac:name="content">titles</ac:parameter>
  <ac:parameter ac:name="spaces">@self,ds</ac:parameter>
  <ac:parameter ac:name="author">jsmith</ac:parameter>
  <ac:parameter ac:name="time">4w</ac:parameter>
  <ac:parameter ac:name="reverse">true</ac:parameter>
  <ac:parameter ac:name="sort">creation</ac:parameter>
  <ac:parameter ac:name="max">10</ac:parameter>
  <ac:parameter ac:name="label">chocolate,cookies</ac:parameter>
</ac:macro>

Change-History macro

Displays a history of updates made to a page.

Macro name: change-history

マクロ本体: なし。

Parameters: None

例: 

<ac:macro ac:name="change-history"/>

Chart macro

Displays a chart based on tabular data.

Macro name: chart

Macro body: Accepts rich text, consisting of tables that hold the chart's data.

このマクロでは、便宜上種類別の一覧にまとめられた多数のパラメーターが使用されます。

チャート タイプのパラメーター

これらのパラメーターは、表示するチャートのタイプやチャートの外観を決定します。

パラメーター必須既定説明
typeいいえpie

表示するチャートの種類。XY グラフは x 軸と y 軸の数値軸を持ちます。x の値は必要に応じて時間ベースにできます。timeSeries パラメーターをご参照ください。

利用可能な値:

  • 標準グラフ - pie, bar, line, area
  • XY プロット – xyArea, xyBar, xyLine, xyStep, xyStepArea, scatter, timeSeries
  • Other charts – gantt (beta)
orientationいいえvertical

表示の向き。area、bar、および line チャートに適用されます。

利用可能な値:

  • vertical - y 軸が垂直軸
  • horizontal - x 軸が垂直軸
3Dいいえfalse

3 次元で表示します。area、bar、および line チャートに適用されます。

stackedいいえfalse積み重ね値。area、bar チャートに適用されます。
showShapesいいえtrueline チャートに適用されます。各データの位置に図形が表示されます。
opacityいいえ
  • 3D チャートの場合 75 パーセント
  • 非積み上げの area チャートの場合 50 パーセント
  • 他のすべてのチャートは 100 パーセント
0 パーセント (透明) から 100 パーセント (不透明) までの値で、前景領域と棒部分の不透明度を決定します。

チャートの表示パラメーター

パラメーター必須既定説明
widthいいえ300ピクセル単位で示されるチャートの幅。
heightいいえ300ピクセル単位で示されるチャートの高さ。
dataDisplayいいえfalse

データ表で構成される、マクロ本文を表示するかどうかを決定します。既定では、チャートのデータ表は表示されません。

利用可能な値:

  • false - データは表示されません。
  • true または after - データがチャートのあとに表示されます。
  • before – - データがチャートの前に表示されます。
imageFormatいいえpng

チャートに使用される画像のフォーマット。

利用可能な値:

  • png
  • jpg

チャートのタイトルとラベルのパラメーター

パラメーター必須既定説明
titleいいえ(なし)チャートのタイトル。
subTitleいいえ(なし)グラフのサブタイトル。
xLabelいいえ(なし)x 軸 (項目) のラベル。
yLabelいいえ(なし)y 軸 (値) のラベル。
legendいいえfalseチャートの凡例 (キー) を表示するかどうかを決定します。

チャートのデータのパラメーター

チャートのデータは、マクロ本文で見つかった表から取得されます。これらのパラメーターは、このデータの解釈方法を制御します。既定では、数値と日付の値は、Confluence のグローバル既定言語 (ロケール) のフォーマットに従って解釈されます。変換が失敗した場合は、Confluence で定義されている他の言語で試行されます。以下のパラメータを使用すると、追加の変換オプションを指定できます。

パラメーター必須既定説明
tablesいいえすべての第 1 レベルの表マクロ本文に含まれ、チャートのデータとして使用される、表 ID または表番号 (1 で開始) をコンマ区切りの一覧にしたものを提供できます。データ表が他のテーブルに埋め込まれている場合、表を選択する必要があります。このような事例は、より複雑な書式設定が行われる (例: セクション マクロや列マクロを使用) 場合に生じます。
columnsいいえすべての列チャート データに使用される表の列ラベルや列タイトル、列番号をコンマ区切りにした一覧指定できます。これは処理されるすべての表に適用されます。列には 1 から始まる番号が付いています。列ラベルは、ヘッダー行の列のテキストです。列タイトルは、ヘッダー行の列の (html の) title 属性です。
dataOrientation いいえhorizontal

コンテンツの向きです。既定では、データ表の (水平方向の) 列が定義域および x の値を表していると解釈されます。

利用可能な値:

  • vertical  - データ表の列が系列と解釈されます。
  • horizontal – データ表の行が系列と解釈されます。
timeSeries いいえfalse

"true" の場合、XY プロットの x の値は時系列データとして扱われるため、日付形式に変換されます。

dateFormat いいえConfluence 言語で定義された日付形式For time series data, the date format allows for additional customisation of the conversion of data to date values. If a dateFormat is specified, it will be the first format used to interpret date values. Specify a format that matches the time series data. See simple date format.
timePeriod いいえday

時系列データに使用される期間。データの解釈粒度を定義します。

利用可能な値: millisecond, second, minute, hour, day, week, month, quarter, year

languageいいえ(なし)

ロケールを形成するために、country パラメータと組み合わせて使用します。これらの追加の数字と日付形式は、既定の言語に先だってデータ変換に使用されます。

Available values are the two-character ISO 639-1 alpha-2 codes.

countryいいえ(なし)Use in combination with the language parameter to form a locale. Valid values are the two-character ISO 3166 codes.
forgiveいいえtrue

マクロがデータ形式エラーを容認 (許可) するかどうかを決定します。

利用可能な値:

  • true - マクロは、既定の形式またはユーザ指定の表示形式に完全に一致しない数値および日付の値の変換を試みます。
  • false — マクロは厳密なデータ形式を適用します。データ形式エラーが生じると、グラフは作成されません。

グラフカラー パラメーター

色は、16 進数表記または HTML カラーネームを使用して指定します。

パラメーター必須既定説明
bgColor いいえ白グラフの背景色。
borderColor いいえ枠線なしグラフの周りの枠線の色。
colorsいいえ カテゴリ、セクション、系列の色をカスタマイズするために使用する色をコンマ区切りの一覧にしたもの。

チャートの軸のパラメーター

グラフの種類に応じて、縦軸、横軸をカスタマイズできます。軸の値はデータに基づいて自動的に生成されますが、これらのパラメータを 1 つ以上指定することにより上書きできます。

パラメーター必須既定説明
rangeAxisLowerBound いいえ(なし)縦軸の最小値。
rangeAxisUpperBound いいえ(なし)縦軸の最大値。
rangeAxisTickUnitいいえ(なし)縦軸の 1 目盛りの単位。
rangeAxisLabelAngleいいえ(なし)縦軸ラベルの表示角度。
domainAxisLowerBoundいいえ(なし)XY プロットにのみ適用されます。横軸の下限。日付軸の場合、この値は、dateFormat パラメータで指定された日付形式である必要があります。
domainAxisUpperBoundいいえ(なし)XY プロットにのみ適用されます。横軸の上限。日付軸の場合、この値は、dateFormat パラメータで指定された日付形式である必要があります。
domainAxisTickUnitいいえ(なし)XY プロットにのみ適用されます。横軸の 1 目盛りの単位。日付軸の場合、この値は、timePeriodパラメーターで指定された単位の数になります。timePeriod 単位は、終了文字を指定することで上書きできます：y (年)、M (月)、d (日)、h (時間)、m (分)、s (秒)、u (ミリ秒)。
domainAxisLabelAngleいいえ(なし)XY プロットにのみ適用されます。横軸ラベルの表示角度。 
categoryLabelPositionいいえ(なし)

カテゴリの軸ラベルのテキストの位置。

利用可能な値:

  • up45 - 45 度上向き
  • up90 - 90 度上向き
  • down45 - 45 度下向き
  • down90 - 90 度下向き
dateTickMarkPositionいいえ start

日付の目盛りの位置。

利用可能な値:

  • start - 目盛りをその期間の開始に表示します。
  • middle - 目盛りをその期間の中間に表示します。
  • end - 目盛りをその期間の終了に表示します。

Pie チャートのパラメーター

パラメーター必須既定説明
pieSectionLabelいいえ円グラフのセクションのキー値のみを表示円グラフのセクション ラベルの表示形式。表示形式には、特別な置換変数の文字列が使用されます。
  • %0% は円グラフ セクションのキーで置換されます。
  • %1% は円グラフ セクションの数値で置換されます。
  • %2% は円グラフ セクションのパーセント値で置換されます。

例 1: "Independent = 20" のように表示するには、次のようにします。

%0% = %1%


例 2: "Independent = (20%)" のように表示するには、次のようにします。

%0% (%2%)
pieSectionExplodeいいえ切り離しなし切り離して表示する円グラフのキーをコンマ区切りの一覧にしたもの。注意: JFreeChart バージョン 1.0.3 以降が必要です。

チャートの添付ファイルのパラメーター

These are advanced options that can be used for chart versioning, to enable automation and to improve performance. Use these options carefully! Normally, the chart image is regenerated each time the page is displayed. These options allow for the generated image to be saved as an attachment and have subsequent access to re-use the attachment. This can be useful especially when combined with the Cache plugin to improve performance. Depending on the options chosen, chart images can be versioned for historical purposes.

パラメーター必須既定説明
attachmentいいえ(なし)

名前とグラフ画像が添付ファイルとして保存される場所です。ユーザーは指定したページに添付ファイルを追加する権限を与えられていなければなりません。

このパラメータで利用可能な構文は次のとおりです。

  • ^attachmentName.png — チャートは現在のページに添付ファイルとして保存されます。
  • page name^attachmentName.png — チャートは指定したページ名に添付ファイルとして保存されます。
  • spacekey:page name^attachmentName.png — チャートは、指定されたスペースの指定されたページ名に添付ファイルとして保存されます。
attachmentVersionいいえnew

保存されたチャートのバージョン管理方法を定義します。

利用可能な値:

  • new — 新しいバージョンの添付ファイルを作成します。
  • replace — replaces all previous versions of the chart. To replace an existing attachment, the user must be authorised to remove attachments for the page specified.
  • keep — 同じ名前の既存のエクスポートが存在しない場合にのみ、新しい添付ファイルを保存します。既存の添付ファイルが変更または更新されることはありません。
attachmentCommentいいえ(なし) 保存されたチャート添付ファイルに使用されるコメント。
thumbnailいいえfalse

 true の場合、チャート画像の添付ファイルがサムネイル (小さいサイズ、拡大可能) として表示されます。

例:

Below is a simple example of a pie chart. See more examples in Storage Format Examples for Chart Macro.

<ac:macro ac:name="chart">
  <ac:parameter ac:name="title">Fish Sold</ac:parameter>
  <ac:parameter ac:name="type">pie</ac:parameter>
  <ac:rich-text-body>
    <table>
      <tbody>
        <tr>
          <th>
            <p>Fish Type</p>
          </th>
          <th>
            <p>2004</p>
          </th>
          <th>
            <p>2005</p>
          </th>
        </tr>
        <tr>
          <th>
            <p>Herring</p>
          </th>
          <td>
            <p>9,500</p>
          </td>
          <td>
            <p>8,300</p>
          </td>
        </tr>
        <tr>
          <th>
            <p>Salmon</p>
          </th>
          <td>
            <p>2,900</p>
          </td>
          <td>
            <p>4,200</p>
          </td>
        </tr>
        <tr>
          <th>
            <p>Tuna</p>
          </th>
          <td>
            <p>1,500</p>
          </td>
          <td>
            <p>1,500</p>
          </td>
        </tr>
      </tbody>
    </table>
  </ac:rich-text-body>
</ac:macro>

Cheese macro

Displays the words "I like cheese!"

Macro name: cheese

マクロ本体: なし。

Parameters: None

例: 

<ac:macro ac:name="cheese"/>

Children Display macro

Displays the children and descendants of the current page.

Macro name: children

マクロ本体: なし。

パラメーター名必須既定パラメーターの説明と指定可能な値
reverseいいえfalseReverses the sort order in the list of child pages. Use this parameter in conjunction with the sort parameter described below. A value of true will change the sort order from ascending to descending.
sortいいえManual if the pages have been manually reordered, otherwise alphabeticalby page title

Determines the sort order of the list of child pages.

利用可能な値:

  • creation – Sort by the date on which the page was created.
  • title – Sort alphabetically by page name.
  • modified – Sort by the date on which the page was last updated.
styleいいえBullet list

A heading style to be applied to the list of child pages.

Available values: h1 (heading level 1) through to h6 (heading level 6).

pageいいえThe page that contains the macro

The name of the parent page. The macro will display the children of the specified page.

To specify a page in a different space, use a space key followed by a colon. For example:
MYSPACE:My page

If the value of this parameter is a forward slash (/) the macro will list the pages at the root of the current space. In other words, the pages without parents.

excerptいいえfalseIf true, Confluence will display any excerpts that are defined on the child pages. The excerpts must be defined via an Excerpt macro.
firstいいえ(なし)The maximum number of child pages to be displayed (at the top level). For example, if the value of this parameter is 99, the macro will display the first 99 pages at the top level. It will also display their children, as determined by the depth and all parameters
depthいいえ(なし)The number of levels of child pages to display. For example, if the value is 2, the macro will display 2 levels of child pages.
allいいえfalse

If true, Confluence will display all levels of child pages. This setting will override the depth setting.

例: 

<p>
  <ac:macro ac:name="children">
    <ac:parameter ac:name="reverse">true</ac:parameter>
    <ac:parameter ac:name="sort">creation</ac:parameter>
    <ac:parameter ac:name="style">h4</ac:parameter>
    <ac:parameter ac:name="page">Home</ac:parameter>
    <ac:parameter ac:name="excerpt">true</ac:parameter>
    <ac:parameter ac:name="first">99</ac:parameter>
    <ac:parameter ac:name="depth">2</ac:parameter>
    <ac:parameter ac:name="all">true</ac:parameter>
  </ac:macro>
</p>

 

コー​ド ブロック マクロ

Displays code in your document with the appropriate syntax highlighting.

Macro name: code

Macro body: Accepts plain text.

パラメーター名必須既定パラメーターの説明と指定可能な値
titleいいえ(なし)Adds a title to the code macro box.
themeいいえConfluence

Specifies the colour scheme used for displaying your code. Many of these themes are based on the default colour schemes of popular integrated development environments (IDEs). The default theme is Confluence (also known as Default), which is typically black and coloured text on a blank background.

Available themes:

  • DJango
  • Emacs
  • FadeToGrey
  • Midnight
  • RDark
  • Eclipse
  • Confluence (same as default)
linenumbersいいえfalse

If true, a line number will be shown to the left of each line of code. Numbering is incremented by 1.

If false, no line numbers are shown.

languageいいえjava

Specifies the language (or environment) for syntax highlighting.

  • (none) — that is, no syntax highlighting
  • actionscript3
  • bash
  • csharp — that is, C#
  • coldfusion
  • cpp — that is, C++
  • css
  • delphi
  • diff
  • erlang
  • groovy
  • java
  • javafx
  • javascript
  • perl
  • php
  • powershell
  • python
  • ruby
  • scala
  • sql
  • vb — that is, Visual Basic
  • html/xml
firstlineいいえ1When linenumbers is true, this value defines the number of the first line of code.
collapseいいえfalse

If true, the code macro's content will be collapsed upon visiting or refreshing the Confluence page. Clicking the 'expand source' link allows you to view the content.

If false, the code macro's content is always displayed in full.

例:

以下の例ではすべてのパラメータと本文を表示しています。

<ac:macro ac:name="code">
  <ac:parameter ac:name="title">This is my title</ac:parameter>
  <ac:parameter ac:name="theme">FadeToGrey</ac:parameter>
  <ac:parameter ac:name="linenumbers">true</ac:parameter>
  <ac:parameter ac:name="language">html/xml</ac:parameter>
  <ac:parameter ac:name="firstline">0001</ac:parameter>
  <ac:parameter ac:name="collapse">true</ac:parameter>
  <ac:plain-text-body><![CDATA[<b>This is my code</b>]]></ac:plain-text-body>
</ac:macro>

下記の 3 例はさまざまなオプションのパラメータを使用したコードブロック マクロの例です。

説明

Markup表示結果
本文にコードブロック マクロ、オプションのパラメータなし
<ac:macro ac:name="code">
	<ac:plain-text-body><![CDATA[this is my code]]></ac:plain-text-body>
</ac:macro>
this is my code
本文にコードブロック マクロ、オプションの言語パラメータが定義されている
<ac:macro ac:name="code">
	<ac:parameter ac:name="language">html/xml</ac:parameter>
	<ac:plain-text-body><![CDATA[this is my code]]></ac:plain-text-body>
</ac:macro>
this is my code

本文にコードブロック マクロとオプションのタイトル、行数、言語パラメータが定義されている

<ac:macro ac:name="code">
	<ac:parameter ac:name="title">This is my title</ac:parameter>
	<ac:parameter ac:name="linenumbers">true</ac:parameter>
	<ac:parameter ac:name="language">html/xml</ac:parameter>
	<ac:plain-text-body><![CDATA[this is my code]]></ac:plain-text-body></ac:macro>
This is my title
this is my code

Column macro

Used with the Section macro to define columns on a page. See  Working with page layouts and columns and sections.

Macro name: column

Macro body: Accepts rich text.

パラメーター名必須既定パラメーターの説明と指定可能な値

width

いいえ100％のページ幅をセクション内の列の数で均等に分割。列幅。ピクセル (例: 400px) または有効なページ幅のパーセント値 (例: 50%) で指定します。

例: 

<ac:macro ac:name="column">
  <ac:parameter ac:name="width">100px</ac:parameter>
    <ac:rich-text-body>
      <p>This is the content of <strong>column 1</strong>.</p>
    </ac:rich-text-body>
</ac:macro>

ラベル別コンテンツ マクロ

Displays a list of content associated with specific labels.

Macro name: contentbylabel

マクロ本体: なし。

パラメーター名必須既定パラメーターの説明と指定可能な値
spacesいいえ@all

Filters the results by space. The macro will display only the pages and other content types which belong to the space(s) you specify here.

You can specify one or more space keys, separated by a comma or a space.

  • 特定のスペースのコンテンツを除外するには、スペース キーのすぐ前にマイナス記号 (-) を追加します。例: スペース キーを -BADSPACE と指定すると、BADSPACE に含まれないコンテンツのみを取得できます。
  • 特定のスペースのコンテンツのみを指定するには、スペース キーのすぐ前にプラス記号 (+) を追加します。例: スペース キーを +GOODSPACE と指定すると、GOODSPACE のコンテンツのみを取得できます (各コンテンツ項目は 1 つのスペースにのみ所属するため、このオプションが有効な麺は少ないことにご注意ください。1 つのスペース キーの前にプラス記号を設定してほかのスペース キーを一覧に追加した場合、追加したスペース キーは無視されます)。

特別な値:

  • @self — 現在のスペース。
  • @personal — All personal spaces.
  • @global — All site spaces.
  • @favorite — The spaces you have marked as favourite.
  • @favourite — 上記の @favorite と同様。
  • @all — Confluence サイトのすべてのスペース。
  • * — 上記の @all と同様。

個人用スペースを指定する場合、~jbloggs や ~jbloggs@example.com のように、ユーザー名の前にチルダ (~) 記号をつける必要があることにご注意ください。

authorいいえ(なし)

Filters the results by author. The macro will display only the pages and other content types which are written or updated by the author(s) you specify here.

You can specify one or more authors, separated by a comma.

 例: jsmith,jbrown
titleいいえ(なし)Adds a heading to the list.
showLabelsいいえtrueDetermines whether to display the matching labels in the list of results.
reverseいいえfalseUse this parameter in conjunction with the sort parameter. Set reverse=true to change the sort from ascending to descending. This parameter is ignored if the sort parameter is not specified.
sortいいえmodifiedDetermines how the results are sorted. To change the sort order from ascending to descending, use the reverse parameter described above.

If this parameter is not specified, the sort order defaults to descending order based on the last modification date.

Values:
  • タイトル — タイトルのアルファベット順で並べ替え
  • 作成日 - コンテンツが追加された日付で並べ替え。
  • 更新日 - コンテンツが最後に更新された日付で並べ替え。
maxいいえ15Determines the maximum number of results to be displayed. Note that the results are sorted first, and then the maximum parameter is applied.
excerptいいえfalseIf this parameter is set to true, the macro displays an excerpt from each page listed in the results. Note that you must define the excerpts on each of those pages, by adding the Excerpt macro to each page. If a particular page does not have an excerpt defined, then the Content by Label macro will not attempt to show an excerpt for that page. The Content by Label macro will show only the first few lines of the excerpt for each page.
labelsはい(なし)Use this parameter to filter the results by label. The macro will display only the pages and other content types which are tagged with the label(s) you specify here. See also the operator parameter.

You can specify one or more label values, separated by a comma or a space.
  • To exclude content which matches a given label, put a minus sign (-) immediately in front of that label value. For example: If you specify a label value of -badpage you will get only content which is not labelled with 'badpage'.
  • 特定のラベル値を持つ結果のみを指定するには、ラベル値のすぐ前にプラス記号 (+) を追加します。例: ラベル値を +superpage,+goodpage と指定すると、少なくとも "superpage" と "goodpage" の 2 つのラベルを持つコンテンツのみを取得できます。
showSpaceいいえtrueDetermines whether to display the spaces in the list of results.
typeいいえすべてFilters the restults by content type. The macro will display only the content of the type you specify here.

You can specify one or more types, separated by a comma or a space.

特定のコンテンツ タイプのコンテンツを除外するには、そのコンテンツ タイプのすぐ前にマイナス記号 (-) を追加します。例: コンテンツ タイプを -blogpost と指定すると、ページと、ブログ投稿を除くその他すべてのコンテンツを取得できます。

利用可能な値:

  • page — ages.
  • blogpost or news — blog posts, also known as news items.
  • attachment – attachments.
operatorいいえORThe operator to apply to the supplied lists of labels. By default, a page with any of the non-prefixed labels (that is, labels without a plus (+) or minus (-) sign immediately preceding it) will be listed. If you specify a value of AND, only pages with all of the supplied non-prefixed labels will be listed.

Note that this parameter only modifies the behaviour of the 'Label(s)' parameter and only affects label values without a plus (+) or minus (-) sign prefix. To avoid confusion or unexpected results, we recommend that you do not use the operator parameter in conjunction with any label values prefixed with '+' or '-' signs.

例: 

<ac:macro ac:name="contentbylabel">
    <ac:parameter ac:name="spaces">@personal,@self</ac:parameter>
    <ac:parameter ac:name="author">admin,smaddox</ac:parameter>
    <ac:parameter ac:name="title">My labelled pages</ac:parameter>
    <ac:parameter ac:name="showLabels">false</ac:parameter>
    <ac:parameter ac:name="reverse">true</ac:parameter>
    <ac:parameter ac:name="sort">creation</ac:parameter>
    <ac:parameter ac:name="max">10</ac:parameter>
    <ac:parameter ac:name="excerpt">true</ac:parameter>
    <ac:parameter ac:name="labels">chocolate,cake</ac:parameter>
    <ac:parameter ac:name="showSpace">false</ac:parameter>
    <ac:parameter ac:name="type">page</ac:parameter>
    <ac:parameter ac:name="operator">AND</ac:parameter>
  </ac:macro>

Content by User macro

Displays a list of the content items that have been created by a specified Confluence user.

Macro name: content-by-user

マクロ本体: なし。

パラメーター名必須既定パラメーターの説明と指定可能な値

default-parameter

(Unnamed in wiki markup)

はい(なし)The Confluence username for the person whose content you wish to display

例: 

<ac:macro ac:name="content-by-user">
   <ac:default-parameter>jsmith</ac:default-parameter>
</ac:macro>

コンテンツ レポートテーブル マクロ

Displays a set of pages and blog posts in tabular format, based on the labels specifed in the macro parameters.

Macro name: content-report-table

マクロ本体: なし。

パラメーター名必須既定パラメーターの説明と指定可能な値
spacesいいえ(なし)This parameter is required. Specify one or more labels, separated by a comma. The macro will display only the content tagged with the label(s) specified here.
labelsはい(なし)カンマまたはスペースで区切った 1 つ以上のスペース キーを指定します。マクロはここで指定したスペース (複数可) に属するコンテンツのみを表示します。

個人用スペースを指定する場合、~jbloggs や ~jbloggs@example.com のように、ユーザー名の前にチルダ (~) 記号をつける必要があります。

例: 

<ac:macro ac:name="content-report-table">
  <ac:parameter ac:name="spaces">DOC</ac:parameter>
  <ac:parameter ac:name="labels">LDAP</ac:parameter>
  <ac:parameter ac:name="analytics-key">meeting-notes</ac:parameter>
</ac:macro>

Contributors macro

Displays a list of Confluence users who have made a contribution of some type to a page.

Macro name: contributors

マクロ本体: なし。

パラメーター名

必須

既定

パラメーターの説明と指定可能な値

limit

 いいえ

(なし)

Limits the number of contributors displayed in the list.

spaces

 いいえ

現在のスペース

Specifies the space key of the Confluence space to search. Space keys are case sensitive.

Special values:

  • @global — All site spaces.
  • @personal — All personal spaces.
  • @all — All spaces in the Confluence site.

You can specify one or more space keys or special values, separated by commas.

If no page and labels are specified, all pages from the specified set of spaces are included.

reverse

いいえ

false

Reverses the order of contributors in the list. Must be used in conjunction with the order parameter.

scope
 いいえ

The specified page only

Specifies additional pages to include when generating the list of contributors.

利用可能な値:

  • children – only the child pages of the specified page.
  • descendants – all descendants of the specified page.

labels

 いいえ

(なし)

Limits the list of contributors to those who created the specified labels on a page. You can specify one or more labels, separated by commas.

showPages いいえ

false

If the value is true, the macro will display a list of the pages used to generate the list of contributors.

noneFoundMessage いいえ

"No contributors found for:" (and a summary of selected parameter values)

Any message given here will override the default message that is displayed when no contributors are found.

showCount

 いいえ

false

Determines whether the macro will show the number of times each person made a contribution.

contentType
 いいえ

Both pages and blog posts

Restricts the content type that the macro will use when generating the list of contributors.

利用可能な値:

  • pages – pages

  • blogposts – blog posts.

include
いいえ

authors

ページ (およびオプションでその子孫ページ) で行われた投稿のタイプ、またはページのウォッチによる絞り込み。投稿者タイプは次のものになります。

  • authors - ページを作成または編集したユーザーを含む
  • comments - ページにコメントしたユーザーを含む
  • labels - ページにラベルを追加したユーザーを含む
  • watches - includes people who are watching the page(s).

You can specify one or more contribution types, separated by commas.

mode
 いいえ
inline

Determines how the list of contributors is formatted:

  • inline — a comma-separated list
  • list — a bullet list.
showAnonymous
 いいえ
false

Determines whether to include those who contributed anonymously to a page.

order
いいえ
count

投稿者の並べ替えに使用される基準を指定します。並べ替え基準には次のものがあります。

  • count – sorts the names based on the total number of contributions to the page(s)
  • name – sorts the names into alphabetical order
  • update – sorts the names by the date of their last contribution to the page(s).
ページ
いいえ

The current page

Specifies the page to use when generating the list of contributors. If page and spaces are left blank, the current page is assumed.

showLastTime
いいえ
false

Determines whether to show the last time each person made a contribution.

publishDate
いいえ

(None)e

Specifies the publication date for a blog post. The date format required is: YYYY/MM/DD.

例:

この例では、ブログ投稿のコンテンツ タイプを指定しています。

<ac:macro ac:name="contributors">
    <ac:parameter ac:name="limit">10</ac:parameter>
    <ac:parameter ac:name="spaces">ds,@personal</ac:parameter>
    <ac:parameter ac:name="reverse">true</ac:parameter>
    <ac:parameter ac:name="labels">chocolate,cake</ac:parameter>
    <ac:parameter ac:name="showPages">true</ac:parameter>
    <ac:parameter ac:name="noneFoundMessage">Oh dear, no contributors found</ac:parameter>
    <ac:parameter ac:name="showCount">true</ac:parameter>
    <ac:parameter ac:name="contentType">blogposts</ac:parameter>
    <ac:parameter ac:name="include">authors,comments,labels,watches</ac:parameter>
    <ac:parameter ac:name="mode">list</ac:parameter>
    <ac:parameter ac:name="showAnonymous">true</ac:parameter>
    <ac:parameter ac:name="order">update</ac:parameter>
    <ac:parameter ac:name="showLastTime">true</ac:parameter>
    <ac:parameter ac:name="publishDate">2012/06/30</ac:parameter>
  </ac:macro>

この例では、ページ コンテンツ タイプを指定しています。

<ac:macro ac:name="contributors">
    <ac:parameter ac:name="limit">10</ac:parameter>
    <ac:parameter ac:name="spaces">ds,@personal</ac:parameter>
    <ac:parameter ac:name="reverse">true</ac:parameter>
    <ac:parameter ac:name="scope">descendants</ac:parameter>
    <ac:parameter ac:name="labels">chocolate,cake</ac:parameter>
    <ac:parameter ac:name="showPages">true</ac:parameter>
    <ac:parameter ac:name="noneFoundMessage">Oh dear, no contributors found</ac:parameter>
    <ac:parameter ac:name="showCount">true</ac:parameter>
    <ac:parameter ac:name="contentType">pages</ac:parameter>
    <ac:parameter ac:name="include">authors,comments,labels,watches</ac:parameter>
    <ac:parameter ac:name="mode">list</ac:parameter>
    <ac:parameter ac:name="showAnonymous">true</ac:parameter>
    <ac:parameter ac:name="order">update</ac:parameter>
    <ac:parameter ac:name="page">ds:Advanced Topics</ac:parameter>
    <ac:parameter ac:name="showLastTime">true</ac:parameter>
  </ac:macro>

Contributors Summary macro

Displays a table of contribution-based statistics for a set of pages.

Macro name: contributors-summary

マクロ本体: なし。

パラメーター名

必須

既定

パラメーターの説明と指定可能な値

limit

 いいえ

(なし)

Limits the number of contributors or pages displayed in the table.

spaces

 いいえ

現在のスペース

Specifies the space key of the Confluence space to search. Space keys are case sensitive.

Special values:

  • @global — All site spaces.
  • @personal — All personal spaces.
  • @all — All spaces in the Confluence site.

You can specify one or more space keys or special values, separated by commas.

If no page and labels are specified, all pages from the specified set of spaces are included.

reverse

いいえ

false

Reverses the order of items in the table. Must be used in conjunction with the order parameter.

showAnonymous
 いいえ
false

Determines whether to include those who contributed anonymously to a page.

scope
 いいえ

The specified page only

Specifies additional pages to include when generating the list of contributors.

利用可能な値:

  • children – only the child pages of the specified page.
  • descendants – all descendants of the specified page.
order
いいえ
edits

Sets the criterion used for sorting items in the table.

利用可能な値:

  • edits – sorts items in the table based on the total number of edits made, either by a contributor or to a page.
  • name – sorts items in the table in alphabetical order, either by contributor or page name.
  • editTime – sorts items in the table based on when the contributor last edited a page (or a specified set of pages) or when the page was lasted edited.
  • update – sorts items in the table based on when the contributor last made any contribution to a page (or a specified set of pages) or when the page last had any contribution made to it.
ページ
いいえ

The current page

A page title. Specifies the page to use when generating the list of contributors. If page and spaces are left blank, the current page is assumed.

labels

 いいえ

(なし)

Limits contribution-based statistics to the specified labels only. You can specify one or more labels, separated by commas.

列
いいえ

edits,comments,labels

Determines the columns that should appear in the table. The statistics or type of information presented depends on the groupby parameter.

利用可能な値:

  • edits – the number of times each contributor has edited the page(s) or the number of edits made to each page.
  • edited – a list of the pages edited by each contributor or a list of contributors who have edited each page.
  • comments – the number of times each contributor has added comments to the page(s) or the number of comments on each page.
  • commented – a list of pages to which each contributor has added comments or a list of contributors who have commented on each page.
  • labels – the number of times each contributor has added labels to the page(s) or the number of labels on each page.
  • labeled – a list of pages to which each contributor has added labels or a list of contributors who have added a label to each page.
  • labellist – a list of labels either added by each contributor or on each page.
  • watches – the number of pages being watched by each contributor/person or the number of contributors/people watching each page.
  • watching – a list of pages being watched by each contributor/person or a list of contributors/people watching each page.
  • lastupdate – the last time each contributor made an update or when each page was last updated. Valid updates can include edits, comments or label modifications to a page.

You can specify one or more columns, separated by commas.

groupby
いいえcontributors

投稿者ベース統計をグループ化する基準を指定します：

  • contributors – group by the people who have contributed.
  • pages – group by the pages used to find the contributors.
contentType
 いいえ

Both pages and blog posts

Restricts the content type that the macro will use when generating the list of contributors.

利用可能な値:

  • pages – pages

  • blogposts – blog posts.

showZeroCountsいいえfalseDetermines whether contributors or pages are included for which the calculated statistic is zero.
publishDate
いいえ

(なし)

Specifies the publication date for a blog post. The date format required is: YYYY/MM/DD.

例:

この例では、ブログ投稿のコンテンツ タイプを指定しています。

<ac:macro ac:name="contributors-summary">
    <ac:parameter ac:name="limit">10</ac:parameter>
    <ac:parameter ac:name="spaces">ds,@personal</ac:parameter>
    <ac:parameter ac:name="reverse">true</ac:parameter>
    <ac:parameter ac:name="showAnonymous">true</ac:parameter>
    <ac:parameter ac:name="order">update</ac:parameter>
    <ac:parameter ac:name="labels">chocolate,cake</ac:parameter>
    <ac:parameter ac:name="columns">edits,comments,labels,lastupdate</ac:parameter>
    <ac:parameter ac:name="groupby">pages</ac:parameter>
    <ac:parameter ac:name="contentType">blogposts</ac:parameter>
    <ac:parameter ac:name="showZeroCounts">true</ac:parameter>
    <ac:parameter ac:name="publishDate">2012/06/07</ac:parameter>
</ac:macro>

この例では、ページ コンテンツ タイプを指定しています。

<ac:macro ac:name="contributors-summary">
    <ac:parameter ac:name="limit">10</ac:parameter>
    <ac:parameter ac:name="spaces">ds,@personal</ac:parameter>
    <ac:parameter ac:name="reverse">true</ac:parameter>
    <ac:parameter ac:name="showAnonymous">true</ac:parameter>
    <ac:parameter ac:name="scope">descendants</ac:parameter>
    <ac:parameter ac:name="order">update</ac:parameter>
    <ac:parameter ac:name="page">ds:Advanced Topics</ac:parameter>
    <ac:parameter ac:name="labels">chocolate,cake</ac:parameter>
    <ac:parameter ac:name="columns">edits,comments,labels,lastupdate</ac:parameter>
    <ac:parameter ac:name="groupby">pages</ac:parameter>
    <ac:parameter ac:name="contentType">pages</ac:parameter>
    <ac:parameter ac:name="showZeroCounts">true</ac:parameter>
</ac:macro>

テンプレートから作成マクロ

Creates a page from a given template.

Macro name: create-from-template

マクロ本体: なし。

パラメーター名必須既定パラメーターの説明と指定可能な値

templateId

ユーザーが作成したテンプレートに必須(なし)The ID of a user-created template. This is the unique identifier that Confluence assigns when you create a template. For example, 299630593. To find the ID of a template, edit the template and look at the URL in your browser. The template ID is given in the URL parameter named entityId.
blueprintModuleCompleteKeyブループリントに必須(なし)The qualified name of the add-on that defines the blueprint (for example, com.atlassian.confluence.plugins.confluence-shared-files-plugin:file-list-blueprint).

templateName

はい(なし)The ID of a user-created template (for example, 299630593) or the qualified name of the add-on that defines the blueprint (for example, com.atlassian.confluence.plugins.confluence-shared-files-plugin:file-list-blueprint).
buttonLabelはい'Create from Template'ページ上で表示されるマクロの説明。
spaceKeyはい現在のページが作成されているスペースマクロを使用してページを作成する際に新規ページが作成される場所を特定するための、一意のスペース識別子（スペース キー）。

例:

この例では、ユーザーが作成したテンプレートを指定しています。

<ac:macro ac:name="create-from-template">
  <ac:parameter ac:name="templateId">299630593</ac:parameter>
  <ac:parameter ac:name="buttonLabel">Blitz test</ac:parameter>
  <ac:parameter ac:name="spaceKey">DOCTHEME</ac:parameter>
  <ac:parameter ac:name="templateName">299630593</ac:parameter>
</ac:macro>

 

この例ではブループリントを使用しています。

<ac:macro ac:name="create-from-template">
  <ac:parameter ac:name="blueprintModuleCompleteKey">com.atlassian.confluence.plugins.confluence-shared-files-plugin:file-list-blueprint</ac:parameter>
  <ac:parameter ac:name="buttonLabel">Shared files</ac:parameter>
  <ac:parameter ac:name="spaceKey">DOCTHEME</ac:parameter>
  <ac:parameter ac:name="templateName">com.atlassian.confluence.plugins.confluence-shared-files-plugin:file-list-blueprint</ac:parameter>
</ac:macro>

Create Space Button macro

Displays a create space button linked to the create space page.

Macro name: create-space-button

マクロ本体: なし。

パラメーター名必須既定パラメーターの説明と指定可能な値
sizeいいえlarge

Determines the size of the 'create space' icon displayed. Available values:

  • large
  • small
widthいいえ

自然なサイズのアイコン

（1:1 ピクセル比）

表示されるアイコン幅をピクセルで指定。Confluence は、アイコン幅を指定したピクセル数に伸縮します。

注意：このパラメータはマクロ ブラウザからは使用できません。

heightいいえ

自然なサイズのアイコン

（1:1 ピクセル比）

表示されるアイコンの高さをピクセルで指定。Confluence は、アイコンの高さを指定したピクセル数に伸縮します。

注意：このパラメータはマクロ ブラウザからは使用できません。

例: 

<ac:macro ac:name="create-space-button">
    <ac:parameter ac:name="size">small</ac:parameter>
  </ac:macro>

Excerpt Include macro

Allows you to display an excerpt from another page within the current page.

Macro name: excerpt-include

マクロ本体: なし。

パラメーター名必須既定パラメーターの説明と指定可能な値

default-parameter

(Unnamed in wiki markup)

はい(なし)

The name of the page that contains the excerpt to be displayed.

To include an excerpt from a page in another space, type the space key followed by a colon (:) and the page name, like this:

SPACEKEY:My page name

Note: The ability to include excerpts from other spaces is available only in Confluence 4.3.2 and later. In earlier versions of Confluence, the Excerpt Include macro does not work across spaces. Use the Include Page macro instead.

nopanelいいえFalseDetermines whether Confluence will display a panal around the excerpted content. The panel includes the title of the page containing the excerpt, and the border of the panel. By default, the panel and title are shown.

例: 

<ac:macro ac:name="excerpt-include">
  <ac:parameter ac:name="nopanel">true</ac:parameter>
  <ac:default-parameter>My page name</ac:default-parameter>
</ac:macro>

抜粋マクロ

ページの一部を「抜粋」として定義し、他のページで表示されるようにします。

Macro name: excerpt

Macro body: Accepts rich text.

パラメーター名必須既定パラメーターの説明と指定可能な値
hiddenいいえFalse

Determines whether the content of the Excerpt macro body is displayed on the page that contains the Excerpt macro.

このオプションは抜粋マクロを含むページにのみ影響します。コンテンツを再利用したページには影響しません。

atlassian-macro-output-typeいいえBLOCK

抜粋マクロ本体に含まれるコンテンツを新たに行を追加して表示するか、インラインで表示するか決定します。

利用可能な値:

  • BLOCK – マクロのコンテンツを新しい行で表示します。
  • INLINE – マクロのコンテンツを前後のテキストと同じ段落の一部として表示します。

このオプションは抜粋マクロを含むページにのみ影響します。コンテンツを再利用したページには影響しません。

例: 

<ac:macro ac:name="excerpt">
  <ac:parameter ac:name="hidden">true</ac:parameter>
  <ac:parameter ac:name="atlassian-macro-output-type">BLOCK</ac:parameter>
  <ac:rich-text-body>
    <p>This is the <strong>text</strong> I want to reuse in other pages. This text is inside an Excerpt macro.</p>
  </ac:rich-text-body>
</ac:macro>

Expand macro

Displays an expandable/collapsible section of text.

Macro name: expand

Macro body: Accepts rich text.

パラメーター名必須既定パラメーターの説明と指定可能な値

default-parameter

(Unnamed in wiki markup)

いいえClick here to expand...Text that will be displayed on the line that people can click to expand the hidden text.

例: 

<ac:macro ac:name="expand">
<ac:default-parameter>This is my message</ac:default-parameter>
<ac:rich-text-body>
  <p>This text is <em>hidden</em> until you expand it.</p>
</ac:rich-text-body>
</ac:macro>

Favourite Pages macro

Displays a list of your favourite pages.

Macro name: favpages

マクロ本体: なし。

Parameters: None.

例: 

<ac:macro ac:name="favpages"/>

ガジェットマクロ

Allows you to add Confluence gadgets to pages or blog posts.

Macro name: gadget

マクロ本体: なし。

パラメーター名必須既定パラメーターの説明と指定可能な値

width

いいえ450 pixelsThe width of the gadget, using one of the following conventions:
  • Width in pixesl, using px or plain numbers. For example, 500px or 500
  • %. を使用してページ幅のパーセント値を指定。例: 50%
  • ページ幅の 100% に合わせてガジェットのサイズを自動的に調整: auto
borderいいえtrueDetermines whether Confluence will draw a border around the gadget.
urlはい(none.)ガジェット仕様が設定されている場所（XML ファイル）。
preferencesいいえ(Gadget-dependent.)各ガジェット固有の、特定のプロパティ設定。

マークアップでのガジェットプロパティ（設定）を編集する際の注意：プロパティの値は Wiki マークアップや保存形式で直接編集することが可能ですが、無効な値しか入力できません。ガジェットプロパティが値をサポートしている場合、マクロブラウザはユーザーにプロパティに有効な値を選択させるよう制限します。そのため、ガジェットプロパティの編集には、マクロブラウザを使用することをおすすめします。

例:

これは Confluence ページ ガジェットの例です。

<ac:macro ac:name="gadget">
  <ac:parameter ac:name="width">500</ac:parameter>
  <ac:parameter ac:name="border">false</ac:parameter>
  <ac:parameter ac:name="url">rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:confluence-page-gadget/gadgets/confluence-page-gadget.xml</ac:parameter>
  <ac:parameter ac:name="preferences">spaceName=Documentation&amp;spaceKey=DOC&amp;quickfind-space=Documentation&amp;pageId=753666&amp;pageName=Documentation%20Home&amp;quickfind-page=Documentation%20Home&amp;isEditable=true&amp;isConfigured=true&amp;refresh=15&amp;showLink=false</ac:parameter>
</ac:macro>

これは Confluence ニュース ガジェットの例です。

<ac:macro ac:name="gadget">
  <ac:parameter ac:name="url">rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:confluence-news-gadget/gadgets/confluence-news-gadget.xml</ac:parameter>
  <ac:parameter ac:name="preferences"/>
</ac:macro> 

ギャラリー マクロ

Forms a thumbnail gallery of all images attached to a page.

Macro name: gallery

マクロ本体: なし。

パラメーター名

必須

既定

パラメーターの説明と指定可能な値

title
いいえ

(なし)

Specify a title to be displayed above your gallery of pictures.

リバース
いいえ

Not specified. Sort order is ascending.

Used in combination with the sort parameter, to change the sort order from ascending to descending.

利用可能な値:

  • true – 降順で並べ替え。
  • false – 降順で並べ替え。
並べ替え
 いいえ

なし。並べ替え順が指定されていないため、順不同。

Specify an attribute to sort the images by. Sort order is ascending, unless you specify the reverse parameter.

利用可能な値:

  • name – file name.
  • comment – comment linked to the attached file.
  • date – date/time last modified.
  • size – size of the attached file.
ページ
 いいえ

ページが指定されていない場合、ギャラリー マクロはマクロが使用されているページに添付された画像を表示します。

表示する画像を含むページのタイトルを指定します。複数のページ名をカンマ区切りで指定できます。異なるスペースのページを指定するには、以下の構文を使用します: SPACEKEY:Page title.
includeLabel いいえなし。画像はラベルでフィルタリングされません。The gallery will include only those pictures that have the specified label. If you wish to enter more than one label, separate the labels with commas. Confluence will show only images that have all the labels specified. (The match is an AND, not an OR.) For information on labelling the attachments, see Adding Labels.
excludeLabel いいえ

No exclusions. The gallery will include all the pictures on the page.

The gallery will ignore any pictures that have the specified label. You can specify more than one label, separated by commas. For information on labelling the attachments, see Adding Labels.
列
いいえ

4

Specify the number of columns for the table that forms the gallery.

exclude

いいえ

除外なし。ページのすべての写真を含める。

Specify images by file name. The gallery will ignore any images specified. You can specify more than one image, separated by commas.
Note: The file name and file type for this parameter are case sensitive. For example, 'my picture.PNG' will not be recognised as 'my picture.png'.

include

いいえ

ページのすべての写真を含める

If you specifically include one or more pictures, the gallery will show only those pictures. You can specify more than one picture, separated by commas.
Note: The file name and file type for this parameter are case-sensitive. For example, 'my picture.PNG' will not be recognised as 'my picture.png'.

例: 

<ac:macro ac:name="gallery">
    <ac:parameter ac:name="title">My holiday pictures</ac:parameter>
    <ac:parameter ac:name="reverse">true</ac:parameter>
    <ac:parameter ac:name="sort">size</ac:parameter>
    <ac:parameter ac:name="page">My page1, ds:Welcome to Confluence</ac:parameter>
    <ac:parameter ac:name="excludeLabel">badlabel1, badlabel2</ac:parameter>
    <ac:parameter ac:name="columns">3</ac:parameter>
    <ac:parameter ac:name="exclude">badpicture.png</ac:parameter>
  </ac:macro>

Global Reports macro

Displays a list of links to global reports within a table.

Macro name: global-reports

マクロ本体: なし。

パラメーター名

必須

既定

パラメーターの説明と指定可能な値

width
いいえ

99%

リンクを表示する表の幅を、ウィンドウ幅のパーセンテージで指定します。

例: 

<ac:macro ac:name="global-reports">
  <ac:parameter ac:name="width">50%</ac:parameter>
</ac:macro>

HTML Include macro

Includes the content of an external HTML file into a Confluence page.

Macro name: html-include

マクロ本体: なし。

パラメーター名

必須

既定

パラメーターの説明と指定可能な値

URL
はい

(なし)

Specify a URL of the content to be included into your Confluence page.

例: 

<ac:macro ac:name="html-include">
  <ac:parameter ac:name="url">http://www.example.com</ac:parameter>
</ac:macro>

HTMLマクロ

Renders your specified HTML code within the current page.

Macro name: html

Macro body: Text, consisting of HTML code.

Parameters: None.

例: 

<ac:macro ac:name="html">
  <ac:plain-text-body><![CDATA[<a href="http://www.atlassian.com">Click here</a> to see the <b>Atlassian</b> website.]]></ac:plain-text-body>
</ac:macro>

IM プレゼンス マクロ

Displays graphically when a contact is online.

Macro name: im

マクロ本体: なし。

パラメーター名

必須

既定

パラメーターの説明と指定可能な値

showid
いいえ

true

Determines whether the macro shows or hides the user ID of the contact.

利用可能な値:

  • true – User ID is shown on the page.
  • false – User ID is not shown on the page.
サービス
はい

Not specified.

The web service that Confluence should query.

利用可能な値:

default-parameter

(Unnamed in wiki markup)

はいNot specified.User ID. Identifies the IM contact by their ID, account name or screen name.

例: 

<ac:macro ac:name="im">
  <ac:parameter ac:name="showid">false</ac:parameter>
  <ac:parameter ac:name="service">skype</ac:parameter>
  <ac:default-parameter>MySkypeName</ac:default-parameter>
</ac:macro>

インクルード ページ マクロ

Inserts the contents of the specified page into the current one.

Macro name: include

マクロ本体: なし。

パラメーター名必須既定パラメーターの説明と指定可能な値

default-parameter

(Unnamed in wiki markup)

はい(なし)

The name of the page whose content should be included on the current page

To includecontent from a page in another space, type the space key followed by a colon (:) and the page name, like this:

SPACEKEY:My page name

To include a blog post, specify the date as well as the title of the blog post. For example: /2010/12/01/My blog post.

You can include pages from personal spaces using ~username as the space key, where 'username' is the person's username. For example, ~jsmith:My page name.

例: 

<ac:macro ac:name="include">
    <ac:default-parameter>DOC:My chocolate page</ac:default-parameter>
  </ac:macro>

Info macro

Displays a block of text in a blue highlight box.

Macro name: info

Macro body: Accepts rich text.

パラメーター名必須既定パラメーターの説明と指定可能な値
iconいいえtrueDetermines whether to display the (info) icon in the title bar of the information box.
titleいいえ(なし)The title of the information box. If specified, the title text will be displayed in bold next to the icon.

例:

以下の例ではすべてのパラメータと本文を表示しています。

<ac:macro ac:name="info">
<ac:parameter ac:name="icon">false</ac:parameter>
<ac:parameter ac:name="title">This is my title</ac:parameter>
<ac:rich-text-body>
  <p>
    <span>This is </span>
    <em>important</em>
    <span> information.</span>
  </p>
</ac:rich-text-body>
</ac:macro>

下記の例はさまざまなオプションのパラメーターを使用した情報マクロの例です。

説明

Markup表示結果

定義済み本文ありおよびオプション パラメーターなしの情報マクロ

<ac:macro ac:name="info">
	<ac:rich-text-body><p>This is <em>important</em> information.</p></ac:rich-text-body></ac:macro>

 これは重要な情報です。

定義済みの本文およびオプションタイトルパラメーターありの情報マクロ

<ac:macro ac:name="info">
	<ac:parameter ac:name="title">This is my title</ac:parameter>
	<ac:rich-text-body><p>This is <em>important</em> information.</p></ac:rich-text-body>
</ac:macro>

This is my title

 これは重要な情報です。

定義済みの本文とオプションタイトルおよびアイコンパラメーターありの情報マクロ

<ac:macro ac:name="info">
  <ac:parameter ac:name="icon">false</ac:parameter>
  <ac:parameter ac:name="title">This is my title</ac:parameter>
  <ac:rich-text-body>
    <p>
      <span>This is </span>
      <em>important</em>
      <span> information.</span>
    </p>
  </ac:rich-text-body>
</ac:macro>

This is my title

 これは重要な情報です。

JIRA Issues macro

Displays a list of JIRA issues in a page.

Macro name: jiraissues

マクロ本体: なし。

パラメーター名

必須

既定

パラメーターの説明と指定可能な値

anonymous

いいえ

false

If this parameter is set to 'true', JIRA will return only the issues which allow unrestricted viewing i.e. the issues which are visible to anonymous viewers, as determined by JIRA's viewing restrictions. If this parameter is omitted or set to 'false', then the results depend on how your administrator has configured the communication between JIRA and Confluence. By default, Confluence will show only the JIRA issues which the user is authorised to view. See more details below.

baseurl

いいえ

'url' パラメーターの値

If you specify a 'baseurl', then the link in the header, pointing to your JIRA site, will use this base URL instead of the value of the 'url' parameter. This is useful when Confluence connects to JIRA with a different URL from the one used by other users.

columns

いいえ

既定では、次の列が表示されます。

  • type
  • 鍵 (キー)
  • 要約
  • 担当者
  • reporter
  • 優先度
  • ステータス
  • resolution
  • created
  • updated
  • due

A list of JIRA column names, separated by semi-colons (;). Example columns are: key, summary, type, created, fixversion, updated, due, assignee, reporter, priority, status and resolution. You can include any columns recognised by your JIRA site, including custom columns. See the JIRA documentation for a list of names.

count

いいえ

false

このパラメーターが 'true' に設定されている場合、課題リストには JIRA 課題の数が表示されます。カウントは JIRA サイトにリンクされます。

cache

いいえ

on

マクロは、JIRA クエリの結果の課題のキャッシュを保持します。'cache' パラメーターが 'off' に設定されている場合、キャッシュの関連部分は、マクロが再度ロードされるたびにクリアされます。(値 'false' も使用でき、 と同じ効果があります。)

height

いいえ

480

The height in pixels of the table displaying the JIRA issues.
Note that this height specification is ignored in the following situations:

  • If you set the 'renderMode' parameter (see below) to 'static'.
  • When the JIRA issues are displayed in a PDF or Word document, in an email message or in an RSS feed.

renderMode

いいえ

In formats not mentioned below, the default is 'dynamic'.
The default is 'static' when the JIRA issues are displayed in a PDF or Word document, in an email message or in an RSS feed.

By default, the JIRA Issues macro offers a dynamic display with the following features:

  • 列ヘッダーをクリックして出力を並べ替えます。
  • 列をドラッグし、別の順序にドロップします。
  • ディスプレイから列を一時的に削除します。
  • View a page of issues at a time, for faster response times.
    Set the 'renderMode' parameter to 'static' if you want to disable the dynamic display features.

title

いいえ

JIRA 課題

You can customise the title text at the top of the JIRA issues table with this parameter. For instance, setting the title to 'Bugs-to-fix' will replace the default 'JIRA Issues' text. This can help provide more context to the list of issues displayed.

url

はい

なし

The URL of the XML view of your selected issues in JIRA Issue Navigator.
Note: If the URL in the 'url' parameter does not contain a tempMax argument, then the value of tempMax will default to 500. If your JIRA server is version 3.12 or earlier, this means that the JIRA Issues macro will return a maximum of 500 issues. If your JIRA server is version 3.13 or later, a value of 500 means that the JIRA Issues macro will return a maximum of 500 issues per page.

width

いいえ

100%

The width of the table displaying the JIRA issues. Can be indicated either as a percentage (%) or in pixels (px).

例: 

<ac:macro ac:name="jiraissues">
    <ac:parameter ac:name="anonymous">true</ac:parameter>
    <ac:parameter ac:name="columns">type;key;summary</ac:parameter>
    <ac:parameter ac:name="url">http://jira.atlassian.com/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?jqlQuery=project+%3D+CONF+AND+%28summary+%7E+jiraissues+OR+description+%7E+jiraissues+OR+comment+%7E+jiraissues%29&amp;tempMax=10</ac:parameter>
  </ac:macro>

JUnit レポート マクロ

Display a summary of JUnit test results.

Macro name: junitreport

マクロ本体: なし。

パラメーター名

必須

既定

パラメーターの説明と指定可能な値

directory

Must include either the directory or the url parameter

(なし)

URL of a directory containing your test result files. This must be a directory name and not the XML file itself. Overrides the url parameter if you use both.

Note: When using a local drive, you must use a directory name and not the XML file itself.

reportdetail

いいえ

all

Level of detail required in the report.

利用可能な値:

  • all
  • fixture
  • summary
  • failuresonly

url

Must include either the directory or the url parameter

(なし)

URL of a particular test result XML file.

This parameter is overridden by the directory parameter if you use both.

For Confluence installations that require authentication, you can specify login credentials as part of this parameter, in the form of URL parameters:

  • os_username — The username of a Confluence user with permission to access the JUnit test results.
  • os_password — os_username パラメータで指定した Confluence ユーザーのパスワード。

debug

いいえ

false

If the value of this parameter is true, the report will show the content of failures, as well as the error messages.

例: 

<ac:macro ac:name="junitreport">
    <ac:parameter ac:name="reportdetail">summary</ac:parameter>
    <ac:parameter ac:name="directory">http://confluence.com/download/attachments/123/</ac:parameter>
    <ac:parameter ac:name="debug">true</ac:parameter>
    <ac:parameter ac:name="url">http://confluence.com/download/attachments/123/file.xml</ac:parameter>
  </ac:macro>

ラベル一覧マクロ

Displays a hyperlinked alphabetical index of all labels within the current space.

Macro name: listlabels

マクロ本体: なし。

パラメーター名

必須

既定

パラメーターの説明と指定可能な値

spaceKey

いいえ

現在のスペース

ラベルを表示したいスペースのキー。

例: 

<ac:macro ac:name="listlabels">
    <ac:parameter ac:name="spaceKey">DOC</ac:parameter>
</ac:macro>

ライブサーチ マクロ

Add a dynamic search box to a wiki page.

Macro name: livesearch

マクロ本体: なし。

パラメーター名

必須

既定

パラメーターの説明と指定可能な値

id

いいえ

(なし)

Uniquely identifies the Livesearch macro when there are more than one Livesearch macros in a page.

spaceKey

いいえ

すべてのスペース

Specify a space key to limit the search to the given space.

例: 

<ac:macro ac:name="livesearch">
  <ac:parameter ac:name="id">mysearch1</ac:parameter>
  <ac:parameter ac:name="spaceKey">DOC</ac:parameter>
</ac:macro>

Loremipsum macro

Display a few paragraphs of pseudo-Latin text.

Macro name: loremipsum

マクロ本体: なし。

パラメーター名

必須

既定

パラメーターの説明と指定可能な値

default-parameter

(No name in wiki markup)

いいえ

3

Number of paragraphs. Determines the amount of pseudo-Latin (space-filler) text to display. The macro will display a maximum number of 30 paragraphs.

例: 

<ac:macro ac:name="loremipsum">
    <ac:default-parameter>2</ac:default-parameter>
</ac:macro>

Multimedia macro

Displays videos, animations and more, sourced from a file attached to a Confluence page and displayed on your page.

Macro name: multimedia

マクロ本体: なし。

パラメーター名

必須

既定

パラメーターの説明と指定可能な値

page

いいえ

現在のページ

Name of the page to which the multimedia file is attached.

space

いいえ

現在のスペース

Space key of the page that has the multimedia file attached.

name

はい

なし

File name of the multimedia file, which is attached to a Confluence page.

width

いいえ

指定されていない場合、ブラウザーはファイルの種類に基づいて幅を決定します。

ページに表示されるムービー ウィンドウの幅。デフォルトでは、この値がピクセルで指定されます。また、ウィンドウの幅のパーセンテージや、HTML で使用可能なその他の値を指定するよう選択することもできます。

height

いいえ

指定されていない場合、ブラウザーはファイルの種類に基づいて高さを決定します。

ページに表示されるムービー ウィンドウの高さ。デフォルトでは、この値がピクセルで指定されます。また、ウィンドウの高さのパーセンテージや、HTML で使用可能なその他の値を指定するよう選択することもできます。

autostart

いいえ

false

パラメータが true に設定されている場合、ページの読み込みが完了するとすぐにビデオまたはオーディオ ファイルの再生が開始します。このオプションが false に設定されている場合、ユーザーがページのアイコンまたはイメージをクリックするまでファイルは再生されません。

例: 

<ac:macro ac:name="multimedia">
  <ac:parameter ac:name="page">Macros</ac:parameter>
  <ac:parameter ac:name="name">ninjas.swf</ac:parameter>
  <ac:parameter ac:name="space">DOC</ac:parameter>
  <ac:parameter ac:name="autostart">true</ac:parameter>
</ac:macro>

Page Properties macro

Error rendering macro 'excerpt-include'

No link could be created for 'Metadata Details Macro'.

Error rendering macro 'excerpt-include'

No link could be created for '_MetadataDetailsMacroMarkup'.

例: 

<ac:macro ac:name="details">
  <ac:parameter ac:name="hidden">true</ac:parameter>
  <ac:parameter ac:name="label">status</ac:parameter>
  <ac:rich-text-body>
    <table>
      <tbody>
        <tr>
          <td style="text-align: left;">Project Status</td>
          <td style="text-align: left;">Complete</td>
        </tr>
        <tr>
          <td colspan="1" style="text-align: left;">Team</td>
          <td colspan="1" style="text-align: left;">Green Parrots</td>
        </tr>
        <tr>
          <td colspan="1" style="text-align: left;">Deadline</td>
          <td colspan="1" style="text-align: left;">2012-09</td>
        </tr>
      </tbody>
    </table>
  </ac:rich-text-body>
</ac:macro>

ページプロパティ レポート マクロ

Error rendering macro 'excerpt-include'

No link could be created for 'Details Summary Macro'.

Error rendering macro 'excerpt-include'

No link could be created for '_DetailsSummaryMacroMarkup'.

例: 

<ac:macro ac:name="detailssummary">
  <ac:parameter ac:name="label">status</ac:parameter>
</ac:macro>

Section macro

Used with the Column macro to define columns on a page. See  Working with page layouts and columns and sections.

Macro name: section

Macro body: Rich text, consisting of one or more Column macros.

パラメーター名必須既定パラメーターの説明と指定可能な値

border

いいえFalse値が true の場合、このセクションの列の枠線は破線になります。

例: 

<ac:macro ac:name="section">
  <ac:parameter ac:name="border">true</ac:parameter>
  <ac:rich-text-body>
    <ac:macro ac:name="column">
      <ac:parameter ac:name="width">100px</ac:parameter>
      <ac:rich-text-body>
        <p>This is the content of <strong>column 1</strong>.</p>
      </ac:rich-text-body>
    </ac:macro>
    <ac:macro ac:name="column">
      <ac:rich-text-body>
        <p>This is the content of <strong>column 2</strong>.</p>
      </ac:rich-text-body>
    </ac:macro>
  </ac:rich-text-body>
</ac:macro>

コンテンツ テーブル マクロ

Displays a table of contents from your page headings.

Macro name: toc

マクロ本体: なし。

パラメーター名必須既定パラメーターの説明と指定可能な値
printableいいえtrueIf you set this parameter to false, the table of contents will not be visible when you print the page.
styleいいえnoneThe style of bullet point for each list item. You can use any valid CSS style. For example:
  • none – No list style is displayed.
  • circle –  The list style is a circle.
  • disc – The list style is a filled circle. This is the typical bullet list, and is the one we are using in this example list.
  • square — The list style is a square.
  • decimal — The list is numbered (1, 2, 3, 4, 5).
  • lower-alpha — The list style is lower case, alphabetised (a, b, c, d, e).
  • lower-roman — The list style is lower-case roman numerals (i, ii, iii, iv, v, vi).
  • upper-roman — The list style is upper-case roman numerals (I, II, III, IV, V, VI).
maxLevelいいえ7Maximum heading level. Use this parameter to select the highest heading level to include.  For example, a value of 2 will list h1 and h2 levels, but will not include h3 and below.
indentいいえ(なし)

This parameter applies to vertical lists only (type = list). 

Use this parameter to indent the list items according to CSS quantities. For example, a value of 10px will successively indent list heading groups by 10 pixels. Level 1 headings will be indented 10px, and level 2 headings by an additional 10px, and so on.

minLevelいいえ1Minimum heading level. The heading level at which the table of contents will start.  For example, a value of 2 will list h2, h3, and h4 headings, but will not include h1 headings.
classいいえ(なし)A CSS class name. If you have a custom style sheet, you can use this parameter to output the table of contents with the specified class attribute.
excludeいいえ(なし)

Specifies the headings to exclude by pattern matching. The value must be a regular expression. If this parameter is specified, the table of contents will include only the headings that match the regular expression. Example: .*\.[1//2]

 See Sun's Regex documentation for examples of constructing regular expression strings.
typeいいえlist

Defines the overall format of the table of contents.

利用可能な値:

  • list – displays the table of contents in a vertical list.
  • flat – displays a horizontal series of links. For example: [Heading 1] [Heading 2] [Heading 3].
outlineいいえfalseA value of true will apply outline numbering to the headings as displayed in the table of contents. For example: 1.1, 1.2, 1.3.
separatorいいえbrackets

This parameter applies to flat lists only (type = flat).  Use this parameter to style the display of a flat list. 

利用可能な値:

  • brackets – Each item is enclosed by square brackets: [ ].
  • braces  – Each item is enclosed by braces: { }.
  • parens – Each item is enclosed by parentheses: ( ).
  • pipe – The items are separated by a pipe: |
  • anything – The items are separated by the value you enter. You can enter any text as a separator, for example ***. If using a custom separator, be aware that text displays exactly as entered, with no additional white space to further separate the characters.
includeいいえ(なし)

Specifies the headings to include by pattern matching. The value must be a regular expression. If this parameter is specified, the table of contents will ignore any headings that do not match the regular expression. Example: .*\.[1//2]

 See Sun's Regex documentation for examples of constructing regular expression strings.

例:

この例は、リスト タイプの目次を示しています。

<ac:macro ac:name="toc">
    <ac:parameter ac:name="printable">true</ac:parameter>
    <ac:parameter ac:name="style">square</ac:parameter>
    <ac:parameter ac:name="maxLevel">2</ac:parameter>
    <ac:parameter ac:name="indent">5px</ac:parameter>
    <ac:parameter ac:name="minLevel">2</ac:parameter>
    <ac:parameter ac:name="class">bigpink</ac:parameter>
    <ac:parameter ac:name="exclude">[1//2]</ac:parameter>
    <ac:parameter ac:name="type">list</ac:parameter>
    <ac:parameter ac:name="outline">true</ac:parameter>
    <ac:parameter ac:name="include">.*</ac:parameter>
  </ac:macro>

この例では、目次のフラット テーブルを示しています。

<ac:macro ac:name="toc">
    <ac:parameter ac:name="printable">true</ac:parameter>
    <ac:parameter ac:name="maxLevel">2</ac:parameter>
    <ac:parameter ac:name="minLevel">2</ac:parameter>
    <ac:parameter ac:name="class">bigpink</ac:parameter>
    <ac:parameter ac:name="exclude">[1//2]</ac:parameter>
    <ac:parameter ac:name="type">flat</ac:parameter>
    <ac:parameter ac:name="outline">true</ac:parameter>
    <ac:parameter ac:name="separator">pipe</ac:parameter>
    <ac:parameter ac:name="include">.*</ac:parameter>
  </ac:macro> 

 

 

Macro format notes

Macro bodies

Some macros accept a body as well as parameters.

Plain text bodies

The body of a plain text macro must be inside a CDATA block. So the following is not sufficient:

<ac:plain-text-body>text</ac:plain-text-body>

The correct usage is:

<ac:plain-text-body><![CDATA[text]]></ac:plain-text-body>

Other notes

  • [Required (必須)] 列は、データ入力時にパラメーターが必要かどうかを示します。パラメーターが指定されていない場合、Confluence は [デフォルト] 列に示されているように既定値を挿入します。

  • A request from the Atlassian technical writers about comments and feedback: When adding comments to this page, please restrict your comments to constructive feedback on the documentation itself: Things we've missed in the documentation, and things that will be useful to other readers. If you have other feedback about the editor, wiki markup, the XML storage format, and Confluence 4 in general, please add your comments in the section titled Confluence 4 Editor - Customer Feedback, and its child pages. Our reason for this request: When a page attracts a large number of comments, it makes it difficult for everyone to read the page, and to add or respond to comments about the documentation. Thanks. (smile)
  • ラベルなし

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.