| blob | 388c5b82f986a29c13a6fd00bcd3100bd8c13c64 |
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
127 (:ascii-format-inlinetask-function
128 nil nil org-ascii-format-inlinetask-function)
137 (:ascii-table-keep-all-vertical-lines
138 nil nil org-ascii-table-keep-all-vertical-lines)
146 \f
147 ;;; User Configurable Variables
150 "Options for exporting Org mode files to ASCII."
155 "Maximum width of exported text.
156 This number includes margin size, as set in
157 `org-ascii-global-margin'."
164 "Width of the left margin, in number of characters."
171 "Width of the inner margin, in number of characters.
172 Inner margin is applied between each headline."
179 "Width of margin used for quoting text, in characters.
180 This margin is applied on both sides of the text."
187 "Width of margin used for plain lists, in characters.
188 This margin applies to top level list only, not to its
189 sub-lists."
196 "Width of inline tasks, in number of characters.
197 This number ignores any margin."
204 "Number of blank lines inserted around headlines.
206 This variable can be set to a cons cell. In that case, its car
207 represents the number of blank lines present before headline
208 contents whereas its cdr reflects the number of blank lines after
209 contents.
211 A nil value replicates the number of blank lines found in the
212 original Org buffer at the same place."
223 "Additional indentation width for the first line in a paragraph.
224 If the value is an integer, indent the first line of each
225 paragraph by this width, unless it is located at the beginning of
226 a section, in which case indentation is removed from that line.
227 If it is the symbol `auto' preserve indentation from original
228 document."
237 "Number of white lines between paragraphs.
238 If the value is an integer, add this number of blank lines
239 between contiguous paragraphs. If is it the symbol `auto', keep
240 the same number of blank lines as in the original document."
249 "The charset allowed to represent various elements and objects.
250 Possible values are:
251 `ascii' Only use plain ASCII characters
252 `latin1' Include Latin-1 characters
253 `utf-8' Use all UTF-8 characters"
265 "Characters for underlining headings in ASCII export.
267 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
268 and whose value is a list of characters.
270 For each supported charset, this variable associates a sequence
271 of underline characters. In a sequence, the characters will be
272 used in order for headlines level 1, 2, ... If no character is
273 available for a given level, the headline won't be underlined."
291 "Bullet characters for headlines converted to lists in ASCII export.
293 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
294 and whose value is a list of characters.
296 The first character is used for the first level considered as low
297 level, and so on. If there are more levels than characters given
298 here, the list will be repeated.
300 Note that this variable doesn't affect plain lists
301 representation."
317 "Non-nil means convert links to notes before the next headline.
318 When nil, the link will be exported in place. If the line
319 becomes long in this way, it will be wrapped."
326 "Non-nil means keep all vertical lines in ASCII tables.
327 When nil, vertical lines will be removed except for those needed
328 for column grouping."
335 "Non-nil means widen narrowed columns for export.
336 When nil, narrowed columns will look in ASCII export just like in
344 "Non-nil means table.el tables are turned into ascii-art.
346 It only makes sense when export charset is `utf-8'. It is nil by
347 default since it requires ascii-art-to-unicode.el package. You
348 can download it here:
350 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
357 "When non-nil, place caption string before the element.
358 Otherwise, place it right after it."
365 "Format string used for verbatim text and inline code."
373 "Function called to format a drawer in ASCII.
375 The function must accept three parameters:
377 CONTENTS the contents of the drawer.
378 WIDTH the text width within the drawer.
380 The function should return either the string to be exported or
381 nil to ignore the drawer.
383 The default value simply returns the value of CONTENTS."
390 'org-ascii-format-inlinetask-default
391 "Function called to format an inlinetask in ASCII.
393 The function must accept nine parameters:
394 TODO the todo keyword, as a string
395 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
396 PRIORITY the inlinetask priority, as a string
397 NAME the inlinetask name, as a string.
398 TAGS the inlinetask tags, as a list of strings.
399 CONTENTS the contents of the inlinetask, as a string.
400 WIDTH the width of the inlinetask, as a number.
401 INLINETASK the inlinetask itself.
402 INFO the info channel.
404 The function should return either the string to be exported or
405 nil to ignore the inline task."
412 \f
413 ;;; Internal Functions
415 ;; Internal functions fall into three categories.
417 ;; The first one is about text formatting. The core functions are
418 ;; `org-ascii--current-text-width' and
419 ;; `org-ascii--current-justification', which determine, respectively,
420 ;; the current text width allowed to a given element and its expected
421 ;; justification. Once this information is known,
422 ;; `org-ascii--fill-string', `org-ascii--justify-lines',
423 ;; `org-ascii--justify-element' `org-ascii--box-string' and
424 ;; `org-ascii--indent-string' can operate on a given output string.
425 ;; In particular, justification happens at the regular (i.e.,
426 ;; non-greater) element level, which means that when the exporting
427 ;; process reaches a container (e.g., a center block) content are
428 ;; already justified.
430 ;; The second category contains functions handling elements listings,
431 ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
432 ;; returns a complete table of contents, `org-ascii--list-listings'
433 ;; returns a list of referenceable src-block elements, and
434 ;; `org-ascii--list-tables' does the same for table elements.
436 ;; The third category includes general helper functions.
437 ;; `org-ascii--build-title' creates the title for a given headline
438 ;; or inlinetask element. `org-ascii--build-caption' returns the
439 ;; caption string associated to a table or a src-block.
440 ;; `org-ascii--describe-links' creates notes about links for
441 ;; insertion at the end of a section. It uses
442 ;; `org-ascii--unique-links' to get the list of links to describe.
443 ;; Eventually, `org-ascii--translate' translates a string according
444 ;; to language and charset specification.
448 "Fill a string with specified text-width and return it.
450 S is the string being filled. TEXT-WIDTH is an integer
451 specifying maximum length of a line. INFO is the plist used as
452 a communication channel.
454 Optional argument JUSTIFY can specify any type of justification
455 among `left', `center', `right' or `full'. A nil value is
456 equivalent to `left'. For a justification that doesn't also fill
457 string, see `org-ascii--justify-lines' and
458 `org-ascii--justify-block'.
460 Return nil if S isn't a string."
469 s))
474 "Justify all lines in string S.
475 TEXT-WIDTH is an integer specifying maximum length of a line.
476 HOW determines the type of justification: it can be `left',
477 `right', `full' or `center'."
482 ;; Disable `adaptive-fill-mode' so it doesn't prevent
483 ;; filling lines matching `adaptive-fill-regexp'.
491 "Justify CONTENTS of ELEMENT.
492 INFO is a plist used as a communication channel. Justification
493 is done according to the type of element. More accurately,
494 paragraphs are filled and other elements are justified as blocks,
495 that is according to the widest non blank line in CONTENTS."
501 ;; Paragraphs are treated specially as they need to be filled.
509 ;; Compute maximum width. Bail out if it is greater
510 ;; than page width, since no justification is
511 ;; possible.
521 ;; Justify every line according to TEXT-WIDTH and
522 ;; MAX-WIDTH.
533 "Indent string S by WIDTH white spaces.
534 Empty lines are not indented."
540 "Return string S with a partial box to its left.
541 INFO is a plist used as a communication channel."
546 ;; Remove last newline character.
550 "Return maximum text width for ELEMENT's contents.
551 INFO is a plist used as a communication channel."
553 ;; Elements with an absolute width: `headline' and `inlinetask'.
560 ;; Elements with a relative width: store maximum text width in
561 ;; TOTAL-WIDTH.
564 ;; Total width is determined by the presence, or not, of an
565 ;; inline task among ELEMENT parents.
570 ;; No inlinetask: Remove global margin from text width.
574 ;; Inner margin doesn't apply to text before first
575 ;; headline.
579 ;; Inner margin doesn't apply to contents of
580 ;; low level headlines, since they've got their
581 ;; own indentation mechanism.
585 ;; Each `quote-block' and `verse-block' above narrows text
586 ;; width by twice the standard margin size.
590 count parent)
592 ;; Apply list margin once per "top-level" plain-list
593 ;; containing current line
601 ;; Text width within a plain-list is restricted by
602 ;; indentation of current item. If that's the case,
603 ;; compute it with the help of `:structure' property from
604 ;; parent item, if any.
609 return parent))))
611 ;; Compute indentation offset of the current item,
612 ;; that is the sum of the difference between its
613 ;; indentation and the indentation of the top item in
614 ;; the list and current item bullet's length. Also
615 ;; remove checkbox length, and tag length (for
616 ;; description lists) or bullet length.
630 "Return expected justification for ELEMENT's contents.
631 Return value is a symbol among `left', `center', `right' and
632 `full'."
646 "Format ELEMENT title and return it.
648 ELEMENT is either an `headline' or `inlinetask' element. INFO is
649 a plist used as a communication channel. TEXT-WIDTH is an
650 integer representing the maximum length of a line.
652 When optional argument UNDERLINE is non-nil, underline title,
653 without the tags, according to `org-ascii-underline'
654 specifications.
656 If optional argument NOTAGS is non-nil, no tags will be added to
657 the title.
659 When optional argument TOC is non-nil, use optional title if
660 possible. It doesn't apply to `inlinetask' elements."
663 ;; Numbering is specific to headlines.
665 ;; All tests passed: build numbering string.
668 'number-to-string
676 info)))
693 first-part
694 ;; Align tags, if any.
700 tags))
701 ;; Maybe underline text, if ELEMENT type is `headline' and an
702 ;; underline character has been defined.
712 under-char))))))))
715 "Non-nil when ELEMENT has a caption affiliated keyword.
716 INFO is a plist used as a communication channel. This function
717 is meant to be used as a predicate for `org-export-get-ordinal'."
721 "Return caption string for ELEMENT, if applicable.
723 INFO is a plist used as a communication channel.
725 The caption string contains the sequence number of ELEMENT along
726 with its real caption. Return nil when ELEMENT has no affiliated
727 caption keyword."
730 ;; Get sequence number of current src-block among every
731 ;; src-block with a caption.
739 info)))
742 " "
747 "Return a table of contents.
749 INFO is a plist used as a communication channel.
751 Optional argument N, when non-nil, is an integer specifying the
752 depth of the table.
754 Optional argument KEYWORD specifies the TOC keyword, if any, from
755 which the table of contents generation has been initiated.
757 When optional argument LOCAL is non-nil, build a table of
758 contents according to the current headline."
785 "Return a list of listings.
787 KEYWORD is the keyword that initiated the list of listings
788 generation. INFO is a plist used as a communication channel."
799 ;; Use a counter instead of retrieving ordinal of each
800 ;; src-block.
804 ;; Store initial text so its length can be computed. This is
805 ;; used to properly align caption right to it in case of
806 ;; filling (like contents of a description list item).
812 initial-text " "
816 ;; Use short name in priority, if available.
821 initial-width)))))
825 "Return a list of tables.
827 KEYWORD is the keyword that initiated the list of tables
828 generation. INFO is a plist used as a communication channel."
839 ;; Use a counter instead of retrieving ordinal of each
840 ;; src-block.
844 ;; Store initial text so its length can be computed. This is
845 ;; used to properly align caption right to it in case of
846 ;; filling (like contents of a description list item).
852 initial-text " "
856 ;; Use short name in priority, if available.
861 initial-width)))))
865 "Return a list of unique link references in ELEMENT.
866 ELEMENT is either a headline element or a section element. INFO
867 is a plist used as a communication channel."
871 ;; Return LINK if it wasn't referenced so far, or nil.
872 ;; Update SEEN links along the way.
875 ;; Normalize description in footprints.
883 ;; Ignore LINK if it hasn't been translated already.
884 ;; It can happen if it is located in an affiliated
885 ;; keyword that was ignored.
890 ;; If at a section, find parent headline, if any, in order to
891 ;; count links that might be in the title.
895 ;; Get all links in HEADLINE.
900 "Return a string describing a list of links.
902 LINKS is a list of link type objects, as returned by
903 `org-ascii--unique-links'. WIDTH is the text width allowed for
904 the output string. INFO is a plist used as a communication
905 channel."
913 ;; Coderefs, radio links and fuzzy links are ignored.
915 ;; Id and custom-id links: Headlines refer to their numbering.
921 "[%s] %s"
922 anchor
931 ;; Do not add a link that cannot be resolved and doesn't have
932 ;; any description: destination is already visible in the
933 ;; paragraph.
935 ;; Do not add a link already handled by custom export
936 ;; functions.
941 nil)
946 width info)
951 "Return checkbox string for ITEM or nil.
952 INFO is a plist used as a communication channel."
960 \f
961 ;;; Template
964 "Return document title, as a string.
965 INFO is a plist used as a communication channel."
967 ;; Links in the title will not be resolved later, so we make
968 ;; sure their path is located right after them.
980 ;; There are two types of title blocks depending on the presence
981 ;; of a title to display.
983 ;; Title block without a title. DATE is positioned at the top
984 ;; right of the document, AUTHOR to the top left and EMAIL
985 ;; just below.
989 author
991 ?\s)
992 date
997 email
999 ?\s)
1009 ;; Title block with a title. Document's TITLE, along with the
1010 ;; AUTHOR and its EMAIL are both overlined and an underlined,
1011 ;; centered. Date is just below, also centered.
1013 ;; Format TITLE. It may be filled if it is too wide,
1014 ;; that is wider than the two thirds of the total width.
1040 "Return complete document string after ASCII conversion.
1041 CONTENTS is the transcoded contents string. INFO is a plist
1042 holding export options."
1047 ;; 1. Document's body.
1048 contents
1049 ;; 2. Footnote definitions.
1051 ;; Insert full links right inside the footnote definition
1052 ;; as they have no chance to be inserted later.
1065 global-margin)))
1069 ;; Distinguish between inline definitions and
1070 ;; full-fledged definitions.
1074 ;; Full-fledged definition: footnote ID is
1075 ;; inserted inside the first parsed
1076 ;; paragraph (FIRST), if any, to be sure
1077 ;; filling will take it into consideration.
1083 ;; Fill paragraph once footnote ID is inserted
1084 ;; in order to have a correct length for first
1085 ;; line.
1088 text-width info))))))
1090 global-margin))))
1093 "Return complete document string after ASCII conversion.
1094 CONTENTS is the transcoded contents string. INFO is a plist
1095 holding export options."
1098 ;; Build title block.
1101 ;; 2. Table of contents.
1107 global-margin)
1108 ;; Document's body.
1109 contents
1110 ;; Creator. Justify it to the bottom right.
1119 global-margin)))))
1122 "Translate string S according to specified language and charset.
1123 INFO is a plist used as a communication channel."
1128 \f
1129 ;;; Transcode Functions
1131 ;;;; Bold
1134 "Transcode BOLD from Org to ASCII.
1135 CONTENTS is the text with bold markup. INFO is a plist holding
1136 contextual information."
1140 ;;;; Center Block
1143 "Transcode a CENTER-BLOCK element from Org to ASCII.
1144 CONTENTS holds the contents of the block. INFO is a plist
1145 holding contextual information."
1146 ;; Center has already been taken care of at a lower level, so
1147 ;; there's nothing left to do.
1148 contents)
1151 ;;;; Clock
1154 "Transcode a CLOCK object from Org to ASCII.
1155 CONTENTS is nil. INFO is a plist holding contextual
1156 information."
1164 "%2s:%02s"
1166 clock info))
1169 ;;;; Code
1172 "Return a CODE object from Org to ASCII.
1173 CONTENTS is nil. INFO is a plist holding contextual
1174 information."
1179 ;;;; Drawer
1182 "Transcode a DRAWER element from Org to ASCII.
1183 CONTENTS holds the contents of the block. INFO is a plist
1184 holding contextual information."
1188 name contents width)))
1191 ;;;; Dynamic Block
1194 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1195 CONTENTS holds the contents of the block. INFO is a plist
1196 holding contextual information."
1197 contents)
1200 ;;;; Entity
1203 "Transcode an ENTITY object from Org to ASCII.
1204 CONTENTS are the definition itself. INFO is a plist holding
1205 contextual information."
1208 entity))
1211 ;;;; Example Block
1214 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1215 CONTENTS is nil. INFO is a plist holding contextual information."
1219 example-block info))
1222 ;;;; Export Snippet
1225 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1226 CONTENTS is nil. INFO is a plist holding contextual information."
1231 ;;;; Export Block
1234 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1235 CONTENTS is nil. INFO is a plist holding contextual information."
1241 ;;;; Fixed Width
1244 "Transcode a FIXED-WIDTH element from Org to ASCII.
1245 CONTENTS is nil. INFO is a plist holding contextual information."
1250 fixed-width info))
1253 ;;;; Footnote Definition
1255 ;; Footnote Definitions are ignored. They are compiled at the end of
1256 ;; the document, by `org-ascii-inner-template'.
1259 ;;;; Footnote Reference
1262 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1263 CONTENTS is nil. INFO is a plist holding contextual information."
1267 ;;;; Headline
1270 "Transcode a HEADLINE element from Org to ASCII.
1271 CONTENTS holds the contents of the headline. INFO is a plist
1272 holding contextual information."
1273 ;; Don't export footnote section, which will be handled at the end
1274 ;; of the template.
1278 ;; Blank lines between headline and its contents.
1279 ;; `org-ascii-headline-spacing', when set, overwrites
1280 ;; original buffer's spacing.
1286 ;; Even if HEADLINE has no section, there might be some
1287 ;; links in its title that we shouldn't forget to describe.
1294 ;; Deep subtree: export it as a list item.
1297 ;; Bullet.
1302 " "
1303 ;; Title.
1305 ;; Contents, indented by length of bullet.
1306 pre-blanks
1311 ;; Else: Standard headline.
1318 ;;;; Horizontal Rule
1321 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1322 CONTENTS is nil. INFO is a plist holding contextual
1323 information."
1330 text-width)
1335 ;;;; Inline Src Block
1338 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1339 CONTENTS holds the contents of the item. INFO is a plist holding
1340 contextual information."
1345 ;;;; Inlinetask
1349 "Format an inline task element for ASCII export.
1350 See `org-ascii-format-inlinetask-function' for a description
1351 of the parameters."
1356 ;; Top line, with an additional blank line if not in UTF-8.
1359 ;; Add title. Fill it if wider than inlinetask.
1364 ;; If CONTENTS is not empty, insert it along with
1365 ;; a separator.
1368 ;; Bottom line.
1370 ;; Flush the inlinetask to the right.
1377 "Transcode an INLINETASK element from Org to ASCII.
1378 CONTENTS holds the contents of the block. INFO is a plist
1379 holding contextual information."
1382 ;; todo.
1387 ;; todo-type
1389 ;; priority
1392 ;; title
1394 ;; tags
1397 ;; contents and width
1398 contents width inlinetask info)))
1401 ;;;; Italic
1404 "Transcode italic from Org to ASCII.
1405 CONTENTS is the text with italic markup. INFO is a plist holding
1406 contextual information."
1410 ;;;; Item
1413 "Transcode an ITEM element from Org to ASCII.
1414 CONTENTS holds the contents of the item. INFO is a plist holding
1415 contextual information."
1420 ;; First parent of ITEM is always the plain-list. Get
1421 ;; `:type' property from it.
1429 ;; Return correct number for ITEM, paying attention to
1430 ;; counters.
1436 struct
1441 ;; Change bullets into more visible form if UTF-8 is active.
1449 bullet
1451 ;; Contents: Pay attention to indentation. Note: check-boxes are
1452 ;; already taken care of at the paragraph level so they don't
1453 ;; interfere with indentation.
1460 ;;;; Keyword
1463 "Transcode a KEYWORD element from Org to ASCII.
1464 CONTENTS is nil. INFO is a plist holding contextual
1465 information."
1483 keyword info)))))
1486 ;;;; Latex Environment
1489 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1490 CONTENTS is nil. INFO is a plist holding contextual
1491 information."
1495 latex-environment info)))
1498 ;;;; Latex Fragment
1501 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1502 CONTENTS is nil. INFO is a plist holding contextual
1503 information."
1508 ;;;; Line Break
1511 "Transcode a LINE-BREAK object from Org to ASCII.
1512 CONTENTS is nil. INFO is a plist holding contextual
1516 ;;;; Link
1519 "Transcode a LINK object from Org to ASCII.
1521 DESC is the description part of the link, or the empty string.
1522 INFO is a plist holding contextual information."
1530 ;; Do not apply a special syntax on radio links. Though, use
1531 ;; transcoded target's contents as output.
1533 ;; Do not apply a special syntax on fuzzy links pointing to
1534 ;; targets.
1545 ;; Unnumbered headline.
1550 info)))))))))
1559 ;;;; Node Properties
1562 "Transcode a NODE-PROPERTY element from Org to ASCII.
1563 CONTENTS is nil. INFO is a plist holding contextual
1564 information."
1571 ;;;; Paragraph
1574 "Transcode a PARAGRAPH element from Org to ASCII.
1575 CONTENTS is the contents of the paragraph, as a string. INFO is
1576 the plist used as a communication channel."
1581 ;; Do not indent first paragraph in a section.
1587 paragraph info))
1590 ;;;; Plain List
1593 "Transcode a PLAIN-LIST element from Org to ASCII.
1594 CONTENTS is the contents of the list. INFO is a plist holding
1595 contextual information."
1599 contents
1603 ;;;; Plain Text
1606 "Transcode a TEXT string from Org to ASCII.
1607 INFO is a plist used as a communication channel."
1614 ;; Usual replacements in utf-8 with proper option set.
1622 ;;;; Planning
1625 "Transcode a PLANNING element from Org to ASCII.
1626 CONTENTS is nil. INFO is a plist used as a communication
1627 channel."
1630 #'identity
1645 planning info))
1648 ;;;; Property Drawer
1651 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1652 CONTENTS holds the contents of the drawer. INFO is a plist
1653 holding contextual information."
1658 ;;;; Quote Block
1661 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1662 CONTENTS holds the contents of the block. INFO is a plist
1663 holding contextual information."
1667 ;;;; Radio Target
1670 "Transcode a RADIO-TARGET object from Org to ASCII.
1671 CONTENTS is the contents of the target. INFO is a plist holding
1672 contextual information."
1673 contents)
1676 ;;;; Section
1679 "Transcode a SECTION element from Org to ASCII.
1680 CONTENTS is the contents of the section. INFO is a plist holding
1681 contextual information."
1684 contents
1686 ;; Add list of links at the end of SECTION.
1690 ;; Separate list of links and section contents.
1692 ;; Do not apply inner margin if parent headline is low level.
1698 ;;;; Special Block
1701 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1702 CONTENTS holds the contents of the block. INFO is a plist
1703 holding contextual information."
1704 ;; "JUSTIFYLEFT" and "JUSTFYRIGHT" have already been taken care of
1705 ;; at a lower level. There is no other special block type to
1706 ;; handle.
1707 contents)
1710 ;;;; Src Block
1713 "Transcode a SRC-BLOCK element from Org to ASCII.
1714 CONTENTS holds the contents of the item. INFO is a plist holding
1715 contextual information."
1725 src-block info))))
1728 ;;;; Statistics Cookie
1731 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1732 CONTENTS is nil. INFO is a plist holding contextual information."
1736 ;;;; Subscript
1739 "Transcode a SUBSCRIPT object from Org to ASCII.
1740 CONTENTS is the contents of the object. INFO is a plist holding
1741 contextual information."
1747 ;;;; Superscript
1750 "Transcode a SUPERSCRIPT object from Org to ASCII.
1751 CONTENTS is the contents of the object. INFO is a plist holding
1752 contextual information."
1758 ;;;; Strike-through
1761 "Transcode STRIKE-THROUGH from Org to ASCII.
1762 CONTENTS is text with strike-through markup. INFO is a plist
1763 holding contextual information."
1767 ;;;; Table
1770 "Transcode a TABLE element from Org to ASCII.
1771 CONTENTS is the contents of the table. INFO is a plist holding
1772 contextual information."
1777 ;; Possibly add a caption string above.
1779 ;; Insert table. Note: "table.el" tables are left unmodified.
1793 ;; Possible add a caption string below.
1795 table info)))
1798 ;;;; Table Cell
1801 "Return width of TABLE-CELL.
1803 INFO is a plist used as a communication channel.
1805 Width of a cell is determined either by a width cookie in the
1806 same column as the cell, or by the maximum cell's length in that
1807 column.
1809 When `org-ascii-table-widen-columns' is non-nil, width cookies
1810 are ignored."
1825 key
1837 info))
1838 max-width)))
1839 info)
1840 max-width)))
1844 cache))))
1847 "Transcode a TABLE-CELL object from Org to ASCII.
1848 CONTENTS is the cell contents. INFO is a plist used as
1849 a communication channel."
1850 ;; Determine column width. When `org-ascii-table-widen-columns'
1851 ;; is nil and some width cookie has set it, use that value.
1852 ;; Otherwise, compute the maximum width among transcoded data of
1853 ;; each cell in the column.
1855 ;; When contents are too large, truncate them.
1859 ;; Align contents correctly within the cell.
1864 contents width
1869 ;; Return cell.
1875 ;;;; Table Row
1878 "Transcode a TABLE-ROW element from Org to ASCII.
1879 CONTENTS is the row contents. INFO is a plist used as
1880 a communication channel."
1887 'concat
1893 ;; In order to know if CELL starts the row, do
1894 ;; not compare it with the first cell in the
1895 ;; row as there might be a special column.
1896 ;; Instead, compare it with first exportable
1897 ;; cell, obtained with `org-element-map'.
1901 cell))
1902 lcorner)
1907 rcorner)
1913 info)))
1928 ;;;; Timestamp
1931 "Transcode a TIMESTAMP object from Org to ASCII.
1932 CONTENTS is nil. INFO is a plist holding contextual information."
1936 ;;;; Underline
1939 "Transcode UNDERLINE from Org to ASCII.
1940 CONTENTS is the text with underline markup. INFO is a plist
1941 holding contextual information."
1945 ;;;; Verbatim
1948 "Return a VERBATIM object from Org to ASCII.
1949 CONTENTS is nil. INFO is a plist holding contextual information."
1954 ;;;; Verse Block
1957 "Transcode a VERSE-BLOCK element from Org to ASCII.
1958 CONTENTS is verse block contents. INFO is a plist holding
1959 contextual information."
1966 \f
1967 ;;; Filters
1970 "Filter controlling number of blank lines after a headline.
1972 HEADLINE is a string representing a transcoded headline.
1973 BACK-END is symbol specifying back-end used for export. INFO is
1974 plist containing the communication channel.
1976 This function only applies to `ascii' back-end. See
1977 `org-ascii-headline-spacing' for information."
1984 "Filter controlling number of blank lines between paragraphs.
1986 TREE is the parse tree. BACK-END is the symbol specifying
1987 back-end used for export. INFO is a plist used as
1988 a communication channel.
1990 See `org-ascii-paragraph-spacing' for information."
1998 tree)
2001 "Filter removing blank lines between comments.
2002 TREE is the parse tree. BACK-END is the symbol specifying
2003 back-end used for export. INFO is a plist used as
2004 a communication channel."
2010 tree)
2013 \f
2014 ;;; End-user functions
2016 ;;;###autoload
2019 "Export current buffer to a text buffer.
2021 If narrowing is active in the current buffer, only export its
2022 narrowed part.
2024 If a region is active, export that region.
2026 A non-nil optional argument ASYNC means the process should happen
2027 asynchronously. The resulting buffer should be accessible
2028 through the `org-export-stack' interface.
2030 When optional argument SUBTREEP is non-nil, export the sub-tree
2031 at point, extracting information from the headline properties
2032 first.
2034 When optional argument VISIBLE-ONLY is non-nil, don't export
2035 contents of hidden elements.
2037 When optional argument BODY-ONLY is non-nil, strip title and
2038 table of contents from output.
2040 EXT-PLIST, when provided, is a property list with external
2041 parameters overriding Org default settings, but still inferior to
2042 file-local settings.
2045 will be displayed when `org-export-show-temporary-export-buffer'
2046 is non-nil."
2051 ;;;###autoload
2054 "Export current buffer to a text file.
2056 If narrowing is active in the current buffer, only export its
2057 narrowed part.
2059 If a region is active, export that region.
2061 A non-nil optional argument ASYNC means the process should happen
2062 asynchronously. The resulting file should be accessible through
2063 the `org-export-stack' interface.
2065 When optional argument SUBTREEP is non-nil, export the sub-tree
2066 at point, extracting information from the headline properties
2067 first.
2069 When optional argument VISIBLE-ONLY is non-nil, don't export
2070 contents of hidden elements.
2072 When optional argument BODY-ONLY is non-nil, strip title and
2073 table of contents from output.
2075 EXT-PLIST, when provided, is a property list with external
2076 parameters overriding Org default settings, but still inferior to
2077 file-local settings.
2079 Return output file's name."
2083 async subtreep visible-only body-only ext-plist)))
2085 ;;;###autoload
2087 "Publish an Org file to ASCII.
2089 FILENAME is the filename of the Org file to be published. PLIST
2090 is the property list for the given project. PUB-DIR is the
2091 publishing directory.
2093 Return output file name."
2097 ;;;###autoload
2099 "Publish an Org file to Latin-1.
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 UTF-8.
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."
2124 ;; Local variables:
2125 ;; generated-autoload-file: "org-loaddefs.el"
2126 ;; coding: utf-8-emacs
2127 ;; End:
2129 ;;; ox-ascii.el ends here