| blob | 4de38c793bb778d449f8b294108572d94deb586e |
1 ;; org-export-generic.el --- Export frameworg with custom backends
3 ;; Copyright (C) 2009-2012 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 yet 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 ;; org-export-generic is basically a simple translation system that
31 ;; knows how to parse at least most of a .org buffer and then add
32 ;; various formatting prefixes before and after each section type. It
33 ;; does this by examining a property list stored in org-generic-alist.
34 ;; You can dynamically add propety lists of your own using the
35 ;; org-set-generic-type function:
36 ;;
37 ;; (org-set-generic-type
38 ;; "really-basic-text"
39 ;; '(:file-suffix ".txt"
40 ;; :key-binding ?R
41 ;;
42 ;; :title-format "=== %s ===\n"
43 ;; :body-header-section-numbers t
44 ;; :body-header-section-number-format "%s) "
45 ;; :body-section-header-prefix "\n"
46 ;; :body-section-header-suffix "\n"
47 ;; :body-line-format " %s\n"
48 ;; :body-line-wrap 75
49 ;; ))
50 ;;
51 ;; Note: Upper case key-bindings are reserved for your use. Lower
52 ;; case key bindings may conflict with future export-generic
53 ;; publications.
54 ;;
55 ;; Then run org-export (ctrl-c ctrl-e) and select generic or run
56 ;; org-export-generic. You'll then be prompted with a list of export
57 ;; types to choose from which will include your new type assigned to
58 ;; the key "r".
59 ;;
60 ;; ----------------------------------------------------------------------
61 ;;
62 ;; TODO (non-ordered)
63 ;; * handle function references
64 ;; * handle other types of multi-complex-listy-things to do
65 ;; ideas: (t ?- "%s" ?-)
66 ;; * handle indent specifiers better
67 ;; ideas: (4 ?\ "%s")
68 ;; * need flag to remove indents from body text
69 ;; * handle links
70 ;; * handle internationalization strings better
71 ;; * date/author/etc needs improvment (internationalization too)
72 ;; * allow specifying of section ordering
73 ;; ideas: :ordering ("header" "toc" "body" "footer")
74 ;; ^ matches current hard coded ordering
75 ;; * err, actually *do* a footer
76 ;; * deal with usage of org globals
77 ;; *** should we even consider them, or let the per-section specifiers do it
78 ;; *** answer: remove; mostly removed now
79 ;; * deal with interactive support for picking a export specifier label
80 ;; * char specifiers that need extra length because of formatting
81 ;; idea: (?- 4) for 4-longer
82 ;; * centering specifier
83 ;; idea: ('center " -- %s -- ")
84 ;; * remove more of the unneeded export-to-ascii copy code
85 ;; * tags
86 ;; *** supported now, but need separate format per tag
87 ;; *** allow different open/closing prefixes
88 ;; * properties
89 ;; * drawers
90 ;; * Escape camel-case for wiki exporters.
91 ;; * Adjust to depth limits on headers --- need to roll-over from headers
92 ;; to lists, as per other exporters
93 ;; * optmization (many plist extracts should be in let vars)
94 ;; * define defcustom spec for the specifier list
95 ;; * fonts: at least monospace is not handled at all here.
96 ;;
97 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
98 ;;
99 ;;; Commentary:
106 "Options specific for ASCII export of Org-mode files."
111 "Non-nil means convert links to notes before the next headline.
112 When nil, the link will be exported in place. If the line becomes long
113 in this way, it will be wrapped."
121 '(
122 ;;
123 ;; generic DEMO exporter
124 ;;
125 ;; (this tries to use every specifier for demo purposes)
126 ;;
129 :key-binding ?d
134 :author-export t
135 :tags-export t
137 :drawers-export t
144 :date-export t
149 :toc-export t
157 :toc-section-numbers t
161 :toc-indent-char ?\
164 :toc-tags-export t
172 ; lists indicate different things per level
173 ; list contents or straight value can either be a
174 ; ?x char reference for printing strings that match the header len
175 ; "" string to print directly
182 :timestamps-export t
183 :priorities-export t
184 :todo-keywords-export t
186 :body-tags-export t
190 ; section prefixes/suffixes can be direct strings or lists as well
193 ; :body-section-prefix ("<sec1>\n" "<sec2>\n" "<sec3>\n")
194 ; :body-section-suffix ("</sec1>\n" "</sec2>\n" "</sec3>\n")
197 ; if preformated text should be included (eg, : prefixed)
198 :body-line-export-preformated t
211 :body-number-list-leave-number t
223 ; other body lines
227 ; print above and below all body parts
231 )
233 ;;
234 ;; ascii exporter
235 ;;
236 ;; (close to the original ascii specifier)
237 ;;
240 :key-binding ?a
249 :date-export t
258 :toc-export t
259 :toc-section-numbers t
263 :toc-indent-char ?\
269 ; :body-section-header-prefix "\n"
270 ; :body-section-header-format "%s\n"
271 ; :body-section-header-suffix (?\$ ?\# ?^ ?\~ ?\= ?\-)
277 ; :body-section-marker-prefix ""
278 ; :body-section-marker-chars (?\$ ?\# ?^ ?\~ ?\= ?\-)
279 ; :body-section-marker-suffix "\n"
281 :body-line-export-preformated t
285 ; :body-text-prefix "<t>\n"
286 ; :body-text-suffix "</t>\n"
290 ; :body-bullet-list-suffix (?* ?+ ?-)
291 )
293 ;;
294 ;; wikipedia
295 ;;
298 :key-binding ?w
305 :date-export nil
307 :toc-export nil
309 :body-header-section-numbers nil
327 )
328 ;;
329 ;; mediawiki
330 ;;
333 :key-binding ?m
340 :date-export nil
342 :toc-export nil
344 :body-header-section-numbers nil
372 )
373 ;;
374 ;; internet-draft .xml for xml2rfc exporter
375 ;;
377 ;; this tries to use every specifier for demo purposes
379 :key-binding ?i
383 <!ENTITY rfcs PUBLIC '' 'blah'>
391 <front>
392 "
395 <organization>Comany, Inc..</organization>
396 <address>
397 <postal>
398 <street></street>
399 <city></city>
400 <region></region>
401 <code></code>
402 <country></country>
403 </postal>
404 <phone></phone>
405 <email></email>
406 </address>
407 </author>
409 <area>Operations and Management</area>
410 <workgroup>FIXME</workgroup>
412 :date-export nil
414 :toc-export nil
416 :body-header-section-numbers nil
421 ; if preformated text should be included (eg, : prefixed)
422 :body-line-export-preformated t
426 ; other body lines
430 ; print above and below all body parts
438 )
441 :key-binding ?T
443 ;; lifted from wikipedia exporter
449 :date-export nil
451 :toc-export nil
453 :body-header-section-numbers nil
469 ;; :body-list-prefix "LISTSTART"
470 ;; :body-list-suffix "LISTEND"
472 ;; this is ignored! [2010/02/02:rpg]
474 )
477 :key-binding ?U
479 ;; lifted from wikipedia exporter
485 :date-export nil
487 :toc-export nil
489 :body-header-section-numbers nil
500 :body-line-wrap nil
506 ;; :body-list-prefix "LISTSTART"
507 ;; :body-list-suffix "LISTEND"
517 )
518 )
519 "A assoc list of property lists to specify export definitions"
520 )
527 ;;;###autoload
529 "Adds a TYPE and DEFINITION to the existing list of defined generic
530 export definitions."
533 ;;; helper functions for org-set-generic-type
536 &key documentation
537 type)
538 "Define KEYWORD as a legitimate element for inclusion in
539 the body of an org-set-generic-type definition."
542 ;; TODO: push the documentation and type information
543 ;; somewhere where it will do us some good.
544 ))
548 inserted in the output for every blank line in the input.
549 The intention is to handle formats where text is flowed, and
550 newlines are interpreted as significant \(e.g., as indicating
551 preformatted text\). A common non-nil value for this keyword
553 :body-line-format that does NOT end with a newline."
556 ;;; fontification keywords
572 )
575 "checks to see if type is already in use, or we're switching parts
576 If we're switching, then insert a potentially previously remembered
577 suffix, and insert the current prefix immediately and then save the
578 suffix a later change time."
588 ;;;###autoload
590 "Export the outline as generic output.
591 If there is an active region, export only the region.
592 The prefix ARG specifies how many levels of the outline should become
593 underlined headlines. The default is 3."
616 opt-plist)))
618 helpstart
625 org-generic-alist))
629 \[ ] the current setting of the org-generic-export-type variable
639 org-generic-alist)
642 r1 r2 ass
644 ;; read in the type to use
662 org-generic-alist))))
679 filesuffix))
683 filename))
699 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
709 region
711 :skip-before-1st-heading
719 :verbatim-multiline t
722 :emph-multiline t
723 :archived-trees
727 ;; export-generic plist variables
799 ;; dynamic variables used heinously in fontification
800 ;; not referenced locally...
810 thetoc toctags have-headings first-heading-pos
811 table-open table-buffer link-buffer link desc desc0 rpl wrap)
829 ;; create local variables for all options, to make sure all called
830 ;; functions get the correct information
834 org-export-plist-vars)
837 org-export-headline-levels))
840 ;; File header
844 :title-prefix
845 :title-format
863 :date-prefix
864 :date-format
867 ;; export the table of contents first
872 :toc-header-prefix
873 :toc-header-format
875 thetoc)
882 ;; This is a headline
886 level-offset)
889 todo
893 org-done-keywords)))
894 ; TODO, not DONE
898 line lines level))))
905 t t txt)))
910 txt))
912 ; include tags but formated
915 txt)
918 toctags
921 export-plist :toc-tags-prefix
925 txt)
939 tocindentchar)
948 txt)
950 toctags)
952 thetoc)
954 ))))
955 lines)
967 ;; Remove the quoted HTML tags.
968 ;; XXX
970 ;; Replace links with the description when possible
971 ;; XXX
982 org-export-code-refs)))
983 t t line))
998 ;;
999 ;; a Headline
1000 ;;
1005 level-offset))
1012 ;;
1013 ;; a Table
1014 ;;
1018 ;; New table starts
1020 ;; Accumulate table lines
1034 ;;
1035 ;; pre-formatted text
1036 ;;
1044 ;; if the bullet list item is an asterisk, the leading space is /mandatory/
1045 ;; [2010/02/02:rpg]
1047 ;;
1048 ;; plain list item
1049 ;; TODO: nested lists
1050 ;;
1051 ;; first add a line break between any previous paragraph or line item and this
1052 ;; one
1056 ;; I believe this gets rid of leading whitespace.
1059 ;; won't this insert the suffix /before/ the last line of the list?
1060 ;; also isn't it spoofed by bulleted lists that have a line skip between the list items
1061 ;; unless 'org-empty-line-terminates-plain-lists' is true?
1064 ;; deal with checkboxes
1068 listchecktodoend)))
1071 listcheckdoneend)))
1074 listcheckhalfend)))
1075 )
1079 ;;
1080 ;; numbered list item
1081 ;;
1082 ;; TODO: nested lists
1083 ;;
1087 numlistprefix numlistsuffix)
1089 ;; deal with checkboxes
1090 ;; TODO: whoops; leaving the numbers is a problem for ^ matching
1094 listchecktodoend)))
1097 listcheckdoneend)))
1100 listcheckhalfend)))
1101 )
1110 ;; blank line
1114 ;;
1115 ;; body
1116 ;;
1122 ;; XXX: properties? list?
1128 ;; Remove forced line breaks
1133 ;; XXX: was dependent on wrap var which was calculated by???
1140 ;; if we're at a level > 0; insert the closing body level stuff
1154 ;; insert the table of contents
1166 ;; Convert whitespace place holders
1177 ;; remove display and invisible chars
1194 "converts a property specification to a string given types of properties
1196 The EXPORT-PLIST should be defined as the lookup plist.
1197 The PROP should be the property name to search for in it.
1198 LEN is set to the length of multi-characters strings to generate (or 0)
1199 N is the tree depth
1200 REVERSE means to reverse the list if the plist match is a list
1201 "
1203 subtype)
1207 ;; sequence of chars
1210 prefixtype)
1218 subtype
1221 ))
1224 prefixprop formatprop postfixprop
1226 "convert a header to an output string given formatting property names"
1233 ))
1236 "Do extra work for ASCII export"
1237 ;; Put quotes around verbatim text
1245 ;; Remove target markers
1251 "Handle quoted HTML for ASCII export."
1254 ;; We just remove the tags for now.
1256 line)
1259 "Wrap LINE at or before WHERE."
1264 pos didfirst)
1286 "Push out links in the buffer."
1288 ;; We still have links to push out.
1298 link-buffer))
1303 "Insert a new level in a generic export."
1310 char tagstring)
1316 ;; going deeper
1323 ))
1324 ;; going up
1331 ))
1332 ;; same level
1336 )
1337 )
1342 secnums
1349 ;; handle tags and formatting
1355 export-plist
1356 :body-tags-prefix
1357 :body-tags-format
1365 :body-section-header-prefix
1366 :body-section-header-format
1367 :body-section-header-suffix
1368 level))
1375 "Insert the string S centered and underline it with character UNDERLINE."
1385 "Format a table for ascii export."
1389 ;; Table made by table.el - test for spanning
1390 lines
1392 ;; A normal org table
1393 ;; Get rid of hlines at beginning and end
1399 ;; Check if the table has a marking column. If yes remove the
1400 ;; column and the special lines
1402 ;; Get rid of the vertical lines except for grouping
1412 (setq line (replace-match (concat bodytablefirstcellstart bodytablecellstart " \\1 " bodytablecellend bodytablelastcellend) t nil line)))
1414 (setq start (+ (match-end 0) (length (concat bodytablecellend bodytableinteriorcellend bodytableinteriorcellstart bodytablecellstart))))
1415 (or (pop vl1) (setq line (replace-match (concat bodytablecellend bodytableinteriorcellend bodytableinteriorcellstart bodytablecellstart) t t line)))))
1431 vl))
1434 ;;; FIXME: this should probably turn into a defconstant later [2010/05/20:rpg]
1442 "Alist of org format -> formatting variables for fontification.
1443 Each element of the list is a list of three elements.
1444 The first element is the character used as a marker for fontification.
1445 The second element is a variable name, set in org-export-generic. That
1446 variable will be dereferenced to obtain a formatting string to wrap
1447 fontified text with.
1448 The third element decides whether to protect converted text from other
1451 ;;; Cargo-culted from the latex translation. I couldn't figure out how
1452 ;;; to keep the structure since the generic export operates on lines, rather
1453 ;;; than on a buffer as in the latex export, meaning that none of the
1454 ;;; search forward code could be kept. This led me to rewrite the
1455 ;;; whole thing recursively. A huge lose for efficiency (potentially),
1456 ;;; but I couldn't figure out how to make the looping work.
1457 ;;; Worse, it's /doubly/ recursive, because this function calls
1458 ;;; org-export-generic-emph-format, which can call it recursively...
1459 ;;; [2010/05/20:rpg]
1461 "Convert fontification according to generic rules."
1463 ;; The match goes one char after the *string*, except at the end of a line
1465 org-export-generic-emphasis-alist))
1471 ;; now we need to determine whether we have strikethrough or
1472 ;; a list, which is a bit nasty
1476 ;; a list --- skip this match and recurse on the point after the
1477 ;; first emph char...
1487 string))
1490 "Return a string that results from applying the markup indicated by
1491 FORMAT-VARNAME to STRING."
1495 string
1499 string-to-emphasize))))
1504 ;;; org-export-generic.el ends here