gnu-emacs-sources
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

;;; jde-ant-docindex.el --- provides Ant task document indexing


From: Kevin A. Burton
Subject: ;;; jde-ant-docindex.el --- provides Ant task document indexing
Date: 16 Jan 2002 15:17:24 -0800
User-agent: Gnus/5.0808 (Gnus v5.8.8) Emacs/21.1.50

;;; jde-ant-docindex.el --- provides Ant task document indexing

;; $Id: $

;; Copyright (C) 2000-2003 Free Software Foundation, Inc.
;; Copyright (C) 2000-2003 Kevin A. Burton (address@hidden)

;; Author: Kevin A. Burton (address@hidden)
;; Maintainer: Kevin A. Burton (address@hidden)
;; Location: http://relativity.yi.org
;; Keywords: 
;; Version: 1.0.0

;; This file is [not yet] part of GNU Emacs.

;; This program is free software; you can redistribute it and/or modify it under
;; the terms of the GNU General Public License as published by the Free Software
;; Foundation; either version 2 of the License, or any later version.
;;
;; This program is distributed in the hope that it will be useful, but WITHOUT
;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
;; FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
;; details.
;;
;; You should have received a copy of the GNU General Public License along with
;; this program; if not, write to the Free Software Foundation, Inc., 59 Temple
;; Place - Suite 330, Boston, MA 02111-1307, USA.

;;; Commentary:

;; Provides a document index for Ant.  Basically this allows you to jump to an
;; HTML representation of known Ant tasks by name.

;; NOTE: If you enjoy this software, please consider a donation to the EFF
;; (http://www.eff.org)

;;; TODO:
;;
;; - Is there a better way of keeping tasks instead of encoding them in this
;;   file?
;;
;; - What should be do about optional tasks.

;;; Code:

(defcustom jde-ant-docindex-home-url 
"http://jakarta.apache.org/ant/manual/CoreTasks";
  "Home URL for Ant tasks.  This can be a local file:// URL if you want to keep
  your documentation local.  The jakara.apache.org URL is used so that we don't
  have to provide Ant documentation with `jde-ant-docindex'."
  :group 'jde-ant-docindex
  :type 'string)

(defcustom jde-ant-docindex-browse-url-function 'browse-url
  "Function to use to browse URLs.  This can be used with other browse URL
  functions so that `jde-ant-docindex' uses special behavior.  For example you
  can use `browse-url-netscape' to launch your documentation within netscape
  instead of the default `browse-url' behavior.  By default we just use
  `browse-url'."
  :group 'jde-ant-docindex
  :type 'symbol)

(defvar jde-ant-docindex-tasks '(("antcall")
                                 ("ant")
                                 ("antstructure")
                                 ("apply")
                                 ("available")
                                 ("checksum")
                                 ("chmod")
                                 ("common")
                                 ("condition")
                                 ("conditions")
                                 ("copydir")
                                 ("copyfile")
                                 ("copy")
                                 ("cvs")
                                 ("cvspass")
                                 ("delete")
                                 ("deltree")
                                 ("dependset")
                                 ("ear")
                                 ("echo")
                                 ("exec")
                                 ("fail")
                                 ("filter")
                                 ("fixcrlf")
                                 ("genkey")
                                 ("get")
                                 ("gunzip")
                                 ("gzip")
                                 ("input")
                                 ("jar")
                                 ("javac")
                                 ("javadoc")
                                 ("java")
                                 ("loadfile")
                                 ("mail")
                                 ("manifest")
                                 ("mkdir")
                                 ("move")
                                 ("overview")
                                 ("pack")
                                 ("parallel")
                                 ("patch")
                                 ("pathconvert")
                                 ("property")
                                 ("recorder")
                                 ("rename")
                                 ("replace")
                                 ("rmic")
                                 ("sequential")
                                 ("signjar")
                                 ("sleep")
                                 ("sql")
                                 ("style")
                                 ("tar")
                                 ("taskdef")
                                 ("test.txt")
                                 ("touch")
                                 ("tstamp")
                                 ("typedef")
                                 ("unpack")
                                 ("untar")
                                 ("unzip")
                                 ("uptodate")
                                 ("waitfor")
                                 ("war")
                                 ("zip"))
  "List of all known Ant tasks")

(defun jde-ant-docindex(task)
  "Jump to a tasks html definition."
  (interactive
   (list
    (completing-read "Ant task: " jde-ant-docindex-tasks nil t)))

  (funcall jde-ant-docindex-browse-url-function (concat 
jde-ant-docindex-home-url "/" task ".html")))

(provide 'jde-ant-docindex)

;;; jde-ant-docindex.el ends here

-- 
Kevin A. Burton ( address@hidden, address@hidden, address@hidden )
             Location - San Francisco, CA, Cell - 415.595.9965
        Jabber - address@hidden,  Web - http://relativity.yi.org/

Give a man a flame and keep him warm for the night. Set him on fire and keep
him warm for the rest of his life.






reply via email to

[Prev in Thread] Current Thread [Next in Thread]