====== Plugin for the GNU EMACS editor ======

{{:emacs_screenshot.png?640|emacs screen shot for cp2k input}}

cp2k-mode.el provides a major mode in emacs for editing CP2K input
files. It has been tested on emacs 21, 23 and 24.

==== Functionalities ====

=== Recognises and font-locks ===

  * the full CP2K input preprocessor syntax
  * the sections and subsections
  * the keywords
  * the comment lines

=== Indents lines according to the CP2K input syntax using <tab> key ===

=== Input sections can be folded or unfolded, using emacs ''outline-minor-mode'' ===

  * ''outline-toggle-children'' when called on an unfolded section, folds the section recursively; when called on a folded section, unfolds the top level tree
  * ''show-all'' when called unfolds all sections recursively
  * ''show-subtree'' when called unfolds a folded section recursively

=== New interactive functions ===

  * ''cp2k-indent-line''        :: indents the line according to CP2K input syntax.
  * ''cp2k-beginning-of-block'' :: goes to the beginning of the subsection, marks the current cursor position.
  * ''cp2k-end-of-block''       :: goes to the ending of the subsection, marks the current cursor position.

=== Key Bindings ===

  * ''<tab>''   :: cp2k-indent-line
  * ''C-j''     :: newline-and-indent
  * ''C-c ;''   :: comment-region
  * ''C-M-a''   :: cp2k-beginning-of-block
  * ''C-M-e''   :: cp2k-end-of-block
  * ''C-c C-c'' :: outline-toggle-children
  * ''C-c C-a'' :: show-all
  * ''C-c C-t'' :: show-subtree

==== How to Obtain ====

You can download cp2k-mode.el from [[https://github.com/cp2k/cp2k/tree/master/tools/input_editing/emacs|the CP2K Repository]].

If you already have the code checked out locally, you can find it in:
<code>
cp2k/tools/input_editing/emacs/
</code>

==== Installation ====

You need to put cp2k-mode.el in one of your local emacs lisp directories, which is in the search path of your emacs installation.

=== Adding to emacs's search path ===

If you have never installed any packages manually before, and do not know the search path of your emacs installation, then in your home directory create directory:
<code>
~/.emacs.d/lisp/
</code>
This is the usual place where the local/user defined emacs lisp files are installed. Move cp2k-mode.el to ~/.emacs.d/lisp/

Then, add the following to your .emacs file (which should be in your home directory, and if it does not exist, create one):
<code lisp>
(add-to-list 'load-path "~/.emacs.d/lisp/")
</code>
This tells emacs to add ~/.emacs.d/lisp/ to its search path for *.el files.
                                                        
=== Tell emacs to load cp2k-mode.el at startup ===

Once cp2k-mode.el is in the search path, we need to tell emacs to load it at start up, this is done by adding
<code lisp>
(require 'cp2k-mode nil 'noerror)
</code>
to your .emacs file.

=== Tell emacs to recognise *.inp automatically as a cp2k input file ===

Add
<code lisp>
(add-to-list 'auto-mode-alist '("\\.inp\\'" . cp2k-mode))
</code>
to your .emacs file.