| blob | 637728e882c4a7817ebf9361d45593cddea8db77 |
1 #+OPTIONS: H:3 num:nil toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
2 #+STARTUP: align fold nodlcheck hidestars oddeven lognotestate
3 #+SEQ_TODO: TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
4 #+TAGS: Write(w) Update(u) Fix(f) Check(c)
5 #+TITLE: Org ad hoc code, quick hacks and workarounds
6 #+AUTHOR: Worg people
7 #+EMAIL: mdl AT imapmail DOT org
8 #+LANGUAGE: en
9 #+PRIORITIES: A C B
10 #+CATEGORY: worg
12 # This file is the default header for new Org files in Worg. Feel free
13 # to tailor it to your needs.
15 [[file:index.org][{Back to Worg's index}]]
17 This page is for ad hoc bits of code. Feel free to add quick hacks and
18 workaround. Go crazy.
20 * Hacking Org: Working within Org-mode.
21 ** Building and Managing Org
22 *** Compiling Org without make
23 :PROPERTIES:
24 :CUSTOM_ID: compiling-org-without-make
25 :END:
27 This file is the result of [[http://article.gmane.org/gmane.emacs.orgmode/15264][one of our discussions]] on the mailing list.
28 Enhancements welcome.
30 To use this function, adjust the variables =my/org-lisp-directory= and
31 =my/org-compile-sources= to suite your needs.
33 #+BEGIN_SRC emacs-lisp
34 (defvar my/org-lisp-directory "~/.emacs.d/org/lisp"
35 "Directory where your org-mode files live.")
37 (defvar my/org-compile-sources t
38 "If `nil', never compile org-sources. `my/compile-org' will only create
39 the autoloads file `org-install.el' then. If `t', compile the sources, too.")
41 ;; Customize:
42 (setq my/org-lisp-directory "~/.emacs.d/org/lisp")
44 ;; Customize:
45 (setq my/org-compile-sources t)
47 (defun my/compile-org(&optional directory)
48 "Compile all *.el files that come with org-mode."
49 (interactive)
50 (setq directory (concat
51 (file-truename
52 (or directory my/org-lisp-directory)) "/"))
54 (add-to-list 'load-path directory)
56 (let ((list-of-org-files (file-expand-wildcards (concat directory "*.el"))))
58 ;; create the org-install file
59 (require 'autoload)
60 (setq esf/org-install-file (concat directory "org-install.el"))
61 (find-file esf/org-install-file)
62 (erase-buffer)
63 (mapc (lambda (x)
64 (generate-file-autoloads x))
65 list-of-org-files)
66 (insert "\n(provide (quote org-install))\n")
67 (save-buffer)
68 (kill-buffer)
69 (byte-compile-file esf/org-install-file t)
71 (dolist (f list-of-org-files)
72 (if (file-exists-p (concat f "c")) ; delete compiled files
73 (delete-file (concat f "c")))
74 (if my/org-compile-sources ; Compile, if `my/org-compile-sources' is t
75 (byte-compile-file f)))))
76 #+END_SRC
77 *** Reload Org
79 As of Org version 6.23b (released Sunday Feb 22, 2009) there is a new
80 function to reload org files.
82 Normally you want to use the compiled files since they are faster.
83 If you update your org files you can easily reload them with
85 : M-x org-reload
87 If you run into a bug and want to generate a useful backtrace you can
88 reload the source files instead of the compiled files with
90 : C-u M-x org-reload
92 and turn on the "Enter Debugger On Error" option. Redo the action
93 that generates the error and cut and paste the resulting backtrace.
94 To switch back to the compiled version just reload again with
96 : M-x org-reload
98 *** Check for possibly problematic old link escapes
99 :PROPERTIES:
100 :CUSTOM_ID: check-old-link-escapes
101 :END:
103 Starting with version 7.5 Org uses [[http://en.wikipedia.org/wiki/Percent-encoding][percent escaping]] more consistently
104 and with a modified algorithm to determine which characters to escape
105 and how.
107 As a side effect this modified behaviour might break existing links if
108 they contain a sequence of characters that look like a percent escape
109 (e.g. =[0-9A-Fa-f]{2}=) but are in fact not a percent escape.
111 The function below can be used to perform a preliminary check for such
112 links in an Org mode file. It will run through all links in the file
113 and issue a warning if it finds a percent escape sequence which is not
114 in old Org's list of known percent escapes.
116 #+begin_src emacs-lisp
117 (defun dmaus/org-check-percent-escapes ()
118 "*Check buffer for possibly problematic old link escapes."
119 (interactive)
120 (when (eq major-mode 'org-mode)
121 (let ((old-escapes '("%20" "%5B" "%5D" "%E0" "%E2" "%E7" "%E8" "%E9"
122 "%EA" "%EE" "%F4" "%F9" "%FB" "%3B" "%3D" "%2B")))
123 (unless (boundp 'warning-suppress-types)
124 (setq warning-suppress-types nil))
125 (widen)
126 (show-all)
127 (goto-char (point-min))
128 (while (re-search-forward org-any-link-re nil t)
129 (let ((end (match-end 0)))
130 (goto-char (match-beginning 0))
131 (while (re-search-forward "%[0-9a-zA-Z]\\{2\\}" end t)
132 (let ((escape (match-string-no-properties 0)))
133 (unless (member (upcase escape) old-escapes)
134 (warn "Found unknown percent escape sequence %s at buffer %s, position %d"
135 escape
136 (buffer-name)
137 (- (point) 3)))))
138 (goto-char end))))))
139 #+end_src
141 ** Structure Movement and Editing
142 *** Show next/prev heading tidily
143 - Dan Davison
144 These close the current heading and open the next/previous heading.
146 #+begin_src emacs-lisp
147 (defun ded/org-show-next-heading-tidily ()
148 "Show next entry, keeping other entries closed."
149 (if (save-excursion (end-of-line) (outline-invisible-p))
150 (progn (org-show-entry) (show-children))
151 (outline-next-heading)
152 (unless (and (bolp) (org-on-heading-p))
153 (org-up-heading-safe)
154 (hide-subtree)
155 (error "Boundary reached"))
156 (org-overview)
157 (org-reveal t)
158 (org-show-entry)
159 (show-children)))
161 (defun ded/org-show-previous-heading-tidily ()
162 "Show previous entry, keeping other entries closed."
163 (let ((pos (point)))
164 (outline-previous-heading)
165 (unless (and (< (point) pos) (bolp) (org-on-heading-p))
166 (goto-char pos)
167 (hide-subtree)
168 (error "Boundary reached"))
169 (org-overview)
170 (org-reveal t)
171 (org-show-entry)
172 (show-children)))
174 (setq org-use-speed-commands t)
175 (add-to-list 'org-speed-commands-user
176 '("n" ded/org-show-next-heading-tidily))
177 (add-to-list 'org-speed-commands-user
178 '("p" ded/org-show-previous-heading-tidily))
179 #+end_src
181 *** Promote all items in subtree
182 - Matt Lundin
184 This function will promote all items in a subtree. Since I use
185 subtrees primarily to organize projects, the function is somewhat
186 unimaginatively called my-org-un-project:
188 #+begin_src emacs-lisp
189 (defun my-org-un-project ()
190 (interactive)
191 (org-map-entries 'org-do-promote "LEVEL>1" 'tree)
192 (org-cycle t))
193 #+end_src
195 *** Turn a heading into an Org link
196 :PROPERTIES:
197 :CUSTOM_ID: heading-to-link
198 :END:
200 From David Maus:
202 #+begin_src emacs-lisp
203 (defun dmj:turn-headline-into-org-mode-link ()
204 "Replace word at point by an Org mode link."
205 (interactive)
206 (when (org-at-heading-p)
207 (let ((hl-text (nth 4 (org-heading-components))))
208 (unless (or (null hl-text)
209 (org-string-match-p "^[ \t]*:[^:]+:$" hl-text))
210 (beginning-of-line)
211 (search-forward hl-text (point-at-eol))
212 (replace-string
213 hl-text
214 (format "[[file:%s.org][%s]]"
215 (org-link-escape hl-text)
216 (org-link-escape hl-text '((?\] . "%5D") (?\[ . "%5B"))))
217 nil (- (point) (length hl-text)) (point))))))
218 #+end_src
220 *** Using M-up and M-down to transpose paragraphs
222 From Paul Sexton: By default, if used within ordinary paragraphs in
223 org mode, =M-up= and =M-down= transpose *lines* (not sentences). The
224 following code makes these keys transpose paragraphs, keeping the
225 point at the start of the moved paragraph. Behavior in tables and
226 headings is unaffected. It would be easy to modify this to transpose
227 sentences.
229 #+begin_src emacs-lisp
230 (defun org-transpose-paragraphs (arg)
231 (interactive)
232 (when (and (not (or (org-at-table-p) (org-on-heading-p) (org-at-item-p)))
233 (thing-at-point 'sentence))
234 (transpose-paragraphs arg)
235 (backward-paragraph)
236 (re-search-forward "[[:graph:]]")
237 (goto-char (match-beginning 0))
238 t))
240 (add-to-list 'org-metaup-hook
241 (lambda () (interactive) (org-transpose-paragraphs -1)))
242 (add-to-list 'org-metadown-hook
243 (lambda () (interactive) (org-transpose-paragraphs 1)))
244 #+end_src
245 *** Changelog support for org headers
246 -- James TD Smith
248 Put the following in your =.emacs=, and =C-x 4 a= and other functions which
249 use =add-log-current-defun= like =magit-add-log= will pick up the nearest org
250 headline as the "current function" if you add a changelog entry from an org
251 buffer.
253 #+BEGIN_SRC emacs-lisp
254 (defun org-log-current-defun ()
255 (save-excursion
256 (org-back-to-heading)
257 (if (looking-at org-complex-heading-regexp)
258 (match-string 4))))
260 (add-hook 'org-mode-hook
261 (lambda ()
262 (make-variable-buffer-local 'add-log-current-defun-function)
263 (setq add-log-current-defun-function 'org-log-current-defun)))
264 #+END_SRC
266 *** Different org-cycle-level behavior
267 -- Ryan Thompson
269 In recent org versions, when your point (cursor) is at the end of an
270 empty header line (like after you first created the header), the TAB
271 key (=org-cycle=) has a special behavior: it cycles the headline through
272 all possible levels. However, I did not like the way it determined
273 "all possible levels," so I rewrote the whole function, along with a
274 couple of supporting functions.
276 The original function's definition of "all possible levels" was "every
277 level from 1 to one more than the initial level of the current
278 headline before you started cycling." My new definition is "every
279 level from 1 to one more than the previous headline's level." So, if
280 you have a headline at level 4 and you use ALT+RET to make a new
281 headline below it, it will cycle between levels 1 and 5, inclusive.
283 The main advantage of my custom =org-cycle-level= function is that it
284 is stateless: the next level in the cycle is determined entirely by
285 the contents of the buffer, and not what command you executed last.
286 This makes it more predictable, I hope.
288 #+BEGIN_SRC emacs-lisp
289 (require 'cl)
291 (defun org-point-at-end-of-empty-headline ()
292 "If point is at the end of an empty headline, return t, else nil."
293 (and (looking-at "[ \t]*$")
294 (save-excursion
295 (beginning-of-line 1)
296 (looking-at (concat "^\\(\\*+\\)[ \t]+\\(" org-todo-regexp "\\)?[ \t]*")))))
298 (defun org-level-increment ()
299 "Return the number of stars that will be added or removed at a
300 time to headlines when structure editing, based on the value of
301 `org-odd-levels-only'."
302 (if org-odd-levels-only 2 1))
304 (defvar org-previous-line-level-cached nil)
306 (defun org-recalculate-previous-line-level ()
307 "Same as `org-get-previous-line-level', but does not use cached
308 value. It does *set* the cached value, though."
309 (set 'org-previous-line-level-cached
310 (let ((current-level (org-current-level))
311 (prev-level (when (> (line-number-at-pos) 1)
312 (save-excursion
313 (previous-line)
314 (org-current-level)))))
315 (cond ((null current-level) nil) ; Before first headline
316 ((null prev-level) 0) ; At first headline
317 (prev-level)))))
319 (defun org-get-previous-line-level ()
320 "Return the outline depth of the last headline before the
321 current line. Returns 0 for the first headline in the buffer, and
322 nil if before the first headline."
323 ;; This calculation is quite expensive, with all the regex searching
324 ;; and stuff. Since org-cycle-level won't change lines, we can reuse
325 ;; the last value of this command.
326 (or (and (eq last-command 'org-cycle-level)
327 org-previous-line-level-cached)
328 (org-recalculate-previous-line-level)))
330 (defun org-cycle-level ()
331 (interactive)
332 (let ((org-adapt-indentation nil))
333 (when (org-point-at-end-of-empty-headline)
334 (setq this-command 'org-cycle-level) ;Only needed for caching
335 (let ((cur-level (org-current-level))
336 (prev-level (org-get-previous-line-level)))
337 (cond
338 ;; If first headline in file, promote to top-level.
339 ((= prev-level 0)
340 (loop repeat (/ (- cur-level 1) (org-level-increment))
341 do (org-do-promote)))
342 ;; If same level as prev, demote one.
343 ((= prev-level cur-level)
344 (org-do-demote))
345 ;; If parent is top-level, promote to top level if not already.
346 ((= prev-level 1)
347 (loop repeat (/ (- cur-level 1) (org-level-increment))
348 do (org-do-promote)))
349 ;; If top-level, return to prev-level.
350 ((= cur-level 1)
351 (loop repeat (/ (- prev-level 1) (org-level-increment))
352 do (org-do-demote)))
353 ;; If less than prev-level, promote one.
354 ((< cur-level prev-level)
355 (org-do-promote))
356 ;; If deeper than prev-level, promote until higher than
357 ;; prev-level.
358 ((> cur-level prev-level)
359 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
360 do (org-do-promote))))
361 t))))
362 #+END_SRC
364 *** Count words in an Org buffer
365 #FIXME: Does not fit too well under Structure. Any idea where to put it?
366 Paul Sexton [[http://article.gmane.org/gmane.emacs.orgmode/38014][posted]] this function to count words in an Org buffer:
368 #+begin_src emacs-lisp
369 (defun org-word-count (beg end
370 &optional count-latex-macro-args?
371 count-footnotes?)
372 "Report the number of words in the Org mode buffer or selected region.
373 Ignores:
374 - comments
375 - tables
376 - source code blocks (#+BEGIN_SRC ... #+END_SRC, and inline blocks)
377 - hyperlinks (but does count words in hyperlink descriptions)
378 - tags, priorities, and TODO keywords in headers
379 - sections tagged as 'not for export'.
381 The text of footnote definitions is ignored, unless the optional argument
382 COUNT-FOOTNOTES? is non-nil.
384 If the optional argument COUNT-LATEX-MACRO-ARGS? is non-nil, the word count
385 includes LaTeX macro arguments (the material between {curly braces}).
386 Otherwise, and by default, every LaTeX macro counts as 1 word regardless
387 of its arguments."
388 (interactive "r")
389 (unless mark-active
390 (setf beg (point-min)
391 end (point-max)))
392 (let ((wc 0)
393 (latex-macro-regexp "\\\\[A-Za-z]+\\(\\[[^]]*\\]\\|\\){\\([^}]*\\)}"))
394 (save-excursion
395 (goto-char beg)
396 (while (< (point) end)
397 (cond
398 ;; Ignore comments.
399 ((or (org-in-commented-line) (org-at-table-p))
400 nil)
401 ;; Ignore hyperlinks. But if link has a description, count
402 ;; the words within the description.
403 ((looking-at org-bracket-link-analytic-regexp)
404 (when (match-string-no-properties 5)
405 (let ((desc (match-string-no-properties 5)))
406 (save-match-data
407 (incf wc (length (remove "" (org-split-string
408 desc "\\W")))))))
409 (goto-char (match-end 0)))
410 ((looking-at org-any-link-re)
411 (goto-char (match-end 0)))
412 ;; Ignore source code blocks.
413 ((org-in-regexps-block-p "^#\\+BEGIN_SRC\\W" "^#\\+END_SRC\\W")
414 nil)
415 ;; Ignore inline source blocks, counting them as 1 word.
416 ((save-excursion
417 (backward-char)
418 (looking-at org-babel-inline-src-block-regexp))
419 (goto-char (match-end 0))
420 (setf wc (+ 2 wc)))
421 ;; Count latex macros as 1 word, ignoring their arguments.
422 ((save-excursion
423 (backward-char)
424 (looking-at latex-macro-regexp))
425 (goto-char (if count-latex-macro-args?
426 (match-beginning 2)
427 (match-end 0)))
428 (setf wc (+ 2 wc)))
429 ;; Ignore footnotes.
430 ((and (not count-footnotes?)
431 (or (org-footnote-at-definition-p)
432 (org-footnote-at-reference-p)))
433 nil)
434 (t
435 (let ((contexts (org-context)))
436 (cond
437 ;; Ignore tags and TODO keywords, etc.
438 ((or (assoc :todo-keyword contexts)
439 (assoc :priority contexts)
440 (assoc :keyword contexts)
441 (assoc :checkbox contexts))
442 nil)
443 ;; Ignore sections marked with tags that are
444 ;; excluded from export.
445 ((assoc :tags contexts)
446 (if (intersection (org-get-tags-at) org-export-exclude-tags
447 :test 'equal)
448 (org-forward-same-level 1)
449 nil))
450 (t
451 (incf wc))))))
452 (re-search-forward "\\w+\\W*")))
453 (message (format "%d words in %s." wc
454 (if mark-active "region" "buffer")))))
455 #+end_src
457 ** Org Table
458 *** Transpose table
459 :PROPERTIES:
460 :CUSTOM_ID: transpose-table
461 :END:
463 This function by Juan Pechiar will transpose a table:
465 #+begin_src emacs-lisp
466 (defun org-transpose-table-at-point ()
467 "Transpose orgmode table at point, eliminate hlines"
468 (interactive)
469 (let ((contents
470 (apply #'mapcar* #'list
471 ;; remove 'hline from list
472 (remove-if-not 'listp
473 ;; signals error if not table
474 (org-table-to-lisp)))))
475 (delete-region (org-table-begin) (org-table-end))
476 (insert (mapconcat (lambda(x) (concat "| " (mapconcat 'identity x " | " ) " |\n" ))
477 contents ""))
478 (org-table-align)))
479 #+end_src
481 So a table like
483 : | 1 | 2 | 4 | 5 |
484 : |---+---+---+---|
485 : | a | b | c | d |
486 : | e | f | g | h |
488 will be transposed as
490 : | 1 | a | e |
491 : | 2 | b | f |
492 : | 4 | c | g |
493 : | 5 | d | h |
495 (Note that horizontal lines disappeared.)
497 There are also other solutions:
498 - with org-babel and Emacs Lisp: provided by Thomas S. Dye in the mailing
499 list, see
500 [[http://thread.gmane.org/gmane.emacs.orgmode/23809/focus=23815][gmane]]
501 or
502 [[http://lists.gnu.org/archive/html/emacs-orgmode/2010-04/msg00239.html][gnu]]
503 - with org-babel and R: provided by Dan Davison in the mailing list (old
504 =#+TBLR:= syntax), see
505 [[http://thread.gmane.org/gmane.emacs.orgmode/10159/focus=10159][gmane]]
506 or
507 [[http://lists.gnu.org/archive/html/emacs-orgmode/2008-12/msg00454.html][gnu]]
508 - with field coordinates in formulas (=@#= and =$#=): see
509 [[file:org-hacks.org::#field-coordinates-in-formulas-transpose-table][Worg]].
511 *** Manipulate hours/minutes/seconds in table formulas
513 Both Bastien and Martin Halder have posted code ([[http://article.gmane.org/gmane.emacs.orgmode/39519][Bastien's code]] and
514 [[http://article.gmane.org/gmane.emacs.orgmode/39519][Martin's code]]) for interpreting =dd:dd= or =dd:dd:dd= strings (where
515 "=d=" is any digit) as time values in Org-mode table formula. These
516 functions have now been wrapped up into a =with-time= macro which can
517 be used in table formula to translate table cell values to and from
518 numerical values for algebraic manipulation.
520 Here is the code implementing this macro.
521 #+begin_src emacs-lisp :results silent
522 (defun org-time-string-to-seconds (s)
523 "Convert a string HH:MM:SS to a number of seconds."
524 (cond
525 ((and (stringp s)
526 (string-match "\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)" s))
527 (let ((hour (string-to-number (match-string 1 s)))
528 (min (string-to-number (match-string 2 s)))
529 (sec (string-to-number (match-string 3 s))))
530 (+ (* hour 3600) (* min 60) sec)))
531 ((and (stringp s)
532 (string-match "\\([0-9]+\\):\\([0-9]+\\)" s))
533 (let ((min (string-to-number (match-string 1 s)))
534 (sec (string-to-number (match-string 2 s))))
535 (+ (* min 60) sec)))
536 ((stringp s) (string-to-number s))
537 (t s)))
539 (defun org-time-seconds-to-string (secs)
540 "Convert a number of seconds to a time string."
541 (cond ((>= secs 3600) (format-seconds "%h:%.2m:%.2s" secs))
542 ((>= secs 60) (format-seconds "%m:%.2s" secs))
543 (t (format-seconds "%s" secs))))
545 (defmacro with-time (time-output-p &rest exprs)
546 "Evaluate an org-table formula, converting all fields that look
547 like time data to integer seconds. If TIME-OUTPUT-P then return
548 the result as a time value."
549 (list
550 (if time-output-p 'org-time-seconds-to-string 'identity)
551 (cons 'progn
552 (mapcar
553 (lambda (expr)
554 `,(cons (car expr)
555 (mapcar
556 (lambda (el)
557 (if (listp el)
558 (list 'with-time nil el)
559 (org-time-string-to-seconds el)))
560 (cdr expr))))
561 `,@exprs))))
562 #+end_src
564 Which allows the following forms of table manipulation such as adding
565 and subtracting time values.
566 : | Date | Start | Lunch | Back | End | Sum |
567 : |------------------+-------+-------+-------+-------+------|
568 : | [2011-03-01 Tue] | 8:00 | 12:00 | 12:30 | 18:15 | 9:45 |
569 : #+TBLFM: $6='(with-time t (+ (- $5 $4) (- $3 $2)))
571 and dividing time values by integers
572 : | time | miles | minutes/mile |
573 : |-------+-------+--------------|
574 : | 34:43 | 2.9 | 11:58 |
575 : | 32:15 | 2.77 | 11:38 |
576 : | 33:56 | 3.0 | 11:18 |
577 : | 52:22 | 4.62 | 11:20 |
578 : #+TBLFM: $3='(with-time t (/ $1 $2))
580 *Update*: As of Org version 7.6, you can use the =T= flag (both in Calc and
581 Elisp formulas) to compute time durations. For example:
583 : | Task 1 | Task 2 | Total |
584 : |--------+--------+---------|
585 : | 35:00 | 35:00 | 1:10:00 |
586 : #+TBLFM: @2$3=$1+$2;T
588 *** Dates computation
590 Xin Shi [[http://article.gmane.org/gmane.emacs.orgmode/15692][asked]] for a way to calculate the duration of
591 dates stored in an org table.
593 Nick Dokos [[http://article.gmane.org/gmane.emacs.orgmode/15694][suggested]]:
595 Try the following:
597 | Start Date | End Date | Duration |
598 |------------+------------+----------|
599 | 2004.08.07 | 2005.07.08 | 335 |
600 :#+TBLFM: $3=(date(<$2>)-date(<$1>))
602 See [[http://thread.gmane.org/gmane.emacs.orgmode/7741][this thread]] as well as [[http://article.gmane.org/gmane.emacs.orgmode/7753][this post]] (which is really a followup on the
603 above). The problem that this last article pointed out was solved in [[http://article.gmane.org/gmane.emacs.orgmode/8001][this
604 post]] and Chris Randle's original musings are [[http://article.gmane.org/gmane.emacs.orgmode/6536/][here]].
606 *** Hex computation
608 As with Times computation, the following code allows Computation with
609 Hex values in Org-mode tables using the =with-hex= macro.
611 Here is the code implementing this macro.
612 #+begin_src emacs-lisp
613 (defun org-hex-strip-lead (str)
614 (if (and (> (length str) 2) (string= (substring str 0 2) "0x"))
615 (substring str 2) str))
617 (defun org-hex-to-hex (int)
618 (format "0x%x" int))
620 (defun org-hex-to-dec (str)
621 (cond
622 ((and (stringp str)
623 (string-match "\\([0-9a-f]+\\)" (setf str (org-hex-strip-lead str))))
624 (let ((out 0))
625 (mapc
626 (lambda (ch)
627 (setf out (+ (* out 16)
628 (if (and (>= ch 48) (<= ch 57)) (- ch 48) (- ch 87)))))
629 (coerce (match-string 1 str) 'list))
630 out))
631 ((stringp str) (string-to-number str))
632 (t str)))
634 (defmacro with-hex (hex-output-p &rest exprs)
635 "Evaluate an org-table formula, converting all fields that look
636 like hexadecimal to decimal integers. If HEX-OUTPUT-P then
637 return the result as a hex value."
638 (list
639 (if hex-output-p 'org-hex-to-hex 'identity)
640 (cons 'progn
641 (mapcar
642 (lambda (expr)
643 `,(cons (car expr)
644 (mapcar (lambda (el)
645 (if (listp el)
646 (list 'with-hex nil el)
647 (org-hex-to-dec el)))
648 (cdr expr))))
649 `,@exprs))))
650 #+end_src
652 Which allows the following forms of table manipulation such as adding
653 and subtracting hex values.
654 | 0x10 | 0x0 | 0x10 | 16 |
655 | 0x20 | 0x1 | 0x21 | 33 |
656 | 0x30 | 0x2 | 0x32 | 50 |
657 | 0xf0 | 0xf | 0xff | 255 |
658 #+TBLFM: $3='(with-hex 'hex (+ $2 $1))::$4='(with-hex nil (identity $3))
660 *** Field coordinates in formulas (=@#= and =$#=)
661 :PROPERTIES:
662 :CUSTOM_ID: field-coordinates-in-formulas
663 :END:
665 -- Michael Brand
667 Following are some use cases that can be implemented with the “field
668 coordinates in formulas” described in the corresponding chapter in the
669 [[http://orgmode.org/manual/References.html#References][Org manual]].
671 **** Copy a column from a remote table into a column
672 :PROPERTIES:
673 :CUSTOM_ID: field-coordinates-in-formulas-copy-col-to-col
674 :END:
676 current column =$3= = remote column =$2=:
677 : #+TBLFM: $3 = remote(FOO, @@#$2)
679 **** Copy a row from a remote table transposed into a column
680 :PROPERTIES:
681 :CUSTOM_ID: field-coordinates-in-formulas-copy-row-to-col
682 :END:
684 current column =$1= = transposed remote row =@1=:
685 : #+TBLFM: $1 = remote(FOO, @$#$@#)
687 **** Transpose table
688 :PROPERTIES:
689 :CUSTOM_ID: field-coordinates-in-formulas-transpose-table
690 :END:
692 -- Michael Brand
694 This is more like a demonstration of using “field coordinates in formulas”
695 and is bound to be slow for large tables. See the discussion in the mailing
696 list on
697 [[http://thread.gmane.org/gmane.emacs.orgmode/22610/focus=23662][gmane]] or
698 [[http://lists.gnu.org/archive/html/emacs-orgmode/2010-04/msg00086.html][gnu]].
699 For more efficient solutions see
700 [[file:org-hacks.org::#transpose-table][Worg]].
702 To transpose this 4x7 table
704 : #+TBLNAME: FOO
705 : | year | 2004 | 2005 | 2006 | 2007 | 2008 | 2009 |
706 : |------+------+------+------+------+------+------|
707 : | min | 401 | 501 | 601 | 701 | 801 | 901 |
708 : | avg | 402 | 502 | 602 | 702 | 802 | 902 |
709 : | max | 403 | 503 | 603 | 703 | 803 | 903 |
711 start with a 7x4 table without any horizontal line (to have filled
712 also the column header) and yet empty:
714 : | | | | |
715 : | | | | |
716 : | | | | |
717 : | | | | |
718 : | | | | |
719 : | | | | |
720 : | | | | |
722 Then add the =TBLFM= line below. After recalculation this will end up with
723 the transposed copy:
725 : | year | min | avg | max |
726 : | 2004 | 401 | 402 | 403 |
727 : | 2005 | 501 | 502 | 503 |
728 : | 2006 | 601 | 602 | 603 |
729 : | 2007 | 701 | 702 | 703 |
730 : | 2008 | 801 | 802 | 803 |
731 : | 2009 | 901 | 902 | 903 |
732 : #+TBLFM: @<$<..@>$> = remote(FOO, @$#$@#)
734 The formula simply exchanges row and column numbers by taking
735 - the absolute remote row number =@$#= from the current column number =$#=
736 - the absolute remote column number =$@#= from the current row number =@#=
738 Formulas to be taken over from the remote table will have to be transformed
739 manually.
741 **** Dynamic variation of ranges
743 -- Michael Brand
745 In this example all columns next to =quote= are calculated from the column
746 =quote= and show the average change of the time series =quote[year]=
747 during the period of the preceding =1=, =2=, =3= or =4= years:
749 : | year | quote | 1 a | 2 a | 3 a | 4 a |
750 : |------+-------+-------+-------+-------+-------|
751 : | 2005 | 10 | | | | |
752 : | 2006 | 12 | 0.200 | | | |
753 : | 2007 | 14 | 0.167 | 0.183 | | |
754 : | 2008 | 16 | 0.143 | 0.155 | 0.170 | |
755 : | 2009 | 18 | 0.125 | 0.134 | 0.145 | 0.158 |
756 : #+TBLFM: @I$3..@>$>=if(@# >= $#, ($2 / subscr(@-I$2..@+I$2, @# + 1 - $#)) ^ (1 / ($# - 2)) - 1, string("")) +.0; f-3
758 The important part of the formula without the field blanking is:
760 : ($2 / subscr(@-I$2..@+I$2, @# + 1 - $#)) ^ (1 / ($# - 2)) - 1
762 which is the Emacs Calc implementation of the equation
764 /AvgChange(i, a) = (quote[i] / quote[i - a]) ^ (1 / a) - 1/
766 where /i/ is the current time and /a/ is the length of the preceding period.
768 ** Capture and Remember
769 *** Customize the size of the frame for remember
770 (Note: this hack is likely out of date due to the development of
771 [[org-capture]].)
773 #FIXME: gmane link?
774 On emacs-orgmode, Ryan C. Thompson suggested this:
776 #+begin_quote
777 I am using org-remember set to open a new frame when used,
778 and the default frame size is much too large. To fix this, I have
779 designed some advice and a custom variable to implement custom
780 parameters for the remember frame:
781 #+end_quote
783 #+begin_src emacs-lisp
784 (defcustom remember-frame-alist nil
785 "Additional frame parameters for dedicated remember frame."
786 :type 'alist
787 :group 'remember)
789 (defadvice remember (around remember-frame-parameters activate)
790 "Set some frame parameters for the remember frame."
791 (let ((default-frame-alist (append remember-frame-alist
792 default-frame-alist)))
793 ad-do-it))
794 #+end_src
796 Setting remember-frame-alist to =((width . 80) (height . 15)))= give a
797 reasonable size for the frame.
798 ** Handling Links
799 *** [[#heading-to-link][Turn a heading into an org link]]
800 *** Quickaccess to the link part of hyperlinks
801 Christian Moe [[http://permalink.gmane.org/gmane.emacs.orgmode/43122][asked]], if there is a simpler way to copy the link part
802 of an org hyperling other than to use `C-c C-l C-a C-k C-g',
803 which is indeed kind of cumbersome.
805 The thread offered [[http://permalink.gmane.org/gmane.emacs.orgmode/43606][two ways]]:
807 Using a [[http://www.gnu.org/software/emacs/manual/html_node/emacs/Keyboard-Macros.html][keyboard macro]]:
808 #+begin_src emacs-lisp
809 (fset 'getlink
810 (lambda (&optional arg)
811 "Keyboard macro."
812 (interactive "p")
813 (kmacro-exec-ring-item (quote ("\C-c\C-l\C-a\C-k\C-g" 0 "%d")) arg)))
814 #+end_src
816 or a function:
817 #+begin_src emacs-lisp
818 (defun my-org-extract-link ()
819 "Extract the link location at point and put it on the killring."
820 (interactive)
821 (when (org-in-regexp org-bracket-link-regexp 1)
822 (kill-new (org-link-unescape (org-match-string-no-properties 1)))))
823 #+end_src
825 They put the link destination on the killring and can be easily bound to a key.
827 ** Archiving Content in Org-Mode
828 *** Preserve top level headings when archiving to a file
829 - Matt Lundin
831 To preserve (somewhat) the integrity of your archive structure while
832 archiving lower level items to a file, you can use the following
833 defadvice:
835 #+begin_src emacs-lisp
836 (defadvice org-archive-subtree (around my-org-archive-subtree activate)
837 (let ((org-archive-location
838 (if (save-excursion (org-back-to-heading)
839 (> (org-outline-level) 1))
840 (concat (car (split-string org-archive-location "::"))
841 "::* "
842 (car (org-get-outline-path)))
843 org-archive-location)))
844 ad-do-it))
845 #+end_src
847 Thus, if you have an outline structure such as...
849 #+begin_src org
850 ,* Heading
851 ,** Subheading
852 ,*** Subsubheading
853 #+end_src
855 ...archiving "Subsubheading" to a new file will set the location in
856 the new file to the top level heading:
858 #+begin_src org
859 ,* Heading
860 ,** Subsubheading
861 #+end_src
863 While this hack obviously destroys the outline hierarchy somewhat, it
864 at least preserves the logic of level one groupings.
866 A slightly more complex version of this hack will not only keep the
867 archive organized by top-level headings, but will also preserve the
868 tags found on those headings:
870 #+begin_src emacs-lisp
871 (defun my-org-inherited-no-file-tags ()
872 (let ((tags (org-entry-get nil "ALLTAGS" 'selective))
873 (ltags (org-entry-get nil "TAGS")))
874 (mapc (lambda (tag)
875 (setq tags
876 (replace-regexp-in-string (concat tag ":") "" tags)))
877 (append org-file-tags (when ltags (split-string ltags ":" t))))
878 (if (string= ":" tags) nil tags)))
880 (defadvice org-archive-subtree (around my-org-archive-subtree-low-level activate)
881 (let ((tags (my-org-inherited-no-file-tags))
882 (org-archive-location
883 (if (save-excursion (org-back-to-heading)
884 (> (org-outline-level) 1))
885 (concat (car (split-string org-archive-location "::"))
886 "::* "
887 (car (org-get-outline-path)))
888 org-archive-location)))
889 ad-do-it
890 (with-current-buffer (find-file-noselect (org-extract-archive-file))
891 (save-excursion
892 (while (org-up-heading-safe))
893 (org-set-tags-to tags)))))
894 #+end_src
896 *** Archive in a date tree
898 Posted to Org-mode mailing list by Osamu Okano [2010-04-21 Wed].
900 (Make sure org-datetree.el is loaded for this to work.)
902 #+begin_src emacs-lisp
903 ;; (setq org-archive-location "%s_archive::date-tree")
904 (defadvice org-archive-subtree
905 (around org-archive-subtree-to-data-tree activate)
906 "org-archive-subtree to date-tree"
907 (if
908 (string= "date-tree"
909 (org-extract-archive-heading
910 (org-get-local-archive-location)))
911 (let* ((dct (decode-time (org-current-time)))
912 (y (nth 5 dct))
913 (m (nth 4 dct))
914 (d (nth 3 dct))
915 (this-buffer (current-buffer))
916 (location (org-get-local-archive-location))
917 (afile (org-extract-archive-file location))
918 (org-archive-location
919 (format "%s::*** %04d-%02d-%02d %s" afile y m d
920 (format-time-string "%A" (encode-time 0 0 0 d m y)))))
921 (message "afile=%s" afile)
922 (unless afile
923 (error "Invalid `org-archive-location'"))
924 (save-excursion
925 (switch-to-buffer (find-file-noselect afile))
926 (org-datetree-find-year-create y)
927 (org-datetree-find-month-create y m)
928 (org-datetree-find-day-create y m d)
929 (widen)
930 (switch-to-buffer this-buffer))
931 ad-do-it)
932 ad-do-it))
933 #+end_src
935 *** Add inherited tags to archived entries
937 To make =org-archive-subtree= keep inherited tags, Osamu OKANO suggests to
938 advise the function like this:
940 #+begin_example
941 (defadvice org-archive-subtree
942 (before add-inherited-tags-before-org-archive-subtree activate)
943 "add inherited tags before org-archive-subtree"
944 (org-set-tags-to (org-get-tags-at)))
945 #+end_example
947 ** Using and Managing Org-Metadata
948 *** Remove redundant tags of headlines
949 -- David Maus
951 A small function that processes all headlines in current buffer and
952 removes tags that are local to a headline and inherited by a parent
953 headline or the #+FILETAGS: statement.
955 #+BEGIN_SRC emacs-lisp
956 (defun dmj/org-remove-redundant-tags ()
957 "Remove redundant tags of headlines in current buffer.
959 A tag is considered redundant if it is local to a headline and
960 inherited by a parent headline."
961 (interactive)
962 (when (eq major-mode 'org-mode)
963 (save-excursion
964 (org-map-entries
965 '(lambda ()
966 (let ((alltags (split-string (or (org-entry-get (point) "ALLTAGS") "") ":"))
967 local inherited tag)
968 (dolist (tag alltags)
969 (if (get-text-property 0 'inherited tag)
970 (push tag inherited) (push tag local)))
971 (dolist (tag local)
972 (if (member tag inherited) (org-toggle-tag tag 'off)))))
973 t nil))))
974 #+END_SRC
976 *** Remove empty property drawers
978 David Maus proposed this:
980 #+begin_src emacs-lisp
981 (defun dmj:org:remove-empty-propert-drawers ()
982 "*Remove all empty property drawers in current file."
983 (interactive)
984 (unless (eq major-mode 'org-mode)
985 (error "You need to turn on Org mode for this function."))
986 (save-excursion
987 (goto-char (point-min))
988 (while (re-search-forward ":PROPERTIES:" nil t)
989 (save-excursion
990 (org-remove-empty-drawer-at "PROPERTIES" (match-beginning 0))))))
991 #+end_src
993 *** Group task list by a property
995 This advice allows you to group a task list in Org-Mode. To use it,
996 set the variable =org-agenda-group-by-property= to the name of a
997 property in the option list for a TODO or TAGS search. The resulting
998 agenda view will group tasks by that property prior to searching.
1000 #+begin_src emacs-lisp
1001 (defvar org-agenda-group-by-property nil
1002 "Set this in org-mode agenda views to group tasks by property")
1004 (defun org-group-bucket-items (prop items)
1005 (let ((buckets ()))
1006 (dolist (item items)
1007 (let* ((marker (get-text-property 0 'org-marker item))
1008 (pvalue (org-entry-get marker prop t))
1009 (cell (assoc pvalue buckets)))
1010 (if cell
1011 (setcdr cell (cons item (cdr cell)))
1012 (setq buckets (cons (cons pvalue (list item))
1013 buckets)))))
1014 (setq buckets (mapcar (lambda (bucket)
1015 (cons (car bucket)
1016 (reverse (cdr bucket))))
1017 buckets))
1018 (sort buckets (lambda (i1 i2)
1019 (string< (car i1) (car i2))))))
1021 (defadvice org-finalize-agenda-entries (around org-group-agenda-finalize
1022 (list &optional nosort))
1023 "Prepare bucketed agenda entry lists"
1024 (if org-agenda-group-by-property
1025 ;; bucketed, handle appropriately
1026 (let ((text ""))
1027 (dolist (bucket (org-group-bucket-items
1028 org-agenda-group-by-property
1029 list))
1030 (let ((header (concat "Property "
1031 org-agenda-group-by-property
1032 " is "
1033 (or (car bucket) "<nil>") ":\n")))
1034 (add-text-properties 0 (1- (length header))
1035 (list 'face 'org-agenda-structure)
1036 header)
1037 (setq text
1038 (concat text header
1039 ;; recursively process
1040 (let ((org-agenda-group-by-property nil))
1041 (org-finalize-agenda-entries
1042 (cdr bucket) nosort))
1043 "\n\n"))))
1044 (setq ad-return-value text))
1045 ad-do-it))
1046 (ad-activate 'org-finalize-agenda-entries)
1047 #+end_src
1048 *** A way to tag a task so that when clocking-out user is prompted to take a note.
1049 Thanks to Richard Riley (see [[http://permalink.gmane.org/gmane.emacs.orgmode/40896][this post on the mailing list]]).
1051 A small hook run when clocking out of a task that prompts for a note
1052 when the tag "=clockout_note=" is found in a headline. It uses the tag
1053 ("=clockout_note=") so inheritance can also be used...
1055 #+begin_src emacs-lisp
1056 (defun rgr/check-for-clock-out-note()
1057 (interactive)
1058 (save-excursion
1059 (org-back-to-heading)
1060 (let ((tags (org-get-tags)))
1061 (and tags (message "tags: %s " tags)
1062 (when (member "clocknote" tags)
1063 (org-add-note))))))
1065 (add-hook 'org-clock-out-hook 'rgr/check-for-clock-out-note)
1066 #+end_src
1067 *** Dynamically adjust tag position
1068 Here is a bit of code that allows you to have the tags always
1069 right-adjusted in the buffer.
1071 This is useful when you have bigger window than default window-size
1072 and you dislike the aesthetics of having the tag in the middle of the
1073 line.
1075 This hack solves the problem of adjusting it whenever you change the
1076 window size.
1077 Before saving it will revert the file to having the tag position be
1078 left-adjusted so that if you track your files with version control,
1079 you won't run into artificial diffs just because the window-size
1080 changed.
1082 *IMPORTANT*: This is probably slow on very big files.
1084 #+begin_src emacs-lisp
1085 (setq ba/org-adjust-tags-column t)
1087 (defun ba/org-adjust-tags-column-reset-tags ()
1088 "In org-mode buffers it will reset tag position according to
1089 `org-tags-column'."
1090 (when (and
1091 (not (string= (buffer-name) "*Remember*"))
1092 (eql major-mode 'org-mode))
1093 (let ((b-m-p (buffer-modified-p)))
1094 (condition-case nil
1095 (save-excursion
1096 (goto-char (point-min))
1097 (command-execute 'outline-next-visible-heading)
1098 ;; disable (message) that org-set-tags generates
1099 (flet ((message (&rest ignored) nil))
1100 (org-set-tags 1 t))
1101 (set-buffer-modified-p b-m-p))
1102 (error nil)))))
1104 (defun ba/org-adjust-tags-column-now ()
1105 "Right-adjust `org-tags-column' value, then reset tag position."
1106 (set (make-local-variable 'org-tags-column)
1107 (- (- (window-width) (length org-ellipsis))))
1108 (ba/org-adjust-tags-column-reset-tags))
1110 (defun ba/org-adjust-tags-column-maybe ()
1111 "If `ba/org-adjust-tags-column' is set to non-nil, adjust tags."
1112 (when ba/org-adjust-tags-column
1113 (ba/org-adjust-tags-column-now)))
1115 (defun ba/org-adjust-tags-column-before-save ()
1116 "Tags need to be left-adjusted when saving."
1117 (when ba/org-adjust-tags-column
1118 (setq org-tags-column 1)
1119 (ba/org-adjust-tags-column-reset-tags)))
1121 (defun ba/org-adjust-tags-column-after-save ()
1122 "Revert left-adjusted tag position done by before-save hook."
1123 (ba/org-adjust-tags-column-maybe)
1124 (set-buffer-modified-p nil))
1126 ; automatically align tags on right-hand side
1127 (add-hook 'window-configuration-change-hook
1128 'ba/org-adjust-tags-column-maybe)
1129 (add-hook 'before-save-hook 'ba/org-adjust-tags-column-before-save)
1130 (add-hook 'after-save-hook 'ba/org-adjust-tags-column-after-save)
1131 (add-hook 'org-agenda-mode-hook '(lambda ()
1132 (setq org-agenda-tags-column (- (window-width)))))
1134 ; between invoking org-refile and displaying the prompt (which
1135 ; triggers window-configuration-change-hook) tags might adjust,
1136 ; which invalidates the org-refile cache
1137 (defadvice org-refile (around org-refile-disable-adjust-tags)
1138 "Disable dynamically adjusting tags"
1139 (let ((ba/org-adjust-tags-column nil))
1140 ad-do-it))
1141 (ad-activate 'org-refile)
1142 #+end_src
1143 *** Use an "attach" link type to open files without worrying about their location
1145 -- Darlan Cavalcante Moreira
1147 In the setup part in my org-files I put:
1149 #+begin_src org
1150 ,#+LINK: attach elisp:(org-open-file (org-attach-expand "%s"))
1151 #+end_src org
1153 Now I can use the "attach" link type, but org will ask me if I want to
1154 allow executing the elisp code. To avoid this you can even set
1155 org-confirm-elisp-link-function to nil (I don't like this because it allows
1156 any elisp code in links) or you can set org-confirm-elisp-link-not-regexp
1157 appropriately.
1159 In my case I use
1161 : (setq org-confirm-elisp-link-not-regexp "org-open-file")
1163 This works very well.
1165 ** Org Agenda and Task Management
1166 *** Make it easier to set org-agenda-files from multiple directories
1167 - Matt Lundin
1169 #+begin_src emacs-lisp
1170 (defun my-org-list-files (dirs ext)
1171 "Function to create list of org files in multiple subdirectories.
1172 This can be called to generate a list of files for
1173 org-agenda-files or org-refile-targets.
1175 DIRS is a list of directories.
1177 EXT is a list of the extensions of files to be included."
1178 (let ((dirs (if (listp dirs)
1179 dirs
1180 (list dirs)))
1181 (ext (if (listp ext)
1182 ext
1183 (list ext)))
1184 files)
1185 (mapc
1186 (lambda (x)
1187 (mapc
1188 (lambda (y)
1189 (setq files
1190 (append files
1191 (file-expand-wildcards
1192 (concat (file-name-as-directory x) "*" y)))))
1193 ext))
1194 dirs)
1195 (mapc
1196 (lambda (x)
1197 (when (or (string-match "/.#" x)
1198 (string-match "#$" x))
1199 (setq files (delete x files))))
1200 files)
1201 files))
1203 (defvar my-org-agenda-directories '("~/org/")
1204 "List of directories containing org files.")
1205 (defvar my-org-agenda-extensions '(".org")
1206 "List of extensions of agenda files")
1208 (setq my-org-agenda-directories '("~/org/" "~/work/"))
1209 (setq my-org-agenda-extensions '(".org" ".ref"))
1211 (defun my-org-set-agenda-files ()
1212 (interactive)
1213 (setq org-agenda-files (my-org-list-files
1214 my-org-agenda-directories
1215 my-org-agenda-extensions)))
1217 (my-org-set-agenda-files)
1218 #+end_src
1220 The code above will set your "default" agenda files to all files
1221 ending in ".org" and ".ref" in the directories "~/org/" and "~/work/".
1222 You can change these values by setting the variables
1223 my-org-agenda-extensions and my-org-agenda-directories. The function
1224 my-org-agenda-files-by-filetag uses these two variables to determine
1225 which files to search for filetags (i.e., the larger set from which
1226 the subset will be drawn).
1228 You can also easily use my-org-list-files to "mix and match"
1229 directories and extensions to generate different lists of agenda
1230 files.
1232 *** Restrict org-agenda-files by filetag
1233 :PROPERTIES:
1234 :CUSTOM_ID: set-agenda-files-by-filetag
1235 :END:
1236 - Matt Lundin
1238 It is often helpful to limit yourself to a subset of your agenda
1239 files. For instance, at work, you might want to see only files related
1240 to work (e.g., bugs, clientA, projectxyz, etc.). The FAQ has helpful
1241 information on filtering tasks using [[file:org-faq.org::#limit-agenda-with-tag-filtering][filetags]] and [[file:org-faq.org::#limit-agenda-with-category-match][custom agenda
1242 commands]]. These solutions, however, require reapplying a filter each
1243 time you call the agenda or writing several new custom agenda commands
1244 for each context. Another solution is to use directories for different
1245 types of tasks and to change your agenda files with a function that
1246 sets org-agenda-files to the appropriate directory. But this relies on
1247 hard and static boundaries between files.
1249 The following functions allow for a more dynamic approach to selecting
1250 a subset of files based on filetags:
1252 #+begin_src emacs-lisp
1253 (defun my-org-agenda-restrict-files-by-filetag (&optional tag)
1254 "Restrict org agenda files only to those containing filetag."
1255 (interactive)
1256 (let* ((tagslist (my-org-get-all-filetags))
1257 (ftag (or tag
1258 (completing-read "Tag: "
1259 (mapcar 'car tagslist)))))
1260 (org-agenda-remove-restriction-lock 'noupdate)
1261 (put 'org-agenda-files 'org-restrict (cdr (assoc ftag tagslist)))
1262 (setq org-agenda-overriding-restriction 'files)))
1264 (defun my-org-get-all-filetags ()
1265 "Get list of filetags from all default org-files."
1266 (let ((files org-agenda-files)
1267 tagslist x)
1268 (save-window-excursion
1269 (while (setq x (pop files))
1270 (set-buffer (find-file-noselect x))
1271 (mapc
1272 (lambda (y)
1273 (let ((tagfiles (assoc y tagslist)))
1274 (if tagfiles
1275 (setcdr tagfiles (cons x (cdr tagfiles)))
1276 (add-to-list 'tagslist (list y x)))))
1277 (my-org-get-filetags)))
1278 tagslist)))
1280 (defun my-org-get-filetags ()
1281 "Get list of filetags for current buffer"
1282 (let ((ftags org-file-tags)
1283 x)
1284 (mapcar
1285 (lambda (x)
1286 (org-substring-no-properties x))
1287 ftags)))
1288 #+end_src
1290 Calling my-org-agenda-restrict-files-by-filetag results in a prompt
1291 with all filetags in your "normal" agenda files. When you select a
1292 tag, org-agenda-files will be restricted to only those files
1293 containing the filetag. To release the restriction, type C-c C-x >
1294 (org-agenda-remove-restriction-lock).
1296 *** Highlight the agenda line under cursor
1298 This is useful to make sure what task you are operating on.
1300 #+BEGIN_SRC emacs-lisp
1301 (add-hook 'org-agenda-mode-hook '(lambda () (hl-line-mode 1)))
1302 #+END_SRC
1304 Under XEmacs:
1306 #+BEGIN_SRC emacs-lisp
1307 ;; hl-line seems to be only for emacs
1308 (require 'highline)
1309 (add-hook 'org-agenda-mode-hook '(lambda () (highline-mode 1)))
1311 ;; highline-mode does not work straightaway in tty mode.
1312 ;; I use a black background
1313 (custom-set-faces
1314 '(highline-face ((((type tty) (class color))
1315 (:background "white" :foreground "black")))))
1316 #+END_SRC
1318 *** Split horizontally for agenda
1320 If you would like to split the frame into two side-by-side windows when
1321 displaying the agenda, try this hack from Jan Rehders, which uses the
1322 `toggle-window-split' from
1324 http://www.emacswiki.org/cgi-bin/wiki/ToggleWindowSplit
1326 #+BEGIN_SRC emacs-lisp
1327 ;; Patch org-mode to use vertical splitting
1328 (defadvice org-prepare-agenda (after org-fix-split)
1329 (toggle-window-split))
1330 (ad-activate 'org-prepare-agenda)
1331 #+END_SRC
1333 *** Automatically add an appointment when clocking in a task
1335 #+BEGIN_SRC emacs-lisp
1336 ;; Make sure you have a sensible value for `appt-message-warning-time'
1337 (defvar bzg-org-clock-in-appt-delay 100
1338 "Number of minutes for setting an appointment by clocking-in")
1339 #+END_SRC
1341 This function let's you add an appointment for the current entry.
1342 This can be useful when you need a reminder.
1344 #+BEGIN_SRC emacs-lisp
1345 (defun bzg-org-clock-in-add-appt (&optional n)
1346 "Add an appointment for the Org entry at point in N minutes."
1347 (interactive)
1348 (save-excursion
1349 (org-back-to-heading t)
1350 (looking-at org-complex-heading-regexp)
1351 (let* ((msg (match-string-no-properties 4))
1352 (ct-time (decode-time))
1353 (appt-min (+ (cadr ct-time)
1354 (or n bzg-org-clock-in-appt-delay)))
1355 (appt-time ; define the time for the appointment
1356 (progn (setf (cadr ct-time) appt-min) ct-time)))
1357 (appt-add (format-time-string
1358 "%H:%M" (apply 'encode-time appt-time)) msg)
1359 (if (interactive-p) (message "New appointment for %s" msg)))))
1360 #+END_SRC
1362 You can advise =org-clock-in= so that =C-c C-x C-i= will automatically
1363 add an appointment:
1365 #+BEGIN_SRC emacs-lisp
1366 (defadvice org-clock-in (after org-clock-in-add-appt activate)
1367 "Add an appointment when clocking a task in."
1368 (bzg-org-clock-in-add-appt))
1369 #+END_SRC
1371 You may also want to delete the associated appointment when clocking
1372 out. This function does this:
1374 #+BEGIN_SRC emacs-lisp
1375 (defun bzg-org-clock-out-delete-appt nil
1376 "When clocking out, delete any associated appointment."
1377 (interactive)
1378 (save-excursion
1379 (org-back-to-heading t)
1380 (looking-at org-complex-heading-regexp)
1381 (let* ((msg (match-string-no-properties 4)))
1382 (setq appt-time-msg-list
1383 (delete nil
1384 (mapcar
1385 (lambda (appt)
1386 (if (not (string-match (regexp-quote msg)
1387 (cadr appt))) appt))
1388 appt-time-msg-list)))
1389 (appt-check))))
1390 #+END_SRC
1392 And here is the advice for =org-clock-out= (=C-c C-x C-o=)
1394 #+BEGIN_SRC emacs-lisp
1395 (defadvice org-clock-out (before org-clock-out-delete-appt activate)
1396 "Delete an appointment when clocking a task out."
1397 (bzg-org-clock-out-delete-appt))
1398 #+END_SRC
1400 *IMPORTANT*: You can add appointment by clocking in in both an
1401 =org-mode= and an =org-agenda-mode= buffer. But clocking out from
1402 agenda buffer with the advice above will bring an error.
1404 *** Using external programs for appointments reminders
1406 Read this rich [[http://comments.gmane.org/gmane.emacs.orgmode/46641][thread]] from the org-mode list.
1408 *** Remove time grid lines that are in an appointment
1410 The agenda shows lines for the time grid. Some people think that
1411 these lines are a distraction when there are appointments at those
1412 times. You can get rid of the lines which coincide exactly with the
1413 beginning of an appointment. Michael Ekstrand has written a piece of
1414 advice that also removes lines that are somewhere inside an
1415 appointment:
1417 #+begin_src emacs-lisp
1418 (defun org-time-to-minutes (time)
1419 "Convert an HHMM time to minutes"
1420 (+ (* (/ time 100) 60) (% time 100)))
1422 (defun org-time-from-minutes (minutes)
1423 "Convert a number of minutes to an HHMM time"
1424 (+ (* (/ minutes 60) 100) (% minutes 60)))
1426 (defadvice org-agenda-add-time-grid-maybe (around mde-org-agenda-grid-tweakify
1427 (list ndays todayp))
1428 (if (member 'remove-match (car org-agenda-time-grid))
1429 (flet ((extract-window
1430 (line)
1431 (let ((start (get-text-property 1 'time-of-day line))
1432 (dur (get-text-property 1 'duration line)))
1433 (cond
1434 ((and start dur)
1435 (cons start
1436 (org-time-from-minutes
1437 (+ dur (org-time-to-minutes start)))))
1438 (start start)
1439 (t nil)))))
1440 (let* ((windows (delq nil (mapcar 'extract-window list)))
1441 (org-agenda-time-grid
1442 (list (car org-agenda-time-grid)
1443 (cadr org-agenda-time-grid)
1444 (remove-if
1445 (lambda (time)
1446 (find-if (lambda (w)
1447 (if (numberp w)
1448 (equal w time)
1449 (and (>= time (car w))
1450 (< time (cdr w)))))
1451 windows))
1452 (caddr org-agenda-time-grid)))))
1453 ad-do-it))
1454 ad-do-it))
1455 (ad-activate 'org-agenda-add-time-grid-maybe)
1456 #+end_src
1457 *** Disable vc for Org mode agenda files
1458 -- David Maus
1460 Even if you use Git to track your agenda files you might not need
1461 vc-mode to be enabled for these files.
1463 #+begin_src emacs-lisp
1464 (add-hook 'find-file-hook 'dmj/disable-vc-for-agenda-files-hook)
1465 (defun dmj/disable-vc-for-agenda-files-hook ()
1466 "Disable vc-mode for Org agenda files."
1467 (if (and (fboundp 'org-agenda-file-p)
1468 (org-agenda-file-p (buffer-file-name)))
1469 (remove-hook 'find-file-hook 'vc-find-file-hook)
1470 (add-hook 'find-file-hook 'vc-find-file-hook)))
1471 #+end_src
1473 *** Easy customization of TODO colors
1474 -- Ryan C. Thompson
1476 Here is some code I came up with some code to make it easier to
1477 customize the colors of various TODO keywords. As long as you just
1478 want a different color and nothing else, you can customize the
1479 variable org-todo-keyword-faces and use just a string color (i.e. a
1480 string of the color name) as the face, and then org-get-todo-face
1481 will convert the color to a face, inheriting everything else from
1482 the standard org-todo face.
1484 To demonstrate, I currently have org-todo-keyword-faces set to
1486 #+BEGIN_SRC emacs-lisp
1487 (("IN PROGRESS" . "dark orange")
1488 ("WAITING" . "red4")
1489 ("CANCELED" . "saddle brown"))
1490 #+END_SRC
1492 Here's the code, in a form you can put in your =.emacs=
1494 #+BEGIN_SRC emacs-lisp
1495 (eval-after-load 'org-faces
1496 '(progn
1497 (defcustom org-todo-keyword-faces nil
1498 "Faces for specific TODO keywords.
1499 This is a list of cons cells, with TODO keywords in the car and
1500 faces in the cdr. The face can be a symbol, a color, or a
1501 property list of attributes, like (:foreground \"blue\" :weight
1502 bold :underline t)."
1503 :group 'org-faces
1504 :group 'org-todo
1505 :type '(repeat
1506 (cons
1507 (string :tag "Keyword")
1508 (choice color (sexp :tag "Face")))))))
1510 (eval-after-load 'org
1511 '(progn
1512 (defun org-get-todo-face-from-color (color)
1513 "Returns a specification for a face that inherits from org-todo
1514 face and has the given color as foreground. Returns nil if
1515 color is nil."
1516 (when color
1517 `(:inherit org-warning :foreground ,color)))
1519 (defun org-get-todo-face (kwd)
1520 "Get the right face for a TODO keyword KWD.
1521 If KWD is a number, get the corresponding match group."
1522 (if (numberp kwd) (setq kwd (match-string kwd)))
1523 (or (let ((face (cdr (assoc kwd org-todo-keyword-faces))))
1524 (if (stringp face)
1525 (org-get-todo-face-from-color face)
1526 face))
1527 (and (member kwd org-done-keywords) 'org-done)
1528 'org-todo))))
1529 #+END_SRC
1531 *** Add an effort estimate on the fly when clocking in
1533 You can use =org-clock-in-prepare-hook= to add an effort estimate.
1534 This way you can easily have a "tea-timer" for your tasks when they
1535 don't already have an effort estimate.
1537 #+begin_src emacs-lisp
1538 (add-hook 'org-clock-in-prepare-hook
1539 'my-org-mode-ask-effort)
1541 (defun my-org-mode-ask-effort ()
1542 "Ask for an effort estimate when clocking in."
1543 (unless (org-entry-get (point) "Effort")
1544 (let ((effort
1545 (completing-read
1546 "Effort: "
1547 (org-entry-get-multivalued-property (point) "Effort"))))
1548 (unless (equal effort "")
1549 (org-set-property "Effort" effort)))))
1550 #+end_src
1552 Or you can use a default effort for such a timer:
1554 #+begin_src emacs-lisp
1555 (add-hook 'org-clock-in-prepare-hook
1556 'my-org-mode-add-default-effort)
1558 (defvar org-clock-default-effort "1:00")
1560 (defun my-org-mode-add-default-effort ()
1561 "Add a default effort estimation."
1562 (unless (org-entry-get (point) "Effort")
1563 (org-set-property "Effort" org-clock-default-effort)))
1564 #+end_src
1566 *** Refresh the agenda view regurally
1568 Hack sent by Kiwon Um:
1570 #+begin_src emacs-lisp
1571 (defun kiwon/org-agenda-redo-in-other-window ()
1572 "Call org-agenda-redo function even in the non-agenda buffer."
1573 (interactive)
1574 (let ((agenda-window (get-buffer-window org-agenda-buffer-name t)))
1575 (when agenda-window
1576 (with-selected-window agenda-window (org-agenda-redo)))))
1577 (run-at-time nil 300 'kiwon/org-agenda-redo-in-other-window)
1578 #+end_src
1580 *** Reschedule agenda items to today with a single command
1582 This was suggested by Carsten in reply to David Abrahams:
1584 #+begin_example emacs-lisp
1585 (defun org-agenda-reschedule-to-today ()
1586 (interactive)
1587 (flet ((org-read-date (&rest rest) (current-time)))
1588 (call-interactively 'org-agenda-schedule)))
1589 #+end_example
1591 *** Mark subtree DONE along with all subheadings
1593 Bernt Hansen [[http://permalink.gmane.org/gmane.emacs.orgmode/44693][suggested]] this command:
1595 #+begin_src emacs-lisp
1596 (defun bh/mark-subtree-done ()
1597 (interactive)
1598 (org-mark-subtree)
1599 (let ((limit (point)))
1600 (save-excursion
1601 (exchange-point-and-mark)
1602 (while (> (point) limit)
1603 (org-todo "DONE")
1604 (outline-previous-visible-heading 1))
1605 (org-todo "DONE"))))
1606 #+end_src
1608 Then M-x bh/mark-subtree-done.
1610 ** Exporting org files
1611 *** Export Org to Org and handle includes.
1613 Nick Dokos came up with this useful function:
1615 #+begin_src emacs-lisp
1616 (defun org-to-org-handle-includes ()
1617 "Copy the contents of the current buffer to OUTFILE,
1618 recursively processing #+INCLUDEs."
1619 (let* ((s (buffer-string))
1620 (fname (buffer-file-name))
1621 (ofname (format "%s.I.org" (file-name-sans-extension fname))))
1622 (setq result
1623 (with-temp-buffer
1624 (insert s)
1625 (org-export-handle-include-files-recurse)
1626 (buffer-string)))
1627 (find-file ofname)
1628 (delete-region (point-min) (point-max))
1629 (insert result)
1630 (save-buffer)))
1631 #+end_src
1633 *** Specifying LaTeX commands to floating environments
1634 :PROPERTIES:
1635 :CUSTOM_ID: latex-command-for-floats
1636 :END:
1638 The keyword ~placement~ can be used to specify placement options to
1639 floating environments (like =\begin{figure}= and =\begin{table}=}) in
1640 LaTeX export. Org passes along everything passed in options as long as
1641 there are no spaces. One can take advantage of this to pass other
1642 LaTeX commands and have their scope limited to the floating
1643 environment.
1645 For example one can set the fontsize of a table different from the
1646 default normal size by putting something like =\footnotesize= right
1647 after the placement options. During LaTeX export using the
1648 ~#+ATTR_LaTeX:~ line below:
1650 #+begin_src org
1651 ,#+ATTR_LaTeX: placement=[<options>]\footnotesize
1652 #+end_src
1654 exports the associated floating environment as shown in the following
1655 block.
1657 #+begin_src latex
1658 \begin{table}[<options>]\footnotesize
1659 ...
1660 \end{table}
1661 #+end_src
1663 It should be noted that this hack does not work for beamer export of
1664 tables since the =table= environment is not used. As an ugly
1665 workaround, one can use the following:
1667 #+begin_src org
1668 ,#+LATEX: {\footnotesize
1669 ,#+ATTR_LaTeX: align=rr
1670 ,| some | table |
1671 ,|------+-------|
1672 ,| .. | .. |
1673 ,#+LATEX: }
1674 #+end_src
1676 *** Styling code sections with CSS
1678 Code sections (marked with =#+begin_src= and =#+end_src=) are exported
1679 to HTML using =<pre>= tags, and assigned CSS classes by their content
1680 type. For example, Perl content will have an opening tag like
1681 =<pre class="src src-perl">=. You can use those classes to add styling
1682 to the output, such as here where a small language tag is added at the
1683 top of each kind of code box:
1685 #+begin_src lisp
1686 (setq org-export-html-style
1687 "<style type=\"text/css\">
1688 <!--/*--><![CDATA[/*><!--*/
1689 .src { background-color: #F5FFF5; position: relative; overflow: visible; }
1690 .src:before { position: absolute; top: -15px; background: #ffffff; padding: 1px; border: 1px solid #000000; font-size: small; }
1691 .src-sh:before { content: 'sh'; }
1692 .src-bash:before { content: 'sh'; }
1693 .src-R:before { content: 'R'; }
1694 .src-perl:before { content: 'Perl'; }
1695 .src-sql:before { content: 'SQL'; }
1696 .example { background-color: #FFF5F5; }
1697 /*]]>*/-->
1698 </style>")
1699 #+end_src
1701 Additionally, we use color to distinguish code output (the =.example=
1702 class) from input (all the =.src-*= classes).
1704 * Hacking Org: Working with Org-mode and other Emacs Packages.
1705 ** org-remember-anything
1707 [[http://www.emacswiki.org/cgi-bin/wiki/Anything][Anything]] users may find the snippet below interesting:
1709 #+BEGIN_SRC emacs-lisp
1710 (defvar org-remember-anything
1711 '((name . "Org Remember")
1712 (candidates . (lambda () (mapcar 'car org-remember-templates)))
1713 (action . (lambda (name)
1714 (let* ((orig-template org-remember-templates)
1715 (org-remember-templates
1716 (list (assoc name orig-template))))
1717 (call-interactively 'org-remember))))))
1718 #+END_SRC
1720 You can add it to your 'anything-sources' variable and open remember directly
1721 from anything. I imagine this would be more interesting for people with many
1722 remember templates, so that you are out of keys to assign those to.
1724 ** Org-mode and saveplace.el
1726 Fix a problem with saveplace.el putting you back in a folded position:
1728 #+begin_src emacs-lisp
1729 (add-hook 'org-mode-hook
1730 (lambda ()
1731 (when (outline-invisible-p)
1732 (save-excursion
1733 (outline-previous-visible-heading 1)
1734 (org-show-subtree)))))
1735 #+end_src
1737 ** Using ido-completing-read to find attachments
1738 -- Matt Lundin.
1740 Org-attach is great for quickly linking files to a project. But if you
1741 use org-attach extensively you might find yourself wanting to browse
1742 all the files you've attached to org headlines. This is not easy to do
1743 manually, since the directories containing the files are not human
1744 readable (i.e., they are based on automatically generated ids). Here's
1745 some code to browse those files using ido (obviously, you need to be
1746 using ido):
1748 #+begin_src emacs-lisp
1749 (load-library "find-lisp")
1751 ;; Adapted from http://www.emacswiki.org/emacs/RecentFiles
1753 (defun my-ido-find-org-attach ()
1754 "Find files in org-attachment directory"
1755 (interactive)
1756 (let* ((enable-recursive-minibuffers t)
1757 (files (find-lisp-find-files org-attach-directory "."))
1758 (file-assoc-list
1759 (mapcar (lambda (x)
1760 (cons (file-name-nondirectory x)
1761 x))
1762 files))
1763 (filename-list
1764 (remove-duplicates (mapcar #'car file-assoc-list)
1765 :test #'string=))
1766 (filename (ido-completing-read "Org attachments: " filename-list nil t))
1767 (longname (cdr (assoc filename file-assoc-list))))
1768 (ido-set-current-directory
1769 (if (file-directory-p longname)
1770 longname
1771 (file-name-directory longname)))
1772 (setq ido-exit 'refresh
1773 ido-text-init ido-text
1774 ido-rotate-temp t)
1775 (exit-minibuffer)))
1777 (add-hook 'ido-setup-hook 'ido-my-keys)
1779 (defun ido-my-keys ()
1780 "Add my keybindings for ido."
1781 (define-key ido-completion-map (kbd "C-;") 'my-ido-find-org-attach))
1782 #+end_src
1784 To browse your org attachments using ido fuzzy matching and/or the
1785 completion buffer, invoke ido-find-file as usual (=C-x C-f=) and then
1786 press =C-;=.
1788 ** Use idle timer for automatic agenda views
1790 From John Wiegley's mailing list post (March 18, 2010):
1792 #+begin_quote
1793 I have the following snippet in my .emacs file, which I find very
1794 useful. Basically what it does is that if I don't touch my Emacs for 5
1795 minutes, it displays the current agenda. This keeps my tasks "always
1796 in mind" whenever I come back to Emacs after doing something else,
1797 whereas before I had a tendency to forget that it was there.
1798 #+end_quote
1800 - [[http://mid.gmane.org/55590EA7-C744-44E5-909F-755F0BBE452D@gmail.com][John Wiegley: Displaying your Org agenda after idle time]]
1802 #+begin_src emacs-lisp
1803 (defun jump-to-org-agenda ()
1804 (interactive)
1805 (let ((buf (get-buffer "*Org Agenda*"))
1806 wind)
1807 (if buf
1808 (if (setq wind (get-buffer-window buf))
1809 (select-window wind)
1810 (if (called-interactively-p)
1811 (progn
1812 (select-window (display-buffer buf t t))
1813 (org-fit-window-to-buffer)
1814 ;; (org-agenda-redo)
1815 )
1816 (with-selected-window (display-buffer buf)
1817 (org-fit-window-to-buffer)
1818 ;; (org-agenda-redo)
1819 )))
1820 (call-interactively 'org-agenda-list)))
1821 ;;(let ((buf (get-buffer "*Calendar*")))
1822 ;; (unless (get-buffer-window buf)
1823 ;; (org-agenda-goto-calendar)))
1824 )
1826 (run-with-idle-timer 300 t 'jump-to-org-agenda)
1827 #+end_src
1829 #+results:
1830 : [nil 0 300 0 t jump-to-org-agenda nil idle]
1832 ** Link to Gnus messages by Message-Id
1834 In a [[http://thread.gmane.org/gmane.emacs.orgmode/8860][recent thread]] on the Org-Mode mailing list, there was some
1835 discussion about linking to Gnus messages without encoding the folder
1836 name in the link. The following code hooks in to the store-link
1837 function in Gnus to capture links by Message-Id when in nnml folders,
1838 and then provides a link type "mid" which can open this link. The
1839 =mde-org-gnus-open-message-link= function uses the
1840 =mde-mid-resolve-methods= variable to determine what Gnus backends to
1841 scan. It will go through them, in order, asking each to locate the
1842 message and opening it from the first one that reports success.
1844 It has only been tested with a single nnml backend, so there may be
1845 bugs lurking here and there.
1847 The logic for finding the message was adapted from [[http://www.emacswiki.org/cgi-bin/wiki/FindMailByMessageId][an Emacs Wiki
1848 article]].
1850 #+begin_src emacs-lisp
1851 ;; Support for saving Gnus messages by Message-ID
1852 (defun mde-org-gnus-save-by-mid ()
1853 (when (memq major-mode '(gnus-summary-mode gnus-article-mode))
1854 (when (eq major-mode 'gnus-article-mode)
1855 (gnus-article-show-summary))
1856 (let* ((group gnus-newsgroup-name)
1857 (method (gnus-find-method-for-group group)))
1858 (when (eq 'nnml (car method))
1859 (let* ((article (gnus-summary-article-number))
1860 (header (gnus-summary-article-header article))
1861 (from (mail-header-from header))
1862 (message-id
1863 (save-match-data
1864 (let ((mid (mail-header-id header)))
1865 (if (string-match "<\\(.*\\)>" mid)
1866 (match-string 1 mid)
1867 (error "Malformed message ID header %s" mid)))))
1868 (date (mail-header-date header))
1869 (subject (gnus-summary-subject-string)))
1870 (org-store-link-props :type "mid" :from from :subject subject
1871 :message-id message-id :group group
1872 :link (org-make-link "mid:" message-id))
1873 (apply 'org-store-link-props
1874 :description (org-email-link-description)
1875 org-store-link-plist)
1876 t)))))
1878 (defvar mde-mid-resolve-methods '()
1879 "List of methods to try when resolving message ID's. For Gnus,
1880 it is a cons of 'gnus and the select (type and name).")
1881 (setq mde-mid-resolve-methods
1882 '((gnus nnml "")))
1884 (defvar mde-org-gnus-open-level 1
1885 "Level at which Gnus is started when opening a link")
1886 (defun mde-org-gnus-open-message-link (msgid)
1887 "Open a message link with Gnus"
1888 (require 'gnus)
1889 (require 'org-table)
1890 (catch 'method-found
1891 (message "[MID linker] Resolving %s" msgid)
1892 (dolist (method mde-mid-resolve-methods)
1893 (cond
1894 ((and (eq (car method) 'gnus)
1895 (eq (cadr method) 'nnml))
1896 (funcall (cdr (assq 'gnus org-link-frame-setup))
1897 mde-org-gnus-open-level)
1898 (when gnus-other-frame-object
1899 (select-frame gnus-other-frame-object))
1900 (let* ((msg-info (nnml-find-group-number
1901 (concat "<" msgid ">")
1902 (cdr method)))
1903 (group (and msg-info (car msg-info)))
1904 (message (and msg-info (cdr msg-info)))
1905 (qname (and group
1906 (if (gnus-methods-equal-p
1907 (cdr method)
1908 gnus-select-method)
1909 group
1910 (gnus-group-full-name group (cdr method))))))
1911 (when msg-info
1912 (gnus-summary-read-group qname nil t)
1913 (gnus-summary-goto-article message nil t))
1914 (throw 'method-found t)))
1915 (t (error "Unknown link type"))))))
1917 (eval-after-load 'org-gnus
1918 '(progn
1919 (add-to-list 'org-store-link-functions 'mde-org-gnus-save-by-mid)
1920 (org-add-link-type "mid" 'mde-org-gnus-open-message-link)))
1921 #+end_src
1923 ** Store link upon sending a message in Gnus
1925 Ulf Stegemann came up with this solution (see his [[http://www.mail-archive.com/emacs-orgmode@gnu.org/msg33278.html][original message]]):
1927 #+begin_src emacs-lisp
1928 (defun ulf-message-send-and-org-gnus-store-link (&optional arg)
1929 "Send message with `message-send-and-exit' and store org link to message copy.
1930 If multiple groups appear in the Gcc header, the link refers to
1931 the copy in the last group."
1932 (interactive "P")
1933 (save-excursion
1934 (save-restriction
1935 (message-narrow-to-headers)
1936 (let ((gcc (car (last
1937 (message-unquote-tokens
1938 (message-tokenize-header
1939 (mail-fetch-field "gcc" nil t) " ,")))))
1940 (buf (current-buffer))
1941 (message-kill-buffer-on-exit nil)
1942 id to from subject desc link newsgroup xarchive)
1943 (message-send-and-exit arg)
1944 (or
1945 ;; gcc group found ...
1946 (and gcc
1947 (save-current-buffer
1948 (progn (set-buffer buf)
1949 (setq id (org-remove-angle-brackets
1950 (mail-fetch-field "Message-ID")))
1951 (setq to (mail-fetch-field "To"))
1952 (setq from (mail-fetch-field "From"))
1953 (setq subject (mail-fetch-field "Subject"))))
1954 (org-store-link-props :type "gnus" :from from :subject subject
1955 :message-id id :group gcc :to to)
1956 (setq desc (org-email-link-description))
1957 (setq link (org-gnus-article-link
1958 gcc newsgroup id xarchive))
1959 (setq org-stored-links
1960 (cons (list link desc) org-stored-links)))
1961 ;; no gcc group found ...
1962 (message "Can not create Org link: No Gcc header found."))))))
1964 (define-key message-mode-map [(control c) (control meta c)]
1965 'ulf-message-send-and-org-gnus-store-link)
1966 #+end_src
1968 ** Send html messages and attachments with Wanderlust
1969 -- David Maus
1971 /Note/: The module [[file:org-contrib/org-mime.org][Org-mime]] in Org's contrib directory provides
1972 similar functionality for both Wanderlust and Gnus. The hack below is
1973 still somewhat different: It allows you to toggle sending of html
1974 messages within Wanderlust transparently. I.e. html markup of the
1975 message body is created right before sending starts.
1977 *** Send HTML message
1979 Putting the code below in your .emacs adds following four functions:
1981 - dmj/wl-send-html-message
1983 Function that does the job: Convert everything between "--text
1984 follows this line--" and first mime entity (read: attachment) or
1985 end of buffer into html markup using `org-export-region-as-html'
1986 and replaces original body with a multipart MIME entity with the
1987 plain text version of body and the html markup version. Thus a
1988 recipient that prefers html messages can see the html markup,
1989 recipients that prefer or depend on plain text can see the plain
1990 text.
1992 Cannot be called interactively: It is hooked into SEMI's
1993 `mime-edit-translate-hook' if message should be HTML message.
1995 - dmj/wl-send-html-message-draft-init
1997 Cannot be called interactively: It is hooked into WL's
1998 `wl-mail-setup-hook' and provides a buffer local variable to
1999 toggle.
2001 - dmj/wl-send-html-message-draft-maybe
2003 Cannot be called interactively: It is hooked into WL's
2004 `wl-draft-send-hook' and hooks `dmj/wl-send-html-message' into
2005 `mime-edit-translate-hook' depending on whether HTML message is
2006 toggled on or off
2008 - dmj/wl-send-html-message-toggle
2010 Toggles sending of HTML message. If toggled on, the letters
2011 "HTML" appear in the mode line.
2013 Call it interactively! Or bind it to a key in `wl-draft-mode'.
2015 If you have to send HTML messages regularly you can set a global
2016 variable `dmj/wl-send-html-message-toggled-p' to the string "HTML" to
2017 toggle on sending HTML message by default.
2019 The image [[http://s11.directupload.net/file/u/15851/48ru5wl3.png][here]] shows an example of how the HTML message looks like in
2020 Google's web front end. As you can see you have the whole markup of
2021 Org at your service: *bold*, /italics/, tables, lists...
2023 So even if you feel uncomfortable with sending HTML messages at least
2024 you send HTML that looks quite good.
2026 #+begin_src emacs-lisp
2027 (defun dmj/wl-send-html-message ()
2028 "Send message as html message.
2029 Convert body of message to html using
2030 `org-export-region-as-html'."
2031 (require 'org)
2032 (save-excursion
2033 (let (beg end html text)
2034 (goto-char (point-min))
2035 (re-search-forward "^--text follows this line--$")
2036 ;; move to beginning of next line
2037 (beginning-of-line 2)
2038 (setq beg (point))
2039 (if (not (re-search-forward "^--\\[\\[" nil t))
2040 (setq end (point-max))
2041 ;; line up
2042 (end-of-line 0)
2043 (setq end (point)))
2044 ;; grab body
2045 (setq text (buffer-substring-no-properties beg end))
2046 ;; convert to html
2047 (with-temp-buffer
2048 (org-mode)
2049 (insert text)
2050 ;; handle signature
2051 (when (re-search-backward "^-- \n" nil t)
2052 ;; preserve link breaks in signature
2053 (insert "\n#+BEGIN_VERSE\n")
2054 (goto-char (point-max))
2055 (insert "\n#+END_VERSE\n")
2056 ;; grab html
2057 (setq html (org-export-region-as-html
2058 (point-min) (point-max) t 'string))))
2059 (delete-region beg end)
2060 (insert
2061 (concat
2062 "--" "<<alternative>>-{\n"
2063 "--" "[[text/plain]]\n" text
2064 "--" "[[text/html]]\n" html
2065 "--" "}-<<alternative>>\n")))))
2067 (defun dmj/wl-send-html-message-toggle ()
2068 "Toggle sending of html message."
2069 (interactive)
2070 (setq dmj/wl-send-html-message-toggled-p
2071 (if dmj/wl-send-html-message-toggled-p
2072 nil "HTML"))
2073 (message "Sending html message toggled %s"
2074 (if dmj/wl-send-html-message-toggled-p
2075 "on" "off")))
2077 (defun dmj/wl-send-html-message-draft-init ()
2078 "Create buffer local settings for maybe sending html message."
2079 (unless (boundp 'dmj/wl-send-html-message-toggled-p)
2080 (setq dmj/wl-send-html-message-toggled-p nil))
2081 (make-variable-buffer-local 'dmj/wl-send-html-message-toggled-p)
2082 (add-to-list 'global-mode-string
2083 '(:eval (if (eq major-mode 'wl-draft-mode)
2084 dmj/wl-send-html-message-toggled-p))))
2086 (defun dmj/wl-send-html-message-maybe ()
2087 "Maybe send this message as html message.
2089 If buffer local variable `dmj/wl-send-html-message-toggled-p' is
2090 non-nil, add `dmj/wl-send-html-message' to
2091 `mime-edit-translate-hook'."
2092 (if dmj/wl-send-html-message-toggled-p
2093 (add-hook 'mime-edit-translate-hook 'dmj/wl-send-html-message)
2094 (remove-hook 'mime-edit-translate-hook 'dmj/wl-send-html-message)))
2096 (add-hook 'wl-draft-reedit-hook 'dmj/wl-send-html-message-draft-init)
2097 (add-hook 'wl-mail-setup-hook 'dmj/wl-send-html-message-draft-init)
2098 (add-hook 'wl-draft-send-hook 'dmj/wl-send-html-message-maybe)
2099 #+end_src
2101 *** Attach HTML of region or subtree
2103 Instead of sending a complete HTML message you might only send parts
2104 of an Org file as HTML for the poor souls who are plagued with
2105 non-proportional fonts in their mail program that messes up pretty
2106 ASCII tables.
2108 This short function does the trick: It exports region or subtree to
2109 HTML, prefixes it with a MIME entity delimiter and pushes to killring
2110 and clipboard. If a region is active, it uses the region, the
2111 complete subtree otherwise.
2113 #+begin_src emacs-lisp
2114 (defun dmj/org-export-region-as-html-attachment (beg end arg)
2115 "Export region between BEG and END as html attachment.
2116 If BEG and END are not set, use current subtree. Region or
2117 subtree is exported to html without header and footer, prefixed
2118 with a mime entity string and pushed to clipboard and killring.
2119 When called with prefix, mime entity is not marked as
2120 attachment."
2121 (interactive "r\nP")
2122 (save-excursion
2123 (let* ((beg (if (region-active-p) (region-beginning)
2124 (progn
2125 (org-back-to-heading)
2126 (point))))
2127 (end (if (region-active-p) (region-end)
2128 (progn
2129 (org-end-of-subtree)
2130 (point))))
2131 (html (concat "--[[text/html"
2132 (if arg "" "\nContent-Disposition: attachment")
2133 "]]\n"
2134 (org-export-region-as-html beg end t 'string))))
2135 (when (fboundp 'x-set-selection)
2136 (ignore-errors (x-set-selection 'PRIMARY html))
2137 (ignore-errors (x-set-selection 'CLIPBOARD html)))
2138 (message "html export done, pushed to kill ring and clipboard"))))
2139 #+end_src
2141 *** Adopting for Gnus
2143 The whole magic lies in the special strings that mark a HTML
2144 attachment. So you might just have to find out what these special
2145 strings are in message-mode and modify the functions accordingly.
2146 ** Add sunrise/sunset times to the agenda.
2147 -- Nick Dokos
2149 The diary package provides the function =diary-sunrise-sunset= which can be used
2150 in a diary s-expression in some agenda file like this:
2152 #+begin_src org-mode
2153 %%(diary-sunrise-sunset)
2154 #+end_src
2156 Seb Vauban asked if it is possible to put sunrise and sunset in
2157 separate lines. Here is a hack to do that. It adds two functions (they
2158 have to be available before the agenda is shown, so I add them early
2159 in my org-config file which is sourced from .emacs, but you'll have to
2160 suit yourself here) that just parse the output of
2161 diary-sunrise-sunset, instead of doing the right thing which would be
2162 to take advantage of the data structures that diary/solar.el provides.
2163 In short, a hack - so perfectly suited for inclusion here :-)
2165 The functions (and latitude/longitude settings which you have to modify for
2166 your location) are as follows:
2168 #+begin_src emacs-lisp
2169 (setq calendar-latitude 40.3)
2170 (setq calendar-longitude -71.0)
2171 (defun diary-sunrise ()
2172 (let ((dss (diary-sunrise-sunset)))
2173 (with-temp-buffer
2174 (insert dss)
2175 (goto-char (point-min))
2176 (while (re-search-forward " ([^)]*)" nil t)
2177 (replace-match "" nil nil))
2178 (goto-char (point-min))
2179 (search-forward ",")
2180 (buffer-substring (point-min) (match-beginning 0)))))
2182 (defun diary-sunset ()
2183 (let ((dss (diary-sunrise-sunset))
2184 start end)
2185 (with-temp-buffer
2186 (insert dss)
2187 (goto-char (point-min))
2188 (while (re-search-forward " ([^)]*)" nil t)
2189 (replace-match "" nil nil))
2190 (goto-char (point-min))
2191 (search-forward ", ")
2192 (setq start (match-end 0))
2193 (search-forward " at")
2194 (setq end (match-beginning 0))
2195 (goto-char start)
2196 (capitalize-word 1)
2197 (buffer-substring start end))))
2198 #+end_src
2200 You also need to add a couple of diary s-expressions in one of your agenda
2201 files:
2203 #+begin_src org-mode
2204 %%(diary-sunrise)
2205 %%(diary-sunset)
2206 #+end_src
2208 The thread on the mailing list that started this can be found [[http://thread.gmane.org/gmane.emacs.orgmode/38723Here%20is%20a%20pointer%20to%20the%20thread%20on%20the%20mailing%20list][here]].
2209 In comparison to the version posted on the mailing list, this one
2210 gets rid of the timezone information.
2211 ** Export BBDB contacts to org-contacts.el
2213 Try this tool by Wes Hardaker:
2215 http://www.hardakers.net/code/bbdb-to-org-contacts/
2217 ** Calculating date differences - how to write a simple elisp function
2219 Alexander Wingård asked how to calculate the number of days between a
2220 time stamp in his org file and today (see
2221 http://thread.gmane.org/gmane.emacs.orgmode/46881). Although the
2222 resulting answer is probably not of general interest, the method might
2223 be useful to a budding Elisp programmer.
2225 Alexander started from an already existing org function,
2226 =org-evaluate-time-range=. When this function is called in the context
2227 of a time range (two time stamps separated by "=--="), it calculates the
2228 number of days between the two dates and outputs the result in Emacs's
2229 echo area. What he wanted was a similar function that, when called from
2230 the context of a single time stamp, would calculate the number of days
2231 between the date in the time stamp and today. The result should go to
2232 the same place: Emacs's echo area.
2234 The solution presented in the mail thread is as follows:
2236 #+begin_src emacs-lisp
2237 (defun aw/org-evaluate-time-range (&optional to-buffer)
2238 (interactive)
2239 (if (org-at-date-range-p t)
2240 (org-evaluate-time-range to-buffer)
2241 ;; otherwise, make a time range in a temp buffer and run o-e-t-r there
2242 (let ((headline (buffer-substring (point-at-bol) (point-at-eol))))
2243 (with-temp-buffer
2244 (insert headline)
2245 (goto-char (point-at-bol))
2246 (re-search-forward org-ts-regexp (point-at-eol) t)
2247 (if (not (org-at-timestamp-p t))
2248 (error "No timestamp here"))
2249 (goto-char (match-beginning 0))
2250 (org-insert-time-stamp (current-time) nil nil)
2251 (insert "--")
2252 (org-evaluate-time-range to-buffer)))))
2253 #+end_src
2255 The function assumes that point is on some line with some time stamp
2256 (or a date range) in it. Note that =org-evaluate-time-range= does not care
2257 whether the first date is earlier than the second: it will always output
2258 the number of days between the earlier date and the later date.
2260 As stated before, the function itself is of limited interest (although
2261 it satisfied Alexander's need).The *method* used might be of wider
2262 interest however, so here is a short explanation.
2264 The idea is that we want =org-evaluate-time-range= to do all the
2265 heavy lifting, but that function requires that it be in a date-range
2266 context. So the function first checks whether it's in a date range
2267 context already: if so, it calls =org-evaluate-time-range= directly
2268 to do the work. The trick now is to arrange things so we can call this
2269 same function in the case where we do *not* have a date range
2270 context. In that case, we manufacture one: we create a temporary
2271 buffer, copy the line with the purported time stamp to the temp
2272 buffer, find the time stamp (signal an error if no time stamp is
2273 found) and insert a new time stamp with the current time before the
2274 existing time stamp, followed by "=--=": voilà, we now have a time range
2275 on which we can apply our old friend =org-evaluate-time-range= to
2276 produce the answer. Because of the above-mentioned property
2277 of =org-evaluate-time-range=, it does not matter if the existing
2278 time stamp is earlier or later than the current time: the correct
2279 number of days is output.
2281 Note that at the end of the call to =with-temp-buffer=, the temporary
2282 buffer goes away. It was just used as a scratch pad for the function
2283 to do some figuring.
2285 The idea of using a temp buffer as a scratch pad has wide
2286 applicability in Emacs programming. The rest of the work is knowing
2287 enough about facilities provided by Emacs (e.g. regexp searching) and
2288 by Org (e.g. checking for time stamps and generating a time stamp) so
2289 that you don't reinvent the wheel, and impedance-matching between the
2290 various pieces.
2292 * Hacking Org: Working with Org-mode and External Programs.
2293 ** Use Org-mode with Screen [Andrew Hyatt]
2295 "The general idea is that you start a task in which all the work will
2296 take place in a shell. This usually is not a leaf-task for me, but
2297 usually the parent of a leaf task. From a task in your org-file, M-x
2298 ash-org-screen will prompt for the name of a session. Give it a name,
2299 and it will insert a link. Open the link at any time to go the screen
2300 session containing your work!"
2302 http://article.gmane.org/gmane.emacs.orgmode/5276
2304 #+BEGIN_SRC emacs-lisp
2305 (require 'term)
2307 (defun ash-org-goto-screen (name)
2308 "Open the screen with the specified name in the window"
2309 (interactive "MScreen name: ")
2310 (let ((screen-buffer-name (ash-org-screen-buffer-name name)))
2311 (if (member screen-buffer-name
2312 (mapcar 'buffer-name (buffer-list)))
2313 (switch-to-buffer screen-buffer-name)
2314 (switch-to-buffer (ash-org-screen-helper name "-dr")))))
2316 (defun ash-org-screen-buffer-name (name)
2317 "Returns the buffer name corresponding to the screen name given."
2318 (concat "*screen " name "*"))
2320 (defun ash-org-screen-helper (name arg)
2321 ;; Pick the name of the new buffer.
2322 (let ((term-ansi-buffer-name
2323 (generate-new-buffer-name
2324 (ash-org-screen-buffer-name name))))
2325 (setq term-ansi-buffer-name
2326 (term-ansi-make-term
2327 term-ansi-buffer-name "/usr/bin/screen" nil arg name))
2328 (set-buffer term-ansi-buffer-name)
2329 (term-mode)
2330 (term-char-mode)
2331 (term-set-escape-char ?\C-x)
2332 term-ansi-buffer-name))
2334 (defun ash-org-screen (name)
2335 "Start a screen session with name"
2336 (interactive "MScreen name: ")
2337 (save-excursion
2338 (ash-org-screen-helper name "-S"))
2339 (insert-string (concat "[[screen:" name "]]")))
2341 ;; And don't forget to add ("screen" . "elisp:(ash-org-goto-screen
2342 ;; \"%s\")") to org-link-abbrev-alist.
2343 #+END_SRC
2345 ** Org Agenda + Appt + Zenity
2346 #+BEGIN_HTML
2347 <a name="agenda-appt-zenity"></a>
2348 #+END_HTML
2349 Russell Adams posted this setup [[http://article.gmane.org/gmane.emacs.orgmode/5806][on the list]]. It makes sure your agenda
2350 appointments are known by Emacs, and it displays warnings in a [[http://live.gnome.org/Zenity][zenity]]
2351 popup window.
2353 #+BEGIN_SRC emacs-lisp
2354 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2355 ; For org appointment reminders
2357 ;; Get appointments for today
2358 (defun my-org-agenda-to-appt ()
2359 (interactive)
2360 (setq appt-time-msg-list nil)
2361 (let ((org-deadline-warning-days 0)) ;; will be automatic in org 5.23
2362 (org-agenda-to-appt)))
2364 ;; Run once, activate and schedule refresh
2365 (my-org-agenda-to-appt)
2366 (appt-activate t)
2367 (run-at-time "24:01" nil 'my-org-agenda-to-appt)
2369 ; 5 minute warnings
2370 (setq appt-message-warning-time 15)
2371 (setq appt-display-interval 5)
2373 ; Update appt each time agenda opened.
2374 (add-hook 'org-finalize-agenda-hook 'my-org-agenda-to-appt)
2376 ; Setup zenify, we tell appt to use window, and replace default function
2377 (setq appt-display-format 'window)
2378 (setq appt-disp-window-function (function my-appt-disp-window))
2380 (defun my-appt-disp-window (min-to-app new-time msg)
2381 (save-window-excursion (shell-command (concat
2382 "/usr/bin/zenity --info --title='Appointment' --text='"
2383 msg "' &") nil nil)))
2384 #+END_SRC
2386 ** Org-Mode + gnome-osd
2388 Richard Riley uses gnome-osd in interaction with Org-Mode to display
2389 appointments. You can look at the code on the [[http://www.emacswiki.org/emacs-en/OrgMode-OSD][emacswiki]].
2391 ** remind2org
2393 From Detlef Steuer
2395 http://article.gmane.org/gmane.emacs.orgmode/5073
2397 #+BEGIN_QUOTE
2398 Remind (http://www.roaringpenguin.com/products/remind) is a very powerful
2399 command line calendaring program. Its features superseed the possibilities
2400 of orgmode in the area of date specifying, so that I want to use it
2401 combined with orgmode.
2403 Using the script below I'm able use remind and incorporate its output in my
2404 agenda views. The default of using 13 months look ahead is easily
2405 changed. It just happens I sometimes like to look a year into the
2406 future. :-)
2407 #+END_QUOTE
2409 ** Useful webjumps for conkeror
2411 If you are using the [[http://conkeror.org][conkeror browser]], maybe you want to put this into
2412 your =~/.conkerorrc= file:
2414 #+begin_example
2415 define_webjump("orglist", "http://search.gmane.org/?query=%s&group=gmane.emacs.orgmode");
2416 define_webjump("worg", "http://www.google.com/cse?cx=002987994228320350715%3Az4glpcrritm&ie=UTF-8&q=%s&sa=Search&siteurl=orgmode.org%2Fworg%2F");
2417 #+end_example
2419 It creates two [[http://conkeror.org/Webjumps][webjumps]] for easily searching the Worg website and the
2420 Org-mode mailing list.
2422 ** Use MathJax for HTML export without requiring JavaScript
2423 As of 2010-08-14, MathJax is the default method used to export math to HTML.
2425 If you like the results but do not want JavaScript in the exported pages,
2426 check out [[http://www.jboecker.de/2010/08/15/staticmathjax.html][Static MathJax]], a XULRunner application which generates a static
2427 HTML file from the exported version. It can also embed all referenced fonts
2428 within the HTML file itself, so there are no dependencies to external files.
2430 The download archive contains an elisp file which integrates it into the Org
2431 export process (configurable per file with a "#+StaticMathJax:" line).
2433 Read README.org and the comments in org-static-mathjax.el for usage instructions.
2434 ** Search Org files using lgrep
2436 Matt Lundin suggests this:
2438 #+begin_src emacs-lisp
2439 (defun my-org-grep (search &optional context)
2440 "Search for word in org files.
2442 Prefix argument determines number of lines."
2443 (interactive "sSearch for: \nP")
2444 (let ((grep-find-ignored-files '("#*" ".#*"))
2445 (grep-template (concat "grep <X> -i -nH "
2446 (when context
2447 (concat "-C" (number-to-string context)))
2448 " -e <R> <F>")))
2449 (lgrep search "*org*" "/home/matt/org/")))
2451 (global-set-key (kbd "<f8>") 'my-org-grep)
2452 #+end_src
2454 ** Automatic screenshot insertion
2456 Suggested by Russell Adams
2458 #+begin_src emacs-lisp
2459 (defun my-org-screenshot ()
2460 "Take a screenshot into a time stamped unique-named file in the
2461 same directory as the org-buffer and insert a link to this file."
2462 (interactive)
2463 (setq filename
2464 (concat
2465 (make-temp-name
2466 (concat (buffer-file-name)
2467 "_"
2468 (format-time-string "%Y%m%d_%H%M%S_")) ) ".png"))
2469 (call-process "import" nil nil nil filename)
2470 (insert (concat "[[" filename "]]"))
2471 (org-display-inline-images))
2472 #+end_src
2474 ** Capture invitations/appointments from MS Exchange emails
2476 Dirk-Jan C.Binnema [[http://article.gmane.org/gmane.emacs.orgmode/27684/][provided]] code to do this. Please check
2477 [[file:code/elisp/org-exchange-capture.el][org-exchange-capture.el]]
2479 ** Audio/video file playback within org mode
2481 Paul Sexton provided code that makes =file:= links to audio or video files
2482 (MP3, WAV, OGG, AVI, MPG, et cetera) play those files using the [[https://github.com/dbrock/bongo][Bongo]] Emacs
2483 media player library. The user can pause, skip forward and backward in the
2484 track, and so on from without leaving Emacs. Links can also contain a time
2485 after a double colon -- when this is present, playback will begin at that
2486 position in the track.
2488 See the file [[file:code/elisp/org-player.el][org-player.el]]
2490 ** Under X11 Keep a window with the current agenda items at all time
2492 I struggle to keep (in emacs) a window with the agenda at all times.
2493 For a long time I have wanted a sticky window that keeps this
2494 information, and then use my window manager to place it and remove its
2495 decorations (I can also force its placement in the stack: top always,
2496 for example).
2498 I wrote a small program in qt that simply monitors an HTML file and
2499 displays it. Nothing more. It does the work for me, and maybe somebody
2500 else will find it useful. It relies on exporting the agenda as HTML
2501 every time the org file is saved, and then this little program
2502 displays the html file. The window manager is responsible of removing
2503 decorations, making it sticky, and placing it in same place always.
2505 Here is a screenshot (see window to the bottom right). The decorations
2506 are removed by the window manager:
2508 http://turingmachine.org/hacking/org-mode/orgdisplay.png
2510 Here is the code. As I said, very, very simple, but maybe somebody will
2511 find if useful.
2513 http://turingmachine.org/hacking/org-mode/
2515 --daniel german
2517 ** Script (thru procmail) to output emails to an Org file
2519 Tycho Garen sent [[http://comments.gmane.org/gmane.emacs.orgmode/44773][this]]:
2521 : I've [...] created some procmail and shell glue that takes emails and
2522 : inserts them into an org-file so that I can capture stuff on the go using
2523 : the email program.
2525 Everything is documented [[http://tychoish.com/code/org-mail/][here]].
2527 ** Meaningful diff for org files in a git repository
2529 Since most diff utilities are primarily meant for source code, it is
2530 difficult to read diffs of text files like ~.org~ files easily. If you
2531 version your org directory with a SCM like git you will know what I
2532 mean. However for git, there is a way around. You can use
2533 =gitattributes= to define a custom diff driver for org files. Then a
2534 regular expression can be used to configure how the diff driver
2535 recognises a "function".
2537 Put the following in your =<org_dir>/.gitattributes=.
2538 : *.org diff=org
2539 Then put the following lines in =<org_dir>/.git/config=
2540 : [diff "org"]
2541 : xfuncname = "^(\\*+ [a-zA-Z0-9]+.+)$"
2543 This will let you see diffs for org files with each hunk identified by
2544 the unmodified headline closest to the changes. After the
2545 configuration a diff should look something like the example below.
2547 #+begin_example
2548 diff --git a/org-hacks.org b/org-hacks.org
2549 index a0672ea..92a08f7 100644
2550 --- a/org-hacks.org
2551 +++ b/org-hacks.org
2552 @@ -2495,6 +2495,22 @@ ** Script (thru procmail) to output emails to an Org file
2554 Everything is documented [[http://tychoish.com/code/org-mail/][here]].
2556 +** Meaningful diff for org files in a git repository
2557 +
2558 +Since most diff utilities are primarily meant for source code, it is
2559 +difficult to read diffs of text files like ~.org~ files easily. If you
2560 +version your org directory with a SCM like git you will know what I
2561 +mean. However for git, there is a way around. You can use
2562 +=gitattributes= to define a custom diff driver for org files. Then a
2563 +regular expression can be used to configure how the diff driver
2564 +recognises a "function".
2565 +
2566 +Put the following in your =<org_dir>/.gitattributes=.
2567 +: *.org diff=org
2568 +Then put the following lines in =<org_dir>/.git/config=
2569 +: [diff "org"]
2570 +: xfuncname = "^(\\*+ [a-zA-Z0-9]+.+)$"
2571 +
2572 * Musings
2574 ** Cooking? Brewing?
2575 #+end_example
2577 * Musings
2579 ** Cooking? Brewing?
2581 See [[http://article.gmane.org/gmane.emacs.orgmode/44981][this message]] from Erik Hetzner:
2583 It currently does metric/english conversion, and a few other tricks.
2584 Basically I just use calc’s units code. I think scaling recipes, or
2585 turning percentages into weights would be pretty easy.
2587 https://gitorious.org/org-cook/org-cook
2589 There is also, for those interested:
2591 https://gitorious.org/org-brew/org-brew
2593 for brewing beer. This is again, mostly just calc functions, including
2594 hydrometer correction, abv calculation, priming sugar for a given CO_2
2595 volume, etc. More integration with org-mode should be possible: for
2596 instance it would be nice to be able to use a lookup table (of ingredients)
2597 to calculate target original gravity, IBUs, etc.