1 Star 0 Fork 0

vimer / tagbar

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Vim

Tagbar: a class outline viewer for Vim

What Tagbar is

Tagbar is a Vim plugin that provides an easy way to browse the tags of the current file and get an overview of its structure. It does this by creating 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.

What Tagbar is not

Tagbar is not a general-purpose tool for managing tags files. It only creates the tags it needs on-the-fly in-memory without creating any files. tags file management is provided by other plugins, like for example easytags.

Dependencies

Vim 7.0 (But see note below)
Exuberant ctags 5.5

Installation

Extract the archive or clone the repository into a directory in your 'runtimepath', or use a plugin manager of your choice like pathogen. Don't forget to run :helptags if your plugin manager doesn't do it for you so you can access the documentation with :help tagbar.

Note: Vim versions < 7.0.167 have a bug that prevents Tagbar from working. If you are affected by this use this alternate Tagbar download instead: zip. It is on par with version 2.2 but probably won't be updated after that due to the amount of changes required.

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.

Quickstart

Put something like the following into your ~/.vimrc:

nmap <F8> :TagbarToggle<CR>

If you do this 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.

Support for additional filetypes

For filetypes that are not supported by Exuberant Ctags check out the wiki to see whether other projects offer support for them and how to use them. Please add any other projects/configurations that you find or create yourself so that others can benefit from them, too.

Note: If the file structure display is wrong

If you notice that there are some errors in the way your file's structure is displayed in Tagbar, please make sure that the bug is actually in Tagbar before you report an issue. Since Tagbar uses exuberant-ctags and compatible programs to do the actual file parsing, it is likely that the bug is actually in the program responsible for that filetype instead.

There is an example in :h tagbar-issues about how to run ctags manually so you can determine where the bug actually is. If the bug is actually in ctags, please report it on their website instead, as there is nothing I can do about it in Tagbar. Thank you!

You can also have a look at ctags bugs that have previously been filed against Tagbar.

Screenshots

screenshot1 screenshot2

License

Vim license, see LICENSE

Maintainer

Jan Larres <jan@majutsushi.net>

TAGBAR LICENSE This is the normal Vim license (see ':h license' in Vim) with the necessary replacements for the project and maintainer information. I) There are no restrictions on distributing unmodified copies of Tagbar except that they must include this license text. You can also distribute unmodified parts of Tagbar, likewise unrestricted except that they must include this license text. You are also allowed to include executables that you made from the unmodified Tagbar sources, plus your own usage examples and scripts. II) It is allowed to distribute a modified (or extended) version of Tagbar, including executables and/or source code, when the following four conditions are met: 1) This license text must be included unmodified. 2) The modified Tagbar must be distributed in one of the following five ways: a) If you make changes to Tagbar yourself, you must clearly describe in the distribution how to contact you. When the maintainer asks you (in any way) for a copy of the modified Tagbar you distributed, you must make your changes, including source code, available to the maintainer without fee. The maintainer reserves the right to include your changes in the official version of Tagbar. What the maintainer will do with your changes and under what license they will be distributed is negotiable. If there has been no negotiation then this license, or a later version, also applies to your changes. The current maintainer is Jan Larres <jan@majutsushi.net>. If this changes it will be announced in appropriate places (most likely majutsushi.github.io/tagbar and/or github.com/majutsushi/tagbar). When it is completely impossible to contact the maintainer, the obligation to send him your changes ceases. Once the maintainer has confirmed that he has received your changes they will not have to be sent again. b) If you have received a modified Tagbar that was distributed as mentioned under a) you are allowed to further distribute it unmodified, as mentioned at I). If you make additional changes the text under a) applies to those changes. c) Provide all the changes, including source code, with every copy of the modified Tagbar you distribute. This may be done in the form of a context diff. You can choose what license to use for new code you add. The changes and their license must not restrict others from making their own changes to the official version of Tagbar. d) When you have a modified Tagbar which includes changes as mentioned under c), you can distribute it without the source code for the changes if the following three conditions are met: - The license that applies to the changes permits you to distribute the changes to the Tagbar maintainer without fee or restriction, and permits the Tagbar maintainer to include the changes in the official version of Tagbar without fee or restriction. - You keep the changes for at least three years after last distributing the corresponding modified Tagbar. When the maintainer or someone who you distributed the modified Tagbar to asks you (in any way) for the changes within this period, you must make them available to him. - You clearly describe in the distribution how to contact you. This contact information must remain valid for at least three years after last distributing the corresponding modified Tagbar, or as long as possible. e) When the GNU General Public License (GPL) applies to the changes, you can distribute the modified Tagbar under the GNU GPL version 2 or any later version. 3) A message must be added, at least in the documentation, such that the user of the modified Tagbar is able to see that it was modified. When distributing as mentioned under 2)e) adding the message is only required for as far as this does not conflict with the license used for the changes. 4) The contact information as required under 2)a) and 2)d) must not be removed or changed, except that the person himself can make corrections. III) If you distribute a modified version of Tagbar, you are encouraged to use the Tagbar license for your changes and make them available to the maintainer, including the source code. The preferred way to do this is by e-mail or by uploading the files to a server and e-mailing the URL. If the number of changes is small (e.g., a modified Makefile) e-mailing a context diff will do. The e-mail address to be used is <jan@majutsushi.net> IV) It is not allowed to remove this license from the distribution of the Tagbar sources, parts of it or from a modified version. You may use this license for previous Tagbar releases instead of the license that they came with, at your option.

简介

暂无描述 展开 收起
Vim
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/bingxuechangyaxvimer/tagbar.git
git@gitee.com:bingxuechangyaxvimer/tagbar.git
bingxuechangyaxvimer
tagbar
tagbar
master

搜索帮助