ox-ascii.el 74 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131
  1. ;;; ox-ascii.el --- ASCII Back-End for Org Export Engine
  2. ;; Copyright (C) 2012-2015 Free Software Foundation, Inc.
  3. ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; This file is part of GNU Emacs.
  6. ;; GNU Emacs is free software: you can redistribute it and/or modify
  7. ;; it under the terms of the GNU General Public License as published by
  8. ;; the Free Software Foundation, either version 3 of the License, or
  9. ;; (at your option) any later version.
  10. ;; GNU Emacs is distributed in the hope that it will be useful,
  11. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. ;; GNU General Public License for more details.
  14. ;; You should have received a copy of the GNU General Public License
  15. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  16. ;;; Commentary:
  17. ;;
  18. ;; This library implements an ASCII back-end for Org generic exporter.
  19. ;; See Org manual for more information.
  20. ;;; Code:
  21. (eval-when-compile (require 'cl))
  22. (require 'ox)
  23. (require 'ox-publish)
  24. (declare-function aa2u "ext:ascii-art-to-unicode" ())
  25. ;;; Define Back-End
  26. ;;
  27. ;; The following setting won't allow to modify preferred charset
  28. ;; through a buffer keyword or an option item, but, since the property
  29. ;; will appear in communication channel nonetheless, it allows to
  30. ;; override `org-ascii-charset' variable on the fly by the ext-plist
  31. ;; mechanism.
  32. ;;
  33. ;; We also install a filter for headlines and sections, in order to
  34. ;; control blank lines separating them in output string.
  35. (org-export-define-backend 'ascii
  36. '((bold . org-ascii-bold)
  37. (center-block . org-ascii-center-block)
  38. (clock . org-ascii-clock)
  39. (code . org-ascii-code)
  40. (comment . (lambda (&rest args) ""))
  41. (comment-block . (lambda (&rest args) ""))
  42. (drawer . org-ascii-drawer)
  43. (dynamic-block . org-ascii-dynamic-block)
  44. (entity . org-ascii-entity)
  45. (example-block . org-ascii-example-block)
  46. (export-block . org-ascii-export-block)
  47. (export-snippet . org-ascii-export-snippet)
  48. (fixed-width . org-ascii-fixed-width)
  49. (footnote-reference . org-ascii-footnote-reference)
  50. (headline . org-ascii-headline)
  51. (horizontal-rule . org-ascii-horizontal-rule)
  52. (inline-src-block . org-ascii-inline-src-block)
  53. (inlinetask . org-ascii-inlinetask)
  54. (inner-template . org-ascii-inner-template)
  55. (italic . org-ascii-italic)
  56. (item . org-ascii-item)
  57. (keyword . org-ascii-keyword)
  58. (latex-environment . org-ascii-latex-environment)
  59. (latex-fragment . org-ascii-latex-fragment)
  60. (line-break . org-ascii-line-break)
  61. (link . org-ascii-link)
  62. (node-property . org-ascii-node-property)
  63. (paragraph . org-ascii-paragraph)
  64. (plain-list . org-ascii-plain-list)
  65. (plain-text . org-ascii-plain-text)
  66. (planning . org-ascii-planning)
  67. (property-drawer . org-ascii-property-drawer)
  68. (quote-block . org-ascii-quote-block)
  69. (radio-target . org-ascii-radio-target)
  70. (section . org-ascii-section)
  71. (special-block . org-ascii-special-block)
  72. (src-block . org-ascii-src-block)
  73. (statistics-cookie . org-ascii-statistics-cookie)
  74. (strike-through . org-ascii-strike-through)
  75. (subscript . org-ascii-subscript)
  76. (superscript . org-ascii-superscript)
  77. (table . org-ascii-table)
  78. (table-cell . org-ascii-table-cell)
  79. (table-row . org-ascii-table-row)
  80. (target . org-ascii-target)
  81. (template . org-ascii-template)
  82. (timestamp . org-ascii-timestamp)
  83. (underline . org-ascii-underline)
  84. (verbatim . org-ascii-verbatim)
  85. (verse-block . org-ascii-verse-block))
  86. :export-block "ASCII"
  87. :menu-entry
  88. '(?t "Export to Plain Text"
  89. ((?A "As ASCII buffer"
  90. (lambda (a s v b)
  91. (org-ascii-export-as-ascii a s v b '(:ascii-charset ascii))))
  92. (?a "As ASCII file"
  93. (lambda (a s v b)
  94. (org-ascii-export-to-ascii a s v b '(:ascii-charset ascii))))
  95. (?L "As Latin1 buffer"
  96. (lambda (a s v b)
  97. (org-ascii-export-as-ascii a s v b '(:ascii-charset latin1))))
  98. (?l "As Latin1 file"
  99. (lambda (a s v b)
  100. (org-ascii-export-to-ascii a s v b '(:ascii-charset latin1))))
  101. (?U "As UTF-8 buffer"
  102. (lambda (a s v b)
  103. (org-ascii-export-as-ascii a s v b '(:ascii-charset utf-8))))
  104. (?u "As UTF-8 file"
  105. (lambda (a s v b)
  106. (org-ascii-export-to-ascii a s v b '(:ascii-charset utf-8))))))
  107. :filters-alist '((:filter-headline . org-ascii-filter-headline-blank-lines)
  108. (:filter-parse-tree org-ascii-filter-paragraph-spacing
  109. org-ascii-filter-comment-spacing)
  110. (:filter-section . org-ascii-filter-headline-blank-lines))
  111. :options-alist
  112. '((:ascii-bullets nil nil org-ascii-bullets)
  113. (:ascii-caption-above nil nil org-ascii-caption-above)
  114. (:ascii-charset nil nil org-ascii-charset)
  115. (:ascii-global-margin nil nil org-ascii-global-margin)
  116. (:ascii-format-drawer-function nil nil org-ascii-format-drawer-function)
  117. (:ascii-format-inlinetask-function
  118. nil nil org-ascii-format-inlinetask-function)
  119. (:ascii-headline-spacing nil nil org-ascii-headline-spacing)
  120. (:ascii-indented-line-width nil nil org-ascii-indented-line-width)
  121. (:ascii-inlinetask-width nil nil org-ascii-inlinetask-width)
  122. (:ascii-inner-margin nil nil org-ascii-inner-margin)
  123. (:ascii-links-to-notes nil nil org-ascii-links-to-notes)
  124. (:ascii-list-margin nil nil org-ascii-list-margin)
  125. (:ascii-paragraph-spacing nil nil org-ascii-paragraph-spacing)
  126. (:ascii-quote-margin nil nil org-ascii-quote-margin)
  127. (:ascii-table-keep-all-vertical-lines
  128. nil nil org-ascii-table-keep-all-vertical-lines)
  129. (:ascii-table-use-ascii-art nil nil org-ascii-table-use-ascii-art)
  130. (:ascii-table-widen-columns nil nil org-ascii-table-widen-columns)
  131. (:ascii-text-width nil nil org-ascii-text-width)
  132. (:ascii-underline nil nil org-ascii-underline)
  133. (:ascii-verbatim-format nil nil org-ascii-verbatim-format)))
  134. ;;; User Configurable Variables
  135. (defgroup org-export-ascii nil
  136. "Options for exporting Org mode files to ASCII."
  137. :tag "Org Export ASCII"
  138. :group 'org-export)
  139. (defcustom org-ascii-text-width 72
  140. "Maximum width of exported text.
  141. This number includes margin size, as set in
  142. `org-ascii-global-margin'."
  143. :group 'org-export-ascii
  144. :version "24.4"
  145. :package-version '(Org . "8.0")
  146. :type 'integer)
  147. (defcustom org-ascii-global-margin 0
  148. "Width of the left margin, in number of characters."
  149. :group 'org-export-ascii
  150. :version "24.4"
  151. :package-version '(Org . "8.0")
  152. :type 'integer)
  153. (defcustom org-ascii-inner-margin 2
  154. "Width of the inner margin, in number of characters.
  155. Inner margin is applied between each headline."
  156. :group 'org-export-ascii
  157. :version "24.4"
  158. :package-version '(Org . "8.0")
  159. :type 'integer)
  160. (defcustom org-ascii-quote-margin 6
  161. "Width of margin used for quoting text, in characters.
  162. This margin is applied on both sides of the text."
  163. :group 'org-export-ascii
  164. :version "24.4"
  165. :package-version '(Org . "8.0")
  166. :type 'integer)
  167. (defcustom org-ascii-list-margin 0
  168. "Width of margin used for plain lists, in characters.
  169. This margin applies to top level list only, not to its
  170. sub-lists."
  171. :group 'org-export-ascii
  172. :version "25.1"
  173. :package-version '(Org . "8.3")
  174. :type 'integer)
  175. (defcustom org-ascii-inlinetask-width 30
  176. "Width of inline tasks, in number of characters.
  177. This number ignores any margin."
  178. :group 'org-export-ascii
  179. :version "24.4"
  180. :package-version '(Org . "8.0")
  181. :type 'integer)
  182. (defcustom org-ascii-headline-spacing '(1 . 2)
  183. "Number of blank lines inserted around headlines.
  184. This variable can be set to a cons cell. In that case, its car
  185. represents the number of blank lines present before headline
  186. contents whereas its cdr reflects the number of blank lines after
  187. contents.
  188. A nil value replicates the number of blank lines found in the
  189. original Org buffer at the same place."
  190. :group 'org-export-ascii
  191. :version "24.4"
  192. :package-version '(Org . "8.0")
  193. :type '(choice
  194. (const :tag "Replicate original spacing" nil)
  195. (cons :tag "Set an uniform spacing"
  196. (integer :tag "Number of blank lines before contents")
  197. (integer :tag "Number of blank lines after contents"))))
  198. (defcustom org-ascii-indented-line-width 'auto
  199. "Additional indentation width for the first line in a paragraph.
  200. If the value is an integer, indent the first line of each
  201. paragraph by this width, unless it is located at the beginning of
  202. a section, in which case indentation is removed from that line.
  203. If it is the symbol `auto' preserve indentation from original
  204. document."
  205. :group 'org-export-ascii
  206. :version "24.4"
  207. :package-version '(Org . "8.0")
  208. :type '(choice
  209. (integer :tag "Number of white spaces characters")
  210. (const :tag "Preserve original width" auto)))
  211. (defcustom org-ascii-paragraph-spacing 'auto
  212. "Number of white lines between paragraphs.
  213. If the value is an integer, add this number of blank lines
  214. between contiguous paragraphs. If is it the symbol `auto', keep
  215. the same number of blank lines as in the original document."
  216. :group 'org-export-ascii
  217. :version "24.4"
  218. :package-version '(Org . "8.0")
  219. :type '(choice
  220. (integer :tag "Number of blank lines")
  221. (const :tag "Preserve original spacing" auto)))
  222. (defcustom org-ascii-charset 'ascii
  223. "The charset allowed to represent various elements and objects.
  224. Possible values are:
  225. `ascii' Only use plain ASCII characters
  226. `latin1' Include Latin-1 characters
  227. `utf-8' Use all UTF-8 characters"
  228. :group 'org-export-ascii
  229. :version "24.4"
  230. :package-version '(Org . "8.0")
  231. :type '(choice
  232. (const :tag "ASCII" ascii)
  233. (const :tag "Latin-1" latin1)
  234. (const :tag "UTF-8" utf-8)))
  235. (defcustom org-ascii-underline '((ascii ?= ?~ ?-)
  236. (latin1 ?= ?~ ?-)
  237. (utf-8 ?═ ?─ ?╌ ?┄ ?┈))
  238. "Characters for underlining headings in ASCII export.
  239. Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
  240. and whose value is a list of characters.
  241. For each supported charset, this variable associates a sequence
  242. of underline characters. In a sequence, the characters will be
  243. used in order for headlines level 1, 2, ... If no character is
  244. available for a given level, the headline won't be underlined."
  245. :group 'org-export-ascii
  246. :version "24.4"
  247. :package-version '(Org . "8.0")
  248. :type '(list
  249. (cons :tag "Underline characters sequence"
  250. (const :tag "ASCII charset" ascii)
  251. (repeat character))
  252. (cons :tag "Underline characters sequence"
  253. (const :tag "Latin-1 charset" latin1)
  254. (repeat character))
  255. (cons :tag "Underline characters sequence"
  256. (const :tag "UTF-8 charset" utf-8)
  257. (repeat character))))
  258. (defcustom org-ascii-bullets '((ascii ?* ?+ ?-)
  259. (latin1 ?§ ?¶)
  260. (utf-8 ?◊))
  261. "Bullet characters for headlines converted to lists in ASCII export.
  262. Alist whose key is a symbol among `ascii', `latin1' and `utf-8'
  263. and whose value is a list of characters.
  264. The first character is used for the first level considered as low
  265. level, and so on. If there are more levels than characters given
  266. here, the list will be repeated.
  267. Note that this variable doesn't affect plain lists
  268. representation."
  269. :group 'org-export-ascii
  270. :version "24.4"
  271. :package-version '(Org . "8.0")
  272. :type '(list
  273. (cons :tag "Bullet characters for low level headlines"
  274. (const :tag "ASCII charset" ascii)
  275. (repeat character))
  276. (cons :tag "Bullet characters for low level headlines"
  277. (const :tag "Latin-1 charset" latin1)
  278. (repeat character))
  279. (cons :tag "Bullet characters for low level headlines"
  280. (const :tag "UTF-8 charset" utf-8)
  281. (repeat character))))
  282. (defcustom org-ascii-links-to-notes t
  283. "Non-nil means convert links to notes before the next headline.
  284. When nil, the link will be exported in place. If the line
  285. becomes long in this way, it will be wrapped."
  286. :group 'org-export-ascii
  287. :version "24.4"
  288. :package-version '(Org . "8.0")
  289. :type 'boolean)
  290. (defcustom org-ascii-table-keep-all-vertical-lines nil
  291. "Non-nil means keep all vertical lines in ASCII tables.
  292. When nil, vertical lines will be removed except for those needed
  293. for column grouping."
  294. :group 'org-export-ascii
  295. :version "24.4"
  296. :package-version '(Org . "8.0")
  297. :type 'boolean)
  298. (defcustom org-ascii-table-widen-columns t
  299. "Non-nil means widen narrowed columns for export.
  300. When nil, narrowed columns will look in ASCII export just like in
  301. Org mode, i.e. with \"=>\" as ellipsis."
  302. :group 'org-export-ascii
  303. :version "24.4"
  304. :package-version '(Org . "8.0")
  305. :type 'boolean)
  306. (defcustom org-ascii-table-use-ascii-art nil
  307. "Non-nil means table.el tables are turned into ascii-art.
  308. It only makes sense when export charset is `utf-8'. It is nil by
  309. default since it requires ascii-art-to-unicode.el package. You
  310. can download it here:
  311. http://gnuvola.org/software/j/aa2u/ascii-art-to-unicode.el."
  312. :group 'org-export-ascii
  313. :version "24.4"
  314. :package-version '(Org . "8.0")
  315. :type 'boolean)
  316. (defcustom org-ascii-caption-above nil
  317. "When non-nil, place caption string before the element.
  318. Otherwise, place it right after it."
  319. :group 'org-export-ascii
  320. :version "24.4"
  321. :package-version '(Org . "8.0")
  322. :type 'boolean)
  323. (defcustom org-ascii-verbatim-format "`%s'"
  324. "Format string used for verbatim text and inline code."
  325. :group 'org-export-ascii
  326. :version "24.4"
  327. :package-version '(Org . "8.0")
  328. :type 'string)
  329. (defcustom org-ascii-format-drawer-function
  330. (lambda (name contents width) contents)
  331. "Function called to format a drawer in ASCII.
  332. The function must accept three parameters:
  333. NAME the drawer name, like \"LOGBOOK\"
  334. CONTENTS the contents of the drawer.
  335. WIDTH the text width within the drawer.
  336. The function should return either the string to be exported or
  337. nil to ignore the drawer.
  338. The default value simply returns the value of CONTENTS."
  339. :group 'org-export-ascii
  340. :version "24.4"
  341. :package-version '(Org . "8.0")
  342. :type 'function)
  343. (defcustom org-ascii-format-inlinetask-function
  344. 'org-ascii-format-inlinetask-default
  345. "Function called to format an inlinetask in ASCII.
  346. The function must accept nine parameters:
  347. TODO the todo keyword, as a string
  348. TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
  349. PRIORITY the inlinetask priority, as a string
  350. NAME the inlinetask name, as a string.
  351. TAGS the inlinetask tags, as a list of strings.
  352. CONTENTS the contents of the inlinetask, as a string.
  353. WIDTH the width of the inlinetask, as a number.
  354. INLINETASK the inlinetask itself.
  355. INFO the info channel.
  356. The function should return either the string to be exported or
  357. nil to ignore the inline task."
  358. :group 'org-export-ascii
  359. :version "24.4"
  360. :package-version '(Org . "8.3")
  361. :type 'function)
  362. ;;; Internal Functions
  363. ;; Internal functions fall into three categories.
  364. ;; The first one is about text formatting. The core functions are
  365. ;; `org-ascii--current-text-width' and
  366. ;; `org-ascii--current-justification', which determine, respectively,
  367. ;; the current text width allowed to a given element and its expected
  368. ;; justification. Once this information is known,
  369. ;; `org-ascii--fill-string', `org-ascii--justify-lines',
  370. ;; `org-ascii--justify-element' `org-ascii--box-string' and
  371. ;; `org-ascii--indent-string' can operate on a given output string.
  372. ;; In particular, justification happens at the regular (i.e.,
  373. ;; non-greater) element level, which means that when the exporting
  374. ;; process reaches a container (e.g., a center block) content are
  375. ;; already justified.
  376. ;; The second category contains functions handling elements listings,
  377. ;; triggered by "#+TOC:" keyword. As such, `org-ascii--build-toc'
  378. ;; returns a complete table of contents, `org-ascii--list-listings'
  379. ;; returns a list of referenceable src-block elements, and
  380. ;; `org-ascii--list-tables' does the same for table elements.
  381. ;; The third category includes general helper functions.
  382. ;; `org-ascii--build-title' creates the title for a given headline
  383. ;; or inlinetask element. `org-ascii--build-caption' returns the
  384. ;; caption string associated to a table or a src-block.
  385. ;; `org-ascii--describe-links' creates notes about links for
  386. ;; insertion at the end of a section. It uses
  387. ;; `org-ascii--unique-links' to get the list of links to describe.
  388. ;; Eventually, `org-ascii--translate' translates a string according
  389. ;; to language and charset specification.
  390. (defun org-ascii--fill-string (s text-width info &optional justify)
  391. "Fill a string with specified text-width and return it.
  392. S is the string being filled. TEXT-WIDTH is an integer
  393. specifying maximum length of a line. INFO is the plist used as
  394. a communication channel.
  395. Optional argument JUSTIFY can specify any type of justification
  396. among `left', `center', `right' or `full'. A nil value is
  397. equivalent to `left'. For a justification that doesn't also fill
  398. string, see `org-ascii--justify-lines' and
  399. `org-ascii--justify-block'.
  400. Return nil if S isn't a string."
  401. (when (stringp s)
  402. (let ((double-space-p sentence-end-double-space))
  403. (with-temp-buffer
  404. (let ((fill-column text-width)
  405. (use-hard-newlines t)
  406. (sentence-end-double-space double-space-p))
  407. (insert (if (plist-get info :preserve-breaks)
  408. (replace-regexp-in-string "\n" hard-newline s)
  409. s))
  410. (fill-region (point-min) (point-max) justify))
  411. (buffer-string)))))
  412. (defun org-ascii--justify-lines (s text-width how)
  413. "Justify all lines in string S.
  414. TEXT-WIDTH is an integer specifying maximum length of a line.
  415. HOW determines the type of justification: it can be `left',
  416. `right', `full' or `center'."
  417. (with-temp-buffer
  418. (insert s)
  419. (goto-char (point-min))
  420. (let ((fill-column text-width)
  421. ;; Disable `adaptive-fill-mode' so it doesn't prevent
  422. ;; filling lines matching `adaptive-fill-regexp'.
  423. (adaptive-fill-mode nil))
  424. (while (< (point) (point-max))
  425. (justify-current-line how)
  426. (forward-line)))
  427. (buffer-string)))
  428. (defun org-ascii--justify-element (contents element info)
  429. "Justify CONTENTS of ELEMENT.
  430. INFO is a plist used as a communication channel. Justification
  431. is done according to the type of element. More accurately,
  432. paragraphs are filled and other elements are justified as blocks,
  433. that is according to the widest non blank line in CONTENTS."
  434. (if (not (org-string-nw-p contents)) contents
  435. (let ((text-width (org-ascii--current-text-width element info))
  436. (how (org-ascii--current-justification element)))
  437. (cond
  438. ((eq (org-element-type element) 'paragraph)
  439. ;; Paragraphs are treated specially as they need to be filled.
  440. (org-ascii--fill-string contents text-width info how))
  441. ((eq how 'left) contents)
  442. (t (with-temp-buffer
  443. (insert contents)
  444. (goto-char (point-min))
  445. (catch 'exit
  446. (let ((max-width 0))
  447. ;; Compute maximum width. Bail out if it is greater
  448. ;; than page width, since no justification is
  449. ;; possible.
  450. (save-excursion
  451. (while (not (eobp))
  452. (unless (org-looking-at-p "[ \t]*$")
  453. (end-of-line)
  454. (let ((column (current-column)))
  455. (cond
  456. ((>= column text-width) (throw 'exit contents))
  457. ((> column max-width) (setq max-width column)))))
  458. (forward-line)))
  459. ;; Justify every line according to TEXT-WIDTH and
  460. ;; MAX-WIDTH.
  461. (let ((offset (/ (- text-width max-width)
  462. (if (eq how 'right) 1 2))))
  463. (if (zerop offset) (throw 'exit contents)
  464. (while (not (eobp))
  465. (unless (org-looking-at-p "[ \t]*$")
  466. (org-indent-to-column offset))
  467. (forward-line)))))
  468. (buffer-string))))))))
  469. (defun org-ascii--indent-string (s width)
  470. "Indent string S by WIDTH white spaces.
  471. Empty lines are not indented."
  472. (when (stringp s)
  473. (replace-regexp-in-string
  474. "\\(^\\)[ \t]*\\S-" (make-string width ?\s) s nil nil 1)))
  475. (defun org-ascii--box-string (s info)
  476. "Return string S with a partial box to its left.
  477. INFO is a plist used as a communication channel."
  478. (let ((utf8p (eq (plist-get info :ascii-charset) 'utf-8)))
  479. (format (if utf8p "┌────\n%s\n└────" ",----\n%s\n`----")
  480. (replace-regexp-in-string
  481. "^" (if utf8p "│ " "| ")
  482. ;; Remove last newline character.
  483. (replace-regexp-in-string "\n[ \t]*\\'" "" s)))))
  484. (defun org-ascii--current-text-width (element info)
  485. "Return maximum text width for ELEMENT's contents.
  486. INFO is a plist used as a communication channel."
  487. (case (org-element-type element)
  488. ;; Elements with an absolute width: `headline' and `inlinetask'.
  489. (inlinetask (plist-get info :ascii-inlinetask-width))
  490. (headline
  491. (- (plist-get info :ascii-text-width)
  492. (let ((low-level-rank (org-export-low-level-p element info)))
  493. (if low-level-rank (* low-level-rank 2)
  494. (plist-get info :ascii-global-margin)))))
  495. ;; Elements with a relative width: store maximum text width in
  496. ;; TOTAL-WIDTH.
  497. (otherwise
  498. (let* ((genealogy (org-element-lineage element nil t))
  499. ;; Total width is determined by the presence, or not, of an
  500. ;; inline task among ELEMENT parents.
  501. (total-width
  502. (if (loop for parent in genealogy
  503. thereis (eq (org-element-type parent) 'inlinetask))
  504. (plist-get info :ascii-inlinetask-width)
  505. ;; No inlinetask: Remove global margin from text width.
  506. (- (plist-get info :ascii-text-width)
  507. (plist-get info :ascii-global-margin)
  508. (let ((parent (org-export-get-parent-headline element)))
  509. ;; Inner margin doesn't apply to text before first
  510. ;; headline.
  511. (if (not parent) 0
  512. (let ((low-level-rank
  513. (org-export-low-level-p parent info)))
  514. ;; Inner margin doesn't apply to contents of
  515. ;; low level headlines, since they've got their
  516. ;; own indentation mechanism.
  517. (if low-level-rank (* low-level-rank 2)
  518. (plist-get info :ascii-inner-margin)))))))))
  519. (- total-width
  520. ;; Each `quote-block' and `verse-block' above narrows text
  521. ;; width by twice the standard margin size.
  522. (+ (* (loop for parent in genealogy
  523. when (memq (org-element-type parent)
  524. '(quote-block verse-block))
  525. count parent)
  526. 2 (plist-get info :ascii-quote-margin))
  527. ;; Apply list margin once per "top-level" plain-list
  528. ;; containing current line
  529. (* (let ((count 0))
  530. (dolist (e genealogy count)
  531. (and (eq (org-element-type e) 'plain-list)
  532. (not (eq (org-element-type (org-export-get-parent e))
  533. 'item))
  534. (incf count))))
  535. (plist-get info :ascii-list-margin))
  536. ;; Text width within a plain-list is restricted by
  537. ;; indentation of current item. If that's the case,
  538. ;; compute it with the help of `:structure' property from
  539. ;; parent item, if any.
  540. (let ((item
  541. (if (eq (org-element-type element) 'item) element
  542. (loop for parent in genealogy
  543. when (eq (org-element-type parent) 'item)
  544. return parent))))
  545. (if (not item) 0
  546. ;; Compute indentation offset of the current item,
  547. ;; that is the sum of the difference between its
  548. ;; indentation and the indentation of the top item in
  549. ;; the list and current item bullet's length. Also
  550. ;; remove checkbox length, and tag length (for
  551. ;; description lists) or bullet length.
  552. (let ((struct (org-element-property :structure item))
  553. (beg-item (org-element-property :begin item)))
  554. (+ (- (org-list-get-ind beg-item struct)
  555. (org-list-get-ind
  556. (org-list-get-top-point struct) struct))
  557. (string-width (or (org-ascii--checkbox item info)
  558. ""))
  559. (string-width
  560. (let ((tag (org-element-property :tag item)))
  561. (if tag (org-export-data tag info)
  562. (org-element-property :bullet item))))))))))))))
  563. (defun org-ascii--current-justification (element)
  564. "Return expected justification for ELEMENT's contents.
  565. Return value is a symbol among `left', `center', `right' and
  566. `full'."
  567. (let (justification)
  568. (while (and (not justification)
  569. (setq element (org-element-property :parent element)))
  570. (case (org-element-type element)
  571. (center-block (setq justification 'center))
  572. (special-block
  573. (let ((name (org-element-property :type element)))
  574. (cond ((string= name "JUSTIFYRIGHT") (setq justification 'right))
  575. ((string= name "JUSTIFYLEFT") (setq justification 'left)))))))
  576. (or justification 'left)))
  577. (defun org-ascii--build-title
  578. (element info text-width &optional underline notags toc)
  579. "Format ELEMENT title and return it.
  580. ELEMENT is either an `headline' or `inlinetask' element. INFO is
  581. a plist used as a communication channel. TEXT-WIDTH is an
  582. integer representing the maximum length of a line.
  583. When optional argument UNDERLINE is non-nil, underline title,
  584. without the tags, according to `org-ascii-underline'
  585. specifications.
  586. If optional argument NOTAGS is non-nil, no tags will be added to
  587. the title.
  588. When optional argument TOC is non-nil, use optional title if
  589. possible. It doesn't apply to `inlinetask' elements."
  590. (let* ((headlinep (eq (org-element-type element) 'headline))
  591. (numbers
  592. ;; Numbering is specific to headlines.
  593. (and headlinep (org-export-numbered-headline-p element info)
  594. ;; All tests passed: build numbering string.
  595. (concat
  596. (mapconcat
  597. 'number-to-string
  598. (org-export-get-headline-number element info) ".")
  599. " ")))
  600. (text
  601. (org-trim
  602. (org-export-data
  603. (if (and toc headlinep) (org-export-get-alt-title element info)
  604. (org-element-property :title element))
  605. info)))
  606. (todo
  607. (and (plist-get info :with-todo-keywords)
  608. (let ((todo (org-element-property :todo-keyword element)))
  609. (and todo (concat (org-export-data todo info) " ")))))
  610. (tags (and (not notags)
  611. (plist-get info :with-tags)
  612. (let ((tag-list (org-export-get-tags element info)))
  613. (and tag-list
  614. (format ":%s:"
  615. (mapconcat 'identity tag-list ":"))))))
  616. (priority
  617. (and (plist-get info :with-priority)
  618. (let ((char (org-element-property :priority element)))
  619. (and char (format "(#%c) " char)))))
  620. (first-part (concat numbers todo priority text)))
  621. (concat
  622. first-part
  623. ;; Align tags, if any.
  624. (when tags
  625. (format
  626. (format " %%%ds"
  627. (max (- text-width (1+ (string-width first-part)))
  628. (string-width tags)))
  629. tags))
  630. ;; Maybe underline text, if ELEMENT type is `headline' and an
  631. ;; underline character has been defined.
  632. (when (and underline headlinep)
  633. (let ((under-char
  634. (nth (1- (org-export-get-relative-level element info))
  635. (cdr (assq (plist-get info :ascii-charset)
  636. (plist-get info :ascii-underline))))))
  637. (and under-char
  638. (concat "\n"
  639. (make-string (/ (string-width first-part)
  640. (char-width under-char))
  641. under-char))))))))
  642. (defun org-ascii--has-caption-p (element info)
  643. "Non-nil when ELEMENT has a caption affiliated keyword.
  644. INFO is a plist used as a communication channel. This function
  645. is meant to be used as a predicate for `org-export-get-ordinal'."
  646. (org-element-property :caption element))
  647. (defun org-ascii--build-caption (element info)
  648. "Return caption string for ELEMENT, if applicable.
  649. INFO is a plist used as a communication channel.
  650. The caption string contains the sequence number of ELEMENT along
  651. with its real caption. Return nil when ELEMENT has no affiliated
  652. caption keyword."
  653. (let ((caption (org-export-get-caption element)))
  654. (when caption
  655. ;; Get sequence number of current src-block among every
  656. ;; src-block with a caption.
  657. (let ((reference
  658. (org-export-get-ordinal
  659. element info nil 'org-ascii--has-caption-p))
  660. (title-fmt (org-ascii--translate
  661. (case (org-element-type element)
  662. (table "Table %d:")
  663. (src-block "Listing %d:"))
  664. info)))
  665. (org-ascii--fill-string
  666. (concat (format title-fmt reference)
  667. " "
  668. (org-export-data caption info))
  669. (org-ascii--current-text-width element info) info)))))
  670. (defun org-ascii--build-toc (info &optional n keyword local)
  671. "Return a table of contents.
  672. INFO is a plist used as a communication channel.
  673. Optional argument N, when non-nil, is an integer specifying the
  674. depth of the table.
  675. Optional argument KEYWORD specifies the TOC keyword, if any, from
  676. which the table of contents generation has been initiated.
  677. When optional argument LOCAL is non-nil, build a table of
  678. contents according to the current headline."
  679. (concat
  680. (unless local
  681. (let ((title (org-ascii--translate "Table of Contents" info)))
  682. (concat title "\n"
  683. (make-string
  684. (string-width title)
  685. (if (eq (plist-get info :ascii-charset) 'utf-8) ?─ ?_))
  686. "\n\n")))
  687. (let ((text-width
  688. (if keyword (org-ascii--current-text-width keyword info)
  689. (- (plist-get info :ascii-text-width)
  690. (plist-get info :ascii-global-margin)))))
  691. (mapconcat
  692. (lambda (headline)
  693. (let* ((level (org-export-get-relative-level headline info))
  694. (indent (* (1- level) 3)))
  695. (concat
  696. (unless (zerop indent) (concat (make-string (1- indent) ?.) " "))
  697. (org-ascii--build-title
  698. headline info (- text-width indent) nil
  699. (or (not (plist-get info :with-tags))
  700. (eq (plist-get info :with-tags) 'not-in-toc))
  701. 'toc))))
  702. (org-export-collect-headlines info n (and local keyword)) "\n"))))
  703. (defun org-ascii--list-listings (keyword info)
  704. "Return a list of listings.
  705. KEYWORD is the keyword that initiated the list of listings
  706. generation. INFO is a plist used as a communication channel."
  707. (let ((title (org-ascii--translate "List of Listings" info)))
  708. (concat
  709. title "\n"
  710. (make-string (string-width title)
  711. (if (eq (plist-get info :ascii-charset) 'utf-8) ?─ ?_))
  712. "\n\n"
  713. (let ((text-width
  714. (if keyword (org-ascii--current-text-width keyword info)
  715. (- (plist-get info :ascii-text-width)
  716. (plist-get info :ascii-global-margin))))
  717. ;; Use a counter instead of retrieving ordinal of each
  718. ;; src-block.
  719. (count 0))
  720. (mapconcat
  721. (lambda (src-block)
  722. ;; Store initial text so its length can be computed. This is
  723. ;; used to properly align caption right to it in case of
  724. ;; filling (like contents of a description list item).
  725. (let* ((initial-text
  726. (format (org-ascii--translate "Listing %d:" info)
  727. (incf count)))
  728. (initial-width (string-width initial-text)))
  729. (concat
  730. initial-text " "
  731. (org-trim
  732. (org-ascii--indent-string
  733. (org-ascii--fill-string
  734. ;; Use short name in priority, if available.
  735. (let ((caption (or (org-export-get-caption src-block t)
  736. (org-export-get-caption src-block))))
  737. (org-export-data caption info))
  738. (- text-width initial-width) info)
  739. initial-width)))))
  740. (org-export-collect-listings info) "\n")))))
  741. (defun org-ascii--list-tables (keyword info)
  742. "Return a list of tables.
  743. KEYWORD is the keyword that initiated the list of tables
  744. generation. INFO is a plist used as a communication channel."
  745. (let ((title (org-ascii--translate "List of Tables" info)))
  746. (concat
  747. title "\n"
  748. (make-string (string-width title)
  749. (if (eq (plist-get info :ascii-charset) 'utf-8) ?─ ?_))
  750. "\n\n"
  751. (let ((text-width
  752. (if keyword (org-ascii--current-text-width keyword info)
  753. (- (plist-get info :ascii-text-width)
  754. (plist-get info :ascii-global-margin))))
  755. ;; Use a counter instead of retrieving ordinal of each
  756. ;; src-block.
  757. (count 0))
  758. (mapconcat
  759. (lambda (table)
  760. ;; Store initial text so its length can be computed. This is
  761. ;; used to properly align caption right to it in case of
  762. ;; filling (like contents of a description list item).
  763. (let* ((initial-text
  764. (format (org-ascii--translate "Table %d:" info)
  765. (incf count)))
  766. (initial-width (string-width initial-text)))
  767. (concat
  768. initial-text " "
  769. (org-trim
  770. (org-ascii--indent-string
  771. (org-ascii--fill-string
  772. ;; Use short name in priority, if available.
  773. (let ((caption (or (org-export-get-caption table t)
  774. (org-export-get-caption table))))
  775. (org-export-data caption info))
  776. (- text-width initial-width) info)
  777. initial-width)))))
  778. (org-export-collect-tables info) "\n")))))
  779. (defun org-ascii--unique-links (element info)
  780. "Return a list of unique link references in ELEMENT.
  781. ELEMENT is either a headline element or a section element. INFO
  782. is a plist used as a communication channel."
  783. (let* (seen
  784. (unique-link-p
  785. (function
  786. ;; Return LINK if it wasn't referenced so far, or nil.
  787. ;; Update SEEN links along the way.
  788. (lambda (link)
  789. (let ((footprint
  790. ;; Normalize description in footprints.
  791. (cons (org-element-property :raw-link link)
  792. (let ((contents (org-element-contents link)))
  793. (and contents
  794. (replace-regexp-in-string
  795. "[ \r\t\n]+" " "
  796. (org-trim
  797. (org-element-interpret-data contents))))))))
  798. ;; Ignore LINK if it hasn't been translated already.
  799. ;; It can happen if it is located in an affiliated
  800. ;; keyword that was ignored.
  801. (when (and (org-string-nw-p
  802. (gethash link (plist-get info :exported-data)))
  803. (not (member footprint seen)))
  804. (push footprint seen) link)))))
  805. ;; If at a section, find parent headline, if any, in order to
  806. ;; count links that might be in the title.
  807. (headline
  808. (if (eq (org-element-type element) 'headline) element
  809. (or (org-export-get-parent-headline element) element))))
  810. ;; Get all links in HEADLINE.
  811. (org-element-map headline 'link
  812. (lambda (l) (funcall unique-link-p l)) info nil nil t)))
  813. (defun org-ascii--describe-links (links width info)
  814. "Return a string describing a list of links.
  815. LINKS is a list of link type objects, as returned by
  816. `org-ascii--unique-links'. WIDTH is the text width allowed for
  817. the output string. INFO is a plist used as a communication
  818. channel."
  819. (mapconcat
  820. (lambda (link)
  821. (let ((type (org-element-property :type link))
  822. (anchor (let ((desc (org-element-contents link)))
  823. (if desc (org-export-data desc info)
  824. (org-element-property :raw-link link)))))
  825. (cond
  826. ;; Coderefs, radio links and fuzzy links are ignored.
  827. ((member type '("coderef" "radio" "fuzzy")) nil)
  828. ;; Id and custom-id links: Headlines refer to their numbering.
  829. ((member type '("custom-id" "id"))
  830. (let ((dest (org-export-resolve-id-link link info)))
  831. (concat
  832. (org-ascii--fill-string
  833. (format
  834. "[%s] %s"
  835. anchor
  836. (if (not dest) (org-ascii--translate "Unknown reference" info)
  837. (format
  838. (org-ascii--translate "See section %s" info)
  839. (if (org-export-numbered-headline-p dest info)
  840. (mapconcat #'number-to-string
  841. (org-export-get-headline-number dest info) ".")
  842. (org-export-data (org-element-property :title dest) info)))))
  843. width info) "\n\n")))
  844. ;; Do not add a link that cannot be resolved and doesn't have
  845. ;; any description: destination is already visible in the
  846. ;; paragraph.
  847. ((not (org-element-contents link)) nil)
  848. ;; Do not add a link already handled by custom export
  849. ;; functions.
  850. ((let ((protocol (nth 2 (assoc type org-link-protocols)))
  851. (path (org-element-property :path link)))
  852. (and (functionp protocol)
  853. (funcall protocol (org-link-unescape path) anchor 'ascii)))
  854. nil)
  855. (t
  856. (concat
  857. (org-ascii--fill-string
  858. (format "[%s] %s" anchor (org-element-property :raw-link link))
  859. width info)
  860. "\n\n")))))
  861. links ""))
  862. (defun org-ascii--checkbox (item info)
  863. "Return checkbox string for ITEM or nil.
  864. INFO is a plist used as a communication channel."
  865. (let ((utf8p (eq (plist-get info :ascii-charset) 'utf-8)))
  866. (case (org-element-property :checkbox item)
  867. (on (if utf8p "☑ " "[X] "))
  868. (off (if utf8p "☐ " "[ ] "))
  869. (trans (if utf8p "☒ " "[-] ")))))
  870. ;;; Template
  871. (defun org-ascii-template--document-title (info)
  872. "Return document title, as a string.
  873. INFO is a plist used as a communication channel."
  874. (let* ((text-width (plist-get info :ascii-text-width))
  875. ;; Links in the title will not be resolved later, so we make
  876. ;; sure their path is located right after them.
  877. (info (org-combine-plists info '(:ascii-links-to-notes nil)))
  878. (title (if (plist-get info :with-title)
  879. (org-export-data (plist-get info :title) info)
  880. ""))
  881. (author (and (plist-get info :with-author)
  882. (let ((auth (plist-get info :author)))
  883. (and auth (org-export-data auth info)))))
  884. (email (and (plist-get info :with-email)
  885. (org-export-data (plist-get info :email) info)))
  886. (date (and (plist-get info :with-date)
  887. (org-export-data (org-export-get-date info) info))))
  888. ;; There are two types of title blocks depending on the presence
  889. ;; of a title to display.
  890. (if (string= title "")
  891. ;; Title block without a title. DATE is positioned at the top
  892. ;; right of the document, AUTHOR to the top left and EMAIL
  893. ;; just below.
  894. (cond
  895. ((and (org-string-nw-p date) (org-string-nw-p author))
  896. (concat
  897. author
  898. (make-string (- text-width (string-width date) (string-width author))
  899. ?\s)
  900. date
  901. (when (org-string-nw-p email) (concat "\n" email))
  902. "\n\n\n"))
  903. ((and (org-string-nw-p date) (org-string-nw-p email))
  904. (concat
  905. email
  906. (make-string (- text-width (string-width date) (string-width email))
  907. ?\s)
  908. date "\n\n\n"))
  909. ((org-string-nw-p date)
  910. (concat
  911. (org-ascii--justify-lines date text-width 'right)
  912. "\n\n\n"))
  913. ((and (org-string-nw-p author) (org-string-nw-p email))
  914. (concat author "\n" email "\n\n\n"))
  915. ((org-string-nw-p author) (concat author "\n\n\n"))
  916. ((org-string-nw-p email) (concat email "\n\n\n")))
  917. ;; Title block with a title. Document's TITLE, along with the
  918. ;; AUTHOR and its EMAIL are both overlined and an underlined,
  919. ;; centered. Date is just below, also centered.
  920. (let* ((utf8p (eq (plist-get info :ascii-charset) 'utf-8))
  921. ;; Format TITLE. It may be filled if it is too wide,
  922. ;; that is wider than the two thirds of the total width.
  923. (title-len (min (length title) (/ (* 2 text-width) 3)))
  924. (formatted-title (org-ascii--fill-string title title-len info))
  925. (line
  926. (make-string
  927. (min (+ (max title-len
  928. (string-width (or author ""))
  929. (string-width (or email "")))
  930. 2)
  931. text-width) (if utf8p ?━ ?_))))
  932. (org-ascii--justify-lines
  933. (concat line "\n"
  934. (unless utf8p "\n")
  935. (upcase formatted-title)
  936. (cond
  937. ((and (org-string-nw-p author) (org-string-nw-p email))
  938. (concat (if utf8p "\n\n\n" "\n\n") author "\n" email))
  939. ((org-string-nw-p author)
  940. (concat (if utf8p "\n\n\n" "\n\n") author))
  941. ((org-string-nw-p email)
  942. (concat (if utf8p "\n\n\n" "\n\n") email)))
  943. "\n" line
  944. (when (org-string-nw-p date) (concat "\n\n\n" date))
  945. "\n\n\n") text-width 'center)))))
  946. (defun org-ascii-inner-template (contents info)
  947. "Return complete document string after ASCII conversion.
  948. CONTENTS is the transcoded contents string. INFO is a plist
  949. holding export options."
  950. (org-element-normalize-string
  951. (let ((global-margin (plist-get info :ascii-global-margin)))
  952. (org-ascii--indent-string
  953. (concat
  954. ;; 1. Document's body.
  955. contents
  956. ;; 2. Footnote definitions.
  957. (let ((definitions (org-export-collect-footnote-definitions info))
  958. ;; Insert full links right inside the footnote definition
  959. ;; as they have no chance to be inserted later.
  960. (info (org-combine-plists info '(:ascii-links-to-notes nil))))
  961. (when definitions
  962. (concat
  963. "\n\n\n"
  964. (let ((title (org-ascii--translate "Footnotes" info)))
  965. (concat
  966. title "\n"
  967. (make-string
  968. (string-width title)
  969. (if (eq (plist-get info :ascii-charset) 'utf-8) ?─ ?_))))
  970. "\n\n"
  971. (let ((text-width (- (plist-get info :ascii-text-width)
  972. global-margin)))
  973. (mapconcat
  974. (lambda (ref)
  975. (let ((id (format "[%s] " (car ref))))
  976. ;; Distinguish between inline definitions and
  977. ;; full-fledged definitions.
  978. (org-trim
  979. (let ((def (nth 2 ref)))
  980. (if (eq (org-element-type def) 'org-data)
  981. ;; Full-fledged definition: footnote ID is
  982. ;; inserted inside the first parsed
  983. ;; paragraph (FIRST), if any, to be sure
  984. ;; filling will take it into consideration.
  985. (let ((first (car (org-element-contents def))))
  986. (if (not (eq (org-element-type first) 'paragraph))
  987. (concat id "\n" (org-export-data def info))
  988. (push id (nthcdr 2 first))
  989. (org-export-data def info)))
  990. ;; Fill paragraph once footnote ID is inserted
  991. ;; in order to have a correct length for first
  992. ;; line.
  993. (org-ascii--fill-string
  994. (concat id (org-export-data def info))
  995. text-width info))))))
  996. definitions "\n\n"))))))
  997. global-margin))))
  998. (defun org-ascii-template (contents info)
  999. "Return complete document string after ASCII conversion.
  1000. CONTENTS is the transcoded contents string. INFO is a plist
  1001. holding export options."
  1002. (let ((global-margin (plist-get info :ascii-global-margin)))
  1003. (concat
  1004. ;; Build title block.
  1005. (org-ascii--indent-string
  1006. (concat (org-ascii-template--document-title info)
  1007. ;; 2. Table of contents.
  1008. (let ((depth (plist-get info :with-toc)))
  1009. (when depth
  1010. (concat
  1011. (org-ascii--build-toc info (and (wholenump depth) depth))
  1012. "\n\n\n"))))
  1013. global-margin)
  1014. ;; Document's body.
  1015. contents
  1016. ;; Creator. Justify it to the bottom right.
  1017. (and (plist-get info :with-creator)
  1018. (org-ascii--indent-string
  1019. (let ((text-width
  1020. (- (plist-get info :ascii-text-width) global-margin)))
  1021. (concat
  1022. "\n\n\n"
  1023. (org-ascii--fill-string
  1024. (plist-get info :creator) text-width info 'right)))
  1025. global-margin)))))
  1026. (defun org-ascii--translate (s info)
  1027. "Translate string S according to specified language and charset.
  1028. INFO is a plist used as a communication channel."
  1029. (let ((charset (intern (format ":%s" (plist-get info :ascii-charset)))))
  1030. (org-export-translate s charset info)))
  1031. ;;; Transcode Functions
  1032. ;;;; Bold
  1033. (defun org-ascii-bold (bold contents info)
  1034. "Transcode BOLD from Org to ASCII.
  1035. CONTENTS is the text with bold markup. INFO is a plist holding
  1036. contextual information."
  1037. (format "*%s*" contents))
  1038. ;;;; Center Block
  1039. (defun org-ascii-center-block (center-block contents info)
  1040. "Transcode a CENTER-BLOCK element from Org to ASCII.
  1041. CONTENTS holds the contents of the block. INFO is a plist
  1042. holding contextual information."
  1043. ;; Center has already been taken care of at a lower level, so
  1044. ;; there's nothing left to do.
  1045. contents)
  1046. ;;;; Clock
  1047. (defun org-ascii-clock (clock contents info)
  1048. "Transcode a CLOCK object from Org to ASCII.
  1049. CONTENTS is nil. INFO is a plist holding contextual
  1050. information."
  1051. (org-ascii--justify-element
  1052. (concat org-clock-string " "
  1053. (org-timestamp-translate (org-element-property :value clock))
  1054. (let ((time (org-element-property :duration clock)))
  1055. (and time
  1056. (concat " => "
  1057. (apply 'format
  1058. "%2s:%02s"
  1059. (org-split-string time ":"))))))
  1060. clock info))
  1061. ;;;; Code
  1062. (defun org-ascii-code (code contents info)
  1063. "Return a CODE object from Org to ASCII.
  1064. CONTENTS is nil. INFO is a plist holding contextual
  1065. information."
  1066. (format (plist-get info :ascii-verbatim-format)
  1067. (org-element-property :value code)))
  1068. ;;;; Drawer
  1069. (defun org-ascii-drawer (drawer contents info)
  1070. "Transcode a DRAWER element from Org to ASCII.
  1071. CONTENTS holds the contents of the block. INFO is a plist
  1072. holding contextual information."
  1073. (let ((name (org-element-property :drawer-name drawer))
  1074. (width (org-ascii--current-text-width drawer info)))
  1075. (funcall (plist-get info :ascii-format-drawer-function)
  1076. name contents width)))
  1077. ;;;; Dynamic Block
  1078. (defun org-ascii-dynamic-block (dynamic-block contents info)
  1079. "Transcode a DYNAMIC-BLOCK element from Org to ASCII.
  1080. CONTENTS holds the contents of the block. INFO is a plist
  1081. holding contextual information."
  1082. contents)
  1083. ;;;; Entity
  1084. (defun org-ascii-entity (entity contents info)
  1085. "Transcode an ENTITY object from Org to ASCII.
  1086. CONTENTS are the definition itself. INFO is a plist holding
  1087. contextual information."
  1088. (org-element-property
  1089. (intern (concat ":" (symbol-name (plist-get info :ascii-charset))))
  1090. entity))
  1091. ;;;; Example Block
  1092. (defun org-ascii-example-block (example-block contents info)
  1093. "Transcode a EXAMPLE-BLOCK element from Org to ASCII.
  1094. CONTENTS is nil. INFO is a plist holding contextual information."
  1095. (org-ascii--justify-element
  1096. (org-ascii--box-string
  1097. (org-export-format-code-default example-block info) info)
  1098. example-block info))
  1099. ;;;; Export Snippet
  1100. (defun org-ascii-export-snippet (export-snippet contents info)
  1101. "Transcode a EXPORT-SNIPPET object from Org to ASCII.
  1102. CONTENTS is nil. INFO is a plist holding contextual information."
  1103. (when (eq (org-export-snippet-backend export-snippet) 'ascii)
  1104. (org-element-property :value export-snippet)))
  1105. ;;;; Export Block
  1106. (defun org-ascii-export-block (export-block contents info)
  1107. "Transcode a EXPORT-BLOCK element from Org to ASCII.
  1108. CONTENTS is nil. INFO is a plist holding contextual information."
  1109. (when (string= (org-element-property :type export-block) "ASCII")
  1110. (org-ascii--justify-element
  1111. (org-element-property :value export-block) export-block info)))
  1112. ;;;; Fixed Width
  1113. (defun org-ascii-fixed-width (fixed-width contents info)
  1114. "Transcode a FIXED-WIDTH element from Org to ASCII.
  1115. CONTENTS is nil. INFO is a plist holding contextual information."
  1116. (org-ascii--justify-element
  1117. (org-ascii--box-string
  1118. (org-remove-indentation
  1119. (org-element-property :value fixed-width)) info)
  1120. fixed-width info))
  1121. ;;;; Footnote Definition
  1122. ;; Footnote Definitions are ignored. They are compiled at the end of
  1123. ;; the document, by `org-ascii-inner-template'.
  1124. ;;;; Footnote Reference
  1125. (defun org-ascii-footnote-reference (footnote-reference contents info)
  1126. "Transcode a FOOTNOTE-REFERENCE element from Org to ASCII.
  1127. CONTENTS is nil. INFO is a plist holding contextual information."
  1128. (format "[%s]" (org-export-get-footnote-number footnote-reference info)))
  1129. ;;;; Headline
  1130. (defun org-ascii-headline (headline contents info)
  1131. "Transcode a HEADLINE element from Org to ASCII.
  1132. CONTENTS holds the contents of the headline. INFO is a plist
  1133. holding contextual information."
  1134. ;; Don't export footnote section, which will be handled at the end
  1135. ;; of the template.
  1136. (unless (org-element-property :footnote-section-p headline)
  1137. (let* ((low-level-rank (org-export-low-level-p headline info))
  1138. (width (org-ascii--current-text-width headline info))
  1139. ;; Blank lines between headline and its contents.
  1140. ;; `org-ascii-headline-spacing', when set, overwrites
  1141. ;; original buffer's spacing.
  1142. (pre-blanks
  1143. (make-string
  1144. (or (car (plist-get info :ascii-headline-spacing))
  1145. (org-element-property :pre-blank headline))
  1146. ?\n))
  1147. ;; Even if HEADLINE has no section, there might be some
  1148. ;; links in its title that we shouldn't forget to describe.
  1149. (links
  1150. (unless (or (eq (caar (org-element-contents headline)) 'section))
  1151. (let ((title (org-element-property :title headline)))
  1152. (when (consp title)
  1153. (org-ascii--describe-links
  1154. (org-ascii--unique-links title info) width info))))))
  1155. ;; Deep subtree: export it as a list item.
  1156. (if low-level-rank
  1157. (concat
  1158. ;; Bullet.
  1159. (let ((bullets (cdr (assq (plist-get info :ascii-charset)
  1160. (plist-get info :ascii-bullets)))))
  1161. (char-to-string
  1162. (nth (mod (1- low-level-rank) (length bullets)) bullets)))
  1163. " "
  1164. ;; Title.
  1165. (org-ascii--build-title headline info width) "\n"
  1166. ;; Contents, indented by length of bullet.
  1167. pre-blanks
  1168. (org-ascii--indent-string
  1169. (concat contents
  1170. (when (org-string-nw-p links) (concat "\n\n" links)))
  1171. 2))
  1172. ;; Else: Standard headline.
  1173. (concat
  1174. (org-ascii--build-title headline info width 'underline)
  1175. "\n" pre-blanks
  1176. (concat (when (org-string-nw-p links) links) contents))))))
  1177. ;;;; Horizontal Rule
  1178. (defun org-ascii-horizontal-rule (horizontal-rule contents info)
  1179. "Transcode an HORIZONTAL-RULE object from Org to ASCII.
  1180. CONTENTS is nil. INFO is a plist holding contextual
  1181. information."
  1182. (let ((text-width (org-ascii--current-text-width horizontal-rule info))
  1183. (spec-width
  1184. (org-export-read-attribute :attr_ascii horizontal-rule :width)))
  1185. (org-ascii--justify-lines
  1186. (make-string (if (and spec-width (string-match "^[0-9]+$" spec-width))
  1187. (string-to-number spec-width)
  1188. text-width)
  1189. (if (eq (plist-get info :ascii-charset) 'utf-8) ?― ?-))
  1190. text-width 'center)))
  1191. ;;;; Inline Src Block
  1192. (defun org-ascii-inline-src-block (inline-src-block contents info)
  1193. "Transcode an INLINE-SRC-BLOCK element from Org to ASCII.
  1194. CONTENTS holds the contents of the item. INFO is a plist holding
  1195. contextual information."
  1196. (format (plist-get info :ascii-verbatim-format)
  1197. (org-element-property :value inline-src-block)))
  1198. ;;;; Inlinetask
  1199. (defun org-ascii-format-inlinetask-default
  1200. (todo type priority name tags contents width inlinetask info)
  1201. "Format an inline task element for ASCII export.
  1202. See `org-ascii-format-inlinetask-function' for a description
  1203. of the parameters."
  1204. (let* ((utf8p (eq (plist-get info :ascii-charset) 'utf-8))
  1205. (width (or width (plist-get info :ascii-inlinetask-width))))
  1206. (org-ascii--indent-string
  1207. (concat
  1208. ;; Top line, with an additional blank line if not in UTF-8.
  1209. (make-string width (if utf8p ?━ ?_)) "\n"
  1210. (unless utf8p (concat (make-string width ? ) "\n"))
  1211. ;; Add title. Fill it if wider than inlinetask.
  1212. (let ((title (org-ascii--build-title inlinetask info width)))
  1213. (if (<= (string-width title) width) title
  1214. (org-ascii--fill-string title width info)))
  1215. "\n"
  1216. ;; If CONTENTS is not empty, insert it along with
  1217. ;; a separator.
  1218. (when (org-string-nw-p contents)
  1219. (concat (make-string width (if utf8p ?─ ?-)) "\n" contents))
  1220. ;; Bottom line.
  1221. (make-string width (if utf8p ?━ ?_)))
  1222. ;; Flush the inlinetask to the right.
  1223. (- (plist-get info :ascii-text-width) (plist-get info :ascii-global-margin)
  1224. (if (not (org-export-get-parent-headline inlinetask)) 0
  1225. (plist-get info :ascii-inner-margin))
  1226. (org-ascii--current-text-width inlinetask info)))))
  1227. (defun org-ascii-inlinetask (inlinetask contents info)
  1228. "Transcode an INLINETASK element from Org to ASCII.
  1229. CONTENTS holds the contents of the block. INFO is a plist
  1230. holding contextual information."
  1231. (let ((width (org-ascii--current-text-width inlinetask info)))
  1232. (funcall (plist-get info :ascii-format-inlinetask-function)
  1233. ;; todo.
  1234. (and (plist-get info :with-todo-keywords)
  1235. (let ((todo (org-element-property
  1236. :todo-keyword inlinetask)))
  1237. (and todo (org-export-data todo info))))
  1238. ;; todo-type
  1239. (org-element-property :todo-type inlinetask)
  1240. ;; priority
  1241. (and (plist-get info :with-priority)
  1242. (org-element-property :priority inlinetask))
  1243. ;; title
  1244. (org-export-data (org-element-property :title inlinetask) info)
  1245. ;; tags
  1246. (and (plist-get info :with-tags)
  1247. (org-element-property :tags inlinetask))
  1248. ;; contents and width
  1249. contents width inlinetask info)))
  1250. ;;;; Italic
  1251. (defun org-ascii-italic (italic contents info)
  1252. "Transcode italic from Org to ASCII.
  1253. CONTENTS is the text with italic markup. INFO is a plist holding
  1254. contextual information."
  1255. (format "/%s/" contents))
  1256. ;;;; Item
  1257. (defun org-ascii-item (item contents info)
  1258. "Transcode an ITEM element from Org to ASCII.
  1259. CONTENTS holds the contents of the item. INFO is a plist holding
  1260. contextual information."
  1261. (let* ((utf8p (eq (plist-get info :ascii-charset) 'utf-8))
  1262. (checkbox (org-ascii--checkbox item info))
  1263. (list-type (org-element-property :type (org-export-get-parent item)))
  1264. (bullet
  1265. ;; First parent of ITEM is always the plain-list. Get
  1266. ;; `:type' property from it.
  1267. (org-list-bullet-string
  1268. (case list-type
  1269. (descriptive
  1270. (concat checkbox
  1271. (org-export-data (org-element-property :tag item) info)
  1272. ": "))
  1273. (ordered
  1274. ;; Return correct number for ITEM, paying attention to
  1275. ;; counters.
  1276. (let* ((struct (org-element-property :structure item))
  1277. (bul (org-element-property :bullet item))
  1278. (num (number-to-string
  1279. (car (last (org-list-get-item-number
  1280. (org-element-property :begin item)
  1281. struct
  1282. (org-list-prevs-alist struct)
  1283. (org-list-parents-alist struct)))))))
  1284. (replace-regexp-in-string "[0-9]+" num bul)))
  1285. (t (let ((bul (org-element-property :bullet item)))
  1286. ;; Change bullets into more visible form if UTF-8 is active.
  1287. (if (not utf8p) bul
  1288. (replace-regexp-in-string
  1289. "-" "•"
  1290. (replace-regexp-in-string
  1291. "+" "⁃"
  1292. (replace-regexp-in-string "*" "‣" bul))))))))))
  1293. (concat
  1294. bullet
  1295. (unless (eq list-type 'descriptive) checkbox)
  1296. ;; Contents: Pay attention to indentation. Note: check-boxes are
  1297. ;; already taken care of at the paragraph level so they don't
  1298. ;; interfere with indentation.
  1299. (let ((contents (org-ascii--indent-string contents (string-width bullet))))
  1300. (if (eq (org-element-type (car (org-element-contents item))) 'paragraph)
  1301. (org-trim contents)
  1302. (concat "\n" contents))))))
  1303. ;;;; Keyword
  1304. (defun org-ascii-keyword (keyword contents info)
  1305. "Transcode a KEYWORD element from Org to ASCII.
  1306. CONTENTS is nil. INFO is a plist holding contextual
  1307. information."
  1308. (let ((key (org-element-property :key keyword))
  1309. (value (org-element-property :value keyword)))
  1310. (cond
  1311. ((string= key "ASCII") (org-ascii--justify-element value keyword info))
  1312. ((string= key "TOC")
  1313. (org-ascii--justify-element
  1314. (let ((case-fold-search t))
  1315. (cond
  1316. ((org-string-match-p "\\<headlines\\>" value)
  1317. (let ((depth (and (string-match "\\<[0-9]+\\>" value)
  1318. (string-to-number (match-string 0 value))))
  1319. (localp (org-string-match-p "\\<local\\>" value)))
  1320. (org-ascii--build-toc info depth keyword localp)))
  1321. ((org-string-match-p "\\<tables\\>" value)
  1322. (org-ascii--list-tables keyword info))
  1323. ((org-string-match-p "\\<listings\\>" value)
  1324. (org-ascii--list-listings keyword info))))
  1325. keyword info)))))
  1326. ;;;; Latex Environment
  1327. (defun org-ascii-latex-environment (latex-environment contents info)
  1328. "Transcode a LATEX-ENVIRONMENT element from Org to ASCII.
  1329. CONTENTS is nil. INFO is a plist holding contextual
  1330. information."
  1331. (when (plist-get info :with-latex)
  1332. (org-ascii--justify-element
  1333. (org-remove-indentation (org-element-property :value latex-environment))
  1334. latex-environment info)))
  1335. ;;;; Latex Fragment
  1336. (defun org-ascii-latex-fragment (latex-fragment contents info)
  1337. "Transcode a LATEX-FRAGMENT object from Org to ASCII.
  1338. CONTENTS is nil. INFO is a plist holding contextual
  1339. information."
  1340. (when (plist-get info :with-latex)
  1341. (org-element-property :value latex-fragment)))
  1342. ;;;; Line Break
  1343. (defun org-ascii-line-break (line-break contents info)
  1344. "Transcode a LINE-BREAK object from Org to ASCII.
  1345. CONTENTS is nil. INFO is a plist holding contextual
  1346. information." hard-newline)
  1347. ;;;; Link
  1348. (defun org-ascii-link (link desc info)
  1349. "Transcode a LINK object from Org to ASCII.
  1350. DESC is the description part of the link, or the empty string.
  1351. INFO is a plist holding contextual information."
  1352. (let ((type (org-element-property :type link)))
  1353. (cond
  1354. ((org-export-custom-protocol-maybe link desc 'ascii))
  1355. ((string= type "coderef")
  1356. (let ((ref (org-element-property :path link)))
  1357. (format (org-export-get-coderef-format ref desc)
  1358. (org-export-resolve-coderef ref info))))
  1359. ;; Do not apply a special syntax on radio links. Though, use
  1360. ;; transcoded target's contents as output.
  1361. ((string= type "radio") desc)
  1362. ;; Do not apply a special syntax on fuzzy links pointing to
  1363. ;; targets.
  1364. ((string= type "fuzzy")
  1365. (let ((destination (org-export-resolve-fuzzy-link link info)))
  1366. (if (org-string-nw-p desc) desc
  1367. (when destination
  1368. (let ((number
  1369. (org-export-get-ordinal
  1370. destination info nil 'org-ascii--has-caption-p)))
  1371. (if number
  1372. (if (atom number) (number-to-string number)
  1373. (mapconcat #'number-to-string number "."))
  1374. ;; Unnumbered headline.
  1375. (when (eq 'headline (org-element-type destination))
  1376. (format "[%s]"
  1377. (org-export-data
  1378. (org-element-property :title destination)
  1379. info)))))))))
  1380. (t
  1381. (let ((raw-link (org-element-property :raw-link link)))
  1382. (if (not (org-string-nw-p desc)) (format "[%s]" raw-link)
  1383. (concat (format "[%s]" desc)
  1384. (and (not (plist-get info :ascii-links-to-notes))
  1385. (format " (%s)" raw-link)))))))))
  1386. ;;;; Node Properties
  1387. (defun org-ascii-node-property (node-property contents info)
  1388. "Transcode a NODE-PROPERTY element from Org to ASCII.
  1389. CONTENTS is nil. INFO is a plist holding contextual
  1390. information."
  1391. (format "%s:%s"
  1392. (org-element-property :key node-property)
  1393. (let ((value (org-element-property :value node-property)))
  1394. (if value (concat " " value) ""))))
  1395. ;;;; Paragraph
  1396. (defun org-ascii-paragraph (paragraph contents info)
  1397. "Transcode a PARAGRAPH element from Org to ASCII.
  1398. CONTENTS is the contents of the paragraph, as a string. INFO is
  1399. the plist used as a communication channel."
  1400. (org-ascii--justify-element
  1401. (let ((indented-line-width (plist-get info :ascii-indented-line-width)))
  1402. (if (not (wholenump indented-line-width)) contents
  1403. (concat
  1404. ;; Do not indent first paragraph in a section.
  1405. (unless (and (not (org-export-get-previous-element paragraph info))
  1406. (eq (org-element-type (org-export-get-parent paragraph))
  1407. 'section))
  1408. (make-string indented-line-width ?\s))
  1409. (replace-regexp-in-string "\\`[ \t]+" "" contents))))
  1410. paragraph info))
  1411. ;;;; Plain List
  1412. (defun org-ascii-plain-list (plain-list contents info)
  1413. "Transcode a PLAIN-LIST element from Org to ASCII.
  1414. CONTENTS is the contents of the list. INFO is a plist holding
  1415. contextual information."
  1416. (let ((margin (plist-get info :ascii-list-margin)))
  1417. (if (or (< margin 1)
  1418. (eq (org-element-type (org-export-get-parent plain-list)) 'item))
  1419. contents
  1420. (org-ascii--indent-string contents margin))))
  1421. ;;;; Plain Text
  1422. (defun org-ascii-plain-text (text info)
  1423. "Transcode a TEXT string from Org to ASCII.
  1424. INFO is a plist used as a communication channel."
  1425. (let ((utf8p (eq (plist-get info :ascii-charset) 'utf-8)))
  1426. (when (and utf8p (plist-get info :with-smart-quotes))
  1427. (setq text (org-export-activate-smart-quotes text :utf-8 info)))
  1428. (if (not (plist-get info :with-special-strings)) text
  1429. (setq text (replace-regexp-in-string "\\\\-" "" text))
  1430. (if (not utf8p) text
  1431. ;; Usual replacements in utf-8 with proper option set.
  1432. (replace-regexp-in-string
  1433. "\\.\\.\\." "…"
  1434. (replace-regexp-in-string
  1435. "--" "–"
  1436. (replace-regexp-in-string "---" "—" text)))))))
  1437. ;;;; Planning
  1438. (defun org-ascii-planning (planning contents info)
  1439. "Transcode a PLANNING element from Org to ASCII.
  1440. CONTENTS is nil. INFO is a plist used as a communication
  1441. channel."
  1442. (org-ascii--justify-element
  1443. (mapconcat
  1444. #'identity
  1445. (delq nil
  1446. (list (let ((closed (org-element-property :closed planning)))
  1447. (when closed
  1448. (concat org-closed-string " "
  1449. (org-timestamp-translate closed))))
  1450. (let ((deadline (org-element-property :deadline planning)))
  1451. (when deadline
  1452. (concat org-deadline-string " "
  1453. (org-timestamp-translate deadline))))
  1454. (let ((scheduled (org-element-property :scheduled planning)))
  1455. (when scheduled
  1456. (concat org-scheduled-string " "
  1457. (org-timestamp-translate scheduled))))))
  1458. " ")
  1459. planning info))
  1460. ;;;; Property Drawer
  1461. (defun org-ascii-property-drawer (property-drawer contents info)
  1462. "Transcode a PROPERTY-DRAWER element from Org to ASCII.
  1463. CONTENTS holds the contents of the drawer. INFO is a plist
  1464. holding contextual information."
  1465. (and (org-string-nw-p contents)
  1466. (org-ascii--justify-element contents property-drawer info)))
  1467. ;;;; Quote Block
  1468. (defun org-ascii-quote-block (quote-block contents info)
  1469. "Transcode a QUOTE-BLOCK element from Org to ASCII.
  1470. CONTENTS holds the contents of the block. INFO is a plist
  1471. holding contextual information."
  1472. (org-ascii--indent-string contents (plist-get info :ascii-quote-margin)))
  1473. ;;;; Radio Target
  1474. (defun org-ascii-radio-target (radio-target contents info)
  1475. "Transcode a RADIO-TARGET object from Org to ASCII.
  1476. CONTENTS is the contents of the target. INFO is a plist holding
  1477. contextual information."
  1478. contents)
  1479. ;;;; Section
  1480. (defun org-ascii-section (section contents info)
  1481. "Transcode a SECTION element from Org to ASCII.
  1482. CONTENTS is the contents of the section. INFO is a plist holding
  1483. contextual information."
  1484. (org-ascii--indent-string
  1485. (concat
  1486. contents
  1487. (when (plist-get info :ascii-links-to-notes)
  1488. ;; Add list of links at the end of SECTION.
  1489. (let ((links (org-ascii--describe-links
  1490. (org-ascii--unique-links section info)
  1491. (org-ascii--current-text-width section info) info)))
  1492. ;; Separate list of links and section contents.
  1493. (when (org-string-nw-p links) (concat "\n\n" links)))))
  1494. ;; Do not apply inner margin if parent headline is low level.
  1495. (let ((headline (org-export-get-parent-headline section)))
  1496. (if (or (not headline) (org-export-low-level-p headline info)) 0
  1497. (plist-get info :ascii-inner-margin)))))
  1498. ;;;; Special Block
  1499. (defun org-ascii-special-block (special-block contents info)
  1500. "Transcode a SPECIAL-BLOCK element from Org to ASCII.
  1501. CONTENTS holds the contents of the block. INFO is a plist
  1502. holding contextual information."
  1503. ;; "JUSTIFYLEFT" and "JUSTFYRIGHT" have already been taken care of
  1504. ;; at a lower level. There is no other special block type to
  1505. ;; handle.
  1506. contents)
  1507. ;;;; Src Block
  1508. (defun org-ascii-src-block (src-block contents info)
  1509. "Transcode a SRC-BLOCK element from Org to ASCII.
  1510. CONTENTS holds the contents of the item. INFO is a plist holding
  1511. contextual information."
  1512. (let ((caption (org-ascii--build-caption src-block info))
  1513. (caption-above-p (plist-get info :ascii-caption-above))
  1514. (code (org-export-format-code-default src-block info)))
  1515. (if (equal code "") ""
  1516. (org-ascii--justify-element
  1517. (concat
  1518. (and caption caption-above-p (concat caption "\n"))
  1519. (org-ascii--box-string code info)
  1520. (and caption (not caption-above-p) (concat "\n" caption)))
  1521. src-block info))))
  1522. ;;;; Statistics Cookie
  1523. (defun org-ascii-statistics-cookie (statistics-cookie contents info)
  1524. "Transcode a STATISTICS-COOKIE object from Org to ASCII.
  1525. CONTENTS is nil. INFO is a plist holding contextual information."
  1526. (org-element-property :value statistics-cookie))
  1527. ;;;; Subscript
  1528. (defun org-ascii-subscript (subscript contents info)
  1529. "Transcode a SUBSCRIPT object from Org to ASCII.
  1530. CONTENTS is the contents of the object. INFO is a plist holding
  1531. contextual information."
  1532. (if (org-element-property :use-brackets-p subscript)
  1533. (format "_{%s}" contents)
  1534. (format "_%s" contents)))
  1535. ;;;; Superscript
  1536. (defun org-ascii-superscript (superscript contents info)
  1537. "Transcode a SUPERSCRIPT object from Org to ASCII.
  1538. CONTENTS is the contents of the object. INFO is a plist holding
  1539. contextual information."
  1540. (if (org-element-property :use-brackets-p superscript)
  1541. (format "^{%s}" contents)
  1542. (format "^%s" contents)))
  1543. ;;;; Strike-through
  1544. (defun org-ascii-strike-through (strike-through contents info)
  1545. "Transcode STRIKE-THROUGH from Org to ASCII.
  1546. CONTENTS is text with strike-through markup. INFO is a plist
  1547. holding contextual information."
  1548. (format "+%s+" contents))
  1549. ;;;; Table
  1550. (defun org-ascii-table (table contents info)
  1551. "Transcode a TABLE element from Org to ASCII.
  1552. CONTENTS is the contents of the table. INFO is a plist holding
  1553. contextual information."
  1554. (let ((caption (org-ascii--build-caption table info))
  1555. (caption-above-p (plist-get info :ascii-caption-above)))
  1556. (org-ascii--justify-element
  1557. (concat
  1558. ;; Possibly add a caption string above.
  1559. (and caption caption-above-p (concat caption "\n"))
  1560. ;; Insert table. Note: "table.el" tables are left unmodified.
  1561. (cond ((eq (org-element-property :type table) 'org) contents)
  1562. ((and (plist-get info :ascii-table-use-ascii-art)
  1563. (eq (plist-get info :ascii-charset) 'utf-8)
  1564. (require 'ascii-art-to-unicode nil t))
  1565. (with-temp-buffer
  1566. (insert (org-remove-indentation
  1567. (org-element-property :value table)))
  1568. (goto-char (point-min))
  1569. (aa2u)
  1570. (goto-char (point-max))
  1571. (skip-chars-backward " \r\t\n")
  1572. (buffer-substring (point-min) (point))))
  1573. (t (org-remove-indentation (org-element-property :value table))))
  1574. ;; Possible add a caption string below.
  1575. (and (not caption-above-p) caption))
  1576. table info)))
  1577. ;;;; Table Cell
  1578. (defun org-ascii--table-cell-width (table-cell info)
  1579. "Return width of TABLE-CELL.
  1580. INFO is a plist used as a communication channel.
  1581. Width of a cell is determined either by a width cookie in the
  1582. same column as the cell, or by the maximum cell's length in that
  1583. column.
  1584. When `org-ascii-table-widen-columns' is non-nil, width cookies
  1585. are ignored."
  1586. (let* ((row (org-export-get-parent table-cell))
  1587. (table (org-export-get-parent row))
  1588. (col (let ((cells (org-element-contents row)))
  1589. (- (length cells) (length (memq table-cell cells)))))
  1590. (cache
  1591. (or (plist-get info :ascii-table-cell-width-cache)
  1592. (plist-get (setq info
  1593. (plist-put info :ascii-table-cell-width-cache
  1594. (make-hash-table :test 'equal)))
  1595. :ascii-table-cell-width-cache)))
  1596. (key (cons table col))
  1597. (widenp (plist-get info :ascii-table-widen-columns)))
  1598. (or (gethash key cache)
  1599. (puthash
  1600. key
  1601. (let ((cookie-width (org-export-table-cell-width table-cell info)))
  1602. (or (and (not widenp) cookie-width)
  1603. (let ((contents-width
  1604. (let ((max-width 0))
  1605. (org-element-map table 'table-row
  1606. (lambda (row)
  1607. (setq max-width
  1608. (max (string-width
  1609. (org-export-data
  1610. (org-element-contents
  1611. (elt (org-element-contents row) col))
  1612. info))
  1613. max-width)))
  1614. info)
  1615. max-width)))
  1616. (cond ((not cookie-width) contents-width)
  1617. (widenp (max cookie-width contents-width))
  1618. (t cookie-width)))))
  1619. cache))))
  1620. (defun org-ascii-table-cell (table-cell contents info)
  1621. "Transcode a TABLE-CELL object from Org to ASCII.
  1622. CONTENTS is the cell contents. INFO is a plist used as
  1623. a communication channel."
  1624. ;; Determine column width. When `org-ascii-table-widen-columns'
  1625. ;; is nil and some width cookie has set it, use that value.
  1626. ;; Otherwise, compute the maximum width among transcoded data of
  1627. ;; each cell in the column.
  1628. (let ((width (org-ascii--table-cell-width table-cell info)))
  1629. ;; When contents are too large, truncate them.
  1630. (unless (or (plist-get info :ascii-table-widen-columns)
  1631. (<= (string-width (or contents "")) width))
  1632. (setq contents (concat (substring contents 0 (- width 2)) "=>")))
  1633. ;; Align contents correctly within the cell.
  1634. (let* ((indent-tabs-mode nil)
  1635. (data
  1636. (when contents
  1637. (org-ascii--justify-lines
  1638. contents width
  1639. (org-export-table-cell-alignment table-cell info)))))
  1640. (setq contents
  1641. (concat data
  1642. (make-string (- width (string-width (or data ""))) ?\s))))
  1643. ;; Return cell.
  1644. (concat (format " %s " contents)
  1645. (when (memq 'right (org-export-table-cell-borders table-cell info))
  1646. (if (eq (plist-get info :ascii-charset) 'utf-8) "│" "|")))))
  1647. ;;;; Table Row
  1648. (defun org-ascii-table-row (table-row contents info)
  1649. "Transcode a TABLE-ROW element from Org to ASCII.
  1650. CONTENTS is the row contents. INFO is a plist used as
  1651. a communication channel."
  1652. (when (eq (org-element-property :type table-row) 'standard)
  1653. (let ((build-hline
  1654. (function
  1655. (lambda (lcorner horiz vert rcorner)
  1656. (concat
  1657. (apply
  1658. 'concat
  1659. (org-element-map table-row 'table-cell
  1660. (lambda (cell)
  1661. (let ((width (org-ascii--table-cell-width cell info))
  1662. (borders (org-export-table-cell-borders cell info)))
  1663. (concat
  1664. ;; In order to know if CELL starts the row, do
  1665. ;; not compare it with the first cell in the
  1666. ;; row as there might be a special column.
  1667. ;; Instead, compare it with first exportable
  1668. ;; cell, obtained with `org-element-map'.
  1669. (when (and (memq 'left borders)
  1670. (eq (org-element-map table-row 'table-cell
  1671. 'identity info t)
  1672. cell))
  1673. lcorner)
  1674. (make-string (+ 2 width) (string-to-char horiz))
  1675. (cond
  1676. ((not (memq 'right borders)) nil)
  1677. ((eq (car (last (org-element-contents table-row))) cell)
  1678. rcorner)
  1679. (t vert)))))
  1680. info)) "\n"))))
  1681. (utf8p (eq (plist-get info :ascii-charset) 'utf-8))
  1682. (borders (org-export-table-cell-borders
  1683. (org-element-map table-row 'table-cell 'identity info t)
  1684. info)))
  1685. (concat (cond
  1686. ((and (memq 'top borders) (or utf8p (memq 'above borders)))
  1687. (if utf8p (funcall build-hline "┍" "━" "┯" "┑")
  1688. (funcall build-hline "+" "-" "+" "+")))
  1689. ((memq 'above borders)
  1690. (if utf8p (funcall build-hline "├" "─" "┼" "┤")
  1691. (funcall build-hline "+" "-" "+" "+"))))
  1692. (when (memq 'left borders) (if utf8p "│" "|"))
  1693. contents "\n"
  1694. (when (and (memq 'bottom borders) (or utf8p (memq 'below borders)))
  1695. (if utf8p (funcall build-hline "┕" "━" "┷" "┙")
  1696. (funcall build-hline "+" "-" "+" "+")))))))
  1697. ;;;; Timestamp
  1698. (defun org-ascii-timestamp (timestamp contents info)
  1699. "Transcode a TIMESTAMP object from Org to ASCII.
  1700. CONTENTS is nil. INFO is a plist holding contextual information."
  1701. (org-ascii-plain-text (org-timestamp-translate timestamp) info))
  1702. ;;;; Underline
  1703. (defun org-ascii-underline (underline contents info)
  1704. "Transcode UNDERLINE from Org to ASCII.
  1705. CONTENTS is the text with underline markup. INFO is a plist
  1706. holding contextual information."
  1707. (format "_%s_" contents))
  1708. ;;;; Verbatim
  1709. (defun org-ascii-verbatim (verbatim contents info)
  1710. "Return a VERBATIM object from Org to ASCII.
  1711. CONTENTS is nil. INFO is a plist holding contextual information."
  1712. (format (plist-get info :ascii-verbatim-format)
  1713. (org-element-property :value verbatim)))
  1714. ;;;; Verse Block
  1715. (defun org-ascii-verse-block (verse-block contents info)
  1716. "Transcode a VERSE-BLOCK element from Org to ASCII.
  1717. CONTENTS is verse block contents. INFO is a plist holding
  1718. contextual information."
  1719. (let ((verse-width (org-ascii--current-text-width verse-block info)))
  1720. (org-ascii--indent-string
  1721. (org-ascii--justify-element contents verse-block info)
  1722. (plist-get info :ascii-quote-margin))))
  1723. ;;; Filters
  1724. (defun org-ascii-filter-headline-blank-lines (headline back-end info)
  1725. "Filter controlling number of blank lines after a headline.
  1726. HEADLINE is a string representing a transcoded headline.
  1727. BACK-END is symbol specifying back-end used for export. INFO is
  1728. plist containing the communication channel.
  1729. This function only applies to `ascii' back-end. See
  1730. `org-ascii-headline-spacing' for information."
  1731. (let ((headline-spacing (plist-get info :ascii-headline-spacing)))
  1732. (if (not headline-spacing) headline
  1733. (let ((blanks (make-string (1+ (cdr headline-spacing)) ?\n)))
  1734. (replace-regexp-in-string "\n\\(?:\n[ \t]*\\)*\\'" blanks headline)))))
  1735. (defun org-ascii-filter-paragraph-spacing (tree back-end info)
  1736. "Filter controlling number of blank lines between paragraphs.
  1737. TREE is the parse tree. BACK-END is the symbol specifying
  1738. back-end used for export. INFO is a plist used as
  1739. a communication channel.
  1740. See `org-ascii-paragraph-spacing' for information."
  1741. (let ((paragraph-spacing (plist-get info :ascii-paragraph-spacing)))
  1742. (when (wholenump paragraph-spacing)
  1743. (org-element-map tree 'paragraph
  1744. (lambda (p)
  1745. (when (eq (org-element-type (org-export-get-next-element p info))
  1746. 'paragraph)
  1747. (org-element-put-property p :post-blank paragraph-spacing))))))
  1748. tree)
  1749. (defun org-ascii-filter-comment-spacing (tree backend info)
  1750. "Filter removing blank lines between comments.
  1751. TREE is the parse tree. BACK-END is the symbol specifying
  1752. back-end used for export. INFO is a plist used as
  1753. a communication channel."
  1754. (org-element-map tree '(comment comment-block)
  1755. (lambda (c)
  1756. (when (memq (org-element-type (org-export-get-next-element c info))
  1757. '(comment comment-block))
  1758. (org-element-put-property c :post-blank 0))))
  1759. tree)
  1760. ;;; End-user functions
  1761. ;;;###autoload
  1762. (defun org-ascii-export-as-ascii
  1763. (&optional async subtreep visible-only body-only ext-plist)
  1764. "Export current buffer to a text buffer.
  1765. If narrowing is active in the current buffer, only export its
  1766. narrowed part.
  1767. If a region is active, export that region.
  1768. A non-nil optional argument ASYNC means the process should happen
  1769. asynchronously. The resulting buffer should be accessible
  1770. through the `org-export-stack' interface.
  1771. When optional argument SUBTREEP is non-nil, export the sub-tree
  1772. at point, extracting information from the headline properties
  1773. first.
  1774. When optional argument VISIBLE-ONLY is non-nil, don't export
  1775. contents of hidden elements.
  1776. When optional argument BODY-ONLY is non-nil, strip title and
  1777. table of contents from output.
  1778. EXT-PLIST, when provided, is a property list with external
  1779. parameters overriding Org default settings, but still inferior to
  1780. file-local settings.
  1781. Export is done in a buffer named \"*Org ASCII Export*\", which
  1782. will be displayed when `org-export-show-temporary-export-buffer'
  1783. is non-nil."
  1784. (interactive)
  1785. (org-export-to-buffer 'ascii "*Org ASCII Export*"
  1786. async subtreep visible-only body-only ext-plist (lambda () (text-mode))))
  1787. ;;;###autoload
  1788. (defun org-ascii-export-to-ascii
  1789. (&optional async subtreep visible-only body-only ext-plist)
  1790. "Export current buffer to a text file.
  1791. If narrowing is active in the current buffer, only export its
  1792. narrowed part.
  1793. If a region is active, export that region.
  1794. A non-nil optional argument ASYNC means the process should happen
  1795. asynchronously. The resulting file should be accessible through
  1796. the `org-export-stack' interface.
  1797. When optional argument SUBTREEP is non-nil, export the sub-tree
  1798. at point, extracting information from the headline properties
  1799. first.
  1800. When optional argument VISIBLE-ONLY is non-nil, don't export
  1801. contents of hidden elements.
  1802. When optional argument BODY-ONLY is non-nil, strip title and
  1803. table of contents from output.
  1804. EXT-PLIST, when provided, is a property list with external
  1805. parameters overriding Org default settings, but still inferior to
  1806. file-local settings.
  1807. Return output file's name."
  1808. (interactive)
  1809. (let ((file (org-export-output-file-name ".txt" subtreep)))
  1810. (org-export-to-file 'ascii file
  1811. async subtreep visible-only body-only ext-plist)))
  1812. ;;;###autoload
  1813. (defun org-ascii-publish-to-ascii (plist filename pub-dir)
  1814. "Publish an Org file to ASCII.
  1815. FILENAME is the filename of the Org file to be published. PLIST
  1816. is the property list for the given project. PUB-DIR is the
  1817. publishing directory.
  1818. Return output file name."
  1819. (org-publish-org-to
  1820. 'ascii filename ".txt" `(:ascii-charset ascii ,@plist) pub-dir))
  1821. ;;;###autoload
  1822. (defun org-ascii-publish-to-latin1 (plist filename pub-dir)
  1823. "Publish an Org file to Latin-1.
  1824. FILENAME is the filename of the Org file to be published. PLIST
  1825. is the property list for the given project. PUB-DIR is the
  1826. publishing directory.
  1827. Return output file name."
  1828. (org-publish-org-to
  1829. 'ascii filename ".txt" `(:ascii-charset latin1 ,@plist) pub-dir))
  1830. ;;;###autoload
  1831. (defun org-ascii-publish-to-utf8 (plist filename pub-dir)
  1832. "Publish an org file to UTF-8.
  1833. FILENAME is the filename of the Org file to be published. PLIST
  1834. is the property list for the given project. PUB-DIR is the
  1835. publishing directory.
  1836. Return output file name."
  1837. (org-publish-org-to
  1838. 'ascii filename ".txt" `(:ascii-charset utf-8 ,@plist) pub-dir))
  1839. (provide 'ox-ascii)
  1840. ;; Local variables:
  1841. ;; generated-autoload-file: "org-loaddefs.el"
  1842. ;; coding: utf-8-emacs
  1843. ;; End:
  1844. ;;; ox-ascii.el ends here