1 ;;; ox-ascii.el --- ASCII Back-End for Org Export Engine -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2018 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 <https://www.gnu.org/licenses/>.
25 ;; This library implements an ASCII back-end for Org generic exporter.
26 ;; See Org manual for more information.
34 (declare-function aa2u
"ext:ascii-art-to-unicode" ())
38 ;; The following setting won't allow modifying preferred charset
39 ;; through a buffer keyword or an option item, but, since the property
40 ;; will appear in communication channel nonetheless, it allows
41 ;; overriding `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 (drawer . org-ascii-drawer
)
53 (dynamic-block . org-ascii-dynamic-block
)
54 (entity . org-ascii-entity
)
55 (example-block . org-ascii-example-block
)
56 (export-block . org-ascii-export-block
)
57 (export-snippet . org-ascii-export-snippet
)
58 (fixed-width . org-ascii-fixed-width
)
59 (footnote-reference . org-ascii-footnote-reference
)
60 (headline . org-ascii-headline
)
61 (horizontal-rule . org-ascii-horizontal-rule
)
62 (inline-src-block . org-ascii-inline-src-block
)
63 (inlinetask . org-ascii-inlinetask
)
64 (inner-template . org-ascii-inner-template
)
65 (italic . org-ascii-italic
)
66 (item . org-ascii-item
)
67 (keyword . org-ascii-keyword
)
68 (latex-environment . org-ascii-latex-environment
)
69 (latex-fragment . org-ascii-latex-fragment
)
70 (line-break . org-ascii-line-break
)
71 (link . org-ascii-link
)
72 (node-property . org-ascii-node-property
)
73 (paragraph . org-ascii-paragraph
)
74 (plain-list . org-ascii-plain-list
)
75 (plain-text . org-ascii-plain-text
)
76 (planning . org-ascii-planning
)
77 (property-drawer . org-ascii-property-drawer
)
78 (quote-block . org-ascii-quote-block
)
79 (radio-target . org-ascii-radio-target
)
80 (section . org-ascii-section
)
81 (special-block . org-ascii-special-block
)
82 (src-block . org-ascii-src-block
)
83 (statistics-cookie . org-ascii-statistics-cookie
)
84 (strike-through . org-ascii-strike-through
)
85 (subscript . org-ascii-subscript
)
86 (superscript . org-ascii-superscript
)
87 (table . org-ascii-table
)
88 (table-cell . org-ascii-table-cell
)
89 (table-row . org-ascii-table-row
)
90 (target . org-ascii-target
)
91 (template . org-ascii-template
)
92 (timestamp . org-ascii-timestamp
)
93 (underline . org-ascii-underline
)
94 (verbatim . org-ascii-verbatim
)
95 (verse-block . org-ascii-verse-block
))
97 '(?t
"Export to Plain Text"
98 ((?A
"As ASCII buffer"
100 (org-ascii-export-as-ascii a s v b
'(:ascii-charset ascii
))))
103 (org-ascii-export-to-ascii a s v b
'(:ascii-charset ascii
))))
104 (?L
"As Latin1 buffer"
106 (org-ascii-export-as-ascii a s v b
'(:ascii-charset latin1
))))
109 (org-ascii-export-to-ascii a s v b
'(:ascii-charset latin1
))))
110 (?U
"As UTF-8 buffer"
112 (org-ascii-export-as-ascii a s v b
'(:ascii-charset utf-8
))))
115 (org-ascii-export-to-ascii a s v b
'(:ascii-charset utf-8
))))))
116 :filters-alist
'((:filter-headline . org-ascii-filter-headline-blank-lines
)
117 (:filter-parse-tree org-ascii-filter-paragraph-spacing
118 org-ascii-filter-comment-spacing
)
119 (:filter-section . org-ascii-filter-headline-blank-lines
))
121 '((:subtitle
"SUBTITLE" nil nil parse
)
122 (:ascii-bullets nil nil org-ascii-bullets
)
123 (:ascii-caption-above nil nil org-ascii-caption-above
)
124 (:ascii-charset nil nil org-ascii-charset
)
125 (:ascii-global-margin nil nil org-ascii-global-margin
)
126 (:ascii-format-drawer-function nil nil org-ascii-format-drawer-function
)
127 (:ascii-format-inlinetask-function
128 nil nil org-ascii-format-inlinetask-function
)
129 (:ascii-headline-spacing nil nil org-ascii-headline-spacing
)
130 (:ascii-indented-line-width nil nil org-ascii-indented-line-width
)
131 (:ascii-inlinetask-width nil nil org-ascii-inlinetask-width
)
132 (:ascii-inner-margin nil nil org-ascii-inner-margin
)
133 (:ascii-links-to-notes nil nil org-ascii-links-to-notes
)
134 (:ascii-list-margin nil nil org-ascii-list-margin
)
135 (:ascii-paragraph-spacing nil nil org-ascii-paragraph-spacing
)
136 (:ascii-quote-margin nil nil org-ascii-quote-margin
)
137 (:ascii-table-keep-all-vertical-lines
138 nil nil org-ascii-table-keep-all-vertical-lines
)
139 (:ascii-table-use-ascii-art nil nil org-ascii-table-use-ascii-art
)
140 (:ascii-table-widen-columns nil nil org-ascii-table-widen-columns
)
141 (:ascii-text-width nil nil org-ascii-text-width
)
142 (:ascii-underline nil nil org-ascii-underline
)
143 (:ascii-verbatim-format nil nil org-ascii-verbatim-format
)))
147 ;;; User Configurable Variables
149 (defgroup org-export-ascii nil
150 "Options for exporting Org mode files to ASCII."
151 :tag
"Org Export ASCII"
154 (defcustom org-ascii-text-width
72
155 "Maximum width of exported text.
156 This number includes margin size, as set in
157 `org-ascii-global-margin'."
158 :group
'org-export-ascii
160 :package-version
'(Org .
"8.0")
163 (defcustom org-ascii-global-margin
0
164 "Width of the left margin, in number of characters."
165 :group
'org-export-ascii
167 :package-version
'(Org .
"8.0")
170 (defcustom org-ascii-inner-margin
2
171 "Width of the inner margin, in number of characters.
172 Inner margin is applied between each headline."
173 :group
'org-export-ascii
175 :package-version
'(Org .
"8.0")
178 (defcustom org-ascii-quote-margin
6
179 "Width of margin used for quoting text, in characters.
180 This margin is applied on both sides of the text. It is also
181 applied on the left side of contents in descriptive lists."
182 :group
'org-export-ascii
184 :package-version
'(Org .
"8.0")
187 (defcustom org-ascii-list-margin
0
188 "Width of margin used for plain lists, in characters.
189 This margin applies to top level list only, not to its
191 :group
'org-export-ascii
193 :package-version
'(Org .
"8.3")
196 (defcustom org-ascii-inlinetask-width
30
197 "Width of inline tasks, in number of characters.
198 This number ignores any margin."
199 :group
'org-export-ascii
201 :package-version
'(Org .
"8.0")
204 (defcustom org-ascii-headline-spacing
'(1 .
2)
205 "Number of blank lines inserted around headlines.
207 This variable can be set to a cons cell. In that case, its car
208 represents the number of blank lines present before headline
209 contents whereas its cdr reflects the number of blank lines after
212 A nil value replicates the number of blank lines found in the
213 original Org buffer at the same place."
214 :group
'org-export-ascii
216 :package-version
'(Org .
"8.0")
218 (const :tag
"Replicate original spacing" nil
)
219 (cons :tag
"Set a uniform spacing"
220 (integer :tag
"Number of blank lines before contents")
221 (integer :tag
"Number of blank lines after contents"))))
223 (defcustom org-ascii-indented-line-width
'auto
224 "Additional indentation width for the first line in a paragraph.
225 If the value is an integer, indent the first line of each
226 paragraph by this width, unless it is located at the beginning of
227 a section, in which case indentation is removed from that line.
228 If it is the symbol `auto' preserve indentation from original
230 :group
'org-export-ascii
232 :package-version
'(Org .
"8.0")
234 (integer :tag
"Number of white spaces characters")
235 (const :tag
"Preserve original width" auto
)))
237 (defcustom org-ascii-paragraph-spacing
'auto
238 "Number of white lines between paragraphs.
239 If the value is an integer, add this number of blank lines
240 between contiguous paragraphs. If is it the symbol `auto', keep
241 the same number of blank lines as in the original document."
242 :group
'org-export-ascii
244 :package-version
'(Org .
"8.0")
246 (integer :tag
"Number of blank lines")
247 (const :tag
"Preserve original spacing" auto
)))
249 (defcustom org-ascii-charset
'ascii
250 "The charset allowed to represent various elements and objects.
252 `ascii' Only use plain ASCII characters
253 `latin1' Include Latin-1 characters
254 `utf-8' Use all UTF-8 characters"
255 :group
'org-export-ascii
257 :package-version
'(Org .
"8.0")
259 (const :tag
"ASCII" ascii
)
260 (const :tag
"Latin-1" latin1
)
261 (const :tag
"UTF-8" utf-8
)))
263 (defcustom org-ascii-underline
'((ascii ?
= ?~ ?-
)
265 (utf-8 ?═ ?─ ?╌ ?┄ ?┈
))
266 "Characters for underlining headings in ASCII export.
268 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
269 and whose value is a list of characters.
271 For each supported charset, this variable associates a sequence
272 of underline characters. In a sequence, the characters will be
273 used in order for headlines level 1, 2, ... If no character is
274 available for a given level, the headline won't be underlined."
275 :group
'org-export-ascii
277 :package-version
'(Org .
"8.0")
279 (cons :tag
"Underline characters sequence"
280 (const :tag
"ASCII charset" ascii
)
282 (cons :tag
"Underline characters sequence"
283 (const :tag
"Latin-1 charset" latin1
)
285 (cons :tag
"Underline characters sequence"
286 (const :tag
"UTF-8 charset" utf-8
)
287 (repeat character
))))
289 (defcustom org-ascii-bullets
'((ascii ?
* ?
+ ?-
)
292 "Bullet characters for headlines converted to lists in ASCII export.
294 Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
295 and whose value is a list of characters.
297 The first character is used for the first level considered as low
298 level, and so on. If there are more levels than characters given
299 here, the list will be repeated.
301 Note that this variable doesn't affect plain lists
303 :group
'org-export-ascii
305 :package-version
'(Org .
"8.0")
307 (cons :tag
"Bullet characters for low level headlines"
308 (const :tag
"ASCII charset" ascii
)
310 (cons :tag
"Bullet characters for low level headlines"
311 (const :tag
"Latin-1 charset" latin1
)
313 (cons :tag
"Bullet characters for low level headlines"
314 (const :tag
"UTF-8 charset" utf-8
)
315 (repeat character
))))
317 (defcustom org-ascii-links-to-notes t
318 "Non-nil means convert links to notes before the next headline.
319 When nil, the link will be exported in place. If the line
320 becomes long in this way, it will be wrapped."
321 :group
'org-export-ascii
323 :package-version
'(Org .
"8.0")
326 (defcustom org-ascii-table-keep-all-vertical-lines nil
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."
330 :group
'org-export-ascii
332 :package-version
'(Org .
"8.0")
335 (defcustom org-ascii-table-widen-columns t
336 "Non-nil means widen narrowed columns for export.
337 When nil, narrowed columns will look in ASCII export just like in
338 Org mode, i.e. with \"=>\" as ellipsis."
339 :group
'org-export-ascii
341 :package-version
'(Org .
"8.0")
344 (defcustom org-ascii-table-use-ascii-art nil
345 "Non-nil means \"table.el\" tables are turned into ASCII art.
346 It only makes sense when export charset is `utf-8'. It is nil by
347 default since it requires \"ascii-art-to-unicode.el\" package,
348 available through, e.g., GNU ELPA."
349 :group
'org-export-ascii
351 :package-version
'(Org .
"8.0")
354 (defcustom org-ascii-caption-above nil
355 "When non-nil, place caption string before the element.
356 Otherwise, place it right after it."
357 :group
'org-export-ascii
359 :package-version
'(Org .
"8.0")
362 (defcustom org-ascii-verbatim-format
"`%s'"
363 "Format string used for verbatim text and inline code."
364 :group
'org-export-ascii
366 :package-version
'(Org .
"8.0")
369 (defcustom org-ascii-format-drawer-function
370 (lambda (_name contents _width
) contents
)
371 "Function called to format a drawer in ASCII.
373 The function must accept three parameters:
374 NAME the drawer name, like \"LOGBOOK\"
375 CONTENTS the contents of the drawer.
376 WIDTH the text width within the drawer.
378 The function should return either the string to be exported or
379 nil to ignore the drawer.
381 The default value simply returns the value of CONTENTS."
382 :group
'org-export-ascii
384 :package-version
'(Org .
"8.0")
387 (defcustom org-ascii-format-inlinetask-function
388 'org-ascii-format-inlinetask-default
389 "Function called to format an inlinetask in ASCII.
391 The function must accept nine parameters:
392 TODO the todo keyword, as a string
393 TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
394 PRIORITY the inlinetask priority, as a string
395 NAME the inlinetask name, as a string.
396 TAGS the inlinetask tags, as a list of strings.
397 CONTENTS the contents of the inlinetask, as a string.
398 WIDTH the width of the inlinetask, as a number.
399 INLINETASK the inlinetask itself.
400 INFO the info channel.
402 The function should return either the string to be exported or
403 nil to ignore the inline task."
404 :group
'org-export-ascii
406 :package-version
'(Org .
"8.3")
411 ;;; Internal Functions
413 ;; Internal functions fall into three categories.
415 ;; The first one is about text formatting. The core functions are
416 ;; `org-ascii--current-text-width' and
417 ;; `org-ascii--current-justification', which determine, respectively,
418 ;; the current text width allowed to a given element and its expected
419 ;; justification. Once this information is known,
420 ;; `org-ascii--fill-string', `org-ascii--justify-lines',
421 ;; `org-ascii--justify-element' `org-ascii--box-string' and
422 ;; `org-ascii--indent-string' can operate on a given output string.
423 ;; In particular, justification happens at the regular (i.e.,
424 ;; non-greater) element level, which means that when the exporting
425 ;; process reaches a container (e.g., a center block) content are
426 ;; already justified.
428 ;; The second category contains functions handling elements listings,
429 ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
430 ;; returns a complete table of contents, `org-ascii--list-listings'
431 ;; returns a list of referenceable src-block elements, and
432 ;; `org-ascii--list-tables' does the same for table elements.
434 ;; The third category includes general helper functions.
435 ;; `org-ascii--build-title' creates the title for a given headline
436 ;; or inlinetask element. `org-ascii--build-caption' returns the
437 ;; caption string associated to a table or a src-block.
438 ;; `org-ascii--describe-links' creates notes about links for
439 ;; insertion at the end of a section. It uses
440 ;; `org-ascii--unique-links' to get the list of links to describe.
441 ;; Eventually, `org-ascii--translate' translates a string according
442 ;; to language and charset specification.
445 (defun org-ascii--fill-string (s text-width info
&optional justify
)
446 "Fill a string with specified text-width and return it.
448 S is the string being filled. TEXT-WIDTH is an integer
449 specifying maximum length of a line. INFO is the plist used as
450 a communication channel.
452 Optional argument JUSTIFY can specify any type of justification
453 among `left', `center', `right' or `full'. A nil value is
454 equivalent to `left'. For a justification that doesn't also fill
455 string, see `org-ascii--justify-lines' and
456 `org-ascii--justify-block'.
458 Return nil if S isn't a string."
460 (let ((double-space-p sentence-end-double-space
))
462 (let ((fill-column text-width
)
463 (use-hard-newlines t
)
464 (sentence-end-double-space double-space-p
))
465 (insert (if (plist-get info
:preserve-breaks
)
466 (replace-regexp-in-string "\n" hard-newline s
)
468 (fill-region (point-min) (point-max) justify
))
471 (defun org-ascii--justify-lines (s text-width how
)
472 "Justify all lines in string S.
473 TEXT-WIDTH is an integer specifying maximum length of a line.
474 HOW determines the type of justification: it can be `left',
475 `right', `full' or `center'."
478 (goto-char (point-min))
479 (let ((fill-column text-width
)
480 ;; Disable `adaptive-fill-mode' so it doesn't prevent
481 ;; filling lines matching `adaptive-fill-regexp'.
482 (adaptive-fill-mode nil
))
483 (while (< (point) (point-max))
484 (justify-current-line how
)
488 (defun org-ascii--justify-element (contents element info
)
489 "Justify CONTENTS of ELEMENT.
490 INFO is a plist used as a communication channel. Justification
491 is done according to the type of element. More accurately,
492 paragraphs are filled and other elements are justified as blocks,
493 that is according to the widest non blank line in CONTENTS."
494 (if (not (org-string-nw-p contents
)) contents
495 (let ((text-width (org-ascii--current-text-width element info
))
496 (how (org-ascii--current-justification element
)))
498 ((eq (org-element-type element
) 'paragraph
)
499 ;; Paragraphs are treated specially as they need to be filled.
500 (org-ascii--fill-string contents text-width info how
))
501 ((eq how
'left
) contents
)
504 (goto-char (point-min))
507 ;; Compute maximum width. Bail out if it is greater
508 ;; than page width, since no justification is
512 (unless (looking-at-p "[ \t]*$")
514 (let ((column (current-column)))
516 ((>= column text-width
) (throw 'exit contents
))
517 ((> column max-width
) (setq max-width column
)))))
519 ;; Justify every line according to TEXT-WIDTH and
521 (let ((offset (/ (- text-width max-width
)
522 (if (eq how
'right
) 1 2))))
523 (if (zerop offset
) (throw 'exit contents
)
525 (unless (looking-at-p "[ \t]*$")
526 (indent-to-column offset
))
528 (buffer-string))))))))
530 (defun org-ascii--indent-string (s width
)
531 "Indent string S by WIDTH white spaces.
532 Empty lines are not indented."
534 (replace-regexp-in-string
535 "\\(^\\)[ \t]*\\S-" (make-string width ?\s
) s nil nil
1)))
537 (defun org-ascii--box-string (s info
)
538 "Return string S with a partial box to its left.
539 INFO is a plist used as a communication channel."
540 (let ((utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
)))
541 (format (if utf8p
"┌────\n%s\n└────" ",----\n%s\n`----")
542 (replace-regexp-in-string
543 "^" (if utf8p
"│ " "| ")
544 ;; Remove last newline character.
545 (replace-regexp-in-string "\n[ \t]*\\'" "" s
)))))
547 (defun org-ascii--current-text-width (element info
)
548 "Return maximum text width for ELEMENT's contents.
549 INFO is a plist used as a communication channel."
550 (pcase (org-element-type element
)
551 ;; Elements with an absolute width: `headline' and `inlinetask'.
552 (`inlinetask
(plist-get info
:ascii-inlinetask-width
))
554 (- (plist-get info
:ascii-text-width
)
555 (let ((low-level-rank (org-export-low-level-p element info
)))
556 (if low-level-rank
(* low-level-rank
2)
557 (plist-get info
:ascii-global-margin
)))))
558 ;; Elements with a relative width: store maximum text width in
561 (let* ((genealogy (org-element-lineage element nil t
))
562 ;; Total width is determined by the presence, or not, of an
563 ;; inline task among ELEMENT parents.
565 (if (cl-some (lambda (parent)
566 (eq (org-element-type parent
) 'inlinetask
))
568 (plist-get info
:ascii-inlinetask-width
)
569 ;; No inlinetask: Remove global margin from text width.
570 (- (plist-get info
:ascii-text-width
)
571 (plist-get info
:ascii-global-margin
)
572 (let ((parent (org-export-get-parent-headline element
)))
573 ;; Inner margin doesn't apply to text before first
576 (let ((low-level-rank
577 (org-export-low-level-p parent info
)))
578 ;; Inner margin doesn't apply to contents of
579 ;; low level headlines, since they've got their
580 ;; own indentation mechanism.
581 (if low-level-rank
(* low-level-rank
2)
582 (plist-get info
:ascii-inner-margin
)))))))))
584 ;; Each `quote-block' and `verse-block' above narrows text
585 ;; width by twice the standard margin size.
586 (+ (* (cl-count-if (lambda (parent)
587 (memq (org-element-type parent
)
588 '(quote-block verse-block
)))
591 (plist-get info
:ascii-quote-margin
))
592 ;; Apply list margin once per "top-level" plain-list
593 ;; containing current line
596 (and (eq (org-element-type e
) 'plain-list
)
597 (not (eq (org-element-type (org-export-get-parent e
))
600 (plist-get info
:ascii-list-margin
))
601 ;; Compute indentation offset due to current list. It is
602 ;; `org-ascii-quote-margin' per descriptive item in the
603 ;; genealogy, bullet's length otherwise.
604 (let ((indentation 0))
605 (dolist (e genealogy
)
607 ((not (eq 'item
(org-element-type e
))))
608 ((eq (org-element-property :type
(org-export-get-parent e
))
610 (cl-incf indentation org-ascii-quote-margin
))
614 (or (org-ascii--checkbox e info
) ""))
616 (org-element-property :bullet e
)))))))
619 (defun org-ascii--current-justification (element)
620 "Return expected justification for ELEMENT's contents.
621 Return value is a symbol among `left', `center', `right' and
624 (while (and (not justification
)
625 (setq element
(org-element-property :parent element
)))
626 (pcase (org-element-type element
)
627 (`center-block
(setq justification
'center
))
629 (let ((name (org-element-property :type element
)))
630 (cond ((string= name
"JUSTIFYRIGHT") (setq justification
'right
))
631 ((string= name
"JUSTIFYLEFT") (setq justification
'left
)))))))
632 (or justification
'left
)))
634 (defun org-ascii--build-title
635 (element info text-width
&optional underline notags toc
)
636 "Format ELEMENT title and return it.
638 ELEMENT is either an `headline' or `inlinetask' element. INFO is
639 a plist used as a communication channel. TEXT-WIDTH is an
640 integer representing the maximum length of a line.
642 When optional argument UNDERLINE is non-nil, underline title,
643 without the tags, according to `org-ascii-underline'
646 If optional argument NOTAGS is non-nil, no tags will be added to
649 When optional argument TOC is non-nil, use optional title if
650 possible. It doesn't apply to `inlinetask' elements."
651 (let* ((headlinep (eq (org-element-type element
) 'headline
))
653 ;; Numbering is specific to headlines.
655 (org-export-numbered-headline-p element info
)
656 (let ((numbering (org-export-get-headline-number element info
)))
657 (if toc
(format "%d. " (org-last numbering
))
658 (concat (mapconcat #'number-to-string numbering
".")
663 (if (and toc headlinep
) (org-export-get-alt-title element info
)
664 (org-element-property :title element
))
667 (and (plist-get info
:with-todo-keywords
)
668 (let ((todo (org-element-property :todo-keyword element
)))
669 (and todo
(concat (org-export-data todo info
) " ")))))
670 (tags (and (not notags
)
671 (plist-get info
:with-tags
)
672 (let ((tag-list (org-export-get-tags element info
)))
674 (org-make-tag-string tag-list
)))))
676 (and (plist-get info
:with-priority
)
677 (let ((char (org-element-property :priority element
)))
678 (and char
(format "(#%c) " char
)))))
679 (first-part (concat numbers todo priority text
)))
682 ;; Align tags, if any.
686 (max (- text-width
(1+ (string-width first-part
)))
687 (string-width tags
)))
689 ;; Maybe underline text, if ELEMENT type is `headline' and an
690 ;; underline character has been defined.
691 (when (and underline headlinep
)
693 (nth (1- (org-export-get-relative-level element info
))
694 (cdr (assq (plist-get info
:ascii-charset
)
695 (plist-get info
:ascii-underline
))))))
698 (make-string (/ (string-width first-part
)
699 (char-width under-char
))
702 (defun org-ascii--has-caption-p (element _info
)
703 "Non-nil when ELEMENT has a caption affiliated keyword.
704 INFO is a plist used as a communication channel. This function
705 is meant to be used as a predicate for `org-export-get-ordinal'."
706 (org-element-property :caption element
))
708 (defun org-ascii--build-caption (element info
)
709 "Return caption string for ELEMENT, if applicable.
711 INFO is a plist used as a communication channel.
713 The caption string contains the sequence number of ELEMENT along
714 with its real caption. Return nil when ELEMENT has no affiliated
716 (let ((caption (org-export-get-caption element
)))
718 ;; Get sequence number of current src-block among every
719 ;; src-block with a caption.
721 (org-export-get-ordinal
722 element info nil
'org-ascii--has-caption-p
))
723 (title-fmt (org-ascii--translate
724 (pcase (org-element-type element
)
726 (`src-block
"Listing %d:"))
728 (org-ascii--fill-string
729 (concat (format title-fmt reference
)
731 (org-export-data caption info
))
732 (org-ascii--current-text-width element info
) info
)))))
734 (defun org-ascii--build-toc (info &optional n keyword local
)
735 "Return a table of contents.
737 INFO is a plist used as a communication channel.
739 Optional argument N, when non-nil, is an integer specifying the
742 Optional argument KEYWORD specifies the TOC keyword, if any, from
743 which the table of contents generation has been initiated.
745 When optional argument LOCAL is non-nil, build a table of
746 contents according to the current headline."
749 (let ((title (org-ascii--translate "Table of Contents" info
)))
753 (if (eq (plist-get info
:ascii-charset
) 'utf-8
) ?─ ?_
))
756 (if keyword
(org-ascii--current-text-width keyword info
)
757 (- (plist-get info
:ascii-text-width
)
758 (plist-get info
:ascii-global-margin
)))))
761 (let* ((level (org-export-get-relative-level headline info
))
762 (indent (* (1- level
) 3)))
764 (unless (zerop indent
) (concat (make-string (1- indent
) ?.
) " "))
765 (org-ascii--build-title
766 headline info
(- text-width indent
) nil
767 (or (not (plist-get info
:with-tags
))
768 (eq (plist-get info
:with-tags
) 'not-in-toc
))
770 (org-export-collect-headlines info n
(and local keyword
)) "\n"))))
772 (defun org-ascii--list-listings (keyword info
)
773 "Return a list of listings.
775 KEYWORD is the keyword that initiated the list of listings
776 generation. INFO is a plist used as a communication channel."
777 (let ((title (org-ascii--translate "List of Listings" info
)))
780 (make-string (string-width title
)
781 (if (eq (plist-get info
:ascii-charset
) 'utf-8
) ?─ ?_
))
784 (if keyword
(org-ascii--current-text-width keyword info
)
785 (- (plist-get info
:ascii-text-width
)
786 (plist-get info
:ascii-global-margin
))))
787 ;; Use a counter instead of retrieving ordinal of each
792 ;; Store initial text so its length can be computed. This is
793 ;; used to properly align caption right to it in case of
794 ;; filling (like contents of a description list item).
796 (format (org-ascii--translate "Listing %d:" info
)
798 (initial-width (string-width initial-text
)))
802 (org-ascii--indent-string
803 (org-ascii--fill-string
804 ;; Use short name in priority, if available.
805 (let ((caption (or (org-export-get-caption src-block t
)
806 (org-export-get-caption src-block
))))
807 (org-export-data caption info
))
808 (- text-width initial-width
) info
)
810 (org-export-collect-listings info
) "\n")))))
812 (defun org-ascii--list-tables (keyword info
)
813 "Return a list of tables.
815 KEYWORD is the keyword that initiated the list of tables
816 generation. INFO is a plist used as a communication channel."
817 (let ((title (org-ascii--translate "List of Tables" info
)))
820 (make-string (string-width title
)
821 (if (eq (plist-get info
:ascii-charset
) 'utf-8
) ?─ ?_
))
824 (if keyword
(org-ascii--current-text-width keyword info
)
825 (- (plist-get info
:ascii-text-width
)
826 (plist-get info
:ascii-global-margin
))))
827 ;; Use a counter instead of retrieving ordinal of each
832 ;; Store initial text so its length can be computed. This is
833 ;; used to properly align caption right to it in case of
834 ;; filling (like contents of a description list item).
836 (format (org-ascii--translate "Table %d:" info
)
838 (initial-width (string-width initial-text
)))
842 (org-ascii--indent-string
843 (org-ascii--fill-string
844 ;; Use short name in priority, if available.
845 (let ((caption (or (org-export-get-caption table t
)
846 (org-export-get-caption table
))))
847 (org-export-data caption info
))
848 (- text-width initial-width
) info
)
850 (org-export-collect-tables info
) "\n")))))
852 (defun org-ascii--unique-links (element info
)
853 "Return a list of unique link references in ELEMENT.
854 ELEMENT is either a headline element or a section element. INFO
855 is a plist used as a communication channel."
858 ;; Return LINK if it wasn't referenced so far, or nil.
859 ;; Update SEEN links along the way.
862 ;; Normalize description in footprints.
863 (cons (org-element-property :raw-link link
)
864 (let ((contents (org-element-contents link
)))
866 (replace-regexp-in-string
869 (org-element-interpret-data contents
))))))))
870 ;; Ignore LINK if it hasn't been translated already. It
871 ;; can happen if it is located in an affiliated keyword
873 (when (and (org-string-nw-p
874 (gethash link
(plist-get info
:exported-data
)))
875 (not (member footprint seen
)))
876 (push footprint seen
) link
)))))
877 (org-element-map (if (eq (org-element-type element
) 'section
)
879 ;; In a headline, only retrieve links in title
880 ;; and relative section, not in children.
881 (list (org-element-property :title element
)
882 (car (org-element-contents element
))))
883 'link unique-link-p info nil
'headline t
)))
885 (defun org-ascii--describe-datum (datum info
)
886 "Describe DATUM object or element.
887 If DATUM is a string, consider it to be a file name, per
888 `org-export-resolve-id-link'. INFO is the communication channel,
890 (pcase (org-element-type datum
)
891 (`plain-text
(format "See file %s" datum
)) ;External file
893 (format (org-ascii--translate "See section %s" info
)
894 (if (org-export-numbered-headline-p datum info
)
895 (mapconcat #'number-to-string
896 (org-export-get-headline-number datum info
)
898 (org-export-data (org-element-property :title datum
) info
))))
900 (let ((number (org-export-get-ordinal
901 datum info nil
#'org-ascii--has-caption-p
))
902 ;; If destination is a target, make sure we can name the
903 ;; container it refers to.
905 (org-element-lineage datum
906 '(headline paragraph src-block table
) t
)))
907 (pcase (org-element-type enumerable
)
909 (format (org-ascii--translate "See section %s" info
)
910 (if (org-export-numbered-headline-p enumerable info
)
911 (mapconcat #'number-to-string number
".")
913 (org-element-property :title enumerable
) info
))))
914 ((guard (not number
))
915 (org-ascii--translate "Unknown reference" info
))
917 (format (org-ascii--translate "See figure %s" info
) number
))
919 (format (org-ascii--translate "See listing %s" info
) number
))
921 (format (org-ascii--translate "See table %s" info
) number
))
922 (_ (org-ascii--translate "Unknown reference" info
)))))))
924 (defun org-ascii--describe-links (links width info
)
925 "Return a string describing a list of links.
926 LINKS is a list of link type objects, as returned by
927 `org-ascii--unique-links'. WIDTH is the text width allowed for
928 the output string. INFO is a plist used as a communication
932 (let* ((type (org-element-property :type link
))
933 (description (org-element-contents link
))
934 (anchor (org-export-data
935 (or description
(org-element-property :raw-link link
))
938 ((member type
'("coderef" "radio")) nil
)
939 ((member type
'("custom-id" "fuzzy" "id"))
940 ;; Only links with a description need an entry. Other are
941 ;; already handled in `org-ascii-link'.
943 (let ((dest (if (equal type
"fuzzy")
944 (org-export-resolve-fuzzy-link link info
)
945 (org-export-resolve-id-link link info
))))
947 (org-ascii--fill-string
948 (format "[%s] %s" anchor
(org-ascii--describe-datum dest info
))
951 ;; Do not add a link that cannot be resolved and doesn't have
952 ;; any description: destination is already visible in the
954 ((not (org-element-contents link
)) nil
)
955 ;; Do not add a link already handled by custom export
957 ((org-export-custom-protocol-maybe link anchor
'ascii
) nil
)
960 (org-ascii--fill-string
961 (format "[%s] <%s>" anchor
(org-element-property :raw-link link
))
966 (defun org-ascii--checkbox (item info
)
967 "Return checkbox string for ITEM or nil.
968 INFO is a plist used as a communication channel."
969 (let ((utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
)))
970 (pcase (org-element-property :checkbox item
)
971 (`on
(if utf8p
"☑ " "[X] "))
972 (`off
(if utf8p
"☐ " "[ ] "))
973 (`trans
(if utf8p
"☒ " "[-] ")))))
979 (defun org-ascii-template--document-title (info)
980 "Return document title, as a string.
981 INFO is a plist used as a communication channel."
982 (let* ((text-width (plist-get info
:ascii-text-width
))
983 ;; Links in the title will not be resolved later, so we make
984 ;; sure their path is located right after them.
985 (info (org-combine-plists info
'(:ascii-links-to-notes nil
)))
986 (with-title (plist-get info
:with-title
))
987 (title (org-export-data
988 (when with-title
(plist-get info
:title
)) info
))
989 (subtitle (org-export-data
990 (when with-title
(plist-get info
:subtitle
)) info
))
991 (author (and (plist-get info
:with-author
)
992 (let ((auth (plist-get info
:author
)))
993 (and auth
(org-export-data auth info
)))))
994 (email (and (plist-get info
:with-email
)
995 (org-export-data (plist-get info
:email
) info
)))
996 (date (and (plist-get info
:with-date
)
997 (org-export-data (org-export-get-date info
) info
))))
998 ;; There are two types of title blocks depending on the presence
999 ;; of a title to display.
1000 (if (string= title
"")
1001 ;; Title block without a title. DATE is positioned at the top
1002 ;; right of the document, AUTHOR to the top left and EMAIL
1005 ((and (org-string-nw-p date
) (org-string-nw-p author
))
1008 (make-string (- text-width
(string-width date
) (string-width author
))
1011 (when (org-string-nw-p email
) (concat "\n" email
))
1013 ((and (org-string-nw-p date
) (org-string-nw-p email
))
1016 (make-string (- text-width
(string-width date
) (string-width email
))
1019 ((org-string-nw-p date
)
1021 (org-ascii--justify-lines date text-width
'right
)
1023 ((and (org-string-nw-p author
) (org-string-nw-p email
))
1024 (concat author
"\n" email
"\n\n\n"))
1025 ((org-string-nw-p author
) (concat author
"\n\n\n"))
1026 ((org-string-nw-p email
) (concat email
"\n\n\n")))
1027 ;; Title block with a title. Document's TITLE, along with the
1028 ;; AUTHOR and its EMAIL are both overlined and an underlined,
1029 ;; centered. Date is just below, also centered.
1030 (let* ((utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
))
1031 ;; Format TITLE. It may be filled if it is too wide,
1032 ;; that is wider than the two thirds of the total width.
1033 (title-len (min (apply #'max
1036 (concat title
"\n" subtitle
) "\n")))
1037 (/ (* 2 text-width
) 3)))
1038 (formatted-title (org-ascii--fill-string title title-len info
))
1039 (formatted-subtitle (when (org-string-nw-p subtitle
)
1040 (org-ascii--fill-string subtitle title-len info
)))
1043 (min (+ (max title-len
1044 (string-width (or author
""))
1045 (string-width (or email
"")))
1047 text-width
) (if utf8p ?━ ?_
))))
1048 (org-ascii--justify-lines
1051 (upcase formatted-title
)
1052 (and formatted-subtitle
(concat "\n" formatted-subtitle
))
1054 ((and (org-string-nw-p author
) (org-string-nw-p email
))
1055 (concat "\n\n" author
"\n" email
))
1056 ((org-string-nw-p author
) (concat "\n\n" author
))
1057 ((org-string-nw-p email
) (concat "\n\n" email
)))
1059 (when (org-string-nw-p date
) (concat "\n\n\n" date
))
1060 "\n\n\n") text-width
'center
)))))
1062 (defun org-ascii-inner-template (contents info
)
1063 "Return complete document string after ASCII conversion.
1064 CONTENTS is the transcoded contents string. INFO is a plist
1065 holding export options."
1066 (org-element-normalize-string
1067 (let ((global-margin (plist-get info
:ascii-global-margin
)))
1068 (org-ascii--indent-string
1070 ;; 1. Document's body.
1072 ;; 2. Footnote definitions.
1073 (let ((definitions (org-export-collect-footnote-definitions info
))
1074 ;; Insert full links right inside the footnote definition
1075 ;; as they have no chance to be inserted later.
1076 (info (org-combine-plists info
'(:ascii-links-to-notes nil
))))
1080 (let ((title (org-ascii--translate "Footnotes" info
)))
1084 (string-width title
)
1085 (if (eq (plist-get info
:ascii-charset
) 'utf-8
) ?─ ?_
))))
1087 (let ((text-width (- (plist-get info
:ascii-text-width
)
1091 (let ((id (format "[%s] " (car ref
))))
1092 ;; Distinguish between inline definitions and
1093 ;; full-fledged definitions.
1095 (let ((def (nth 2 ref
)))
1096 (if (org-element-map def org-element-all-elements
1097 #'identity info
'first-match
)
1098 ;; Full-fledged definition: footnote ID is
1099 ;; inserted inside the first parsed
1100 ;; paragraph (FIRST), if any, to be sure
1101 ;; filling will take it into consideration.
1102 (let ((first (car (org-element-contents def
))))
1103 (if (not (eq (org-element-type first
) 'paragraph
))
1104 (concat id
"\n" (org-export-data def info
))
1105 (push id
(nthcdr 2 first
))
1106 (org-export-data def info
)))
1107 ;; Fill paragraph once footnote ID is inserted
1108 ;; in order to have a correct length for first
1110 (org-ascii--fill-string
1111 (concat id
(org-export-data def info
))
1112 text-width info
))))))
1113 definitions
"\n\n"))))))
1116 (defun org-ascii-template (contents info
)
1117 "Return complete document string after ASCII conversion.
1118 CONTENTS is the transcoded contents string. INFO is a plist
1119 holding export options."
1120 (let ((global-margin (plist-get info
:ascii-global-margin
)))
1122 ;; Build title block.
1123 (org-ascii--indent-string
1124 (concat (org-ascii-template--document-title info
)
1125 ;; 2. Table of contents.
1126 (let ((depth (plist-get info
:with-toc
)))
1129 (org-ascii--build-toc info
(and (wholenump depth
) depth
))
1134 ;; Creator. Justify it to the bottom right.
1135 (and (plist-get info
:with-creator
)
1136 (org-ascii--indent-string
1138 (- (plist-get info
:ascii-text-width
) global-margin
)))
1141 (org-ascii--fill-string
1142 (plist-get info
:creator
) text-width info
'right
)))
1145 (defun org-ascii--translate (s info
)
1146 "Translate string S according to specified language and charset.
1147 INFO is a plist used as a communication channel."
1148 (let ((charset (intern (format ":%s" (plist-get info
:ascii-charset
)))))
1149 (org-export-translate s charset info
)))
1153 ;;; Transcode Functions
1157 (defun org-ascii-bold (_bold contents _info
)
1158 "Transcode BOLD from Org to ASCII.
1159 CONTENTS is the text with bold markup. INFO is a plist holding
1160 contextual information."
1161 (format "*%s*" contents
))
1166 (defun org-ascii-center-block (_center-block contents _info
)
1167 "Transcode a CENTER-BLOCK element from Org to ASCII.
1168 CONTENTS holds the contents of the block. INFO is a plist
1169 holding contextual information."
1170 ;; Center has already been taken care of at a lower level, so
1171 ;; there's nothing left to do.
1177 (defun org-ascii-clock (clock _contents info
)
1178 "Transcode a CLOCK object from Org to ASCII.
1179 CONTENTS is nil. INFO is a plist holding contextual
1181 (org-ascii--justify-element
1182 (concat org-clock-string
" "
1183 (org-timestamp-translate (org-element-property :value clock
))
1184 (let ((time (org-element-property :duration clock
)))
1189 (org-split-string time
":"))))))
1195 (defun org-ascii-code (code _contents info
)
1196 "Return a CODE object from Org to ASCII.
1197 CONTENTS is nil. INFO is a plist holding contextual
1199 (format (plist-get info
:ascii-verbatim-format
)
1200 (org-element-property :value code
)))
1205 (defun org-ascii-drawer (drawer contents info
)
1206 "Transcode a DRAWER element from Org to ASCII.
1207 CONTENTS holds the contents of the block. INFO is a plist
1208 holding contextual information."
1209 (let ((name (org-element-property :drawer-name drawer
))
1210 (width (org-ascii--current-text-width drawer info
)))
1211 (funcall (plist-get info
:ascii-format-drawer-function
)
1212 name contents width
)))
1217 (defun org-ascii-dynamic-block (_dynamic-block contents _info
)
1218 "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
1219 CONTENTS holds the contents of the block. INFO is a plist
1220 holding contextual information."
1226 (defun org-ascii-entity (entity _contents info
)
1227 "Transcode an ENTITY object from Org to ASCII.
1228 CONTENTS are the definition itself. INFO is a plist holding
1229 contextual information."
1230 (org-element-property
1231 (intern (concat ":" (symbol-name (plist-get info
:ascii-charset
))))
1237 (defun org-ascii-example-block (example-block _contents info
)
1238 "Transcode a EXAMPLE-BLOCK 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-export-format-code-default example-block info
) info
)
1243 example-block info
))
1248 (defun org-ascii-export-snippet (export-snippet _contents _info
)
1249 "Transcode a EXPORT-SNIPPET object from Org to ASCII.
1250 CONTENTS is nil. INFO is a plist holding contextual information."
1251 (when (eq (org-export-snippet-backend export-snippet
) 'ascii
)
1252 (org-element-property :value export-snippet
)))
1257 (defun org-ascii-export-block (export-block _contents info
)
1258 "Transcode a EXPORT-BLOCK element from Org to ASCII.
1259 CONTENTS is nil. INFO is a plist holding contextual information."
1260 (when (string= (org-element-property :type export-block
) "ASCII")
1261 (org-ascii--justify-element
1262 (org-element-property :value export-block
) export-block info
)))
1267 (defun org-ascii-fixed-width (fixed-width _contents info
)
1268 "Transcode a FIXED-WIDTH element from Org to ASCII.
1269 CONTENTS is nil. INFO is a plist holding contextual information."
1270 (org-ascii--justify-element
1271 (org-ascii--box-string
1272 (org-remove-indentation
1273 (org-element-property :value fixed-width
)) info
)
1277 ;;;; Footnote Definition
1279 ;; Footnote Definitions are ignored. They are compiled at the end of
1280 ;; the document, by `org-ascii-inner-template'.
1283 ;;;; Footnote Reference
1285 (defun org-ascii-footnote-reference (footnote-reference _contents info
)
1286 "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
1287 CONTENTS is nil. INFO is a plist holding contextual information."
1288 (format "[%s]" (org-export-get-footnote-number footnote-reference info
)))
1293 (defun org-ascii-headline (headline contents info
)
1294 "Transcode a HEADLINE element from Org to ASCII.
1295 CONTENTS holds the contents of the headline. INFO is a plist
1296 holding contextual information."
1297 ;; Don't export footnote section, which will be handled at the end
1299 (unless (org-element-property :footnote-section-p headline
)
1300 (let* ((low-level (org-export-low-level-p headline info
))
1301 (width (org-ascii--current-text-width headline info
))
1302 ;; Export title early so that any link in it can be
1303 ;; exported and seen in `org-ascii--unique-links'.
1304 (title (org-ascii--build-title headline info width
(not low-level
)))
1305 ;; Blank lines between headline and its contents.
1306 ;; `org-ascii-headline-spacing', when set, overwrites
1307 ;; original buffer's spacing.
1309 (make-string (or (car (plist-get info
:ascii-headline-spacing
))
1310 (org-element-property :pre-blank headline
)
1313 (links (and (plist-get info
:ascii-links-to-notes
)
1314 (org-ascii--describe-links
1315 (org-ascii--unique-links headline info
) width info
)))
1316 ;; Re-build contents, inserting section links at the right
1317 ;; place. The cost is low since build results are cached.
1319 (if (not (org-string-nw-p links
)) contents
1320 (let* ((contents (org-element-contents headline
))
1321 (section (let ((first (car contents
)))
1322 (and (eq (org-element-type first
) 'section
)
1324 (concat (and section
1325 (concat (org-element-normalize-string
1326 (org-export-data section info
))
1329 (mapconcat (lambda (e) (org-export-data e info
))
1330 (if section
(cdr contents
) contents
)
1332 ;; Deep subtree: export it as a list item.
1334 (let* ((bullets (cdr (assq (plist-get info
:ascii-charset
)
1335 (plist-get info
:ascii-bullets
))))
1338 (nth (mod (1- low-level
) (length bullets
)) bullets
))))
1339 (concat bullet title
"\n" pre-blanks
1340 ;; Contents, indented by length of bullet.
1341 (org-ascii--indent-string body
(length bullet
))))
1342 ;; Else: Standard headline.
1343 (concat title
"\n" pre-blanks body
)))))
1346 ;;;; Horizontal Rule
1348 (defun org-ascii-horizontal-rule (horizontal-rule _contents info
)
1349 "Transcode an HORIZONTAL-RULE object from Org to ASCII.
1350 CONTENTS is nil. INFO is a plist holding contextual
1352 (let ((text-width (org-ascii--current-text-width horizontal-rule info
))
1354 (org-export-read-attribute :attr_ascii horizontal-rule
:width
)))
1355 (org-ascii--justify-lines
1356 (make-string (if (and spec-width
(string-match "^[0-9]+$" spec-width
))
1357 (string-to-number spec-width
)
1359 (if (eq (plist-get info
:ascii-charset
) 'utf-8
) ?― ?-
))
1360 text-width
'center
)))
1363 ;;;; Inline Src Block
1365 (defun org-ascii-inline-src-block (inline-src-block _contents info
)
1366 "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
1367 CONTENTS holds the contents of the item. INFO is a plist holding
1368 contextual information."
1369 (format (plist-get info
:ascii-verbatim-format
)
1370 (org-element-property :value inline-src-block
)))
1375 (defun org-ascii-format-inlinetask-default
1376 (_todo _type _priority _name _tags contents width inlinetask info
)
1377 "Format an inline task element for ASCII export.
1378 See `org-ascii-format-inlinetask-function' for a description
1380 (let* ((utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
))
1381 (width (or width
(plist-get info
:ascii-inlinetask-width
))))
1382 (org-ascii--indent-string
1384 ;; Top line, with an additional blank line if not in UTF-8.
1385 (make-string width
(if utf8p ?━ ?_
)) "\n"
1386 (unless utf8p
(concat (make-string width ?
) "\n"))
1387 ;; Add title. Fill it if wider than inlinetask.
1388 (let ((title (org-ascii--build-title inlinetask info width
)))
1389 (if (<= (string-width title
) width
) title
1390 (org-ascii--fill-string title width info
)))
1392 ;; If CONTENTS is not empty, insert it along with
1394 (when (org-string-nw-p contents
)
1395 (concat (make-string width
(if utf8p ?─ ?-
)) "\n" contents
))
1397 (make-string width
(if utf8p ?━ ?_
)))
1398 ;; Flush the inlinetask to the right.
1399 (- (plist-get info
:ascii-text-width
) (plist-get info
:ascii-global-margin
)
1400 (if (not (org-export-get-parent-headline inlinetask
)) 0
1401 (plist-get info
:ascii-inner-margin
))
1402 (org-ascii--current-text-width inlinetask info
)))))
1404 (defun org-ascii-inlinetask (inlinetask contents info
)
1405 "Transcode an INLINETASK element from Org to ASCII.
1406 CONTENTS holds the contents of the block. INFO is a plist
1407 holding contextual information."
1408 (let ((width (org-ascii--current-text-width inlinetask info
)))
1409 (funcall (plist-get info
:ascii-format-inlinetask-function
)
1411 (and (plist-get info
:with-todo-keywords
)
1412 (let ((todo (org-element-property
1413 :todo-keyword inlinetask
)))
1414 (and todo
(org-export-data todo info
))))
1416 (org-element-property :todo-type inlinetask
)
1418 (and (plist-get info
:with-priority
)
1419 (org-element-property :priority inlinetask
))
1421 (org-export-data (org-element-property :title inlinetask
) info
)
1423 (and (plist-get info
:with-tags
)
1424 (org-element-property :tags inlinetask
))
1425 ;; contents and width
1426 contents width inlinetask info
)))
1431 (defun org-ascii-italic (_italic contents _info
)
1432 "Transcode italic from Org to ASCII.
1433 CONTENTS is the text with italic markup. INFO is a plist holding
1434 contextual information."
1435 (format "/%s/" contents
))
1440 (defun org-ascii-item (item contents info
)
1441 "Transcode an ITEM element from Org to ASCII.
1442 CONTENTS holds the contents of the item. INFO is a plist holding
1443 contextual information."
1444 (let* ((utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
))
1445 (checkbox (org-ascii--checkbox item info
))
1446 (list-type (org-element-property :type
(org-export-get-parent item
)))
1448 ;; First parent of ITEM is always the plain-list. Get
1449 ;; `:type' property from it.
1453 (org-export-data (org-element-property :tag item
)
1456 ;; Return correct number for ITEM, paying attention to
1458 (let* ((struct (org-element-property :structure item
))
1459 (bul (org-list-bullet-string
1460 (org-element-property :bullet item
)))
1461 (num (number-to-string
1462 (car (last (org-list-get-item-number
1463 (org-element-property :begin item
)
1465 (org-list-prevs-alist struct
)
1466 (org-list-parents-alist struct
)))))))
1467 (replace-regexp-in-string "[0-9]+" num bul
)))
1468 (_ (let ((bul (org-list-bullet-string
1469 (org-element-property :bullet item
))))
1470 ;; Change bullets into more visible form if UTF-8 is active.
1472 (replace-regexp-in-string
1474 (replace-regexp-in-string
1476 (replace-regexp-in-string "*" "‣" bul
))))))))
1477 (indentation (if (eq list-type
'descriptive
) org-ascii-quote-margin
1478 (string-width bullet
))))
1482 ;; Contents: Pay attention to indentation. Note: check-boxes are
1483 ;; already taken care of at the paragraph level so they don't
1484 ;; interfere with indentation.
1485 (let ((contents (org-ascii--indent-string contents indentation
)))
1486 ;; Determine if contents should follow the bullet or start
1487 ;; a new line. Do the former when the first contributing
1488 ;; element to contents is a paragraph. In descriptive lists
1489 ;; however, contents always start a new line.
1490 (if (and (not (eq list-type
'descriptive
))
1491 (org-string-nw-p contents
)
1494 (cl-some (lambda (e)
1495 (and (org-string-nw-p (org-export-data e info
))
1497 (org-element-contents item
)))))
1499 (concat "\n" contents
))))))
1504 (defun org-ascii-keyword (keyword _contents info
)
1505 "Transcode a KEYWORD element from Org to ASCII.
1506 CONTENTS is nil. INFO is a plist holding contextual
1508 (let ((key (org-element-property :key keyword
))
1509 (value (org-element-property :value keyword
)))
1511 ((string= key
"ASCII") (org-ascii--justify-element value keyword info
))
1512 ((string= key
"TOC")
1513 (org-ascii--justify-element
1514 (let ((case-fold-search t
))
1516 ((string-match-p "\\<headlines\\>" value
)
1517 (let ((depth (and (string-match "\\<[0-9]+\\>" value
)
1518 (string-to-number (match-string 0 value
))))
1519 (localp (string-match-p "\\<local\\>" value
)))
1520 (org-ascii--build-toc info depth keyword localp
)))
1521 ((string-match-p "\\<tables\\>" value
)
1522 (org-ascii--list-tables keyword info
))
1523 ((string-match-p "\\<listings\\>" value
)
1524 (org-ascii--list-listings keyword info
))))
1528 ;;;; Latex Environment
1530 (defun org-ascii-latex-environment (latex-environment _contents info
)
1531 "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
1532 CONTENTS is nil. INFO is a plist holding contextual
1534 (when (plist-get info
:with-latex
)
1535 (org-ascii--justify-element
1536 (org-remove-indentation (org-element-property :value latex-environment
))
1537 latex-environment info
)))
1542 (defun org-ascii-latex-fragment (latex-fragment _contents info
)
1543 "Transcode a LATEX-FRAGMENT object from Org to ASCII.
1544 CONTENTS is nil. INFO is a plist holding contextual
1546 (when (plist-get info
:with-latex
)
1547 (org-element-property :value latex-fragment
)))
1552 (defun org-ascii-line-break (_line-break _contents _info
)
1553 "Transcode a LINE-BREAK object from Org to ASCII.
1554 CONTENTS is nil. INFO is a plist holding contextual
1555 information." hard-newline
)
1560 (defun org-ascii-link (link desc info
)
1561 "Transcode a LINK object from Org to ASCII.
1563 DESC is the description part of the link, or the empty string.
1564 INFO is a plist holding contextual information."
1565 (let ((type (org-element-property :type link
)))
1567 ((org-export-custom-protocol-maybe link desc
'ascii
))
1568 ((string= type
"coderef")
1569 (let ((ref (org-element-property :path link
)))
1570 (format (org-export-get-coderef-format ref desc
)
1571 (org-export-resolve-coderef ref info
))))
1572 ;; Do not apply a special syntax on radio links. Though, use
1573 ;; transcoded target's contents as output.
1574 ((string= type
"radio") desc
)
1575 ((member type
'("custom-id" "fuzzy" "id"))
1576 (let ((destination (if (string= type
"fuzzy")
1577 (org-export-resolve-fuzzy-link link info
)
1578 (org-export-resolve-id-link link info
))))
1579 (pcase (org-element-type destination
)
1581 (if (plist-get info
:ascii-links-to-notes
)
1582 (format "[%s]" desc
)
1585 (org-ascii--describe-datum destination info
)))))
1587 (`plain-text destination
)
1589 (if (org-export-numbered-headline-p destination info
)
1590 (mapconcat #'number-to-string
1591 (org-export-get-headline-number destination info
)
1593 (org-export-data (org-element-property :title destination
) info
)))
1594 ;; Handle enumerable elements and targets within them.
1595 ((and (let number
(org-export-get-ordinal
1596 destination info nil
#'org-ascii--has-caption-p
))
1598 (if (atom number
) (number-to-string number
)
1599 (mapconcat #'number-to-string number
".")))
1600 ;; Don't know what to do. Signal it.
1603 (let ((raw-link (org-element-property :raw-link link
)))
1604 (if (not (org-string-nw-p desc
)) (format "<%s>" raw-link
)
1605 (concat (format "[%s]" desc
)
1606 (and (not (plist-get info
:ascii-links-to-notes
))
1607 (format " (<%s>)" raw-link
)))))))))
1610 ;;;; Node Properties
1612 (defun org-ascii-node-property (node-property _contents _info
)
1613 "Transcode a NODE-PROPERTY element from Org to ASCII.
1614 CONTENTS is nil. INFO is a plist holding contextual
1617 (org-element-property :key node-property
)
1618 (let ((value (org-element-property :value node-property
)))
1619 (if value
(concat " " value
) ""))))
1624 (defun org-ascii-paragraph (paragraph contents info
)
1625 "Transcode a PARAGRAPH element from Org to ASCII.
1626 CONTENTS is the contents of the paragraph, as a string. INFO is
1627 the plist used as a communication channel."
1628 (org-ascii--justify-element
1629 (let ((indented-line-width (plist-get info
:ascii-indented-line-width
)))
1630 (if (not (wholenump indented-line-width
)) contents
1632 ;; Do not indent first paragraph in a section.
1633 (unless (and (not (org-export-get-previous-element paragraph info
))
1634 (eq (org-element-type (org-export-get-parent paragraph
))
1636 (make-string indented-line-width ?\s
))
1637 (replace-regexp-in-string "\\`[ \t]+" "" contents
))))
1643 (defun org-ascii-plain-list (plain-list contents info
)
1644 "Transcode a PLAIN-LIST element from Org to ASCII.
1645 CONTENTS is the contents of the list. INFO is a plist holding
1646 contextual information."
1647 (let ((margin (plist-get info
:ascii-list-margin
)))
1648 (if (or (< margin
1)
1649 (eq (org-element-type (org-export-get-parent plain-list
)) 'item
))
1651 (org-ascii--indent-string contents margin
))))
1656 (defun org-ascii-plain-text (text info
)
1657 "Transcode a TEXT string from Org to ASCII.
1658 INFO is a plist used as a communication channel."
1659 (let ((utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
)))
1660 (when (and utf8p
(plist-get info
:with-smart-quotes
))
1661 (setq text
(org-export-activate-smart-quotes text
:utf-8 info
)))
1662 (if (not (plist-get info
:with-special-strings
)) text
1663 (setq text
(replace-regexp-in-string "\\\\-" "" text
))
1664 (if (not utf8p
) text
1665 ;; Usual replacements in utf-8 with proper option set.
1666 (replace-regexp-in-string
1668 (replace-regexp-in-string
1670 (replace-regexp-in-string "---" "—" text
)))))))
1675 (defun org-ascii-planning (planning _contents info
)
1676 "Transcode a PLANNING element from Org to ASCII.
1677 CONTENTS is nil. INFO is a plist used as a communication
1679 (org-ascii--justify-element
1683 (list (let ((closed (org-element-property :closed planning
)))
1685 (concat org-closed-string
" "
1686 (org-timestamp-translate closed
))))
1687 (let ((deadline (org-element-property :deadline planning
)))
1689 (concat org-deadline-string
" "
1690 (org-timestamp-translate deadline
))))
1691 (let ((scheduled (org-element-property :scheduled planning
)))
1693 (concat org-scheduled-string
" "
1694 (org-timestamp-translate scheduled
))))))
1699 ;;;; Property Drawer
1701 (defun org-ascii-property-drawer (property-drawer contents info
)
1702 "Transcode a PROPERTY-DRAWER element from Org to ASCII.
1703 CONTENTS holds the contents of the drawer. INFO is a plist
1704 holding contextual information."
1705 (and (org-string-nw-p contents
)
1706 (org-ascii--justify-element contents property-drawer info
)))
1711 (defun org-ascii-quote-block (_quote-block contents info
)
1712 "Transcode a QUOTE-BLOCK element from Org to ASCII.
1713 CONTENTS holds the contents of the block. INFO is a plist
1714 holding contextual information."
1715 (org-ascii--indent-string contents
(plist-get info
:ascii-quote-margin
)))
1720 (defun org-ascii-radio-target (_radio-target contents _info
)
1721 "Transcode a RADIO-TARGET object from Org to ASCII.
1722 CONTENTS is the contents of the target. INFO is a plist holding
1723 contextual information."
1729 (defun org-ascii-section (section contents info
)
1730 "Transcode a SECTION element from Org to ASCII.
1731 CONTENTS is the contents of the section. INFO is a plist holding
1732 contextual information."
1734 (and (plist-get info
:ascii-links-to-notes
)
1735 ;; Take care of links in first section of the document.
1736 (not (org-element-lineage section
'(headline)))
1737 (org-ascii--describe-links
1738 (org-ascii--unique-links section info
)
1739 (org-ascii--current-text-width section info
)
1741 (org-ascii--indent-string
1742 (if (not (org-string-nw-p links
)) contents
1743 (concat (org-element-normalize-string contents
) "\n\n" links
))
1744 ;; Do not apply inner margin if parent headline is low level.
1745 (let ((headline (org-export-get-parent-headline section
)))
1746 (if (or (not headline
) (org-export-low-level-p headline info
)) 0
1747 (plist-get info
:ascii-inner-margin
))))))
1752 (defun org-ascii-special-block (_special-block contents _info
)
1753 "Transcode a SPECIAL-BLOCK element from Org to ASCII.
1754 CONTENTS holds the contents of the block. INFO is a plist
1755 holding contextual information."
1756 ;; "JUSTIFYLEFT" and "JUSTIFYRIGHT" have already been taken care of
1757 ;; at a lower level. There is no other special block type to
1764 (defun org-ascii-src-block (src-block _contents info
)
1765 "Transcode a SRC-BLOCK element from Org to ASCII.
1766 CONTENTS holds the contents of the item. INFO is a plist holding
1767 contextual information."
1768 (let ((caption (org-ascii--build-caption src-block info
))
1769 (caption-above-p (plist-get info
:ascii-caption-above
))
1770 (code (org-export-format-code-default src-block info
)))
1771 (if (equal code
"") ""
1772 (org-ascii--justify-element
1774 (and caption caption-above-p
(concat caption
"\n"))
1775 (org-ascii--box-string code info
)
1776 (and caption
(not caption-above-p
) (concat "\n" caption
)))
1780 ;;;; Statistics Cookie
1782 (defun org-ascii-statistics-cookie (statistics-cookie _contents _info
)
1783 "Transcode a STATISTICS-COOKIE object from Org to ASCII.
1784 CONTENTS is nil. INFO is a plist holding contextual information."
1785 (org-element-property :value statistics-cookie
))
1790 (defun org-ascii-subscript (subscript contents _info
)
1791 "Transcode a SUBSCRIPT object from Org to ASCII.
1792 CONTENTS is the contents of the object. INFO is a plist holding
1793 contextual information."
1794 (if (org-element-property :use-brackets-p subscript
)
1795 (format "_{%s}" contents
)
1796 (format "_%s" contents
)))
1801 (defun org-ascii-superscript (superscript contents _info
)
1802 "Transcode a SUPERSCRIPT object from Org to ASCII.
1803 CONTENTS is the contents of the object. INFO is a plist holding
1804 contextual information."
1805 (if (org-element-property :use-brackets-p superscript
)
1806 (format "^{%s}" contents
)
1807 (format "^%s" contents
)))
1812 (defun org-ascii-strike-through (_strike-through contents _info
)
1813 "Transcode STRIKE-THROUGH from Org to ASCII.
1814 CONTENTS is text with strike-through markup. INFO is a plist
1815 holding contextual information."
1816 (format "+%s+" contents
))
1821 (defun org-ascii-table (table contents info
)
1822 "Transcode a TABLE element from Org to ASCII.
1823 CONTENTS is the contents of the table. INFO is a plist holding
1824 contextual information."
1825 (let ((caption (org-ascii--build-caption table info
))
1826 (caption-above-p (plist-get info
:ascii-caption-above
)))
1827 (org-ascii--justify-element
1829 ;; Possibly add a caption string above.
1830 (and caption caption-above-p
(concat caption
"\n"))
1831 ;; Insert table. Note: "table.el" tables are left unmodified.
1832 (cond ((eq (org-element-property :type table
) 'org
) contents
)
1833 ((and (plist-get info
:ascii-table-use-ascii-art
)
1834 (eq (plist-get info
:ascii-charset
) 'utf-8
)
1835 (require 'ascii-art-to-unicode nil t
))
1837 (insert (org-remove-indentation
1838 (org-element-property :value table
)))
1839 (goto-char (point-min))
1841 (goto-char (point-max))
1842 (skip-chars-backward " \r\t\n")
1843 (buffer-substring (point-min) (point))))
1844 (t (org-remove-indentation (org-element-property :value table
))))
1845 ;; Possible add a caption string below.
1846 (and (not caption-above-p
) caption
))
1852 (defun org-ascii--table-cell-width (table-cell info
)
1853 "Return width of TABLE-CELL.
1855 INFO is a plist used as a communication channel.
1857 Width of a cell is determined either by a width cookie in the
1858 same column as the cell, or by the maximum cell's length in that
1861 When `org-ascii-table-widen-columns' is non-nil, width cookies
1863 (let* ((row (org-export-get-parent table-cell
))
1864 (table (org-export-get-parent row
))
1865 (col (let ((cells (org-element-contents row
)))
1866 (- (length cells
) (length (memq table-cell cells
)))))
1868 (or (plist-get info
:ascii-table-cell-width-cache
)
1869 (plist-get (setq info
1870 (plist-put info
:ascii-table-cell-width-cache
1871 (make-hash-table :test
'equal
)))
1872 :ascii-table-cell-width-cache
)))
1873 (key (cons table col
))
1874 (widenp (plist-get info
:ascii-table-widen-columns
)))
1875 (or (gethash key cache
)
1878 (let ((cookie-width (org-export-table-cell-width table-cell info
)))
1879 (or (and (not widenp
) cookie-width
)
1880 (let ((contents-width
1881 (let ((max-width 0))
1882 (org-element-map table
'table-row
1887 (org-element-contents
1888 (elt (org-element-contents row
) col
))
1893 (cond ((not cookie-width
) contents-width
)
1894 (widenp (max cookie-width contents-width
))
1895 (t cookie-width
)))))
1898 (defun org-ascii-table-cell (table-cell contents info
)
1899 "Transcode a TABLE-CELL object from Org to ASCII.
1900 CONTENTS is the cell contents. INFO is a plist used as
1901 a communication channel."
1902 ;; Determine column width. When `org-ascii-table-widen-columns'
1903 ;; is nil and some width cookie has set it, use that value.
1904 ;; Otherwise, compute the maximum width among transcoded data of
1905 ;; each cell in the column.
1906 (let ((width (org-ascii--table-cell-width table-cell info
)))
1907 ;; When contents are too large, truncate them.
1908 (unless (or (plist-get info
:ascii-table-widen-columns
)
1909 (<= (string-width (or contents
"")) width
))
1910 (setq contents
(concat (substring contents
0 (- width
2)) "=>")))
1911 ;; Align contents correctly within the cell.
1912 (let* ((indent-tabs-mode nil
)
1915 (org-ascii--justify-lines
1917 (org-export-table-cell-alignment table-cell info
)))))
1920 (make-string (- width
(string-width (or data
""))) ?\s
))))
1922 (concat (format " %s " contents
)
1923 (when (memq 'right
(org-export-table-cell-borders table-cell info
))
1924 (if (eq (plist-get info
:ascii-charset
) 'utf-8
) "│" "|")))))
1929 (defun org-ascii-table-row (table-row contents info
)
1930 "Transcode a TABLE-ROW element from Org to ASCII.
1931 CONTENTS is the row contents. INFO is a plist used as
1932 a communication channel."
1933 (when (eq (org-element-property :type table-row
) 'standard
)
1936 (lambda (lcorner horiz vert rcorner
)
1940 (org-element-map table-row
'table-cell
1942 (let ((width (org-ascii--table-cell-width cell info
))
1943 (borders (org-export-table-cell-borders cell info
)))
1945 ;; In order to know if CELL starts the row, do
1946 ;; not compare it with the first cell in the
1947 ;; row as there might be a special column.
1948 ;; Instead, compare it with first exportable
1949 ;; cell, obtained with `org-element-map'.
1950 (when (and (memq 'left borders
)
1951 (eq (org-element-map table-row
'table-cell
1955 (make-string (+ 2 width
) (string-to-char horiz
))
1957 ((not (memq 'right borders
)) nil
)
1958 ((eq (car (last (org-element-contents table-row
))) cell
)
1962 (utf8p (eq (plist-get info
:ascii-charset
) 'utf-8
))
1963 (borders (org-export-table-cell-borders
1964 (org-element-map table-row
'table-cell
'identity info t
)
1967 ((and (memq 'top borders
) (or utf8p
(memq 'above borders
)))
1968 (if utf8p
(funcall build-hline
"┍" "━" "┯" "┑")
1969 (funcall build-hline
"+" "-" "+" "+")))
1970 ((memq 'above borders
)
1971 (if utf8p
(funcall build-hline
"├" "─" "┼" "┤")
1972 (funcall build-hline
"+" "-" "+" "+"))))
1973 (when (memq 'left borders
) (if utf8p
"│" "|"))
1975 (when (and (memq 'bottom borders
) (or utf8p
(memq 'below borders
)))
1976 (if utf8p
(funcall build-hline
"┕" "━" "┷" "┙")
1977 (funcall build-hline
"+" "-" "+" "+")))))))
1982 (defun org-ascii-timestamp (timestamp _contents info
)
1983 "Transcode a TIMESTAMP object from Org to ASCII.
1984 CONTENTS is nil. INFO is a plist holding contextual information."
1985 (org-ascii-plain-text (org-timestamp-translate timestamp
) info
))
1990 (defun org-ascii-underline (_underline contents _info
)
1991 "Transcode UNDERLINE from Org to ASCII.
1992 CONTENTS is the text with underline markup. INFO is a plist
1993 holding contextual information."
1994 (format "_%s_" contents
))
1999 (defun org-ascii-verbatim (verbatim _contents info
)
2000 "Return a VERBATIM object from Org to ASCII.
2001 CONTENTS is nil. INFO is a plist holding contextual information."
2002 (format (plist-get info
:ascii-verbatim-format
)
2003 (org-element-property :value verbatim
)))
2008 (defun org-ascii-verse-block (verse-block contents info
)
2009 "Transcode a VERSE-BLOCK element from Org to ASCII.
2010 CONTENTS is verse block contents. INFO is a plist holding
2011 contextual information."
2012 (org-ascii--indent-string
2013 (org-ascii--justify-element contents verse-block info
)
2014 (plist-get info
:ascii-quote-margin
)))
2020 (defun org-ascii-filter-headline-blank-lines (headline _backend info
)
2021 "Filter controlling number of blank lines after a headline.
2023 HEADLINE is a string representing a transcoded headline. BACKEND
2024 is symbol specifying back-end used for export. INFO is plist
2025 containing the communication channel.
2027 This function only applies to `ascii' back-end. See
2028 `org-ascii-headline-spacing' for information."
2029 (let ((headline-spacing (plist-get info
:ascii-headline-spacing
)))
2030 (if (not headline-spacing
) headline
2031 (let ((blanks (make-string (1+ (cdr headline-spacing
)) ?
\n)))
2032 (replace-regexp-in-string "\n\\(?:\n[ \t]*\\)*\\'" blanks headline
)))))
2034 (defun org-ascii-filter-paragraph-spacing (tree _backend info
)
2035 "Filter controlling number of blank lines between paragraphs.
2037 TREE is the parse tree. BACKEND is the symbol specifying
2038 back-end used for export. INFO is a plist used as
2039 a communication channel.
2041 See `org-ascii-paragraph-spacing' for information."
2042 (let ((paragraph-spacing (plist-get info
:ascii-paragraph-spacing
)))
2043 (when (wholenump paragraph-spacing
)
2044 (org-element-map tree
'paragraph
2046 (when (eq (org-element-type (org-export-get-next-element p info
))
2048 (org-element-put-property p
:post-blank paragraph-spacing
))))))
2051 (defun org-ascii-filter-comment-spacing (tree _backend info
)
2052 "Filter removing blank lines between comments.
2053 TREE is the parse tree. BACKEND is the symbol specifying
2054 back-end used for export. INFO is a plist used as
2055 a communication channel."
2056 (org-element-map tree
'(comment comment-block
)
2058 (when (memq (org-element-type (org-export-get-next-element c info
))
2059 '(comment comment-block
))
2060 (org-element-put-property c
:post-blank
0))))
2065 ;;; End-user functions
2068 (defun org-ascii-export-as-ascii
2069 (&optional async subtreep visible-only body-only ext-plist
)
2070 "Export current buffer to a text buffer.
2072 If narrowing is active in the current buffer, only export its
2075 If a region is active, export that region.
2077 A non-nil optional argument ASYNC means the process should happen
2078 asynchronously. The resulting buffer should be accessible
2079 through the `org-export-stack' interface.
2081 When optional argument SUBTREEP is non-nil, export the sub-tree
2082 at point, extracting information from the headline properties
2085 When optional argument VISIBLE-ONLY is non-nil, don't export
2086 contents of hidden elements.
2088 When optional argument BODY-ONLY is non-nil, strip title and
2089 table of contents from output.
2091 EXT-PLIST, when provided, is a property list with external
2092 parameters overriding Org default settings, but still inferior to
2093 file-local settings.
2095 Export is done in a buffer named \"*Org ASCII Export*\", which
2096 will be displayed when `org-export-show-temporary-export-buffer'
2099 (org-export-to-buffer 'ascii
"*Org ASCII Export*"
2100 async subtreep visible-only body-only ext-plist
(lambda () (text-mode))))
2103 (defun org-ascii-export-to-ascii
2104 (&optional async subtreep visible-only body-only ext-plist
)
2105 "Export current buffer to a text file.
2107 If narrowing is active in the current buffer, only export its
2110 If a region is active, export that region.
2112 A non-nil optional argument ASYNC means the process should happen
2113 asynchronously. The resulting file should be accessible through
2114 the `org-export-stack' interface.
2116 When optional argument SUBTREEP is non-nil, export the sub-tree
2117 at point, extracting information from the headline properties
2120 When optional argument VISIBLE-ONLY is non-nil, don't export
2121 contents of hidden elements.
2123 When optional argument BODY-ONLY is non-nil, strip title and
2124 table of contents from output.
2126 EXT-PLIST, when provided, is a property list with external
2127 parameters overriding Org default settings, but still inferior to
2128 file-local settings.
2130 Return output file's name."
2132 (let ((file (org-export-output-file-name ".txt" subtreep
)))
2133 (org-export-to-file 'ascii file
2134 async subtreep visible-only body-only ext-plist
)))
2137 (defun org-ascii-publish-to-ascii (plist filename pub-dir
)
2138 "Publish an Org file to ASCII.
2140 FILENAME is the filename of the Org file to be published. PLIST
2141 is the property list for the given project. PUB-DIR is the
2142 publishing directory.
2144 Return output file name."
2146 'ascii filename
".txt" `(:ascii-charset ascii
,@plist
) pub-dir
))
2149 (defun org-ascii-publish-to-latin1 (plist filename pub-dir
)
2150 "Publish an Org file to Latin-1.
2152 FILENAME is the filename of the Org file to be published. PLIST
2153 is the property list for the given project. PUB-DIR is the
2154 publishing directory.
2156 Return output file name."
2158 'ascii filename
".txt" `(:ascii-charset latin1
,@plist
) pub-dir
))
2161 (defun org-ascii-publish-to-utf8 (plist filename pub-dir
)
2162 "Publish an org file to UTF-8.
2164 FILENAME is the filename of the Org file to be published. PLIST
2165 is the property list for the given project. PUB-DIR is the
2166 publishing directory.
2168 Return output file name."
2170 'ascii filename
".txt" `(:ascii-charset utf-8
,@plist
) pub-dir
))
2176 ;; generated-autoload-file: "org-loaddefs.el"
2180 ;;; ox-ascii.el ends here