| blob | dea440e9d41a2668e297a4fef075c20767c1c55a |
1 ;;; org-e-ascii.el --- ASCII Back-End For Org Export Engine
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
23 ;; This library implements an ASCII back-end for Org generic exporter.
25 ;; To test it, run
26 ;;
27 ;; M-: (org-export-to-buffer 'e-ascii "*Test e-ASCII*") RET
28 ;;
29 ;; in an Org mode buffer then switch to that buffer to see the ASCII
30 ;; export. See contrib/lisp/org-export.el for more details on how
31 ;; this exporter works.
33 ;;; Code:
66 org-export-to-file "org-export"
70 \f
71 ;;; Internal Variables
73 ;; The following setting won't allow to modify preferred charset
74 ;; through a buffer keyword or an option item, but, since the property
75 ;; will appear in communication channel nonetheless, it allows to
76 ;; override `org-e-ascii-charset' variable on the fly by the ext-plist
77 ;; mechanism.
79 ;; We also install a filter for headlines and sections, in order to
80 ;; control blank lines separating them in output string.
84 "Alist between ASCII export properties and ways to set them.
85 See `org-export-option-alist' for more information on the
91 "Alist between filters keywords and back-end specific filters.
185 "Dictionary for ASCII back-end.
187 Alist whose car is the string to translate and cdr is an alist
188 whose car is the language string and cdr is a plist whose
189 properties are possible charsets and value the translated term.
194 \f
195 ;;; User Configurable Variables
198 "Options for exporting Org mode files to ASCII."
203 "Maximum width of exported text.
204 This number includes margin size, as set in
205 `org-e-ascii-global-margin'."
210 "Width of the left margin, in number of characters."
215 "Width of the inner margin, in number of characters.
216 Inner margin is applied between each headline."
221 "Width of margin used for quoting text, in characters.
222 This margin is applied on both sides of the text."
227 "Width of inline tasks, in number of characters.
228 This number ignores any margin."
233 "Number of blank lines inserted around headlines.
235 This variable can be set to a cons cell. In that case, its car
236 represents the number of blank lines present before headline
237 contents whereas its cdr reflects the number of blank lines after
238 contents.
240 A nil value replicates the number of blank lines found in the
241 original Org buffer at the same place."
250 "The charset allowed to represent various elements and objects.
251 Possible values are:
252 `ascii' Only use plain ASCII characters
253 `latin1' Include Latin-1 characters
254 `utf-8' Use all UTF-8 characters"
264 "Characters for underlining headings in ASCII export.
266 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
267 and whose value is a list of characters.
269 For each supported charset, this variable associates a sequence
270 of underline characters. In a sequence, the characters will be
271 used in order for headlines level 1, 2, ... If no character is
272 available for a given level, the headline won't be underlined."
288 "Bullet characters for headlines converted to lists in ASCII export.
290 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
291 and whose value is a list of characters.
293 The first character is used for the first level considered as low
294 level, and so on. If there are more levels than characters given
295 here, the list will be repeated.
297 Note that this variable doesn't affect plain lists
298 representation."
312 "Non-nil means convert links to notes before the next headline.
313 When nil, the link will be exported in place. If the line
314 becomes long in this way, it will be wrapped."
319 "Non-nil means keep all vertical lines in ASCII tables.
320 When nil, vertical lines will be removed except for those needed
321 for column grouping."
326 "Non-nil means widen narrowed columns for export.
327 When nil, narrowed columns will look in ASCII export just like in
333 "When non-nil, place caption string before the element.
334 Otherwise, place it right after it."
339 "Format string used for verbatim text and inline code."
344 "Function called to format a drawer in ASCII.
346 The function must accept two parameters:
348 CONTENTS the contents of the drawer.
349 WIDTH the text width within the drawer.
351 The function should return either the string to be exported or
352 nil to ignore the drawer.
354 For example, the variable could be set to the following function
355 in order to mimic default behaviour:
357 \(defun org-e-ascii-format-drawer-default \(name contents width\)
359 contents\)"
364 "Function called to format an inlinetask in ASCII.
366 The function must accept six parameters:
367 TODO the todo keyword, as a string
368 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
369 PRIORITY the inlinetask priority, as a string
370 NAME the inlinetask name, as a string.
371 TAGS the inlinetask tags, as a string.
372 CONTENTS the contents of the inlinetask, as a string.
374 The function should return either the string to be exported or
375 nil to ignore the inline task.
377 For example, the variable could be set to the following function
378 in order to mimic default behaviour:
380 \(defun org-e-ascii-format-inlinetask-default
381 \(todo type priority name tags contents\)
383 \(let* \(\(utf8p \(eq \(plist-get info :ascii-charset\) 'utf-8\)\)
384 \(width org-e-ascii-inlinetask-width\)
385 \(org-e-ascii--indent-string
386 \(concat
387 ;; Top line, with an additional blank line if not in UTF-8.
390 ;; Add title. Fill it if wider than inlinetask.
391 \(let \(\(title \(org-e-ascii--build-title inlinetask info width\)\)\)
392 \(if \(<= \(length title\) width\) title
393 \(org-e-ascii--fill-string title width info\)\)\)
395 ;; If CONTENTS is not empty, insert it along with
396 ;; a separator.
397 \(when \(org-string-nw-p contents\)
399 ;; Bottom line.
400 \(make-string width \(if utf8p ?━ ?_\)\)\)
401 ;; Flush the inlinetask to the right.
402 \(- \(plist-get info :ascii-width\)
403 \(plist-get info :ascii-margin\)
404 \(plist-get info :ascii-inner-margin\)
405 \(org-e-ascii--current-text-width inlinetask info\)\)"
410 \f
411 ;;; Internal Functions
413 ;; Internal functions fall into three categories.
415 ;; The first one is about text formatting. The core function is
416 ;; `org-e-ascii--current-text-width', which determines the current
417 ;; text width allowed to a given element. In other words, it helps
418 ;; keeping each line width within maximum text width defined in
419 ;; `org-e-ascii-text-width'. Once this information is known,
420 ;; `org-e-ascii--fill-string', `org-e-ascii--justify-string',
421 ;; `org-e-ascii--box-string' and `org-e-ascii--indent-string' can
422 ;; operate on a given output string.
424 ;; The second category contains functions handling elements listings,
425 ;; triggered by "#+TOC:" keyword. As such, `org-e-ascii--build-toc'
426 ;; returns a complete table of contents, `org-e-ascii--list-listings'
427 ;; returns a list of referenceable src-block elements, and
428 ;; `org-e-ascii--list-tables' does the same for table elements.
430 ;; The third category includes general helper functions.
431 ;; `org-e-ascii--build-title' creates the title for a given headline
432 ;; or inlinetask element. `org-e-ascii--build-caption' returns the
433 ;; caption string associated to a table or a src-block.
434 ;; `org-e-ascii--describe-links' creates notes about links for
435 ;; insertion at the end of a section. It uses
436 ;; `org-e-ascii--unique-links' to get the list of links to describe.
437 ;; Eventually, `org-e-ascii--translate' reads `org-e-ascii-dictionary'
438 ;; to internationalize output.
442 "Fill a string with specified text-width and return it.
444 S is the string being filled. TEXT-WIDTH is an integer
445 specifying maximum length of a line. INFO is the plist used as
446 a communication channel.
448 Optional argument JUSTIFY can specify any type of justification
449 among `left', `center', `right' or `full'. A nil value is
450 equivalent to `left'. For a justification that doesn't also fill
451 string, see `org-e-ascii--justify-string'.
453 Return nil if S isn't a string."
454 ;; Don't fill paragraph when break should be preserved.
465 "Justify string S.
466 TEXT-WIDTH is an integer specifying maximum length of a line.
467 HOW determines the type of justification: it can be `left',
468 `right', `full' or `center'."
479 "Indent string S by WIDTH white spaces.
480 Empty lines are not indented."
486 "Return string S with a partial box to its left.
487 INFO is a plist used as a communicaton channel."
492 ;; Remove last newline character.
496 "Return maximum text width for ELEMENT's contents.
497 INFO is a plist used as a communication channel."
499 ;; Elements with an absolute width: `headline' and `inlinetask'.
501 ('headline
505 ;; Elements with a relative width: store maximum text width in
506 ;; TOTAL-WIDTH.
509 ;; Total width is determined by the presence, or not, of an
510 ;; inline task among ELEMENT parents.
514 org-e-ascii-inlinetask-width
515 ;; No inlinetask: Remove global margin from text width.
517 org-e-ascii-global-margin
519 ;; Inner margin doesn't apply to text before first
520 ;; headline.
524 ;; Inner margin doesn't apply to contents of
525 ;; low level headlines, since they've got their
526 ;; own indentation mechanism.
528 org-e-ascii-inner-margin))))))))
530 ;; Each `quote-block', `quote-section' and `verse-block' above
531 ;; narrows text width by twice the standard margin size.
535 count parent)
537 ;; Text width within a plain-list is restricted by
538 ;; indentation of current item. If that's the case,
539 ;; compute it with the help of `:structure' property from
540 ;; parent item, if any.
545 return parent))))
547 ;; Compute indentation offset of the current item,
548 ;; that is the sum of the difference between its
549 ;; indentation and the indentation of the top item in
550 ;; the list and current item bullet's length. Also
551 ;; remove tag length (for description lists) or bullet
552 ;; length.
564 "Format ELEMENT title and return it.
566 ELEMENT is either an `headline' or `inlinetask' element. INFO is
567 a plist used as a communication channel. TEXT-WIDTH is an
568 integer representing the maximum length of a line.
570 When optional argument UNDERLINE is non-nil, underline title,
571 without the tags, according to `org-e-ascii-underline'
572 specifications.
574 if optional argument NOTAGS is nil, no tags will be added to the
575 title."
578 ;; Numbering is specific to headlines.
580 ;; All tests passed: build numbering string.
583 #'number-to-string
599 first-part
600 ;; Align tags, if any.
605 tags))
606 ;; Maybe underline text, if ELEMENT type is `headline' and an
607 ;; underline character has been defined.
612 org-e-ascii-underline)))))
618 "Return caption string for ELEMENT, if applicable.
620 INFO is a plist used as a communication channel.
622 The caption string contains the sequence number of ELEMENT if it
623 has a name affiliated keyword, along with the real caption, if
624 any. Return nil when ELEMENT has no affiliated caption or name
625 keyword."
629 ;; Get sequence number of current src-block among every
630 ;; src-block with either a caption or a name.
633 element info nil
642 title-fmt reference
647 "Return a table of contents.
649 INFO is a plist used as a communication channel.
651 Optional argument N, when non-nil, is an integer specifying the
652 depth of the table.
654 Optional argument KEYWORD specifies the TOC keyword, if any, from
655 which the table of contents generation has been initiated."
658 title
677 "Return a list of listings.
679 KEYWORD is the keyword that initiated the list of listings
680 generation. INFO is a plist used as a communication channel."
683 title
690 ;; Use a counter instead of retreiving ordinal of each
691 ;; src-block.
695 ;; Store initial text so its length can be computed. This is
696 ;; used to properly align caption right to it in case of
697 ;; filling (like contents of a description list item).
702 initial-text
708 ;; Use short name in priority, if available.
715 "Return a list of listings.
717 KEYWORD is the keyword that initiated the list of listings
718 generation. INFO is a plist used as a communication channel."
721 title
728 ;; Use a counter instead of retreiving ordinal of each
729 ;; src-block.
733 ;; Store initial text so its length can be computed. This is
734 ;; used to properly align caption right to it in case of
735 ;; filling (like contents of a description list item).
740 initial-text
746 ;; Use short name in priority, if available.
753 "Return a list of unique link references in ELEMENT.
755 ELEMENT is either an headline element or a section element. INFO
756 is a plist used as a communication channel.
758 It covers links that may be found current headline's title, in
759 the following section and in any inlinetask's title there."
763 ;; Return LINK if it wasn't referenced so far, or nil.
764 ;; Update SEEN links along the way.
773 ;; Return a list of all unique links in ELEMENT. ELEMENT
774 ;; may be an headline or an inlinetask element.
781 ;; Retrieve HEADLINE's section, if it exists.
788 ;; Links that may be in HEADLINE's title.
790 ;; Get all links in SECTION.
795 "Return a string describing a list of links.
797 LINKS is a list of link type objects, as returned by
798 `org-e-ascii--unique-links'. WIDTH is the text width allowed for
799 the output string. INFO is a plist used as a communication
800 channel."
808 ;; Coderefs, radio links and fuzzy links are ignored.
810 ;; Id and custom-id links: Headlines refer to their numbering.
816 "[%s] %s"
817 anchor
824 ;; Do not add a link that cannot be resolved and doesn't have
825 ;; any description: destination is already visible in the
826 ;; paragraph.
832 width info)
837 \f
838 ;;; Template
841 "Return document title, as a string.
842 INFO is a plist used as a communication channel."
851 ;; There are two types of title blocks depending on the presence
852 ;; of a title to display.
854 ;; Title block without a title. DATE is positioned at the top
855 ;; right of the document, AUTHOR to the top left and EMAIL
856 ;; just below.
860 author
862 date
867 email
878 ;; Title block with a title. Document's TITLE, along with the
879 ;; AUTHOR and its EMAIL are both overlined and an underlined,
880 ;; centered. Date is just below, also centered.
882 ;; Format TITLE. It may be filled if it is too wide,
883 ;; that is wider than the two thirds of the total width.
906 "Return complete document string after ASCII conversion.
907 CONTENTS is the transcoded contents string. INFO is a plist
908 holding export options."
912 ;; 1. Build title block.
915 ;; 2. Table of contents.
921 ;; 3. Document's body.
922 contents
923 ;; 4. Footnote definitions.
926 ;; Insert full links right inside the footnote definition
927 ;; as they have no chance to be inserted later.
934 title
942 ;; Distinguish between inline definitions and
943 ;; full-fledged definitions.
947 ;; Full-fledged definition: footnote ID is
948 ;; inserted inside the first parsed paragraph
949 ;; (FIRST), if any, to be sure filling will
950 ;; take it into consideration.
956 ;; Fill paragraph once footnote ID is inserted in
957 ;; order to have a correct length for first line.
960 text-width info))))))
962 ;; 5. Creator. Ignore `comment' value as there are no comments in
963 ;; ASCII. Justify it to the bottom right.
970 org-e-ascii-global-margin)))
973 "Translate string S.
975 INFO is a plist used as a communication channel.
977 Translation depends on `:language' property and allowed charset.
978 If no translation in found for a given language and a given
979 charset, fall-back to S."
986 \f
987 ;;; Transcode Functions
989 ;;;; Babel Call
991 ;; Babel Calls are ignored.
994 ;;;; Bold
997 "Transcode BOLD from Org to ASCII.
998 CONTENTS is the text with bold markup. INFO is a plist holding
999 contextual information."
1003 ;;;; Center Block
1006 "Transcode a CENTER-BLOCK element from Org to ASCII.
1007 CONTENTS holds the contents of the block. INFO is a plist
1008 holding contextual information."
1013 ;;;; Clock
1016 "Transcode a CLOCK object from Org to ASCII.
1017 CONTENTS is nil. INFO is a plist holding contextual
1018 information."
1025 "%2s:%02s"
1029 ;;;; Code
1032 "Return a CODE object from Org to ASCII.
1033 CONTENTS is nil. INFO is a plist holding contextual
1034 information."
1038 ;;;; Comment
1040 ;; Comments are ignored.
1043 ;;;; Comment Block
1045 ;; Comment Blocks are ignored.
1048 ;;;; Drawer
1051 "Transcode a DRAWER element from Org to ASCII.
1052 CONTENTS holds the contents of the block. INFO is a plist
1053 holding contextual information."
1058 ;; If there's no user defined function: simply
1059 ;; display contents of the drawer.
1060 contents)))
1063 ;;;; Dynamic Block
1066 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1067 CONTENTS holds the contents of the block. INFO is a plist
1068 holding contextual information. See `org-export-data'."
1069 contents)
1072 ;;;; Entity
1075 "Transcode an ENTITY object from Org to ASCII.
1076 CONTENTS are the definition itself. INFO is a plist holding
1077 contextual information."
1080 entity))
1083 ;;;; Example Block
1086 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1087 CONTENTS is nil. INFO is a plist holding contextual information."
1092 ;;;; Export Snippet
1095 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1096 CONTENTS is nil. INFO is a plist holding contextual information."
1101 ;;;; Export Block
1104 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1105 CONTENTS is nil. INFO is a plist holding contextual information."
1110 ;;;; Fixed Width
1113 "Transcode a FIXED-WIDTH element from Org to ASCII.
1114 CONTENTS is nil. INFO is a plist holding contextual information."
1120 ;;;; Footnote Definition
1122 ;; Footnote Definitions are ignored. They are compiled at the end of
1123 ;; the document, by `org-e-ascii-template'.
1126 ;;;; Footnote Reference
1129 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1130 CONTENTS is nil. INFO is a plist holding contextual information."
1134 ;;;; Headline
1137 "Transcode an HEADLINE element from Org to ASCII.
1138 CONTENTS holds the contents of the headline. INFO is a plist
1139 holding contextual information."
1140 ;; Don't export footnote section, which will be handled at the end
1141 ;; of the template.
1145 ;; Blank lines between headline and its contents.
1146 ;; `org-e-ascii-headline-spacing', when set, overwrites
1147 ;; original buffer's spacing.
1152 ;; Even if HEADLINE has no section, there might be some
1153 ;; links in its title that we shouldn't forget to describe.
1158 ;; Deep subtree: export it as a list item.
1161 ;; Bullet.
1163 org-e-ascii-bullets))))
1166 " "
1167 ;; Title.
1169 ;; Contents, indented by length of bullet.
1170 pre-blanks
1175 ;; Else: Standard headline.
1182 ;;;; Horizontal Rule
1185 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1186 CONTENTS is nil. INFO is a plist holding contextual
1187 information."
1191 "(%s)"
1193 #'identity
1202 ;;;; Inline Babel Call
1204 ;; Inline Babel Calls are ignored.
1207 ;;;; Inline Src Block
1210 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1211 CONTENTS holds the contents of the item. INFO is a plist holding
1212 contextual information."
1217 ;;;; Inlinetask
1220 "Transcode an INLINETASK element from Org to ASCII.
1221 CONTENTS holds the contents of the block. INFO is a plist
1222 holding contextual information."
1233 ;; If `org-e-ascii-format-inlinetask-function' is provided, call it
1234 ;; with appropriate arguments.
1237 todo todo-type priority title tags contents width)
1238 ;; Otherwise, use a default template.
1242 ;; Top line, with an additional blank line if not in UTF-8.
1245 ;; Add title. Fill it if wider than inlinetask.
1250 ;; If CONTENTS is not empty, insert it along with
1251 ;; a separator.
1254 ;; Bottom line.
1256 ;; Flush the inlinetask to the right.
1259 org-e-ascii-inner-margin)
1262 ;;;; Italic
1265 "Transcode italic from Org to ASCII.
1266 CONTENTS is the text with italic markup. INFO is a plist holding
1267 contextual information."
1271 ;;;; Item
1274 "Transcode an ITEM element from Org to ASCII.
1275 CONTENTS holds the contents of the item. INFO is a plist holding
1276 contextual information."
1278 ;; First parent of ITEM is always the plain-list. Get
1279 ;; `:type' property from it.
1286 ;; Return correct number for ITEM, paying attention to
1287 ;; counters.
1294 struct
1299 ;; Change bullets into more visible form if UTF-8 is active.
1307 bullet
1308 ;; Contents: Pay attention to indentation. Note: check-boxes are
1309 ;; already taken care of at the paragraph level so they don't
1310 ;; interfere with indentation.
1317 ;;;; Keyword
1320 "Transcode a KEYWORD element from Org to ASCII.
1321 CONTENTS is nil. INFO is a plist holding contextual
1322 information."
1342 ;;;; Latex Environment
1345 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1346 CONTENTS is nil. INFO is a plist holding contextual
1347 information."
1351 ;;;; Latex Fragment
1354 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1355 CONTENTS is nil. INFO is a plist holding contextual
1356 information."
1360 ;;;; Line Break
1363 "Transcode a LINE-BREAK object from Org to ASCII.
1364 CONTENTS is nil. INFO is a plist holding contextual
1368 ;;;; Link
1371 "Transcode a LINK object from Org to ASCII.
1373 DESC is the description part of the link, or the empty string.
1374 INFO is a plist holding contextual information."
1382 ;; Do not apply a special syntax on radio links. Though, parse
1383 ;; and transcode path to have a proper display of contents.
1389 info))
1390 ;; Do not apply a special syntax on fuzzy links pointing to
1391 ;; targets.
1394 ;; Ignore invisible "#+target: path".
1409 ;;;; Macro
1412 "Transcode a MACRO element from Org to ASCII.
1413 CONTENTS is nil. INFO is a plist holding contextual
1414 information."
1418 ;;;; Paragraph
1421 "Transcode a PARAGRAPH element from Org to ASCII.
1422 CONTENTS is the contents of the paragraph, as a string. INFO is
1423 the plist used as a communication channel."
1426 ;; If PARAGRAPH is the first one in a list element, be sure to
1427 ;; add the check-box in front of it, before any filling. Later,
1428 ;; it would interfere with line width.
1436 contents))
1437 contents))
1441 ;;;; Plain List
1444 "Transcode a PLAIN-LIST element from Org to ASCII.
1445 CONTENTS is the contents of the list. INFO is a plist holding
1446 contextual information."
1447 contents)
1450 ;;;; Plain Text
1453 "Transcode a TEXT string from Org to ASCII.
1454 INFO is a plist used as a communication channel."
1457 text
1458 ;; Usual replacements in utf-8 with proper option set.
1466 ;;;; Planning
1469 "Transcode a PLANNING element from Org to ASCII.
1470 CONTENTS is nil. INFO is a plist used as a communication
1471 channel."
1473 'identity
1487 ;;;; Property Drawer
1488 ;;
1489 ;; Property drawers are ignored.
1492 ;;;; Quote Block
1495 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1496 CONTENTS holds the contents of the block. INFO is a plist
1497 holding contextual information."
1502 org-e-ascii-quote-margin)))
1505 ;;;; Quote Section
1508 "Transcode a QUOTE-SECTION element from Org to ASCII.
1509 CONTENTS is nil. INFO is a plist holding contextual information."
1514 info)))
1516 value
1517 (+ org-e-ascii-quote-margin
1518 ;; Don't apply inner margin if parent headline is low level.
1521 org-e-ascii-inner-margin))))))
1524 ;;;; Radio Target
1527 "Transcode a RADIO-TARGET object from Org to ASCII.
1528 CONTENTS is the contents of the target. INFO is a plist holding
1529 contextual information."
1530 contents)
1532 ;;;; Section
1535 "Transcode a SECTION element from Org to ASCII.
1536 CONTENTS is the contents of the section. INFO is a plist holding
1537 contextual information."
1540 contents
1542 ;; Add list of links at the end of SECTION.
1546 ;; Separate list of links and section contents.
1548 ;; Do not apply inner margin if parent headline is low level.
1551 org-e-ascii-inner-margin))))
1554 ;;;; Special Block
1557 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1558 CONTENTS holds the contents of the block. INFO is a plist
1559 holding contextual information."
1560 contents)
1563 ;;;; Src Block
1566 "Transcode a SRC-BLOCK element from Org to ASCII.
1567 CONTENTS holds the contents of the item. INFO is a plist holding
1568 contextual information."
1577 ;;;; Statistics Cookie
1580 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1581 CONTENTS is nil. INFO is a plist holding contextual information."
1585 ;;;; Subscript
1588 "Transcode a SUBSCRIPT object from Org to ASCII.
1589 CONTENTS is the contents of the object. INFO is a plist holding
1590 contextual information."
1596 ;;;; Superscript
1599 "Transcode a SUPERSCRIPT object from Org to ASCII.
1600 CONTENTS is the contents of the object. INFO is a plist holding
1601 contextual information."
1607 ;;;; Strike-through
1610 "Transcode STRIKE-THROUGH from Org to ASCII.
1611 CONTENTS is text with strike-through markup. INFO is a plist
1612 holding contextual information."
1616 ;;;; Table
1619 "Transcode a TABLE element from Org to ASCII.
1620 CONTENTS is nil. INFO is a plist holding contextual information."
1623 ;; Possibly add a caption string above.
1625 ;; Insert table. Note: "table.el" tables are left unmodified.
1628 ;; Possible add a caption string below.
1633 ;;;; Table Cell
1636 "Return width of TABLE-CELL.
1638 Width of a cell is determined either by a width cookie in the
1639 same column as the cell, or by the length of its contents.
1641 When `org-e-ascii-table-widen-columns' is non-nil, width cookies
1642 are ignored. "
1650 table 'table-row
1659 col))
1661 max-width))))
1662 max-width)))
1665 "Transcode a TABLE-CELL object from Org to ASCII.
1666 CONTENTS is the cell contents. INFO is a plist used as
1667 a communication channel."
1668 ;; Determine column width. When `org-e-ascii-table-widen-columns'
1669 ;; is nil and some width cookie has set it, use that value.
1670 ;; Otherwise, compute the maximum width among transcoded data of
1671 ;; each cell in the column.
1673 ;; When contents are too large, truncate them.
1676 ;; Align contents correctly within the cell.
1681 contents width
1684 ;; Return cell.
1690 ;;;; Table Row
1693 "Transcode a TABLE-ROW element from Org to ASCII.
1694 CONTENTS is the row contents. INFO is a plist used as
1695 a communication channel."
1702 'concat
1704 table-row 'table-cell
1712 cell)))
1717 cell)
1718 rcorner)
1724 info)))
1739 ;;;; Target
1741 ;; Targets are invisible.
1744 ;;;; Timestamp
1747 "Transcode a TIMESTAMP object from Org to ASCII.
1748 CONTENTS is nil. INFO is a plist holding contextual information."
1752 ;;;; Underline
1755 "Transcode UNDERLINE from Org to ASCII.
1756 CONTENTS is the text with underline markup. INFO is a plist
1757 holding contextual information."
1761 ;;;; Verbatim
1764 "Return a VERBATIM object from Org to ASCII.
1765 CONTENTS is nil. INFO is a plist holding contextual information."
1770 ;;;; Verse Block
1773 "Transcode a VERSE-BLOCK element from Org to ASCII.
1774 CONTENTS is verse block contents. INFO is a plist holding
1775 contextual information."
1779 org-e-ascii-quote-margin)))
1781 \f
1782 ;;; Filter
1785 "Filter controlling number of blank lines after an headline.
1787 HEADLINE is a string representing a transcoded headline.
1788 BACK-END is symbol specifying back-end used for export. INFO is
1789 plist containing the communication channel.
1791 This function only applies to `e-ascii' back-end. See
1792 `org-e-ascii-headline-spacing' for information.
1794 For any other back-end, HEADLINE is returned as-is."
1800 \f
1801 ;;; Interactive function
1805 "Export current buffer to a text file.
1807 If narrowing is active in the current buffer, only export its
1808 narrowed part.
1810 If a region is active, export that region.
1812 When optional argument SUBTREEP is non-nil, export the sub-tree
1813 at point, extracting information from the headline properties
1814 first.
1816 When optional argument VISIBLE-ONLY is non-nil, don't export
1817 contents of hidden elements.
1819 When optional argument BODY-ONLY is non-nil, strip title, table
1820 of contents and footnote definitions from output.
1822 EXT-PLIST, when provided, is a property list with external
1823 parameters overriding Org default settings, but still inferior to
1824 file-local settings.
1826 When optional argument PUB-DIR is set, use it as the publishing
1827 directory.
1829 Return output file's name."
1837 ;;; org-e-ascii.el ends here