コード ブロック マクロ
このマクロは、Confluence Data Center と Confluence Cloud で使用できます。マクロの詳細については、「Confluence Cloud」を参照してください。
Add a Code Block macro to your page to display code examples with syntax highlighting for more than 80 programming languages.
これは、以下のようなコード スニペットの共有に役立ちます。
- サンプル コード
- ターミナル コマンド
- アプリケーション ログからの抜粋
On this page:
スクリーンショット: 構文強調表示を使用したコード ブロック マクロのコード サンプル
コード ブロック マクロの設定オプション
コード ブロック マクロの外観は、さまざまな方法でカスタマイズできます。
次の表は、使用可能な各パラメーターの概要を示しています。
フィールド | パラメーター名 (Confluence ストレージ形式または Wiki マークアップで使用) | 既定 | 説明 |
---|---|---|---|
Syntax highlighting |
| プレーン テキスト | Specifies the language (or environment) for syntax highlighting. If you’re an admin, you can configure the default language in the admin area of Confluence. |
タイトル |
| なし | コードブロックにタイトルを追加します。指定すると、コードブロックの先頭行のヘッダーに表示されます。 |
折りたたむ |
| false | 選択すると、コード マクロの内容が、アクセス時やリフレッシュ時に折りたたまれます。 |
行番号を表示 |
| false | 選択すると、コード行の左側に数字が表示されます。 |
最初の行番号 |
| 1 | 行数を表示を選択すると、この値を最初の行の数字として定義します。 |
折り返しをオン | - | false | このボタンを切り替えて、コード ブロック内のテキストの折り返しを有効または無効にします。 このボタンは、該当するページの閲覧者全員を対象にコード ブロック マクロの右上隅にも表示されます。 |
テキストとしてコピー | - | - | コード ブロックをプレーン テキストとしてコピーするには、このボタンをクリックします。 このボタンは、該当するページの閲覧者全員を対象にコード ブロック マクロの右上隅にも表示されます。 |
Supported Code Block macro languages
Code Block macro supports over 80 programming languages.
AABAP | JJava | qQML |
cC | KKotlin | rR |
dD | LLiveScript | SSass |
EElixir | MMathematica | TTcl |
FFortran | nNGINX | VVala |
GGo | OObjective-C | xXML |
ただし、Haskell | PPascal | これからはYAML |
コード ブロック マクロをページに追加する
コード ブロック マクロをページに追加するには、次の手順を実行します。
- エディターのツールバーから、[挿入]> [その他のマクロ] の順に選択します。
- From the Formatting category, select Code Block .
- To choose your preferred language, either start typing its name in the Syntax highlighting field, or click on the dropdown button to scroll through the list.
- 上記のフィールドを使用して、コード ブロックをページに表示する方法をカスタマイズします。
- [挿入] ボタンを選択します。
- コードをマクロ プレースホルダーに入力するか貼り付けます。
プレースホルダー内に含まれるスペースは、コード ブロック マクロでは処理されないので注意してください。これにより、入力時にコードのインデントを柔軟に行うことができます。
You can now publish your page to see the macro in action. Once published, readers of your page will also be able to use options Turn on wrap
and Copy as text , displayed in the top right corner of the code block.マクロ パラメーターを変更する
Macro parameters are used to change the behavior of a macro. For example, you can directly update the language from the toolbar that appears while you’re editing your code on the page.
マクロ パラメーターを変更するには、次の手順を実行します。
- エディターで、マクロ プレースホルダー内の任意の場所をクリックしてツールバーを表示します。
- [編集] を選択します。
- 必要に応じてパラメーターを更新し、[挿入] を選択します。
コード ブロック マクロを管理する
You can configure the Code Block macro to use a specific language and theme by default. You need Confluence Administrator permissions to change the default language .
サイトのコード ブロックの既定の言語を設定するには、次の手順に従います。
- [管理] メニュー に移動して、[一般設定] > [コード マクロの設定] の順に選択します。
- From the Default language dropdown, select your preferred default language.
- [保存] を選択します。
特に指定しない限り、新しいコード ブロックでは常に既定の言語が使用されます。既存のコード ブロックは変更されません。
Uploaded custom languages were removed in Confluence 9.0. Previously uploaded languages are no longer supported . You can uninstall these from your system.
ユーザーがインストールした言語を削除するには、次の手順に従います。
- [管理] メニュー から [アプリの管理] に移動します。
- [ユーザーがインストールしたアプリ] に移動し、アップロードした言語に対応するアプリを探します。
- 次のように表示されます。
「Custom Code Macro Highlighting for...」 - If you have many apps, you might prefer to search for the namspace:
com.atlassian.confluence.ext.code.custom
. - Select Uninstall or Disable.
カスタム言語はコード ブロック マクロに表示されなくなります。
このマクロを追加するその他の方法
手入力でこのマクロを追加する
Wiki マークアップを使用してこのマクロを追加する
これは、エディタ外部 (スペースのサイドバー、ヘッダー、フッターのカスタム コンテンツなど) でマクロを追加する場合に便利です。
マクロ名: code
マクロ本文:プレーンテキストをアクセプトする
{code:title=This is my title|linenumbers=true|language=javascript|firstline=0001|collapse=true}
This is my code
{code}
Confluence を使いこなす
Atlassian Marketplace で提供されている数百ものマクロを使用して、Confluence を拡張できます。人気のあるアプリの一部を紹介します。
- Include Bitbucket Server for Confluence - Bitbucket Server へ自動的に同期されるコード スニペットをConfluence 内に簡単に追加
- Markdown Extension for Confluence - 公開および非公開 Github & Bitbucket リポジトリのマークダウンを Confluence に埋め込み