| blob | 436badcb8e8d280b2d974f7b5347add7f9c3d0cc |
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:
105 "Options specific for ASCII export of Org-mode files."
110 "Non-nil means convert links to notes before the next headline.
111 When nil, the link will be exported in place. If the line becomes long
112 in this way, it will be wrapped."
120 '(
121 ;;
122 ;; generic DEMO exporter
123 ;;
124 ;; (this tries to use every specifier for demo purposes)
125 ;;
128 :key-binding ?d
133 :author-export t
134 :tags-export t
136 :drawers-export t
143 :date-export t
148 :toc-export t
156 :toc-section-numbers t
160 :toc-indent-char ?\
163 :toc-tags-export t
171 ; lists indicate different things per level
172 ; list contents or straight value can either be a
173 ; ?x char reference for printing strings that match the header len
174 ; "" string to print directly
181 :timestamps-export t
182 :priorities-export t
183 :todo-keywords-export t
185 :body-tags-export t
189 ; section prefixes/suffixes can be direct strings or lists as well
192 ; :body-section-prefix ("<sec1>\n" "<sec2>\n" "<sec3>\n")
193 ; :body-section-suffix ("</sec1>\n" "</sec2>\n" "</sec3>\n")
196 ; if preformated text should be included (eg, : prefixed)
197 :body-line-export-preformated t
210 :body-number-list-leave-number t
222 ; other body lines
226 ; print above and below all body parts
230 )
232 ;;
233 ;; ascii exporter
234 ;;
235 ;; (close to the original ascii specifier)
236 ;;
239 :key-binding ?a
248 :date-export t
257 :toc-export t
258 :toc-section-numbers t
262 :toc-indent-char ?\
268 ; :body-section-header-prefix "\n"
269 ; :body-section-header-format "%s\n"
270 ; :body-section-header-suffix (?\$ ?\# ?^ ?\~ ?\= ?\-)
276 ; :body-section-marker-prefix ""
277 ; :body-section-marker-chars (?\$ ?\# ?^ ?\~ ?\= ?\-)
278 ; :body-section-marker-suffix "\n"
280 :body-line-export-preformated t
284 ; :body-text-prefix "<t>\n"
285 ; :body-text-suffix "</t>\n"
289 ; :body-bullet-list-suffix (?* ?+ ?-)
290 )
292 ;;
293 ;; wikipedia
294 ;;
297 :key-binding ?w
304 :date-export nil
306 :toc-export nil
308 :body-header-section-numbers nil
326 )
327 ;;
328 ;; internet-draft .xml for xml2rfc exporter
329 ;;
331 ;; this tries to use every specifier for demo purposes
333 :key-binding ?i
337 <!ENTITY rfcs PUBLIC '' 'blah'>
345 <front>
346 "
349 <organization>Comany, Inc..</organization>
350 <address>
351 <postal>
352 <street></street>
353 <city></city>
354 <region></region>
355 <code></code>
356 <country></country>
357 </postal>
358 <phone></phone>
359 <email></email>
360 </address>
361 </author>
363 <area>Operations and Management</area>
364 <workgroup>FIXME</workgroup>
366 :date-export nil
368 :toc-export nil
370 :body-header-section-numbers nil
375 ; if preformated text should be included (eg, : prefixed)
376 :body-line-export-preformated t
380 ; other body lines
384 ; print above and below all body parts
392 )
395 :key-binding ?T
397 ;; lifted from wikipedia exporter
403 :date-export nil
405 :toc-export nil
407 :body-header-section-numbers nil
423 ;; :body-list-prefix "LISTSTART"
424 ;; :body-list-suffix "LISTEND"
426 ;; this is ignored! [2010/02/02:rpg]
428 )
431 :key-binding ?U
433 ;; lifted from wikipedia exporter
439 :date-export nil
441 :toc-export nil
443 :body-header-section-numbers nil
454 :body-line-wrap nil
460 ;; :body-list-prefix "LISTSTART"
461 ;; :body-list-suffix "LISTEND"
471 )
472 )
473 "A assoc list of property lists to specify export definitions"
474 )
481 ;;;###autoload
483 "Adds a TYPE and DEFINITION to the existing list of defined generic
484 export definitions."
487 ;;; helper functions for org-set-generic-type
490 &key documentation
491 type)
492 "Define KEYWORD as a legitimate element for inclusion in
493 the body of an org-set-generic-type definition."
496 ;; TODO: push the documentation and type information
497 ;; somewhere where it will do us some good.
498 ))
502 inserted in the output for every blank line in the input.
503 The intention is to handle formats where text is flowed, and
504 newlines are interpreted as significant \(e.g., as indicating
505 preformatted text\). A common non-nil value for this keyword
507 :body-line-format that does NOT end with a newline."
510 ;;; fontification keywords
526 )
529 "checks to see if type is already in use, or we're switching parts
530 If we're switching, then insert a potentially previously remembered
531 suffix, and insert the current prefix immediately and then save the
532 suffix a later change time."
542 ;;;###autoload
544 "Export the outline as generic output.
545 If there is an active region, export only the region.
546 The prefix ARG specifies how many levels of the outline should become
547 underlined headlines. The default is 3."
570 opt-plist)))
572 helpstart
579 org-generic-alist))
583 \[ ] the current setting of the org-generic-export-type variable
593 org-generic-alist)
596 r1 r2 ass
598 ;; read in the type to use
616 org-generic-alist))))
633 filesuffix))
637 filename))
653 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
663 region
665 :skip-before-1st-heading
673 :verbatim-multiline t
676 :emph-multiline t
677 :archived-trees
681 ;; export-generic plist variables
726 ;; dynamic variables used heinously in fontification
727 ;; not referenced locally...
737 thetoc toctags have-headings first-heading-pos
738 table-open table-buffer link-buffer link desc desc0 rpl wrap)
756 ;; create local variables for all options, to make sure all called
757 ;; functions get the correct information
761 org-export-plist-vars)
764 org-export-headline-levels))
767 ;; File header
771 :title-prefix
772 :title-format
790 :date-prefix
791 :date-format
794 ;; export the table of contents first
799 :toc-header-prefix
800 :toc-header-format
802 thetoc)
809 ;; This is a headline
813 level-offset)
816 todo
820 org-done-keywords)))
821 ; TODO, not DONE
825 line lines level))))
832 t t txt)))
837 txt))
839 ; include tags but formated
842 txt)
845 toctags
848 export-plist :toc-tags-prefix
852 txt)
866 tocindentchar)
875 txt)
877 toctags)
879 thetoc)
881 ))))
882 lines)
894 ;; Remove the quoted HTML tags.
895 ;; XXX
897 ;; Replace links with the description when possible
898 ;; XXX
909 org-export-code-refs)))
910 t t line))
925 ;;
926 ;; a Headline
927 ;;
932 level-offset))
939 ;;
940 ;; a Table
941 ;;
945 ;; New table starts
947 ;; Accumulate table lines
961 ;;
962 ;; pre-formatted text
963 ;;
971 ;; if the bullet list item is an asterisk, the leading space is /mandatory/
972 ;; [2010/02/02:rpg]
974 ;;
975 ;; plain list item
976 ;; TODO: nested lists
977 ;;
978 ;; first add a line break between any previous paragraph or line item and this
979 ;; one
983 ;; I believe this gets rid of leading whitespace.
986 ;; won't this insert the suffix /before/ the last line of the list?
987 ;; also isn't it spoofed by bulleted lists that have a line skip between the list items
988 ;; unless 'org-empty-line-terminates-plain-lists' is true?
991 ;; deal with checkboxes
995 listchecktodoend)))
998 listcheckdoneend)))
1001 listcheckhalfend)))
1002 )
1006 ;;
1007 ;; numbered list item
1008 ;;
1009 ;; TODO: nested lists
1010 ;;
1014 numlistprefix numlistsuffix)
1016 ;; deal with checkboxes
1017 ;; TODO: whoops; leaving the numbers is a problem for ^ matching
1021 listchecktodoend)))
1024 listcheckdoneend)))
1027 listcheckhalfend)))
1028 )
1037 ;; blank line
1041 ;;
1042 ;; body
1043 ;;
1049 ;; XXX: properties? list?
1055 ;; Remove forced line breaks
1060 ;; XXX: was dependent on wrap var which was calculated by???
1067 ;; if we're at a level > 0; insert the closing body level stuff
1081 ;; insert the table of contents
1093 ;; Convert whitespace place holders
1104 ;; remove display and invisible chars
1121 "converts a property specification to a string given types of properties
1123 The EXPORT-PLIST should be defined as the lookup plist.
1124 The PROP should be the property name to search for in it.
1125 LEN is set to the length of multi-characters strings to generate (or 0)
1126 N is the tree depth
1127 REVERSE means to reverse the list if the plist match is a list
1128 "
1130 subtype)
1134 ;; sequence of chars
1137 prefixtype)
1145 subtype
1148 ))
1151 prefixprop formatprop postfixprop
1153 "convert a header to an output string given formatting property names"
1160 ))
1163 "Do extra work for ASCII export"
1164 ;; Put quotes around verbatim text
1172 ;; Remove target markers
1178 "Handle quoted HTML for ASCII export."
1181 ;; We just remove the tags for now.
1183 line)
1186 "Wrap LINE at or before WHERE."
1191 pos didfirst)
1213 "Push out links in the buffer."
1215 ;; We still have links to push out.
1225 link-buffer))
1230 "Insert a new level in a generic export."
1237 char tagstring)
1243 ;; going deeper
1250 ))
1251 ;; going up
1258 ))
1259 ;; same level
1263 )
1264 )
1269 secnums
1276 ;; handle tags and formatting
1282 export-plist
1283 :body-tags-prefix
1284 :body-tags-format
1292 :body-section-header-prefix
1293 :body-section-header-format
1294 :body-section-header-suffix
1295 level))
1302 "Insert the string S centered and underline it with character UNDERLINE."
1312 "Format a table for ascii export."
1316 ;; Table made by table.el - test for spanning
1317 lines
1319 ;; A normal org table
1320 ;; Get rid of hlines at beginning and end
1326 ;; Check if the table has a marking column. If yes remove the
1327 ;; column and the special lines
1329 ;; Get rid of the vertical lines except for grouping
1331 rtn line vl1 start)
1353 vl))
1356 ;;; FIXME: this should probably turn into a defconstant later [2010/05/20:rpg]
1364 "Alist of org format -> formatting variables for fontification.
1365 Each element of the list is a list of three elements.
1366 The first element is the character used as a marker for fontification.
1367 The second element is a variable name, set in org-export-generic. That
1368 variable will be dereferenced to obtain a formatting string to wrap
1369 fontified text with.
1370 The third element decides whether to protect converted text from other
1373 ;;; Cargo-culted from the latex translation. I couldn't figure out how
1374 ;;; to keep the structure since the generic export operates on lines, rather
1375 ;;; than on a buffer as in the latex export, meaning that none of the
1376 ;;; search forward code could be kept. This led me to rewrite the
1377 ;;; whole thing recursively. A huge lose for efficiency (potentially),
1378 ;;; but I couldn't figure out how to make the looping work.
1379 ;;; Worse, it's /doubly/ recursive, because this function calls
1380 ;;; org-export-generic-emph-format, which can call it recursively...
1381 ;;; [2010/05/20:rpg]
1383 "Convert fontification according to generic rules."
1385 ;; The match goes one char after the *string*, except at the end of a line
1387 org-export-generic-emphasis-alist))
1393 ;; now we need to determine whether we have strikethrough or
1394 ;; a list, which is a bit nasty
1398 ;; a list --- skip this match and recurse on the point after the
1399 ;; first emph char...
1409 string))
1412 "Return a string that results from applying the markup indicated by
1413 FORMAT-VARNAME to STRING."
1417 string
1421 string-to-emphasize))))
1426 ;;; org-export-generic.el ends here