| 1 | <!-- |
|---|
| 2 | //----------------------------------------------------------- |
|---|
| 3 | // Copyright Christian Arnault LAL-Orsay CNRS |
|---|
| 4 | // arnault@lal.in2p3.fr |
|---|
| 5 | // See the complete license in cmt_license.txt "http://www.cecill.info". |
|---|
| 6 | //----------------------------------------------------------- |
|---|
| 7 | --> |
|---|
| 8 | |
|---|
| 9 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
|---|
| 10 | <html> |
|---|
| 11 | <head> |
|---|
| 12 | <title>Emacs mode for CMT</title> |
|---|
| 13 | </head> |
|---|
| 14 | |
|---|
| 15 | <body> |
|---|
| 16 | <center><h1>Emacs mode for CMT</h1></center> |
|---|
| 17 | |
|---|
| 18 | <center>***** Preliminary version v0.4 *****</center> |
|---|
| 19 | |
|---|
| 20 | <center><a href="mailto:perus@lal.in2p3.fr">Antoine Pérus</a></center> |
|---|
| 21 | |
|---|
| 22 | |
|---|
| 23 | <p>The CMT mode for XEmacs is intended to help editing CMT |
|---|
| 24 | requirements files. At the current time it allows coloration of |
|---|
| 25 | files, keyword completion and adds some specific keyword |
|---|
| 26 | motions.</p> |
|---|
| 27 | |
|---|
| 28 | <p>For more informations, type Ctl-h m</p> |
|---|
| 29 | |
|---|
| 30 | <p>CMT mode was only tested with XEmacs (formerly Lucid Emacs) |
|---|
| 31 | version 21.5 on my PowerBook with MacOS 10.3.3 ...</p> |
|---|
| 32 | |
|---|
| 33 | <p>In addition, CMT mode now works with FSF Emacs version 21.2.1 |
|---|
| 34 | in a slightly limited way. It may work with some earlier |
|---|
| 35 | versions, but has not been tested.</p> |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | <h2>Files</h2> |
|---|
| 39 | |
|---|
| 40 | <ul> |
|---|
| 41 | |
|---|
| 42 | <li><tt><a href="cmt-mode.el">cmt-mode.el</a></tt> source file of CMT mode</li> |
|---|
| 43 | |
|---|
| 44 | <li><tt><a href="init.el">init.el</a></tt> an example for a XEmacs init file</li> |
|---|
| 45 | |
|---|
| 46 | </ul> |
|---|
| 47 | |
|---|
| 48 | <h2>Installation for XEmacs</h2> |
|---|
| 49 | |
|---|
| 50 | <p>To install CMT mode, you need to insert the following lines |
|---|
| 51 | into your <tt>$HOME/.xemacs/init.el</tt> file.</p> |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | <pre> |
|---|
| 55 | ========================================================= |
|---|
| 56 | |
|---|
| 57 | ;; Tell xemacs where to look for CMT mode |
|---|
| 58 | ;; [useless if you put the cmt-mode.el in a directory in your load-path] |
|---|
| 59 | |
|---|
| 60 | (setq load-path (cons "<PATH-TO-CMT-MODE>/" load-path)) |
|---|
| 61 | |
|---|
| 62 | ;; Automatically load the CMT mode. |
|---|
| 63 | |
|---|
| 64 | (autoload 'cmt-mode "cmt-mode" "CMT requirements file editing mode." t) |
|---|
| 65 | (setq auto-mode-alist |
|---|
| 66 | (append (list (cons "requirements$" 'cmt-mode)) |
|---|
| 67 | auto-mode-alist)) |
|---|
| 68 | |
|---|
| 69 | ========================================================= |
|---|
| 70 | </pre> |
|---|
| 71 | |
|---|
| 72 | <i>[note that this may also work with recent versions of Emacs]</i> |
|---|
| 73 | |
|---|
| 74 | |
|---|
| 75 | <p>The hook needed to attach local keybindings is already defined |
|---|
| 76 | in <tt>cmt-mode.el</tt>. [For more informations, see <tt>Ctl-h |
|---|
| 77 | m</tt> when editing a requirements file]</p> |
|---|
| 78 | |
|---|
| 79 | <p>In addition, we provide a XEmacs init file example in the |
|---|
| 80 | distribution kit with two functions for commenting or uncommenting |
|---|
| 81 | regions as well as the keybindings to use them inside the CMT |
|---|
| 82 | mode.</p> |
|---|
| 83 | |
|---|
| 84 | |
|---|
| 85 | |
|---|
| 86 | <h2>Todo</h2> |
|---|
| 87 | |
|---|
| 88 | <p>Things I'd like to do (quickly) in CMT mode: (in approximate order of importance)</p> |
|---|
| 89 | |
|---|
| 90 | <ul> |
|---|
| 91 | |
|---|
| 92 | <li>full support of CMT keywords</li> |
|---|
| 93 | <li> decent indentation |
|---|
| 94 | <ul> |
|---|
| 95 | <li>syntax parser</li> |
|---|
| 96 | <li>indentation engine ?</li> |
|---|
| 97 | </ul> |
|---|
| 98 | </li> |
|---|
| 99 | <li> contextual completiony |
|---|
| 100 | <li> ??</li> |
|---|
| 101 | </ul> |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | <h2>Note</h2> |
|---|
| 105 | |
|---|
| 106 | <p>As already said it is a very preliminary version. Some |
|---|
| 107 | structures are in place but very few features are fully |
|---|
| 108 | implemented. Last but not least I'm not a lisp expert and this |
|---|
| 109 | mode is my first attempt.</p> |
|---|
| 110 | |
|---|
| 111 | <p>Please feel free to submit bugs and suggestions.</p> |
|---|
| 112 | |
|---|
| 113 | <hr> |
|---|
| 114 | <address><a href="mailto:arnault@lal.in2p3.fr">Christian Arnault</a></address> |
|---|
| 115 | <!-- Created: Tue Mar 23 10:39:25 CET 2004 --> |
|---|
| 116 | <!-- hhmts start --> |
|---|
| 117 | Last modified: Tue Mar 23 14:31:44 CET 2004 |
|---|
| 118 | <!-- hhmts end --> |
|---|
| 119 | </body> |
|---|
| 120 | </html> |
|---|
