Home

#unite-outline

==============================================================================
概要						*unite-outline-introduction*

*unite-outline* は、ファイルの見出しを抽出し、|unite| のインターフェースを使って
それらを一覧表示、各見出しへのジャンプ機能を提供する source です。見出しを抽出
するためのパターンおよび見出しレベルの決定ロジックをファイルタイプごとに設定す
ることができ、ユーザーによる高度なカスタマイズが可能です。

==============================================================================
インストール					*unite-outline-install*

配布アーカイブに含まれるファイル群を、そのフォルダごと Vim の 'runtimepath' に
コピーします。 $HOME/.vim（Windows の場合は $HOME/vimfiles）へのインストールが
もっとも一般的でしょう。その場合コピー後の配置は

	$HOME/.vim/autoload/unite/sources/outline.vim
	$HOME/.vim/autoload/unite/sources/outline
	$HOME/.vim/doc/unite-outline.jax

になります。

インストールに成功すると :Unite outline でファイルの見出し一覧を表示できます。
（そのファイルタイプ用の outline info が存在する場合）

詳細は同梱のヘルプを参照して下さい。

##スクリーンショット

###Ruby

###VimScript

ToDo

==============================================================================
TODO						*unite-outline-todo*

* 対応ファイルタイプの充実
* 英語ヘルプ

対応ファイルタイプの充実はぼちぼちやっていこうと考えていますが、

あるファイルタイプにおける妥当な見出し抽出を実現するには、そのファイルタイプに
対する知見がどうしても必要なため、自分が普段使っていない言語については対応が後
手にまわっています。

そこで↓

------------------------------------------------------------------------------
outline info 募集！

デフォルトの outline info が用意されていないファイルタイプについて、もし
outline info を書かれた方がおられたら、ぜひとも作者までお寄せ下さい。

デフォルトの outline info を書くときに参考に（もしくはそのまま採用）させていた
だきます。

	* Issues - h1mesuke/unite-outline - GitHub
	  https://github.com/h1mesuke/unite-outline/issues
	
	* Send a pull request - GitHub
	  https://github.com/h1mesuke/unite-outline/pull/new/master