| blob | 61c231b4461af23766d4608eace398a10facd77b |
1 ;;; ox-ascii.el --- ASCII Back-End for Org Export Engine -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2017 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 <https://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 modifying preferred charset
39 ;; through a buffer keyword or an option item, but, since the property
40 ;; will appear in communication channel nonetheless, it allows
41 ;; overriding `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.
96 :menu-entry
117 (:filter-parse-tree org-ascii-filter-paragraph-spacing
118 org-ascii-filter-comment-spacing)
120 :options-alist
127 (:ascii-format-inlinetask-function
128 nil nil org-ascii-format-inlinetask-function)
137 (:ascii-table-keep-all-vertical-lines
138 nil nil org-ascii-table-keep-all-vertical-lines)
146 \f
147 ;;; User Configurable Variables
150 "Options for exporting Org mode files to ASCII."
155 "Maximum width of exported text.
156 This number includes margin size, as set in
157 `org-ascii-global-margin'."
164 "Width of the left margin, in number of characters."
171 "Width of the inner margin, in number of characters.
172 Inner margin is applied between each headline."
179 "Width of margin used for quoting text, in characters.
180 This margin is applied on both sides of the text. It is also
181 applied on the left side of contents in descriptive lists."
188 "Width of margin used for plain lists, in characters.
189 This margin applies to top level list only, not to its
190 sub-lists."
197 "Width of inline tasks, in number of characters.
198 This number ignores any margin."
205 "Number of blank lines inserted around headlines.
207 This variable can be set to a cons cell. In that case, its car
208 represents the number of blank lines present before headline
209 contents whereas its cdr reflects the number of blank lines after
210 contents.
212 A nil value replicates the number of blank lines found in the
213 original Org buffer at the same place."
224 "Additional indentation width for the first line in a paragraph.
225 If the value is an integer, indent the first line of each
226 paragraph by this width, unless it is located at the beginning of
227 a section, in which case indentation is removed from that line.
228 If it is the symbol `auto' preserve indentation from original
229 document."
238 "Number of white lines between paragraphs.
239 If the value is an integer, add this number of blank lines
240 between contiguous paragraphs. If is it the symbol `auto', keep
241 the same number of blank lines as in the original document."
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"
266 "Characters for underlining headings in ASCII export.
268 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
269 and whose value is a list of characters.
271 For each supported charset, this variable associates a sequence
272 of underline characters. In a sequence, the characters will be
273 used in order for headlines level 1, 2, ... If no character is
274 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."
318 "Non-nil means convert links to notes before the next headline.
319 When nil, the link will be exported in place. If the line
320 becomes long in this way, it will be wrapped."
327 "Non-nil means keep all vertical lines in ASCII tables.
328 When nil, vertical lines will be removed except for those needed
329 for column grouping."
336 "Non-nil means widen narrowed columns for export.
337 When nil, narrowed columns will look in ASCII export just like in
346 It only makes sense when export charset is `utf-8'. It is nil by
348 available through, e.g., GNU ELPA."
355 "When non-nil, place caption string before the element.
356 Otherwise, place it right after it."
363 "Format string used for verbatim text and inline code."
371 "Function called to format a drawer in ASCII.
373 The function must accept three parameters:
375 CONTENTS the contents of the drawer.
376 WIDTH the text width within the drawer.
378 The function should return either the string to be exported or
379 nil to ignore the drawer.
381 The default value simply returns the value of CONTENTS."
388 'org-ascii-format-inlinetask-default
389 "Function called to format an inlinetask in ASCII.
391 The function must accept nine parameters:
392 TODO the todo keyword, as a string
393 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
394 PRIORITY the inlinetask priority, as a string
395 NAME the inlinetask name, as a string.
396 TAGS the inlinetask tags, as a list of strings.
397 CONTENTS the contents of the inlinetask, as a string.
398 WIDTH the width of the inlinetask, as a number.
399 INLINETASK the inlinetask itself.
400 INFO the info channel.
402 The function should return either the string to be exported or
403 nil to ignore the inline task."
410 \f
411 ;;; Internal Functions
413 ;; Internal functions fall into three categories.
415 ;; The first one is about text formatting. The core functions are
416 ;; `org-ascii--current-text-width' and
417 ;; `org-ascii--current-justification', which determine, respectively,
418 ;; the current text width allowed to a given element and its expected
419 ;; justification. Once this information is known,
420 ;; `org-ascii--fill-string', `org-ascii--justify-lines',
421 ;; `org-ascii--justify-element' `org-ascii--box-string' and
422 ;; `org-ascii--indent-string' can operate on a given output string.
423 ;; In particular, justification happens at the regular (i.e.,
424 ;; non-greater) element level, which means that when the exporting
425 ;; process reaches a container (e.g., a center block) content are
426 ;; already justified.
428 ;; The second category contains functions handling elements listings,
429 ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
430 ;; returns a complete table of contents, `org-ascii--list-listings'
431 ;; returns a list of referenceable src-block elements, and
432 ;; `org-ascii--list-tables' does the same for table elements.
434 ;; The third category includes general helper functions.
435 ;; `org-ascii--build-title' creates the title for a given headline
436 ;; or inlinetask element. `org-ascii--build-caption' returns the
437 ;; caption string associated to a table or a src-block.
438 ;; `org-ascii--describe-links' creates notes about links for
439 ;; insertion at the end of a section. It uses
440 ;; `org-ascii--unique-links' to get the list of links to describe.
441 ;; Eventually, `org-ascii--translate' translates a string according
442 ;; to language and charset specification.
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-ascii--justify-lines' and
456 `org-ascii--justify-block'.
458 Return nil if S isn't a string."
467 s))
472 "Justify all lines in string S.
473 TEXT-WIDTH is an integer specifying maximum length of a line.
474 HOW determines the type of justification: it can be `left',
475 `right', `full' or `center'."
480 ;; Disable `adaptive-fill-mode' so it doesn't prevent
481 ;; filling lines matching `adaptive-fill-regexp'.
489 "Justify CONTENTS of ELEMENT.
490 INFO is a plist used as a communication channel. Justification
491 is done according to the type of element. More accurately,
492 paragraphs are filled and other elements are justified as blocks,
493 that is according to the widest non blank line in CONTENTS."
499 ;; Paragraphs are treated specially as they need to be filled.
507 ;; Compute maximum width. Bail out if it is greater
508 ;; than page width, since no justification is
509 ;; possible.
519 ;; Justify every line according to TEXT-WIDTH and
520 ;; MAX-WIDTH.
531 "Indent string S by WIDTH white spaces.
532 Empty lines are not indented."
538 "Return string S with a partial box to its left.
539 INFO is a plist used as a communication channel."
544 ;; Remove last newline character.
548 "Return maximum text width for ELEMENT's contents.
549 INFO is a plist used as a communication channel."
551 ;; Elements with an absolute width: `headline' and `inlinetask'.
553 (`headline
558 ;; Elements with a relative width: store maximum text width in
559 ;; TOTAL-WIDTH.
562 ;; Total width is determined by the presence, or not, of an
563 ;; inline task among ELEMENT parents.
567 genealogy)
569 ;; No inlinetask: Remove global margin from text width.
573 ;; Inner margin doesn't apply to text before first
574 ;; headline.
578 ;; Inner margin doesn't apply to contents of
579 ;; low level headlines, since they've got their
580 ;; own indentation mechanism.
584 ;; Each `quote-block' and `verse-block' above narrows text
585 ;; width by twice the standard margin size.
589 genealogy)
590 2
592 ;; Apply list margin once per "top-level" plain-list
593 ;; containing current line
599 genealogy)
601 ;; Compute indentation offset due to current list. It is
602 ;; `org-ascii-quote-margin' per descriptive item in the
603 ;; genealogy, bullet's length otherwise.
617 indentation)))))))
620 "Return expected justification for ELEMENT's contents.
621 Return value is a symbol among `left', `center', `right' and
622 `full'."
628 (`special-block
636 "Format ELEMENT title and return it.
638 ELEMENT is either an `headline' or `inlinetask' element. INFO is
639 a plist used as a communication channel. TEXT-WIDTH is an
640 integer representing the maximum length of a line.
642 When optional argument UNDERLINE is non-nil, underline title,
643 without the tags, according to `org-ascii-underline'
644 specifications.
646 If optional argument NOTAGS is non-nil, no tags will be added to
647 the title.
649 When optional argument TOC is non-nil, use optional title if
650 possible. It doesn't apply to `inlinetask' elements."
653 ;; Numbering is specific to headlines.
665 info)))
682 first-part
683 ;; Align tags, if any.
689 tags))
690 ;; Maybe underline text, if ELEMENT type is `headline' and an
691 ;; underline character has been defined.
701 under-char))))))))
704 "Non-nil when ELEMENT has a caption affiliated keyword.
705 INFO is a plist used as a communication channel. This function
706 is meant to be used as a predicate for `org-export-get-ordinal'."
710 "Return caption string for ELEMENT, if applicable.
712 INFO is a plist used as a communication channel.
714 The caption string contains the sequence number of ELEMENT along
715 with its real caption. Return nil when ELEMENT has no affiliated
716 caption keyword."
719 ;; Get sequence number of current src-block among every
720 ;; src-block with a caption.
728 info)))
731 " "
736 "Return a table of contents.
738 INFO is a plist used as a communication channel.
740 Optional argument N, when non-nil, is an integer specifying the
741 depth of the table.
743 Optional argument KEYWORD specifies the TOC keyword, if any, from
744 which the table of contents generation has been initiated.
746 When optional argument LOCAL is non-nil, build a table of
747 contents according to the current headline."
774 "Return a list of listings.
776 KEYWORD is the keyword that initiated the list of listings
777 generation. INFO is a plist used as a communication channel."
788 ;; Use a counter instead of retrieving ordinal of each
789 ;; src-block.
793 ;; Store initial text so its length can be computed. This is
794 ;; used to properly align caption right to it in case of
795 ;; filling (like contents of a description list item).
801 initial-text " "
805 ;; Use short name in priority, if available.
810 initial-width)))))
814 "Return a list of tables.
816 KEYWORD is the keyword that initiated the list of tables
817 generation. INFO is a plist used as a communication channel."
828 ;; Use a counter instead of retrieving ordinal of each
829 ;; src-block.
833 ;; Store initial text so its length can be computed. This is
834 ;; used to properly align caption right to it in case of
835 ;; filling (like contents of a description list item).
841 initial-text " "
845 ;; Use short name in priority, if available.
850 initial-width)))))
854 "Return a list of unique link references in ELEMENT.
855 ELEMENT is either a headline element or a section element. INFO
856 is a plist used as a communication channel."
859 ;; Return LINK if it wasn't referenced so far, or nil.
860 ;; Update SEEN links along the way.
863 ;; Normalize description in footprints.
871 ;; Ignore LINK if it hasn't been translated already. It
872 ;; can happen if it is located in an affiliated keyword
873 ;; that was ignored.
879 element
880 ;; In a headline, only retrieve links in title
881 ;; and relative section, not in children.
887 "Describe DATUM object or element.
888 If DATUM is a string, consider it to be a file name, per
889 `org-export-resolve-id-link'. INFO is the communication channel,
890 as a plist."
893 (`headline
903 ;; If destination is a target, make sure we can name the
904 ;; container it refers to.
909 (`headline
917 (`paragraph
919 (`src-block
921 (`table
926 "Return a string describing a list of links.
927 LINKS is a list of link type objects, as returned by
928 `org-ascii--unique-links'. WIDTH is the text width allowed for
929 the output string. INFO is a plist used as a communication
930 channel."
937 info)))
941 ;; Only links with a description need an entry. Other are
942 ;; already handled in `org-ascii-link'.
950 width info)
952 ;; Do not add a link that cannot be resolved and doesn't have
953 ;; any description: destination is already visible in the
954 ;; paragraph.
956 ;; Do not add a link already handled by custom export
957 ;; functions.
963 width info)
968 "Return checkbox string for ITEM or nil.
969 INFO is a plist used as a communication channel."
977 \f
978 ;;; Template
981 "Return document title, as a string.
982 INFO is a plist used as a communication channel."
984 ;; Links in the title will not be resolved later, so we make
985 ;; sure their path is located right after them.
999 ;; There are two types of title blocks depending on the presence
1000 ;; of a title to display.
1002 ;; Title block without a title. DATE is positioned at the top
1003 ;; right of the document, AUTHOR to the top left and EMAIL
1004 ;; just below.
1008 author
1010 ?\s)
1011 date
1016 email
1018 ?\s)
1028 ;; Title block with a title. Document's TITLE, along with the
1029 ;; AUTHOR and its EMAIL are both overlined and an underlined,
1030 ;; centered. Date is just below, also centered.
1032 ;; Format TITLE. It may be filled if it is too wide,
1033 ;; that is wider than the two thirds of the total width.
1064 "Return complete document string after ASCII conversion.
1065 CONTENTS is the transcoded contents string. INFO is a plist
1066 holding export options."
1071 ;; 1. Document's body.
1072 contents
1073 ;; 2. Footnote definitions.
1075 ;; Insert full links right inside the footnote definition
1076 ;; as they have no chance to be inserted later.
1089 global-margin)))
1093 ;; Distinguish between inline definitions and
1094 ;; full-fledged definitions.
1099 ;; Full-fledged definition: footnote ID is
1100 ;; inserted inside the first parsed
1101 ;; paragraph (FIRST), if any, to be sure
1102 ;; filling will take it into consideration.
1108 ;; Fill paragraph once footnote ID is inserted
1109 ;; in order to have a correct length for first
1110 ;; line.
1113 text-width info))))))
1115 global-margin))))
1118 "Return complete document string after ASCII conversion.
1119 CONTENTS is the transcoded contents string. INFO is a plist
1120 holding export options."
1123 ;; Build title block.
1126 ;; 2. Table of contents.
1132 global-margin)
1133 ;; Document's body.
1134 contents
1135 ;; Creator. Justify it to the bottom right.
1144 global-margin)))))
1147 "Translate string S according to specified language and charset.
1148 INFO is a plist used as a communication channel."
1153 \f
1154 ;;; Transcode Functions
1156 ;;;; Bold
1159 "Transcode BOLD from Org to ASCII.
1160 CONTENTS is the text with bold markup. INFO is a plist holding
1161 contextual information."
1165 ;;;; Center Block
1168 "Transcode a CENTER-BLOCK element from Org to ASCII.
1169 CONTENTS holds the contents of the block. INFO is a plist
1170 holding contextual information."
1171 ;; Center has already been taken care of at a lower level, so
1172 ;; there's nothing left to do.
1173 contents)
1176 ;;;; Clock
1179 "Transcode a CLOCK object from Org to ASCII.
1180 CONTENTS is nil. INFO is a plist holding contextual
1181 information."
1189 "%2s:%02s"
1191 clock info))
1194 ;;;; Code
1197 "Return a CODE object from Org to ASCII.
1198 CONTENTS is nil. INFO is a plist holding contextual
1199 information."
1204 ;;;; Drawer
1207 "Transcode a DRAWER element from Org to ASCII.
1208 CONTENTS holds the contents of the block. INFO is a plist
1209 holding contextual information."
1213 name contents width)))
1216 ;;;; Dynamic Block
1219 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1220 CONTENTS holds the contents of the block. INFO is a plist
1221 holding contextual information."
1222 contents)
1225 ;;;; Entity
1228 "Transcode an ENTITY object from Org to ASCII.
1229 CONTENTS are the definition itself. INFO is a plist holding
1230 contextual information."
1233 entity))
1236 ;;;; Example Block
1239 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1240 CONTENTS is nil. INFO is a plist holding contextual information."
1244 example-block info))
1247 ;;;; Export Snippet
1250 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1251 CONTENTS is nil. INFO is a plist holding contextual information."
1256 ;;;; Export Block
1259 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1260 CONTENTS is nil. INFO is a plist holding contextual information."
1266 ;;;; Fixed Width
1269 "Transcode a FIXED-WIDTH element from Org to ASCII.
1270 CONTENTS is nil. INFO is a plist holding contextual information."
1275 fixed-width info))
1278 ;;;; Footnote Definition
1280 ;; Footnote Definitions are ignored. They are compiled at the end of
1281 ;; the document, by `org-ascii-inner-template'.
1284 ;;;; Footnote Reference
1287 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1288 CONTENTS is nil. INFO is a plist holding contextual information."
1292 ;;;; Headline
1295 "Transcode a HEADLINE element from Org to ASCII.
1296 CONTENTS holds the contents of the headline. INFO is a plist
1297 holding contextual information."
1298 ;; Don't export footnote section, which will be handled at the end
1299 ;; of the template.
1303 ;; Export title early so that any link in it can be
1304 ;; exported and seen in `org-ascii--unique-links'.
1306 ;; Blank lines between headline and its contents.
1307 ;; `org-ascii-headline-spacing', when set, overwrites
1308 ;; original buffer's spacing.
1317 ;; Re-build contents, inserting section links at the right
1318 ;; place. The cost is low since build results are cached.
1324 first))))
1329 links
1333 ;; Deep subtree: export it as a list item.
1341 ;; Contents, indented by length of bullet.
1343 ;; Else: Standard headline.
1347 ;;;; Horizontal Rule
1350 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1351 CONTENTS is nil. INFO is a plist holding contextual
1352 information."
1359 text-width)
1364 ;;;; Inline Src Block
1367 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1368 CONTENTS holds the contents of the item. INFO is a plist holding
1369 contextual information."
1374 ;;;; Inlinetask
1378 "Format an inline task element for ASCII export.
1379 See `org-ascii-format-inlinetask-function' for a description
1380 of the parameters."
1385 ;; Top line, with an additional blank line if not in UTF-8.
1388 ;; Add title. Fill it if wider than inlinetask.
1393 ;; If CONTENTS is not empty, insert it along with
1394 ;; a separator.
1397 ;; Bottom line.
1399 ;; Flush the inlinetask to the right.
1406 "Transcode an INLINETASK element from Org to ASCII.
1407 CONTENTS holds the contents of the block. INFO is a plist
1408 holding contextual information."
1411 ;; todo.
1416 ;; todo-type
1418 ;; priority
1421 ;; title
1423 ;; tags
1426 ;; contents and width
1427 contents width inlinetask info)))
1430 ;;;; Italic
1433 "Transcode italic from Org to ASCII.
1434 CONTENTS is the text with italic markup. INFO is a plist holding
1435 contextual information."
1439 ;;;; Item
1442 "Transcode an ITEM element from Org to ASCII.
1443 CONTENTS holds the contents of the item. INFO is a plist holding
1444 contextual information."
1449 ;; First parent of ITEM is always the plain-list. Get
1450 ;; `:type' property from it.
1452 (`descriptive
1455 info)))
1456 (`ordered
1457 ;; Return correct number for ITEM, paying attention to
1458 ;; counters.
1465 struct
1471 ;; Change bullets into more visible form if UTF-8 is active.
1481 bullet
1482 checkbox
1483 ;; Contents: Pay attention to indentation. Note: check-boxes are
1484 ;; already taken care of at the paragraph level so they don't
1485 ;; interfere with indentation.
1487 ;; Determine if contents should follow the bullet or start
1488 ;; a new line. Do the former when the first contributing
1489 ;; element to contents is a paragraph. In descriptive lists
1490 ;; however, contents always start a new line.
1497 e))
1503 ;;;; Keyword
1506 "Transcode a KEYWORD element from Org to ASCII.
1507 CONTENTS is nil. INFO is a plist holding contextual
1508 information."
1526 keyword info)))))
1529 ;;;; Latex Environment
1532 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1533 CONTENTS is nil. INFO is a plist holding contextual
1534 information."
1538 latex-environment info)))
1541 ;;;; Latex Fragment
1544 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1545 CONTENTS is nil. INFO is a plist holding contextual
1546 information."
1551 ;;;; Line Break
1554 "Transcode a LINE-BREAK object from Org to ASCII.
1555 CONTENTS is nil. INFO is a plist holding contextual
1559 ;;;; Link
1562 "Transcode a LINK object from Org to ASCII.
1564 DESC is the description part of the link, or the empty string.
1565 INFO is a plist holding contextual information."
1573 ;; Do not apply a special syntax on radio links. Though, use
1574 ;; transcoded target's contents as output.
1587 ;; External file.
1589 (`headline
1595 ;; Handle enumerable elements and targets within them.
1601 ;; Don't know what to do. Signal it.
1611 ;;;; Node Properties
1614 "Transcode a NODE-PROPERTY element from Org to ASCII.
1615 CONTENTS is nil. INFO is a plist holding contextual
1616 information."
1623 ;;;; Paragraph
1626 "Transcode a PARAGRAPH element from Org to ASCII.
1627 CONTENTS is the contents of the paragraph, as a string. INFO is
1628 the plist used as a communication channel."
1633 ;; Do not indent first paragraph in a section.
1639 paragraph info))
1642 ;;;; Plain List
1645 "Transcode a PLAIN-LIST element from Org to ASCII.
1646 CONTENTS is the contents of the list. INFO is a plist holding
1647 contextual information."
1651 contents
1655 ;;;; Plain Text
1658 "Transcode a TEXT string from Org to ASCII.
1659 INFO is a plist used as a communication channel."
1666 ;; Usual replacements in utf-8 with proper option set.
1674 ;;;; Planning
1677 "Transcode a PLANNING element from Org to ASCII.
1678 CONTENTS is nil. INFO is a plist used as a communication
1679 channel."
1682 #'identity
1697 planning info))
1700 ;;;; Property Drawer
1703 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1704 CONTENTS holds the contents of the drawer. INFO is a plist
1705 holding contextual information."
1710 ;;;; Quote Block
1713 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1714 CONTENTS holds the contents of the block. INFO is a plist
1715 holding contextual information."
1719 ;;;; Radio Target
1722 "Transcode a RADIO-TARGET object from Org to ASCII.
1723 CONTENTS is the contents of the target. INFO is a plist holding
1724 contextual information."
1725 contents)
1728 ;;;; Section
1731 "Transcode a SECTION element from Org to ASCII.
1732 CONTENTS is the contents of the section. INFO is a plist holding
1733 contextual information."
1736 ;; Take care of links in first section of the document.
1741 info))))
1745 ;; Do not apply inner margin if parent headline is low level.
1751 ;;;; Special Block
1754 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1755 CONTENTS holds the contents of the block. INFO is a plist
1756 holding contextual information."
1757 ;; "JUSTIFYLEFT" and "JUSTIFYRIGHT" have already been taken care of
1758 ;; at a lower level. There is no other special block type to
1759 ;; handle.
1760 contents)
1763 ;;;; Src Block
1766 "Transcode a SRC-BLOCK element from Org to ASCII.
1767 CONTENTS holds the contents of the item. INFO is a plist holding
1768 contextual information."
1778 src-block info))))
1781 ;;;; Statistics Cookie
1784 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1785 CONTENTS is nil. INFO is a plist holding contextual information."
1789 ;;;; Subscript
1792 "Transcode a SUBSCRIPT object from Org to ASCII.
1793 CONTENTS is the contents of the object. INFO is a plist holding
1794 contextual information."
1800 ;;;; Superscript
1803 "Transcode a SUPERSCRIPT object from Org to ASCII.
1804 CONTENTS is the contents of the object. INFO is a plist holding
1805 contextual information."
1811 ;;;; Strike-through
1814 "Transcode STRIKE-THROUGH from Org to ASCII.
1815 CONTENTS is text with strike-through markup. INFO is a plist
1816 holding contextual information."
1820 ;;;; Table
1823 "Transcode a TABLE element from Org to ASCII.
1824 CONTENTS is the contents of the table. INFO is a plist holding
1825 contextual information."
1830 ;; Possibly add a caption string above.
1832 ;; Insert table. Note: "table.el" tables are left unmodified.
1846 ;; Possible add a caption string below.
1848 table info)))
1851 ;;;; Table Cell
1854 "Return width of TABLE-CELL.
1856 INFO is a plist used as a communication channel.
1858 Width of a cell is determined either by a width cookie in the
1859 same column as the cell, or by the maximum cell's length in that
1860 column.
1862 When `org-ascii-table-widen-columns' is non-nil, width cookies
1863 are ignored."
1878 key
1890 info))
1891 max-width)))
1892 info)
1893 max-width)))
1897 cache))))
1900 "Transcode a TABLE-CELL object from Org to ASCII.
1901 CONTENTS is the cell contents. INFO is a plist used as
1902 a communication channel."
1903 ;; Determine column width. When `org-ascii-table-widen-columns'
1904 ;; is nil and some width cookie has set it, use that value.
1905 ;; Otherwise, compute the maximum width among transcoded data of
1906 ;; each cell in the column.
1908 ;; When contents are too large, truncate them.
1912 ;; Align contents correctly within the cell.
1917 contents width
1922 ;; Return cell.
1928 ;;;; Table Row
1931 "Transcode a TABLE-ROW element from Org to ASCII.
1932 CONTENTS is the row contents. INFO is a plist used as
1933 a communication channel."
1940 'concat
1946 ;; In order to know if CELL starts the row, do
1947 ;; not compare it with the first cell in the
1948 ;; row as there might be a special column.
1949 ;; Instead, compare it with first exportable
1950 ;; cell, obtained with `org-element-map'.
1954 cell))
1955 lcorner)
1960 rcorner)
1966 info)))
1981 ;;;; Timestamp
1984 "Transcode a TIMESTAMP object from Org to ASCII.
1985 CONTENTS is nil. INFO is a plist holding contextual information."
1989 ;;;; Underline
1992 "Transcode UNDERLINE from Org to ASCII.
1993 CONTENTS is the text with underline markup. INFO is a plist
1994 holding contextual information."
1998 ;;;; Verbatim
2001 "Return a VERBATIM object from Org to ASCII.
2002 CONTENTS is nil. INFO is a plist holding contextual information."
2007 ;;;; Verse Block
2010 "Transcode a VERSE-BLOCK element from Org to ASCII.
2011 CONTENTS is verse block contents. INFO is a plist holding
2012 contextual information."
2018 \f
2019 ;;; Filters
2022 "Filter controlling number of blank lines after a headline.
2024 HEADLINE is a string representing a transcoded headline. BACKEND
2025 is symbol specifying back-end used for export. INFO is plist
2026 containing the communication channel.
2028 This function only applies to `ascii' back-end. See
2029 `org-ascii-headline-spacing' for information."
2036 "Filter controlling number of blank lines between paragraphs.
2038 TREE is the parse tree. BACKEND is the symbol specifying
2039 back-end used for export. INFO is a plist used as
2040 a communication channel.
2042 See `org-ascii-paragraph-spacing' for information."
2050 tree)
2053 "Filter removing blank lines between comments.
2054 TREE is the parse tree. BACKEND is the symbol specifying
2055 back-end used for export. INFO is a plist used as
2056 a communication channel."
2062 tree)
2065 \f
2066 ;;; End-user functions
2068 ;;;###autoload
2071 "Export current buffer to a text buffer.
2073 If narrowing is active in the current buffer, only export its
2074 narrowed part.
2076 If a region is active, export that region.
2078 A non-nil optional argument ASYNC means the process should happen
2079 asynchronously. The resulting buffer should be accessible
2080 through the `org-export-stack' interface.
2082 When optional argument SUBTREEP is non-nil, export the sub-tree
2083 at point, extracting information from the headline properties
2084 first.
2086 When optional argument VISIBLE-ONLY is non-nil, don't export
2087 contents of hidden elements.
2089 When optional argument BODY-ONLY is non-nil, strip title and
2090 table of contents from output.
2092 EXT-PLIST, when provided, is a property list with external
2093 parameters overriding Org default settings, but still inferior to
2094 file-local settings.
2097 will be displayed when `org-export-show-temporary-export-buffer'
2098 is non-nil."
2103 ;;;###autoload
2106 "Export current buffer to a text file.
2108 If narrowing is active in the current buffer, only export its
2109 narrowed part.
2111 If a region is active, export that region.
2113 A non-nil optional argument ASYNC means the process should happen
2114 asynchronously. The resulting file should be accessible through
2115 the `org-export-stack' interface.
2117 When optional argument SUBTREEP is non-nil, export the sub-tree
2118 at point, extracting information from the headline properties
2119 first.
2121 When optional argument VISIBLE-ONLY is non-nil, don't export
2122 contents of hidden elements.
2124 When optional argument BODY-ONLY is non-nil, strip title and
2125 table of contents from output.
2127 EXT-PLIST, when provided, is a property list with external
2128 parameters overriding Org default settings, but still inferior to
2129 file-local settings.
2131 Return output file's name."
2135 async subtreep visible-only body-only ext-plist)))
2137 ;;;###autoload
2139 "Publish an Org file to ASCII.
2141 FILENAME is the filename of the Org file to be published. PLIST
2142 is the property list for the given project. PUB-DIR is the
2143 publishing directory.
2145 Return output file name."
2149 ;;;###autoload
2151 "Publish an Org file to Latin-1.
2153 FILENAME is the filename of the Org file to be published. PLIST
2154 is the property list for the given project. PUB-DIR is the
2155 publishing directory.
2157 Return output file name."
2161 ;;;###autoload
2163 "Publish an org file to UTF-8.
2165 FILENAME is the filename of the Org file to be published. PLIST
2166 is the property list for the given project. PUB-DIR is the
2167 publishing directory.
2169 Return output file name."
2176 ;; Local variables:
2177 ;; generated-autoload-file: "org-loaddefs.el"
2178 ;; coding: utf-8
2179 ;; End:
2181 ;;; ox-ascii.el ends here