SyntaxHighlighterを導入してソースコードを見やすくしてみました

2013/07/27 2015/03/08

SyntaxHighlighterでソースコードを見やすくする

　
PHPのソースコードを始め、ソースコードの部分が見にくいなぁ、と以前から思っていましたが、ブログを再開後しばらくして便利なツールがあることを知りまして、今回、それを入れてみることにいたしました。
　
その便利なツールが「SyntaxHighlighter」です。
　
現在は、Ver 3.0になっているようで、機能的にも徐々にバージョンアップしてきているようですね。
設置の方法もブログなどを探していただくと、いろいろと情報提供をしてくれている方も増えてきていて、それほど苦労せずに設置できるんじゃないかなぁ。と思い．．．．たいですね。
　
　

SyntaxHighlighter設置の参考サイト

　
設置の方法としては、下記のサイトに分かりやすく説明がしてありました。
http://www.netyasun.com/syntaxhighlighter/
http://controlkey.blog.fc2.com/blog-entry-16.html
　
最初は上の方のサイトを見て「SyntaxHighlighter」の基本的な使い方を勉強して、2コ目のサイトで FC2ブログへの設置方法を勉強しました。
　
しかしっ！！
私は、2週間前の三連休の時に 2日間ほど設置に時間を費やしたあげくに「’SyntaxHighlighter’は宣言されていません。」という JavaScriptのエラーから脱出できずに断念。
　
　

SyntaxHighlighterを設置する際の落とし穴ポイント

　
http://www.872style.com/872/memo/web/SyntaxHighlighter.php
　
そして、今日、改めて上記のサイトを参考にしながらやり直してみました。
このサイトには、Headの部分に書くものと、bodyの最後に書くものと、その理由も含めて書いてありまして、非常に参考になりました。
　
まずは、ローカルに HTMLファイルを作成し、ローカルで動くことを確認しました。
そして、ブログ上に CSS、JSファイルをアップロードして、相対パスで書いていたソースの場所を URL形式の絶対パスに切り替えて動作を確認。
　
そして、動作することを確認した上で FC2ブログ上のテンプレートの修正と、記事の修正を実行。
そして、動作確認．．．．．．
　
でも動かないっ！！！！！
　
2時間ほど悩んでみましたがよく分からず、仕方がないからと、違うテンプレートファイルに同じソースを貼り付けてみると．．．今度は動作しましたっ！！！
　
つまりは、テンプレートによっては CSSの設定なのか、JSの記述の仕方なのか分かりませんが、正しく動作しない場合があります！って言うことですね。
そこまで分析する気がありませんので、テンプレートを変えてよしとします。
　
もし、「SyntaxHighlighter」がブログでうまく動かない場合は、テンプレートを変えてみてください。
動くかもしれません。
　
そんなわけで、このサイトもテンプレートを変更しました。
　
　
ちなみに、最初に参考にしたサイトがありましたが、そのサイトは、トップページの画像のバージョンは、3.0.83となっていたものの、ダウンロードのファイルのバージョンは 1.5.1。
で、最初に参考にしたサイトだったこともあって、よく分からずにそのまま進めて行ってもうまくいかず、表示が崩れてそこでようやくバージョンが違っているということに気づきました。
みなさんもバージョン違いには気を付けましょうっ！！
　
　

SyntaxHighlighterはブラウザによって見え方が違う

　
また、IEではスクロールバーが出る際に最後の 1行が欠けてしまう不具合がありまして、こちらも参考にして対応しました。
http://blog.remora.cx/2010/07/new-function-of-syntaxhighlighter-3.html
　
でも、これを対応しても半分くらい欠けていたので、「margin-bottom: 1em !important;」の部分の「1em」を「2em」にしています。なので、スクロールバーがない場合や、IE以外の場合は、多少余白が多く見えますが、欠けてしまうよりいいでしょう。
　
　

SyntaxHighlighterを設置するサンプルコード

　
ちなみに、ローカルで動作確認した際の HTMLは以下の通りです。
大したものではないですが。
　
———————–

<head>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  <title>SyntaxHighlighter Brushes Tests</title>

<!-- /ここから/ -->
<link href="./styles/shCore.css" rel="stylesheet" type="text/css" />
<link href="./styles/shThemeDefault.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="./scripts/shCore.js"></script>
<script type="text/javascript" src="./scripts/shAutoloader.js"></script>
<script type="text/javascript" src="./scripts/shBrushXml.js"></script>
<!-- /ここまでは head内/ -->

</head>
<body>

＜pre class="brush: php;">
<p>　表示したいソースを <em>＜pre> ～ ＜/pre></em>でかこみ、HTMLの表示であれば、<br />
<em>class=&quot;brush: html;&quot;</em> を記入します。</p>
＜/pre>

＜pre class="brush: text;">
<p>　表示したいソースを <em>＜pre> ～ ＜/pre></em>でかこみ、HTMLの表示であれば、<br />
<em>class=&quot;brush: html;&quot;</em> を記入します。</p>
＜/pre>

