コー​ド ブロック マクロ

The Code Block macro allows you to display source code in your document with the appropriate syntax highlighting. The code block displays on the page as shown below:

public static void main(String[] args) 
{ 
  System.out.println("Hello World!");
}

Using the Code Block Macro

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

1. Confluence のエディタで、[挿入] > [その他のマクロ] を選択します。
2. 対象のマクロを見つけて、選択します。

Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete.

既存のマクロを編集する方法: マクロのプレースホルダをクリックして、[編集] を選択します。マクロのパラメータが編集可能な場合、マクロのダイアログ ウィンドウが開きます。

You type the code block directly into the macro placeholder in the editor. Note that any white space contained in the placeholder is not manipulated in any way by the Code Block macro. This is to provide the writer with flexibility over code indentation.

パラメーター

Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).

Configuring the Code Block macro

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

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

1. Choose the cog icon , then choose General Configuration under Confluence Administration
2. Choose Configure Code Macro.
3. [既定のテーマ] と [既定の言語] を選択します。
4. 保存を選択します 。

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

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

1. Choose the cog icon , then choose General Configuration under Confluence Administration
2. Choose Configure Code Macro.
3. [新規言語の追加] を選択します。 
4. 追加する言語ファイルを見つけ、新しい言語の [名前] を入力します (これは言語の選択時に表示されます)。
5. 追加を選択します。

Language files must be correctly formatted JavaScript files and adhere to the Custom Brush syntax. 

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

1. Choose the cog icon , then choose General Configuration under Confluence Administration
2. アドオンの管理を選択します。
3. ユーザーがインストールしたアドオンから、アップロードしたアドオンを検索する - 「～をハイライトするカスタムコード マクロ」のように表示されます
4. [アンインストール] または [無効化] を選択します。 

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

コー​​ドの例

次の例は、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 例はさまざまなオプションのパラメータを使用したコードブロック マクロの例です。

<ac:structured-macro ac:name="code">
  <ac:plain-text-body><![CDATA[this is my code]]></ac:plain-text-body>
</ac:structured-macro>

this is my code

<ac:structured-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:structured-macro>

this is my code

<ac:structured-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:structured-macro>

this is my code

Wiki マークアップの例

{code:title=This is my title|theme=FadeToGrey|linenumbers=true|language=html/xml|firstline=0001|collapse=true}
これは私のコードです
{code}