| blob | e8f1b1f417347dfa1ef3d8c96ad79809f65b9f11 |
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.
98 :menu-entry
119 (:filter-parse-tree org-ascii-filter-paragraph-spacing
120 org-ascii-filter-comment-spacing)
125 \f
126 ;;; User Configurable Variables
129 "Options for exporting Org mode files to ASCII."
134 "Maximum width of exported text.
135 This number includes margin size, as set in
136 `org-ascii-global-margin'."
143 "Width of the left margin, in number of characters."
150 "Width of the inner margin, in number of characters.
151 Inner margin is applied between each headline."
158 "Width of margin used for quoting text, in characters.
159 This margin is applied on both sides of the text."
166 "Width of inline tasks, in number of characters.
167 This number ignores any margin."
174 "Number of blank lines inserted around headlines.
176 This variable can be set to a cons cell. In that case, its car
177 represents the number of blank lines present before headline
178 contents whereas its cdr reflects the number of blank lines after
179 contents.
181 A nil value replicates the number of blank lines found in the
182 original Org buffer at the same place."
193 "Additional indentation width for the first line in a paragraph.
194 If the value is an integer, indent the first line of each
195 paragraph by this number. If it is the symbol `auto' preserve
196 indentation from original document."
205 "Number of white lines between paragraphs.
206 If the value is an integer, add this number of blank lines
207 between contiguous paragraphs. If is it the symbol `auto', keep
208 the same number of blank lines as in the original document."
217 "The charset allowed to represent various elements and objects.
218 Possible values are:
219 `ascii' Only use plain ASCII characters
220 `latin1' Include Latin-1 characters
221 `utf-8' Use all UTF-8 characters"
233 "Characters for underlining headings in ASCII export.
235 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
236 and whose value is a list of characters.
238 For each supported charset, this variable associates a sequence
239 of underline characters. In a sequence, the characters will be
240 used in order for headlines level 1, 2, ... If no character is
241 available for a given level, the headline won't be underlined."
259 "Bullet characters for headlines converted to lists in ASCII export.
261 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
262 and whose value is a list of characters.
264 The first character is used for the first level considered as low
265 level, and so on. If there are more levels than characters given
266 here, the list will be repeated.
268 Note that this variable doesn't affect plain lists
269 representation."
285 "Non-nil means convert links to notes before the next headline.
286 When nil, the link will be exported in place. If the line
287 becomes long in this way, it will be wrapped."
294 "Non-nil means keep all vertical lines in ASCII tables.
295 When nil, vertical lines will be removed except for those needed
296 for column grouping."
303 "Non-nil means widen narrowed columns for export.
304 When nil, narrowed columns will look in ASCII export just like in
312 "Non-nil means table.el tables are turned into ascii-art.
314 It only makes sense when export charset is `utf-8'. It is nil by
315 default since it requires ascii-art-to-unicode.el package. You
316 can download it here:
318 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
325 "When non-nil, place caption string before the element.
326 Otherwise, place it right after it."
333 "Format string used for verbatim text and inline code."
341 "Function called to format a drawer in ASCII.
343 The function must accept three parameters:
345 CONTENTS the contents of the drawer.
346 WIDTH the text width within the drawer.
348 The function should return either the string to be exported or
349 nil to ignore the drawer.
351 The default value simply returns the value of CONTENTS."
358 'org-ascii-format-inlinetask-default
359 "Function called to format an inlinetask in ASCII.
361 The function must accept nine parameters:
362 TODO the todo keyword, as a string
363 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
364 PRIORITY the inlinetask priority, as a string
365 NAME the inlinetask name, as a string.
366 TAGS the inlinetask tags, as a list of strings.
367 CONTENTS the contents of the inlinetask, as a string.
368 WIDTH the width of the inlinetask, as a number.
369 INLINETASK the inlinetask itself.
370 INFO the info channel.
372 The function should return either the string to be exported or
373 nil to ignore the inline task."
380 \f
381 ;;; Internal Functions
383 ;; Internal functions fall into three categories.
385 ;; The first one is about text formatting. The core function is
386 ;; `org-ascii--current-text-width', which determines the current
387 ;; text width allowed to a given element. In other words, it helps
388 ;; keeping each line width within maximum text width defined in
389 ;; `org-ascii-text-width'. Once this information is known,
390 ;; `org-ascii--fill-string', `org-ascii--justify-string',
391 ;; `org-ascii--box-string' and `org-ascii--indent-string' can
392 ;; operate on a given output string.
394 ;; The second category contains functions handling elements listings,
395 ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
396 ;; returns a complete table of contents, `org-ascii--list-listings'
397 ;; returns a list of referenceable src-block elements, and
398 ;; `org-ascii--list-tables' does the same for table elements.
400 ;; The third category includes general helper functions.
401 ;; `org-ascii--build-title' creates the title for a given headline
402 ;; or inlinetask element. `org-ascii--build-caption' returns the
403 ;; caption string associated to a table or a src-block.
404 ;; `org-ascii--describe-links' creates notes about links for
405 ;; insertion at the end of a section. It uses
406 ;; `org-ascii--unique-links' to get the list of links to describe.
407 ;; Eventually, `org-ascii--translate' translates a string according
408 ;; to language and charset specification.
412 "Fill a string with specified text-width and return it.
414 S is the string being filled. TEXT-WIDTH is an integer
415 specifying maximum length of a line. INFO is the plist used as
416 a communication channel.
418 Optional argument JUSTIFY can specify any type of justification
419 among `left', `center', `right' or `full'. A nil value is
420 equivalent to `left'. For a justification that doesn't also fill
421 string, see `org-ascii--justify-string'.
423 Return nil if S isn't a string."
424 ;; Don't fill paragraph when break should be preserved.
437 "Justify string S.
438 TEXT-WIDTH is an integer specifying maximum length of a line.
439 HOW determines the type of justification: it can be `left',
440 `right', `full' or `center'."
445 ;; Disable `adaptive-fill-mode' so it doesn't prevent
446 ;; filling lines matching `adaptive-fill-regexp'.
454 "Indent string S by WIDTH white spaces.
455 Empty lines are not indented."
461 "Return string S with a partial box to its left.
462 INFO is a plist used as a communication channel."
467 ;; Remove last newline character.
471 "Return maximum text width for ELEMENT's contents.
472 INFO is a plist used as a communication channel."
474 ;; Elements with an absolute width: `headline' and `inlinetask'.
476 ('headline
480 ;; Elements with a relative width: store maximum text width in
481 ;; TOTAL-WIDTH.
484 ;; Total width is determined by the presence, or not, of an
485 ;; inline task among ELEMENT parents.
489 org-ascii-inlinetask-width
490 ;; No inlinetask: Remove global margin from text width.
492 org-ascii-global-margin
494 ;; Inner margin doesn't apply to text before first
495 ;; headline.
499 ;; Inner margin doesn't apply to contents of
500 ;; low level headlines, since they've got their
501 ;; own indentation mechanism.
503 org-ascii-inner-margin))))))))
505 ;; Each `quote-block', `quote-section' and `verse-block' above
506 ;; narrows text width by twice the standard margin size.
510 count parent)
512 ;; Text width within a plain-list is restricted by
513 ;; indentation of current item. If that's the case,
514 ;; compute it with the help of `:structure' property from
515 ;; parent item, if any.
520 return parent))))
522 ;; Compute indentation offset of the current item,
523 ;; that is the sum of the difference between its
524 ;; indentation and the indentation of the top item in
525 ;; the list and current item bullet's length. Also
526 ;; remove checkbox length, and tag length (for
527 ;; description lists) or bullet length.
541 "Format ELEMENT title and return it.
543 ELEMENT is either an `headline' or `inlinetask' element. INFO is
544 a plist used as a communication channel. TEXT-WIDTH is an
545 integer representing the maximum length of a line.
547 When optional argument UNDERLINE is non-nil, underline title,
548 without the tags, according to `org-ascii-underline'
549 specifications.
551 If optional argument NOTAGS is non-nil, no tags will be added to
552 the title.
554 When optional argument TOC is non-nil, use optional title if
555 possible. It doesn't apply to `inlinetask' elements."
558 ;; Numbering is specific to headlines.
560 ;; All tests passed: build numbering string.
563 'number-to-string
571 info)))
588 first-part
589 ;; Align tags, if any.
595 tags))
596 ;; Maybe underline text, if ELEMENT type is `headline' and an
597 ;; underline character has been defined.
602 org-ascii-underline)))))
607 under-char))))))))
610 "Non-nil when ELEMENT has a caption affiliated keyword.
611 INFO is a plist used as a communication channel. This function
612 is meant to be used as a predicate for `org-export-get-ordinal'."
616 "Return caption string for ELEMENT, if applicable.
618 INFO is a plist used as a communication channel.
620 The caption string contains the sequence number of ELEMENT along
621 with its real caption. Return nil when ELEMENT has no affiliated
622 caption keyword."
625 ;; Get sequence number of current src-block among every
626 ;; src-block with a caption.
634 info)))
637 " "
642 "Return a table of contents.
644 INFO is a plist used as a communication channel.
646 Optional argument N, when non-nil, is an integer specifying the
647 depth of the table.
649 Optional argument KEYWORD specifies the TOC keyword, if any, from
650 which the table of contents generation has been initiated."
674 "Return a list of listings.
676 KEYWORD is the keyword that initiated the list of listings
677 generation. INFO is a plist used as a communication channel."
687 ;; Use a counter instead of retrieving ordinal of each
688 ;; src-block.
692 ;; Store initial text so its length can be computed. This is
693 ;; used to properly align caption right to it in case of
694 ;; filling (like contents of a description list item).
700 initial-text " "
704 ;; Use short name in priority, if available.
709 initial-width)))))
713 "Return a list of tables.
715 KEYWORD is the keyword that initiated the list of tables
716 generation. INFO is a plist used as a communication channel."
726 ;; Use a counter instead of retrieving ordinal of each
727 ;; src-block.
731 ;; Store initial text so its length can be computed. This is
732 ;; used to properly align caption right to it in case of
733 ;; filling (like contents of a description list item).
739 initial-text " "
743 ;; Use short name in priority, if available.
748 initial-width)))))
752 "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.
765 ;; Ignore LINK if it hasn't been translated already.
766 ;; It can happen if it is located in an affiliated
767 ;; keyword that was ignored.
772 ;; If at a section, find parent headline, if any, in order to
773 ;; count links that might be in the title.
777 ;; Get all links in HEADLINE.
782 "Return a string describing a list of links.
784 LINKS is a list of link type objects, as returned by
785 `org-ascii--unique-links'. WIDTH is the text width allowed for
786 the output string. INFO is a plist used as a communication
787 channel."
795 ;; Coderefs, radio links and fuzzy links are ignored.
797 ;; Id and custom-id links: Headlines refer to their numbering.
803 "[%s] %s"
804 anchor
811 ;; Do not add a link that cannot be resolved and doesn't have
812 ;; any description: destination is already visible in the
813 ;; paragraph.
819 width info)
824 "Return checkbox string for ITEM or nil.
825 INFO is a plist used as a communication channel."
833 \f
834 ;;; Template
837 "Return document title, as a string.
838 INFO is a plist used as a communication channel."
840 ;; Links in the title will not be resolved later, so we make
841 ;; sure their path is located right after them.
851 ;; There are two types of title blocks depending on the presence
852 ;; of a title to display.
854 ;; Title block without a title. DATE is positioned at the top
855 ;; right of the document, AUTHOR to the top left and EMAIL
856 ;; just below.
860 author
862 ?\s)
863 date
868 email
870 ?\s)
880 ;; Title block with a title. Document's TITLE, along with the
881 ;; AUTHOR and its EMAIL are both overlined and an underlined,
882 ;; centered. Date is just below, also centered.
884 ;; Format TITLE. It may be filled if it is too wide,
885 ;; that is wider than the two thirds of the total width.
911 "Return complete document string after ASCII conversion.
912 CONTENTS is the transcoded contents string. INFO is a plist
913 holding export options."
917 ;; 1. Document's body.
918 contents
919 ;; 2. Footnote definitions.
922 ;; Insert full links right inside the footnote definition
923 ;; as they have no chance to be inserted later.
939 ;; Distinguish between inline definitions and
940 ;; full-fledged definitions.
944 ;; Full-fledged definition: footnote ID is
945 ;; inserted inside the first parsed paragraph
946 ;; (FIRST), if any, to be sure filling will
947 ;; take it into consideration.
953 ;; Fill paragraph once footnote ID is inserted
954 ;; in order to have a correct length for first
955 ;; line.
958 text-width info))))))
960 org-ascii-global-margin)))
963 "Return complete document string after ASCII conversion.
964 CONTENTS is the transcoded contents string. INFO is a plist
965 holding export options."
967 ;; 1. Build title block.
970 ;; 2. Table of contents.
976 org-ascii-global-margin)
977 ;; 3. Document's body.
978 contents
979 ;; 4. Creator. Ignore `comment' value as there are no comments in
980 ;; ASCII. Justify it to the bottom right.
989 org-ascii-global-margin)))
992 "Translate string S according to specified language and charset.
993 INFO is a plist used as a communication channel."
998 \f
999 ;;; Transcode Functions
1001 ;;;; Bold
1004 "Transcode BOLD from Org to ASCII.
1005 CONTENTS is the text with bold markup. INFO is a plist holding
1006 contextual information."
1010 ;;;; Center Block
1013 "Transcode a CENTER-BLOCK element from Org to ASCII.
1014 CONTENTS holds the contents of the block. INFO is a plist
1015 holding contextual information."
1020 ;;;; Clock
1023 "Transcode a CLOCK object from Org to ASCII.
1024 CONTENTS is nil. INFO is a plist holding contextual
1025 information."
1034 "%2s:%02s"
1038 ;;;; Code
1041 "Return a CODE object from Org to ASCII.
1042 CONTENTS is nil. INFO is a plist holding contextual
1043 information."
1047 ;;;; Drawer
1050 "Transcode a DRAWER element from Org to ASCII.
1051 CONTENTS holds the contents of the block. INFO is a plist
1052 holding contextual information."
1058 ;;;; Dynamic Block
1061 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1062 CONTENTS holds the contents of the block. INFO is a plist
1063 holding contextual information."
1064 contents)
1067 ;;;; Entity
1070 "Transcode an ENTITY object from Org to ASCII.
1071 CONTENTS are the definition itself. INFO is a plist holding
1072 contextual information."
1075 entity))
1078 ;;;; Example Block
1081 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1082 CONTENTS is nil. INFO is a plist holding contextual information."
1087 ;;;; Export Snippet
1090 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1091 CONTENTS is nil. INFO is a plist holding contextual information."
1096 ;;;; Export Block
1099 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1100 CONTENTS is nil. INFO is a plist holding contextual information."
1105 ;;;; Fixed Width
1108 "Transcode a FIXED-WIDTH element from Org to ASCII.
1109 CONTENTS is nil. INFO is a plist holding contextual information."
1115 ;;;; Footnote Definition
1117 ;; Footnote Definitions are ignored. They are compiled at the end of
1118 ;; the document, by `org-ascii-inner-template'.
1121 ;;;; Footnote Reference
1124 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1125 CONTENTS is nil. INFO is a plist holding contextual information."
1129 ;;;; Headline
1132 "Transcode a HEADLINE element from Org to ASCII.
1133 CONTENTS holds the contents of the headline. INFO is a plist
1134 holding contextual information."
1135 ;; Don't export footnote section, which will be handled at the end
1136 ;; of the template.
1140 ;; Blank lines between headline and its contents.
1141 ;; `org-ascii-headline-spacing', when set, overwrites
1142 ;; original buffer's spacing.
1147 ;; Even if HEADLINE has no section, there might be some
1148 ;; links in its title that we shouldn't forget to describe.
1155 ;; Deep subtree: export it as a list item.
1158 ;; Bullet.
1160 org-ascii-bullets))))
1163 " "
1164 ;; Title.
1166 ;; Contents, indented by length of bullet.
1167 pre-blanks
1172 ;; Else: Standard headline.
1179 ;;;; Horizontal Rule
1182 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1183 CONTENTS is nil. INFO is a plist holding contextual
1184 information."
1191 text-width)
1196 ;;;; Inline Src Block
1199 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1200 CONTENTS holds the contents of the item. INFO is a plist holding
1201 contextual information."
1206 ;;;; Inlinetask
1210 "Format an inline task element for ASCII export.
1211 See `org-ascii-format-inlinetask-function' for a description
1212 of the parameters."
1217 ;; Top line, with an additional blank line if not in UTF-8.
1220 ;; Add title. Fill it if wider than inlinetask.
1225 ;; If CONTENTS is not empty, insert it along with
1226 ;; a separator.
1229 ;; Bottom line.
1231 ;; Flush the inlinetask to the right.
1234 org-ascii-inner-margin)
1238 "Transcode an INLINETASK element from Org to ASCII.
1239 CONTENTS holds the contents of the block. INFO is a plist
1240 holding contextual information."
1243 ;; todo.
1248 ;; todo-type
1250 ;; priority
1253 ;; title
1255 ;; tags
1258 ;; contents and width
1259 contents width inlinetask info)))
1262 ;;;; Italic
1265 "Transcode italic from Org to ASCII.
1266 CONTENTS is the text with italic markup. INFO is a plist holding
1267 contextual information."
1271 ;;;; Item
1274 "Transcode an ITEM element from Org to ASCII.
1275 CONTENTS holds the contents of the item. INFO is a plist holding
1276 contextual information."
1281 ;; First parent of ITEM is always the plain-list. Get
1282 ;; `:type' property from it.
1290 ;; Return correct number for ITEM, paying attention to
1291 ;; counters.
1297 struct
1302 ;; Change bullets into more visible form if UTF-8 is active.
1310 bullet
1312 ;; Contents: Pay attention to indentation. Note: check-boxes are
1313 ;; already taken care of at the paragraph level so they don't
1314 ;; interfere with indentation.
1321 ;;;; Keyword
1324 "Transcode a KEYWORD element from Org to ASCII.
1325 CONTENTS is nil. INFO is a plist holding contextual
1326 information."
1346 ;;;; Latex Environment
1349 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1350 CONTENTS is nil. INFO is a plist holding contextual
1351 information."
1356 ;;;; Latex Fragment
1359 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1360 CONTENTS is nil. INFO is a plist holding contextual
1361 information."
1366 ;;;; Line Break
1369 "Transcode a LINE-BREAK object from Org to ASCII.
1370 CONTENTS is nil. INFO is a plist holding contextual
1374 ;;;; Link
1377 "Transcode a LINK object from Org to ASCII.
1379 DESC is the description part of the link, or the empty string.
1380 INFO is a plist holding contextual information."
1388 ;; Do not apply a special syntax on radio links. Though, use
1389 ;; transcoded target's contents as output.
1394 ;; Do not apply a special syntax on fuzzy links pointing to
1395 ;; targets.
1413 ;;;; Paragraph
1416 "Transcode a PARAGRAPH element from Org to ASCII.
1417 CONTENTS is the contents of the paragraph, as a string. INFO is
1418 the plist used as a communication channel."
1427 ;;;; Plain List
1430 "Transcode a PLAIN-LIST element from Org to ASCII.
1431 CONTENTS is the contents of the list. INFO is a plist holding
1432 contextual information."
1433 contents)
1436 ;;;; Plain Text
1439 "Transcode a TEXT string from Org to ASCII.
1440 INFO is a plist used as a communication channel."
1447 ;; Usual replacements in utf-8 with proper option set.
1455 ;;;; Planning
1458 "Transcode a PLANNING element from Org to ASCII.
1459 CONTENTS is nil. INFO is a plist used as a communication
1460 channel."
1462 'identity
1482 ;;;; Quote Block
1485 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1486 CONTENTS holds the contents of the block. INFO is a plist
1487 holding contextual information."
1491 ;;;; Quote Section
1494 "Transcode a QUOTE-SECTION element from Org to ASCII.
1495 CONTENTS is nil. INFO is a plist holding contextual information."
1500 info)))
1502 value
1503 (+ org-ascii-quote-margin
1504 ;; Don't apply inner margin if parent headline is low level.
1507 org-ascii-inner-margin))))))
1510 ;;;; Radio Target
1513 "Transcode a RADIO-TARGET object from Org to ASCII.
1514 CONTENTS is the contents of the target. INFO is a plist holding
1515 contextual information."
1516 contents)
1519 ;;;; Section
1522 "Transcode a SECTION element from Org to ASCII.
1523 CONTENTS is the contents of the section. INFO is a plist holding
1524 contextual information."
1527 contents
1529 ;; Add list of links at the end of SECTION.
1533 ;; Separate list of links and section contents.
1535 ;; Do not apply inner margin if parent headline is low level.
1538 org-ascii-inner-margin))))
1541 ;;;; Special Block
1544 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1545 CONTENTS holds the contents of the block. INFO is a plist
1546 holding contextual information."
1547 contents)
1550 ;;;; Src Block
1553 "Transcode a SRC-BLOCK element from Org to ASCII.
1554 CONTENTS holds the contents of the item. INFO is a plist holding
1555 contextual information."
1566 ;;;; Statistics Cookie
1569 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1570 CONTENTS is nil. INFO is a plist holding contextual information."
1574 ;;;; Subscript
1577 "Transcode a SUBSCRIPT object from Org to ASCII.
1578 CONTENTS is the contents of the object. INFO is a plist holding
1579 contextual information."
1585 ;;;; Superscript
1588 "Transcode a SUPERSCRIPT object from Org to ASCII.
1589 CONTENTS is the contents of the object. INFO is a plist holding
1590 contextual information."
1596 ;;;; Strike-through
1599 "Transcode STRIKE-THROUGH from Org to ASCII.
1600 CONTENTS is text with strike-through markup. INFO is a plist
1601 holding contextual information."
1605 ;;;; Table
1608 "Transcode a TABLE element from Org to ASCII.
1609 CONTENTS is the contents of the table. INFO is a plist holding
1610 contextual information."
1613 ;; Possibly add a caption string above.
1615 ;; Insert table. Note: "table.el" tables are left unmodified.
1629 ;; Possible add a caption string below.
1633 ;;;; Table Cell
1636 "Return width of TABLE-CELL.
1638 INFO is a plist used as a communication channel.
1640 Width of a cell is determined either by a width cookie in the
1641 same column as the cell, or by the maximum cell's length in that
1642 column.
1644 When `org-ascii-table-widen-columns' is non-nil, width cookies
1645 are ignored."
1659 key
1670 info))
1671 max-width)))
1672 info)
1673 max-width))
1674 cache))))
1677 "Transcode a TABLE-CELL object from Org to ASCII.
1678 CONTENTS is the cell contents. INFO is a plist used as
1679 a communication channel."
1680 ;; Determine column width. When `org-ascii-table-widen-columns'
1681 ;; is nil and some width cookie has set it, use that value.
1682 ;; Otherwise, compute the maximum width among transcoded data of
1683 ;; each cell in the column.
1685 ;; When contents are too large, truncate them.
1689 ;; Align contents correctly within the cell.
1694 contents width
1699 ;; Return cell.
1705 ;;;; Table Row
1708 "Transcode a TABLE-ROW element from Org to ASCII.
1709 CONTENTS is the row contents. INFO is a plist used as
1710 a communication channel."
1717 'concat
1723 ;; In order to know if CELL starts the row, do
1724 ;; not compare it with the first cell in the
1725 ;; row as there might be a special column.
1726 ;; Instead, compare it with first exportable
1727 ;; cell, obtained with `org-element-map'.
1731 cell))
1732 lcorner)
1737 rcorner)
1743 info)))
1758 ;;;; Timestamp
1761 "Transcode a TIMESTAMP object from Org to ASCII.
1762 CONTENTS is nil. INFO is a plist holding contextual information."
1766 ;;;; Underline
1769 "Transcode UNDERLINE from Org to ASCII.
1770 CONTENTS is the text with underline markup. INFO is a plist
1771 holding contextual information."
1775 ;;;; Verbatim
1778 "Return a VERBATIM object from Org to ASCII.
1779 CONTENTS is nil. INFO is a plist holding contextual information."
1784 ;;;; Verse Block
1787 "Transcode a VERSE-BLOCK element from Org to ASCII.
1788 CONTENTS is verse block contents. INFO is a plist holding
1789 contextual information."
1793 org-ascii-quote-margin)))
1796 \f
1797 ;;; Filters
1800 "Filter controlling number of blank lines after a headline.
1802 HEADLINE is a string representing a transcoded headline.
1803 BACK-END is symbol specifying back-end used for export. INFO is
1804 plist containing the communication channel.
1806 This function only applies to `ascii' back-end. See
1807 `org-ascii-headline-spacing' for information."
1813 "Filter controlling number of blank lines between paragraphs.
1815 TREE is the parse tree. BACK-END is the symbol specifying
1816 back-end used for export. INFO is a plist used as
1817 a communication channel.
1819 See `org-ascii-paragraph-spacing' for information."
1827 tree)
1830 "Filter removing blank lines between comments.
1831 TREE is the parse tree. BACK-END is the symbol specifying
1832 back-end used for export. INFO is a plist used as
1833 a communication channel."
1839 tree)
1842 \f
1843 ;;; End-user functions
1845 ;;;###autoload
1848 "Export current buffer to a text buffer.
1850 If narrowing is active in the current buffer, only export its
1851 narrowed part.
1853 If a region is active, export that region.
1855 A non-nil optional argument ASYNC means the process should happen
1856 asynchronously. The resulting buffer should be accessible
1857 through the `org-export-stack' interface.
1859 When optional argument SUBTREEP is non-nil, export the sub-tree
1860 at point, extracting information from the headline properties
1861 first.
1863 When optional argument VISIBLE-ONLY is non-nil, don't export
1864 contents of hidden elements.
1866 When optional argument BODY-ONLY is non-nil, strip title and
1867 table of contents from output.
1869 EXT-PLIST, when provided, is a property list with external
1870 parameters overriding Org default settings, but still inferior to
1871 file-local settings.
1874 will be displayed when `org-export-show-temporary-export-buffer'
1875 is non-nil."
1880 ;;;###autoload
1883 "Export current buffer to a text file.
1885 If narrowing is active in the current buffer, only export its
1886 narrowed part.
1888 If a region is active, export that region.
1890 A non-nil optional argument ASYNC means the process should happen
1891 asynchronously. The resulting file should be accessible through
1892 the `org-export-stack' interface.
1894 When optional argument SUBTREEP is non-nil, export the sub-tree
1895 at point, extracting information from the headline properties
1896 first.
1898 When optional argument VISIBLE-ONLY is non-nil, don't export
1899 contents of hidden elements.
1901 When optional argument BODY-ONLY is non-nil, strip title and
1902 table of contents from output.
1904 EXT-PLIST, when provided, is a property list with external
1905 parameters overriding Org default settings, but still inferior to
1906 file-local settings.
1908 Return output file's name."
1912 async subtreep visible-only body-only ext-plist)))
1914 ;;;###autoload
1916 "Publish an Org file to ASCII.
1918 FILENAME is the filename of the Org file to be published. PLIST
1919 is the property list for the given project. PUB-DIR is the
1920 publishing directory.
1922 Return output file name."
1926 ;;;###autoload
1928 "Publish an Org file to Latin-1.
1930 FILENAME is the filename of the Org file to be published. PLIST
1931 is the property list for the given project. PUB-DIR is the
1932 publishing directory.
1934 Return output file name."
1938 ;;;###autoload
1940 "Publish an org file to UTF-8.
1942 FILENAME is the filename of the Org file to be published. PLIST
1943 is the property list for the given project. PUB-DIR is the
1944 publishing directory.
1946 Return output file name."
1953 ;; Local variables:
1954 ;; generated-autoload-file: "org-loaddefs.el"
1955 ;; coding: utf-8-emacs
1956 ;; End:
1958 ;;; ox-ascii.el ends here