| blob | 0b50bbe7cf14774980cb71a5d5b7c55b5eed4955 |
1 ;;; ox-ascii.el --- ASCII Back-End for Org Export Engine -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2016 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 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."
187 "Width of margin used for plain lists, in characters.
188 This margin applies to top level list only, not to its
189 sub-lists."
196 "Width of inline tasks, in number of characters.
197 This number ignores any margin."
204 "Number of blank lines inserted around headlines.
206 This variable can be set to a cons cell. In that case, its car
207 represents the number of blank lines present before headline
208 contents whereas its cdr reflects the number of blank lines after
209 contents.
211 A nil value replicates the number of blank lines found in the
212 original Org buffer at the same place."
223 "Additional indentation width for the first line in a paragraph.
224 If the value is an integer, indent the first line of each
225 paragraph by this width, unless it is located at the beginning of
226 a section, in which case indentation is removed from that line.
227 If it is the symbol `auto' preserve indentation from original
228 document."
237 "Number of white lines between paragraphs.
238 If the value is an integer, add this number of blank lines
239 between contiguous paragraphs. If is it the symbol `auto', keep
240 the same number of blank lines as in the original document."
249 "The charset allowed to represent various elements and objects.
250 Possible values are:
251 `ascii' Only use plain ASCII characters
252 `latin1' Include Latin-1 characters
253 `utf-8' Use all UTF-8 characters"
265 "Characters for underlining headings in ASCII export.
267 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
268 and whose value is a list of characters.
270 For each supported charset, this variable associates a sequence
271 of underline characters. In a sequence, the characters will be
272 used in order for headlines level 1, 2, ... If no character is
273 available for a given level, the headline won't be underlined."
291 "Bullet characters for headlines converted to lists in ASCII export.
293 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
294 and whose value is a list of characters.
296 The first character is used for the first level considered as low
297 level, and so on. If there are more levels than characters given
298 here, the list will be repeated.
300 Note that this variable doesn't affect plain lists
301 representation."
317 "Non-nil means convert links to notes before the next headline.
318 When nil, the link will be exported in place. If the line
319 becomes long in this way, it will be wrapped."
326 "Non-nil means keep all vertical lines in ASCII tables.
327 When nil, vertical lines will be removed except for those needed
328 for column grouping."
335 "Non-nil means widen narrowed columns for export.
336 When nil, narrowed columns will look in ASCII export just like in
344 "Non-nil means table.el tables are turned into ascii-art.
346 It only makes sense when export charset is `utf-8'. It is nil by
347 default since it requires ascii-art-to-unicode.el package. You
348 can download it here:
350 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
357 "When non-nil, place caption string before the element.
358 Otherwise, place it right after it."
365 "Format string used for verbatim text and inline code."
373 "Function called to format a drawer in ASCII.
375 The function must accept three parameters:
377 CONTENTS the contents of the drawer.
378 WIDTH the text width within the drawer.
380 The function should return either the string to be exported or
381 nil to ignore the drawer.
383 The default value simply returns the value of CONTENTS."
390 'org-ascii-format-inlinetask-default
391 "Function called to format an inlinetask in ASCII.
393 The function must accept nine parameters:
394 TODO the todo keyword, as a string
395 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
396 PRIORITY the inlinetask priority, as a string
397 NAME the inlinetask name, as a string.
398 TAGS the inlinetask tags, as a list of strings.
399 CONTENTS the contents of the inlinetask, as a string.
400 WIDTH the width of the inlinetask, as a number.
401 INLINETASK the inlinetask itself.
402 INFO the info channel.
404 The function should return either the string to be exported or
405 nil to ignore the inline task."
412 \f
413 ;;; Internal Functions
415 ;; Internal functions fall into three categories.
417 ;; The first one is about text formatting. The core functions are
418 ;; `org-ascii--current-text-width' and
419 ;; `org-ascii--current-justification', which determine, respectively,
420 ;; the current text width allowed to a given element and its expected
421 ;; justification. Once this information is known,
422 ;; `org-ascii--fill-string', `org-ascii--justify-lines',
423 ;; `org-ascii--justify-element' `org-ascii--box-string' and
424 ;; `org-ascii--indent-string' can operate on a given output string.
425 ;; In particular, justification happens at the regular (i.e.,
426 ;; non-greater) element level, which means that when the exporting
427 ;; process reaches a container (e.g., a center block) content are
428 ;; already justified.
430 ;; The second category contains functions handling elements listings,
431 ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
432 ;; returns a complete table of contents, `org-ascii--list-listings'
433 ;; returns a list of referenceable src-block elements, and
434 ;; `org-ascii--list-tables' does the same for table elements.
436 ;; The third category includes general helper functions.
437 ;; `org-ascii--build-title' creates the title for a given headline
438 ;; or inlinetask element. `org-ascii--build-caption' returns the
439 ;; caption string associated to a table or a src-block.
440 ;; `org-ascii--describe-links' creates notes about links for
441 ;; insertion at the end of a section. It uses
442 ;; `org-ascii--unique-links' to get the list of links to describe.
443 ;; Eventually, `org-ascii--translate' translates a string according
444 ;; to language and charset specification.
448 "Fill a string with specified text-width and return it.
450 S is the string being filled. TEXT-WIDTH is an integer
451 specifying maximum length of a line. INFO is the plist used as
452 a communication channel.
454 Optional argument JUSTIFY can specify any type of justification
455 among `left', `center', `right' or `full'. A nil value is
456 equivalent to `left'. For a justification that doesn't also fill
457 string, see `org-ascii--justify-lines' and
458 `org-ascii--justify-block'.
460 Return nil if S isn't a string."
469 s))
474 "Justify all lines in string S.
475 TEXT-WIDTH is an integer specifying maximum length of a line.
476 HOW determines the type of justification: it can be `left',
477 `right', `full' or `center'."
482 ;; Disable `adaptive-fill-mode' so it doesn't prevent
483 ;; filling lines matching `adaptive-fill-regexp'.
491 "Justify CONTENTS of ELEMENT.
492 INFO is a plist used as a communication channel. Justification
493 is done according to the type of element. More accurately,
494 paragraphs are filled and other elements are justified as blocks,
495 that is according to the widest non blank line in CONTENTS."
501 ;; Paragraphs are treated specially as they need to be filled.
509 ;; Compute maximum width. Bail out if it is greater
510 ;; than page width, since no justification is
511 ;; possible.
521 ;; Justify every line according to TEXT-WIDTH and
522 ;; MAX-WIDTH.
533 "Indent string S by WIDTH white spaces.
534 Empty lines are not indented."
540 "Return string S with a partial box to its left.
541 INFO is a plist used as a communication channel."
546 ;; Remove last newline character.
550 "Return maximum text width for ELEMENT's contents.
551 INFO is a plist used as a communication channel."
553 ;; Elements with an absolute width: `headline' and `inlinetask'.
560 ;; Elements with a relative width: store maximum text width in
561 ;; TOTAL-WIDTH.
564 ;; Total width is determined by the presence, or not, of an
565 ;; inline task among ELEMENT parents.
570 ;; No inlinetask: Remove global margin from text width.
574 ;; Inner margin doesn't apply to text before first
575 ;; headline.
579 ;; Inner margin doesn't apply to contents of
580 ;; low level headlines, since they've got their
581 ;; own indentation mechanism.
585 ;; Each `quote-block' and `verse-block' above narrows text
586 ;; width by twice the standard margin size.
590 count parent)
592 ;; Apply list margin once per "top-level" plain-list
593 ;; containing current line
601 ;; Text width within a plain-list is restricted by
602 ;; indentation of current item. If that's the case,
603 ;; compute it with the help of `:structure' property from
604 ;; parent item, if any.
609 return parent))))
611 ;; Compute indentation offset of the current item,
612 ;; that is the sum of the difference between its
613 ;; indentation and the indentation of the top item in
614 ;; the list and current item bullet's length. Also
615 ;; remove checkbox length, and tag length (for
616 ;; description lists) or bullet length.
630 "Return expected justification for ELEMENT's contents.
631 Return value is a symbol among `left', `center', `right' and
632 `full'."
646 "Format ELEMENT title and return it.
648 ELEMENT is either an `headline' or `inlinetask' element. INFO is
649 a plist used as a communication channel. TEXT-WIDTH is an
650 integer representing the maximum length of a line.
652 When optional argument UNDERLINE is non-nil, underline title,
653 without the tags, according to `org-ascii-underline'
654 specifications.
656 If optional argument NOTAGS is non-nil, no tags will be added to
657 the title.
659 When optional argument TOC is non-nil, use optional title if
660 possible. It doesn't apply to `inlinetask' elements."
663 ;; Numbering is specific to headlines.
665 ;; All tests passed: build numbering string.
668 'number-to-string
676 info)))
693 first-part
694 ;; Align tags, if any.
700 tags))
701 ;; Maybe underline text, if ELEMENT type is `headline' and an
702 ;; underline character has been defined.
712 under-char))))))))
715 "Non-nil when ELEMENT has a caption affiliated keyword.
716 INFO is a plist used as a communication channel. This function
717 is meant to be used as a predicate for `org-export-get-ordinal'."
721 "Return caption string for ELEMENT, if applicable.
723 INFO is a plist used as a communication channel.
725 The caption string contains the sequence number of ELEMENT along
726 with its real caption. Return nil when ELEMENT has no affiliated
727 caption keyword."
730 ;; Get sequence number of current src-block among every
731 ;; src-block with a caption.
739 info)))
742 " "
747 "Return a table of contents.
749 INFO is a plist used as a communication channel.
751 Optional argument N, when non-nil, is an integer specifying the
752 depth of the table.
754 Optional argument KEYWORD specifies the TOC keyword, if any, from
755 which the table of contents generation has been initiated.
757 When optional argument LOCAL is non-nil, build a table of
758 contents according to the current headline."
785 "Return a list of listings.
787 KEYWORD is the keyword that initiated the list of listings
788 generation. INFO is a plist used as a communication channel."
799 ;; Use a counter instead of retrieving ordinal of each
800 ;; src-block.
804 ;; Store initial text so its length can be computed. This is
805 ;; used to properly align caption right to it in case of
806 ;; filling (like contents of a description list item).
812 initial-text " "
816 ;; Use short name in priority, if available.
821 initial-width)))))
825 "Return a list of tables.
827 KEYWORD is the keyword that initiated the list of tables
828 generation. INFO is a plist used as a communication channel."
839 ;; Use a counter instead of retrieving ordinal of each
840 ;; src-block.
844 ;; Store initial text so its length can be computed. This is
845 ;; used to properly align caption right to it in case of
846 ;; filling (like contents of a description list item).
852 initial-text " "
856 ;; Use short name in priority, if available.
861 initial-width)))))
865 "Return a list of unique link references in ELEMENT.
866 ELEMENT is either a headline element or a section element. INFO
867 is a plist used as a communication channel."
871 ;; Return LINK if it wasn't referenced so far, or nil.
872 ;; Update SEEN links along the way.
875 ;; Normalize description in footprints.
883 ;; Ignore LINK if it hasn't been translated already.
884 ;; It can happen if it is located in an affiliated
885 ;; keyword that was ignored.
890 ;; If at a section, find parent headline, if any, in order to
891 ;; count links that might be in the title.
895 ;; Get all links in HEADLINE.
900 "Return a string describing a list of links.
902 LINKS is a list of link type objects, as returned by
903 `org-ascii--unique-links'. WIDTH is the text width allowed for
904 the output string. INFO is a plist used as a communication
905 channel."
913 ;; Coderefs, radio links and fuzzy links are ignored.
915 ;; Id and custom-id links: Headlines refer to their numbering.
921 "[%s] %s"
922 anchor
924 dest
932 width info)
934 ;; Do not add a link that cannot be resolved and doesn't have
935 ;; any description: destination is already visible in the
936 ;; paragraph.
938 ;; Do not add a link already handled by custom export
939 ;; functions.
944 nil)
949 width info)
954 "Return checkbox string for ITEM or nil.
955 INFO is a plist used as a communication channel."
963 \f
964 ;;; Template
967 "Return document title, as a string.
968 INFO is a plist used as a communication channel."
970 ;; Links in the title will not be resolved later, so we make
971 ;; sure their path is located right after them.
985 ;; There are two types of title blocks depending on the presence
986 ;; of a title to display.
988 ;; Title block without a title. DATE is positioned at the top
989 ;; right of the document, AUTHOR to the top left and EMAIL
990 ;; just below.
994 author
996 ?\s)
997 date
1002 email
1004 ?\s)
1014 ;; Title block with a title. Document's TITLE, along with the
1015 ;; AUTHOR and its EMAIL are both overlined and an underlined,
1016 ;; centered. Date is just below, also centered.
1018 ;; Format TITLE. It may be filled if it is too wide,
1019 ;; that is wider than the two thirds of the total width.
1050 "Return complete document string after ASCII conversion.
1051 CONTENTS is the transcoded contents string. INFO is a plist
1052 holding export options."
1057 ;; 1. Document's body.
1058 contents
1059 ;; 2. Footnote definitions.
1061 ;; Insert full links right inside the footnote definition
1062 ;; as they have no chance to be inserted later.
1075 global-margin)))
1079 ;; Distinguish between inline definitions and
1080 ;; full-fledged definitions.
1085 ;; Full-fledged definition: footnote ID is
1086 ;; inserted inside the first parsed
1087 ;; paragraph (FIRST), if any, to be sure
1088 ;; filling will take it into consideration.
1094 ;; Fill paragraph once footnote ID is inserted
1095 ;; in order to have a correct length for first
1096 ;; line.
1099 text-width info))))))
1101 global-margin))))
1104 "Return complete document string after ASCII conversion.
1105 CONTENTS is the transcoded contents string. INFO is a plist
1106 holding export options."
1109 ;; Build title block.
1112 ;; 2. Table of contents.
1118 global-margin)
1119 ;; Document's body.
1120 contents
1121 ;; Creator. Justify it to the bottom right.
1130 global-margin)))))
1133 "Translate string S according to specified language and charset.
1134 INFO is a plist used as a communication channel."
1139 \f
1140 ;;; Transcode Functions
1142 ;;;; Bold
1145 "Transcode BOLD from Org to ASCII.
1146 CONTENTS is the text with bold markup. INFO is a plist holding
1147 contextual information."
1151 ;;;; Center Block
1154 "Transcode a CENTER-BLOCK element from Org to ASCII.
1155 CONTENTS holds the contents of the block. INFO is a plist
1156 holding contextual information."
1157 ;; Center has already been taken care of at a lower level, so
1158 ;; there's nothing left to do.
1159 contents)
1162 ;;;; Clock
1165 "Transcode a CLOCK object from Org to ASCII.
1166 CONTENTS is nil. INFO is a plist holding contextual
1167 information."
1175 "%2s:%02s"
1177 clock info))
1180 ;;;; Code
1183 "Return a CODE object from Org to ASCII.
1184 CONTENTS is nil. INFO is a plist holding contextual
1185 information."
1190 ;;;; Drawer
1193 "Transcode a DRAWER element from Org to ASCII.
1194 CONTENTS holds the contents of the block. INFO is a plist
1195 holding contextual information."
1199 name contents width)))
1202 ;;;; Dynamic Block
1205 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1206 CONTENTS holds the contents of the block. INFO is a plist
1207 holding contextual information."
1208 contents)
1211 ;;;; Entity
1214 "Transcode an ENTITY object from Org to ASCII.
1215 CONTENTS are the definition itself. INFO is a plist holding
1216 contextual information."
1219 entity))
1222 ;;;; Example Block
1225 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1226 CONTENTS is nil. INFO is a plist holding contextual information."
1230 example-block info))
1233 ;;;; Export Snippet
1236 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1237 CONTENTS is nil. INFO is a plist holding contextual information."
1242 ;;;; Export Block
1245 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1246 CONTENTS is nil. INFO is a plist holding contextual information."
1252 ;;;; Fixed Width
1255 "Transcode a FIXED-WIDTH element from Org to ASCII.
1256 CONTENTS is nil. INFO is a plist holding contextual information."
1261 fixed-width info))
1264 ;;;; Footnote Definition
1266 ;; Footnote Definitions are ignored. They are compiled at the end of
1267 ;; the document, by `org-ascii-inner-template'.
1270 ;;;; Footnote Reference
1273 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1274 CONTENTS is nil. INFO is a plist holding contextual information."
1278 ;;;; Headline
1281 "Transcode a HEADLINE element from Org to ASCII.
1282 CONTENTS holds the contents of the headline. INFO is a plist
1283 holding contextual information."
1284 ;; Don't export footnote section, which will be handled at the end
1285 ;; of the template.
1289 ;; Blank lines between headline and its contents.
1290 ;; `org-ascii-headline-spacing', when set, overwrites
1291 ;; original buffer's spacing.
1297 ;; Even if HEADLINE has no section, there might be some
1298 ;; links in its title that we shouldn't forget to describe.
1305 ;; Deep subtree: export it as a list item.
1308 ;; Bullet.
1313 " "
1314 ;; Title.
1316 ;; Contents, indented by length of bullet.
1317 pre-blanks
1322 ;; Else: Standard headline.
1329 ;;;; Horizontal Rule
1332 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1333 CONTENTS is nil. INFO is a plist holding contextual
1334 information."
1341 text-width)
1346 ;;;; Inline Src Block
1349 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1350 CONTENTS holds the contents of the item. INFO is a plist holding
1351 contextual information."
1356 ;;;; Inlinetask
1360 "Format an inline task element for ASCII export.
1361 See `org-ascii-format-inlinetask-function' for a description
1362 of the parameters."
1367 ;; Top line, with an additional blank line if not in UTF-8.
1370 ;; Add title. Fill it if wider than inlinetask.
1375 ;; If CONTENTS is not empty, insert it along with
1376 ;; a separator.
1379 ;; Bottom line.
1381 ;; Flush the inlinetask to the right.
1388 "Transcode an INLINETASK element from Org to ASCII.
1389 CONTENTS holds the contents of the block. INFO is a plist
1390 holding contextual information."
1393 ;; todo.
1398 ;; todo-type
1400 ;; priority
1403 ;; title
1405 ;; tags
1408 ;; contents and width
1409 contents width inlinetask info)))
1412 ;;;; Italic
1415 "Transcode italic from Org to ASCII.
1416 CONTENTS is the text with italic markup. INFO is a plist holding
1417 contextual information."
1421 ;;;; Item
1424 "Transcode an ITEM element from Org to ASCII.
1425 CONTENTS holds the contents of the item. INFO is a plist holding
1426 contextual information."
1431 ;; First parent of ITEM is always the plain-list. Get
1432 ;; `:type' property from it.
1440 ;; Return correct number for ITEM, paying attention to
1441 ;; counters.
1447 struct
1452 ;; Change bullets into more visible form if UTF-8 is active.
1460 bullet
1462 ;; Contents: Pay attention to indentation. Note: check-boxes are
1463 ;; already taken care of at the paragraph level so they don't
1464 ;; interfere with indentation.
1471 ;;;; Keyword
1474 "Transcode a KEYWORD element from Org to ASCII.
1475 CONTENTS is nil. INFO is a plist holding contextual
1476 information."
1494 keyword info)))))
1497 ;;;; Latex Environment
1500 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1501 CONTENTS is nil. INFO is a plist holding contextual
1502 information."
1506 latex-environment info)))
1509 ;;;; Latex Fragment
1512 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1513 CONTENTS is nil. INFO is a plist holding contextual
1514 information."
1519 ;;;; Line Break
1522 "Transcode a LINE-BREAK object from Org to ASCII.
1523 CONTENTS is nil. INFO is a plist holding contextual
1527 ;;;; Link
1530 "Transcode a LINK object from Org to ASCII.
1532 DESC is the description part of the link, or the empty string.
1533 INFO is a plist holding contextual information."
1541 ;; Do not apply a special syntax on radio links. Though, use
1542 ;; transcoded target's contents as output.
1544 ;; Do not apply a special syntax on fuzzy links pointing to
1545 ;; targets.
1556 ;; Unnumbered headline.
1561 info)))))))))
1570 ;;;; Node Properties
1573 "Transcode a NODE-PROPERTY element from Org to ASCII.
1574 CONTENTS is nil. INFO is a plist holding contextual
1575 information."
1582 ;;;; Paragraph
1585 "Transcode a PARAGRAPH element from Org to ASCII.
1586 CONTENTS is the contents of the paragraph, as a string. INFO is
1587 the plist used as a communication channel."
1592 ;; Do not indent first paragraph in a section.
1598 paragraph info))
1601 ;;;; Plain List
1604 "Transcode a PLAIN-LIST element from Org to ASCII.
1605 CONTENTS is the contents of the list. INFO is a plist holding
1606 contextual information."
1610 contents
1614 ;;;; Plain Text
1617 "Transcode a TEXT string from Org to ASCII.
1618 INFO is a plist used as a communication channel."
1625 ;; Usual replacements in utf-8 with proper option set.
1633 ;;;; Planning
1636 "Transcode a PLANNING element from Org to ASCII.
1637 CONTENTS is nil. INFO is a plist used as a communication
1638 channel."
1641 #'identity
1656 planning info))
1659 ;;;; Property Drawer
1662 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1663 CONTENTS holds the contents of the drawer. INFO is a plist
1664 holding contextual information."
1669 ;;;; Quote Block
1672 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1673 CONTENTS holds the contents of the block. INFO is a plist
1674 holding contextual information."
1678 ;;;; Radio Target
1681 "Transcode a RADIO-TARGET object from Org to ASCII.
1682 CONTENTS is the contents of the target. INFO is a plist holding
1683 contextual information."
1684 contents)
1687 ;;;; Section
1690 "Transcode a SECTION element from Org to ASCII.
1691 CONTENTS is the contents of the section. INFO is a plist holding
1692 contextual information."
1695 contents
1697 ;; Add list of links at the end of SECTION.
1701 ;; Separate list of links and section contents.
1703 ;; Do not apply inner margin if parent headline is low level.
1709 ;;;; Special Block
1712 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1713 CONTENTS holds the contents of the block. INFO is a plist
1714 holding contextual information."
1715 ;; "JUSTIFYLEFT" and "JUSTFYRIGHT" have already been taken care of
1716 ;; at a lower level. There is no other special block type to
1717 ;; handle.
1718 contents)
1721 ;;;; Src Block
1724 "Transcode a SRC-BLOCK element from Org to ASCII.
1725 CONTENTS holds the contents of the item. INFO is a plist holding
1726 contextual information."
1736 src-block info))))
1739 ;;;; Statistics Cookie
1742 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1743 CONTENTS is nil. INFO is a plist holding contextual information."
1747 ;;;; Subscript
1750 "Transcode a SUBSCRIPT object from Org to ASCII.
1751 CONTENTS is the contents of the object. INFO is a plist holding
1752 contextual information."
1758 ;;;; Superscript
1761 "Transcode a SUPERSCRIPT object from Org to ASCII.
1762 CONTENTS is the contents of the object. INFO is a plist holding
1763 contextual information."
1769 ;;;; Strike-through
1772 "Transcode STRIKE-THROUGH from Org to ASCII.
1773 CONTENTS is text with strike-through markup. INFO is a plist
1774 holding contextual information."
1778 ;;;; Table
1781 "Transcode a TABLE element from Org to ASCII.
1782 CONTENTS is the contents of the table. INFO is a plist holding
1783 contextual information."
1788 ;; Possibly add a caption string above.
1790 ;; Insert table. Note: "table.el" tables are left unmodified.
1804 ;; Possible add a caption string below.
1806 table info)))
1809 ;;;; Table Cell
1812 "Return width of TABLE-CELL.
1814 INFO is a plist used as a communication channel.
1816 Width of a cell is determined either by a width cookie in the
1817 same column as the cell, or by the maximum cell's length in that
1818 column.
1820 When `org-ascii-table-widen-columns' is non-nil, width cookies
1821 are ignored."
1836 key
1848 info))
1849 max-width)))
1850 info)
1851 max-width)))
1855 cache))))
1858 "Transcode a TABLE-CELL object from Org to ASCII.
1859 CONTENTS is the cell contents. INFO is a plist used as
1860 a communication channel."
1861 ;; Determine column width. When `org-ascii-table-widen-columns'
1862 ;; is nil and some width cookie has set it, use that value.
1863 ;; Otherwise, compute the maximum width among transcoded data of
1864 ;; each cell in the column.
1866 ;; When contents are too large, truncate them.
1870 ;; Align contents correctly within the cell.
1875 contents width
1880 ;; Return cell.
1886 ;;;; Table Row
1889 "Transcode a TABLE-ROW element from Org to ASCII.
1890 CONTENTS is the row contents. INFO is a plist used as
1891 a communication channel."
1898 'concat
1904 ;; In order to know if CELL starts the row, do
1905 ;; not compare it with the first cell in the
1906 ;; row as there might be a special column.
1907 ;; Instead, compare it with first exportable
1908 ;; cell, obtained with `org-element-map'.
1912 cell))
1913 lcorner)
1918 rcorner)
1924 info)))
1939 ;;;; Timestamp
1942 "Transcode a TIMESTAMP object from Org to ASCII.
1943 CONTENTS is nil. INFO is a plist holding contextual information."
1947 ;;;; Underline
1950 "Transcode UNDERLINE from Org to ASCII.
1951 CONTENTS is the text with underline markup. INFO is a plist
1952 holding contextual information."
1956 ;;;; Verbatim
1959 "Return a VERBATIM object from Org to ASCII.
1960 CONTENTS is nil. INFO is a plist holding contextual information."
1965 ;;;; Verse Block
1968 "Transcode a VERSE-BLOCK element from Org to ASCII.
1969 CONTENTS is verse block contents. INFO is a plist holding
1970 contextual information."
1976 \f
1977 ;;; Filters
1980 "Filter controlling number of blank lines after a headline.
1982 HEADLINE is a string representing a transcoded headline. BACKEND
1983 is symbol specifying back-end used for export. INFO is plist
1984 containing the communication channel.
1986 This function only applies to `ascii' back-end. See
1987 `org-ascii-headline-spacing' for information."
1994 "Filter controlling number of blank lines between paragraphs.
1996 TREE is the parse tree. BACKEND is the symbol specifying
1997 back-end used for export. INFO is a plist used as
1998 a communication channel.
2000 See `org-ascii-paragraph-spacing' for information."
2008 tree)
2011 "Filter removing blank lines between comments.
2012 TREE is the parse tree. BACKEND is the symbol specifying
2013 back-end used for export. INFO is a plist used as
2014 a communication channel."
2020 tree)
2023 \f
2024 ;;; End-user functions
2026 ;;;###autoload
2029 "Export current buffer to a text buffer.
2031 If narrowing is active in the current buffer, only export its
2032 narrowed part.
2034 If a region is active, export that region.
2036 A non-nil optional argument ASYNC means the process should happen
2037 asynchronously. The resulting buffer should be accessible
2038 through the `org-export-stack' interface.
2040 When optional argument SUBTREEP is non-nil, export the sub-tree
2041 at point, extracting information from the headline properties
2042 first.
2044 When optional argument VISIBLE-ONLY is non-nil, don't export
2045 contents of hidden elements.
2047 When optional argument BODY-ONLY is non-nil, strip title and
2048 table of contents from output.
2050 EXT-PLIST, when provided, is a property list with external
2051 parameters overriding Org default settings, but still inferior to
2052 file-local settings.
2055 will be displayed when `org-export-show-temporary-export-buffer'
2056 is non-nil."
2061 ;;;###autoload
2064 "Export current buffer to a text file.
2066 If narrowing is active in the current buffer, only export its
2067 narrowed part.
2069 If a region is active, export that region.
2071 A non-nil optional argument ASYNC means the process should happen
2072 asynchronously. The resulting file should be accessible through
2073 the `org-export-stack' interface.
2075 When optional argument SUBTREEP is non-nil, export the sub-tree
2076 at point, extracting information from the headline properties
2077 first.
2079 When optional argument VISIBLE-ONLY is non-nil, don't export
2080 contents of hidden elements.
2082 When optional argument BODY-ONLY is non-nil, strip title and
2083 table of contents from output.
2085 EXT-PLIST, when provided, is a property list with external
2086 parameters overriding Org default settings, but still inferior to
2087 file-local settings.
2089 Return output file's name."
2093 async subtreep visible-only body-only ext-plist)))
2095 ;;;###autoload
2097 "Publish an Org file to ASCII.
2099 FILENAME is the filename of the Org file to be published. PLIST
2100 is the property list for the given project. PUB-DIR is the
2101 publishing directory.
2103 Return output file name."
2107 ;;;###autoload
2109 "Publish an Org file to Latin-1.
2111 FILENAME is the filename of the Org file to be published. PLIST
2112 is the property list for the given project. PUB-DIR is the
2113 publishing directory.
2115 Return output file name."
2119 ;;;###autoload
2121 "Publish an org file to UTF-8.
2123 FILENAME is the filename of the Org file to be published. PLIST
2124 is the property list for the given project. PUB-DIR is the
2125 publishing directory.
2127 Return output file name."
2134 ;; Local variables:
2135 ;; generated-autoload-file: "org-loaddefs.el"
2136 ;; coding: utf-8
2137 ;; End:
2139 ;;; ox-ascii.el ends here