txtfmtテキスト装飾プラグイン #1 インストールから簡単な使い方まで
txtfmtプラグインは特別なマーカー文字をファイル中に埋め込むことで、 指定範囲の文字色や、テキストの装飾を指定できるプラグインです。 例えば、他人にコードを見せる際、プログラムコードの一部分を太字にして目立たせたり、 あるいは、プレーンなテキストに独自のハイライトを適用したり、といった使い方ができます。 (Windows, Mac)
概要
txtfmt : Syntax/Filetype plugin for formatting plain text
http://www.vim.org/scripts/script.php?script_id=2208
txtfmtプラグインは特別なマーカー文字をファイル中に埋め込むことで、
指定範囲の文字色や、テキストの装飾を指定できるプラグインです。
例えば、他人にコードを見せる際、プログラムコードの一部分を太字にして目立たせたり、
あるいは、プレーンなテキストに独自のハイライトを適用したり、といった使い方ができます。
↓ txtfmtプラグインを使うと、テキストの装飾を指定できます。
インストール方法
ファイルの配置
プラグインをインストールするには、vim.orgで 配布されているファイル をダウンロード後、
解凍ツールでダウンロードファイルを解凍し、
展開されたファイルをVimエディタの設定ファイルディレクトリにコピーしてください。
" Windows環境の場合のインストール先ディレクトリ $HOME/vimfiles/ " Mac OSX環境の場合のインストール先ディレクトリ $HOME/.vim/
" 圧縮ファイルを解凍すると、下記のようにファイルが展開されます
/---+
|
+- doc/txtfmt.txt ... docディレクトリにコピー。ディレクトリが無ければ作成し、その中にコピーする。
+- ftplugin/txtfmt.vim ... ftpluginディレクトリにコピー。ディレクトリが無ければ作成し、その中にコピーする。
+- plugin/txtfmt.vim ... pluginディレクトリにコピー。ディレクトリが無ければ作成し、その中にコピーする。
+- syntax/txtfmt.vim ... Syntaxディレクトリにコピー。ディレクトリが無ければ作成し、その中にコピーする。
|
+- indent_patch.txt ... 最新版のVimエディタを使用している場合は不要。削除して良い。
| indent.vimスクリプトへのパッチファイル。現在は本体に取り込まれている。
+- mb_patch.txt ... 最新版のtxtfmtプラグインを使用している場合は不要。削除して良い。
古いバージョンのプラグイン用のパッチファイル。
Note
次の日付以降のindent.vimであれば、indent_patch.txtパッチは取り込まれています。
確認するにはテキストエディタでindent.vimファイルを開き、
「Last Change:」の行にどの日付が設定されているか確認してください。
" Last Change: 2008 Feb 22
:helptagsコマンドの実行
txtfmtプラグインのドキュメントをコピーした「doc」ディレクトリに「:helptags」コマンドを実行します。
この作業を行うと、「:help」コマンドでtxtfmtドキュメントを検索できるようになります。
" Windows環境の場合のコマンド例 :helptags ~/vimfiles/doc
" Mac OSX環境の場合のコマンド例 :helptags ~/.vim/doc
| ファイル | URL |
|---|---|
| txtfmt_v1.3.tar.gz | http://www.vim.org/scripts/script.php?script_id=2208 |
txtfmtプラグインの基本的ワークフロー
txtfmtプラグインを使用するには、いくつかお手順を踏む必要があります。 下記は、その手順の簡単なリストです。
- ファイルタイプを「txtfmt」に設定する。
- (txtfmtプラグインの機能が読み込まれる。)
- テキストの装飾を変更したい箇所にカーソルを移動する。
- txtfmtプラグインのプロンプトを呼び出す。
- プロンプトでテキストの装飾（色、フォーマット）を指定する。
- (txtfmtプラグインのマーカー文字列が埋め込まれる。)
- (マーカー文字列の埋め込まれた位置から、独自のテキスト装飾が設定される。)
txtfmtプラグイン チュートリアル
1. ファイルタイプを「txtfmt」に設定する。
まず、ファイルタイプを「txtfmt」に変更します。
ファイルタイプを「txtfmt」に設定する方法は数種類あるのですが、このチュートリアルでは、最も簡単な方法、
直接コマンドを実行し、ファイルタイプを変更する方法を採ります。
Vimエディタでファイルを開いたら次のコマンドを実行し、ファイルタイプを「txtfmt」に設定してください。
" コマンドでファイルタイプ「txtfmt」を指定 :set filetype=txtfmt
2. txtfmtプラグインのプロンプトを呼び出す。
ファイルタイプを「txtfmt」にすると、txtfmtプラグイン独自のマーカー文字列を埋め込んだ位置以降に、
独自のテキスト装飾を適用できます。
このtxtfmtプラグイン独自のマーカー文字列を埋め込むには、txtfmtプラグインが用意するプロンプトの機能を使用します
独自のテキスト装飾を指定したい箇所にカーソルを移動して、ノーマルモードで「\i」と実行、 txtfmtプラグインのプロンプトを呼び出してください。
" txtfmtプラグインのプロンプトを呼び出す \i
3. テキスト装飾を指定する。
txtfmtプラグインのプロンプトでテキスト装飾の種類を指定すると、
カーソルのある位置に、指定した色、フォーマットを示すマーカー文字列が挿入されます。
試しに、文字色「赤」を指定してみます。
プロンプトで「cr」と入力し、「Enter」キーで確定させてください。
マーカー文字列の挿入された位置以降の文字色が「赤」色に変更されます。
" color red を指定 cr
↓ cr実行結果
次に、文字のフォーマットを指定してみます。
もう一度、txtfmtプラグインのプロンプトを表示し、今度は「fi」と入力してください。
マーカー文字列の挿入された位置以降の文字がイタリック文字に変化します。
" format italic を指定 fi
↓ fi実行結果
今見た例のように、txtfmtプラグインのプロンプトは、
「c」の後に、色を示すキーワードを指定すると、文字色を指定する、
「f」の後に、フォーマットを示すキーワードを指定すると、テキストのフォーマットを指定する、
txtfmtプラグインのマーカー文字列をカーソル位置に埋め込みます。
Note
背景色と文字色が同じ色になるので、マーカー文字列は見えません。
見えませんが、下記の画像の円の位置にマーカー文字列があります。
4. txtfmtプラグインで利用できるテキスト装飾
txtfmtプラグインで利用できるテキスト装飾は、カラーと、フォーマットの2種類あり、
カラーを設定する場合は、
c{色を示すキーワード}
と指定し、
| キーワード | 設定される色 | 説明 | 指定の仕方 |
|---|---|---|---|
| r | レッド | 文字色を赤にする | cr |
| b | ブルー | 文字色を青にする | cb |
| g | グリーン | 文字色を緑にする | cg |
フォーマットを指定する場合は、
f{フォーマットを示すキーワード}
と、txtfmtプラグインのプロンプトで指定します。
| キーワード | 設定されるテキストフォーマット | 説明 | 指定の仕方 |
|---|---|---|---|
| u | underline | 文字をアンダーラインつきにする | fu |
| b | bold | 文字をボールドにする | fb |
| i | italic | 文字をイタリックにする | fi |
表は利用できるテキスト装飾の一覧ですが、この一覧の他にも利用できる装飾はあります。
Note
残念ながら、利用しているフォントの種類によっては利用できない（指定しても有効にならない）
種類のテキスト装飾があります。
5. さらに詳しく
このページでは、txtfmtプラグインの簡単な使い方のみを紹介しました。
次ページ以降には「こういった時はどうすれば良いのか」といった内容や、
各機能の細かいオプションの説明を用意しておきましたので、興味があればご覧ください。
