[bpt/emacs.git] / lisp / org / ox-org.el

;;; ox-org.el --- Org Back-End for Org Export Engine

;; Copyright (C) 2013-2014 Free Software Foundation, Inc.

;; Author: Nicolas Goaziou <n.goaziou@gmail.com>
;; Keywords: org, wp

;; This file is part of GNU Emacs.

;; GNU Emacs 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 of the License, or
;; (at your option) any later version.

;; GNU Emacs 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.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;;; Code:

(require 'ox)
(declare-function htmlize-buffer "htmlize" (&optional buffer))

(defgroup org-export-org nil
  "Options for exporting Org mode files to Org."
  :tag "Org Export Org"
  :group 'org-export
  :version "24.4"
  :package-version '(Org . "8.0"))

(define-obsolete-variable-alias
  'org-export-htmlized-org-css-url 'org-org-htmlized-css-url "24.4")
(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")))

(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)
    (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))))))))

(defun org-org-identity (blob contents info)
  "Transcode BLOB element or object back into Org syntax.
CONTENTS is its contents, as a string or nil.  INFO is ignored."
  (let ((case-fold-search t))
    (replace-regexp-in-string
     "^[ \t]*#\\+ATTR_[-_A-Za-z0-9]+:\\(?: .*\\)?\n" ""
     (org-export-expand blob contents t))))

(defun org-org-headline (headline contents info)
  "Transcode HEADLINE element back into Org syntax.
CONTENTS is its contents, as a string or nil.  INFO is ignored."
  (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))
  (org-element-put-property headline :level
			    (org-export-get-relative-level headline info))
  (org-element-headline-interpreter headline contents))

(defun org-org-keyword (keyword contents info)
  "Transcode KEYWORD element back into Org syntax.
CONTENTS is nil.  INFO is ignored.  This function ignores
keywords targeted at other export back-ends."
  (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)))

;;;###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)
  (org-export-to-buffer 'org "*Org ORG Export*"
    async subtreep visible-only nil ext-plist (lambda () (org-mode))))

;;;###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)))
    (org-export-to-file 'org outfile
      async subtreep visible-only nil ext-plist)))

;;;###autoload
(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."
  (org-publish-org-to 'org filename ".org" plist pub-dir)
  (when (plist-get plist :htmlized-source)
    (require 'htmlize)
    (require 'ox-html)
    (let* ((org-inhibit-startup t)
	   (htmlize-output-type 'css)
	   (html-ext (concat "." (or (plist-get plist :html-extension)
				     org-html-extension "html")))
	   (visitingp (find-buffer-visiting filename))
	   (work-buffer (or visitingp (find-file-noselect filename)))
	   newbuf)
      (with-current-buffer work-buffer
        (org-font-lock-ensure)
        (show-all)
        (org-show-block-all)
        (setq newbuf (htmlize-buffer)))
      (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)))
	(write-file (concat pub-dir (file-name-nondirectory filename) html-ext)))
      (kill-buffer newbuf)
      (unless visitingp (kill-buffer work-buffer)))
    ;; FIXME: Why?  Which buffer is this supposed to apply to?
    (set-buffer-modified-p nil)))


(provide 'ox-org)

;; Local variables:
;; generated-autoload-file: "org-loaddefs.el"
;; End:

;;; ox-org.el ends here
Commit	Line	Data
271672fa BG	1	;;; ox-org.el --- Org Back-End for Org Export Engine
271672fa BG	2
ba318903	3	;; Copyright (C) 2013-2014 Free Software Foundation, Inc.
271672fa BG	4
	5	;; Author: Nicolas Goaziou <n.goaziou@gmail.com>
	6	;; Keywords: org, wp
	7
439d6b1c GM	8	;; This file is part of GNU Emacs.
439d6b1c GM	9
271672fa BG	10	;; GNU Emacs is free software: you can redistribute it and/or modify
	11	;; it under the terms of the GNU General Public License as published by
	12	;; the Free Software Foundation, either version 3 of the License, or
	13	;; (at your option) any later version.
	14
	15	;; GNU Emacs is distributed in the hope that it will be useful,
	16	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	;; GNU General Public License for more details.
	19
	20	;; You should have received a copy of the GNU General Public License
	21	;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
	22
	23	;;; Commentary:
	24
271672fa	25	;;; Code:
3c8b09ca	26
271672fa BG	27	(require 'ox)
	28	(declare-function htmlize-buffer "htmlize" (&optional buffer))
	29
	30	(defgroup org-export-org nil
	31	"Options for exporting Org mode files to Org."
	32	:tag "Org Export Org"
	33	:group 'org-export
	34	:version "24.4"
	35	:package-version '(Org . "8.0"))
	36
	37	(define-obsolete-variable-alias
	38	'org-export-htmlized-org-css-url 'org-org-htmlized-css-url "24.4")
	39	(defcustom org-org-htmlized-css-url nil
	40	"URL pointing to the CSS defining colors for htmlized Emacs buffers.
	41	Normally when creating an htmlized version of an Org buffer,
	42	htmlize will create the CSS to define the font colors. However,
	43	this does not work when converting in batch mode, and it also can
	44	look bad if different people with different fontification setup
	45	work on the same website. When this variable is non-nil,
	46	creating an htmlized version of an Org buffer using
	47	`org-org-export-as-org' will include a link to this URL if the
	48	setting of `org-html-htmlize-output-type' is 'css."
	49	:group 'org-export-org
	50	:type '(choice
	51	(const :tag "Don't include external stylesheet link" nil)
	52	(string :tag "URL or local href")))
	53
	54	(org-export-define-backend 'org
	55	'((babel-call . org-org-identity)
	56	(bold . org-org-identity)
	57	(center-block . org-org-identity)
	58	(clock . org-org-identity)
	59	(code . org-org-identity)
	60	(comment . (lambda (&rest args) ""))
	61	(comment-block . (lambda (&rest args) ""))
	62	(diary-sexp . org-org-identity)
	63	(drawer . org-org-identity)
	64	(dynamic-block . org-org-identity)
	65	(entity . org-org-identity)
	66	(example-block . org-org-identity)
	67	(fixed-width . org-org-identity)
	68	(footnote-definition . org-org-identity)
	69	(footnote-reference . org-org-identity)
	70	(headline . org-org-headline)
	71	(horizontal-rule . org-org-identity)
	72	(inline-babel-call . org-org-identity)
	73	(inline-src-block . org-org-identity)
	74	(inlinetask . org-org-identity)
	75	(italic . org-org-identity)
	76	(item . org-org-identity)
	77	(keyword . org-org-keyword)
	78	(latex-environment . org-org-identity)
	79	(latex-fragment . org-org-identity)
	80	(line-break . org-org-identity)
	81	(link . org-org-identity)
	82	(node-property . org-org-identity)
	83	(paragraph . org-org-identity)
	84	(plain-list . org-org-identity)
	85	(planning . org-org-identity)
	86	(property-drawer . org-org-identity)
	87	(quote-block . org-org-identity)
	88	(quote-section . org-org-identity)
	89	(radio-target . org-org-identity)
	90	(section . org-org-identity)
91	(special-block . org-org-identity)
92	(src-block . org-org-identity)
93	(statistics-cookie . org-org-identity)
94	(strike-through . org-org-identity)
95	(subscript . org-org-identity)
96	(superscript . org-org-identity)
97	(table . org-org-identity)
98	(table-cell . org-org-identity)
99	(table-row . org-org-identity)
100	(target . org-org-identity)
101	(timestamp . org-org-identity)
102	(underline . org-org-identity)
103	(verbatim . org-org-identity)
104	(verse-block . org-org-identity))
105	:menu-entry
106	'(?O "Export to Org"
107	((?O "As Org buffer" org-org-export-as-org)
108	(?o "As Org file" org-org-export-to-org)
109	(?v "As Org file and open"
110	(lambda (a s v b)
111	(if a (org-org-export-to-org t s v b)
112	(org-open-file (org-org-export-to-org nil s v b))))))))
113
114	(defun org-org-identity (blob contents info)
115	"Transcode BLOB element or object back into Org syntax.
116	CONTENTS is its contents, as a string or nil. INFO is ignored."
3c8b09ca BG	117	(let ((case-fold-search t))
	118	(replace-regexp-in-string
	119	"^[ \t]#\\+ATTR_[-_A-Za-z0-9]+:\\(?: .\\)?\n" ""
	120	(org-export-expand blob contents t))))
271672fa BG	121
	122	(defun org-org-headline (headline contents info)
	123	"Transcode HEADLINE element back into Org syntax.
	124	CONTENTS is its contents, as a string or nil. INFO is ignored."
	125	(unless (plist-get info :with-todo-keywords)
	126	(org-element-put-property headline :todo-keyword nil))
	127	(unless (plist-get info :with-tags)
	128	(org-element-put-property headline :tags nil))
	129	(unless (plist-get info :with-priority)
	130	(org-element-put-property headline :priority nil))
	131	(org-element-put-property headline :level
	132	(org-export-get-relative-level headline info))
	133	(org-element-headline-interpreter headline contents))
	134
	135	(defun org-org-keyword (keyword contents info)
	136	"Transcode KEYWORD element back into Org syntax.
	137	CONTENTS is nil. INFO is ignored. This function ignores
	138	keywords targeted at other export back-ends."
	139	(unless (member (org-element-property :key keyword)
	140	(mapcar
	141	(lambda (block-cons)
	142	(and (eq (cdr block-cons) 'org-element-export-block-parser)
	143	(car block-cons)))
	144	org-element-block-name-alist))
	145	(org-element-keyword-interpreter keyword nil)))
	146
	147	;;;###autoload
	148	(defun org-org-export-as-org (&optional async subtreep visible-only ext-plist)
	149	"Export current buffer to an Org buffer.
	150
	151	If narrowing is active in the current buffer, only export its
	152	narrowed part.
	153
	154	If a region is active, export that region.
	155
	156	A non-nil optional argument ASYNC means the process should happen
	157	asynchronously. The resulting buffer should be accessible
	158	through the `org-export-stack' interface.
	159
	160	When optional argument SUBTREEP is non-nil, export the sub-tree
	161	at point, extracting information from the headline properties
	162	first.
	163
	164	When optional argument VISIBLE-ONLY is non-nil, don't export
	165	contents of hidden elements.
	166
	167	EXT-PLIST, when provided, is a property list with external
	168	parameters overriding Org default settings, but still inferior to
	169	file-local settings.
	170
	171	Export is done in a buffer named \"Org ORG Export\", which will
	172	be displayed when `org-export-show-temporary-export-buffer' is
	173	non-nil."
	174	(interactive)
	175	(org-export-to-buffer 'org "Org ORG Export"
	176	async subtreep visible-only nil ext-plist (lambda () (org-mode))))
	177
	178	;;;###autoload
	179	(defun org-org-export-to-org (&optional async subtreep visible-only ext-plist)
	180	"Export current buffer to an org file.
	181
	182	If narrowing is active in the current buffer, only export its
	183	narrowed part.
	184
185	If a region is active, export that region.
186
187	A non-nil optional argument ASYNC means the process should happen
188	asynchronously. The resulting file should be accessible through
189	the `org-export-stack' interface.
190
191	When optional argument SUBTREEP is non-nil, export the sub-tree
192	at point, extracting information from the headline properties
193	first.
194
195	When optional argument VISIBLE-ONLY is non-nil, don't export
196	contents of hidden elements.
197
198	EXT-PLIST, when provided, is a property list with external
199	parameters overriding Org default settings, but still inferior to
200	file-local settings.
201
202	Return output file name."
203	(interactive)
204	(let ((outfile (org-export-output-file-name ".org" subtreep)))
205	(org-export-to-file 'org outfile
206	async subtreep visible-only nil ext-plist)))
207
208	;;;###autoload
209	(defun org-org-publish-to-org (plist filename pub-dir)
210	"Publish an org file to org.
211
212	FILENAME is the filename of the Org file to be published. PLIST
213	is the property list for the given project. PUB-DIR is the
214	publishing directory.
215
216	Return output file name."
217	(org-publish-org-to 'org filename ".org" plist pub-dir)
218	(when (plist-get plist :htmlized-source)
219	(require 'htmlize)
220	(require 'ox-html)
221	(let* ((org-inhibit-startup t)
222	(htmlize-output-type 'css)
223	(html-ext (concat "." (or (plist-get plist :html-extension)
224	org-html-extension "html")))
225	(visitingp (find-buffer-visiting filename))
6711a21f	226	(work-buffer (or visitingp (find-file-noselect filename)))
271672fa	227	newbuf)
6711a21f SM	228	(with-current-buffer work-buffer
	229	(org-font-lock-ensure)
	230	(show-all)
	231	(org-show-block-all)
	232	(setq newbuf (htmlize-buffer)))
271672fa BG	233	(with-current-buffer newbuf
	234	(when org-org-htmlized-css-url
	235	(goto-char (point-min))
	236	(and (re-search-forward
	237	"<style type=\"text/css\">[^\000]?\n[ \t]</style>.*" nil t)
	238	(replace-match
	239	(format
	240	"<link rel=\"stylesheet\" type=\"text/css\" href=\"%s\">"
6711a21f SM	241	org-org-htmlized-css-url)
6711a21f SM	242	t t)))
271672fa BG	243	(write-file (concat pub-dir (file-name-nondirectory filename) html-ext)))
	244	(kill-buffer newbuf)
	245	(unless visitingp (kill-buffer work-buffer)))
6711a21f	246	;; FIXME: Why? Which buffer is this supposed to apply to?
271672fa BG	247	(set-buffer-modified-p nil)))
	248
	249
	250	(provide 'ox-org)
	251
	252	;; Local variables:
	253	;; generated-autoload-file: "org-loaddefs.el"
	254	;; End:
	255
	256	;;; ox-org.el ends here