Highlightのプラグインの詳細

Highlight のサイトマップ

• GUI編
• コマンド編
• プラグインの詳細　※ココ
• 日本語の翻訳ファイルの作成

　

概要

ソースコードに色付けなどの強調表示を施すHighlight専用のプラグインです。

Highlight アプリケーションに無い機能を追加したり、作成された強調表示に更に驚く効果を追加したりする事が可能になります。

※WordPressやSNS等のプラグインとは全く関係無いです！

　

目次

• Highlightのサイトマップ
• 概要
• 目次　※ココ
• 使用例
• お知らせ
• Pluginの説明
  1. asciidoc_html_add_links
  2. bash_functions
  3. bash_ref_man7_org
  4. comment_links
  5. cpp_qt
  6. cpp_ref_cplusplus_com
  7. cpp_ref_gtk_gnome_org
  8. cpp_ref_local_includes
  9. cpp_ref_qtproject_org
  10. cpp_ref_wxwidgets_org
  11. cpp_syslog
  12. cpp_wx
  13. ctags_html_tooltips
  14. java_library
  15. keywords_capitalize
  16. keywords_lowercase
  17. keywords_uppercase
  18. latex_single_outfile
  19. mark_lines
  20. outhtml_add_background_stripes
  21. outhtml_add_background_svg
  22. outhtml_add_figure
  23. outhtml_add_line
  24. outhtml_add_shadow
  25. outhtml_codefold
  26. outhtml_curly_brackets_matcher
  27. outhtml_ie7_webctrl
  28. outhtml_keyword_matcher
  29. outhtml_ligature_fonts
  30. outhtml_modern_fonts
  31. outhtml_parantheses_matcher
  32. outhtml_tooltips
  33. perl_ref_perl_org
  34. python_ref_python_org
  35. reduce_filesize
  36. scala_ref_scala_lang_org
  37. terminal_add_info
  38. theme_invert
  39. token_add_state_ids
  40. outhtml_not_select_line_numbers
• プラグインのカスタマイズ

　

使用例

先によく使うと予測される機能をいくつか紹介します。

例１：指定の行をマークする

特定の行を強調表示します。例：45 , 52 , 54 をマーク

例２：行に横の縞模様を入れる

１行ごとに横の縞（しま）模様を入れます。

例３：色を反転する

テーマで設定された色を全て反転します。

例４：コードの周囲に影付きの枠をつける

ファイル出力時にソースコードの周囲に影付きの枠を表示します。

　
目次へ戻る

お知らせ

プラグイン使用時の注意事項です。

• 結果がプレビューのパネルに表示されるとは限りません。出力ファイルのみに反映される場合も有ります。
• プラグインが機能してないと思われる時は「CSSのクラスの接頭語」を空にしてください。空の時はデフォルトの hl が適用されます。

　
目次へ戻る

PlugIn の説明

１．asciidoc_html_add_links

AsciiDocファイルにハイパーリンクを追加します。

メモ：AsciiDocファイルの拡張子は .adoc

２．bash_functions

キーワードリストに関数名を追加して、後で括弧なしでそれらを認識できるようにします。

３．bash_ref_man7_org

BashスクリプトのHTML、LaTeX、RTFおよびODT出力時に、man7.orgリンクを追加します。

４．comment_links

コメント内のURLをHTML、LaTeX、ODT、RTF出力時に、クリック可能なハイパーリンクに変更します。

５．cpp_qt

カラーテーマのC++構文の説明とそれに対応する書式にQtキーワードを追加します。

６．cpp_ref_cplusplus_com

CおよびC ++コードのHTML、LaTeX、RTFおよびODT出力時に、cplusplus.comリンクを追加します。

７．cpp_ref_gtk_gnome_org

C++ GTKコードのHTML、LeTeX、RTFおよびODT出力時に、developer.gnome.orgリンクを追加してください。

８．cpp_ref_local_includes

HTML、LaTeX、RTF、およびODT出力時に、CまたはC++ヘッダーへの参照リンクを追加します。必要に応じてプラグインスクリプトでbase_urlを設定します。

９．cpp_ref_qtproject_org

C++コードのHTML、LaTeX、RTFおよびODT出力時に、doc.qt.ioリンクを追加します。

１０．cpp_ref_wxwidgets_org

C++コードのHTML、LaTeX、RTFまたはODT出力時に、wxwidgets.orgリンクを追加します。

１１．cpp_syslog

syslogおよびカーネルログレベルをCおよびC++キーワードに追加します。

使い方メモ：highlight -I main.cpp –plug-in=plugin.lua.

１２．cpp_wx

CおよびC++のキーワードにwxWidgetsクラス名を追加します。

使い方メモ：highlight -I main.cpp –plug-in=plugin.lua

１３．ctags_html_tooltips

ctagsファイル（デフォルトの入力ファイル：tags）に基づいてツールチップを追加します。

１４．java_library

標準ライブラリクラス名をJava定義に追加します。

