本節所用命令的協助入口:
:help helptags
:help taglist.txt
使用下面的命令產生協助標籤
:helptags ~/.vim/doc
下面介紹常用的taglist配置選項,你可以根據自己的習慣進行配置:
- Tlist_Ctags_Cmd選項用於指定你的Exuberant ctags程式的位置,如果它沒在你PATH變數所定義的路徑中,需要使用此選項設定一下;
- 如果你不想同時顯示多個檔案中的tag,設定Tlist_Show_One_File為1。預設為顯示多個檔案中的tag;
- 設定Tlist_Sort_Type為”name”可以使taglist以tag名字進行排序,預設是按tag在檔案中出現的順序進行排序。按tag出現的範圍(即所屬的namespace或class)排序,已經加入taglist的TODO List,但尚未支援;
- 如果你在想taglist視窗是最後一個視窗時退出VIM,設定Tlist_Exit_OnlyWindow為1;
- 如果你想taglist視窗出現在右側,設定Tlist_Use_Right_Window為1。預設顯示在左側。
- 在gvim中,如果你想顯示taglist菜單,設定Tlist_Show_Menu為1。你可以使用Tlist_Max_Submenu_Items和Tlist_Max_Tag_Length來控制功能表條目數和所顯示tag名字的長度;
- 預設情況下,在雙擊一個tag時,才會跳到該tag定義的位置,如果你想單擊tag就跳轉,設定Tlist_Use_SingleClick為1;
- 如果你想在啟動VIM後,自動開啟taglist視窗,設定Tlist_Auto_Open為1;
- 如果你希望在選擇了tag後自動關閉taglist視窗,設定Tlist_Close_On_Select為1;
- 當同時顯示多個檔案中的tag時,設定Tlist_File_Fold_Auto_Close為1,可使taglist只顯示當前檔案tag,其它檔案的tag都被摺疊起來。
- 在使用:TlistToggle開啟taglist視窗時,如果希望輸入焦點在taglist視窗中,設定Tlist_GainFocus_On_ToggleOpen為1;
- 如果希望taglist始終解析檔案中的tag,不管taglist視窗有沒有開啟,設定Tlist_Process_File_Always為1;
- Tlist_WinHeight和Tlist_WinWidth可以設定taglist視窗的高度和寬度。Tlist_Use_Horiz_Window為1設定taglist視窗橫向顯示;
在taglist視窗中,可以使用下面的快速鍵:
<CR> 跳到游標下tag所定義的位置,用滑鼠雙擊此tag功能也一樣
o 在一個新開啟的視窗中顯示光線標下tag
<Space> 顯示光線標下tag的原型定義
u 更新taglist視窗中的tag
s 更改排序方式,在按名字排序和按出現順序排序間切換
x taglist視窗放大和縮小,方便查看較長的tag
+ 開啟一個摺疊,同zo
- 將tag摺疊起來,同zc
* 開啟所有的摺疊,同zR
= 將所有tag摺疊起來,同zM
[[ 跳到前一個檔案
]] 跳到後一個檔案
q 關閉taglist視窗
<F1> 顯示協助
可以用“:TlistOpen”開啟taglist視窗,用“:TlistClose”關閉taglist視窗。或者使用“:TlistToggle”在開啟和關閉間切換。
可以自訂快速鍵,在我的vimrc中定義了下面的映射,使用“,tl”鍵就可以開啟/關閉taglist視窗:
map <silent> <leader>tl :TlistToogle<cr>