| blob | 4be0a20d2090d3bc45e5f58007ae2baa2edeea8b |
1 ;; org-export-generic.el --- Export frameworg with custom backends
3 ;; Copyright (C) 2009 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 )
326 ;;
327 ;; minimal html exporter
328 ;;
330 ;; simple html output
332 :key-binding ?h
338 :date-export t
341 :toc-export nil
353 ; :body-section-prefix ("<sec1>\n" "<sec2>\n" "<sec3>\n")
354 ; :body-section-suffix ("</sec1>\n" "</sec2>\n" "</sec3>\n")
356 :body-line-export-preformated t
363 ; :body-bullet-list-suffix (?* ?+ ?-)
364 )
366 ;;
367 ;; internet-draft .xml for xml2rfc exporter
368 ;;
370 ;; this tries to use every specifier for demo purposes
372 :key-binding ?i
376 <!ENTITY rfcs PUBLIC '' 'blah'>
384 <front>
385 "
388 <organization>Comany, Inc..</organization>
389 <address>
390 <postal>
391 <street></street>
392 <city></city>
393 <region></region>
394 <code></code>
395 <country></country>
396 </postal>
397 <phone></phone>
398 <email></email>
399 </address>
400 </author>
402 <area>Operations and Management</area>
403 <workgroup>FIXME</workgroup>
405 :date-export nil
407 :toc-export nil
409 :body-header-section-numbers nil
414 ; if preformated text should be included (eg, : prefixed)
415 :body-line-export-preformated t
419 ; other body lines
423 ; print above and below all body parts
431 )
432 )
433 "A assoc list of property lists to specify export definitions"
434 )
441 ;;;###autoload
443 "Adds a TYPE and DEFINITION to the existing list of defined generic
444 export definitions."
447 ;;; helper functions for org-set-generic-type
450 &key documentation
451 type)
452 "Define KEYWORD as a legitimate element for inclusion in
453 the body of an org-set-generic-type definition."
456 ;; TODO: push the documentation and type information
457 ;; somewhere where it will do us some good.
458 ))
462 inserted in the output for every blank line in the input.
463 The intention is to handle formats where text is flowed, and
464 newlines are interpreted as significant \(e.g., as indicating
465 preformatted text\). A common non-nil value for this keyword
467 :body-line-format that does NOT end with a newline."
470 ;;; fontification keywords
486 )
489 "checks to see if type is already in use, or we're switching parts
490 If we're switching, then insert a potentially previously remembered
491 suffix, and insert the current prefix immediately and then save the
492 suffix a later change time."
502 ;;;###autoload
504 "Export the outline as generic output.
505 If there is an active region, export only the region.
506 The prefix ARG specifies how many levels of the outline should become
507 underlined headlines. The default is 3."
530 opt-plist)))
532 helpstart
539 org-generic-alist))
543 \[ ] the current setting of the org-generic-export-type variable
553 org-generic-alist)
556 r1 r2 ass
558 ;; read in the type to use
576 org-generic-alist))))
593 filesuffix))
597 filename))
613 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
622 region
624 :skip-before-1st-heading
632 :verbatim-multiline t
635 :emph-multiline t
636 :archived-trees
640 ;; export-generic plist variables
685 ;; dynamic variables used heinously in fontification
686 ;; not referenced locally...
696 thetoc toctags have-headings first-heading-pos
697 table-open table-buffer link-buffer link desc desc0 rpl wrap)
715 ;; create local variables for all options, to make sure all called
716 ;; functions get the correct information
720 org-export-plist-vars)
723 org-export-headline-levels))
726 ;; File header
730 :title-prefix
731 :title-format
749 :date-prefix
750 :date-format
753 ;; export the table of contents first
758 :toc-header-prefix
759 :toc-header-format
761 thetoc)
768 ;; This is a headline
772 level-offset)
775 todo
779 org-done-keywords)))
780 ; TODO, not DONE
784 line lines level))))
791 t t txt)))
796 txt))
798 ; include tags but formated
801 txt)
804 toctags
807 export-plist :toc-tags-prefix
811 txt)
825 tocindentchar)
834 txt)
836 toctags)
838 thetoc)
840 ))))
841 lines)
853 ;; Remove the quoted HTML tags.
854 ;; XXX
856 ;; Replace links with the description when possible
857 ;; XXX
868 org-export-code-refs)))
869 t t line))
884 ;;
885 ;; a Headline
886 ;;
891 level-offset))
898 ;;
899 ;; a Table
900 ;;
904 ;; New table starts
906 ;; Accumulate table lines
920 ;;
921 ;; pre-formatted text
922 ;;
930 ;; if the bullet list item is an asterisk, the leading space is /mandatory/
931 ;; [2010/02/02:rpg]
933 ;;
934 ;; plain list item
935 ;; TODO: nested lists
936 ;;
937 ;; first add a line break between any previous paragraph or line item and this
938 ;; one
942 ;; I believe this gets rid of leading whitespace.
945 ;; won't this insert the suffix /before/ the last line of the list?
946 ;; also isn't it spoofed by bulleted lists that have a line skip between the list items
947 ;; unless 'org-empty-line-terminates-plain-lists' is true?
950 ;; deal with checkboxes
954 listchecktodoend)))
957 listcheckdoneend)))
960 listcheckhalfend)))
961 )
965 ;;
966 ;; numbered list item
967 ;;
968 ;; TODO: nested lists
969 ;;
973 numlistprefix numlistsuffix)
975 ;; deal with checkboxes
976 ;; TODO: whoops; leaving the numbers is a problem for ^ matching
980 listchecktodoend)))
983 listcheckdoneend)))
986 listcheckhalfend)))
987 )
996 ;; blank line
1000 ;;
1001 ;; body
1002 ;;
1008 ;; XXX: properties? list?
1014 ;; Remove forced line breaks
1019 ;; XXX: was dependent on wrap var which was calculated by???
1026 ;; if we're at a level > 0; insert the closing body level stuff
1040 ;; insert the table of contents
1052 ;; Convert whitespace place holders
1063 ;; remove display and invisible chars
1080 "converts a property specification to a string given types of properties
1082 The EXPORT-PLIST should be defined as the lookup plist.
1083 The PROP should be the property name to search for in it.
1084 LEN is set to the length of multi-characters strings to generate (or 0)
1085 N is the tree depth
1086 REVERSE means to reverse the list if the plist match is a list
1087 "
1089 subtype)
1093 ;; sequence of chars
1096 prefixtype)
1104 subtype
1107 ))
1110 prefixprop formatprop postfixprop
1112 "convert a header to an output string given formatting property names"
1119 ))
1122 "Do extra work for ASCII export"
1123 ;; Put quotes around verbatim text
1131 ;; Remove target markers
1137 "Handle quoted HTML for ASCII export."
1140 ;; We just remove the tags for now.
1142 line)
1145 "Wrap LINE at or before WHERE."
1150 pos didfirst)
1172 "Push out links in the buffer."
1174 ;; We still have links to push out.
1184 link-buffer))
1189 "Insert a new level in a generic export."
1196 char tagstring)
1202 ;; going deeper
1209 ))
1210 ;; going up
1217 ))
1218 ;; same level
1222 )
1223 )
1228 secnums
1235 ;; handle tags and formatting
1241 export-plist
1242 :body-tags-prefix
1243 :body-tags-format
1251 :body-section-header-prefix
1252 :body-section-header-format
1253 :body-section-header-suffix
1254 level))
1261 "Insert the string S centered and underline it with character UNDERLINE."
1271 "Format a table for ascii export."
1275 ;; Table made by table.el - test for spanning
1276 lines
1278 ;; A normal org table
1279 ;; Get rid of hlines at beginning and end
1285 ;; Check if the table has a marking column. If yes remove the
1286 ;; column and the special lines
1288 ;; Get rid of the vertical lines except for grouping
1290 rtn line vl1 start)
1312 vl))
1315 ;;; FIXME: this should probably turn into a defconstant later [2010/05/20:rpg]
1323 "Alist of org format -> formatting variables for fontification.
1324 Each element of the list is a list of three elements.
1325 The first element is the character used as a marker for fontification.
1326 The second element is a variable name, set in org-export-generic. That
1327 variable will be dereferenced to obtain a formatting string to wrap
1328 fontified text with.
1329 The third element decides whether to protect converted text from other
1332 ;;; Cargo-culted from the latex translation. I couldn't figure out how
1333 ;;; to keep the structure since the generic export operates on lines, rather
1334 ;;; than on a buffer as in the latex export, meaning that none of the
1335 ;;; search forward code could be kept. This led me to rewrite the
1336 ;;; whole thing recursively. A huge lose for efficiency (potentially),
1337 ;;; but I couldn't figure out how to make the looping work.
1338 ;;; Worse, it's /doubly/ recursive, because this function calls
1339 ;;; org-export-generic-emph-format, which can call it recursively...
1340 ;;; [2010/05/20:rpg]
1342 "Convert fontification according to generic rules."
1344 ;; The match goes one char after the *string*, except at the end of a line
1346 org-export-generic-emphasis-alist))
1352 ;; now we need to determine whether we have strikethrough or
1353 ;; a list, which is a bit nasty
1357 ;; a list --- skip this match and recurse on the point after the
1358 ;; first emph char...
1368 string))
1371 "Return a string that results from applying the markup indicated by
1372 FORMAT-VARNAME to STRING."
1376 string
1380 string-to-emphasize))))
1385 ;;; org-export-generic.el ends here