Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Update readme.

  • Loading branch information...
commit 8775e0faa001fec78b255e55b20ee8d4e207c5ea 1 parent c8a3292
Federico Holgado authored October 20, 2011

Showing 2 changed files with 184 additions and 58 deletions. Show diff stats Hide diff stats

  1. 58  README
  2. 184  readme.markdown
58  README
... ...
@@ -1,58 +0,0 @@
1  
-This is an updated and modified version of the script available here: http://www.vim.org/scripts/script.php?script_id=159
2  
-
3  
-[6.4.1] 1/6/2011 - Added patches by Danielle Church to sort the MBE window by most recently used buffers. Added patches by Stephan Sokolow to close MBE on buffer select.
4  
-
5  
-[6.4.0] 1/1/2011 - Added Emacs-like 'uniquify' feature where MBE will show a parent directory when there are 2 buffers with the same filename.
6  
-
7  
-i.e. There are 2 buffers with the same filename:
8  
-/ProjectA/Application/CSS/style.css
9  
-/ProjectB/Applications/CSS/style.css
10  
-
11  
-Originally, MBE would just display 'style.css' for both buffers. Now, MBE crawls up the directory tree to find the first differentiating parent directory for both buffers, s MBE will show:
12  
-
13  
-ProjectA/style.css
14  
-ProjectB/style.css
15  
-
16  
-- Now sets winfixheight and winfixwidth for the MBE buffer so that it does not get resized automatically by window resizing commands such as 'CTRL W='.
17  
-
18  
-[6.3.7] 12/19/2010 - MBE now uses it's own custom statusline format to reduce visual clutter. (By Federico Holgado)
19  
-
20  
-[6.3.6] 12/16/2010 - Added behavior to reflect buffer highlighting states automatically on buffer change and buffer save. This corrects previous behavior where MBE was only updated after entering another buffer and it would be marked as modified even though the buffer was just saved. (By Federico Holgado)
21  
-
22  
-[6.3.5] 12/12/2010 - Added two more states for buffer names to the included possible states to reflect the current buffer that is active. These states can be targeted by the following syntax: (By Federico Holgado)
23  
-
24  
-	MBEVisibleActive
25  
-	MBEVisibleChangedActive
26  
-
27  
-You can see a screenshot of what this looks like here: http://fhl.gd/qnNQ
28  
-
29  
-[6.3.4] - Added to the original script were the following keybindings: (By Oliver Uvman)
30  
-
31  
-Added to the original script were the following keybindings: (By Oliver Uvman)
32  
-
33  
-h and l to move left and right when selecting buffers in addition to the original Tab and Shift-Tab
34  
-o and e to show a buffer in addition to the original <CR>
35  
-s to open the selected buffer in a split window
36  
-v to open the selected buffer in a vertically split window
37  
-
38  
-
39  
-Big thanks to Bindu Wavell for writing this script! I just added some minor things which I think others might find useful. I tried submitting this as a patch to him, but got no answer. Bindu: Contact me if you want to integrate this into your plugin and I'll remove this one.
40  
-
41  
-Original description:
42  
-
43  
-Several modern GUI editors list your open buffers as tabs along the top or bottom of your screen (VisualStudio, DreamWeaver, EditPlus and UltraEdit come to mind), now we have this feature in VIM! You can checkout a screenshot here: http://www.wavell.net/vim/vim_screenshot.gif.
44  
-
45  
-You can quickly switch buffers by double-clicking the appropriate "tab" (if you don't want to use the mouse just put the cursor on the "tab" and press enter). As you open and close buffers the tabs get updated. Buffers that are modified get visually marked and buffers that are open in a window get visually marked. The -MiniBufferExplorer- opens automatically when you open more than one eligible buffer (no need to open the explorer if you’re only editing one file.) -MiniBufExplorer- doesn't bother showing non-modifiable or hidden buffers. You can delete buffers by selecting them and pressing d on the keyboard.
46  
-
47  
-When you are in the -MiniBufExplorer- window, Tab and Shift-Tab move forward and backward respectively through the buffer list.
48  
-
49  
-There are a growing number of optional features in this script that are enabled by letting variables in your .vimrc:
50  
-
51  
-  control + the vim direction keys [hjkl] can be made to move you between windows.
52  
-  control + arrow keys can be made to do the same thing
53  
-  control + tab & shift + control + tab can be setup to switch through your open windows (like in MS Windows)
54  
-  control + tab & shift + control + tab can alternatively be setup to cycle forwards and backwards through your modifiable buffers in the current window
55  
-
56  
-NOTE: Some versions of vim don't support all of the key mappings that this script uses so you may experience degraded functionality. For example on Solaris SHIFT-TAB appears to fire the regular TAB mappings (same for console and gvim.) Also CONTROL+ARROWS appears to work in gvim on Solaris, but not in my xterm. All of the key bindings appear to work in Windows.
57  
-
58  
-[Thanks to Jeff Lanzarotta for his BufExplorer plugin (http://vim.sourceforge.net/scripts/script.php?script_id=42) that got me started down this slippery slope.]
184  readme.markdown
Source Rendered
... ...
@@ -0,0 +1,184 @@
  1
+# MiniBufExplorer
  2
+
  3
+I've been working on improving MiniBufExplorer, a plugin for [Vim][1].
  4
+
  5
+   [1]: http://vim.org
  6
+
  7
+## The story: Why am I doing this?
  8
+
  9
+The reason why I took it upon myself to improve MiniBufExplorer is a matter of
  10
+need. I am a User Interface designer who spends a lot of time writing front-
  11
+end code. I recently found Vim and fell in love with it. During my search for
  12
+the plugins that would help me the most, I came across MBE. I loved it
  13
+initially, but quickly saw that it had some major flaws.
  14
+
  15
+After using MBE for some time, I have been able to identify some areas that
  16
+needed some dire attention from a usability standpoint. I am doing my best to
  17
+fix those issues without adding "feature bloat" or other unnecessary things to
  18
+MBE. I am always open to suggestions and discussion as to what we can do to
  19
+improve this great plugin.
  20
+
  21
+I would also like to thank [Bindu Wavell][2], who is the plugin's original
  22
+creator and [Oliver Uvman][3], who like myself has been hacking at MBE to make
  23
+needed improvements. My goal is to consolidate the code and act as the
  24
+maintainer so that any further changes from contributors can be found in a
  25
+single location.
  26
+
  27
+   [2]: http://www.wavell.net/
  28
+   [3]: https://github.com/OliverUv
  29
+
  30
+* * *
  31
+
  32
+## New and Improved Features
  33
+
  34
+  1. Highlight currently active buffer
  35
+  2. Show differentiating parent directory with multiple buffers with the same filename
  36
+  3. Custom non-intrusive status line
  37
+  4. Update buffer name color according to buffer state (modified or unmodified) immediately after changes are made
  38
+  5. Prevents resizing of MBE buffer by window resizing commands
  39
+
  40
+* * *
  41
+
  42
+## Features Overview
  43
+
  44
+### Current Buffer Highlighting
  45
+
  46
+Previously, MBE would only tell you if a buffer was currently visible in the
  47
+editor like such:
  48
+
  49
+![][6]
  50
+
  51
+   [6]: http://dl.dropbox.com/u/118650/mbe/screenshots/current_buffer/old.png
  52
+
  53
+Now, MBE shows you the buffer that is currently visible _and_ active in the
  54
+editor. Here is an animated GIF that shows the current buffer highlighting in
  55
+action:
  56
+
  57
+![][7]
  58
+
  59
+   [7]: http://dl.dropbox.com/u/118650/mbe/screenshots/mbe1.gif
  60
+
  61
+* * *
  62
+
  63
+### Duplicate Buffer Names
  64
+
  65
+If you are an MBE user, I am sure you are familiar with the following
  66
+scenario:
  67
+
  68
+![][8]
  69
+
  70
+   [8]: http://dl.dropbox.com/u/118650/mbe/screenshots/dupe_buf_names/old_fade.png
  71
+
  72
+The problem is that buffers with the same filename do not get differentiated,
  73
+and it makes it very hard to find the buffer you are trying to edit. The
  74
+simple solution is to show a parent directory that is different between all
  75
+buffers like such:
  76
+
  77
+![][9]
  78
+
  79
+   [9]: http://dl.dropbox.com/u/118650/mbe/screenshots/dupe_buf_names/new_fade.png
  80
+
  81
+Let me explain how it works. Let's observe 2 files that have the same
  82
+filename.
  83
+
  84
+    		/Users/fholgado/Sites/website1/css/style.css
  85
+    		/Users/fholgado/Sites/website2/css/style.css
  86
+    		
  87
+You'll notice both files have the same filename _and_ are in a folder called
  88
+'css'. This happens all the time in web development projects.
  89
+
  90
+In order to differentiate the two files, MBE now crawls up the directory tree
  91
+and finds the first parent directory that differs from both files, which in
  92
+this case is 'website1' and 'website2'. MBE will now show you these 2 files as
  93
+such:
  94
+
  95
+[1:website1/style.css][2:website2/style.css]
  96
+
  97
+* * *
  98
+
  99
+### Buffer Save States
  100
+
  101
+It is always important to be able to see at a glance what buffers are modified
  102
+and need to be saved. MBE now shows you respective colors whether the buffer
  103
+is modified or not modified.
  104
+
  105
+![][10]
  106
+
  107
+   [10]: http://dl.dropbox.com/u/118650/mbe/screenshots/save_states/new.png
  108
+
  109
+**Most importantly**, MBE now updates the buffer states immediately after making changes, instead of the previous behavior that only updated buffer states when switching buffers.
  110
+
  111
+* * *
  112
+
  113
+### Status Line Clutter
  114
+
  115
+Previously, the MBE buffer would use the same statusline that is currently
  116
+configured for Vim. This adds a lot of visual clutter to MBE and does not add
  117
+any functionality, since the status line is showing information for a buffer
  118
+that does not contain any real content.
  119
+
  120
+![][11]
  121
+
  122
+   [11]: http://dl.dropbox.com/u/118650/mbe/screenshots/status_line/old.png
  123
+
  124
+MBE now uses it's own custom Status Line format to reduce the unwanted
  125
+information. This line is customizable and can even be empty.
  126
+
  127
+![][12]
  128
+
  129
+   [12]: http://dl.dropbox.com/u/118650/mbe/screenshots/status_line/new.png
  130
+
  131
+* * *
  132
+
  133
+### Window Resizing
  134
+
  135
+Previously, the MBE buffer made the automatic window resizing using the ctrl +
  136
+w + = command in Vim. Many of you have seen the following picture:
  137
+
  138
+![][13]
  139
+
  140
+   [13]: http://dl.dropbox.com/u/118650/mbe/screenshots/window_resizing/old.png
  141
+
  142
+MBE now maintains it's buffer size both in horizontal and vertical mode when
  143
+using window resizing commands. Now you can take a Vim tab that looks like
  144
+this:
  145
+
  146
+![][14]
  147
+
  148
+   [14]: http://dl.dropbox.com/u/118650/mbe/screenshots/window_resizing/new1.png
  149
+
  150
+And turn it into something like this without worrying about the MBE window
  151
+becoming large as well:
  152
+
  153
+![][15]
  154
+
  155
+   [15]: http://dl.dropbox.com/u/118650/mbe/screenshots/window_resizing/new2.png
  156
+
  157
+* * *
  158
+
  159
+### Customizing Colors
  160
+
  161
+Here are all the color additions to customize MBE's new features. You can add
  162
+the following to your Color file and customize the color accordingly:
  163
+    
  164
+    			" MiniBufExpl Colors
  165
+    			hi MBEVisibleActive guifg=#A6DB29 guibg=fg
  166
+    			hi MBEVisibleChangedActive guifg=#F1266F guibg=fg
  167
+    			hi MBEVisibleChanged guifg=#F1266F guibg=fg
  168
+    			hi MBEVisibleNormal guifg=#5DC2D6 guibg=fg
  169
+    			hi MBEChanged guifg=#CD5907 guibg=fg
  170
+    			hi MBENormal guifg=#808080 guibg=fg
  171
+    			
  172
+* * *
  173
+
  174
+## Download MiniBufExplorer 6.4.0 (1/1/2011)
  175
+
  176
+[Download MiniBufExplorer from GitHub][16]
  177
+
  178
+   [16]: https://github.com/fholgado/minibufexpl.vim
  179
+
  180
+If you want to report a bug, or suggest a feature just post it to the [GitHub
  181
+Issue Tracker for MiniBufExplorer][17]. If you don't have a GitHub account,
  182
+just email me at fholgado at gmail.
  183
+
  184
+   [17]: https://github.com/fholgado/minibufexpl.vim/issues

0 notes on commit 8775e0f

Please sign in to comment.
Something went wrong with that request. Please try again.