| blob | 7470d5572411068ad6a8ae1276536f609aa6ed44 |
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:
73 org-export-to-file "org-export"
77 \f
78 ;;; Internal Variables
80 ;; The following setting won't allow to modify preferred charset
81 ;; through a buffer keyword or an option item, but, since the property
82 ;; will appear in communication channel nonetheless, it allows to
83 ;; override `org-e-ascii-charset' variable on the fly by the ext-plist
84 ;; mechanism.
86 ;; We also install a filter for headlines and sections, in order to
87 ;; control blank lines separating them in output string.
91 )
92 "Alist between ASCII export properties and ways to set them.
93 See `org-export-option-alist' for more information on the
99 "Alist between filters keywords and back-end specific filters.
193 "Dictionary for ASCII back-end.
195 Alist whose car is the string to translate and cdr is an alist
196 whose car is the language string and cdr is a plist whose
197 properties are possible charsets and value the translated term.
202 \f
203 ;;; User Configurable Variables
206 "Options for exporting Org mode files to ASCII."
211 "Maximum width of exported text.
212 This number includes margin size, as set in
213 `org-e-ascii-global-margin'."
218 "Width of the left margin, in number of characters."
223 "Width of the inner margin, in number of characters.
224 Inner margin is applied between each headline."
229 "Width of margin used for quoting text, in characters.
230 This margin is applied on both sides of the text."
235 "Width of inline tasks, in number of characters.
236 This number ignores any margin."
241 "Number of blank lines inserted around headlines.
243 This variable can be set to a cons cell. In that case, its car
244 represents the number of blank lines present before headline
245 contents whereas its cdr reflects the number of blank lines after
246 contents.
248 A nil value replicates the number of blank lines found in the
249 original Org buffer at the same place."
258 "The charset allowed to represent various elements and objects.
259 Possible values are:
260 `ascii' Only use plain ASCII characters
261 `latin1' Include Latin-1 characters
262 `utf-8' Use all UTF-8 characters"
272 "Characters for underlining headings in ASCII export.
274 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
275 and whose value is a list of characters.
277 For each supported charset, this variable associates a sequence
278 of underline characters. In a sequence, the characters will be
279 used in order for headlines level 1, 2, ... If no character is
280 available for a given level, the headline won't be underlined."
296 "Bullet characters for headlines converted to lists in ASCII export.
298 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
299 and whose value is a list of characters.
301 The first character is used for the first level considered as low
302 level, and so on. If there are more levels than characters given
303 here, the list will be repeated.
305 Note that this variable doesn't affect plain lists
306 representation."
320 "Non-nil means convert links to notes before the next headline.
321 When nil, the link will be exported in place. If the line
322 becomes long in this way, it will be wrapped."
327 "Non-nil means keep all vertical lines in ASCII tables.
328 When nil, vertical lines will be removed except for those needed
329 for column grouping."
334 "Non-nil means widen narrowed columns for export.
335 When nil, narrowed columns will look in ASCII export just like in
341 "When non-nil, place caption string before the element.
342 Otherwise, place it right after it."
347 "Format string used for verbatim text and inline code."
352 "Function called to format a drawer in ASCII.
354 The function must accept two parameters:
356 CONTENTS the contents of the drawer.
357 WIDTH the text width within the drawer.
359 The function should return either the string to be exported or
360 nil to ignore the drawer.
362 For example, the variable could be set to the following function
363 in order to mimic default behaviour:
365 \(defun org-e-ascii-format-drawer-default \(name contents width\)
367 contents\)"
372 "Function called to format an inlinetask in ASCII.
374 The function must accept six parameters:
375 TODO the todo keyword, as a string
376 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
377 PRIORITY the inlinetask priority, as a string
378 NAME the inlinetask name, as a string.
379 TAGS the inlinetask tags, as a string.
380 CONTENTS the contents of the inlinetask, as a string.
382 The function should return either the string to be exported or
383 nil to ignore the inline task.
385 For example, the variable could be set to the following function
386 in order to mimic default behaviour:
388 \(defun org-e-ascii-format-inlinetask-default
389 \(todo type priority name tags contents\)
391 \(let* \(\(utf8p \(eq \(plist-get info :ascii-charset\) 'utf-8\)\)
392 \(width org-e-ascii-inlinetask-width\)
393 \(org-e-ascii--indent-string
394 \(concat
395 ;; Top line, with an additional blank line if not in UTF-8.
398 ;; Add title. Fill it if wider than inlinetask.
399 \(let \(\(title \(org-e-ascii--build-title inlinetask info width\)\)\)
400 \(if \(<= \(length title\) width\) title
401 \(org-e-ascii--fill-string title width info\)\)\)
403 ;; If CONTENTS is not empty, insert it along with
404 ;; a separator.
405 \(when \(org-string-nw-p contents\)
407 ;; Bottom line.
408 \(make-string width \(if utf8p ?━ ?_\)\)\)
409 ;; Flush the inlinetask to the right.
410 \(- \(plist-get info :ascii-width\)
411 \(plist-get info :ascii-margin\)
412 \(plist-get info :ascii-inner-margin\)
413 \(org-e-ascii--current-text-width inlinetask info\)\)"
418 \f
419 ;;; Internal Functions
421 ;; Internal functions fall into three categories.
423 ;; The first one is about text formatting. The core function is
424 ;; `org-e-ascii--current-text-width', which determines the current
425 ;; text width allowed to a given element. In other words, it helps
426 ;; keeping each line width within maximum text width defined in
427 ;; `org-e-ascii-text-width'. Once this information is known,
428 ;; `org-e-ascii--fill-string', `org-e-ascii--justify-string',
429 ;; `org-e-ascii--box-string' and `org-e-ascii--indent-string' can
430 ;; operate on a given output string.
432 ;; The second category contains functions handling elements listings,
433 ;; triggered by "#+TOC:" keyword. As such, `org-e-ascii--build-toc'
434 ;; returns a complete table of contents, `org-e-ascii--list-listings'
435 ;; returns a list of referenceable src-block elements, and
436 ;; `org-e-ascii--list-tables' does the same for table elements.
438 ;; The third category includes general helper functions.
439 ;; `org-e-ascii--build-title' creates the title for a given headline
440 ;; or inlinetask element. `org-e-ascii--build-caption' returns the
441 ;; caption string associated to a table or a src-block.
442 ;; `org-e-ascii--describe-links' creates notes about links for
443 ;; insertion at the end of a section. It uses
444 ;; `org-e-ascii--unique-links' to get the list of links to describe.
445 ;; Eventually, `org-e-ascii--translate' reads `org-e-ascii-dictionary'
446 ;; to internationalize output.
450 "Fill a string with specified text-width and return it.
452 S is the string being filled. TEXT-WIDTH is an integer
453 specifying maximum length of a line. INFO is the plist used as
454 a communication channel.
456 Optional argument JUSTIFY can specify any type of justification
457 among `left', `center', `right' or `full'. A nil value is
458 equivalent to `left'. For a justification that doesn't also fill
459 string, see `org-e-ascii--justify-string'.
461 Return nil if S isn't a string."
462 ;; Don't fill paragraph when break should be preserved.
473 "Justify string S.
474 TEXT-WIDTH is an integer specifying maximum length of a line.
475 HOW determines the type of justification: it can be `left',
476 `right', `full' or `center'."
487 "Indent string S by WIDTH white spaces.
488 Empty lines are not indented."
494 "Return string S with a partial box to its left.
495 INFO is a plist used as a communicaton channel."
500 ;; Remove last newline character.
504 "Return maximum text width for ELEMENT's contents.
505 INFO is a plist used as a communication channel."
507 ;; Elements with an absolute width: `headline' and `inlinetask'.
509 ('headline
513 ;; Elements with a relative width: store maximum text width in
514 ;; TOTAL-WIDTH.
517 ;; Total width is determined by the presence, or not, of an
518 ;; inline task among ELEMENT parents.
522 org-e-ascii-inlinetask-width
523 ;; No inlinetask: Remove global margin from text width.
525 org-e-ascii-global-margin
527 ;; Inner margin doesn't apply to text before first
528 ;; headline.
532 ;; Inner margin doesn't apply to contents of
533 ;; low level headlines, since they've got their
534 ;; own indentation mechanism.
536 org-e-ascii-inner-margin))))))))
538 ;; Each `quote-block', `quote-section' and `verse-block' above
539 ;; narrows text width by twice the standard margin size.
543 count parent)
545 ;; Text width within a plain-list is restricted by
546 ;; indentation of current item. If that's the case,
547 ;; compute it with the help of `:structure' property from
548 ;; parent item, if any.
553 return parent))))
555 ;; Compute indentation offset of the current item,
556 ;; that is the sum of the difference between its
557 ;; indentation and the indentation of the top item in
558 ;; the list and current item bullet's length. Also
559 ;; remove tag length (for description lists) or bullet
560 ;; length.
572 "Format ELEMENT title and return it.
574 ELEMENT is either an `headline' or `inlinetask' element. INFO is
575 a plist used as a communication channel. TEXT-WIDTH is an
576 integer representing the maximum length of a line.
578 When optional argument UNDERLINE is non-nil, underline title,
579 without the tags, according to `org-e-ascii-underline'
580 specifications.
582 if optional argument NOTAGS is nil, no tags will be added to the
583 title."
586 ;; Numbering is specific to headlines.
588 ;; All tests passed: build numbering string.
591 #'number-to-string
610 first-part
611 ;; Align tags, if any.
616 tags))
617 ;; Maybe underline text, if ELEMENT type is `headline' and an
618 ;; underline character has been defined.
623 org-e-ascii-underline)))))
629 "Return caption string for ELEMENT, if applicable.
631 INFO is a plist used as a communication channel.
633 The caption string contains the sequence number of ELEMENT if it
634 has a name affiliated keyword, along with the real caption, if
635 any. Return nil when ELEMENT has no affiliated caption or name
636 keyword."
640 ;; Get sequence number of current src-block among every
641 ;; src-block with either a caption or a name.
644 element info nil
653 title-fmt reference
659 "Return a table of contents.
661 INFO is a plist used as a communication channel.
663 Optional argument N, when non-nil, is an integer specifying the
664 depth of the table.
666 Optional argument KEYWORD specifies the TOC keyword, if any, from
667 which the table of contents generation has been initiated."
670 title
689 "Return a list of listings.
691 KEYWORD is the keyword that initiated the list of listings
692 generation. INFO is a plist used as a communication channel."
695 title
702 ;; Use a counter instead of retreiving ordinal of each
703 ;; src-block.
707 ;; Store initial text so its length can be computed. This is
708 ;; used to properly align caption right to it in case of
709 ;; filling (like contents of a description list item).
714 initial-text
721 ;; Use short name in priority, if available.
728 "Return a list of listings.
730 KEYWORD is the keyword that initiated the list of listings
731 generation. INFO is a plist used as a communication channel."
734 title
741 ;; Use a counter instead of retreiving ordinal of each
742 ;; src-block.
746 ;; Store initial text so its length can be computed. This is
747 ;; used to properly align caption right to it in case of
748 ;; filling (like contents of a description list item).
753 initial-text
759 ;; Use short name in priority, if available.
767 "Return a list of unique link references in ELEMENT.
769 ELEMENT is either an headline element or a section element. INFO
770 is a plist used as a communication channel.
772 It covers links that may be found current headline's title, in
773 the following section and in any inlinetask's title there."
777 ;; Return LINK if it wasn't referenced so far, or nil.
778 ;; Update SEEN links along the way.
787 ;; Return a list of all unique links in ELEMENT. ELEMENT
788 ;; may be an headline or an inlinetask element.
795 ;; Retrieve HEADLINE's section, if it exists.
802 ;; Links that may be in HEADLINE's title.
804 ;; Get all links in SECTION.
809 "Return a string describing a list of links.
811 LINKS is a list of link type objects, as returned by
812 `org-e-ascii--unique-links'. WIDTH is the text width allowed for
813 the output string. INFO is a plist used as a communication
814 channel."
822 ;; Coderefs, radio links and fuzzy links are ignored.
824 ;; Id and custom-id links: Headlines refer to their numbering.
830 "[%s] %s"
831 anchor
838 ;; Do not add a link that cannot be resolved and doesn't have
839 ;; any description: destination is already visible in the
840 ;; paragraph.
846 width info)
851 \f
852 ;;; Template
855 "Return document title, as a string.
856 INFO is a plist used as a communication channel."
869 ;; There are two types of title blocks depending on the presence
870 ;; of a title to display.
872 ;; Title block without a title. DATE is positioned at the top
873 ;; right of the document, AUTHOR to the top left and EMAIL
874 ;; just below.
878 author
880 date
885 email
896 ;; Title block with a title. Document's TITLE, along with the
897 ;; AUTHOR and its EMAIL are both overlined and an underlined,
898 ;; centered. Date is just below, also centered.
900 ;; Format TITLE. It may be filled if it is too wide,
901 ;; that is wider than the two thirds of the total width.
924 "Return complete document string after ASCII conversion.
925 CONTENTS is the transcoded contents string. INFO is a plist
926 holding export options."
930 ;; 1. Build title block.
933 ;; 2. Table of contents.
939 ;; 3. Document's body.
940 contents
941 ;; 4. Footnote definitions.
944 ;; Insert full links right inside the footnote definition
945 ;; as they have no chance to be inserted later.
952 title
960 ;; Distinguish between inline definitions and
961 ;; full-fledged definitions.
965 ;; Full-fledged definition: footnote ID is
966 ;; inserted inside the first parsed paragraph
967 ;; (FIRST), if any, to be sure filling will
968 ;; take it into consideration.
974 ;; Fill paragraph once footnote ID is inserted in
975 ;; order to have a correct length for first line.
978 text-width info))))))
980 ;; 5. Creator. Ignore `comment' value as there are no comments in
981 ;; ASCII. Justify it to the bottom right.
988 org-e-ascii-global-margin)))
991 "Translate string S.
993 INFO is a plist used as a communication channel.
995 Translation depends on `:language' property and allowed charset.
996 If no translation in found for a given language and a given
997 charset, fall-back to S."
1004 \f
1005 ;;; Transcode Functions
1007 ;;;; Babel Call
1009 ;; Babel Calls are ignored.
1012 ;;;; Center Block
1015 "Transcode a CENTER-BLOCK element from Org to ASCII.
1016 CONTENTS holds the contents of the block. INFO is a plist
1017 holding contextual information."
1022 ;;;; Comment
1024 ;; Comments are ignored.
1027 ;;;; Comment Block
1029 ;; Comment Blocks are ignored.
1032 ;;;; Drawer
1035 "Transcode a DRAWER element from Org to ASCII.
1036 CONTENTS holds the contents of the block. INFO is a plist
1037 holding contextual information."
1042 ;; If there's no user defined function: simply
1043 ;; display contents of the drawer.
1044 contents)))
1047 ;;;; Dynamic Block
1050 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1051 CONTENTS holds the contents of the block. INFO is a plist
1052 holding contextual information. See
1053 `org-export-data'."
1054 contents)
1057 ;;;; Emphasis
1060 "Transcode EMPHASIS from Org to ASCII.
1061 CONTENTS is the contents of the emphasized text. INFO is a plist
1062 holding contextual information.."
1064 ;; Leave emphasis markers as-is.
1068 ;;;; Entity
1071 "Transcode an ENTITY object from Org to ASCII.
1072 CONTENTS are the definition itself. INFO is a plist holding
1073 contextual information."
1076 entity))
1079 ;;;; Example Block
1082 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1083 CONTENTS is nil. INFO is a plist holding contextual information."
1088 ;;;; Export Snippet
1091 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1092 CONTENTS is nil. INFO is a plist holding contextual information."
1097 ;;;; Export Block
1100 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1101 CONTENTS is nil. INFO is a plist holding contextual information."
1106 ;;;; Fixed Width
1109 "Transcode a FIXED-WIDTH element from Org to ASCII.
1110 CONTENTS is nil. INFO is a plist holding contextual information."
1116 ;;;; Footnote Definition
1118 ;; Footnote Definitions are ignored. They are compiled at the end of
1119 ;; the document, by `org-e-ascii-template'.
1122 ;;;; Footnote Reference
1125 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1126 CONTENTS is nil. INFO is a plist holding contextual information."
1130 ;;;; Headline
1133 "Transcode an HEADLINE element from Org to ASCII.
1134 CONTENTS holds the contents of the headline. INFO is a plist
1135 holding contextual information."
1136 ;; Don't export footnote section, which will be handled at the end
1137 ;; of the template.
1141 ;; Blank lines between headline and its contents.
1142 ;; `org-e-ascii-headline-spacing', when set, overwrites
1143 ;; original buffer's spacing.
1148 ;; Even if HEADLINE has no section, there might be some
1149 ;; links in its title that we shouldn't forget to describe.
1154 ;; Deep subtree: export it as a list item.
1157 ;; Bullet.
1159 org-e-ascii-bullets))))
1162 " "
1163 ;; Title.
1165 ;; Contents, indented by length of bullet.
1166 pre-blanks
1171 ;; Else: Standard headline.
1178 ;;;; Horizontal Rule
1181 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1182 CONTENTS is nil. INFO is a plist holding contextual
1183 information."
1187 "(%s)"
1189 #'identity
1198 ;;;; Inline Babel Call
1200 ;; Inline Babel Calls are ignored.
1203 ;;;; Inline Src Block
1206 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1207 CONTENTS holds the contents of the item. INFO is a plist holding
1208 contextual information."
1213 ;;;; Inlinetask
1216 "Transcode an INLINETASK element from Org to ASCII.
1217 CONTENTS holds the contents of the block. INFO is a plist
1218 holding contextual information."
1232 ;; If `org-e-ascii-format-inlinetask-function' is provided, call it
1233 ;; with appropriate arguments.
1236 todo todo-type priority title tags contents width)
1237 ;; Otherwise, use a default template.
1241 ;; Top line, with an additional blank line if not in UTF-8.
1244 ;; Add title. Fill it if wider than inlinetask.
1249 ;; If CONTENTS is not empty, insert it along with
1250 ;; a separator.
1253 ;; Bottom line.
1255 ;; Flush the inlinetask to the right.
1258 org-e-ascii-inner-margin)
1262 ;;;; Item
1265 "Transcode an ITEM element from Org to ASCII.
1266 CONTENTS holds the contents of the item. INFO is a plist holding
1267 contextual information."
1269 ;; First parent of ITEM is always the plain-list. Get
1270 ;; `:type' property from it.
1278 ;; Return correct number for ITEM, paying attention to
1279 ;; counters.
1286 struct
1291 ;; Change bullets into more visible form if UTF-8 is active.
1299 bullet
1300 ;; Contents: Pay attention to indentation. Note: check-boxes are
1301 ;; already taken care of at the paragraph level so they don't
1302 ;; interfere with indentation.
1309 ;;;; Keyword
1312 "Transcode a KEYWORD element from Org to ASCII.
1313 CONTENTS is nil. INFO is a plist holding contextual
1314 information."
1334 ;;;; Latex Environment
1337 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1338 CONTENTS is nil. INFO is a plist holding contextual
1339 information."
1343 ;;;; Latex Fragment
1346 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1347 CONTENTS is nil. INFO is a plist holding contextual
1348 information."
1352 ;;;; Line Break
1355 "Transcode a LINE-BREAK object from Org to ASCII.
1356 CONTENTS is nil. INFO is a plist holding contextual
1360 ;;;; Link
1363 "Transcode a LINK object from Org to ASCII.
1365 DESC is the description part of the link, or the empty string.
1366 INFO is a plist holding contextual information."
1374 ;; Do not apply a special syntax on radio links. Though, parse
1375 ;; and transcode path to have a proper display of contents.
1382 ;; Do not apply a special syntax on fuzzy links pointing to
1383 ;; targets.
1386 ;; Ignore invisible "#+target: path".
1401 ;;;; Macro
1404 "Transcode a MACRO element from Org to ASCII.
1405 CONTENTS is nil. INFO is a plist holding contextual
1406 information."
1410 ;;;; Paragraph
1413 "Transcode a PARAGRAPH element from Org to ASCII.
1414 CONTENTS is the contents of the paragraph, as a string. INFO is
1415 the plist used as a communication channel."
1418 ;; If PARAGRAPH is the first one in a list element, be sure to
1419 ;; add the check-box in front of it, before any filling. Later,
1420 ;; it would interfere with line width.
1428 contents))
1429 contents))
1433 ;;;; Plain List
1436 "Transcode a PLAIN-LIST element from Org to ASCII.
1437 CONTENTS is the contents of the list. INFO is a plist holding
1438 contextual information."
1439 contents)
1442 ;;;; Plain Text
1445 "Transcode a TEXT string from Org to ASCII.
1446 INFO is a plist used as a communication channel."
1449 text
1450 ;; Usual replacements in utf-8 with proper option set.
1458 ;;;; Property Drawer
1461 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1462 CONTENTS is nil. INFO is a plist used as a communication
1463 channel."
1464 ;; The property drawer isn't exported but we want separating blank
1465 ;; lines nonetheless.
1469 ;;;; Quote Block
1472 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1473 CONTENTS holds the contents of the block. INFO is a plist
1474 holding contextual information."
1479 org-e-ascii-quote-margin)))
1482 ;;;; Quote Section
1485 "Transcode a QUOTE-SECTION element from Org to ASCII.
1486 CONTENTS is nil. INFO is a plist holding contextual information."
1493 value
1494 (+ org-e-ascii-quote-margin
1495 ;; Don't apply inner margin if parent headline is low level.
1498 org-e-ascii-inner-margin))))))
1501 ;;;; Radio Target
1504 "Transcode a RADIO-TARGET object from Org to ASCII.
1505 CONTENTS is the contents of the target. INFO is a plist holding
1506 contextual information."
1507 contents)
1509 ;;;; Section
1512 "Transcode a SECTION element from Org to ASCII.
1513 CONTENTS is the contents of the section. INFO is a plist holding
1514 contextual information."
1517 contents
1519 ;; Add list of links at the end of SECTION.
1523 ;; Separate list of links and section contents.
1525 ;; Do not apply inner margin if parent headline is low level.
1528 org-e-ascii-inner-margin))))
1531 ;;;; Special Block
1534 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1535 CONTENTS holds the contents of the block. INFO is a plist
1536 holding contextual information."
1537 contents)
1540 ;;;; Src Block
1543 "Transcode a SRC-BLOCK element from Org to ASCII.
1544 CONTENTS holds the contents of the item. INFO is a plist holding
1545 contextual information."
1554 ;;;; Statistics Cookie
1557 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1558 CONTENTS is nil. INFO is a plist holding contextual information."
1562 ;;;; Subscript
1565 "Transcode a SUBSCRIPT object from Org to ASCII.
1566 CONTENTS is the contents of the object. INFO is a plist holding
1567 contextual information."
1573 ;;;; Superscript
1576 "Transcode a SUPERSCRIPT object from Org to ASCII.
1577 CONTENTS is the contents of the object. INFO is a plist holding
1578 contextual information."
1584 ;;;; Table
1586 ;; While `org-e-ascii-table' is the callback function expected by
1587 ;; org-export mechanism, it requires four subroutines to display
1588 ;; tables accordingly to chosen charset, alignment and width
1589 ;; specifications.
1591 ;; Thus, `org-e-ascii-table--column-width' computes the display width
1592 ;; for each column in the table,
1593 ;; `org-e-ascii-table--vertical-separators' returns a vector
1594 ;; containing separators (or lack thereof),
1595 ;; `org-e-ascii-table--build-hline' creates various hline strings,
1596 ;; depending on charset, separators and position within the tabl and
1597 ;; `org-e-ascii-table--format-cell' properly aligns contents within
1598 ;; a given cell and width.
1601 "Transcode a TABLE element from Org to ASCII.
1602 CONTENTS is nil. INFO is a plist holding contextual information."
1606 ;; Possibly add a caption string above.
1608 ;; Insert table. Note: "table.el" tables are left unmodified.
1611 ;; Extract information out of the raw table (TABLE-INFO)
1612 ;; and clean it (CLEAN-TABLE).
1617 ;; Change table into lisp, much like
1618 ;; `org-table-to-lisp', though cells are parsed and
1619 ;; transcoded along the way.
1629 cell
1634 ;; Compute real column widths.
1637 ;; Construct separators according to column groups.
1639 ;; Build different `hline' strings, depending on
1640 ;; separators, column widths and position.
1643 nil separators column-widths info))
1650 ;; Now build table back, with correct alignment, considering
1651 ;; columns widths and separators.
1660 concat
1665 cell col column-widths alignment info)) into l
1666 finally return
1670 sep)))))))
1671 ;; If charset is `utf-8', make sure lisp-table always starts
1672 ;; with `hline-top' and ends with `hline-bottom'.
1677 lisp-table)))
1681 lisp-table)
1683 ;; Possible add a caption string below.
1688 "Return vector of TABLE columns width.
1690 TABLE is the Lisp representation of the Org table considered.
1691 TABLE-INFO holds information about the table. See
1692 `org-export-table-format-info'.
1694 Unlike to `:width' property from `org-export-table-format-info',
1695 the return value is a vector containing width of every column,
1696 not only those with an explicit width cookie. Special column, if
1697 any, is ignored."
1698 ;; All rows have the same length, but be sure to ignore hlines.
1704 ;; Set column width to the maximum width of the cells in that
1705 ;; column.
1714 line))))
1715 table)
1717 ;; When colums are not widened, width cookies have precedence
1718 ;; over string lengths. Thus, overwrite the latter with the
1719 ;; former.
1722 ;; Remove special column from COOKIES vector, if any.
1724 for idx from 0 to width
1726 ;; Return value.
1727 width))
1730 "Return a vector of strings for vertical separators.
1732 TABLE-INFO holds information about considered table. See
1733 `org-export-table-format-info'.
1735 Return value is a vector whose length is one more than the number
1736 of columns in the table. Special column, if any, is ignored."
1748 colgroups)
1749 ;; Remove unneeded special column.
1754 "Format CELL with column width and alignment constraints.
1756 CELL is the contents of the cell, as a string.
1758 COL is the column containing the cell considered.
1760 WIDTH is a vector holding every column width, as returned by
1761 `org-e-ascii-table--column-width'.
1763 ALIGNMENT is a vector containing alignment strings for every
1764 column.
1766 INFO is a plist used as a communication channel."
1769 ;; When CELL is too large, it has to be truncated.
1779 ;; Return aligned cell, with missing white spaces added and
1780 ;; space separators between columns.
1782 " %s "
1787 "Return string used as an horizontal line in tables.
1789 POSITION is a symbol among `top', `bottom' and nil, which
1790 specifies position of the horizontal line within the table.
1792 SEPARATORS is a vector strings specifying separators used in the
1793 table, as returned by `org-e-ascii-table--vertical-separators'.
1795 COLUMN-WIDTHS is a vector of numbers specifying widths of all
1796 columns in the table, as returned by
1797 `org-e-ascii-table--column-width'.
1799 INFO is a plist used as a communication channel."
1802 for width across column-widths
1803 concat
1815 ;; Hline has to cover all the cell and both white spaces
1816 ;; between columns.
1821 into hline
1822 finally return
1823 ;; There is one separator more than columns, so handle it
1824 ;; here.
1826 hline
1835 ;;;; Target
1837 ;; Targets are invisible.
1840 ;;;; Time-stamp
1843 "Transcode a TIME-STAMP object from Org to ASCII.
1844 CONTENTS is nil. INFO is a plist holding contextual information."
1845 ;; Return time-stamps as-is.
1849 ;;;; Verbatim
1852 "Return a VERBATIM object from Org to ASCII.
1853 CONTENTS is nil. INFO is a plist holding contextual information."
1858 ;;;; Verse Block
1861 "Transcode a VERSE-BLOCK element from Org to ASCII.
1862 CONTENTS is nil. INFO is a plist holding contextual information."
1869 org-e-ascii-quote-margin)))
1871 \f
1872 ;;; Filter
1875 "Filter controlling number of blank lines after an headline.
1877 HEADLINE is a string representing a transcoded headline.
1878 BACK-END is symbol specifying back-end used for export. INFO is
1879 plist containing the communication channel.
1881 This function only applies to `e-ascii' back-end. See
1882 `org-e-ascii-headline-spacing' for information.
1884 For any other back-end, HEADLINE is returned as-is."
1890 \f
1891 ;;; Interactive function
1895 "Export current buffer to a text file.
1897 If narrowing is active in the current buffer, only export its
1898 narrowed part.
1900 If a region is active, export that region.
1902 When optional argument SUBTREEP is non-nil, export the sub-tree
1903 at point, extracting information from the headline properties
1904 first.
1906 When optional argument VISIBLE-ONLY is non-nil, don't export
1907 contents of hidden elements.
1909 When optional argument BODY-ONLY is non-nil, strip title, table
1910 of contents and footnote definitions from output.
1912 EXT-PLIST, when provided, is a property list with external
1913 parameters overriding Org default settings, but still inferior to
1914 file-local settings.
1916 When optional argument PUB-DIR is set, use it as the publishing
1917 directory.
1919 Return output file's name."
1927 ;;; org-e-ascii.el ends here