| blob | b4efa538fe6b04cb995ea17e9534555f4bd9a3b5 |
1 ;;; ox-ascii.el --- ASCII Back-End for Org Export Engine
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements an ASCII back-end for Org generic exporter.
26 ;; See Org manual for more information.
28 ;;; Code:
36 ;;; Define Back-End
37 ;;
38 ;; The following setting won't allow to modify preferred charset
39 ;; through a buffer keyword or an option item, but, since the property
40 ;; will appear in communication channel nonetheless, it allows to
41 ;; override `org-ascii-charset' variable on the fly by the ext-plist
42 ;; mechanism.
43 ;;
44 ;; We also install a filter for headlines and sections, in order to
45 ;; control blank lines separating them in output string.
98 :menu-entry
119 (:filter-parse-tree org-ascii-filter-paragraph-spacing
120 org-ascii-filter-comment-spacing)
125 \f
126 ;;; User Configurable Variables
129 "Options for exporting Org mode files to ASCII."
134 "Maximum width of exported text.
135 This number includes margin size, as set in
136 `org-ascii-global-margin'."
143 "Width of the left margin, in number of characters."
150 "Width of the inner margin, in number of characters.
151 Inner margin is applied between each headline."
158 "Width of margin used for quoting text, in characters.
159 This margin is applied on both sides of the text."
166 "Width of inline tasks, in number of characters.
167 This number ignores any margin."
174 "Number of blank lines inserted around headlines.
176 This variable can be set to a cons cell. In that case, its car
177 represents the number of blank lines present before headline
178 contents whereas its cdr reflects the number of blank lines after
179 contents.
181 A nil value replicates the number of blank lines found in the
182 original Org buffer at the same place."
193 "Additional indentation width for the first line in a paragraph.
194 If the value is an integer, indent the first line of each
195 paragraph by this width, unless it is located at the beginning of
196 a section, in which case indentation is removed from that line.
197 If it is the symbol `auto' preserve indentation from original
198 document."
207 "Number of white lines between paragraphs.
208 If the value is an integer, add this number of blank lines
209 between contiguous paragraphs. If is it the symbol `auto', keep
210 the same number of blank lines as in the original document."
219 "The charset allowed to represent various elements and objects.
220 Possible values are:
221 `ascii' Only use plain ASCII characters
222 `latin1' Include Latin-1 characters
223 `utf-8' Use all UTF-8 characters"
235 "Characters for underlining headings in ASCII export.
237 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
238 and whose value is a list of characters.
240 For each supported charset, this variable associates a sequence
241 of underline characters. In a sequence, the characters will be
242 used in order for headlines level 1, 2, ... If no character is
243 available for a given level, the headline won't be underlined."
261 "Bullet characters for headlines converted to lists in ASCII export.
263 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
264 and whose value is a list of characters.
266 The first character is used for the first level considered as low
267 level, and so on. If there are more levels than characters given
268 here, the list will be repeated.
270 Note that this variable doesn't affect plain lists
271 representation."
287 "Non-nil means convert links to notes before the next headline.
288 When nil, the link will be exported in place. If the line
289 becomes long in this way, it will be wrapped."
296 "Non-nil means keep all vertical lines in ASCII tables.
297 When nil, vertical lines will be removed except for those needed
298 for column grouping."
305 "Non-nil means widen narrowed columns for export.
306 When nil, narrowed columns will look in ASCII export just like in
314 "Non-nil means table.el tables are turned into ascii-art.
316 It only makes sense when export charset is `utf-8'. It is nil by
317 default since it requires ascii-art-to-unicode.el package. You
318 can download it here:
320 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
327 "When non-nil, place caption string before the element.
328 Otherwise, place it right after it."
335 "Format string used for verbatim text and inline code."
343 "Function called to format a drawer in ASCII.
345 The function must accept three parameters:
347 CONTENTS the contents of the drawer.
348 WIDTH the text width within the drawer.
350 The function should return either the string to be exported or
351 nil to ignore the drawer.
353 The default value simply returns the value of CONTENTS."
360 'org-ascii-format-inlinetask-default
361 "Function called to format an inlinetask in ASCII.
363 The function must accept nine parameters:
364 TODO the todo keyword, as a string
365 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
366 PRIORITY the inlinetask priority, as a string
367 NAME the inlinetask name, as a string.
368 TAGS the inlinetask tags, as a list of strings.
369 CONTENTS the contents of the inlinetask, as a string.
370 WIDTH the width of the inlinetask, as a number.
371 INLINETASK the inlinetask itself.
372 INFO the info channel.
374 The function should return either the string to be exported or
375 nil to ignore the inline task."
382 \f
383 ;;; Internal Functions
385 ;; Internal functions fall into three categories.
387 ;; The first one is about text formatting. The core function is
388 ;; `org-ascii--current-text-width', which determines the current
389 ;; text width allowed to a given element. In other words, it helps
390 ;; keeping each line width within maximum text width defined in
391 ;; `org-ascii-text-width'. Once this information is known,
392 ;; `org-ascii--fill-string', `org-ascii--justify-string',
393 ;; `org-ascii--box-string' and `org-ascii--indent-string' can
394 ;; operate on a given output string.
396 ;; The second category contains functions handling elements listings,
397 ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
398 ;; returns a complete table of contents, `org-ascii--list-listings'
399 ;; returns a list of referenceable src-block elements, and
400 ;; `org-ascii--list-tables' does the same for table elements.
402 ;; The third category includes general helper functions.
403 ;; `org-ascii--build-title' creates the title for a given headline
404 ;; or inlinetask element. `org-ascii--build-caption' returns the
405 ;; caption string associated to a table or a src-block.
406 ;; `org-ascii--describe-links' creates notes about links for
407 ;; insertion at the end of a section. It uses
408 ;; `org-ascii--unique-links' to get the list of links to describe.
409 ;; Eventually, `org-ascii--translate' translates a string according
410 ;; to language and charset specification.
414 "Fill a string with specified text-width and return it.
416 S is the string being filled. TEXT-WIDTH is an integer
417 specifying maximum length of a line. INFO is the plist used as
418 a communication channel.
420 Optional argument JUSTIFY can specify any type of justification
421 among `left', `center', `right' or `full'. A nil value is
422 equivalent to `left'. For a justification that doesn't also fill
423 string, see `org-ascii--justify-string'.
425 Return nil if S isn't a string."
426 ;; Don't fill paragraph when break should be preserved.
439 "Justify string S.
440 TEXT-WIDTH is an integer specifying maximum length of a line.
441 HOW determines the type of justification: it can be `left',
442 `right', `full' or `center'."
447 ;; Disable `adaptive-fill-mode' so it doesn't prevent
448 ;; filling lines matching `adaptive-fill-regexp'.
456 "Indent string S by WIDTH white spaces.
457 Empty lines are not indented."
463 "Return string S with a partial box to its left.
464 INFO is a plist used as a communication channel."
469 ;; Remove last newline character.
473 "Return maximum text width for ELEMENT's contents.
474 INFO is a plist used as a communication channel."
476 ;; Elements with an absolute width: `headline' and `inlinetask'.
482 ;; Elements with a relative width: store maximum text width in
483 ;; TOTAL-WIDTH.
486 ;; Total width is determined by the presence, or not, of an
487 ;; inline task among ELEMENT parents.
491 org-ascii-inlinetask-width
492 ;; No inlinetask: Remove global margin from text width.
494 org-ascii-global-margin
496 ;; Inner margin doesn't apply to text before first
497 ;; headline.
501 ;; Inner margin doesn't apply to contents of
502 ;; low level headlines, since they've got their
503 ;; own indentation mechanism.
505 org-ascii-inner-margin))))))))
507 ;; Each `quote-block', `quote-section' and `verse-block' above
508 ;; narrows text width by twice the standard margin size.
512 count parent)
514 ;; Text width within a plain-list is restricted by
515 ;; indentation of current item. If that's the case,
516 ;; compute it with the help of `:structure' property from
517 ;; parent item, if any.
522 return parent))))
524 ;; Compute indentation offset of the current item,
525 ;; that is the sum of the difference between its
526 ;; indentation and the indentation of the top item in
527 ;; the list and current item bullet's length. Also
528 ;; remove checkbox length, and tag length (for
529 ;; description lists) or bullet length.
543 "Format ELEMENT title and return it.
545 ELEMENT is either an `headline' or `inlinetask' element. INFO is
546 a plist used as a communication channel. TEXT-WIDTH is an
547 integer representing the maximum length of a line.
549 When optional argument UNDERLINE is non-nil, underline title,
550 without the tags, according to `org-ascii-underline'
551 specifications.
553 If optional argument NOTAGS is non-nil, no tags will be added to
554 the title.
556 When optional argument TOC is non-nil, use optional title if
557 possible. It doesn't apply to `inlinetask' elements."
560 ;; Numbering is specific to headlines.
562 ;; All tests passed: build numbering string.
565 'number-to-string
573 info)))
590 first-part
591 ;; Align tags, if any.
597 tags))
598 ;; Maybe underline text, if ELEMENT type is `headline' and an
599 ;; underline character has been defined.
604 org-ascii-underline)))))
609 under-char))))))))
612 "Non-nil when ELEMENT has a caption affiliated keyword.
613 INFO is a plist used as a communication channel. This function
614 is meant to be used as a predicate for `org-export-get-ordinal'."
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 along
623 with its real caption. Return nil when ELEMENT has no affiliated
624 caption keyword."
627 ;; Get sequence number of current src-block among every
628 ;; src-block with a caption.
636 info)))
639 " "
644 "Return a table of contents.
646 INFO is a plist used as a communication channel.
648 Optional argument N, when non-nil, is an integer specifying the
649 depth of the table.
651 Optional argument KEYWORD specifies the TOC keyword, if any, from
652 which the table of contents generation has been initiated."
676 "Return a list of listings.
678 KEYWORD is the keyword that initiated the list of listings
679 generation. INFO is a plist used as a communication channel."
689 ;; Use a counter instead of retrieving ordinal of each
690 ;; src-block.
694 ;; Store initial text so its length can be computed. This is
695 ;; used to properly align caption right to it in case of
696 ;; filling (like contents of a description list item).
702 initial-text " "
706 ;; Use short name in priority, if available.
711 initial-width)))))
715 "Return a list of tables.
717 KEYWORD is the keyword that initiated the list of tables
718 generation. INFO is a plist used as a communication channel."
728 ;; Use a counter instead of retrieving 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).
741 initial-text " "
745 ;; Use short name in priority, if available.
750 initial-width)))))
754 "Return a list of unique link references in ELEMENT.
755 ELEMENT is either a headline element or a section element. INFO
756 is a plist used as a communication channel."
760 ;; Return LINK if it wasn't referenced so far, or nil.
761 ;; Update SEEN links along the way.
764 ;; Normalize description in footprints.
772 ;; Ignore LINK if it hasn't been translated already.
773 ;; It can happen if it is located in an affiliated
774 ;; keyword that was ignored.
779 ;; If at a section, find parent headline, if any, in order to
780 ;; count links that might be in the title.
784 ;; Get all links in HEADLINE.
789 "Return a string describing a list of links.
791 LINKS is a list of link type objects, as returned by
792 `org-ascii--unique-links'. WIDTH is the text width allowed for
793 the output string. INFO is a plist used as a communication
794 channel."
802 ;; Coderefs, radio links and fuzzy links are ignored.
804 ;; Id and custom-id links: Headlines refer to their numbering.
810 "[%s] %s"
811 anchor
818 ;; Do not add a link that cannot be resolved and doesn't have
819 ;; any description: destination is already visible in the
820 ;; paragraph.
826 width info)
831 "Return checkbox string for ITEM or nil.
832 INFO is a plist used as a communication channel."
840 \f
841 ;;; Template
844 "Return document title, as a string.
845 INFO is a plist used as a communication channel."
847 ;; Links in the title will not be resolved later, so we make
848 ;; sure their path is located right after them.
858 ;; There are two types of title blocks depending on the presence
859 ;; of a title to display.
861 ;; Title block without a title. DATE is positioned at the top
862 ;; right of the document, AUTHOR to the top left and EMAIL
863 ;; just below.
867 author
869 ?\s)
870 date
875 email
877 ?\s)
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.
918 "Return complete document string after ASCII conversion.
919 CONTENTS is the transcoded contents string. INFO is a plist
920 holding export options."
924 ;; 1. Document's body.
925 contents
926 ;; 2. Footnote definitions.
929 ;; Insert full links right inside the footnote definition
930 ;; as they have no chance to be inserted later.
946 ;; Distinguish between inline definitions and
947 ;; full-fledged definitions.
951 ;; Full-fledged definition: footnote ID is
952 ;; inserted inside the first parsed paragraph
953 ;; (FIRST), if any, to be sure filling will
954 ;; take it into consideration.
960 ;; Fill paragraph once footnote ID is inserted
961 ;; in order to have a correct length for first
962 ;; line.
965 text-width info))))))
967 org-ascii-global-margin)))
970 "Return complete document string after ASCII conversion.
971 CONTENTS is the transcoded contents string. INFO is a plist
972 holding export options."
974 ;; 1. Build title block.
977 ;; 2. Table of contents.
983 org-ascii-global-margin)
984 ;; 3. Document's body.
985 contents
986 ;; 4. Creator. Ignore `comment' value as there are no comments in
987 ;; ASCII. Justify it to the bottom right.
996 org-ascii-global-margin)))
999 "Translate string S according to specified language and charset.
1000 INFO is a plist used as a communication channel."
1005 \f
1006 ;;; Transcode Functions
1008 ;;;; Bold
1011 "Transcode BOLD from Org to ASCII.
1012 CONTENTS is the text with bold markup. INFO is a plist holding
1013 contextual information."
1017 ;;;; Center Block
1020 "Transcode a CENTER-BLOCK element from Org to ASCII.
1021 CONTENTS holds the contents of the block. INFO is a plist
1022 holding contextual information."
1027 ;;;; Clock
1030 "Transcode a CLOCK object from Org to ASCII.
1031 CONTENTS is nil. INFO is a plist holding contextual
1032 information."
1041 "%2s:%02s"
1045 ;;;; Code
1048 "Return a CODE object from Org to ASCII.
1049 CONTENTS is nil. INFO is a plist holding contextual
1050 information."
1054 ;;;; Drawer
1057 "Transcode a DRAWER element from Org to ASCII.
1058 CONTENTS holds the contents of the block. INFO is a plist
1059 holding contextual information."
1065 ;;;; Dynamic Block
1068 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1069 CONTENTS holds the contents of the block. INFO is a plist
1070 holding contextual information."
1071 contents)
1074 ;;;; Entity
1077 "Transcode an ENTITY object from Org to ASCII.
1078 CONTENTS are the definition itself. INFO is a plist holding
1079 contextual information."
1082 entity))
1085 ;;;; Example Block
1088 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1089 CONTENTS is nil. INFO is a plist holding contextual information."
1094 ;;;; Export Snippet
1097 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1098 CONTENTS is nil. INFO is a plist holding contextual information."
1103 ;;;; Export Block
1106 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1107 CONTENTS is nil. INFO is a plist holding contextual information."
1112 ;;;; Fixed Width
1115 "Transcode a FIXED-WIDTH element from Org to ASCII.
1116 CONTENTS is nil. INFO is a plist holding contextual information."
1122 ;;;; Footnote Definition
1124 ;; Footnote Definitions are ignored. They are compiled at the end of
1125 ;; the document, by `org-ascii-inner-template'.
1128 ;;;; Footnote Reference
1131 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1132 CONTENTS is nil. INFO is a plist holding contextual information."
1136 ;;;; Headline
1139 "Transcode a HEADLINE element from Org to ASCII.
1140 CONTENTS holds the contents of the headline. INFO is a plist
1141 holding contextual information."
1142 ;; Don't export footnote section, which will be handled at the end
1143 ;; of the template.
1147 ;; Blank lines between headline and its contents.
1148 ;; `org-ascii-headline-spacing', when set, overwrites
1149 ;; original buffer's spacing.
1154 ;; Even if HEADLINE has no section, there might be some
1155 ;; links in its title that we shouldn't forget to describe.
1162 ;; Deep subtree: export it as a list item.
1165 ;; Bullet.
1167 org-ascii-bullets))))
1170 " "
1171 ;; Title.
1173 ;; Contents, indented by length of bullet.
1174 pre-blanks
1179 ;; Else: Standard headline.
1186 ;;;; Horizontal Rule
1189 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1190 CONTENTS is nil. INFO is a plist holding contextual
1191 information."
1198 text-width)
1203 ;;;; Inline Src Block
1206 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1207 CONTENTS holds the contents of the item. INFO is a plist holding
1208 contextual information."
1213 ;;;; Inlinetask
1217 "Format an inline task element for ASCII export.
1218 See `org-ascii-format-inlinetask-function' for a description
1219 of the parameters."
1224 ;; Top line, with an additional blank line if not in UTF-8.
1227 ;; Add title. Fill it if wider than inlinetask.
1232 ;; If CONTENTS is not empty, insert it along with
1233 ;; a separator.
1236 ;; Bottom line.
1238 ;; Flush the inlinetask to the right.
1241 org-ascii-inner-margin)
1245 "Transcode an INLINETASK element from Org to ASCII.
1246 CONTENTS holds the contents of the block. INFO is a plist
1247 holding contextual information."
1250 ;; todo.
1255 ;; todo-type
1257 ;; priority
1260 ;; title
1262 ;; tags
1265 ;; contents and width
1266 contents width inlinetask info)))
1269 ;;;; Italic
1272 "Transcode italic from Org to ASCII.
1273 CONTENTS is the text with italic markup. INFO is a plist holding
1274 contextual information."
1278 ;;;; Item
1281 "Transcode an ITEM element from Org to ASCII.
1282 CONTENTS holds the contents of the item. INFO is a plist holding
1283 contextual information."
1288 ;; First parent of ITEM is always the plain-list. Get
1289 ;; `:type' property from it.
1297 ;; Return correct number for ITEM, paying attention to
1298 ;; counters.
1304 struct
1309 ;; Change bullets into more visible form if UTF-8 is active.
1317 bullet
1319 ;; Contents: Pay attention to indentation. Note: check-boxes are
1320 ;; already taken care of at the paragraph level so they don't
1321 ;; interfere with indentation.
1328 ;;;; Keyword
1331 "Transcode a KEYWORD element from Org to ASCII.
1332 CONTENTS is nil. INFO is a plist holding contextual
1333 information."
1353 ;;;; Latex Environment
1356 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1357 CONTENTS is nil. INFO is a plist holding contextual
1358 information."
1363 ;;;; Latex Fragment
1366 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1367 CONTENTS is nil. INFO is a plist holding contextual
1368 information."
1373 ;;;; Line Break
1376 "Transcode a LINE-BREAK object from Org to ASCII.
1377 CONTENTS is nil. INFO is a plist holding contextual
1381 ;;;; Link
1384 "Transcode a LINK object from Org to ASCII.
1386 DESC is the description part of the link, or the empty string.
1387 INFO is a plist holding contextual information."
1395 ;; Do not apply a special syntax on radio links. Though, use
1396 ;; transcoded target's contents as output.
1398 ;; Do not apply a special syntax on fuzzy links pointing to
1399 ;; targets.
1417 ;;;; Paragraph
1420 "Transcode a PARAGRAPH element from Org to ASCII.
1421 CONTENTS is the contents of the paragraph, as a string. INFO is
1422 the plist used as a communication channel."
1426 ;; Do not indent first paragraph in a section.
1435 ;;;; Plain List
1438 "Transcode a PLAIN-LIST element from Org to ASCII.
1439 CONTENTS is the contents of the list. INFO is a plist holding
1440 contextual information."
1441 contents)
1444 ;;;; Plain Text
1447 "Transcode a TEXT string from Org to ASCII.
1448 INFO is a plist used as a communication channel."
1455 ;; Usual replacements in utf-8 with proper option set.
1463 ;;;; Planning
1466 "Transcode a PLANNING element from Org to ASCII.
1467 CONTENTS is nil. INFO is a plist used as a communication
1468 channel."
1470 'identity
1490 ;;;; Quote Block
1493 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1494 CONTENTS holds the contents of the block. INFO is a plist
1495 holding contextual information."
1499 ;;;; Quote Section
1502 "Transcode a QUOTE-SECTION element from Org to ASCII.
1503 CONTENTS is nil. INFO is a plist holding contextual information."
1508 info)))
1510 value
1511 (+ org-ascii-quote-margin
1512 ;; Don't apply inner margin if parent headline is low level.
1515 org-ascii-inner-margin))))))
1518 ;;;; Radio Target
1521 "Transcode a RADIO-TARGET object from Org to ASCII.
1522 CONTENTS is the contents of the target. INFO is a plist holding
1523 contextual information."
1524 contents)
1527 ;;;; Section
1530 "Transcode a SECTION element from Org to ASCII.
1531 CONTENTS is the contents of the section. INFO is a plist holding
1532 contextual information."
1535 contents
1537 ;; Add list of links at the end of SECTION.
1541 ;; Separate list of links and section contents.
1543 ;; Do not apply inner margin if parent headline is low level.
1546 org-ascii-inner-margin))))
1549 ;;;; Special Block
1552 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1553 CONTENTS holds the contents of the block. INFO is a plist
1554 holding contextual information."
1555 contents)
1558 ;;;; Src Block
1561 "Transcode a SRC-BLOCK element from Org to ASCII.
1562 CONTENTS holds the contents of the item. INFO is a plist holding
1563 contextual information."
1574 ;;;; Statistics Cookie
1577 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1578 CONTENTS is nil. INFO is a plist holding contextual information."
1582 ;;;; Subscript
1585 "Transcode a SUBSCRIPT object from Org to ASCII.
1586 CONTENTS is the contents of the object. INFO is a plist holding
1587 contextual information."
1593 ;;;; Superscript
1596 "Transcode a SUPERSCRIPT object from Org to ASCII.
1597 CONTENTS is the contents of the object. INFO is a plist holding
1598 contextual information."
1604 ;;;; Strike-through
1607 "Transcode STRIKE-THROUGH from Org to ASCII.
1608 CONTENTS is text with strike-through markup. INFO is a plist
1609 holding contextual information."
1613 ;;;; Table
1616 "Transcode a TABLE element from Org to ASCII.
1617 CONTENTS is the contents of the table. INFO is a plist holding
1618 contextual information."
1621 ;; Possibly add a caption string above.
1623 ;; Insert table. Note: "table.el" tables are left unmodified.
1637 ;; Possible add a caption string below.
1641 ;;;; Table Cell
1644 "Return width of TABLE-CELL.
1646 INFO is a plist used as a communication channel.
1648 Width of a cell is determined either by a width cookie in the
1649 same column as the cell, or by the maximum cell's length in that
1650 column.
1652 When `org-ascii-table-widen-columns' is non-nil, width cookies
1653 are ignored."
1667 key
1678 info))
1679 max-width)))
1680 info)
1681 max-width))
1682 cache))))
1685 "Transcode a TABLE-CELL object from Org to ASCII.
1686 CONTENTS is the cell contents. INFO is a plist used as
1687 a communication channel."
1688 ;; Determine column width. When `org-ascii-table-widen-columns'
1689 ;; is nil and some width cookie has set it, use that value.
1690 ;; Otherwise, compute the maximum width among transcoded data of
1691 ;; each cell in the column.
1693 ;; When contents are too large, truncate them.
1697 ;; Align contents correctly within the cell.
1702 contents width
1707 ;; Return cell.
1713 ;;;; Table Row
1716 "Transcode a TABLE-ROW element from Org to ASCII.
1717 CONTENTS is the row contents. INFO is a plist used as
1718 a communication channel."
1725 'concat
1731 ;; In order to know if CELL starts the row, do
1732 ;; not compare it with the first cell in the
1733 ;; row as there might be a special column.
1734 ;; Instead, compare it with first exportable
1735 ;; cell, obtained with `org-element-map'.
1739 cell))
1740 lcorner)
1745 rcorner)
1751 info)))
1766 ;;;; Timestamp
1769 "Transcode a TIMESTAMP object from Org to ASCII.
1770 CONTENTS is nil. INFO is a plist holding contextual information."
1774 ;;;; Underline
1777 "Transcode UNDERLINE from Org to ASCII.
1778 CONTENTS is the text with underline markup. INFO is a plist
1779 holding contextual information."
1783 ;;;; Verbatim
1786 "Return a VERBATIM object from Org to ASCII.
1787 CONTENTS is nil. INFO is a plist holding contextual information."
1792 ;;;; Verse Block
1795 "Transcode a VERSE-BLOCK element from Org to ASCII.
1796 CONTENTS is verse block contents. INFO is a plist holding
1797 contextual information."
1801 org-ascii-quote-margin)))
1804 \f
1805 ;;; Filters
1808 "Filter controlling number of blank lines after a headline.
1810 HEADLINE is a string representing a transcoded headline.
1811 BACK-END is symbol specifying back-end used for export. INFO is
1812 plist containing the communication channel.
1814 This function only applies to `ascii' back-end. See
1815 `org-ascii-headline-spacing' for information."
1821 "Filter controlling number of blank lines between paragraphs.
1823 TREE is the parse tree. BACK-END is the symbol specifying
1824 back-end used for export. INFO is a plist used as
1825 a communication channel.
1827 See `org-ascii-paragraph-spacing' for information."
1835 tree)
1838 "Filter removing blank lines between comments.
1839 TREE is the parse tree. BACK-END is the symbol specifying
1840 back-end used for export. INFO is a plist used as
1841 a communication channel."
1847 tree)
1850 \f
1851 ;;; End-user functions
1853 ;;;###autoload
1856 "Export current buffer to a text buffer.
1858 If narrowing is active in the current buffer, only export its
1859 narrowed part.
1861 If a region is active, export that region.
1863 A non-nil optional argument ASYNC means the process should happen
1864 asynchronously. The resulting buffer should be accessible
1865 through the `org-export-stack' interface.
1867 When optional argument SUBTREEP is non-nil, export the sub-tree
1868 at point, extracting information from the headline properties
1869 first.
1871 When optional argument VISIBLE-ONLY is non-nil, don't export
1872 contents of hidden elements.
1874 When optional argument BODY-ONLY is non-nil, strip title and
1875 table of contents from output.
1877 EXT-PLIST, when provided, is a property list with external
1878 parameters overriding Org default settings, but still inferior to
1879 file-local settings.
1882 will be displayed when `org-export-show-temporary-export-buffer'
1883 is non-nil."
1888 ;;;###autoload
1891 "Export current buffer to a text file.
1893 If narrowing is active in the current buffer, only export its
1894 narrowed part.
1896 If a region is active, export that region.
1898 A non-nil optional argument ASYNC means the process should happen
1899 asynchronously. The resulting file should be accessible through
1900 the `org-export-stack' interface.
1902 When optional argument SUBTREEP is non-nil, export the sub-tree
1903 at point, extracting information from the headline properties
1904 first.
1906 When optional argument VISIBLE-ONLY is non-nil, don't export
1907 contents of hidden elements.
1909 When optional argument BODY-ONLY is non-nil, strip title and
1910 table of contents from output.
1912 EXT-PLIST, when provided, is a property list with external
1913 parameters overriding Org default settings, but still inferior to
1914 file-local settings.
1916 Return output file's name."
1920 async subtreep visible-only body-only ext-plist)))
1922 ;;;###autoload
1924 "Publish an Org file to ASCII.
1926 FILENAME is the filename of the Org file to be published. PLIST
1927 is the property list for the given project. PUB-DIR is the
1928 publishing directory.
1930 Return output file name."
1934 ;;;###autoload
1936 "Publish an Org file to Latin-1.
1938 FILENAME is the filename of the Org file to be published. PLIST
1939 is the property list for the given project. PUB-DIR is the
1940 publishing directory.
1942 Return output file name."
1946 ;;;###autoload
1948 "Publish an org file to UTF-8.
1950 FILENAME is the filename of the Org file to be published. PLIST
1951 is the property list for the given project. PUB-DIR is the
1952 publishing directory.
1954 Return output file name."
1961 ;; Local variables:
1962 ;; generated-autoload-file: "org-loaddefs.el"
1963 ;; coding: utf-8-emacs
1964 ;; End:
1966 ;;; ox-ascii.el ends here