Permalink
Browse files

Update readme.

  • Loading branch information...
1 parent c8a3292 commit 8775e0faa001fec78b255e55b20ee8d4e207c5ea @fholgado fholgado committed Oct 20, 2011
Showing with 184 additions and 58 deletions.
  1. +0 −58 README
  2. +184 −0 readme.markdown
View
58 README
@@ -1,58 +0,0 @@
-This is an updated and modified version of the script available here: http://www.vim.org/scripts/script.php?script_id=159
-
-[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.
-
-[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.
-
-i.e. There are 2 buffers with the same filename:
-/ProjectA/Application/CSS/style.css
-/ProjectB/Applications/CSS/style.css
-
-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:
-
-ProjectA/style.css
-ProjectB/style.css
-
-- 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='.
-
-[6.3.7] 12/19/2010 - MBE now uses it's own custom statusline format to reduce visual clutter. (By Federico Holgado)
-
-[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)
-
-[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)
-
- MBEVisibleActive
- MBEVisibleChangedActive
-
-You can see a screenshot of what this looks like here: http://fhl.gd/qnNQ
-
-[6.3.4] - Added to the original script were the following keybindings: (By Oliver Uvman)
-
-Added to the original script were the following keybindings: (By Oliver Uvman)
-
-h and l to move left and right when selecting buffers in addition to the original Tab and Shift-Tab
-o and e to show a buffer in addition to the original <CR>
-s to open the selected buffer in a split window
-v to open the selected buffer in a vertically split window
-
-
-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.
-
-Original description:
-
-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.
-
-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.
-
-When you are in the -MiniBufExplorer- window, Tab and Shift-Tab move forward and backward respectively through the buffer list.
-
-There are a growing number of optional features in this script that are enabled by letting variables in your .vimrc:
-
- control + the vim direction keys [hjkl] can be made to move you between windows.
- control + arrow keys can be made to do the same thing
- control + tab & shift + control + tab can be setup to switch through your open windows (like in MS Windows)
- control + tab & shift + control + tab can alternatively be setup to cycle forwards and backwards through your modifiable buffers in the current window
-
-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.
-
-[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.]
View
@@ -0,0 +1,184 @@
+# MiniBufExplorer
+
+I've been working on improving MiniBufExplorer, a plugin for [Vim][1].
+
+ [1]: http://vim.org
+
+## The story: Why am I doing this?
+
+The reason why I took it upon myself to improve MiniBufExplorer is a matter of
+need. I am a User Interface designer who spends a lot of time writing front-
+end code. I recently found Vim and fell in love with it. During my search for
+the plugins that would help me the most, I came across MBE. I loved it
+initially, but quickly saw that it had some major flaws.
+
+After using MBE for some time, I have been able to identify some areas that
+needed some dire attention from a usability standpoint. I am doing my best to
+fix those issues without adding "feature bloat" or other unnecessary things to
+MBE. I am always open to suggestions and discussion as to what we can do to
+improve this great plugin.
+
+I would also like to thank [Bindu Wavell][2], who is the plugin's original
+creator and [Oliver Uvman][3], who like myself has been hacking at MBE to make
+needed improvements. My goal is to consolidate the code and act as the
+maintainer so that any further changes from contributors can be found in a
+single location.
+
+ [2]: http://www.wavell.net/
+ [3]: https://github.com/OliverUv
+
+* * *
+
+## New and Improved Features
+
+ 1. Highlight currently active buffer
+ 2. Show differentiating parent directory with multiple buffers with the same filename
+ 3. Custom non-intrusive status line
+ 4. Update buffer name color according to buffer state (modified or unmodified) immediately after changes are made
+ 5. Prevents resizing of MBE buffer by window resizing commands
+
+* * *
+
+## Features Overview
+
+### Current Buffer Highlighting
+
+Previously, MBE would only tell you if a buffer was currently visible in the
+editor like such:
+
+![][6]
+
+ [6]: http://dl.dropbox.com/u/118650/mbe/screenshots/current_buffer/old.png
+
+Now, MBE shows you the buffer that is currently visible _and_ active in the
+editor. Here is an animated GIF that shows the current buffer highlighting in
+action:
+
+![][7]
+
+ [7]: http://dl.dropbox.com/u/118650/mbe/screenshots/mbe1.gif
+
+* * *
+
+### Duplicate Buffer Names
+
+If you are an MBE user, I am sure you are familiar with the following
+scenario:
+
+![][8]
+
+ [8]: http://dl.dropbox.com/u/118650/mbe/screenshots/dupe_buf_names/old_fade.png
+
+The problem is that buffers with the same filename do not get differentiated,
+and it makes it very hard to find the buffer you are trying to edit. The
+simple solution is to show a parent directory that is different between all
+buffers like such:
+
+![][9]
+
+ [9]: http://dl.dropbox.com/u/118650/mbe/screenshots/dupe_buf_names/new_fade.png
+
+Let me explain how it works. Let's observe 2 files that have the same
+filename.
+
+ /Users/fholgado/Sites/website1/css/style.css
+ /Users/fholgado/Sites/website2/css/style.css
+
+You'll notice both files have the same filename _and_ are in a folder called
+'css'. This happens all the time in web development projects.
+
+In order to differentiate the two files, MBE now crawls up the directory tree
+and finds the first parent directory that differs from both files, which in
+this case is 'website1' and 'website2'. MBE will now show you these 2 files as
+such:
+
+[1:website1/style.css][2:website2/style.css]
+
+* * *
+
+### Buffer Save States
+
+It is always important to be able to see at a glance what buffers are modified
+and need to be saved. MBE now shows you respective colors whether the buffer
+is modified or not modified.
+
+![][10]
+
+ [10]: http://dl.dropbox.com/u/118650/mbe/screenshots/save_states/new.png
+
+**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.
+
+* * *
+
+### Status Line Clutter
+
+Previously, the MBE buffer would use the same statusline that is currently
+configured for Vim. This adds a lot of visual clutter to MBE and does not add
+any functionality, since the status line is showing information for a buffer
+that does not contain any real content.
+
+![][11]
+
+ [11]: http://dl.dropbox.com/u/118650/mbe/screenshots/status_line/old.png
+
+MBE now uses it's own custom Status Line format to reduce the unwanted
+information. This line is customizable and can even be empty.
+
+![][12]
+
+ [12]: http://dl.dropbox.com/u/118650/mbe/screenshots/status_line/new.png
+
+* * *
+
+### Window Resizing
+
+Previously, the MBE buffer made the automatic window resizing using the ctrl +
+w + = command in Vim. Many of you have seen the following picture:
+
+![][13]
+
+ [13]: http://dl.dropbox.com/u/118650/mbe/screenshots/window_resizing/old.png
+
+MBE now maintains it's buffer size both in horizontal and vertical mode when
+using window resizing commands. Now you can take a Vim tab that looks like
+this:
+
+![][14]
+
+ [14]: http://dl.dropbox.com/u/118650/mbe/screenshots/window_resizing/new1.png
+
+And turn it into something like this without worrying about the MBE window
+becoming large as well:
+
+![][15]
+
+ [15]: http://dl.dropbox.com/u/118650/mbe/screenshots/window_resizing/new2.png
+
+* * *
+
+### Customizing Colors
+
+Here are all the color additions to customize MBE's new features. You can add
+the following to your Color file and customize the color accordingly:
+
+ " MiniBufExpl Colors
+ hi MBEVisibleActive guifg=#A6DB29 guibg=fg
+ hi MBEVisibleChangedActive guifg=#F1266F guibg=fg
+ hi MBEVisibleChanged guifg=#F1266F guibg=fg
+ hi MBEVisibleNormal guifg=#5DC2D6 guibg=fg
+ hi MBEChanged guifg=#CD5907 guibg=fg
+ hi MBENormal guifg=#808080 guibg=fg
+
+* * *
+
+## Download MiniBufExplorer 6.4.0 (1/1/2011)
+
+[Download MiniBufExplorer from GitHub][16]
+
+ [16]: https://github.com/fholgado/minibufexpl.vim
+
+If you want to report a bug, or suggest a feature just post it to the [GitHub
+Issue Tracker for MiniBufExplorer][17]. If you don't have a GitHub account,
+just email me at fholgado at gmail.
+
+ [17]: https://github.com/fholgado/minibufexpl.vim/issues

0 comments on commit 8775e0f

Please sign in to comment.