コー​ド ブロック マクロ

マクロ

このページの内容

お困りですか?

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

コミュニティに質問

Add a Code Block macro to your page to display code examples with syntax highlighting. 

This is great for sharing code snippets such as:

  • sample code
  • terminal commands
  • excerpts from application logs.

Screenshot: code sample in the Code Block macro, with syntax highlighting and a dark theme.


Add this macro to your page

To add the Code Block macro to a page:

  1. From the editor toolbar, choose Insert > Other Macros.
  2. Choose Code Block from the Formatting category.
  3. Choose a language for syntax highlighting.
  4. Use the parameters below to customise how the code block should appear on your page. 
  5. [挿入] をクリックします。 
  6. Type or paste your code into the macro placeholder. 

You can then publish your page to see the macro in action. 

Screenshot: Choosing syntax highlighting language and theme in the Code Block macro

Note: 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.

Change the macro parameters

Macro parameters are used to change the behaviour of a macro.

To change the macro parameters:

  1. In the editor, click the macro placeholder and choose Edit.
  2. Update the parameters as required then choose Insert.

Here's a list of the parameters available in this macro. 

パラメーター

既定

説明

シンタックス ハイライト
(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

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).

Administer the Code Block macro

You can configure the Code Block macro to use a specific language and theme by default and also upload new languages. You need Confluence Administrator permissions to change the default theme and language and System Administrator permissions to upload new languages.

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

  1. Go to  > General Configuration > Configure Code Macro.
  2. Select a Default Theme and Default Language.
  3. 保存を選択します 。

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

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

  1. Go to  > General Configuration > Configure Code Macro.
  2. Choose Add a new language.
  3. Locate your language file and enter a Name for the new language (this will appear when selecting the language).
  4. 追加を選択します。

言語ファイルは Language files で正しくフォーマットされており、Custom Brush syntaxに準拠している必要があります。

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

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

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

Other ways to add this macro

Add this macro as you type

Type followed by the start of the macro name, to see a list of macros. 

Add this macro using wiki markup

This is useful when you want to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

マクロ名: 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 を拡張できます。人気のあるアプリの一部を紹介します。

最終更新日 2020 年 5 月 20 日

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

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