コード、構文をハイライトする「SyntaxHighlighter」


このブログではよくプログラムのサンプルコードを書くことがあります。コードを書くときテーブルを作って行番号をつけたり、構文などを区別しやすいように色をつけたりと結構手間でした。この作業を自動的にしてくれるjavascriptライブラリ「SyntaxHighlighter」をweb開発の仲間がみつけてくれました。さっそくこのライブラリの検証をしてみたいと思います。

SyntaxHighlighterとは

alexgorbatchev.com/wiki」からダウンロードできます。トップページに簡単な説明がありましたので引用してみます。

SyntaxHighlighter is a fully functional self-contained code syntax
highlighter developed in JavaScript.

訳:
SyntaxHighlighterはjavascriptで開発された完全に機能的な
自己完結型コード構文マーカーです。

javascriptを利用してコードを自動判定し構文などに色をつけていくようです。

ライセンス

ライブラリを使う時に必ず確認しなければいけないのがライセンスです。商用利用には有料などもありますので注意が必要です。このライブラリのライセンス部分を引用します。

SyntaxHighlighter is licenced under LGPL 3
and while being free of charge is a work of one man who needs beer,
ie if you are using SyntaxHighlighter, please donate.

訳:
SyntaxHighlighterは「LGPL3」ライセンスです。無料で提供していますが、
SyntaxHighlighterを使用するならば、1人で開発しているビールが必要な
男性にどうか寄付をください。

ライセンス形式はLGPLのバージョン3です。オープンソースライセンスの1つで無料使用ですが、いろいろと条件がついてきます。LGPL 3の日本語全訳を一通り目を通しておいてください。

ダウンロード

SyntaxHighlighter/Download のページからダウンロードできます。
2009年9月22日時点では、最新バージョンは 2.0.320 です。

syntaxhighlighter01

SyntaxHighlighterの構成

syntaxhighlighter02

ダウンロードした圧縮ファイルを解凍しました。「SyntaxHighlighter」は数多くのファイルから構成されています。「LGPlv3.txt」はライセンスの説明で、「test.html」はサンプルファイルです。その他はこのライブラリのコアになります。

ユーザガイド(公式サイト)

syntaxhighlighter03

公式サイトトップページに、ユーザガイドがありました。英語で書かれていますが画像やサンプルコードなどを利用して書かれているので理解はしやすいと思います。解凍したら数多くのファイルがありますが、全部利用しなくても表示したい言語やデザインを選択して一部を利用していく感じですね。次回はこのユーザガイドをみながらライブラリの使い方を詳しくみていきます。


コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です