Difference between revisions of "Ncl"

From WikEmacs
Jump to: navigation, search
(started)
Line 1: Line 1:
 +
{{Package
 +
|name=ncl.el
 +
|description=ncl-mode for editing NCL files.
 +
|maintainer= ncl folks (forked version by Yagnesh)
 +
|source=http://github.com/yyr/ncl.el
 +
|in_emacs=no
 +
|Development status=active
 +
|website=http://github.com/yyr/ncl.el
 +
}}
 +
 
'''NCL''' (NCAR Command Language) is popular language in Earth science
 
'''NCL''' (NCAR Command Language) is popular language in Earth science
 
to display scientific data.
 
to display scientific data.
  
= ncl-mode =
+
==ncl-mode==
 +
'''NOTE:''' There are two version of ncl.el. One is the official
 +
version by NCL folks which contains only ncl.el. The forked version
 +
contains few fixes to ncl.el and and ncl-doc el and other goodies to
 +
be used by other Emacs packages 
 +
 
 +
==ncl-doc-mode ==
 +
 
 +
'''ncl-doc''' minor mode helps you read NCL documentation from UCAR website
 +
 
 +
=== Basic Setup===
 +
to start ncl-doc-mode for each ncl buffer add  the following your [[.emacs]]
 +
<syntaxhighlight lang="lisp">
 +
 
 +
(require 'ncl-doc)
 +
(add-hook 'ncl-mode-hook
 +
  (lambda ()
 +
    (ncl-doc-minor-mode 1)))
 +
 
 +
</syntaxhighlight>
 +
 
 +
=== 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
  
= ncl-doc-mode =
+
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.
  
= setup =
 
  
= Basic Usage =
 
  
 
[[Category:Programming languages]][[Category:Sciences]]
 
[[Category:Programming languages]][[Category:Sciences]]

Revision as of 03:34, 31 March 2012

ncl.el
Description ncl-mode for editing NCL files.
Author name of author
Maintainer ncl folks (forked version by Yagnesh)
Source http://github.com/yyr/ncl.el
Part of Emacs no

NCL (NCAR Command Language) is popular language in Earth science to display scientific data.

ncl-mode

NOTE: There are two version of ncl.el. One is the official version by NCL folks which contains only ncl.el. The forked version contains few fixes to ncl.el and and ncl-doc el and other goodies to be used by other Emacs packages

ncl-doc-mode

ncl-doc minor mode helps you read NCL documentation from UCAR website

Basic Setup

to start ncl-doc-mode for each ncl buffer add the following your .emacs

(require 'ncl-doc)
(add-hook 'ncl-mode-hook
  (lambda ()
    (ncl-doc-minor-mode 1)))

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.