コー​ド ブロック マクロ

マクロ

このページの内容

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

このマクロは、Confluence Server と Data Center で使用できます。マクロの詳細については、「Confluence Cloud」を参照してください。

シンタックス ハイライトを使用してコード例を表示するには、コード ブロック マクロをページに追加します。 

これは、以下のようなコード スニペットの共有に役立ちます。

  • サンプル コード
  • ターミナル コマンド
  • アプリケーション ログからの抜粋

On this page:

スクリーンショット: ダーク テーマでシンタックス ハイライトを使用したコード ブロック マクロのコード例


コード ブロック マクロをページに追加する

コード ブロック マクロをページに追加するには、次の手順を実行します。

  1. エディタのツールバーで、[挿入] > [その他のマクロ] を選択します。
  2. [形式設定] カテゴリから [コード ブロック] を選択します。
  3. シンタックス ハイライトの言語を選択します。
  4. 以下のパラメーターを使用して、ページでのコード ブロックの表示方法をカスタマイズします。 
  5. [挿入] をクリックします。 
  6. コードをマクロ プレースホルダーに入力するか貼り付けます。 

その後、ページを公開するとマクロの動作を確認できます。 

スクリーンショット: コード ブロック マクロでのシンタックス ハイライトの言語とテーマの選択

注: コード ブロックはエディタのマクロ プレースホルダーに直接入力します。プレースホルダー内に含まれるスペースは、コード ブロック マクロでは処理されないので注意してください。これにより入力時、柔軟にコード インデントを行えます。

マクロ パラメーターを変更する

マクロ パラメーターは、マクロの動作を変えるために使用します。

マクロ パラメーターを変更するには、次の手順を実行します。

  1. エディタでマクロのプレースホルダーをクリックし、[編集] を選択します。
  2. 必要に応じてパラメーターを更新し、[挿入] を選択します。

このマクロで使用できるパラメーターの一覧は、次のとおりです。 

パラメーター

既定

説明

シンタックス ハイライト
(language

java

構文をハイライトする言語(または環境)を特定します。既定値は java ですが、下記の言語/環境から選択可能です。

  • ActionScript
  • AppleScript
  • bash
  • C#
  • C++
  • CSS
  • coldfusion
  • delphi
  • diff
  • erlang
  • groovy
  • HTML および XML
  • Java
  • javafx
  • javascript
  • PHP
  • プレーン テキスト
  • PowerShell
  • python
  • ruby
  • SQL
  • Sass
  • scala
  • Visual Basic
  • YAML

タイトル

なし

コードブロックにタイトルを追加します。指定すると、コードブロックの先頭行のヘッダーに表示されます。

折りたたみ可能
(collapse

false

選択すると、コード マクロの内容が、アクセス時やリフレッシュ時に折りたたまれます。expand source リンクをクリックすると、コンテンツを確認できます。false の場合、コード マクロの内容は常に全表示されます。

行番号を表示
(linenumbers)

false

選択すると、コード行の左側に数字が表示されます。

最初の行番号
(firstline

1

行数を表示を選択すると、この値を最初の行の数字として定義します。

テーマ

既定

コードブロックの表示に使用するカラーテーマを指定します。テーマの多くは人気の統合開発環境 (IDE)のデフォルトのカラースキームをベースにしています。 既定のテーマConfluence (既定) は、ブランクの背景にブラックとカラーフォントの一般的なものですが、下記の人気のテーマから他のテーマを選択することも可能です。

  • DJango
  • Emacs
  • FadeToGrey
  • Midnight
  • RDark
  • Eclipse
  • Confluence

Confluence の保存形式または wiki マークアップで使用されるパラメーター名がマクロ ブラウザで使用されるラベルと異なる場合、以下の一覧に括弧付きで表示されます (example)。

コード ブロック マクロを管理する

コード ブロック マクロを構成して、特定の言語やテーマを既定で使用したり、新しい言語をアップロードしたりできます。既定のテーマと言語を変更するには Confluence 管理者権限が、新しい言語をアップロードするにはシステム管理者権限が必要です。

サイトにコードブロックの既定の外観を設定するには:

  1. [管理] > [一般設定] > [コード マクロの設定] に移動します。
  2. [既定のテーマ] と [既定の言語] を選択します。
  3. 保存を選択します 。

他を指定していない限り、すべての新しいコードブロックに既定のテーマと言語が適用されます。既存のコードブロックは変更されません。 

他の言語を追加するには:

  1. [管理] > [一般設定] > [コード マクロの設定] に移動します。
  2. [新規言語の追加] を選択します。
  3. 追加する言語ファイルを見つけ、新しい言語の [名前] を入力します (これは言語の選択時に表示されます)。
  4. 追加を選択します。

言語ファイルは正しくフォーマットされた JavaScript ファイルで、Custom Brush syntax に準拠している必要があります。サンプルを <install-directory>/confluence/includes/js/third-party で確認いただけます。

インストールした言語を無効化または削除するには:

  1. [管理] > [アプリの管理] に移動します。
  2. [ユーザーがインストールしたアプリ] から、アップロードした言語に対応するアプリを検索します。"Custom Code Macro Highlighting for..." のように表示されます
  3. [アンインストール] または [無効化] を選択します。

言語がコードマクロに表示されなくなります。 

このマクロを追加するその他の方法

手入力でこのマクロを追加する

{」と入力してからマクロ名の入力を開始すると、マクロの一覧が表示されます。

Wiki マークアップを使用してこのマクロを追加する

これは、エディタ外部 (スペースのサイドバー、ヘッダー、フッターのカスタム コンテンツなど) でマクロを追加する場合に便利です。

マクロ名: code

マクロ本文:プレーンテキストをアクセプトする

{code:title=This is my title|theme=FadeToGrey|linenumbers=true|language=java|firstline=0001|collapse=true}
This is my code
{code}
tip/resting Created with Sketch.

Confluence を使いこなす

Atlassian Marketplace で提供されている数百ものマクロを使用して、Confluence を拡張できます。人気のあるアプリの一部を紹介します。

Last modified on Mar 22, 2022

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.