ox-man.el 41 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261
  1. ;; ox-man.el --- Man Back-End for Org Export Engine
  2. ;; Copyright (C) 2011-2015 Free Software Foundation, Inc.
  3. ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
  4. ;; Luis R Anaya <papoanaya aroba hot mail punto com>
  5. ;; Keywords: outlines, hypermedia, calendar, wp
  6. ;; This file is part of GNU Emacs.
  7. ;; GNU Emacs is free software: you can redistribute it and/or modify
  8. ;; it under the terms of the GNU General Public License as published by
  9. ;; the Free Software Foundation, either version 3 of the License, or
  10. ;; (at your option) any later version.
  11. ;; GNU Emacs is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. ;; GNU General Public License for more details.
  15. ;; You should have received a copy of the GNU General Public License
  16. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  17. ;;; Commentary:
  18. ;;
  19. ;; This library implements a Man back-end for Org generic exporter.
  20. ;;
  21. ;; To test it, run
  22. ;;
  23. ;; M-: (org-export-to-buffer 'man "*Test Man*") RET
  24. ;;
  25. ;; in an org-mode buffer then switch to the buffer to see the Man
  26. ;; export. See ox.el for more details on how this exporter works.
  27. ;;
  28. ;; It introduces one new buffer keywords:
  29. ;; "MAN_CLASS_OPTIONS".
  30. ;;; Code:
  31. (require 'ox)
  32. (eval-when-compile (require 'cl))
  33. (defvar org-export-man-default-packages-alist)
  34. (defvar org-export-man-packages-alist)
  35. (defvar orgtbl-exp-regexp)
  36. ;;; Define Back-End
  37. (org-export-define-backend 'man
  38. '((babel-call . org-man-babel-call)
  39. (bold . org-man-bold)
  40. (center-block . org-man-center-block)
  41. (clock . org-man-clock)
  42. (code . org-man-code)
  43. (drawer . org-man-drawer)
  44. (dynamic-block . org-man-dynamic-block)
  45. (entity . org-man-entity)
  46. (example-block . org-man-example-block)
  47. (export-block . org-man-export-block)
  48. (export-snippet . org-man-export-snippet)
  49. (fixed-width . org-man-fixed-width)
  50. (footnote-definition . org-man-footnote-definition)
  51. (footnote-reference . org-man-footnote-reference)
  52. (headline . org-man-headline)
  53. (horizontal-rule . org-man-horizontal-rule)
  54. (inline-babel-call . org-man-inline-babel-call)
  55. (inline-src-block . org-man-inline-src-block)
  56. (inlinetask . org-man-inlinetask)
  57. (italic . org-man-italic)
  58. (item . org-man-item)
  59. (keyword . org-man-keyword)
  60. (line-break . org-man-line-break)
  61. (link . org-man-link)
  62. (node-property . org-man-node-property)
  63. (paragraph . org-man-paragraph)
  64. (plain-list . org-man-plain-list)
  65. (plain-text . org-man-plain-text)
  66. (planning . org-man-planning)
  67. (property-drawer . org-man-property-drawer)
  68. (quote-block . org-man-quote-block)
  69. (radio-target . org-man-radio-target)
  70. (section . org-man-section)
  71. (special-block . org-man-special-block)
  72. (src-block . org-man-src-block)
  73. (statistics-cookie . org-man-statistics-cookie)
  74. (strike-through . org-man-strike-through)
  75. (subscript . org-man-subscript)
  76. (superscript . org-man-superscript)
  77. (table . org-man-table)
  78. (table-cell . org-man-table-cell)
  79. (table-row . org-man-table-row)
  80. (target . org-man-target)
  81. (template . org-man-template)
  82. (timestamp . org-man-timestamp)
  83. (underline . org-man-underline)
  84. (verbatim . org-man-verbatim)
  85. (verse-block . org-man-verse-block))
  86. :export-block "MAN"
  87. :menu-entry
  88. '(?M "Export to MAN"
  89. ((?m "As MAN file" org-man-export-to-man)
  90. (?p "As PDF file" org-man-export-to-pdf)
  91. (?o "As PDF file and open"
  92. (lambda (a s v b)
  93. (if a (org-man-export-to-pdf t s v b)
  94. (org-open-file (org-man-export-to-pdf nil s v b)))))))
  95. :options-alist
  96. '((:man-class "MAN_CLASS" nil nil t)
  97. (:man-class-options "MAN_CLASS_OPTIONS" nil nil t)
  98. (:man-header-extra "MAN_HEADER" nil nil newline)
  99. ;; Other variables.
  100. (:man-tables-centered nil nil org-man-tables-centered)
  101. (:man-tables-verbatim nil nil org-man-tables-verbatim)
  102. (:man-table-scientific-notation nil nil org-man-table-scientific-notation)
  103. (:man-source-highlight nil nil org-man-source-highlight)
  104. (:man-source-highlight-langs nil nil org-man-source-highlight-langs)))
  105. ;;; User Configurable Variables
  106. (defgroup org-export-man nil
  107. "Options for exporting Org mode files to Man."
  108. :tag "Org Export Man"
  109. :group 'org-export)
  110. ;;; Tables
  111. (defcustom org-man-tables-centered t
  112. "When non-nil, tables are exported in a center environment."
  113. :group 'org-export-man
  114. :version "24.4"
  115. :package-version '(Org . "8.0")
  116. :type 'boolean)
  117. (defcustom org-man-tables-verbatim nil
  118. "When non-nil, tables are exported verbatim."
  119. :group 'org-export-man
  120. :version "24.4"
  121. :package-version '(Org . "8.0")
  122. :type 'boolean)
  123. (defcustom org-man-table-scientific-notation "%sE%s"
  124. "Format string to display numbers in scientific notation.
  125. The format should have \"%s\" twice, for mantissa and exponent
  126. \(i.e. \"%s\\\\times10^{%s}\").
  127. When nil, no transformation is made."
  128. :group 'org-export-man
  129. :version "24.4"
  130. :package-version '(Org . "8.0")
  131. :type '(choice
  132. (string :tag "Format string")
  133. (const :tag "No formatting")))
  134. ;;; Inlinetasks
  135. ;; Src blocks
  136. (defcustom org-man-source-highlight nil
  137. "Use GNU source highlight to embellish source blocks "
  138. :group 'org-export-man
  139. :version "24.4"
  140. :package-version '(Org . "8.0")
  141. :type 'boolean)
  142. (defcustom org-man-source-highlight-langs
  143. '((emacs-lisp "lisp") (lisp "lisp") (clojure "lisp")
  144. (scheme "scheme")
  145. (c "c") (cc "cpp") (csharp "csharp") (d "d")
  146. (fortran "fortran") (cobol "cobol") (pascal "pascal")
  147. (ada "ada") (asm "asm")
  148. (perl "perl") (cperl "perl")
  149. (python "python") (ruby "ruby") (tcl "tcl") (lua "lua")
  150. (java "java") (javascript "javascript")
  151. (tex "latex")
  152. (shell-script "sh") (awk "awk") (diff "diff") (m4 "m4")
  153. (ocaml "caml") (caml "caml")
  154. (sql "sql") (sqlite "sql")
  155. (html "html") (css "css") (xml "xml")
  156. (bat "bat") (bison "bison") (clipper "clipper")
  157. (ldap "ldap") (opa "opa")
  158. (php "php") (postscript "postscript") (prolog "prolog")
  159. (properties "properties") (makefile "makefile")
  160. (tml "tml") (vala "vala") (vbscript "vbscript") (xorg "xorg"))
  161. "Alist mapping languages to their listing language counterpart.
  162. The key is a symbol, the major mode symbol without the \"-mode\".
  163. The value is the string that should be inserted as the language
  164. parameter for the listings package. If the mode name and the
  165. listings name are the same, the language does not need an entry
  166. in this list - but it does not hurt if it is present."
  167. :group 'org-export-man
  168. :version "24.4"
  169. :package-version '(Org . "8.0")
  170. :type '(repeat
  171. (list
  172. (symbol :tag "Major mode ")
  173. (string :tag "Listings language"))))
  174. (defvar org-man-custom-lang-environments nil
  175. "Alist mapping languages to language-specific Man environments.
  176. It is used during export of src blocks by the listings and
  177. man packages. For example,
  178. (setq org-man-custom-lang-environments
  179. '((python \"pythoncode\")))
  180. would have the effect that if org encounters begin_src python
  181. during man export."
  182. )
  183. ;;; Compilation
  184. (defcustom org-man-pdf-process
  185. '("tbl %f | eqn | groff -man | ps2pdf - > %b.pdf"
  186. "tbl %f | eqn | groff -man | ps2pdf - > %b.pdf"
  187. "tbl %f | eqn | groff -man | ps2pdf - > %b.pdf")
  188. "Commands to process a Man file to a PDF file.
  189. This is a list of strings, each of them will be given to the
  190. shell as a command. %f in the command will be replaced by the
  191. full file name, %b by the file base name (i.e. without directory
  192. and extension parts) and %o by the base directory of the file.
  193. By default, Org uses 3 runs of to do the processing.
  194. Alternatively, this may be a Lisp function that does the
  195. processing. This function should accept the file name as
  196. its single argument."
  197. :group 'org-export-pdf
  198. :group 'org-export-man
  199. :version "24.4"
  200. :package-version '(Org . "8.0")
  201. :type '(choice
  202. (repeat :tag "Shell command sequence"
  203. (string :tag "Shell command"))
  204. (const :tag "2 runs of pdfgroff"
  205. ("tbl %f | eqn | groff -mm | ps2pdf - > %b.pdf"
  206. "tbl %f | eqn | groff -mm | ps2pdf - > %b.pdf" ))
  207. (const :tag "3 runs of pdfgroff"
  208. ("tbl %f | eqn | groff -mm | ps2pdf - > %b.pdf"
  209. "tbl %f | eqn | groff -mm | ps2pdf - > %b.pdf"
  210. "tbl %f | eqn | groff -mm | ps2pdf - > %b.pdf"))
  211. (function)))
  212. (defcustom org-man-logfiles-extensions
  213. '("log" "out" "toc")
  214. "The list of file extensions to consider as Man logfiles."
  215. :group 'org-export-man
  216. :version "24.4"
  217. :package-version '(Org . "8.0")
  218. :type '(repeat (string :tag "Extension")))
  219. (defcustom org-man-remove-logfiles t
  220. "Non-nil means remove the logfiles produced by PDF production.
  221. These are the .aux, .log, .out, and .toc files."
  222. :group 'org-export-man
  223. :version "24.4"
  224. :package-version '(Org . "8.0")
  225. :type 'boolean)
  226. ;;; Internal Functions
  227. (defun org-man--caption/label-string (element info)
  228. "Return caption and label Man string for ELEMENT.
  229. INFO is a plist holding contextual information. If there's no
  230. caption nor label, return the empty string.
  231. For non-floats, see `org-man--wrap-label'."
  232. (let ((label (org-element-property :label element))
  233. (main (org-export-get-caption element))
  234. (short (org-export-get-caption element t)))
  235. (cond ((and (not main) (not label)) "")
  236. ((not main) (format "\\fI%s\\fP" label))
  237. ;; Option caption format with short name.
  238. (short (format "\\fR%s\\fP - \\fI\\P - %s\n"
  239. (org-export-data short info)
  240. (org-export-data main info)))
  241. ;; Standard caption format.
  242. (t (format "\\fR%s\\fP" (org-export-data main info))))))
  243. (defun org-man--wrap-label (element output)
  244. "Wrap label associated to ELEMENT around OUTPUT, if appropriate.
  245. This function shouldn't be used for floats. See
  246. `org-man--caption/label-string'."
  247. (let ((label (org-element-property :name element)))
  248. (if (or (not output) (not label) (string= output "") (string= label ""))
  249. output
  250. (concat (format "%s\n.br\n" label) output))))
  251. ;;; Template
  252. (defun org-man-template (contents info)
  253. "Return complete document string after Man conversion.
  254. CONTENTS is the transcoded contents string. INFO is a plist
  255. holding export options."
  256. (let* ((title (when (plist-get info :with-title)
  257. (org-export-data (plist-get info :title) info)))
  258. (attr (read (format "(%s)"
  259. (mapconcat
  260. #'identity
  261. (list (plist-get info :man-class-options))
  262. " "))))
  263. (section-item (plist-get attr :section-id)))
  264. (concat
  265. (cond
  266. ((and title (stringp section-item))
  267. (format ".TH \"%s\" \"%s\" \n" title section-item))
  268. ((and (string= "" title) (stringp section-item))
  269. (format ".TH \"%s\" \"%s\" \n" " " section-item))
  270. (title
  271. (format ".TH \"%s\" \"1\" \n" title))
  272. (t
  273. ".TH \" \" \"1\" "))
  274. contents)))
  275. ;;; Transcode Functions
  276. ;;; Babel Call
  277. ;;
  278. ;; Babel Calls are ignored.
  279. ;;; Bold
  280. (defun org-man-bold (bold contents info)
  281. "Transcode BOLD from Org to Man.
  282. CONTENTS is the text with bold markup. INFO is a plist holding
  283. contextual information."
  284. (format "\\fB%s\\fP" contents))
  285. ;;; Center Block
  286. (defun org-man-center-block (center-block contents info)
  287. "Transcode a CENTER-BLOCK element from Org to Man.
  288. CONTENTS holds the contents of the center block. INFO is a plist
  289. holding contextual information."
  290. (org-man--wrap-label
  291. center-block
  292. (format ".ce %d\n.nf\n%s\n.fi"
  293. (- (length (split-string contents "\n")) 1 )
  294. contents)))
  295. ;;; Clock
  296. (defun org-man-clock (clock contents info)
  297. "Transcode a CLOCK element from Org to Man.
  298. CONTENTS is nil. INFO is a plist holding contextual
  299. information."
  300. "" )
  301. ;;; Code
  302. (defun org-man-code (code contents info)
  303. "Transcode a CODE object from Org to Man.
  304. CONTENTS is nil. INFO is a plist used as a communication
  305. channel."
  306. (format "\\fC%s\\fP" code))
  307. ;;; Comment
  308. ;;
  309. ;; Comments are ignored.
  310. ;;; Comment Block
  311. ;;
  312. ;; Comment Blocks are ignored.
  313. ;;; Drawer
  314. (defun org-man-drawer (drawer contents info)
  315. "Transcode a DRAWER element from Org to Man.
  316. DRAWER holds the drawer information
  317. CONTENTS holds the contents of the block.
  318. INFO is a plist holding contextual information. "
  319. contents)
  320. ;;; Dynamic Block
  321. (defun org-man-dynamic-block (dynamic-block contents info)
  322. "Transcode a DYNAMIC-BLOCK element from Org to Man.
  323. CONTENTS holds the contents of the block. INFO is a plist
  324. holding contextual information. See `org-export-data'."
  325. (org-man--wrap-label dynamic-block contents))
  326. ;;; Entity
  327. (defun org-man-entity (entity contents info)
  328. "Transcode an ENTITY object from Org to Man.
  329. CONTENTS are the definition itself. INFO is a plist holding
  330. contextual information."
  331. (org-element-property :utf-8 entity))
  332. ;;; Example Block
  333. (defun org-man-example-block (example-block contents info)
  334. "Transcode an EXAMPLE-BLOCK element from Org to Man.
  335. CONTENTS is nil. INFO is a plist holding contextual
  336. information."
  337. (org-man--wrap-label
  338. example-block
  339. (format ".RS\n.nf\n%s\n.fi\n.RE"
  340. (org-export-format-code-default example-block info))))
  341. ;;; Export Block
  342. (defun org-man-export-block (export-block contents info)
  343. "Transcode a EXPORT-BLOCK element from Org to Man.
  344. CONTENTS is nil. INFO is a plist holding contextual information."
  345. (when (string= (org-element-property :type export-block) "MAN")
  346. (org-remove-indentation (org-element-property :value export-block))))
  347. ;;; Export Snippet
  348. (defun org-man-export-snippet (export-snippet contents info)
  349. "Transcode a EXPORT-SNIPPET object from Org to Man.
  350. CONTENTS is nil. INFO is a plist holding contextual information."
  351. (when (eq (org-export-snippet-backend export-snippet) 'man)
  352. (org-element-property :value export-snippet)))
  353. ;;; Fixed Width
  354. (defun org-man-fixed-width (fixed-width contents info)
  355. "Transcode a FIXED-WIDTH element from Org to Man.
  356. CONTENTS is nil. INFO is a plist holding contextual information."
  357. (org-man--wrap-label
  358. fixed-width
  359. (format "\\fC\n%s\\fP"
  360. (org-remove-indentation
  361. (org-element-property :value fixed-width)))))
  362. ;;; Footnote Definition
  363. ;;
  364. ;; Footnote Definitions are ignored.
  365. ;;; Footnote References
  366. ;;
  367. ;; Footnote References are Ignored
  368. ;;; Headline
  369. (defun org-man-headline (headline contents info)
  370. "Transcode a HEADLINE element from Org to Man.
  371. CONTENTS holds the contents of the headline. INFO is a plist
  372. holding contextual information."
  373. (let* ((level (org-export-get-relative-level headline info))
  374. (numberedp (org-export-numbered-headline-p headline info))
  375. ;; Section formatting will set two placeholders: one for the
  376. ;; title and the other for the contents.
  377. (section-fmt
  378. (case level
  379. (1 ".SH \"%s\"\n%s")
  380. (2 ".SS \"%s\"\n%s")
  381. (3 ".SS \"%s\"\n%s")
  382. (t nil)))
  383. (text (org-export-data (org-element-property :title headline) info)))
  384. (cond
  385. ;; Case 1: This is a footnote section: ignore it.
  386. ((org-element-property :footnote-section-p headline) nil)
  387. ;; Case 2. This is a deep sub-tree: export it as a list item.
  388. ;; Also export as items headlines for which no section
  389. ;; format has been found.
  390. ((or (not section-fmt) (org-export-low-level-p headline info))
  391. ;; Build the real contents of the sub-tree.
  392. (let ((low-level-body
  393. (concat
  394. ;; If the headline is the first sibling, start a list.
  395. (when (org-export-first-sibling-p headline info)
  396. (format "%s\n" ".RS"))
  397. ;; Itemize headline
  398. ".TP\n.ft I\n" text "\n.ft\n"
  399. contents ".RE")))
  400. ;; If headline is not the last sibling simply return
  401. ;; LOW-LEVEL-BODY. Otherwise, also close the list, before any
  402. ;; blank line.
  403. (if (not (org-export-last-sibling-p headline info)) low-level-body
  404. (replace-regexp-in-string
  405. "[ \t\n]*\\'" ""
  406. low-level-body))))
  407. ;; Case 3. Standard headline. Export it as a section.
  408. (t (format section-fmt text contents )))))
  409. ;;; Horizontal Rule
  410. ;; Not supported
  411. ;;; Inline Babel Call
  412. ;;
  413. ;; Inline Babel Calls are ignored.
  414. ;;; Inline Src Block
  415. (defun org-man-inline-src-block (inline-src-block contents info)
  416. "Transcode an INLINE-SRC-BLOCK element from Org to Man.
  417. CONTENTS holds the contents of the item. INFO is a plist holding
  418. contextual information."
  419. (let* ((code (org-element-property :value inline-src-block)))
  420. (cond
  421. ((plist-get info :man-source-highlight)
  422. (let* ((tmpdir (if (featurep 'xemacs)
  423. temp-directory
  424. temporary-file-directory ))
  425. (in-file (make-temp-name
  426. (expand-file-name "srchilite" tmpdir)))
  427. (out-file (make-temp-name
  428. (expand-file-name "reshilite" tmpdir)))
  429. (org-lang (org-element-property :language inline-src-block))
  430. (lst-lang
  431. (cadr (assq (intern org-lang)
  432. (plist-get info :man-source-highlight-langs))))
  433. (cmd (concat (expand-file-name "source-highlight")
  434. " -s " lst-lang
  435. " -f groff_man"
  436. " -i " in-file
  437. " -o " out-file )))
  438. (if lst-lang
  439. (let ((code-block "" ))
  440. (with-temp-file in-file (insert code))
  441. (shell-command cmd)
  442. (setq code-block (org-file-contents out-file))
  443. (delete-file in-file)
  444. (delete-file out-file)
  445. code-block)
  446. (format ".RS\n.nf\n\\fC\\m[black]%s\\m[]\\fP\n.fi\n.RE\n"
  447. code))))
  448. ;; Do not use a special package: transcode it verbatim.
  449. (t
  450. (concat ".RS\n.nf\n" "\\fC" "\n" code "\n"
  451. "\\fP\n.fi\n.RE\n")))))
  452. ;;; Inlinetask
  453. ;;; Italic
  454. (defun org-man-italic (italic contents info)
  455. "Transcode ITALIC from Org to Man.
  456. CONTENTS is the text with italic markup. INFO is a plist holding
  457. contextual information."
  458. (format "\\fI%s\\fP" contents))
  459. ;;; Item
  460. (defun org-man-item (item contents info)
  461. "Transcode an ITEM element from Org to Man.
  462. CONTENTS holds the contents of the item. INFO is a plist holding
  463. contextual information."
  464. (let* ((bullet (org-element-property :bullet item))
  465. (type (org-element-property :type (org-element-property :parent item)))
  466. (checkbox (case (org-element-property :checkbox item)
  467. (on "\\o'\\(sq\\(mu'") ;;
  468. (off "\\(sq ") ;;
  469. (trans "\\o'\\(sq\\(mi'" ))) ;;
  470. (tag (let ((tag (org-element-property :tag item)))
  471. ;; Check-boxes must belong to the tag.
  472. (and tag (format "\\fB%s\\fP"
  473. (concat checkbox
  474. (org-export-data tag info)))))))
  475. (if (and (null tag )
  476. (null checkbox))
  477. (let* ((bullet (org-trim bullet))
  478. (marker (cond ((string= "-" bullet) "\\(em")
  479. ((string= "*" bullet) "\\(bu")
  480. ((eq type 'ordered)
  481. (format "%s " (org-trim bullet)))
  482. (t "\\(dg"))))
  483. (concat ".IP " marker " 4\n"
  484. (org-trim (or contents " " ))))
  485. ; else
  486. (concat ".TP\n" (or tag (concat " " checkbox)) "\n"
  487. (org-trim (or contents " " ))))))
  488. ;;; Keyword
  489. (defun org-man-keyword (keyword contents info)
  490. "Transcode a KEYWORD element from Org to Man.
  491. CONTENTS is nil. INFO is a plist holding contextual information."
  492. (let ((key (org-element-property :key keyword))
  493. (value (org-element-property :value keyword)))
  494. (cond
  495. ((string= key "MAN") value)
  496. ((string= key "INDEX") nil)
  497. ((string= key "TOC" ) nil))))
  498. ;;; Line Break
  499. (defun org-man-line-break (line-break contents info)
  500. "Transcode a LINE-BREAK object from Org to Man.
  501. CONTENTS is nil. INFO is a plist holding contextual information."
  502. ".br\n")
  503. ;;; Link
  504. (defun org-man-link (link desc info)
  505. "Transcode a LINK object from Org to Man.
  506. DESC is the description part of the link, or the empty string.
  507. INFO is a plist holding contextual information. See
  508. `org-export-data'."
  509. (let* ((type (org-element-property :type link))
  510. (raw-path (org-element-property :path link))
  511. ;; Ensure DESC really exists, or set it to nil.
  512. (desc (and (not (string= desc "")) desc))
  513. (path (cond
  514. ((member type '("http" "https" "ftp" "mailto"))
  515. (concat type ":" raw-path))
  516. ((string= type "file") (org-export-file-uri raw-path))
  517. (t raw-path)))
  518. protocol)
  519. (cond
  520. ;; Link type is handled by a special function.
  521. ((org-export-custom-protocol-maybe link desc 'man))
  522. ;; External link with a description part.
  523. ((and path desc) (format "%s \\fBat\\fP \\fI%s\\fP" path desc))
  524. ;; External link without a description part.
  525. (path (format "\\fI%s\\fP" path))
  526. ;; No path, only description. Try to do something useful.
  527. (t (format "\\fI%s\\fP" desc)))))
  528. ;;;; Node Property
  529. (defun org-man-node-property (node-property contents info)
  530. "Transcode a NODE-PROPERTY element from Org to Man.
  531. CONTENTS is nil. INFO is a plist holding contextual
  532. information."
  533. (format "%s:%s"
  534. (org-element-property :key node-property)
  535. (let ((value (org-element-property :value node-property)))
  536. (if value (concat " " value) ""))))
  537. ;;; Paragraph
  538. (defun org-man-paragraph (paragraph contents info)
  539. "Transcode a PARAGRAPH element from Org to Man.
  540. CONTENTS is the contents of the paragraph, as a string. INFO is
  541. the plist used as a communication channel."
  542. (let ((parent (plist-get (nth 1 paragraph) :parent)))
  543. (when parent
  544. (let ((parent-type (car parent))
  545. (fixed-paragraph ""))
  546. (cond ((and (eq parent-type 'item)
  547. (plist-get (nth 1 parent) :bullet ))
  548. (setq fixed-paragraph (concat "" contents)))
  549. ((eq parent-type 'section)
  550. (setq fixed-paragraph (concat ".PP\n" contents)))
  551. ((eq parent-type 'footnote-definition)
  552. (setq fixed-paragraph contents))
  553. (t (setq fixed-paragraph (concat "" contents))))
  554. fixed-paragraph ))))
  555. ;;; Plain List
  556. (defun org-man-plain-list (plain-list contents info)
  557. "Transcode a PLAIN-LIST element from Org to Man.
  558. CONTENTS is the contents of the list. INFO is a plist holding
  559. contextual information."
  560. contents)
  561. ;;; Plain Text
  562. (defun org-man-plain-text (text info)
  563. "Transcode a TEXT string from Org to Man.
  564. TEXT is the string to transcode. INFO is a plist holding
  565. contextual information."
  566. (let ((output text))
  567. ;; Protect various chars.
  568. (setq output (replace-regexp-in-string
  569. "\\(?:[^\\]\\|^\\)\\(\\\\\\)\\(?:[^%$#&{}~^_\\]\\|$\\)"
  570. "$\\" output nil t 1))
  571. ;; Activate smart quotes. Be sure to provide original TEXT string
  572. ;; since OUTPUT may have been modified.
  573. (when (plist-get info :with-smart-quotes)
  574. (setq output (org-export-activate-smart-quotes output :utf-8 info text)))
  575. ;; Handle break preservation if required.
  576. (when (plist-get info :preserve-breaks)
  577. (setq output (replace-regexp-in-string "\\(\\\\\\\\\\)?[ \t]*\n" ".br\n"
  578. output)))
  579. ;; Return value.
  580. output))
  581. ;;; Planning
  582. ;;; Property Drawer
  583. (defun org-man-property-drawer (property-drawer contents info)
  584. "Transcode a PROPERTY-DRAWER element from Org to Man.
  585. CONTENTS holds the contents of the drawer. INFO is a plist
  586. holding contextual information."
  587. (and (org-string-nw-p contents)
  588. (format ".RS\n.nf\n%s\n.fi\n.RE" contents)))
  589. ;;; Quote Block
  590. (defun org-man-quote-block (quote-block contents info)
  591. "Transcode a QUOTE-BLOCK element from Org to Man.
  592. CONTENTS holds the contents of the block. INFO is a plist
  593. holding contextual information."
  594. (org-man--wrap-label
  595. quote-block
  596. (format ".RS\n%s\n.RE" contents)))
  597. ;;; Radio Target
  598. (defun org-man-radio-target (radio-target text info)
  599. "Transcode a RADIO-TARGET object from Org to Man.
  600. TEXT is the text of the target. INFO is a plist holding
  601. contextual information."
  602. text )
  603. ;;; Section
  604. (defun org-man-section (section contents info)
  605. "Transcode a SECTION element from Org to Man.
  606. CONTENTS holds the contents of the section. INFO is a plist
  607. holding contextual information."
  608. contents)
  609. ;;; Special Block
  610. (defun org-man-special-block (special-block contents info)
  611. "Transcode a SPECIAL-BLOCK element from Org to Man.
  612. CONTENTS holds the contents of the block. INFO is a plist
  613. holding contextual information."
  614. (let ((type (org-element-property :type special-block)))
  615. (org-man--wrap-label
  616. special-block
  617. (format "%s\n" contents))))
  618. ;;; Src Block
  619. (defun org-man-src-block (src-block contents info)
  620. "Transcode a SRC-BLOCK element from Org to Man.
  621. CONTENTS holds the contents of the item. INFO is a plist holding
  622. contextual information."
  623. (let* ((lang (org-element-property :language src-block))
  624. (code (org-element-property :value src-block))
  625. (custom-env (and lang
  626. (cadr (assq (intern lang)
  627. org-man-custom-lang-environments))))
  628. (num-start (case (org-element-property :number-lines src-block)
  629. (continued (org-export-get-loc src-block info))
  630. (new 0)))
  631. (retain-labels (org-element-property :retain-labels src-block)))
  632. (if (not (plist-get info :man-source-highlight))
  633. (format ".RS\n.nf\n\\fC%s\\fP\n.fi\n.RE\n\n"
  634. (org-export-format-code-default src-block info))
  635. (let* ((tmpdir (if (featurep 'xemacs) temp-directory
  636. temporary-file-directory))
  637. (in-file (make-temp-name (expand-file-name "srchilite" tmpdir)))
  638. (out-file (make-temp-name (expand-file-name "reshilite" tmpdir)))
  639. (org-lang (org-element-property :language src-block))
  640. (lst-lang
  641. (cadr (assq (intern org-lang)
  642. (plist-get info :man-source-highlight-langs))))
  643. (cmd (concat "source-highlight"
  644. " -s " lst-lang
  645. " -f groff_man "
  646. " -i " in-file
  647. " -o " out-file)))
  648. (if lst-lang
  649. (let ((code-block ""))
  650. (with-temp-file in-file (insert code))
  651. (shell-command cmd)
  652. (setq code-block (org-file-contents out-file))
  653. (delete-file in-file)
  654. (delete-file out-file)
  655. code-block)
  656. (format ".RS\n.nf\n\\fC\\m[black]%s\\m[]\\fP\n.fi\n.RE" code))))))
  657. ;;; Statistics Cookie
  658. (defun org-man-statistics-cookie (statistics-cookie contents info)
  659. "Transcode a STATISTICS-COOKIE object from Org to Man.
  660. CONTENTS is nil. INFO is a plist holding contextual information."
  661. (org-element-property :value statistics-cookie))
  662. ;;; Strike-Through
  663. (defun org-man-strike-through (strike-through contents info)
  664. "Transcode STRIKE-THROUGH from Org to Man.
  665. CONTENTS is the text with strike-through markup. INFO is a plist
  666. holding contextual information."
  667. (format "\\fI%s\\fP" contents))
  668. ;;; Subscript
  669. (defun org-man-subscript (subscript contents info)
  670. "Transcode a SUBSCRIPT object from Org to Man.
  671. CONTENTS is the contents of the object. INFO is a plist holding
  672. contextual information."
  673. (format "\\d\\s-2%s\\s+2\\u" contents))
  674. ;;; Superscript "^_%s$
  675. (defun org-man-superscript (superscript contents info)
  676. "Transcode a SUPERSCRIPT object from Org to Man.
  677. CONTENTS is the contents of the object. INFO is a plist holding
  678. contextual information."
  679. (format "\\u\\s-2%s\\s+2\\d" contents))
  680. ;;; Table
  681. ;;
  682. ;; `org-man-table' is the entry point for table transcoding. It
  683. ;; takes care of tables with a "verbatim" attribute. Otherwise, it
  684. ;; delegates the job to either `org-man-table--table.el-table' or
  685. ;; `org-man-table--org-table' functions, depending of the type of
  686. ;; the table.
  687. ;;
  688. ;; `org-man-table--align-string' is a subroutine used to build
  689. ;; alignment string for Org tables.
  690. (defun org-man-table (table contents info)
  691. "Transcode a TABLE element from Org to Man.
  692. CONTENTS is the contents of the table. INFO is a plist holding
  693. contextual information."
  694. (cond
  695. ;; Case 1: verbatim table.
  696. ((or (plist-get info :man-tables-verbatim)
  697. (let ((attr (read (format "(%s)"
  698. (mapconcat
  699. #'identity
  700. (org-element-property :attr_man table)
  701. " ")))))
  702. (and attr (plist-get attr :verbatim))))
  703. (format ".nf\n\\fC%s\\fP\n.fi"
  704. ;; Re-create table, without affiliated keywords.
  705. (org-trim
  706. (org-element-interpret-data
  707. `(table nil ,@(org-element-contents table))))))
  708. ;; Case 2: Standard table.
  709. (t (org-man-table--org-table table contents info))))
  710. (defun org-man-table--align-string (divider table info)
  711. "Return an appropriate Man alignment string.
  712. TABLE is the considered table. INFO is a plist used as
  713. a communication channel."
  714. (let (alignment)
  715. ;; Extract column groups and alignment from first (non-rule) row.
  716. (org-element-map
  717. (org-element-map table 'table-row
  718. (lambda (row)
  719. (and (eq (org-element-property :type row) 'standard) row))
  720. info 'first-match)
  721. 'table-cell
  722. (lambda (cell)
  723. (let* ((borders (org-export-table-cell-borders cell info))
  724. (raw-width (org-export-table-cell-width cell info))
  725. (width-cm (when raw-width (/ raw-width 5)))
  726. (width (if raw-width (format "w(%dc)"
  727. (if (< width-cm 1) 1 width-cm)) "")))
  728. ;; Check left border for the first cell only.
  729. (when (and (memq 'left borders) (not alignment))
  730. (push "|" alignment))
  731. (push
  732. (case (org-export-table-cell-alignment cell info)
  733. (left (concat "l" width divider))
  734. (right (concat "r" width divider))
  735. (center (concat "c" width divider)))
  736. alignment)
  737. (when (memq 'right borders) (push "|" alignment))))
  738. info)
  739. (apply 'concat (reverse alignment))))
  740. (defun org-man-table--org-table (table contents info)
  741. "Return appropriate Man code for an Org table.
  742. TABLE is the table type element to transcode. CONTENTS is its
  743. contents, as a string. INFO is a plist used as a communication
  744. channel.
  745. This function assumes TABLE has `org' as its `:type' attribute."
  746. (let* ((attr (org-export-read-attribute :attr_man table))
  747. (label (org-element-property :name table))
  748. (caption (and (not (plist-get attr :disable-caption))
  749. (org-man--caption/label-string table info)))
  750. (divider (if (plist-get attr :divider) "|" " "))
  751. ;; Determine alignment string.
  752. (alignment (org-man-table--align-string divider table info))
  753. ;; Extract others display options.
  754. (lines (org-split-string contents "\n"))
  755. (attr-list
  756. (delq nil
  757. (list
  758. (and (plist-get attr :expand) "expand")
  759. (let ((placement (plist-get attr :placement)))
  760. (cond ((string= placement 'center) "center")
  761. ((string= placement 'left) nil)
  762. ((plist-get info :man-tables-centered) "center")
  763. (t "")))
  764. (or (plist-get attr :boxtype) "box"))))
  765. (title-line (plist-get attr :title-line))
  766. (long-cells (plist-get attr :long-cells))
  767. (table-format (concat
  768. (format "%s" (or (car attr-list) "" ))
  769. (or
  770. (let ((output-list '()))
  771. (when (cdr attr-list)
  772. (dolist (attr-item (cdr attr-list))
  773. (setq output-list (concat output-list (format ",%s" attr-item)))))
  774. output-list)
  775. "")))
  776. (first-line (when lines (org-split-string (car lines) "\t"))))
  777. ;; Prepare the final format string for the table.
  778. (cond
  779. ;; Others.
  780. (lines (concat ".TS\n " table-format ";\n"
  781. (format "%s.\n"
  782. (let ((final-line ""))
  783. (when title-line
  784. (dotimes (i (length first-line))
  785. (setq final-line (concat final-line "cb" divider))))
  786. (setq final-line (concat final-line "\n"))
  787. (if alignment
  788. (setq final-line (concat final-line alignment))
  789. (dotimes (i (length first-line))
  790. (setq final-line (concat final-line "c" divider))))
  791. final-line ))
  792. (format "%s.TE\n"
  793. (let ((final-line "")
  794. (long-line "")
  795. (lines (org-split-string contents "\n")))
  796. (dolist (line-item lines)
  797. (setq long-line "")
  798. (if long-cells
  799. (progn
  800. (if (string= line-item "_")
  801. (setq long-line (format "%s\n" line-item))
  802. ;; else string =
  803. (let ((cell-item-list (org-split-string line-item "\t")))
  804. (dolist (cell-item cell-item-list)
  805. (cond ((eq cell-item (car (last cell-item-list)))
  806. (setq long-line (concat long-line
  807. (format "T{\n%s\nT}\t\n" cell-item ))))
  808. (t
  809. (setq long-line (concat long-line
  810. (format "T{\n%s\nT}\t" cell-item ))))))
  811. long-line))
  812. ;; else long cells
  813. (setq final-line (concat final-line long-line )))
  814. (setq final-line (concat final-line line-item "\n"))))
  815. final-line))
  816. (and caption (format ".TB \"%s\"" caption)))))))
  817. ;;; Table Cell
  818. (defun org-man-table-cell (table-cell contents info)
  819. "Transcode a TABLE-CELL element from Org to Man
  820. CONTENTS is the cell contents. INFO is a plist used as
  821. a communication channel."
  822. (concat
  823. (let ((scientific-format (plist-get info :man-table-scientific-notation)))
  824. (if (and contents
  825. scientific-format
  826. (string-match orgtbl-exp-regexp contents))
  827. ;; Use appropriate format string for scientific notation.
  828. (format scientific-format
  829. (match-string 1 contents)
  830. (match-string 2 contents))
  831. contents))
  832. (when (org-export-get-next-element table-cell info) "\t")))
  833. ;;; Table Row
  834. (defun org-man-table-row (table-row contents info)
  835. "Transcode a TABLE-ROW element from Org to Man
  836. CONTENTS is the contents of the row. INFO is a plist used as
  837. a communication channel."
  838. ;; Rules are ignored since table separators are deduced from
  839. ;; borders of the current row.
  840. (when (eq (org-element-property :type table-row) 'standard)
  841. (let* ((attr (mapconcat 'identity
  842. (org-element-property
  843. :attr_man (org-export-get-parent table-row))
  844. " "))
  845. ;; TABLE-ROW's borders are extracted from its first cell.
  846. (borders
  847. (org-export-table-cell-borders
  848. (car (org-element-contents table-row)) info)))
  849. (concat
  850. ;; Mark horizontal lines
  851. (cond ((and (memq 'top borders) (memq 'above borders)) "_\n"))
  852. contents
  853. (cond
  854. ;; When BOOKTABS are activated enforce bottom rule even when
  855. ;; no hline was specifically marked.
  856. ((and (memq 'bottom borders) (memq 'below borders)) "\n_")
  857. ((memq 'below borders) "\n_"))))))
  858. ;;; Target
  859. (defun org-man-target (target contents info)
  860. "Transcode a TARGET object from Org to Man.
  861. CONTENTS is nil. INFO is a plist holding contextual
  862. information."
  863. (format "\\fI%s\\fP" (org-export-get-reference target info)))
  864. ;;; Timestamp
  865. (defun org-man-timestamp (timestamp contents info)
  866. "Transcode a TIMESTAMP object from Org to Man.
  867. CONTENTS is nil. INFO is a plist holding contextual
  868. information."
  869. "" )
  870. ;;; Underline
  871. (defun org-man-underline (underline contents info)
  872. "Transcode UNDERLINE from Org to Man.
  873. CONTENTS is the text with underline markup. INFO is a plist
  874. holding contextual information."
  875. (format "\\fI%s\\fP" contents))
  876. ;;; Verbatim
  877. (defun org-man-verbatim (verbatim contents info)
  878. "Transcode a VERBATIM object from Org to Man.
  879. CONTENTS is nil. INFO is a plist used as a communication
  880. channel."
  881. (format ".nf\n%s\n.fi" contents))
  882. ;;; Verse Block
  883. (defun org-man-verse-block (verse-block contents info)
  884. "Transcode a VERSE-BLOCK element from Org to Man.
  885. CONTENTS is verse block contents. INFO is a plist holding
  886. contextual information."
  887. (format ".RS\n.ft I\n%s\n.ft\n.RE" contents))
  888. ;;; Interactive functions
  889. (defun org-man-export-to-man
  890. (&optional async subtreep visible-only body-only ext-plist)
  891. "Export current buffer to a Man file.
  892. If narrowing is active in the current buffer, only export its
  893. narrowed part.
  894. If a region is active, export that region.
  895. A non-nil optional argument ASYNC means the process should happen
  896. asynchronously. The resulting file should be accessible through
  897. the `org-export-stack' interface.
  898. When optional argument SUBTREEP is non-nil, export the sub-tree
  899. at point, extracting information from the headline properties
  900. first.
  901. When optional argument VISIBLE-ONLY is non-nil, don't export
  902. contents of hidden elements.
  903. When optional argument BODY-ONLY is non-nil, only the body
  904. without any markers.
  905. EXT-PLIST, when provided, is a property list with external
  906. parameters overriding Org default settings, but still inferior to
  907. file-local settings.
  908. Return output file's name."
  909. (interactive)
  910. (let ((outfile (org-export-output-file-name ".man" subtreep)))
  911. (org-export-to-file 'man outfile
  912. async subtreep visible-only body-only ext-plist)))
  913. (defun org-man-export-to-pdf
  914. (&optional async subtreep visible-only body-only ext-plist)
  915. "Export current buffer to Groff then process through to PDF.
  916. If narrowing is active in the current buffer, only export its
  917. narrowed part.
  918. If a region is active, export that region.
  919. A non-nil optional argument ASYNC means the process should happen
  920. asynchronously. The resulting file should be accessible through
  921. the `org-export-stack' interface.
  922. When optional argument SUBTREEP is non-nil, export the sub-tree
  923. at point, extracting information from the headline properties
  924. first.
  925. When optional argument VISIBLE-ONLY is non-nil, don't export
  926. contents of hidden elements.
  927. When optional argument BODY-ONLY is non-nil, only write between
  928. markers.
  929. EXT-PLIST, when provided, is a property list with external
  930. parameters overriding Org default settings, but still inferior to
  931. file-local settings.
  932. Return PDF file's name."
  933. (interactive)
  934. (let ((outfile (org-export-output-file-name ".man" subtreep)))
  935. (org-export-to-file 'man outfile
  936. async subtreep visible-only body-only ext-plist
  937. (lambda (file) (org-latex-compile file)))))
  938. (defun org-man-compile (file)
  939. "Compile a Groff file.
  940. FILE is the name of the file being compiled. Processing is done
  941. through the command specified in `org-man-pdf-process'.
  942. Return PDF file name or an error if it couldn't be produced."
  943. (let* ((base-name (file-name-sans-extension (file-name-nondirectory file)))
  944. (full-name (file-truename file))
  945. (out-dir (file-name-directory file))
  946. ;; Properly set working directory for compilation.
  947. (default-directory (if (file-name-absolute-p file)
  948. (file-name-directory full-name)
  949. default-directory))
  950. errors)
  951. (message "Processing Groff file %s..." file)
  952. (save-window-excursion
  953. (cond
  954. ;; A function is provided: Apply it.
  955. ((functionp org-man-pdf-process)
  956. (funcall org-man-pdf-process (shell-quote-argument file)))
  957. ;; A list is provided: Replace %b, %f and %o with appropriate
  958. ;; values in each command before applying it. Output is
  959. ;; redirected to "*Org PDF Groff Output*" buffer.
  960. ((consp org-man-pdf-process)
  961. (let ((outbuf (get-buffer-create "*Org PDF Groff Output*")))
  962. (mapc
  963. (lambda (command)
  964. (shell-command
  965. (replace-regexp-in-string
  966. "%b" (shell-quote-argument base-name)
  967. (replace-regexp-in-string
  968. "%f" (shell-quote-argument full-name)
  969. (replace-regexp-in-string
  970. "%o" (shell-quote-argument out-dir) command t t) t t) t t)
  971. outbuf))
  972. org-man-pdf-process)
  973. ;; Collect standard errors from output buffer.
  974. (setq errors (org-man-collect-errors outbuf))))
  975. (t (error "No valid command to process to PDF")))
  976. (let ((pdffile (concat out-dir base-name ".pdf")))
  977. ;; Check for process failure. Provide collected errors if
  978. ;; possible.
  979. (if (not (file-exists-p pdffile))
  980. (error "PDF file %s wasn't produced%s" pdffile
  981. (if errors (concat ": " errors) ""))
  982. ;; Else remove log files, when specified, and signal end of
  983. ;; process to user, along with any error encountered.
  984. (when org-man-remove-logfiles
  985. (dolist (ext org-man-logfiles-extensions)
  986. (let ((file (concat out-dir base-name "." ext)))
  987. (when (file-exists-p file) (delete-file file)))))
  988. (message (concat "Process completed"
  989. (if (not errors) "."
  990. (concat " with errors: " errors)))))
  991. ;; Return output file name.
  992. pdffile))))
  993. (defun org-man-collect-errors (buffer)
  994. "Collect some kind of errors from \"groff\" output
  995. BUFFER is the buffer containing output.
  996. Return collected error types as a string, or nil if there was
  997. none."
  998. (with-current-buffer buffer
  999. (save-excursion
  1000. (goto-char (point-max))
  1001. ;; Find final run
  1002. nil )))
  1003. (provide 'ox-man)
  1004. ;; Local variables:
  1005. ;; generated-autoload-file: "org-loaddefs.el"
  1006. ;; End:
  1007. ;;; ox-man.el ends here