| blob | b6e3753934ac884833ca630f0423d993d9c16819 |
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:
69 org-export-to-file "org-export"
73 \f
74 ;;; Internal Variables
76 ;; The following setting won't allow to modify preferred charset
77 ;; through a buffer keyword or an option item, but, since the property
78 ;; will appear in communication channel nonetheless, it allows to
79 ;; override `org-e-ascii-charset' variable on the fly by the ext-plist
80 ;; mechanism.
82 ;; We also install a filter for headlines and sections, in order to
83 ;; control blank lines separating them in output string.
87 )
88 "Alist between ASCII export properties and ways to set them.
89 See `org-export-option-alist' for more information on the
95 "Alist between filters keywords and back-end specific filters.
189 "Dictionary for ASCII back-end.
191 Alist whose car is the string to translate and cdr is an alist
192 whose car is the language string and cdr is a plist whose
193 properties are possible charsets and value the translated term.
198 \f
199 ;;; User Configurable Variables
202 "Options for exporting Org mode files to ASCII."
207 "Maximum width of exported text.
208 This number includes margin size, as set in
209 `org-e-ascii-global-margin'."
214 "Width of the left margin, in number of characters."
219 "Width of the inner margin, in number of characters.
220 Inner margin is applied between each headline."
225 "Width of margin used for quoting text, in characters.
226 This margin is applied on both sides of the text."
231 "Width of inline tasks, in number of characters.
232 This number ignores any margin."
237 "Number of blank lines inserted around headlines.
239 This variable can be set to a cons cell. In that case, its car
240 represents the number of blank lines present before headline
241 contents whereas its cdr reflects the number of blank lines after
242 contents.
244 A nil value replicates the number of blank lines found in the
245 original Org buffer at the same place."
254 "The charset allowed to represent various elements and objects.
255 Possible values are:
256 `ascii' Only use plain ASCII characters
257 `latin1' Include Latin-1 characters
258 `utf-8' Use all UTF-8 characters"
268 "Characters for underlining headings in ASCII export.
270 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
271 and whose value is a list of characters.
273 For each supported charset, this variable associates a sequence
274 of underline characters. In a sequence, the characters will be
275 used in order for headlines level 1, 2, ... If no character is
276 available for a given level, the headline won't be underlined."
292 "Bullet characters for headlines converted to lists in ASCII export.
294 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
295 and whose value is a list of characters.
297 The first character is used for the first level considered as low
298 level, and so on. If there are more levels than characters given
299 here, the list will be repeated.
301 Note that this variable doesn't affect plain lists
302 representation."
316 "Non-nil means convert links to notes before the next headline.
317 When nil, the link will be exported in place. If the line
318 becomes long in this way, it will be wrapped."
323 "Non-nil means keep all vertical lines in ASCII tables.
324 When nil, vertical lines will be removed except for those needed
325 for column grouping."
330 "Non-nil means widen narrowed columns for export.
331 When nil, narrowed columns will look in ASCII export just like in
337 "When non-nil, place caption string before the element.
338 Otherwise, place it right after it."
343 "Format string used for verbatim text and inline code."
348 "Function called to format a drawer in ASCII.
350 The function must accept two parameters:
352 CONTENTS the contents of the drawer.
353 WIDTH the text width within the drawer.
355 The function should return either the string to be exported or
356 nil to ignore the drawer.
358 For example, the variable could be set to the following function
359 in order to mimic default behaviour:
361 \(defun org-e-ascii-format-drawer-default \(name contents width\)
363 contents\)"
368 "Function called to format an inlinetask in ASCII.
370 The function must accept six parameters:
371 TODO the todo keyword, as a string
372 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
373 PRIORITY the inlinetask priority, as a string
374 NAME the inlinetask name, as a string.
375 TAGS the inlinetask tags, as a string.
376 CONTENTS the contents of the inlinetask, as a string.
378 The function should return either the string to be exported or
379 nil to ignore the inline task.
381 For example, the variable could be set to the following function
382 in order to mimic default behaviour:
384 \(defun org-e-ascii-format-inlinetask-default
385 \(todo type priority name tags contents\)
387 \(let* \(\(utf8p \(eq \(plist-get info :ascii-charset\) 'utf-8\)\)
388 \(width org-e-ascii-inlinetask-width\)
389 \(org-e-ascii--indent-string
390 \(concat
391 ;; Top line, with an additional blank line if not in UTF-8.
394 ;; Add title. Fill it if wider than inlinetask.
395 \(let \(\(title \(org-e-ascii--build-title inlinetask info width\)\)\)
396 \(if \(<= \(length title\) width\) title
397 \(org-e-ascii--fill-string title width info\)\)\)
399 ;; If CONTENTS is not empty, insert it along with
400 ;; a separator.
401 \(when \(org-string-nw-p contents\)
403 ;; Bottom line.
404 \(make-string width \(if utf8p ?━ ?_\)\)\)
405 ;; Flush the inlinetask to the right.
406 \(- \(plist-get info :ascii-width\)
407 \(plist-get info :ascii-margin\)
408 \(plist-get info :ascii-inner-margin\)
409 \(org-e-ascii--current-text-width inlinetask info\)\)"
414 \f
415 ;;; Internal Functions
417 ;; Internal functions fall into three categories.
419 ;; The first one is about text formatting. The core function is
420 ;; `org-e-ascii--current-text-width', which determines the current
421 ;; text width allowed to a given element. In other words, it helps
422 ;; keeping each line width within maximum text width defined in
423 ;; `org-e-ascii-text-width'. Once this information is known,
424 ;; `org-e-ascii--fill-string', `org-e-ascii--justify-string',
425 ;; `org-e-ascii--box-string' and `org-e-ascii--indent-string' can
426 ;; operate on a given output string.
428 ;; The second category contains functions handling elements listings,
429 ;; triggered by "#+TOC:" keyword. As such, `org-e-ascii--build-toc'
430 ;; returns a complete table of contents, `org-e-ascii--list-listings'
431 ;; returns a list of referenceable src-block elements, and
432 ;; `org-e-ascii--list-tables' does the same for table elements.
434 ;; The third category includes general helper functions.
435 ;; `org-e-ascii--build-title' creates the title for a given headline
436 ;; or inlinetask element. `org-e-ascii--build-caption' returns the
437 ;; caption string associated to a table or a src-block.
438 ;; `org-e-ascii--describe-links' creates notes about links for
439 ;; insertion at the end of a section. It uses
440 ;; `org-e-ascii--unique-links' to get the list of links to describe.
441 ;; Eventually, `org-e-ascii--translate' reads `org-e-ascii-dictionary'
442 ;; to internationalize output.
446 "Fill a string with specified text-width and return it.
448 S is the string being filled. TEXT-WIDTH is an integer
449 specifying maximum length of a line. INFO is the plist used as
450 a communication channel.
452 Optional argument JUSTIFY can specify any type of justification
453 among `left', `center', `right' or `full'. A nil value is
454 equivalent to `left'. For a justification that doesn't also fill
455 string, see `org-e-ascii--justify-string'.
457 Return nil if S isn't a string."
458 ;; Don't fill paragraph when break should be preserved.
469 "Justify string S.
470 TEXT-WIDTH is an integer specifying maximum length of a line.
471 HOW determines the type of justification: it can be `left',
472 `right', `full' or `center'."
483 "Indent string S by WIDTH white spaces.
484 Empty lines are not indented."
490 "Return string S with a partial box to its left.
491 INFO is a plist used as a communicaton channel."
496 ;; Remove last newline character.
500 "Return maximum text width for ELEMENT's contents.
501 INFO is a plist used as a communication channel."
503 ;; Elements with an absolute width: `headline' and `inlinetask'.
505 ('headline
509 ;; Elements with a relative width: store maximum text width in
510 ;; TOTAL-WIDTH.
513 ;; Total width is determined by the presence, or not, of an
514 ;; inline task among ELEMENT parents.
518 org-e-ascii-inlinetask-width
519 ;; No inlinetask: Remove global margin from text width.
521 org-e-ascii-global-margin
523 ;; Inner margin doesn't apply to text before first
524 ;; headline.
528 ;; Inner margin doesn't apply to contents of
529 ;; low level headlines, since they've got their
530 ;; own indentation mechanism.
532 org-e-ascii-inner-margin))))))))
534 ;; Each `quote-block', `quote-section' and `verse-block' above
535 ;; narrows text width by twice the standard margin size.
539 count parent)
541 ;; Text width within a plain-list is restricted by
542 ;; indentation of current item. If that's the case,
543 ;; compute it with the help of `:structure' property from
544 ;; parent item, if any.
549 return parent))))
551 ;; Compute indentation offset of the current item,
552 ;; that is the sum of the difference between its
553 ;; indentation and the indentation of the top item in
554 ;; the list and current item bullet's length. Also
555 ;; remove tag length (for description lists) or bullet
556 ;; length.
568 "Format ELEMENT title and return it.
570 ELEMENT is either an `headline' or `inlinetask' element. INFO is
571 a plist used as a communication channel. TEXT-WIDTH is an
572 integer representing the maximum length of a line.
574 When optional argument UNDERLINE is non-nil, underline title,
575 without the tags, according to `org-e-ascii-underline'
576 specifications.
578 if optional argument NOTAGS is nil, no tags will be added to the
579 title."
582 ;; Numbering is specific to headlines.
584 ;; All tests passed: build numbering string.
587 #'number-to-string
605 first-part
606 ;; Align tags, if any.
611 tags))
612 ;; Maybe underline text, if ELEMENT type is `headline' and an
613 ;; underline character has been defined.
618 org-e-ascii-underline)))))
624 "Return caption string for ELEMENT, if applicable.
626 INFO is a plist used as a communication channel.
628 The caption string contains the sequence number of ELEMENT if it
629 has a name affiliated keyword, along with the real caption, if
630 any. Return nil when ELEMENT has no affiliated caption or name
631 keyword."
635 ;; Get sequence number of current src-block among every
636 ;; src-block with either a caption or a name.
639 element info nil
648 title-fmt reference
654 "Return a table of contents.
656 INFO is a plist used as a communication channel.
658 Optional argument N, when non-nil, is an integer specifying the
659 depth of the table.
661 Optional argument KEYWORD specifies the TOC keyword, if any, from
662 which the table of contents generation has been initiated."
665 title
684 "Return a list of listings.
686 KEYWORD is the keyword that initiated the list of listings
687 generation. INFO is a plist used as a communication channel."
690 title
697 ;; Use a counter instead of retreiving ordinal of each
698 ;; src-block.
702 ;; Store initial text so its length can be computed. This is
703 ;; used to properly align caption right to it in case of
704 ;; filling (like contents of a description list item).
709 initial-text
716 ;; Use short name in priority, if available.
723 "Return a list of listings.
725 KEYWORD is the keyword that initiated the list of listings
726 generation. INFO is a plist used as a communication channel."
729 title
736 ;; Use a counter instead of retreiving ordinal of each
737 ;; src-block.
741 ;; Store initial text so its length can be computed. This is
742 ;; used to properly align caption right to it in case of
743 ;; filling (like contents of a description list item).
748 initial-text
754 ;; Use short name in priority, if available.
762 "Return a list of unique link references in ELEMENT.
764 ELEMENT is either an headline element or a section element. INFO
765 is a plist used as a communication channel.
767 It covers links that may be found current headline's title, in
768 the following section and in any inlinetask's title there."
772 ;; Return LINK if it wasn't referenced so far, or nil.
773 ;; Update SEEN links along the way.
782 ;; Return a list of all unique links in ELEMENT. ELEMENT
783 ;; may be an headline or an inlinetask element.
790 ;; Retrieve HEADLINE's section, if it exists.
797 ;; Links that may be in HEADLINE's title.
799 ;; Get all links in SECTION.
804 "Return a string describing a list of links.
806 LINKS is a list of link type objects, as returned by
807 `org-e-ascii--unique-links'. WIDTH is the text width allowed for
808 the output string. INFO is a plist used as a communication
809 channel."
817 ;; Coderefs, radio links and fuzzy links are ignored.
819 ;; Id and custom-id links: Headlines refer to their numbering.
825 "[%s] %s"
826 anchor
833 ;; Do not add a link that cannot be resolved and doesn't have
834 ;; any description: destination is already visible in the
835 ;; paragraph.
841 width info)
846 \f
847 ;;; Template
850 "Return document title, as a string.
851 INFO is a plist used as a communication channel."
860 ;; There are two types of title blocks depending on the presence
861 ;; of a title to display.
863 ;; Title block without a title. DATE is positioned at the top
864 ;; right of the document, AUTHOR to the top left and EMAIL
865 ;; just below.
869 author
871 date
876 email
887 ;; Title block with a title. Document's TITLE, along with the
888 ;; AUTHOR and its EMAIL are both overlined and an underlined,
889 ;; centered. Date is just below, also centered.
891 ;; Format TITLE. It may be filled if it is too wide,
892 ;; that is wider than the two thirds of the total width.
915 "Return complete document string after ASCII conversion.
916 CONTENTS is the transcoded contents string. INFO is a plist
917 holding export options."
921 ;; 1. Build title block.
924 ;; 2. Table of contents.
930 ;; 3. Document's body.
931 contents
932 ;; 4. Footnote definitions.
935 ;; Insert full links right inside the footnote definition
936 ;; as they have no chance to be inserted later.
943 title
951 ;; Distinguish between inline definitions and
952 ;; full-fledged definitions.
956 ;; Full-fledged definition: footnote ID is
957 ;; inserted inside the first parsed paragraph
958 ;; (FIRST), if any, to be sure filling will
959 ;; take it into consideration.
965 ;; Fill paragraph once footnote ID is inserted in
966 ;; order to have a correct length for first line.
969 text-width info))))))
971 ;; 5. Creator. Ignore `comment' value as there are no comments in
972 ;; ASCII. Justify it to the bottom right.
979 org-e-ascii-global-margin)))
982 "Translate string S.
984 INFO is a plist used as a communication channel.
986 Translation depends on `:language' property and allowed charset.
987 If no translation in found for a given language and a given
988 charset, fall-back to S."
995 \f
996 ;;; Transcode Functions
998 ;;;; Babel Call
1000 ;; Babel Calls are ignored.
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 ;;;; Comment
1015 ;; Comments are ignored.
1018 ;;;; Comment Block
1020 ;; Comment Blocks are ignored.
1023 ;;;; Drawer
1026 "Transcode a DRAWER element from Org to ASCII.
1027 CONTENTS holds the contents of the block. INFO is a plist
1028 holding contextual information."
1033 ;; If there's no user defined function: simply
1034 ;; display contents of the drawer.
1035 contents)))
1038 ;;;; Dynamic Block
1041 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1042 CONTENTS holds the contents of the block. INFO is a plist
1043 holding contextual information. See `org-export-data'."
1044 contents)
1047 ;;;; Emphasis
1050 "Transcode EMPHASIS from Org to ASCII.
1051 CONTENTS is the contents of the emphasized text. INFO is a plist
1052 holding contextual information.."
1054 ;; Leave emphasis markers as-is.
1058 ;;;; Entity
1061 "Transcode an ENTITY object from Org to ASCII.
1062 CONTENTS are the definition itself. INFO is a plist holding
1063 contextual information."
1066 entity))
1069 ;;;; Example Block
1072 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1073 CONTENTS is nil. INFO is a plist holding contextual information."
1078 ;;;; Export Snippet
1081 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1082 CONTENTS is nil. INFO is a plist holding contextual information."
1087 ;;;; Export Block
1090 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1091 CONTENTS is nil. INFO is a plist holding contextual information."
1096 ;;;; Fixed Width
1099 "Transcode a FIXED-WIDTH element from Org to ASCII.
1100 CONTENTS is nil. INFO is a plist holding contextual information."
1106 ;;;; Footnote Definition
1108 ;; Footnote Definitions are ignored. They are compiled at the end of
1109 ;; the document, by `org-e-ascii-template'.
1112 ;;;; Footnote Reference
1115 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1116 CONTENTS is nil. INFO is a plist holding contextual information."
1120 ;;;; Headline
1123 "Transcode an HEADLINE element from Org to ASCII.
1124 CONTENTS holds the contents of the headline. INFO is a plist
1125 holding contextual information."
1126 ;; Don't export footnote section, which will be handled at the end
1127 ;; of the template.
1131 ;; Blank lines between headline and its contents.
1132 ;; `org-e-ascii-headline-spacing', when set, overwrites
1133 ;; original buffer's spacing.
1138 ;; Even if HEADLINE has no section, there might be some
1139 ;; links in its title that we shouldn't forget to describe.
1144 ;; Deep subtree: export it as a list item.
1147 ;; Bullet.
1149 org-e-ascii-bullets))))
1152 " "
1153 ;; Title.
1155 ;; Contents, indented by length of bullet.
1156 pre-blanks
1161 ;; Else: Standard headline.
1168 ;;;; Horizontal Rule
1171 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1172 CONTENTS is nil. INFO is a plist holding contextual
1173 information."
1177 "(%s)"
1179 #'identity
1188 ;;;; Inline Babel Call
1190 ;; Inline Babel Calls are ignored.
1193 ;;;; Inline Src Block
1196 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1197 CONTENTS holds the contents of the item. INFO is a plist holding
1198 contextual information."
1203 ;;;; Inlinetask
1206 "Transcode an INLINETASK element from Org to ASCII.
1207 CONTENTS holds the contents of the block. INFO is a plist
1208 holding contextual information."
1222 ;; If `org-e-ascii-format-inlinetask-function' is provided, call it
1223 ;; with appropriate arguments.
1226 todo todo-type priority title tags contents width)
1227 ;; Otherwise, use a default template.
1231 ;; Top line, with an additional blank line if not in UTF-8.
1234 ;; Add title. Fill it if wider than inlinetask.
1239 ;; If CONTENTS is not empty, insert it along with
1240 ;; a separator.
1243 ;; Bottom line.
1245 ;; Flush the inlinetask to the right.
1248 org-e-ascii-inner-margin)
1252 ;;;; Item
1255 "Transcode an ITEM element from Org to ASCII.
1256 CONTENTS holds the contents of the item. INFO is a plist holding
1257 contextual information."
1259 ;; First parent of ITEM is always the plain-list. Get
1260 ;; `:type' property from it.
1269 ;; Return correct number for ITEM, paying attention to
1270 ;; counters.
1277 struct
1282 ;; Change bullets into more visible form if UTF-8 is active.
1290 bullet
1291 ;; Contents: Pay attention to indentation. Note: check-boxes are
1292 ;; already taken care of at the paragraph level so they don't
1293 ;; interfere with indentation.
1300 ;;;; Keyword
1303 "Transcode a KEYWORD element from Org to ASCII.
1304 CONTENTS is nil. INFO is a plist holding contextual
1305 information."
1325 ;;;; Latex Environment
1328 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1329 CONTENTS is nil. INFO is a plist holding contextual
1330 information."
1334 ;;;; Latex Fragment
1337 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1338 CONTENTS is nil. INFO is a plist holding contextual
1339 information."
1343 ;;;; Line Break
1346 "Transcode a LINE-BREAK object from Org to ASCII.
1347 CONTENTS is nil. INFO is a plist holding contextual
1351 ;;;; Link
1354 "Transcode a LINK object from Org to ASCII.
1356 DESC is the description part of the link, or the empty string.
1357 INFO is a plist holding contextual information."
1365 ;; Do not apply a special syntax on radio links. Though, parse
1366 ;; and transcode path to have a proper display of contents.
1372 info))
1373 ;; Do not apply a special syntax on fuzzy links pointing to
1374 ;; targets.
1377 ;; Ignore invisible "#+target: path".
1392 ;;;; Macro
1395 "Transcode a MACRO element from Org to ASCII.
1396 CONTENTS is nil. INFO is a plist holding contextual
1397 information."
1401 ;;;; Paragraph
1404 "Transcode a PARAGRAPH element from Org to ASCII.
1405 CONTENTS is the contents of the paragraph, as a string. INFO is
1406 the plist used as a communication channel."
1409 ;; If PARAGRAPH is the first one in a list element, be sure to
1410 ;; add the check-box in front of it, before any filling. Later,
1411 ;; it would interfere with line width.
1419 contents))
1420 contents))
1424 ;;;; Plain List
1427 "Transcode a PLAIN-LIST element from Org to ASCII.
1428 CONTENTS is the contents of the list. INFO is a plist holding
1429 contextual information."
1430 contents)
1433 ;;;; Plain Text
1436 "Transcode a TEXT string from Org to ASCII.
1437 INFO is a plist used as a communication channel."
1440 text
1441 ;; Usual replacements in utf-8 with proper option set.
1449 ;;;; Property Drawer
1452 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1453 CONTENTS is nil. INFO is a plist used as a communication
1454 channel."
1455 ;; The property drawer isn't exported but we want separating blank
1456 ;; lines nonetheless.
1460 ;;;; Quote Block
1463 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1464 CONTENTS holds the contents of the block. INFO is a plist
1465 holding contextual information."
1470 org-e-ascii-quote-margin)))
1473 ;;;; Quote Section
1476 "Transcode a QUOTE-SECTION element from Org to ASCII.
1477 CONTENTS is nil. INFO is a plist holding contextual information."
1483 info)))
1485 value
1486 (+ org-e-ascii-quote-margin
1487 ;; Don't apply inner margin if parent headline is low level.
1490 org-e-ascii-inner-margin))))))
1493 ;;;; Radio Target
1496 "Transcode a RADIO-TARGET object from Org to ASCII.
1497 CONTENTS is the contents of the target. INFO is a plist holding
1498 contextual information."
1499 contents)
1501 ;;;; Section
1504 "Transcode a SECTION element from Org to ASCII.
1505 CONTENTS is the contents of the section. INFO is a plist holding
1506 contextual information."
1509 contents
1511 ;; Add list of links at the end of SECTION.
1515 ;; Separate list of links and section contents.
1517 ;; Do not apply inner margin if parent headline is low level.
1520 org-e-ascii-inner-margin))))
1523 ;;;; Special Block
1526 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1527 CONTENTS holds the contents of the block. INFO is a plist
1528 holding contextual information."
1529 contents)
1532 ;;;; Src Block
1535 "Transcode a SRC-BLOCK element from Org to ASCII.
1536 CONTENTS holds the contents of the item. INFO is a plist holding
1537 contextual information."
1546 ;;;; Statistics Cookie
1549 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1550 CONTENTS is nil. INFO is a plist holding contextual information."
1554 ;;;; Subscript
1557 "Transcode a SUBSCRIPT object from Org to ASCII.
1558 CONTENTS is the contents of the object. INFO is a plist holding
1559 contextual information."
1565 ;;;; Superscript
1568 "Transcode a SUPERSCRIPT object from Org to ASCII.
1569 CONTENTS is the contents of the object. INFO is a plist holding
1570 contextual information."
1576 ;;;; Table
1579 "Transcode a TABLE element from Org to ASCII.
1580 CONTENTS is nil. INFO is a plist holding contextual information."
1583 ;; Possibly add a caption string above.
1585 ;; Insert table. Note: "table.el" tables are left unmodified.
1588 ;; Possible add a caption string below.
1593 ;;;; Table Cell
1597 "Return width of TABLE-CELL.
1599 Width of a cell is determined either by a width cookie in the
1600 same column as the cell, or by the length of its contents.
1602 When `org-e-ascii-table-widen-columns' is non-nil, width cookies
1603 are ignored. "
1611 table 'table-row
1618 col)
1619 info))
1620 max-width))))
1621 max-width)))
1624 "Transcode a TABLE-CELL object from Org to ASCII.
1625 CONTENTS is the cell contents. INFO is a plist used as
1626 a communication channel."
1627 ;; Determine column width. When `org-e-ascii-table-widen-columns'
1628 ;; is nil and some width cookie has set it, use that value.
1629 ;; Otherwise, compute the maximum width among transcoded data of
1630 ;; each cell in the column.
1632 ;; When contents are too large, truncate them.
1635 ;; Align contents correctly within the cell.
1640 contents width
1643 ;; Return cell.
1649 ;;;; Table Row
1652 "Transcode a TABLE-ROW element from Org to ASCII.
1653 CONTENTS is the row contents. INFO is a plist used as
1654 a communication channel."
1661 'concat
1663 table-row 'table-cell
1671 cell)))
1676 cell)
1677 rcorner)
1683 info)))
1698 ;;;; Target
1700 ;; Targets are invisible.
1703 ;;;; Time-stamp
1706 "Transcode a TIME-STAMP object from Org to ASCII.
1707 CONTENTS is nil. INFO is a plist holding contextual information."
1708 ;; Return time-stamps as-is.
1712 ;;;; Verbatim
1715 "Return a VERBATIM object from Org to ASCII.
1716 CONTENTS is nil. INFO is a plist holding contextual information."
1721 ;;;; Verse Block
1724 "Transcode a VERSE-BLOCK element from Org to ASCII.
1725 CONTENTS is verse block contents. INFO is a plist holding
1726 contextual information."
1730 org-e-ascii-quote-margin)))
1732 \f
1733 ;;; Filter
1736 "Filter controlling number of blank lines after an headline.
1738 HEADLINE is a string representing a transcoded headline.
1739 BACK-END is symbol specifying back-end used for export. INFO is
1740 plist containing the communication channel.
1742 This function only applies to `e-ascii' back-end. See
1743 `org-e-ascii-headline-spacing' for information.
1745 For any other back-end, HEADLINE is returned as-is."
1751 \f
1752 ;;; Interactive function
1756 "Export current buffer to a text file.
1758 If narrowing is active in the current buffer, only export its
1759 narrowed part.
1761 If a region is active, export that region.
1763 When optional argument SUBTREEP is non-nil, export the sub-tree
1764 at point, extracting information from the headline properties
1765 first.
1767 When optional argument VISIBLE-ONLY is non-nil, don't export
1768 contents of hidden elements.
1770 When optional argument BODY-ONLY is non-nil, strip title, table
1771 of contents and footnote definitions from output.
1773 EXT-PLIST, when provided, is a property list with external
1774 parameters overriding Org default settings, but still inferior to
1775 file-local settings.
1777 When optional argument PUB-DIR is set, use it as the publishing
1778 directory.
1780 Return output file's name."
1788 ;;; org-e-ascii.el ends here