1 ;;; org-lparse.el --- Line-oriented parser-exporter for Org-mode
3 ;; Copyright (C) 2010-2011 Jambunathan <kjambunathan at gmail dot com>
5 ;; Author: Jambunathan K <kjambunathan at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
10 ;; This file is not (yet) part of GNU Emacs.
11 ;; However, it is distributed under the same license.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
29 ;; `org-lparse' is the entry point for the generic line-oriented
30 ;; exporter. `org-do-lparse' is the genericized version of the
31 ;; original `org-export-as-html' routine.
33 ;; `org-lparse-native-backends' is a good starting point for
34 ;; exploring the generic exporter.
36 ;; Following new interactive commands are provided by this library.
37 ;; `org-lparse', `org-lparse-and-open', `org-lparse-to-buffer'
38 ;; `org-replace-region-by', `org-lparse-region'.
40 ;; Note that the above routines correspond to the following routines
41 ;; in the html exporter `org-export-as-html',
42 ;; `org-export-as-html-and-open', `org-export-as-html-to-buffer',
43 ;; `org-replace-region-by-html' and `org-export-region-as-html'.
45 ;; The new interactive command `org-lparse-convert' can be used to
46 ;; convert documents between various formats. Use this to command,
47 ;; for example, to convert odt file to doc or pdf format.
49 ;; See README.org file that comes with this library for answers to
50 ;; FAQs and more information on using this library.
58 (defun org-lparse-and-open (target-backend native-backend arg
)
59 "Export outline to TARGET-BACKEND via NATIVE-BACKEND and open exported file.
60 If there is an active region, export only the region. The prefix
61 ARG specifies how many levels of the outline should become
62 headlines. The default is 3. Lower levels will become bulleted
64 ;; (interactive "Mbackend: \nP")
66 (let* ((input (if (featurep 'ido
) 'ido-completing-read
'completing-read
))
67 (all-backends (org-lparse-all-backends))
69 (funcall input
"Export to: " all-backends nil t nil
))
72 ;; (and (org-lparse-backend-is-native-p target-backend)
74 (funcall input
"Use Native backend: "
75 (cdr (assoc target-backend all-backends
)) nil t nil
))))
76 (list target-backend native-backend current-prefix-arg
)))
77 (let (f (file-or-buf (org-lparse target-backend native-backend
81 ((bufferp file-or-buf
) buffer-file-name
)
82 ((file-exists-p file-or-buf
) file-or-buf
)
83 (t (error "org-lparse-and-open: This shouldn't happen"))))
84 (message "Opening file %s" f
)
86 (when org-export-kill-product-buffer-when-displayed
87 (kill-buffer (current-buffer))))))
90 (defun org-lparse-batch (target-backend &optional native-backend
)
91 "Call the function `org-lparse'.
92 This function can be used in batch processing as:
94 --load=$HOME/lib/emacs/org.el
95 --eval \"(setq org-export-headline-levels 2)\"
96 --visit=MyFile --funcall org-lparse-batch"
97 (setq native-backend
(or native-backend target-backend
))
98 (org-lparse target-backend native-backend
99 org-export-headline-levels
'hidden
))
102 (defun org-lparse-to-buffer (backend arg
)
103 "Call `org-lparse' with output to a temporary buffer.
104 No file is created. The prefix ARG is passed through to
106 (interactive "Mbackend: \nP")
107 (let ((tempbuf (format "*Org %s Export*" (upcase backend
))))
108 (org-lparse backend backend arg nil nil tempbuf
)
109 (when org-export-show-temporary-export-buffer
110 (switch-to-buffer-other-window tempbuf
))))
113 (defun org-replace-region-by (backend beg end
)
114 "Assume the current region has org-mode syntax, and convert it to HTML.
115 This can be used in any buffer. For example, you could write an
116 itemized list in org-mode syntax in an HTML buffer and then use
117 this command to convert it."
118 (interactive "Mbackend: \nr")
119 (let (reg backend-string buf pop-up-frames
)
120 (save-window-excursion
122 (setq backend-string
(org-lparse-region backend beg end t
'string
))
123 (setq reg
(buffer-substring beg end
)
124 buf
(get-buffer-create "*Org tmp*"))
125 (with-current-buffer buf
129 (setq backend-string
(org-lparse-region backend
(point-min)
130 (point-max) t
'string
)))
132 (delete-region beg end
)
133 (insert backend-string
)))
136 (defun org-lparse-region (backend beg end
&optional body-only buffer
)
137 "Convert region from BEG to END in org-mode buffer to HTML.
138 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
139 contents, and only produce the region of converted text, useful for
140 cut-and-paste operations.
141 If BUFFER is a buffer or a string, use/create that buffer as a target
142 of the converted HTML. If BUFFER is the symbol `string', return the
143 produced HTML as a string and leave not buffer behind. For example,
144 a Lisp program could call this function in the following way:
146 (setq html (org-lparse-region \"html\" beg end t 'string))
148 When called interactively, the output buffer is selected, and shown
149 in a window. A non-interactive call will only return the buffer."
150 (interactive "Mbackend: \nr\nP")
151 (when (org-called-interactively-p 'any
)
152 (setq buffer
(format "*Org %s Export*" (upcase backend
))))
153 (let ((transient-mark-mode t
) (zmacs-regions t
)
155 (setq ext-plist
(plist-put ext-plist
:ignore-subtree-p t
))
157 (set-mark (point)) ;; to activate the region
159 (setq rtn
(org-lparse backend backend nil nil ext-plist buffer body-only
))
160 (if (fboundp 'deactivate-mark
) (deactivate-mark))
161 (if (and (org-called-interactively-p 'any
) (bufferp rtn
))
162 (switch-to-buffer-other-window rtn
)
165 (defvar org-lparse-par-open nil
)
167 (defun org-lparse-should-inline-p (filename descp
)
168 "Return non-nil if link FILENAME should be inlined.
169 The decision to inline the FILENAME link is based on the current
170 settings. DESCP is the boolean of whether there was a link
171 description. See variables `org-export-html-inline-images' and
172 `org-export-html-inline-image-extensions'."
173 (let ((inline-images (org-lparse-get 'INLINE-IMAGES
))
174 (inline-image-extensions
175 (org-lparse-get 'INLINE-IMAGE-EXTENSIONS
)))
176 (and (or (eq t inline-images
) (and inline-images
(not descp
)))
177 (org-file-image-p filename inline-image-extensions
))))
179 (defun org-lparse-format-org-link (line opt-plist
)
180 "Return LINE with markup of Org mode links.
181 OPT-PLIST is the export options list."
183 (current-dir (if buffer-file-name
184 (file-name-directory buffer-file-name
)
186 (link-validate (plist-get opt-plist
:link-validation-function
))
188 rpl path attr desc descp desc1 desc2 link
189 org-lparse-link-description-is-image
)
190 (while (string-match org-bracket-link-analytic-regexp
++ line start
)
191 (setq org-lparse-link-description-is-image nil
)
192 (setq start
(match-beginning 0))
193 (setq path
(save-match-data (org-link-unescape
194 (match-string 3 line
))))
196 ((match-end 2) (match-string 2 line
))
198 (or (file-name-absolute-p path
)
199 (string-match "^\\.\\.?/" path
)))
202 (setq path
(org-extract-attributes (org-link-unescape path
)))
203 (setq attr
(get-text-property 0 'org-attributes path
))
204 (setq desc1
(if (match-end 5) (match-string 5 line
))
205 desc2
(if (match-end 2) (concat type
":" path
) path
)
206 descp
(and desc1
(not (equal desc1 desc2
)))
207 desc
(or desc1 desc2
))
208 ;; Make an image out of the description if that is so wanted
209 (when (and descp
(org-file-image-p
210 desc
(org-lparse-get 'INLINE-IMAGE-EXTENSIONS
)))
211 (setq org-lparse-link-description-is-image t
)
213 (if (string-match "^file:" desc
)
214 (setq desc
(substring desc
(match-end 0)))))
216 (setq desc
(org-add-props
217 (org-lparse-format 'INLINE-IMAGE desc
)
218 '(org-protected t
)))))
220 ((equal type
"internal")
223 (if (= (string-to-char path
) ?
#)
228 'ORG-LINK opt-plist
"" "" (org-solidify-link-text
230 (org-link-unescape frag-0
))
231 nil
) desc attr descp
))))
232 ((and (equal type
"id")
233 (setq id-file
(org-id-find-id-file path
)))
234 ;; This is an id: link to another file (if it was the same file,
235 ;; it would have become an internal link...)
237 (setq id-file
(file-relative-name
239 (file-name-directory org-current-export-file
)))
242 'ORG-LINK opt-plist type id-file
243 (concat (if (org-uuidgen-p path
) "ID-") path
)
245 ((member type
'("http" "https"))
246 ;; standard URL, can inline as image
249 'ORG-LINK opt-plist type path nil desc attr descp
)))
250 ((member type
'("ftp" "mailto" "news"))
251 ;; standard URL, can't inline as image
254 'ORG-LINK opt-plist type path nil desc attr descp
)))
256 ((string= type
"coderef")
259 'ORG-LINK opt-plist type
"" (format "coderef-%s" path
)
261 (org-export-get-coderef-format
264 (cdr (assoc path org-export-code-refs
))) nil descp
)))
266 ((functionp (setq fnc
(nth 2 (assoc type org-link-protocols
))))
267 ;; The link protocol has a function for format the link
270 (funcall fnc
(org-link-unescape path
) desc1
'html
))))
272 ((string= type
"file")
278 (string-match "::\\(.*\\)" path
)
280 (replace-match "" t nil path
)
281 (match-string 1 path
))
284 ;;The proper path, without a fragment
292 ;;Check the fragment. If it can't be used as
293 ;;target fragment we'll pass nil instead.
297 (not (string-match "^[0-9]*$" fragment-0
))
298 (not (string-match "^\\*" fragment-0
))
299 (not (string-match "^/.*/$" fragment-0
)))
300 (org-solidify-link-text
301 (org-link-unescape fragment-0
))
304 ;;Description minus "file:" and ".org"
305 (if (string-match "^file:" desc
)
307 ((desc-1 (replace-match "" t t desc
)))
308 (if (string-match "\\.org$" desc-1
)
309 (replace-match "" t t desc-1
)
316 (functionp link-validate
)
317 (not (funcall link-validate path-1 current-dir
)))
320 'ORG-LINK opt-plist
"file" path-1 fragment-1
321 desc-2 attr descp
))))))
324 ;; just publish the path, as default
325 (setq rpl
(concat "<i><" type
":"
326 (save-match-data (org-link-unescape path
))
328 (setq line
(replace-match rpl t t line
)
329 start
(+ start
(length rpl
))))
332 (defmacro with-org-lparse-preserve-paragraph-state
(&rest body
)
333 `(let ((org-lparse-do-open-par org-lparse-par-open
))
334 (org-lparse-end-paragraph)
336 (when org-lparse-do-open-par
337 (org-lparse-begin-paragraph))))
339 (defvar org-lparse-native-backends nil
340 "List of native backends registered with `org-lparse'.
341 A backend can use `org-lparse-register-backend' to add itself to
344 All native backends must implement a get routine and a mandatory
345 set of callback routines.
347 The get routine must be named as org-<backend>-get where backend
348 is the name of the backend. The exporter uses `org-lparse-get'
349 and retrieves the backend-specific callback by querying for
350 ENTITY-CONTROL and ENTITY-FORMAT variables.
352 For the sake of illustration, the html backend implements
353 `org-xhtml-get'. It returns
354 `org-xhtml-entity-control-callbacks-alist' and
355 `org-xhtml-entity-format-callbacks-alist' as the values of
356 ENTITY-CONTROL and ENTITY-FORMAT settings.")
358 (defun org-lparse-register-backend (backend)
359 "Make BACKEND known to `org-lparse' library.
360 Add BACKEND to `org-lparse-native-backends'."
363 ((symbolp backend
) (symbol-name backend
))
364 ((stringp backend
) backend
)
365 (t (error "Error while registering backend: %S" backend
))))
366 (add-to-list 'org-lparse-native-backends backend
)))
368 (defun org-lparse-unregister-backend (backend)
369 (setq org-lparse-native-backends
371 ((symbolp backend
) (symbol-name backend
))
372 ((stringp backend
) backend
))
373 org-lparse-native-backends
))
374 (message "Unregistered backend %S" backend
))
376 (defun org-lparse-get-other-backends (in-fmt)
377 "Return OUTPUT-FMT-ALIST corresponding to IN-FMT.
378 See `org-lparse-convert-capabilities' for definition of
380 (when (org-lparse-get-converter in-fmt
)
381 (or (ignore-errors (org-lparse-backend-get in-fmt
'OTHER-BACKENDS
) )
383 (dolist (c org-lparse-convert-capabilities
)
384 (when (member in-fmt
(nth 1 c
))
385 (throw 'out-fmts
(nth 2 c
))))))))
387 (defun org-lparse-get-converter (in-fmt)
388 "Return converter associated with IN-FMT.
389 See `org-lparse-convert-capabilities' for further information."
390 (or (ignore-errors (org-lparse-backend-get in-fmt
'CONVERT-METHOD
))
391 org-lparse-convert-process
))
393 (defun org-lparse-all-backends ()
394 "Return all formats to which `org-lparse' could export to.
395 The return value is an alist of the form (TARGET-BACKEND
396 NATIVE-BACKEND-1 NATIVE-BACKEND-2 ...) with the condition that
397 the org file can be exported to TARGET-BACKEND via any one of
398 NATIVE-BACKEND-1, NATIVE-BACKEND-2 etc.
400 For example, an entry of the form \"(\"pdf\" \"odt\" \"xhtml\")\"
401 would mean that the org file could be exported to \"pdf\" format
402 by exporting natively either to \"xhtml\" or \"odt\" backends."
404 (flet ((add (other native
)
405 (let ((val (assoc-string other all-backends t
)))
406 (if val
(setcdr val
(nconc (list native
) (cdr val
)))
407 (push (cons other
(list native
)) all-backends
)))))
408 (loop for backend in org-lparse-native-backends
409 do
(loop for other in
410 (mapcar #'car
(org-lparse-get-other-backends backend
))
411 do
(add other backend
))))
414 (defun org-lparse-backend-is-native-p (backend)
415 (member backend org-lparse-native-backends
))
417 (defun org-lparse (target-backend native-backend arg
418 &optional hidden ext-plist
419 to-buffer body-only pub-dir
)
420 "Export the outline to various formats.
421 If there is an active region, export only the region. The
422 outline is first exported to NATIVE-BACKEND and optionally
423 converted to TARGET-BACKEND. See `org-lparse-native-backends'
424 for list of known native backends. Each native backend can
425 specify a converter and list of target backends it exports to
426 using the CONVERT-PROCESS and OTHER-BACKENDS settings of it's get
427 method. See `org-xhtml-get' for an illustrative example.
429 ARG is a prefix argument that specifies how many levels of
430 outline should become headlines. The default is 3. Lower levels
431 will become bulleted lists.
433 HIDDEN is obsolete and does nothing.
435 EXT-PLIST is a property list that controls various aspects of
436 export. The settings here override org-mode's default settings
437 and but are inferior to file-local settings.
439 TO-BUFFER dumps the exported lines to a buffer or a string
440 instead of a file. If TO-BUFFER is the symbol `string' return the
441 exported lines as a string. If TO-BUFFER is non-nil, create a
442 buffer with that name and export to that buffer.
444 BODY-ONLY controls the presence of header and footer lines in
445 exported text. If BODY-ONLY is non-nil, don't produce the file
446 header and footer, simply return the content of <body>...</body>,
447 without even the body tags themselves.
449 PUB-DIR specifies the publishing directory."
451 (let* ((input (if (featurep 'ido
) 'ido-completing-read
'completing-read
))
452 (all-backends (org-lparse-all-backends))
455 (funcall input
"Export to: " all-backends nil t nil
)))
457 (let ((choices (if target-backend
458 (cdr (assoc target-backend all-backends
))
459 (or org-lparse-native-backends
460 (error "No registered backends")))))
461 (funcall input
"Use Native backend: " choices nil t nil
))))
462 (list target-backend native-backend current-prefix-arg
)))
463 (let* ((org-lparse-backend (intern native-backend
))
464 (org-lparse-other-backend (and target-backend
465 (intern target-backend
))))
466 (unless (org-lparse-backend-is-native-p native-backend
)
467 (error "Don't know how to export natively to backend %s" native-backend
))
468 (unless (or (not target-backend
)
469 (equal target-backend native-backend
)
470 (assoc target-backend
(org-lparse-get-other-backends
472 (error "Don't know how to export to backend %s %s" target-backend
473 (format "via %s" native-backend
)))
474 (run-hooks 'org-export-first-hook
)
475 (org-do-lparse arg hidden ext-plist to-buffer body-only pub-dir
)))
477 (defcustom org-lparse-convert-processes
478 '(("BasicODConverter"
479 ("soffice" "-norestore" "-invisible" "-headless"
480 "\"macro:///BasicODConverter.Main.Convert(%I,%f,%O)\""))
482 ("unoconv" "-f" "%f" "-o" "%d" "%i")))
483 "Specify a list of document converters and their usage.
484 The converters in this list are offered as choices while
485 customizing `org-lparse-convert-process'.
487 This variable is an alist where each element is of the
488 form (CONVERTER-NAME (CONVERTER-PROGRAM ARG1 ARG2 ...)).
489 CONVERTER-NAME is name of the converter. CONVERTER-PROGRAM is
490 the name of the executable. ARG1, ARG2 etc are command line
491 options that are passed to CONVERTER-PROGRAM. Format specifiers
492 can be used in the ARGs and they are interpreted as below:
494 %i input file name in full
495 %I input file name as a URL
496 %f format of the output file
497 %o output file name in full
498 %O output file name as a URL
499 %d output dir in full
500 %D output dir as a URL."
504 (const :tag
"None" nil
)
505 (alist :tag
"Converters"
506 :key-type
(string :tag
"Converter Name")
507 :value-type
(group (cons (string :tag
"Executable")
508 (repeat (string :tag
"Command line args")))))))
509 (defcustom org-lparse-convert-process nil
510 "Command to convert from an Org exported format to other formats.
511 During customization, the list of choices are populated from
512 `org-lparse-convert-processes'. Refer afore-mentioned variable
513 for further information."
515 :type
'(choice :convert-widget
517 (apply 'widget-convert
(widget-type w
)
518 (eval (car (widget-get w
:args
)))))
519 `((const :tag
"None" nil
)
520 ,@(mapcar (lambda (c)
521 `(const :tag
,(car c
) ,(cadr c
)))
522 org-lparse-convert-processes
))))
524 (defcustom org-lparse-convert-capabilities
526 ("odt" "ott" "doc" "rtf")
527 (("pdf" "pdf") ("odt" "odt") ("xhtml" "html") ("rtf" "rtf")
528 ("ott" "ott") ("doc" "doc") ("ooxml" "xml") ("html" "html")))
530 ("html" "xhtml") (("pdf" "pdf") ("odt" "txt") ("html" "html")))
532 ("ods" "ots" "xls" "csv")
533 (("pdf" "pdf") ("ots" "ots") ("html" "html") ("csv" "csv")
534 ("ods" "ods") ("xls" "xls") ("xhtml" "xhtml") ("ooxml" "xml")))
537 (("pdf" "pdf") ("swf" "swf") ("odp" "odp") ("xhtml" "xml")
538 ("otp" "otp") ("ppt" "ppt") ("odg" "odg") ("html" "html"))))
539 "Specify input and output formats of `org-lparse-convert-process'.
540 More correctly, specify the set of input and output formats that
541 the user is actually interested in.
543 This variable is an alist where each element is of the
544 form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST).
545 INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an
546 alist where each element is of the form (OUTPUT-FMT
547 OUTPUT-FILE-EXTENSION).
549 The variable is interpreted as follows:
550 `org-lparse-convert-process' can take any document that is in
551 INPUT-FMT-LIST and produce any document that is in the
552 OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have
553 OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT
554 serves dual purposes:
555 - It is used for populating completion candidates during
556 `org-lparse' and `org-lparse-convert' commands.
558 - It is used as the value of \"%f\" specifier in
559 `org-lparse-convert-process'.
561 DOCUMENT-CLASS is used to group a set of file formats in
562 INPUT-FMT-LIST in to a single class.
564 Note that this variable inherently captures how LibreOffice based
565 converters work. LibreOffice maps documents of various formats
566 to classes like Text, Web, Spreadsheet, Presentation etc and
567 allow document of a given class (irrespective of it's source
568 format) to be converted to any of the export formats associated
571 See default setting of this variable for an typical
576 (const :tag
"None" nil
)
577 (alist :key-type
(string :tag
"Document Class")
579 (group (repeat :tag
"Input formats" (string :tag
"Input format"))
580 (alist :tag
"Output formats"
581 :key-type
(string :tag
"Output format")
583 (group (string :tag
"Output file extension")))))))
585 (defcustom org-lparse-use-flashy-warning nil
586 "Control flashing of messages logged with `org-lparse-warn'.
587 When non-nil, messages are fontified with warning face and the
588 exporter lingers for a while to catch user's attention."
592 (defun org-lparse-convert (&optional in-file out-fmt prefix-arg
)
593 "Convert IN-FILE to format OUT-FMT using a command line converter.
594 IN-FILE is the file to be converted. If unspecified, it defaults
595 to variable `buffer-file-name'. OUT-FMT is the desired output
596 format. If the backend has registered a CONVERT-METHOD as part
597 of it's get function then that converter is used. Otherwise
598 `org-lparse-convert-process' is used. If PREFIX-ARG is non-nil
599 then the newly converted file is opened using `org-open-file'."
601 (let* ((input (if (featurep 'ido
) 'ido-completing-read
'completing-read
))
602 (in-file (read-file-name "File to be converted: "
603 nil buffer-file-name t
))
604 (in-fmt (file-name-extension in-file
))
605 (out-fmt-choices (org-lparse-get-other-backends in-fmt
))
607 (or (and out-fmt-choices
608 (funcall input
"Output format: "
609 out-fmt-choices nil nil nil
))
611 "No known converter or no known output formats for %s files"
613 (list in-file out-fmt current-prefix-arg
)))
614 (require 'browse-url
)
615 (let* ((in-file (expand-file-name (or in-file buffer-file-name
)))
616 (dummy (or (file-readable-p in-file
)
617 (error "Cannot read %s" in-file
)))
618 (in-fmt (file-name-extension in-file
))
619 (out-fmt (or out-fmt
(error "Output format unspecified")))
620 (convert-process (org-lparse-get-converter in-fmt
))
621 (program (car convert-process
))
622 (dummy (and (or program
(error "Converter not configured"))
623 (or (executable-find program
)
624 (error "Cannot find converter %s" program
))))
626 (or (assoc out-fmt
(org-lparse-get-other-backends in-fmt
))
627 (error "Cannot convert from %s to %s format" in-fmt out-fmt
)))
628 (out-file (concat (file-name-sans-extension in-file
) "."
629 (nth 1 out-fmt-alist
)))
630 (out-dir (file-name-directory in-file
))
631 (arglist (mapcar (lambda (arg)
633 arg
`((?i .
,in-file
)
634 (?I .
,(browse-url-file-url in-file
))
637 (?O .
,(browse-url-file-url out-file
))
639 (?D .
,(browse-url-file-url out-dir
)))))
640 (cdr convert-process
))))
641 (when (file-exists-p out-file
)
642 (delete-file out-file
))
644 (message "Executing %s %s" program
(mapconcat 'identity arglist
" "))
645 (apply 'call-process program nil nil nil arglist
)
647 ((file-exists-p out-file
)
648 (message "Exported to %s using %s" out-file program
)
650 (message "Opening %s..." out-file
)
651 (org-open-file out-file
))
653 ;; (set-buffer (find-file-noselect out-file))
656 (message "Export to %s failed" out-file
)
659 (defvar org-lparse-insert-tag-with-newlines
'both
)
661 ;; Following variables are let-bound during `org-lparse'
662 (defvar org-lparse-dyn-first-heading-pos
)
663 (defvar org-lparse-toc
)
664 (defvar org-lparse-entity-control-callbacks-alist
)
665 (defvar org-lparse-entity-format-callbacks-alist
)
666 (defvar org-lparse-backend nil
667 "The native backend to which the document is currently exported.
668 This variable is let bound during `org-lparse'. Valid values are
669 one of the symbols corresponding to `org-lparse-native-backends'.
671 Compare this variable with `org-export-current-backend' which is
672 bound only during `org-export-preprocess-string' stage of the
675 See also `org-lparse-other-backend'.")
677 (defvar org-lparse-other-backend nil
678 "The target backend to which the document is currently exported.
679 This variable is let bound during `org-lparse'. This variable is
680 set to either `org-lparse-backend' or one of the symbols
681 corresponding to OTHER-BACKENDS specification of the
684 For example, if a document is exported to \"odt\" then both
685 org-lparse-backend and org-lparse-other-backend are bound to
686 'odt. On the other hand, if a document is exported to \"odt\"
687 and then converted to \"doc\" then org-lparse-backend is set to
688 'odt and org-lparse-other-backend is set to 'doc.")
690 (defvar org-lparse-body-only nil
691 "Bind this to BODY-ONLY arg of `org-lparse'.")
693 (defvar org-lparse-to-buffer nil
694 "Bind this to TO-BUFFER arg of `org-lparse'.")
696 (defun org-do-lparse (arg &optional hidden ext-plist
697 to-buffer body-only pub-dir
)
698 "Export the outline to various formats.
699 See `org-lparse' for more information. This function is a
700 html-agnostic version of the `org-export-as-html' function in 7.5
702 ;; Make sure we have a file name when we need it.
703 (when (and (not (or to-buffer body-only
))
704 (not buffer-file-name
))
705 (if (buffer-base-buffer)
706 (org-set-local 'buffer-file-name
707 (with-current-buffer (buffer-base-buffer)
709 (error "Need a file name to be able to export")))
712 (format "Exporting to %s using org-lparse..."
714 (or org-lparse-backend org-lparse-other-backend
)))))
716 (setq-default org-todo-line-regexp org-todo-line-regexp
)
717 (setq-default org-deadline-line-regexp org-deadline-line-regexp
)
718 (setq-default org-done-keywords org-done-keywords
)
719 (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp
)
720 (let* (hfy-user-sheet-assoc ; let `htmlfontify' know that
721 ; we are interested in
723 org-lparse-encode-pending
725 (org-lparse-list-level 0) ; list level starts at 1. A
726 ; value of 0 implies we are
727 ; outside of any list
728 org-lparse-outline-text-open
729 (org-lparse-latex-fragment-fallback ; currently used only by
731 (or (ignore-errors (org-lparse-get 'LATEX-FRAGMENT-FALLBACK
))
732 (if (and (org-check-external-command "latex" "" t
)
733 (org-check-external-command "dvipng" "" t
))
736 (org-lparse-insert-tag-with-newlines 'both
)
737 (org-lparse-to-buffer to-buffer
)
738 (org-lparse-body-only body-only
)
739 (org-lparse-entity-control-callbacks-alist
740 (org-lparse-get 'ENTITY-CONTROL
))
741 (org-lparse-entity-format-callbacks-alist
742 (org-lparse-get 'ENTITY-FORMAT
))
744 (org-export-process-option-filters
745 (org-combine-plists (org-default-export-plist)
747 (org-infile-export-plist))))
748 (body-only (or body-only
(plist-get opt-plist
:body-only
)))
749 valid org-lparse-dyn-first-heading-pos
750 (odd org-odd-levels-only
)
751 (region-p (org-region-active-p))
752 (rbeg (and region-p
(region-beginning)))
753 (rend (and region-p
(region-end)))
755 (if (plist-get opt-plist
:ignore-subtree-p
)
760 (and (org-at-heading-p)
761 (>= (org-end-of-subtree t t
) rend
))))))
762 (level-offset (if subtree-p
765 (+ (funcall outline-level
)
766 (if org-odd-levels-only
1 0)))
768 (opt-plist (setq org-export-opt-plist
770 (org-export-add-subtree-options opt-plist rbeg
)
772 ;; The following two are dynamically scoped into other
774 (org-current-export-dir
775 (or pub-dir
(org-lparse-get 'EXPORT-DIR opt-plist
)))
776 (org-current-export-file buffer-file-name
)
777 (level 0) (line "") (origline "") txt todo
780 (filename (if to-buffer nil
783 (file-name-sans-extension
785 (org-entry-get (region-beginning)
786 "EXPORT_FILE_NAME" t
))
787 (file-name-nondirectory buffer-file-name
)))
788 "." (org-lparse-get 'FILE-NAME-EXTENSION opt-plist
))
789 (file-name-as-directory
790 (or pub-dir
(org-lparse-get 'EXPORT-DIR opt-plist
))))))
791 (current-dir (if buffer-file-name
792 (file-name-directory buffer-file-name
)
794 (buffer (if to-buffer
796 ((eq to-buffer
'string
)
797 (get-buffer-create (org-lparse-get 'EXPORT-BUFFER-NAME
)))
798 (t (get-buffer-create to-buffer
)))
800 (or (let ((f (org-lparse-get 'INIT-METHOD
)))
801 (and f
(functionp f
) (funcall f filename
)))
803 (org-levels-open (make-vector org-level-max nil
))
804 (date (plist-get opt-plist
:date
))
806 ((and date
(string-match "%" date
))
807 (format-time-string date
))
809 (t (format-time-string "%Y-%m-%d %T %Z"))))
810 (dummy (setq opt-plist
(plist-put opt-plist
:effective-date date
)))
811 (title (org-xml-encode-org-text-skip-links
812 (or (and subtree-p
(org-export-get-title-from-subtree))
813 (plist-get opt-plist
:title
)
816 (plist-get opt-plist
:skip-before-1st-heading
))
817 (org-export-grab-title-from-buffer))
818 (and buffer-file-name
819 (file-name-sans-extension
820 (file-name-nondirectory buffer-file-name
)))
822 (dummy (setq opt-plist
(plist-put opt-plist
:title title
)))
823 (html-table-tag (plist-get opt-plist
:html-table-tag
))
824 (quote-re0 (concat "^[ \t]*" org-quote-string
"\\>"))
825 (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string
"\\>\\)"))
826 (org-lparse-dyn-current-environment nil
)
827 ;; Get the language-dependent settings
828 (lang-words (or (assoc (plist-get opt-plist
:language
)
829 org-export-language-setup
)
830 (assoc "en" org-export-language-setup
)))
831 (dummy (setq opt-plist
(plist-put opt-plist
:lang-words lang-words
)))
834 (coding-system-for-write
835 (or (ignore-errors (org-lparse-get 'CODING-SYSTEM-FOR-WRITE
))
836 (and (boundp 'buffer-file-coding-system
)
837 buffer-file-coding-system
)))
838 (save-buffer-coding-system
839 (or (ignore-errors (org-lparse-get 'CODING-SYSTEM-FOR-SAVE
))
840 (and (boundp 'buffer-file-coding-system
)
841 buffer-file-coding-system
)))
844 (if region-p
(region-beginning) (point-min))
845 (if region-p
(region-end) (point-max))))
846 (org-export-have-math nil
)
847 (org-export-footnotes-seen nil
)
848 (org-export-footnotes-data (org-footnote-all-labels 'with-defs
))
849 (org-footnote-insert-pos-for-preprocessor 'point-min
)
852 (org-export-preprocess-string
855 :for-backend
(if (equal org-lparse-backend
'xhtml
) ; hack
858 :skip-before-1st-heading
859 (plist-get opt-plist
:skip-before-1st-heading
)
860 :drawers
(plist-get opt-plist
:drawers
)
861 :todo-keywords
(plist-get opt-plist
:todo-keywords
)
862 :tasks
(plist-get opt-plist
:tasks
)
863 :tags
(plist-get opt-plist
:tags
)
864 :priority
(plist-get opt-plist
:priority
)
865 :footnotes
(plist-get opt-plist
:footnotes
)
866 :timestamps
(plist-get opt-plist
:timestamps
)
868 (plist-get opt-plist
:archived-trees
)
869 :select-tags
(plist-get opt-plist
:select-tags
)
870 :exclude-tags
(plist-get opt-plist
:exclude-tags
)
872 (plist-get opt-plist
:text
)
874 (plist-get opt-plist
:LaTeX-fragments
))
877 table-buffer table-orig-buffer
879 rpl path attr desc descp desc1 desc2 link
881 footnotes footref-seen
882 org-lparse-output-buffer
883 org-lparse-footnote-definitions
884 org-lparse-footnote-number
885 org-lparse-footnote-buffer
890 (let ((inhibit-read-only t
))
892 (remove-text-properties (point-min) (point-max)
893 '(:org-license-to-kill t
))))
895 (message "Exporting...")
896 (org-init-section-numbers)
898 ;; Switch to the output buffer
899 (setq org-lparse-output-buffer buffer
)
900 (set-buffer org-lparse-output-buffer
)
901 (let ((inhibit-read-only t
)) (erase-buffer))
903 (org-install-letbind)
905 (and (fboundp 'set-buffer-file-coding-system
)
906 (set-buffer-file-coding-system coding-system-for-write
))
908 (let ((case-fold-search nil
)
909 (org-odd-levels-only odd
))
910 ;; create local variables for all options, to make sure all called
911 ;; functions get the correct information
913 (set (make-local-variable (nth 2 x
))
914 (plist-get opt-plist
(car x
))))
915 org-export-plist-vars
)
916 (setq umax
(if arg
(prefix-numeric-value arg
)
917 org-export-headline-levels
))
918 (setq umax-toc
(if (integerp org-export-with-toc
)
919 (min org-export-with-toc umax
)
922 (when (and org-export-with-toc
(not body-only
))
923 (setq lines
(org-lparse-prepare-toc
924 lines level-offset opt-plist umax-toc
)))
927 (org-lparse-begin 'DOCUMENT-CONTENT opt-plist
)
928 (org-lparse-begin 'DOCUMENT-BODY opt-plist
))
931 (org-init-section-numbers)
933 (org-lparse-begin-paragraph)
935 (while (setq line
(pop lines
) origline line
)
937 (when (and (org-lparse-current-environment-p 'quote
)
938 (string-match org-outline-regexp-bol line
))
939 (org-lparse-end-environment 'quote
))
941 (when (org-lparse-current-environment-p 'quote
)
942 (org-lparse-insert 'LINE line
)
943 (throw 'nextline nil
))
945 ;; Fixed-width, verbatim lines (examples)
946 (when (and org-export-with-fixed-width
947 (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line
))
948 (when (not (org-lparse-current-environment-p 'fixedwidth
))
949 (org-lparse-begin-environment 'fixedwidth
))
950 (org-lparse-insert 'LINE
(match-string 3 line
))
951 (when (or (not lines
)
952 (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
954 (org-lparse-end-environment 'fixedwidth
))
955 (throw 'nextline nil
))
957 ;; Notes: The baseline version of org-html.el (git commit
958 ;; 3d802e), while encoutering a *line-long* protected text,
959 ;; does one of the following two things based on the state
960 ;; of the export buffer.
962 ;; 1. If a paragraph element has just been opened and
963 ;; contains only whitespace as content, insert the
964 ;; protected text as part of the previous paragraph.
966 ;; 2. If the paragraph element has already been opened and
967 ;; contains some valid content insert the protected text
968 ;; as part of the current paragraph.
972 ;; Scenario 1 mentioned above kicks in when a block of
973 ;; protected text has to be inserted enbloc. For example,
974 ;; this happens, when inserting an source or example block
975 ;; or preformatted content enclosed in #+backend,
976 ;; #+begin_bakend ... #+end_backend)
978 ;; Scenario 2 mentioned above kicks in when the protected
979 ;; text is part of a running sentence. For example this
980 ;; happens in the case of an *multiline* LaTeX equation that
981 ;; needs to be inserted verbatim.
983 ;; org-html.el in the master branch seems to do some
984 ;; jugglery by moving paragraphs around. Inorder to make
985 ;; these changes backend-agnostic introduce a new text
986 ;; property org-native-text and impose the added semantics
987 ;; that these protected blocks appear outside of a
988 ;; conventional paragraph element.
990 ;; Extra Note: Check whether org-example and org-native-text
991 ;; are entirely equivalent.
993 ;; Fixes bug reported by Christian Moe concerning verbatim
995 ;; on git commit 533ba3f90250a1f25f494c390d639ea6274f235c
996 ;; http://repo.or.cz/w/org-mode/org-jambu.git/shortlog/refs/heads/staging
997 ;; See http://lists.gnu.org/archive/html/emacs-orgmode/2011-03/msg01379.html
1000 (when (and (get-text-property 0 'org-native-text line
)
1001 ;; Make sure it is the entire line that is protected
1002 (not (< (or (next-single-property-change
1003 0 'org-native-text line
) 10000)
1005 (let ((ind (get-text-property 0 'original-indentation line
)))
1006 (org-lparse-begin-environment 'native
)
1007 (org-lparse-insert 'LINE line
)
1009 (or (= (length (car lines
)) 0)
1011 (equal ind
(get-text-property
1012 0 'original-indentation
(car lines
))))
1013 (or (= (length (car lines
)) 0)
1014 (get-text-property 0 'org-native-text
(car lines
))))
1015 (org-lparse-insert 'LINE
(pop lines
)))
1016 (org-lparse-end-environment 'native
))
1017 (throw 'nextline nil
))
1020 (when (and (get-text-property 0 'org-protected line
)
1021 ;; Make sure it is the entire line that is protected
1022 (not (< (or (next-single-property-change
1023 0 'org-protected line
) 10000)
1025 (let ((ind (get-text-property 0 'original-indentation line
)))
1026 (org-lparse-insert 'LINE line
)
1028 (or (= (length (car lines
)) 0)
1030 (equal ind
(get-text-property
1031 0 'original-indentation
(car lines
))))
1032 (or (= (length (car lines
)) 0)
1033 (get-text-property 0 'org-protected
(car lines
))))
1034 (org-lparse-insert 'LINE
(pop lines
))))
1035 (throw 'nextline nil
))
1037 ;; Blockquotes, verse, and center
1038 (when (string-match "^ORG-\\(.+\\)-\\(START\\|END\\)$" line
)
1039 (let* ((style (intern (downcase (match-string 1 line
))))
1040 (f (cdr (assoc (match-string 2 line
)
1041 '(("START" . org-lparse-begin-environment
)
1042 ("END" . org-lparse-end-environment
))))))
1043 (when (memq style
'(blockquote verse center
))
1045 (throw 'nextline nil
))))
1047 (run-hooks 'org-export-html-after-blockquotes-hook
)
1048 (when (org-lparse-current-environment-p 'verse
)
1049 (let ((i (org-get-string-indentation line
)))
1052 (let ((org-lparse-encode-pending t
))
1053 (org-lparse-format 'SPACES
(* 2 i
)))
1054 " " (org-trim line
))))
1055 (unless (string-match "\\\\\\\\[ \t]*$" line
)
1056 (setq line
(concat line
"\\\\")))))
1058 ;; make targets to anchors
1060 (while (string-match
1061 "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start
)
1063 ((get-text-property (match-beginning 1) 'org-protected line
)
1064 (setq start
(match-end 1)))
1066 (setq line
(replace-match
1067 (let ((org-lparse-encode-pending t
))
1069 'ANCHOR
"" (org-solidify-link-text
1070 (match-string 1 line
))))
1072 ((and org-export-with-toc
(equal (string-to-char line
) ?
*))
1073 ;; FIXME: NOT DEPENDENT on TOC?????????????????????
1074 (setq line
(replace-match
1075 (let ((org-lparse-encode-pending t
))
1077 'FONTIFY
(match-string 1 line
) "target"))
1078 ;; (concat "@<i>" (match-string 1 line) "@</i> ")
1081 (setq line
(replace-match
1083 (let ((org-lparse-encode-pending t
))
1085 'ANCHOR
(match-string 1 line
)
1086 (org-solidify-link-text (match-string 1 line
))
1090 (let ((org-lparse-encode-pending t
))
1091 (setq line
(org-lparse-handle-time-stamps line
)))
1093 ;; replace "&" by "&", "<" and ">" by "<" and ">"
1094 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
1095 ;; Also handle sub_superscripts and checkboxes
1096 (or (string-match org-table-hline-regexp line
)
1097 (string-match "^[ \t]*\\([+]-\\||[ ]\\)[-+ |]*[+|][ \t]*$" line
)
1098 (setq line
(org-xml-encode-org-text-skip-links line
)))
1100 (setq line
(org-lparse-format-org-link line opt-plist
))
1103 (if (and (string-match org-todo-line-regexp line
)
1104 (match-beginning 2))
1106 (substring line
0 (match-beginning 2))
1107 (org-lparse-format 'TODO
(match-string 2 line
))
1108 (substring line
(match-end 2)))))
1110 ;; Does this contain a reference to a footnote?
1111 (when org-export-with-footnotes
1113 (while (string-match "\\([^* \t].*?\\)[ \t]*\\[\\([0-9]+\\)\\]" line start
)
1114 ;; Discard protected matches not clearly identified as
1115 ;; footnote markers.
1116 (if (or (get-text-property (match-beginning 2) 'org-protected line
)
1117 (not (get-text-property (match-beginning 2) 'org-footnote line
)))
1118 (setq start
(match-end 2))
1119 (let ((n (match-string 2 line
)) refcnt a
)
1120 (if (setq a
(assoc n footref-seen
))
1122 (setcdr a
(1+ (cdr a
)))
1123 (setq refcnt
(cdr a
)))
1125 (push (cons n
1) footref-seen
))
1129 (or (match-string 1 line
) "")
1132 n
(cdr (assoc n org-lparse-footnote-definitions
))
1134 ;; If another footnote is following the
1135 ;; current one, add a separator.
1136 (if (save-match-data
1137 (string-match "\\`\\[[0-9]+\\]"
1138 (substring line
(match-end 0))))
1140 (org-lparse-get 'FOOTNOTE-SEPARATOR
))
1145 ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line
)
1146 ;; This is a headline
1147 (setq level
(org-tr-level (- (match-end 1) (match-beginning 1)
1149 txt
(match-string 2 line
))
1150 (if (string-match quote-re0 txt
)
1151 (setq txt
(replace-match "" t t txt
)))
1152 (if (<= level
(max umax umax-toc
))
1153 (setq head-count
(+ head-count
1)))
1154 (unless org-lparse-dyn-first-heading-pos
1155 (setq org-lparse-dyn-first-heading-pos
(point)))
1156 (org-lparse-begin-level level txt umax head-count
)
1159 (when (string-match quote-re line
)
1160 (org-lparse-begin-environment 'quote
)))
1162 ((and org-export-with-tables
1163 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line
))
1164 (when (not table-open
)
1166 (setq table-open t table-buffer nil table-orig-buffer nil
))
1169 (setq table-buffer
(cons line table-buffer
)
1170 table-orig-buffer
(cons origline table-orig-buffer
))
1171 (when (or (not lines
)
1172 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
1174 (setq table-open nil
1175 table-buffer
(nreverse table-buffer
)
1176 table-orig-buffer
(nreverse table-orig-buffer
))
1177 (org-lparse-end-paragraph)
1178 (org-lparse-insert 'TABLE table-buffer table-orig-buffer
)))
1183 ;; This line either is list item or end a list.
1184 (when (get-text-property 0 'list-item line
)
1185 (setq line
(org-lparse-export-list-line
1187 (get-text-property 0 'list-item line
)
1188 (get-text-property 0 'list-struct line
)
1189 (get-text-property 0 'list-prevs line
))))
1192 (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line
)
1193 (with-org-lparse-preserve-paragraph-state
1194 (org-lparse-insert 'HORIZONTAL-LINE
))
1195 (throw 'nextline nil
))
1197 ;; Empty lines start a new paragraph. If hand-formatted lists
1198 ;; are not fully interpreted, lines starting with "-", "+", "*"
1199 ;; also start a new paragraph.
1200 (when (string-match "^ [-+*]-\\|^[ \t]*$" line
)
1201 (when org-lparse-footnote-number
1202 (org-lparse-end-footnote-definition org-lparse-footnote-number
)
1203 (setq org-lparse-footnote-number nil
))
1204 (org-lparse-begin-paragraph))
1206 ;; Is this the start of a footnote?
1207 (when org-export-with-footnotes
1208 (when (and (boundp 'footnote-section-tag-regexp
)
1209 (string-match (concat "^" footnote-section-tag-regexp
)
1212 (throw 'nextline nil
))
1213 (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line
)
1214 (org-lparse-end-paragraph)
1215 (setq org-lparse-footnote-number
(match-string 1 line
))
1216 (setq line
(replace-match "" t t line
))
1217 (org-lparse-begin-footnote-definition org-lparse-footnote-number
)))
1218 ;; Check if the line break needs to be conserved
1220 ((string-match "\\\\\\\\[ \t]*$" line
)
1221 (setq line
(replace-match
1222 (org-lparse-format 'LINE-BREAK
)
1224 (org-export-preserve-breaks
1225 (setq line
(concat line
(org-lparse-format 'LINE-BREAK
)))))
1227 ;; Check if a paragraph should be started
1229 (while (and org-lparse-par-open
1230 (string-match "\\\\par\\>" line start
))
1232 ;; Leave a space in the </p> so that the footnote matcher
1233 ;; does not see this.
1234 (if (not (get-text-property (match-beginning 0)
1235 'org-protected line
))
1236 (setq line
(replace-match "</p ><p >" t t line
)))
1237 (setq start
(match-end 0))))
1239 (org-lparse-insert 'LINE line
)))))
1241 ;; Properly close all local lists and other lists
1242 (when (org-lparse-current-environment-p 'quote
)
1243 (org-lparse-end-environment 'quote
))
1245 (org-lparse-end-level 1 umax
)
1247 ;; the </div> to close the last text-... div.
1248 (when (and (> umax
0) org-lparse-dyn-first-heading-pos
)
1249 (org-lparse-end-outline-text-or-outline))
1251 (org-lparse-end 'DOCUMENT-BODY opt-plist
)
1253 (org-lparse-end 'DOCUMENT-CONTENT
))
1255 (unless (plist-get opt-plist
:buffer-will-be-killed
)
1258 (org-lparse-end 'EXPORT
)
1260 (goto-char (point-min))
1261 (or (org-export-push-to-kill-ring
1262 (upcase (symbol-name org-lparse-backend
)))
1263 (message "Exporting... done"))
1267 (let ((f (org-lparse-get 'SAVE-METHOD
)))
1268 (or (and f
(functionp f
) (funcall f filename opt-plist
))
1270 (or (when (and (boundp 'org-lparse-other-backend
)
1271 org-lparse-other-backend
1272 (not (equal org-lparse-backend org-lparse-other-backend
)))
1273 (let ((org-lparse-convert-process
1274 (org-lparse-get-converter org-lparse-backend
)))
1275 (when org-lparse-convert-process
1276 (org-lparse-convert buffer-file-name
1277 (symbol-name org-lparse-other-backend
)))))
1279 ((eq to-buffer
'string
)
1280 (prog1 (buffer-substring (point-min) (point-max))
1281 (kill-buffer (current-buffer))))
1282 (t (current-buffer))))))
1284 (defun org-lparse-format-table (lines olines
)
1285 "Retuns backend-specific code for org-type and table-type tables."
1287 (setq lines
(org-split-string lines
"\n")))
1288 (if (string-match "^[ \t]*|" (car lines
))
1289 ;; A normal org table
1290 (org-lparse-format-org-table lines nil
)
1291 ;; Table made by table.el
1292 (or (org-lparse-format-table-table-using-table-generate-source
1293 org-lparse-backend olines
1294 (not org-export-prefer-native-exporter-for-tables
))
1295 ;; We are here only when table.el table has NO col or row
1296 ;; spanning and the user prefers using org's own converter for
1297 ;; exporting of such simple table.el tables.
1298 (org-lparse-format-table-table lines
))))
1300 (defun org-lparse-table-get-colalign-info (lines)
1301 (let ((forced-aligns (org-find-text-property-in-string
1302 'org-forced-aligns
(car lines
))))
1303 (when (and forced-aligns org-table-clean-did-remove-column
)
1305 (mapcar (lambda (x) (cons (1- (car x
)) (cdr x
))) forced-aligns
)))
1309 (defvar org-lparse-table-style
)
1310 (defvar org-lparse-table-ncols
)
1311 (defvar org-lparse-table-rownum
)
1312 (defvar org-lparse-table-is-styled
)
1313 (defvar org-lparse-table-begin-marker
)
1314 (defvar org-lparse-table-num-numeric-items-per-column
)
1315 (defvar org-lparse-table-colalign-info
)
1316 (defvar org-lparse-table-colalign-vector
)
1318 ;; Following variables are defined in org-table.el
1319 (defvar org-table-number-fraction
)
1320 (defvar org-table-number-regexp
)
1322 (defun org-lparse-do-format-org-table (lines &optional splice
)
1323 "Format a org-type table into backend-specific code.
1324 LINES is a list of lines. Optional argument SPLICE means, do not
1325 insert header and surrounding <table> tags, just format the lines.
1326 Optional argument NO-CSS means use XHTML attributes instead of CSS
1327 for formatting. This is required for the DocBook exporter."
1328 (require 'org-table
)
1329 ;; Get rid of hlines at beginning and end
1330 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1331 (setq lines
(nreverse lines
))
1332 (if (string-match "^[ \t]*|-" (car lines
)) (setq lines
(cdr lines
)))
1333 (setq lines
(nreverse lines
))
1334 (when org-export-table-remove-special-lines
1335 ;; Check if the table has a marking column. If yes remove the
1336 ;; column and the special lines
1337 (setq lines
(org-table-clean-before-export lines
)))
1339 (let* ((caption (org-find-text-property-in-string 'org-caption
(car lines
)))
1340 (caption (and caption
(org-xml-encode-org-text caption
)))
1341 (label (org-find-text-property-in-string 'org-label
(car lines
)))
1342 (org-lparse-table-colalign-info (org-lparse-table-get-colalign-info lines
))
1343 (attributes (org-find-text-property-in-string 'org-attributes
1345 (head (and org-export-highlight-first-table-line
1347 (lambda (x) (string-match "^[ \t]*|-" x
))
1349 (org-lparse-table-rownum -
1) org-lparse-table-ncols i
(cnt 0)
1351 org-lparse-table-cur-rowgrp-is-hdr
1352 org-lparse-table-rowgrp-open
1353 org-lparse-table-num-numeric-items-per-column
1354 org-lparse-table-colalign-vector n
1355 org-lparse-table-rowgrp-info
1356 org-lparse-table-begin-marker
1357 (org-lparse-table-style 'org-table
)
1358 org-lparse-table-is-styled
)
1361 (setq org-lparse-table-is-styled nil
)
1362 (while (setq line
(pop lines
))
1363 (unless (string-match "^[ \t]*|-" line
)
1365 (org-lparse-format-table-row
1366 (org-split-string line
"[ \t]*|[ \t]*")) "\n"))))
1368 (setq org-lparse-table-is-styled t
)
1369 (org-lparse-begin 'TABLE caption label attributes
)
1370 (setq org-lparse-table-begin-marker
(point))
1371 (org-lparse-begin-table-rowgroup head
)
1372 (while (setq line
(pop lines
))
1374 ((string-match "^[ \t]*|-" line
)
1375 (when lines
(org-lparse-begin-table-rowgroup)))
1378 (org-lparse-format-table-row
1379 (org-split-string line
"[ \t]*|[ \t]*")) "\n"))))
1380 (org-lparse-end 'TABLE-ROWGROUP
)
1381 (org-lparse-end-table)))))
1383 (defun org-lparse-format-org-table (lines &optional splice
)
1385 (org-lparse-do-format-org-table lines splice
)
1386 (buffer-substring-no-properties (point-min) (point-max))))
1388 (defun org-lparse-do-format-table-table (lines)
1389 "Format a table generated by table.el into backend-specific code.
1390 This conversion does *not* use `table-generate-source' from table.el.
1391 This has the advantage that Org-mode's HTML conversions can be used.
1392 But it has the disadvantage, that no cell- or row-spanning is allowed."
1393 (let (line field-buffer
1394 (org-lparse-table-cur-rowgrp-is-hdr
1395 org-export-highlight-first-table-line
)
1399 (org-lparse-table-style 'table-table
)
1400 (org-lparse-table-is-styled nil
)
1401 fields org-lparse-table-ncols i
(org-lparse-table-rownum -
1)
1402 (empty (org-lparse-format 'SPACES
1)))
1403 (org-lparse-begin 'TABLE caption label attributes
)
1404 (while (setq line
(pop lines
))
1406 ((string-match "^[ \t]*\\+-" line
)
1408 (let ((org-export-table-row-tags '("<tr>" .
"</tr>"))
1409 ;; (org-export-html-table-use-header-tags-for-first-column nil)
1411 (insert (org-lparse-format-table-row field-buffer empty
)))
1412 (setq org-lparse-table-cur-rowgrp-is-hdr nil
)
1413 (setq field-buffer nil
)))
1415 ;; Break the line into fields and store the fields
1416 (setq fields
(org-split-string line
"[ \t]*|[ \t]*"))
1418 (setq field-buffer
(mapcar
1420 (concat x
(org-lparse-format 'LINE-BREAK
)
1423 (setq field-buffer fields
)))))
1424 (org-lparse-end-table)))
1426 (defun org-lparse-format-table-table (lines)
1428 (org-lparse-do-format-table-table lines
)
1429 (buffer-substring-no-properties (point-min) (point-max))))
1431 (defvar table-source-languages
) ; defined in table.el
1432 (defun org-lparse-format-table-table-using-table-generate-source (backend
1436 "Format a table into BACKEND, using `table-generate-source' from table.el.
1437 Use SPANNED-ONLY to suppress exporting of simple table.el tables.
1439 When SPANNED-ONLY is nil, all table.el tables are exported. When
1440 SPANNED-ONLY is non-nil, only tables with either row or column
1443 This routine returns the generated source or nil as appropriate.
1445 Refer docstring of `org-export-prefer-native-exporter-for-tables'
1446 for further information."
1448 (with-current-buffer (get-buffer-create " org-tmp1 ")
1450 (insert (mapconcat 'identity lines
"\n"))
1451 (goto-char (point-min))
1452 (if (not (re-search-forward "|[^+]" nil t
))
1453 (error "Error processing table"))
1454 (table-recognize-table)
1455 (when (or (not spanned-only
)
1456 (let* ((dim (table-query-dimension))
1457 (c (nth 4 dim
)) (r (nth 5 dim
)) (cells (nth 6 dim
)))
1458 (not (= (* c r
) cells
))))
1459 (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
1461 ((member backend table-source-languages
)
1462 (table-generate-source backend
" org-tmp2 ")
1463 (set-buffer " org-tmp2 ")
1464 (buffer-substring (point-min) (point-max)))
1466 ;; table.el doesn't support the given backend. Currently this
1467 ;; happens in case of odt export. Strip the table from the
1468 ;; generated document. A better alternative would be to embed
1469 ;; the table as ascii text in the output document.
1472 "Found table.el-type table in the source org file. "
1473 (format "table.el doesn't support %s backend. "
1474 (upcase (symbol-name backend
)))
1475 "Skipping ahead ..."))
1478 (defun org-lparse-handle-time-stamps (s)
1479 "Format time stamps in string S, or remove them."
1482 (while (string-match org-maybe-keyword-time-regexp s
)
1483 (or b
(setq b
(substring s
0 (match-beginning 0))))
1485 r
(substring s
0 (match-beginning 0)) " "
1492 (match-string 1 s
) "timestamp-kwd"))
1496 (substring (org-translate-time (match-string 3 s
)) 1 -
1)
1498 "timestamp-wrapper"))
1499 s
(substring s
(match-end 0))))
1500 ;; Line break if line started and ended with time stamp stuff
1503 (setq r
(concat r s
))
1504 (unless (string-match "\\S-" (concat b s
))
1505 (setq r
(concat r
(org-lparse-format 'LINE-BREAK
))))
1508 (defun org-xml-encode-plain-text (s)
1509 "Convert plain text characters to HTML equivalent.
1510 Possible conversions are set in `org-export-html-protect-char-alist'."
1511 (let ((cl (org-lparse-get 'PLAIN-TEXT-MAP
)) c
)
1512 (while (setq c
(pop cl
))
1514 (while (string-match (car c
) s start
)
1515 (setq s
(replace-match (cdr c
) t t s
)
1516 start
(1+ (match-beginning 0))))))
1519 (defun org-xml-encode-org-text-skip-links (string)
1520 "Prepare STRING for HTML export. Apply all active conversions.
1521 If there are links in the string, don't modify these."
1522 (let* ((re (concat org-bracket-link-regexp
"\\|"
1523 (org-re "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")))
1525 (while (setq m
(string-match re string
))
1526 (setq s
(substring string
0 m
)
1527 l
(match-string 0 string
)
1528 string
(substring string
(match-end 0)))
1529 (push (org-xml-encode-org-text s
) res
)
1531 (push (org-xml-encode-org-text string
) res
)
1532 (apply 'concat
(nreverse res
))))
1534 (defun org-xml-encode-org-text (s)
1535 "Apply all active conversions to translate special ASCII to HTML."
1536 (setq s
(org-xml-encode-plain-text s
))
1537 (if org-export-html-expand
1538 (while (string-match "@<\\([^&]*\\)>" s
)
1539 (setq s
(replace-match "<\\1>" t nil s
))))
1540 (if org-export-with-emphasize
1541 (setq s
(org-lparse-apply-char-styles s
)))
1542 (if org-export-with-special-strings
1543 (setq s
(org-lparse-convert-special-strings s
)))
1544 (if org-export-with-sub-superscripts
1545 (setq s
(org-lparse-apply-sub-superscript-styles s
)))
1546 (if org-export-with-TeX-macros
1547 (let ((start 0) wd rep
)
1548 (while (setq start
(string-match "\\\\\\([a-zA-Z]+[0-9]*\\)\\({}\\)?"
1550 (if (get-text-property (match-beginning 0) 'org-protected s
)
1551 (setq start
(match-end 0))
1552 (setq wd
(match-string 1 s
))
1553 (if (setq rep
(org-lparse-format 'ORG-ENTITY wd
))
1554 (setq s
(replace-match rep t t s
))
1555 (setq start
(+ start
(length wd
))))))))
1558 (defun org-lparse-convert-special-strings (string)
1559 "Convert special characters in STRING to HTML."
1560 (let ((all (org-lparse-get 'SPECIAL-STRING-REGEXPS
))
1562 (while (setq a
(pop all
))
1563 (setq re
(car a
) rpl
(cdr a
) start
0)
1564 (while (string-match re string start
)
1565 (if (get-text-property (match-beginning 0) 'org-protected string
)
1566 (setq start
(match-end 0))
1567 (setq string
(replace-match rpl t nil string
)))))
1570 (defun org-lparse-apply-sub-superscript-styles (string)
1571 "Apply subscript and superscript styles to STRING.
1572 Use `org-export-with-sub-superscripts' to control application of
1573 sub and superscript styles."
1574 (let (key c
(s 0) (requireb (eq org-export-with-sub-superscripts
'{})))
1575 (while (string-match org-match-substring-regexp string s
)
1577 ((and requireb
(match-end 8)) (setq s
(match-end 2)))
1578 ((get-text-property (match-beginning 2) 'org-protected string
)
1579 (setq s
(match-end 2)))
1581 (setq s
(match-end 1)
1582 key
(if (string= (match-string 2 string
) "_")
1583 'subscript
'superscript
)
1584 c
(or (match-string 8 string
)
1585 (match-string 6 string
)
1586 (match-string 5 string
))
1587 string
(replace-match
1588 (concat (match-string 1 string
)
1589 (org-lparse-format 'FONTIFY c key
))
1591 (while (string-match "\\\\\\([_^]\\)" string
)
1592 (setq string
(replace-match (match-string 1 string
) t t string
)))
1595 (defvar org-lparse-char-styles
1602 "Map Org emphasis markers to char styles.
1603 This is an alist where each element is of the
1604 form (ORG-EMPHASIS-CHAR . CHAR-STYLE).")
1606 (defun org-lparse-apply-char-styles (string)
1607 "Apply char styles to STRING.
1608 The variable `org-lparse-char-styles' controls how the Org
1609 emphasis markers are interpreted."
1611 (while (string-match org-emph-re string s
)
1613 (substring string
(match-beginning 3) (1+ (match-beginning 3)))
1614 (substring string
(match-beginning 4) (1+ (match-beginning 4)))))
1615 (setq s
(match-beginning 0)
1618 (match-string 1 string
)
1620 'FONTIFY
(match-string 4 string
)
1621 (nth 1 (assoc (match-string 3 string
)
1622 org-lparse-char-styles
)))
1623 (match-string 5 string
))
1624 string
(replace-match rpl t t string
)
1625 s
(+ s
(- (length rpl
) 2)))
1629 (defun org-lparse-export-list-line (line pos struct prevs
)
1630 "Insert list syntax in export buffer. Return LINE, maybe modified.
1632 POS is the item position or line position the line had before
1633 modifications to buffer. STRUCT is the list structure. PREVS is
1634 the alist of previous items."
1637 ;; Translate type of list containing POS to "d", "o" or
1639 (lambda (pos struct prevs
)
1640 (let ((type (org-list-get-list-type pos struct prevs
)))
1642 ((eq 'ordered type
) "o")
1643 ((eq 'descriptive type
) "d")
1647 ;; Return list of all items and sublists ending at POS, in
1653 (let ((end (nth 6 e
))
1656 ((= end pos
) (push item out
))
1657 ((>= item pos
) (throw 'exit nil
)))))
1660 ;; First close any previous item, or list, ending at POS.
1662 (let* ((lastp (= (org-list-get-last-item e struct prevs
) e
))
1663 (first-item (org-list-get-list-begin e struct prevs
))
1664 (type (funcall get-type first-item struct prevs
)))
1665 (org-lparse-end-paragraph)
1666 ;; Ending for every item
1667 (org-lparse-end-list-item type
)
1668 ;; We're ending last item of the list: end list.
1670 (org-lparse-end-list type
)
1671 (org-lparse-begin-paragraph))))
1672 (funcall get-closings pos
))
1674 ;; At an item: insert appropriate tags in export buffer.
1677 (concat "[ \t]*\\(\\S-+[ \t]*\\)"
1678 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
1679 "\\(?:\\(\\[[ X-]\\]\\)[ \t]+\\)?"
1680 "\\(?:\\(.*\\)[ \t]+::\\(?:[ \t]+\\|$\\)\\)?"
1682 (let* ((checkbox (match-string 3 line
))
1683 (desc-tag (or (match-string 4 line
) "???"))
1684 (body (or (match-string 5 line
) ""))
1685 (list-beg (org-list-get-list-begin pos struct prevs
))
1686 (firstp (= list-beg pos
))
1687 ;; Always refer to first item to determine list type, in
1688 ;; case list is ill-formed.
1689 (type (funcall get-type list-beg struct prevs
))
1690 (counter (let ((count-tmp (org-list-get-counter pos struct
)))
1692 ((not count-tmp
) nil
)
1693 ((string-match "[A-Za-z]" count-tmp
)
1694 (- (string-to-char (upcase count-tmp
)) 64))
1695 ((string-match "[0-9]+" count-tmp
)
1698 (org-lparse-end-paragraph)
1699 (org-lparse-begin-list type
))
1701 (let ((arg (cond ((equal type
"d") desc-tag
)
1702 ((equal type
"o") counter
))))
1703 (org-lparse-begin 'LIST-ITEM type arg
))
1705 ;; If line had a checkbox, some additional modification is required.
1713 ((string-match "X" checkbox
) "X")
1714 ((string-match " " checkbox
)
1715 (org-lparse-format 'SPACES
1))
1721 ;; Return modified line
1723 ;; At a list ender: go to next line (side-effects only).
1724 ((equal "ORG-LIST-END-MARKER" line
) (throw 'nextline nil
))
1725 ;; Not at an item: return line unchanged (side-effects only).
1728 (defun org-lparse-bind-local-variables (opt-plist)
1730 (set (make-local-variable (nth 2 x
))
1731 (plist-get opt-plist
(car x
))))
1732 org-export-plist-vars
))
1734 (defvar org-lparse-table-rowgrp-open
)
1735 (defvar org-lparse-table-cur-rowgrp-is-hdr
)
1736 (defvar org-lparse-footnote-number
)
1737 (defvar org-lparse-footnote-definitions
)
1738 (defvar org-lparse-footnote-buffer
)
1739 (defvar org-lparse-output-buffer
)
1741 (defcustom org-lparse-debug nil
1742 "Enable or Disable logging of `org-lparse' callbacks.
1743 The parameters passed to the backend-registered ENTITY-CONTROL
1744 and ENTITY-FORMAT callbacks are logged as comment strings in the
1745 exported buffer. (org-lparse-format 'COMMENT fmt args) is used
1746 for logging. Customize this variable only if you are an expert
1747 user. Valid values of this variable are:
1748 nil : Disable logging
1749 control : Log all invocations of `org-lparse-begin' and
1750 `org-lparse-end' callbacks.
1751 format : Log invocations of `org-lparse-format' callbacks.
1752 t : Log all invocations of `org-lparse-begin', `org-lparse-end'
1753 and `org-lparse-format' callbacks,"
1756 (const :tag
"Disable" nil
)
1757 (const :tag
"Format callbacks" format
)
1758 (const :tag
"Control callbacks" control
)
1759 (const :tag
"Format and Control callbacks" t
)))
1761 (defun org-lparse-begin (entity &rest args
)
1762 "Begin ENTITY in current buffer. ARGS is entity specific.
1763 ENTITY can be one of PARAGRAPH, LIST, LIST-ITEM etc.
1765 Use (org-lparse-begin 'LIST \"o\") to begin a list in current
1768 See `org-xhtml-entity-control-callbacks-alist' for more
1770 (when (and (member org-lparse-debug
'(t control
))
1771 (not (eq entity
'DOCUMENT-CONTENT
)))
1772 (insert (org-lparse-format 'COMMENT
"%s BEGIN %S" entity args
)))
1774 (let ((f (cadr (assoc entity org-lparse-entity-control-callbacks-alist
))))
1775 (unless f
(error "Unknown entity: %s" entity
))
1778 (defun org-lparse-end (entity &rest args
)
1779 "Close ENTITY in current buffer. ARGS is entity specific.
1780 ENTITY can be one of PARAGRAPH, LIST, LIST-ITEM
1783 Use (org-lparse-end 'LIST \"o\") to close a list in current
1786 See `org-xhtml-entity-control-callbacks-alist' for more
1788 (when (and (member org-lparse-debug
'(t control
))
1789 (not (eq entity
'DOCUMENT-CONTENT
)))
1790 (insert (org-lparse-format 'COMMENT
"%s END %S" entity args
)))
1792 (let ((f (caddr (assoc entity org-lparse-entity-control-callbacks-alist
))))
1793 (unless f
(error "Unknown entity: %s" entity
))
1796 (defun org-lparse-begin-paragraph (&optional style
)
1797 "Insert <p>, but first close previous paragraph if any."
1798 (org-lparse-end-paragraph)
1799 (org-lparse-begin 'PARAGRAPH style
)
1800 (setq org-lparse-par-open t
))
1802 (defun org-lparse-end-paragraph ()
1803 "Close paragraph if there is one open."
1804 (when org-lparse-par-open
1805 (org-lparse-end 'PARAGRAPH
)
1806 (setq org-lparse-par-open nil
)))
1808 (defun org-lparse-end-list-item (&optional type
)
1809 "Close <li> if necessary."
1810 (org-lparse-end-paragraph)
1811 (org-lparse-end 'LIST-ITEM
(or type
"u")))
1813 (defvar org-lparse-dyn-current-environment nil
)
1814 (defun org-lparse-begin-environment (style)
1815 (assert (not org-lparse-dyn-current-environment
) t
)
1816 (setq org-lparse-dyn-current-environment style
)
1817 (org-lparse-begin 'ENVIRONMENT style
))
1819 (defun org-lparse-end-environment (style)
1820 (org-lparse-end 'ENVIRONMENT style
)
1822 (assert (eq org-lparse-dyn-current-environment style
) t
)
1823 (setq org-lparse-dyn-current-environment nil
))
1825 (defun org-lparse-current-environment-p (style)
1826 (eq org-lparse-dyn-current-environment style
))
1828 (defun org-lparse-begin-footnote-definition (n)
1829 (unless org-lparse-footnote-buffer
1830 (setq org-lparse-footnote-buffer
1831 (get-buffer-create "*Org HTML Export Footnotes*")))
1832 (set-buffer org-lparse-footnote-buffer
)
1834 (setq org-lparse-insert-tag-with-newlines nil
)
1835 (org-lparse-begin 'FOOTNOTE-DEFINITION n
))
1837 (defun org-lparse-end-footnote-definition (n)
1838 (org-lparse-end 'FOOTNOTE-DEFINITION n
)
1839 (setq org-lparse-insert-tag-with-newlines
'both
)
1840 (push (cons n
(buffer-string)) org-lparse-footnote-definitions
)
1841 (set-buffer org-lparse-output-buffer
))
1843 (defun org-lparse-format (entity &rest args
)
1844 "Format ENTITY in backend-specific way and return it.
1845 ARGS is specific to entity being formatted.
1847 Use (org-lparse-format 'HEADING \"text\" 1) to format text as
1850 See `org-xhtml-entity-format-callbacks-alist' for more information."
1851 (when (and (member org-lparse-debug
'(t format
))
1852 (not (equal entity
'COMMENT
)))
1853 (insert (org-lparse-format 'COMMENT
"%s: %S" entity args
)))
1856 (let ((text (pop args
)))
1857 (apply 'org-lparse-format
'TAGS entity text args
)))
1859 (let ((f (cdr (assoc entity org-lparse-entity-format-callbacks-alist
))))
1860 (unless f
(error "Unknown entity: %s" entity
))
1863 (defun org-lparse-insert (entity &rest args
)
1864 (insert (apply 'org-lparse-format entity args
)))
1866 (defun org-lparse-prepare-toc (lines level-offset opt-plist umax-toc
)
1867 (let* ((quote-re0 (concat "^[ \t]*" org-quote-string
"\\>"))
1868 (org-min-level (org-get-min-level lines level-offset
))
1869 (org-last-level org-min-level
)
1872 (org-lparse-bind-local-variables opt-plist
)
1874 (org-lparse-begin 'TOC
(nth 3 (plist-get opt-plist
:lang-words
)))
1879 (when (and (string-match org-todo-line-regexp line
)
1880 (not (get-text-property 0 'org-protected line
))
1881 (<= (setq level
(org-tr-level
1882 (- (match-end 1) (match-beginning 1)
1885 (let ((txt (save-match-data
1886 (org-xml-encode-org-text-skip-links
1887 (org-export-cleanup-toc-line
1888 (match-string 3 line
)))))
1890 org-export-mark-todo-in-toc
1891 (or (and (match-beginning 2)
1892 (not (member (match-string 2 line
)
1893 org-done-keywords
)))
1894 (and (= level umax-toc
)
1895 (org-search-todo-below
1896 line lines level
)))))
1898 ;; Check for targets
1899 (while (string-match org-any-target-regexp line
)
1902 (let ((org-lparse-encode-pending t
))
1903 (org-lparse-format 'FONTIFY
1904 (match-string 1 line
) "target"))
1907 (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt
)
1908 (setq tags
(match-string 1 txt
)
1909 txt
(replace-match "" t nil txt
)))
1910 (when (string-match quote-re0 txt
)
1911 (setq txt
(replace-match "" t t txt
)))
1912 (while (string-match "<\\(<\\)+\\|>\\(>\\)+" txt
)
1913 (setq txt
(replace-match "" t t txt
)))
1916 (let* ((snumber (org-section-number level
))
1917 (href (replace-regexp-in-string
1918 "\\." "-" (format "sec-%s" snumber
)))
1922 href org-export-preferred-target-alist
))
1924 (href (org-solidify-link-text href
)))
1925 (org-lparse-format 'TOC-ENTRY snumber todo txt tags href
))
1926 level org-last-level
)
1927 (setq org-last-level level
)))
1930 (org-lparse-end 'TOC
)
1931 (setq org-lparse-toc
(buffer-string))))
1934 (defun org-lparse-format-table-row (fields &optional text-for-empty-fields
)
1935 (unless org-lparse-table-ncols
1936 ;; first row of the table
1937 (setq org-lparse-table-ncols
(length fields
))
1938 (when org-lparse-table-is-styled
1939 (setq org-lparse-table-num-numeric-items-per-column
1940 (make-vector org-lparse-table-ncols
0))
1941 (setq org-lparse-table-colalign-vector
1942 (make-vector org-lparse-table-ncols nil
))
1944 (while (< (incf c
) org-lparse-table-ncols
)
1945 (let ((cookie (cdr (assoc (1+ c
) org-lparse-table-colalign-info
))))
1946 (setf (aref org-lparse-table-colalign-vector c
)
1948 ((string= cookie
"l") "left")
1949 ((string= cookie
"r") "right")
1950 ((string= cookie
"c") "center")
1952 (incf org-lparse-table-rownum
)
1958 (when (and (string= x
"") text-for-empty-fields
)
1959 (setq x text-for-empty-fields
))
1961 (and org-lparse-table-is-styled
1962 (< i org-lparse-table-ncols
)
1963 (string-match org-table-number-regexp x
)
1964 (incf (aref org-lparse-table-num-numeric-items-per-column i
)))
1965 (org-lparse-format 'TABLE-CELL x org-lparse-table-rownum i
))
1968 (defun org-lparse-get (what &optional opt-plist
)
1969 "Query for value of WHAT for the current backend `org-lparse-backend'.
1970 See also `org-lparse-backend-get'."
1971 (if (boundp 'org-lparse-backend
)
1972 (org-lparse-backend-get (symbol-name org-lparse-backend
) what opt-plist
)
1973 (error "org-lparse-backend is not bound yet")))
1975 (defun org-lparse-backend-get (backend what
&optional opt-plist
)
1976 "Query BACKEND for value of WHAT.
1977 Dispatch the call to `org-<backend>-user-get'. If that throws an
1978 error, dispatch the call to `org-<backend>-get'. See
1979 `org-xhtml-get' for all known settings queried for by
1980 `org-lparse' during the course of export."
1981 (assert (stringp backend
) t
)
1982 (unless (org-lparse-backend-is-native-p backend
)
1983 (error "Unknown native backend %s" backend
))
1984 (let ((backend-get-method (intern (format "org-%s-get" backend
)))
1985 (backend-user-get-method (intern (format "org-%s-user-get" backend
))))
1987 ((functionp backend-get-method
)
1989 (funcall backend-user-get-method what opt-plist
)
1990 (error (funcall backend-get-method what opt-plist
))))
1992 (error "Native backend %s doesn't define %s" backend backend-get-method
)))))
1994 (defun org-lparse-insert-tag (tag &rest args
)
1995 (when (member org-lparse-insert-tag-with-newlines
'(lead both
))
1997 (insert (apply 'format tag args
))
1998 (when (member org-lparse-insert-tag-with-newlines
'(trail both
))
2001 (defun org-lparse-get-targets-from-title (title)
2002 (let* ((target (org-get-text-property-any 0 'target title
))
2003 (extra-targets (assoc target org-export-target-aliases
))
2004 (target (or (cdr (assoc target org-export-preferred-target-alist
))
2006 (cons target
(remove target extra-targets
))))
2008 (defun org-lparse-suffix-from-snumber (snumber)
2009 (let* ((snu (replace-regexp-in-string "\\." "-" snumber
))
2010 (href (cdr (assoc (concat "sec-" snu
)
2011 org-export-preferred-target-alist
))))
2012 (org-solidify-link-text (or href snu
))))
2014 (defun org-lparse-begin-level (level title umax head-count
)
2015 "Insert a new LEVEL in HTML export.
2016 When TITLE is nil, just close all open levels."
2017 (org-lparse-end-level level umax
)
2018 (unless title
(error "Why is heading nil"))
2019 (let* ((targets (org-lparse-get-targets-from-title title
))
2020 (target (car targets
)) (extra-targets (cdr targets
))
2021 (target (and target
(org-solidify-link-text target
)))
2022 (extra-class (org-get-text-property-any 0 'html-container-class title
))
2023 snumber tags level1 class
)
2024 (when (string-match (org-re "\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") title
)
2025 (setq tags
(and org-export-with-tags
(match-string 1 title
)))
2026 (setq title
(replace-match "" t t title
)))
2029 (if (aref org-levels-open
(1- level
))
2030 (org-lparse-end-list-item)
2031 (aset org-levels-open
(1- level
) t
)
2032 (org-lparse-end-paragraph)
2033 (org-lparse-begin-list 'unordered
))
2035 'LIST-ITEM
'unordered target
2036 (org-lparse-format 'HEADLINE title extra-targets tags
)))
2037 (aset org-levels-open
(1- level
) t
)
2038 (setq snumber
(org-section-number level
))
2039 (setq level1
(+ level
(or (org-lparse-get 'TOPLEVEL-HLEVEL
) 1) -
1))
2040 (unless (= head-count
1)
2041 (org-lparse-end-outline-text-or-outline))
2042 (org-lparse-begin-outline-and-outline-text
2043 level1 snumber title tags target extra-targets extra-class
)
2044 (org-lparse-begin-paragraph))))
2046 (defun org-lparse-end-level (level umax
)
2047 (org-lparse-end-paragraph)
2048 (loop for l from org-level-max downto level
2049 do
(when (aref org-levels-open
(1- l
))
2050 ;; Terminate one level in HTML export
2052 (org-lparse-end-outline-text-or-outline)
2053 (org-lparse-end-list-item)
2054 (org-lparse-end-list 'unordered
))
2055 (aset org-levels-open
(1- l
) nil
))))
2057 (defvar org-lparse-outline-text-open
)
2058 (defun org-lparse-begin-outline-and-outline-text (level1 snumber title tags
2059 target extra-targets
2062 'OUTLINE level1 snumber title tags target extra-targets extra-class
)
2063 (org-lparse-begin-outline-text level1 snumber extra-class
))
2065 (defun org-lparse-end-outline-text-or-outline ()
2067 (org-lparse-outline-text-open
2068 (org-lparse-end 'OUTLINE-TEXT
)
2069 (setq org-lparse-outline-text-open nil
))
2070 (t (org-lparse-end 'OUTLINE
))))
2072 (defun org-lparse-begin-outline-text (level1 snumber extra-class
)
2073 (assert (not org-lparse-outline-text-open
) t
)
2074 (setq org-lparse-outline-text-open t
)
2075 (org-lparse-begin 'OUTLINE-TEXT level1 snumber extra-class
))
2077 (defun org-lparse-html-list-type-to-canonical-list-type (ltype)
2078 (cdr (assoc ltype
'(("o" . ordered
)
2080 ("d" . description
)))))
2082 (defvar org-lparse-list-level
) ; dynamically bound in org-do-lparse
2083 (defun org-lparse-begin-list (ltype)
2084 (incf org-lparse-list-level
)
2085 (org-lparse-begin 'LIST ltype
))
2087 (defun org-lparse-end-list (ltype)
2088 (decf org-lparse-list-level
)
2089 (org-lparse-end 'LIST ltype
))
2091 (defvar org-lparse-table-rowgrp-info
)
2092 (defun org-lparse-begin-table-rowgroup (&optional is-header-row
)
2093 (push (cons (1+ org-lparse-table-rownum
) :start
) org-lparse-table-rowgrp-info
)
2094 (org-lparse-begin 'TABLE-ROWGROUP is-header-row
))
2096 (defun org-lparse-end-table ()
2097 (when org-lparse-table-is-styled
2099 (unless (car org-table-colgroup-info
)
2100 (setq org-table-colgroup-info
2101 (cons :start
(cdr org-table-colgroup-info
))))
2108 (setf (aref org-lparse-table-colalign-vector c
)
2109 (or (aref org-lparse-table-colalign-vector c
)
2110 (if (> (/ (float x
) (1+ org-lparse-table-rownum
))
2111 org-table-number-fraction
)
2113 org-lparse-table-num-numeric-items-per-column
)))
2114 (org-lparse-end 'TABLE
))
2116 (defvar org-lparse-encode-pending nil
)
2118 (defun org-lparse-format-tags (tag text prefix suffix
&rest args
)
2121 (concat prefix
(apply 'format
(car tag
) args
) text suffix
2122 (format (cdr tag
))))
2123 ((stringp tag
) ; singleton tag
2124 (concat prefix
(apply 'format tag args
) text
))))
2126 (defun org-xml-fix-class-name (kwd) ; audit callers of this function
2127 "Turn todo keyword into a valid class name.
2128 Replaces invalid characters with \"_\"."
2130 (while (string-match "[^a-zA-Z0-9_]" kwd
)
2131 (setq kwd
(replace-match "_" t t kwd
))))
2134 (defun org-lparse-format-todo (todo)
2135 (org-lparse-format 'FONTIFY
2137 (ignore-errors (org-lparse-get 'TODO-KWD-CLASS-PREFIX
))
2138 (org-xml-fix-class-name todo
))
2139 (list (if (member todo org-done-keywords
) "done" "todo")
2142 (defun org-lparse-format-extra-targets (extra-targets)
2143 (if (not extra-targets
) ""
2144 (mapconcat (lambda (x)
2145 (setq x
(org-solidify-link-text
2146 (if (org-uuidgen-p x
) (concat "ID-" x
) x
)))
2147 (org-lparse-format 'ANCHOR
"" x
))
2150 (defun org-lparse-format-org-tags (tags)
2158 (ignore-errors (org-lparse-get 'TAG-CLASS-PREFIX
))
2159 (org-xml-fix-class-name x
))))
2160 (org-split-string tags
":")
2161 (org-lparse-format 'SPACES
1)) "tag")))
2163 (defun org-lparse-format-section-number (&optional snumber level
)
2164 (and org-export-with-section-numbers
2165 (not org-lparse-body-only
) snumber level
2166 (org-lparse-format 'FONTIFY snumber
(format "section-number-%d" level
))))
2168 (defun org-lparse-warn (msg)
2169 (if (not org-lparse-use-flashy-warning
)
2171 (put-text-property 0 (length msg
) 'face
'font-lock-warning-face msg
)
2175 (defun org-xml-format-href (s)
2176 "Make sure the S is valid as a href reference in an XHTML document."
2179 (while (string-match "&" s start
)
2180 (setq start
(+ (match-beginning 0) 3)
2181 s
(replace-match "&" t t s
)))))
2184 (defun org-xml-format-desc (s)
2185 "Make sure the S is valid as a description in a link."
2186 (if (and s
(not (get-text-property 1 'org-protected s
)))
2188 (org-xml-encode-org-text s
))
2191 (provide 'org-lparse
)
2193 ;;; org-lparse.el ends here