Ncl-mode

Emacs editing mode for Ncar Command Language(NCL).

Introduction.

ncl-mode package contains emacs major mode and other utilities to help write Ncl scripts

Please do to confuse this mode with the other written by NCAR people. You may think this package newer and hopefully better Emacs support for Ncl.

Features

• Easy code navigation (consistent with other Emacs modes)
• Better indentation
• Proper comment handling
• Imenu support (my favorite)
• Menu support
• Snippets for yasnippet
• auto-complete support
• ctags support (ctags generation script included)
• ncl-doc-mode minor mode for browsing/searching NCL documentation from NCAR website
• inf-ncl.el mode for running NCL within Emacs.

Compatibility

This is know to work on emacs-24.1 and above. But may work with emacs-23.3.

This package is not compatible below emacs-23.2.

Installation

El-get (recommended way)

If you el-get just do = M-x el-get-install ncl-mode =

Manual Installation

• Download the package from the latest release from here

• unzip/untar put some where in your path (optionally rename it to ncl-mode)

• put the following your .emacs

  (load "/path/to/downloaded/ncl-mode/ncl-mode-load.el")
  

• That' it. It will take care of all the needed set up for ncl-mode, ncl-doc-mode, auto-complete, yasnippet and inf-ncl. If you care to know what they are, then read on..

Bug & Feature request

Please open a issue on github, if you have a patch want to contribute please drop me a mail (replace unicode character) or preferably make a pull request through github interface.

ncl-doc.el

Helps you read NCL documentation for NCAR website.

Usage:

M-x ncl-doc-query-at-point ( C-c C-s )

This function does few things.

1. It prompts for a string/keyword and collects a given string
2. It tries to find a URL for the given string
   • if it finds URL for the string call the browser to open that URL
   • If no URL is found, then goes on to search for the given string.
   • Displays all search matches in separate buffer category wise. In that buffer RET in any search match will call browser for take you to that page.
   • If no matches found for a given string it leaves you there

M-x ncl-doc-query-open ( C-c C-o )

Use this function you lets you choose from the all keywords ncl-doc has in its database and takes you to that page.

To get an idea what ncl-doc does: here I loaded the ncl-doc.el then called the function "ncl-doc-query-at-point" and given "add" string.

inf-ncl.el

Which lets you run NCL within Emacs and interact NCL process from ncl-mode buffer. ac-completion support is also available for this mode.

Utilities

gen-tags.sh

One liner to generate ctags from NCL Source files (look into tools directory); uses USAGE:

gen-tags.sh /path/to/ncl/files

if no arguments supplied it searches for ncl files in current directory including sub directories

Customization:

M-x customize-group RET ncl-doc RET check out the following variables

• `ncl-doc-url-base' = defaults to "http://www.ncl.ucar.edu" you can change this to any folder if you have downloaded the documentation from the NCL website and want read offline.

(setq ncl-doc-url-base "file:///home/yagnesh/docs/ncl/")

Tip from NCL website FAQ:

Is there a way I can download the NCL website documentation so I
can access it locally on my machine?

TJ Onley pointed out this nice solution. For example, if you just want
to download the files under http://www.ncl.ucar.edu/Document, use:

 wget -r -l0  -p -np -nH -k http://www.ncl.ucar.edu/Document/



This will create a directory called "Document", and in that directory,
you can open the "index.shtml" file with your web browser and have
access to all the files locally.

• `ncl-doc-minor-mode-hook'

Todos

See todo.org file.

License

GPL v3 (or later).