Home

h1mesuke edited this page Oct 31, 2011 · 39 revisions
Clone this wiki locally

unite-outline

Introduction

unite-outline is a unite.vim's source which provides your Vim's buffer with the outline view. It parses the current buffer's content and extracts headings from the buffer. And then it shows the list of the headings using unite.vim's interface. When you select a heading from the list, you can jump to the corresponding location in the buffer.

The methods for extracting headings can be implemented for each individual filetypes. You can customize them as you like with Vim script and can also create new ones for unsupported filetypes.

Install

Install the distributed files into your Vim script directory which is usually ~/.vim/, or $HOME/vimfiles on Windows.

You can show the heading list of the current buffer with ":Unite outline" command if you succeeded the installation (and unite-outline supports the filetype of the buffer).

Usage

To show the heading list of the current buffer, execute :Unite command with "outline" as a source parameter.

:Unite outline

unite-outline parses the current buffer's content and extracts headings from the buffer. And then, it shows the list of the headings with unite.vim's interface. When you select a heading from the list, you can jump to the corresponding location of the buffer.

See :help unite-outline for more details.

Screenshots

C

c.png

C++

cpp.png

HTML

html.png

Java

java.png

JavaScript

javascript.png

Markdown

markdown.png

Supported also:

  • reStructuredText
  • ReVIEW
  • Textile

Perl

perl.png

PHP

php.png

Python

python.png

Ruby

ruby.png

Shell script

sh.png

Vim Help

help.png

Vim script

vim.png

And more...

Here is the list of all supported filetypes.

Message From the Author

Please send your nice outline info!

I want unite-outline to support more and more filetypes. But, creating an outline info worth of using is not easy because it requires deep knowledge of the target filetype. So, it is virtually impossible for me to create outline infos for all filetypes around the world.

If you have written an outline info for some filetype and think it is nice, please send it to me. I will bundle it to the distribution as the default outline info of the filetype.