| blob | deb98a6dd97c3f92485f70d766a22cfa50979911 |
1 ;;; ox-ascii.el --- ASCII Back-End for Org Export Engine
3 ;; Copyright (C) 2012-2015 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.
97 :menu-entry
118 (:filter-parse-tree org-ascii-filter-paragraph-spacing
119 org-ascii-filter-comment-spacing)
121 :options-alist
128 (:ascii-format-inlinetask-function
129 nil nil org-ascii-format-inlinetask-function)
138 (:ascii-table-keep-all-vertical-lines
139 nil nil org-ascii-table-keep-all-vertical-lines)
147 \f
148 ;;; User Configurable Variables
151 "Options for exporting Org mode files to ASCII."
156 "Maximum width of exported text.
157 This number includes margin size, as set in
158 `org-ascii-global-margin'."
165 "Width of the left margin, in number of characters."
172 "Width of the inner margin, in number of characters.
173 Inner margin is applied between each headline."
180 "Width of margin used for quoting text, in characters.
181 This margin is applied on both sides of the text."
188 "Width of margin used for plain lists, in characters.
189 This margin applies to top level list only, not to its
190 sub-lists."
197 "Width of inline tasks, in number of characters.
198 This number ignores any margin."
205 "Number of blank lines inserted around headlines.
207 This variable can be set to a cons cell. In that case, its car
208 represents the number of blank lines present before headline
209 contents whereas its cdr reflects the number of blank lines after
210 contents.
212 A nil value replicates the number of blank lines found in the
213 original Org buffer at the same place."
224 "Additional indentation width for the first line in a paragraph.
225 If the value is an integer, indent the first line of each
226 paragraph by this width, unless it is located at the beginning of
227 a section, in which case indentation is removed from that line.
228 If it is the symbol `auto' preserve indentation from original
229 document."
238 "Number of white lines between paragraphs.
239 If the value is an integer, add this number of blank lines
240 between contiguous paragraphs. If is it the symbol `auto', keep
241 the same number of blank lines as in the original document."
250 "The charset allowed to represent various elements and objects.
251 Possible values are:
252 `ascii' Only use plain ASCII characters
253 `latin1' Include Latin-1 characters
254 `utf-8' Use all UTF-8 characters"
266 "Characters for underlining headings in ASCII export.
268 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
269 and whose value is a list of characters.
271 For each supported charset, this variable associates a sequence
272 of underline characters. In a sequence, the characters will be
273 used in order for headlines level 1, 2, ... If no character is
274 available for a given level, the headline won't be underlined."
292 "Bullet characters for headlines converted to lists in ASCII export.
294 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
295 and whose value is a list of characters.
297 The first character is used for the first level considered as low
298 level, and so on. If there are more levels than characters given
299 here, the list will be repeated.
301 Note that this variable doesn't affect plain lists
302 representation."
318 "Non-nil means convert links to notes before the next headline.
319 When nil, the link will be exported in place. If the line
320 becomes long in this way, it will be wrapped."
327 "Non-nil means keep all vertical lines in ASCII tables.
328 When nil, vertical lines will be removed except for those needed
329 for column grouping."
336 "Non-nil means widen narrowed columns for export.
337 When nil, narrowed columns will look in ASCII export just like in
345 "Non-nil means table.el tables are turned into ascii-art.
347 It only makes sense when export charset is `utf-8'. It is nil by
348 default since it requires ascii-art-to-unicode.el package. You
349 can download it here:
351 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
358 "When non-nil, place caption string before the element.
359 Otherwise, place it right after it."
366 "Format string used for verbatim text and inline code."
374 "Function called to format a drawer in ASCII.
376 The function must accept three parameters:
378 CONTENTS the contents of the drawer.
379 WIDTH the text width within the drawer.
381 The function should return either the string to be exported or
382 nil to ignore the drawer.
384 The default value simply returns the value of CONTENTS."
391 'org-ascii-format-inlinetask-default
392 "Function called to format an inlinetask in ASCII.
394 The function must accept nine parameters:
395 TODO the todo keyword, as a string
396 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
397 PRIORITY the inlinetask priority, as a string
398 NAME the inlinetask name, as a string.
399 TAGS the inlinetask tags, as a list of strings.
400 CONTENTS the contents of the inlinetask, as a string.
401 WIDTH the width of the inlinetask, as a number.
402 INLINETASK the inlinetask itself.
403 INFO the info channel.
405 The function should return either the string to be exported or
406 nil to ignore the inline task."
413 \f
414 ;;; Internal Functions
416 ;; Internal functions fall into three categories.
418 ;; The first one is about text formatting. The core functions are
419 ;; `org-ascii--current-text-width' and
420 ;; `org-ascii--current-justification', which determine, respectively,
421 ;; the current text width allowed to a given element and its expected
422 ;; justification. Once this information is known,
423 ;; `org-ascii--fill-string', `org-ascii--justify-lines',
424 ;; `org-ascii--justify-element' `org-ascii--box-string' and
425 ;; `org-ascii--indent-string' can operate on a given output string.
426 ;; In particular, justification happens at the regular (i.e.,
427 ;; non-greater) element level, which means that when the exporting
428 ;; process reaches a container (e.g., a center block) content are
429 ;; already justified.
431 ;; The second category contains functions handling elements listings,
432 ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
433 ;; returns a complete table of contents, `org-ascii--list-listings'
434 ;; returns a list of referenceable src-block elements, and
435 ;; `org-ascii--list-tables' does the same for table elements.
437 ;; The third category includes general helper functions.
438 ;; `org-ascii--build-title' creates the title for a given headline
439 ;; or inlinetask element. `org-ascii--build-caption' returns the
440 ;; caption string associated to a table or a src-block.
441 ;; `org-ascii--describe-links' creates notes about links for
442 ;; insertion at the end of a section. It uses
443 ;; `org-ascii--unique-links' to get the list of links to describe.
444 ;; Eventually, `org-ascii--translate' translates a string according
445 ;; to language and charset specification.
449 "Fill a string with specified text-width and return it.
451 S is the string being filled. TEXT-WIDTH is an integer
452 specifying maximum length of a line. INFO is the plist used as
453 a communication channel.
455 Optional argument JUSTIFY can specify any type of justification
456 among `left', `center', `right' or `full'. A nil value is
457 equivalent to `left'. For a justification that doesn't also fill
458 string, see `org-ascii--justify-lines' and
459 `org-ascii--justify-block'.
461 Return nil if S isn't a string."
470 s))
475 "Justify all lines in string S.
476 TEXT-WIDTH is an integer specifying maximum length of a line.
477 HOW determines the type of justification: it can be `left',
478 `right', `full' or `center'."
483 ;; Disable `adaptive-fill-mode' so it doesn't prevent
484 ;; filling lines matching `adaptive-fill-regexp'.
492 "Justify CONTENTS of ELEMENT.
493 INFO is a plist used as a communication channel. Justification
494 is done according to the type of element. More accurately,
495 paragraphs are filled and other elements are justified as blocks,
496 that is according to the widest non blank line in CONTENTS."
502 ;; Paragraphs are treated specially as they need to be filled.
510 ;; Compute maximum width. Bail out if it is greater
511 ;; than page width, since no justification is
512 ;; possible.
522 ;; Justify every line according to TEXT-WIDTH and
523 ;; MAX-WIDTH.
534 "Indent string S by WIDTH white spaces.
535 Empty lines are not indented."
541 "Return string S with a partial box to its left.
542 INFO is a plist used as a communication channel."
547 ;; Remove last newline character.
551 "Return maximum text width for ELEMENT's contents.
552 INFO is a plist used as a communication channel."
554 ;; Elements with an absolute width: `headline' and `inlinetask'.
561 ;; Elements with a relative width: store maximum text width in
562 ;; TOTAL-WIDTH.
565 ;; Total width is determined by the presence, or not, of an
566 ;; inline task among ELEMENT parents.
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 count parent)
593 ;; Apply list margin once per "top-level" plain-list
594 ;; containing current line
602 ;; Text width within a plain-list is restricted by
603 ;; indentation of current item. If that's the case,
604 ;; compute it with the help of `:structure' property from
605 ;; parent item, if any.
610 return parent))))
612 ;; Compute indentation offset of the current item,
613 ;; that is the sum of the difference between its
614 ;; indentation and the indentation of the top item in
615 ;; the list and current item bullet's length. Also
616 ;; remove checkbox length, and tag length (for
617 ;; 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.
758 When optional argument LOCAL is non-nil, build a table of
759 contents according to the current headline."
786 "Return a list of listings.
788 KEYWORD is the keyword that initiated the list of listings
789 generation. INFO is a plist used as a communication channel."
800 ;; Use a counter instead of retrieving ordinal of each
801 ;; src-block.
805 ;; Store initial text so its length can be computed. This is
806 ;; used to properly align caption right to it in case of
807 ;; filling (like contents of a description list item).
813 initial-text " "
817 ;; Use short name in priority, if available.
822 initial-width)))))
826 "Return a list of tables.
828 KEYWORD is the keyword that initiated the list of tables
829 generation. INFO is a plist used as a communication channel."
840 ;; Use a counter instead of retrieving ordinal of each
841 ;; src-block.
845 ;; Store initial text so its length can be computed. This is
846 ;; used to properly align caption right to it in case of
847 ;; filling (like contents of a description list item).
853 initial-text " "
857 ;; Use short name in priority, if available.
862 initial-width)))))
866 "Return a list of unique link references in ELEMENT.
867 ELEMENT is either a headline element or a section element. INFO
868 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.
885 ;; It can happen if it is located in an affiliated
886 ;; keyword that was ignored.
891 ;; If at a section, find parent headline, if any, in order to
892 ;; count links that might be in the title.
896 ;; Get all links in HEADLINE.
901 "Return a string describing a list of links.
903 LINKS is a list of link type objects, as returned by
904 `org-ascii--unique-links'. WIDTH is the text width allowed for
905 the output string. INFO is a plist used as a communication
906 channel."
914 ;; Coderefs, radio links and fuzzy links are ignored.
916 ;; Id and custom-id links: Headlines refer to their numbering.
922 "[%s] %s"
923 anchor
925 dest
934 width info)
936 ;; Do not add a link that cannot be resolved and doesn't have
937 ;; any description: destination is already visible in the
938 ;; paragraph.
940 ;; Do not add a link already handled by custom export
941 ;; functions.
946 nil)
951 width info)
956 "Return checkbox string for ITEM or nil.
957 INFO is a plist used as a communication channel."
965 \f
966 ;;; Template
969 "Return document title, as a string.
970 INFO is a plist used as a communication channel."
972 ;; Links in the title will not be resolved later, so we make
973 ;; sure their path is located right after them.
987 ;; There are two types of title blocks depending on the presence
988 ;; of a title to display.
990 ;; Title block without a title. DATE is positioned at the top
991 ;; right of the document, AUTHOR to the top left and EMAIL
992 ;; just below.
996 author
998 ?\s)
999 date
1004 email
1006 ?\s)
1016 ;; Title block with a title. Document's TITLE, along with the
1017 ;; AUTHOR and its EMAIL are both overlined and an underlined,
1018 ;; centered. Date is just below, also centered.
1020 ;; Format TITLE. It may be filled if it is too wide,
1021 ;; that is wider than the two thirds of the total width.
1052 "Return complete document string after ASCII conversion.
1053 CONTENTS is the transcoded contents string. INFO is a plist
1054 holding export options."
1059 ;; 1. Document's body.
1060 contents
1061 ;; 2. Footnote definitions.
1063 ;; Insert full links right inside the footnote definition
1064 ;; as they have no chance to be inserted later.
1077 global-margin)))
1081 ;; Distinguish between inline definitions and
1082 ;; full-fledged definitions.
1086 ;; Full-fledged definition: footnote ID is
1087 ;; inserted inside the first parsed
1088 ;; paragraph (FIRST), if any, to be sure
1089 ;; filling will take it into consideration.
1095 ;; Fill paragraph once footnote ID is inserted
1096 ;; in order to have a correct length for first
1097 ;; line.
1100 text-width info))))))
1102 global-margin))))
1105 "Return complete document string after ASCII conversion.
1106 CONTENTS is the transcoded contents string. INFO is a plist
1107 holding export options."
1110 ;; Build title block.
1113 ;; 2. Table of contents.
1119 global-margin)
1120 ;; Document's body.
1121 contents
1122 ;; Creator. Justify it to the bottom right.
1131 global-margin)))))
1134 "Translate string S according to specified language and charset.
1135 INFO is a plist used as a communication channel."
1140 \f
1141 ;;; Transcode Functions
1143 ;;;; Bold
1146 "Transcode BOLD from Org to ASCII.
1147 CONTENTS is the text with bold markup. INFO is a plist holding
1148 contextual information."
1152 ;;;; Center Block
1155 "Transcode a CENTER-BLOCK element from Org to ASCII.
1156 CONTENTS holds the contents of the block. INFO is a plist
1157 holding contextual information."
1158 ;; Center has already been taken care of at a lower level, so
1159 ;; there's nothing left to do.
1160 contents)
1163 ;;;; Clock
1166 "Transcode a CLOCK object from Org to ASCII.
1167 CONTENTS is nil. INFO is a plist holding contextual
1168 information."
1176 "%2s:%02s"
1178 clock info))
1181 ;;;; Code
1184 "Return a CODE object from Org to ASCII.
1185 CONTENTS is nil. INFO is a plist holding contextual
1186 information."
1191 ;;;; Drawer
1194 "Transcode a DRAWER element from Org to ASCII.
1195 CONTENTS holds the contents of the block. INFO is a plist
1196 holding contextual information."
1200 name contents width)))
1203 ;;;; Dynamic Block
1206 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1207 CONTENTS holds the contents of the block. INFO is a plist
1208 holding contextual information."
1209 contents)
1212 ;;;; Entity
1215 "Transcode an ENTITY object from Org to ASCII.
1216 CONTENTS are the definition itself. INFO is a plist holding
1217 contextual information."
1220 entity))
1223 ;;;; Example Block
1226 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1227 CONTENTS is nil. INFO is a plist holding contextual information."
1231 example-block info))
1234 ;;;; Export Snippet
1237 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1238 CONTENTS is nil. INFO is a plist holding contextual information."
1243 ;;;; Export Block
1246 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1247 CONTENTS is nil. INFO is a plist holding contextual information."
1253 ;;;; Fixed Width
1256 "Transcode a FIXED-WIDTH element from Org to ASCII.
1257 CONTENTS is nil. INFO is a plist holding contextual information."
1262 fixed-width info))
1265 ;;;; Footnote Definition
1267 ;; Footnote Definitions are ignored. They are compiled at the end of
1268 ;; the document, by `org-ascii-inner-template'.
1271 ;;;; Footnote Reference
1274 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1275 CONTENTS is nil. INFO is a plist holding contextual information."
1279 ;;;; Headline
1282 "Transcode a HEADLINE element from Org to ASCII.
1283 CONTENTS holds the contents of the headline. INFO is a plist
1284 holding contextual information."
1285 ;; Don't export footnote section, which will be handled at the end
1286 ;; of the template.
1290 ;; Blank lines between headline and its contents.
1291 ;; `org-ascii-headline-spacing', when set, overwrites
1292 ;; original buffer's spacing.
1298 ;; Even if HEADLINE has no section, there might be some
1299 ;; links in its title that we shouldn't forget to describe.
1306 ;; Deep subtree: export it as a list item.
1309 ;; Bullet.
1314 " "
1315 ;; Title.
1317 ;; Contents, indented by length of bullet.
1318 pre-blanks
1323 ;; Else: Standard headline.
1330 ;;;; Horizontal Rule
1333 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1334 CONTENTS is nil. INFO is a plist holding contextual
1335 information."
1342 text-width)
1347 ;;;; Inline Src Block
1350 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1351 CONTENTS holds the contents of the item. INFO is a plist holding
1352 contextual information."
1357 ;;;; Inlinetask
1361 "Format an inline task element for ASCII export.
1362 See `org-ascii-format-inlinetask-function' for a description
1363 of the parameters."
1368 ;; Top line, with an additional blank line if not in UTF-8.
1371 ;; Add title. Fill it if wider than inlinetask.
1376 ;; If CONTENTS is not empty, insert it along with
1377 ;; a separator.
1380 ;; Bottom line.
1382 ;; Flush the inlinetask to the right.
1389 "Transcode an INLINETASK element from Org to ASCII.
1390 CONTENTS holds the contents of the block. INFO is a plist
1391 holding contextual information."
1394 ;; todo.
1399 ;; todo-type
1401 ;; priority
1404 ;; title
1406 ;; tags
1409 ;; contents and width
1410 contents width inlinetask info)))
1413 ;;;; Italic
1416 "Transcode italic from Org to ASCII.
1417 CONTENTS is the text with italic markup. INFO is a plist holding
1418 contextual information."
1422 ;;;; Item
1425 "Transcode an ITEM element from Org to ASCII.
1426 CONTENTS holds the contents of the item. INFO is a plist holding
1427 contextual information."
1432 ;; First parent of ITEM is always the plain-list. Get
1433 ;; `:type' property from it.
1441 ;; Return correct number for ITEM, paying attention to
1442 ;; counters.
1448 struct
1453 ;; Change bullets into more visible form if UTF-8 is active.
1461 bullet
1463 ;; Contents: Pay attention to indentation. Note: check-boxes are
1464 ;; already taken care of at the paragraph level so they don't
1465 ;; interfere with indentation.
1472 ;;;; Keyword
1475 "Transcode a KEYWORD element from Org to ASCII.
1476 CONTENTS is nil. INFO is a plist holding contextual
1477 information."
1495 keyword info)))))
1498 ;;;; Latex Environment
1501 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1502 CONTENTS is nil. INFO is a plist holding contextual
1503 information."
1507 latex-environment info)))
1510 ;;;; Latex Fragment
1513 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1514 CONTENTS is nil. INFO is a plist holding contextual
1515 information."
1520 ;;;; Line Break
1523 "Transcode a LINE-BREAK object from Org to ASCII.
1524 CONTENTS is nil. INFO is a plist holding contextual
1528 ;;;; Link
1531 "Transcode a LINK object from Org to ASCII.
1533 DESC is the description part of the link, or the empty string.
1534 INFO is a plist holding contextual information."
1542 ;; Do not apply a special syntax on radio links. Though, use
1543 ;; transcoded target's contents as output.
1545 ;; Do not apply a special syntax on fuzzy links pointing to
1546 ;; targets.
1557 ;; Unnumbered headline.
1562 info)))))))))
1571 ;;;; Node Properties
1574 "Transcode a NODE-PROPERTY element from Org to ASCII.
1575 CONTENTS is nil. INFO is a plist holding contextual
1576 information."
1583 ;;;; Paragraph
1586 "Transcode a PARAGRAPH element from Org to ASCII.
1587 CONTENTS is the contents of the paragraph, as a string. INFO is
1588 the plist used as a communication channel."
1593 ;; Do not indent first paragraph in a section.
1599 paragraph info))
1602 ;;;; Plain List
1605 "Transcode a PLAIN-LIST element from Org to ASCII.
1606 CONTENTS is the contents of the list. INFO is a plist holding
1607 contextual information."
1611 contents
1615 ;;;; Plain Text
1618 "Transcode a TEXT string from Org to ASCII.
1619 INFO is a plist used as a communication channel."
1626 ;; Usual replacements in utf-8 with proper option set.
1634 ;;;; Planning
1637 "Transcode a PLANNING element from Org to ASCII.
1638 CONTENTS is nil. INFO is a plist used as a communication
1639 channel."
1642 #'identity
1657 planning info))
1660 ;;;; Property Drawer
1663 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1664 CONTENTS holds the contents of the drawer. INFO is a plist
1665 holding contextual information."
1670 ;;;; Quote Block
1673 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1674 CONTENTS holds the contents of the block. INFO is a plist
1675 holding contextual information."
1679 ;;;; Radio Target
1682 "Transcode a RADIO-TARGET object from Org to ASCII.
1683 CONTENTS is the contents of the target. INFO is a plist holding
1684 contextual information."
1685 contents)
1688 ;;;; Section
1691 "Transcode a SECTION element from Org to ASCII.
1692 CONTENTS is the contents of the section. INFO is a plist holding
1693 contextual information."
1696 contents
1698 ;; Add list of links at the end of SECTION.
1702 ;; Separate list of links and section contents.
1704 ;; Do not apply inner margin if parent headline is low level.
1710 ;;;; Special Block
1713 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1714 CONTENTS holds the contents of the block. INFO is a plist
1715 holding contextual information."
1716 ;; "JUSTIFYLEFT" and "JUSTFYRIGHT" have already been taken care of
1717 ;; at a lower level. There is no other special block type to
1718 ;; handle.
1719 contents)
1722 ;;;; Src Block
1725 "Transcode a SRC-BLOCK element from Org to ASCII.
1726 CONTENTS holds the contents of the item. INFO is a plist holding
1727 contextual information."
1737 src-block info))))
1740 ;;;; Statistics Cookie
1743 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1744 CONTENTS is nil. INFO is a plist holding contextual information."
1748 ;;;; Subscript
1751 "Transcode a SUBSCRIPT object from Org to ASCII.
1752 CONTENTS is the contents of the object. INFO is a plist holding
1753 contextual information."
1759 ;;;; Superscript
1762 "Transcode a SUPERSCRIPT object from Org to ASCII.
1763 CONTENTS is the contents of the object. INFO is a plist holding
1764 contextual information."
1770 ;;;; Strike-through
1773 "Transcode STRIKE-THROUGH from Org to ASCII.
1774 CONTENTS is text with strike-through markup. INFO is a plist
1775 holding contextual information."
1779 ;;;; Table
1782 "Transcode a TABLE element from Org to ASCII.
1783 CONTENTS is the contents of the table. INFO is a plist holding
1784 contextual information."
1789 ;; Possibly add a caption string above.
1791 ;; Insert table. Note: "table.el" tables are left unmodified.
1805 ;; Possible add a caption string below.
1807 table info)))
1810 ;;;; Table Cell
1813 "Return width of TABLE-CELL.
1815 INFO is a plist used as a communication channel.
1817 Width of a cell is determined either by a width cookie in the
1818 same column as the cell, or by the maximum cell's length in that
1819 column.
1821 When `org-ascii-table-widen-columns' is non-nil, width cookies
1822 are ignored."
1837 key
1849 info))
1850 max-width)))
1851 info)
1852 max-width)))
1856 cache))))
1859 "Transcode a TABLE-CELL object from Org to ASCII.
1860 CONTENTS is the cell contents. INFO is a plist used as
1861 a communication channel."
1862 ;; Determine column width. When `org-ascii-table-widen-columns'
1863 ;; is nil and some width cookie has set it, use that value.
1864 ;; Otherwise, compute the maximum width among transcoded data of
1865 ;; each cell in the column.
1867 ;; When contents are too large, truncate them.
1871 ;; Align contents correctly within the cell.
1876 contents width
1881 ;; Return cell.
1887 ;;;; Table Row
1890 "Transcode a TABLE-ROW element from Org to ASCII.
1891 CONTENTS is the row contents. INFO is a plist used as
1892 a communication channel."
1899 'concat
1905 ;; In order to know if CELL starts the row, do
1906 ;; not compare it with the first cell in the
1907 ;; row as there might be a special column.
1908 ;; Instead, compare it with first exportable
1909 ;; cell, obtained with `org-element-map'.
1913 cell))
1914 lcorner)
1919 rcorner)
1925 info)))
1940 ;;;; Timestamp
1943 "Transcode a TIMESTAMP object from Org to ASCII.
1944 CONTENTS is nil. INFO is a plist holding contextual information."
1948 ;;;; Underline
1951 "Transcode UNDERLINE from Org to ASCII.
1952 CONTENTS is the text with underline markup. INFO is a plist
1953 holding contextual information."
1957 ;;;; Verbatim
1960 "Return a VERBATIM object from Org to ASCII.
1961 CONTENTS is nil. INFO is a plist holding contextual information."
1966 ;;;; Verse Block
1969 "Transcode a VERSE-BLOCK element from Org to ASCII.
1970 CONTENTS is verse block contents. INFO is a plist holding
1971 contextual information."
1978 \f
1979 ;;; Filters
1982 "Filter controlling number of blank lines after a headline.
1984 HEADLINE is a string representing a transcoded headline.
1985 BACK-END is symbol specifying back-end used for export. INFO is
1986 plist containing the communication channel.
1988 This function only applies to `ascii' back-end. See
1989 `org-ascii-headline-spacing' for information."
1996 "Filter controlling number of blank lines between paragraphs.
1998 TREE is the parse tree. BACK-END is the symbol specifying
1999 back-end used for export. INFO is a plist used as
2000 a communication channel.
2002 See `org-ascii-paragraph-spacing' for information."
2010 tree)
2013 "Filter removing blank lines between comments.
2014 TREE is the parse tree. BACK-END is the symbol specifying
2015 back-end used for export. INFO is a plist used as
2016 a communication channel."
2022 tree)
2025 \f
2026 ;;; End-user functions
2028 ;;;###autoload
2031 "Export current buffer to a text buffer.
2033 If narrowing is active in the current buffer, only export its
2034 narrowed part.
2036 If a region is active, export that region.
2038 A non-nil optional argument ASYNC means the process should happen
2039 asynchronously. The resulting buffer should be accessible
2040 through the `org-export-stack' interface.
2042 When optional argument SUBTREEP is non-nil, export the sub-tree
2043 at point, extracting information from the headline properties
2044 first.
2046 When optional argument VISIBLE-ONLY is non-nil, don't export
2047 contents of hidden elements.
2049 When optional argument BODY-ONLY is non-nil, strip title and
2050 table of contents from output.
2052 EXT-PLIST, when provided, is a property list with external
2053 parameters overriding Org default settings, but still inferior to
2054 file-local settings.
2057 will be displayed when `org-export-show-temporary-export-buffer'
2058 is non-nil."
2063 ;;;###autoload
2066 "Export current buffer to a text file.
2068 If narrowing is active in the current buffer, only export its
2069 narrowed part.
2071 If a region is active, export that region.
2073 A non-nil optional argument ASYNC means the process should happen
2074 asynchronously. The resulting file should be accessible through
2075 the `org-export-stack' interface.
2077 When optional argument SUBTREEP is non-nil, export the sub-tree
2078 at point, extracting information from the headline properties
2079 first.
2081 When optional argument VISIBLE-ONLY is non-nil, don't export
2082 contents of hidden elements.
2084 When optional argument BODY-ONLY is non-nil, strip title and
2085 table of contents from output.
2087 EXT-PLIST, when provided, is a property list with external
2088 parameters overriding Org default settings, but still inferior to
2089 file-local settings.
2091 Return output file's name."
2095 async subtreep visible-only body-only ext-plist)))
2097 ;;;###autoload
2099 "Publish an Org file to ASCII.
2101 FILENAME is the filename of the Org file to be published. PLIST
2102 is the property list for the given project. PUB-DIR is the
2103 publishing directory.
2105 Return output file name."
2109 ;;;###autoload
2111 "Publish an Org file to Latin-1.
2113 FILENAME is the filename of the Org file to be published. PLIST
2114 is the property list for the given project. PUB-DIR is the
2115 publishing directory.
2117 Return output file name."
2121 ;;;###autoload
2123 "Publish an org file to UTF-8.
2125 FILENAME is the filename of the Org file to be published. PLIST
2126 is the property list for the given project. PUB-DIR is the
2127 publishing directory.
2129 Return output file name."
2136 ;; Local variables:
2137 ;; generated-autoload-file: "org-loaddefs.el"
2138 ;; coding: utf-8
2139 ;; End:
2141 ;;; ox-ascii.el ends here