| blob | 11c37da4ee6c3ca3cf4b4d28ce9e7e5ec4385e9b |
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 ;;
94 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
95 ;;
96 ;;; Commentary:
102 "Options specific for ASCII export of Org-mode files."
107 "Non-nil means convert links to notes before the next headline.
108 When nil, the link will be exported in place. If the line becomes long
109 in this way, it will be wrapped."
117 '(
118 ;;
119 ;; generic DEMO exporter
120 ;;
121 ;; (this tries to use every specifier for demo purposes)
122 ;;
125 :key-binding ?d
130 :author-export t
131 :tags-export t
133 :drawers-export t
140 :date-export t
145 :toc-export t
153 :toc-section-numbers t
157 :toc-indent-char ?\
160 :toc-tags-export t
168 ; lists indicate different things per level
169 ; list contents or straight value can either be a
170 ; ?x char reference for printing strings that match the header len
171 ; "" string to print directly
178 :timestamps-export t
179 :priorities-export t
180 :todo-keywords-export t
182 :body-tags-export t
186 ; section prefixes/suffixes can be direct strings or lists as well
189 ; :body-section-prefix ("<sec1>\n" "<sec2>\n" "<sec3>\n")
190 ; :body-section-suffix ("</sec1>\n" "</sec2>\n" "</sec3>\n")
193 ; if preformated text should be included (eg, : prefixed)
194 :body-line-export-preformated t
207 :body-number-list-leave-number t
219 ; other body lines
223 ; print above and below all body parts
227 )
229 ;;
230 ;; ascii exporter
231 ;;
232 ;; (close to the original ascii specifier)
233 ;;
236 :key-binding ?a
245 :date-export t
254 :toc-export t
255 :toc-section-numbers t
259 :toc-indent-char ?\
265 ; :body-section-header-prefix "\n"
266 ; :body-section-header-format "%s\n"
267 ; :body-section-header-suffix (?\$ ?\# ?^ ?\~ ?\= ?\-)
273 ; :body-section-marker-prefix ""
274 ; :body-section-marker-chars (?\$ ?\# ?^ ?\~ ?\= ?\-)
275 ; :body-section-marker-suffix "\n"
277 :body-line-export-preformated t
281 ; :body-text-prefix "<t>\n"
282 ; :body-text-suffix "</t>\n"
286 ; :body-bullet-list-suffix (?* ?+ ?-)
287 )
289 ;;
290 ;; wikipedia
291 ;;
294 :key-binding ?w
301 :date-export nil
303 :toc-export nil
305 :body-header-section-numbers nil
323 )
325 ;;
326 ;; minimal html exporter
327 ;;
329 ;; simple html output
331 :key-binding ?h
337 :date-export t
340 :toc-export nil
352 ; :body-section-prefix ("<sec1>\n" "<sec2>\n" "<sec3>\n")
353 ; :body-section-suffix ("</sec1>\n" "</sec2>\n" "</sec3>\n")
355 :body-line-export-preformated t
362 ; :body-bullet-list-suffix (?* ?+ ?-)
363 )
365 ;;
366 ;; internet-draft .xml for xml2rfc exporter
367 ;;
369 ;; this tries to use every specifier for demo purposes
371 :key-binding ?i
375 <!ENTITY rfcs PUBLIC '' 'blah'>
383 <front>
384 "
387 <organization>Comany, Inc..</organization>
388 <address>
389 <postal>
390 <street></street>
391 <city></city>
392 <region></region>
393 <code></code>
394 <country></country>
395 </postal>
396 <phone></phone>
397 <email></email>
398 </address>
399 </author>
401 <area>Operations and Management</area>
402 <workgroup>FIXME</workgroup>
404 :date-export nil
406 :toc-export nil
408 :body-header-section-numbers nil
413 ; if preformated text should be included (eg, : prefixed)
414 :body-line-export-preformated t
418 ; other body lines
422 ; print above and below all body parts
430 )
431 )
432 "A assoc list of property lists to specify export definitions"
433 )
440 ;;;###autoload
442 "Adds a TYPE and DEFINITION to the existing list of defined generic
443 export definitions."
451 )
454 "checks to see if type is already in use, or we're switching parts
455 If we're switching, then insert a potentially previously remembered
456 suffix, and insert the current prefix immediately and then save the
457 suffix a later change time."
467 ;;;###autoload
469 "Export the outline as generic output.
470 If there is an active region, export only the region.
471 The prefix ARG specifies how many levels of the outline should become
472 underlined headlines. The default is 3."
495 opt-plist)))
497 helpstart
504 org-generic-alist))
508 \[ ] the current setting of the org-generic-export-type variable
518 org-generic-alist)
521 r1 r2 ass
523 ;; read in the type to use
541 org-generic-alist))))
558 filesuffix))
562 filename))
578 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
587 region
588 :for-ascii t
589 :skip-before-1st-heading
597 :verbatim-multiline t
600 :archived-trees
604 ;; export-generic plist variables
646 thetoc toctags have-headings first-heading-pos
647 table-open table-buffer link-buffer link desc desc0 rpl wrap)
665 ;; create local variables for all options, to make sure all called
666 ;; functions get the correct information
670 org-export-plist-vars)
673 org-export-headline-levels))
676 ;; File header
680 :title-prefix
681 :title-format
699 :date-prefix
700 :date-format
703 ;; export the table of contents first
708 :toc-header-prefix
709 :toc-header-format
711 thetoc)
718 ;; This is a headline
722 level-offset)
725 todo
729 org-done-keywords)))
730 ; TODO, not DONE
734 line lines level))))
741 t t txt)))
746 txt))
748 ; include tags but formated
751 txt)
754 toctags
757 export-plist :toc-tags-prefix
761 txt)
775 tocindentchar)
784 txt)
786 toctags)
788 thetoc)
790 ))))
791 lines)
803 ;; Remove the quoted HTML tags.
804 ;; XXX
806 ;; Replace links with the description when possible
807 ;; XXX
818 org-export-code-refs)))
819 t t line))
834 ;;
835 ;; a Headline
836 ;;
841 level-offset))
848 ;;
849 ;; a Table
850 ;;
854 ;; New table starts
856 ;; Accumulate table lines
870 ;;
871 ;; pre-formated text
872 ;;
880 ;; if the bullet list item is an asterisk, the leading space is /mandatory/
881 ;; [2010/02/02:rpg]
883 ;;
884 ;; plain list item
885 ;;
886 ;; TODO: nested lists
887 ;;
888 ;; I believe this gets rid of leading whitespace.
891 ;; won't this insert the suffix /before/ the last line of the list?
892 ;; also isn't it spoofed by bulleted lists that have a line skip between the list items
893 ;; unless 'org-empty-line-terminates-plain-lists' is true?
896 ;; deal with checkboxes
900 listchecktodoend)))
903 listcheckdoneend)))
906 listcheckhalfend)))
907 )
911 ;;
912 ;; numbered list item
913 ;;
914 ;; TODO: nested lists
915 ;;
919 numlistprefix numlistsuffix)
921 ;; deal with checkboxes
922 ;; TODO: whoops; leaving the numbers is a problem for ^ matching
926 listchecktodoend)))
929 listcheckdoneend)))
932 listcheckhalfend)))
933 )
937 ;;
938 ;; body
939 ;;
942 ;; XXX: properties? list?
948 ;; Remove forced line breaks
953 ;; XXX: was dependent on wrap var which was calculated by???
960 ;; if we're at a level > 0; insert the closing body level stuff
974 ;; insert the table of contents
986 ;; Convert whitespace place holders
997 ;; remove display and invisible chars
1013 "converts a property specification to a string given types of properties
1015 The EXPORT-PLIST should be defined as the lookup plist.
1016 The PROP should be the property name to search for in it.
1017 LEN is set to the length of multi-characters strings to generate (or 0)
1018 N is the tree depth
1019 REVERSE means to reverse the list if the plist match is a list
1020 "
1022 subtype)
1026 ;; sequence of chars
1029 prefixtype)
1037 subtype
1040 ))
1043 prefixprop formatprop postfixprop
1045 "convert a header to an output string given formatting property names"
1052 ))
1055 "Do extra work for ASCII export"
1056 ;; Put quotes around verbatim text
1064 ;; Remove target markers
1070 "Handle quoted HTML for ASCII export."
1073 ;; We just remove the tags for now.
1075 line)
1078 "Wrap LINE at or before WHERE."
1083 pos didfirst)
1105 "Push out links in the buffer."
1107 ;; We still have links to push out.
1117 link-buffer))
1122 "Insert a new level in a generic export."
1129 char tagstring)
1135 ;; going deeper
1142 ))
1143 ;; going up
1150 ))
1151 ;; same level
1155 )
1156 )
1161 secnums
1168 ;; handle tags and formatting
1174 export-plist
1175 :body-tags-prefix
1176 :body-tags-format
1184 :body-section-header-prefix
1185 :body-section-header-format
1186 :body-section-header-suffix
1187 level))
1194 "Insert the string S centered and underline it with character UNDERLINE."
1204 "Format a table for ascii export."
1208 ;; Table made by table.el - test for spanning
1209 lines
1211 ;; A normal org table
1212 ;; Get rid of hlines at beginning and end
1218 ;; Check if the table has a marking column. If yes remove the
1219 ;; column and the special lines
1221 ;; Get rid of the vertical lines except for grouping
1223 rtn line vl1 start)
1245 vl))
1250 ;;; org-export-generic.el ends here