| blob | f343d1462b86b2547192d65245ad9e71b6fc0745 |
1 ;;; ox-ascii.el --- ASCII Back-End for Org Export Engine
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements an ASCII back-end for Org generic exporter.
26 ;; See Org manual for more information.
28 ;;; Code:
36 ;;; Define Back-End
37 ;;
38 ;; The following setting won't allow to modify preferred charset
39 ;; through a buffer keyword or an option item, but, since the property
40 ;; will appear in communication channel nonetheless, it allows to
41 ;; override `org-ascii-charset' variable on the fly by the ext-plist
42 ;; mechanism.
43 ;;
44 ;; We also install a filter for headlines and sections, in order to
45 ;; control blank lines separating them in output string.
99 :menu-entry
120 (:filter-parse-tree org-ascii-filter-paragraph-spacing
121 org-ascii-filter-comment-spacing)
126 \f
127 ;;; User Configurable Variables
130 "Options for exporting Org mode files to ASCII."
135 "Maximum width of exported text.
136 This number includes margin size, as set in
137 `org-ascii-global-margin'."
144 "Width of the left margin, in number of characters."
151 "Width of the inner margin, in number of characters.
152 Inner margin is applied between each headline."
159 "Width of margin used for quoting text, in characters.
160 This margin is applied on both sides of the text."
167 "Width of inline tasks, in number of characters.
168 This number ignores any margin."
175 "Number of blank lines inserted around headlines.
177 This variable can be set to a cons cell. In that case, its car
178 represents the number of blank lines present before headline
179 contents whereas its cdr reflects the number of blank lines after
180 contents.
182 A nil value replicates the number of blank lines found in the
183 original Org buffer at the same place."
194 "Additional indentation width for the first line in a paragraph.
195 If the value is an integer, indent the first line of each
196 paragraph by this width, unless it is located at the beginning of
197 a section, in which case indentation is removed from that line.
198 If it is the symbol `auto' preserve indentation from original
199 document."
208 "Number of white lines between paragraphs.
209 If the value is an integer, add this number of blank lines
210 between contiguous paragraphs. If is it the symbol `auto', keep
211 the same number of blank lines as in the original document."
220 "The charset allowed to represent various elements and objects.
221 Possible values are:
222 `ascii' Only use plain ASCII characters
223 `latin1' Include Latin-1 characters
224 `utf-8' Use all UTF-8 characters"
236 "Characters for underlining headings in ASCII export.
238 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
239 and whose value is a list of characters.
241 For each supported charset, this variable associates a sequence
242 of underline characters. In a sequence, the characters will be
243 used in order for headlines level 1, 2, ... If no character is
244 available for a given level, the headline won't be underlined."
262 "Bullet characters for headlines converted to lists in ASCII export.
264 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
265 and whose value is a list of characters.
267 The first character is used for the first level considered as low
268 level, and so on. If there are more levels than characters given
269 here, the list will be repeated.
271 Note that this variable doesn't affect plain lists
272 representation."
288 "Non-nil means convert links to notes before the next headline.
289 When nil, the link will be exported in place. If the line
290 becomes long in this way, it will be wrapped."
297 "Non-nil means keep all vertical lines in ASCII tables.
298 When nil, vertical lines will be removed except for those needed
299 for column grouping."
306 "Non-nil means widen narrowed columns for export.
307 When nil, narrowed columns will look in ASCII export just like in
315 "Non-nil means table.el tables are turned into ascii-art.
317 It only makes sense when export charset is `utf-8'. It is nil by
318 default since it requires ascii-art-to-unicode.el package. You
319 can download it here:
321 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
328 "When non-nil, place caption string before the element.
329 Otherwise, place it right after it."
336 "Format string used for verbatim text and inline code."
344 "Function called to format a drawer in ASCII.
346 The function must accept three parameters:
348 CONTENTS the contents of the drawer.
349 WIDTH the text width within the drawer.
351 The function should return either the string to be exported or
352 nil to ignore the drawer.
354 The default value simply returns the value of CONTENTS."
361 'org-ascii-format-inlinetask-default
362 "Function called to format an inlinetask in ASCII.
364 The function must accept nine parameters:
365 TODO the todo keyword, as a string
366 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
367 PRIORITY the inlinetask priority, as a string
368 NAME the inlinetask name, as a string.
369 TAGS the inlinetask tags, as a list of strings.
370 CONTENTS the contents of the inlinetask, as a string.
371 WIDTH the width of the inlinetask, as a number.
372 INLINETASK the inlinetask itself.
373 INFO the info channel.
375 The function should return either the string to be exported or
376 nil to ignore the inline task."
383 \f
384 ;;; Internal Functions
386 ;; Internal functions fall into three categories.
388 ;; The first one is about text formatting. The core functions are
389 ;; `org-ascii--current-text-width' and
390 ;; `org-ascii--current-justification', which determine, respectively,
391 ;; the current text width allowed to a given element and its expected
392 ;; justification. Once this information is known,
393 ;; `org-ascii--fill-string', `org-ascii--justify-lines',
394 ;; `org-ascii--justify-element' `org-ascii--box-string' and
395 ;; `org-ascii--indent-string' can operate on a given output string.
396 ;; In particular, justification happens at the regular (i.e.,
397 ;; non-greater) element level, which means that when the exporting
398 ;; process reaches a container (e.g., a center block) content are
399 ;; already justified.
401 ;; The second category contains functions handling elements listings,
402 ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
403 ;; returns a complete table of contents, `org-ascii--list-listings'
404 ;; returns a list of referenceable src-block elements, and
405 ;; `org-ascii--list-tables' does the same for table elements.
407 ;; The third category includes general helper functions.
408 ;; `org-ascii--build-title' creates the title for a given headline
409 ;; or inlinetask element. `org-ascii--build-caption' returns the
410 ;; caption string associated to a table or a src-block.
411 ;; `org-ascii--describe-links' creates notes about links for
412 ;; insertion at the end of a section. It uses
413 ;; `org-ascii--unique-links' to get the list of links to describe.
414 ;; Eventually, `org-ascii--translate' translates a string according
415 ;; to language and charset specification.
419 "Fill a string with specified text-width and return it.
421 S is the string being filled. TEXT-WIDTH is an integer
422 specifying maximum length of a line. INFO is the plist used as
423 a communication channel.
425 Optional argument JUSTIFY can specify any type of justification
426 among `left', `center', `right' or `full'. A nil value is
427 equivalent to `left'. For a justification that doesn't also fill
428 string, see `org-ascii--justify-lines' and
429 `org-ascii--justify-block'.
431 Return nil if S isn't a string."
432 ;; Don't fill paragraph when break should be preserved.
445 "Justify all lines in string S.
446 TEXT-WIDTH is an integer specifying maximum length of a line.
447 HOW determines the type of justification: it can be `left',
448 `right', `full' or `center'."
453 ;; Disable `adaptive-fill-mode' so it doesn't prevent
454 ;; filling lines matching `adaptive-fill-regexp'.
462 "Justify CONTENTS of ELEMENT.
463 INFO is a plist used as a communication channel. Justification
464 is done according to the type of element. More accurately,
465 paragraphs are filled and other elements are justified as blocks,
466 that is according to the widest non blank line in CONTENTS."
471 ;; Paragraphs are treated specially as they also need to be
472 ;; filled.
480 ;; Compute maximum width. Bail out if it is greater
481 ;; than page width, since no justification is
482 ;; possible.
492 ;; Justify every line according to TEXT-WIDTH and
493 ;; MAX-WIDTH.
504 "Indent string S by WIDTH white spaces.
505 Empty lines are not indented."
511 "Return string S with a partial box to its left.
512 INFO is a plist used as a communication channel."
517 ;; Remove last newline character.
521 "Return maximum text width for ELEMENT's contents.
522 INFO is a plist used as a communication channel."
524 ;; Elements with an absolute width: `headline' and `inlinetask'.
530 ;; Elements with a relative width: store maximum text width in
531 ;; TOTAL-WIDTH.
534 ;; Total width is determined by the presence, or not, of an
535 ;; inline task among ELEMENT parents.
539 org-ascii-inlinetask-width
540 ;; No inlinetask: Remove global margin from text width.
542 org-ascii-global-margin
544 ;; Inner margin doesn't apply to text before first
545 ;; headline.
549 ;; Inner margin doesn't apply to contents of
550 ;; low level headlines, since they've got their
551 ;; own indentation mechanism.
553 org-ascii-inner-margin))))))))
555 ;; Each `quote-block' and `verse-block' above narrows text
556 ;; width by twice the standard margin size.
560 count parent)
562 ;; Text width within a plain-list is restricted by
563 ;; indentation of current item. If that's the case,
564 ;; compute it with the help of `:structure' property from
565 ;; parent item, if any.
570 return parent))))
572 ;; Compute indentation offset of the current item,
573 ;; that is the sum of the difference between its
574 ;; indentation and the indentation of the top item in
575 ;; the list and current item bullet's length. Also
576 ;; remove checkbox length, and tag length (for
577 ;; description lists) or bullet length.
590 "Return expected justification for ELEMENT's contents.
591 Return value is a symbol among `left', `center', `right' and
592 `full'."
606 "Format ELEMENT title and return it.
608 ELEMENT is either an `headline' or `inlinetask' element. INFO is
609 a plist used as a communication channel. TEXT-WIDTH is an
610 integer representing the maximum length of a line.
612 When optional argument UNDERLINE is non-nil, underline title,
613 without the tags, according to `org-ascii-underline'
614 specifications.
616 If optional argument NOTAGS is non-nil, no tags will be added to
617 the title.
619 When optional argument TOC is non-nil, use optional title if
620 possible. It doesn't apply to `inlinetask' elements."
623 ;; Numbering is specific to headlines.
625 ;; All tests passed: build numbering string.
628 'number-to-string
636 info)))
653 first-part
654 ;; Align tags, if any.
660 tags))
661 ;; Maybe underline text, if ELEMENT type is `headline' and an
662 ;; underline character has been defined.
667 org-ascii-underline)))))
672 under-char))))))))
675 "Non-nil when ELEMENT has a caption affiliated keyword.
676 INFO is a plist used as a communication channel. This function
677 is meant to be used as a predicate for `org-export-get-ordinal'."
681 "Return caption string for ELEMENT, if applicable.
683 INFO is a plist used as a communication channel.
685 The caption string contains the sequence number of ELEMENT along
686 with its real caption. Return nil when ELEMENT has no affiliated
687 caption keyword."
690 ;; Get sequence number of current src-block among every
691 ;; src-block with a caption.
699 info)))
702 " "
707 "Return a table of contents.
709 INFO is a plist used as a communication channel.
711 Optional argument N, when non-nil, is an integer specifying the
712 depth of the table.
714 Optional argument KEYWORD specifies the TOC keyword, if any, from
715 which the table of contents generation has been initiated."
739 "Return a list of listings.
741 KEYWORD is the keyword that initiated the list of listings
742 generation. INFO is a plist used as a communication channel."
752 ;; Use a counter instead of retrieving ordinal of each
753 ;; src-block.
757 ;; Store initial text so its length can be computed. This is
758 ;; used to properly align caption right to it in case of
759 ;; filling (like contents of a description list item).
765 initial-text " "
769 ;; Use short name in priority, if available.
774 initial-width)))))
778 "Return a list of tables.
780 KEYWORD is the keyword that initiated the list of tables
781 generation. INFO is a plist used as a communication channel."
791 ;; Use a counter instead of retrieving ordinal of each
792 ;; src-block.
796 ;; Store initial text so its length can be computed. This is
797 ;; used to properly align caption right to it in case of
798 ;; filling (like contents of a description list item).
804 initial-text " "
808 ;; Use short name in priority, if available.
813 initial-width)))))
817 "Return a list of unique link references in ELEMENT.
818 ELEMENT is either a headline element or a section element. INFO
819 is a plist used as a communication channel."
823 ;; Return LINK if it wasn't referenced so far, or nil.
824 ;; Update SEEN links along the way.
827 ;; Normalize description in footprints.
835 ;; Ignore LINK if it hasn't been translated already.
836 ;; It can happen if it is located in an affiliated
837 ;; keyword that was ignored.
842 ;; If at a section, find parent headline, if any, in order to
843 ;; count links that might be in the title.
847 ;; Get all links in HEADLINE.
852 "Return a string describing a list of links.
854 LINKS is a list of link type objects, as returned by
855 `org-ascii--unique-links'. WIDTH is the text width allowed for
856 the output string. INFO is a plist used as a communication
857 channel."
865 ;; Coderefs, radio links and fuzzy links are ignored.
867 ;; Id and custom-id links: Headlines refer to their numbering.
873 "[%s] %s"
874 anchor
881 ;; Do not add a link that cannot be resolved and doesn't have
882 ;; any description: destination is already visible in the
883 ;; paragraph.
889 width info)
894 "Return checkbox string for ITEM or nil.
895 INFO is a plist used as a communication channel."
903 \f
904 ;;; Template
907 "Return document title, as a string.
908 INFO is a plist used as a communication channel."
910 ;; Links in the title will not be resolved later, so we make
911 ;; sure their path is located right after them.
921 ;; There are two types of title blocks depending on the presence
922 ;; of a title to display.
924 ;; Title block without a title. DATE is positioned at the top
925 ;; right of the document, AUTHOR to the top left and EMAIL
926 ;; just below.
930 author
932 ?\s)
933 date
938 email
940 ?\s)
950 ;; Title block with a title. Document's TITLE, along with the
951 ;; AUTHOR and its EMAIL are both overlined and an underlined,
952 ;; centered. Date is just below, also centered.
954 ;; Format TITLE. It may be filled if it is too wide,
955 ;; that is wider than the two thirds of the total width.
981 "Return complete document string after ASCII conversion.
982 CONTENTS is the transcoded contents string. INFO is a plist
983 holding export options."
987 ;; 1. Document's body.
988 contents
989 ;; 2. Footnote definitions.
992 ;; Insert full links right inside the footnote definition
993 ;; as they have no chance to be inserted later.
1009 ;; Distinguish between inline definitions and
1010 ;; full-fledged definitions.
1014 ;; Full-fledged definition: footnote ID is
1015 ;; inserted inside the first parsed paragraph
1016 ;; (FIRST), if any, to be sure filling will
1017 ;; take it into consideration.
1023 ;; Fill paragraph once footnote ID is inserted
1024 ;; in order to have a correct length for first
1025 ;; line.
1028 text-width info))))))
1030 org-ascii-global-margin)))
1033 "Return complete document string after ASCII conversion.
1034 CONTENTS is the transcoded contents string. INFO is a plist
1035 holding export options."
1037 ;; 1. Build title block.
1040 ;; 2. Table of contents.
1046 org-ascii-global-margin)
1047 ;; 3. Document's body.
1048 contents
1049 ;; 4. Creator. Ignore `comment' value as there are no comments in
1050 ;; ASCII. Justify it to the bottom right.
1059 org-ascii-global-margin)))
1062 "Translate string S according to specified language and charset.
1063 INFO is a plist used as a communication channel."
1068 \f
1069 ;;; Transcode Functions
1071 ;;;; Bold
1074 "Transcode BOLD from Org to ASCII.
1075 CONTENTS is the text with bold markup. INFO is a plist holding
1076 contextual information."
1080 ;;;; Center Block
1083 "Transcode a CENTER-BLOCK element from Org to ASCII.
1084 CONTENTS holds the contents of the block. INFO is a plist
1085 holding contextual information."
1086 ;; Center has already been taken care of at a lower level, so
1087 ;; there's nothing left to do.
1088 contents)
1091 ;;;; Clock
1094 "Transcode a CLOCK object from Org to ASCII.
1095 CONTENTS is nil. INFO is a plist holding contextual
1096 information."
1106 "%2s:%02s"
1108 clock info))
1111 ;;;; Code
1114 "Return a CODE object from Org to ASCII.
1115 CONTENTS is nil. INFO is a plist holding contextual
1116 information."
1120 ;;;; Drawer
1123 "Transcode a DRAWER element from Org to ASCII.
1124 CONTENTS holds the contents of the block. INFO is a plist
1125 holding contextual information."
1131 ;;;; Dynamic Block
1134 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1135 CONTENTS holds the contents of the block. INFO is a plist
1136 holding contextual information."
1137 contents)
1140 ;;;; Entity
1143 "Transcode an ENTITY object from Org to ASCII.
1144 CONTENTS are the definition itself. INFO is a plist holding
1145 contextual information."
1148 entity))
1151 ;;;; Example Block
1154 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1155 CONTENTS is nil. INFO is a plist holding contextual information."
1159 example-block info))
1162 ;;;; Export Snippet
1165 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1166 CONTENTS is nil. INFO is a plist holding contextual information."
1171 ;;;; Export Block
1174 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1175 CONTENTS is nil. INFO is a plist holding contextual information."
1181 ;;;; Fixed Width
1184 "Transcode a FIXED-WIDTH element from Org to ASCII.
1185 CONTENTS is nil. INFO is a plist holding contextual information."
1190 fixed-width info))
1193 ;;;; Footnote Definition
1195 ;; Footnote Definitions are ignored. They are compiled at the end of
1196 ;; the document, by `org-ascii-inner-template'.
1199 ;;;; Footnote Reference
1202 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1203 CONTENTS is nil. INFO is a plist holding contextual information."
1207 ;;;; Headline
1210 "Transcode a HEADLINE element from Org to ASCII.
1211 CONTENTS holds the contents of the headline. INFO is a plist
1212 holding contextual information."
1213 ;; Don't export footnote section, which will be handled at the end
1214 ;; of the template.
1218 ;; Blank lines between headline and its contents.
1219 ;; `org-ascii-headline-spacing', when set, overwrites
1220 ;; original buffer's spacing.
1225 ;; Even if HEADLINE has no section, there might be some
1226 ;; links in its title that we shouldn't forget to describe.
1233 ;; Deep subtree: export it as a list item.
1236 ;; Bullet.
1238 org-ascii-bullets))))
1241 " "
1242 ;; Title.
1244 ;; Contents, indented by length of bullet.
1245 pre-blanks
1250 ;; Else: Standard headline.
1257 ;;;; Horizontal Rule
1260 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1261 CONTENTS is nil. INFO is a plist holding contextual
1262 information."
1269 text-width)
1274 ;;;; Inline Src Block
1277 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1278 CONTENTS holds the contents of the item. INFO is a plist holding
1279 contextual information."
1284 ;;;; Inlinetask
1288 "Format an inline task element for ASCII export.
1289 See `org-ascii-format-inlinetask-function' for a description
1290 of the parameters."
1295 ;; Top line, with an additional blank line if not in UTF-8.
1298 ;; Add title. Fill it if wider than inlinetask.
1303 ;; If CONTENTS is not empty, insert it along with
1304 ;; a separator.
1307 ;; Bottom line.
1309 ;; Flush the inlinetask to the right.
1312 org-ascii-inner-margin)
1316 "Transcode an INLINETASK element from Org to ASCII.
1317 CONTENTS holds the contents of the block. INFO is a plist
1318 holding contextual information."
1321 ;; todo.
1326 ;; todo-type
1328 ;; priority
1331 ;; title
1333 ;; tags
1336 ;; contents and width
1337 contents width inlinetask info)))
1340 ;;;; Italic
1343 "Transcode italic from Org to ASCII.
1344 CONTENTS is the text with italic markup. INFO is a plist holding
1345 contextual information."
1349 ;;;; Item
1352 "Transcode an ITEM element from Org to ASCII.
1353 CONTENTS holds the contents of the item. INFO is a plist holding
1354 contextual information."
1359 ;; First parent of ITEM is always the plain-list. Get
1360 ;; `:type' property from it.
1368 ;; Return correct number for ITEM, paying attention to
1369 ;; counters.
1375 struct
1380 ;; Change bullets into more visible form if UTF-8 is active.
1388 bullet
1390 ;; Contents: Pay attention to indentation. Note: check-boxes are
1391 ;; already taken care of at the paragraph level so they don't
1392 ;; interfere with indentation.
1399 ;;;; Keyword
1402 "Transcode a KEYWORD element from Org to ASCII.
1403 CONTENTS is nil. INFO is a plist holding contextual
1404 information."
1424 keyword info)))))
1427 ;;;; Latex Environment
1430 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1431 CONTENTS is nil. INFO is a plist holding contextual
1432 information."
1436 latex-environment info)))
1439 ;;;; Latex Fragment
1442 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1443 CONTENTS is nil. INFO is a plist holding contextual
1444 information."
1449 ;;;; Line Break
1452 "Transcode a LINE-BREAK object from Org to ASCII.
1453 CONTENTS is nil. INFO is a plist holding contextual
1457 ;;;; Link
1460 "Transcode a LINK object from Org to ASCII.
1462 DESC is the description part of the link, or the empty string.
1463 INFO is a plist holding contextual information."
1471 ;; Do not apply a special syntax on radio links. Though, use
1472 ;; transcoded target's contents as output.
1474 ;; Do not apply a special syntax on fuzzy links pointing to
1475 ;; targets.
1493 ;;;; Node Properties
1496 "Transcode a NODE-PROPERTY element from Org to ASCII.
1497 CONTENTS is nil. INFO is a plist holding contextual
1498 information."
1505 ;;;; Paragraph
1508 "Transcode a PARAGRAPH element from Org to ASCII.
1509 CONTENTS is the contents of the paragraph, as a string. INFO is
1510 the plist used as a communication channel."
1514 ;; Do not indent first paragraph in a section.
1520 paragraph info))
1523 ;;;; Plain List
1526 "Transcode a PLAIN-LIST element from Org to ASCII.
1527 CONTENTS is the contents of the list. INFO is a plist holding
1528 contextual information."
1529 contents)
1532 ;;;; Plain Text
1535 "Transcode a TEXT string from Org to ASCII.
1536 INFO is a plist used as a communication channel."
1543 ;; Usual replacements in utf-8 with proper option set.
1551 ;;;; Planning
1554 "Transcode a PLANNING element from Org to ASCII.
1555 CONTENTS is nil. INFO is a plist used as a communication
1556 channel."
1559 #'identity
1577 planning info))
1580 ;;;; Property Drawer
1583 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1584 CONTENTS holds the contents of the drawer. INFO is a plist
1585 holding contextual information."
1590 ;;;; Quote Block
1593 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1594 CONTENTS holds the contents of the block. INFO is a plist
1595 holding contextual information."
1599 ;;;; Radio Target
1602 "Transcode a RADIO-TARGET object from Org to ASCII.
1603 CONTENTS is the contents of the target. INFO is a plist holding
1604 contextual information."
1605 contents)
1608 ;;;; Section
1611 "Transcode a SECTION element from Org to ASCII.
1612 CONTENTS is the contents of the section. INFO is a plist holding
1613 contextual information."
1616 contents
1618 ;; Add list of links at the end of SECTION.
1622 ;; Separate list of links and section contents.
1624 ;; Do not apply inner margin if parent headline is low level.
1627 org-ascii-inner-margin))))
1630 ;;;; Special Block
1633 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1634 CONTENTS holds the contents of the block. INFO is a plist
1635 holding contextual information."
1636 ;; "JUSTIFYLEFT" and "JUSTFYRIGHT" have already been taken care of
1637 ;; at a lower level. There is no other special block type to
1638 ;; handle.
1639 contents)
1642 ;;;; Src Block
1645 "Transcode a SRC-BLOCK element from Org to ASCII.
1646 CONTENTS holds the contents of the item. INFO is a plist holding
1647 contextual information."
1657 src-block info))))
1660 ;;;; Statistics Cookie
1663 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1664 CONTENTS is nil. INFO is a plist holding contextual information."
1668 ;;;; Subscript
1671 "Transcode a SUBSCRIPT object from Org to ASCII.
1672 CONTENTS is the contents of the object. INFO is a plist holding
1673 contextual information."
1679 ;;;; Superscript
1682 "Transcode a SUPERSCRIPT object from Org to ASCII.
1683 CONTENTS is the contents of the object. INFO is a plist holding
1684 contextual information."
1690 ;;;; Strike-through
1693 "Transcode STRIKE-THROUGH from Org to ASCII.
1694 CONTENTS is text with strike-through markup. INFO is a plist
1695 holding contextual information."
1699 ;;;; Table
1702 "Transcode a TABLE element from Org to ASCII.
1703 CONTENTS is the contents of the table. INFO is a plist holding
1704 contextual information."
1708 ;; Possibly add a caption string above.
1710 ;; Insert table. Note: "table.el" tables are left unmodified.
1724 ;; Possible add a caption string below.
1726 table info)))
1729 ;;;; Table Cell
1732 "Return width of TABLE-CELL.
1734 INFO is a plist used as a communication channel.
1736 Width of a cell is determined either by a width cookie in the
1737 same column as the cell, or by the maximum cell's length in that
1738 column.
1740 When `org-ascii-table-widen-columns' is non-nil, width cookies
1741 are ignored."
1755 key
1766 info))
1767 max-width)))
1768 info)
1769 max-width))
1770 cache))))
1773 "Transcode a TABLE-CELL object from Org to ASCII.
1774 CONTENTS is the cell contents. INFO is a plist used as
1775 a communication channel."
1776 ;; Determine column width. When `org-ascii-table-widen-columns'
1777 ;; is nil and some width cookie has set it, use that value.
1778 ;; Otherwise, compute the maximum width among transcoded data of
1779 ;; each cell in the column.
1781 ;; When contents are too large, truncate them.
1785 ;; Align contents correctly within the cell.
1790 contents width
1795 ;; Return cell.
1801 ;;;; Table Row
1804 "Transcode a TABLE-ROW element from Org to ASCII.
1805 CONTENTS is the row contents. INFO is a plist used as
1806 a communication channel."
1813 'concat
1819 ;; In order to know if CELL starts the row, do
1820 ;; not compare it with the first cell in the
1821 ;; row as there might be a special column.
1822 ;; Instead, compare it with first exportable
1823 ;; cell, obtained with `org-element-map'.
1827 cell))
1828 lcorner)
1833 rcorner)
1839 info)))
1854 ;;;; Timestamp
1857 "Transcode a TIMESTAMP object from Org to ASCII.
1858 CONTENTS is nil. INFO is a plist holding contextual information."
1862 ;;;; Underline
1865 "Transcode UNDERLINE from Org to ASCII.
1866 CONTENTS is the text with underline markup. INFO is a plist
1867 holding contextual information."
1871 ;;;; Verbatim
1874 "Return a VERBATIM object from Org to ASCII.
1875 CONTENTS is nil. INFO is a plist holding contextual information."
1880 ;;;; Verse Block
1883 "Transcode a VERSE-BLOCK element from Org to ASCII.
1884 CONTENTS is verse block contents. INFO is a plist holding
1885 contextual information."
1889 org-ascii-quote-margin)))
1892 \f
1893 ;;; Filters
1896 "Filter controlling number of blank lines after a headline.
1898 HEADLINE is a string representing a transcoded headline.
1899 BACK-END is symbol specifying back-end used for export. INFO is
1900 plist containing the communication channel.
1902 This function only applies to `ascii' back-end. See
1903 `org-ascii-headline-spacing' for information."
1909 "Filter controlling number of blank lines between paragraphs.
1911 TREE is the parse tree. BACK-END is the symbol specifying
1912 back-end used for export. INFO is a plist used as
1913 a communication channel.
1915 See `org-ascii-paragraph-spacing' for information."
1923 tree)
1926 "Filter removing blank lines between comments.
1927 TREE is the parse tree. BACK-END is the symbol specifying
1928 back-end used for export. INFO is a plist used as
1929 a communication channel."
1935 tree)
1938 \f
1939 ;;; End-user functions
1941 ;;;###autoload
1944 "Export current buffer to a text buffer.
1946 If narrowing is active in the current buffer, only export its
1947 narrowed part.
1949 If a region is active, export that region.
1951 A non-nil optional argument ASYNC means the process should happen
1952 asynchronously. The resulting buffer should be accessible
1953 through the `org-export-stack' interface.
1955 When optional argument SUBTREEP is non-nil, export the sub-tree
1956 at point, extracting information from the headline properties
1957 first.
1959 When optional argument VISIBLE-ONLY is non-nil, don't export
1960 contents of hidden elements.
1962 When optional argument BODY-ONLY is non-nil, strip title and
1963 table of contents from output.
1965 EXT-PLIST, when provided, is a property list with external
1966 parameters overriding Org default settings, but still inferior to
1967 file-local settings.
1970 will be displayed when `org-export-show-temporary-export-buffer'
1971 is non-nil."
1976 ;;;###autoload
1979 "Export current buffer to a text file.
1981 If narrowing is active in the current buffer, only export its
1982 narrowed part.
1984 If a region is active, export that region.
1986 A non-nil optional argument ASYNC means the process should happen
1987 asynchronously. The resulting file should be accessible through
1988 the `org-export-stack' interface.
1990 When optional argument SUBTREEP is non-nil, export the sub-tree
1991 at point, extracting information from the headline properties
1992 first.
1994 When optional argument VISIBLE-ONLY is non-nil, don't export
1995 contents of hidden elements.
1997 When optional argument BODY-ONLY is non-nil, strip title and
1998 table of contents from output.
2000 EXT-PLIST, when provided, is a property list with external
2001 parameters overriding Org default settings, but still inferior to
2002 file-local settings.
2004 Return output file's name."
2008 async subtreep visible-only body-only ext-plist)))
2010 ;;;###autoload
2012 "Publish an Org file to ASCII.
2014 FILENAME is the filename of the Org file to be published. PLIST
2015 is the property list for the given project. PUB-DIR is the
2016 publishing directory.
2018 Return output file name."
2022 ;;;###autoload
2024 "Publish an Org file to Latin-1.
2026 FILENAME is the filename of the Org file to be published. PLIST
2027 is the property list for the given project. PUB-DIR is the
2028 publishing directory.
2030 Return output file name."
2034 ;;;###autoload
2036 "Publish an org file to UTF-8.
2038 FILENAME is the filename of the Org file to be published. PLIST
2039 is the property list for the given project. PUB-DIR is the
2040 publishing directory.
2042 Return output file name."
2049 ;; Local variables:
2050 ;; generated-autoload-file: "org-loaddefs.el"
2051 ;; coding: utf-8-emacs
2052 ;; End:
2054 ;;; ox-ascii.el ends here