| blob | 820d763c17bed4647bd8771e6aa72e7d81eb7a38 |
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)
123 :options-alist
129 (:ascii-format-inlinetask-function
130 nil nil org-ascii-format-inlinetask-function)
139 (:ascii-table-keep-all-vertical-lines
140 nil nil org-ascii-table-keep-all-vertical-lines)
148 \f
149 ;;; User Configurable Variables
152 "Options for exporting Org mode files to ASCII."
157 "Maximum width of exported text.
158 This number includes margin size, as set in
159 `org-ascii-global-margin'."
166 "Width of the left margin, in number of characters."
173 "Width of the inner margin, in number of characters.
174 Inner margin is applied between each headline."
181 "Width of margin used for quoting text, in characters.
182 This margin is applied on both sides of the text."
189 "Width of margin used for plain lists, in characters.
190 This margin applies to top level list only, not to its
191 sub-lists."
198 "Width of inline tasks, in number of characters.
199 This number ignores any margin."
206 "Number of blank lines inserted around headlines.
208 This variable can be set to a cons cell. In that case, its car
209 represents the number of blank lines present before headline
210 contents whereas its cdr reflects the number of blank lines after
211 contents.
213 A nil value replicates the number of blank lines found in the
214 original Org buffer at the same place."
225 "Additional indentation width for the first line in a paragraph.
226 If the value is an integer, indent the first line of each
227 paragraph by this width, unless it is located at the beginning of
228 a section, in which case indentation is removed from that line.
229 If it is the symbol `auto' preserve indentation from original
230 document."
239 "Number of white lines between paragraphs.
240 If the value is an integer, add this number of blank lines
241 between contiguous paragraphs. If is it the symbol `auto', keep
242 the same number of blank lines as in the original document."
251 "The charset allowed to represent various elements and objects.
252 Possible values are:
253 `ascii' Only use plain ASCII characters
254 `latin1' Include Latin-1 characters
255 `utf-8' Use all UTF-8 characters"
267 "Characters for underlining headings in ASCII export.
269 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
270 and whose value is a list of characters.
272 For each supported charset, this variable associates a sequence
273 of underline characters. In a sequence, the characters will be
274 used in order for headlines level 1, 2, ... If no character is
275 available for a given level, the headline won't be underlined."
293 "Bullet characters for headlines converted to lists in ASCII export.
295 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
296 and whose value is a list of characters.
298 The first character is used for the first level considered as low
299 level, and so on. If there are more levels than characters given
300 here, the list will be repeated.
302 Note that this variable doesn't affect plain lists
303 representation."
319 "Non-nil means convert links to notes before the next headline.
320 When nil, the link will be exported in place. If the line
321 becomes long in this way, it will be wrapped."
328 "Non-nil means keep all vertical lines in ASCII tables.
329 When nil, vertical lines will be removed except for those needed
330 for column grouping."
337 "Non-nil means widen narrowed columns for export.
338 When nil, narrowed columns will look in ASCII export just like in
346 "Non-nil means table.el tables are turned into ascii-art.
348 It only makes sense when export charset is `utf-8'. It is nil by
349 default since it requires ascii-art-to-unicode.el package. You
350 can download it here:
352 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
359 "When non-nil, place caption string before the element.
360 Otherwise, place it right after it."
367 "Format string used for verbatim text and inline code."
375 "Function called to format a drawer in ASCII.
377 The function must accept three parameters:
379 CONTENTS the contents of the drawer.
380 WIDTH the text width within the drawer.
382 The function should return either the string to be exported or
383 nil to ignore the drawer.
385 The default value simply returns the value of CONTENTS."
392 'org-ascii-format-inlinetask-default
393 "Function called to format an inlinetask in ASCII.
395 The function must accept nine parameters:
396 TODO the todo keyword, as a string
397 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
398 PRIORITY the inlinetask priority, as a string
399 NAME the inlinetask name, as a string.
400 TAGS the inlinetask tags, as a list of strings.
401 CONTENTS the contents of the inlinetask, as a string.
402 WIDTH the width of the inlinetask, as a number.
403 INLINETASK the inlinetask itself.
404 INFO the info channel.
406 The function should return either the string to be exported or
407 nil to ignore the inline task."
414 \f
415 ;;; Internal Functions
417 ;; Internal functions fall into three categories.
419 ;; The first one is about text formatting. The core functions are
420 ;; `org-ascii--current-text-width' and
421 ;; `org-ascii--current-justification', which determine, respectively,
422 ;; the current text width allowed to a given element and its expected
423 ;; justification. Once this information is known,
424 ;; `org-ascii--fill-string', `org-ascii--justify-lines',
425 ;; `org-ascii--justify-element' `org-ascii--box-string' and
426 ;; `org-ascii--indent-string' can operate on a given output string.
427 ;; In particular, justification happens at the regular (i.e.,
428 ;; non-greater) element level, which means that when the exporting
429 ;; process reaches a container (e.g., a center block) content are
430 ;; already justified.
432 ;; The second category contains functions handling elements listings,
433 ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
434 ;; returns a complete table of contents, `org-ascii--list-listings'
435 ;; returns a list of referenceable src-block elements, and
436 ;; `org-ascii--list-tables' does the same for table elements.
438 ;; The third category includes general helper functions.
439 ;; `org-ascii--build-title' creates the title for a given headline
440 ;; or inlinetask element. `org-ascii--build-caption' returns the
441 ;; caption string associated to a table or a src-block.
442 ;; `org-ascii--describe-links' creates notes about links for
443 ;; insertion at the end of a section. It uses
444 ;; `org-ascii--unique-links' to get the list of links to describe.
445 ;; Eventually, `org-ascii--translate' translates a string according
446 ;; to language and charset specification.
450 "Fill a string with specified text-width and return it.
452 S is the string being filled. TEXT-WIDTH is an integer
453 specifying maximum length of a line. INFO is the plist used as
454 a communication channel.
456 Optional argument JUSTIFY can specify any type of justification
457 among `left', `center', `right' or `full'. A nil value is
458 equivalent to `left'. For a justification that doesn't also fill
459 string, see `org-ascii--justify-lines' and
460 `org-ascii--justify-block'.
462 Return nil if S isn't a string."
471 s))
476 "Justify all lines in string S.
477 TEXT-WIDTH is an integer specifying maximum length of a line.
478 HOW determines the type of justification: it can be `left',
479 `right', `full' or `center'."
484 ;; Disable `adaptive-fill-mode' so it doesn't prevent
485 ;; filling lines matching `adaptive-fill-regexp'.
493 "Justify CONTENTS of ELEMENT.
494 INFO is a plist used as a communication channel. Justification
495 is done according to the type of element. More accurately,
496 paragraphs are filled and other elements are justified as blocks,
497 that is according to the widest non blank line in CONTENTS."
503 ;; Paragraphs are treated specially as they need to be filled.
511 ;; Compute maximum width. Bail out if it is greater
512 ;; than page width, since no justification is
513 ;; possible.
523 ;; Justify every line according to TEXT-WIDTH and
524 ;; MAX-WIDTH.
535 "Indent string S by WIDTH white spaces.
536 Empty lines are not indented."
542 "Return string S with a partial box to its left.
543 INFO is a plist used as a communication channel."
548 ;; Remove last newline character.
552 "Return maximum text width for ELEMENT's contents.
553 INFO is a plist used as a communication channel."
555 ;; Elements with an absolute width: `headline' and `inlinetask'.
562 ;; Elements with a relative width: store maximum text width in
563 ;; TOTAL-WIDTH.
566 ;; Total width is determined by the presence, or not, of an
567 ;; inline task among ELEMENT parents.
572 ;; No inlinetask: Remove global margin from text width.
576 ;; Inner margin doesn't apply to text before first
577 ;; headline.
581 ;; Inner margin doesn't apply to contents of
582 ;; low level headlines, since they've got their
583 ;; own indentation mechanism.
587 ;; Each `quote-block' and `verse-block' above narrows text
588 ;; width by twice the standard margin size.
592 count parent)
594 ;; Apply list margin once per "top-level" plain-list
595 ;; containing current line
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 return parent))))
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.
631 "Return expected justification for ELEMENT's contents.
632 Return value is a symbol among `left', `center', `right' and
633 `full'."
647 "Format ELEMENT title and return it.
649 ELEMENT is either an `headline' or `inlinetask' element. INFO is
650 a plist used as a communication channel. TEXT-WIDTH is an
651 integer representing the maximum length of a line.
653 When optional argument UNDERLINE is non-nil, underline title,
654 without the tags, according to `org-ascii-underline'
655 specifications.
657 If optional argument NOTAGS is non-nil, no tags will be added to
658 the title.
660 When optional argument TOC is non-nil, use optional title if
661 possible. It doesn't apply to `inlinetask' elements."
664 ;; Numbering is specific to headlines.
666 ;; All tests passed: build numbering string.
669 'number-to-string
677 info)))
694 first-part
695 ;; Align tags, if any.
701 tags))
702 ;; Maybe underline text, if ELEMENT type is `headline' and an
703 ;; underline character has been defined.
713 under-char))))))))
716 "Non-nil when ELEMENT has a caption affiliated keyword.
717 INFO is a plist used as a communication channel. This function
718 is meant to be used as a predicate for `org-export-get-ordinal'."
722 "Return caption string for ELEMENT, if applicable.
724 INFO is a plist used as a communication channel.
726 The caption string contains the sequence number of ELEMENT along
727 with its real caption. Return nil when ELEMENT has no affiliated
728 caption keyword."
731 ;; Get sequence number of current src-block among every
732 ;; src-block with a caption.
740 info)))
743 " "
748 "Return a table of contents.
750 INFO is a plist used as a communication channel.
752 Optional argument N, when non-nil, is an integer specifying the
753 depth of the table.
755 Optional argument KEYWORD specifies the TOC keyword, if any, from
756 which the table of contents generation has been initiated."
781 "Return a list of listings.
783 KEYWORD is the keyword that initiated the list of listings
784 generation. INFO is a plist used as a communication channel."
795 ;; Use a counter instead of retrieving ordinal of each
796 ;; src-block.
800 ;; Store initial text so its length can be computed. This is
801 ;; used to properly align caption right to it in case of
802 ;; filling (like contents of a description list item).
808 initial-text " "
812 ;; Use short name in priority, if available.
817 initial-width)))))
821 "Return a list of tables.
823 KEYWORD is the keyword that initiated the list of tables
824 generation. INFO is a plist used as a communication channel."
835 ;; Use a counter instead of retrieving ordinal of each
836 ;; src-block.
840 ;; Store initial text so its length can be computed. This is
841 ;; used to properly align caption right to it in case of
842 ;; filling (like contents of a description list item).
848 initial-text " "
852 ;; Use short name in priority, if available.
857 initial-width)))))
861 "Return a list of unique link references in ELEMENT.
862 ELEMENT is either a headline element or a section element. INFO
863 is a plist used as a communication channel."
867 ;; Return LINK if it wasn't referenced so far, or nil.
868 ;; Update SEEN links along the way.
871 ;; Normalize description in footprints.
879 ;; Ignore LINK if it hasn't been translated already.
880 ;; It can happen if it is located in an affiliated
881 ;; keyword that was ignored.
886 ;; If at a section, find parent headline, if any, in order to
887 ;; count links that might be in the title.
891 ;; Get all links in HEADLINE.
896 "Return a string describing a list of links.
898 LINKS is a list of link type objects, as returned by
899 `org-ascii--unique-links'. WIDTH is the text width allowed for
900 the output string. INFO is a plist used as a communication
901 channel."
909 ;; Coderefs, radio links and fuzzy links are ignored.
911 ;; Id and custom-id links: Headlines refer to their numbering.
917 "[%s] %s"
918 anchor
925 ;; Do not add a link that cannot be resolved and doesn't have
926 ;; any description: destination is already visible in the
927 ;; paragraph.
929 ;; Do not add a link already handled by custom export
930 ;; functions.
935 nil)
940 width info)
945 "Return checkbox string for ITEM or nil.
946 INFO is a plist used as a communication channel."
954 \f
955 ;;; Template
958 "Return document title, as a string.
959 INFO is a plist used as a communication channel."
961 ;; Links in the title will not be resolved later, so we make
962 ;; sure their path is located right after them.
972 ;; There are two types of title blocks depending on the presence
973 ;; of a title to display.
975 ;; Title block without a title. DATE is positioned at the top
976 ;; right of the document, AUTHOR to the top left and EMAIL
977 ;; just below.
981 author
983 ?\s)
984 date
989 email
991 ?\s)
1001 ;; Title block with a title. Document's TITLE, along with the
1002 ;; AUTHOR and its EMAIL are both overlined and an underlined,
1003 ;; centered. Date is just below, also centered.
1005 ;; Format TITLE. It may be filled if it is too wide,
1006 ;; that is wider than the two thirds of the total width.
1032 "Return complete document string after ASCII conversion.
1033 CONTENTS is the transcoded contents string. INFO is a plist
1034 holding export options."
1039 ;; 1. Document's body.
1040 contents
1041 ;; 2. Footnote definitions.
1044 ;; Insert full links right inside the footnote definition
1045 ;; as they have no chance to be inserted later.
1058 global-margin)))
1062 ;; Distinguish between inline definitions and
1063 ;; full-fledged definitions.
1067 ;; Full-fledged definition: footnote ID is
1068 ;; inserted inside the first parsed
1069 ;; paragraph (FIRST), if any, to be sure
1070 ;; filling will take it into consideration.
1076 ;; Fill paragraph once footnote ID is inserted
1077 ;; in order to have a correct length for first
1078 ;; line.
1081 text-width info))))))
1083 global-margin))))
1086 "Return complete document string after ASCII conversion.
1087 CONTENTS is the transcoded contents string. INFO is a plist
1088 holding export options."
1091 ;; 1. Build title block.
1094 ;; 2. Table of contents.
1100 global-margin)
1101 ;; 3. Document's body.
1102 contents
1103 ;; 4. Creator. Ignore `comment' value as there are no comments in
1104 ;; ASCII. Justify it to the bottom right.
1113 global-margin))))
1116 "Translate string S according to specified language and charset.
1117 INFO is a plist used as a communication channel."
1122 \f
1123 ;;; Transcode Functions
1125 ;;;; Bold
1128 "Transcode BOLD from Org to ASCII.
1129 CONTENTS is the text with bold markup. INFO is a plist holding
1130 contextual information."
1134 ;;;; Center Block
1137 "Transcode a CENTER-BLOCK element from Org to ASCII.
1138 CONTENTS holds the contents of the block. INFO is a plist
1139 holding contextual information."
1140 ;; Center has already been taken care of at a lower level, so
1141 ;; there's nothing left to do.
1142 contents)
1145 ;;;; Clock
1148 "Transcode a CLOCK object from Org to ASCII.
1149 CONTENTS is nil. INFO is a plist holding contextual
1150 information."
1158 "%2s:%02s"
1160 clock info))
1163 ;;;; Code
1166 "Return a CODE object from Org to ASCII.
1167 CONTENTS is nil. INFO is a plist holding contextual
1168 information."
1173 ;;;; Drawer
1176 "Transcode a DRAWER element from Org to ASCII.
1177 CONTENTS holds the contents of the block. INFO is a plist
1178 holding contextual information."
1182 name contents width)))
1185 ;;;; Dynamic Block
1188 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1189 CONTENTS holds the contents of the block. INFO is a plist
1190 holding contextual information."
1191 contents)
1194 ;;;; Entity
1197 "Transcode an ENTITY object from Org to ASCII.
1198 CONTENTS are the definition itself. INFO is a plist holding
1199 contextual information."
1202 entity))
1205 ;;;; Example Block
1208 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1209 CONTENTS is nil. INFO is a plist holding contextual information."
1213 example-block info))
1216 ;;;; Export Snippet
1219 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1220 CONTENTS is nil. INFO is a plist holding contextual information."
1225 ;;;; Export Block
1228 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1229 CONTENTS is nil. INFO is a plist holding contextual information."
1235 ;;;; Fixed Width
1238 "Transcode a FIXED-WIDTH element from Org to ASCII.
1239 CONTENTS is nil. INFO is a plist holding contextual information."
1244 fixed-width info))
1247 ;;;; Footnote Definition
1249 ;; Footnote Definitions are ignored. They are compiled at the end of
1250 ;; the document, by `org-ascii-inner-template'.
1253 ;;;; Footnote Reference
1256 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1257 CONTENTS is nil. INFO is a plist holding contextual information."
1261 ;;;; Headline
1264 "Transcode a HEADLINE element from Org to ASCII.
1265 CONTENTS holds the contents of the headline. INFO is a plist
1266 holding contextual information."
1267 ;; Don't export footnote section, which will be handled at the end
1268 ;; of the template.
1272 ;; Blank lines between headline and its contents.
1273 ;; `org-ascii-headline-spacing', when set, overwrites
1274 ;; original buffer's spacing.
1280 ;; Even if HEADLINE has no section, there might be some
1281 ;; links in its title that we shouldn't forget to describe.
1288 ;; Deep subtree: export it as a list item.
1291 ;; Bullet.
1296 " "
1297 ;; Title.
1299 ;; Contents, indented by length of bullet.
1300 pre-blanks
1305 ;; Else: Standard headline.
1312 ;;;; Horizontal Rule
1315 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1316 CONTENTS is nil. INFO is a plist holding contextual
1317 information."
1324 text-width)
1329 ;;;; Inline Src Block
1332 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1333 CONTENTS holds the contents of the item. INFO is a plist holding
1334 contextual information."
1339 ;;;; Inlinetask
1343 "Format an inline task element for ASCII export.
1344 See `org-ascii-format-inlinetask-function' for a description
1345 of the parameters."
1350 ;; Top line, with an additional blank line if not in UTF-8.
1353 ;; Add title. Fill it if wider than inlinetask.
1358 ;; If CONTENTS is not empty, insert it along with
1359 ;; a separator.
1362 ;; Bottom line.
1364 ;; Flush the inlinetask to the right.
1371 "Transcode an INLINETASK element from Org to ASCII.
1372 CONTENTS holds the contents of the block. INFO is a plist
1373 holding contextual information."
1376 ;; todo.
1381 ;; todo-type
1383 ;; priority
1386 ;; title
1388 ;; tags
1391 ;; contents and width
1392 contents width inlinetask info)))
1395 ;;;; Italic
1398 "Transcode italic from Org to ASCII.
1399 CONTENTS is the text with italic markup. INFO is a plist holding
1400 contextual information."
1404 ;;;; Item
1407 "Transcode an ITEM element from Org to ASCII.
1408 CONTENTS holds the contents of the item. INFO is a plist holding
1409 contextual information."
1414 ;; First parent of ITEM is always the plain-list. Get
1415 ;; `:type' property from it.
1423 ;; Return correct number for ITEM, paying attention to
1424 ;; counters.
1430 struct
1435 ;; Change bullets into more visible form if UTF-8 is active.
1443 bullet
1445 ;; Contents: Pay attention to indentation. Note: check-boxes are
1446 ;; already taken care of at the paragraph level so they don't
1447 ;; interfere with indentation.
1454 ;;;; Keyword
1457 "Transcode a KEYWORD element from Org to ASCII.
1458 CONTENTS is nil. INFO is a plist holding contextual
1459 information."
1479 keyword info)))))
1482 ;;;; Latex Environment
1485 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1486 CONTENTS is nil. INFO is a plist holding contextual
1487 information."
1491 latex-environment info)))
1494 ;;;; Latex Fragment
1497 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1498 CONTENTS is nil. INFO is a plist holding contextual
1499 information."
1504 ;;;; Line Break
1507 "Transcode a LINE-BREAK object from Org to ASCII.
1508 CONTENTS is nil. INFO is a plist holding contextual
1512 ;;;; Link
1515 "Transcode a LINK object from Org to ASCII.
1517 DESC is the description part of the link, or the empty string.
1518 INFO is a plist holding contextual information."
1525 ;; Do not apply a special syntax on radio links. Though, use
1526 ;; transcoded target's contents as output.
1528 ;; Do not apply a special syntax on fuzzy links pointing to
1529 ;; targets.
1540 ;; Unnumbered headline.
1545 info)))))))))
1558 ;;;; Node Properties
1561 "Transcode a NODE-PROPERTY element from Org to ASCII.
1562 CONTENTS is nil. INFO is a plist holding contextual
1563 information."
1570 ;;;; Paragraph
1573 "Transcode a PARAGRAPH element from Org to ASCII.
1574 CONTENTS is the contents of the paragraph, as a string. INFO is
1575 the plist used as a communication channel."
1580 ;; Do not indent first paragraph in a section.
1586 paragraph info))
1589 ;;;; Plain List
1592 "Transcode a PLAIN-LIST element from Org to ASCII.
1593 CONTENTS is the contents of the list. INFO is a plist holding
1594 contextual information."
1598 contents
1602 ;;;; Plain Text
1605 "Transcode a TEXT string from Org to ASCII.
1606 INFO is a plist used as a communication channel."
1613 ;; Usual replacements in utf-8 with proper option set.
1621 ;;;; Planning
1624 "Transcode a PLANNING element from Org to ASCII.
1625 CONTENTS is nil. INFO is a plist used as a communication
1626 channel."
1629 #'identity
1644 planning info))
1647 ;;;; Property Drawer
1650 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1651 CONTENTS holds the contents of the drawer. INFO is a plist
1652 holding contextual information."
1657 ;;;; Quote Block
1660 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1661 CONTENTS holds the contents of the block. INFO is a plist
1662 holding contextual information."
1666 ;;;; Radio Target
1669 "Transcode a RADIO-TARGET object from Org to ASCII.
1670 CONTENTS is the contents of the target. INFO is a plist holding
1671 contextual information."
1672 contents)
1675 ;;;; Section
1678 "Transcode a SECTION element from Org to ASCII.
1679 CONTENTS is the contents of the section. INFO is a plist holding
1680 contextual information."
1683 contents
1685 ;; Add list of links at the end of SECTION.
1689 ;; Separate list of links and section contents.
1691 ;; Do not apply inner margin if parent headline is low level.
1697 ;;;; Special Block
1700 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1701 CONTENTS holds the contents of the block. INFO is a plist
1702 holding contextual information."
1703 ;; "JUSTIFYLEFT" and "JUSTFYRIGHT" have already been taken care of
1704 ;; at a lower level. There is no other special block type to
1705 ;; handle.
1706 contents)
1709 ;;;; Src Block
1712 "Transcode a SRC-BLOCK element from Org to ASCII.
1713 CONTENTS holds the contents of the item. INFO is a plist holding
1714 contextual information."
1724 src-block info))))
1727 ;;;; Statistics Cookie
1730 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1731 CONTENTS is nil. INFO is a plist holding contextual information."
1735 ;;;; Subscript
1738 "Transcode a SUBSCRIPT object from Org to ASCII.
1739 CONTENTS is the contents of the object. INFO is a plist holding
1740 contextual information."
1746 ;;;; Superscript
1749 "Transcode a SUPERSCRIPT object from Org to ASCII.
1750 CONTENTS is the contents of the object. INFO is a plist holding
1751 contextual information."
1757 ;;;; Strike-through
1760 "Transcode STRIKE-THROUGH from Org to ASCII.
1761 CONTENTS is text with strike-through markup. INFO is a plist
1762 holding contextual information."
1766 ;;;; Table
1769 "Transcode a TABLE element from Org to ASCII.
1770 CONTENTS is the contents of the table. INFO is a plist holding
1771 contextual information."
1776 ;; Possibly add a caption string above.
1778 ;; Insert table. Note: "table.el" tables are left unmodified.
1792 ;; Possible add a caption string below.
1794 table info)))
1797 ;;;; Table Cell
1800 "Return width of TABLE-CELL.
1802 INFO is a plist used as a communication channel.
1804 Width of a cell is determined either by a width cookie in the
1805 same column as the cell, or by the maximum cell's length in that
1806 column.
1808 When `org-ascii-table-widen-columns' is non-nil, width cookies
1809 are ignored."
1824 key
1836 info))
1837 max-width)))
1838 info)
1839 max-width)))
1843 cache))))
1846 "Transcode a TABLE-CELL object from Org to ASCII.
1847 CONTENTS is the cell contents. INFO is a plist used as
1848 a communication channel."
1849 ;; Determine column width. When `org-ascii-table-widen-columns'
1850 ;; is nil and some width cookie has set it, use that value.
1851 ;; Otherwise, compute the maximum width among transcoded data of
1852 ;; each cell in the column.
1854 ;; When contents are too large, truncate them.
1858 ;; Align contents correctly within the cell.
1863 contents width
1868 ;; Return cell.
1874 ;;;; Table Row
1877 "Transcode a TABLE-ROW element from Org to ASCII.
1878 CONTENTS is the row contents. INFO is a plist used as
1879 a communication channel."
1886 'concat
1892 ;; In order to know if CELL starts the row, do
1893 ;; not compare it with the first cell in the
1894 ;; row as there might be a special column.
1895 ;; Instead, compare it with first exportable
1896 ;; cell, obtained with `org-element-map'.
1900 cell))
1901 lcorner)
1906 rcorner)
1912 info)))
1927 ;;;; Timestamp
1930 "Transcode a TIMESTAMP object from Org to ASCII.
1931 CONTENTS is nil. INFO is a plist holding contextual information."
1935 ;;;; Underline
1938 "Transcode UNDERLINE from Org to ASCII.
1939 CONTENTS is the text with underline markup. INFO is a plist
1940 holding contextual information."
1944 ;;;; Verbatim
1947 "Return a VERBATIM object from Org to ASCII.
1948 CONTENTS is nil. INFO is a plist holding contextual information."
1953 ;;;; Verse Block
1956 "Transcode a VERSE-BLOCK element from Org to ASCII.
1957 CONTENTS is verse block contents. INFO is a plist holding
1958 contextual information."
1965 \f
1966 ;;; Filters
1969 "Filter controlling number of blank lines after a headline.
1971 HEADLINE is a string representing a transcoded headline.
1972 BACK-END is symbol specifying back-end used for export. INFO is
1973 plist containing the communication channel.
1975 This function only applies to `ascii' back-end. See
1976 `org-ascii-headline-spacing' for information."
1983 "Filter controlling number of blank lines between paragraphs.
1985 TREE is the parse tree. BACK-END is the symbol specifying
1986 back-end used for export. INFO is a plist used as
1987 a communication channel.
1989 See `org-ascii-paragraph-spacing' for information."
1997 tree)
2000 "Filter removing blank lines between comments.
2001 TREE is the parse tree. BACK-END is the symbol specifying
2002 back-end used for export. INFO is a plist used as
2003 a communication channel."
2009 tree)
2012 \f
2013 ;;; End-user functions
2015 ;;;###autoload
2018 "Export current buffer to a text buffer.
2020 If narrowing is active in the current buffer, only export its
2021 narrowed part.
2023 If a region is active, export that region.
2025 A non-nil optional argument ASYNC means the process should happen
2026 asynchronously. The resulting buffer should be accessible
2027 through the `org-export-stack' interface.
2029 When optional argument SUBTREEP is non-nil, export the sub-tree
2030 at point, extracting information from the headline properties
2031 first.
2033 When optional argument VISIBLE-ONLY is non-nil, don't export
2034 contents of hidden elements.
2036 When optional argument BODY-ONLY is non-nil, strip title and
2037 table of contents from output.
2039 EXT-PLIST, when provided, is a property list with external
2040 parameters overriding Org default settings, but still inferior to
2041 file-local settings.
2044 will be displayed when `org-export-show-temporary-export-buffer'
2045 is non-nil."
2050 ;;;###autoload
2053 "Export current buffer to a text file.
2055 If narrowing is active in the current buffer, only export its
2056 narrowed part.
2058 If a region is active, export that region.
2060 A non-nil optional argument ASYNC means the process should happen
2061 asynchronously. The resulting file should be accessible through
2062 the `org-export-stack' interface.
2064 When optional argument SUBTREEP is non-nil, export the sub-tree
2065 at point, extracting information from the headline properties
2066 first.
2068 When optional argument VISIBLE-ONLY is non-nil, don't export
2069 contents of hidden elements.
2071 When optional argument BODY-ONLY is non-nil, strip title and
2072 table of contents from output.
2074 EXT-PLIST, when provided, is a property list with external
2075 parameters overriding Org default settings, but still inferior to
2076 file-local settings.
2078 Return output file's name."
2082 async subtreep visible-only body-only ext-plist)))
2084 ;;;###autoload
2086 "Publish an Org file to ASCII.
2088 FILENAME is the filename of the Org file to be published. PLIST
2089 is the property list for the given project. PUB-DIR is the
2090 publishing directory.
2092 Return output file name."
2096 ;;;###autoload
2098 "Publish an Org file to Latin-1.
2100 FILENAME is the filename of the Org file to be published. PLIST
2101 is the property list for the given project. PUB-DIR is the
2102 publishing directory.
2104 Return output file name."
2108 ;;;###autoload
2110 "Publish an org file to UTF-8.
2112 FILENAME is the filename of the Org file to be published. PLIST
2113 is the property list for the given project. PUB-DIR is the
2114 publishing directory.
2116 Return output file name."
2123 ;; Local variables:
2124 ;; generated-autoload-file: "org-loaddefs.el"
2125 ;; coding: utf-8-emacs
2126 ;; End:
2128 ;;; ox-ascii.el ends here