Changes between Version 1 and Version 2 of EmacsInterface

Timestamp:

Feb 15, 2012, 10:48:20 AM (13 years ago)

Author:

manualwiki

Comment:

--

EmacsInterface

@@ -9 +9 @@
 those files that are loaded into the database are subjects to refactoring.
 
-== Configuration in XEmacs/Emacs. ==
+== Configuration in XEmacs/Emacs ==
 
-=== Loading !RefactorErl.=== 
+=== Loading !RefactorErl === 
 First of all, you need to load the !RefactorErl library
 into XEmacs or into Emacs. You can do this by placing the following two
@@ -34 +34 @@
 
  
-=== Basic settings. ===
+=== Basic settings ===
 
 Before you can run !RefactorErl, you must make some settings
@@ -50 +50 @@
  * {{{Refactorerl Server Type}}}: if you want to experiment with the command line interface of the tool, you should set this to "Managed server with shell access". This feature requires the standard Erlang editing mode.
 
+== !RefactorErl mode ==
+
+Refactoring functionality is provided through an (X)Emacs minor mode1 that
+can be turned on using the command {{{M-x refactorerl-mode}}}. When this mode
+is active, there is a status display in the mode line that shows one of the following
+values:
+
+  * {{{Refact}}} means !RefactorErl mode is active, and the file can be refactored.
+
+  * {{{Refact:off}}} means !RefactorErl mode is active, but the file is not in the database, so it cannot be refactored.
+
+  * {{{Refact:err}}} means the file has some errors.
+
+  * {{{Refact:???}}} means that !RefactorErl mode is active, but there is no information available about the file. Normally this is shown only during processing, use the "update status" command if it doesn't go away.
+
+When !RefactorErl mode is active, functionality can be accessed through
+either the "Refactor" menu or keyboard shortcuts. Key sequences start with
+{{{C-c C-r}}}, and a complete list is given by {{{C-c C-r C-h}}}.
+
+As a standard (X)Emacs feature, help on !RefactorErl keyboard shortcuts
+is available by typing {{{C-h k}}} followed by the keyboard command itself. For
+example, {{{C-h k C-c C-r r f}}} provides help on the rename function refactoring.
+The same works with menus: selecting a menu item after typing {{{C-h k}}} gives
+help on the menu item.
+
+== The "Refactor" menu ==
+
+=== Server sub-menu ===
+
+While working with Erlang files the sever process of the !RefactorErl can be
+stopped or can be restarted if it is required. The refactoring server can be
+stopped by selecting the "Stop server" menu item from the "!Refactor/Server" menu
+or typing the shortcut {{{C-c C-r Q}}}. The !RefactorErl server can be started (or
+restarted) by selecting the menu item "Start server" from the "!Refactor/Server" menu or
+typing the {{{C-c C-r R}}} shortcut.
+
+
+=== Files sub-menu ===
+
 ...
-