vim-hgrev: comparison specky/doc/specky.txt

equal deleted inserted replaced

-:6b33188f1694
+:db3e3abfc647
 1) Intro........................................|SpeckyIntro|
 2) Functionality................................|SpeckyFunctionality|
 3) Enabling Specky..............................|SpeckyVimrcExample|
 4) Configuration................................|SpeckyOptions|
-4.1) Cycling quote styles...................|g:speckyQuoteSwitcherKey|
+4.1) Create text banners....................|g:speckyBannerKey|
-4.2) Display ruby documentation.............|g:speckyRunRdocKey|
+4.2) Cycling quote styles...................|g:speckyQuoteSwitcherKey|
-4.3) Toggle editing between spec and code...|g:speckySpecSwitcherKey|
+4.3) Display ruby documentation.............|g:speckyRunRdocKey|
-4.4) Run specs for the current buffer.......|g:speckyRunSpecKey|
+4.4) Toggle editing between spec and code...|g:speckySpecSwitcherKey|
-4.5) Modify the default spec command........|g:speckyRunSpecCmd|
+4.5) Run specs for the current buffer.......|g:speckyRunSpecKey|
-4.6) Modify the default rdoc command........|g:speckyRunRdocCmd|
+4.6) Modify the default spec command........|g:speckyRunSpecCmd|
-4.7) Split windows vertically...............|g:speckyVertSplit|
+4.7) Modify the default rdoc command........|g:speckyRunRdocCmd|
+4.8) Split windows vertically...............|g:speckyVertSplit|
 5) Author.......................................|SpeckyAuthor|
 6) License......................................|SpeckyLicense|
 By default?  Nothing, unless you are comfortable using the menus.  I decided
 the easiest way to cherry pick the functionality that you'd like was to enable
 them via key bindings.  By doing this, Specky won't make assumptions about
 your current environment, and won't stomp on anything you don't want it to.
->
-Specky won't do -anything- with your environment until you enable
+Specky won't do -anything- with your environment until you enable ~
-the key bindings!!
+the key bindings!! ~
 After you've configured your bindings, here are some of the things you can
 now do with a single key stroke:
 >
 - Switch back and forth from code to testing spec
 - View rdoc of the word under the cursor
 - Dynamically switch string types for the word under the cursor
 (double quoted, quoted, symbol)
+- Make lovely and quick comment banners for ruby code.
 ==============================================================================
 3. ENABLING-SPECKY                                        *SpeckyVimrcExample*
 Here's what my config looks like. >
+let g:speckyBannerKey = "<C-S>b"
 let g:speckyQuoteSwitcherKey = "<C-S>'"
 let g:speckyRunRdocKey = "<C-S>r"
 let g:speckySpecSwitcherKey = "<C-S>x"
 let g:speckyRunSpecKey = "<C-S>s"
 let g:speckyRunSpecCmd = "spec -fs -r loadpath.rb"
 With these bindings, all specky commands start with <ctrl-s> ("s" for
 specky!), followed by a mnemonic function to run:
+b ----> Banner creation ~
 ' ----> Quote cycling ~
 r ----> run Rdoc ~
 x ----> code and spec eXchange ~
 s ----> run Spec ~
 Of course, <ctrl-s> is a "suspend" signal for most terminals, so these
 bindings are meant for a |gui| environment, such as gvim.  Your mileage (and
-tastes) will doubtlessly vary.
+tastes) will doubtlessly vary.  Do what you will.  I won't judge you.
 ==============================================================================
 4. CONFIGURATION-OPTIONS                                       *SpeckyOptions*
 Here are all of the available configuration options.
-Please note that you must (at an optional minimum) set the respective binding
+Please note that you must set binding variables:
-variables:
+|g:speckyBannerKey|
 |g:speckyQuoteSwitcherKey|
 |g:speckyRunRdocKey|
 |g:speckySpecSwitcherKey|
 |g:speckyRunSpecKey|
-...in order to enable specky functionality.  See |SpeckyVimrcExample| for
+...in order to enable the respective specky functionality.  See
-details. Any other options are entirely optional.  Put these into your
+|SpeckyVimrcExample| for details. Any other options are entirely optional.
-|vimrc|, or wherever else you enjoy storing this kind of stuff.
+Put these into your |vimrc|, or wherever else you enjoy storing this kind of
+stuff.
-------------------------------------------------------------------------------
-4.1                                                 *g:speckyQuoteSwitcherKey*
+------------------------------------------------------------------------------
+4.1                                                        *g:speckyBannerKey*
+Setting this binding enables comment banner creation.
+This is purely a convenience routine, and a stylistic one at that.  I prefer
+large advertising of what "area" of code you are in, along with other
+miscellaneous labels for humans to read.  If this isn't how you roll, then by
+all means, don't enable this binding!  :)
+As an example -- you can just type:
+	instance methods ~
+Then hit the keystroke.  It will magically turn into: >
+########################################################################
+### I N S T A N C E   M E T H O D S
+########################################################################
+With all those saved extra keystrokes this might provide you per banner over
+the years, your RSI-free hands will thank you.  And the total time savings!!
+Oh man, what are you going to DO with all of that extra free time?
+The possibilities are staggering.
+------------------------------------------------------------------------------
+4.2                                                 *g:speckyQuoteSwitcherKey*
 Setting this binding enables quote "style switching".
 If you aren't in ruby mode, this just changes the word under the cursor
 In ruby mode, symbols are also put into the rotation.
 "string" -> 'string' -> :string -> "string" ... ~
-Note that quote cycling only works with a |word|.  Sentences are not currently
+Note that quote cycling only works with a |word|.
-supported.  (But hopefully will be soon.)
+------------------------------------------------------------------------------
-------------------------------------------------------------------------------
+4.3                                                       *g:speckyRunRdocKey*
-4.2                                                       *g:speckyRunRdocKey*
 Setting this enables the display of rdoc documentation for the current
 word under the cursor.  For lookups with multiple matches, you can continue
 using this binding to "drill down" to the desired documentation.
 ------------------------------------------------------------------------------
-4.3                                                  *g:speckySpecSwitcherKey*
+4.4                                                  *g:speckySpecSwitcherKey*
 Setting this enables spec to code switching, and visa versa.
 Switching uses path searching instead of reliance on directory structure in
 as a quick toggle for code and tests.
 ------------------------------------------------------------------------------
-4.4                                                       *g:speckyRunSpecKey*
+4.5                                                       *g:speckyRunSpecKey*
 Setting this variable allows you to run "spec" on the current buffer.
 All output is sent to a syntax highlighted scratch buffer. This new window is
 switch to the spec before running the command.
 ------------------------------------------------------------------------------
-4.5                                                       *g:speckyRunSpecCmd*
+4.6                                                       *g:speckyRunSpecCmd*
 This is the program, with flags, that the current file is sent to when
 executing the |g:speckyRunSpecKey| keybinding.
 spec -fs
 ------------------------------------------------------------------------------
-4.6                                                       *g:speckyRunRdocCmd*
+4.7                                                       *g:speckyRunRdocCmd*
 If you prefer an rdoc display program other than "ri", you can set it
 with this variable.
 ri
 ------------------------------------------------------------------------------
-4.7                                                        *g:speckyVertSplit*
+4.8                                                        *g:speckyVertSplit*
 For both spec and rdoc commands, split the new window vertically instead of
 horizontally.
 6. LICENSE                                                     *SpeckyLicense*
 Specky is distributed under the BSD license.
 http://www.opensource.org/licenses/bsd-license.php
 >
 Copyright (c) 2008, Mahlon E. Smith <mahlon@martini.nu>
 All rights reserved.
 Redistribution and use in source and binary forms, with or without
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 vim: set noet nosta sw=4 ts=4 ft=help :

branch	vim-stuff
changeset 3	db3e3abfc647
parent 2	6b33188f1694
child 5	3346aa8d5364