使い方メモ：highlight -I main.java –plug-in=plugin.lua

１５．keywords_capitalize

構文で大文字と小文字が区別されない場合は、キーワードを大文字にします。

※ keywords_uppercase.lua と一行処理が異なるだけで、違いは不明。

１６．keywords_lowercase

構文で大文字と小文字が区別されない場合は、キーワードを小文字に変換します。

１７．keywords_uppercase

構文で大文字と小文字が区別されない場合は、キーワードを大文字に変換します。

１８．latex_single_outfile

後で結果を連結するために各LaTeX出力ファイルにセクションを挿入します。

１９．mark_lines

プラグインパラメータでカンマ区切りリストとして定義された行をマークします（HTMLおよびRTFのみ）。

以下はプラグインのパラメータに「45,52,54」を設定した時です。

行の範囲指定は出来ません。１行単位で指定します。

２０．outhtml_add_background_stripes

HTML出力時に背景に横の縞（しま）模様を追加します。

２１．outhtml_add_background_svg

HTML出力時に背景に方眼紙パターンを追加します。幅はプラグインファイル（outhtml_add_background_svg.lua）内のパラメータ（gridsize）で変更可能です。

２２．outhtml_add_figure

HTML出力時にfigureとfigcaptureを追加します。キャプチャをプラグインパラメータとして定義します。

２３．outhtml_add_line

HTML出力時にコードボックスの左側にラインを追加します。

２４．outhtml_add_shadow

HTML出力時にコードボックスに影と余白を追加した枠を表示します（明るいテーマ用）。

２５．outhtml_codefold

Cスタイル言語、Pascal、Lua、Rubyなどのコードの折りたたみをHTML出力時に追加します（インラインCSSまたは順序付きリスト出力とは互換性がありません）。

２６．outhtml_curly_brackets_matcher

HTML出力時に一致する中括弧を強調表示します。その中括弧をマウスでクリックすると、ペアの中括弧は黄色に変化します。

CSSが有効になっている（つまり、インラインCSSが設定されていない）と想定します。

２７．outhtml_ie7_webctrl

HTML出力時に、旧のMS Webコントロールに適応させます。

２８．outhtml_keyword_matcher

HTML出力時に、一致するキーワードを表示します。 キーワードグループをプラグインパラメータとして定義します。

※動作確認できない。version 3.50

２９．outhtml_ligature_fonts

HTML出力時に合字フォントを追加します。

追加フォント名：Monoid , Fira Code , DejaVu Sans Code , monospace

合字(ごうじ)：複数の文字を合成して一文字にしたもの

３０．outhtml_modern_fonts

HTML出力時に等幅フォントを追加します。

追加フォント名：Consolas , Monaco , Andale Mono , Ubuntu Mono , monospace

３１．outhtml_parantheses_matcher

HTML出力時にペアの括弧と中括弧を強調表示します。括弧をクリックするとペアの括弧が黄色に変化します。

CSSが有効になっている（つまり、インラインCSSが設定されていない）と想定します。

３２．outhtml_tooltips

丸数字にリンクされたコメント内にHTMLツールチップを追加します（@tip [tooltip text]の形式）。

３３．perl_ref_perl_org

PerlコードのHTML、LaTeX、RTFおよびODT出力時に、perldoc.perl.orgリンクを追加します。

３４．python_ref_python_org

PythonコードのHTML、LaTeX、RTFおよびODT出力時に、python.orgリンクを追加します。

３５．reduce_filesize

数値と演算子を無視して、出力ファイルのサイズを小さくします。

３６．scala_ref_scala_lang_org

ScalaコードのHTML、LaTeX、RTFおよびODT出力時に、scala-lang.orgリンクを追加します。

３７．terminal_add_info

端末出力（ansi、xterm、truecolor）にファイル情報を追加します。

３８．theme_invert

テーマの色を全て反転します。

使い方メモ： highlight -I main.cpp –plug-in=plugin.lua.

３９．token_add_state_ids

各トークンの後ろに内部状態IDを追加します（デバッグ用）。

４０．outhtml_not_select_line_numbers

HTML出力時に、行番号をマウスやキーボードで選択できないようにします。

• CSSの「.hl.lin { -ms-user-select: none; -moz-user-select: -moz-none; -khtml-user-select: none; -webkit-user-select: none; user-select: none; }」を追加します。
• これは当サイトが独自に作成したプラグインです。公式サイトには有りません。コチラのダウンロードファイルに含まれています。
• 「CSSのクラスの接頭語」は空または hl にして下さい。

　
目次へ戻る

プラグインのカスタマイズ

プラグインのファイル内容を変更して使用する上での注意事項等です。

• プラグインのファイルは UTF-8 の BOM無し で保存します。
• 別名でファイルを登録する時に、ファイル名に日本語を使用すると実行エラーになります。
• プラグインで日本語（２バイト文字）を使用には注意が必要です。対応してない場合が有ります。
• 実行エラーのメッセージが出るとは限りません。

　
目次へ戻る