＜pre class="brush: css;">
<p>　表示したいソースを <em>＜pre> ～ ＜/pre></em>でかこみ、HTMLの表示であれば、<br />
<em>class=&quot;brush: html;&quot;</em> を記入します。</p>
＜/pre>


<!-- /ここから/ -->
<script type="text/javascript">
SyntaxHighlighter.autoloader(
      "css                      ./scripts/shBrushCss.js"
     ,"js jscript javascript    ./scripts/shBrushJScript.js"
     ,"perl pl                  ./scripts/shBrushPerl.js"
     ,"php                      ./scripts/shBrushPhp.js"
     ,"plain text               ./scripts/shBrushPlain.js"
     ,"sql                      ./scripts/shBrushSql.js"
     ,"html xml xhtml           ./scripts/shBrushXml.js"
);
SyntaxHighlighter.all();
</script>
<!-- /ここまでは bodyuの前/ -->

</body>

<head>

<title>SyntaxHighlighter Brushes Tests</title>

</head>

<body>

＜pre class="brush: php;">

<p>　表示したいソースを <em>＜pre> ～＜/pre></em>でかこみ、HTMLの表示であれば、<br />

<em>class="brush: html;"</em> を記入します。</p>

＜/pre>

＜pre class="brush: text;">

<p>　表示したいソースを <em>＜pre> ～＜/pre></em>でかこみ、HTMLの表示であれば、<br />

<em>class="brush: html;"</em> を記入します。</p>

＜/pre>

＜pre class="brush: css;">

<p>　表示したいソースを <em>＜pre> ～＜/pre></em>でかこみ、HTMLの表示であれば、<br />

<em>class="brush: html;"</em> を記入します。</p>

＜/pre>

SyntaxHighlighter.autoloader(

"css ./scripts/shBrushCss.js"

,"js jscript javascript ./scripts/shBrushJScript.js"

,"perl pl ./scripts/shBrushPerl.js"

,"php ./scripts/shBrushPhp.js"

,"plain text ./scripts/shBrushPlain.js"

,"sql ./scripts/shBrushSql.js"

,"html xml xhtml ./scripts/shBrushXml.js"

);

SyntaxHighlighter.all();

</script>

</body>

———————–
※一部全角の「＜」を使用しています。　
　
　
　
※2014.01.15　追記
この記事は、FC2ブログで書いていた頃の記事です。現在はWordPressに移り「Crayon Syntax Highlighter」と言うプラグインで運用をしています。
　
「Crayon Syntax Highlighter」についての記事は「WordPressのCrayon Syntax Highlighterの使い方」に記事を書いています。

- プログラミング・Web関連技術

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: .gitignoreで無視フォルダの中の特定のファイルを除外「!（否定文）」を使う場合の注意点

Gitで管理する対象、対象外のファイル、フォルダの指定は .gitignoreに記述する。その基本的な記述の方法に加え、無視対象にしたフォルダの中の特定のファイルを管理対象にする記述方法を解説。

: コピーコンテンツ対策.htaccessで直リンク禁止しリダイレクトで対応

不正なコピーコンテンツからの直リンクを拒否する.htaccessの設定方法。拒否するサイトを指定、許可するサイトを指定する方法、単純な拒否と画像の差し替えを解説。

: サイト更新、引越時に.htaccessでリダイレクトする方法解説

サイト更新,引越しなどでサイトのURLが変わった場合のリダイレクトを.htaccessのRewriteEngineを使って処理する方法の解説です。

: 直リンクとは何か？直リンクとディープリンクの違いと著作権問題

直リンクは著作権違反なのか？議論の前にまず「直リンク」の意味を正しく理解しよう。直リンクは他のサイトの画像を読み込む、ディープリンクなど多様な意味がある。

: Pythonをコマンドラインで実行。全角文字（日本語）を引数にする場合の対処方法

Pythonをコマンドラインで実行する際、引数を付与して実行する方法の解説。その時問題となる日本語（全角文字）を利用する方法を解説。Windows環境での解説。

: ロリポップからX-Serverに引越し。サーバの月額費用が増えても求めた理由は？

ロリポップからX-Serverに引越すその理由とは？SEOの観点からも少しでもサーバレスポンスが早いサーバが求められロリポップでは限界を感じたからです。

: 日本語は2バイト文字？3バイト文字？

日本語は2バイトという理解でしたが、UTF-8では事情が違います。その説明です。

: Selenium WebDriver、Pythonをインストールし Chromeの自動操作の環境構築手順のまとめ

Selenium WebDriverを使ってChromeを自動操作する環境を構築する手順のまとめ。使用するPythonのインストールから、サンプルスクリプトの動作確認までを詳細解説。

: Selenium WebDriver、Pythonをインストールしブラウザ自動操作の環境構築手順のまとめ

ブラウザを自動操作しテストを実行するロボットをselenium WebDriver＋Pythonの環境を構築し、動作確認までの手順のまとめ。初心者向けに詳細解説。サンプルソースも。