docco tool (see http://jashkenas.github.com/docco/) generates
display of source code and comments. This file (see org-docco.org)
generates the same type of output from Org-mode documents with code
embedded in code blocks.
The way this works is an Org-mode document with embedded code blocks
is exported to html using the standard Org-mode export functions.
This file defines a new function named
org-docco-buffer which, when
added to the
org-export-html-final-hook, will be run automatically
as part of the Org-mod export process doccoizing your Org-mode
A pure source code file can be extracted (or "/tangled/") from the
Org-mode document using the normal
org-babel-tangle function. See
Working With Source Code chapter of the Org-mode manual for more
information on using code blocks in Org-mode files.
*Disclaimer*: this currently only works on very simple Org-mode files which have no headings but rather are just a collection of alternating text and code blocks. It wouldn't be difficult to generalize the following code so that it could be run in particular sub-trees but I simply don't have the time to do so myself, and this version perfectly satisfies my own limit needs. I make no promises to support this code moving forward. Caveat Emptor
;;; org-docco.el --- docco type html generation from Org-mode
;; Copyright (C) 2012 Eric Schulte
;; Author: Eric Schulte ;; Keywords: org-mode, literate programming, html ;; Homepage: https://orgmode.org/worg/org-contrib/org-mime.php ;; Version: 0.01
;; This file is not part of GNU Emacs.
;; This program is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation; either version 3, or (at your option) ;; any later version. ;; ;; This program is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs; see the file COPYING. If not, write to the ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, ;; Boston, MA 02110-1301, USA.
;; <- look over there
cl package provides all of the state-changing functions used
incf. It looks like a namespace-safe version
cl may soon be permissible for use in official Emacs packages.
;;; Code: (require 'cl)
This is a function which returns the buffer positions of matching regular expressions. It has two special features...
end-reare set to
(and =)= respectively and we run this against the following,
1 2 3 4 5 6 | | | | | | v v v v v v (foo (bar baz) (qux) quux)
(defun org-docco-balanced-re (beg-re end-re) "Return the beginning and of a balanced regexp." (save-excursion (save-match-data (let ((both-re (concat "\\(" beg-re "\\|" end-re "\\)")) (beg-count 0) (end-count 0) beg end) (when (re-search-forward beg-re nil t) (goto-char (match-beginning 0)) (setq beg (point-marker)) (incf beg-count) (goto-char (match-end 0)) (while (and (not end) (re-search-forward both-re nil t)) (goto-char (match-beginning 0)) (cond ((looking-at beg-re) (incf beg-count)) ((looking-at end-re) (incf end-count)) (:otherwise (error "miss-matched"))) (goto-char (match-end 0)) (when (= beg-count end-count) (setq end (point-marker)))) (when end (cons beg end)))))))
(org-docco-balanced-re "<div" "</div>")to find the
(defun org-docco-buffer () "Call from within an HTML buffer to doccoize it." (interactive) (let ((table-start "
|\n") (doc-row-end "\n") (code-row-start "||\n") (code-row-end "|
")) (goto-char (cdr next)) (push (car next) transition-points) (push (cdr next) transition-points)) (goto-char (cdr pair)) (push (and (re-search-backward "
We'll use Emacs File Local Variables and the =org-export-html-final-hook= to control which buffers have =org-docco-buffer= run as part of their export process.
(defvar org-docco-doccoize-me nil "File local variable controlling if html export should be doccoized.") (make-local-variable 'org-docco-doccoize-me)
A simple function will conditionally process HTML output based on the value of this variable.
(defun org-docco-buffer-maybe () (when org-docco-doccoize-me (org-docco-buffer)))
Finally this function is added to the
(add-hook 'org-export-html-final-hook #'org-docco-buffer-maybe)
That's it. To use this simply;
git clone git://github.com/eschulte/org-docco.git
and open it using Emacs.
org-docco.elout of this file by calling
C-c C-v t.
(add-file-local-variable 'org-export-html-postamble nil) (add-file-local-variable 'org-export-html-style-include-default nil) (add-file-local-variable 'org-docco-doccoize-me t)
And add the following style declaration to make use of the
docco.css style sheet taken directly from
(provide 'org-docco) ;;; org-docco.el ends here