| blob | 5a2b0c2dc03fd41ddc3033469466ed5e5935edd4 |
1 ;;; org-e-ascii.el --- ASCII Back-End For Org Export Engine
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary:
23 ;; This library implements an ASCII back-end for Org generic exporter.
25 ;; To test it, run
26 ;;
27 ;; M-: (org-export-to-buffer 'e-ascii "*Test e-ASCII*") RET
28 ;;
29 ;; in an Org mode buffer then switch to that buffer to see the ASCII
30 ;; export. See contrib/lisp/org-export.el for more details on how
31 ;; this exporter works.
33 ;;; Code:
74 org-export-to-file "org-export"
78 \f
79 ;;; Internal Variables
81 ;; The following setting won't allow to modify preferred charset
82 ;; through a buffer keyword or an option item, but, since the property
83 ;; will appear in communication channel nonetheless, it allows to
84 ;; override `org-e-ascii-charset' variable on the fly by the ext-plist
85 ;; mechanism.
87 ;; We also install a filter for headlines and sections, in order to
88 ;; control blank lines separating them in output string.
92 )
93 "Alist between ASCII export properties and ways to set them.
94 See `org-export-option-alist' for more information on the
100 "Alist between filters keywords and back-end specific filters.
194 "Dictionary for ASCII back-end.
196 Alist whose car is the string to translate and cdr is an alist
197 whose car is the language string and cdr is a plist whose
198 properties are possible charsets and value the translated term.
203 \f
204 ;;; User Configurable Variables
207 "Options for exporting Org mode files to ASCII."
212 "Maximum width of exported text.
213 This number includes margin size, as set in
214 `org-e-ascii-global-margin'."
219 "Width of the left margin, in number of characters."
224 "Width of the inner margin, in number of characters.
225 Inner margin is applied between each headline."
230 "Width of margin used for quoting text, in characters.
231 This margin is applied on both sides of the text."
236 "Width of inline tasks, in number of characters.
237 This number ignores any margin."
242 "Number of blank lines inserted around headlines.
244 This variable can be set to a cons cell. In that case, its car
245 represents the number of blank lines present before headline
246 contents whereas its cdr reflects the number of blank lines after
247 contents.
249 A nil value replicates the number of blank lines found in the
250 original Org buffer at the same place."
259 "The charset allowed to represent various elements and objects.
260 Possible values are:
261 `ascii' Only use plain ASCII characters
262 `latin1' Include Latin-1 characters
263 `utf-8' Use all UTF-8 characters"
273 "Characters for underlining headings in ASCII export.
275 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
276 and whose value is a list of characters.
278 For each supported charset, this variable associates a sequence
279 of underline characters. In a sequence, the characters will be
280 used in order for headlines level 1, 2, ... If no character is
281 available for a given level, the headline won't be underlined."
297 "Bullet characters for headlines converted to lists in ASCII export.
299 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
300 and whose value is a list of characters.
302 The first character is used for the first level considered as low
303 level, and so on. If there are more levels than characters given
304 here, the list will be repeated.
306 Note that this variable doesn't affect plain lists
307 representation."
321 "Non-nil means convert links to notes before the next headline.
322 When nil, the link will be exported in place. If the line
323 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."
335 "Non-nil means widen narrowed columns for export.
336 When nil, narrowed columns will look in ASCII export just like in
342 "When non-nil, place caption string before the element.
343 Otherwise, place it right after it."
348 "Format string used for verbatim text and inline code."
353 "Function called to format a drawer in ASCII.
355 The function must accept two parameters:
357 CONTENTS the contents of the drawer.
358 WIDTH the text width within the drawer.
360 The function should return either the string to be exported or
361 nil to ignore the drawer.
363 For example, the variable could be set to the following function
364 in order to mimic default behaviour:
366 \(defun org-e-ascii-format-drawer-default \(name contents width\)
368 contents\)"
373 "Function called to format an inlinetask in ASCII.
375 The function must accept six parameters:
376 TODO the todo keyword, as a string
377 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
378 PRIORITY the inlinetask priority, as a string
379 NAME the inlinetask name, as a string.
380 TAGS the inlinetask tags, as a string.
381 CONTENTS the contents of the inlinetask, as a string.
383 The function should return either the string to be exported or
384 nil to ignore the inline task.
386 For example, the variable could be set to the following function
387 in order to mimic default behaviour:
389 \(defun org-e-ascii-format-inlinetask-default
390 \(todo type priority name tags contents\)
392 \(let* \(\(utf8p \(eq \(plist-get info :ascii-charset\) 'utf-8\)\)
393 \(width org-e-ascii-inlinetask-width\)
394 \(org-e-ascii--indent-string
395 \(concat
396 ;; Top line, with an additional blank line if not in UTF-8.
399 ;; Add title. Fill it if wider than inlinetask.
400 \(let \(\(title \(org-e-ascii--build-title inlinetask info width\)\)\)
401 \(if \(<= \(length title\) width\) title
402 \(org-e-ascii--fill-string title width info\)\)\)
404 ;; If CONTENTS is not empty, insert it along with
405 ;; a separator.
406 \(when \(org-string-nw-p contents\)
408 ;; Bottom line.
409 \(make-string width \(if utf8p ?━ ?_\)\)\)
410 ;; Flush the inlinetask to the right.
411 \(- \(plist-get info :ascii-width\)
412 \(plist-get info :ascii-margin\)
413 \(plist-get info :ascii-inner-margin\)
414 \(org-e-ascii--current-text-width inlinetask info\)\)"
419 \f
420 ;;; Internal Functions
422 ;; Internal functions fall into three categories.
424 ;; The first one is about text formatting. The core function is
425 ;; `org-e-ascii--current-text-width', which determines the current
426 ;; text width allowed to a given element. In other words, it helps
427 ;; keeping each line width within maximum text width defined in
428 ;; `org-e-ascii-text-width'. Once this information is known,
429 ;; `org-e-ascii--fill-string', `org-e-ascii--justify-string',
430 ;; `org-e-ascii--box-string' and `org-e-ascii--indent-string' can
431 ;; operate on a given output string.
433 ;; The second category contains functions handling elements listings,
434 ;; triggered by "#+TOC:" keyword. As such, `org-e-ascii--build-toc'
435 ;; returns a complete table of contents, `org-e-ascii--list-listings'
436 ;; returns a list of referenceable src-block elements, and
437 ;; `org-e-ascii--list-tables' does the same for table elements.
439 ;; The third category includes general helper functions.
440 ;; `org-e-ascii--build-title' creates the title for a given headline
441 ;; or inlinetask element. `org-e-ascii--build-caption' returns the
442 ;; caption string associated to a table or a src-block.
443 ;; `org-e-ascii--describe-links' creates notes about links for
444 ;; insertion at the end of a section. It uses
445 ;; `org-e-ascii--unique-links' to get the list of links to describe.
446 ;; Eventually, `org-e-ascii--translate' reads `org-e-ascii-dictionary'
447 ;; to internationalize output.
451 "Fill a string with specified text-width and return it.
453 S is the string being filled. TEXT-WIDTH is an integer
454 specifying maximum length of a line. INFO is the plist used as
455 a communication channel.
457 Optional argument JUSTIFY can specify any type of justification
458 among `left', `center', `right' or `full'. A nil value is
459 equivalent to `left'. For a justification that doesn't also fill
460 string, see `org-e-ascii--justify-string'.
462 Return nil if S isn't a string."
463 ;; Don't fill paragraph when break should be preserved.
474 "Justify string S.
475 TEXT-WIDTH is an integer specifying maximum length of a line.
476 HOW determines the type of justification: it can be `left',
477 `right', `full' or `center'."
488 "Indent string S by WIDTH white spaces.
489 Empty lines are not indented."
495 "Return string S with a partial box to its left.
496 INFO is a plist used as a communicaton channel."
501 ;; Remove last newline character.
505 "Return maximum text width for ELEMENT's contents.
506 INFO is a plist used as a communication channel."
508 ;; Elements with an absolute width: `headline' and `inlinetask'.
510 ('headline
514 ;; Elements with a relative width: store maximum text width in
515 ;; TOTAL-WIDTH.
518 ;; Total width is determined by the presence, or not, of an
519 ;; inline task among ELEMENT parents.
523 org-e-ascii-inlinetask-width
524 ;; No inlinetask: Remove global margin from text width.
526 org-e-ascii-global-margin
528 ;; Inner margin doesn't apply to text before first
529 ;; headline.
533 ;; Inner margin doesn't apply to contents of
534 ;; low level headlines, since they've got their
535 ;; own indentation mechanism.
537 org-e-ascii-inner-margin))))))))
539 ;; Each `quote-block', `quote-section' and `verse-block' above
540 ;; narrows text width by twice the standard margin size.
544 count parent)
546 ;; Text width within a plain-list is restricted by
547 ;; indentation of current item. If that's the case,
548 ;; compute it with the help of `:structure' property from
549 ;; parent item, if any.
554 return parent))))
556 ;; Compute indentation offset of the current item,
557 ;; that is the sum of the difference between its
558 ;; indentation and the indentation of the top item in
559 ;; the list and current item bullet's length. Also
560 ;; remove tag length (for description lists) or bullet
561 ;; length.
573 "Format ELEMENT title and return it.
575 ELEMENT is either an `headline' or `inlinetask' element. INFO is
576 a plist used as a communication channel. TEXT-WIDTH is an
577 integer representing the maximum length of a line.
579 When optional argument UNDERLINE is non-nil, underline title,
580 without the tags, according to `org-e-ascii-underline'
581 specifications.
583 if optional argument NOTAGS is nil, no tags will be added to the
584 title."
587 ;; Numbering is specific to headlines.
589 ;; All tests passed: build numbering string.
592 #'number-to-string
611 first-part
612 ;; Align tags, if any.
617 tags))
618 ;; Maybe underline text, if ELEMENT type is `headline' and an
619 ;; underline character has been defined.
624 org-e-ascii-underline)))))
630 "Return caption string for ELEMENT, if applicable.
632 INFO is a plist used as a communication channel.
634 The caption string contains the sequence number of ELEMENT if it
635 has a name affiliated keyword, along with the real caption, if
636 any. Return nil when ELEMENT has no affiliated caption or name
637 keyword."
641 ;; Get sequence number of current src-block among every
642 ;; src-block with either a caption or a name.
645 element info nil nil
654 title-fmt reference
660 "Return a table of contents.
662 INFO is a plist used as a communication channel.
664 Optional argument N, when non-nil, is an integer specifying the
665 depth of the table.
667 Optional argument KEYWORD specifies the TOC keyword, if any, from
668 which the table of contents generation has been initiated."
671 title
690 "Return a list of listings.
692 KEYWORD is the keyword that initiated the list of listings
693 generation. INFO is a plist used as a communication channel."
696 title
703 ;; Use a counter instead of retreiving ordinal of each
704 ;; src-block.
708 ;; Store initial text so its length can be computed. This is
709 ;; used to properly align caption right to it in case of
710 ;; filling (like contents of a description list item).
715 initial-text
722 ;; Use short name in priority, if available.
729 "Return a list of listings.
731 KEYWORD is the keyword that initiated the list of listings
732 generation. INFO is a plist used as a communication channel."
735 title
742 ;; Use a counter instead of retreiving ordinal of each
743 ;; src-block.
747 ;; Store initial text so its length can be computed. This is
748 ;; used to properly align caption right to it in case of
749 ;; filling (like contents of a description list item).
754 initial-text
760 ;; Use short name in priority, if available.
768 "Return a list of unique link references in ELEMENT.
770 ELEMENT is either an headline element or a section element. INFO
771 is a plist used as a communication channel.
773 It covers links that may be found current headline's title, in
774 the following section and in any inlinetask's title there."
778 ;; Return LINK if it wasn't referenced so far, or nil.
779 ;; Update SEEN links along the way.
788 ;; Return a list of all unique links in ELEMENT. ELEMENT
789 ;; may be an headline or an inlinetask element.
796 ;; Retrieve HEADLINE's section, if it exists.
803 ;; Links that may be in HEADLINE's title.
805 ;; Get all links in SECTION.
810 "Return a string describing a list of links.
812 LINKS is a list of link type objects, as returned by
813 `org-e-ascii--unique-links'. WIDTH is the text width allowed for
814 the output string. INFO is a plist used as a communication
815 channel."
823 ;; Coderefs, radio links and ref links are ignored.
825 ;; Id, custom-id and fuzzy links (with the exception of
826 ;; targets): Headlines refer to their numbering.
835 "[%s] %s"
836 anchor
845 ;; Do not add a link that cannot be resolved and doesn't have
846 ;; any description: destination is already visible in the
847 ;; paragraph.
853 width info)
858 \f
859 ;;; Template
862 "Return document title, as a string.
863 INFO is a plist used as a communication channel."
876 ;; There are two types of title blocks depending on the presence
877 ;; of a title to display.
879 ;; Title block without a title. DATE is positioned at the top
880 ;; right of the document, AUTHOR to the top left and EMAIL
881 ;; just below.
885 author
887 date
892 email
903 ;; Title block with a title. Document's TITLE, along with the
904 ;; AUTHOR and its EMAIL are both overlined and an underlined,
905 ;; centered. Date is just below, also centered.
907 ;; Format TITLE. It may be filled if it is too wide,
908 ;; that is wider than the two thirds of the total width.
931 "Return complete document string after ASCII conversion.
932 CONTENTS is the transcoded contents string. INFO is a plist
933 holding export options."
937 ;; 1. Build title block.
940 ;; 2. Table of contents.
946 ;; 3. Document's body.
947 contents
948 ;; 4. Footnote definitions.
951 ;; Insert full links right inside the footnote definition
952 ;; as they have no chance to be inserted later.
959 title
967 ;; Distinguish between inline definitions and
968 ;; full-fledged definitions.
972 ;; Full-fledged definition: footnote ID is
973 ;; inserted inside the first parsed paragraph
974 ;; (FIRST), if any, to be sure filling will
975 ;; take it into consideration.
981 ;; Fill paragraph once footnote ID is inserted in
982 ;; order to have a correct length for first line.
985 text-width info))))))
987 ;; 5. Creator. Ignore `comment' value as there are no comments in
988 ;; ASCII. Justify it to the bottom right.
995 org-e-ascii-global-margin)))
998 "Translate string S.
1000 INFO is a plist used as a communication channel.
1002 Translation depends on `:language' property and allowed charset.
1003 If no translation in found for a given language and a given
1004 charset, fall-back to S."
1011 \f
1012 ;;; Transcode Functions
1014 ;;;; Babel Call
1016 ;; Babel Calls are ignored.
1019 ;;;; Center Block
1022 "Transcode a CENTER-BLOCK element from Org to ASCII.
1023 CONTENTS holds the contents of the block. INFO is a plist
1024 holding contextual information."
1029 ;;;; Comment
1031 ;; Comments are ignored.
1034 ;;;; Comment Block
1036 ;; Comment Blocks are ignored.
1039 ;;;; Drawer
1042 "Transcode a DRAWER element from Org to ASCII.
1043 CONTENTS holds the contents of the block. INFO is a plist
1044 holding contextual information."
1049 ;; If there's no user defined function: simply
1050 ;; display contents of the drawer.
1051 contents)))
1054 ;;;; Dynamic Block
1057 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1058 CONTENTS holds the contents of the block. INFO is a plist
1059 holding contextual information. See
1060 `org-export-data'."
1061 contents)
1064 ;;;; Emphasis
1067 "Transcode EMPHASIS from Org to ASCII.
1068 CONTENTS is the contents of the emphasized text. INFO is a plist
1069 holding contextual information.."
1071 ;; Leave emphasis markers as-is.
1075 ;;;; Entity
1078 "Transcode an ENTITY object from Org to ASCII.
1079 CONTENTS are the definition itself. INFO is a plist holding
1080 contextual information."
1083 entity))
1086 ;;;; Example Block
1089 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1090 CONTENTS is nil. INFO is a plist holding contextual information."
1094 ;;;; Export Snippet
1097 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1098 CONTENTS is nil. INFO is a plist holding contextual information."
1103 ;;;; Export Block
1106 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1107 CONTENTS is nil. INFO is a plist holding contextual information."
1112 ;;;; Fixed Width
1115 "Transcode a FIXED-WIDTH element from Org to ASCII.
1116 CONTENTS is nil. INFO is a plist holding contextual information."
1122 ;;;; Footnote Definition
1124 ;; Footnote Definitions are ignored. They are compiled at the end of
1125 ;; the document, by `org-e-ascii-template'.
1128 ;;;; Footnote Reference
1131 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1132 CONTENTS is nil. INFO is a plist holding contextual information."
1136 ;;;; Headline
1139 "Transcode an HEADLINE element from Org to ASCII.
1140 CONTENTS holds the contents of the headline. INFO is a plist
1141 holding contextual information."
1142 ;; Don't export footnote section, which will be handled at the end
1143 ;; of the template.
1147 ;; Blank lines between headline and its contents.
1148 ;; `org-e-ascii-headline-spacing', when set, overwrites
1149 ;; original buffer's spacing.
1154 ;; Even if HEADLINE has no section, there might be some
1155 ;; links in its title that we shouldn't forget to describe.
1160 ;; Deep subtree: export it as a list item.
1163 ;; Bullet.
1165 org-e-ascii-bullets))))
1168 " "
1169 ;; Title.
1171 ;; Contents, indented by length of bullet.
1172 pre-blanks
1177 ;; Else: Standard headline.
1184 ;;;; Horizontal Rule
1187 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1188 CONTENTS is nil. INFO is a plist holding contextual
1189 information."
1193 "(%s)"
1195 #'identity
1204 ;;;; Inline Babel Call
1206 ;; Inline Babel Calls are ignored.
1209 ;;;; Inline Src Block
1212 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1213 CONTENTS holds the contents of the item. INFO is a plist holding
1214 contextual information."
1219 ;;;; Inlinetask
1222 "Transcode an INLINETASK element from Org to ASCII.
1223 CONTENTS holds the contents of the block. INFO is a plist
1224 holding contextual information."
1238 ;; If `org-e-ascii-format-inlinetask-function' is provided, call it
1239 ;; with appropriate arguments.
1242 todo todo-type priority title tags contents width)
1243 ;; Otherwise, use a default template.
1247 ;; Top line, with an additional blank line if not in UTF-8.
1250 ;; Add title. Fill it if wider than inlinetask.
1255 ;; If CONTENTS is not empty, insert it along with
1256 ;; a separator.
1259 ;; Bottom line.
1261 ;; Flush the inlinetask to the right.
1264 org-e-ascii-inner-margin)
1268 ;;;; Item
1271 "Transcode an ITEM element from Org to ASCII.
1272 CONTENTS holds the contents of the item. INFO is a plist holding
1273 contextual information."
1275 ;; First parent of ITEM is always the plain-list. Get
1276 ;; `:type' property from it.
1284 ;; Return correct number for ITEM, paying attention to
1285 ;; counters.
1292 struct
1297 ;; Change bullets into more visible form if UTF-8 is active.
1305 bullet
1306 ;; Contents: Pay attention to indentation. Note: check-boxes are
1307 ;; already taken care of at the paragraph level so they don't
1308 ;; interfere with indentation.
1315 ;;;; Keyword
1318 "Transcode a KEYWORD element from Org to ASCII.
1319 CONTENTS is nil. INFO is a plist holding contextual
1320 information."
1340 ;;;; Latex Environment
1343 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1344 CONTENTS is nil. INFO is a plist holding contextual
1345 information."
1349 ;;;; Latex Fragment
1352 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1353 CONTENTS is nil. INFO is a plist holding contextual
1354 information."
1358 ;;;; Line Break
1361 "Transcode a LINE-BREAK object from Org to ASCII.
1362 CONTENTS is nil. INFO is a plist holding contextual
1366 ;;;; Link
1369 "Transcode a LINK object from Org to ASCII.
1371 DESC is the description part of the link, or the empty string.
1372 INFO is a plist holding contextual information."
1380 ;; Do not apply a special syntax on radio links. Though, parse
1381 ;; and transcode path to have a proper display of contents.
1388 ;; Ref link: If there's no description (DESC, return link's
1389 ;; destination sequence number among elements of same
1390 ;; type. Otherwise, use DESC.
1396 info nil nil
1399 ;; Do not apply a special syntax on fuzzy links pointing to
1400 ;; targets.
1406 path))))
1413 ;;;; Macro
1416 "Transcode a MACRO element from Org to ASCII.
1417 CONTENTS is nil. INFO is a plist holding contextual
1418 information."
1422 ;;;; Paragraph
1425 "Transcode a PARAGRAPH element from Org to ASCII.
1426 CONTENTS is the contents of the paragraph, as a string. INFO is
1427 the plist used as a communication channel."
1430 ;; If PARAGRAPH is the first one in a list element, be sure to
1431 ;; add the check-box in front of it, before any filling. Later,
1432 ;; it would interfere with line width.
1440 contents))
1441 contents))
1445 ;;;; Plain List
1448 "Transcode a PLAIN-LIST element from Org to ASCII.
1449 CONTENTS is the contents of the list. INFO is a plist holding
1450 contextual information."
1451 contents)
1454 ;;;; Plain Text
1457 "Transcode a TEXT string from Org to ASCII.
1458 INFO is a plist used as a communication channel."
1461 text
1462 ;; Usual replacements in utf-8 with proper option set.
1470 ;;;; Property Drawer
1473 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1474 CONTENTS is nil. INFO is a plist used as a communication
1475 channel."
1476 ;; The property drawer isn't exported but we want separating blank
1477 ;; lines nonetheless.
1481 ;;;; Quote Block
1484 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1485 CONTENTS holds the contents of the block. INFO is a plist
1486 holding contextual information."
1491 org-e-ascii-quote-margin)))
1494 ;;;; Quote Section
1497 "Transcode a QUOTE-SECTION element from Org to ASCII.
1498 CONTENTS is nil. INFO is a plist holding contextual information."
1505 value
1506 (+ org-e-ascii-quote-margin
1507 ;; Don't apply inner margin if parent headline is low level.
1510 org-e-ascii-inner-margin))))))
1513 ;;;; Radio Target
1516 "Transcode a RADIO-TARGET object from Org to ASCII.
1517 CONTENTS is the contents of the target. INFO is a plist holding
1518 contextual information."
1519 contents)
1521 ;;;; Section
1524 "Transcode a SECTION element from Org to ASCII.
1525 CONTENTS is the contents of the section. INFO is a plist holding
1526 contextual information."
1529 contents
1531 ;; Add list of links at the end of SECTION.
1535 ;; Separate list of links and section contents.
1537 ;; Do not apply inner margin if parent headline is low level.
1540 org-e-ascii-inner-margin))))
1543 ;;;; Special Block
1546 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1547 CONTENTS holds the contents of the block. INFO is a plist
1548 holding contextual information."
1549 contents)
1552 ;;;; Src Block
1555 "Transcode a SRC-BLOCK element from Org to ASCII.
1556 CONTENTS holds the contents of the item. INFO is a plist holding
1557 contextual information."
1565 ;;;; Statistics Cookie
1568 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1569 CONTENTS is nil. INFO is a plist holding contextual information."
1573 ;;;; Subscript
1576 "Transcode a SUBSCRIPT object from Org to ASCII.
1577 CONTENTS is the contents of the object. INFO is a plist holding
1578 contextual information."
1584 ;;;; Superscript
1587 "Transcode a SUPERSCRIPT object from Org to ASCII.
1588 CONTENTS is the contents of the object. INFO is a plist holding
1589 contextual information."
1595 ;;;; Table
1597 ;; While `org-e-ascii-table' is the callback function expected by
1598 ;; org-export mechanism, it requires four subroutines to display
1599 ;; tables accordingly to chosen charset, alignment and width
1600 ;; specifications.
1602 ;; Thus, `org-e-ascii-table--column-width' computes the display width
1603 ;; for each column in the table,
1604 ;; `org-e-ascii-table--vertical-separators' returns a vector
1605 ;; containing separators (or lack thereof),
1606 ;; `org-e-ascii-table--build-hline' creates various hline strings,
1607 ;; depending on charset, separators and position within the tabl and
1608 ;; `org-e-ascii-table--format-cell' properly aligns contents within
1609 ;; a given cell and width.
1612 "Transcode a TABLE element from Org to ASCII.
1613 CONTENTS is nil. INFO is a plist holding contextual information."
1617 ;; Possibly add a caption string above.
1619 ;; Insert table. Note: "table.el" tables are left unmodified.
1622 ;; Extract information out of the raw table (TABLE-INFO)
1623 ;; and clean it (CLEAN-TABLE).
1628 ;; Change table into lisp, much like
1629 ;; `org-table-to-lisp', though cells are parsed and
1630 ;; transcoded along the way.
1640 cell
1645 ;; Compute real column widths.
1648 ;; Construct separators according to column groups.
1650 ;; Build different `hline' strings, depending on
1651 ;; separators, column widths and position.
1654 nil separators column-widths info))
1661 ;; Now build table back, with correct alignment, considering
1662 ;; columns widths and separators.
1671 concat
1676 cell col column-widths alignment info)) into l
1677 finally return
1681 sep)))))))
1682 ;; If charset is `utf-8', make sure lisp-table always starts
1683 ;; with `hline-top' and ends with `hline-bottom'.
1688 lisp-table)))
1692 lisp-table)
1694 ;; Possible add a caption string below.
1699 "Return vector of TABLE columns width.
1701 TABLE is the Lisp representation of the Org table considered.
1702 TABLE-INFO holds information about the table. See
1703 `org-export-table-format-info'.
1705 Unlike to `:width' property from `org-export-table-format-info',
1706 the return value is a vector containing width of every column,
1707 not only those with an explicit width cookie. Special column, if
1708 any, is ignored."
1709 ;; All rows have the same length, but be sure to ignore hlines.
1715 ;; Set column width to the maximum width of the cells in that
1716 ;; column.
1725 line))))
1726 table)
1728 ;; When colums are not widened, width cookies have precedence
1729 ;; over string lengths. Thus, overwrite the latter with the
1730 ;; former.
1733 ;; Remove special column from COOKIES vector, if any.
1735 for idx from 0 to width
1737 ;; Return value.
1738 width))
1741 "Return a vector of strings for vertical separators.
1743 TABLE-INFO holds information about considered table. See
1744 `org-export-table-format-info'.
1746 Return value is a vector whose length is one more than the number
1747 of columns in the table. Special column, if any, is ignored."
1759 colgroups)
1760 ;; Remove unneeded special column.
1765 "Format CELL with column width and alignment constraints.
1767 CELL is the contents of the cell, as a string.
1769 COL is the column containing the cell considered.
1771 WIDTH is a vector holding every column width, as returned by
1772 `org-e-ascii-table--column-width'.
1774 ALIGNMENT is a vector containing alignment strings for every
1775 column.
1777 INFO is a plist used as a communication channel."
1780 ;; When CELL is too large, it has to be truncated.
1790 ;; Return aligned cell, with missing white spaces added and
1791 ;; space separators between columns.
1793 " %s "
1798 "Return string used as an horizontal line in tables.
1800 POSITION is a symbol among `top', `bottom' and nil, which
1801 specifies position of the horizontal line within the table.
1803 SEPARATORS is a vector strings specifying separators used in the
1804 table, as returned by `org-e-ascii-table--vertical-separators'.
1806 COLUMN-WIDTHS is a vector of numbers specifying widths of all
1807 columns in the table, as returned by
1808 `org-e-ascii-table--column-width'.
1810 INFO is a plist used as a communication channel."
1813 for width across column-widths
1814 concat
1826 ;; Hline has to cover all the cell and both white spaces
1827 ;; between columns.
1832 into hline
1833 finally return
1834 ;; There is one separator more than columns, so handle it
1835 ;; here.
1837 hline
1846 ;;;; Target
1849 "Transcode a TARGET object from Org to ASCII.
1850 CONTENTS is the contents of the target. INFO is a plist holding
1851 contextual information."
1852 contents)
1855 ;;;; Time-stamp
1858 "Transcode a TIME-STAMP object from Org to ASCII.
1859 CONTENTS is nil. INFO is a plist holding contextual information."
1860 ;; Return time-stamps as-is.
1864 ;;;; Verbatim
1867 "Return a VERBATIM object from Org to ASCII.
1868 CONTENTS is nil. INFO is a plist holding contextual information."
1873 ;;;; Verse Block
1876 "Transcode a VERSE-BLOCK element from Org to ASCII.
1877 CONTENTS is nil. INFO is a plist holding contextual information."
1884 org-e-ascii-quote-margin)))
1886 \f
1887 ;;; Filter
1890 "Filter controlling number of blank lines after an headline.
1892 HEADLINE is a string representing a transcoded headline.
1893 BACK-END is symbol specifying back-end used for export. INFO is
1894 plist containing the communication channel.
1896 This function only applies to `e-ascii' back-end. See
1897 `org-e-ascii-headline-spacing' for information.
1899 For any other back-end, HEADLINE is returned as-is."
1905 \f
1906 ;;; Interactive function
1910 "Export current buffer to a text file.
1912 If narrowing is active in the current buffer, only export its
1913 narrowed part.
1915 If a region is active, export that region.
1917 When optional argument SUBTREEP is non-nil, export the sub-tree
1918 at point, extracting information from the headline properties
1919 first.
1921 When optional argument VISIBLE-ONLY is non-nil, don't export
1922 contents of hidden elements.
1924 When optional argument BODY-ONLY is non-nil, strip title, table
1925 of contents and footnote definitions from output.
1927 EXT-PLIST, when provided, is a property list with external
1928 parameters overriding Org default settings, but still inferior to
1929 file-local settings.
1931 When optional argument PUB-DIR is set, use it as the publishing
1932 directory.
1934 Return output file's name."
1942 ;;; org-e-ascii.el ends here