mirror of
https://github.com/gryf/tagbar.git
synced 2026-01-07 14:44:11 +01:00
95 lines
3.2 KiB
HTML
95 lines
3.2 KiB
HTML
---
|
|
layout: default
|
|
title: Tagbar, the Vim class outline viewer
|
|
---
|
|
|
|
<a href="http://github.com/majutsushi/tagbar"><img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
|
|
|
|
<div id="container">
|
|
|
|
<h1><a href="http://github.com/majutsushi/tagbar">Tagbar</a>
|
|
<span class="small">by <a href="http://github.com/majutsushi">Jan Larres</a></span></h1>
|
|
|
|
<div class="description">
|
|
Vim plugin that displays tags in a window, ordered by class etc.
|
|
</div>
|
|
|
|
<p>
|
|
Tagbar is a vim plugin for browsing the tags of source code files. It
|
|
provides a sidebar that displays the ctags-generated tags of the
|
|
current file, ordered by their scope. This means that for example
|
|
methods in C++ are displayed under the class they are defined in.
|
|
</p>
|
|
|
|
<h2>Dependencies</h2>
|
|
<p><a href="http://www.vim.org/">Vim 7.0</a><br/>
|
|
<a href="http://ctags.sourceforge.net/">Exuberant ctags 5.5</a></p>
|
|
|
|
<h2>Install</h2>
|
|
<p>
|
|
Extract the archive or clone the repository into a directory in your
|
|
'runtimepath' or use
|
|
<a href="http://www.vim.org/scripts/script.php?script_id=2332">pathogen</a>.
|
|
Don't forget to run :helptags if you don't use pathogen.
|
|
</p>
|
|
|
|
<p>
|
|
If the ctags executable is not installed in one of the directories in
|
|
your $PATH environment variable you have to set the
|
|
g:tagbar_ctags_bin variable, see the documentation for more info.
|
|
</p>
|
|
|
|
<h2>Quickstart</h2>
|
|
<p>
|
|
Put something like the following into your ~/.vimrc:
|
|
|
|
<pre>nmap <F8> :TagbarToggle<CR></pre>
|
|
|
|
Then the F8 key will toggle the Tagbar window. You can of course use
|
|
any shortcut you want. For more flexible ways to open and close the
|
|
window (and the rest of the functionality) see the documentation.
|
|
</p>
|
|
|
|
<h2>Screenshots</h2>
|
|
<a href="tagbar1.png"><img src="tagbar1_t.png"/></a>
|
|
<a href="tagbar2.png"><img src="tagbar2_t.png"/></a>
|
|
<a href="tagbar3.png"><img src="tagbar3_t.png"/></a>
|
|
|
|
<h2>License</h2>
|
|
<p>Vim license</p>
|
|
|
|
<h2>Authors</h2>
|
|
<p>Jan Larres (jan@majutsushi.net)</p>
|
|
|
|
<h2>Download</h2>
|
|
<h3>Stable releases</h3>
|
|
|
|
{% for post in site.posts %}
|
|
|
|
<span style="font-weight:bold">{{ post.title }}</span> ({{ post.date | date:"%Y-%m-%d" }})
|
|
<a href="http://github.com/majutsushi/tagbar/zipball/v{{ post.title }}">zip</a>
|
|
<a href="http://github.com/majutsushi/tagbar/tarball/v{{ post.title }}">tar</a>
|
|
|
|
{{ post.content }}
|
|
|
|
{% endfor %}
|
|
|
|
<h3>Latest source</h3>
|
|
<p>
|
|
Download as:
|
|
<a href="http://github.com/majutsushi/tagbar/zipball/master">zip</a>
|
|
<a href="http://github.com/majutsushi/tagbar/tarball/master">tar</a>
|
|
</p>
|
|
<p>
|
|
You can also clone the project with <a href="http://git-scm.com">Git</a>
|
|
by running:
|
|
|
|
<pre>$ git clone git://github.com/majutsushi/tagbar</pre>
|
|
</p>
|
|
|
|
<div class="footer">
|
|
get the source code on GitHub : <a href="http://github.com/majutsushi/tagbar">majutsushi/tagbar</a>
|
|
</div>
|
|
|
|
</div>
|