forked from mirrors/org-mode
58f1dbccf8
Also remove blank lines before the ";;; org*el ends here" declarations. Having a "Version" header forced us to update every file when releasing a new version of Org; it also forced us to update every file when merging Org with Emacs trunk, thus cluttering the diffs between the previously merged version and the new one with useless information. Glenn Morris suggested this in emacs-devel: http://lists.gnu.org/archive/html/emacs-devel/2011-08/msg00322.html
132 lines
4.8 KiB
EmacsLisp
132 lines
4.8 KiB
EmacsLisp
;;; org-annotate-file.el --- Annotate a file with org syntax
|
|
|
|
;; Copyright (C) 2008-2011 Philip Jackson
|
|
|
|
;; Author: Philip Jackson <phil@shellarchive.co.uk>
|
|
;; Version: 0.2
|
|
|
|
;; This file is not currently 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, or (at
|
|
;; your option) 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 ; see the file COPYING. If not, write to
|
|
;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
;; Boston, MA 02111-1307, USA.
|
|
|
|
;;; Commentary:
|
|
|
|
;; This is yet another implementation to allow the annotation of a
|
|
;; file without modification of the file itself. The annotation is in
|
|
;; org syntax so you can use all of the org features you are used to.
|
|
|
|
;; To use you might put the following in your .emacs:
|
|
;;
|
|
;; (require 'org-annotate-file)
|
|
;; (global-set-key (kbd "C-c C-l") 'org-annotate-file) ; for example
|
|
;;
|
|
;; To change the location of the annotation file:
|
|
;;
|
|
;; (setq org-annotate-file-storage-file "~/annotated.org")
|
|
;;
|
|
;; Then when you visit any file and hit C-c C-l you will find yourself
|
|
;; in an org buffer on a headline which links to the file you were
|
|
;; visiting, e.g:
|
|
|
|
;; * ~/org-annotate-file.el
|
|
|
|
;; Under here you can put anything you like, save the file
|
|
;; and next time you hit C-c C-l you will hit those notes again.
|
|
;;
|
|
;; To put a subheading with a text search for the current line set
|
|
;; `org-annotate-file-add-search` to non-nil value. Then when you hit
|
|
;; C-c C-l (on the above line for example) you will get:
|
|
|
|
;; * ~/org-annotate-file.el
|
|
;; ** `org-annotate-file-add-search` to non-nil value. Then whe...
|
|
|
|
;; Note that both of the above will be links.
|
|
|
|
(require 'org)
|
|
|
|
(defvar org-annotate-file-storage-file "~/.org-annotate-file.org"
|
|
"File in which to keep annotations.")
|
|
|
|
(defvar org-annotate-file-add-search nil
|
|
"If non-nil then add a link as a second level to the actual
|
|
location in the file")
|
|
|
|
(defvar org-annotate-file-always-open t
|
|
"non-nil means always expand the full tree when you visit
|
|
`org-annotate-file-storage-file'.")
|
|
|
|
(defun org-annotate-file-elipsify-desc (string &optional after)
|
|
"Strip starting and ending whitespace and replace any chars
|
|
that appear after the value in `after' with '...'"
|
|
(let* ((after (number-to-string (or after 30)))
|
|
(replace-map (list (cons "^[ \t]*" "")
|
|
(cons "[ \t]*$" "")
|
|
(cons (concat "^\\(.\\{" after
|
|
"\\}\\).*") "\\1..."))))
|
|
(mapc (lambda (x)
|
|
(when (string-match (car x) string)
|
|
(setq string (replace-match (cdr x) nil nil string))))
|
|
replace-map)
|
|
string))
|
|
|
|
(defun org-annotate-file ()
|
|
"Put a section for the current file into your annotation file"
|
|
(interactive)
|
|
(unless (buffer-file-name)
|
|
(error "This buffer has no associated file."))
|
|
(org-annotate-file-show-section))
|
|
|
|
(defun org-annotate-file-show-section (&optional buffer)
|
|
"Visit the buffer named `org-annotate-file-storage-file' and
|
|
show the relevant section"
|
|
(let* ((filename (abbreviate-file-name (or buffer (buffer-file-name))))
|
|
(line (buffer-substring-no-properties (point-at-bol) (point-at-eol)))
|
|
(link (org-make-link-string (concat "file:" filename) filename))
|
|
(search-link (org-make-link-string
|
|
(concat "file:" filename "::" line)
|
|
(org-annotate-file-elipsify-desc line))))
|
|
(with-current-buffer (find-file org-annotate-file-storage-file)
|
|
(unless (org-mode-p)
|
|
(org-mode))
|
|
(goto-char (point-min))
|
|
(widen)
|
|
(when org-annotate-file-always-open
|
|
(show-all))
|
|
(unless (search-forward-regexp
|
|
(concat "^* " (regexp-quote link)) nil t)
|
|
(org-annotate-file-add-upper-level link))
|
|
(beginning-of-line)
|
|
(org-narrow-to-subtree)
|
|
;; deal with a '::' search if need be
|
|
(when org-annotate-file-add-search
|
|
(unless (search-forward-regexp
|
|
(concat "^** " (regexp-quote search-link)) nil t)
|
|
(org-annotate-file-add-second-level search-link))))))
|
|
|
|
(defun org-annotate-file-add-upper-level (link)
|
|
(goto-char (point-min))
|
|
(call-interactively 'org-insert-heading)
|
|
(insert link))
|
|
|
|
(defun org-annotate-file-add-second-level (link)
|
|
(goto-char (point-at-eol))
|
|
(call-interactively 'org-insert-subheading)
|
|
(insert link))
|
|
|
|
(provide 'org-annotate-file)
|
|
|
|
;;; org-annotate-file.el ends here
|