org-html.el 85 KB

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