ylib/tagbar
1
0
Fork 0
mirror of https://github.com/preservim/tagbar.git synced 2025-02-15 05:53:00 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Align help tags better

Browse Source
This commit is contained in:
Jan Larres 2012-02-29 00:33:27 +13:00
parent d9857cf204
commit c18599234e
1 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
doc/tagbar.txt
View File

@ -6,7 +6,7 @@ Homepage: http://majutsushi.github.com/tagbar/
Version: 2.3
==============================================================================
Contents *tagbar* *tagbar-contents*
Contents *tagbar* *tagbar-contents*
1. Intro ........................... |tagbar-intro|
Pseudo-tags ................... |tagbar-pseudotags|
@ -28,7 +28,7 @@ Contents *tagbar* *tagbar-contents*
10. Credits ......................... |tagbar-credits|
==============================================================================
1. Intro *tagbar-intro*
1. Intro *tagbar-intro*
Tagbar is a 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
@ -65,7 +65,7 @@ listed after its name and a colon. Third, tags for which the access/visibility
information is known are prefixed with a symbol indicating that.
------------------------------------------------------------------------------
PSEUDO-TAGS *tagbar-pseudotags*
PSEUDO-TAGS *tagbar-pseudotags*
The example also introduces the concept of "pseudo-tags". Pseudo-tags are tags
that are not explicitly defined in the file but have children in it. In this
@ -84,7 +84,7 @@ window.
Pseudo-tags are denoted with an asterisk ('*') at the end of their name.
------------------------------------------------------------------------------
SUPPORTED FEATURES *tagbar-features*
SUPPORTED FEATURES *tagbar-features*
The following features are supported by Tagbar:
@ -105,7 +105,7 @@ The following features are supported by Tagbar:
- Can be extended to support arbitrary new types.
------------------------------------------------------------------------------
OTHER CTAGS-COMPATIBLE PROGRAMS *tagbar-other*
OTHER CTAGS-COMPATIBLE PROGRAMS *tagbar-other*
Tagbar theoretically also supports filetype-specific programs that can output
tag information that is compatible with ctags. However due to potential
@ -117,7 +117,7 @@ correct configuration please contact me.
Note: Please check |tagbar-issues| for some possible issues with jsctags.
==============================================================================
2. Requirements *tagbar-requirements*
2. Requirements *tagbar-requirements*
The following requirements have to be met in order to be able to use tagbar:
@ -144,7 +144,7 @@ The following requirements have to be met in order to be able to use tagbar:
- Tagbar will not work in |restricted-mode| or with 'compatible' set.
==============================================================================
3. Installation *tagbar-installation*
3. Installation *tagbar-installation*
Use the normal Vimball install method for installing tagbar.vba:
>
@ -161,7 +161,7 @@ $PATH environment variable you have to set the g:tagbar_ctags_bin variable,
see |g:tagbar_ctags_bin|.
==============================================================================
4. Usage *tagbar-usage*
4. Usage *tagbar-usage*
There are essentially two ways to use Tagbar:
@ -224,7 +224,7 @@ case it will be displayed in a pop-up window. The prototype will also be
displayed when the cursor stays on a tag for 'updatetime' milliseconds.
------------------------------------------------------------------------------
COMMANDS *tagbar-commands*
COMMANDS *tagbar-commands*
:TagbarOpen [{flags}]
Open the Tagbar window if it is closed.
@ -270,7 +270,7 @@ COMMANDS *tagbar-commands*
End debug mode, debug messages will no longer be written to the logfile.
------------------------------------------------------------------------------
KEY MAPPINGS *tagbar-keys*
KEY MAPPINGS *tagbar-keys*
The following mappings are valid in the Tagbar window:
@ -298,9 +298,9 @@ x Toggle zooming the window.
q Close the Tagbar window.
==============================================================================
5. Configuration *tagbar-configuration*
5. Configuration *tagbar-configuration*
*g:tagbar_ctags_bin*
*g:tagbar_ctags_bin*
g:tagbar_ctags_bin~
Default: empty
@ -312,7 +312,7 @@ Example:
let g:tagbar_ctags_bin = 'C:\Ctags5.8\ctags.exe'
<
*g:tagbar_left*
*g:tagbar_left*
g:tagbar_left~
Default: 0
@ -324,7 +324,7 @@ Example:
let g:tagbar_left = 1
<
*g:tagbar_width*
*g:tagbar_width*
g:tagbar_width~
Default: 40
@ -335,7 +335,7 @@ Example:
let g:tagbar_width = 30
<
*g:tagbar_autoclose*
*g:tagbar_autoclose*
g:tagbar_autoclose~
Default: 0
@ -347,7 +347,7 @@ Example:
let g:tagbar_autoclose = 1
<
*g:tagbar_autofocus*
*g:tagbar_autofocus*
g:tagbar_autofocus~
Default: 0
@ -359,7 +359,7 @@ Example:
let g:tagbar_autofocus = 1
<
*g:tagbar_sort*
*g:tagbar_sort*
g:tagbar_sort~
Default: 1
@ -373,7 +373,7 @@ Example:
let g:tagbar_sort = 0
<
*g:tagbar_compact*
*g:tagbar_compact*
g:tagbar_compact~
Default: 0
@ -386,7 +386,7 @@ Example:
let g:tagbar_compact = 1
<
*g:tagbar_expand*
*g:tagbar_expand*
g:tagbar_expand~
Default: 0
@ -398,7 +398,7 @@ Example:
let g:tagbar_expand = 1
<
*g:tagbar_singleclick*
*g:tagbar_singleclick*
g:tagbar_singleclick~
Default: 0
@ -410,7 +410,7 @@ Example:
let g:tagbar_singleclick = 1
<
*g:tagbar_foldlevel*
*g:tagbar_foldlevel*
g:tagbar_foldlevel~
Default: 99
@ -422,7 +422,7 @@ Example:
let g:tagbar_foldlevel = 2
<
*g:tagbar_iconchars*
*g:tagbar_iconchars*
g:tagbar_iconchars~
Since the display of the icons used to indicate open or closed folds depends
@ -440,7 +440,7 @@ choose other characters in that case):
let g:tagbar_iconchars = ['+', '-'] (default on Windows)
<
*g:tagbar_autoshowtag*
*g:tagbar_autoshowtag*
g:tagbar_autoshowtag~
Default: 0
@ -455,7 +455,7 @@ Example:
let g:tagbar_autoshowtag = 1
<
*g:tagbar_updateonsave_maxlines*
*g:tagbar_updateonsave_maxlines*
g:tagbar_updateonsave_maxlines~
Default: 5000
@ -471,7 +471,7 @@ Example:
let g:tagbar_updateonsave_maxlines = 10000
<
*g:tagbar_systemenc*
*g:tagbar_systemenc*
g:tagbar_systemenc~
Default: value of 'encoding'
@ -487,7 +487,7 @@ Example:
<
------------------------------------------------------------------------------
HIGHLIGHT COLOURS *tagbar-highlight*
HIGHLIGHT COLOURS *tagbar-highlight*
All of the colours used by Tagbar can be customized. Here is a list of the
highlight groups that are defined by Tagbar:
@ -536,7 +536,7 @@ your vimrc:
See |:highlight| for more information.
------------------------------------------------------------------------------
AUTOMATICALLY OPENING TAGBAR *tagbar-autoopen*
AUTOMATICALLY OPENING TAGBAR *tagbar-autoopen*
Since there are several different situations in which you might want to open
Tagbar automatically there is no single option to enable automatic opening.
@ -579,7 +579,7 @@ Check out |autocmd.txt| if you want it to open automatically in more
complicated cases.
------------------------------------------------------------------------------
SHOWING THE CURRENT TAG IN THE STATUSLINE *tagbar-statusline*
SHOWING THE CURRENT TAG IN THE STATUSLINE *tagbar-statusline*
You can show the current tag in the 'statusline', or in any other place that
you want to, by calling the tagbar#currenttag() function. The current tag is
@ -603,7 +603,7 @@ tagbar#currenttag({format}, {default} [, {longsig}])
< then the function "myfunc" will be show as "[myfunc()] ".
==============================================================================
6. Extending Tagbar *tagbar-extend*
6. Extending Tagbar *tagbar-extend*
Tagbar has a flexible mechanism for extending the existing file type (i.e.
language) definitions. This can be used both to change the settings of the
@ -878,7 +878,7 @@ Tagbar should now be able to show the sections and other tags from LaTeX
files.
==============================================================================
7. Troubleshooting & Known issues *tagbar-issues*
7. Troubleshooting & Known issues *tagbar-issues*
As a general rule, if the tag information displayed by Tagbar is wrong (for
example, a method doesn't show up or is in the wrong place) you should first
@ -948,7 +948,7 @@ file.
are no problem, though.
==============================================================================
8. History *tagbar-history*
8. History *tagbar-history*
2.3 (2011-12-24)
- Add a convenience function that allows more flexible ways to
@ -1031,7 +1031,7 @@ file.
- Initial release
==============================================================================
9. Todo *tagbar-todo*
9. Todo *tagbar-todo*
- Allow filtering the Tagbar content by some criteria like tag name,
visibility, kind ...
@ -1040,7 +1040,7 @@ file.
- Allow jumping to a tag in the preview window, a split window or a new tab.
==============================================================================
10. Credits *tagbar-credits*
10. Credits *tagbar-credits*
Tagbar was written by Jan Larres and is released under the Vim licence, see
|license|. It was heavily inspired by the Taglist plugin by Yegappan