Redmineのシンタックスハイライトの対応形式

2012-01-07 14:48  •  分類:

Redmineのチケットの説明・注記・Wikiなどテキストを入力できる多くの箇所で、ソースコードの予約語などに色をつけてわかりやすく表示するシンタックスハイライト機能が利用できます。

シンタックスハイライトは Coderay と呼ばれるライブラリを利用することで実現されています。Redmine 1.3ではCoderayのバージョンが0.9.7から1.0.0に更新されました。これにより対応形式にClojure、ERB、HAMLが新たに追加され、Nitoro XTML、Schemeは削除されました。

シンタックスハイライトの利用方法

以下の例のように、ソースコードをcodeタグで囲み、さらにcodeタグの外側をpreタグで囲みます。codeタグのclass属性はシンタックスハイライト対象のコードの種類を示します。例では、C言語を指定しています。

<pre><code class="c">
#include <stdio.h>
 
int main(void) {
    printf("Hello, World!\n");
 
    return 0;
}
</code></pre>

対応形式とclass属性の値

形式 class属性に指定する値
C c, h
C++ cpp, cplusplus
Clojure clj
CSS css
Delphi delphi, pascal
diff diff
ERB erb, rhtml, eruby
Groovy groovy
HAML haml
HTML html, xhtml
Java java
Javascript java_script, ecma, ecmascript, ecma_script, javascript, js
JSON json
PHP php
plain text plaintext, plain
Python python
RHTML rhtml
Ruby ruby, irb
SQL sql
XML xml
YAML yaml, yml

※Redmine同梱のCodeRayのソースコードの一部 (vendor/plugins/coderay-0.9.2/lib/coderay/scanners/ 以下)を参照して作成。

シンタックスハイライトの実行例

以下はC, CSS, diff, SQLに対してシンタックスハイライトを行った例です。

作成: 2012-01-07 14:48  •  分類:

複数拠点にまたがるプロジェクトのタスク管理・情報共有ができる
インターネット経由で使えるSaaS「My Redmine」「My Subversion

My Redmine - いつでも、どこでもプロジェクト管理
SSL・ウイルス対策・バックアップ込み。何人で使っても月額税別8,000円から。
ぜひ1ヶ月無料でお試しください。

My Subversion - いつでも、どこでもソースコード共有
ソースコードをメールで送るのはやめて作業効率アップ。月額税別2,500円から。
ぜひ1ヶ月無料でお試しください。