| blob | f7bc31918e1ed434d540d8c7b6eca90e7d7a74d7 |
1 ;;; ox-ascii.el --- ASCII Back-End for Org Export Engine
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; This library implements an ASCII back-end for Org generic exporter.
26 ;; See Org manual for more information.
28 ;;; Code:
36 ;;; Define Back-End
37 ;;
38 ;; The following setting won't allow to modify preferred charset
39 ;; through a buffer keyword or an option item, but, since the property
40 ;; will appear in communication channel nonetheless, it allows to
41 ;; override `org-ascii-charset' variable on the fly by the ext-plist
42 ;; mechanism.
43 ;;
44 ;; We also install a filter for headlines and sections, in order to
45 ;; control blank lines separating them in output string.
99 :menu-entry
120 (:filter-parse-tree org-ascii-filter-paragraph-spacing
121 org-ascii-filter-comment-spacing)
123 :options-alist
129 (:ascii-format-inlinetask-function
130 nil nil org-ascii-format-inlinetask-function)
139 (:ascii-table-keep-all-vertical-lines
140 nil nil org-ascii-table-keep-all-vertical-lines)
148 \f
149 ;;; User Configurable Variables
152 "Options for exporting Org mode files to ASCII."
157 "Maximum width of exported text.
158 This number includes margin size, as set in
159 `org-ascii-global-margin'."
166 "Width of the left margin, in number of characters."
173 "Width of the inner margin, in number of characters.
174 Inner margin is applied between each headline."
181 "Width of margin used for quoting text, in characters.
182 This margin is applied on both sides of the text."
189 "Width of margin used for plain lists, in characters.
190 This margin applies to top level list only, not to its
191 sub-lists."
198 "Width of inline tasks, in number of characters.
199 This number ignores any margin."
206 "Number of blank lines inserted around headlines.
208 This variable can be set to a cons cell. In that case, its car
209 represents the number of blank lines present before headline
210 contents whereas its cdr reflects the number of blank lines after
211 contents.
213 A nil value replicates the number of blank lines found in the
214 original Org buffer at the same place."
225 "Additional indentation width for the first line in a paragraph.
226 If the value is an integer, indent the first line of each
227 paragraph by this width, unless it is located at the beginning of
228 a section, in which case indentation is removed from that line.
229 If it is the symbol `auto' preserve indentation from original
230 document."
239 "Number of white lines between paragraphs.
240 If the value is an integer, add this number of blank lines
241 between contiguous paragraphs. If is it the symbol `auto', keep
242 the same number of blank lines as in the original document."
251 "The charset allowed to represent various elements and objects.
252 Possible values are:
253 `ascii' Only use plain ASCII characters
254 `latin1' Include Latin-1 characters
255 `utf-8' Use all UTF-8 characters"
267 "Characters for underlining headings in ASCII export.
269 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
270 and whose value is a list of characters.
272 For each supported charset, this variable associates a sequence
273 of underline characters. In a sequence, the characters will be
274 used in order for headlines level 1, 2, ... If no character is
275 available for a given level, the headline won't be underlined."
293 "Bullet characters for headlines converted to lists in ASCII export.
295 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
296 and whose value is a list of characters.
298 The first character is used for the first level considered as low
299 level, and so on. If there are more levels than characters given
300 here, the list will be repeated.
302 Note that this variable doesn't affect plain lists
303 representation."
319 "Non-nil means convert links to notes before the next headline.
320 When nil, the link will be exported in place. If the line
321 becomes long in this way, it will be wrapped."
328 "Non-nil means keep all vertical lines in ASCII tables.
329 When nil, vertical lines will be removed except for those needed
330 for column grouping."
337 "Non-nil means widen narrowed columns for export.
338 When nil, narrowed columns will look in ASCII export just like in
346 "Non-nil means table.el tables are turned into ascii-art.
348 It only makes sense when export charset is `utf-8'. It is nil by
349 default since it requires ascii-art-to-unicode.el package. You
350 can download it here:
352 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
359 "When non-nil, place caption string before the element.
360 Otherwise, place it right after it."
367 "Format string used for verbatim text and inline code."
375 "Function called to format a drawer in ASCII.
377 The function must accept three parameters:
379 CONTENTS the contents of the drawer.
380 WIDTH the text width within the drawer.
382 The function should return either the string to be exported or
383 nil to ignore the drawer.
385 The default value simply returns the value of CONTENTS."
392 'org-ascii-format-inlinetask-default
393 "Function called to format an inlinetask in ASCII.
395 The function must accept nine parameters:
396 TODO the todo keyword, as a string
397 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
398 PRIORITY the inlinetask priority, as a string
399 NAME the inlinetask name, as a string.
400 TAGS the inlinetask tags, as a list of strings.
401 CONTENTS the contents of the inlinetask, as a string.
402 WIDTH the width of the inlinetask, as a number.
403 INLINETASK the inlinetask itself.
404 INFO the info channel.
406 The function should return either the string to be exported or
407 nil to ignore the inline task."
414 \f
415 ;;; Internal Functions
417 ;; Internal functions fall into three categories.
419 ;; The first one is about text formatting. The core functions are
420 ;; `org-ascii--current-text-width' and
421 ;; `org-ascii--current-justification', which determine, respectively,
422 ;; the current text width allowed to a given element and its expected
423 ;; justification. Once this information is known,
424 ;; `org-ascii--fill-string', `org-ascii--justify-lines',
425 ;; `org-ascii--justify-element' `org-ascii--box-string' and
426 ;; `org-ascii--indent-string' can operate on a given output string.
427 ;; In particular, justification happens at the regular (i.e.,
428 ;; non-greater) element level, which means that when the exporting
429 ;; process reaches a container (e.g., a center block) content are
430 ;; already justified.
432 ;; The second category contains functions handling elements listings,
433 ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
434 ;; returns a complete table of contents, `org-ascii--list-listings'
435 ;; returns a list of referenceable src-block elements, and
436 ;; `org-ascii--list-tables' does the same for table elements.
438 ;; The third category includes general helper functions.
439 ;; `org-ascii--build-title' creates the title for a given headline
440 ;; or inlinetask element. `org-ascii--build-caption' returns the
441 ;; caption string associated to a table or a src-block.
442 ;; `org-ascii--describe-links' creates notes about links for
443 ;; insertion at the end of a section. It uses
444 ;; `org-ascii--unique-links' to get the list of links to describe.
445 ;; Eventually, `org-ascii--translate' translates a string according
446 ;; to language and charset specification.
450 "Fill a string with specified text-width and return it.
452 S is the string being filled. TEXT-WIDTH is an integer
453 specifying maximum length of a line. INFO is the plist used as
454 a communication channel.
456 Optional argument JUSTIFY can specify any type of justification
457 among `left', `center', `right' or `full'. A nil value is
458 equivalent to `left'. For a justification that doesn't also fill
459 string, see `org-ascii--justify-lines' and
460 `org-ascii--justify-block'.
462 Return nil if S isn't a string."
471 s))
476 "Justify all lines in string S.
477 TEXT-WIDTH is an integer specifying maximum length of a line.
478 HOW determines the type of justification: it can be `left',
479 `right', `full' or `center'."
484 ;; Disable `adaptive-fill-mode' so it doesn't prevent
485 ;; filling lines matching `adaptive-fill-regexp'.
493 "Justify CONTENTS of ELEMENT.
494 INFO is a plist used as a communication channel. Justification
495 is done according to the type of element. More accurately,
496 paragraphs are filled and other elements are justified as blocks,
497 that is according to the widest non blank line in CONTENTS."
503 ;; Paragraphs are treated specially as they need to be filled.
511 ;; Compute maximum width. Bail out if it is greater
512 ;; than page width, since no justification is
513 ;; possible.
523 ;; Justify every line according to TEXT-WIDTH and
524 ;; MAX-WIDTH.
535 "Indent string S by WIDTH white spaces.
536 Empty lines are not indented."
542 "Return string S with a partial box to its left.
543 INFO is a plist used as a communication channel."
548 ;; Remove last newline character.
552 "Return maximum text width for ELEMENT's contents.
553 INFO is a plist used as a communication channel."
555 ;; Elements with an absolute width: `headline' and `inlinetask'.
562 ;; Elements with a relative width: store maximum text width in
563 ;; TOTAL-WIDTH.
566 ;; Total width is determined by the presence, or not, of an
567 ;; inline task among ELEMENT parents.
572 ;; No inlinetask: Remove global margin from text width.
576 ;; Inner margin doesn't apply to text before first
577 ;; headline.
581 ;; Inner margin doesn't apply to contents of
582 ;; low level headlines, since they've got their
583 ;; own indentation mechanism.
587 ;; Each `quote-block' and `verse-block' above narrows text
588 ;; width by twice the standard margin size.
592 count parent)
594 ;; Apply list margin once per "top-level" plain-list
595 ;; containing current line
603 ;; Text width within a plain-list is restricted by
604 ;; indentation of current item. If that's the case,
605 ;; compute it with the help of `:structure' property from
606 ;; parent item, if any.
611 return parent))))
613 ;; Compute indentation offset of the current item,
614 ;; that is the sum of the difference between its
615 ;; indentation and the indentation of the top item in
616 ;; the list and current item bullet's length. Also
617 ;; remove checkbox length, and tag length (for
618 ;; description lists) or bullet length.
632 "Return expected justification for ELEMENT's contents.
633 Return value is a symbol among `left', `center', `right' and
634 `full'."
648 "Format ELEMENT title and return it.
650 ELEMENT is either an `headline' or `inlinetask' element. INFO is
651 a plist used as a communication channel. TEXT-WIDTH is an
652 integer representing the maximum length of a line.
654 When optional argument UNDERLINE is non-nil, underline title,
655 without the tags, according to `org-ascii-underline'
656 specifications.
658 If optional argument NOTAGS is non-nil, no tags will be added to
659 the title.
661 When optional argument TOC is non-nil, use optional title if
662 possible. It doesn't apply to `inlinetask' elements."
665 ;; Numbering is specific to headlines.
667 ;; All tests passed: build numbering string.
670 'number-to-string
678 info)))
695 first-part
696 ;; Align tags, if any.
702 tags))
703 ;; Maybe underline text, if ELEMENT type is `headline' and an
704 ;; underline character has been defined.
714 under-char))))))))
717 "Non-nil when ELEMENT has a caption affiliated keyword.
718 INFO is a plist used as a communication channel. This function
719 is meant to be used as a predicate for `org-export-get-ordinal'."
723 "Return caption string for ELEMENT, if applicable.
725 INFO is a plist used as a communication channel.
727 The caption string contains the sequence number of ELEMENT along
728 with its real caption. Return nil when ELEMENT has no affiliated
729 caption keyword."
732 ;; Get sequence number of current src-block among every
733 ;; src-block with a caption.
741 info)))
744 " "
749 "Return a table of contents.
751 INFO is a plist used as a communication channel.
753 Optional argument N, when non-nil, is an integer specifying the
754 depth of the table.
756 Optional argument KEYWORD specifies the TOC keyword, if any, from
757 which the table of contents generation has been initiated.
759 When optional argument LOCAL is non-nil, build a table of
760 contents according to the current headline."
787 "Return a list of listings.
789 KEYWORD is the keyword that initiated the list of listings
790 generation. INFO is a plist used as a communication channel."
801 ;; Use a counter instead of retrieving ordinal of each
802 ;; src-block.
806 ;; Store initial text so its length can be computed. This is
807 ;; used to properly align caption right to it in case of
808 ;; filling (like contents of a description list item).
814 initial-text " "
818 ;; Use short name in priority, if available.
823 initial-width)))))
827 "Return a list of tables.
829 KEYWORD is the keyword that initiated the list of tables
830 generation. INFO is a plist used as a communication channel."
841 ;; Use a counter instead of retrieving ordinal of each
842 ;; src-block.
846 ;; Store initial text so its length can be computed. This is
847 ;; used to properly align caption right to it in case of
848 ;; filling (like contents of a description list item).
854 initial-text " "
858 ;; Use short name in priority, if available.
863 initial-width)))))
867 "Return a list of unique link references in ELEMENT.
868 ELEMENT is either a headline element or a section element. INFO
869 is a plist used as a communication channel."
873 ;; Return LINK if it wasn't referenced so far, or nil.
874 ;; Update SEEN links along the way.
877 ;; Normalize description in footprints.
885 ;; Ignore LINK if it hasn't been translated already.
886 ;; It can happen if it is located in an affiliated
887 ;; keyword that was ignored.
892 ;; If at a section, find parent headline, if any, in order to
893 ;; count links that might be in the title.
897 ;; Get all links in HEADLINE.
902 "Return a string describing a list of links.
904 LINKS is a list of link type objects, as returned by
905 `org-ascii--unique-links'. WIDTH is the text width allowed for
906 the output string. INFO is a plist used as a communication
907 channel."
915 ;; Coderefs, radio links and fuzzy links are ignored.
917 ;; Id and custom-id links: Headlines refer to their numbering.
923 "[%s] %s"
924 anchor
933 ;; Do not add a link that cannot be resolved and doesn't have
934 ;; any description: destination is already visible in the
935 ;; paragraph.
937 ;; Do not add a link already handled by custom export
938 ;; functions.
943 nil)
948 width info)
953 "Return checkbox string for ITEM or nil.
954 INFO is a plist used as a communication channel."
962 \f
963 ;;; Template
966 "Return document title, as a string.
967 INFO is a plist used as a communication channel."
969 ;; Links in the title will not be resolved later, so we make
970 ;; 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.
1052 ;; Insert full links right inside the footnote definition
1053 ;; as they have no chance to be inserted later.
1066 global-margin)))
1070 ;; Distinguish between inline definitions and
1071 ;; full-fledged definitions.
1075 ;; Full-fledged definition: footnote ID is
1076 ;; inserted inside the first parsed
1077 ;; paragraph (FIRST), if any, to be sure
1078 ;; filling will take it into consideration.
1084 ;; Fill paragraph once footnote ID is inserted
1085 ;; in order to have a correct length for first
1086 ;; line.
1089 text-width info))))))
1091 global-margin))))
1094 "Return complete document string after ASCII conversion.
1095 CONTENTS is the transcoded contents string. INFO is a plist
1096 holding export options."
1099 ;; 1. Build title block.
1102 ;; 2. Table of contents.
1108 global-margin)
1109 ;; 3. Document's body.
1110 contents
1111 ;; 4. Creator. Ignore `comment' value as there are no comments in
1112 ;; ASCII. Justify it to the bottom right.
1121 global-margin))))
1124 "Translate string S according to specified language and charset.
1125 INFO is a plist used as a communication channel."
1130 \f
1131 ;;; Transcode Functions
1133 ;;;; Bold
1136 "Transcode BOLD from Org to ASCII.
1137 CONTENTS is the text with bold markup. INFO is a plist holding
1138 contextual information."
1142 ;;;; Center Block
1145 "Transcode a CENTER-BLOCK element from Org to ASCII.
1146 CONTENTS holds the contents of the block. INFO is a plist
1147 holding contextual information."
1148 ;; Center has already been taken care of at a lower level, so
1149 ;; there's nothing left to do.
1150 contents)
1153 ;;;; Clock
1156 "Transcode a CLOCK object from Org to ASCII.
1157 CONTENTS is nil. INFO is a plist holding contextual
1158 information."
1166 "%2s:%02s"
1168 clock info))
1171 ;;;; Code
1174 "Return a CODE object from Org to ASCII.
1175 CONTENTS is nil. INFO is a plist holding contextual
1176 information."
1181 ;;;; Drawer
1184 "Transcode a DRAWER element from Org to ASCII.
1185 CONTENTS holds the contents of the block. INFO is a plist
1186 holding contextual information."
1190 name contents width)))
1193 ;;;; Dynamic Block
1196 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1197 CONTENTS holds the contents of the block. INFO is a plist
1198 holding contextual information."
1199 contents)
1202 ;;;; Entity
1205 "Transcode an ENTITY object from Org to ASCII.
1206 CONTENTS are the definition itself. INFO is a plist holding
1207 contextual information."
1210 entity))
1213 ;;;; Example Block
1216 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1217 CONTENTS is nil. INFO is a plist holding contextual information."
1221 example-block info))
1224 ;;;; Export Snippet
1227 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1228 CONTENTS is nil. INFO is a plist holding contextual information."
1233 ;;;; Export Block
1236 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1237 CONTENTS is nil. INFO is a plist holding contextual information."
1243 ;;;; Fixed Width
1246 "Transcode a FIXED-WIDTH element from Org to ASCII.
1247 CONTENTS is nil. INFO is a plist holding contextual information."
1252 fixed-width info))
1255 ;;;; Footnote Definition
1257 ;; Footnote Definitions are ignored. They are compiled at the end of
1258 ;; the document, by `org-ascii-inner-template'.
1261 ;;;; Footnote Reference
1264 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1265 CONTENTS is nil. INFO is a plist holding contextual information."
1269 ;;;; Headline
1272 "Transcode a HEADLINE element from Org to ASCII.
1273 CONTENTS holds the contents of the headline. INFO is a plist
1274 holding contextual information."
1275 ;; Don't export footnote section, which will be handled at the end
1276 ;; of the template.
1280 ;; Blank lines between headline and its contents.
1281 ;; `org-ascii-headline-spacing', when set, overwrites
1282 ;; original buffer's spacing.
1288 ;; Even if HEADLINE has no section, there might be some
1289 ;; links in its title that we shouldn't forget to describe.
1296 ;; Deep subtree: export it as a list item.
1299 ;; Bullet.
1304 " "
1305 ;; Title.
1307 ;; Contents, indented by length of bullet.
1308 pre-blanks
1313 ;; Else: Standard headline.
1320 ;;;; Horizontal Rule
1323 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1324 CONTENTS is nil. INFO is a plist holding contextual
1325 information."
1332 text-width)
1337 ;;;; Inline Src Block
1340 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1341 CONTENTS holds the contents of the item. INFO is a plist holding
1342 contextual information."
1347 ;;;; Inlinetask
1351 "Format an inline task element for ASCII export.
1352 See `org-ascii-format-inlinetask-function' for a description
1353 of the parameters."
1358 ;; Top line, with an additional blank line if not in UTF-8.
1361 ;; Add title. Fill it if wider than inlinetask.
1366 ;; If CONTENTS is not empty, insert it along with
1367 ;; a separator.
1370 ;; Bottom line.
1372 ;; Flush the inlinetask to the right.
1379 "Transcode an INLINETASK element from Org to ASCII.
1380 CONTENTS holds the contents of the block. INFO is a plist
1381 holding contextual information."
1384 ;; todo.
1389 ;; todo-type
1391 ;; priority
1394 ;; title
1396 ;; tags
1399 ;; contents and width
1400 contents width inlinetask info)))
1403 ;;;; Italic
1406 "Transcode italic from Org to ASCII.
1407 CONTENTS is the text with italic markup. INFO is a plist holding
1408 contextual information."
1412 ;;;; Item
1415 "Transcode an ITEM element from Org to ASCII.
1416 CONTENTS holds the contents of the item. INFO is a plist holding
1417 contextual information."
1422 ;; First parent of ITEM is always the plain-list. Get
1423 ;; `:type' property from it.
1431 ;; Return correct number for ITEM, paying attention to
1432 ;; counters.
1438 struct
1443 ;; Change bullets into more visible form if UTF-8 is active.
1451 bullet
1453 ;; Contents: Pay attention to indentation. Note: check-boxes are
1454 ;; already taken care of at the paragraph level so they don't
1455 ;; interfere with indentation.
1462 ;;;; Keyword
1465 "Transcode a KEYWORD element from Org to ASCII.
1466 CONTENTS is nil. INFO is a plist holding contextual
1467 information."
1485 keyword info)))))
1488 ;;;; Latex Environment
1491 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1492 CONTENTS is nil. INFO is a plist holding contextual
1493 information."
1497 latex-environment info)))
1500 ;;;; Latex Fragment
1503 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1504 CONTENTS is nil. INFO is a plist holding contextual
1505 information."
1510 ;;;; Line Break
1513 "Transcode a LINE-BREAK object from Org to ASCII.
1514 CONTENTS is nil. INFO is a plist holding contextual
1518 ;;;; Link
1521 "Transcode a LINK object from Org to ASCII.
1523 DESC is the description part of the link, or the empty string.
1524 INFO is a plist holding contextual information."
1532 ;; Do not apply a special syntax on radio links. Though, use
1533 ;; transcoded target's contents as output.
1535 ;; Do not apply a special syntax on fuzzy links pointing to
1536 ;; targets.
1547 ;; Unnumbered headline.
1552 info)))))))))
1561 ;;;; Node Properties
1564 "Transcode a NODE-PROPERTY element from Org to ASCII.
1565 CONTENTS is nil. INFO is a plist holding contextual
1566 information."
1573 ;;;; Paragraph
1576 "Transcode a PARAGRAPH element from Org to ASCII.
1577 CONTENTS is the contents of the paragraph, as a string. INFO is
1578 the plist used as a communication channel."
1583 ;; Do not indent first paragraph in a section.
1589 paragraph info))
1592 ;;;; Plain List
1595 "Transcode a PLAIN-LIST element from Org to ASCII.
1596 CONTENTS is the contents of the list. INFO is a plist holding
1597 contextual information."
1601 contents
1605 ;;;; Plain Text
1608 "Transcode a TEXT string from Org to ASCII.
1609 INFO is a plist used as a communication channel."
1616 ;; Usual replacements in utf-8 with proper option set.
1624 ;;;; Planning
1627 "Transcode a PLANNING element from Org to ASCII.
1628 CONTENTS is nil. INFO is a plist used as a communication
1629 channel."
1632 #'identity
1647 planning info))
1650 ;;;; Property Drawer
1653 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1654 CONTENTS holds the contents of the drawer. INFO is a plist
1655 holding contextual information."
1660 ;;;; Quote Block
1663 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1664 CONTENTS holds the contents of the block. INFO is a plist
1665 holding contextual information."
1669 ;;;; Radio Target
1672 "Transcode a RADIO-TARGET object from Org to ASCII.
1673 CONTENTS is the contents of the target. INFO is a plist holding
1674 contextual information."
1675 contents)
1678 ;;;; Section
1681 "Transcode a SECTION element from Org to ASCII.
1682 CONTENTS is the contents of the section. INFO is a plist holding
1683 contextual information."
1686 contents
1688 ;; Add list of links at the end of SECTION.
1692 ;; Separate list of links and section contents.
1694 ;; Do not apply inner margin if parent headline is low level.
1700 ;;;; Special Block
1703 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1704 CONTENTS holds the contents of the block. INFO is a plist
1705 holding contextual information."
1706 ;; "JUSTIFYLEFT" and "JUSTFYRIGHT" have already been taken care of
1707 ;; at a lower level. There is no other special block type to
1708 ;; handle.
1709 contents)
1712 ;;;; Src Block
1715 "Transcode a SRC-BLOCK element from Org to ASCII.
1716 CONTENTS holds the contents of the item. INFO is a plist holding
1717 contextual information."
1727 src-block info))))
1730 ;;;; Statistics Cookie
1733 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1734 CONTENTS is nil. INFO is a plist holding contextual information."
1738 ;;;; Subscript
1741 "Transcode a SUBSCRIPT object from Org to ASCII.
1742 CONTENTS is the contents of the object. INFO is a plist holding
1743 contextual information."
1749 ;;;; Superscript
1752 "Transcode a SUPERSCRIPT object from Org to ASCII.
1753 CONTENTS is the contents of the object. INFO is a plist holding
1754 contextual information."
1760 ;;;; Strike-through
1763 "Transcode STRIKE-THROUGH from Org to ASCII.
1764 CONTENTS is text with strike-through markup. INFO is a plist
1765 holding contextual information."
1769 ;;;; Table
1772 "Transcode a TABLE element from Org to ASCII.
1773 CONTENTS is the contents of the table. INFO is a plist holding
1774 contextual information."
1779 ;; Possibly add a caption string above.
1781 ;; Insert table. Note: "table.el" tables are left unmodified.
1795 ;; Possible add a caption string below.
1797 table info)))
1800 ;;;; Table Cell
1803 "Return width of TABLE-CELL.
1805 INFO is a plist used as a communication channel.
1807 Width of a cell is determined either by a width cookie in the
1808 same column as the cell, or by the maximum cell's length in that
1809 column.
1811 When `org-ascii-table-widen-columns' is non-nil, width cookies
1812 are ignored."
1827 key
1839 info))
1840 max-width)))
1841 info)
1842 max-width)))
1846 cache))))
1849 "Transcode a TABLE-CELL object from Org to ASCII.
1850 CONTENTS is the cell contents. INFO is a plist used as
1851 a communication channel."
1852 ;; Determine column width. When `org-ascii-table-widen-columns'
1853 ;; is nil and some width cookie has set it, use that value.
1854 ;; Otherwise, compute the maximum width among transcoded data of
1855 ;; each cell in the column.
1857 ;; When contents are too large, truncate them.
1861 ;; Align contents correctly within the cell.
1866 contents width
1871 ;; Return cell.
1877 ;;;; Table Row
1880 "Transcode a TABLE-ROW element from Org to ASCII.
1881 CONTENTS is the row contents. INFO is a plist used as
1882 a communication channel."
1889 'concat
1895 ;; In order to know if CELL starts the row, do
1896 ;; not compare it with the first cell in the
1897 ;; row as there might be a special column.
1898 ;; Instead, compare it with first exportable
1899 ;; cell, obtained with `org-element-map'.
1903 cell))
1904 lcorner)
1909 rcorner)
1915 info)))
1930 ;;;; Timestamp
1933 "Transcode a TIMESTAMP object from Org to ASCII.
1934 CONTENTS is nil. INFO is a plist holding contextual information."
1938 ;;;; Underline
1941 "Transcode UNDERLINE from Org to ASCII.
1942 CONTENTS is the text with underline markup. INFO is a plist
1943 holding contextual information."
1947 ;;;; Verbatim
1950 "Return a VERBATIM object from Org to ASCII.
1951 CONTENTS is nil. INFO is a plist holding contextual information."
1956 ;;;; Verse Block
1959 "Transcode a VERSE-BLOCK element from Org to ASCII.
1960 CONTENTS is verse block contents. INFO is a plist holding
1961 contextual information."
1968 \f
1969 ;;; Filters
1972 "Filter controlling number of blank lines after a headline.
1974 HEADLINE is a string representing a transcoded headline.
1975 BACK-END is symbol specifying back-end used for export. INFO is
1976 plist containing the communication channel.
1978 This function only applies to `ascii' back-end. See
1979 `org-ascii-headline-spacing' for information."
1986 "Filter controlling number of blank lines between paragraphs.
1988 TREE is the parse tree. BACK-END is the symbol specifying
1989 back-end used for export. INFO is a plist used as
1990 a communication channel.
1992 See `org-ascii-paragraph-spacing' for information."
2000 tree)
2003 "Filter removing blank lines between comments.
2004 TREE is the parse tree. BACK-END is the symbol specifying
2005 back-end used for export. INFO is a plist used as
2006 a communication channel."
2012 tree)
2015 \f
2016 ;;; End-user functions
2018 ;;;###autoload
2021 "Export current buffer to a text buffer.
2023 If narrowing is active in the current buffer, only export its
2024 narrowed part.
2026 If a region is active, export that region.
2028 A non-nil optional argument ASYNC means the process should happen
2029 asynchronously. The resulting buffer should be accessible
2030 through the `org-export-stack' interface.
2032 When optional argument SUBTREEP is non-nil, export the sub-tree
2033 at point, extracting information from the headline properties
2034 first.
2036 When optional argument VISIBLE-ONLY is non-nil, don't export
2037 contents of hidden elements.
2039 When optional argument BODY-ONLY is non-nil, strip title and
2040 table of contents from output.
2042 EXT-PLIST, when provided, is a property list with external
2043 parameters overriding Org default settings, but still inferior to
2044 file-local settings.
2047 will be displayed when `org-export-show-temporary-export-buffer'
2048 is non-nil."
2053 ;;;###autoload
2056 "Export current buffer to a text file.
2058 If narrowing is active in the current buffer, only export its
2059 narrowed part.
2061 If a region is active, export that region.
2063 A non-nil optional argument ASYNC means the process should happen
2064 asynchronously. The resulting file should be accessible through
2065 the `org-export-stack' interface.
2067 When optional argument SUBTREEP is non-nil, export the sub-tree
2068 at point, extracting information from the headline properties
2069 first.
2071 When optional argument VISIBLE-ONLY is non-nil, don't export
2072 contents of hidden elements.
2074 When optional argument BODY-ONLY is non-nil, strip title and
2075 table of contents from output.
2077 EXT-PLIST, when provided, is a property list with external
2078 parameters overriding Org default settings, but still inferior to
2079 file-local settings.
2081 Return output file's name."
2085 async subtreep visible-only body-only ext-plist)))
2087 ;;;###autoload
2089 "Publish an Org file to ASCII.
2091 FILENAME is the filename of the Org file to be published. PLIST
2092 is the property list for the given project. PUB-DIR is the
2093 publishing directory.
2095 Return output file name."
2099 ;;;###autoload
2101 "Publish an Org file to Latin-1.
2103 FILENAME is the filename of the Org file to be published. PLIST
2104 is the property list for the given project. PUB-DIR is the
2105 publishing directory.
2107 Return output file name."
2111 ;;;###autoload
2113 "Publish an org file to UTF-8.
2115 FILENAME is the filename of the Org file to be published. PLIST
2116 is the property list for the given project. PUB-DIR is the
2117 publishing directory.
2119 Return output file name."
2126 ;; Local variables:
2127 ;; generated-autoload-file: "org-loaddefs.el"
2128 ;; coding: utf-8-emacs
2129 ;; End:
2131 ;;; ox-ascii.el ends here