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/>.
25 ;; This library implements an ASCII back-end for Org generic exporter.
26 ;; See Org manual for more information.
30 (eval-when-compile (require 'cl
))
34 (declare-function aa2u
"ext:ascii-art-to-unicode" ())
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
44 ;; We also install a filter for headlines and sections, in order to
45 ;; control blank lines separating them in output string.
47 (org-export-define-backend 'ascii
48 '((bold . org-ascii-bold
)
49 (center-block . org-ascii-center-block
)
50 (clock . org-ascii-clock
)
51 (code . org-ascii-code
)
52 (comment .
(lambda (&rest args
) ""))
53 (comment-block .
(lambda (&rest args
) ""))
54 (drawer . org-ascii-drawer
)
55 (dynamic-block . org-ascii-dynamic-block
)
56 (entity . org-ascii-entity
)
57 (example-block . org-ascii-example-block
)
58 (export-block . org-ascii-export-block
)
59 (export-snippet . org-ascii-export-snippet
)
60 (fixed-width . org-ascii-fixed-width
)
61 (footnote-reference . org-ascii-footnote-reference
)
62 (headline . org-ascii-headline
)
63 (horizontal-rule . org-ascii-horizontal-rule
)
64 (inline-src-block . org-ascii-inline-src-block
)
65 (inlinetask . org-ascii-inlinetask
)
66 (inner-template . org-ascii-inner-template
)
67 (italic . org-ascii-italic
)
68 (item . org-ascii-item
)
69 (keyword . org-ascii-keyword
)
70 (latex-environment . org-ascii-latex-environment
)
71 (latex-fragment . org-ascii-latex-fragment
)
72 (line-break . org-ascii-line-break
)
73 (link . org-ascii-link
)
74 (node-property . org-ascii-node-property
)
75 (paragraph . org-ascii-paragraph
)
76 (plain-list . org-ascii-plain-list
)
77 (plain-text . org-ascii-plain-text
)
78 (planning . org-ascii-planning
)
79 (property-drawer . org-ascii-property-drawer
)
80 (quote-block . org-ascii-quote-block
)
81 (radio-target . org-ascii-radio-target
)
82 (section . org-ascii-section
)
83 (special-block . org-ascii-special-block
)
84 (src-block . org-ascii-src-block
)
85 (statistics-cookie . org-ascii-statistics-cookie
)
86 (strike-through . org-ascii-strike-through
)
87 (subscript . org-ascii-subscript
)
88 (superscript . org-ascii-superscript
)
89 (table . org-ascii-table
)
90 (table-cell . org-ascii-table-cell
)
91 (table-row . org-ascii-table-row
)
92 (target . org-ascii-target
)
93 (template . org-ascii-template
)
94 (timestamp . org-ascii-timestamp
)
95 (underline . org-ascii-underline
)
96 (verbatim . org-ascii-verbatim
)
97 (verse-block . org-ascii-verse-block
))
100 '(?t
"Export to Plain Text"
101 ((?A
"As ASCII buffer"
103 (org-ascii-export-as-ascii a s v b
'(:ascii-charset ascii
))))
106 (org-ascii-export-to-ascii a s v b
'(:ascii-charset ascii
))))
107 (?L
"As Latin1 buffer"
109 (org-ascii-export-as-ascii a s v b
'(:ascii-charset latin1
))))
112 (org-ascii-export-to-ascii a s v b
'(:ascii-charset latin1
))))
113 (?U
"As UTF-8 buffer"
115 (org-ascii-export-as-ascii a s v b
'(:ascii-charset utf-8
))))
118 (org-ascii-export-to-ascii a s v b
'(:ascii-charset utf-8
))))))
119 :filters-alist
'((:filter-headline . org-ascii-filter-headline-blank-lines
)
120 (:filter-parse-tree org-ascii-filter-paragraph-spacing
121 org-ascii-filter-comment-spacing
)
122 (:filter-section . org-ascii-filter-headline-blank-lines
))
124 '((:ascii-bullets nil nil org-ascii-bullets
)
125 (:ascii-caption-above nil nil org-ascii-caption-above
)
126 (:ascii-charset nil nil org-ascii-charset
)
127 (:ascii-global-margin nil nil org-ascii-global-margin
)
128 (:ascii-format-drawer-function nil nil org-ascii-format-drawer-function
)
129 (:ascii-format-inlinetask-function
130 nil nil org-ascii-format-inlinetask-function
)
131 (:ascii-headline-spacing nil nil org-ascii-headline-spacing
)
132 (:ascii-indented-line-width nil nil org-ascii-indented-line-width
)
133 (:ascii-inlinetask-width nil nil org-ascii-inlinetask-width
)
134 (:ascii-inner-margin nil nil org-ascii-inner-margin
)
135 (:ascii-links-to-notes nil nil org-ascii-links-to-notes
)
136 (:ascii-list-margin nil nil org-ascii-list-margin
)
137 (:ascii-paragraph-spacing nil nil org-ascii-paragraph-spacing
)
138 (:ascii-quote-margin nil nil org-ascii-quote-margin
)
139 (:ascii-table-keep-all-vertical-lines
140 nil nil org-ascii-table-keep-all-vertical-lines
)
141 (:ascii-table-use-ascii-art nil nil org-ascii-table-use-ascii-art
)
142 (:ascii-table-widen-columns nil nil org-ascii-table-widen-columns
)
143 (:ascii-text-width nil nil org-ascii-text-width
)
144 (:ascii-underline nil nil org-ascii-underline
)
145 (:ascii-verbatim-format nil nil org-ascii-verbatim-format
)))
149 ;;; User Configurable Variables
151 (defgroup org-export-ascii nil
152 "Options for exporting Org mode files to ASCII."
153 :tag
"Org Export ASCII"
156 (defcustom org-ascii-text-width
72
157 "Maximum width of exported text.
158 This number includes margin size, as set in
159 `org-ascii-global-margin'."
160 :group
'org-export-ascii
162 :package-version
'(Org .
"8.0")
165 (defcustom org-ascii-global-margin
0
166 "Width of the left margin, in number of characters."
167 :group
'org-export-ascii
169 :package-version
'(Org .
"8.0")
172 (defcustom org-ascii-inner-margin
2
173 "Width of the inner margin, in number of characters.
174 Inner margin is applied between each headline."
175 :group
'org-export-ascii
177 :package-version
'(Org .
"8.0")
180 (defcustom org-ascii-quote-margin
6
181 "Width of margin used for quoting text, in characters.
182 This margin is applied on both sides of the text."
183 :group
'org-export-ascii
185 :package-version
'(Org .
"8.0")
188 (defcustom org-ascii-list-margin
0
189 "Width of margin used for plain lists, in characters.
190 This margin applies to top level list only, not to its
192 :group
'org-export-ascii
194 :package-version
'(Org .
"8.3")
197 (defcustom org-ascii-inlinetask-width
30
198 "Width of inline tasks, in number of characters.
199 This number ignores any margin."
200 :group
'org-export-ascii
202 :package-version
'(Org .
"8.0")
205 (defcustom org-ascii-headline-spacing
'(1 .
2)
206 "Number of blank lines inserted around headlines.
208 This variable can be set to a cons cell. In that case, its car
209 represents the number of blank lines present before headline
210 contents whereas its cdr reflects the number of blank lines after
213 A nil value replicates the number of blank lines found in the
214 original Org buffer at the same place."
215 :group
'org-export-ascii
217 :package-version
'(Org .
"8.0")
219 (const :tag
"Replicate original spacing" nil
)
220 (cons :tag
"Set an uniform spacing"
221 (integer :tag
"Number of blank lines before contents")
222 (integer :tag
"Number of blank lines after contents"))))
224 (defcustom org-ascii-indented-line-width
'auto
225 "Additional indentation width for the first line in a paragraph.
226 If the value is an integer, indent the first line of each
227 paragraph by this width, unless it is located at the beginning of
228 a section, in which case indentation is removed from that line.
229 If it is the symbol `auto' preserve indentation from original
231 :group
'org-export-ascii
233 :package-version
'(Org .
"8.0")
235 (integer :tag
"Number of white spaces characters")
236 (const :tag
"Preserve original width" auto
)))
238 (defcustom org-ascii-paragraph-spacing
'auto
239 "Number of white lines between paragraphs.
240 If the value is an integer, add this number of blank lines
241 between contiguous paragraphs. If is it the symbol `auto', keep
242 the same number of blank lines as in the original document."
243 :group
'org-export-ascii
245 :package-version
'(Org .
"8.0")
247 (integer :tag
"Number of blank lines")
248 (const :tag
"Preserve original spacing" auto
)))
250 (defcustom org-ascii-charset
'ascii
251 "The charset allowed to represent various elements and objects.
253 `ascii' Only use plain ASCII characters
254 `latin1' Include Latin-1 characters
255 `utf-8' Use all UTF-8 characters"
256 :group
'org-export-ascii
258 :package-version
'(Org .
"8.0")
260 (const :tag
"ASCII" ascii
)
261 (const :tag
"Latin-1" latin1
)
262 (const :tag
"UTF-8" utf-8
)))
264 (defcustom org-ascii-underline
'((ascii ?
= ?~ ?-
)
266 (utf-8 ?═ ?─ ?╌ ?┄ ?┈
))
267 "Characters for underlining headings in ASCII export.
269 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
270 and whose value is a list of characters.
272 For each supported charset, this variable associates a sequence
273 of underline characters. In a sequence, the characters will be
274 used in order for headlines level 1, 2, ... If no character is
275 available for a given level, the headline won't be underlined."
276 :group
'org-export-ascii
278 :package-version
'(Org .
"8.0")
280 (cons :tag
"Underline characters sequence"
281 (const :tag
"ASCII charset" ascii
)
283 (cons :tag
"Underline characters sequence"
284 (const :tag
"Latin-1 charset" latin1
)
286 (cons :tag
"Underline characters sequence"
287 (const :tag
"UTF-8 charset" utf-8
)
288 (repeat character
))))
290 (defcustom org-ascii-bullets
'((ascii ?
* ?
+ ?-
)
293 "Bullet characters for headlines converted to lists in ASCII export.
295 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
296 and whose value is a list of characters.
298 The first character is used for the first level considered as low
299 level, and so on. If there are more levels than characters given
300 here, the list will be repeated.
302 Note that this variable doesn't affect plain lists
304 :group
'org-export-ascii
306 :package-version
'(Org .
"8.0")
308 (cons :tag
"Bullet characters for low level headlines"
309 (const :tag
"ASCII charset" ascii
)
311 (cons :tag
"Bullet characters for low level headlines"
312 (const :tag
"Latin-1 charset" latin1
)
314 (cons :tag
"Bullet characters for low level headlines"
315 (const :tag
"UTF-8 charset" utf-8
)
316 (repeat character
))))
318 (defcustom org-ascii-links-to-notes t
319 "Non-nil means convert links to notes before the next headline.
320 When nil, the link will be exported in place. If the line
321 becomes long in this way, it will be wrapped."
322 :group
'org-export-ascii
324 :package-version
'(Org .
"8.0")
327 (defcustom org-ascii-table-keep-all-vertical-lines nil
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."
331 :group
'org-export-ascii
333 :package-version
'(Org .
"8.0")
336 (defcustom org-ascii-table-widen-columns t
337 "Non-nil means widen narrowed columns for export.
338 When nil, narrowed columns will look in ASCII export just like in
339 Org mode, i.e. with \"=>\" as ellipsis."
340 :group
'org-export-ascii
342 :package-version
'(Org .
"8.0")
345 (defcustom org-ascii-table-use-ascii-art nil
346 "Non-nil means table.el tables are turned into ascii-art.
348 It only makes sense when export charset is `utf-8'. It is nil by
349 default since it requires ascii-art-to-unicode.el package. You
350 can download it here:
352 http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
353 :group
'org-export-ascii
355 :package-version
'(Org .
"8.0")
358 (defcustom org-ascii-caption-above nil
359 "When non-nil, place caption string before the element.
360 Otherwise, place it right after it."
361 :group
'org-export-ascii
363 :package-version
'(Org .
"8.0")
366 (defcustom org-ascii-verbatim-format
"`%s'"
367 "Format string used for verbatim text and inline code."
368 :group
'org-export-ascii
370 :package-version
'(Org .
"8.0")
373 (defcustom org-ascii-format-drawer-function
374 (lambda (name contents width
) contents
)
375 "Function called to format a drawer in ASCII.
377 The function must accept three parameters:
378 NAME the drawer name, like \"LOGBOOK\"
379 CONTENTS the contents of the drawer.
380 WIDTH the text width within the drawer.
382 The function should return either the string to be exported or
383 nil to ignore the drawer.
385 The default value simply returns the value of CONTENTS."
386 :group
'org-export-ascii
388 :package-version
'(Org .
"8.0")
391 (defcustom org-ascii-format-inlinetask-function
392 'org-ascii-format-inlinetask-default
393 "Function called to format an inlinetask in ASCII.
395 The function must accept nine parameters:
396 TODO the todo keyword, as a string
397 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
398 PRIORITY the inlinetask priority, as a string
399 NAME the inlinetask name, as a string.
400 TAGS the inlinetask tags, as a list of strings.
401 CONTENTS the contents of the inlinetask, as a string.
402 WIDTH the width of the inlinetask, as a number.
403 INLINETASK the inlinetask itself.
404 INFO the info channel.
406 The function should return either the string to be exported or
407 nil to ignore the inline task."
408 :group
'org-export-ascii
410 :package-version
'(Org .
"8.3")
415 ;;; Internal Functions
417 ;; Internal functions fall into three categories.
419 ;; The first one is about text formatting. The core functions are
420 ;; `org-ascii--current-text-width' and
421 ;; `org-ascii--current-justification', which determine, respectively,
422 ;; the current text width allowed to a given element and its expected
423 ;; justification. Once this information is known,
424 ;; `org-ascii--fill-string', `org-ascii--justify-lines',
425 ;; `org-ascii--justify-element' `org-ascii--box-string' and
426 ;; `org-ascii--indent-string' can operate on a given output string.
427 ;; In particular, justification happens at the regular (i.e.,
428 ;; non-greater) element level, which means that when the exporting
429 ;; process reaches a container (e.g., a center block) content are
430 ;; already justified.
432 ;; The second category contains functions handling elements listings,
433 ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
434 ;; returns a complete table of contents, `org-ascii--list-listings'
435 ;; returns a list of referenceable src-block elements, and
436 ;; `org-ascii--list-tables' does the same for table elements.
438 ;; The third category includes general helper functions.
439 ;; `org-ascii--build-title' creates the title for a given headline
440 ;; or inlinetask element. `org-ascii--build-caption' returns the
441 ;; caption string associated to a table or a src-block.
442 ;; `org-ascii--describe-links' creates notes about links for
443 ;; insertion at the end of a section. It uses
444 ;; `org-ascii--unique-links' to get the list of links to describe.
445 ;; Eventually, `org-ascii--translate' translates a string according
446 ;; to language and charset specification.
449 (defun org-ascii--fill-string (s text-width info
&optional justify
)
450 "Fill a string with specified text-width and return it.
452 S is the string being filled. TEXT-WIDTH is an integer
453 specifying maximum length of a line. INFO is the plist used as
454 a communication channel.
456 Optional argument JUSTIFY can specify any type of justification
457 among `left', `center', `right' or `full'. A nil value is
458 equivalent to `left'. For a justification that doesn't also fill
459 string, see `org-ascii--justify-lines' and
460 `org-ascii--justify-block'.
462 Return nil if S isn't a string."
464 (let ((double-space-p sentence-end-double-space
))
466 (let ((fill-column text-width
)
467 (use-hard-newlines t
)
468 (sentence-end-double-space double-space-p
))
469 (insert (if (plist-get info
:preserve-breaks
)
470 (replace-regexp-in-string "\n" hard-newline s
)
472 (fill-region (point-min) (point-max) justify
))
475 (defun org-ascii--justify-lines (s text-width how
)
476 "Justify all lines in string S.
477 TEXT-WIDTH is an integer specifying maximum length of a line.
478 HOW determines the type of justification: it can be `left',
479 `right', `full' or `center'."
482 (goto-char (point-min))
483 (let ((fill-column text-width
)
484 ;; Disable `adaptive-fill-mode' so it doesn't prevent
485 ;; filling lines matching `adaptive-fill-regexp'.
486 (adaptive-fill-mode nil
))
487 (while (< (point) (point-max))
488 (justify-current-line how
)
492 (defun org-ascii--justify-element (contents element info
)
493 "Justify CONTENTS of ELEMENT.
494 INFO is a plist used as a communication channel. Justification
495 is done according to the type of element. More accurately,
496 paragraphs are filled and other elements are justified as blocks,
497 that is according to the widest non blank line in CONTENTS."
498 (if (not (org-string-nw-p contents
)) contents
499 (let ((text-width (org-ascii--current-text-width element info
))
500 (how (org-ascii--current-justification element
)))
502 ((eq (org-element-type element
) 'paragraph
)
503 ;; Paragraphs are treated specially as they need to be filled.
504 (org-ascii--fill-string contents text-width info how
))
505 ((eq how
'left
) contents
)
508 (goto-char (point-min))
511 ;; Compute maximum width. Bail out if it is greater
512 ;; than page width, since no justification is
516 (unless (org-looking-at-p "[ \t]*$")
518 (let ((column (current-column)))
520 ((>= column text-width
) (throw 'exit contents
))
521 ((> column max-width
) (setq max-width column
)))))
523 ;; Justify every line according to TEXT-WIDTH and
525 (let ((offset (/ (- text-width max-width
)
526 (if (eq how
'right
) 1 2))))
527 (if (zerop offset
) (throw 'exit contents
)
529 (unless (org-looking-at-p "[ \t]*$")
530 (org-indent-to-column offset
))
532 (buffer-string))))))))
534 (defun org-ascii--indent-string (s width
)
535 "Indent string S by WIDTH white spaces.
536 Empty lines are not indented."
538 (replace-regexp-in-string
539 "\\(^\\)[ \t]*\\S-" (make-string width ?\s
) s nil nil
1)))
541 (defun org-ascii--box-string (s info
)
542 "Return string S with a partial box to its left.
543 INFO is a plist used as a communication channel."
544 (let ((utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
)))
545 (format (if utf8p
"┌────\n%s\n└────" ",----\n%s\n`----")
546 (replace-regexp-in-string
547 "^" (if utf8p
"│ " "| ")
548 ;; Remove last newline character.
549 (replace-regexp-in-string "\n[ \t]*\\'" "" s
)))))
551 (defun org-ascii--current-text-width (element info
)
552 "Return maximum text width for ELEMENT's contents.
553 INFO is a plist used as a communication channel."
554 (case (org-element-type element
)
555 ;; Elements with an absolute width: `headline' and `inlinetask'.
556 (inlinetask (plist-get info
:ascii-inlinetask-width
))
558 (- (plist-get info
:ascii-text-width
)
559 (let ((low-level-rank (org-export-low-level-p element info
)))
560 (if low-level-rank
(* low-level-rank
2)
561 (plist-get info
:ascii-global-margin
)))))
562 ;; Elements with a relative width: store maximum text width in
565 (let* ((genealogy (org-element-lineage element nil t
))
566 ;; Total width is determined by the presence, or not, of an
567 ;; inline task among ELEMENT parents.
569 (if (loop for parent in genealogy
570 thereis
(eq (org-element-type parent
) 'inlinetask
))
571 (plist-get info
:ascii-inlinetask-width
)
572 ;; No inlinetask: Remove global margin from text width.
573 (- (plist-get info
:ascii-text-width
)
574 (plist-get info
:ascii-global-margin
)
575 (let ((parent (org-export-get-parent-headline element
)))
576 ;; Inner margin doesn't apply to text before first
579 (let ((low-level-rank
580 (org-export-low-level-p parent info
)))
581 ;; Inner margin doesn't apply to contents of
582 ;; low level headlines, since they've got their
583 ;; own indentation mechanism.
584 (if low-level-rank
(* low-level-rank
2)
585 (plist-get info
:ascii-inner-margin
)))))))))
587 ;; Each `quote-block' and `verse-block' above narrows text
588 ;; width by twice the standard margin size.
589 (+ (* (loop for parent in genealogy
590 when
(memq (org-element-type parent
)
591 '(quote-block verse-block
))
593 2 (plist-get info
:ascii-quote-margin
))
594 ;; Apply list margin once per "top-level" plain-list
595 ;; containing current line
597 (dolist (e genealogy count
)
598 (and (eq (org-element-type e
) 'plain-list
)
599 (not (eq (org-element-type (org-export-get-parent e
))
602 (plist-get info
:ascii-list-margin
))
603 ;; Text width within a plain-list is restricted by
604 ;; indentation of current item. If that's the case,
605 ;; compute it with the help of `:structure' property from
606 ;; parent item, if any.
608 (if (eq (org-element-type element
) 'item
) element
609 (loop for parent in genealogy
610 when
(eq (org-element-type parent
) 'item
)
612 (if (not parent-item
) 0
613 ;; Compute indentation offset of the current item,
614 ;; that is the sum of the difference between its
615 ;; indentation and the indentation of the top item in
616 ;; the list and current item bullet's length. Also
617 ;; remove checkbox length, and tag length (for
618 ;; description lists) or bullet length.
619 (let ((struct (org-element-property :structure parent-item
))
620 (beg-item (org-element-property :begin parent-item
)))
621 (+ (- (org-list-get-ind beg-item struct
)
623 (org-list-get-top-point struct
) struct
))
624 (string-width (or (org-ascii--checkbox parent-item info
)
627 (or (org-list-get-tag beg-item struct
)
628 (org-list-get-bullet beg-item struct
)))))))))))))
630 (defun org-ascii--current-justification (element)
631 "Return expected justification for ELEMENT's contents.
632 Return value is a symbol among `left', `center', `right' and
635 (while (and (not justification
)
636 (setq element
(org-element-property :parent element
)))
637 (case (org-element-type element
)
638 (center-block (setq justification
'center
))
640 (let ((name (org-element-property :type element
)))
641 (cond ((string= name
"JUSTIFYRIGHT") (setq justification
'right
))
642 ((string= name
"JUSTIFYLEFT") (setq justification
'left
)))))))
643 (or justification
'left
)))
645 (defun org-ascii--build-title
646 (element info text-width
&optional underline notags toc
)
647 "Format ELEMENT title and return it.
649 ELEMENT is either an `headline' or `inlinetask' element. INFO is
650 a plist used as a communication channel. TEXT-WIDTH is an
651 integer representing the maximum length of a line.
653 When optional argument UNDERLINE is non-nil, underline title,
654 without the tags, according to `org-ascii-underline'
657 If optional argument NOTAGS is non-nil, no tags will be added to
660 When optional argument TOC is non-nil, use optional title if
661 possible. It doesn't apply to `inlinetask' elements."
662 (let* ((headlinep (eq (org-element-type element
) 'headline
))
664 ;; Numbering is specific to headlines.
665 (and headlinep
(org-export-numbered-headline-p element info
)
666 ;; All tests passed: build numbering string.
670 (org-export-get-headline-number element info
) ".")
675 (if (and toc headlinep
) (org-export-get-alt-title element info
)
676 (org-element-property :title element
))
679 (and (plist-get info
:with-todo-keywords
)
680 (let ((todo (org-element-property :todo-keyword element
)))
681 (and todo
(concat (org-export-data todo info
) " ")))))
682 (tags (and (not notags
)
683 (plist-get info
:with-tags
)
684 (let ((tag-list (org-export-get-tags element info
)))
687 (mapconcat 'identity tag-list
":"))))))
689 (and (plist-get info
:with-priority
)
690 (let ((char (org-element-property :priority element
)))
691 (and char
(format "(#%c) " char
)))))
692 (first-part (concat numbers todo priority text
)))
695 ;; Align tags, if any.
699 (max (- text-width
(1+ (string-width first-part
)))
700 (string-width tags
)))
702 ;; Maybe underline text, if ELEMENT type is `headline' and an
703 ;; underline character has been defined.
704 (when (and underline headlinep
)
706 (nth (1- (org-export-get-relative-level element info
))
707 (cdr (assq (plist-get info
:ascii-charset
)
708 (plist-get info
:ascii-underline
))))))
711 (make-string (/ (string-width first-part
)
712 (char-width under-char
))
715 (defun org-ascii--has-caption-p (element info
)
716 "Non-nil when ELEMENT has a caption affiliated keyword.
717 INFO is a plist used as a communication channel. This function
718 is meant to be used as a predicate for `org-export-get-ordinal'."
719 (org-element-property :caption element
))
721 (defun org-ascii--build-caption (element info
)
722 "Return caption string for ELEMENT, if applicable.
724 INFO is a plist used as a communication channel.
726 The caption string contains the sequence number of ELEMENT along
727 with its real caption. Return nil when ELEMENT has no affiliated
729 (let ((caption (org-export-get-caption element
)))
731 ;; Get sequence number of current src-block among every
732 ;; src-block with a caption.
734 (org-export-get-ordinal
735 element info nil
'org-ascii--has-caption-p
))
736 (title-fmt (org-ascii--translate
737 (case (org-element-type element
)
739 (src-block "Listing %d:"))
741 (org-ascii--fill-string
742 (concat (format title-fmt reference
)
744 (org-export-data caption info
))
745 (org-ascii--current-text-width element info
) info
)))))
747 (defun org-ascii--build-toc (info &optional n keyword
)
748 "Return a table of contents.
750 INFO is a plist used as a communication channel.
752 Optional argument N, when non-nil, is an integer specifying the
755 Optional argument KEYWORD specifies the TOC keyword, if any, from
756 which the table of contents generation has been initiated."
757 (let ((title (org-ascii--translate "Table of Contents" info
)))
760 (make-string (string-width title
)
761 (if (eq (plist-get info
:ascii-charset
) 'utf-8
) ?─ ?_
))
764 (if keyword
(org-ascii--current-text-width keyword info
)
765 (- (plist-get info
:ascii-text-width
)
766 (plist-get info
:ascii-global-margin
)))))
769 (let* ((level (org-export-get-relative-level headline info
))
770 (indent (* (1- level
) 3)))
772 (unless (zerop indent
) (concat (make-string (1- indent
) ?.
) " "))
773 (org-ascii--build-title
774 headline info
(- text-width indent
) nil
775 (or (not (plist-get info
:with-tags
))
776 (eq (plist-get info
:with-tags
) 'not-in-toc
))
778 (org-export-collect-headlines info n
) "\n")))))
780 (defun org-ascii--list-listings (keyword info
)
781 "Return a list of listings.
783 KEYWORD is the keyword that initiated the list of listings
784 generation. INFO is a plist used as a communication channel."
785 (let ((title (org-ascii--translate "List of Listings" info
)))
788 (make-string (string-width title
)
789 (if (eq (plist-get info
:ascii-charset
) 'utf-8
) ?─ ?_
))
792 (if keyword
(org-ascii--current-text-width keyword info
)
793 (- (plist-get info
:ascii-text-width
)
794 (plist-get info
:ascii-global-margin
))))
795 ;; Use a counter instead of retrieving ordinal of each
800 ;; Store initial text so its length can be computed. This is
801 ;; used to properly align caption right to it in case of
802 ;; filling (like contents of a description list item).
804 (format (org-ascii--translate "Listing %d:" info
)
806 (initial-width (string-width initial-text
)))
810 (org-ascii--indent-string
811 (org-ascii--fill-string
812 ;; Use short name in priority, if available.
813 (let ((caption (or (org-export-get-caption src-block t
)
814 (org-export-get-caption src-block
))))
815 (org-export-data caption info
))
816 (- text-width initial-width
) info
)
818 (org-export-collect-listings info
) "\n")))))
820 (defun org-ascii--list-tables (keyword info
)
821 "Return a list of tables.
823 KEYWORD is the keyword that initiated the list of tables
824 generation. INFO is a plist used as a communication channel."
825 (let ((title (org-ascii--translate "List of Tables" info
)))
828 (make-string (string-width title
)
829 (if (eq (plist-get info
:ascii-charset
) 'utf-8
) ?─ ?_
))
832 (if keyword
(org-ascii--current-text-width keyword info
)
833 (- (plist-get info
:ascii-text-width
)
834 (plist-get info
:ascii-global-margin
))))
835 ;; Use a counter instead of retrieving ordinal of each
840 ;; Store initial text so its length can be computed. This is
841 ;; used to properly align caption right to it in case of
842 ;; filling (like contents of a description list item).
844 (format (org-ascii--translate "Table %d:" info
)
846 (initial-width (string-width initial-text
)))
850 (org-ascii--indent-string
851 (org-ascii--fill-string
852 ;; Use short name in priority, if available.
853 (let ((caption (or (org-export-get-caption table t
)
854 (org-export-get-caption table
))))
855 (org-export-data caption info
))
856 (- text-width initial-width
) info
)
858 (org-export-collect-tables info
) "\n")))))
860 (defun org-ascii--unique-links (element info
)
861 "Return a list of unique link references in ELEMENT.
862 ELEMENT is either a headline element or a section element. INFO
863 is a plist used as a communication channel."
867 ;; Return LINK if it wasn't referenced so far, or nil.
868 ;; Update SEEN links along the way.
871 ;; Normalize description in footprints.
872 (cons (org-element-property :raw-link link
)
873 (let ((contents (org-element-contents link
)))
875 (replace-regexp-in-string
878 (org-element-interpret-data contents
))))))))
879 ;; Ignore LINK if it hasn't been translated already.
880 ;; It can happen if it is located in an affiliated
881 ;; keyword that was ignored.
882 (when (and (org-string-nw-p
883 (gethash link
(plist-get info
:exported-data
)))
884 (not (member footprint seen
)))
885 (push footprint seen
) link
)))))
886 ;; If at a section, find parent headline, if any, in order to
887 ;; count links that might be in the title.
889 (if (eq (org-element-type element
) 'headline
) element
890 (or (org-export-get-parent-headline element
) element
))))
891 ;; Get all links in HEADLINE.
892 (org-element-map headline
'link
893 (lambda (l) (funcall unique-link-p l
)) info nil nil t
)))
895 (defun org-ascii--describe-links (links width info
)
896 "Return a string describing a list of links.
898 LINKS is a list of link type objects, as returned by
899 `org-ascii--unique-links'. WIDTH is the text width allowed for
900 the output string. INFO is a plist used as a communication
904 (let ((type (org-element-property :type link
))
905 (anchor (let ((desc (org-element-contents link
)))
906 (if desc
(org-export-data desc info
)
907 (org-element-property :raw-link link
)))))
909 ;; Coderefs, radio links and fuzzy links are ignored.
910 ((member type
'("coderef" "radio" "fuzzy")) nil
)
911 ;; Id and custom-id links: Headlines refer to their numbering.
912 ((member type
'("custom-id" "id"))
913 (let ((dest (org-export-resolve-id-link link info
)))
915 (org-ascii--fill-string
919 (if (not dest
) (org-ascii--translate "Unknown reference" info
)
921 (org-ascii--translate "See section %s" info
)
922 (mapconcat 'number-to-string
923 (org-export-get-headline-number dest info
) "."))))
924 width info
) "\n\n")))
925 ;; Do not add a link that cannot be resolved and doesn't have
926 ;; any description: destination is already visible in the
928 ((not (org-element-contents link
)) nil
)
929 ;; Do not add a link already handled by custom export
931 ((let ((protocol (nth 2 (assoc type org-link-protocols
)))
932 (path (org-element-property :path link
)))
933 (and (functionp protocol
)
934 (funcall protocol
(org-link-unescape path
) anchor
'ascii
)))
938 (org-ascii--fill-string
939 (format "[%s] %s" anchor
(org-element-property :raw-link link
))
944 (defun org-ascii--checkbox (item info
)
945 "Return checkbox string for ITEM or nil.
946 INFO is a plist used as a communication channel."
947 (let ((utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
)))
948 (case (org-element-property :checkbox item
)
949 (on (if utf8p
"☑ " "[X] "))
950 (off (if utf8p
"☐ " "[ ] "))
951 (trans (if utf8p
"☒ " "[-] ")))))
957 (defun org-ascii-template--document-title (info)
958 "Return document title, as a string.
959 INFO is a plist used as a communication channel."
960 (let* ((text-width (plist-get info
:ascii-text-width
))
961 ;; Links in the title will not be resolved later, so we make
962 ;; sure their path is located right after them.
963 (info (org-combine-plists info
'(:ascii-links-to-notes nil
)))
964 (title (org-export-data (plist-get info
:title
) info
))
965 (author (and (plist-get info
:with-author
)
966 (let ((auth (plist-get info
:author
)))
967 (and auth
(org-export-data auth info
)))))
968 (email (and (plist-get info
:with-email
)
969 (org-export-data (plist-get info
:email
) info
)))
970 (date (and (plist-get info
:with-date
)
971 (org-export-data (org-export-get-date info
) info
))))
972 ;; There are two types of title blocks depending on the presence
973 ;; of a title to display.
974 (if (string= title
"")
975 ;; Title block without a title. DATE is positioned at the top
976 ;; right of the document, AUTHOR to the top left and EMAIL
979 ((and (org-string-nw-p date
) (org-string-nw-p author
))
982 (make-string (- text-width
(string-width date
) (string-width author
))
985 (when (org-string-nw-p email
) (concat "\n" email
))
987 ((and (org-string-nw-p date
) (org-string-nw-p email
))
990 (make-string (- text-width
(string-width date
) (string-width email
))
993 ((org-string-nw-p date
)
995 (org-ascii--justify-lines date text-width
'right
)
997 ((and (org-string-nw-p author
) (org-string-nw-p email
))
998 (concat author
"\n" email
"\n\n\n"))
999 ((org-string-nw-p author
) (concat author
"\n\n\n"))
1000 ((org-string-nw-p email
) (concat email
"\n\n\n")))
1001 ;; Title block with a title. Document's TITLE, along with the
1002 ;; AUTHOR and its EMAIL are both overlined and an underlined,
1003 ;; centered. Date is just below, also centered.
1004 (let* ((utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
))
1005 ;; Format TITLE. It may be filled if it is too wide,
1006 ;; that is wider than the two thirds of the total width.
1007 (title-len (min (length title
) (/ (* 2 text-width
) 3)))
1008 (formatted-title (org-ascii--fill-string title title-len info
))
1011 (min (+ (max title-len
1012 (string-width (or author
""))
1013 (string-width (or email
"")))
1015 text-width
) (if utf8p ?━ ?_
))))
1016 (org-ascii--justify-lines
1019 (upcase formatted-title
)
1021 ((and (org-string-nw-p author
) (org-string-nw-p email
))
1022 (concat (if utf8p
"\n\n\n" "\n\n") author
"\n" email
))
1023 ((org-string-nw-p author
)
1024 (concat (if utf8p
"\n\n\n" "\n\n") author
))
1025 ((org-string-nw-p email
)
1026 (concat (if utf8p
"\n\n\n" "\n\n") email
)))
1028 (when (org-string-nw-p date
) (concat "\n\n\n" date
))
1029 "\n\n\n") text-width
'center
)))))
1031 (defun org-ascii-inner-template (contents info
)
1032 "Return complete document string after ASCII conversion.
1033 CONTENTS is the transcoded contents string. INFO is a plist
1034 holding export options."
1035 (org-element-normalize-string
1036 (let ((global-margin (plist-get info
:ascii-global-margin
)))
1037 (org-ascii--indent-string
1039 ;; 1. Document's body.
1041 ;; 2. Footnote definitions.
1042 (let ((definitions (org-export-collect-footnote-definitions
1043 (plist-get info
:parse-tree
) info
))
1044 ;; Insert full links right inside the footnote definition
1045 ;; as they have no chance to be inserted later.
1046 (info (org-combine-plists info
'(:ascii-links-to-notes nil
))))
1050 (let ((title (org-ascii--translate "Footnotes" info
)))
1054 (string-width title
)
1055 (if (eq (plist-get info
:ascii-charset
) 'utf-8
) ?─ ?_
))))
1057 (let ((text-width (- (plist-get info
:ascii-text-width
)
1061 (let ((id (format "[%s] " (car ref
))))
1062 ;; Distinguish between inline definitions and
1063 ;; full-fledged definitions.
1065 (let ((def (nth 2 ref
)))
1066 (if (eq (org-element-type def
) 'org-data
)
1067 ;; Full-fledged definition: footnote ID is
1068 ;; inserted inside the first parsed
1069 ;; paragraph (FIRST), if any, to be sure
1070 ;; filling will take it into consideration.
1071 (let ((first (car (org-element-contents def
))))
1072 (if (not (eq (org-element-type first
) 'paragraph
))
1073 (concat id
"\n" (org-export-data def info
))
1074 (push id
(nthcdr 2 first
))
1075 (org-export-data def info
)))
1076 ;; Fill paragraph once footnote ID is inserted
1077 ;; in order to have a correct length for first
1079 (org-ascii--fill-string
1080 (concat id
(org-export-data def info
))
1081 text-width info
))))))
1082 definitions
"\n\n"))))))
1085 (defun org-ascii-template (contents info
)
1086 "Return complete document string after ASCII conversion.
1087 CONTENTS is the transcoded contents string. INFO is a plist
1088 holding export options."
1089 (let ((global-margin (plist-get info
:ascii-global-margin
)))
1091 ;; 1. Build title block.
1092 (org-ascii--indent-string
1093 (concat (org-ascii-template--document-title info
)
1094 ;; 2. Table of contents.
1095 (let ((depth (plist-get info
:with-toc
)))
1098 (org-ascii--build-toc info
(and (wholenump depth
) depth
))
1101 ;; 3. Document's body.
1103 ;; 4. Creator. Ignore `comment' value as there are no comments in
1104 ;; ASCII. Justify it to the bottom right.
1105 (org-ascii--indent-string
1106 (let ((creator-info (plist-get info
:with-creator
))
1107 (text-width (- (plist-get info
:ascii-text-width
) global-margin
)))
1108 (unless (or (not creator-info
) (eq creator-info
'comment
))
1111 (org-ascii--fill-string
1112 (plist-get info
:creator
) text-width info
'right
))))
1115 (defun org-ascii--translate (s info
)
1116 "Translate string S according to specified language and charset.
1117 INFO is a plist used as a communication channel."
1118 (let ((charset (intern (format ":%s" (plist-get info
:ascii-charset
)))))
1119 (org-export-translate s charset info
)))
1123 ;;; Transcode Functions
1127 (defun org-ascii-bold (bold contents info
)
1128 "Transcode BOLD from Org to ASCII.
1129 CONTENTS is the text with bold markup. INFO is a plist holding
1130 contextual information."
1131 (format "*%s*" contents
))
1136 (defun org-ascii-center-block (center-block contents info
)
1137 "Transcode a CENTER-BLOCK element from Org to ASCII.
1138 CONTENTS holds the contents of the block. INFO is a plist
1139 holding contextual information."
1140 ;; Center has already been taken care of at a lower level, so
1141 ;; there's nothing left to do.
1147 (defun org-ascii-clock (clock contents info
)
1148 "Transcode a CLOCK object from Org to ASCII.
1149 CONTENTS is nil. INFO is a plist holding contextual
1151 (org-ascii--justify-element
1152 (concat org-clock-string
" "
1153 (org-timestamp-translate (org-element-property :value clock
))
1154 (let ((time (org-element-property :duration clock
)))
1159 (org-split-string time
":"))))))
1165 (defun org-ascii-code (code contents info
)
1166 "Return a CODE object from Org to ASCII.
1167 CONTENTS is nil. INFO is a plist holding contextual
1169 (format (plist-get info
:ascii-verbatim-format
)
1170 (org-element-property :value code
)))
1175 (defun org-ascii-drawer (drawer contents info
)
1176 "Transcode a DRAWER element from Org to ASCII.
1177 CONTENTS holds the contents of the block. INFO is a plist
1178 holding contextual information."
1179 (let ((name (org-element-property :drawer-name drawer
))
1180 (width (org-ascii--current-text-width drawer info
)))
1181 (funcall (plist-get info
:ascii-format-drawer-function
)
1182 name contents width
)))
1187 (defun org-ascii-dynamic-block (dynamic-block contents info
)
1188 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1189 CONTENTS holds the contents of the block. INFO is a plist
1190 holding contextual information."
1196 (defun org-ascii-entity (entity contents info
)
1197 "Transcode an ENTITY object from Org to ASCII.
1198 CONTENTS are the definition itself. INFO is a plist holding
1199 contextual information."
1200 (org-element-property
1201 (intern (concat ":" (symbol-name (plist-get info
:ascii-charset
))))
1207 (defun org-ascii-example-block (example-block contents info
)
1208 "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
1209 CONTENTS is nil. INFO is a plist holding contextual information."
1210 (org-ascii--justify-element
1211 (org-ascii--box-string
1212 (org-export-format-code-default example-block info
) info
)
1213 example-block info
))
1218 (defun org-ascii-export-snippet (export-snippet contents info
)
1219 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1220 CONTENTS is nil. INFO is a plist holding contextual information."
1221 (when (eq (org-export-snippet-backend export-snippet
) 'ascii
)
1222 (org-element-property :value export-snippet
)))
1227 (defun org-ascii-export-block (export-block contents info
)
1228 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1229 CONTENTS is nil. INFO is a plist holding contextual information."
1230 (when (string= (org-element-property :type export-block
) "ASCII")
1231 (org-ascii--justify-element
1232 (org-element-property :value export-block
) export-block info
)))
1237 (defun org-ascii-fixed-width (fixed-width contents info
)
1238 "Transcode a FIXED-WIDTH element from Org to ASCII.
1239 CONTENTS is nil. INFO is a plist holding contextual information."
1240 (org-ascii--justify-element
1241 (org-ascii--box-string
1242 (org-remove-indentation
1243 (org-element-property :value fixed-width
)) info
)
1247 ;;;; Footnote Definition
1249 ;; Footnote Definitions are ignored. They are compiled at the end of
1250 ;; the document, by `org-ascii-inner-template'.
1253 ;;;; Footnote Reference
1255 (defun org-ascii-footnote-reference (footnote-reference contents info
)
1256 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1257 CONTENTS is nil. INFO is a plist holding contextual information."
1258 (format "[%s]" (org-export-get-footnote-number footnote-reference info
)))
1263 (defun org-ascii-headline (headline contents info
)
1264 "Transcode a HEADLINE element from Org to ASCII.
1265 CONTENTS holds the contents of the headline. INFO is a plist
1266 holding contextual information."
1267 ;; Don't export footnote section, which will be handled at the end
1269 (unless (org-element-property :footnote-section-p headline
)
1270 (let* ((low-level-rank (org-export-low-level-p headline info
))
1271 (width (org-ascii--current-text-width headline info
))
1272 ;; Blank lines between headline and its contents.
1273 ;; `org-ascii-headline-spacing', when set, overwrites
1274 ;; original buffer's spacing.
1277 (or (car (plist-get info
:ascii-headline-spacing
))
1278 (org-element-property :pre-blank headline
))
1280 ;; Even if HEADLINE has no section, there might be some
1281 ;; links in its title that we shouldn't forget to describe.
1283 (unless (or (eq (caar (org-element-contents headline
)) 'section
))
1284 (let ((title (org-element-property :title headline
)))
1286 (org-ascii--describe-links
1287 (org-ascii--unique-links title info
) width info
))))))
1288 ;; Deep subtree: export it as a list item.
1292 (let ((bullets (cdr (assq (plist-get info
:ascii-charset
)
1293 (plist-get info
:ascii-bullets
)))))
1295 (nth (mod (1- low-level-rank
) (length bullets
)) bullets
)))
1298 (org-ascii--build-title headline info width
) "\n"
1299 ;; Contents, indented by length of bullet.
1301 (org-ascii--indent-string
1303 (when (org-string-nw-p links
) (concat "\n\n" links
)))
1305 ;; Else: Standard headline.
1307 (org-ascii--build-title headline info width
'underline
)
1309 (concat (when (org-string-nw-p links
) links
) contents
))))))
1312 ;;;; Horizontal Rule
1314 (defun org-ascii-horizontal-rule (horizontal-rule contents info
)
1315 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1316 CONTENTS is nil. INFO is a plist holding contextual
1318 (let ((text-width (org-ascii--current-text-width horizontal-rule info
))
1320 (org-export-read-attribute :attr_ascii horizontal-rule
:width
)))
1321 (org-ascii--justify-lines
1322 (make-string (if (and spec-width
(string-match "^[0-9]+$" spec-width
))
1323 (string-to-number spec-width
)
1325 (if (eq (plist-get info
:ascii-charset
) 'utf-8
) ?― ?-
))
1326 text-width
'center
)))
1329 ;;;; Inline Src Block
1331 (defun org-ascii-inline-src-block (inline-src-block contents info
)
1332 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1333 CONTENTS holds the contents of the item. INFO is a plist holding
1334 contextual information."
1335 (format (plist-get info
:ascii-verbatim-format
)
1336 (org-element-property :value inline-src-block
)))
1341 (defun org-ascii-format-inlinetask-default
1342 (todo type priority name tags contents width inlinetask info
)
1343 "Format an inline task element for ASCII export.
1344 See `org-ascii-format-inlinetask-function' for a description
1346 (let* ((utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
))
1347 (width (or width
(plist-get info
:ascii-inlinetask-width
))))
1348 (org-ascii--indent-string
1350 ;; Top line, with an additional blank line if not in UTF-8.
1351 (make-string width
(if utf8p ?━ ?_
)) "\n"
1352 (unless utf8p
(concat (make-string width ?
) "\n"))
1353 ;; Add title. Fill it if wider than inlinetask.
1354 (let ((title (org-ascii--build-title inlinetask info width
)))
1355 (if (<= (string-width title
) width
) title
1356 (org-ascii--fill-string title width info
)))
1358 ;; If CONTENTS is not empty, insert it along with
1360 (when (org-string-nw-p contents
)
1361 (concat (make-string width
(if utf8p ?─ ?-
)) "\n" contents
))
1363 (make-string width
(if utf8p ?━ ?_
)))
1364 ;; Flush the inlinetask to the right.
1365 (- (plist-get info
:ascii-text-width
) (plist-get info
:ascii-global-margin
)
1366 (if (not (org-export-get-parent-headline inlinetask
)) 0
1367 (plist-get info
:ascii-inner-margin
))
1368 (org-ascii--current-text-width inlinetask info
)))))
1370 (defun org-ascii-inlinetask (inlinetask contents info
)
1371 "Transcode an INLINETASK element from Org to ASCII.
1372 CONTENTS holds the contents of the block. INFO is a plist
1373 holding contextual information."
1374 (let ((width (org-ascii--current-text-width inlinetask info
)))
1375 (funcall (plist-get info
:ascii-format-inlinetask-function
)
1377 (and (plist-get info
:with-todo-keywords
)
1378 (let ((todo (org-element-property
1379 :todo-keyword inlinetask
)))
1380 (and todo
(org-export-data todo info
))))
1382 (org-element-property :todo-type inlinetask
)
1384 (and (plist-get info
:with-priority
)
1385 (org-element-property :priority inlinetask
))
1387 (org-export-data (org-element-property :title inlinetask
) info
)
1389 (and (plist-get info
:with-tags
)
1390 (org-element-property :tags inlinetask
))
1391 ;; contents and width
1392 contents width inlinetask info
)))
1397 (defun org-ascii-italic (italic contents info
)
1398 "Transcode italic from Org to ASCII.
1399 CONTENTS is the text with italic markup. INFO is a plist holding
1400 contextual information."
1401 (format "/%s/" contents
))
1406 (defun org-ascii-item (item contents info
)
1407 "Transcode an ITEM element from Org to ASCII.
1408 CONTENTS holds the contents of the item. INFO is a plist holding
1409 contextual information."
1410 (let* ((utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
))
1411 (checkbox (org-ascii--checkbox item info
))
1412 (list-type (org-element-property :type
(org-export-get-parent item
)))
1414 ;; First parent of ITEM is always the plain-list. Get
1415 ;; `:type' property from it.
1416 (org-list-bullet-string
1420 (org-export-data (org-element-property :tag item
) info
)
1423 ;; Return correct number for ITEM, paying attention to
1425 (let* ((struct (org-element-property :structure item
))
1426 (bul (org-element-property :bullet item
))
1427 (num (number-to-string
1428 (car (last (org-list-get-item-number
1429 (org-element-property :begin item
)
1431 (org-list-prevs-alist struct
)
1432 (org-list-parents-alist struct
)))))))
1433 (replace-regexp-in-string "[0-9]+" num bul
)))
1434 (t (let ((bul (org-element-property :bullet item
)))
1435 ;; Change bullets into more visible form if UTF-8 is active.
1437 (replace-regexp-in-string
1439 (replace-regexp-in-string
1441 (replace-regexp-in-string "*" "‣" bul
))))))))))
1444 (unless (eq list-type
'descriptive
) checkbox
)
1445 ;; Contents: Pay attention to indentation. Note: check-boxes are
1446 ;; already taken care of at the paragraph level so they don't
1447 ;; interfere with indentation.
1448 (let ((contents (org-ascii--indent-string contents
(string-width bullet
))))
1449 (if (eq (org-element-type (car (org-element-contents item
))) 'paragraph
)
1451 (concat "\n" contents
))))))
1456 (defun org-ascii-keyword (keyword contents info
)
1457 "Transcode a KEYWORD element from Org to ASCII.
1458 CONTENTS is nil. INFO is a plist holding contextual
1460 (let ((key (org-element-property :key keyword
)))
1462 ((string= key
"ASCII")
1463 (org-ascii--justify-element
1464 (org-element-property :value keyword
) keyword info
))
1465 ((string= key
"TOC")
1466 (org-ascii--justify-element
1467 (let ((value (downcase (org-element-property :value keyword
))))
1469 ((string-match "\\<headlines\\>" value
)
1470 (let ((depth (or (and (string-match "[0-9]+" value
)
1471 (string-to-number (match-string 0 value
)))
1472 (plist-get info
:with-toc
))))
1473 (org-ascii--build-toc
1474 info
(and (wholenump depth
) depth
) keyword
)))
1475 ((string= "tables" value
)
1476 (org-ascii--list-tables keyword info
))
1477 ((string= "listings" value
)
1478 (org-ascii--list-listings keyword info
))))
1482 ;;;; Latex Environment
1484 (defun org-ascii-latex-environment (latex-environment contents info
)
1485 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1486 CONTENTS is nil. INFO is a plist holding contextual
1488 (when (plist-get info
:with-latex
)
1489 (org-ascii--justify-element
1490 (org-remove-indentation (org-element-property :value latex-environment
))
1491 latex-environment info
)))
1496 (defun org-ascii-latex-fragment (latex-fragment contents info
)
1497 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1498 CONTENTS is nil. INFO is a plist holding contextual
1500 (when (plist-get info
:with-latex
)
1501 (org-element-property :value latex-fragment
)))
1506 (defun org-ascii-line-break (line-break contents info
)
1507 "Transcode a LINE-BREAK object from Org to ASCII.
1508 CONTENTS is nil. INFO is a plist holding contextual
1509 information." hard-newline
)
1514 (defun org-ascii-link (link desc info
)
1515 "Transcode a LINK object from Org to ASCII.
1517 DESC is the description part of the link, or the empty string.
1518 INFO is a plist holding contextual information."
1519 (let ((type (org-element-property :type link
)))
1521 ((string= type
"coderef")
1522 (let ((ref (org-element-property :path link
)))
1523 (format (org-export-get-coderef-format ref desc
)
1524 (org-export-resolve-coderef ref info
))))
1525 ;; Do not apply a special syntax on radio links. Though, use
1526 ;; transcoded target's contents as output.
1527 ((string= type
"radio") desc
)
1528 ;; Do not apply a special syntax on fuzzy links pointing to
1530 ((string= type
"fuzzy")
1531 (let ((destination (org-export-resolve-fuzzy-link link info
)))
1532 (if (org-string-nw-p desc
) desc
1535 (org-export-get-ordinal
1536 destination info nil
'org-ascii--has-caption-p
)))
1538 (if (atom number
) (number-to-string number
)
1539 (mapconcat #'number-to-string number
"."))
1540 ;; Unnumbered headline.
1541 (when (eq 'headline
(org-element-type destination
))
1544 (org-element-property :title destination
)
1546 ((let ((protocol (nth 2 (assoc type org-link-protocols
)))
1547 (path (org-element-property :path link
)))
1548 (and (functionp protocol
)
1549 (funcall protocol
(org-link-unescape path
) desc
'ascii
))))
1551 (let ((raw-link (org-element-property :raw-link link
)))
1552 (if (not (org-string-nw-p desc
)) (format "[%s]" raw-link
)
1553 (concat (format "[%s]" desc
)
1554 (and (not (plist-get info
:ascii-links-to-notes
))
1555 (format " (%s)" raw-link
)))))))))
1558 ;;;; Node Properties
1560 (defun org-ascii-node-property (node-property contents info
)
1561 "Transcode a NODE-PROPERTY element from Org to ASCII.
1562 CONTENTS is nil. INFO is a plist holding contextual
1565 (org-element-property :key node-property
)
1566 (let ((value (org-element-property :value node-property
)))
1567 (if value
(concat " " value
) ""))))
1572 (defun org-ascii-paragraph (paragraph contents info
)
1573 "Transcode a PARAGRAPH element from Org to ASCII.
1574 CONTENTS is the contents of the paragraph, as a string. INFO is
1575 the plist used as a communication channel."
1576 (org-ascii--justify-element
1577 (let ((indented-line-width (plist-get info
:ascii-indented-line-width
)))
1578 (if (not (wholenump indented-line-width
)) contents
1580 ;; Do not indent first paragraph in a section.
1581 (unless (and (not (org-export-get-previous-element paragraph info
))
1582 (eq (org-element-type (org-export-get-parent paragraph
))
1584 (make-string indented-line-width ?\s
))
1585 (replace-regexp-in-string "\\`[ \t]+" "" contents
))))
1591 (defun org-ascii-plain-list (plain-list contents info
)
1592 "Transcode a PLAIN-LIST element from Org to ASCII.
1593 CONTENTS is the contents of the list. INFO is a plist holding
1594 contextual information."
1595 (let ((margin (plist-get info
:ascii-list-margin
)))
1596 (if (or (< margin
1)
1597 (eq (org-element-type (org-export-get-parent plain-list
)) 'item
))
1599 (org-ascii--indent-string contents margin
))))
1604 (defun org-ascii-plain-text (text info
)
1605 "Transcode a TEXT string from Org to ASCII.
1606 INFO is a plist used as a communication channel."
1607 (let ((utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
)))
1608 (when (and utf8p
(plist-get info
:with-smart-quotes
))
1609 (setq text
(org-export-activate-smart-quotes text
:utf-8 info
)))
1610 (if (not (plist-get info
:with-special-strings
)) text
1611 (setq text
(replace-regexp-in-string "\\\\-" "" text
))
1612 (if (not utf8p
) text
1613 ;; Usual replacements in utf-8 with proper option set.
1614 (replace-regexp-in-string
1616 (replace-regexp-in-string
1618 (replace-regexp-in-string "---" "—" text
)))))))
1623 (defun org-ascii-planning (planning contents info
)
1624 "Transcode a PLANNING element from Org to ASCII.
1625 CONTENTS is nil. INFO is a plist used as a communication
1627 (org-ascii--justify-element
1631 (list (let ((closed (org-element-property :closed planning
)))
1633 (concat org-closed-string
" "
1634 (org-timestamp-translate closed
))))
1635 (let ((deadline (org-element-property :deadline planning
)))
1637 (concat org-deadline-string
" "
1638 (org-timestamp-translate deadline
))))
1639 (let ((scheduled (org-element-property :scheduled planning
)))
1641 (concat org-scheduled-string
" "
1642 (org-timestamp-translate scheduled
))))))
1647 ;;;; Property Drawer
1649 (defun org-ascii-property-drawer (property-drawer contents info
)
1650 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1651 CONTENTS holds the contents of the drawer. INFO is a plist
1652 holding contextual information."
1653 (and (org-string-nw-p contents
)
1654 (org-ascii--justify-element contents property-drawer info
)))
1659 (defun org-ascii-quote-block (quote-block contents info
)
1660 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1661 CONTENTS holds the contents of the block. INFO is a plist
1662 holding contextual information."
1663 (org-ascii--indent-string contents
(plist-get info
:ascii-quote-margin
)))
1668 (defun org-ascii-radio-target (radio-target contents info
)
1669 "Transcode a RADIO-TARGET object from Org to ASCII.
1670 CONTENTS is the contents of the target. INFO is a plist holding
1671 contextual information."
1677 (defun org-ascii-section (section contents info
)
1678 "Transcode a SECTION element from Org to ASCII.
1679 CONTENTS is the contents of the section. INFO is a plist holding
1680 contextual information."
1681 (org-ascii--indent-string
1684 (when (plist-get info
:ascii-links-to-notes
)
1685 ;; Add list of links at the end of SECTION.
1686 (let ((links (org-ascii--describe-links
1687 (org-ascii--unique-links section info
)
1688 (org-ascii--current-text-width section info
) info
)))
1689 ;; Separate list of links and section contents.
1690 (when (org-string-nw-p links
) (concat "\n\n" links
)))))
1691 ;; Do not apply inner margin if parent headline is low level.
1692 (let ((headline (org-export-get-parent-headline section
)))
1693 (if (or (not headline
) (org-export-low-level-p headline info
)) 0
1694 (plist-get info
:ascii-inner-margin
)))))
1699 (defun org-ascii-special-block (special-block contents info
)
1700 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1701 CONTENTS holds the contents of the block. INFO is a plist
1702 holding contextual information."
1703 ;; "JUSTIFYLEFT" and "JUSTFYRIGHT" have already been taken care of
1704 ;; at a lower level. There is no other special block type to
1711 (defun org-ascii-src-block (src-block contents info
)
1712 "Transcode a SRC-BLOCK element from Org to ASCII.
1713 CONTENTS holds the contents of the item. INFO is a plist holding
1714 contextual information."
1715 (let ((caption (org-ascii--build-caption src-block info
))
1716 (caption-above-p (plist-get info
:ascii-caption-above
))
1717 (code (org-export-format-code-default src-block info
)))
1718 (if (equal code
"") ""
1719 (org-ascii--justify-element
1721 (and caption caption-above-p
(concat caption
"\n"))
1722 (org-ascii--box-string code info
)
1723 (and caption
(not caption-above-p
) (concat "\n" caption
)))
1727 ;;;; Statistics Cookie
1729 (defun org-ascii-statistics-cookie (statistics-cookie contents info
)
1730 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1731 CONTENTS is nil. INFO is a plist holding contextual information."
1732 (org-element-property :value statistics-cookie
))
1737 (defun org-ascii-subscript (subscript contents info
)
1738 "Transcode a SUBSCRIPT object from Org to ASCII.
1739 CONTENTS is the contents of the object. INFO is a plist holding
1740 contextual information."
1741 (if (org-element-property :use-brackets-p subscript
)
1742 (format "_{%s}" contents
)
1743 (format "_%s" contents
)))
1748 (defun org-ascii-superscript (superscript contents info
)
1749 "Transcode a SUPERSCRIPT object from Org to ASCII.
1750 CONTENTS is the contents of the object. INFO is a plist holding
1751 contextual information."
1752 (if (org-element-property :use-brackets-p superscript
)
1753 (format "^{%s}" contents
)
1754 (format "^%s" contents
)))
1759 (defun org-ascii-strike-through (strike-through contents info
)
1760 "Transcode STRIKE-THROUGH from Org to ASCII.
1761 CONTENTS is text with strike-through markup. INFO is a plist
1762 holding contextual information."
1763 (format "+%s+" contents
))
1768 (defun org-ascii-table (table contents info
)
1769 "Transcode a TABLE element from Org to ASCII.
1770 CONTENTS is the contents of the table. INFO is a plist holding
1771 contextual information."
1772 (let ((caption (org-ascii--build-caption table info
))
1773 (caption-above-p (plist-get info
:ascii-caption-above
)))
1774 (org-ascii--justify-element
1776 ;; Possibly add a caption string above.
1777 (and caption caption-above-p
(concat caption
"\n"))
1778 ;; Insert table. Note: "table.el" tables are left unmodified.
1779 (cond ((eq (org-element-property :type table
) 'org
) contents
)
1780 ((and (plist-get info
:ascii-table-use-ascii-art
)
1781 (eq (plist-get info
:ascii-charset
) 'utf-8
)
1782 (require 'ascii-art-to-unicode nil t
))
1784 (insert (org-remove-indentation
1785 (org-element-property :value table
)))
1786 (goto-char (point-min))
1788 (goto-char (point-max))
1789 (skip-chars-backward " \r\t\n")
1790 (buffer-substring (point-min) (point))))
1791 (t (org-remove-indentation (org-element-property :value table
))))
1792 ;; Possible add a caption string below.
1793 (and (not caption-above-p
) caption
))
1799 (defun org-ascii--table-cell-width (table-cell info
)
1800 "Return width of TABLE-CELL.
1802 INFO is a plist used as a communication channel.
1804 Width of a cell is determined either by a width cookie in the
1805 same column as the cell, or by the maximum cell's length in that
1808 When `org-ascii-table-widen-columns' is non-nil, width cookies
1810 (let* ((row (org-export-get-parent table-cell
))
1811 (table (org-export-get-parent row
))
1812 (col (let ((cells (org-element-contents row
)))
1813 (- (length cells
) (length (memq table-cell cells
)))))
1815 (or (plist-get info
:ascii-table-cell-width-cache
)
1816 (plist-get (setq info
1817 (plist-put info
:ascii-table-cell-width-cache
1818 (make-hash-table :test
'equal
)))
1819 :ascii-table-cell-width-cache
)))
1820 (key (cons table col
))
1821 (widenp (plist-get info
:ascii-table-widen-columns
)))
1822 (or (gethash key cache
)
1825 (let ((cookie-width (org-export-table-cell-width table-cell info
)))
1826 (or (and (not widenp
) cookie-width
)
1827 (let ((contents-width
1828 (let ((max-width 0))
1829 (org-element-map table
'table-row
1834 (org-element-contents
1835 (elt (org-element-contents row
) col
))
1840 (cond ((not cookie-width
) contents-width
)
1841 (widenp (max cookie-width contents-width
))
1842 (t cookie-width
)))))
1845 (defun org-ascii-table-cell (table-cell contents info
)
1846 "Transcode a TABLE-CELL object from Org to ASCII.
1847 CONTENTS is the cell contents. INFO is a plist used as
1848 a communication channel."
1849 ;; Determine column width. When `org-ascii-table-widen-columns'
1850 ;; is nil and some width cookie has set it, use that value.
1851 ;; Otherwise, compute the maximum width among transcoded data of
1852 ;; each cell in the column.
1853 (let ((width (org-ascii--table-cell-width table-cell info
)))
1854 ;; When contents are too large, truncate them.
1855 (unless (or (plist-get info
:ascii-table-widen-columns
)
1856 (<= (string-width (or contents
"")) width
))
1857 (setq contents
(concat (substring contents
0 (- width
2)) "=>")))
1858 ;; Align contents correctly within the cell.
1859 (let* ((indent-tabs-mode nil
)
1862 (org-ascii--justify-lines
1864 (org-export-table-cell-alignment table-cell info
)))))
1867 (make-string (- width
(string-width (or data
""))) ?\s
))))
1869 (concat (format " %s " contents
)
1870 (when (memq 'right
(org-export-table-cell-borders table-cell info
))
1871 (if (eq (plist-get info
:ascii-charset
) 'utf-8
) "│" "|")))))
1876 (defun org-ascii-table-row (table-row contents info
)
1877 "Transcode a TABLE-ROW element from Org to ASCII.
1878 CONTENTS is the row contents. INFO is a plist used as
1879 a communication channel."
1880 (when (eq (org-element-property :type table-row
) 'standard
)
1883 (lambda (lcorner horiz vert rcorner
)
1887 (org-element-map table-row
'table-cell
1889 (let ((width (org-ascii--table-cell-width cell info
))
1890 (borders (org-export-table-cell-borders cell info
)))
1892 ;; In order to know if CELL starts the row, do
1893 ;; not compare it with the first cell in the
1894 ;; row as there might be a special column.
1895 ;; Instead, compare it with first exportable
1896 ;; cell, obtained with `org-element-map'.
1897 (when (and (memq 'left borders
)
1898 (eq (org-element-map table-row
'table-cell
1902 (make-string (+ 2 width
) (string-to-char horiz
))
1904 ((not (memq 'right borders
)) nil
)
1905 ((eq (car (last (org-element-contents table-row
))) cell
)
1909 (utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
))
1910 (borders (org-export-table-cell-borders
1911 (org-element-map table-row
'table-cell
'identity info t
)
1914 ((and (memq 'top borders
) (or utf8p
(memq 'above borders
)))
1915 (if utf8p
(funcall build-hline
"┍" "━" "┯" "┑")
1916 (funcall build-hline
"+" "-" "+" "+")))
1917 ((memq 'above borders
)
1918 (if utf8p
(funcall build-hline
"├" "─" "┼" "┤")
1919 (funcall build-hline
"+" "-" "+" "+"))))
1920 (when (memq 'left borders
) (if utf8p
"│" "|"))
1922 (when (and (memq 'bottom borders
) (or utf8p
(memq 'below borders
)))
1923 (if utf8p
(funcall build-hline
"┕" "━" "┷" "┙")
1924 (funcall build-hline
"+" "-" "+" "+")))))))
1929 (defun org-ascii-timestamp (timestamp contents info
)
1930 "Transcode a TIMESTAMP object from Org to ASCII.
1931 CONTENTS is nil. INFO is a plist holding contextual information."
1932 (org-ascii-plain-text (org-timestamp-translate timestamp
) info
))
1937 (defun org-ascii-underline (underline contents info
)
1938 "Transcode UNDERLINE from Org to ASCII.
1939 CONTENTS is the text with underline markup. INFO is a plist
1940 holding contextual information."
1941 (format "_%s_" contents
))
1946 (defun org-ascii-verbatim (verbatim contents info
)
1947 "Return a VERBATIM object from Org to ASCII.
1948 CONTENTS is nil. INFO is a plist holding contextual information."
1949 (format (plist-get info
:ascii-verbatim-format
)
1950 (org-element-property :value verbatim
)))
1955 (defun org-ascii-verse-block (verse-block contents info
)
1956 "Transcode a VERSE-BLOCK element from Org to ASCII.
1957 CONTENTS is verse block contents. INFO is a plist holding
1958 contextual information."
1959 (let ((verse-width (org-ascii--current-text-width verse-block info
)))
1960 (org-ascii--indent-string
1961 (org-ascii--justify-element contents verse-block info
)
1962 (plist-get info
:ascii-quote-margin
))))
1968 (defun org-ascii-filter-headline-blank-lines (headline back-end info
)
1969 "Filter controlling number of blank lines after a headline.
1971 HEADLINE is a string representing a transcoded headline.
1972 BACK-END is symbol specifying back-end used for export. INFO is
1973 plist containing the communication channel.
1975 This function only applies to `ascii' back-end. See
1976 `org-ascii-headline-spacing' for information."
1977 (let ((headline-spacing (plist-get info
:ascii-headline-spacing
)))
1978 (if (not headline-spacing
) headline
1979 (let ((blanks (make-string (1+ (cdr headline-spacing
)) ?
\n)))
1980 (replace-regexp-in-string "\n\\(?:\n[ \t]*\\)*\\'" blanks headline
)))))
1982 (defun org-ascii-filter-paragraph-spacing (tree back-end info
)
1983 "Filter controlling number of blank lines between paragraphs.
1985 TREE is the parse tree. BACK-END is the symbol specifying
1986 back-end used for export. INFO is a plist used as
1987 a communication channel.
1989 See `org-ascii-paragraph-spacing' for information."
1990 (let ((paragraph-spacing (plist-get info
:ascii-paragraph-spacing
)))
1991 (when (wholenump paragraph-spacing
)
1992 (org-element-map tree
'paragraph
1994 (when (eq (org-element-type (org-export-get-next-element p info
))
1996 (org-element-put-property p
:post-blank paragraph-spacing
))))))
1999 (defun org-ascii-filter-comment-spacing (tree backend info
)
2000 "Filter removing blank lines between comments.
2001 TREE is the parse tree. BACK-END is the symbol specifying
2002 back-end used for export. INFO is a plist used as
2003 a communication channel."
2004 (org-element-map tree
'(comment comment-block
)
2006 (when (memq (org-element-type (org-export-get-next-element c info
))
2007 '(comment comment-block
))
2008 (org-element-put-property c
:post-blank
0))))
2013 ;;; End-user functions
2016 (defun org-ascii-export-as-ascii
2017 (&optional async subtreep visible-only body-only ext-plist
)
2018 "Export current buffer to a text buffer.
2020 If narrowing is active in the current buffer, only export its
2023 If a region is active, export that region.
2025 A non-nil optional argument ASYNC means the process should happen
2026 asynchronously. The resulting buffer should be accessible
2027 through the `org-export-stack' interface.
2029 When optional argument SUBTREEP is non-nil, export the sub-tree
2030 at point, extracting information from the headline properties
2033 When optional argument VISIBLE-ONLY is non-nil, don't export
2034 contents of hidden elements.
2036 When optional argument BODY-ONLY is non-nil, strip title and
2037 table of contents from output.
2039 EXT-PLIST, when provided, is a property list with external
2040 parameters overriding Org default settings, but still inferior to
2041 file-local settings.
2043 Export is done in a buffer named \"*Org ASCII Export*\", which
2044 will be displayed when `org-export-show-temporary-export-buffer'
2047 (org-export-to-buffer 'ascii
"*Org ASCII Export*"
2048 async subtreep visible-only body-only ext-plist
(lambda () (text-mode))))
2051 (defun org-ascii-export-to-ascii
2052 (&optional async subtreep visible-only body-only ext-plist
)
2053 "Export current buffer to a text file.
2055 If narrowing is active in the current buffer, only export its
2058 If a region is active, export that region.
2060 A non-nil optional argument ASYNC means the process should happen
2061 asynchronously. The resulting file should be accessible through
2062 the `org-export-stack' interface.
2064 When optional argument SUBTREEP is non-nil, export the sub-tree
2065 at point, extracting information from the headline properties
2068 When optional argument VISIBLE-ONLY is non-nil, don't export
2069 contents of hidden elements.
2071 When optional argument BODY-ONLY is non-nil, strip title and
2072 table of contents from output.
2074 EXT-PLIST, when provided, is a property list with external
2075 parameters overriding Org default settings, but still inferior to
2076 file-local settings.
2078 Return output file's name."
2080 (let ((file (org-export-output-file-name ".txt" subtreep
)))
2081 (org-export-to-file 'ascii file
2082 async subtreep visible-only body-only ext-plist
)))
2085 (defun org-ascii-publish-to-ascii (plist filename pub-dir
)
2086 "Publish an Org file to ASCII.
2088 FILENAME is the filename of the Org file to be published. PLIST
2089 is the property list for the given project. PUB-DIR is the
2090 publishing directory.
2092 Return output file name."
2094 'ascii filename
".txt" `(:ascii-charset ascii
,@plist
) pub-dir
))
2097 (defun org-ascii-publish-to-latin1 (plist filename pub-dir
)
2098 "Publish an Org file to Latin-1.
2100 FILENAME is the filename of the Org file to be published. PLIST
2101 is the property list for the given project. PUB-DIR is the
2102 publishing directory.
2104 Return output file name."
2106 'ascii filename
".txt" `(:ascii-charset latin1
,@plist
) pub-dir
))
2109 (defun org-ascii-publish-to-utf8 (plist filename pub-dir
)
2110 "Publish an org file to UTF-8.
2112 FILENAME is the filename of the Org file to be published. PLIST
2113 is the property list for the given project. PUB-DIR is the
2114 publishing directory.
2116 Return output file name."
2118 'ascii filename
".txt" `(:ascii-charset utf-8
,@plist
) pub-dir
))
2124 ;; generated-autoload-file: "org-loaddefs.el"
2125 ;; coding: utf-8-emacs
2128 ;;; ox-ascii.el ends here