| blob | 5a5af14d79a9894cb054ad765af350b7d1ecbed9 |
1 ;; org-export-generic.el --- Export frameworg with custom backends
3 ;; Copyright (C) 2009-2011 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 ;; * oh my
91 ;; * optmization (many plist extracts should be in let vars)
92 ;; * define defcustom spec for the specifier list
93 ;; * fonts: at least monospace is not handled at all here.
94 ;;
95 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
96 ;;
97 ;;; Commentary:
103 "Options specific for ASCII export of Org-mode files."
108 "Non-nil means convert links to notes before the next headline.
109 When nil, the link will be exported in place. If the line becomes long
110 in this way, it will be wrapped."
118 '(
119 ;;
120 ;; generic DEMO exporter
121 ;;
122 ;; (this tries to use every specifier for demo purposes)
123 ;;
126 :key-binding ?d
131 :author-export t
132 :tags-export t
134 :drawers-export t
141 :date-export t
146 :toc-export t
154 :toc-section-numbers t
158 :toc-indent-char ?\
161 :toc-tags-export t
169 ; lists indicate different things per level
170 ; list contents or straight value can either be a
171 ; ?x char reference for printing strings that match the header len
172 ; "" string to print directly
179 :timestamps-export t
180 :priorities-export t
181 :todo-keywords-export t
183 :body-tags-export t
187 ; section prefixes/suffixes can be direct strings or lists as well
190 ; :body-section-prefix ("<sec1>\n" "<sec2>\n" "<sec3>\n")
191 ; :body-section-suffix ("</sec1>\n" "</sec2>\n" "</sec3>\n")
194 ; if preformated text should be included (eg, : prefixed)
195 :body-line-export-preformated t
208 :body-number-list-leave-number t
220 ; other body lines
224 ; print above and below all body parts
228 )
230 ;;
231 ;; ascii exporter
232 ;;
233 ;; (close to the original ascii specifier)
234 ;;
237 :key-binding ?a
246 :date-export t
255 :toc-export t
256 :toc-section-numbers t
260 :toc-indent-char ?\
266 ; :body-section-header-prefix "\n"
267 ; :body-section-header-format "%s\n"
268 ; :body-section-header-suffix (?\$ ?\# ?^ ?\~ ?\= ?\-)
274 ; :body-section-marker-prefix ""
275 ; :body-section-marker-chars (?\$ ?\# ?^ ?\~ ?\= ?\-)
276 ; :body-section-marker-suffix "\n"
278 :body-line-export-preformated t
282 ; :body-text-prefix "<t>\n"
283 ; :body-text-suffix "</t>\n"
287 ; :body-bullet-list-suffix (?* ?+ ?-)
288 )
290 ;;
291 ;; wikipedia
292 ;;
295 :key-binding ?w
302 :date-export nil
304 :toc-export nil
306 :body-header-section-numbers nil
324 )
325 ;;
326 ;; internet-draft .xml for xml2rfc exporter
327 ;;
329 ;; this tries to use every specifier for demo purposes
331 :key-binding ?i
335 <!ENTITY rfcs PUBLIC '' 'blah'>
343 <front>
344 "
347 <organization>Comany, Inc..</organization>
348 <address>
349 <postal>
350 <street></street>
351 <city></city>
352 <region></region>
353 <code></code>
354 <country></country>
355 </postal>
356 <phone></phone>
357 <email></email>
358 </address>
359 </author>
361 <area>Operations and Management</area>
362 <workgroup>FIXME</workgroup>
364 :date-export nil
366 :toc-export nil
368 :body-header-section-numbers nil
373 ; if preformated text should be included (eg, : prefixed)
374 :body-line-export-preformated t
378 ; other body lines
382 ; print above and below all body parts
390 )
393 :key-binding ?T
395 ;; lifted from wikipedia exporter
401 :date-export nil
403 :toc-export nil
405 :body-header-section-numbers nil
421 ;; :body-list-prefix "LISTSTART"
422 ;; :body-list-suffix "LISTEND"
424 ;; this is ignored! [2010/02/02:rpg]
426 )
429 :key-binding ?U
431 ;; lifted from wikipedia exporter
437 :date-export nil
439 :toc-export nil
441 :body-header-section-numbers nil
452 :body-line-wrap nil
458 ;; :body-list-prefix "LISTSTART"
459 ;; :body-list-suffix "LISTEND"
469 )
470 )
471 "A assoc list of property lists to specify export definitions"
472 )
479 ;;;###autoload
481 "Adds a TYPE and DEFINITION to the existing list of defined generic
482 export definitions."
485 ;;; helper functions for org-set-generic-type
488 &key documentation
489 type)
490 "Define KEYWORD as a legitimate element for inclusion in
491 the body of an org-set-generic-type definition."
494 ;; TODO: push the documentation and type information
495 ;; somewhere where it will do us some good.
496 ))
500 inserted in the output for every blank line in the input.
501 The intention is to handle formats where text is flowed, and
502 newlines are interpreted as significant \(e.g., as indicating
503 preformatted text\). A common non-nil value for this keyword
505 :body-line-format that does NOT end with a newline."
508 ;;; fontification keywords
524 )
527 "checks to see if type is already in use, or we're switching parts
528 If we're switching, then insert a potentially previously remembered
529 suffix, and insert the current prefix immediately and then save the
530 suffix a later change time."
540 ;;;###autoload
542 "Export the outline as generic output.
543 If there is an active region, export only the region.
544 The prefix ARG specifies how many levels of the outline should become
545 underlined headlines. The default is 3."
568 opt-plist)))
570 helpstart
577 org-generic-alist))
581 \[ ] the current setting of the org-generic-export-type variable
591 org-generic-alist)
594 r1 r2 ass
596 ;; read in the type to use
614 org-generic-alist))))
631 filesuffix))
635 filename))
651 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
661 region
663 :skip-before-1st-heading
671 :verbatim-multiline t
674 :emph-multiline t
675 :archived-trees
679 ;; export-generic plist variables
724 ;; dynamic variables used heinously in fontification
725 ;; not referenced locally...
735 thetoc toctags have-headings first-heading-pos
736 table-open table-buffer link-buffer link desc desc0 rpl wrap)
754 ;; create local variables for all options, to make sure all called
755 ;; functions get the correct information
759 org-export-plist-vars)
762 org-export-headline-levels))
765 ;; File header
769 :title-prefix
770 :title-format
788 :date-prefix
789 :date-format
792 ;; export the table of contents first
797 :toc-header-prefix
798 :toc-header-format
800 thetoc)
807 ;; This is a headline
811 level-offset)
814 todo
818 org-done-keywords)))
819 ; TODO, not DONE
823 line lines level))))
830 t t txt)))
835 txt))
837 ; include tags but formated
840 txt)
843 toctags
846 export-plist :toc-tags-prefix
850 txt)
864 tocindentchar)
873 txt)
875 toctags)
877 thetoc)
879 ))))
880 lines)
892 ;; Remove the quoted HTML tags.
893 ;; XXX
895 ;; Replace links with the description when possible
896 ;; XXX
907 org-export-code-refs)))
908 t t line))
923 ;;
924 ;; a Headline
925 ;;
930 level-offset))
937 ;;
938 ;; a Table
939 ;;
943 ;; New table starts
945 ;; Accumulate table lines
959 ;;
960 ;; pre-formatted text
961 ;;
969 ;; if the bullet list item is an asterisk, the leading space is /mandatory/
970 ;; [2010/02/02:rpg]
972 ;;
973 ;; plain list item
974 ;; TODO: nested lists
975 ;;
976 ;; first add a line break between any previous paragraph or line item and this
977 ;; one
981 ;; I believe this gets rid of leading whitespace.
984 ;; won't this insert the suffix /before/ the last line of the list?
985 ;; also isn't it spoofed by bulleted lists that have a line skip between the list items
986 ;; unless 'org-empty-line-terminates-plain-lists' is true?
989 ;; deal with checkboxes
993 listchecktodoend)))
996 listcheckdoneend)))
999 listcheckhalfend)))
1000 )
1004 ;;
1005 ;; numbered list item
1006 ;;
1007 ;; TODO: nested lists
1008 ;;
1012 numlistprefix numlistsuffix)
1014 ;; deal with checkboxes
1015 ;; TODO: whoops; leaving the numbers is a problem for ^ matching
1019 listchecktodoend)))
1022 listcheckdoneend)))
1025 listcheckhalfend)))
1026 )
1035 ;; blank line
1039 ;;
1040 ;; body
1041 ;;
1047 ;; XXX: properties? list?
1053 ;; Remove forced line breaks
1058 ;; XXX: was dependent on wrap var which was calculated by???
1065 ;; if we're at a level > 0; insert the closing body level stuff
1079 ;; insert the table of contents
1091 ;; Convert whitespace place holders
1102 ;; remove display and invisible chars
1119 "converts a property specification to a string given types of properties
1121 The EXPORT-PLIST should be defined as the lookup plist.
1122 The PROP should be the property name to search for in it.
1123 LEN is set to the length of multi-characters strings to generate (or 0)
1124 N is the tree depth
1125 REVERSE means to reverse the list if the plist match is a list
1126 "
1128 subtype)
1132 ;; sequence of chars
1135 prefixtype)
1143 subtype
1146 ))
1149 prefixprop formatprop postfixprop
1151 "convert a header to an output string given formatting property names"
1158 ))
1161 "Do extra work for ASCII export"
1162 ;; Put quotes around verbatim text
1170 ;; Remove target markers
1176 "Handle quoted HTML for ASCII export."
1179 ;; We just remove the tags for now.
1181 line)
1184 "Wrap LINE at or before WHERE."
1189 pos didfirst)
1211 "Push out links in the buffer."
1213 ;; We still have links to push out.
1223 link-buffer))
1228 "Insert a new level in a generic export."
1235 char tagstring)
1241 ;; going deeper
1248 ))
1249 ;; going up
1256 ))
1257 ;; same level
1261 )
1262 )
1267 secnums
1274 ;; handle tags and formatting
1280 export-plist
1281 :body-tags-prefix
1282 :body-tags-format
1290 :body-section-header-prefix
1291 :body-section-header-format
1292 :body-section-header-suffix
1293 level))
1300 "Insert the string S centered and underline it with character UNDERLINE."
1310 "Format a table for ascii export."
1314 ;; Table made by table.el - test for spanning
1315 lines
1317 ;; A normal org table
1318 ;; Get rid of hlines at beginning and end
1324 ;; Check if the table has a marking column. If yes remove the
1325 ;; column and the special lines
1327 ;; Get rid of the vertical lines except for grouping
1329 rtn line vl1 start)
1351 vl))
1354 ;;; FIXME: this should probably turn into a defconstant later [2010/05/20:rpg]
1362 "Alist of org format -> formatting variables for fontification.
1363 Each element of the list is a list of three elements.
1364 The first element is the character used as a marker for fontification.
1365 The second element is a variable name, set in org-export-generic. That
1366 variable will be dereferenced to obtain a formatting string to wrap
1367 fontified text with.
1368 The third element decides whether to protect converted text from other
1371 ;;; Cargo-culted from the latex translation. I couldn't figure out how
1372 ;;; to keep the structure since the generic export operates on lines, rather
1373 ;;; than on a buffer as in the latex export, meaning that none of the
1374 ;;; search forward code could be kept. This led me to rewrite the
1375 ;;; whole thing recursively. A huge lose for efficiency (potentially),
1376 ;;; but I couldn't figure out how to make the looping work.
1377 ;;; Worse, it's /doubly/ recursive, because this function calls
1378 ;;; org-export-generic-emph-format, which can call it recursively...
1379 ;;; [2010/05/20:rpg]
1381 "Convert fontification according to generic rules."
1383 ;; The match goes one char after the *string*, except at the end of a line
1385 org-export-generic-emphasis-alist))
1391 ;; now we need to determine whether we have strikethrough or
1392 ;; a list, which is a bit nasty
1396 ;; a list --- skip this match and recurse on the point after the
1397 ;; first emph char...
1407 string))
1410 "Return a string that results from applying the markup indicated by
1411 FORMAT-VARNAME to STRING."
1415 string
1419 string-to-emphasize))))
1424 ;;; org-export-generic.el ends here