mirror of
https://github.com/chylex/IntelliJ-IdeaVim.git
synced 2025-03-01 04:46:02 +01:00
Update documentation
This commit is contained in:
Oleg Shpynov
parent
52eeca8cf7
commit
e322793a2e
@ -213,13 +213,6 @@
|
||||
<filter token="IDEA-VERSION" value="${idea-version}"/>
|
||||
</filterset>
|
||||
</copy>
|
||||
<copy file="${basedir}/docs/NOTES.txt" tofile="${build}/IdeaVim/NOTES">
|
||||
<filterset>
|
||||
<filter token="NAME" value="IdeaVim"/>
|
||||
<filter token="VERSION" value="${version}"/>
|
||||
<filter token="IDEA-VERSION" value="${idea-version}"/>
|
||||
</filterset>
|
||||
</copy>
|
||||
<zip basedir="${build}" zipfile="${dist}/${filename}.zip" compress="true" includes="IdeaVim/**"/>
|
||||
</target>
|
||||
|
||||
|
||||
@ -1,26 +0,0 @@
|
||||
@NAME@ version @VERSION@ Release Notes for IDEA @IDEA-VERSION@
|
||||
|
||||
Ctrl-K is being used for the first time and it appears this is mapped to
|
||||
several source control menus. In order to resolve this you must either
|
||||
install the updated Vim.xml into the keymaps directory or unmap Ctrl-K from
|
||||
all source control menus. This is accomplished as follows:
|
||||
|
||||
- Select File|Settings menus.
|
||||
- Click on the Keymap icon.
|
||||
- Ensure Vim is the active keymap.
|
||||
- Expand the 'Other' node under the keymap tree.
|
||||
- Scroll down to the entry labeld 'Keys' and select it.
|
||||
- Click on 'Add Keyboard Shortcut...'
|
||||
- Type 'Ctrl-K' in the first key field.
|
||||
- You may see a message about conflicts.
|
||||
- Click OK to save the Ctrl-K shortcut.
|
||||
- If there was a conflict you will get a Warning dialog. Select 'Remove' to
|
||||
remove the conflicts.
|
||||
- Click OK in the key mapping dialog.
|
||||
- Click Close in the settings dialog.
|
||||
|
||||
VIM Emulator plugin for IntelliJ IDEA. See the enclosed README file in the
|
||||
binary distribution for installation instructions. See docs/vim/index.txt for
|
||||
a complete list of supported VIM commands. This release has been tested with
|
||||
IDEA 4.0 to 4.0.3. (builds #1162 - 1182) and IDEA 4.5.1 (through build 2239).
|
||||
|
||||
@ -1,44 +1,12 @@
|
||||
@NAME@ - Version @VERSION@ for IDEA @IDEA-VERSION@
|
||||
|
||||
This plugin attempts to emulate the functionality of VIM within IDEA. It
|
||||
actually emulates 'gvim' more than 'vim' since IDEA is a graphical IDE (of
|
||||
course).
|
||||
@NAME@ - Version @VERSION@
|
||||
Minimal compatible IDE version @IDEA-VERSION@
|
||||
|
||||
This plugin attempts to emulate the functionality of VIM within IntelliJ platform based products. It actually emulates 'gvim' more than 'vim'. IdeaVim can be used with IntellIJ IDEA, RubyMine, PyCharm, PhpStorm and WebStorm ides.
|
||||
|
||||
Installation
|
||||
|
||||
Use IDEA's plugin manager to install the latest version of the plugin.
|
||||
|
||||
First Time Installation
|
||||
|
||||
UNIX/Linux
|
||||
|
||||
Copy Vim.xml from the plugin to $HOME/.IntelliJIdea/config/keymaps. You will
|
||||
have to create the keymaps directory if it doesn't exist.
|
||||
|
||||
Windows
|
||||
|
||||
Copy Vim.xml from the plugin to
|
||||
C:\Documents and Settings\<user>\.IntelliJIdea\config\keymaps.
|
||||
You will have to create the keymaps directory if it doesn't exist.
|
||||
|
||||
Starting
|
||||
|
||||
Once the files have been installed into their proper locations, start IDEA
|
||||
normally and then perform the following steps. These only need to be done the
|
||||
first time:
|
||||
|
||||
1) Select the "Tools" menu. There should be a new menu option labeled
|
||||
"VIM Emulator". This should have a checkmark next to it. If not, please
|
||||
select this menu to check it. If this menu option is not available, you did
|
||||
not copy @NAME@.jar into the correct location.
|
||||
2) Select the "Options|Keymaps" menu. There should be a new keymap labeled "vim"
|
||||
listed in the top listbox. If there is no such keymap listed you did not
|
||||
install the vim.xml file in the proper location. Please highlight "vim" and
|
||||
click on the "Set Active" button. Click "OK" to save these changes.
|
||||
|
||||
At this point you must use VIM keystrokes in all editors.
|
||||
|
||||
Start IDEA normally and Enable VIM emulation using "Tools|VIM Emulator" menu item. At this point you must use VIM keystrokes in all editors.
|
||||
|
||||
Disabling the @NAME@ Plugin
|
||||
|
||||
@ -48,7 +16,7 @@ than "vim" the active keymap. At this point IDEA will work with it's regular
|
||||
keyboard shortcuts.
|
||||
|
||||
|
||||
Changes to IDEA
|
||||
Changes to the IDE
|
||||
|
||||
Undo/Redo
|
||||
|
||||
@ -61,7 +29,7 @@ file will result in strange behavior and you will most likely lose changes.
|
||||
|
||||
Escape
|
||||
|
||||
In IDEA, the Escape key is used during editing to cancel code completion
|
||||
In IDE, the Escape key is used during editing to cancel code completion
|
||||
windows and parameter tooltips. While in VIM Insert mode, Escape is used to
|
||||
return back to Normal mode. If you are typing in Insert mode and a code
|
||||
completion window is popped up, pressing Escape will both cancel the window
|
||||
@ -73,7 +41,7 @@ the method call. (I would love to receive solutions for both of these issues.)
|
||||
Menu Changes
|
||||
|
||||
In order to emulate the keystrokes used by VIM, several of the default hotkeys
|
||||
used by IDEA had to be changed. Below is a list of IDEA menus, their default
|
||||
used by IDE had to be changed. Below is a list of IDE menus, their default
|
||||
keyboard shortcuts, and their new VIM keystrokes.
|
||||
|
||||
File
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
Bugs to fix:
|
||||
|
||||
x Using column selection causes exception.
|
||||
- Split text when typing fast after o command.
|
||||
- Show message after shifting lines with :< or :>
|
||||
- Replace mode - fix cursor. Can't figure out how to keep block cursor.
|
||||
|
||||
Requested Functionality to add:
|
||||
|
||||
- Visual Column mode
|
||||
- More fold region support
|
||||
- Window support (need access to splitter)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user