specky/doc/specky.txt
branchvim-stuff
changeset 6 31d00503e038
parent 5 3346aa8d5364
child 10 a8f9271a7cab
equal deleted inserted replaced
5:3346aa8d5364 6:31d00503e038
    19         4.3) Display ruby documentation.............|g:speckyRunRdocKey|
    19         4.3) Display ruby documentation.............|g:speckyRunRdocKey|
    20         4.4) Toggle editing between spec and code...|g:speckySpecSwitcherKey|
    20         4.4) Toggle editing between spec and code...|g:speckySpecSwitcherKey|
    21         4.5) Run specs for the current buffer.......|g:speckyRunSpecKey|
    21         4.5) Run specs for the current buffer.......|g:speckyRunSpecKey|
    22         4.6) Modify the default spec command........|g:speckyRunSpecCmd|
    22         4.6) Modify the default spec command........|g:speckyRunSpecCmd|
    23         4.7) Modify the default rdoc command........|g:speckyRunRdocCmd|
    23         4.7) Modify the default rdoc command........|g:speckyRunRdocCmd|
    24         4.8) Split windows vertically...............|g:speckyVertSplit|
    24         4.8) Alter new window behavior..............|g:speckyWindowType|
    25     5) Author.......................................|SpeckyAuthor|
    25     5) Author.......................................|SpeckyAuthor|
    26     6) License......................................|SpeckyLicense|
    26     6) License......................................|SpeckyLicense|
    27 
    27 
    28 
    28 
    29 
    29 
    90     let g:speckyRunRdocKey = "<C-S>r"
    90     let g:speckyRunRdocKey = "<C-S>r"
    91     let g:speckySpecSwitcherKey = "<C-S>x"
    91     let g:speckySpecSwitcherKey = "<C-S>x"
    92     let g:speckyRunSpecKey = "<C-S>s"
    92     let g:speckyRunSpecKey = "<C-S>s"
    93     let g:speckyRunSpecCmd = "spec -fs -r loadpath.rb"
    93     let g:speckyRunSpecCmd = "spec -fs -r loadpath.rb"
    94     let g:speckyRunRdocCmd = "fri -L -f plain"
    94     let g:speckyRunRdocCmd = "fri -L -f plain"
    95     let g:speckyVertSplit = 1
    95     let g:speckyWindowType = 2
    96 
    96 
    97 
    97 
    98 With these bindings, all specky commands start with <ctrl-s> ("s" for
    98 With these bindings, all specky commands start with <ctrl-s> ("s" for
    99 specky!), followed by a mnemonic function to run:
    99 specky!), followed by a mnemonic function to run:
   100 
   100 
   199 directory.  Spec files just need to end in '_spec.rb', which is a common
   199 directory.  Spec files just need to end in '_spec.rb', which is a common
   200 convention.
   200 convention.
   201 
   201 
   202     aRubyClass.rb ---> aRubyClass_spec.rb~
   202     aRubyClass.rb ---> aRubyClass_spec.rb~
   203  
   203  
   204  Because it leaves respective buffers open, you can essentially think of this
   204 Because it leaves respective buffers open, you can essentially think of this
   205  as a quick toggle for code and tests.
   205 as a quick toggle between code and tests.
   206 
   206 
   207 
   207 
   208 
   208 
   209 ------------------------------------------------------------------------------
   209 ------------------------------------------------------------------------------
   210 4.5                                                       *g:speckyRunSpecKey*
   210 4.5                                                       *g:speckyRunSpecKey*
   211 
   211 
   212 
   212 
   213 Setting this variable allows you to run "spec" on the current buffer.
   213 Setting this variable runs "spec" on the current buffer.
   214 
   214 
   215 All output is sent to a syntax highlighted scratch buffer. This new window is
   215 All output is sent to a syntax highlighted scratch buffer. This new window is
   216 re-used for each spec run.  You can quickly "jump" to assertion failures and
   216 re-used for each spec run.  You can quickly "jump" to assertion failures and
   217 their associated details with the following keys:
   217 their associated details with the following keys:
   218 
   218 
   257 ------------------------------------------------------------------------------
   257 ------------------------------------------------------------------------------
   258 4.7                                                       *g:speckyRunRdocCmd*
   258 4.7                                                       *g:speckyRunRdocCmd*
   259 
   259 
   260 
   260 
   261 If you prefer an rdoc display program other than "ri", you can set it
   261 If you prefer an rdoc display program other than "ri", you can set it
   262 with this variable.
   262 with this variable.  "fri -L -f plain" is always a nice choice, for example.
   263 
   263 
   264     Default: ~
   264     Default: ~
   265         ri
   265         ri
   266 
   266 
   267 
   267 
   268 
   268 
   269 ------------------------------------------------------------------------------
   269 ------------------------------------------------------------------------------
   270 4.8                                                        *g:speckyVertSplit*
   270 4.8                                                       *g:speckyWindowType*
   271 
   271 
   272 
   272 
   273 For both spec and rdoc commands, split the new window vertically instead of
   273 For both spec and rdoc commands, this variable controls the behavior of the
   274 horizontally.
   274 newly generated window.
   275 
   275 
       
   276 	Default: ~
       
   277 		0
       
   278 		
       
   279 	0 ~
       
   280 		Create a new tabbed window
       
   281 	1 ~
       
   282 		Split the current window horizontally
       
   283 	2 ~
       
   284 		Split the current window vertically
   276 
   285 
   277 
   286 
   278 ==============================================================================
   287 ==============================================================================
   279 5. AUTHOR                                                       *SpeckyAuthor*
   288 5. AUTHOR                                                       *SpeckyAuthor*
   280 
   289