org-html.el 92 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620
  1. ;;; org-html.el --- HTML export for Org-mode
  2. ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: http://orgmode.org
  6. ;;
  7. ;; This file is part of GNU Emacs.
  8. ;;
  9. ;; GNU Emacs is free software: you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation, either version 3 of the License, or
  12. ;; (at your option) any later version.
  13. ;; GNU Emacs is distributed in the hope that it will be useful,
  14. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. ;; GNU General Public License for more details.
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;;; Code:
  23. (require 'org-exp)
  24. (require 'format-spec)
  25. (eval-when-compile (require 'cl))
  26. (declare-function org-id-find-id-file "org-id" (id))
  27. (declare-function htmlize-region "ext:htmlize" (beg end))
  28. (declare-function org-pop-to-buffer-same-window
  29. "org-compat" (&optional buffer-or-name norecord label))
  30. (defgroup org-export-html nil
  31. "Options specific for HTML export of Org-mode files."
  32. :tag "Org Export HTML"
  33. :group 'org-export)
  34. (defcustom org-export-html-footnotes-section "<div id=\"footnotes\">
  35. <h2 class=\"footnotes\">%s: </h2>
  36. <div id=\"text-footnotes\">
  37. %s
  38. </div>
  39. </div>"
  40. "Format for the footnotes section.
  41. Should contain a two instances of %s. The first will be replaced with the
  42. language-specific word for \"Footnotes\", the second one will be replaced
  43. by the footnotes themselves."
  44. :group 'org-export-html
  45. :type 'string)
  46. (defcustom org-export-html-footnote-format "<sup>%s</sup>"
  47. "The format for the footnote reference.
  48. %s will be replaced by the footnote reference itself."
  49. :group 'org-export-html
  50. :type 'string)
  51. (defcustom org-export-html-footnote-separator "<sup>, </sup>"
  52. "Text used to separate footnotes."
  53. :group 'org-export-html
  54. :type 'string)
  55. (defcustom org-export-html-coding-system nil
  56. "Coding system for HTML export, defaults to `buffer-file-coding-system'."
  57. :group 'org-export-html
  58. :type 'coding-system)
  59. (defcustom org-export-html-extension "html"
  60. "The extension for exported HTML files."
  61. :group 'org-export-html
  62. :type 'string)
  63. (defcustom org-export-html-xml-declaration
  64. '(("html" . "<?xml version=\"1.0\" encoding=\"%s\"?>")
  65. ("php" . "<?php echo \"<?xml version=\\\"1.0\\\" encoding=\\\"%s\\\" ?>\"; ?>"))
  66. "The extension for exported HTML files.
  67. %s will be replaced with the charset of the exported file.
  68. This may be a string, or an alist with export extensions
  69. and corresponding declarations."
  70. :group 'org-export-html
  71. :type '(choice
  72. (string :tag "Single declaration")
  73. (repeat :tag "Dependent on extension"
  74. (cons (string :tag "Extension")
  75. (string :tag "Declaration")))))
  76. (defcustom org-export-html-style-include-scripts t
  77. "Non-nil means include the JavaScript snippets in exported HTML files.
  78. The actual script is defined in `org-export-html-scripts' and should
  79. not be modified."
  80. :group 'org-export-html
  81. :type 'boolean)
  82. (defconst org-export-html-scripts
  83. "<script type=\"text/javascript\">
  84. <!--/*--><![CDATA[/*><!--*/
  85. function CodeHighlightOn(elem, id)
  86. {
  87. var target = document.getElementById(id);
  88. if(null != target) {
  89. elem.cacheClassElem = elem.className;
  90. elem.cacheClassTarget = target.className;
  91. target.className = \"code-highlighted\";
  92. elem.className = \"code-highlighted\";
  93. }
  94. }
  95. function CodeHighlightOff(elem, id)
  96. {
  97. var target = document.getElementById(id);
  98. if(elem.cacheClassElem)
  99. elem.className = elem.cacheClassElem;
  100. if(elem.cacheClassTarget)
  101. target.className = elem.cacheClassTarget;
  102. }
  103. /*]]>*///-->
  104. </script>"
  105. "Basic JavaScript that is needed by HTML files produced by Org-mode.")
  106. (defconst org-export-html-style-default
  107. "<style type=\"text/css\">
  108. <!--/*--><![CDATA[/*><!--*/
  109. html { font-family: Times, serif; font-size: 12pt; }
  110. .title { text-align: center; }
  111. .todo { color: red; }
  112. .done { color: green; }
  113. .tag { background-color: #add8e6; font-weight:normal }
  114. .target { }
  115. .timestamp { color: #bebebe; }
  116. .timestamp-kwd { color: #5f9ea0; }
  117. .right {margin-left:auto; margin-right:0px; text-align:right;}
  118. .left {margin-left:0px; margin-right:auto; text-align:left;}
  119. .center {margin-left:auto; margin-right:auto; text-align:center;}
  120. p.verse { margin-left: 3% }
  121. pre {
  122. border: 1pt solid #AEBDCC;
  123. background-color: #F3F5F7;
  124. padding: 5pt;
  125. font-family: courier, monospace;
  126. font-size: 90%;
  127. overflow:auto;
  128. }
  129. table { border-collapse: collapse; }
  130. td, th { vertical-align: top; }
  131. th.right { text-align:center; }
  132. th.left { text-align:center; }
  133. th.center { text-align:center; }
  134. td.right { text-align:right; }
  135. td.left { text-align:left; }
  136. td.center { text-align:center; }
  137. dt { font-weight: bold; }
  138. div.figure { padding: 0.5em; }
  139. div.figure p { text-align: center; }
  140. div.inlinetask {
  141. padding:10px;
  142. border:2px solid gray;
  143. margin:10px;
  144. background: #ffffcc;
  145. }
  146. textarea { overflow-x: auto; }
  147. .linenr { font-size:smaller }
  148. .code-highlighted {background-color:#ffff00;}
  149. .org-info-js_info-navigation { border-style:none; }
  150. #org-info-js_console-label { font-size:10px; font-weight:bold;
  151. white-space:nowrap; }
  152. .org-info-js_search-highlight {background-color:#ffff00; color:#000000;
  153. font-weight:bold; }
  154. /*]]>*/-->
  155. </style>"
  156. "The default style specification for exported HTML files.
  157. Please use the variables `org-export-html-style' and
  158. `org-export-html-style-extra' to add to this style. If you wish to not
  159. have the default style included, customize the variable
  160. `org-export-html-style-include-default'.")
  161. (defcustom org-export-html-style-include-default t
  162. "Non-nil means include the default style in exported HTML files.
  163. The actual style is defined in `org-export-html-style-default' and should
  164. not be modified. Use the variables `org-export-html-style' to add
  165. your own style information."
  166. :group 'org-export-html
  167. :type 'boolean)
  168. ;;;###autoload
  169. (put 'org-export-html-style-include-default 'safe-local-variable 'booleanp)
  170. (defcustom org-export-html-style ""
  171. "Org-wide style definitions for exported HTML files.
  172. This variable needs to contain the full HTML structure to provide a style,
  173. including the surrounding HTML tags. If you set the value of this variable,
  174. you should consider to include definitions for the following classes:
  175. title, todo, done, timestamp, timestamp-kwd, tag, target.
  176. For example, a valid value would be:
  177. <style type=\"text/css\">
  178. <![CDATA[
  179. p { font-weight: normal; color: gray; }
  180. h1 { color: black; }
  181. .title { text-align: center; }
  182. .todo, .timestamp-kwd { color: red; }
  183. .done { color: green; }
  184. ]]>
  185. </style>
  186. If you'd like to refer to an external style file, use something like
  187. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  188. As the value of this option simply gets inserted into the HTML <head> header,
  189. you can \"misuse\" it to add arbitrary text to the header.
  190. See also the variable `org-export-html-style-extra'."
  191. :group 'org-export-html
  192. :type 'string)
  193. ;;;###autoload
  194. (put 'org-export-html-style 'safe-local-variable 'stringp)
  195. (defcustom org-export-html-style-extra ""
  196. "Additional style information for HTML export.
  197. The value of this variable is inserted into the HTML buffer right after
  198. the value of `org-export-html-style'. Use this variable for per-file
  199. settings of style information, and do not forget to surround the style
  200. settings with <style>...</style> tags."
  201. :group 'org-export-html
  202. :type 'string)
  203. ;;;###autoload
  204. (put 'org-export-html-style-extra 'safe-local-variable 'stringp)
  205. (defcustom org-export-html-mathjax-options
  206. '((path "http://orgmode.org/mathjax/MathJax.js")
  207. (scale "100")
  208. (align "center")
  209. (indent "2em")
  210. (mathml nil))
  211. "Options for MathJax setup.
  212. path The path where to find MathJax
  213. scale Scaling for the HTML-CSS backend, usually between 100 and 133
  214. align How to align display math: left, center, or right
  215. indent If align is not center, how far from the left/right side?
  216. mathml Should a MathML player be used if available?
  217. This is faster and reduces bandwidth use, but currently
  218. sometimes has lower spacing quality. Therefore, the default is
  219. nil. When browsers get better, this switch can be flipped.
  220. You can also customize this for each buffer, using something like
  221. #+MATHJAX: scale:\"133\" align:\"right\" mathml:t path:\"/MathJax/\""
  222. :group 'org-export-html
  223. :type '(list :greedy t
  224. (list :tag "path (the path from where to load MathJax.js)"
  225. (const :format " " path) (string))
  226. (list :tag "scale (scaling for the displayed math)"
  227. (const :format " " scale) (string))
  228. (list :tag "align (alignment of displayed equations)"
  229. (const :format " " align) (string))
  230. (list :tag "indent (indentation with left or right alignment)"
  231. (const :format " " indent) (string))
  232. (list :tag "mathml (should MathML display be used is possible)"
  233. (const :format " " mathml) (boolean))))
  234. (defun org-export-html-mathjax-config (template options in-buffer)
  235. "Insert the user setup into the matchjax template."
  236. (let (name val (yes " ") (no "// ") x)
  237. (mapc
  238. (lambda (e)
  239. (setq name (car e) val (nth 1 e))
  240. (if (string-match (concat "\\<" (symbol-name name) ":") in-buffer)
  241. (setq val (car (read-from-string
  242. (substring in-buffer (match-end 0))))))
  243. (if (not (stringp val)) (setq val (format "%s" val)))
  244. (if (string-match (concat "%" (upcase (symbol-name name))) template)
  245. (setq template (replace-match val t t template))))
  246. options)
  247. (setq val (nth 1 (assq 'mathml options)))
  248. (if (string-match (concat "\\<mathml:") in-buffer)
  249. (setq val (car (read-from-string
  250. (substring in-buffer (match-end 0))))))
  251. ;; Exchange prefixes depending on mathml setting
  252. (if (not val) (setq x yes yes no no x))
  253. ;; Replace cookies to turn on or off the config/jax lines
  254. (if (string-match ":MMLYES:" template)
  255. (setq template (replace-match yes t t template)))
  256. (if (string-match ":MMLNO:" template)
  257. (setq template (replace-match no t t template)))
  258. ;; Return the modified template
  259. template))
  260. (defcustom org-export-html-mathjax-template
  261. "<script type=\"text/javascript\" src=\"%PATH\">
  262. <!--/*--><![CDATA[/*><!--*/
  263. MathJax.Hub.Config({
  264. // Only one of the two following lines, depending on user settings
  265. // First allows browser-native MathML display, second forces HTML/CSS
  266. :MMLYES: config: [\"MMLorHTML.js\"], jax: [\"input/TeX\"],
  267. :MMLNO: jax: [\"input/TeX\", \"output/HTML-CSS\"],
  268. extensions: [\"tex2jax.js\",\"TeX/AMSmath.js\",\"TeX/AMSsymbols.js\",
  269. \"TeX/noUndefined.js\"],
  270. tex2jax: {
  271. inlineMath: [ [\"\\\\(\",\"\\\\)\"] ],
  272. displayMath: [ ['$$','$$'], [\"\\\\[\",\"\\\\]\"], [\"\\\\begin{displaymath}\",\"\\\\end{displaymath}\"] ],
  273. skipTags: [\"script\",\"noscript\",\"style\",\"textarea\",\"pre\",\"code\"],
  274. ignoreClass: \"tex2jax_ignore\",
  275. processEscapes: false,
  276. processEnvironments: true,
  277. preview: \"TeX\"
  278. },
  279. showProcessingMessages: true,
  280. displayAlign: \"%ALIGN\",
  281. displayIndent: \"%INDENT\",
  282. \"HTML-CSS\": {
  283. scale: %SCALE,
  284. availableFonts: [\"STIX\",\"TeX\"],
  285. preferredFont: \"TeX\",
  286. webFont: \"TeX\",
  287. imageFont: \"TeX\",
  288. showMathMenu: true,
  289. },
  290. MMLorHTML: {
  291. prefer: {
  292. MSIE: \"MML\",
  293. Firefox: \"MML\",
  294. Opera: \"HTML\",
  295. other: \"HTML\"
  296. }
  297. }
  298. });
  299. /*]]>*///-->
  300. </script>"
  301. "The MathJax setup for XHTML files."
  302. :group 'org-export-html
  303. :type 'string)
  304. (defcustom org-export-html-tag-class-prefix ""
  305. "Prefix to class names for TODO keywords.
  306. Each tag gets a class given by the tag itself, with this prefix.
  307. The default prefix is empty because it is nice to just use the keyword
  308. as a class name. But if you get into conflicts with other, existing
  309. CSS classes, then this prefix can be very useful."
  310. :group 'org-export-html
  311. :type 'string)
  312. (defcustom org-export-html-todo-kwd-class-prefix ""
  313. "Prefix to class names for TODO keywords.
  314. Each TODO keyword gets a class given by the keyword itself, with this prefix.
  315. The default prefix is empty because it is nice to just use the keyword
  316. as a class name. But if you get into conflicts with other, existing
  317. CSS classes, then this prefix can be very useful."
  318. :group 'org-export-html
  319. :type 'string)
  320. (defcustom org-export-html-preamble t
  321. "Non-nil means insert a preamble in HTML export.
  322. When `t', insert a string as defined by one of the formatting
  323. strings in `org-export-html-preamble-format'. When set to a
  324. string, this string overrides `org-export-html-preamble-format'.
  325. When set to a function, apply this function and insert the
  326. returned string. The function takes the property list of export
  327. options as its only argument.
  328. Setting :html-preamble in publishing projects will take
  329. precedence over this variable."
  330. :group 'org-export-html
  331. :type '(choice (const :tag "No preamble" nil)
  332. (const :tag "Default preamble" t)
  333. (string :tag "Custom formatting string")
  334. (function :tag "Function (must return a string)")))
  335. (defcustom org-export-html-preamble-format '(("en" ""))
  336. "The format for the HTML preamble.
  337. %t stands for the title.
  338. %a stands for the author's name.
  339. %e stands for the author's email.
  340. %d stands for the date.
  341. If you need to use a \"%\" character, you need to escape it
  342. like that: \"%%\"."
  343. :group 'org-export-html
  344. :type 'string)
  345. (defcustom org-export-html-postamble 'auto
  346. "Non-nil means insert a postamble in HTML export.
  347. When `t', insert a string as defined by the formatting string in
  348. `org-export-html-postamble-format'. When set to a string, this
  349. string overrides `org-export-html-postamble-format'. When set to
  350. 'auto, discard `org-export-html-postamble-format' and honor
  351. `org-export-author/email/creator-info' variables. When set to a
  352. function, apply this function and insert the returned string.
  353. The function takes the property list of export options as its
  354. only argument.
  355. Setting :html-postamble in publishing projects will take
  356. precedence over this variable."
  357. :group 'org-export-html
  358. :type '(choice (const :tag "No postamble" nil)
  359. (const :tag "Auto preamble" 'auto)
  360. (const :tag "Default formatting string" t)
  361. (string :tag "Custom formatting string")
  362. (function :tag "Function (must return a string)")))
  363. (defcustom org-export-html-postamble-format
  364. '(("en" "<p class=\"author\">Author: %a (%e)</p>
  365. <p class=\"date\">Date: %d</p>
  366. <p class=\"creator\">Generated by %c</p>
  367. <p class=\"xhtml-validation\">%v</p>
  368. "))
  369. "The format for the HTML postamble.
  370. %a stands for the author's name.
  371. %e stands for the author's email.
  372. %d stands for the date.
  373. %c will be replaced by information about Org/Emacs versions.
  374. %v will be replaced by `org-export-html-validation-link'.
  375. If you need to use a \"%\" character, you need to escape it
  376. like that: \"%%\"."
  377. :group 'org-export-html
  378. :type 'string)
  379. (defcustom org-export-html-home/up-format
  380. "<div id=\"org-div-home-and-up\" style=\"text-align:right;font-size:70%%;white-space:nowrap;\">
  381. <a accesskey=\"h\" href=\"%s\"> UP </a>
  382. |
  383. <a accesskey=\"H\" href=\"%s\"> HOME </a>
  384. </div>"
  385. "Snippet used to insert the HOME and UP links.
  386. This is a format string, the first %s will receive the UP link,
  387. the second the HOME link. If both `org-export-html-link-up' and
  388. `org-export-html-link-home' are empty, the entire snippet will be
  389. ignored."
  390. :group 'org-export-html
  391. :type 'string)
  392. (defcustom org-export-html-toplevel-hlevel 2
  393. "The <H> level for level 1 headings in HTML export.
  394. This is also important for the classes that will be wrapped around headlines
  395. and outline structure. If this variable is 1, the top-level headlines will
  396. be <h1>, and the corresponding classes will be outline-1, section-number-1,
  397. and outline-text-1. If this is 2, all of these will get a 2 instead.
  398. The default for this variable is 2, because we use <h1> for formatting the
  399. document title."
  400. :group 'org-export-html
  401. :type 'string)
  402. (defcustom org-export-html-link-org-files-as-html t
  403. "Non-nil means make file links to `file.org' point to `file.html'.
  404. When org-mode is exporting an org-mode file to HTML, links to
  405. non-html files are directly put into a href tag in HTML.
  406. However, links to other Org-mode files (recognized by the
  407. extension `.org.) should become links to the corresponding html
  408. file, assuming that the linked org-mode file will also be
  409. converted to HTML.
  410. When nil, the links still point to the plain `.org' file."
  411. :group 'org-export-html
  412. :type 'boolean)
  413. (defcustom org-export-html-inline-images 'maybe
  414. "Non-nil means inline images into exported HTML pages.
  415. This is done using an <img> tag. When nil, an anchor with href is used to
  416. link to the image. If this option is `maybe', then images in links with
  417. an empty description will be inlined, while images with a description will
  418. be linked only."
  419. :group 'org-export-html
  420. :type '(choice (const :tag "Never" nil)
  421. (const :tag "Always" t)
  422. (const :tag "When there is no description" maybe)))
  423. (defcustom org-export-html-inline-image-extensions
  424. '("png" "jpeg" "jpg" "gif" "svg")
  425. "Extensions of image files that can be inlined into HTML."
  426. :group 'org-export-html
  427. :type '(repeat (string :tag "Extension")))
  428. (defcustom org-export-html-table-tag
  429. "<table border=\"2\" cellspacing=\"0\" cellpadding=\"6\" rules=\"groups\" frame=\"hsides\">"
  430. "The HTML tag that is used to start a table.
  431. This must be a <table> tag, but you may change the options like
  432. borders and spacing."
  433. :group 'org-export-html
  434. :type 'string)
  435. (defcustom org-export-table-header-tags '("<th scope=\"%s\"%s>" . "</th>")
  436. "The opening tag for table header fields.
  437. This is customizable so that alignment options can be specified.
  438. The first %s will be filled with the scope of the field, either row or col.
  439. The second %s will be replaced by a style entry to align the field.
  440. See also the variable `org-export-html-table-use-header-tags-for-first-column'.
  441. See also the variable `org-export-html-table-align-individual-fields'."
  442. :group 'org-export-tables
  443. :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
  444. (defcustom org-export-table-data-tags '("<td%s>" . "</td>")
  445. "The opening tag for table data fields.
  446. This is customizable so that alignment options can be specified.
  447. The first %s will be filled with the scope of the field, either row or col.
  448. The second %s will be replaced by a style entry to align the field.
  449. See also the variable `org-export-html-table-align-individual-fields'."
  450. :group 'org-export-tables
  451. :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
  452. (defcustom org-export-table-row-tags '("<tr>" . "</tr>")
  453. "The opening tag for table data fields.
  454. This is customizable so that alignment options can be specified.
  455. Instead of strings, these can be Lisp forms that will be evaluated
  456. for each row in order to construct the table row tags. During evaluation,
  457. the variable `head' will be true when this is a header line, nil when this
  458. is a body line. And the variable `nline' will contain the line number,
  459. starting from 1 in the first header line. For example
  460. (setq org-export-table-row-tags
  461. (cons '(if head
  462. \"<tr>\"
  463. (if (= (mod nline 2) 1)
  464. \"<tr class=\\\"tr-odd\\\">\"
  465. \"<tr class=\\\"tr-even\\\">\"))
  466. \"</tr>\"))
  467. will give even lines the class \"tr-even\" and odd lines the class \"tr-odd\"."
  468. :group 'org-export-tables
  469. :type '(cons
  470. (choice :tag "Opening tag"
  471. (string :tag "Specify")
  472. (sexp))
  473. (choice :tag "Closing tag"
  474. (string :tag "Specify")
  475. (sexp))))
  476. (defcustom org-export-html-table-align-individual-fields t
  477. "Non-nil means attach style attributes for alignment to each table field.
  478. When nil, alignment will only be specified in the column tags, but this
  479. is ignored by some browsers (like Firefox, Safari). Opera does it right
  480. though."
  481. :group 'org-export-tables
  482. :type 'boolean)
  483. (defcustom org-export-html-table-use-header-tags-for-first-column nil
  484. "Non-nil means format column one in tables with header tags.
  485. When nil, also column one will use data tags."
  486. :group 'org-export-tables
  487. :type 'boolean)
  488. (defcustom org-export-html-validation-link
  489. "<a href=\"http://validator.w3.org/check?uri=referer\">Validate XHTML 1.0</a>"
  490. "Link to HTML validation service."
  491. :group 'org-export-html
  492. :type 'string)
  493. ;; FIXME Obsolete since Org 7.7
  494. ;; Use the :timestamp option or `org-export-time-stamp-file' instead
  495. (defvar org-export-html-with-timestamp nil
  496. "If non-nil, write container for HTML-helper-mode timestamp.")
  497. ;; FIXME Obsolete since Org 7.7
  498. (defvar org-export-html-html-helper-timestamp
  499. "\n<p><br/><br/>\n<!-- hhmts start --> <!-- hhmts end --></p>\n"
  500. "The HTML tag used as timestamp delimiter for HTML-helper-mode.")
  501. (defcustom org-export-html-protect-char-alist
  502. '(("&" . "&amp;")
  503. ("<" . "&lt;")
  504. (">" . "&gt;"))
  505. "Alist of characters to be converted by `org-html-protect'."
  506. :group 'org-export-html
  507. :type '(repeat (cons (string :tag "Character")
  508. (string :tag "HTML equivalent"))))
  509. (defgroup org-export-htmlize nil
  510. "Options for processing examples with htmlize.el."
  511. :tag "Org Export Htmlize"
  512. :group 'org-export-html)
  513. (defcustom org-export-htmlize-output-type 'inline-css
  514. "Output type to be used by htmlize when formatting code snippets.
  515. Choices are `css', to export the CSS selectors only, or `inline-css', to
  516. export the CSS attribute values inline in the HTML. We use as default
  517. `inline-css', in order to make the resulting HTML self-containing.
  518. However, this will fail when using Emacs in batch mode for export, because
  519. then no rich font definitions are in place. It will also not be good if
  520. people with different Emacs setup contribute HTML files to a website,
  521. because the fonts will represent the individual setups. In these cases,
  522. it is much better to let Org/Htmlize assign classes only, and to use
  523. a style file to define the look of these classes.
  524. To get a start for your css file, start Emacs session and make sure that
  525. all the faces you are interested in are defined, for example by loading files
  526. in all modes you want. Then, use the command
  527. \\[org-export-htmlize-generate-css] to extract class definitions."
  528. :group 'org-export-htmlize
  529. :type '(choice (const css) (const inline-css)))
  530. (defcustom org-export-htmlize-css-font-prefix "org-"
  531. "The prefix for CSS class names for htmlize font specifications."
  532. :group 'org-export-htmlize
  533. :type 'string)
  534. (defcustom org-export-htmlized-org-css-url nil
  535. "URL pointing to a CSS file defining text colors for htmlized Emacs buffers.
  536. Normally when creating an htmlized version of an Org buffer, htmlize will
  537. create CSS to define the font colors. However, this does not work when
  538. converting in batch mode, and it also can look bad if different people
  539. with different fontification setup work on the same website.
  540. When this variable is non-nil, creating an htmlized version of an Org buffer
  541. using `org-export-as-org' will remove the internal CSS section and replace it
  542. with a link to this URL."
  543. :group 'org-export-htmlize
  544. :type '(choice
  545. (const :tag "Keep internal css" nil)
  546. (string :tag "URL or local href")))
  547. ;; FIXME: The following variable is obsolete since Org 7.7 but is
  548. ;; still declared and checked within code for compatibility reasons.
  549. ;; Use the custom variables `org-export-html-divs' instead.
  550. (defvar org-export-html-content-div "content"
  551. "The name of the container DIV that holds all the page contents.
  552. This variable is obsolete since Org version 7.7.
  553. Please set `org-export-html-divs' instead.")
  554. (defcustom org-export-html-divs '("preamble" "content" "postamble")
  555. "The name of the main divs for HTML export.
  556. This is a list of three strings, the first one for the preamble
  557. DIV, the second one for the content DIV and the third one for the
  558. postamble DIV."
  559. :group 'org-export-html
  560. :type '(list
  561. (string :tag " Div for the preamble:")
  562. (string :tag " Div for the content:")
  563. (string :tag "Div for the postamble:")))
  564. ;;; Hooks
  565. (defvar org-export-html-after-blockquotes-hook nil
  566. "Hook run during HTML export, after blockquote, verse, center are done.")
  567. (defvar org-export-html-final-hook nil
  568. "Hook run at the end of HTML export, in the new buffer.")
  569. ;;; HTML export
  570. (defun org-export-html-preprocess (parameters)
  571. "Convert LaTeX fragments to images."
  572. (when (and org-current-export-file
  573. (plist-get parameters :LaTeX-fragments))
  574. (org-format-latex
  575. (concat "ltxpng/" (file-name-sans-extension
  576. (file-name-nondirectory
  577. org-current-export-file)))
  578. org-current-export-dir nil "Creating LaTeX image %s"
  579. nil nil
  580. (cond
  581. ((eq (plist-get parameters :LaTeX-fragments) 'verbatim) 'verbatim)
  582. ((eq (plist-get parameters :LaTeX-fragments) 'mathjax ) 'mathjax)
  583. ((eq (plist-get parameters :LaTeX-fragments) t ) 'mathjax)
  584. ((eq (plist-get parameters :LaTeX-fragments) 'dvipng ) 'dvipng)
  585. (t nil))))
  586. (goto-char (point-min))
  587. (let (label l1)
  588. (while (re-search-forward "\\\\ref{\\([^{}\n]+\\)}" nil t)
  589. (org-if-unprotected-at (match-beginning 1)
  590. (setq label (match-string 1))
  591. (save-match-data
  592. (if (string-match "\\`[a-z]\\{1,10\\}:\\(.+\\)" label)
  593. (setq l1 (substring label (match-beginning 1)))
  594. (setq l1 label)))
  595. (replace-match (format "[[#%s][%s]]" label l1) t t)))))
  596. ;;;###autoload
  597. (defun org-export-as-html-and-open (arg)
  598. "Export the outline as HTML and immediately open it with a browser.
  599. If there is an active region, export only the region.
  600. The prefix ARG specifies how many levels of the outline should become
  601. headlines. The default is 3. Lower levels will become bulleted lists."
  602. (interactive "P")
  603. (org-export-as-html arg 'hidden)
  604. (org-open-file buffer-file-name)
  605. (when org-export-kill-product-buffer-when-displayed
  606. (kill-buffer (current-buffer))))
  607. ;;;###autoload
  608. (defun org-export-as-html-batch ()
  609. "Call the function `org-export-as-html'.
  610. This function can be used in batch processing as:
  611. emacs --batch
  612. --load=$HOME/lib/emacs/org.el
  613. --eval \"(setq org-export-headline-levels 2)\"
  614. --visit=MyFile --funcall org-export-as-html-batch"
  615. (org-export-as-html org-export-headline-levels 'hidden))
  616. ;;;###autoload
  617. (defun org-export-as-html-to-buffer (arg)
  618. "Call `org-export-as-html` with output to a temporary buffer.
  619. No file is created. The prefix ARG is passed through to `org-export-as-html'."
  620. (interactive "P")
  621. (org-export-as-html arg nil nil "*Org HTML Export*")
  622. (when org-export-show-temporary-export-buffer
  623. (switch-to-buffer-other-window "*Org HTML Export*")))
  624. ;;;###autoload
  625. (defun org-replace-region-by-html (beg end)
  626. "Assume the current region has org-mode syntax, and convert it to HTML.
  627. This can be used in any buffer. For example, you could write an
  628. itemized list in org-mode syntax in an HTML buffer and then use this
  629. command to convert it."
  630. (interactive "r")
  631. (let (reg html buf pop-up-frames)
  632. (save-window-excursion
  633. (if (eq major-mode 'org-mode)
  634. (setq html (org-export-region-as-html
  635. beg end t 'string))
  636. (setq reg (buffer-substring beg end)
  637. buf (get-buffer-create "*Org tmp*"))
  638. (with-current-buffer buf
  639. (erase-buffer)
  640. (insert reg)
  641. (org-mode)
  642. (setq html (org-export-region-as-html
  643. (point-min) (point-max) t 'string)))
  644. (kill-buffer buf)))
  645. (delete-region beg end)
  646. (insert html)))
  647. ;;;###autoload
  648. (defun org-export-region-as-html (beg end &optional body-only buffer)
  649. "Convert region from BEG to END in org-mode buffer to HTML.
  650. If prefix arg BODY-ONLY is set, omit file header, footer, and table of
  651. contents, and only produce the region of converted text, useful for
  652. cut-and-paste operations.
  653. If BUFFER is a buffer or a string, use/create that buffer as a target
  654. of the converted HTML. If BUFFER is the symbol `string', return the
  655. produced HTML as a string and leave not buffer behind. For example,
  656. a Lisp program could call this function in the following way:
  657. (setq html (org-export-region-as-html beg end t 'string))
  658. When called interactively, the output buffer is selected, and shown
  659. in a window. A non-interactive call will only return the buffer."
  660. (interactive "r\nP")
  661. (when (org-called-interactively-p 'any)
  662. (setq buffer "*Org HTML Export*"))
  663. (let ((transient-mark-mode t) (zmacs-regions t)
  664. ext-plist rtn)
  665. (setq ext-plist (plist-put ext-plist :ignore-subtree-p t))
  666. (goto-char end)
  667. (set-mark (point)) ;; to activate the region
  668. (goto-char beg)
  669. (setq rtn (org-export-as-html
  670. nil nil ext-plist
  671. buffer body-only))
  672. (if (fboundp 'deactivate-mark) (deactivate-mark))
  673. (if (and (org-called-interactively-p 'any) (bufferp rtn))
  674. (switch-to-buffer-other-window rtn)
  675. rtn)))
  676. (defvar html-table-tag nil) ; dynamically scoped into this.
  677. (defvar org-par-open nil)
  678. ;;; org-html-cvt-link-fn
  679. (defconst org-html-cvt-link-fn
  680. nil
  681. "Function to convert link URLs to exportable URLs.
  682. Takes two arguments, TYPE and PATH.
  683. Returns exportable url as (TYPE PATH), or nil to signal that it
  684. didn't handle this case.
  685. Intended to be locally bound around a call to `org-export-as-html'." )
  686. (defun org-html-cvt-org-as-html (opt-plist type path)
  687. "Convert an org filename to an equivalent html filename.
  688. If TYPE is not file, just return `nil'.
  689. See variable `org-export-html-link-org-files-as-html'"
  690. (save-match-data
  691. (and
  692. org-export-html-link-org-files-as-html
  693. (string= type "file")
  694. (string-match "\\.org$" path)
  695. (progn
  696. (list
  697. "file"
  698. (concat
  699. (substring path 0 (match-beginning 0))
  700. "."
  701. (plist-get opt-plist :html-extension)))))))
  702. ;;; org-html-should-inline-p
  703. (defun org-html-should-inline-p (filename descp)
  704. "Return non-nil if link FILENAME should be inlined.
  705. The decision to inline the FILENAME link is based on the current
  706. settings. DESCP is the boolean of whether there was a link
  707. description. See variables `org-export-html-inline-images' and
  708. `org-export-html-inline-image-extensions'."
  709. (declare (special
  710. org-export-html-inline-images
  711. org-export-html-inline-image-extensions))
  712. (and (or (eq t org-export-html-inline-images)
  713. (and org-export-html-inline-images (not descp)))
  714. (org-file-image-p
  715. filename org-export-html-inline-image-extensions)))
  716. ;;; org-html-make-link
  717. (defun org-html-make-link (opt-plist type path fragment desc attr
  718. may-inline-p)
  719. "Make an HTML link.
  720. OPT-PLIST is an options list.
  721. TYPE is the device-type of the link (THIS://foo.html).
  722. PATH is the path of the link (http://THIS#location).
  723. FRAGMENT is the fragment part of the link, if any (foo.html#THIS).
  724. DESC is the link description, if any.
  725. ATTR is a string of other attributes of the \"a\" element.
  726. MAY-INLINE-P allows inlining it as an image."
  727. (declare (special org-par-open))
  728. (save-match-data
  729. (let* ((filename path)
  730. ;;First pass. Just sanity stuff.
  731. (components-1
  732. (cond
  733. ((string= type "file")
  734. (list
  735. type
  736. ;;Substitute just if original path was absolute.
  737. ;;(Otherwise path must remain relative)
  738. (if (file-name-absolute-p path)
  739. (concat "file://" (expand-file-name path))
  740. path)))
  741. ((string= type "")
  742. (list nil path))
  743. (t (list type path))))
  744. ;;Second pass. Components converted so they can refer
  745. ;;to a remote site.
  746. (components-2
  747. (or
  748. (and org-html-cvt-link-fn
  749. (apply org-html-cvt-link-fn
  750. opt-plist components-1))
  751. (apply #'org-html-cvt-org-as-html
  752. opt-plist components-1)
  753. components-1))
  754. (type (first components-2))
  755. (thefile (second components-2)))
  756. ;;Third pass. Build final link except for leading type
  757. ;;spec.
  758. (cond
  759. ((or
  760. (not type)
  761. (string= type "http")
  762. (string= type "https")
  763. (string= type "file")
  764. (string= type "coderef"))
  765. (if fragment
  766. (setq thefile (concat thefile "#" fragment))))
  767. (t))
  768. ;;Final URL-build, for all types.
  769. (setq thefile
  770. (let
  771. ((str (org-export-html-format-href thefile)))
  772. (if (and type (not (or (string= "file" type)
  773. (string= "coderef" type))))
  774. (concat type ":" str)
  775. str)))
  776. (if (and
  777. may-inline-p
  778. ;;Can't inline a URL with a fragment.
  779. (not fragment))
  780. (progn
  781. (message "image %s %s" thefile org-par-open)
  782. (org-export-html-format-image thefile org-par-open))
  783. (concat
  784. "<a href=\"" thefile "\"" (if attr (concat " " attr)) ">"
  785. (org-export-html-format-desc desc)
  786. "</a>")))))
  787. (defun org-html-handle-links (line opt-plist)
  788. "Return LINE with markup of Org mode links.
  789. OPT-PLIST is the export options list."
  790. (let ((start 0)
  791. (current-dir (if buffer-file-name
  792. (file-name-directory buffer-file-name)
  793. default-directory))
  794. (link-validate (plist-get opt-plist :link-validation-function))
  795. type id-file fnc
  796. rpl path attr desc descp desc1 desc2 link)
  797. (while (string-match org-bracket-link-analytic-regexp++ line start)
  798. (setq start (match-beginning 0))
  799. (setq path (save-match-data (org-link-unescape
  800. (match-string 3 line))))
  801. (setq type (cond
  802. ((match-end 2) (match-string 2 line))
  803. ((save-match-data
  804. (or (file-name-absolute-p path)
  805. (string-match "^\\.\\.?/" path)))
  806. "file")
  807. (t "internal")))
  808. (setq path (org-extract-attributes path))
  809. (setq attr (get-text-property 0 'org-attributes path))
  810. (setq desc1 (if (match-end 5) (match-string 5 line))
  811. desc2 (if (match-end 2) (concat type ":" path) path)
  812. descp (and desc1 (not (equal desc1 desc2)))
  813. desc (or desc1 desc2))
  814. ;; Make an image out of the description if that is so wanted
  815. (when (and descp (org-file-image-p
  816. desc org-export-html-inline-image-extensions))
  817. (save-match-data
  818. (if (string-match "^file:" desc)
  819. (setq desc (substring desc (match-end 0)))))
  820. (setq desc (org-add-props
  821. (concat "<img src=\"" desc "\" alt=\""
  822. (file-name-nondirectory desc) "\"/>")
  823. '(org-protected t))))
  824. (cond
  825. ((equal type "internal")
  826. (let
  827. ((frag-0
  828. (if (= (string-to-char path) ?#)
  829. (substring path 1)
  830. path)))
  831. (setq rpl
  832. (org-html-make-link
  833. opt-plist
  834. ""
  835. ""
  836. (org-solidify-link-text
  837. (save-match-data (org-link-unescape frag-0))
  838. nil)
  839. desc attr nil))))
  840. ((and (equal type "id")
  841. (setq id-file (org-id-find-id-file path)))
  842. ;; This is an id: link to another file (if it was the same file,
  843. ;; it would have become an internal link...)
  844. (save-match-data
  845. (setq id-file (file-relative-name
  846. id-file
  847. (file-name-directory org-current-export-file)))
  848. (setq rpl
  849. (org-html-make-link opt-plist
  850. "file" id-file
  851. (concat (if (org-uuidgen-p path) "ID-") path)
  852. desc
  853. attr
  854. nil))))
  855. ((member type '("http" "https"))
  856. ;; standard URL, can inline as image
  857. (setq rpl
  858. (org-html-make-link opt-plist
  859. type path nil
  860. desc
  861. attr
  862. (org-html-should-inline-p path descp))))
  863. ((member type '("ftp" "mailto" "news"))
  864. ;; standard URL, can't inline as image
  865. (setq rpl
  866. (org-html-make-link opt-plist
  867. type path nil
  868. desc
  869. attr
  870. nil)))
  871. ((string= type "coderef")
  872. (let*
  873. ((coderef-str (format "coderef-%s" path))
  874. (attr-1
  875. (format "class=\"coderef\" onmouseover=\"CodeHighlightOn(this, '%s');\" onmouseout=\"CodeHighlightOff(this, '%s');\""
  876. coderef-str coderef-str)))
  877. (setq rpl
  878. (org-html-make-link opt-plist
  879. type "" coderef-str
  880. (format
  881. (org-export-get-coderef-format
  882. path
  883. (and descp desc))
  884. (cdr (assoc path org-export-code-refs)))
  885. attr-1
  886. nil))))
  887. ((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
  888. ;; The link protocol has a function for format the link
  889. (setq rpl
  890. (save-match-data
  891. (funcall fnc (org-link-unescape path) desc1 'html))))
  892. ((string= type "file")
  893. ;; FILE link
  894. (save-match-data
  895. (let*
  896. ((components
  897. (if
  898. (string-match "::\\(.*\\)" path)
  899. (list
  900. (replace-match "" t nil path)
  901. (match-string 1 path))
  902. (list path nil)))
  903. ;;The proper path, without a fragment
  904. (path-1
  905. (first components))
  906. ;;The raw fragment
  907. (fragment-0
  908. (second components))
  909. ;;Check the fragment. If it can't be used as
  910. ;;target fragment we'll pass nil instead.
  911. (fragment-1
  912. (if
  913. (and fragment-0
  914. (not (string-match "^[0-9]*$" fragment-0))
  915. (not (string-match "^\\*" fragment-0))
  916. (not (string-match "^/.*/$" fragment-0)))
  917. (org-solidify-link-text
  918. (org-link-unescape fragment-0))
  919. nil))
  920. (desc-2
  921. ;;Description minus "file:" and ".org"
  922. (if (string-match "^file:" desc)
  923. (let
  924. ((desc-1 (replace-match "" t t desc)))
  925. (if (string-match "\\.org$" desc-1)
  926. (replace-match "" t t desc-1)
  927. desc-1))
  928. desc)))
  929. (setq rpl
  930. (if
  931. (and
  932. (functionp link-validate)
  933. (not (funcall link-validate path-1 current-dir)))
  934. desc
  935. (org-html-make-link opt-plist
  936. "file" path-1 fragment-1 desc-2 attr
  937. (org-html-should-inline-p path-1 descp)))))))
  938. (t
  939. ;; just publish the path, as default
  940. (setq rpl (concat "<i>&lt;" type ":"
  941. (save-match-data (org-link-unescape path))
  942. "&gt;</i>"))))
  943. (setq line (replace-match rpl t t line)
  944. start (+ start (length rpl))))
  945. line))
  946. ;;; org-export-as-html
  947. ;;;###autoload
  948. (defun org-export-as-html (arg &optional hidden ext-plist
  949. to-buffer body-only pub-dir)
  950. "Export the outline as a pretty HTML file.
  951. If there is an active region, export only the region. The prefix
  952. ARG specifies how many levels of the outline should become
  953. headlines. The default is 3. Lower levels will become bulleted
  954. lists. HIDDEN is obsolete and does nothing.
  955. EXT-PLIST is a property list with external parameters overriding
  956. org-mode's default settings, but still inferior to file-local
  957. settings. When TO-BUFFER is non-nil, create a buffer with that
  958. name and export to that buffer. If TO-BUFFER is the symbol
  959. `string', don't leave any buffer behind but just return the
  960. resulting HTML as a string. When BODY-ONLY is set, don't produce
  961. the file header and footer, simply return the content of
  962. <body>...</body>, without even the body tags themselves. When
  963. PUB-DIR is set, use this as the publishing directory."
  964. (interactive "P")
  965. (run-hooks 'org-export-first-hook)
  966. ;; Make sure we have a file name when we need it.
  967. (when (and (not (or to-buffer body-only))
  968. (not buffer-file-name))
  969. (if (buffer-base-buffer)
  970. (org-set-local 'buffer-file-name
  971. (with-current-buffer (buffer-base-buffer)
  972. buffer-file-name))
  973. (error "Need a file name to be able to export")))
  974. (message "Exporting...")
  975. (setq-default org-todo-line-regexp org-todo-line-regexp)
  976. (setq-default org-deadline-line-regexp org-deadline-line-regexp)
  977. (setq-default org-done-keywords org-done-keywords)
  978. (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp)
  979. (let* ((opt-plist
  980. (org-export-process-option-filters
  981. (org-combine-plists (org-default-export-plist)
  982. ext-plist
  983. (org-infile-export-plist))))
  984. (body-only (or body-only (plist-get opt-plist :body-only)))
  985. (style (concat (if (plist-get opt-plist :style-include-default)
  986. org-export-html-style-default)
  987. (plist-get opt-plist :style)
  988. (plist-get opt-plist :style-extra)
  989. "\n"
  990. (if (plist-get opt-plist :style-include-scripts)
  991. org-export-html-scripts)))
  992. (html-extension (plist-get opt-plist :html-extension))
  993. valid thetoc have-headings first-heading-pos
  994. (odd org-odd-levels-only)
  995. (region-p (org-region-active-p))
  996. (rbeg (and region-p (region-beginning)))
  997. (rend (and region-p (region-end)))
  998. (subtree-p
  999. (if (plist-get opt-plist :ignore-subtree-p)
  1000. nil
  1001. (when region-p
  1002. (save-excursion
  1003. (goto-char rbeg)
  1004. (and (org-at-heading-p)
  1005. (>= (org-end-of-subtree t t) rend))))))
  1006. (level-offset (if subtree-p
  1007. (save-excursion
  1008. (goto-char rbeg)
  1009. (+ (funcall outline-level)
  1010. (if org-odd-levels-only 1 0)))
  1011. 0))
  1012. (opt-plist (setq org-export-opt-plist
  1013. (if subtree-p
  1014. (org-export-add-subtree-options opt-plist rbeg)
  1015. opt-plist)))
  1016. ;; The following two are dynamically scoped into other
  1017. ;; routines below.
  1018. (org-current-export-dir
  1019. (or pub-dir (org-export-directory :html opt-plist)))
  1020. (org-current-export-file buffer-file-name)
  1021. (level 0) (line "") (origline "") txt todo
  1022. (umax nil)
  1023. (umax-toc nil)
  1024. (filename (if to-buffer nil
  1025. (expand-file-name
  1026. (concat
  1027. (file-name-sans-extension
  1028. (or (and subtree-p
  1029. (org-entry-get (region-beginning)
  1030. "EXPORT_FILE_NAME" t))
  1031. (file-name-nondirectory buffer-file-name)))
  1032. "." html-extension)
  1033. (file-name-as-directory
  1034. (or pub-dir (org-export-directory :html opt-plist))))))
  1035. (current-dir (if buffer-file-name
  1036. (file-name-directory buffer-file-name)
  1037. default-directory))
  1038. (buffer (if to-buffer
  1039. (cond
  1040. ((eq to-buffer 'string) (get-buffer-create "*Org HTML Export*"))
  1041. (t (get-buffer-create to-buffer)))
  1042. (find-file-noselect filename)))
  1043. (org-levels-open (make-vector org-level-max nil))
  1044. (date (plist-get opt-plist :date))
  1045. (author (plist-get opt-plist :author))
  1046. (html-validation-link (or org-export-html-validation-link ""))
  1047. (title (org-html-expand
  1048. (or (and subtree-p (org-export-get-title-from-subtree))
  1049. (plist-get opt-plist :title)
  1050. (and (not body-only)
  1051. (not
  1052. (plist-get opt-plist :skip-before-1st-heading))
  1053. (org-export-grab-title-from-buffer))
  1054. (and buffer-file-name
  1055. (file-name-sans-extension
  1056. (file-name-nondirectory buffer-file-name)))
  1057. "UNTITLED")))
  1058. (link-up (and (plist-get opt-plist :link-up)
  1059. (string-match "\\S-" (plist-get opt-plist :link-up))
  1060. (plist-get opt-plist :link-up)))
  1061. (link-home (and (plist-get opt-plist :link-home)
  1062. (string-match "\\S-" (plist-get opt-plist :link-home))
  1063. (plist-get opt-plist :link-home)))
  1064. (dummy (setq opt-plist (plist-put opt-plist :title title)))
  1065. (html-table-tag (plist-get opt-plist :html-table-tag))
  1066. (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
  1067. (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string "\\>\\)"))
  1068. (inquote nil)
  1069. (infixed nil)
  1070. (inverse nil)
  1071. (email (plist-get opt-plist :email))
  1072. (language (plist-get opt-plist :language))
  1073. (keywords (plist-get opt-plist :keywords))
  1074. (description (plist-get opt-plist :description))
  1075. (num (plist-get opt-plist :section-numbers))
  1076. (lang-words nil)
  1077. (head-count 0) cnt
  1078. (start 0)
  1079. (coding-system (and (boundp 'buffer-file-coding-system)
  1080. buffer-file-coding-system))
  1081. (coding-system-for-write (or org-export-html-coding-system
  1082. coding-system))
  1083. (save-buffer-coding-system (or org-export-html-coding-system
  1084. coding-system))
  1085. (charset (and coding-system-for-write
  1086. (fboundp 'coding-system-get)
  1087. (coding-system-get coding-system-for-write
  1088. 'mime-charset)))
  1089. (region
  1090. (buffer-substring
  1091. (if region-p (region-beginning) (point-min))
  1092. (if region-p (region-end) (point-max))))
  1093. (org-export-have-math nil)
  1094. (org-export-footnotes-seen nil)
  1095. (org-export-footnotes-data (org-footnote-all-labels 'with-defs))
  1096. (lines
  1097. (org-split-string
  1098. (org-export-preprocess-string
  1099. region
  1100. :emph-multiline t
  1101. :for-backend 'html
  1102. :skip-before-1st-heading
  1103. (plist-get opt-plist :skip-before-1st-heading)
  1104. :drawers (plist-get opt-plist :drawers)
  1105. :todo-keywords (plist-get opt-plist :todo-keywords)
  1106. :tasks (plist-get opt-plist :tasks)
  1107. :tags (plist-get opt-plist :tags)
  1108. :priority (plist-get opt-plist :priority)
  1109. :footnotes (plist-get opt-plist :footnotes)
  1110. :timestamps (plist-get opt-plist :timestamps)
  1111. :archived-trees
  1112. (plist-get opt-plist :archived-trees)
  1113. :select-tags (plist-get opt-plist :select-tags)
  1114. :exclude-tags (plist-get opt-plist :exclude-tags)
  1115. :add-text
  1116. (plist-get opt-plist :text)
  1117. :LaTeX-fragments
  1118. (plist-get opt-plist :LaTeX-fragments))
  1119. "[\r\n]"))
  1120. (mathjax
  1121. (if (or (eq (plist-get opt-plist :LaTeX-fragments) 'mathjax)
  1122. (and org-export-have-math
  1123. (eq (plist-get opt-plist :LaTeX-fragments) t)))
  1124. (org-export-html-mathjax-config
  1125. org-export-html-mathjax-template
  1126. org-export-html-mathjax-options
  1127. (or (plist-get opt-plist :mathjax) ""))
  1128. ""))
  1129. table-open
  1130. table-buffer table-orig-buffer
  1131. ind
  1132. rpl path attr desc descp desc1 desc2 link
  1133. snumber fnc
  1134. footnotes footref-seen
  1135. href
  1136. )
  1137. (let ((inhibit-read-only t))
  1138. (org-unmodified
  1139. (remove-text-properties (point-min) (point-max)
  1140. '(:org-license-to-kill t))))
  1141. (message "Exporting...")
  1142. (setq org-min-level (org-get-min-level lines level-offset))
  1143. (setq org-last-level org-min-level)
  1144. (org-init-section-numbers)
  1145. (cond
  1146. ((and date (string-match "%" date))
  1147. (setq date (format-time-string date)))
  1148. (date)
  1149. (t (setq date (format-time-string "%Y-%m-%d %T %Z"))))
  1150. ;; Get the language-dependent settings
  1151. (setq lang-words (or (assoc language org-export-language-setup)
  1152. (assoc "en" org-export-language-setup)))
  1153. ;; Switch to the output buffer
  1154. (set-buffer buffer)
  1155. (let ((inhibit-read-only t)) (erase-buffer))
  1156. (fundamental-mode)
  1157. (org-install-letbind)
  1158. (and (fboundp 'set-buffer-file-coding-system)
  1159. (set-buffer-file-coding-system coding-system-for-write))
  1160. (let ((case-fold-search nil)
  1161. (org-odd-levels-only odd))
  1162. ;; create local variables for all options, to make sure all called
  1163. ;; functions get the correct information
  1164. (mapc (lambda (x)
  1165. (set (make-local-variable (nth 2 x))
  1166. (plist-get opt-plist (car x))))
  1167. org-export-plist-vars)
  1168. (setq umax (if arg (prefix-numeric-value arg)
  1169. org-export-headline-levels))
  1170. (setq umax-toc (if (integerp org-export-with-toc)
  1171. (min org-export-with-toc umax)
  1172. umax))
  1173. (unless body-only
  1174. ;; File header
  1175. (insert (format
  1176. "%s
  1177. <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
  1178. \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
  1179. <html xmlns=\"http://www.w3.org/1999/xhtml\"
  1180. lang=\"%s\" xml:lang=\"%s\">
  1181. <head>
  1182. <title>%s</title>
  1183. <meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
  1184. <meta name=\"generator\" content=\"Org-mode\"/>
  1185. <meta name=\"generated\" content=\"%s\"/>
  1186. <meta name=\"author\" content=\"%s\"/>
  1187. <meta name=\"description\" content=\"%s\"/>
  1188. <meta name=\"keywords\" content=\"%s\"/>
  1189. %s
  1190. %s
  1191. </head>
  1192. <body>
  1193. %s
  1194. "
  1195. (format
  1196. (or (and (stringp org-export-html-xml-declaration)
  1197. org-export-html-xml-declaration)
  1198. (cdr (assoc html-extension org-export-html-xml-declaration))
  1199. (cdr (assoc "html" org-export-html-xml-declaration))
  1200. "")
  1201. (or charset "iso-8859-1"))
  1202. language language
  1203. title
  1204. (or charset "iso-8859-1")
  1205. date author description keywords
  1206. style
  1207. mathjax
  1208. (if (or link-up link-home)
  1209. (concat
  1210. (format org-export-html-home/up-format
  1211. (or link-up link-home)
  1212. (or link-home link-up))
  1213. "\n")
  1214. "")))
  1215. ;; insert html preamble
  1216. (when (plist-get opt-plist :html-preamble)
  1217. (let ((html-pre (plist-get opt-plist :html-preamble)))
  1218. (insert "<div id=\"" (nth 0 org-export-html-divs) "\">\n")
  1219. (cond ((stringp html-pre)
  1220. (insert
  1221. (format-spec html-pre `((?t . ,title) (?a . ,author)
  1222. (?d . ,date) (?e . ,email)))))
  1223. ((functionp html-pre)
  1224. (funcall html-pre))
  1225. (t
  1226. (insert
  1227. (format-spec
  1228. (or (cadr (assoc (nth 0 lang-words)
  1229. org-export-html-preamble-format))
  1230. (cadr (assoc "en" org-export-html-preamble-format)))
  1231. `((?t . ,title) (?a . ,author)
  1232. (?d . ,date) (?e . ,email))))))
  1233. (insert "\n</div>\n")))
  1234. ;; begin wrap around body
  1235. (insert (format "\n<div id=\"%s\">"
  1236. ;; FIXME org-export-html-content-div is obsolete since 7.7
  1237. (or org-export-html-content-div
  1238. (nth 1 org-export-html-divs)))
  1239. ;; FIXME this should go in the preamble but is here so
  1240. ;; that org-infojs can still find it
  1241. "\n<h1 class=\"title\">" title "</h1>\n"))
  1242. ;; insert body
  1243. (if (and org-export-with-toc (not body-only))
  1244. (progn
  1245. (push (format "<h%d>%s</h%d>\n"
  1246. org-export-html-toplevel-hlevel
  1247. (nth 3 lang-words)
  1248. org-export-html-toplevel-hlevel)
  1249. thetoc)
  1250. (push "<div id=\"text-table-of-contents\">\n" thetoc)
  1251. (push "<ul>\n<li>" thetoc)
  1252. (setq lines
  1253. (mapcar
  1254. #'(lambda (line)
  1255. (if (and (string-match org-todo-line-regexp line)
  1256. (not (get-text-property 0 'org-protected line)))
  1257. ;; This is a headline
  1258. (progn
  1259. (setq have-headings t)
  1260. (setq level (- (match-end 1) (match-beginning 1)
  1261. level-offset)
  1262. level (org-tr-level level)
  1263. txt (save-match-data
  1264. (org-html-expand
  1265. (org-export-cleanup-toc-line
  1266. (match-string 3 line))))
  1267. todo
  1268. (or (and org-export-mark-todo-in-toc
  1269. (match-beginning 2)
  1270. (not (member (match-string 2 line)
  1271. org-done-keywords)))
  1272. ; TODO, not DONE
  1273. (and org-export-mark-todo-in-toc
  1274. (= level umax-toc)
  1275. (org-search-todo-below
  1276. line lines level))))
  1277. (if (string-match
  1278. (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt)
  1279. (setq txt (replace-match
  1280. "&nbsp;&nbsp;&nbsp;<span class=\"tag\"> \\1</span>" t nil txt)))
  1281. (if (string-match quote-re0 txt)
  1282. (setq txt (replace-match "" t t txt)))
  1283. (setq snumber (org-section-number level))
  1284. (if (and num (if (integerp num)
  1285. (>= num level)
  1286. num))
  1287. (setq txt (concat snumber " " txt)))
  1288. (if (<= level (max umax umax-toc))
  1289. (setq head-count (+ head-count 1)))
  1290. (if (<= level umax-toc)
  1291. (progn
  1292. (if (> level org-last-level)
  1293. (progn
  1294. (setq cnt (- level org-last-level))
  1295. (while (>= (setq cnt (1- cnt)) 0)
  1296. (push "\n<ul>\n<li>" thetoc))
  1297. (push "\n" thetoc)))
  1298. (if (< level org-last-level)
  1299. (progn
  1300. (setq cnt (- org-last-level level))
  1301. (while (>= (setq cnt (1- cnt)) 0)
  1302. (push "</li>\n</ul>" thetoc))
  1303. (push "\n" thetoc)))
  1304. ;; Check for targets
  1305. (while (string-match org-any-target-regexp line)
  1306. (setq line (replace-match
  1307. (concat "@<span class=\"target\">"
  1308. (match-string 1 line) "@</span> ")
  1309. t t line)))
  1310. (while (string-match "&lt;\\(&lt;\\)+\\|&gt;\\(&gt;\\)+" txt)
  1311. (setq txt (replace-match "" t t txt)))
  1312. (setq href
  1313. (replace-regexp-in-string
  1314. "\\." "-" (format "sec-%s" snumber)))
  1315. (setq href (org-solidify-link-text
  1316. (or (cdr (assoc href
  1317. org-export-preferred-target-alist)) href)))
  1318. (push
  1319. (format
  1320. (if todo
  1321. "</li>\n<li><a href=\"#%s\"><span class=\"todo\">%s</span></a>"
  1322. "</li>\n<li><a href=\"#%s\">%s</a>")
  1323. href txt) thetoc)
  1324. (setq org-last-level level)))))
  1325. line)
  1326. lines))
  1327. (while (> org-last-level (1- org-min-level))
  1328. (setq org-last-level (1- org-last-level))
  1329. (push "</li>\n</ul>\n" thetoc))
  1330. (push "</div>\n" thetoc)
  1331. (setq thetoc (if have-headings (nreverse thetoc) nil))))
  1332. (setq head-count 0)
  1333. (org-init-section-numbers)
  1334. (org-open-par)
  1335. (while (setq line (pop lines) origline line)
  1336. (catch 'nextline
  1337. ;; end of quote section?
  1338. (when (and inquote (string-match org-outline-regexp-bol line))
  1339. (insert "</pre>\n")
  1340. (org-open-par)
  1341. (setq inquote nil))
  1342. ;; inside a quote section?
  1343. (when inquote
  1344. (insert (org-html-protect line) "\n")
  1345. (throw 'nextline nil))
  1346. ;; Fixed-width, verbatim lines (examples)
  1347. (when (and org-export-with-fixed-width
  1348. (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line))
  1349. (when (not infixed)
  1350. (setq infixed t)
  1351. (org-close-par-maybe)
  1352. (insert "<pre class=\"example\">\n"))
  1353. (insert (org-html-protect (match-string 3 line)) "\n")
  1354. (when (or (not lines)
  1355. (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
  1356. (car lines))))
  1357. (setq infixed nil)
  1358. (insert "</pre>\n")
  1359. (org-open-par))
  1360. (throw 'nextline nil))
  1361. ;; Protected HTML
  1362. (when (and (get-text-property 0 'org-protected line)
  1363. ;; Make sure it is the entire line that is protected
  1364. (not (< (or (next-single-property-change
  1365. 0 'org-protected line) 10000)
  1366. (length line))))
  1367. (let (par (ind (get-text-property 0 'original-indentation line)))
  1368. (when (re-search-backward
  1369. "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t)
  1370. (setq par (match-string 1))
  1371. (replace-match "\\2\n"))
  1372. (insert line "\n")
  1373. (while (and lines
  1374. (or (= (length (car lines)) 0)
  1375. (not ind)
  1376. (equal ind (get-text-property 0 'original-indentation (car lines))))
  1377. (or (= (length (car lines)) 0)
  1378. (get-text-property 0 'org-protected (car lines))))
  1379. (insert (pop lines) "\n"))
  1380. (and par (insert "<p>\n")))
  1381. (throw 'nextline nil))
  1382. ;; Blockquotes, verse, and center
  1383. (when (equal "ORG-BLOCKQUOTE-START" line)
  1384. (org-close-par-maybe)
  1385. (insert "<blockquote>\n")
  1386. (org-open-par)
  1387. (throw 'nextline nil))
  1388. (when (equal "ORG-BLOCKQUOTE-END" line)
  1389. (org-close-par-maybe)
  1390. (insert "\n</blockquote>\n")
  1391. (org-open-par)
  1392. (throw 'nextline nil))
  1393. (when (equal "ORG-VERSE-START" line)
  1394. (org-close-par-maybe)
  1395. (insert "\n<p class=\"verse\">\n")
  1396. (setq org-par-open t)
  1397. (setq inverse t)
  1398. (throw 'nextline nil))
  1399. (when (equal "ORG-VERSE-END" line)
  1400. (insert "</p>\n")
  1401. (setq org-par-open nil)
  1402. (org-open-par)
  1403. (setq inverse nil)
  1404. (throw 'nextline nil))
  1405. (when (equal "ORG-CENTER-START" line)
  1406. (org-close-par-maybe)
  1407. (insert "\n<div style=\"text-align: center\">")
  1408. (org-open-par)
  1409. (throw 'nextline nil))
  1410. (when (equal "ORG-CENTER-END" line)
  1411. (org-close-par-maybe)
  1412. (insert "\n</div>")
  1413. (org-open-par)
  1414. (throw 'nextline nil))
  1415. (run-hooks 'org-export-html-after-blockquotes-hook)
  1416. (when inverse
  1417. (let ((i (org-get-string-indentation line)))
  1418. (if (> i 0)
  1419. (setq line (concat (mapconcat 'identity
  1420. (make-list (* 2 i) "\\nbsp") "")
  1421. " " (org-trim line))))
  1422. (unless (string-match "\\\\\\\\[ \t]*$" line)
  1423. (setq line (concat line "\\\\")))))
  1424. ;; make targets to anchors
  1425. (setq start 0)
  1426. (while (string-match
  1427. "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start)
  1428. (cond
  1429. ((get-text-property (match-beginning 1) 'org-protected line)
  1430. (setq start (match-end 1)))
  1431. ((match-end 2)
  1432. (setq line (replace-match
  1433. (format
  1434. "@<a name=\"%s\" id=\"%s\">@</a>"
  1435. (org-solidify-link-text (match-string 1 line))
  1436. (org-solidify-link-text (match-string 1 line)))
  1437. t t line)))
  1438. ((and org-export-with-toc (equal (string-to-char line) ?*))
  1439. ;; FIXME: NOT DEPENDENT on TOC?????????????????????
  1440. (setq line (replace-match
  1441. (concat "@<span class=\"target\">"
  1442. (match-string 1 line) "@</span> ")
  1443. ;; (concat "@<i>" (match-string 1 line) "@</i> ")
  1444. t t line)))
  1445. (t
  1446. (setq line (replace-match
  1447. (concat "@<a name=\""
  1448. (org-solidify-link-text (match-string 1 line))
  1449. "\" class=\"target\">" (match-string 1 line)
  1450. "@</a> ")
  1451. t t line)))))
  1452. (setq line (org-html-handle-time-stamps line))
  1453. ;; replace "&" by "&amp;", "<" and ">" by "&lt;" and "&gt;"
  1454. ;; handle @<..> HTML tags (replace "@&gt;..&lt;" by "<..>")
  1455. ;; Also handle sub_superscripts and checkboxes
  1456. (or (string-match org-table-hline-regexp line)
  1457. (string-match "^[ \t]*\\([+]-\\||[ ]\\)[-+ |]*[+|][ \t]*$" line)
  1458. (setq line (org-html-expand line)))
  1459. ;; Format the links
  1460. (setq line (org-html-handle-links line opt-plist))
  1461. ;; TODO items
  1462. (if (and org-todo-line-regexp
  1463. (string-match org-todo-line-regexp line)
  1464. (match-beginning 2))
  1465. (setq line
  1466. (concat (substring line 0 (match-beginning 2))
  1467. "<span class=\""
  1468. (if (member (match-string 2 line)
  1469. org-done-keywords)
  1470. "done" "todo")
  1471. " " (match-string 2 line)
  1472. "\"> " (org-export-html-get-todo-kwd-class-name
  1473. (match-string 2 line))
  1474. "</span>" (substring line (match-end 2)))))
  1475. ;; Does this contain a reference to a footnote?
  1476. (when org-export-with-footnotes
  1477. (setq start 0)
  1478. (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start)
  1479. ;; Discard protected matches not clearly identified as
  1480. ;; footnote markers.
  1481. (if (or (get-text-property (match-beginning 2) 'org-protected line)
  1482. (not (get-text-property (match-beginning 2) 'org-footnote line)))
  1483. (setq start (match-end 2))
  1484. (let ((n (match-string 2 line)) extra a)
  1485. (if (setq a (assoc n footref-seen))
  1486. (progn
  1487. (setcdr a (1+ (cdr a)))
  1488. (setq extra (format ".%d" (cdr a))))
  1489. (setq extra "")
  1490. (push (cons n 1) footref-seen))
  1491. (setq line
  1492. (replace-match
  1493. (concat
  1494. (format
  1495. (concat "%s"
  1496. (format org-export-html-footnote-format
  1497. (concat "<a class=\"footref\" name=\"fnr.%s%s\" href=\"#fn.%s\">%s</a>")))
  1498. (or (match-string 1 line) "") n extra n n)
  1499. ;; If another footnote is following the
  1500. ;; current one, add a separator.
  1501. (if (save-match-data
  1502. (string-match "\\`\\[[0-9]+\\]"
  1503. (substring line (match-end 0))))
  1504. org-export-html-footnote-separator
  1505. ""))
  1506. t t line))))))
  1507. (cond
  1508. ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
  1509. ;; This is a headline
  1510. (setq level (org-tr-level (- (match-end 1) (match-beginning 1)
  1511. level-offset))
  1512. txt (match-string 2 line))
  1513. (if (string-match quote-re0 txt)
  1514. (setq txt (replace-match "" t t txt)))
  1515. (if (<= level (max umax umax-toc))
  1516. (setq head-count (+ head-count 1)))
  1517. (setq first-heading-pos (or first-heading-pos (point)))
  1518. (org-html-level-start level txt umax
  1519. (and org-export-with-toc (<= level umax))
  1520. head-count opt-plist)
  1521. ;; QUOTES
  1522. (when (string-match quote-re line)
  1523. (org-close-par-maybe)
  1524. (insert "<pre>")
  1525. (setq inquote t)))
  1526. ((and org-export-with-tables
  1527. (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
  1528. (when (not table-open)
  1529. ;; New table starts
  1530. (setq table-open t table-buffer nil table-orig-buffer nil))
  1531. ;; Accumulate lines
  1532. (setq table-buffer (cons line table-buffer)
  1533. table-orig-buffer (cons origline table-orig-buffer))
  1534. (when (or (not lines)
  1535. (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
  1536. (car lines))))
  1537. (setq table-open nil
  1538. table-buffer (nreverse table-buffer)
  1539. table-orig-buffer (nreverse table-orig-buffer))
  1540. (org-close-par-maybe)
  1541. (insert (org-format-table-html table-buffer table-orig-buffer))))
  1542. ;; Normal lines
  1543. (t
  1544. ;; This line either is list item or end a list.
  1545. (when (get-text-property 0 'list-item line)
  1546. (setq line (org-html-export-list-line
  1547. line
  1548. (get-text-property 0 'list-item line)
  1549. (get-text-property 0 'list-struct line)
  1550. (get-text-property 0 'list-prevs line))))
  1551. ;; Horizontal line
  1552. (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line)
  1553. (if org-par-open
  1554. (insert "\n</p>\n<hr/>\n<p>\n")
  1555. (insert "\n<hr/>\n"))
  1556. (throw 'nextline nil))
  1557. ;; Empty lines start a new paragraph. If hand-formatted lists
  1558. ;; are not fully interpreted, lines starting with "-", "+", "*"
  1559. ;; also start a new paragraph.
  1560. (if (string-match "^ [-+*]-\\|^[ \t]*$" line) (org-open-par))
  1561. ;; Is this the start of a footnote?
  1562. (when org-export-with-footnotes
  1563. (when (and (boundp 'footnote-section-tag-regexp)
  1564. (string-match (concat "^" footnote-section-tag-regexp)
  1565. line))
  1566. ;; ignore this line
  1567. (throw 'nextline nil))
  1568. (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line)
  1569. (org-close-par-maybe)
  1570. (let ((n (match-string 1 line)))
  1571. (setq org-par-open t
  1572. line (replace-match
  1573. (format
  1574. (concat "<p class=\"footnote\">"
  1575. (format org-export-html-footnote-format
  1576. "<a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a>"))
  1577. n n n) t t line)))))
  1578. ;; Check if the line break needs to be conserved
  1579. (cond
  1580. ((string-match "\\\\\\\\[ \t]*$" line)
  1581. (setq line (replace-match "<br/>" t t line)))
  1582. (org-export-preserve-breaks
  1583. (setq line (concat line "<br/>"))))
  1584. ;; Check if a paragraph should be started
  1585. (let ((start 0))
  1586. (while (and org-par-open
  1587. (string-match "\\\\par\\>" line start))
  1588. ;; Leave a space in the </p> so that the footnote matcher
  1589. ;; does not see this.
  1590. (if (not (get-text-property (match-beginning 0)
  1591. 'org-protected line))
  1592. (setq line (replace-match "</p ><p >" t t line)))
  1593. (setq start (match-end 0))))
  1594. (insert line "\n")))))
  1595. ;; Properly close all local lists and other lists
  1596. (when inquote
  1597. (insert "</pre>\n")
  1598. (org-open-par))
  1599. (org-html-level-start 1 nil umax
  1600. (and org-export-with-toc (<= level umax))
  1601. head-count opt-plist)
  1602. ;; the </div> to close the last text-... div.
  1603. (when (and (> umax 0) first-heading-pos) (insert "</div>\n"))
  1604. (save-excursion
  1605. (goto-char (point-min))
  1606. (while (re-search-forward
  1607. "\\(\\(<p class=\"footnote\">\\)[^\000]*?\\)\\(\\(\\2\\)\\|\\'\\)"
  1608. nil t)
  1609. (push (match-string 1) footnotes)
  1610. (replace-match "\\4" t nil)
  1611. (goto-char (match-beginning 0))))
  1612. (when footnotes
  1613. (insert (format org-export-html-footnotes-section
  1614. (nth 4 lang-words)
  1615. (mapconcat 'identity (nreverse footnotes) "\n"))
  1616. "\n"))
  1617. (let ((bib (org-export-html-get-bibliography)))
  1618. (when bib
  1619. (insert "\n" bib "\n")))
  1620. (unless body-only
  1621. ;; end wrap around body
  1622. (insert "</div>\n")
  1623. ;; export html postamble
  1624. (let ((html-post (plist-get opt-plist :html-postamble))
  1625. (email
  1626. (mapconcat (lambda(e)
  1627. (format "<a href=\"mailto:%s\">%s</a>" e e))
  1628. (split-string email ",+ *")
  1629. ", "))
  1630. (creator-info
  1631. (concat "Org version " org-version " with Emacs version "
  1632. (number-to-string emacs-major-version))))
  1633. (when (plist-get opt-plist :html-postamble)
  1634. (insert "\n<div id=\"" (nth 2 org-export-html-divs) "\">\n")
  1635. (cond ((stringp html-post)
  1636. (insert (format-spec html-post
  1637. `((?a . ,author) (?e . ,email)
  1638. (?d . ,date) (?c . ,creator-info)
  1639. (?v . ,html-validation-link)))))
  1640. ((functionp html-post)
  1641. (funcall html-post))
  1642. ((eq html-post 'auto)
  1643. ;; fall back on default postamble
  1644. (when (plist-get opt-plist :time-stamp-file)
  1645. (insert "<p class=\"date\">" (nth 2 lang-words) ": " date "</p>\n"))
  1646. (when (and (plist-get opt-plist :author-info) author)
  1647. (insert "<p class=\"author\">" (nth 1 lang-words) ": " author "</p>\n"))
  1648. (when (and (plist-get opt-plist :email-info) email)
  1649. (insert "<p class=\"email\">" email "</p>\n"))
  1650. (when (plist-get opt-plist :creator-info)
  1651. (insert "<p class=\"creator\">"
  1652. (concat "Org version " org-version " with Emacs version "
  1653. (number-to-string emacs-major-version) "</p>\n")))
  1654. (insert html-validation-link "\n"))
  1655. (t
  1656. (insert (format-spec
  1657. (or (cadr (assoc (nth 0 lang-words)
  1658. org-export-html-postamble-format))
  1659. (cadr (assoc "en" org-export-html-postamble-format)))
  1660. `((?a . ,author) (?e . ,email)
  1661. (?d . ,date) (?c . ,creator-info)
  1662. (?v . ,html-validation-link))))))
  1663. (insert "\n</div>"))))
  1664. ;; FIXME `org-export-html-with-timestamp' has been declared
  1665. ;; obsolete since Org 7.7 -- don't forget to remove this.
  1666. (if org-export-html-with-timestamp
  1667. (insert org-export-html-html-helper-timestamp))
  1668. (unless body-only (insert "\n</body>\n</html>\n"))
  1669. (unless (plist-get opt-plist :buffer-will-be-killed)
  1670. (normal-mode)
  1671. (if (eq major-mode (default-value 'major-mode))
  1672. (html-mode)))
  1673. ;; insert the table of contents
  1674. (goto-char (point-min))
  1675. (when thetoc
  1676. (if (or (re-search-forward
  1677. "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t)
  1678. (re-search-forward
  1679. "\\[TABLE-OF-CONTENTS\\]" nil t))
  1680. (progn
  1681. (goto-char (match-beginning 0))
  1682. (replace-match ""))
  1683. (goto-char first-heading-pos)
  1684. (when (looking-at "\\s-*</p>")
  1685. (goto-char (match-end 0))
  1686. (insert "\n")))
  1687. (insert "<div id=\"table-of-contents\">\n")
  1688. (let ((beg (point)))
  1689. (mapc 'insert thetoc)
  1690. (insert "</div>\n")
  1691. (while (re-search-backward "<li>[ \r\n\t]*</li>\n?" beg t)
  1692. (replace-match ""))))
  1693. ;; remove empty paragraphs
  1694. (goto-char (point-min))
  1695. (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t)
  1696. (replace-match ""))
  1697. (goto-char (point-min))
  1698. ;; Convert whitespace place holders
  1699. (goto-char (point-min))
  1700. (let (beg end n)
  1701. (while (setq beg (next-single-property-change (point) 'org-whitespace))
  1702. (setq n (get-text-property beg 'org-whitespace)
  1703. end (next-single-property-change beg 'org-whitespace))
  1704. (goto-char beg)
  1705. (delete-region beg end)
  1706. (insert (format "<span style=\"visibility:hidden;\">%s</span>"
  1707. (make-string n ?x)))))
  1708. ;; Remove empty lines at the beginning of the file.
  1709. (goto-char (point-min))
  1710. (when (looking-at "\\s-+\n") (replace-match ""))
  1711. ;; Remove display properties
  1712. (remove-text-properties (point-min) (point-max) '(display t))
  1713. ;; Run the hook
  1714. (run-hooks 'org-export-html-final-hook)
  1715. (or to-buffer (save-buffer))
  1716. (goto-char (point-min))
  1717. (or (org-export-push-to-kill-ring "HTML")
  1718. (message "Exporting... done"))
  1719. (if (eq to-buffer 'string)
  1720. (prog1 (buffer-substring (point-min) (point-max))
  1721. (kill-buffer (current-buffer)))
  1722. (current-buffer)))))
  1723. (defun org-export-html-format-href (s)
  1724. "Make sure the S is valid as a href reference in an XHTML document."
  1725. (save-match-data
  1726. (let ((start 0))
  1727. (while (string-match "&" s start)
  1728. (setq start (+ (match-beginning 0) 3)
  1729. s (replace-match "&amp;" t t s)))))
  1730. s)
  1731. (defun org-export-html-format-desc (s)
  1732. "Make sure the S is valid as a description in a link."
  1733. (if (and s (not (get-text-property 1 'org-protected s)))
  1734. (save-match-data
  1735. (org-html-do-expand s))
  1736. s))
  1737. (defun org-export-html-format-image (src par-open)
  1738. "Create image tag with source and attributes."
  1739. (save-match-data
  1740. (if (string-match "^ltxpng/" src)
  1741. (format "<img src=\"%s\" alt=\"%s\"/>"
  1742. src (org-find-text-property-in-string 'org-latex-src src))
  1743. (let* ((caption (org-find-text-property-in-string 'org-caption src))
  1744. (attr (org-find-text-property-in-string 'org-attributes src))
  1745. (label (org-find-text-property-in-string 'org-label src)))
  1746. (setq caption (and caption (org-html-do-expand caption)))
  1747. (concat
  1748. (if caption
  1749. (format "%s<div %sclass=\"figure\">
  1750. <p>"
  1751. (if org-par-open "</p>\n" "")
  1752. (if label (format "id=\"%s\" " (org-solidify-link-text label)) "")))
  1753. (format "<img src=\"%s\"%s />"
  1754. src
  1755. (if (string-match "\\<alt=" (or attr ""))
  1756. (concat " " attr )
  1757. (concat " " attr " alt=\"" src "\"")))
  1758. (if caption
  1759. (format "</p>%s
  1760. </div>%s"
  1761. (concat "\n<p>" caption "</p>")
  1762. (if org-par-open "\n<p>" ""))))))))
  1763. (defun org-export-html-get-bibliography ()
  1764. "Find bibliography, cut it out and return it."
  1765. (catch 'exit
  1766. (let (beg end (cnt 1) bib)
  1767. (save-excursion
  1768. (goto-char (point-min))
  1769. (when (re-search-forward "^[ \t]*<div \\(id\\|class\\)=\"bibliography\"" nil t)
  1770. (setq beg (match-beginning 0))
  1771. (while (re-search-forward "</?div\\>" nil t)
  1772. (setq cnt (+ cnt (if (string= (match-string 0) "<div") +1 -1)))
  1773. (when (= cnt 0)
  1774. (and (looking-at ">") (forward-char 1))
  1775. (setq bib (buffer-substring beg (point)))
  1776. (delete-region beg (point))
  1777. (throw 'exit bib))))
  1778. nil))))
  1779. (defvar org-table-number-regexp) ; defined in org-table.el
  1780. (defun org-format-table-html (lines olines &optional no-css)
  1781. "Find out which HTML converter to use and return the HTML code.
  1782. NO-CSS is passed to the exporter."
  1783. (if (stringp lines)
  1784. (setq lines (org-split-string lines "\n")))
  1785. (if (string-match "^[ \t]*|" (car lines))
  1786. ;; A normal org table
  1787. (org-format-org-table-html lines nil no-css)
  1788. ;; Table made by table.el
  1789. (or (org-format-table-table-html-using-table-generate-source
  1790. olines (not org-export-prefer-native-exporter-for-tables))
  1791. ;; We are here only when table.el table has NO col or row
  1792. ;; spanning and the user prefers using org's own converter for
  1793. ;; exporting of such simple table.el tables.
  1794. (org-format-table-table-html lines))))
  1795. (defvar org-table-number-fraction) ; defined in org-table.el
  1796. (defun org-format-org-table-html (lines &optional splice no-css)
  1797. "Format a table into HTML.
  1798. LINES is a list of lines. Optional argument SPLICE means, do not
  1799. insert header and surrounding <table> tags, just format the lines.
  1800. Optional argument NO-CSS means use XHTML attributes instead of CSS
  1801. for formatting. This is required for the DocBook exporter."
  1802. (require 'org-table)
  1803. ;; Get rid of hlines at beginning and end
  1804. (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  1805. (setq lines (nreverse lines))
  1806. (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  1807. (setq lines (nreverse lines))
  1808. (when org-export-table-remove-special-lines
  1809. ;; Check if the table has a marking column. If yes remove the
  1810. ;; column and the special lines
  1811. (setq lines (org-table-clean-before-export lines)))
  1812. (let* ((caption (org-find-text-property-in-string 'org-caption (car lines)))
  1813. (label (org-find-text-property-in-string 'org-label (car lines)))
  1814. (col-cookies (org-find-text-property-in-string 'org-col-cookies
  1815. (car lines)))
  1816. (attributes (org-find-text-property-in-string 'org-attributes
  1817. (car lines)))
  1818. (html-table-tag (org-export-splice-attributes
  1819. html-table-tag attributes))
  1820. (head (and org-export-highlight-first-table-line
  1821. (delq nil (mapcar
  1822. (lambda (x) (string-match "^[ \t]*|-" x))
  1823. (cdr lines)))))
  1824. (nline 0) fnum nfields i (cnt 0)
  1825. tbopen line fields html gr colgropen rowstart rowend
  1826. ali align aligns n)
  1827. (setq caption (and caption (org-html-do-expand caption)))
  1828. (when (and col-cookies org-table-clean-did-remove-column)
  1829. (setq col-cookies
  1830. (mapcar (lambda (x) (cons (1- (car x)) (cdr x))) col-cookies)))
  1831. (if splice (setq head nil))
  1832. (unless splice (push (if head "<thead>" "<tbody>") html))
  1833. (setq tbopen t)
  1834. (while (setq line (pop lines))
  1835. (catch 'next-line
  1836. (if (string-match "^[ \t]*|-" line)
  1837. (progn
  1838. (unless splice
  1839. (push (if head "</thead>" "</tbody>") html)
  1840. (if lines (push "<tbody>" html) (setq tbopen nil)))
  1841. (setq head nil) ;; head ends here, first time around
  1842. ;; ignore this line
  1843. (throw 'next-line t)))
  1844. ;; Break the line into fields
  1845. (setq fields (org-split-string line "[ \t]*|[ \t]*"))
  1846. (unless fnum (setq fnum (make-vector (length fields) 0)
  1847. nfields (length fnum)))
  1848. (setq nline (1+ nline) i -1
  1849. rowstart (eval (car org-export-table-row-tags))
  1850. rowend (eval (cdr org-export-table-row-tags)))
  1851. (push (concat rowstart
  1852. (mapconcat
  1853. (lambda (x)
  1854. (setq i (1+ i) ali (format "@@class%03d@@" i))
  1855. (if (and (< i nfields) ; make sure no rogue line causes an error here
  1856. (string-match org-table-number-regexp x))
  1857. (incf (aref fnum i)))
  1858. (cond
  1859. (head
  1860. (concat
  1861. (format (car org-export-table-header-tags)
  1862. "col" ali)
  1863. x
  1864. (cdr org-export-table-header-tags)))
  1865. ((and (= i 0) org-export-html-table-use-header-tags-for-first-column)
  1866. (concat
  1867. (format (car org-export-table-header-tags)
  1868. "row" ali)
  1869. x
  1870. (cdr org-export-table-header-tags)))
  1871. (t
  1872. (concat (format (car org-export-table-data-tags) ali)
  1873. x
  1874. (cdr org-export-table-data-tags)))))
  1875. fields "")
  1876. rowend)
  1877. html)))
  1878. (unless splice (if tbopen (push "</tbody>" html)))
  1879. (unless splice (push "</table>\n" html))
  1880. (setq html (nreverse html))
  1881. (unless splice
  1882. ;; Put in col tags with the alignment (unfortunately often ignored...)
  1883. (unless (car org-table-colgroup-info)
  1884. (setq org-table-colgroup-info
  1885. (cons :start (cdr org-table-colgroup-info))))
  1886. (setq i 0)
  1887. (push (mapconcat
  1888. (lambda (x)
  1889. (setq gr (pop org-table-colgroup-info)
  1890. i (1+ i)
  1891. align (if (nth 1 (assoc i col-cookies))
  1892. (cdr (assoc (nth 1 (assoc i col-cookies))
  1893. '(("l" . "left") ("r" . "right")
  1894. ("c" . "center"))))
  1895. (if (> (/ (float x) nline)
  1896. org-table-number-fraction)
  1897. "right" "left")))
  1898. (push align aligns)
  1899. (format (if no-css
  1900. "%s<col align=\"%s\" />%s"
  1901. "%s<col class=\"%s\" />%s")
  1902. (if (memq gr '(:start :startend))
  1903. (prog1
  1904. (if colgropen
  1905. "</colgroup>\n<colgroup>"
  1906. "<colgroup>")
  1907. (setq colgropen t))
  1908. "")
  1909. align
  1910. (if (memq gr '(:end :startend))
  1911. (progn (setq colgropen nil) "</colgroup>")
  1912. "")))
  1913. fnum "")
  1914. html)
  1915. (setq aligns (nreverse aligns))
  1916. (if colgropen (setq html (cons (car html)
  1917. (cons "</colgroup>" (cdr html)))))
  1918. ;; Since the output of HTML table formatter can also be used in
  1919. ;; DocBook document, we want to always include the caption to make
  1920. ;; DocBook XML file valid.
  1921. (push (format "<caption>%s</caption>" (or caption "")) html)
  1922. (when label
  1923. (setq html-table-tag (org-export-splice-attributes html-table-tag (format "id=\"%s\"" (org-solidify-link-text label)))))
  1924. (push html-table-tag html))
  1925. (setq html (mapcar
  1926. (lambda (x)
  1927. (replace-regexp-in-string
  1928. "@@class\\([0-9]+\\)@@"
  1929. (lambda (txt)
  1930. (if (not org-export-html-table-align-individual-fields)
  1931. ""
  1932. (setq n (string-to-number (match-string 1 txt)))
  1933. (format (if no-css " align=\"%s\"" " class=\"%s\"")
  1934. (or (nth n aligns) "left"))))
  1935. x))
  1936. html))
  1937. (concat (mapconcat 'identity html "\n") "\n")))
  1938. (defun org-export-splice-attributes (tag attributes)
  1939. "Read attributes in string ATTRIBUTES, add and replace in HTML tag TAG."
  1940. (if (not attributes)
  1941. tag
  1942. (let (oldatt newatt)
  1943. (setq oldatt (org-extract-attributes-from-string tag)
  1944. tag (pop oldatt)
  1945. newatt (cdr (org-extract-attributes-from-string attributes)))
  1946. (while newatt
  1947. (setq oldatt (plist-put oldatt (pop newatt) (pop newatt))))
  1948. (if (string-match ">" tag)
  1949. (setq tag
  1950. (replace-match (concat (org-attributes-to-string oldatt) ">")
  1951. t t tag)))
  1952. tag)))
  1953. (defun org-format-table-table-html (lines)
  1954. "Format a table generated by table.el into HTML.
  1955. This conversion does *not* use `table-generate-source' from table.el.
  1956. This has the advantage that Org-mode's HTML conversions can be used.
  1957. But it has the disadvantage, that no cell- or row-spanning is allowed."
  1958. (let (line field-buffer
  1959. (head org-export-highlight-first-table-line)
  1960. fields html empty i)
  1961. (setq html (concat html-table-tag "\n"))
  1962. (while (setq line (pop lines))
  1963. (setq empty "&nbsp;")
  1964. (catch 'next-line
  1965. (if (string-match "^[ \t]*\\+-" line)
  1966. (progn
  1967. (if field-buffer
  1968. (progn
  1969. (setq
  1970. html
  1971. (concat
  1972. html
  1973. "<tr>"
  1974. (mapconcat
  1975. (lambda (x)
  1976. (if (equal x "") (setq x empty))
  1977. (if head
  1978. (concat
  1979. (format (car org-export-table-header-tags) "col" "")
  1980. x
  1981. (cdr org-export-table-header-tags))
  1982. (concat (format (car org-export-table-data-tags) "") x
  1983. (cdr org-export-table-data-tags))))
  1984. field-buffer "\n")
  1985. "</tr>\n"))
  1986. (setq head nil)
  1987. (setq field-buffer nil)))
  1988. ;; Ignore this line
  1989. (throw 'next-line t)))
  1990. ;; Break the line into fields and store the fields
  1991. (setq fields (org-split-string line "[ \t]*|[ \t]*"))
  1992. (if field-buffer
  1993. (setq field-buffer (mapcar
  1994. (lambda (x)
  1995. (concat x "<br/>" (pop fields)))
  1996. field-buffer))
  1997. (setq field-buffer fields))))
  1998. (setq html (concat html "</table>\n"))
  1999. html))
  2000. (defun org-format-table-table-html-using-table-generate-source (lines
  2001. &optional
  2002. spanned-only)
  2003. "Format a table into html, using `table-generate-source' from table.el.
  2004. Use SPANNED-ONLY to suppress exporting of simple table.el tables.
  2005. When SPANNED-ONLY is nil, all table.el tables are exported. When
  2006. SPANNED-ONLY is non-nil, only tables with either row or column
  2007. spans are exported.
  2008. This routine returns the generated source or nil as appropriate.
  2009. Refer docstring of `org-export-prefer-native-exporter-for-tables'
  2010. for further information."
  2011. (require 'table)
  2012. (with-current-buffer (get-buffer-create " org-tmp1 ")
  2013. (erase-buffer)
  2014. (insert (mapconcat 'identity lines "\n"))
  2015. (goto-char (point-min))
  2016. (if (not (re-search-forward "|[^+]" nil t))
  2017. (error "Error processing table"))
  2018. (table-recognize-table)
  2019. (when (or (not spanned-only)
  2020. (let* ((dim (table-query-dimension))
  2021. (c (nth 4 dim)) (r (nth 5 dim)) (cells (nth 6 dim)))
  2022. (not (= (* c r) cells))))
  2023. (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
  2024. (table-generate-source 'html " org-tmp2 ")
  2025. (set-buffer " org-tmp2 ")
  2026. (buffer-substring (point-min) (point-max)))))
  2027. (defun org-export-splice-style (style extra)
  2028. "Splice EXTRA into STYLE, just before \"</style>\"."
  2029. (if (and (stringp extra)
  2030. (string-match "\\S-" extra)
  2031. (string-match "</style>" style))
  2032. (concat (substring style 0 (match-beginning 0))
  2033. "\n" extra "\n"
  2034. (substring style (match-beginning 0)))
  2035. style))
  2036. (defun org-html-handle-time-stamps (s)
  2037. "Format time stamps in string S, or remove them."
  2038. (catch 'exit
  2039. (let (r b)
  2040. (when org-maybe-keyword-time-regexp
  2041. (while (string-match org-maybe-keyword-time-regexp s)
  2042. (or b (setq b (substring s 0 (match-beginning 0))))
  2043. (setq r (concat
  2044. r (substring s 0 (match-beginning 0))
  2045. " @<span class=\"timestamp-wrapper\">"
  2046. (if (match-end 1)
  2047. (format "@<span class=\"timestamp-kwd\">%s @</span>"
  2048. (match-string 1 s)))
  2049. (format " @<span class=\"timestamp\">%s@</span>"
  2050. (substring
  2051. (org-translate-time (match-string 3 s)) 1 -1))
  2052. "@</span>")
  2053. s (substring s (match-end 0)))))
  2054. ;; Line break if line started and ended with time stamp stuff
  2055. (if (not r)
  2056. s
  2057. (setq r (concat r s))
  2058. (unless (string-match "\\S-" (concat b s))
  2059. (setq r (concat r "@<br/>")))
  2060. r))))
  2061. (defvar htmlize-buffer-places) ; from htmlize.el
  2062. (defun org-export-htmlize-region-for-paste (beg end)
  2063. "Convert the region to HTML, using htmlize.el.
  2064. This is much like `htmlize-region-for-paste', only that it uses
  2065. the settings define in the org-... variables."
  2066. (let* ((htmlize-output-type org-export-htmlize-output-type)
  2067. (htmlize-css-name-prefix org-export-htmlize-css-font-prefix)
  2068. (htmlbuf (htmlize-region beg end)))
  2069. (unwind-protect
  2070. (with-current-buffer htmlbuf
  2071. (buffer-substring (plist-get htmlize-buffer-places 'content-start)
  2072. (plist-get htmlize-buffer-places 'content-end)))
  2073. (kill-buffer htmlbuf))))
  2074. ;;;###autoload
  2075. (defun org-export-htmlize-generate-css ()
  2076. "Create the CSS for all font definitions in the current Emacs session.
  2077. Use this to create face definitions in your CSS style file that can then
  2078. be used by code snippets transformed by htmlize.
  2079. This command just produces a buffer that contains class definitions for all
  2080. faces used in the current Emacs session. You can copy and paste the ones you
  2081. need into your CSS file.
  2082. If you then set `org-export-htmlize-output-type' to `css', calls to
  2083. the function `org-export-htmlize-region-for-paste' will produce code
  2084. that uses these same face definitions."
  2085. (interactive)
  2086. (require 'htmlize)
  2087. (and (get-buffer "*html*") (kill-buffer "*html*"))
  2088. (with-temp-buffer
  2089. (let ((fl (face-list))
  2090. (htmlize-css-name-prefix "org-")
  2091. (htmlize-output-type 'css)
  2092. f i)
  2093. (while (setq f (pop fl)
  2094. i (and f (face-attribute f :inherit)))
  2095. (when (and (symbolp f) (or (not i) (not (listp i))))
  2096. (insert (org-add-props (copy-sequence "1") nil 'face f))))
  2097. (htmlize-region (point-min) (point-max))))
  2098. (org-pop-to-buffer-same-window "*html*")
  2099. (goto-char (point-min))
  2100. (if (re-search-forward "<style" nil t)
  2101. (delete-region (point-min) (match-beginning 0)))
  2102. (if (re-search-forward "</style>" nil t)
  2103. (delete-region (1+ (match-end 0)) (point-max)))
  2104. (beginning-of-line 1)
  2105. (if (looking-at " +") (replace-match ""))
  2106. (goto-char (point-min)))
  2107. (defun org-html-protect (s)
  2108. "Convert characters to HTML equivalent.
  2109. Possible conversions are set in `org-export-html-protect-char-alist'."
  2110. (let ((cl org-export-html-protect-char-alist) c)
  2111. (while (setq c (pop cl))
  2112. (let ((start 0))
  2113. (while (string-match (car c) s start)
  2114. (setq s (replace-match (cdr c) t t s)
  2115. start (1+ (match-beginning 0))))))
  2116. s))
  2117. (defun org-html-expand (string)
  2118. "Prepare STRING for HTML export. Apply all active conversions.
  2119. If there are links in the string, don't modify these."
  2120. (let* ((re (concat org-bracket-link-regexp "\\|"
  2121. (org-re "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")))
  2122. m s l res)
  2123. (while (setq m (string-match re string))
  2124. (setq s (substring string 0 m)
  2125. l (match-string 0 string)
  2126. string (substring string (match-end 0)))
  2127. (push (org-html-do-expand s) res)
  2128. (push l res))
  2129. (push (org-html-do-expand string) res)
  2130. (apply 'concat (nreverse res))))
  2131. (defun org-html-do-expand (s)
  2132. "Apply all active conversions to translate special ASCII to HTML."
  2133. (setq s (org-html-protect s))
  2134. (if org-export-html-expand
  2135. (while (string-match "@&lt;\\([^&]*\\)&gt;" s)
  2136. (setq s (replace-match "<\\1>" t nil s))))
  2137. (if org-export-with-emphasize
  2138. (setq s (org-export-html-convert-emphasize s)))
  2139. (if org-export-with-special-strings
  2140. (setq s (org-export-html-convert-special-strings s)))
  2141. (if org-export-with-sub-superscripts
  2142. (setq s (org-export-html-convert-sub-super s)))
  2143. (if org-export-with-TeX-macros
  2144. (let ((start 0) wd rep)
  2145. (while (setq start (string-match "\\\\\\([a-zA-Z]+[0-9]*\\)\\({}\\)?"
  2146. s start))
  2147. (if (get-text-property (match-beginning 0) 'org-protected s)
  2148. (setq start (match-end 0))
  2149. (setq wd (match-string 1 s))
  2150. (if (setq rep (org-entity-get-representation wd 'html))
  2151. (setq s (replace-match rep t t s))
  2152. (setq start (+ start (length wd))))))))
  2153. s)
  2154. (defun org-export-html-convert-special-strings (string)
  2155. "Convert special characters in STRING to HTML."
  2156. (let ((all org-export-html-special-string-regexps)
  2157. e a re rpl start)
  2158. (while (setq a (pop all))
  2159. (setq re (car a) rpl (cdr a) start 0)
  2160. (while (string-match re string start)
  2161. (if (get-text-property (match-beginning 0) 'org-protected string)
  2162. (setq start (match-end 0))
  2163. (setq string (replace-match rpl t nil string)))))
  2164. string))
  2165. (defun org-export-html-convert-sub-super (string)
  2166. "Convert sub- and superscripts in STRING to HTML."
  2167. (let (key c (s 0) (requireb (eq org-export-with-sub-superscripts '{})))
  2168. (while (string-match org-match-substring-regexp string s)
  2169. (cond
  2170. ((and requireb (match-end 8)) (setq s (match-end 2)))
  2171. ((get-text-property (match-beginning 2) 'org-protected string)
  2172. (setq s (match-end 2)))
  2173. (t
  2174. (setq s (match-end 1)
  2175. key (if (string= (match-string 2 string) "_") "sub" "sup")
  2176. c (or (match-string 8 string)
  2177. (match-string 6 string)
  2178. (match-string 5 string))
  2179. string (replace-match
  2180. (concat (match-string 1 string)
  2181. "<" key ">" c "</" key ">")
  2182. t t string)))))
  2183. (while (string-match "\\\\\\([_^]\\)" string)
  2184. (setq string (replace-match (match-string 1 string) t t string)))
  2185. string))
  2186. (defun org-export-html-convert-emphasize (string)
  2187. "Apply emphasis."
  2188. (let ((s 0) rpl)
  2189. (while (string-match org-emph-re string s)
  2190. (if (not (equal
  2191. (substring string (match-beginning 3) (1+ (match-beginning 3)))
  2192. (substring string (match-beginning 4) (1+ (match-beginning 4)))))
  2193. (setq s (match-beginning 0)
  2194. rpl
  2195. (concat
  2196. (match-string 1 string)
  2197. (nth 2 (assoc (match-string 3 string) org-emphasis-alist))
  2198. (match-string 4 string)
  2199. (nth 3 (assoc (match-string 3 string)
  2200. org-emphasis-alist))
  2201. (match-string 5 string))
  2202. string (replace-match rpl t t string)
  2203. s (+ s (- (length rpl) 2)))
  2204. (setq s (1+ s))))
  2205. string))
  2206. (defun org-open-par ()
  2207. "Insert <p>, but first close previous paragraph if any."
  2208. (org-close-par-maybe)
  2209. (insert "\n<p>")
  2210. (setq org-par-open t))
  2211. (defun org-close-par-maybe ()
  2212. "Close paragraph if there is one open."
  2213. (when org-par-open
  2214. (insert "</p>")
  2215. (setq org-par-open nil)))
  2216. (defun org-close-li (&optional type)
  2217. "Close <li> if necessary."
  2218. (org-close-par-maybe)
  2219. (insert (if (equal type "d") "</dd>\n" "</li>\n")))
  2220. (defvar body-only) ; dynamically scoped into this.
  2221. (defun org-html-level-start (level title umax with-toc head-count &optional opt-plist)
  2222. "Insert a new level in HTML export.
  2223. When TITLE is nil, just close all open levels."
  2224. (org-close-par-maybe)
  2225. (let* ((target (and title (org-get-text-property-any 0 'target title)))
  2226. (extra-targets (and target
  2227. (assoc target org-export-target-aliases)))
  2228. (extra-class (and title (org-get-text-property-any 0 'html-container-class title)))
  2229. (preferred (and target
  2230. (cdr (assoc target org-export-preferred-target-alist))))
  2231. (l org-level-max)
  2232. (num (plist-get opt-plist :section-numbers))
  2233. snumber snu href suffix)
  2234. (setq extra-targets (remove (or preferred target) extra-targets))
  2235. (setq extra-targets
  2236. (mapconcat (lambda (x)
  2237. (setq x (org-solidify-link-text
  2238. (if (org-uuidgen-p x) (concat "ID-" x) x)))
  2239. (format "<a name=\"%s\" id=\"%s\"></a>"
  2240. x x))
  2241. extra-targets
  2242. ""))
  2243. (while (>= l level)
  2244. (if (aref org-levels-open (1- l))
  2245. (progn
  2246. (org-html-level-close l umax)
  2247. (aset org-levels-open (1- l) nil)))
  2248. (setq l (1- l)))
  2249. (when title
  2250. ;; If title is nil, this means this function is called to close
  2251. ;; all levels, so the rest is done only if title is given
  2252. (when (string-match (org-re "\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") title)
  2253. (setq title (replace-match
  2254. (if org-export-with-tags
  2255. (save-match-data
  2256. (concat
  2257. "&nbsp;&nbsp;&nbsp;<span class=\"tag\">"
  2258. (mapconcat
  2259. (lambda (x)
  2260. (format "<span class=\"%s\">%s</span>"
  2261. (org-export-html-get-tag-class-name x)
  2262. x))
  2263. (org-split-string (match-string 1 title) ":")
  2264. "&nbsp;")
  2265. "</span>"))
  2266. "")
  2267. t t title)))
  2268. (if (> level umax)
  2269. (progn
  2270. (if (aref org-levels-open (1- level))
  2271. (progn
  2272. (org-close-li)
  2273. (if target
  2274. (insert (format "<li id=\"%s\">" (org-solidify-link-text (or preferred target)))
  2275. extra-targets title "<br/>\n")
  2276. (insert "<li>" title "<br/>\n")))
  2277. (aset org-levels-open (1- level) t)
  2278. (org-close-par-maybe)
  2279. (if target
  2280. (insert (format "<ul>\n<li id=\"%s\">" (org-solidify-link-text (or preferred target)))
  2281. extra-targets title "<br/>\n")
  2282. (insert "<ul>\n<li>" title "<br/>\n"))))
  2283. (aset org-levels-open (1- level) t)
  2284. (setq snumber (org-section-number level)
  2285. snu (replace-regexp-in-string "\\." "-" snumber))
  2286. (setq level (+ level org-export-html-toplevel-hlevel -1))
  2287. (if (and num (not body-only))
  2288. (setq title (concat
  2289. (format "<span class=\"section-number-%d\">%s</span>"
  2290. level
  2291. (if (and num
  2292. (if (integerp num)
  2293. ;; fix up num to take into
  2294. ;; account the top-level
  2295. ;; heading value
  2296. (>= (+ num org-export-html-toplevel-hlevel -1)
  2297. level)
  2298. num))
  2299. snumber
  2300. ""))
  2301. " " title)))
  2302. (unless (= head-count 1) (insert "\n</div>\n"))
  2303. (setq href (cdr (assoc (concat "sec-" snu) org-export-preferred-target-alist)))
  2304. (setq suffix (org-solidify-link-text (or href snu)))
  2305. (setq href (org-solidify-link-text (or href (concat "sec-" snu))))
  2306. (insert (format "\n<div id=\"outline-container-%s\" class=\"outline-%d%s\">\n<h%d id=\"%s\">%s%s</h%d>\n<div class=\"outline-text-%d\" id=\"text-%s\">\n"
  2307. suffix level (if extra-class (concat " " extra-class) "")
  2308. level href
  2309. extra-targets
  2310. title level level suffix))
  2311. (org-open-par)))))
  2312. (defun org-export-html-get-tag-class-name (tag)
  2313. "Turn tag into a valid class name.
  2314. Replaces invalid characters with \"_\" and then prepends a prefix."
  2315. (save-match-data
  2316. (while (string-match "[^a-zA-Z0-9_]" tag)
  2317. (setq tag (replace-match "_" t t tag))))
  2318. (concat org-export-html-tag-class-prefix tag))
  2319. (defun org-export-html-get-todo-kwd-class-name (kwd)
  2320. "Turn todo keyword into a valid class name.
  2321. Replaces invalid characters with \"_\" and then prepends a prefix."
  2322. (save-match-data
  2323. (while (string-match "[^a-zA-Z0-9_]" kwd)
  2324. (setq kwd (replace-match "_" t t kwd))))
  2325. (concat org-export-html-todo-kwd-class-prefix kwd))
  2326. (defun org-html-level-close (level max-outline-level)
  2327. "Terminate one level in HTML export."
  2328. (if (<= level max-outline-level)
  2329. (insert "</div>\n")
  2330. (org-close-li)
  2331. (insert "</ul>\n")))
  2332. (defun org-html-export-list-line (line pos struct prevs)
  2333. "Insert list syntax in export buffer. Return LINE, maybe modified.
  2334. POS is the item position or line position the line had before
  2335. modifications to buffer. STRUCT is the list structure. PREVS is
  2336. the alist of previous items."
  2337. (let* ((get-type
  2338. (function
  2339. ;; Translate type of list containing POS to "d", "o" or
  2340. ;; "u".
  2341. (lambda (pos struct prevs)
  2342. (let ((type (org-list-get-list-type pos struct prevs)))
  2343. (cond
  2344. ((eq 'ordered type) "o")
  2345. ((eq 'descriptive type) "d")
  2346. (t "u"))))))
  2347. (get-closings
  2348. (function
  2349. ;; Return list of all items and sublists ending at POS, in
  2350. ;; reverse order.
  2351. (lambda (pos)
  2352. (let (out)
  2353. (catch 'exit
  2354. (mapc (lambda (e)
  2355. (let ((end (nth 6 e))
  2356. (item (car e)))
  2357. (cond
  2358. ((= end pos) (push item out))
  2359. ((>= item pos) (throw 'exit nil)))))
  2360. struct))
  2361. out)))))
  2362. ;; First close any previous item, or list, ending at POS.
  2363. (mapc (lambda (e)
  2364. (let* ((lastp (= (org-list-get-last-item e struct prevs) e))
  2365. (first-item (org-list-get-list-begin e struct prevs))
  2366. (type (funcall get-type first-item struct prevs)))
  2367. (org-close-par-maybe)
  2368. ;; Ending for every item
  2369. (org-close-li type)
  2370. ;; We're ending last item of the list: end list.
  2371. (when lastp
  2372. (insert (format "</%sl>\n" type))
  2373. (org-open-par))))
  2374. (funcall get-closings pos))
  2375. (cond
  2376. ;; At an item: insert appropriate tags in export buffer.
  2377. ((assq pos struct)
  2378. (string-match
  2379. (concat "[ \t]*\\(\\S-+[ \t]*\\)"
  2380. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  2381. "\\(?:\\(\\[[ X-]\\]\\)[ \t]+\\)?"
  2382. "\\(?:\\(.*\\)[ \t]+::\\(?:[ \t]+\\|$\\)\\)?"
  2383. "\\(.*\\)") line)
  2384. (let* ((checkbox (match-string 3 line))
  2385. (desc-tag (or (match-string 4 line) "???"))
  2386. (body (or (match-string 5 line) ""))
  2387. (list-beg (org-list-get-list-begin pos struct prevs))
  2388. (firstp (= list-beg pos))
  2389. ;; Always refer to first item to determine list type, in
  2390. ;; case list is ill-formed.
  2391. (type (funcall get-type list-beg struct prevs))
  2392. (counter (let ((count-tmp (org-list-get-counter pos struct)))
  2393. (cond
  2394. ((not count-tmp) nil)
  2395. ((string-match "[A-Za-z]" count-tmp)
  2396. (- (string-to-char (upcase count-tmp)) 64))
  2397. ((string-match "[0-9]+" count-tmp)
  2398. count-tmp)))))
  2399. (when firstp
  2400. (org-close-par-maybe)
  2401. (insert (format "<%sl>\n" type)))
  2402. (insert (cond
  2403. ((equal type "d")
  2404. (format "<dt>%s</dt><dd>" desc-tag))
  2405. ((and (equal type "o") counter)
  2406. (format "<li value=\"%s\">" counter))
  2407. (t "<li>")))
  2408. ;; If line had a checkbox, some additional modification is required.
  2409. (when checkbox
  2410. (setq body
  2411. (concat
  2412. (cond
  2413. ((string-match "X" checkbox) "<code>[X]</code> ")
  2414. ((string-match " " checkbox) "<code>[&nbsp;]</code> ")
  2415. (t "<code>[-]</code> "))
  2416. body)))
  2417. ;; Return modified line
  2418. body))
  2419. ;; At a list ender: go to next line (side-effects only).
  2420. ((equal "ORG-LIST-END-MARKER" line) (throw 'nextline nil))
  2421. ;; Not at an item: return line unchanged (side-effects only).
  2422. (t line))))
  2423. (provide 'org-html)
  2424. ;;; org-html.el ends here