コード ブロック マクロ
コードブロック マクロを使用すると、以下のように、構文をわかりやすく強調表示したソースコードをページに表示できます。
コードブロック マクロを追加する
- エディタのツールバーで、[挿入]
> [その他のマクロ] を選択します。 - 対象のマクロを見つけて、選択します。
オートコンプリートを活用して素早く入力: 「{」とマクロ名の先頭を入力すると、マクロ候補の一覧が表示されます。この例では、cheese マクロを挿入します。
既存のマクロを編集する方法: マクロのプレースホルダをクリックして、[編集] を選択します。これによりマクロの詳細を開き、マクロのパラメーターを編集できます。
エディターのプレースホルダー内に直接コードブロックを入力します。プレースホルダー内に含まれるスペースは、コードブロック マクロでは 処理されないでの注意してください。これにより入力時、柔軟にコード インデントを行えます。
パラメータ
パラメータは、マクロ出力の内容や形式を制御するために設定するオプションです。Confluence の保存形式または wiki マークアップで使用されるパラメータ名がマクロ ブラウザで使用されるラベルと異なる場合、以下の一覧に括弧付きで表示されます (example)。
パラメータ | 既定 | 説明 |
|---|---|---|
シンタックス ハイライト | java | 構文をハイライトする言語（または環境）を特定します。規定値は java ですが、下記の言語／環境から選択可能です。
|
タイトル | なし | コードブロックにタイトルを追加します。指定すると、コードブロックの先頭行のヘッダーに表示されます。 |
折りたたみ可能 | false | 選択すると、コード マクロの内容が、アクセス時やリフレッシュ時に折りたたまれます。 |
行番号を表示 | false | 選択すると、コード行の左側に数字が表示されます。 |
最初の行番号 | 1 | 行数を表示を選択すると、この値を最初の行の数字として定義します。 |
テーマ | 既定 | コードブロックの表示に使用するカラーテーマを指定します。テーマの多くは人気の統合開発環境 (IDE)のデフォルトのカラースキームをベースにしています。 既定のテーマConfluence (既定) は、ブランクの背景にブラックとカラーフォントの一般的なものですが、下記の人気のテーマから他のテーマを選択することも可能です。
|
コードブロック マクロを設定する
コード ブロック マクロを構成して、特定の言語やテーマを既定で使用したり、新しい言語をアップロードしたりできます。既定のテーマと言語を変更するには Confluence 管理者権限が、新しい言語をアップロードするにはシステム管理者権限が必要です。
サイトにコードブロックの既定の外観を設定するには：
- 設定アイコン
を選択し、[一般設定] を選択します。 - コードマクロを設定するを選択する
- 既定のテーマと既定の言語を選択する
- 保存を選択する
他を指定していない限り、すべての新しいコードブロックに既定のテーマと言語が適用されます。既存のコードブロックは変更されません。
他の言語を追加するには：
- 設定アイコン を選択し、[一般設定] を選択します。
- コードマクロを設定するを選択する
- 新しい言語を追加するを選択する
- 追加する言語ファイルを検索し、新しい言語に対し、名前を入力する（言語の選択時に表示されます）
- 追加 を選択します
言語ファイルは Language files で正しくフォーマットされており、Custom Brush syntaxに準拠している必要があります。
インストールした言語を無効化または削除するには：
- 設定アイコン を選択し、[一般設定] を選択します。
- [アプリの管理] を選択します。
- [ユーザーがインストールしたアプリ] から、アップロードした言語に対応するアプリを検索します。"Custom Code Macro Highlighting for..." のように表示されます
- アンインストールまたは無効にする選択する
言語がコードマクロに表示されなくなります。
Wiki マークアップの例
以下の例は、エディタ外部 (スペースのサイドバー、ヘッダー、フッターのカスタム コンテンツなど) でマクロを追加する場合に便利です。
マクロ名: code
マクロ本文：プレーンテキストをアクセプトする
{code:title=This is my title|theme=FadeToGrey|linenumbers=true|language=java|firstline=0001|collapse=true}
This is my code
{code}Confluence を使いこなす
Atlassian Marketplace で提供されている数百ものマクロを使用して、Confluence を拡張できます。人気のあるアプリの一部を紹介します。
- Code Pro for Confluence - Confluence の任意のソースでコードをリアルタイムで表示
- Include Bitbucket Server for Confluence - Bitbucket Server へ自動的に同期されるコード スニペットをConfluence 内に簡単に追加
- Markdown Extension for Confluence - 公開および非公開 Github & Bitbucket リポジトリのマークダウンを Confluence に埋め込み