| blob | 968f297cee0878bbc9f9afe8ca9ca7210eff6b0f |
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)
126 \f
127 ;;; User Configurable Variables
130 "Options for exporting Org mode files to ASCII."
135 "Maximum width of exported text.
136 This number includes margin size, as set in
137 `org-ascii-global-margin'."
144 "Width of the left margin, in number of characters."
151 "Width of the inner margin, in number of characters.
152 Inner margin is applied between each headline."
159 "Width of margin used for quoting text, in characters.
160 This margin is applied on both sides of the text."
167 "Width of inline tasks, in number of characters.
168 This number ignores any margin."
175 "Number of blank lines inserted around headlines.
177 This variable can be set to a cons cell. In that case, its car
178 represents the number of blank lines present before headline
179 contents whereas its cdr reflects the number of blank lines after
180 contents.
182 A nil value replicates the number of blank lines found in the
183 original Org buffer at the same place."
194 "Additional indentation width for the first line in a paragraph.
195 If the value is an integer, indent the first line of each
196 paragraph by this number. If it is the symbol `auto' preserve
197 indentation from original document."
206 "Number of white lines between paragraphs.
207 If the value is an integer, add this number of blank lines
208 between contiguous paragraphs. If is it the symbol `auto', keep
209 the same number of blank lines as in the original document."
218 "The charset allowed to represent various elements and objects.
219 Possible values are:
220 `ascii' Only use plain ASCII characters
221 `latin1' Include Latin-1 characters
222 `utf-8' Use all UTF-8 characters"
234 "Characters for underlining headings in ASCII export.
236 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
237 and whose value is a list of characters.
239 For each supported charset, this variable associates a sequence
240 of underline characters. In a sequence, the characters will be
241 used in order for headlines level 1, 2, ... If no character is
242 available for a given level, the headline won't be underlined."
260 "Bullet characters for headlines converted to lists in ASCII export.
262 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
263 and whose value is a list of characters.
265 The first character is used for the first level considered as low
266 level, and so on. If there are more levels than characters given
267 here, the list will be repeated.
269 Note that this variable doesn't affect plain lists
270 representation."
286 "Non-nil means convert links to notes before the next headline.
287 When nil, the link will be exported in place. If the line
288 becomes long in this way, it will be wrapped."
295 "Non-nil means keep all vertical lines in ASCII tables.
296 When nil, vertical lines will be removed except for those needed
297 for column grouping."
304 "Non-nil means widen narrowed columns for export.
305 When nil, narrowed columns will look in ASCII export just like in
313 "Non-nil means table.el tables are turned into ascii-art.
315 It only makes sense when export charset is `utf-8'. It is nil by
316 default since it requires ascii-art-to-unicode.el package. You
317 can download it here:
319 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
326 "When non-nil, place caption string before the element.
327 Otherwise, place it right after it."
334 "Format string used for verbatim text and inline code."
342 "Function called to format a drawer in ASCII.
344 The function must accept three parameters:
346 CONTENTS the contents of the drawer.
347 WIDTH the text width within the drawer.
349 The function should return either the string to be exported or
350 nil to ignore the drawer.
352 The default value simply returns the value of CONTENTS."
359 'org-ascii-format-inlinetask-default
360 "Function called to format an inlinetask in ASCII.
362 The function must accept nine parameters:
363 TODO the todo keyword, as a string
364 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
365 PRIORITY the inlinetask priority, as a string
366 NAME the inlinetask name, as a string.
367 TAGS the inlinetask tags, as a list of strings.
368 CONTENTS the contents of the inlinetask, as a string.
369 WIDTH the width of the inlinetask, as a number.
370 INLINETASK the inlinetask itself.
371 INFO the info channel.
373 The function should return either the string to be exported or
374 nil to ignore the inline task."
381 \f
382 ;;; Internal Functions
384 ;; Internal functions fall into three categories.
386 ;; The first one is about text formatting. The core function is
387 ;; `org-ascii--current-text-width', which determines the current
388 ;; text width allowed to a given element. In other words, it helps
389 ;; keeping each line width within maximum text width defined in
390 ;; `org-ascii-text-width'. Once this information is known,
391 ;; `org-ascii--fill-string', `org-ascii--justify-string',
392 ;; `org-ascii--box-string' and `org-ascii--indent-string' can
393 ;; operate on a given output string.
395 ;; The second category contains functions handling elements listings,
396 ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
397 ;; returns a complete table of contents, `org-ascii--list-listings'
398 ;; returns a list of referenceable src-block elements, and
399 ;; `org-ascii--list-tables' does the same for table elements.
401 ;; The third category includes general helper functions.
402 ;; `org-ascii--build-title' creates the title for a given headline
403 ;; or inlinetask element. `org-ascii--build-caption' returns the
404 ;; caption string associated to a table or a src-block.
405 ;; `org-ascii--describe-links' creates notes about links for
406 ;; insertion at the end of a section. It uses
407 ;; `org-ascii--unique-links' to get the list of links to describe.
408 ;; Eventually, `org-ascii--translate' translates a string according
409 ;; to language and charset specification.
413 "Fill a string with specified text-width and return it.
415 S is the string being filled. TEXT-WIDTH is an integer
416 specifying maximum length of a line. INFO is the plist used as
417 a communication channel.
419 Optional argument JUSTIFY can specify any type of justification
420 among `left', `center', `right' or `full'. A nil value is
421 equivalent to `left'. For a justification that doesn't also fill
422 string, see `org-ascii--justify-string'.
424 Return nil if S isn't a string."
425 ;; Don't fill paragraph when break should be preserved.
438 "Justify string S.
439 TEXT-WIDTH is an integer specifying maximum length of a line.
440 HOW determines the type of justification: it can be `left',
441 `right', `full' or `center'."
446 ;; Disable `adaptive-fill-mode' so it doesn't prevent
447 ;; filling lines matching `adaptive-fill-regexp'.
455 "Indent string S by WIDTH white spaces.
456 Empty lines are not indented."
462 "Return string S with a partial box to its left.
463 INFO is a plist used as a communication channel."
468 ;; Remove last newline character.
472 "Return maximum text width for ELEMENT's contents.
473 INFO is a plist used as a communication channel."
475 ;; Elements with an absolute width: `headline' and `inlinetask'.
477 ('headline
481 ;; Elements with a relative width: store maximum text width in
482 ;; TOTAL-WIDTH.
485 ;; Total width is determined by the presence, or not, of an
486 ;; inline task among ELEMENT parents.
490 org-ascii-inlinetask-width
491 ;; No inlinetask: Remove global margin from text width.
493 org-ascii-global-margin
495 ;; Inner margin doesn't apply to text before first
496 ;; headline.
500 ;; Inner margin doesn't apply to contents of
501 ;; low level headlines, since they've got their
502 ;; own indentation mechanism.
504 org-ascii-inner-margin))))))))
506 ;; Each `quote-block' and `verse-block' above narrows text
507 ;; width by twice the standard margin size.
511 count parent)
513 ;; Text width within a plain-list is restricted by
514 ;; indentation of current item. If that's the case,
515 ;; compute it with the help of `:structure' property from
516 ;; parent item, if any.
521 return parent))))
523 ;; Compute indentation offset of the current item,
524 ;; that is the sum of the difference between its
525 ;; indentation and the indentation of the top item in
526 ;; the list and current item bullet's length. Also
527 ;; remove checkbox length, and tag length (for
528 ;; description lists) or bullet length.
542 "Format ELEMENT title and return it.
544 ELEMENT is either an `headline' or `inlinetask' element. INFO is
545 a plist used as a communication channel. TEXT-WIDTH is an
546 integer representing the maximum length of a line.
548 When optional argument UNDERLINE is non-nil, underline title,
549 without the tags, according to `org-ascii-underline'
550 specifications.
552 If optional argument NOTAGS is non-nil, no tags will be added to
553 the title.
555 When optional argument TOC is non-nil, use optional title if
556 possible. It doesn't apply to `inlinetask' elements."
559 ;; Numbering is specific to headlines.
561 ;; All tests passed: build numbering string.
564 'number-to-string
572 info)))
589 first-part
590 ;; Align tags, if any.
596 tags))
597 ;; Maybe underline text, if ELEMENT type is `headline' and an
598 ;; underline character has been defined.
603 org-ascii-underline)))))
608 under-char))))))))
611 "Non-nil when ELEMENT has a caption affiliated keyword.
612 INFO is a plist used as a communication channel. This function
613 is meant to be used as a predicate for `org-export-get-ordinal'."
617 "Return caption string for ELEMENT, if applicable.
619 INFO is a plist used as a communication channel.
621 The caption string contains the sequence number of ELEMENT along
622 with its real caption. Return nil when ELEMENT has no affiliated
623 caption keyword."
626 ;; Get sequence number of current src-block among every
627 ;; src-block with a caption.
635 info)))
638 " "
643 "Return a table of contents.
645 INFO is a plist used as a communication channel.
647 Optional argument N, when non-nil, is an integer specifying the
648 depth of the table.
650 Optional argument KEYWORD specifies the TOC keyword, if any, from
651 which the table of contents generation has been initiated."
675 "Return a list of listings.
677 KEYWORD is the keyword that initiated the list of listings
678 generation. INFO is a plist used as a communication channel."
688 ;; Use a counter instead of retrieving ordinal of each
689 ;; src-block.
693 ;; Store initial text so its length can be computed. This is
694 ;; used to properly align caption right to it in case of
695 ;; filling (like contents of a description list item).
701 initial-text " "
705 ;; Use short name in priority, if available.
710 initial-width)))))
714 "Return a list of tables.
716 KEYWORD is the keyword that initiated the list of tables
717 generation. INFO is a plist used as a communication channel."
727 ;; Use a counter instead of retrieving ordinal of each
728 ;; src-block.
732 ;; Store initial text so its length can be computed. This is
733 ;; used to properly align caption right to it in case of
734 ;; filling (like contents of a description list item).
740 initial-text " "
744 ;; Use short name in priority, if available.
749 initial-width)))))
753 "Return a list of unique link references in ELEMENT.
754 ELEMENT is either a headline element or a section element. INFO
755 is a plist used as a communication channel."
759 ;; Return LINK if it wasn't referenced so far, or nil.
760 ;; Update SEEN links along the way.
763 ;; Normalize description in footprints.
771 ;; Ignore LINK if it hasn't been translated already.
772 ;; It can happen if it is located in an affiliated
773 ;; keyword that was ignored.
778 ;; If at a section, find parent headline, if any, in order to
779 ;; count links that might be in the title.
783 ;; Get all links in HEADLINE.
788 "Return a string describing a list of links.
790 LINKS is a list of link type objects, as returned by
791 `org-ascii--unique-links'. WIDTH is the text width allowed for
792 the output string. INFO is a plist used as a communication
793 channel."
801 ;; Coderefs, radio links and fuzzy links are ignored.
803 ;; Id and custom-id links: Headlines refer to their numbering.
809 "[%s] %s"
810 anchor
817 ;; Do not add a link that cannot be resolved and doesn't have
818 ;; any description: destination is already visible in the
819 ;; paragraph.
825 width info)
830 "Return checkbox string for ITEM or nil.
831 INFO is a plist used as a communication channel."
839 \f
840 ;;; Template
843 "Return document title, as a string.
844 INFO is a plist used as a communication channel."
846 ;; Links in the title will not be resolved later, so we make
847 ;; sure their path is located right after them.
857 ;; There are two types of title blocks depending on the presence
858 ;; of a title to display.
860 ;; Title block without a title. DATE is positioned at the top
861 ;; right of the document, AUTHOR to the top left and EMAIL
862 ;; just below.
866 author
868 ?\s)
869 date
874 email
876 ?\s)
886 ;; Title block with a title. Document's TITLE, along with the
887 ;; AUTHOR and its EMAIL are both overlined and an underlined,
888 ;; centered. Date is just below, also centered.
890 ;; Format TITLE. It may be filled if it is too wide,
891 ;; that is wider than the two thirds of the total width.
917 "Return complete document string after ASCII conversion.
918 CONTENTS is the transcoded contents string. INFO is a plist
919 holding export options."
923 ;; 1. Document's body.
924 contents
925 ;; 2. Footnote definitions.
928 ;; Insert full links right inside the footnote definition
929 ;; as they have no chance to be inserted later.
945 ;; Distinguish between inline definitions and
946 ;; full-fledged definitions.
950 ;; Full-fledged definition: footnote ID is
951 ;; inserted inside the first parsed paragraph
952 ;; (FIRST), if any, to be sure filling will
953 ;; take it into consideration.
959 ;; Fill paragraph once footnote ID is inserted
960 ;; in order to have a correct length for first
961 ;; line.
964 text-width info))))))
966 org-ascii-global-margin)))
969 "Return complete document string after ASCII conversion.
970 CONTENTS is the transcoded contents string. INFO is a plist
971 holding export options."
973 ;; 1. Build title block.
976 ;; 2. Table of contents.
982 org-ascii-global-margin)
983 ;; 3. Document's body.
984 contents
985 ;; 4. Creator. Ignore `comment' value as there are no comments in
986 ;; ASCII. Justify it to the bottom right.
995 org-ascii-global-margin)))
998 "Translate string S according to specified language and charset.
999 INFO is a plist used as a communication channel."
1004 \f
1005 ;;; Transcode Functions
1007 ;;;; Bold
1010 "Transcode BOLD from Org to ASCII.
1011 CONTENTS is the text with bold markup. INFO is a plist holding
1012 contextual information."
1016 ;;;; Center Block
1019 "Transcode a CENTER-BLOCK element from Org to ASCII.
1020 CONTENTS holds the contents of the block. INFO is a plist
1021 holding contextual information."
1026 ;;;; Clock
1029 "Transcode a CLOCK object from Org to ASCII.
1030 CONTENTS is nil. INFO is a plist holding contextual
1031 information."
1040 "%2s:%02s"
1044 ;;;; Code
1047 "Return a CODE object from Org to ASCII.
1048 CONTENTS is nil. INFO is a plist holding contextual
1049 information."
1053 ;;;; Drawer
1056 "Transcode a DRAWER element from Org to ASCII.
1057 CONTENTS holds the contents of the block. INFO is a plist
1058 holding contextual information."
1064 ;;;; Dynamic Block
1067 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1068 CONTENTS holds the contents of the block. INFO is a plist
1069 holding contextual information."
1070 contents)
1073 ;;;; Entity
1076 "Transcode an ENTITY object from Org to ASCII.
1077 CONTENTS are the definition itself. INFO is a plist holding
1078 contextual information."
1081 entity))
1084 ;;;; Example Block
1087 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1088 CONTENTS is nil. INFO is a plist holding contextual information."
1093 ;;;; Export Snippet
1096 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1097 CONTENTS is nil. INFO is a plist holding contextual information."
1102 ;;;; Export Block
1105 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1106 CONTENTS is nil. INFO is a plist holding contextual information."
1111 ;;;; Fixed Width
1114 "Transcode a FIXED-WIDTH element from Org to ASCII.
1115 CONTENTS is nil. INFO is a plist holding contextual information."
1121 ;;;; Footnote Definition
1123 ;; Footnote Definitions are ignored. They are compiled at the end of
1124 ;; the document, by `org-ascii-inner-template'.
1127 ;;;; Footnote Reference
1130 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1131 CONTENTS is nil. INFO is a plist holding contextual information."
1135 ;;;; Headline
1138 "Transcode a HEADLINE element from Org to ASCII.
1139 CONTENTS holds the contents of the headline. INFO is a plist
1140 holding contextual information."
1141 ;; Don't export footnote section, which will be handled at the end
1142 ;; of the template.
1146 ;; Blank lines between headline and its contents.
1147 ;; `org-ascii-headline-spacing', when set, overwrites
1148 ;; original buffer's spacing.
1153 ;; Even if HEADLINE has no section, there might be some
1154 ;; links in its title that we shouldn't forget to describe.
1161 ;; Deep subtree: export it as a list item.
1164 ;; Bullet.
1166 org-ascii-bullets))))
1169 " "
1170 ;; Title.
1172 ;; Contents, indented by length of bullet.
1173 pre-blanks
1178 ;; Else: Standard headline.
1185 ;;;; Horizontal Rule
1188 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1189 CONTENTS is nil. INFO is a plist holding contextual
1190 information."
1197 text-width)
1202 ;;;; Inline Src Block
1205 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1206 CONTENTS holds the contents of the item. INFO is a plist holding
1207 contextual information."
1212 ;;;; Inlinetask
1216 "Format an inline task element for ASCII export.
1217 See `org-ascii-format-inlinetask-function' for a description
1218 of the parameters."
1223 ;; Top line, with an additional blank line if not in UTF-8.
1226 ;; Add title. Fill it if wider than inlinetask.
1231 ;; If CONTENTS is not empty, insert it along with
1232 ;; a separator.
1235 ;; Bottom line.
1237 ;; Flush the inlinetask to the right.
1240 org-ascii-inner-margin)
1244 "Transcode an INLINETASK element from Org to ASCII.
1245 CONTENTS holds the contents of the block. INFO is a plist
1246 holding contextual information."
1249 ;; todo.
1254 ;; todo-type
1256 ;; priority
1259 ;; title
1261 ;; tags
1264 ;; contents and width
1265 contents width inlinetask info)))
1268 ;;;; Italic
1271 "Transcode italic from Org to ASCII.
1272 CONTENTS is the text with italic markup. INFO is a plist holding
1273 contextual information."
1277 ;;;; Item
1280 "Transcode an ITEM element from Org to ASCII.
1281 CONTENTS holds the contents of the item. INFO is a plist holding
1282 contextual information."
1287 ;; First parent of ITEM is always the plain-list. Get
1288 ;; `:type' property from it.
1296 ;; Return correct number for ITEM, paying attention to
1297 ;; counters.
1303 struct
1308 ;; Change bullets into more visible form if UTF-8 is active.
1316 bullet
1318 ;; Contents: Pay attention to indentation. Note: check-boxes are
1319 ;; already taken care of at the paragraph level so they don't
1320 ;; interfere with indentation.
1327 ;;;; Keyword
1330 "Transcode a KEYWORD element from Org to ASCII.
1331 CONTENTS is nil. INFO is a plist holding contextual
1332 information."
1352 ;;;; Latex Environment
1355 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1356 CONTENTS is nil. INFO is a plist holding contextual
1357 information."
1362 ;;;; Latex Fragment
1365 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1366 CONTENTS is nil. INFO is a plist holding contextual
1367 information."
1372 ;;;; Line Break
1375 "Transcode a LINE-BREAK object from Org to ASCII.
1376 CONTENTS is nil. INFO is a plist holding contextual
1380 ;;;; Link
1383 "Transcode a LINK object from Org to ASCII.
1385 DESC is the description part of the link, or the empty string.
1386 INFO is a plist holding contextual information."
1394 ;; Do not apply a special syntax on radio links. Though, use
1395 ;; transcoded target's contents as output.
1397 ;; Do not apply a special syntax on fuzzy links pointing to
1398 ;; targets.
1416 ;;;; Node Properties
1419 "Transcode a NODE-PROPERTY element from Org to ASCII.
1420 CONTENTS is nil. INFO is a plist holding contextual
1421 information."
1428 ;;;; Paragraph
1431 "Transcode a PARAGRAPH element from Org to ASCII.
1432 CONTENTS is the contents of the paragraph, as a string. INFO is
1433 the plist used as a communication channel."
1442 ;;;; Plain List
1445 "Transcode a PLAIN-LIST element from Org to ASCII.
1446 CONTENTS is the contents of the list. INFO is a plist holding
1447 contextual information."
1448 contents)
1451 ;;;; Plain Text
1454 "Transcode a TEXT string from Org to ASCII.
1455 INFO is a plist used as a communication channel."
1462 ;; Usual replacements in utf-8 with proper option set.
1470 ;;;; Planning
1473 "Transcode a PLANNING element from Org to ASCII.
1474 CONTENTS is nil. INFO is a plist used as a communication
1475 channel."
1477 'identity
1497 ;;;; Property Drawer
1500 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1501 CONTENTS holds the contents of the drawer. INFO is a plist
1502 holding contextual information."
1506 ;;;; Quote Block
1509 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1510 CONTENTS holds the contents of the block. INFO is a plist
1511 holding contextual information."
1515 ;;;; Radio Target
1518 "Transcode a RADIO-TARGET object from Org to ASCII.
1519 CONTENTS is the contents of the target. INFO is a plist holding
1520 contextual information."
1521 contents)
1524 ;;;; Section
1527 "Transcode a SECTION element from Org to ASCII.
1528 CONTENTS is the contents of the section. INFO is a plist holding
1529 contextual information."
1532 contents
1534 ;; Add list of links at the end of SECTION.
1538 ;; Separate list of links and section contents.
1540 ;; Do not apply inner margin if parent headline is low level.
1543 org-ascii-inner-margin))))
1546 ;;;; Special Block
1549 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1550 CONTENTS holds the contents of the block. INFO is a plist
1551 holding contextual information."
1552 contents)
1555 ;;;; Src Block
1558 "Transcode a SRC-BLOCK element from Org to ASCII.
1559 CONTENTS holds the contents of the item. INFO is a plist holding
1560 contextual information."
1571 ;;;; Statistics Cookie
1574 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1575 CONTENTS is nil. INFO is a plist holding contextual information."
1579 ;;;; Subscript
1582 "Transcode a SUBSCRIPT object from Org to ASCII.
1583 CONTENTS is the contents of the object. INFO is a plist holding
1584 contextual information."
1590 ;;;; Superscript
1593 "Transcode a SUPERSCRIPT object from Org to ASCII.
1594 CONTENTS is the contents of the object. INFO is a plist holding
1595 contextual information."
1601 ;;;; Strike-through
1604 "Transcode STRIKE-THROUGH from Org to ASCII.
1605 CONTENTS is text with strike-through markup. INFO is a plist
1606 holding contextual information."
1610 ;;;; Table
1613 "Transcode a TABLE element from Org to ASCII.
1614 CONTENTS is the contents of the table. INFO is a plist holding
1615 contextual information."
1618 ;; Possibly add a caption string above.
1620 ;; Insert table. Note: "table.el" tables are left unmodified.
1634 ;; Possible add a caption string below.
1638 ;;;; Table Cell
1641 "Return width of TABLE-CELL.
1643 INFO is a plist used as a communication channel.
1645 Width of a cell is determined either by a width cookie in the
1646 same column as the cell, or by the maximum cell's length in that
1647 column.
1649 When `org-ascii-table-widen-columns' is non-nil, width cookies
1650 are ignored."
1664 key
1675 info))
1676 max-width)))
1677 info)
1678 max-width))
1679 cache))))
1682 "Transcode a TABLE-CELL object from Org to ASCII.
1683 CONTENTS is the cell contents. INFO is a plist used as
1684 a communication channel."
1685 ;; Determine column width. When `org-ascii-table-widen-columns'
1686 ;; is nil and some width cookie has set it, use that value.
1687 ;; Otherwise, compute the maximum width among transcoded data of
1688 ;; each cell in the column.
1690 ;; When contents are too large, truncate them.
1694 ;; Align contents correctly within the cell.
1699 contents width
1704 ;; Return cell.
1710 ;;;; Table Row
1713 "Transcode a TABLE-ROW element from Org to ASCII.
1714 CONTENTS is the row contents. INFO is a plist used as
1715 a communication channel."
1722 'concat
1728 ;; In order to know if CELL starts the row, do
1729 ;; not compare it with the first cell in the
1730 ;; row as there might be a special column.
1731 ;; Instead, compare it with first exportable
1732 ;; cell, obtained with `org-element-map'.
1736 cell))
1737 lcorner)
1742 rcorner)
1748 info)))
1763 ;;;; Timestamp
1766 "Transcode a TIMESTAMP object from Org to ASCII.
1767 CONTENTS is nil. INFO is a plist holding contextual information."
1771 ;;;; Underline
1774 "Transcode UNDERLINE from Org to ASCII.
1775 CONTENTS is the text with underline markup. INFO is a plist
1776 holding contextual information."
1780 ;;;; Verbatim
1783 "Return a VERBATIM object from Org to ASCII.
1784 CONTENTS is nil. INFO is a plist holding contextual information."
1789 ;;;; Verse Block
1792 "Transcode a VERSE-BLOCK element from Org to ASCII.
1793 CONTENTS is verse block contents. INFO is a plist holding
1794 contextual information."
1798 org-ascii-quote-margin)))
1801 \f
1802 ;;; Filters
1805 "Filter controlling number of blank lines after a headline.
1807 HEADLINE is a string representing a transcoded headline.
1808 BACK-END is symbol specifying back-end used for export. INFO is
1809 plist containing the communication channel.
1811 This function only applies to `ascii' back-end. See
1812 `org-ascii-headline-spacing' for information."
1818 "Filter controlling number of blank lines between paragraphs.
1820 TREE is the parse tree. BACK-END is the symbol specifying
1821 back-end used for export. INFO is a plist used as
1822 a communication channel.
1824 See `org-ascii-paragraph-spacing' for information."
1832 tree)
1835 "Filter removing blank lines between comments.
1836 TREE is the parse tree. BACK-END is the symbol specifying
1837 back-end used for export. INFO is a plist used as
1838 a communication channel."
1844 tree)
1847 \f
1848 ;;; End-user functions
1850 ;;;###autoload
1853 "Export current buffer to a text buffer.
1855 If narrowing is active in the current buffer, only export its
1856 narrowed part.
1858 If a region is active, export that region.
1860 A non-nil optional argument ASYNC means the process should happen
1861 asynchronously. The resulting buffer should be accessible
1862 through the `org-export-stack' interface.
1864 When optional argument SUBTREEP is non-nil, export the sub-tree
1865 at point, extracting information from the headline properties
1866 first.
1868 When optional argument VISIBLE-ONLY is non-nil, don't export
1869 contents of hidden elements.
1871 When optional argument BODY-ONLY is non-nil, strip title and
1872 table of contents from output.
1874 EXT-PLIST, when provided, is a property list with external
1875 parameters overriding Org default settings, but still inferior to
1876 file-local settings.
1879 will be displayed when `org-export-show-temporary-export-buffer'
1880 is non-nil."
1885 ;;;###autoload
1888 "Export current buffer to a text file.
1890 If narrowing is active in the current buffer, only export its
1891 narrowed part.
1893 If a region is active, export that region.
1895 A non-nil optional argument ASYNC means the process should happen
1896 asynchronously. The resulting file should be accessible through
1897 the `org-export-stack' interface.
1899 When optional argument SUBTREEP is non-nil, export the sub-tree
1900 at point, extracting information from the headline properties
1901 first.
1903 When optional argument VISIBLE-ONLY is non-nil, don't export
1904 contents of hidden elements.
1906 When optional argument BODY-ONLY is non-nil, strip title and
1907 table of contents from output.
1909 EXT-PLIST, when provided, is a property list with external
1910 parameters overriding Org default settings, but still inferior to
1911 file-local settings.
1913 Return output file's name."
1917 async subtreep visible-only body-only ext-plist)))
1919 ;;;###autoload
1921 "Publish an Org file to ASCII.
1923 FILENAME is the filename of the Org file to be published. PLIST
1924 is the property list for the given project. PUB-DIR is the
1925 publishing directory.
1927 Return output file name."
1931 ;;;###autoload
1933 "Publish an Org file to Latin-1.
1935 FILENAME is the filename of the Org file to be published. PLIST
1936 is the property list for the given project. PUB-DIR is the
1937 publishing directory.
1939 Return output file name."
1943 ;;;###autoload
1945 "Publish an org file to UTF-8.
1947 FILENAME is the filename of the Org file to be published. PLIST
1948 is the property list for the given project. PUB-DIR is the
1949 publishing directory.
1951 Return output file name."
1958 ;; Local variables:
1959 ;; generated-autoload-file: "org-loaddefs.el"
1960 ;; coding: utf-8-emacs
1961 ;; End:
1963 ;;; ox-ascii.el ends here