| blob | f8192504c44b0985aae000d8b5b06d516ec3813a |
1 ;;; ox-ascii.el --- ASCII Back-End for Org Export Engine -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2017 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements an ASCII back-end for Org generic exporter.
26 ;; See Org manual for more information.
28 ;;; Code:
36 ;;; Define Back-End
37 ;;
38 ;; The following setting won't allow modifying preferred charset
39 ;; through a buffer keyword or an option item, but, since the property
40 ;; will appear in communication channel nonetheless, it allows
41 ;; overriding `org-ascii-charset' variable on the fly by the ext-plist
42 ;; mechanism.
43 ;;
44 ;; We also install a filter for headlines and sections, in order to
45 ;; control blank lines separating them in output string.
96 :menu-entry
117 (:filter-parse-tree org-ascii-filter-paragraph-spacing
118 org-ascii-filter-comment-spacing)
120 :options-alist
127 (:ascii-format-inlinetask-function
128 nil nil org-ascii-format-inlinetask-function)
137 (:ascii-table-keep-all-vertical-lines
138 nil nil org-ascii-table-keep-all-vertical-lines)
146 \f
147 ;;; User Configurable Variables
150 "Options for exporting Org mode files to ASCII."
155 "Maximum width of exported text.
156 This number includes margin size, as set in
157 `org-ascii-global-margin'."
164 "Width of the left margin, in number of characters."
171 "Width of the inner margin, in number of characters.
172 Inner margin is applied between each headline."
179 "Width of margin used for quoting text, in characters.
180 This margin is applied on both sides of the text."
187 "Width of margin used for plain lists, in characters.
188 This margin applies to top level list only, not to its
189 sub-lists."
196 "Width of inline tasks, in number of characters.
197 This number ignores any margin."
204 "Number of blank lines inserted around headlines.
206 This variable can be set to a cons cell. In that case, its car
207 represents the number of blank lines present before headline
208 contents whereas its cdr reflects the number of blank lines after
209 contents.
211 A nil value replicates the number of blank lines found in the
212 original Org buffer at the same place."
223 "Additional indentation width for the first line in a paragraph.
224 If the value is an integer, indent the first line of each
225 paragraph by this width, unless it is located at the beginning of
226 a section, in which case indentation is removed from that line.
227 If it is the symbol `auto' preserve indentation from original
228 document."
237 "Number of white lines between paragraphs.
238 If the value is an integer, add this number of blank lines
239 between contiguous paragraphs. If is it the symbol `auto', keep
240 the same number of blank lines as in the original document."
249 "The charset allowed to represent various elements and objects.
250 Possible values are:
251 `ascii' Only use plain ASCII characters
252 `latin1' Include Latin-1 characters
253 `utf-8' Use all UTF-8 characters"
265 "Characters for underlining headings in ASCII export.
267 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
268 and whose value is a list of characters.
270 For each supported charset, this variable associates a sequence
271 of underline characters. In a sequence, the characters will be
272 used in order for headlines level 1, 2, ... If no character is
273 available for a given level, the headline won't be underlined."
291 "Bullet characters for headlines converted to lists in ASCII export.
293 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
294 and whose value is a list of characters.
296 The first character is used for the first level considered as low
297 level, and so on. If there are more levels than characters given
298 here, the list will be repeated.
300 Note that this variable doesn't affect plain lists
301 representation."
317 "Non-nil means convert links to notes before the next headline.
318 When nil, the link will be exported in place. If the line
319 becomes long in this way, it will be wrapped."
326 "Non-nil means keep all vertical lines in ASCII tables.
327 When nil, vertical lines will be removed except for those needed
328 for column grouping."
335 "Non-nil means widen narrowed columns for export.
336 When nil, narrowed columns will look in ASCII export just like in
345 It only makes sense when export charset is `utf-8'. It is nil by
347 available through, e.g., GNU ELPA."
354 "When non-nil, place caption string before the element.
355 Otherwise, place it right after it."
362 "Format string used for verbatim text and inline code."
370 "Function called to format a drawer in ASCII.
372 The function must accept three parameters:
374 CONTENTS the contents of the drawer.
375 WIDTH the text width within the drawer.
377 The function should return either the string to be exported or
378 nil to ignore the drawer.
380 The default value simply returns the value of CONTENTS."
387 'org-ascii-format-inlinetask-default
388 "Function called to format an inlinetask in ASCII.
390 The function must accept nine parameters:
391 TODO the todo keyword, as a string
392 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
393 PRIORITY the inlinetask priority, as a string
394 NAME the inlinetask name, as a string.
395 TAGS the inlinetask tags, as a list of strings.
396 CONTENTS the contents of the inlinetask, as a string.
397 WIDTH the width of the inlinetask, as a number.
398 INLINETASK the inlinetask itself.
399 INFO the info channel.
401 The function should return either the string to be exported or
402 nil to ignore the inline task."
409 \f
410 ;;; Internal Functions
412 ;; Internal functions fall into three categories.
414 ;; The first one is about text formatting. The core functions are
415 ;; `org-ascii--current-text-width' and
416 ;; `org-ascii--current-justification', which determine, respectively,
417 ;; the current text width allowed to a given element and its expected
418 ;; justification. Once this information is known,
419 ;; `org-ascii--fill-string', `org-ascii--justify-lines',
420 ;; `org-ascii--justify-element' `org-ascii--box-string' and
421 ;; `org-ascii--indent-string' can operate on a given output string.
422 ;; In particular, justification happens at the regular (i.e.,
423 ;; non-greater) element level, which means that when the exporting
424 ;; process reaches a container (e.g., a center block) content are
425 ;; already justified.
427 ;; The second category contains functions handling elements listings,
428 ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
429 ;; returns a complete table of contents, `org-ascii--list-listings'
430 ;; returns a list of referenceable src-block elements, and
431 ;; `org-ascii--list-tables' does the same for table elements.
433 ;; The third category includes general helper functions.
434 ;; `org-ascii--build-title' creates the title for a given headline
435 ;; or inlinetask element. `org-ascii--build-caption' returns the
436 ;; caption string associated to a table or a src-block.
437 ;; `org-ascii--describe-links' creates notes about links for
438 ;; insertion at the end of a section. It uses
439 ;; `org-ascii--unique-links' to get the list of links to describe.
440 ;; Eventually, `org-ascii--translate' translates a string according
441 ;; to language and charset specification.
445 "Fill a string with specified text-width and return it.
447 S is the string being filled. TEXT-WIDTH is an integer
448 specifying maximum length of a line. INFO is the plist used as
449 a communication channel.
451 Optional argument JUSTIFY can specify any type of justification
452 among `left', `center', `right' or `full'. A nil value is
453 equivalent to `left'. For a justification that doesn't also fill
454 string, see `org-ascii--justify-lines' and
455 `org-ascii--justify-block'.
457 Return nil if S isn't a string."
466 s))
471 "Justify all lines in string S.
472 TEXT-WIDTH is an integer specifying maximum length of a line.
473 HOW determines the type of justification: it can be `left',
474 `right', `full' or `center'."
479 ;; Disable `adaptive-fill-mode' so it doesn't prevent
480 ;; filling lines matching `adaptive-fill-regexp'.
488 "Justify CONTENTS of ELEMENT.
489 INFO is a plist used as a communication channel. Justification
490 is done according to the type of element. More accurately,
491 paragraphs are filled and other elements are justified as blocks,
492 that is according to the widest non blank line in CONTENTS."
498 ;; Paragraphs are treated specially as they need to be filled.
506 ;; Compute maximum width. Bail out if it is greater
507 ;; than page width, since no justification is
508 ;; possible.
518 ;; Justify every line according to TEXT-WIDTH and
519 ;; MAX-WIDTH.
530 "Indent string S by WIDTH white spaces.
531 Empty lines are not indented."
537 "Return string S with a partial box to its left.
538 INFO is a plist used as a communication channel."
543 ;; Remove last newline character.
547 "Return maximum text width for ELEMENT's contents.
548 INFO is a plist used as a communication channel."
550 ;; Elements with an absolute width: `headline' and `inlinetask'.
552 (`headline
557 ;; Elements with a relative width: store maximum text width in
558 ;; TOTAL-WIDTH.
561 ;; Total width is determined by the presence, or not, of an
562 ;; inline task among ELEMENT parents.
566 genealogy)
568 ;; No inlinetask: Remove global margin from text width.
572 ;; Inner margin doesn't apply to text before first
573 ;; headline.
577 ;; Inner margin doesn't apply to contents of
578 ;; low level headlines, since they've got their
579 ;; own indentation mechanism.
583 ;; Each `quote-block' and `verse-block' above narrows text
584 ;; width by twice the standard margin size.
588 genealogy)
589 2
591 ;; Apply list margin once per "top-level" plain-list
592 ;; containing current line
598 genealogy)
600 ;; Text width within a plain-list is restricted by
601 ;; indentation of current item. If that's the case,
602 ;; compute it with the help of `:structure' property from
603 ;; parent item, if any.
608 genealogy))))
610 ;; Compute indentation offset of the current item,
611 ;; that is the sum of the difference between its
612 ;; indentation and the indentation of the top item in
613 ;; the list and current item bullet's length. Also
614 ;; remove checkbox length, and tag length (for
615 ;; description lists) or bullet length.
629 "Return expected justification for ELEMENT's contents.
630 Return value is a symbol among `left', `center', `right' and
631 `full'."
637 (`special-block
645 "Format ELEMENT title and return it.
647 ELEMENT is either an `headline' or `inlinetask' element. INFO is
648 a plist used as a communication channel. TEXT-WIDTH is an
649 integer representing the maximum length of a line.
651 When optional argument UNDERLINE is non-nil, underline title,
652 without the tags, according to `org-ascii-underline'
653 specifications.
655 If optional argument NOTAGS is non-nil, no tags will be added to
656 the title.
658 When optional argument TOC is non-nil, use optional title if
659 possible. It doesn't apply to `inlinetask' elements."
662 ;; Numbering is specific to headlines.
664 ;; All tests passed: build numbering string.
667 'number-to-string
675 info)))
692 first-part
693 ;; Align tags, if any.
699 tags))
700 ;; Maybe underline text, if ELEMENT type is `headline' and an
701 ;; underline character has been defined.
711 under-char))))))))
714 "Non-nil when ELEMENT has a caption affiliated keyword.
715 INFO is a plist used as a communication channel. This function
716 is meant to be used as a predicate for `org-export-get-ordinal'."
720 "Return caption string for ELEMENT, if applicable.
722 INFO is a plist used as a communication channel.
724 The caption string contains the sequence number of ELEMENT along
725 with its real caption. Return nil when ELEMENT has no affiliated
726 caption keyword."
729 ;; Get sequence number of current src-block among every
730 ;; src-block with a caption.
738 info)))
741 " "
746 "Return a table of contents.
748 INFO is a plist used as a communication channel.
750 Optional argument N, when non-nil, is an integer specifying the
751 depth of the table.
753 Optional argument KEYWORD specifies the TOC keyword, if any, from
754 which the table of contents generation has been initiated.
756 When optional argument LOCAL is non-nil, build a table of
757 contents according to the current headline."
784 "Return a list of listings.
786 KEYWORD is the keyword that initiated the list of listings
787 generation. INFO is a plist used as a communication channel."
798 ;; Use a counter instead of retrieving ordinal of each
799 ;; src-block.
803 ;; Store initial text so its length can be computed. This is
804 ;; used to properly align caption right to it in case of
805 ;; filling (like contents of a description list item).
811 initial-text " "
815 ;; Use short name in priority, if available.
820 initial-width)))))
824 "Return a list of tables.
826 KEYWORD is the keyword that initiated the list of tables
827 generation. INFO is a plist used as a communication channel."
838 ;; Use a counter instead of retrieving ordinal of each
839 ;; src-block.
843 ;; Store initial text so its length can be computed. This is
844 ;; used to properly align caption right to it in case of
845 ;; filling (like contents of a description list item).
851 initial-text " "
855 ;; Use short name in priority, if available.
860 initial-width)))))
864 "Return a list of unique link references in ELEMENT.
865 ELEMENT is either a headline element or a section element. INFO
866 is a plist used as a communication channel."
869 ;; Return LINK if it wasn't referenced so far, or nil.
870 ;; Update SEEN links along the way.
873 ;; Normalize description in footprints.
881 ;; Ignore LINK if it hasn't been translated already. It
882 ;; can happen if it is located in an affiliated keyword
883 ;; that was ignored.
889 element
890 ;; In a headline, only retrieve links in title
891 ;; and relative section, not in children.
897 "Describe DATUM object or element.
898 If DATUM is a string, consider it to be a file name, per
899 `org-export-resolve-id-link'. INFO is the communication channel,
900 as a plist."
903 (`headline
913 ;; If destination is a target, make sure we can name the
914 ;; container it refers to.
919 (`headline
927 (`paragraph
929 (`src-block
931 (`table
936 "Return a string describing a list of links.
937 LINKS is a list of link type objects, as returned by
938 `org-ascii--unique-links'. WIDTH is the text width allowed for
939 the output string. INFO is a plist used as a communication
940 channel."
947 info)))
951 ;; Only links with a description need an entry. Other are
952 ;; already handled in `org-ascii-link'.
960 width info)
962 ;; Do not add a link that cannot be resolved and doesn't have
963 ;; any description: destination is already visible in the
964 ;; paragraph.
966 ;; Do not add a link already handled by custom export
967 ;; functions.
973 width info)
978 "Return checkbox string for ITEM or nil.
979 INFO is a plist used as a communication channel."
987 \f
988 ;;; Template
991 "Return document title, as a string.
992 INFO is a plist used as a communication channel."
994 ;; Links in the title will not be resolved later, so we make
995 ;; sure their path is located right after them.
1009 ;; There are two types of title blocks depending on the presence
1010 ;; of a title to display.
1012 ;; Title block without a title. DATE is positioned at the top
1013 ;; right of the document, AUTHOR to the top left and EMAIL
1014 ;; just below.
1018 author
1020 ?\s)
1021 date
1026 email
1028 ?\s)
1038 ;; Title block with a title. Document's TITLE, along with the
1039 ;; AUTHOR and its EMAIL are both overlined and an underlined,
1040 ;; centered. Date is just below, also centered.
1042 ;; Format TITLE. It may be filled if it is too wide,
1043 ;; that is wider than the two thirds of the total width.
1074 "Return complete document string after ASCII conversion.
1075 CONTENTS is the transcoded contents string. INFO is a plist
1076 holding export options."
1081 ;; 1. Document's body.
1082 contents
1083 ;; 2. Footnote definitions.
1085 ;; Insert full links right inside the footnote definition
1086 ;; as they have no chance to be inserted later.
1099 global-margin)))
1103 ;; Distinguish between inline definitions and
1104 ;; full-fledged definitions.
1109 ;; Full-fledged definition: footnote ID is
1110 ;; inserted inside the first parsed
1111 ;; paragraph (FIRST), if any, to be sure
1112 ;; filling will take it into consideration.
1118 ;; Fill paragraph once footnote ID is inserted
1119 ;; in order to have a correct length for first
1120 ;; line.
1123 text-width info))))))
1125 global-margin))))
1128 "Return complete document string after ASCII conversion.
1129 CONTENTS is the transcoded contents string. INFO is a plist
1130 holding export options."
1133 ;; Build title block.
1136 ;; 2. Table of contents.
1142 global-margin)
1143 ;; Document's body.
1144 contents
1145 ;; Creator. Justify it to the bottom right.
1154 global-margin)))))
1157 "Translate string S according to specified language and charset.
1158 INFO is a plist used as a communication channel."
1163 \f
1164 ;;; Transcode Functions
1166 ;;;; Bold
1169 "Transcode BOLD from Org to ASCII.
1170 CONTENTS is the text with bold markup. INFO is a plist holding
1171 contextual information."
1175 ;;;; Center Block
1178 "Transcode a CENTER-BLOCK element from Org to ASCII.
1179 CONTENTS holds the contents of the block. INFO is a plist
1180 holding contextual information."
1181 ;; Center has already been taken care of at a lower level, so
1182 ;; there's nothing left to do.
1183 contents)
1186 ;;;; Clock
1189 "Transcode a CLOCK object from Org to ASCII.
1190 CONTENTS is nil. INFO is a plist holding contextual
1191 information."
1199 "%2s:%02s"
1201 clock info))
1204 ;;;; Code
1207 "Return a CODE object from Org to ASCII.
1208 CONTENTS is nil. INFO is a plist holding contextual
1209 information."
1214 ;;;; Drawer
1217 "Transcode a DRAWER element from Org to ASCII.
1218 CONTENTS holds the contents of the block. INFO is a plist
1219 holding contextual information."
1223 name contents width)))
1226 ;;;; Dynamic Block
1229 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1230 CONTENTS holds the contents of the block. INFO is a plist
1231 holding contextual information."
1232 contents)
1235 ;;;; Entity
1238 "Transcode an ENTITY object from Org to ASCII.
1239 CONTENTS are the definition itself. INFO is a plist holding
1240 contextual information."
1243 entity))
1246 ;;;; Example Block
1249 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1250 CONTENTS is nil. INFO is a plist holding contextual information."
1254 example-block info))
1257 ;;;; Export Snippet
1260 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1261 CONTENTS is nil. INFO is a plist holding contextual information."
1266 ;;;; Export Block
1269 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1270 CONTENTS is nil. INFO is a plist holding contextual information."
1276 ;;;; Fixed Width
1279 "Transcode a FIXED-WIDTH element from Org to ASCII.
1280 CONTENTS is nil. INFO is a plist holding contextual information."
1285 fixed-width info))
1288 ;;;; Footnote Definition
1290 ;; Footnote Definitions are ignored. They are compiled at the end of
1291 ;; the document, by `org-ascii-inner-template'.
1294 ;;;; Footnote Reference
1297 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1298 CONTENTS is nil. INFO is a plist holding contextual information."
1302 ;;;; Headline
1305 "Transcode a HEADLINE element from Org to ASCII.
1306 CONTENTS holds the contents of the headline. INFO is a plist
1307 holding contextual information."
1308 ;; Don't export footnote section, which will be handled at the end
1309 ;; of the template.
1313 ;; Export title early so that any link in it can be
1314 ;; exported and seen in `org-ascii--unique-links'.
1316 ;; Blank lines between headline and its contents.
1317 ;; `org-ascii-headline-spacing', when set, overwrites
1318 ;; original buffer's spacing.
1327 ;; Re-build contents, inserting section links at the right
1328 ;; place. The cost is low since build results are cached.
1334 first))))
1339 links
1343 ;; Deep subtree: export it as a list item.
1351 ;; Contents, indented by length of bullet.
1353 ;; Else: Standard headline.
1357 ;;;; Horizontal Rule
1360 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1361 CONTENTS is nil. INFO is a plist holding contextual
1362 information."
1369 text-width)
1374 ;;;; Inline Src Block
1377 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1378 CONTENTS holds the contents of the item. INFO is a plist holding
1379 contextual information."
1384 ;;;; Inlinetask
1388 "Format an inline task element for ASCII export.
1389 See `org-ascii-format-inlinetask-function' for a description
1390 of the parameters."
1395 ;; Top line, with an additional blank line if not in UTF-8.
1398 ;; Add title. Fill it if wider than inlinetask.
1403 ;; If CONTENTS is not empty, insert it along with
1404 ;; a separator.
1407 ;; Bottom line.
1409 ;; Flush the inlinetask to the right.
1416 "Transcode an INLINETASK element from Org to ASCII.
1417 CONTENTS holds the contents of the block. INFO is a plist
1418 holding contextual information."
1421 ;; todo.
1426 ;; todo-type
1428 ;; priority
1431 ;; title
1433 ;; tags
1436 ;; contents and width
1437 contents width inlinetask info)))
1440 ;;;; Italic
1443 "Transcode italic from Org to ASCII.
1444 CONTENTS is the text with italic markup. INFO is a plist holding
1445 contextual information."
1449 ;;;; Item
1452 "Transcode an ITEM element from Org to ASCII.
1453 CONTENTS holds the contents of the item. INFO is a plist holding
1454 contextual information."
1459 ;; First parent of ITEM is always the plain-list. Get
1460 ;; `:type' property from it.
1463 (`descriptive
1467 (`ordered
1468 ;; Return correct number for ITEM, paying attention to
1469 ;; counters.
1475 struct
1480 ;; Change bullets into more visible form if UTF-8 is active.
1488 bullet
1490 ;; Contents: Pay attention to indentation. Note: check-boxes are
1491 ;; already taken care of at the paragraph level so they don't
1492 ;; interfere with indentation.
1499 ;;;; Keyword
1502 "Transcode a KEYWORD element from Org to ASCII.
1503 CONTENTS is nil. INFO is a plist holding contextual
1504 information."
1522 keyword info)))))
1525 ;;;; Latex Environment
1528 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1529 CONTENTS is nil. INFO is a plist holding contextual
1530 information."
1534 latex-environment info)))
1537 ;;;; Latex Fragment
1540 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1541 CONTENTS is nil. INFO is a plist holding contextual
1542 information."
1547 ;;;; Line Break
1550 "Transcode a LINE-BREAK object from Org to ASCII.
1551 CONTENTS is nil. INFO is a plist holding contextual
1555 ;;;; Link
1558 "Transcode a LINK object from Org to ASCII.
1560 DESC is the description part of the link, or the empty string.
1561 INFO is a plist holding contextual information."
1569 ;; Do not apply a special syntax on radio links. Though, use
1570 ;; transcoded target's contents as output.
1583 ;; External file.
1585 (`headline
1591 ;; Handle enumerable elements and targets within them.
1597 ;; Don't know what to do. Signal it.
1607 ;;;; Node Properties
1610 "Transcode a NODE-PROPERTY element from Org to ASCII.
1611 CONTENTS is nil. INFO is a plist holding contextual
1612 information."
1619 ;;;; Paragraph
1622 "Transcode a PARAGRAPH element from Org to ASCII.
1623 CONTENTS is the contents of the paragraph, as a string. INFO is
1624 the plist used as a communication channel."
1629 ;; Do not indent first paragraph in a section.
1635 paragraph info))
1638 ;;;; Plain List
1641 "Transcode a PLAIN-LIST element from Org to ASCII.
1642 CONTENTS is the contents of the list. INFO is a plist holding
1643 contextual information."
1647 contents
1651 ;;;; Plain Text
1654 "Transcode a TEXT string from Org to ASCII.
1655 INFO is a plist used as a communication channel."
1662 ;; Usual replacements in utf-8 with proper option set.
1670 ;;;; Planning
1673 "Transcode a PLANNING element from Org to ASCII.
1674 CONTENTS is nil. INFO is a plist used as a communication
1675 channel."
1678 #'identity
1693 planning info))
1696 ;;;; Property Drawer
1699 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1700 CONTENTS holds the contents of the drawer. INFO is a plist
1701 holding contextual information."
1706 ;;;; Quote Block
1709 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1710 CONTENTS holds the contents of the block. INFO is a plist
1711 holding contextual information."
1715 ;;;; Radio Target
1718 "Transcode a RADIO-TARGET object from Org to ASCII.
1719 CONTENTS is the contents of the target. INFO is a plist holding
1720 contextual information."
1721 contents)
1724 ;;;; Section
1727 "Transcode a SECTION element from Org to ASCII.
1728 CONTENTS is the contents of the section. INFO is a plist holding
1729 contextual information."
1732 ;; Take care of links in first section of the document.
1737 info))))
1741 ;; Do not apply inner margin if parent headline is low level.
1747 ;;;; Special Block
1750 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1751 CONTENTS holds the contents of the block. INFO is a plist
1752 holding contextual information."
1753 ;; "JUSTIFYLEFT" and "JUSTIFYRIGHT" have already been taken care of
1754 ;; at a lower level. There is no other special block type to
1755 ;; handle.
1756 contents)
1759 ;;;; Src Block
1762 "Transcode a SRC-BLOCK element from Org to ASCII.
1763 CONTENTS holds the contents of the item. INFO is a plist holding
1764 contextual information."
1774 src-block info))))
1777 ;;;; Statistics Cookie
1780 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1781 CONTENTS is nil. INFO is a plist holding contextual information."
1785 ;;;; Subscript
1788 "Transcode a SUBSCRIPT object from Org to ASCII.
1789 CONTENTS is the contents of the object. INFO is a plist holding
1790 contextual information."
1796 ;;;; Superscript
1799 "Transcode a SUPERSCRIPT object from Org to ASCII.
1800 CONTENTS is the contents of the object. INFO is a plist holding
1801 contextual information."
1807 ;;;; Strike-through
1810 "Transcode STRIKE-THROUGH from Org to ASCII.
1811 CONTENTS is text with strike-through markup. INFO is a plist
1812 holding contextual information."
1816 ;;;; Table
1819 "Transcode a TABLE element from Org to ASCII.
1820 CONTENTS is the contents of the table. INFO is a plist holding
1821 contextual information."
1826 ;; Possibly add a caption string above.
1828 ;; Insert table. Note: "table.el" tables are left unmodified.
1842 ;; Possible add a caption string below.
1844 table info)))
1847 ;;;; Table Cell
1850 "Return width of TABLE-CELL.
1852 INFO is a plist used as a communication channel.
1854 Width of a cell is determined either by a width cookie in the
1855 same column as the cell, or by the maximum cell's length in that
1856 column.
1858 When `org-ascii-table-widen-columns' is non-nil, width cookies
1859 are ignored."
1874 key
1886 info))
1887 max-width)))
1888 info)
1889 max-width)))
1893 cache))))
1896 "Transcode a TABLE-CELL object from Org to ASCII.
1897 CONTENTS is the cell contents. INFO is a plist used as
1898 a communication channel."
1899 ;; Determine column width. When `org-ascii-table-widen-columns'
1900 ;; is nil and some width cookie has set it, use that value.
1901 ;; Otherwise, compute the maximum width among transcoded data of
1902 ;; each cell in the column.
1904 ;; When contents are too large, truncate them.
1908 ;; Align contents correctly within the cell.
1913 contents width
1918 ;; Return cell.
1924 ;;;; Table Row
1927 "Transcode a TABLE-ROW element from Org to ASCII.
1928 CONTENTS is the row contents. INFO is a plist used as
1929 a communication channel."
1936 'concat
1942 ;; In order to know if CELL starts the row, do
1943 ;; not compare it with the first cell in the
1944 ;; row as there might be a special column.
1945 ;; Instead, compare it with first exportable
1946 ;; cell, obtained with `org-element-map'.
1950 cell))
1951 lcorner)
1956 rcorner)
1962 info)))
1977 ;;;; Timestamp
1980 "Transcode a TIMESTAMP object from Org to ASCII.
1981 CONTENTS is nil. INFO is a plist holding contextual information."
1985 ;;;; Underline
1988 "Transcode UNDERLINE from Org to ASCII.
1989 CONTENTS is the text with underline markup. INFO is a plist
1990 holding contextual information."
1994 ;;;; Verbatim
1997 "Return a VERBATIM object from Org to ASCII.
1998 CONTENTS is nil. INFO is a plist holding contextual information."
2003 ;;;; Verse Block
2006 "Transcode a VERSE-BLOCK element from Org to ASCII.
2007 CONTENTS is verse block contents. INFO is a plist holding
2008 contextual information."
2014 \f
2015 ;;; Filters
2018 "Filter controlling number of blank lines after a headline.
2020 HEADLINE is a string representing a transcoded headline. BACKEND
2021 is symbol specifying back-end used for export. INFO is plist
2022 containing the communication channel.
2024 This function only applies to `ascii' back-end. See
2025 `org-ascii-headline-spacing' for information."
2032 "Filter controlling number of blank lines between paragraphs.
2034 TREE is the parse tree. BACKEND is the symbol specifying
2035 back-end used for export. INFO is a plist used as
2036 a communication channel.
2038 See `org-ascii-paragraph-spacing' for information."
2046 tree)
2049 "Filter removing blank lines between comments.
2050 TREE is the parse tree. BACKEND is the symbol specifying
2051 back-end used for export. INFO is a plist used as
2052 a communication channel."
2058 tree)
2061 \f
2062 ;;; End-user functions
2064 ;;;###autoload
2067 "Export current buffer to a text buffer.
2069 If narrowing is active in the current buffer, only export its
2070 narrowed part.
2072 If a region is active, export that region.
2074 A non-nil optional argument ASYNC means the process should happen
2075 asynchronously. The resulting buffer should be accessible
2076 through the `org-export-stack' interface.
2078 When optional argument SUBTREEP is non-nil, export the sub-tree
2079 at point, extracting information from the headline properties
2080 first.
2082 When optional argument VISIBLE-ONLY is non-nil, don't export
2083 contents of hidden elements.
2085 When optional argument BODY-ONLY is non-nil, strip title and
2086 table of contents from output.
2088 EXT-PLIST, when provided, is a property list with external
2089 parameters overriding Org default settings, but still inferior to
2090 file-local settings.
2093 will be displayed when `org-export-show-temporary-export-buffer'
2094 is non-nil."
2099 ;;;###autoload
2102 "Export current buffer to a text file.
2104 If narrowing is active in the current buffer, only export its
2105 narrowed part.
2107 If a region is active, export that region.
2109 A non-nil optional argument ASYNC means the process should happen
2110 asynchronously. The resulting file should be accessible through
2111 the `org-export-stack' interface.
2113 When optional argument SUBTREEP is non-nil, export the sub-tree
2114 at point, extracting information from the headline properties
2115 first.
2117 When optional argument VISIBLE-ONLY is non-nil, don't export
2118 contents of hidden elements.
2120 When optional argument BODY-ONLY is non-nil, strip title and
2121 table of contents from output.
2123 EXT-PLIST, when provided, is a property list with external
2124 parameters overriding Org default settings, but still inferior to
2125 file-local settings.
2127 Return output file's name."
2131 async subtreep visible-only body-only ext-plist)))
2133 ;;;###autoload
2135 "Publish an Org file to ASCII.
2137 FILENAME is the filename of the Org file to be published. PLIST
2138 is the property list for the given project. PUB-DIR is the
2139 publishing directory.
2141 Return output file name."
2145 ;;;###autoload
2147 "Publish an Org file to Latin-1.
2149 FILENAME is the filename of the Org file to be published. PLIST
2150 is the property list for the given project. PUB-DIR is the
2151 publishing directory.
2153 Return output file name."
2157 ;;;###autoload
2159 "Publish an org file to UTF-8.
2161 FILENAME is the filename of the Org file to be published. PLIST
2162 is the property list for the given project. PUB-DIR is the
2163 publishing directory.
2165 Return output file name."
2172 ;; Local variables:
2173 ;; generated-autoload-file: "org-loaddefs.el"
2174 ;; coding: utf-8
2175 ;; End:
2177 ;;; ox-ascii.el ends here