2013-01-27 22:11:34 +00:00
|
|
|
;;; ox-org.el --- Org Back-End for Org Export Engine
|
|
|
|
|
|
2014-01-07 13:18:17 +00:00
|
|
|
;; Copyright (C) 2013-2014 Free Software Foundation, Inc.
|
2013-01-27 22:11:34 +00:00
|
|
|
|
|
|
|
|
;; Author: Nicolas Goaziou <n.goaziou@gmail.com>
|
|
|
|
|
;; Keywords: org, wp
|
|
|
|
|
|
Backport changes from Emacs revs 115081 and 115082
2013-11-12 Stefan Monnier <monnier@iro.umontreal.ca>
Address some byte-compiler warnings.
* ob-abc.el (org-babel-expand-body:abc): Use dolist.
(org-babel-execute:abc): Fix regexp quoting.
* ob-calc.el (org--var-syms): Rename from `var-syms'.
* ob-lilypond.el (ly-compile-lilyfile): Remove redundant let-binding.
* ob-table.el (sbe): Move debug declaration.
* org-clock.el (org--msg-extra): Rename from `msg-extra'.
* org.el (org-version): Avoid var name starting with _.
(org-inhibit-startup, org-called-with-limited-levels)
(org-link-search-inhibit-query, org-time-was-given)
(org-end-time-was-given, org-def, org-defdecode, org-with-time):
* org-colview.el (org-agenda-overriding-columns-format):
* org-agenda.el (org-agenda-multi, org-depend-tag-blocked)
(org-agenda-show-log-scoped):
* ob-python.el (py-which-bufname, python-shell-buffer-name):
* ob-haskell.el (org-export-copy-to-kill-ring):
* ob-exp.el (org-link-search-inhibit-query):
* ob-R.el (ess-eval-visibly-p):
* ob-core.el (org-src-window-setup): Declare before use.
(org-babel-expand-noweb-references): Remove unused `blocks-in-buffer'.
* ox-odt.el (org-odt-hfy-face-to-css):
* org-src.el (org-src-associate-babel-session, org-src-get-lang-mode):
* org-bibtex.el (org-bibtex-get, org-bibtex-ask, org-bibtex)
(org-bibtex-check):
* ob-tangle.el (org-babel-tangle, org-babel-spec-to-string)
(org-babel-tangle-single-block, org-babel-tangle-comment-links):
* ob-table.el (sbe):
* ob-sqlite.el (org-babel-sqlite-expand-vars):
* ob-sql.el (org-babel-sql-expand-vars):
* ob-shen.el (org-babel-execute:shen):
* ob-sh.el (org-babel-execute:sh, org-babel-sh-evaluate):
* ob-scala.el (org-babel-scala-evaluate):
* ob-ruby.el (org-babel-ruby-table-or-string)
(org-babel-ruby-evaluate):
* ob-python.el (org-babel-python-table-or-string)
(org-babel-python-evaluate-external-process)
(org-babel-python-evaluate-session):
* ob-picolisp.el (org-babel-execute:picolisp):
* ob-perl.el (org-babel-perl-evaluate):
* ob-maxima.el (org-babel-execute:maxima):
* ob-lisp.el (org-babel-execute:lisp):
* ob-java.el (org-babel-execute:java):
* ob-io.el (org-babel-io-evaluate):
* ob-haskell.el (org-babel-execute:haskell):
* ob-fortran.el (org-babel-execute:fortran):
* ob-exp.el (org-babel-exp-code):
* ob-emacs-lisp.el (org-babel-execute:emacs-lisp):
* ob-ditaa.el (org-babel-execute:ditaa):
* ob-core.el (org-babel-execute-src-block, org-babel-sha1-hash)
(org-babel-parse-header-arguments, org-babel-reassemble-table)
(org-babel-goto-src-block-head, org-babel-mark-block)
(org-babel-expand-noweb-references, org-babel-script-escape)
(org-babel-process-file-name):
* ob-clojure.el (org-babel-execute:clojure):
* ob-calc.el (org-babel-execute:calc):
* ob-awk.el (org-babel-execute:awk):
* ob-abc.el (org-babel-execute:abc):
* ob-R.el (org-babel-expand-body:R):
* ob-C.el (org-babel-C-execute): Avoid deprecated ((lambda) ...).
2013-11-12 Glenn Morris <rgm@gnu.org>
* ox-html.el (org-html-scripts): Add 2013 to copyright years.
(org-html-infojs-template): Copyright holder to FSF.
2013-11-12 19:57:31 +00:00
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
|
2013-02-23 08:56:24 +00:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2013-01-27 22:11:34 +00:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
|
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
|
;; (at your option) any later version.
|
|
|
|
|
|
2013-02-23 08:56:24 +00:00
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
2013-01-27 22:11:34 +00:00
|
|
|
;; 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
|
2013-02-23 08:56:24 +00:00
|
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
2013-01-27 22:11:34 +00:00
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
|
|
;;; Code:
|
2013-12-15 13:52:46 +00:00
|
|
|
|
2013-01-27 22:11:34 +00:00
|
|
|
(require 'ox)
|
2013-03-02 18:31:12 +00:00
|
|
|
(declare-function htmlize-buffer "htmlize" (&optional buffer))
|
2013-01-27 22:11:34 +00:00
|
|
|
|
2013-03-02 17:46:07 +00:00
|
|
|
(defgroup org-export-org nil
|
|
|
|
|
"Options for exporting Org mode files to Org."
|
|
|
|
|
:tag "Org Export Org"
|
2013-03-02 18:31:12 +00:00
|
|
|
:group 'org-export
|
|
|
|
|
:version "24.4"
|
|
|
|
|
:package-version '(Org . "8.0"))
|
2013-03-02 17:46:07 +00:00
|
|
|
|
2013-03-04 06:36:54 +00:00
|
|
|
(define-obsolete-variable-alias
|
|
|
|
|
'org-export-htmlized-org-css-url 'org-org-htmlized-css-url "24.4")
|
2013-03-02 17:46:07 +00:00
|
|
|
(defcustom org-org-htmlized-css-url nil
|
|
|
|
|
"URL pointing to the CSS defining colors for htmlized Emacs buffers.
|
|
|
|
|
Normally when creating an htmlized version of an Org buffer,
|
|
|
|
|
htmlize will create the CSS to define the font colors. However,
|
|
|
|
|
this does not work when converting in batch mode, and it also can
|
|
|
|
|
look bad if different people with different fontification setup
|
|
|
|
|
work on the same website. When this variable is non-nil,
|
|
|
|
|
creating an htmlized version of an Org buffer using
|
|
|
|
|
`org-org-export-as-org' will include a link to this URL if the
|
|
|
|
|
setting of `org-html-htmlize-output-type' is 'css."
|
|
|
|
|
:group 'org-export-org
|
|
|
|
|
:type '(choice
|
|
|
|
|
(const :tag "Don't include external stylesheet link" nil)
|
|
|
|
|
(string :tag "URL or local href")))
|
|
|
|
|
|
2013-03-19 15:24:40 +00:00
|
|
|
(org-export-define-backend 'org
|
|
|
|
|
'((babel-call . org-org-identity)
|
|
|
|
|
(bold . org-org-identity)
|
|
|
|
|
(center-block . org-org-identity)
|
|
|
|
|
(clock . org-org-identity)
|
|
|
|
|
(code . org-org-identity)
|
|
|
|
|
(comment . (lambda (&rest args) ""))
|
|
|
|
|
(comment-block . (lambda (&rest args) ""))
|
|
|
|
|
(diary-sexp . org-org-identity)
|
|
|
|
|
(drawer . org-org-identity)
|
|
|
|
|
(dynamic-block . org-org-identity)
|
|
|
|
|
(entity . org-org-identity)
|
|
|
|
|
(example-block . org-org-identity)
|
|
|
|
|
(fixed-width . org-org-identity)
|
|
|
|
|
(footnote-definition . org-org-identity)
|
|
|
|
|
(footnote-reference . org-org-identity)
|
|
|
|
|
(headline . org-org-headline)
|
|
|
|
|
(horizontal-rule . org-org-identity)
|
|
|
|
|
(inline-babel-call . org-org-identity)
|
|
|
|
|
(inline-src-block . org-org-identity)
|
|
|
|
|
(inlinetask . org-org-identity)
|
|
|
|
|
(italic . org-org-identity)
|
|
|
|
|
(item . org-org-identity)
|
|
|
|
|
(keyword . org-org-keyword)
|
|
|
|
|
(latex-environment . org-org-identity)
|
|
|
|
|
(latex-fragment . org-org-identity)
|
|
|
|
|
(line-break . org-org-identity)
|
|
|
|
|
(link . org-org-identity)
|
|
|
|
|
(node-property . org-org-identity)
|
|
|
|
|
(paragraph . org-org-identity)
|
|
|
|
|
(plain-list . org-org-identity)
|
|
|
|
|
(planning . org-org-identity)
|
|
|
|
|
(property-drawer . org-org-identity)
|
|
|
|
|
(quote-block . org-org-identity)
|
|
|
|
|
(quote-section . org-org-identity)
|
|
|
|
|
(radio-target . org-org-identity)
|
|
|
|
|
(section . org-org-identity)
|
|
|
|
|
(special-block . org-org-identity)
|
|
|
|
|
(src-block . org-org-identity)
|
|
|
|
|
(statistics-cookie . org-org-identity)
|
|
|
|
|
(strike-through . org-org-identity)
|
|
|
|
|
(subscript . org-org-identity)
|
|
|
|
|
(superscript . org-org-identity)
|
|
|
|
|
(table . org-org-identity)
|
|
|
|
|
(table-cell . org-org-identity)
|
|
|
|
|
(table-row . org-org-identity)
|
|
|
|
|
(target . org-org-identity)
|
|
|
|
|
(timestamp . org-org-identity)
|
|
|
|
|
(underline . org-org-identity)
|
|
|
|
|
(verbatim . org-org-identity)
|
2013-04-04 13:09:22 +00:00
|
|
|
(verse-block . org-org-identity))
|
|
|
|
|
:menu-entry
|
|
|
|
|
'(?O "Export to Org"
|
|
|
|
|
((?O "As Org buffer" org-org-export-as-org)
|
|
|
|
|
(?o "As Org file" org-org-export-to-org)
|
|
|
|
|
(?v "As Org file and open"
|
|
|
|
|
(lambda (a s v b)
|
|
|
|
|
(if a (org-org-export-to-org t s v b)
|
|
|
|
|
(org-open-file (org-org-export-to-org nil s v b))))))))
|
2013-01-27 22:11:34 +00:00
|
|
|
|
|
|
|
|
(defun org-org-identity (blob contents info)
|
2013-04-17 20:44:28 +00:00
|
|
|
"Transcode BLOB element or object back into Org syntax.
|
|
|
|
|
CONTENTS is its contents, as a string or nil. INFO is ignored."
|
2013-12-15 14:17:24 +00:00
|
|
|
(let ((case-fold-search t))
|
|
|
|
|
(replace-regexp-in-string
|
|
|
|
|
"^[ \t]*#\\+ATTR_[-_A-Za-z0-9]+:\\(?: .*\\)?\n" ""
|
|
|
|
|
(org-export-expand blob contents t))))
|
2013-01-27 22:11:34 +00:00
|
|
|
|
|
|
|
|
(defun org-org-headline (headline contents info)
|
2013-04-17 20:44:28 +00:00
|
|
|
"Transcode HEADLINE element back into Org syntax.
|
|
|
|
|
CONTENTS is its contents, as a string or nil. INFO is ignored."
|
2013-01-27 22:11:34 +00:00
|
|
|
(unless (plist-get info :with-todo-keywords)
|
|
|
|
|
(org-element-put-property headline :todo-keyword nil))
|
|
|
|
|
(unless (plist-get info :with-tags)
|
|
|
|
|
(org-element-put-property headline :tags nil))
|
|
|
|
|
(unless (plist-get info :with-priority)
|
|
|
|
|
(org-element-put-property headline :priority nil))
|
2013-11-06 18:14:14 +00:00
|
|
|
(org-element-put-property headline :level
|
|
|
|
|
(org-export-get-relative-level headline info))
|
2013-01-27 22:11:34 +00:00
|
|
|
(org-element-headline-interpreter headline contents))
|
|
|
|
|
|
|
|
|
|
(defun org-org-keyword (keyword contents info)
|
|
|
|
|
"Transcode KEYWORD element back into Org syntax.
|
2013-04-17 20:44:28 +00:00
|
|
|
CONTENTS is nil. INFO is ignored. This function ignores
|
|
|
|
|
keywords targeted at other export back-ends."
|
2013-01-27 22:11:34 +00:00
|
|
|
(unless (member (org-element-property :key keyword)
|
|
|
|
|
(mapcar
|
|
|
|
|
(lambda (block-cons)
|
|
|
|
|
(and (eq (cdr block-cons) 'org-element-export-block-parser)
|
|
|
|
|
(car block-cons)))
|
|
|
|
|
org-element-block-name-alist))
|
|
|
|
|
(org-element-keyword-interpreter keyword nil)))
|
|
|
|
|
|
2013-04-04 13:09:22 +00:00
|
|
|
;;;###autoload
|
|
|
|
|
(defun org-org-export-as-org (&optional async subtreep visible-only ext-plist)
|
|
|
|
|
"Export current buffer to an Org buffer.
|
|
|
|
|
|
|
|
|
|
If narrowing is active in the current buffer, only export its
|
|
|
|
|
narrowed part.
|
|
|
|
|
|
|
|
|
|
If a region is active, export that region.
|
|
|
|
|
|
|
|
|
|
A non-nil optional argument ASYNC means the process should happen
|
|
|
|
|
asynchronously. The resulting buffer should be accessible
|
|
|
|
|
through the `org-export-stack' interface.
|
|
|
|
|
|
|
|
|
|
When optional argument SUBTREEP is non-nil, export the sub-tree
|
|
|
|
|
at point, extracting information from the headline properties
|
|
|
|
|
first.
|
|
|
|
|
|
|
|
|
|
When optional argument VISIBLE-ONLY is non-nil, don't export
|
|
|
|
|
contents of hidden elements.
|
|
|
|
|
|
|
|
|
|
EXT-PLIST, when provided, is a property list with external
|
|
|
|
|
parameters overriding Org default settings, but still inferior to
|
|
|
|
|
file-local settings.
|
|
|
|
|
|
|
|
|
|
Export is done in a buffer named \"*Org ORG Export*\", which will
|
|
|
|
|
be displayed when `org-export-show-temporary-export-buffer' is
|
|
|
|
|
non-nil."
|
|
|
|
|
(interactive)
|
Export back-ends: Apply changes to export functions
* contrib/lisp/ox-confluence.el (org-confluence-export-as-confluence):
* contrib/lisp/ox-deck.el (org-deck-export-as-html,
org-deck-export-to-html):
* contrib/lisp/ox-freemind.el (org-freemind-export-to-freemind):
* contrib/lisp/ox-groff.el (org-groff-export-to-groff,
org-groff-export-to-pdf):
* contrib/lisp/ox-koma-letter.el (org-koma-letter-export-as-latex,
org-koma-letter-export-to-latex, org-koma-letter-export-to-pdf):
* contrib/lisp/ox-rss.el (org-rss-export-as-rss,
org-rss-export-to-rss):
* contrib/lisp/ox-s5.el (org-s5-export-as-html,
org-s5-export-to-html):
* contrib/lisp/ox-taskjuggler.el (org-taskjuggler-export):
* lisp/ob-haskell.el:
* lisp/ox-ascii.el (org-ascii-export-as-ascii,
org-ascii-export-to-ascii):
* lisp/ox-beamer.el (org-beamer-export-as-latex,
org-beamer-export-to-latex, org-beamer-export-to-pdf):
* lisp/ox-html.el (org-html-export-as-html, org-html-export-to-html):
* lisp/ox-icalendar.el (org-icalendar-export-to-ics):
* lisp/ox-latex.el (org-latex-export-as-latex,
org-latex-export-to-pdf):
* lisp/ox-man.el (org-man-export-to-man, org-man-export-to-pdf):
* lisp/ox-md.el (org-md-export-as-markdown,
org-md-export-to-markdown):
* lisp/ox-odt.el (org-odt-export-to-odt):
* lisp/ox-org.el (org-org-export-as-org, org-org-export-to-org):
* lisp/ox-publish.el (org-publish-org-to):
* lisp/ox-texinfo.el (org-texinfo-export-to-texinfo,
org-texinfo-export-to-info):
* testing/lisp/test-ob-exp.el (test-ob-exp/org-babel-exp-src-blocks/w-no-file):
2013-08-07 08:35:42 +00:00
|
|
|
(org-export-to-buffer 'org "*Org ORG Export*"
|
2013-08-23 07:32:35 +00:00
|
|
|
async subtreep visible-only nil ext-plist (lambda () (org-mode))))
|
2013-04-04 13:09:22 +00:00
|
|
|
|
|
|
|
|
;;;###autoload
|
|
|
|
|
(defun org-org-export-to-org (&optional async subtreep visible-only ext-plist)
|
|
|
|
|
"Export current buffer to an org file.
|
|
|
|
|
|
|
|
|
|
If narrowing is active in the current buffer, only export its
|
|
|
|
|
narrowed part.
|
|
|
|
|
|
|
|
|
|
If a region is active, export that region.
|
|
|
|
|
|
|
|
|
|
A non-nil optional argument ASYNC means the process should happen
|
|
|
|
|
asynchronously. The resulting file should be accessible through
|
|
|
|
|
the `org-export-stack' interface.
|
|
|
|
|
|
|
|
|
|
When optional argument SUBTREEP is non-nil, export the sub-tree
|
|
|
|
|
at point, extracting information from the headline properties
|
|
|
|
|
first.
|
|
|
|
|
|
|
|
|
|
When optional argument VISIBLE-ONLY is non-nil, don't export
|
|
|
|
|
contents of hidden elements.
|
|
|
|
|
|
|
|
|
|
EXT-PLIST, when provided, is a property list with external
|
|
|
|
|
parameters overriding Org default settings, but still inferior to
|
|
|
|
|
file-local settings.
|
|
|
|
|
|
|
|
|
|
Return output file name."
|
|
|
|
|
(interactive)
|
|
|
|
|
(let ((outfile (org-export-output-file-name ".org" subtreep)))
|
Export back-ends: Apply changes to export functions
* contrib/lisp/ox-confluence.el (org-confluence-export-as-confluence):
* contrib/lisp/ox-deck.el (org-deck-export-as-html,
org-deck-export-to-html):
* contrib/lisp/ox-freemind.el (org-freemind-export-to-freemind):
* contrib/lisp/ox-groff.el (org-groff-export-to-groff,
org-groff-export-to-pdf):
* contrib/lisp/ox-koma-letter.el (org-koma-letter-export-as-latex,
org-koma-letter-export-to-latex, org-koma-letter-export-to-pdf):
* contrib/lisp/ox-rss.el (org-rss-export-as-rss,
org-rss-export-to-rss):
* contrib/lisp/ox-s5.el (org-s5-export-as-html,
org-s5-export-to-html):
* contrib/lisp/ox-taskjuggler.el (org-taskjuggler-export):
* lisp/ob-haskell.el:
* lisp/ox-ascii.el (org-ascii-export-as-ascii,
org-ascii-export-to-ascii):
* lisp/ox-beamer.el (org-beamer-export-as-latex,
org-beamer-export-to-latex, org-beamer-export-to-pdf):
* lisp/ox-html.el (org-html-export-as-html, org-html-export-to-html):
* lisp/ox-icalendar.el (org-icalendar-export-to-ics):
* lisp/ox-latex.el (org-latex-export-as-latex,
org-latex-export-to-pdf):
* lisp/ox-man.el (org-man-export-to-man, org-man-export-to-pdf):
* lisp/ox-md.el (org-md-export-as-markdown,
org-md-export-to-markdown):
* lisp/ox-odt.el (org-odt-export-to-odt):
* lisp/ox-org.el (org-org-export-as-org, org-org-export-to-org):
* lisp/ox-publish.el (org-publish-org-to):
* lisp/ox-texinfo.el (org-texinfo-export-to-texinfo,
org-texinfo-export-to-info):
* testing/lisp/test-ob-exp.el (test-ob-exp/org-babel-exp-src-blocks/w-no-file):
2013-08-07 08:35:42 +00:00
|
|
|
(org-export-to-file 'org outfile
|
|
|
|
|
async subtreep visible-only nil ext-plist)))
|
2013-04-04 13:09:22 +00:00
|
|
|
|
2013-02-22 12:42:02 +00:00
|
|
|
;;;###autoload
|
2013-02-19 18:17:20 +00:00
|
|
|
(defun org-org-publish-to-org (plist filename pub-dir)
|
|
|
|
|
"Publish an org file to org.
|
|
|
|
|
|
|
|
|
|
FILENAME is the filename of the Org file to be published. PLIST
|
|
|
|
|
is the property list for the given project. PUB-DIR is the
|
|
|
|
|
publishing directory.
|
|
|
|
|
|
|
|
|
|
Return output file name."
|
2013-03-02 17:46:07 +00:00
|
|
|
(org-publish-org-to 'org filename ".org" plist pub-dir)
|
|
|
|
|
(when (plist-get plist :htmlized-source)
|
|
|
|
|
(require 'htmlize)
|
|
|
|
|
(require 'ox-html)
|
2013-03-19 10:15:08 +00:00
|
|
|
(let* ((org-inhibit-startup t)
|
|
|
|
|
(htmlize-output-type 'css)
|
2013-04-03 11:25:11 +00:00
|
|
|
(html-ext (concat "." (or (plist-get plist :html-extension)
|
|
|
|
|
org-html-extension "html")))
|
2013-03-19 10:15:08 +00:00
|
|
|
(visitingp (find-buffer-visiting filename))
|
|
|
|
|
(work-buffer (or visitingp (find-file filename)))
|
|
|
|
|
newbuf)
|
|
|
|
|
(font-lock-fontify-buffer)
|
2013-10-14 08:05:30 +00:00
|
|
|
(show-all)
|
|
|
|
|
(org-show-block-all)
|
2013-03-19 10:15:08 +00:00
|
|
|
(setq newbuf (htmlize-buffer))
|
2013-03-02 17:46:07 +00:00
|
|
|
(with-current-buffer newbuf
|
|
|
|
|
(when org-org-htmlized-css-url
|
|
|
|
|
(goto-char (point-min))
|
|
|
|
|
(and (re-search-forward
|
|
|
|
|
"<style type=\"text/css\">[^\000]*?\n[ \t]*</style>.*" nil t)
|
|
|
|
|
(replace-match
|
|
|
|
|
(format
|
|
|
|
|
"<link rel=\"stylesheet\" type=\"text/css\" href=\"%s\">"
|
|
|
|
|
org-org-htmlized-css-url) t t)))
|
2013-04-03 11:25:11 +00:00
|
|
|
(write-file (concat pub-dir (file-name-nondirectory filename) html-ext)))
|
2013-03-19 10:15:08 +00:00
|
|
|
(kill-buffer newbuf)
|
|
|
|
|
(unless visitingp (kill-buffer work-buffer)))
|
2013-03-02 17:46:07 +00:00
|
|
|
(set-buffer-modified-p nil)))
|
2013-01-27 22:11:34 +00:00
|
|
|
|
2013-04-04 13:09:22 +00:00
|
|
|
|
2013-01-27 22:11:34 +00:00
|
|
|
(provide 'ox-org)
|
|
|
|
|
|
|
|
|
|
;; Local variables:
|
|
|
|
|
;; generated-autoload-file: "org-loaddefs.el"
|
|
|
|
|
;; End:
|
|
|
|
|
|
|
|
|
|
;;; ox-org.el ends here
|