Commits

Gabriel AHTUNE  committed ed5d902

added doc/supernormal.txt

  • Participants
  • Parent commits c971828

Comments (0)

Files changed (1)

File doc/supernormal.txt

+*supernormal.txt* Enhance normal button to super buttons !
+
+Author: Gabriel AHTUNE
+
+==============================================================================
+
+1. Usage				|supernormal-usage|
+2. Configuration			|supernormal-configuration|
+3. Home button				|supernormal-home-button|
+4. Backspace button			|supernormal-backspace-button|
+5. Delete button			|supernormal-delete-button|
+6. Return button			|supernormal-enter-button|
+
+==============================================================================
+1. Supernormal Usage                                 *supernormal-home-button*
+
+Use the buttons with new enhanced functionality as you expect they has to work
+if they do not work as you want it's a bug then you have to change them !
+
+==============================================================================
+2. Configuration                                     *supernormal-home-button*
+
+Some variable can be set in order to disable or tweak the behaviour of the
+plugin, by default everything is enable except the 'compatibility' with
+snipmate.
+
+The following variables are explicits ! I do not think I need to explains them
+to you !
+
+- 'g:SuperNormalDeactivateDelMapping'
+- 'g:SuperNormalDeactivateTabMapping'
+- 'g:SuperNormalDeactivateHomeMapping'
+- 'g:SuperNormalDeactivateBackspaceMapping'
+- 'g:SuperNormalDeactivateEnterMapping'
+
+Set it for example like this: >
+
+    let g:SuperNormalDeactivateDelMapping = 1
+
+To deactivate the delete button "enhancement".
+
+
+To make this plugin works with snipmate you need to set this variable: >
+
+    let g:SuperNormalSnipmateCompatible = 1
+
+and comment the following line in the Snipmate plugin: >
+
+    ino <silent> <tab> <c-r>=TriggerSnippet()<cr>
+
+==============================================================================
+                                                     *supernormal-home-button*
+
+With this plugin the behaviour of the home button becomes:
+
+                                          cursor
+                                             v
+           // One home button does not simply| become super by himself
+
+        press <Home> goto the begining of the indented comment
+
+           // |One home button does not simply become super by himself
+              ^
+              cursor
+
+        press <Home> again goto the begining of the indented line
+
+          |// One home button does not simply become super by himself
+          ^
+          cursor
+
+        press <Home> again goto the begining of the line
+
+|          // One home button does not simply become super by himself
+^
+cursor
+
+And if you press again it cycles. And of course it works in all the modes ;)
+
+==============================================================================
+                                                *supernormal-backspace-button*
+
+The backspace has some new behaviour when it normally does nothing
+
+- In the builtin file explorer, backspace is equivalent to "-" (ie goto the
+  parent folder).
+- In visual mode it's equivelent to "x": delete the selection.
+- In normal mode go back to the last tag jump.
+
+==============================================================================
+                                                    *supernormal-enter-button*
+
+The <Return> has some new behaviour when it normally does nothing
+
+- In help file it jumps to the link. (equivalent to <C-]>).
+- In visual mode it delete the selection and insert a newline.
+- In Normal mode it goto the next search result.
+
+==============================================================================
+                                                   *supernormal-delete-button*
+
+For the delete button, I just get ride of one anoying behaviour : in normal
+mode the delete button usually is equivalent to x therefore it overwrite the
+register content with the deleted character. And it's almost never what I
+want, so delete only delete without cutting (because delete was to powerful to
+become super it needs to be less !).
+
+==============================================================================
+vim:tw=78:ts=8:ft=help:norl: