org-html.el 85 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421
  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. Choices are `css', to export the CSS selectors only, or `inline-css', to
  448. export the CSS attribute values inline in the HTML. We use as default
  449. `inline-css', in order to make the resulting HTML self-containing.
  450. However, this will fail when using Emacs in batch mode for export, because
  451. then no rich font definitions are in place. It will also not be good if
  452. people with different Emacs setup contribute HTML files to a website,
  453. because the fonts will represent the individual setups. In these cases,
  454. it is much better to let Org/Htmlize assign classes only, and to use
  455. a style file to define the look of these classes.
  456. To get a start for your css file, start Emacs session and make sure that
  457. all the faces you are interested in are defined, for example by loading files
  458. in all modes you want. Then, use the command
  459. \\[org-export-htmlize-generate-css] to extract class definitions."
  460. :group 'org-export-htmlize
  461. :type '(choice (const css) (const inline-css)))
  462. (defcustom org-export-htmlize-css-font-prefix "org-"
  463. "The prefix for CSS class names for htmlize font specifications."
  464. :group 'org-export-htmlize
  465. :type 'string)
  466. (defcustom org-export-htmlized-org-css-url nil
  467. "URL pointing to a CSS file defining text colors for htmlized Emacs buffers.
  468. Normally when creating an htmlized version of an Org buffer, htmlize will
  469. create CSS to define the font colors. However, this does not work when
  470. converting in batch mode, and it also can look bad if different people
  471. with different fontification setup work on the same website.
  472. When this variable is non-nil, creating an htmlized version of an Org buffer
  473. using `org-export-as-org' will remove the internal CSS section and replace it
  474. with a link to this URL."
  475. :group 'org-export-htmlize
  476. :type '(choice
  477. (const :tag "Keep internal css" nil)
  478. (string :tag "URL or local href")))
  479. ;;; Variables, constants, and parameter plists
  480. (defvar org-export-html-preamble nil
  481. "Preamble, to be inserted just after <body>. Set by publishing functions.
  482. This may also be a function, building and inserting the preamble.")
  483. (defvar org-export-html-postamble nil
  484. "Postamble, to be inserted just before </body>. Set by publishing functions.
  485. This may also be a function, building and inserting the postamble.")
  486. (defvar org-export-html-auto-preamble t
  487. "Should default preamble be inserted? Set by publishing functions.")
  488. (defvar org-export-html-auto-postamble t
  489. "Should default postamble be inserted? Set by publishing functions.")
  490. ;;; Hooks
  491. (defvar org-export-html-after-blockquotes-hook nil
  492. "Hook run during HTML export, after blockquote, verse, center are done.")
  493. (defvar org-export-html-final-hook nil
  494. "Hook run at the end of HTML export, in the new buffer.")
  495. ;;; HTML export
  496. (defun org-export-html-preprocess (parameters)
  497. "Convert LaTeX fragments to images."
  498. (when (and org-current-export-file
  499. (plist-get parameters :LaTeX-fragments))
  500. (org-format-latex
  501. (concat "ltxpng/" (file-name-sans-extension
  502. (file-name-nondirectory
  503. org-current-export-file)))
  504. org-current-export-dir nil "Creating LaTeX image %s"
  505. nil nil
  506. (cond
  507. ((eq (plist-get parameters :LaTeX-fragments) 'verbatim) 'verbatim)
  508. ((eq (plist-get parameters :LaTeX-fragments) 'mathjax ) 'mathjax)
  509. ((eq (plist-get parameters :LaTeX-fragments) t ) 'mathjax)
  510. ((eq (plist-get parameters :LaTeX-fragments) 'dvipng ) 'dvipng)
  511. (t nil))))
  512. (goto-char (point-min))
  513. (let (label l1)
  514. (while (re-search-forward "\\\\ref{\\([^{}\n]+\\)}" nil t)
  515. (org-if-unprotected-at (match-beginning 1)
  516. (setq label (match-string 1))
  517. (save-match-data
  518. (if (string-match "\\`[a-z]\\{1,10\\}:\\(.+\\)" label)
  519. (setq l1 (substring label (match-beginning 1)))
  520. (setq l1 label)))
  521. (replace-match (format "[[#%s][%s]]" label l1) t t)))))
  522. ;;;###autoload
  523. (defun org-export-as-html-and-open (arg)
  524. "Export the outline as HTML and immediately open it with a browser.
  525. If there is an active region, export only the region.
  526. The prefix ARG specifies how many levels of the outline should become
  527. headlines. The default is 3. Lower levels will become bulleted lists."
  528. (interactive "P")
  529. (org-export-as-html arg 'hidden)
  530. (org-open-file buffer-file-name)
  531. (when org-export-kill-product-buffer-when-displayed
  532. (kill-buffer (current-buffer))))
  533. ;;;###autoload
  534. (defun org-export-as-html-batch ()
  535. "Call the function `org-export-as-html'.
  536. This function can be used in batch processing as:
  537. emacs --batch
  538. --load=$HOME/lib/emacs/org.el
  539. --eval \"(setq org-export-headline-levels 2)\"
  540. --visit=MyFile --funcall org-export-as-html-batch"
  541. (org-export-as-html org-export-headline-levels 'hidden))
  542. ;;;###autoload
  543. (defun org-export-as-html-to-buffer (arg)
  544. "Call `org-export-as-html` with output to a temporary buffer.
  545. No file is created. The prefix ARG is passed through to `org-export-as-html'."
  546. (interactive "P")
  547. (org-export-as-html arg nil nil "*Org HTML Export*")
  548. (when org-export-show-temporary-export-buffer
  549. (switch-to-buffer-other-window "*Org HTML Export*")))
  550. ;;;###autoload
  551. (defun org-replace-region-by-html (beg end)
  552. "Assume the current region has org-mode syntax, and convert it to HTML.
  553. This can be used in any buffer. For example, you could write an
  554. itemized list in org-mode syntax in an HTML buffer and then use this
  555. command to convert it."
  556. (interactive "r")
  557. (let (reg html buf pop-up-frames)
  558. (save-window-excursion
  559. (if (org-mode-p)
  560. (setq html (org-export-region-as-html
  561. beg end t 'string))
  562. (setq reg (buffer-substring beg end)
  563. buf (get-buffer-create "*Org tmp*"))
  564. (with-current-buffer buf
  565. (erase-buffer)
  566. (insert reg)
  567. (org-mode)
  568. (setq html (org-export-region-as-html
  569. (point-min) (point-max) t 'string)))
  570. (kill-buffer buf)))
  571. (delete-region beg end)
  572. (insert html)))
  573. ;;;###autoload
  574. (defun org-export-region-as-html (beg end &optional body-only buffer)
  575. "Convert region from BEG to END in org-mode buffer to HTML.
  576. If prefix arg BODY-ONLY is set, omit file header, footer, and table of
  577. contents, and only produce the region of converted text, useful for
  578. cut-and-paste operations.
  579. If BUFFER is a buffer or a string, use/create that buffer as a target
  580. of the converted HTML. If BUFFER is the symbol `string', return the
  581. produced HTML as a string and leave not buffer behind. For example,
  582. a Lisp program could call this function in the following way:
  583. (setq html (org-export-region-as-html beg end t 'string))
  584. When called interactively, the output buffer is selected, and shown
  585. in a window. A non-interactive call will only return the buffer."
  586. (interactive "r\nP")
  587. (when (interactive-p)
  588. (setq buffer "*Org HTML Export*"))
  589. (let ((transient-mark-mode t) (zmacs-regions t)
  590. ext-plist rtn)
  591. (setq ext-plist (plist-put ext-plist :ignore-subtree-p t))
  592. (goto-char end)
  593. (set-mark (point)) ;; to activate the region
  594. (goto-char beg)
  595. (setq rtn (org-export-as-html
  596. nil nil ext-plist
  597. buffer body-only))
  598. (if (fboundp 'deactivate-mark) (deactivate-mark))
  599. (if (and (interactive-p) (bufferp rtn))
  600. (switch-to-buffer-other-window rtn)
  601. rtn)))
  602. (defvar html-table-tag nil) ; dynamically scoped into this.
  603. (defvar org-par-open nil)
  604. ;;; org-html-cvt-link-fn
  605. (defconst org-html-cvt-link-fn
  606. nil
  607. "Function to convert link URLs to exportable URLs.
  608. Takes two arguments, TYPE and PATH.
  609. Returns exportable url as (TYPE PATH), or nil to signal that it
  610. didn't handle this case.
  611. Intended to be locally bound around a call to `org-export-as-html'." )
  612. (defun org-html-cvt-org-as-html (opt-plist type path)
  613. "Convert an org filename to an equivalent html filename.
  614. If TYPE is not file, just return `nil'.
  615. See variable `org-export-html-link-org-files-as-html'"
  616. (save-match-data
  617. (and
  618. org-export-html-link-org-files-as-html
  619. (string= type "file")
  620. (string-match "\\.org$" path)
  621. (progn
  622. (list
  623. "file"
  624. (concat
  625. (substring path 0 (match-beginning 0))
  626. "."
  627. (plist-get opt-plist :html-extension)))))))
  628. ;;; org-html-should-inline-p
  629. (defun org-html-should-inline-p (filename descp)
  630. "Return non-nil if link FILENAME should be inlined.
  631. The decision to inline the FILENAME link is based on the current
  632. settings. DESCP is the boolean of whether there was a link
  633. description. See variables `org-export-html-inline-images' and
  634. `org-export-html-inline-image-extensions'."
  635. (declare (special
  636. org-export-html-inline-images
  637. org-export-html-inline-image-extensions))
  638. (and (or (eq t org-export-html-inline-images)
  639. (and org-export-html-inline-images (not descp)))
  640. (org-file-image-p
  641. filename org-export-html-inline-image-extensions)))
  642. ;;; org-html-make-link
  643. (defun org-html-make-link (opt-plist type path fragment desc attr
  644. may-inline-p)
  645. "Make an HTML link.
  646. OPT-PLIST is an options list.
  647. TYPE is the device-type of the link (THIS://foo.html)
  648. PATH is the path of the link (http://THIS#locationx)
  649. FRAGMENT is the fragment part of the link, if any (foo.html#THIS)
  650. DESC is the link description, if any.
  651. ATTR is a string of other attributes of the a element.
  652. MAY-INLINE-P allows inlining it as an image."
  653. (declare (special org-par-open))
  654. (save-match-data
  655. (let* ((filename path)
  656. ;;First pass. Just sanity stuff.
  657. (components-1
  658. (cond
  659. ((string= type "file")
  660. (list
  661. type
  662. ;;Substitute just if original path was absolute.
  663. ;;(Otherwise path must remain relative)
  664. (if (file-name-absolute-p path)
  665. (concat "file://" (expand-file-name path))
  666. path)))
  667. ((string= type "")
  668. (list nil path))
  669. (t (list type path))))
  670. ;;Second pass. Components converted so they can refer
  671. ;;to a remote site.
  672. (components-2
  673. (or
  674. (and org-html-cvt-link-fn
  675. (apply org-html-cvt-link-fn
  676. opt-plist components-1))
  677. (apply #'org-html-cvt-org-as-html
  678. opt-plist components-1)
  679. components-1))
  680. (type (first components-2))
  681. (thefile (second components-2)))
  682. ;;Third pass. Build final link except for leading type
  683. ;;spec.
  684. (cond
  685. ((or
  686. (not type)
  687. (string= type "http")
  688. (string= type "https")
  689. (string= type "file"))
  690. (if fragment
  691. (setq thefile (concat thefile "#" fragment))))
  692. (t))
  693. ;;Final URL-build, for all types.
  694. (setq thefile
  695. (let
  696. ((str (org-export-html-format-href thefile)))
  697. (if (and type (not (string= "file" type)))
  698. (concat type ":" str)
  699. str)))
  700. (if (and
  701. may-inline-p
  702. ;;Can't inline a URL with a fragment.
  703. (not fragment))
  704. (progn
  705. (message "image %s %s" thefile org-par-open)
  706. (org-export-html-format-image thefile org-par-open))
  707. (concat
  708. "<a href=\"" thefile "\"" (if attr (concat " " attr)) ">"
  709. (org-export-html-format-desc desc)
  710. "</a>")))))
  711. ;;; org-export-as-html
  712. ;;;###autoload
  713. (defun org-export-as-html (arg &optional hidden ext-plist
  714. to-buffer body-only pub-dir)
  715. "Export the outline as a pretty HTML file.
  716. If there is an active region, export only the region. The prefix
  717. ARG specifies how many levels of the outline should become
  718. headlines. The default is 3. Lower levels will become bulleted
  719. lists. HIDDEN is obsolete and does nothing.
  720. EXT-PLIST is a property list with external parameters overriding
  721. org-mode's default settings, but still inferior to file-local
  722. settings. When TO-BUFFER is non-nil, create a buffer with that
  723. name and export to that buffer. If TO-BUFFER is the symbol
  724. `string', don't leave any buffer behind but just return the
  725. resulting HTML as a string. When BODY-ONLY is set, don't produce
  726. the file header and footer, simply return the content of
  727. <body>...</body>, without even the body tags themselves. When
  728. PUB-DIR is set, use this as the publishing directory."
  729. (interactive "P")
  730. (run-hooks 'org-export-first-hook)
  731. ;; Make sure we have a file name when we need it.
  732. (when (and (not (or to-buffer body-only))
  733. (not buffer-file-name))
  734. (if (buffer-base-buffer)
  735. (org-set-local 'buffer-file-name
  736. (with-current-buffer (buffer-base-buffer)
  737. buffer-file-name))
  738. (error "Need a file name to be able to export")))
  739. (message "Exporting...")
  740. (setq-default org-todo-line-regexp org-todo-line-regexp)
  741. (setq-default org-deadline-line-regexp org-deadline-line-regexp)
  742. (setq-default org-done-keywords org-done-keywords)
  743. (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp)
  744. (let* ((opt-plist
  745. (org-export-process-option-filters
  746. (org-combine-plists (org-default-export-plist)
  747. ext-plist
  748. (org-infile-export-plist))))
  749. (body-only (or body-only (plist-get opt-plist :body-only)))
  750. (style (concat (if (plist-get opt-plist :style-include-default)
  751. org-export-html-style-default)
  752. (plist-get opt-plist :style)
  753. (plist-get opt-plist :style-extra)
  754. "\n"
  755. (if (plist-get opt-plist :style-include-scripts)
  756. org-export-html-scripts)))
  757. (html-extension (plist-get opt-plist :html-extension))
  758. (link-validate (plist-get opt-plist :link-validation-function))
  759. valid thetoc have-headings first-heading-pos
  760. (odd org-odd-levels-only)
  761. (region-p (org-region-active-p))
  762. (rbeg (and region-p (region-beginning)))
  763. (rend (and region-p (region-end)))
  764. (subtree-p
  765. (if (plist-get opt-plist :ignore-subtree-p)
  766. nil
  767. (when region-p
  768. (save-excursion
  769. (goto-char rbeg)
  770. (and (org-at-heading-p)
  771. (>= (org-end-of-subtree t t) rend))))))
  772. (level-offset (if subtree-p
  773. (save-excursion
  774. (goto-char rbeg)
  775. (+ (funcall outline-level)
  776. (if org-odd-levels-only 1 0)))
  777. 0))
  778. (opt-plist (setq org-export-opt-plist
  779. (if subtree-p
  780. (org-export-add-subtree-options opt-plist rbeg)
  781. opt-plist)))
  782. ;; The following two are dynamically scoped into other
  783. ;; routines below.
  784. (org-current-export-dir
  785. (or pub-dir (org-export-directory :html opt-plist)))
  786. (org-current-export-file buffer-file-name)
  787. (level 0) (line "") (origline "") txt todo
  788. (umax nil)
  789. (umax-toc nil)
  790. (filename (if to-buffer nil
  791. (expand-file-name
  792. (concat
  793. (file-name-sans-extension
  794. (or (and subtree-p
  795. (org-entry-get (region-beginning)
  796. "EXPORT_FILE_NAME" t))
  797. (file-name-nondirectory buffer-file-name)))
  798. "." html-extension)
  799. (file-name-as-directory
  800. (or pub-dir (org-export-directory :html opt-plist))))))
  801. (current-dir (if buffer-file-name
  802. (file-name-directory buffer-file-name)
  803. default-directory))
  804. (buffer (if to-buffer
  805. (cond
  806. ((eq to-buffer 'string) (get-buffer-create "*Org HTML Export*"))
  807. (t (get-buffer-create to-buffer)))
  808. (find-file-noselect filename)))
  809. (org-levels-open (make-vector org-level-max nil))
  810. (date (plist-get opt-plist :date))
  811. (author (plist-get opt-plist :author))
  812. (title (or (and subtree-p (org-export-get-title-from-subtree))
  813. (plist-get opt-plist :title)
  814. (and (not body-only)
  815. (not
  816. (plist-get opt-plist :skip-before-1st-heading))
  817. (org-export-grab-title-from-buffer))
  818. (and buffer-file-name
  819. (file-name-sans-extension
  820. (file-name-nondirectory buffer-file-name)))
  821. "UNTITLED"))
  822. (link-up (and (plist-get opt-plist :link-up)
  823. (string-match "\\S-" (plist-get opt-plist :link-up))
  824. (plist-get opt-plist :link-up)))
  825. (link-home (and (plist-get opt-plist :link-home)
  826. (string-match "\\S-" (plist-get opt-plist :link-home))
  827. (plist-get opt-plist :link-home)))
  828. (dummy (setq opt-plist (plist-put opt-plist :title title)))
  829. (html-table-tag (plist-get opt-plist :html-table-tag))
  830. (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
  831. (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string "\\>\\)"))
  832. (inquote nil)
  833. (infixed nil)
  834. (inverse nil)
  835. (in-local-list nil)
  836. (local-list-type nil)
  837. (local-list-indent nil)
  838. (llt org-plain-list-ordered-item-terminator)
  839. (email (plist-get opt-plist :email))
  840. (language (plist-get opt-plist :language))
  841. (keywords (plist-get opt-plist :keywords))
  842. (description (plist-get opt-plist :description))
  843. (lang-words nil)
  844. (head-count 0) cnt
  845. (start 0)
  846. (coding-system (and (boundp 'buffer-file-coding-system)
  847. buffer-file-coding-system))
  848. (coding-system-for-write (or org-export-html-coding-system
  849. coding-system))
  850. (save-buffer-coding-system (or org-export-html-coding-system
  851. coding-system))
  852. (charset (and coding-system-for-write
  853. (fboundp 'coding-system-get)
  854. (coding-system-get coding-system-for-write
  855. 'mime-charset)))
  856. (region
  857. (buffer-substring
  858. (if region-p (region-beginning) (point-min))
  859. (if region-p (region-end) (point-max))))
  860. (org-export-have-math nil)
  861. (lines
  862. (org-split-string
  863. (org-export-preprocess-string
  864. region
  865. :emph-multiline t
  866. :for-html t
  867. :skip-before-1st-heading
  868. (plist-get opt-plist :skip-before-1st-heading)
  869. :drawers (plist-get opt-plist :drawers)
  870. :todo-keywords (plist-get opt-plist :todo-keywords)
  871. :tags (plist-get opt-plist :tags)
  872. :priority (plist-get opt-plist :priority)
  873. :footnotes (plist-get opt-plist :footnotes)
  874. :timestamps (plist-get opt-plist :timestamps)
  875. :archived-trees
  876. (plist-get opt-plist :archived-trees)
  877. :select-tags (plist-get opt-plist :select-tags)
  878. :exclude-tags (plist-get opt-plist :exclude-tags)
  879. :add-text
  880. (plist-get opt-plist :text)
  881. :LaTeX-fragments
  882. (plist-get opt-plist :LaTeX-fragments))
  883. "[\r\n]"))
  884. (mathjax
  885. (if (or (eq (plist-get opt-plist :LaTeX-fragments) 'mathjax)
  886. (and org-export-have-math
  887. (eq (plist-get opt-plist :LaTeX-fragments) t)))
  888. (org-export-html-mathjax-config
  889. org-export-html-mathjax-template
  890. org-export-html-mathjax-options
  891. (or (plist-get opt-plist :mathjax) ""))
  892. ""))
  893. table-open type
  894. table-buffer table-orig-buffer
  895. ind item-type starter
  896. rpl path attr desc descp desc1 desc2 link
  897. snumber fnc item-tag item-number
  898. footnotes footref-seen
  899. id-file href
  900. )
  901. (let ((inhibit-read-only t))
  902. (org-unmodified
  903. (remove-text-properties (point-min) (point-max)
  904. '(:org-license-to-kill t))))
  905. (message "Exporting...")
  906. (setq org-min-level (org-get-min-level lines level-offset))
  907. (setq org-last-level org-min-level)
  908. (org-init-section-numbers)
  909. (cond
  910. ((and date (string-match "%" date))
  911. (setq date (format-time-string date)))
  912. (date)
  913. (t (setq date (format-time-string "%Y-%m-%d %T %Z"))))
  914. ;; Get the language-dependent settings
  915. (setq lang-words (or (assoc language org-export-language-setup)
  916. (assoc "en" org-export-language-setup)))
  917. ;; Switch to the output buffer
  918. (set-buffer buffer)
  919. (let ((inhibit-read-only t)) (erase-buffer))
  920. (fundamental-mode)
  921. (org-install-letbind)
  922. (and (fboundp 'set-buffer-file-coding-system)
  923. (set-buffer-file-coding-system coding-system-for-write))
  924. (let ((case-fold-search nil)
  925. (org-odd-levels-only odd))
  926. ;; create local variables for all options, to make sure all called
  927. ;; functions get the correct information
  928. (mapc (lambda (x)
  929. (set (make-local-variable (nth 2 x))
  930. (plist-get opt-plist (car x))))
  931. org-export-plist-vars)
  932. (setq umax (if arg (prefix-numeric-value arg)
  933. org-export-headline-levels))
  934. (setq umax-toc (if (integerp org-export-with-toc)
  935. (min org-export-with-toc umax)
  936. umax))
  937. (unless body-only
  938. ;; File header
  939. (insert (format
  940. "%s
  941. <!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
  942. \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
  943. <html xmlns=\"http://www.w3.org/1999/xhtml\"
  944. lang=\"%s\" xml:lang=\"%s\">
  945. <head>
  946. <title>%s</title>
  947. <meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
  948. <meta name=\"generator\" content=\"Org-mode\"/>
  949. <meta name=\"generated\" content=\"%s\"/>
  950. <meta name=\"author\" content=\"%s\"/>
  951. <meta name=\"description\" content=\"%s\"/>
  952. <meta name=\"keywords\" content=\"%s\"/>
  953. %s
  954. %s
  955. </head>
  956. <body>
  957. <div id=\"content\">
  958. %s
  959. "
  960. (format
  961. (or (and (stringp org-export-html-xml-declaration)
  962. org-export-html-xml-declaration)
  963. (cdr (assoc html-extension org-export-html-xml-declaration))
  964. (cdr (assoc "html" org-export-html-xml-declaration))
  965. "")
  966. (or charset "iso-8859-1"))
  967. language language
  968. title
  969. (or charset "iso-8859-1")
  970. date author description keywords
  971. style
  972. mathjax
  973. (if (or link-up link-home)
  974. (concat
  975. (format org-export-html-home/up-format
  976. (or link-up link-home)
  977. (or link-home link-up))
  978. "\n")
  979. "")))
  980. (org-export-html-insert-plist-item opt-plist :preamble opt-plist)
  981. (when (plist-get opt-plist :auto-preamble)
  982. (if title (insert (format org-export-html-title-format
  983. (org-html-expand title))))))
  984. (if (and org-export-with-toc (not body-only))
  985. (progn
  986. (push (format "<h%d>%s</h%d>\n"
  987. org-export-html-toplevel-hlevel
  988. (nth 3 lang-words)
  989. org-export-html-toplevel-hlevel)
  990. thetoc)
  991. (push "<div id=\"text-table-of-contents\">\n" thetoc)
  992. (push "<ul>\n<li>" thetoc)
  993. (setq lines
  994. (mapcar '(lambda (line)
  995. (if (and (string-match org-todo-line-regexp line)
  996. (not (get-text-property 0 'org-protected line)))
  997. ;; This is a headline
  998. (progn
  999. (setq have-headings t)
  1000. (setq level (- (match-end 1) (match-beginning 1)
  1001. level-offset)
  1002. level (org-tr-level level)
  1003. txt (save-match-data
  1004. (org-html-expand
  1005. (org-export-cleanup-toc-line
  1006. (match-string 3 line))))
  1007. todo
  1008. (or (and org-export-mark-todo-in-toc
  1009. (match-beginning 2)
  1010. (not (member (match-string 2 line)
  1011. org-done-keywords)))
  1012. ; TODO, not DONE
  1013. (and org-export-mark-todo-in-toc
  1014. (= level umax-toc)
  1015. (org-search-todo-below
  1016. line lines level))))
  1017. (if (string-match
  1018. (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt)
  1019. (setq txt (replace-match "&nbsp;&nbsp;&nbsp;<span class=\"tag\"> \\1</span>" t nil txt)))
  1020. (if (string-match quote-re0 txt)
  1021. (setq txt (replace-match "" t t txt)))
  1022. (setq snumber (org-section-number level))
  1023. (if org-export-with-section-numbers
  1024. (setq txt (concat snumber " " txt)))
  1025. (if (<= level (max umax umax-toc))
  1026. (setq head-count (+ head-count 1)))
  1027. (if (<= level umax-toc)
  1028. (progn
  1029. (if (> level org-last-level)
  1030. (progn
  1031. (setq cnt (- level org-last-level))
  1032. (while (>= (setq cnt (1- cnt)) 0)
  1033. (push "\n<ul>\n<li>" thetoc))
  1034. (push "\n" thetoc)))
  1035. (if (< level org-last-level)
  1036. (progn
  1037. (setq cnt (- org-last-level level))
  1038. (while (>= (setq cnt (1- cnt)) 0)
  1039. (push "</li>\n</ul>" thetoc))
  1040. (push "\n" thetoc)))
  1041. ;; Check for targets
  1042. (while (string-match org-any-target-regexp line)
  1043. (setq line (replace-match
  1044. (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
  1045. t t line)))
  1046. (while (string-match "&lt;\\(&lt;\\)+\\|&gt;\\(&gt;\\)+" txt)
  1047. (setq txt (replace-match "" t t txt)))
  1048. (setq href
  1049. (replace-regexp-in-string
  1050. "\\." "_" (format "sec-%s" snumber)))
  1051. (setq href (or (cdr (assoc href org-export-preferred-target-alist)) href))
  1052. (push
  1053. (format
  1054. (if todo
  1055. "</li>\n<li><a href=\"#%s\"><span class=\"todo\">%s</span></a>"
  1056. "</li>\n<li><a href=\"#%s\">%s</a>")
  1057. href txt) thetoc)
  1058. (setq org-last-level level))
  1059. )))
  1060. line)
  1061. lines))
  1062. (while (> org-last-level (1- org-min-level))
  1063. (setq org-last-level (1- org-last-level))
  1064. (push "</li>\n</ul>\n" thetoc))
  1065. (push "</div>\n" thetoc)
  1066. (setq thetoc (if have-headings (nreverse thetoc) nil))))
  1067. (setq head-count 0)
  1068. (org-init-section-numbers)
  1069. (org-open-par)
  1070. (while (setq line (pop lines) origline line)
  1071. (catch 'nextline
  1072. ;; end of quote section?
  1073. (when (and inquote (string-match "^\\*+ " line))
  1074. (insert "</pre>\n")
  1075. (org-open-par)
  1076. (setq inquote nil))
  1077. ;; inside a quote section?
  1078. (when inquote
  1079. (insert (org-html-protect line) "\n")
  1080. (throw 'nextline nil))
  1081. ;; Fixed-width, verbatim lines (examples)
  1082. (when (and org-export-with-fixed-width
  1083. (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)" line))
  1084. (when (not infixed)
  1085. (setq infixed t)
  1086. (org-close-par-maybe)
  1087. (insert "<pre class=\"example\">\n"))
  1088. (insert (org-html-protect (match-string 3 line)) "\n")
  1089. (when (or (not lines)
  1090. (not (string-match "^[ \t]*:\\(\\([ \t]\\|$\\)\\(.*\\)\\)"
  1091. (car lines))))
  1092. (setq infixed nil)
  1093. (insert "</pre>\n")
  1094. (org-open-par))
  1095. (throw 'nextline nil))
  1096. ;; Explicit list closure
  1097. (when (equal "ORG-LIST-END" line)
  1098. (while local-list-indent
  1099. (org-close-li (car local-list-type))
  1100. (insert (format "</%sl>\n" (car local-list-type)))
  1101. (pop local-list-type)
  1102. (pop local-list-indent))
  1103. (setq in-local-list nil)
  1104. (org-open-par)
  1105. (throw 'nextline nil))
  1106. ;; Protected HTML
  1107. (when (and (get-text-property 0 'org-protected line)
  1108. ;; Make sure it is the entire line that is protected
  1109. (not (< (or (next-single-property-change
  1110. 0 'org-protected line) 10000)
  1111. (length line))))
  1112. (let (par (ind (get-text-property 0 'original-indentation line)))
  1113. (when (re-search-backward
  1114. "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t)
  1115. (setq par (match-string 1))
  1116. (replace-match "\\2\n"))
  1117. (insert line "\n")
  1118. (while (and lines
  1119. (or (= (length (car lines)) 0)
  1120. (not ind)
  1121. (equal ind (get-text-property 0 'original-indentation (car lines))))
  1122. (or (= (length (car lines)) 0)
  1123. (get-text-property 0 'org-protected (car lines))))
  1124. (insert (pop lines) "\n"))
  1125. (and par (insert "<p>\n")))
  1126. (throw 'nextline nil))
  1127. ;; Blockquotes, verse, and center
  1128. (when (equal "ORG-BLOCKQUOTE-START" line)
  1129. (org-close-par-maybe)
  1130. (insert "<blockquote>\n")
  1131. (org-open-par)
  1132. (throw 'nextline nil))
  1133. (when (equal "ORG-BLOCKQUOTE-END" line)
  1134. (org-close-par-maybe)
  1135. (insert "\n</blockquote>\n")
  1136. (org-open-par)
  1137. (throw 'nextline nil))
  1138. (when (equal "ORG-VERSE-START" line)
  1139. (org-close-par-maybe)
  1140. (insert "\n<p class=\"verse\">\n")
  1141. (setq org-par-open t)
  1142. (setq inverse t)
  1143. (throw 'nextline nil))
  1144. (when (equal "ORG-VERSE-END" line)
  1145. (insert "</p>\n")
  1146. (setq org-par-open nil)
  1147. (org-open-par)
  1148. (setq inverse nil)
  1149. (throw 'nextline nil))
  1150. (when (equal "ORG-CENTER-START" line)
  1151. (org-close-par-maybe)
  1152. (insert "\n<div style=\"text-align: center\">")
  1153. (org-open-par)
  1154. (throw 'nextline nil))
  1155. (when (equal "ORG-CENTER-END" line)
  1156. (org-close-par-maybe)
  1157. (insert "\n</div>")
  1158. (org-open-par)
  1159. (throw 'nextline nil))
  1160. (run-hooks 'org-export-html-after-blockquotes-hook)
  1161. (when inverse
  1162. (let ((i (org-get-string-indentation line)))
  1163. (if (> i 0)
  1164. (setq line (concat (mapconcat 'identity
  1165. (make-list (* 2 i) "\\nbsp") "")
  1166. " " (org-trim line))))
  1167. (unless (string-match "\\\\\\\\[ \t]*$" line)
  1168. (setq line (concat line "\\\\")))))
  1169. ;; make targets to anchors
  1170. (setq start 0)
  1171. (while (string-match
  1172. "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line start)
  1173. (cond
  1174. ((get-text-property (match-beginning 1) 'org-protected line)
  1175. (setq start (match-end 1)))
  1176. ((match-end 2)
  1177. (setq line (replace-match
  1178. (format
  1179. "@<a name=\"%s\" id=\"%s\">@</a>"
  1180. (org-solidify-link-text (match-string 1 line))
  1181. (org-solidify-link-text (match-string 1 line)))
  1182. t t line)))
  1183. ((and org-export-with-toc (equal (string-to-char line) ?*))
  1184. ;; FIXME: NOT DEPENDENT on TOC?????????????????????
  1185. (setq line (replace-match
  1186. (concat "@<span class=\"target\">"
  1187. (match-string 1 line) "@</span> ")
  1188. ;; (concat "@<i>" (match-string 1 line) "@</i> ")
  1189. t t line)))
  1190. (t
  1191. (setq line (replace-match
  1192. (concat "@<a name=\""
  1193. (org-solidify-link-text (match-string 1 line))
  1194. "\" class=\"target\">" (match-string 1 line)
  1195. "@</a> ")
  1196. t t 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. (setq line (org-html-handle-time-stamps line))
  1352. ;; TODO items
  1353. (if (and (string-match org-todo-line-regexp line)
  1354. (match-beginning 2))
  1355. (setq line
  1356. (concat (substring line 0 (match-beginning 2))
  1357. "<span class=\""
  1358. (if (member (match-string 2 line)
  1359. org-done-keywords)
  1360. "done" "todo")
  1361. " " (match-string 2 line)
  1362. "\"> " (org-export-html-get-todo-kwd-class-name
  1363. (match-string 2 line))
  1364. "</span>" (substring line (match-end 2)))))
  1365. ;; Does this contain a reference to a footnote?
  1366. (when org-export-with-footnotes
  1367. (setq start 0)
  1368. (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start)
  1369. (if (get-text-property (match-beginning 2) 'org-protected line)
  1370. (setq start (match-end 2))
  1371. (let ((n (match-string 2 line)) extra a)
  1372. (if (setq a (assoc n footref-seen))
  1373. (progn
  1374. (setcdr a (1+ (cdr a)))
  1375. (setq extra (format ".%d" (cdr a))))
  1376. (setq extra "")
  1377. (push (cons n 1) footref-seen))
  1378. (setq line
  1379. (replace-match
  1380. (format
  1381. (concat "%s"
  1382. (format org-export-html-footnote-format
  1383. "<a class=\"footref\" name=\"fnr.%s%s\" href=\"#fn.%s\">%s</a>"))
  1384. (or (match-string 1 line) "") n extra n n)
  1385. t t line))))))
  1386. (cond
  1387. ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
  1388. ;; This is a headline
  1389. (setq level (org-tr-level (- (match-end 1) (match-beginning 1)
  1390. level-offset))
  1391. txt (match-string 2 line))
  1392. (if (string-match quote-re0 txt)
  1393. (setq txt (replace-match "" t t txt)))
  1394. (if (<= level (max umax umax-toc))
  1395. (setq head-count (+ head-count 1)))
  1396. (setq first-heading-pos (or first-heading-pos (point)))
  1397. (org-html-level-start level txt umax
  1398. (and org-export-with-toc (<= level umax))
  1399. head-count)
  1400. ;; QUOTES
  1401. (when (string-match quote-re line)
  1402. (org-close-par-maybe)
  1403. (insert "<pre>")
  1404. (setq inquote t)))
  1405. ((and org-export-with-tables
  1406. (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
  1407. (when (not table-open)
  1408. ;; New table starts
  1409. (setq table-open t table-buffer nil table-orig-buffer nil))
  1410. ;; Accumulate lines
  1411. (setq table-buffer (cons line table-buffer)
  1412. table-orig-buffer (cons origline table-orig-buffer))
  1413. (when (or (not lines)
  1414. (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
  1415. (car lines))))
  1416. (setq table-open nil
  1417. table-buffer (nreverse table-buffer)
  1418. table-orig-buffer (nreverse table-orig-buffer))
  1419. (org-close-par-maybe)
  1420. (insert (org-format-table-html table-buffer table-orig-buffer))))
  1421. (t
  1422. ;; Normal lines
  1423. (when (string-match
  1424. (cond
  1425. ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
  1426. ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
  1427. ((= llt ?\)) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+)\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
  1428. (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))
  1429. line)
  1430. (setq ind (or (get-text-property 0 'original-indentation line)
  1431. (org-get-string-indentation line))
  1432. item-type (if (match-beginning 4) "o" "u")
  1433. starter (if (match-beginning 2)
  1434. (substring (match-string 2 line) 0 -1))
  1435. line (substring line (match-beginning 5))
  1436. item-number nil
  1437. item-tag nil)
  1438. (if (string-match "\\[@\\(?:start:\\)?\\([0-9]+\\)\\][ \t]?" line)
  1439. (setq item-number (match-string 1 line)
  1440. line (replace-match "" t t line)))
  1441. (if (and starter (string-match "\\(.*?\\) ::[ \t]*" line))
  1442. (setq item-type "d"
  1443. item-tag (match-string 1 line)
  1444. line (substring line (match-end 0))))
  1445. (cond
  1446. ((and starter
  1447. (or (not in-local-list)
  1448. (> ind (car local-list-indent))))
  1449. ;; Start new (level of) list
  1450. (org-close-par-maybe)
  1451. (insert (cond
  1452. ((equal item-type "u") "<ul>\n<li>\n")
  1453. ((and (equal item-type "o") item-number)
  1454. (format "<ol>\n<li value=\"%s\">\n" item-number))
  1455. ((equal item-type "o") "<ol>\n<li>\n")
  1456. ((equal item-type "d")
  1457. (format "<dl>\n<dt>%s</dt><dd>\n" item-tag))))
  1458. (push item-type local-list-type)
  1459. (push ind local-list-indent)
  1460. (setq in-local-list t))
  1461. ;; Continue list
  1462. (starter
  1463. ;; terminate any previous sublist but first ensure
  1464. ;; list is not ill-formed.
  1465. (let ((min-ind (apply 'min local-list-indent)))
  1466. (when (< ind min-ind) (setq ind min-ind)))
  1467. (while (< ind (car local-list-indent))
  1468. (org-close-li (car local-list-type))
  1469. (insert (format "</%sl>\n" (car local-list-type)))
  1470. (pop local-list-type) (pop local-list-indent)
  1471. (setq in-local-list local-list-indent))
  1472. ;; insert new item
  1473. (org-close-li (car local-list-type))
  1474. (insert (cond
  1475. ((equal (car local-list-type) "d")
  1476. (format "<dt>%s</dt><dd>\n" (or item-tag "???")))
  1477. ((and (equal item-type "o") item-number)
  1478. (format "<li value=\"%s\">\n" item-number))
  1479. (t "<li>\n")))))
  1480. (if (string-match "^[ \t]*\\[\\([X ]\\)\\]" line)
  1481. (setq line
  1482. (replace-match
  1483. (if (equal (match-string 1 line) "X")
  1484. "<b>[X]</b>"
  1485. "<b>[<span style=\"visibility:hidden;\">X</span>]</b>")
  1486. t t line))))
  1487. ;; Horizontal line
  1488. (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line)
  1489. (if org-par-open
  1490. (insert "\n</p>\n<hr/>\n<p>\n")
  1491. (insert "\n<hr/>\n"))
  1492. (throw 'nextline nil))
  1493. ;; Empty lines start a new paragraph. If hand-formatted lists
  1494. ;; are not fully interpreted, lines starting with "-", "+", "*"
  1495. ;; also start a new paragraph.
  1496. (if (string-match "^ [-+*]-\\|^[ \t]*$" line) (org-open-par))
  1497. ;; Is this the start of a footnote?
  1498. (when org-export-with-footnotes
  1499. (when (and (boundp 'footnote-section-tag-regexp)
  1500. (string-match (concat "^" footnote-section-tag-regexp)
  1501. line))
  1502. ;; ignore this line
  1503. (throw 'nextline nil))
  1504. (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line)
  1505. (org-close-par-maybe)
  1506. (let ((n (match-string 1 line)))
  1507. (setq org-par-open t
  1508. line (replace-match
  1509. (format
  1510. (concat "<p class=\"footnote\">"
  1511. (format org-export-html-footnote-format
  1512. "<a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a>"))
  1513. n n n) t t line)))))
  1514. ;; Check if the line break needs to be conserved
  1515. (cond
  1516. ((string-match "\\\\\\\\[ \t]*$" line)
  1517. (setq line (replace-match "<br/>" t t line)))
  1518. (org-export-preserve-breaks
  1519. (setq line (concat line "<br/>"))))
  1520. ;; Check if a paragraph should be started
  1521. (let ((start 0))
  1522. (while (and org-par-open
  1523. (string-match "\\\\par\\>" line start))
  1524. ;; Leave a space in the </p> so that the footnote matcher
  1525. ;; does not see this.
  1526. (if (not (get-text-property (match-beginning 0)
  1527. 'org-protected line))
  1528. (setq line (replace-match "</p ><p >" t t line)))
  1529. (setq start (match-end 0))))
  1530. (insert line "\n")))))
  1531. ;; Properly close all local lists and other lists
  1532. (when inquote
  1533. (insert "</pre>\n")
  1534. (org-open-par))
  1535. (org-html-level-start 1 nil umax
  1536. (and org-export-with-toc (<= level umax))
  1537. head-count)
  1538. ;; the </div> to close the last text-... div.
  1539. (when (and (> umax 0) first-heading-pos) (insert "</div>\n"))
  1540. (save-excursion
  1541. (goto-char (point-min))
  1542. (while (re-search-forward "<p class=\"footnote\">[^\000]*?\\(</p>\\|\\'\\)" nil t)
  1543. (push (match-string 0) footnotes)
  1544. (replace-match "" t t)))
  1545. (when footnotes
  1546. (insert (format org-export-html-footnotes-section
  1547. (nth 4 lang-words)
  1548. (mapconcat 'identity (nreverse footnotes) "\n"))
  1549. "\n"))
  1550. (let ((bib (org-export-html-get-bibliography)))
  1551. (when bib
  1552. (insert "\n" bib "\n")))
  1553. (unless body-only
  1554. (when (plist-get opt-plist :auto-postamble)
  1555. (insert "<div id=\"postamble\">\n")
  1556. (when (and org-export-author-info author)
  1557. (insert "<p class=\"author\"> "
  1558. (nth 1 lang-words) ": " author "\n")
  1559. (when (and org-export-email-info email (string-match "\\S-" email))
  1560. (if (listp (split-string email ",+ *"))
  1561. (mapc (lambda(e)
  1562. (insert "<a href=\"mailto:" e "\">&lt;"
  1563. e "&gt;</a>\n"))
  1564. (split-string email ",+ *"))
  1565. (insert "<a href=\"mailto:" email "\">&lt;"
  1566. email "&gt;</a>\n")))
  1567. (insert "</p>\n"))
  1568. (when (and date org-export-time-stamp-file)
  1569. (insert "<p class=\"date\"> "
  1570. (nth 2 lang-words) ": "
  1571. date "</p>\n"))
  1572. (when org-export-creator-info
  1573. (insert (format "<p class=\"creator\">HTML generated by org-mode %s in emacs %s</p>\n"
  1574. org-version emacs-major-version)))
  1575. (when org-export-html-validation-link
  1576. (insert org-export-html-validation-link "\n"))
  1577. (insert "</div>"))
  1578. (if org-export-html-with-timestamp
  1579. (insert org-export-html-html-helper-timestamp))
  1580. (org-export-html-insert-plist-item opt-plist :postamble opt-plist)
  1581. (insert "\n</div>\n</body>\n</html>\n"))
  1582. (unless (plist-get opt-plist :buffer-will-be-killed)
  1583. (normal-mode)
  1584. (if (eq major-mode (default-value 'major-mode))
  1585. (html-mode)))
  1586. ;; insert the table of contents
  1587. (goto-char (point-min))
  1588. (when thetoc
  1589. (if (or (re-search-forward
  1590. "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t)
  1591. (re-search-forward
  1592. "\\[TABLE-OF-CONTENTS\\]" nil t))
  1593. (progn
  1594. (goto-char (match-beginning 0))
  1595. (replace-match ""))
  1596. (goto-char first-heading-pos)
  1597. (when (looking-at "\\s-*</p>")
  1598. (goto-char (match-end 0))
  1599. (insert "\n")))
  1600. (insert "<div id=\"table-of-contents\">\n")
  1601. (mapc 'insert thetoc)
  1602. (insert "</div>\n"))
  1603. ;; remove empty paragraphs and lists
  1604. (goto-char (point-min))
  1605. (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t)
  1606. (replace-match ""))
  1607. (goto-char (point-min))
  1608. (while (re-search-forward "<li>[ \r\n\t]*</li>\n?" nil t)
  1609. (replace-match ""))
  1610. (goto-char (point-min))
  1611. ;; Convert whitespace place holders
  1612. (goto-char (point-min))
  1613. (let (beg end n)
  1614. (while (setq beg (next-single-property-change (point) 'org-whitespace))
  1615. (setq n (get-text-property beg 'org-whitespace)
  1616. end (next-single-property-change beg 'org-whitespace))
  1617. (goto-char beg)
  1618. (delete-region beg end)
  1619. (insert (format "<span style=\"visibility:hidden;\">%s</span>"
  1620. (make-string n ?x)))))
  1621. ;; Remove empty lines at the beginning of the file.
  1622. (goto-char (point-min))
  1623. (when (looking-at "\\s-+\n") (replace-match ""))
  1624. ;; Remove display properties
  1625. (remove-text-properties (point-min) (point-max) '(display t))
  1626. ;; Run the hook
  1627. (run-hooks 'org-export-html-final-hook)
  1628. (or to-buffer (save-buffer))
  1629. (goto-char (point-min))
  1630. (or (org-export-push-to-kill-ring "HTML")
  1631. (message "Exporting... done"))
  1632. (if (eq to-buffer 'string)
  1633. (prog1 (buffer-substring (point-min) (point-max))
  1634. (kill-buffer (current-buffer)))
  1635. (current-buffer)))))
  1636. (defun org-export-html-insert-plist-item (plist key &rest args)
  1637. (let ((item (plist-get plist key)))
  1638. (cond ((functionp item)
  1639. (apply item args))
  1640. (item
  1641. (insert item)))))
  1642. (defun org-export-html-format-href (s)
  1643. "Make sure the S is valid as a href reference in an XHTML document."
  1644. (save-match-data
  1645. (let ((start 0))
  1646. (while (string-match "&" s start)
  1647. (setq start (+ (match-beginning 0) 3)
  1648. s (replace-match "&amp;" t t s)))))
  1649. s)
  1650. (defun org-export-html-format-desc (s)
  1651. "Make sure the S is valid as a description in a link."
  1652. (if (and s (not (get-text-property 1 'org-protected s)))
  1653. (save-match-data
  1654. (org-html-do-expand s))
  1655. s))
  1656. (defun org-export-html-format-image (src par-open)
  1657. "Create image tag with source and attributes."
  1658. (save-match-data
  1659. (if (string-match "^ltxpng/" src)
  1660. (format "<img src=\"%s\" alt=\"%s\"/>"
  1661. src (org-find-text-property-in-string 'org-latex-src src))
  1662. (let* ((caption (org-find-text-property-in-string 'org-caption src))
  1663. (attr (org-find-text-property-in-string 'org-attributes src))
  1664. (label (org-find-text-property-in-string 'org-label src)))
  1665. (setq caption (and caption (org-html-do-expand caption)))
  1666. (concat
  1667. (if caption
  1668. (format "%s<div %sclass=\"figure\">
  1669. <p>"
  1670. (if org-par-open "</p>\n" "")
  1671. (if label (format "id=\"%s\" " label) "")))
  1672. (format "<img src=\"%s\"%s />"
  1673. src
  1674. (if (string-match "\\<alt=" (or attr ""))
  1675. (concat " " attr )
  1676. (concat " " attr " alt=\"" src "\"")))
  1677. (if caption
  1678. (format "</p>%s
  1679. </div>%s"
  1680. (concat "\n<p>" caption "</p>")
  1681. (if org-par-open "\n<p>" ""))))))))
  1682. (defun org-export-html-get-bibliography ()
  1683. "Find bibliography, cut it out and return it."
  1684. (catch 'exit
  1685. (let (beg end (cnt 1) bib)
  1686. (save-excursion
  1687. (goto-char (point-min))
  1688. (when (re-search-forward "^[ \t]*<div \\(id\\|class\\)=\"bibliography\"" nil t)
  1689. (setq beg (match-beginning 0))
  1690. (while (re-search-forward "</?div\\>" nil t)
  1691. (setq cnt (+ cnt (if (string= (match-string 0) "<div") +1 -1)))
  1692. (when (= cnt 0)
  1693. (and (looking-at ">") (forward-char 1))
  1694. (setq bib (buffer-substring beg (point)))
  1695. (delete-region beg (point))
  1696. (throw 'exit bib))))
  1697. nil))))
  1698. (defvar org-table-number-regexp) ; defined in org-table.el
  1699. (defun org-format-table-html (lines olines &optional no-css)
  1700. "Find out which HTML converter to use and return the HTML code.
  1701. NO-CSS is passed to the exporter."
  1702. (if (stringp lines)
  1703. (setq lines (org-split-string lines "\n")))
  1704. (if (string-match "^[ \t]*|" (car lines))
  1705. ;; A normal org table
  1706. (org-format-org-table-html lines nil no-css)
  1707. ;; Table made by table.el - test for spanning
  1708. (let* ((hlines (delq nil (mapcar
  1709. (lambda (x)
  1710. (if (string-match "^[ \t]*\\+-" x) x
  1711. nil))
  1712. lines)))
  1713. (first (car hlines))
  1714. (ll (and (string-match "\\S-+" first)
  1715. (match-string 0 first)))
  1716. (re (concat "^[ \t]*" (regexp-quote ll)))
  1717. (spanning (delq nil (mapcar (lambda (x) (not (string-match re x)))
  1718. hlines))))
  1719. (if (and (not spanning)
  1720. (not org-export-prefer-native-exporter-for-tables))
  1721. ;; We can use my own converter with HTML conversions
  1722. (org-format-table-table-html lines)
  1723. ;; Need to use the code generator in table.el, with the original text.
  1724. (org-format-table-table-html-using-table-generate-source olines)))))
  1725. (defvar org-table-number-fraction) ; defined in org-table.el
  1726. (defun org-format-org-table-html (lines &optional splice no-css)
  1727. "Format a table into HTML.
  1728. LINES is a list of lines. Optional argument SPLICE means, do not
  1729. insert header and surrounding <table> tags, just format the lines.
  1730. Optional argument NO-CSS means use XHTML attributes instead of CSS
  1731. for formatting. This is required for the DocBook exporter."
  1732. (require 'org-table)
  1733. ;; Get rid of hlines at beginning and end
  1734. (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  1735. (setq lines (nreverse lines))
  1736. (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  1737. (setq lines (nreverse lines))
  1738. (when org-export-table-remove-special-lines
  1739. ;; Check if the table has a marking column. If yes remove the
  1740. ;; column and the special lines
  1741. (setq lines (org-table-clean-before-export lines)))
  1742. (let* ((caption (org-find-text-property-in-string 'org-caption (car lines)))
  1743. (label (org-find-text-property-in-string 'org-label (car lines)))
  1744. (forced-aligns (org-find-text-property-in-string 'org-forced-aligns
  1745. (car lines)))
  1746. (attributes (org-find-text-property-in-string 'org-attributes
  1747. (car lines)))
  1748. (html-table-tag (org-export-splice-attributes
  1749. html-table-tag attributes))
  1750. (head (and org-export-highlight-first-table-line
  1751. (delq nil (mapcar
  1752. (lambda (x) (string-match "^[ \t]*|-" x))
  1753. (cdr lines)))))
  1754. (nline 0) fnum nfields i (cnt 0)
  1755. tbopen line fields html gr colgropen rowstart rowend
  1756. ali align aligns n)
  1757. (setq caption (and caption (org-html-do-expand caption)))
  1758. (when (and forced-aligns org-table-clean-did-remove-column)
  1759. (setq forced-aligns
  1760. (mapcar (lambda (x) (cons (1- (car x)) (cdr x))) forced-aligns)))
  1761. (if splice (setq head nil))
  1762. (unless splice (push (if head "<thead>" "<tbody>") html))
  1763. (setq tbopen t)
  1764. (while (setq line (pop lines))
  1765. (catch 'next-line
  1766. (if (string-match "^[ \t]*|-" line)
  1767. (progn
  1768. (unless splice
  1769. (push (if head "</thead>" "</tbody>") html)
  1770. (if lines (push "<tbody>" html) (setq tbopen nil)))
  1771. (setq head nil) ;; head ends here, first time around
  1772. ;; ignore this line
  1773. (throw 'next-line t)))
  1774. ;; Break the line into fields
  1775. (setq fields (org-split-string line "[ \t]*|[ \t]*"))
  1776. (unless fnum (setq fnum (make-vector (length fields) 0)
  1777. nfields (length fnum)))
  1778. (setq nline (1+ nline) i -1
  1779. rowstart (eval (car org-export-table-row-tags))
  1780. rowend (eval (cdr org-export-table-row-tags)))
  1781. (push (concat rowstart
  1782. (mapconcat
  1783. (lambda (x)
  1784. (setq i (1+ i) ali (format "@@class%03d@@" i))
  1785. (if (and (< i nfields) ; make sure no rogue line causes an error here
  1786. (string-match org-table-number-regexp x))
  1787. (incf (aref fnum i)))
  1788. (cond
  1789. (head
  1790. (concat
  1791. (format (car org-export-table-header-tags)
  1792. "col" ali)
  1793. x
  1794. (cdr org-export-table-header-tags)))
  1795. ((and (= i 0) org-export-html-table-use-header-tags-for-first-column)
  1796. (concat
  1797. (format (car org-export-table-header-tags)
  1798. "row" ali)
  1799. x
  1800. (cdr org-export-table-header-tags)))
  1801. (t
  1802. (concat (format (car org-export-table-data-tags) ali)
  1803. x
  1804. (cdr org-export-table-data-tags)))))
  1805. fields "")
  1806. rowend)
  1807. html)))
  1808. (unless splice (if tbopen (push "</tbody>" html)))
  1809. (unless splice (push "</table>\n" html))
  1810. (setq html (nreverse html))
  1811. (unless splice
  1812. ;; Put in col tags with the alignment (unfortunately often ignored...)
  1813. (unless (car org-table-colgroup-info)
  1814. (setq org-table-colgroup-info
  1815. (cons :start (cdr org-table-colgroup-info))))
  1816. (setq i 0)
  1817. (push (mapconcat
  1818. (lambda (x)
  1819. (setq gr (pop org-table-colgroup-info)
  1820. i (1+ i)
  1821. align (if (assoc i forced-aligns)
  1822. (cdr (assoc (cdr (assoc i forced-aligns))
  1823. '(("l" . "left") ("r" . "right")
  1824. ("c" . "center"))))
  1825. (if (> (/ (float x) nline)
  1826. org-table-number-fraction)
  1827. "right" "left")))
  1828. (push align aligns)
  1829. (format (if no-css
  1830. "%s<col align=\"%s\" />%s"
  1831. "%s<col class=\"%s\" />%s")
  1832. (if (memq gr '(:start :startend))
  1833. (prog1
  1834. (if colgropen
  1835. "</colgroup>\n<colgroup>"
  1836. "<colgroup>")
  1837. (setq colgropen t))
  1838. "")
  1839. align
  1840. (if (memq gr '(:end :startend))
  1841. (progn (setq colgropen nil) "</colgroup>")
  1842. "")))
  1843. fnum "")
  1844. html)
  1845. (setq aligns (nreverse aligns))
  1846. (if colgropen (setq html (cons (car html)
  1847. (cons "</colgroup>" (cdr html)))))
  1848. ;; Since the output of HTML table formatter can also be used in
  1849. ;; DocBook document, we want to always include the caption to make
  1850. ;; DocBook XML file valid.
  1851. (push (format "<caption>%s</caption>" (or caption "")) html)
  1852. (when label (push (format "<a name=\"%s\" id=\"%s\"></a>" label label)
  1853. html))
  1854. (push html-table-tag html))
  1855. (setq html (mapcar
  1856. (lambda (x)
  1857. (replace-regexp-in-string
  1858. "@@class\\([0-9]+\\)@@"
  1859. (lambda (txt)
  1860. (if (not org-export-html-table-align-individual-fields)
  1861. ""
  1862. (setq n (string-to-number (match-string 1 txt)))
  1863. (format (if no-css " align=\"%s\"" " class=\"%s\"")
  1864. (or (nth n aligns) "left"))))
  1865. x))
  1866. html))
  1867. (concat (mapconcat 'identity html "\n") "\n")))
  1868. (defun org-export-splice-attributes (tag attributes)
  1869. "Read attributes in string ATTRIBUTES, add and replace in HTML tag TAG."
  1870. (if (not attributes)
  1871. tag
  1872. (let (oldatt newatt)
  1873. (setq oldatt (org-extract-attributes-from-string tag)
  1874. tag (pop oldatt)
  1875. newatt (cdr (org-extract-attributes-from-string attributes)))
  1876. (while newatt
  1877. (setq oldatt (plist-put oldatt (pop newatt) (pop newatt))))
  1878. (if (string-match ">" tag)
  1879. (setq tag
  1880. (replace-match (concat (org-attributes-to-string oldatt) ">")
  1881. t t tag)))
  1882. tag)))
  1883. (defun org-format-table-table-html (lines)
  1884. "Format a table generated by table.el into HTML.
  1885. This conversion does *not* use `table-generate-source' from table.el.
  1886. This has the advantage that Org-mode's HTML conversions can be used.
  1887. But it has the disadvantage, that no cell- or row-spanning is allowed."
  1888. (let (line field-buffer
  1889. (head org-export-highlight-first-table-line)
  1890. fields html empty i)
  1891. (setq html (concat html-table-tag "\n"))
  1892. (while (setq line (pop lines))
  1893. (setq empty "&nbsp;")
  1894. (catch 'next-line
  1895. (if (string-match "^[ \t]*\\+-" line)
  1896. (progn
  1897. (if field-buffer
  1898. (progn
  1899. (setq
  1900. html
  1901. (concat
  1902. html
  1903. "<tr>"
  1904. (mapconcat
  1905. (lambda (x)
  1906. (if (equal x "") (setq x empty))
  1907. (if head
  1908. (concat
  1909. (format (car org-export-table-header-tags) "col" "")
  1910. x
  1911. (cdr org-export-table-header-tags))
  1912. (concat (format (car org-export-table-data-tags) "") x
  1913. (cdr org-export-table-data-tags))))
  1914. field-buffer "\n")
  1915. "</tr>\n"))
  1916. (setq head nil)
  1917. (setq field-buffer nil)))
  1918. ;; Ignore this line
  1919. (throw 'next-line t)))
  1920. ;; Break the line into fields and store the fields
  1921. (setq fields (org-split-string line "[ \t]*|[ \t]*"))
  1922. (if field-buffer
  1923. (setq field-buffer (mapcar
  1924. (lambda (x)
  1925. (concat x "<br/>" (pop fields)))
  1926. field-buffer))
  1927. (setq field-buffer fields))))
  1928. (setq html (concat html "</table>\n"))
  1929. html))
  1930. (defun org-format-table-table-html-using-table-generate-source (lines)
  1931. "Format a table into html, using `table-generate-source' from table.el.
  1932. This has the advantage that cell- or row-spanning is allowed.
  1933. But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
  1934. (require 'table)
  1935. (with-current-buffer (get-buffer-create " org-tmp1 ")
  1936. (erase-buffer)
  1937. (insert (mapconcat 'identity lines "\n"))
  1938. (goto-char (point-min))
  1939. (if (not (re-search-forward "|[^+]" nil t))
  1940. (error "Error processing table"))
  1941. (table-recognize-table)
  1942. (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
  1943. (table-generate-source 'html " org-tmp2 ")
  1944. (set-buffer " org-tmp2 ")
  1945. (buffer-substring (point-min) (point-max))))
  1946. (defun org-export-splice-style (style extra)
  1947. "Splice EXTRA into STYLE, just before \"</style>\"."
  1948. (if (and (stringp extra)
  1949. (string-match "\\S-" extra)
  1950. (string-match "</style>" style))
  1951. (concat (substring style 0 (match-beginning 0))
  1952. "\n" extra "\n"
  1953. (substring style (match-beginning 0)))
  1954. style))
  1955. (defun org-html-handle-time-stamps (s)
  1956. "Format time stamps in string S, or remove them."
  1957. (catch 'exit
  1958. (let (r b)
  1959. (while (string-match org-maybe-keyword-time-regexp s)
  1960. (or b (setq b (substring s 0 (match-beginning 0))))
  1961. (setq r (concat
  1962. r (substring s 0 (match-beginning 0))
  1963. " @<span class=\"timestamp-wrapper\">"
  1964. (if (match-end 1)
  1965. (format "@<span class=\"timestamp-kwd\">%s @</span>"
  1966. (match-string 1 s)))
  1967. (format " @<span class=\"timestamp\">%s@</span>"
  1968. (substring
  1969. (org-translate-time (match-string 3 s)) 1 -1))
  1970. "@</span>")
  1971. s (substring s (match-end 0))))
  1972. ;; Line break if line started and ended with time stamp stuff
  1973. (if (not r)
  1974. s
  1975. (setq r (concat r s))
  1976. (unless (string-match "\\S-" (concat b s))
  1977. (setq r (concat r "@<br/>")))
  1978. r))))
  1979. (defvar htmlize-buffer-places) ; from htmlize.el
  1980. (defun org-export-htmlize-region-for-paste (beg end)
  1981. "Convert the region to HTML, using htmlize.el.
  1982. This is much like `htmlize-region-for-paste', only that it uses
  1983. the settings define in the org-... variables."
  1984. (let* ((htmlize-output-type org-export-htmlize-output-type)
  1985. (htmlize-css-name-prefix org-export-htmlize-css-font-prefix)
  1986. (htmlbuf (htmlize-region beg end)))
  1987. (unwind-protect
  1988. (with-current-buffer htmlbuf
  1989. (buffer-substring (plist-get htmlize-buffer-places 'content-start)
  1990. (plist-get htmlize-buffer-places 'content-end)))
  1991. (kill-buffer htmlbuf))))
  1992. ;;;###autoload
  1993. (defun org-export-htmlize-generate-css ()
  1994. "Create the CSS for all font definitions in the current Emacs session.
  1995. Use this to create face definitions in your CSS style file that can then
  1996. be used by code snippets transformed by htmlize.
  1997. This command just produces a buffer that contains class definitions for all
  1998. faces used in the current Emacs session. You can copy and paste the ones you
  1999. need into your CSS file.
  2000. If you then set `org-export-htmlize-output-type' to `css', calls to
  2001. the function `org-export-htmlize-region-for-paste' will produce code
  2002. that uses these same face definitions."
  2003. (interactive)
  2004. (require 'htmlize)
  2005. (and (get-buffer "*html*") (kill-buffer "*html*"))
  2006. (with-temp-buffer
  2007. (let ((fl (face-list))
  2008. (htmlize-css-name-prefix "org-")
  2009. (htmlize-output-type 'css)
  2010. f i)
  2011. (while (setq f (pop fl)
  2012. i (and f (face-attribute f :inherit)))
  2013. (when (and (symbolp f) (or (not i) (not (listp i))))
  2014. (insert (org-add-props (copy-sequence "1") nil 'face f))))
  2015. (htmlize-region (point-min) (point-max))))
  2016. (switch-to-buffer "*html*")
  2017. (goto-char (point-min))
  2018. (if (re-search-forward "<style" nil t)
  2019. (delete-region (point-min) (match-beginning 0)))
  2020. (if (re-search-forward "</style>" nil t)
  2021. (delete-region (1+ (match-end 0)) (point-max)))
  2022. (beginning-of-line 1)
  2023. (if (looking-at " +") (replace-match ""))
  2024. (goto-char (point-min)))
  2025. (defun org-html-protect (s)
  2026. "convert & to &amp;, < to &lt; and > to &gt;"
  2027. (let ((start 0))
  2028. (while (string-match "&" s start)
  2029. (setq s (replace-match "&amp;" t t s)
  2030. start (1+ (match-beginning 0))))
  2031. (while (string-match "<" s)
  2032. (setq s (replace-match "&lt;" t t s)))
  2033. (while (string-match ">" s)
  2034. (setq s (replace-match "&gt;" t t s)))
  2035. ; (while (string-match "\"" s)
  2036. ; (setq s (replace-match "&quot;" t t s)))
  2037. )
  2038. s)
  2039. (defun org-html-expand (string)
  2040. "Prepare STRING for HTML export. Apply all active conversions.
  2041. If there are links in the string, don't modify these."
  2042. (let* ((re (concat org-bracket-link-regexp "\\|"
  2043. (org-re "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")))
  2044. m s l res)
  2045. (if (string-match "^[ \t]*\\+-[-+]*\\+[ \t]*$" string)
  2046. string
  2047. (while (setq m (string-match re string))
  2048. (setq s (substring string 0 m)
  2049. l (match-string 0 string)
  2050. string (substring string (match-end 0)))
  2051. (push (org-html-do-expand s) res)
  2052. (push l res))
  2053. (push (org-html-do-expand string) res)
  2054. (apply 'concat (nreverse res)))))
  2055. (defun org-html-do-expand (s)
  2056. "Apply all active conversions to translate special ASCII to HTML."
  2057. (setq s (org-html-protect s))
  2058. (if org-export-html-expand
  2059. (while (string-match "@&lt;\\([^&]*\\)&gt;" s)
  2060. (setq s (replace-match "<\\1>" t nil s))))
  2061. (if org-export-with-emphasize
  2062. (setq s (org-export-html-convert-emphasize s)))
  2063. (if org-export-with-special-strings
  2064. (setq s (org-export-html-convert-special-strings s)))
  2065. (if org-export-with-sub-superscripts
  2066. (setq s (org-export-html-convert-sub-super s)))
  2067. (if org-export-with-TeX-macros
  2068. (let ((start 0) wd rep)
  2069. (while (setq start (string-match "\\\\\\([a-zA-Z]+[0-9]*\\)\\({}\\)?"
  2070. s start))
  2071. (if (get-text-property (match-beginning 0) 'org-protected s)
  2072. (setq start (match-end 0))
  2073. (setq wd (match-string 1 s))
  2074. (if (setq rep (org-entity-get-representation wd 'html))
  2075. (setq s (replace-match rep t t s))
  2076. (setq start (+ start (length wd))))))))
  2077. s)
  2078. (defun org-export-html-convert-special-strings (string)
  2079. "Convert special characters in STRING to HTML."
  2080. (let ((all org-export-html-special-string-regexps)
  2081. e a re rpl start)
  2082. (while (setq a (pop all))
  2083. (setq re (car a) rpl (cdr a) start 0)
  2084. (while (string-match re string start)
  2085. (if (get-text-property (match-beginning 0) 'org-protected string)
  2086. (setq start (match-end 0))
  2087. (setq string (replace-match rpl t nil string)))))
  2088. string))
  2089. (defun org-export-html-convert-sub-super (string)
  2090. "Convert sub- and superscripts in STRING to HTML."
  2091. (let (key c (s 0) (requireb (eq org-export-with-sub-superscripts '{})))
  2092. (while (string-match org-match-substring-regexp string s)
  2093. (cond
  2094. ((and requireb (match-end 8)) (setq s (match-end 2)))
  2095. ((get-text-property (match-beginning 2) 'org-protected string)
  2096. (setq s (match-end 2)))
  2097. (t
  2098. (setq s (match-end 1)
  2099. key (if (string= (match-string 2 string) "_") "sub" "sup")
  2100. c (or (match-string 8 string)
  2101. (match-string 6 string)
  2102. (match-string 5 string))
  2103. string (replace-match
  2104. (concat (match-string 1 string)
  2105. "<" key ">" c "</" key ">")
  2106. t t string)))))
  2107. (while (string-match "\\\\\\([_^]\\)" string)
  2108. (setq string (replace-match (match-string 1 string) t t string)))
  2109. string))
  2110. (defun org-export-html-convert-emphasize (string)
  2111. "Apply emphasis."
  2112. (let ((s 0) rpl)
  2113. (while (string-match org-emph-re string s)
  2114. (if (not (equal
  2115. (substring string (match-beginning 3) (1+ (match-beginning 3)))
  2116. (substring string (match-beginning 4) (1+ (match-beginning 4)))))
  2117. (setq s (match-beginning 0)
  2118. rpl
  2119. (concat
  2120. (match-string 1 string)
  2121. (nth 2 (assoc (match-string 3 string) org-emphasis-alist))
  2122. (match-string 4 string)
  2123. (nth 3 (assoc (match-string 3 string)
  2124. org-emphasis-alist))
  2125. (match-string 5 string))
  2126. string (replace-match rpl t t string)
  2127. s (+ s (- (length rpl) 2)))
  2128. (setq s (1+ s))))
  2129. string))
  2130. (defun org-open-par ()
  2131. "Insert <p>, but first close previous paragraph if any."
  2132. (org-close-par-maybe)
  2133. (insert "\n<p>")
  2134. (setq org-par-open t))
  2135. (defun org-close-par-maybe ()
  2136. "Close paragraph if there is one open."
  2137. (when org-par-open
  2138. (insert "</p>")
  2139. (setq org-par-open nil)))
  2140. (defun org-close-li (&optional type)
  2141. "Close <li> if necessary."
  2142. (org-close-par-maybe)
  2143. (insert (if (equal type "d") "</dd>\n" "</li>\n")))
  2144. (defvar in-local-list)
  2145. (defvar local-list-indent)
  2146. (defvar local-list-type)
  2147. (defvar body-only) ; dynamically scoped into this.
  2148. (defun org-html-level-start (level title umax with-toc head-count)
  2149. "Insert a new level in HTML export.
  2150. When TITLE is nil, just close all open levels."
  2151. (org-close-par-maybe)
  2152. (let* ((target (and title (org-get-text-property-any 0 'target title)))
  2153. (extra-targets (and target
  2154. (assoc target org-export-target-aliases)))
  2155. (extra-class (and title (org-get-text-property-any 0 'html-container-class title)))
  2156. (preferred (and target
  2157. (cdr (assoc target org-export-preferred-target-alist))))
  2158. (l org-level-max)
  2159. snumber snu href suffix)
  2160. (setq extra-targets (remove (or preferred target) extra-targets))
  2161. (setq extra-targets
  2162. (mapconcat (lambda (x)
  2163. (if (org-uuidgen-p x) (setq x (concat "ID-" x)))
  2164. (format "<a name=\"%s\" id=\"%s\"></a>"
  2165. x x))
  2166. extra-targets
  2167. ""))
  2168. (while (>= l level)
  2169. (if (aref org-levels-open (1- l))
  2170. (progn
  2171. (org-html-level-close l umax)
  2172. (aset org-levels-open (1- l) nil)))
  2173. (setq l (1- l)))
  2174. (when title
  2175. ;; If title is nil, this means this function is called to close
  2176. ;; all levels, so the rest is done only if title is given
  2177. (when (string-match (org-re "\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") title)
  2178. (setq title (replace-match
  2179. (if org-export-with-tags
  2180. (save-match-data
  2181. (concat
  2182. "&nbsp;&nbsp;&nbsp;<span class=\"tag\">"
  2183. (mapconcat
  2184. (lambda (x)
  2185. (format "<span class=\"%s\">%s</span>"
  2186. (org-export-html-get-tag-class-name x)
  2187. x))
  2188. (org-split-string (match-string 1 title) ":")
  2189. "&nbsp;")
  2190. "</span>"))
  2191. "")
  2192. t t title)))
  2193. (if (> level umax)
  2194. (progn
  2195. (if (aref org-levels-open (1- level))
  2196. (progn
  2197. (org-close-li)
  2198. (if target
  2199. (insert (format "<li id=\"%s\">" (or preferred target))
  2200. extra-targets title "<br/>\n")
  2201. (insert "<li>" title "<br/>\n")))
  2202. (aset org-levels-open (1- level) t)
  2203. (org-close-par-maybe)
  2204. (if target
  2205. (insert (format "<ul>\n<li id=\"%s\">" (or preferred target))
  2206. extra-targets title "<br/>\n")
  2207. (insert "<ul>\n<li>" title "<br/>\n"))))
  2208. (aset org-levels-open (1- level) t)
  2209. (setq snumber (org-section-number level)
  2210. snu (replace-regexp-in-string "\\." "_" snumber))
  2211. (setq level (+ level org-export-html-toplevel-hlevel -1))
  2212. (if (and org-export-with-section-numbers (not body-only))
  2213. (setq title (concat
  2214. (format "<span class=\"section-number-%d\">%s</span>"
  2215. level snumber)
  2216. " " title)))
  2217. (unless (= head-count 1) (insert "\n</div>\n"))
  2218. (setq href (cdr (assoc (concat "sec-" snu) org-export-preferred-target-alist)))
  2219. (setq suffix (or href snu))
  2220. (setq href (or href (concat "sec-" snu)))
  2221. (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"
  2222. suffix level (if extra-class (concat " " extra-class) "")
  2223. level href
  2224. extra-targets
  2225. title level level suffix))
  2226. (org-open-par)))))
  2227. (defun org-export-html-get-tag-class-name (tag)
  2228. "Turn tag into a valid class name.
  2229. Replaces invalid characters with \"_\" and then prepends a prefix."
  2230. (save-match-data
  2231. (while (string-match "[^a-zA-Z0-9_]" tag)
  2232. (setq tag (replace-match "_" t t tag))))
  2233. (concat org-export-html-tag-class-prefix tag))
  2234. (defun org-export-html-get-todo-kwd-class-name (kwd)
  2235. "Turn todo keyword into a valid class name.
  2236. Replaces invalid characters with \"_\" and then prepends a prefix."
  2237. (save-match-data
  2238. (while (string-match "[^a-zA-Z0-9_]" kwd)
  2239. (setq kwd (replace-match "_" t t kwd))))
  2240. (concat org-export-html-todo-kwd-class-prefix kwd))
  2241. (defun org-html-level-close (level max-outline-level)
  2242. "Terminate one level in HTML export."
  2243. (if (<= level max-outline-level)
  2244. (insert "</div>\n")
  2245. (org-close-li)
  2246. (insert "</ul>\n")))
  2247. (provide 'org-html)
  2248. ;; arch-tag: 8109d84d-eb8f-460b-b1a8-f45f3a6c7ea1
  2249. ;;; org-html.el ends here