| blob | 1b83ab465b1573e71018dacae85e83217b3172fc |
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 <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'.
555 (`headline
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.
569 genealogy)
571 ;; No inlinetask: Remove global margin from text width.
575 ;; Inner margin doesn't apply to text before first
576 ;; headline.
580 ;; Inner margin doesn't apply to contents of
581 ;; low level headlines, since they've got their
582 ;; own indentation mechanism.
586 ;; Each `quote-block' and `verse-block' above narrows text
587 ;; width by twice the standard margin size.
591 genealogy)
592 2
594 ;; Apply list margin once per "top-level" plain-list
595 ;; containing current line
601 genealogy)
603 ;; Text width within a plain-list is restricted by
604 ;; indentation of current item. If that's the case,
605 ;; compute it with the help of `:structure' property from
606 ;; parent item, if any.
611 genealogy))))
613 ;; Compute indentation offset of the current item,
614 ;; that is the sum of the difference between its
615 ;; indentation and the indentation of the top item in
616 ;; the list and current item bullet's length. Also
617 ;; remove checkbox length, and tag length (for
618 ;; description lists) or bullet length.
632 "Return expected justification for ELEMENT's contents.
633 Return value is a symbol among `left', `center', `right' and
634 `full'."
640 (`special-block
648 "Format ELEMENT title and return it.
650 ELEMENT is either an `headline' or `inlinetask' element. INFO is
651 a plist used as a communication channel. TEXT-WIDTH is an
652 integer representing the maximum length of a line.
654 When optional argument UNDERLINE is non-nil, underline title,
655 without the tags, according to `org-ascii-underline'
656 specifications.
658 If optional argument NOTAGS is non-nil, no tags will be added to
659 the title.
661 When optional argument TOC is non-nil, use optional title if
662 possible. It doesn't apply to `inlinetask' elements."
665 ;; Numbering is specific to headlines.
667 ;; All tests passed: build numbering string.
670 'number-to-string
678 info)))
695 first-part
696 ;; Align tags, if any.
702 tags))
703 ;; Maybe underline text, if ELEMENT type is `headline' and an
704 ;; underline character has been defined.
714 under-char))))))))
717 "Non-nil when ELEMENT has a caption affiliated keyword.
718 INFO is a plist used as a communication channel. This function
719 is meant to be used as a predicate for `org-export-get-ordinal'."
723 "Return caption string for ELEMENT, if applicable.
725 INFO is a plist used as a communication channel.
727 The caption string contains the sequence number of ELEMENT along
728 with its real caption. Return nil when ELEMENT has no affiliated
729 caption keyword."
732 ;; Get sequence number of current src-block among every
733 ;; src-block with a caption.
741 info)))
744 " "
749 "Return a table of contents.
751 INFO is a plist used as a communication channel.
753 Optional argument N, when non-nil, is an integer specifying the
754 depth of the table.
756 Optional argument KEYWORD specifies the TOC keyword, if any, from
757 which the table of contents generation has been initiated.
759 When optional argument LOCAL is non-nil, build a table of
760 contents according to the current headline."
787 "Return a list of listings.
789 KEYWORD is the keyword that initiated the list of listings
790 generation. INFO is a plist used as a communication channel."
801 ;; Use a counter instead of retrieving ordinal of each
802 ;; src-block.
806 ;; Store initial text so its length can be computed. This is
807 ;; used to properly align caption right to it in case of
808 ;; filling (like contents of a description list item).
814 initial-text " "
818 ;; Use short name in priority, if available.
823 initial-width)))))
827 "Return a list of tables.
829 KEYWORD is the keyword that initiated the list of tables
830 generation. INFO is a plist used as a communication channel."
841 ;; Use a counter instead of retrieving ordinal of each
842 ;; src-block.
846 ;; Store initial text so its length can be computed. This is
847 ;; used to properly align caption right to it in case of
848 ;; filling (like contents of a description list item).
854 initial-text " "
858 ;; Use short name in priority, if available.
863 initial-width)))))
867 "Return a list of unique link references in ELEMENT.
868 ELEMENT is either a headline element or a section element. INFO
869 is a plist used as a communication channel."
872 ;; Return LINK if it wasn't referenced so far, or nil.
873 ;; Update SEEN links along the way.
876 ;; Normalize description in footprints.
884 ;; Ignore LINK if it hasn't been translated already. It
885 ;; can happen if it is located in an affiliated keyword
886 ;; that was ignored.
892 element
893 ;; In a headline, only retrieve links in title
894 ;; and relative section, not in children.
900 "Describe DATUM object or element.
901 If DATUM is a string, consider it to be a file name, per
902 `org-export-resolve-id-link'. INFO is the communication channel,
903 as a plist."
906 (`headline
916 ;; If destination is a target, make sure we can name the
917 ;; container it refers to.
921 (`headline
929 (`paragraph
931 (`src-block
933 (`table
938 "Return a string describing a list of links.
939 LINKS is a list of link type objects, as returned by
940 `org-ascii--unique-links'. WIDTH is the text width allowed for
941 the output string. INFO is a plist used as a communication
942 channel."
949 info)))
953 ;; Only links with a description need an entry. Other are
954 ;; already handled in `org-ascii-link'.
962 width info)
964 ;; Do not add a link that cannot be resolved and doesn't have
965 ;; any description: destination is already visible in the
966 ;; paragraph.
968 ;; Do not add a link already handled by custom export
969 ;; functions.
975 width info)
980 "Return checkbox string for ITEM or nil.
981 INFO is a plist used as a communication channel."
989 \f
990 ;;; Template
993 "Return document title, as a string.
994 INFO is a plist used as a communication channel."
996 ;; Links in the title will not be resolved later, so we make
997 ;; sure their path is located right after them.
1011 ;; There are two types of title blocks depending on the presence
1012 ;; of a title to display.
1014 ;; Title block without a title. DATE is positioned at the top
1015 ;; right of the document, AUTHOR to the top left and EMAIL
1016 ;; just below.
1020 author
1022 ?\s)
1023 date
1028 email
1030 ?\s)
1040 ;; Title block with a title. Document's TITLE, along with the
1041 ;; AUTHOR and its EMAIL are both overlined and an underlined,
1042 ;; centered. Date is just below, also centered.
1044 ;; Format TITLE. It may be filled if it is too wide,
1045 ;; that is wider than the two thirds of the total width.
1076 "Return complete document string after ASCII conversion.
1077 CONTENTS is the transcoded contents string. INFO is a plist
1078 holding export options."
1083 ;; 1. Document's body.
1084 contents
1085 ;; 2. Footnote definitions.
1087 ;; Insert full links right inside the footnote definition
1088 ;; as they have no chance to be inserted later.
1101 global-margin)))
1105 ;; Distinguish between inline definitions and
1106 ;; full-fledged definitions.
1111 ;; Full-fledged definition: footnote ID is
1112 ;; inserted inside the first parsed
1113 ;; paragraph (FIRST), if any, to be sure
1114 ;; filling will take it into consideration.
1120 ;; Fill paragraph once footnote ID is inserted
1121 ;; in order to have a correct length for first
1122 ;; line.
1125 text-width info))))))
1127 global-margin))))
1130 "Return complete document string after ASCII conversion.
1131 CONTENTS is the transcoded contents string. INFO is a plist
1132 holding export options."
1135 ;; Build title block.
1138 ;; 2. Table of contents.
1144 global-margin)
1145 ;; Document's body.
1146 contents
1147 ;; Creator. Justify it to the bottom right.
1156 global-margin)))))
1159 "Translate string S according to specified language and charset.
1160 INFO is a plist used as a communication channel."
1165 \f
1166 ;;; Transcode Functions
1168 ;;;; Bold
1171 "Transcode BOLD from Org to ASCII.
1172 CONTENTS is the text with bold markup. INFO is a plist holding
1173 contextual information."
1177 ;;;; Center Block
1180 "Transcode a CENTER-BLOCK element from Org to ASCII.
1181 CONTENTS holds the contents of the block. INFO is a plist
1182 holding contextual information."
1183 ;; Center has already been taken care of at a lower level, so
1184 ;; there's nothing left to do.
1185 contents)
1188 ;;;; Clock
1191 "Transcode a CLOCK object from Org to ASCII.
1192 CONTENTS is nil. INFO is a plist holding contextual
1193 information."
1201 "%2s:%02s"
1203 clock info))
1206 ;;;; Code
1209 "Return a CODE object from Org to ASCII.
1210 CONTENTS is nil. INFO is a plist holding contextual
1211 information."
1216 ;;;; Drawer
1219 "Transcode a DRAWER element from Org to ASCII.
1220 CONTENTS holds the contents of the block. INFO is a plist
1221 holding contextual information."
1225 name contents width)))
1228 ;;;; Dynamic Block
1231 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1232 CONTENTS holds the contents of the block. INFO is a plist
1233 holding contextual information."
1234 contents)
1237 ;;;; Entity
1240 "Transcode an ENTITY object from Org to ASCII.
1241 CONTENTS are the definition itself. INFO is a plist holding
1242 contextual information."
1245 entity))
1248 ;;;; Example Block
1251 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1252 CONTENTS is nil. INFO is a plist holding contextual information."
1256 example-block info))
1259 ;;;; Export Snippet
1262 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1263 CONTENTS is nil. INFO is a plist holding contextual information."
1268 ;;;; Export Block
1271 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1272 CONTENTS is nil. INFO is a plist holding contextual information."
1278 ;;;; Fixed Width
1281 "Transcode a FIXED-WIDTH element from Org to ASCII.
1282 CONTENTS is nil. INFO is a plist holding contextual information."
1287 fixed-width info))
1290 ;;;; Footnote Definition
1292 ;; Footnote Definitions are ignored. They are compiled at the end of
1293 ;; the document, by `org-ascii-inner-template'.
1296 ;;;; Footnote Reference
1299 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1300 CONTENTS is nil. INFO is a plist holding contextual information."
1304 ;;;; Headline
1307 "Transcode a HEADLINE element from Org to ASCII.
1308 CONTENTS holds the contents of the headline. INFO is a plist
1309 holding contextual information."
1310 ;; Don't export footnote section, which will be handled at the end
1311 ;; of the template.
1315 ;; Export title early so that any link in it can be
1316 ;; exported and seen in `org-ascii--unique-links'.
1318 ;; Blank lines between headline and its contents.
1319 ;; `org-ascii-headline-spacing', when set, overwrites
1320 ;; original buffer's spacing.
1329 ;; Re-build contents, inserting section links at the right
1330 ;; place. The cost is low since build results are cached.
1336 first))))
1341 links
1345 ;; Deep subtree: export it as a list item.
1353 ;; Contents, indented by length of bullet.
1355 ;; Else: Standard headline.
1359 ;;;; Horizontal Rule
1362 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1363 CONTENTS is nil. INFO is a plist holding contextual
1364 information."
1371 text-width)
1376 ;;;; Inline Src Block
1379 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1380 CONTENTS holds the contents of the item. INFO is a plist holding
1381 contextual information."
1386 ;;;; Inlinetask
1390 "Format an inline task element for ASCII export.
1391 See `org-ascii-format-inlinetask-function' for a description
1392 of the parameters."
1397 ;; Top line, with an additional blank line if not in UTF-8.
1400 ;; Add title. Fill it if wider than inlinetask.
1405 ;; If CONTENTS is not empty, insert it along with
1406 ;; a separator.
1409 ;; Bottom line.
1411 ;; Flush the inlinetask to the right.
1418 "Transcode an INLINETASK element from Org to ASCII.
1419 CONTENTS holds the contents of the block. INFO is a plist
1420 holding contextual information."
1423 ;; todo.
1428 ;; todo-type
1430 ;; priority
1433 ;; title
1435 ;; tags
1438 ;; contents and width
1439 contents width inlinetask info)))
1442 ;;;; Italic
1445 "Transcode italic from Org to ASCII.
1446 CONTENTS is the text with italic markup. INFO is a plist holding
1447 contextual information."
1451 ;;;; Item
1454 "Transcode an ITEM element from Org to ASCII.
1455 CONTENTS holds the contents of the item. INFO is a plist holding
1456 contextual information."
1461 ;; First parent of ITEM is always the plain-list. Get
1462 ;; `:type' property from it.
1465 (`descriptive
1469 (`ordered
1470 ;; Return correct number for ITEM, paying attention to
1471 ;; counters.
1477 struct
1482 ;; Change bullets into more visible form if UTF-8 is active.
1490 bullet
1492 ;; Contents: Pay attention to indentation. Note: check-boxes are
1493 ;; already taken care of at the paragraph level so they don't
1494 ;; interfere with indentation.
1501 ;;;; Keyword
1504 "Transcode a KEYWORD element from Org to ASCII.
1505 CONTENTS is nil. INFO is a plist holding contextual
1506 information."
1524 keyword info)))))
1527 ;;;; Latex Environment
1530 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1531 CONTENTS is nil. INFO is a plist holding contextual
1532 information."
1536 latex-environment info)))
1539 ;;;; Latex Fragment
1542 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1543 CONTENTS is nil. INFO is a plist holding contextual
1544 information."
1549 ;;;; Line Break
1552 "Transcode a LINE-BREAK object from Org to ASCII.
1553 CONTENTS is nil. INFO is a plist holding contextual
1557 ;;;; Link
1560 "Transcode a LINK object from Org to ASCII.
1562 DESC is the description part of the link, or the empty string.
1563 INFO is a plist holding contextual information."
1571 ;; Do not apply a special syntax on radio links. Though, use
1572 ;; transcoded target's contents as output.
1585 ;; External file.
1587 (`headline
1593 ;; Handle enumerable elements and targets within them.
1599 ;; Don't know what to do. Signal it.
1609 ;;;; Node Properties
1612 "Transcode a NODE-PROPERTY element from Org to ASCII.
1613 CONTENTS is nil. INFO is a plist holding contextual
1614 information."
1621 ;;;; Paragraph
1624 "Transcode a PARAGRAPH element from Org to ASCII.
1625 CONTENTS is the contents of the paragraph, as a string. INFO is
1626 the plist used as a communication channel."
1631 ;; Do not indent first paragraph in a section.
1637 paragraph info))
1640 ;;;; Plain List
1643 "Transcode a PLAIN-LIST element from Org to ASCII.
1644 CONTENTS is the contents of the list. INFO is a plist holding
1645 contextual information."
1649 contents
1653 ;;;; Plain Text
1656 "Transcode a TEXT string from Org to ASCII.
1657 INFO is a plist used as a communication channel."
1664 ;; Usual replacements in utf-8 with proper option set.
1672 ;;;; Planning
1675 "Transcode a PLANNING element from Org to ASCII.
1676 CONTENTS is nil. INFO is a plist used as a communication
1677 channel."
1680 #'identity
1695 planning info))
1698 ;;;; Property Drawer
1701 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1702 CONTENTS holds the contents of the drawer. INFO is a plist
1703 holding contextual information."
1708 ;;;; Quote Block
1711 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1712 CONTENTS holds the contents of the block. INFO is a plist
1713 holding contextual information."
1717 ;;;; Radio Target
1720 "Transcode a RADIO-TARGET object from Org to ASCII.
1721 CONTENTS is the contents of the target. INFO is a plist holding
1722 contextual information."
1723 contents)
1726 ;;;; Section
1729 "Transcode a SECTION element from Org to ASCII.
1730 CONTENTS is the contents of the section. INFO is a plist holding
1731 contextual information."
1734 ;; Take care of links in first section of the document.
1739 info))))
1743 ;; Do not apply inner margin if parent headline is low level.
1749 ;;;; Special Block
1752 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1753 CONTENTS holds the contents of the block. INFO is a plist
1754 holding contextual information."
1755 ;; "JUSTIFYLEFT" and "JUSTFYRIGHT" have already been taken care of
1756 ;; at a lower level. There is no other special block type to
1757 ;; handle.
1758 contents)
1761 ;;;; Src Block
1764 "Transcode a SRC-BLOCK element from Org to ASCII.
1765 CONTENTS holds the contents of the item. INFO is a plist holding
1766 contextual information."
1776 src-block info))))
1779 ;;;; Statistics Cookie
1782 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1783 CONTENTS is nil. INFO is a plist holding contextual information."
1787 ;;;; Subscript
1790 "Transcode a SUBSCRIPT object from Org to ASCII.
1791 CONTENTS is the contents of the object. INFO is a plist holding
1792 contextual information."
1798 ;;;; Superscript
1801 "Transcode a SUPERSCRIPT object from Org to ASCII.
1802 CONTENTS is the contents of the object. INFO is a plist holding
1803 contextual information."
1809 ;;;; Strike-through
1812 "Transcode STRIKE-THROUGH from Org to ASCII.
1813 CONTENTS is text with strike-through markup. INFO is a plist
1814 holding contextual information."
1818 ;;;; Table
1821 "Transcode a TABLE element from Org to ASCII.
1822 CONTENTS is the contents of the table. INFO is a plist holding
1823 contextual information."
1828 ;; Possibly add a caption string above.
1830 ;; Insert table. Note: "table.el" tables are left unmodified.
1844 ;; Possible add a caption string below.
1846 table info)))
1849 ;;;; Table Cell
1852 "Return width of TABLE-CELL.
1854 INFO is a plist used as a communication channel.
1856 Width of a cell is determined either by a width cookie in the
1857 same column as the cell, or by the maximum cell's length in that
1858 column.
1860 When `org-ascii-table-widen-columns' is non-nil, width cookies
1861 are ignored."
1876 key
1888 info))
1889 max-width)))
1890 info)
1891 max-width)))
1895 cache))))
1898 "Transcode a TABLE-CELL object from Org to ASCII.
1899 CONTENTS is the cell contents. INFO is a plist used as
1900 a communication channel."
1901 ;; Determine column width. When `org-ascii-table-widen-columns'
1902 ;; is nil and some width cookie has set it, use that value.
1903 ;; Otherwise, compute the maximum width among transcoded data of
1904 ;; each cell in the column.
1906 ;; When contents are too large, truncate them.
1910 ;; Align contents correctly within the cell.
1915 contents width
1920 ;; Return cell.
1926 ;;;; Table Row
1929 "Transcode a TABLE-ROW element from Org to ASCII.
1930 CONTENTS is the row contents. INFO is a plist used as
1931 a communication channel."
1938 'concat
1944 ;; In order to know if CELL starts the row, do
1945 ;; not compare it with the first cell in the
1946 ;; row as there might be a special column.
1947 ;; Instead, compare it with first exportable
1948 ;; cell, obtained with `org-element-map'.
1952 cell))
1953 lcorner)
1958 rcorner)
1964 info)))
1979 ;;;; Timestamp
1982 "Transcode a TIMESTAMP object from Org to ASCII.
1983 CONTENTS is nil. INFO is a plist holding contextual information."
1987 ;;;; Underline
1990 "Transcode UNDERLINE from Org to ASCII.
1991 CONTENTS is the text with underline markup. INFO is a plist
1992 holding contextual information."
1996 ;;;; Verbatim
1999 "Return a VERBATIM object from Org to ASCII.
2000 CONTENTS is nil. INFO is a plist holding contextual information."
2005 ;;;; Verse Block
2008 "Transcode a VERSE-BLOCK element from Org to ASCII.
2009 CONTENTS is verse block contents. INFO is a plist holding
2010 contextual information."
2016 \f
2017 ;;; Filters
2020 "Filter controlling number of blank lines after a headline.
2022 HEADLINE is a string representing a transcoded headline. BACKEND
2023 is symbol specifying back-end used for export. INFO is plist
2024 containing the communication channel.
2026 This function only applies to `ascii' back-end. See
2027 `org-ascii-headline-spacing' for information."
2034 "Filter controlling number of blank lines between paragraphs.
2036 TREE is the parse tree. BACKEND is the symbol specifying
2037 back-end used for export. INFO is a plist used as
2038 a communication channel.
2040 See `org-ascii-paragraph-spacing' for information."
2048 tree)
2051 "Filter removing blank lines between comments.
2052 TREE is the parse tree. BACKEND is the symbol specifying
2053 back-end used for export. INFO is a plist used as
2054 a communication channel."
2060 tree)
2063 \f
2064 ;;; End-user functions
2066 ;;;###autoload
2069 "Export current buffer to a text buffer.
2071 If narrowing is active in the current buffer, only export its
2072 narrowed part.
2074 If a region is active, export that region.
2076 A non-nil optional argument ASYNC means the process should happen
2077 asynchronously. The resulting buffer should be accessible
2078 through the `org-export-stack' interface.
2080 When optional argument SUBTREEP is non-nil, export the sub-tree
2081 at point, extracting information from the headline properties
2082 first.
2084 When optional argument VISIBLE-ONLY is non-nil, don't export
2085 contents of hidden elements.
2087 When optional argument BODY-ONLY is non-nil, strip title and
2088 table of contents from output.
2090 EXT-PLIST, when provided, is a property list with external
2091 parameters overriding Org default settings, but still inferior to
2092 file-local settings.
2095 will be displayed when `org-export-show-temporary-export-buffer'
2096 is non-nil."
2101 ;;;###autoload
2104 "Export current buffer to a text file.
2106 If narrowing is active in the current buffer, only export its
2107 narrowed part.
2109 If a region is active, export that region.
2111 A non-nil optional argument ASYNC means the process should happen
2112 asynchronously. The resulting file should be accessible through
2113 the `org-export-stack' interface.
2115 When optional argument SUBTREEP is non-nil, export the sub-tree
2116 at point, extracting information from the headline properties
2117 first.
2119 When optional argument VISIBLE-ONLY is non-nil, don't export
2120 contents of hidden elements.
2122 When optional argument BODY-ONLY is non-nil, strip title and
2123 table of contents from output.
2125 EXT-PLIST, when provided, is a property list with external
2126 parameters overriding Org default settings, but still inferior to
2127 file-local settings.
2129 Return output file's name."
2133 async subtreep visible-only body-only ext-plist)))
2135 ;;;###autoload
2137 "Publish an Org file to ASCII.
2139 FILENAME is the filename of the Org file to be published. PLIST
2140 is the property list for the given project. PUB-DIR is the
2141 publishing directory.
2143 Return output file name."
2147 ;;;###autoload
2149 "Publish an Org file to Latin-1.
2151 FILENAME is the filename of the Org file to be published. PLIST
2152 is the property list for the given project. PUB-DIR is the
2153 publishing directory.
2155 Return output file name."
2159 ;;;###autoload
2161 "Publish an org file to UTF-8.
2163 FILENAME is the filename of the Org file to be published. PLIST
2164 is the property list for the given project. PUB-DIR is the
2165 publishing directory.
2167 Return output file name."
2174 ;; Local variables:
2175 ;; generated-autoload-file: "org-loaddefs.el"
2176 ;; coding: utf-8
2177 ;; End:
2179 ;;; ox-ascii.el ends here