コード ブロック マクロ
コードブロック マクロを使用すると、以下のように、構文をわかりやすく強調表示したソースコードをページに表示できます。
コードブロック マクロを追加する
- Confluence のエディタで、[挿入] > [その他のマクロ] を選択します。
- 対象のマクロを見つけて、選択します。
オートコンプリートでマクロエントリを高速化： タイプ{とマクロ名の先頭には、提案したマクロの一覧を表示します。詳細は、こちらを参照ください。リンク、ファイル、マクロ、メンションのオートコンプリート
既存のマクロを編集する方法: マクロのプレースホルダをクリックして、[編集] を選択します。マクロのパラメータが編集可能な場合、マクロのダイアログ ウィンドウが開きます。
エディターのプレースホルダー内に直接コードブロックを入力します。プレースホルダー内に含まれるスペースは、コードブロック マクロでは 処理されないでの注意してください。これにより入力時、柔軟にコード インデントを行えます。
パラメーター
パラメーターは、マクロ出力の内容や形式を制御するために設定できるオプションです。Confluence の保存形式または wiki マークアップで使用されるパラメータ名がマクロ ブラウザで使用されるラベルと異なる場合、以下の一覧に括弧付きで表示されます (example)。
パラメーター | 既定 | 説明 |
|---|---|---|
シンタックス ハイライト | java | 構文をハイライトする言語（または環境）を特定します。既定値は java ですが、下記の言語／環境から選択可能です。
|
タイトル | なし | コードブロックにタイトルを追加します。指定すると、コードブロックの先頭行のヘッダーに表示されます。 |
折りたたみ可能 | false | 選択すると、コード マクロの内容が、アクセス時やリフレッシュ時に折りたたまれます。 |
行番号を表示 | false | 選択すると、コード行の左側に数字が表示されます。 |
最初の行番号 | 1 | 行数を表示を選択すると、この値を最初の行の数字として定義します。 |
テーマ | 既定 | コードブロックの表示に使用するカラーテーマを指定します。テーマの多くは人気の統合開発環境 (IDE)のデフォルトのカラースキームをベースにしています。 既定のテーマConfluence (Default) は、ブランクの背景にブラックとカラーフォントの一般的なものですが、下記の人気のテーマから他のテーマを選択することも可能です。
|
コードブロック マクロを設定する
コードブロックマクロを設定すれば、特定の言語とテーマを既定値として使用したり、新しい言語をアップロードしたりできます。既定値のテーマと言語を変更するにはシステム管理者権限が必要です。また、新しい言語をアップロードするにはConfluence 管理者権限が必要です。
サイトにコードブロックの既定の外観を設定するには：
- Choose the cog icon
, then choose General Configuration under Confluence Administration - コードマクロを設定するを選択する
- 既定のテーマと既定の言語を選択する
- 保存を選択する
他を指定していない限り、すべての新しいコードブロックに既定のテーマと言語が適用されます。既存のコードブロックは変更されません。
他の言語を追加するには：
- Choose the cog icon , then choose General Configuration under Confluence Administration
- コードマクロを設定するを選択する
- 新しい言語を追加するを選択する
- 追加する言語ファイルを検索し、新しい言語に対し、名前を入力する（言語の選択時に表示されます）
- 追加 を選択します
言語ファイルは Language files で正しくフォーマットされており、Custom Brush syntaxに準拠している必要があります。
インストールした言語を無効化または削除するには：
- Choose the cog icon , then choose General Configuration under Confluence Administration
- アドオンを管理を選択する
- ユーザーがインストールしたアドオンから、アップロードしたアドオンを検索する - 「～をハイライトするカスタムコード マクロ」のように表示されます
- アンインストールまたは無効にする選択する
言語がコードマクロに表示されなくなります。
コードの例
次の例は、Confluence ページの基本的なマークアップを調べたり、編集したりする上級ユーザー向けに提供されています。
マクロ名: code
マクロ本文：プレーンテキストをアクセプトする
保存形式の例
以下の例ではすべてのパラメータと本文を表示しています。
<ac:structured-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">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:structured-macro>下記の 3 例はさまざまなオプションのパラメータを使用したコードブロック マクロの例です。
説明 | Markup | 表示結果 |
|---|---|---|
| 本文にコードブロック マクロ、オプションのパラメータなし |
|
|
| 本文にコードブロック マクロ、オプションの言語パラメータが定義されている |
|
|
本文にコードブロック マクロとオプションのタイトル、行数、言語パラメータが定義されている |
|
This is my title
|
Wiki マークアップの例
{code:title=This is my title|theme=FadeToGrey|linenumbers=true|language=html/xml|firstline=0001|collapse=true}
This is my code
{code}