| blob | 38de0874f6d1cf9ff194517de613b193994e0579 |
1 ;; org-export-generic.el --- Export frameworg with custom backends
3 ;; Copyright (C) 2009-2013 Free Software Foundation, Inc.
5 ;; Author: Wes Hardaker <hardaker at users dot sourceforge dot net>
6 ;; Keywords: outlines, hypermedia, calendar, wp, export
7 ;; Homepage: http://orgmode.org
8 ;; Version: 6.25trans
9 ;; Acks: Much of this code was stolen form the ascii export from Carsten
10 ;;
11 ;; This file is not part of GNU Emacs.
12 ;;
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 ;;
26 ;; ----------------------------------------------------------------------
27 ;;
28 ;; OVERVIEW
29 ;;
30 ;; IMPORTANT: IF YOU WANT TO WRITE A NEW EXPORTER FOR ORG, PLEASE
31 ;; CHECK contrib/lisp/org-export.el -- ORG-EXPORT-GENERIC.EL, WHILE
32 ;; STILL USEFUL, SHOULD NOT BE USED FOR NEW EXPORTERS.
33 ;;
34 ;; org-export-generic is basically a simple translation system that
35 ;; knows how to parse at least most of a .org buffer and then add
36 ;; various formatting prefixes before and after each section type. It
37 ;; does this by examining a property list stored in org-generic-alist.
38 ;; You can dynamically add propety lists of your own using the
39 ;; org-set-generic-type function:
40 ;;
41 ;; (org-set-generic-type
42 ;; "really-basic-text"
43 ;; '(:file-suffix ".txt"
44 ;; :key-binding ?R
45 ;;
46 ;; :title-format "=== %s ===\n"
47 ;; :body-header-section-numbers t
48 ;; :body-header-section-number-format "%s) "
49 ;; :body-section-header-prefix "\n"
50 ;; :body-section-header-suffix "\n"
51 ;; :body-line-format " %s\n"
52 ;; :body-line-wrap 75
53 ;; ))
54 ;;
55 ;; Note: Upper case key-bindings are reserved for your use. Lower
56 ;; case key bindings may conflict with future export-generic
57 ;; publications.
58 ;;
59 ;; Then run org-export (ctrl-c ctrl-e) and select generic or run
60 ;; org-export-generic. You'll then be prompted with a list of export
61 ;; types to choose from which will include your new type assigned to
62 ;; the key "r".
63 ;;
64 ;; ----------------------------------------------------------------------
65 ;;
66 ;; TODO (non-ordered)
67 ;; * handle function references
68 ;; * handle other types of multi-complex-listy-things to do
69 ;; ideas: (t ?- "%s" ?-)
70 ;; * handle indent specifiers better
71 ;; ideas: (4 ?\ "%s")
72 ;; * need flag to remove indents from body text
73 ;; * handle links
74 ;; * handle internationalization strings better
75 ;; * date/author/etc needs improvment (internationalization too)
76 ;; * allow specifying of section ordering
77 ;; ideas: :ordering ("header" "toc" "body" "footer")
78 ;; ^ matches current hard coded ordering
79 ;; * err, actually *do* a footer
80 ;; * deal with usage of org globals
81 ;; *** should we even consider them, or let the per-section specifiers do it
82 ;; *** answer: remove; mostly removed now
83 ;; * deal with interactive support for picking a export specifier label
84 ;; * char specifiers that need extra length because of formatting
85 ;; idea: (?- 4) for 4-longer
86 ;; * centering specifier
87 ;; idea: ('center " -- %s -- ")
88 ;; * remove more of the unneeded export-to-ascii copy code
89 ;; * tags
90 ;; *** supported now, but need separate format per tag
91 ;; *** allow different open/closing prefixes
92 ;; * properties
93 ;; * drawers
94 ;; * Escape camel-case for wiki exporters.
95 ;; * Adjust to depth limits on headers --- need to roll-over from headers
96 ;; to lists, as per other exporters
97 ;; * optmization (many plist extracts should be in let vars)
98 ;; * define defcustom spec for the specifier list
99 ;; * fonts: at least monospace is not handled at all here.
100 ;;
101 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
102 ;;
103 ;;; Commentary:
110 "Options specific for ASCII export of Org-mode files."
115 "Non-nil means convert links to notes before the next headline.
116 When nil, the link will be exported in place. If the line becomes long
117 in this way, it will be wrapped."
125 '(
126 ;;
127 ;; generic DEMO exporter
128 ;;
129 ;; (this tries to use every specifier for demo purposes)
130 ;;
133 :key-binding ?d
138 :author-export t
139 :tags-export t
141 :drawers-export t
148 :date-export t
153 :toc-export t
161 :toc-section-numbers t
165 :toc-indent-char ?\
168 :toc-tags-export t
176 ; lists indicate different things per level
177 ; list contents or straight value can either be a
178 ; ?x char reference for printing strings that match the header len
179 ; "" string to print directly
186 :timestamps-export t
187 :priorities-export t
188 :todo-keywords-export t
190 :body-tags-export t
194 ; section prefixes/suffixes can be direct strings or lists as well
197 ; :body-section-prefix ("<sec1>\n" "<sec2>\n" "<sec3>\n")
198 ; :body-section-suffix ("</sec1>\n" "</sec2>\n" "</sec3>\n")
201 ; if preformated text should be included (eg, : prefixed)
202 :body-line-export-preformated t
215 :body-number-list-leave-number t
227 ; other body lines
231 ; print above and below all body parts
234 ;;
235 ;; ascii exporter
236 ;;
237 ;; (close to the original ascii specifier)
238 ;;
241 :key-binding ?a
250 :date-export t
259 :toc-export t
260 :toc-section-numbers t
264 :toc-indent-char ?\
270 ; :body-section-header-prefix "\n"
271 ; :body-section-header-format "%s\n"
272 ; :body-section-header-suffix (?\$ ?\# ?^ ?\~ ?\= ?\-)
278 ; :body-section-marker-prefix ""
279 ; :body-section-marker-chars (?\$ ?\# ?^ ?\~ ?\= ?\-)
280 ; :body-section-marker-suffix "\n"
282 :body-line-export-preformated t
286 ; :body-text-prefix "<t>\n"
287 ; :body-text-suffix "</t>\n"
291 ; :body-bullet-list-suffix (?* ?+ ?-)
293 ;;
294 ;; wikipedia
295 ;;
298 :key-binding ?w
305 :date-export nil
307 :toc-export nil
309 :body-header-section-numbers nil
327 ;;
328 ;; mediawiki
329 ;;
332 :key-binding ?m
339 :date-export nil
341 :toc-export nil
343 :body-header-section-numbers nil
369 ;;
370 ;; internet-draft .xml for xml2rfc exporter
371 ;;
373 ;; this tries to use every specifier for demo purposes
375 :key-binding ?i
379 <!ENTITY rfcs PUBLIC '' 'blah'>
387 <front>
388 "
391 <organization>Comany, Inc..</organization>
392 <address>
393 <postal>
394 <street></street>
395 <city></city>
396 <region></region>
397 <code></code>
398 <country></country>
399 </postal>
400 <phone></phone>
401 <email></email>
402 </address>
403 </author>
405 <area>Operations and Management</area>
406 <workgroup>FIXME</workgroup>
408 :date-export nil
410 :toc-export nil
412 :body-header-section-numbers nil
417 ; if preformated text should be included (eg, : prefixed)
418 :body-line-export-preformated t
422 ; other body lines
426 ; print above and below all body parts
435 :key-binding ?T
437 ;; lifted from wikipedia exporter
443 :date-export nil
445 :toc-export nil
447 :body-header-section-numbers nil
463 ;; :body-list-prefix "LISTSTART"
464 ;; :body-list-suffix "LISTEND"
466 ;; this is ignored! [2010/02/02:rpg]
470 :key-binding ?U
472 ;; lifted from wikipedia exporter
478 :date-export nil
480 :toc-export nil
482 :body-header-section-numbers nil
493 :body-line-wrap nil
499 ;; :body-list-prefix "LISTSTART"
500 ;; :body-list-suffix "LISTEND"
518 "Adds a TYPE and DEFINITION to the existing list of defined generic
519 export definitions."
522 ;;; helper functions for org-set-generic-type
525 &key documentation
526 type)
527 "Define KEYWORD as a legitimate element for inclusion in
528 the body of an org-set-generic-type definition."
529 ;; TODO: push the documentation and type information
530 ;; somewhere where it will do us some good.
536 inserted in the output for every blank line in the input.
537 The intention is to handle formats where text is flowed, and
538 newlines are interpreted as significant \(e.g., as indicating
539 preformatted text\). A common non-nil value for this keyword
541 :body-line-format that does NOT end with a newline."
544 ;;; fontification keywords
559 "checks to see if type is already in use, or we're switching parts
560 If we're switching, then insert a potentially previously remembered
561 suffix, and insert the current prefix immediately and then save the
562 suffix a later change time."
573 "Export the outline as generic output.
574 If there is an active region, export only the region.
575 The prefix ARG specifies how many levels of the outline should become
576 underlined headlines. The default is 3."
599 opt-plist)))
601 helpstart
608 org-generic-alist))
612 \[ ] the current setting of the org-generic-export-type variable
622 org-generic-alist)
625 r1 r2 ass
627 ;; read in the type to use
645 org-generic-alist))))
662 filesuffix))
666 filename))
682 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
692 region
694 :skip-before-1st-heading
702 :verbatim-multiline t
705 :emph-multiline t
706 :archived-trees
710 ;; export-generic plist variables
782 ;; dynamic variables used heinously in fontification
783 ;; not referenced locally...
793 thetoc toctags have-headings first-heading-pos
794 table-open table-buffer link-buffer link desc desc0 rpl wrap)
812 ;; create local variables for all options, to make sure all called
813 ;; functions get the correct information
817 org-export-plist-vars)
820 org-export-headline-levels))
823 ;; File header
827 :title-prefix
828 :title-format
846 :date-prefix
847 :date-format
850 ;; export the table of contents first
855 :toc-header-prefix
856 :toc-header-format
858 thetoc)
865 ;; This is a headline
869 level-offset)
872 todo
876 org-done-keywords)))
877 ; TODO, not DONE
881 line lines level))))
888 t t txt)))
893 txt))
895 ; include tags but formated
898 txt)
901 toctags
904 export-plist :toc-tags-prefix
908 txt)
922 tocindentchar)
931 txt)
933 toctags)
935 thetoc)
937 lines)
949 ;; Remove the quoted HTML tags.
950 ;; XXX
952 ;; Replace links with the description when possible
953 ;; XXX
964 org-export-code-refs)))
965 t t line))
980 ;;
981 ;; a Headline
982 ;;
987 level-offset))
994 ;;
995 ;; a Table
996 ;;
1000 ;; New table starts
1002 ;; Accumulate table lines
1016 ;;
1017 ;; pre-formatted text
1018 ;;
1026 ;; if the bullet list item is an asterisk, the leading space is /mandatory/
1027 ;; [2010/02/02:rpg]
1029 ;;
1030 ;; plain list item
1031 ;; TODO: nested lists
1032 ;;
1033 ;; first add a line break between any previous paragraph or line item and this
1034 ;; one
1038 ;; I believe this gets rid of leading whitespace.
1041 ;; won't this insert the suffix /before/ the last line of the list?
1042 ;; also isn't it spoofed by bulleted lists that have a line skip between the list items
1043 ;; unless 'org-empty-line-terminates-plain-lists' is true?
1046 ;; deal with checkboxes
1050 listchecktodoend)))
1053 listcheckdoneend)))
1056 listcheckhalfend))))
1060 ;;
1061 ;; numbered list item
1062 ;;
1063 ;; TODO: nested lists
1064 ;;
1068 numlistprefix numlistsuffix)
1070 ;; deal with checkboxes
1071 ;; TODO: whoops; leaving the numbers is a problem for ^ matching
1075 listchecktodoend)))
1078 listcheckdoneend)))
1081 listcheckhalfend))))
1090 ;; blank line
1094 ;;
1095 ;; body
1096 ;;
1102 ;; XXX: properties? list?
1108 ;; Remove forced line breaks
1113 ;; XXX: was dependent on wrap var which was calculated by???
1120 ;; if we're at a level > 0; insert the closing body level stuff
1134 ;; insert the table of contents
1146 ;; Convert whitespace place holders
1157 ;; remove display and invisible chars
1174 "converts a property specification to a string given types of properties
1176 The EXPORT-PLIST should be defined as the lookup plist.
1177 The PROP should be the property name to search for in it.
1178 LEN is set to the length of multi-characters strings to generate (or 0)
1179 N is the tree depth
1180 REVERSE means to reverse the list if the plist match is a list
1181 "
1183 subtype)
1187 ;; sequence of chars
1190 prefixtype)
1198 subtype
1203 prefixprop formatprop postfixprop
1205 "convert a header to an output string given formatting property names"
1214 "Do extra work for ASCII export"
1215 ;; Put quotes around verbatim text
1223 ;; Remove target markers
1229 "Handle quoted HTML for ASCII export."
1232 ;; We just remove the tags for now.
1234 line)
1237 "Wrap LINE at or before WHERE."
1242 pos didfirst)
1264 "Push out links in the buffer."
1266 ;; We still have links to push out.
1276 link-buffer))
1281 "Insert a new level in a generic export."
1288 char tagstring)
1294 ;; going deeper
1301 ;; going up
1308 ;; same level
1316 secnums
1323 ;; handle tags and formatting
1329 export-plist
1330 :body-tags-prefix
1331 :body-tags-format
1339 :body-section-header-prefix
1340 :body-section-header-format
1341 :body-section-header-suffix
1342 level))
1349 "Insert the string S centered and underline it with character UNDERLINE."
1359 "Format a table for ascii export."
1363 ;; Table made by table.el - test for spanning
1364 lines
1366 ;; A normal org table
1367 ;; Get rid of hlines at beginning and end
1373 ;; Check if the table has a marking column. If yes remove the
1374 ;; column and the special lines
1376 ;; Get rid of the vertical lines except for grouping
1386 (setq line (replace-match (concat bodytablefirstcellstart bodytablecellstart " \\1 " bodytablecellend bodytablelastcellend) t nil line)))
1388 (setq start (+ (match-end 0) (length (concat bodytablecellend bodytableinteriorcellend bodytableinteriorcellstart bodytablecellstart))))
1389 (or (pop vl1) (setq line (replace-match (concat bodytablecellend bodytableinteriorcellend bodytableinteriorcellstart bodytablecellstart) t t line)))))
1405 vl))
1408 ;;; FIXME: this should probably turn into a defconstant later [2010/05/20:rpg]
1416 "Alist of org format -> formatting variables for fontification.
1417 Each element of the list is a list of three elements.
1418 The first element is the character used as a marker for fontification.
1419 The second element is a variable name, set in org-export-generic. That
1420 variable will be dereferenced to obtain a formatting string to wrap
1421 fontified text with.
1422 The third element decides whether to protect converted text from other
1425 ;;; Cargo-culted from the latex translation. I couldn't figure out how
1426 ;;; to keep the structure since the generic export operates on lines, rather
1427 ;;; than on a buffer as in the latex export, meaning that none of the
1428 ;;; search forward code could be kept. This led me to rewrite the
1429 ;;; whole thing recursively. A huge lose for efficiency (potentially),
1430 ;;; but I couldn't figure out how to make the looping work.
1431 ;;; Worse, it's /doubly/ recursive, because this function calls
1432 ;;; org-export-generic-emph-format, which can call it recursively...
1433 ;;; [2010/05/20:rpg]
1435 "Convert fontification according to generic rules."
1437 ;; The match goes one char after the *string*, except at the end of a line
1439 org-export-generic-emphasis-alist))
1445 ;; now we need to determine whether we have strikethrough or
1446 ;; a list, which is a bit nasty
1450 ;; a list --- skip this match and recurse on the point after the
1451 ;; first emph char...
1461 string))
1464 "Return a string that results from applying the markup indicated by
1465 FORMAT-VARNAME to STRING."
1469 string
1473 string-to-emphasize))))
1478 ;;; org-export-generic.el ends here