lisp/org-special-blocks.el

   1 ;;; org-special-blocks.el --- Turn blocks into LaTeX envs and HTML divs
   2
   3 ;; Copyright (C) 2009 Chris Gray
   4
   5 ;; Author: Chris Gray <chrismgray@gmail.com>
   6
   7 ;; This file is not currently part of GNU Emacs.
   8
   9 ;; This program is free software; you can redistribute it and/or
  10 ;; modify it under the terms of the GNU General Public License as
  11 ;; published by the Free Software Foundation; either version 2, or (at
  12 ;; your option) any later version.
  13
  14 ;; This program is distributed in the hope that it will be useful, but
  15 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 ;; General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with this program ; see the file COPYING.  If not, write to
  21 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22 ;; Boston, MA 02111-1307, USA.
  23
  24 ;;; Commentary:
  25 ;;
  26
  27 ;; This package generalizes the #+begin_foo and #+end_foo tokens.
  28
  29 ;; To use, put the following in your init file:
  30 ;;
  31 ;; (require 'org-special-blocks)
  32
  33 ;; The tokens #+begin_center, #+begin_verse, etc. existed previously.
  34 ;; This package generalizes them (at least for the LaTeX and html
  35 ;; exporters).  When a #+begin_foo token is encountered by the LaTeX
  36 ;; exporter, it is expanded into \begin{foo}.  The text inside the
  37 ;; environment is not protected, as text inside environments generally
  38 ;; is.  When #+begin_foo is encountered by the html exporter, a div
  39 ;; with class foo is inserted into the HTML file.  It is up to the
  40 ;; user to add this class to his or her stylesheet if this div is to
  41 ;; mean anything.
  42
  43 (require 'org-compat)
  44
  45 (defvar org-special-blocks-ignore-regexp "^\\(LaTeX\\|HTML\\)$"
  46   "A regexp indicating the names of blocks that should be ignored
  47 by org-special-blocks.  These blocks will presumably be
  48 interpreted by other mechanisms.")
  49
  50 (defvar backend) ; dynamically scoped
  51 (defun org-special-blocks-make-special-cookies ()
  52   "Adds special cookies when #+begin_foo and #+end_foo tokens are
  53 seen.  This is run after a few special cases are taken care of."
  54   (when (or (eq backend 'html) (eq backend 'latex))
  55     (goto-char (point-min))
  56     (while (re-search-forward "^[ \t]*#\\+\\(begin\\|end\\)_\\(.*\\)$" nil t)
  57       (unless (org-string-match-p org-special-blocks-ignore-regexp (match-string 2))
  58         (replace-match
  59          (if (equal (downcase (match-string 1)) "begin")
  60              (concat "ORG-" (match-string 2) "-START")
  61            (concat "ORG-" (match-string 2) "-END"))
  62          t t)))))
  63
  64 (add-hook 'org-export-preprocess-after-blockquote-hook
  65           'org-special-blocks-make-special-cookies)
  66
  67 (defun org-special-blocks-convert-latex-special-cookies ()
  68   "Converts the special cookies into LaTeX blocks."
  69   (goto-char (point-min))
  70   (while (re-search-forward "^ORG-\\([^ \t\n]*\\)[ \t]*\\(.*\\)-\\(START\\|END\\)$" nil t)
  71     (replace-match
  72      (if (equal (match-string 3) "START")
  73          (concat "\\begin{" (match-string 1) "}" (match-string 2))
  74        (concat "\\end{" (match-string 1) "}"))
  75      t t)))
  76
  77
  78 (add-hook 'org-export-latex-after-blockquotes-hook
  79           'org-special-blocks-convert-latex-special-cookies)
  80
  81 (defvar line)
  82 (defun org-special-blocks-convert-html-special-cookies ()
  83   "Converts the special cookies into div blocks."
  84   ;; Uses the dynamically-bound variable `line'.
  85   (when (string-match "^ORG-\\(.*\\)-\\(START\\|END\\)$" line)
  86 ;    (org-close-par-maybe)
  87     (message "%s" (match-string 1))
  88     (if (equal (match-string 2 line) "START")
  89         (insert "<div class=\"" (match-string 1 line) "\">\n")
  90       (insert "</div>\n"))
  91     (throw 'nextline nil)))
  92
  93 (add-hook 'org-export-html-after-blockquotes-hook
  94           'org-special-blocks-convert-html-special-cookies)
  95
  96 (provide 'org-special-blocks)
  97
  98 ;;; org-special-blocks.el ends here