From a445af5bf4193e5b78f97ab25cf8f40b5a81fa11 Mon Sep 17 00:00:00 2001 From: jez Date: Wed, 16 Mar 2011 16:43:12 -0400 Subject: [PATCH] Update README, docs, and comments. Rename files. --- README | 18 ------- README.md | 9 ++++ doc/{taglist.txt => taglist-plus.txt} | 59 +++++++++-------------- doc/tags | 61 ++++++++++++++++++++++++ plugin/{taglist.vim => taglist-plus.vim} | 30 ++++-------- 5 files changed, 101 insertions(+), 76 deletions(-) delete mode 100644 README create mode 100644 README.md rename doc/{taglist.txt => taglist-plus.txt} (98%) create mode 100644 doc/tags rename plugin/{taglist.vim => taglist-plus.vim} (99%) diff --git a/README b/README deleted file mode 100644 index 56bf86f..0000000 --- a/README +++ /dev/null @@ -1,18 +0,0 @@ -This is a mirror of http://www.vim.org/scripts/script.php?script_id=273 - -The "Tag List" plugin is a source code browser plugin for Vim and -provides an overview of the structure of source code files and allows -you to efficiently browse through source code files for different -programming languages. You can visit the taglist plugin home page for -more information: - - http://vim-taglist.sourceforge.net - -You can subscribe to the taglist mailing list to post your questions -or suggestions for improvement or to report bugs. Visit the following -page for subscribing to the mailing list: - - http://groups.yahoo.com/group/taglist/ - -For more information about using this plugin, after installing the -taglist plugin, use the ":help taglist" command. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f8506ce --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +taglist-plus.vim +================ + +This is a fork of the popular taglist.vim plugin. + +Taglist-plus supports jsctags for excellent Javascript tagging. See [here][1] +for examples. + +[1]:http://discontinuously.com/2011/03/vim-support-javascript-taglist-plus/ diff --git a/doc/taglist.txt b/doc/taglist-plus.txt similarity index 98% rename from doc/taglist.txt rename to doc/taglist-plus.txt index 32fdcae..21f9365 100644 --- a/doc/taglist.txt +++ b/doc/taglist-plus.txt @@ -1,21 +1,20 @@ -*taglist.txt* Plugin for browsing source code +*taglist-plus.txt* Plugin for browsing source code Author: Yegappan Lakshmanan (yegappan AT yahoo DOT com) +Modified By: Jezreel Ng (jezreel AT gmail DOT com) For Vim version 6.0 and above -Last change: 2007 May 24 1. Overview |taglist-intro| -2. Taglist on the internet |taglist-internet| -3. Requirements |taglist-requirements| -4. Installation |taglist-install| -5. Usage |taglist-using| -6. Options |taglist-options| -7. Commands |taglist-commands| -8. Global functions |taglist-functions| -9. Extending |taglist-extend| -10. FAQ |taglist-faq| -11. License |taglist-license| -12. Todo |taglist-todo| +2. Requirements |taglist-requirements| +3. Installation |taglist-install| +4. Usage |taglist-using| +5. Options |taglist-options| +6. Commands |taglist-commands| +7. Global functions |taglist-functions| +8. Extending |taglist-extend| +9. FAQ |taglist-faq| +10. License |taglist-license| +11. Todo |taglist-todo| ============================================================================== *taglist-intro* @@ -58,23 +57,9 @@ programming languages. The "Tag List" plugin provides the following features: taglist plugin at the same time like an IDE. * Can be used in both Unix and MS-Windows systems. -============================================================================== - *taglist-internet* -2. Taglist on the internet~ - -The home page of the taglist plugin is at: -> - http://vim-taglist.sourceforge.net/ -< -You can subscribe to the taglist mailing list to post your questions or -suggestions for improvement or to send bug reports. Visit the following page -for subscribing to the mailing list: -> - http://groups.yahoo.com/group/taglist -< ============================================================================== *taglist-requirements* -3. Requirements~ +2. Requirements~ The taglist plugin requires the following: @@ -113,7 +98,7 @@ Vim without the system() function for security reasons. ============================================================================== *taglist-install* -4. Installation~ +3. Installation~ 1. Download the taglist.zip file and unzip the files to the $HOME/.vim or the $HOME/vimfiles or the $VIM/vimfiles directory. After this step, you should @@ -145,7 +130,7 @@ doc/taglist.txt files from the $HOME/.vim or $HOME/vimfiles directory. ============================================================================== *taglist-using* -5. Usage~ +4. Usage~ The taglist plugin can be used in several different ways. @@ -632,7 +617,7 @@ characters from the debug messages are stored. ============================================================================== *taglist-options* -6. Options~ +5. Options~ A number of Vim variables control the behavior of the taglist plugin. These variables are initialized to a default value. By changing these variables you @@ -984,7 +969,7 @@ specified by the 'Tlist_WinWidth' variable. ============================================================================== *taglist-commands* -7. Commands~ +6. Commands~ The taglist plugin provides the following ex-mode commands: @@ -1141,7 +1126,7 @@ The taglist plugin provides the following ex-mode commands: ============================================================================== *taglist-functions* -8. Global functions~ +7. Global functions~ The taglist plugin provides several global functions that can be used from other Vim plugins to interact with the taglist plugin. These functions are @@ -1195,7 +1180,7 @@ Tlist_Set_App({appname}) ============================================================================== *taglist-extend* -9. Extending~ +8. Extending~ The taglist plugin supports all the languages supported by the exuberant ctags tool, which includes the following languages: Assembly, ASP, Awk, Beta, C, @@ -1303,7 +1288,7 @@ are generated for the flags b, c and l respectively. ============================================================================== *taglist-faq* -10. Frequently Asked Questions~ +9. Frequently Asked Questions~ Q. The taglist plugin doesn't work. The taglist window is empty and the tags defined in a file are not displayed. @@ -1476,7 +1461,7 @@ A. The taglist plugin uses the |CursorHold| autocmd to highlight the current ============================================================================== *taglist-license* -11. License~ +10. License~ Permission is hereby granted to use and distribute the taglist plugin, with or without modifications, provided that this copyright notice is copied with it. Like anything else that's free, taglist.vim is provided *as is* and comes with @@ -1486,7 +1471,7 @@ software. ============================================================================== *taglist-todo* -12. Todo~ +11. Todo~ 1. Group tags according to the scope and display them. For example, group all the tags belonging to a C++/Java class diff --git a/doc/tags b/doc/tags new file mode 100644 index 0000000..fa1a989 --- /dev/null +++ b/doc/tags @@ -0,0 +1,61 @@ +'Tlist_Auto_Highlight_Tag' taglist-plus.txt /*'Tlist_Auto_Highlight_Tag'* +'Tlist_Auto_Open' taglist-plus.txt /*'Tlist_Auto_Open'* +'Tlist_Auto_Update' taglist-plus.txt /*'Tlist_Auto_Update'* +'Tlist_Close_On_Select' taglist-plus.txt /*'Tlist_Close_On_Select'* +'Tlist_Compact_Format' taglist-plus.txt /*'Tlist_Compact_Format'* +'Tlist_Ctags_Cmd' taglist-plus.txt /*'Tlist_Ctags_Cmd'* +'Tlist_Display_Prototype' taglist-plus.txt /*'Tlist_Display_Prototype'* +'Tlist_Display_Tag_Scope' taglist-plus.txt /*'Tlist_Display_Tag_Scope'* +'Tlist_Enable_Fold_Column' taglist-plus.txt /*'Tlist_Enable_Fold_Column'* +'Tlist_Exit_OnlyWindow' taglist-plus.txt /*'Tlist_Exit_OnlyWindow'* +'Tlist_File_Fold_Auto_Close' taglist-plus.txt /*'Tlist_File_Fold_Auto_Close'* +'Tlist_GainFocus_On_ToggleOpen' taglist-plus.txt /*'Tlist_GainFocus_On_ToggleOpen'* +'Tlist_Highlight_Tag_On_BufEnter' taglist-plus.txt /*'Tlist_Highlight_Tag_On_BufEnter'* +'Tlist_Inc_Winwidth' taglist-plus.txt /*'Tlist_Inc_Winwidth'* +'Tlist_Max_Submenu_Items' taglist-plus.txt /*'Tlist_Max_Submenu_Items'* +'Tlist_Max_Tag_Length' taglist-plus.txt /*'Tlist_Max_Tag_Length'* +'Tlist_Process_File_Always' taglist-plus.txt /*'Tlist_Process_File_Always'* +'Tlist_Show_Menu' taglist-plus.txt /*'Tlist_Show_Menu'* +'Tlist_Show_One_File' taglist-plus.txt /*'Tlist_Show_One_File'* +'Tlist_Sort_Type' taglist-plus.txt /*'Tlist_Sort_Type'* +'Tlist_Use_Horiz_Window' taglist-plus.txt /*'Tlist_Use_Horiz_Window'* +'Tlist_Use_Right_Window' taglist-plus.txt /*'Tlist_Use_Right_Window'* +'Tlist_Use_SingleClick' taglist-plus.txt /*'Tlist_Use_SingleClick'* +'Tlist_WinHeight' taglist-plus.txt /*'Tlist_WinHeight'* +'Tlist_WinWidth' taglist-plus.txt /*'Tlist_WinWidth'* +:TlistAddFiles taglist-plus.txt /*:TlistAddFiles* +:TlistAddFilesRecursive taglist-plus.txt /*:TlistAddFilesRecursive* +:TlistClose taglist-plus.txt /*:TlistClose* +:TlistDebug taglist-plus.txt /*:TlistDebug* +:TlistHighlightTag taglist-plus.txt /*:TlistHighlightTag* +:TlistLock taglist-plus.txt /*:TlistLock* +:TlistMessages taglist-plus.txt /*:TlistMessages* +:TlistOpen taglist-plus.txt /*:TlistOpen* +:TlistSessionLoad taglist-plus.txt /*:TlistSessionLoad* +:TlistSessionSave taglist-plus.txt /*:TlistSessionSave* +:TlistShowPrototype taglist-plus.txt /*:TlistShowPrototype* +:TlistShowTag taglist-plus.txt /*:TlistShowTag* +:TlistToggle taglist-plus.txt /*:TlistToggle* +:TlistUndebug taglist-plus.txt /*:TlistUndebug* +:TlistUnlock taglist-plus.txt /*:TlistUnlock* +:TlistUpdate taglist-plus.txt /*:TlistUpdate* +Tlist_Get_Tag_Prototype_By_Line() taglist-plus.txt /*Tlist_Get_Tag_Prototype_By_Line()* +Tlist_Get_Tagname_By_Line() taglist-plus.txt /*Tlist_Get_Tagname_By_Line()* +Tlist_Set_App() taglist-plus.txt /*Tlist_Set_App()* +Tlist_Update_File_Tags() taglist-plus.txt /*Tlist_Update_File_Tags()* +taglist-commands taglist-plus.txt /*taglist-commands* +taglist-debug taglist-plus.txt /*taglist-debug* +taglist-extend taglist-plus.txt /*taglist-extend* +taglist-faq taglist-plus.txt /*taglist-faq* +taglist-functions taglist-plus.txt /*taglist-functions* +taglist-install taglist-plus.txt /*taglist-install* +taglist-intro taglist-plus.txt /*taglist-intro* +taglist-keys taglist-plus.txt /*taglist-keys* +taglist-license taglist-plus.txt /*taglist-license* +taglist-menu taglist-plus.txt /*taglist-menu* +taglist-options taglist-plus.txt /*taglist-options* +taglist-plus.txt taglist-plus.txt /*taglist-plus.txt* +taglist-requirements taglist-plus.txt /*taglist-requirements* +taglist-session taglist-plus.txt /*taglist-session* +taglist-todo taglist-plus.txt /*taglist-todo* +taglist-using taglist-plus.txt /*taglist-using* diff --git a/plugin/taglist.vim b/plugin/taglist-plus.vim similarity index 99% rename from plugin/taglist.vim rename to plugin/taglist-plus.vim index 2a6a6ff..7703828 100644 --- a/plugin/taglist.vim +++ b/plugin/taglist-plus.vim @@ -1,8 +1,10 @@ -" File: taglist.vim -" Author: Yegappan Lakshmanan (yegappan AT yahoo DOT com) -" Version: 4.5 -" Last Modified: September 21, 2007 -" Copyright: Copyright (C) 2002-2007 Yegappan Lakshmanan +" File: taglist-plus.vim +" Authors: Jezreel Ng (jezreel AT gmail DOT com) +" Yegappan Lakshmanan (yegappan AT yahoo DOT com) +" Version: 1.0 + "Last Modified: March 16, 2011 + "Copyright: Copyright (C) 2011 Jezeel Ng +" Copyright (C) 2002-2007 Yegappan Lakshmanan " Permission is hereby granted to use and distribute this code, " with or without modifications, provided that this copyright " notice is copied with it. Like anything else that's free, @@ -11,20 +13,6 @@ " holder be liable for any damamges resulting from the use of this " software. " -" The "Tag List" plugin is a source code browser plugin for Vim and provides -" an overview of the structure of the programming language files and allows -" you to efficiently browse through source code files for different -" programming languages. You can visit the taglist plugin home page for more -" information: -" -" http://vim-taglist.sourceforge.net -" -" You can subscribe to the taglist mailing list to post your questions -" or suggestions for improvement or to report bugs. Visit the following -" page for subscribing to the mailing list: -" -" http://groups.yahoo.com/group/taglist/ -" " For more information about using this plugin, after installing the " taglist plugin, use the ":help taglist" command. " @@ -35,8 +23,8 @@ " unzip the following two files (the directory structure should be " preserved): " -" plugin/taglist.vim - main taglist plugin file -" doc/taglist.txt - documentation (help) file +" plugin/taglist-plus.vim - main taglist plugin file +" doc/taglist-plus.txt - documentation (help) file " " Refer to the 'add-plugin', 'add-global-plugin' and 'runtimepath' " Vim help pages for more details about installing Vim plugins.