ox-html.el 142 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835
  1. ;;; ox-html.el --- HTML Back-End for Org Export Engine -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2011-2018 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Jambunathan K <kjambunathan at gmail dot com>
  5. ;; Keywords: outlines, hypermedia, calendar, wp
  6. ;; This file is part of GNU Emacs.
  7. ;; GNU Emacs is free software: you can redistribute it and/or modify
  8. ;; it under the terms of the GNU General Public License as published by
  9. ;; the Free Software Foundation, either version 3 of the License, or
  10. ;; (at your option) any later version.
  11. ;; GNU Emacs is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. ;; GNU General Public License for more details.
  15. ;; You should have received a copy of the GNU General Public License
  16. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  17. ;;; Commentary:
  18. ;; This library implements a HTML back-end for Org generic exporter.
  19. ;; See Org manual for more information.
  20. ;;; Code:
  21. ;;; Dependencies
  22. (require 'cl-lib)
  23. (require 'format-spec)
  24. (require 'ox)
  25. (require 'ox-publish)
  26. (require 'table)
  27. ;;; Function Declarations
  28. (declare-function org-id-find-id-file "org-id" (id))
  29. (declare-function htmlize-region "ext:htmlize" (beg end))
  30. (declare-function mm-url-decode-entities "mm-url" ())
  31. (defvar htmlize-css-name-prefix)
  32. (defvar htmlize-output-type)
  33. (defvar htmlize-output-type)
  34. (defvar htmlize-css-name-prefix)
  35. ;;; Define Back-End
  36. (org-export-define-backend 'html
  37. '((bold . org-html-bold)
  38. (center-block . org-html-center-block)
  39. (clock . org-html-clock)
  40. (code . org-html-code)
  41. (drawer . org-html-drawer)
  42. (dynamic-block . org-html-dynamic-block)
  43. (entity . org-html-entity)
  44. (example-block . org-html-example-block)
  45. (export-block . org-html-export-block)
  46. (export-snippet . org-html-export-snippet)
  47. (fixed-width . org-html-fixed-width)
  48. (footnote-definition . org-html-footnote-definition)
  49. (footnote-reference . org-html-footnote-reference)
  50. (headline . org-html-headline)
  51. (horizontal-rule . org-html-horizontal-rule)
  52. (inline-src-block . org-html-inline-src-block)
  53. (inlinetask . org-html-inlinetask)
  54. (inner-template . org-html-inner-template)
  55. (italic . org-html-italic)
  56. (item . org-html-item)
  57. (keyword . org-html-keyword)
  58. (latex-environment . org-html-latex-environment)
  59. (latex-fragment . org-html-latex-fragment)
  60. (line-break . org-html-line-break)
  61. (link . org-html-link)
  62. (node-property . org-html-node-property)
  63. (paragraph . org-html-paragraph)
  64. (plain-list . org-html-plain-list)
  65. (plain-text . org-html-plain-text)
  66. (planning . org-html-planning)
  67. (property-drawer . org-html-property-drawer)
  68. (quote-block . org-html-quote-block)
  69. (radio-target . org-html-radio-target)
  70. (section . org-html-section)
  71. (special-block . org-html-special-block)
  72. (src-block . org-html-src-block)
  73. (statistics-cookie . org-html-statistics-cookie)
  74. (strike-through . org-html-strike-through)
  75. (subscript . org-html-subscript)
  76. (superscript . org-html-superscript)
  77. (table . org-html-table)
  78. (table-cell . org-html-table-cell)
  79. (table-row . org-html-table-row)
  80. (target . org-html-target)
  81. (template . org-html-template)
  82. (timestamp . org-html-timestamp)
  83. (underline . org-html-underline)
  84. (verbatim . org-html-verbatim)
  85. (verse-block . org-html-verse-block))
  86. :filters-alist '((:filter-options . org-html-infojs-install-script)
  87. (:filter-parse-tree . org-html-image-link-filter)
  88. (:filter-final-output . org-html-final-function))
  89. :menu-entry
  90. '(?h "Export to HTML"
  91. ((?H "As HTML buffer" org-html-export-as-html)
  92. (?h "As HTML file" org-html-export-to-html)
  93. (?o "As HTML file and open"
  94. (lambda (a s v b)
  95. (if a (org-html-export-to-html t s v b)
  96. (org-open-file (org-html-export-to-html nil s v b)))))))
  97. :options-alist
  98. '((:html-doctype "HTML_DOCTYPE" nil org-html-doctype)
  99. (:html-container "HTML_CONTAINER" nil org-html-container-element)
  100. (:description "DESCRIPTION" nil nil newline)
  101. (:keywords "KEYWORDS" nil nil space)
  102. (:html-html5-fancy nil "html5-fancy" org-html-html5-fancy)
  103. (:html-link-use-abs-url nil "html-link-use-abs-url" org-html-link-use-abs-url)
  104. (:html-link-home "HTML_LINK_HOME" nil org-html-link-home)
  105. (:html-link-up "HTML_LINK_UP" nil org-html-link-up)
  106. (:html-mathjax "HTML_MATHJAX" nil "" space)
  107. (:html-postamble nil "html-postamble" org-html-postamble)
  108. (:html-preamble nil "html-preamble" org-html-preamble)
  109. (:html-head "HTML_HEAD" nil org-html-head newline)
  110. (:html-head-extra "HTML_HEAD_EXTRA" nil org-html-head-extra newline)
  111. (:subtitle "SUBTITLE" nil nil parse)
  112. (:html-head-include-default-style
  113. nil "html-style" org-html-head-include-default-style)
  114. (:html-head-include-scripts nil "html-scripts" org-html-head-include-scripts)
  115. (:html-allow-name-attribute-in-anchors
  116. nil nil org-html-allow-name-attribute-in-anchors)
  117. (:html-divs nil nil org-html-divs)
  118. (:html-checkbox-type nil nil org-html-checkbox-type)
  119. (:html-extension nil nil org-html-extension)
  120. (:html-footnote-format nil nil org-html-footnote-format)
  121. (:html-footnote-separator nil nil org-html-footnote-separator)
  122. (:html-footnotes-section nil nil org-html-footnotes-section)
  123. (:html-format-drawer-function nil nil org-html-format-drawer-function)
  124. (:html-format-headline-function nil nil org-html-format-headline-function)
  125. (:html-format-inlinetask-function
  126. nil nil org-html-format-inlinetask-function)
  127. (:html-home/up-format nil nil org-html-home/up-format)
  128. (:html-indent nil nil org-html-indent)
  129. (:html-infojs-options nil nil org-html-infojs-options)
  130. (:html-infojs-template nil nil org-html-infojs-template)
  131. (:html-inline-image-rules nil nil org-html-inline-image-rules)
  132. (:html-link-org-files-as-html nil nil org-html-link-org-files-as-html)
  133. (:html-mathjax-options nil nil org-html-mathjax-options)
  134. (:html-mathjax-template nil nil org-html-mathjax-template)
  135. (:html-metadata-timestamp-format nil nil org-html-metadata-timestamp-format)
  136. (:html-postamble-format nil nil org-html-postamble-format)
  137. (:html-preamble-format nil nil org-html-preamble-format)
  138. (:html-table-align-individual-fields
  139. nil nil org-html-table-align-individual-fields)
  140. (:html-table-caption-above nil nil org-html-table-caption-above)
  141. (:html-table-data-tags nil nil org-html-table-data-tags)
  142. (:html-table-header-tags nil nil org-html-table-header-tags)
  143. (:html-table-use-header-tags-for-first-column
  144. nil nil org-html-table-use-header-tags-for-first-column)
  145. (:html-tag-class-prefix nil nil org-html-tag-class-prefix)
  146. (:html-text-markup-alist nil nil org-html-text-markup-alist)
  147. (:html-todo-kwd-class-prefix nil nil org-html-todo-kwd-class-prefix)
  148. (:html-toplevel-hlevel nil nil org-html-toplevel-hlevel)
  149. (:html-use-infojs nil nil org-html-use-infojs)
  150. (:html-validation-link nil nil org-html-validation-link)
  151. (:html-viewport nil nil org-html-viewport)
  152. (:html-inline-images nil nil org-html-inline-images)
  153. (:html-table-attributes nil nil org-html-table-default-attributes)
  154. (:html-table-row-open-tag nil nil org-html-table-row-open-tag)
  155. (:html-table-row-close-tag nil nil org-html-table-row-close-tag)
  156. (:html-xml-declaration nil nil org-html-xml-declaration)
  157. (:html-klipsify-src nil nil org-html-klipsify-src)
  158. (:html-klipse-css nil nil org-html-klipse-css)
  159. (:html-klipse-js nil nil org-html-klipse-js)
  160. (:html-klipse-selection-script nil nil org-html-klipse-selection-script)
  161. (:infojs-opt "INFOJS_OPT" nil nil)
  162. ;; Redefine regular options.
  163. (:creator "CREATOR" nil org-html-creator-string)
  164. (:with-latex nil "tex" org-html-with-latex)
  165. ;; Retrieve LaTeX header for fragments.
  166. (:latex-header "LATEX_HEADER" nil nil newline)))
  167. ;;; Internal Variables
  168. (defvar org-html-format-table-no-css)
  169. (defvar htmlize-buffer-places) ; from htmlize.el
  170. (defvar org-html--pre/postamble-class "status"
  171. "CSS class used for pre/postamble")
  172. (defconst org-html-doctype-alist
  173. '(("html4-strict" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"
  174. \"http://www.w3.org/TR/html4/strict.dtd\">")
  175. ("html4-transitional" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\"
  176. \"http://www.w3.org/TR/html4/loose.dtd\">")
  177. ("html4-frameset" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Frameset//EN\"
  178. \"http://www.w3.org/TR/html4/frameset.dtd\">")
  179. ("xhtml-strict" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
  180. \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">")
  181. ("xhtml-transitional" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"
  182. \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">")
  183. ("xhtml-frameset" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Frameset//EN\"
  184. \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd\">")
  185. ("xhtml-11" . "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\"
  186. \"http://www.w3.org/TR/xhtml1/DTD/xhtml11.dtd\">")
  187. ("html5" . "<!DOCTYPE html>")
  188. ("xhtml5" . "<!DOCTYPE html>"))
  189. "An alist mapping (x)html flavors to specific doctypes.")
  190. (defconst org-html-html5-elements
  191. '("article" "aside" "audio" "canvas" "details" "figcaption"
  192. "figure" "footer" "header" "menu" "meter" "nav" "output"
  193. "progress" "section" "summary" "video")
  194. "New elements in html5.
  195. For blocks that should contain headlines, use the HTML_CONTAINER
  196. property on the headline itself.")
  197. (defconst org-html-special-string-regexps
  198. '(("\\\\-" . "&#x00ad;") ; shy
  199. ("---\\([^-]\\)" . "&#x2014;\\1") ; mdash
  200. ("--\\([^-]\\)" . "&#x2013;\\1") ; ndash
  201. ("\\.\\.\\." . "&#x2026;")) ; hellip
  202. "Regular expressions for special string conversion.")
  203. (defconst org-html-scripts
  204. "<script type=\"text/javascript\">
  205. /*
  206. @licstart The following is the entire license notice for the
  207. JavaScript code in this tag.
  208. Copyright (C) 2012-2018 Free Software Foundation, Inc.
  209. The JavaScript code in this tag is free software: you can
  210. redistribute it and/or modify it under the terms of the GNU
  211. General Public License (GNU GPL) as published by the Free Software
  212. Foundation, either version 3 of the License, or (at your option)
  213. any later version. The code is distributed WITHOUT ANY WARRANTY;
  214. without even the implied warranty of MERCHANTABILITY or FITNESS
  215. FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
  216. As additional permission under GNU GPL version 3 section 7, you
  217. may distribute non-source (e.g., minimized or compacted) forms of
  218. that code without the copy of the GNU GPL normally required by
  219. section 4, provided you include this license notice and a URL
  220. through which recipients can access the Corresponding Source.
  221. @licend The above is the entire license notice
  222. for the JavaScript code in this tag.
  223. */
  224. <!--/*--><![CDATA[/*><!--*/
  225. function CodeHighlightOn(elem, id)
  226. {
  227. var target = document.getElementById(id);
  228. if(null != target) {
  229. elem.cacheClassElem = elem.className;
  230. elem.cacheClassTarget = target.className;
  231. target.className = \"code-highlighted\";
  232. elem.className = \"code-highlighted\";
  233. }
  234. }
  235. function CodeHighlightOff(elem, id)
  236. {
  237. var target = document.getElementById(id);
  238. if(elem.cacheClassElem)
  239. elem.className = elem.cacheClassElem;
  240. if(elem.cacheClassTarget)
  241. target.className = elem.cacheClassTarget;
  242. }
  243. /*]]>*///-->
  244. </script>"
  245. "Basic JavaScript that is needed by HTML files produced by Org mode.")
  246. (defconst org-html-style-default
  247. "<style type=\"text/css\">
  248. <!--/*--><![CDATA[/*><!--*/
  249. .title { text-align: center;
  250. margin-bottom: .2em; }
  251. .subtitle { text-align: center;
  252. font-size: medium;
  253. font-weight: bold;
  254. margin-top:0; }
  255. .todo { font-family: monospace; color: red; }
  256. .done { font-family: monospace; color: green; }
  257. .priority { font-family: monospace; color: orange; }
  258. .tag { background-color: #eee; font-family: monospace;
  259. padding: 2px; font-size: 80%; font-weight: normal; }
  260. .timestamp { color: #bebebe; }
  261. .timestamp-kwd { color: #5f9ea0; }
  262. .org-right { margin-left: auto; margin-right: 0px; text-align: right; }
  263. .org-left { margin-left: 0px; margin-right: auto; text-align: left; }
  264. .org-center { margin-left: auto; margin-right: auto; text-align: center; }
  265. .underline { text-decoration: underline; }
  266. #postamble p, #preamble p { font-size: 90%; margin: .2em; }
  267. p.verse { margin-left: 3%; }
  268. pre {
  269. border: 1px solid #ccc;
  270. box-shadow: 3px 3px 3px #eee;
  271. padding: 8pt;
  272. font-family: monospace;
  273. overflow: auto;
  274. margin: 1.2em;
  275. }
  276. pre.src {
  277. position: relative;
  278. overflow: visible;
  279. padding-top: 1.2em;
  280. }
  281. pre.src:before {
  282. display: none;
  283. position: absolute;
  284. background-color: white;
  285. top: -10px;
  286. right: 10px;
  287. padding: 3px;
  288. border: 1px solid black;
  289. }
  290. pre.src:hover:before { display: inline;}
  291. /* Languages per Org manual */
  292. pre.src-asymptote:before { content: 'Asymptote'; }
  293. pre.src-awk:before { content: 'Awk'; }
  294. pre.src-C:before { content: 'C'; }
  295. /* pre.src-C++ doesn't work in CSS */
  296. pre.src-clojure:before { content: 'Clojure'; }
  297. pre.src-css:before { content: 'CSS'; }
  298. pre.src-D:before { content: 'D'; }
  299. pre.src-ditaa:before { content: 'ditaa'; }
  300. pre.src-dot:before { content: 'Graphviz'; }
  301. pre.src-calc:before { content: 'Emacs Calc'; }
  302. pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
  303. pre.src-fortran:before { content: 'Fortran'; }
  304. pre.src-gnuplot:before { content: 'gnuplot'; }
  305. pre.src-haskell:before { content: 'Haskell'; }
  306. pre.src-hledger:before { content: 'hledger'; }
  307. pre.src-java:before { content: 'Java'; }
  308. pre.src-js:before { content: 'Javascript'; }
  309. pre.src-latex:before { content: 'LaTeX'; }
  310. pre.src-ledger:before { content: 'Ledger'; }
  311. pre.src-lisp:before { content: 'Lisp'; }
  312. pre.src-lilypond:before { content: 'Lilypond'; }
  313. pre.src-lua:before { content: 'Lua'; }
  314. pre.src-matlab:before { content: 'MATLAB'; }
  315. pre.src-mscgen:before { content: 'Mscgen'; }
  316. pre.src-ocaml:before { content: 'Objective Caml'; }
  317. pre.src-octave:before { content: 'Octave'; }
  318. pre.src-org:before { content: 'Org mode'; }
  319. pre.src-oz:before { content: 'OZ'; }
  320. pre.src-plantuml:before { content: 'Plantuml'; }
  321. pre.src-processing:before { content: 'Processing.js'; }
  322. pre.src-python:before { content: 'Python'; }
  323. pre.src-R:before { content: 'R'; }
  324. pre.src-ruby:before { content: 'Ruby'; }
  325. pre.src-sass:before { content: 'Sass'; }
  326. pre.src-scheme:before { content: 'Scheme'; }
  327. pre.src-screen:before { content: 'Gnu Screen'; }
  328. pre.src-sed:before { content: 'Sed'; }
  329. pre.src-sh:before { content: 'shell'; }
  330. pre.src-sql:before { content: 'SQL'; }
  331. pre.src-sqlite:before { content: 'SQLite'; }
  332. /* additional languages in org.el's org-babel-load-languages alist */
  333. pre.src-forth:before { content: 'Forth'; }
  334. pre.src-io:before { content: 'IO'; }
  335. pre.src-J:before { content: 'J'; }
  336. pre.src-makefile:before { content: 'Makefile'; }
  337. pre.src-maxima:before { content: 'Maxima'; }
  338. pre.src-perl:before { content: 'Perl'; }
  339. pre.src-picolisp:before { content: 'Pico Lisp'; }
  340. pre.src-scala:before { content: 'Scala'; }
  341. pre.src-shell:before { content: 'Shell Script'; }
  342. pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
  343. /* additional language identifiers per \"defun org-babel-execute\"
  344. in ob-*.el */
  345. pre.src-cpp:before { content: 'C++'; }
  346. pre.src-abc:before { content: 'ABC'; }
  347. pre.src-coq:before { content: 'Coq'; }
  348. pre.src-groovy:before { content: 'Groovy'; }
  349. /* additional language identifiers from org-babel-shell-names in
  350. ob-shell.el: ob-shell is the only babel language using a lambda to put
  351. the execution function name together. */
  352. pre.src-bash:before { content: 'bash'; }
  353. pre.src-csh:before { content: 'csh'; }
  354. pre.src-ash:before { content: 'ash'; }
  355. pre.src-dash:before { content: 'dash'; }
  356. pre.src-ksh:before { content: 'ksh'; }
  357. pre.src-mksh:before { content: 'mksh'; }
  358. pre.src-posh:before { content: 'posh'; }
  359. /* Additional Emacs modes also supported by the LaTeX listings package */
  360. pre.src-ada:before { content: 'Ada'; }
  361. pre.src-asm:before { content: 'Assembler'; }
  362. pre.src-caml:before { content: 'Caml'; }
  363. pre.src-delphi:before { content: 'Delphi'; }
  364. pre.src-html:before { content: 'HTML'; }
  365. pre.src-idl:before { content: 'IDL'; }
  366. pre.src-mercury:before { content: 'Mercury'; }
  367. pre.src-metapost:before { content: 'MetaPost'; }
  368. pre.src-modula-2:before { content: 'Modula-2'; }
  369. pre.src-pascal:before { content: 'Pascal'; }
  370. pre.src-ps:before { content: 'PostScript'; }
  371. pre.src-prolog:before { content: 'Prolog'; }
  372. pre.src-simula:before { content: 'Simula'; }
  373. pre.src-tcl:before { content: 'tcl'; }
  374. pre.src-tex:before { content: 'TeX'; }
  375. pre.src-plain-tex:before { content: 'Plain TeX'; }
  376. pre.src-verilog:before { content: 'Verilog'; }
  377. pre.src-vhdl:before { content: 'VHDL'; }
  378. pre.src-xml:before { content: 'XML'; }
  379. pre.src-nxml:before { content: 'XML'; }
  380. /* add a generic configuration mode; LaTeX export needs an additional
  381. (add-to-list 'org-latex-listings-langs '(conf \" \")) in .emacs */
  382. pre.src-conf:before { content: 'Configuration File'; }
  383. table { border-collapse:collapse; }
  384. caption.t-above { caption-side: top; }
  385. caption.t-bottom { caption-side: bottom; }
  386. td, th { vertical-align:top; }
  387. th.org-right { text-align: center; }
  388. th.org-left { text-align: center; }
  389. th.org-center { text-align: center; }
  390. td.org-right { text-align: right; }
  391. td.org-left { text-align: left; }
  392. td.org-center { text-align: center; }
  393. dt { font-weight: bold; }
  394. .footpara { display: inline; }
  395. .footdef { margin-bottom: 1em; }
  396. .figure { padding: 1em; }
  397. .figure p { text-align: center; }
  398. .equation-container {
  399. display: table;
  400. text-align: center;
  401. width: 100%;
  402. }
  403. .equation {
  404. vertical-align: middle;
  405. }
  406. .equation-label {
  407. display: table-cell;
  408. text-align: right;
  409. vertical-align: middle;
  410. }
  411. .inlinetask {
  412. padding: 10px;
  413. border: 2px solid gray;
  414. margin: 10px;
  415. background: #ffffcc;
  416. }
  417. #org-div-home-and-up
  418. { text-align: right; font-size: 70%; white-space: nowrap; }
  419. textarea { overflow-x: auto; }
  420. .linenr { font-size: smaller }
  421. .code-highlighted { background-color: #ffff00; }
  422. .org-info-js_info-navigation { border-style: none; }
  423. #org-info-js_console-label
  424. { font-size: 10px; font-weight: bold; white-space: nowrap; }
  425. .org-info-js_search-highlight
  426. { background-color: #ffff00; color: #000000; font-weight: bold; }
  427. .org-svg { width: 90%; }
  428. /*]]>*/-->
  429. </style>"
  430. "The default style specification for exported HTML files.
  431. You can use `org-html-head' and `org-html-head-extra' to add to
  432. this style. If you don't want to include this default style,
  433. customize `org-html-head-include-default-style'.")
  434. ;;; User Configuration Variables
  435. (defgroup org-export-html nil
  436. "Options for exporting Org mode files to HTML."
  437. :tag "Org Export HTML"
  438. :group 'org-export)
  439. ;;;; Handle infojs
  440. (defvar org-html-infojs-opts-table
  441. '((path PATH "https://orgmode.org/org-info.js")
  442. (view VIEW "info")
  443. (toc TOC :with-toc)
  444. (ftoc FIXED_TOC "0")
  445. (tdepth TOC_DEPTH "max")
  446. (sdepth SECTION_DEPTH "max")
  447. (mouse MOUSE_HINT "underline")
  448. (buttons VIEW_BUTTONS "0")
  449. (ltoc LOCAL_TOC "1")
  450. (up LINK_UP :html-link-up)
  451. (home LINK_HOME :html-link-home))
  452. "JavaScript options, long form for script, default values.")
  453. (defcustom org-html-use-infojs 'when-configured
  454. "Non-nil when Sebastian Rose's Java Script org-info.js should be active.
  455. This option can be nil or t to never or always use the script.
  456. It can also be the symbol `when-configured', meaning that the
  457. script will be linked into the export file if and only if there
  458. is a \"#+INFOJS_OPT:\" line in the buffer. See also the variable
  459. `org-html-infojs-options'."
  460. :group 'org-export-html
  461. :version "24.4"
  462. :package-version '(Org . "8.0")
  463. :type '(choice
  464. (const :tag "Never" nil)
  465. (const :tag "When configured in buffer" when-configured)
  466. (const :tag "Always" t)))
  467. (defcustom org-html-infojs-options
  468. (mapcar (lambda (x) (cons (car x) (nth 2 x))) org-html-infojs-opts-table)
  469. "Options settings for the INFOJS JavaScript.
  470. Each of the options must have an entry in `org-html-infojs-opts-table'.
  471. The value can either be a string that will be passed to the script, or
  472. a property. This property is then assumed to be a property that is defined
  473. by the Export/Publishing setup of Org.
  474. The `sdepth' and `tdepth' parameters can also be set to \"max\", which
  475. means to use the maximum value consistent with other options."
  476. :group 'org-export-html
  477. :version "24.4"
  478. :package-version '(Org . "8.0")
  479. :type
  480. `(set :greedy t :inline t
  481. ,@(mapcar
  482. (lambda (x)
  483. (list 'cons (list 'const (car x))
  484. '(choice
  485. (symbol :tag "Publishing/Export property")
  486. (string :tag "Value"))))
  487. org-html-infojs-opts-table)))
  488. (defcustom org-html-infojs-template
  489. "<script type=\"text/javascript\" src=\"%SCRIPT_PATH\">
  490. /**
  491. *
  492. * @source: %SCRIPT_PATH
  493. *
  494. * @licstart The following is the entire license notice for the
  495. * JavaScript code in %SCRIPT_PATH.
  496. *
  497. * Copyright (C) 2012-2018 Free Software Foundation, Inc.
  498. *
  499. *
  500. * The JavaScript code in this tag is free software: you can
  501. * redistribute it and/or modify it under the terms of the GNU
  502. * General Public License (GNU GPL) as published by the Free Software
  503. * Foundation, either version 3 of the License, or (at your option)
  504. * any later version. The code is distributed WITHOUT ANY WARRANTY;
  505. * without even the implied warranty of MERCHANTABILITY or FITNESS
  506. * FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
  507. *
  508. * As additional permission under GNU GPL version 3 section 7, you
  509. * may distribute non-source (e.g., minimized or compacted) forms of
  510. * that code without the copy of the GNU GPL normally required by
  511. * section 4, provided you include this license notice and a URL
  512. * through which recipients can access the Corresponding Source.
  513. *
  514. * @licend The above is the entire license notice
  515. * for the JavaScript code in %SCRIPT_PATH.
  516. *
  517. */
  518. </script>
  519. <script type=\"text/javascript\">
  520. /*
  521. @licstart The following is the entire license notice for the
  522. JavaScript code in this tag.
  523. Copyright (C) 2012-2018 Free Software Foundation, Inc.
  524. The JavaScript code in this tag is free software: you can
  525. redistribute it and/or modify it under the terms of the GNU
  526. General Public License (GNU GPL) as published by the Free Software
  527. Foundation, either version 3 of the License, or (at your option)
  528. any later version. The code is distributed WITHOUT ANY WARRANTY;
  529. without even the implied warranty of MERCHANTABILITY or FITNESS
  530. FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
  531. As additional permission under GNU GPL version 3 section 7, you
  532. may distribute non-source (e.g., minimized or compacted) forms of
  533. that code without the copy of the GNU GPL normally required by
  534. section 4, provided you include this license notice and a URL
  535. through which recipients can access the Corresponding Source.
  536. @licend The above is the entire license notice
  537. for the JavaScript code in this tag.
  538. */
  539. <!--/*--><![CDATA[/*><!--*/
  540. %MANAGER_OPTIONS
  541. org_html_manager.setup(); // activate after the parameters are set
  542. /*]]>*///-->
  543. </script>"
  544. "The template for the export style additions when org-info.js is used.
  545. Option settings will replace the %MANAGER-OPTIONS cookie."
  546. :group 'org-export-html
  547. :version "24.4"
  548. :package-version '(Org . "8.0")
  549. :type 'string)
  550. (defun org-html-infojs-install-script (exp-plist _backend)
  551. "Install script in export options when appropriate.
  552. EXP-PLIST is a plist containing export options. BACKEND is the
  553. export back-end currently used."
  554. (unless (or (memq 'body-only (plist-get exp-plist :export-options))
  555. (not (plist-get exp-plist :html-use-infojs))
  556. (and (eq (plist-get exp-plist :html-use-infojs) 'when-configured)
  557. (let ((opt (plist-get exp-plist :infojs-opt)))
  558. (or (not opt)
  559. (string= "" opt)
  560. (string-match "\\<view:nil\\>" opt)))))
  561. (let* ((template (plist-get exp-plist :html-infojs-template))
  562. (ptoc (plist-get exp-plist :with-toc))
  563. (hlevels (plist-get exp-plist :headline-levels))
  564. (sdepth hlevels)
  565. (tdepth (if (integerp ptoc) (min ptoc hlevels) hlevels))
  566. (options (plist-get exp-plist :infojs-opt))
  567. (infojs-opt (plist-get exp-plist :html-infojs-options))
  568. (table org-html-infojs-opts-table)
  569. style)
  570. (dolist (entry table)
  571. (let* ((opt (car entry))
  572. (var (nth 1 entry))
  573. ;; Compute default values for script option OPT from
  574. ;; `org-html-infojs-options' variable.
  575. (default
  576. (let ((default (cdr (assq opt infojs-opt))))
  577. (if (and (symbolp default) (not (memq default '(t nil))))
  578. (plist-get exp-plist default)
  579. default)))
  580. ;; Value set through INFOJS_OPT keyword has precedence
  581. ;; over the default one.
  582. (val (if (and options
  583. (string-match (format "\\<%s:\\(\\S-+\\)" opt)
  584. options))
  585. (match-string 1 options)
  586. default)))
  587. (pcase opt
  588. (`path (setq template
  589. (replace-regexp-in-string
  590. "%SCRIPT_PATH" val template t t)))
  591. (`sdepth (when (integerp (read val))
  592. (setq sdepth (min (read val) sdepth))))
  593. (`tdepth (when (integerp (read val))
  594. (setq tdepth (min (read val) tdepth))))
  595. (_ (setq val
  596. (cond
  597. ((or (eq val t) (equal val "t")) "1")
  598. ((or (eq val nil) (equal val "nil")) "0")
  599. ((stringp val) val)
  600. (t (format "%s" val))))
  601. (push (cons var val) style)))))
  602. ;; Now we set the depth of the *generated* TOC to SDEPTH,
  603. ;; because the toc will actually determine the splitting. How
  604. ;; much of the toc will actually be displayed is governed by the
  605. ;; TDEPTH option.
  606. (setq exp-plist (plist-put exp-plist :with-toc sdepth))
  607. ;; The table of contents should not show more sections than we
  608. ;; generate.
  609. (setq tdepth (min tdepth sdepth))
  610. (push (cons "TOC_DEPTH" tdepth) style)
  611. ;; Build style string.
  612. (setq style (mapconcat
  613. (lambda (x)
  614. (format "org_html_manager.set(\"%s\", \"%s\");"
  615. (car x) (cdr x)))
  616. style "\n"))
  617. (when (and style (> (length style) 0))
  618. (and (string-match "%MANAGER_OPTIONS" template)
  619. (setq style (replace-match style t t template))
  620. (setq exp-plist
  621. (plist-put
  622. exp-plist :html-head-extra
  623. (concat (or (plist-get exp-plist :html-head-extra) "")
  624. "\n"
  625. style)))))
  626. ;; This script absolutely needs the table of contents, so we
  627. ;; change that setting.
  628. (unless (plist-get exp-plist :with-toc)
  629. (setq exp-plist (plist-put exp-plist :with-toc t)))
  630. ;; Return the modified property list.
  631. exp-plist)))
  632. ;;;; Bold, etc.
  633. (defcustom org-html-text-markup-alist
  634. '((bold . "<b>%s</b>")
  635. (code . "<code>%s</code>")
  636. (italic . "<i>%s</i>")
  637. (strike-through . "<del>%s</del>")
  638. (underline . "<span class=\"underline\">%s</span>")
  639. (verbatim . "<code>%s</code>"))
  640. "Alist of HTML expressions to convert text markup.
  641. The key must be a symbol among `bold', `code', `italic',
  642. `strike-through', `underline' and `verbatim'. The value is
  643. a formatting string to wrap fontified text with.
  644. If no association can be found for a given markup, text will be
  645. returned as-is."
  646. :group 'org-export-html
  647. :version "24.4"
  648. :package-version '(Org . "8.0")
  649. :type '(alist :key-type (symbol :tag "Markup type")
  650. :value-type (string :tag "Format string"))
  651. :options '(bold code italic strike-through underline verbatim))
  652. (defcustom org-html-indent nil
  653. "Non-nil means to indent the generated HTML.
  654. Warning: non-nil may break indentation of source code blocks."
  655. :group 'org-export-html
  656. :version "24.4"
  657. :package-version '(Org . "8.0")
  658. :type 'boolean)
  659. ;;;; Drawers
  660. (defcustom org-html-format-drawer-function (lambda (_name contents) contents)
  661. "Function called to format a drawer in HTML code.
  662. The function must accept two parameters:
  663. NAME the drawer name, like \"LOGBOOK\"
  664. CONTENTS the contents of the drawer.
  665. The function should return the string to be exported.
  666. For example, the variable could be set to the following function
  667. in order to mimic default behavior:
  668. The default value simply returns the value of CONTENTS."
  669. :group 'org-export-html
  670. :version "24.4"
  671. :package-version '(Org . "8.0")
  672. :type 'function)
  673. ;;;; Footnotes
  674. (defcustom org-html-footnotes-section "<div id=\"footnotes\">
  675. <h2 class=\"footnotes\">%s: </h2>
  676. <div id=\"text-footnotes\">
  677. %s
  678. </div>
  679. </div>"
  680. "Format for the footnotes section.
  681. Should contain a two instances of %s. The first will be replaced with the
  682. language-specific word for \"Footnotes\", the second one will be replaced
  683. by the footnotes themselves."
  684. :group 'org-export-html
  685. :type 'string)
  686. (defcustom org-html-footnote-format "<sup>%s</sup>"
  687. "The format for the footnote reference.
  688. %s will be replaced by the footnote reference itself."
  689. :group 'org-export-html
  690. :type 'string)
  691. (defcustom org-html-footnote-separator "<sup>, </sup>"
  692. "Text used to separate footnotes."
  693. :group 'org-export-html
  694. :type 'string)
  695. ;;;; Headline
  696. (defcustom org-html-toplevel-hlevel 2
  697. "The <H> level for level 1 headings in HTML export.
  698. This is also important for the classes that will be wrapped around headlines
  699. and outline structure. If this variable is 1, the top-level headlines will
  700. be <h1>, and the corresponding classes will be outline-1, section-number-1,
  701. and outline-text-1. If this is 2, all of these will get a 2 instead.
  702. The default for this variable is 2, because we use <h1> for formatting the
  703. document title."
  704. :group 'org-export-html
  705. :type 'integer)
  706. (defcustom org-html-format-headline-function
  707. 'org-html-format-headline-default-function
  708. "Function to format headline text.
  709. This function will be called with six arguments:
  710. TODO the todo keyword (string or nil).
  711. TODO-TYPE the type of todo (symbol: `todo', `done', nil)
  712. PRIORITY the priority of the headline (integer or nil)
  713. TEXT the main headline text (string).
  714. TAGS the tags (string or nil).
  715. INFO the export options (plist).
  716. The function result will be used in the section format string."
  717. :group 'org-export-html
  718. :version "26.1"
  719. :package-version '(Org . "8.3")
  720. :type 'function)
  721. ;;;; HTML-specific
  722. (defcustom org-html-allow-name-attribute-in-anchors nil
  723. "When nil, do not set \"name\" attribute in anchors.
  724. By default, when appropriate, anchors are formatted with \"id\"
  725. but without \"name\" attribute."
  726. :group 'org-export-html
  727. :version "24.4"
  728. :package-version '(Org . "8.0")
  729. :type 'boolean)
  730. ;;;; Inlinetasks
  731. (defcustom org-html-format-inlinetask-function
  732. 'org-html-format-inlinetask-default-function
  733. "Function called to format an inlinetask in HTML code.
  734. The function must accept seven parameters:
  735. TODO the todo keyword, as a string
  736. TODO-TYPE the todo type, a symbol among `todo', `done' and nil.
  737. PRIORITY the inlinetask priority, as a string
  738. NAME the inlinetask name, as a string.
  739. TAGS the inlinetask tags, as a list of strings.
  740. CONTENTS the contents of the inlinetask, as a string.
  741. INFO the export options, as a plist
  742. The function should return the string to be exported."
  743. :group 'org-export-html
  744. :version "26.1"
  745. :package-version '(Org . "8.3")
  746. :type 'function)
  747. ;;;; LaTeX
  748. (defcustom org-html-with-latex org-export-with-latex
  749. "Non-nil means process LaTeX math snippets.
  750. When set, the exporter will process LaTeX environments and
  751. fragments.
  752. This option can also be set with the +OPTIONS line,
  753. e.g. \"tex:mathjax\". Allowed values are:
  754. nil Ignore math snippets.
  755. `verbatim' Keep everything in verbatim
  756. `mathjax', t Do MathJax preprocessing and arrange for MathJax.js to
  757. be loaded.
  758. SYMBOL Any symbol defined in `org-preview-latex-process-alist',
  759. e.g., `dvipng'."
  760. :group 'org-export-html
  761. :version "24.4"
  762. :package-version '(Org . "8.0")
  763. :type '(choice
  764. (const :tag "Do not process math in any way" nil)
  765. (const :tag "Leave math verbatim" verbatim)
  766. (const :tag "Use MathJax to display math" mathjax)
  767. (symbol :tag "Convert to image to display math" :value dvipng)))
  768. ;;;; Links :: Generic
  769. (defcustom org-html-link-org-files-as-html t
  770. "Non-nil means make file links to `file.org' point to `file.html'.
  771. When `org-mode' is exporting an `org-mode' file to HTML, links to
  772. non-html files are directly put into a href tag in HTML.
  773. However, links to other Org files (recognized by the extension
  774. \".org\") should become links to the corresponding HTML
  775. file, assuming that the linked `org-mode' file will also be
  776. converted to HTML.
  777. When nil, the links still point to the plain \".org\" file."
  778. :group 'org-export-html
  779. :type 'boolean)
  780. ;;;; Links :: Inline images
  781. (defcustom org-html-inline-images t
  782. "Non-nil means inline images into exported HTML pages.
  783. This is done using an <img> tag. When nil, an anchor with href is used to
  784. link to the image."
  785. :group 'org-export-html
  786. :version "24.4"
  787. :package-version '(Org . "8.1")
  788. :type 'boolean)
  789. (defcustom org-html-inline-image-rules
  790. '(("file" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'")
  791. ("http" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'")
  792. ("https" . "\\.\\(jpeg\\|jpg\\|png\\|gif\\|svg\\)\\'"))
  793. "Rules characterizing image files that can be inlined into HTML.
  794. A rule consists in an association whose key is the type of link
  795. to consider, and value is a regexp that will be matched against
  796. link's path."
  797. :group 'org-export-html
  798. :version "24.4"
  799. :package-version '(Org . "8.0")
  800. :type '(alist :key-type (string :tag "Type")
  801. :value-type (regexp :tag "Path")))
  802. ;;;; Plain Text
  803. (defvar org-html-protect-char-alist
  804. '(("&" . "&amp;")
  805. ("<" . "&lt;")
  806. (">" . "&gt;"))
  807. "Alist of characters to be converted by `org-html-encode-plain-text'.")
  808. ;;;; Src Block
  809. (defcustom org-html-htmlize-output-type 'inline-css
  810. "Output type to be used by htmlize when formatting code snippets.
  811. Choices are `css' to export the CSS selectors only,`inline-css'
  812. to export the CSS attribute values inline in the HTML or `nil' to
  813. export plain text. We use as default `inline-css', in order to
  814. make the resulting HTML self-containing.
  815. However, this will fail when using Emacs in batch mode for export, because
  816. then no rich font definitions are in place. It will also not be good if
  817. people with different Emacs setup contribute HTML files to a website,
  818. because the fonts will represent the individual setups. In these cases,
  819. it is much better to let Org/Htmlize assign classes only, and to use
  820. a style file to define the look of these classes.
  821. To get a start for your css file, start Emacs session and make sure that
  822. all the faces you are interested in are defined, for example by loading files
  823. in all modes you want. Then, use the command
  824. `\\[org-html-htmlize-generate-css]' to extract class definitions."
  825. :group 'org-export-html
  826. :type '(choice (const css) (const inline-css) (const nil)))
  827. (defcustom org-html-htmlize-font-prefix "org-"
  828. "The prefix for CSS class names for htmlize font specifications."
  829. :group 'org-export-html
  830. :type 'string)
  831. ;;;; Table
  832. (defcustom org-html-table-default-attributes
  833. '(:border "2" :cellspacing "0" :cellpadding "6" :rules "groups" :frame "hsides")
  834. "Default attributes and values which will be used in table tags.
  835. This is a plist where attributes are symbols, starting with
  836. colons, and values are strings.
  837. When exporting to HTML5, these values will be disregarded."
  838. :group 'org-export-html
  839. :version "24.4"
  840. :package-version '(Org . "8.0")
  841. :type '(plist :key-type (symbol :tag "Property")
  842. :value-type (string :tag "Value")))
  843. (defcustom org-html-table-header-tags '("<th scope=\"%s\"%s>" . "</th>")
  844. "The opening and ending tags for table header fields.
  845. This is customizable so that alignment options can be specified.
  846. The first %s will be filled with the scope of the field, either row or col.
  847. The second %s will be replaced by a style entry to align the field.
  848. See also the variable `org-html-table-use-header-tags-for-first-column'.
  849. See also the variable `org-html-table-align-individual-fields'."
  850. :group 'org-export-html
  851. :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
  852. (defcustom org-html-table-data-tags '("<td%s>" . "</td>")
  853. "The opening and ending tags for table data fields.
  854. This is customizable so that alignment options can be specified.
  855. The first %s will be filled with the scope of the field, either row or col.
  856. The second %s will be replaced by a style entry to align the field.
  857. See also the variable `org-html-table-align-individual-fields'."
  858. :group 'org-export-html
  859. :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
  860. (defcustom org-html-table-row-open-tag "<tr>"
  861. "The opening tag for table rows.
  862. This is customizable so that alignment options can be specified.
  863. Instead of strings, these can be a Lisp function that will be
  864. evaluated for each row in order to construct the table row tags.
  865. The function will be called with these arguments:
  866. `number': row number (0 is the first row)
  867. `group-number': group number of current row
  868. `start-group?': non-nil means the row starts a group
  869. `end-group?': non-nil means the row ends a group
  870. `top?': non-nil means this is the top row
  871. `bottom?': non-nil means this is the bottom row
  872. For example:
  873. (setq org-html-table-row-open-tag
  874. (lambda (number group-number start-group? end-group-p top? bottom?)
  875. (cond (top? \"<tr class=\\\"tr-top\\\">\")
  876. (bottom? \"<tr class=\\\"tr-bottom\\\">\")
  877. (t (if (= (mod number 2) 1)
  878. \"<tr class=\\\"tr-odd\\\">\"
  879. \"<tr class=\\\"tr-even\\\">\")))))
  880. will use the \"tr-top\" and \"tr-bottom\" classes for the top row
  881. and the bottom row, and otherwise alternate between \"tr-odd\" and
  882. \"tr-even\" for odd and even rows."
  883. :group 'org-export-html
  884. :type '(choice :tag "Opening tag"
  885. (string :tag "Specify")
  886. (function)))
  887. (defcustom org-html-table-row-close-tag "</tr>"
  888. "The closing tag for table rows.
  889. This is customizable so that alignment options can be specified.
  890. Instead of strings, this can be a Lisp function that will be
  891. evaluated for each row in order to construct the table row tags.
  892. See documentation of `org-html-table-row-open-tag'."
  893. :group 'org-export-html
  894. :type '(choice :tag "Closing tag"
  895. (string :tag "Specify")
  896. (function)))
  897. (defcustom org-html-table-align-individual-fields t
  898. "Non-nil means attach style attributes for alignment to each table field.
  899. When nil, alignment will only be specified in the column tags, but this
  900. is ignored by some browsers (like Firefox, Safari). Opera does it right
  901. though."
  902. :group 'org-export-html
  903. :type 'boolean)
  904. (defcustom org-html-table-use-header-tags-for-first-column nil
  905. "Non-nil means format column one in tables with header tags.
  906. When nil, also column one will use data tags."
  907. :group 'org-export-html
  908. :type 'boolean)
  909. (defcustom org-html-table-caption-above t
  910. "When non-nil, place caption string at the beginning of the table.
  911. Otherwise, place it near the end."
  912. :group 'org-export-html
  913. :type 'boolean)
  914. ;;;; Tags
  915. (defcustom org-html-tag-class-prefix ""
  916. "Prefix to class names for TODO keywords.
  917. Each tag gets a class given by the tag itself, with this prefix.
  918. The default prefix is empty because it is nice to just use the keyword
  919. as a class name. But if you get into conflicts with other, existing
  920. CSS classes, then this prefix can be very useful."
  921. :group 'org-export-html
  922. :type 'string)
  923. ;;;; Template :: Generic
  924. (defcustom org-html-extension "html"
  925. "The extension for exported HTML files."
  926. :group 'org-export-html
  927. :type 'string)
  928. (defcustom org-html-xml-declaration
  929. '(("html" . "<?xml version=\"1.0\" encoding=\"%s\"?>")
  930. ("php" . "<?php echo \"<?xml version=\\\"1.0\\\" encoding=\\\"%s\\\" ?>\"; ?>"))
  931. "The extension for exported HTML files.
  932. %s will be replaced with the charset of the exported file.
  933. This may be a string, or an alist with export extensions
  934. and corresponding declarations.
  935. This declaration only applies when exporting to XHTML."
  936. :group 'org-export-html
  937. :type '(choice
  938. (string :tag "Single declaration")
  939. (repeat :tag "Dependent on extension"
  940. (cons (string :tag "Extension")
  941. (string :tag "Declaration")))))
  942. (defcustom org-html-coding-system 'utf-8
  943. "Coding system for HTML export.
  944. Use utf-8 as the default value."
  945. :group 'org-export-html
  946. :version "24.4"
  947. :package-version '(Org . "8.0")
  948. :type 'coding-system)
  949. (defcustom org-html-doctype "xhtml-strict"
  950. "Document type definition to use for exported HTML files.
  951. Can be set with the in-buffer HTML_DOCTYPE property or for
  952. publishing, with :html-doctype."
  953. :group 'org-export-html
  954. :version "24.4"
  955. :package-version '(Org . "8.0")
  956. :type (append
  957. '(choice)
  958. (mapcar (lambda (x) `(const ,(car x))) org-html-doctype-alist)
  959. '((string :tag "Custom doctype" ))))
  960. (defcustom org-html-html5-fancy nil
  961. "Non-nil means using new HTML5 elements.
  962. This variable is ignored for anything other than HTML5 export.
  963. For compatibility with Internet Explorer, it's probably a good
  964. idea to download some form of the html5shiv (for instance
  965. https://code.google.com/p/html5shiv/) and add it to your
  966. HTML_HEAD_EXTRA, so that your pages don't break for users of IE
  967. versions 8 and below."
  968. :group 'org-export-html
  969. :version "24.4"
  970. :package-version '(Org . "8.0")
  971. :type 'boolean)
  972. (defcustom org-html-container-element "div"
  973. "HTML element to use for wrapping top level sections.
  974. Can be set with the in-buffer HTML_CONTAINER property or for
  975. publishing, with :html-container.
  976. Note that changing the default will prevent you from using
  977. org-info.js for your website."
  978. :group 'org-export-html
  979. :version "24.4"
  980. :package-version '(Org . "8.0")
  981. :type 'string)
  982. (defcustom org-html-divs
  983. '((preamble "div" "preamble")
  984. (content "div" "content")
  985. (postamble "div" "postamble"))
  986. "Alist of the three section elements for HTML export.
  987. The car of each entry is one of `preamble', `content' or `postamble'.
  988. The cdrs of each entry are the ELEMENT_TYPE and ID for each
  989. section of the exported document.
  990. Note that changing the default will prevent you from using
  991. org-info.js for your website."
  992. :group 'org-export-html
  993. :version "24.4"
  994. :package-version '(Org . "8.0")
  995. :type '(list :greedy t
  996. (list :tag "Preamble"
  997. (const :format "" preamble)
  998. (string :tag "element") (string :tag " id"))
  999. (list :tag "Content"
  1000. (const :format "" content)
  1001. (string :tag "element") (string :tag " id"))
  1002. (list :tag "Postamble" (const :format "" postamble)
  1003. (string :tag " id") (string :tag "element"))))
  1004. (defconst org-html-checkbox-types
  1005. '((unicode .
  1006. ((on . "&#x2611;") (off . "&#x2610;") (trans . "&#x2610;")))
  1007. (ascii .
  1008. ((on . "<code>[X]</code>")
  1009. (off . "<code>[&#xa0;]</code>")
  1010. (trans . "<code>[-]</code>")))
  1011. (html .
  1012. ((on . "<input type='checkbox' checked='checked' />")
  1013. (off . "<input type='checkbox' />")
  1014. (trans . "<input type='checkbox' />"))))
  1015. "Alist of checkbox types.
  1016. The cdr of each entry is an alist list three checkbox types for
  1017. HTML export: `on', `off' and `trans'.
  1018. The choices are:
  1019. `unicode' Unicode characters (HTML entities)
  1020. `ascii' ASCII characters
  1021. `html' HTML checkboxes
  1022. Note that only the ascii characters implement tri-state
  1023. checkboxes. The other two use the `off' checkbox for `trans'.")
  1024. (defcustom org-html-checkbox-type 'ascii
  1025. "The type of checkboxes to use for HTML export.
  1026. See `org-html-checkbox-types' for for the values used for each
  1027. option."
  1028. :group 'org-export-html
  1029. :version "24.4"
  1030. :package-version '(Org . "8.0")
  1031. :type '(choice
  1032. (const :tag "ASCII characters" ascii)
  1033. (const :tag "Unicode characters" unicode)
  1034. (const :tag "HTML checkboxes" html)))
  1035. (defcustom org-html-metadata-timestamp-format "%Y-%m-%d %a %H:%M"
  1036. "Format used for timestamps in preamble, postamble and metadata.
  1037. See `format-time-string' for more information on its components."
  1038. :group 'org-export-html
  1039. :version "24.4"
  1040. :package-version '(Org . "8.0")
  1041. :type 'string)
  1042. ;;;; Template :: Mathjax
  1043. (defcustom org-html-mathjax-options
  1044. '((path "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS_HTML" )
  1045. (scale "100")
  1046. (align "center")
  1047. (font "TeX")
  1048. (linebreaks "false")
  1049. (autonumber "AMS")
  1050. (indent "0em")
  1051. (multlinewidth "85%")
  1052. (tagindent ".8em")
  1053. (tagside "right"))
  1054. "Options for MathJax setup.
  1055. Alist of the following elements. All values are strings.
  1056. path The path to MathJax.
  1057. scale Scaling with HTML-CSS, MathML and SVG output engines.
  1058. align How to align display math: left, center, or right.
  1059. font The font to use with HTML-CSS and SVG output. As of MathJax 2.5
  1060. the following values are understood: \"TeX\", \"STIX-Web\",
  1061. \"Asana-Math\", \"Neo-Euler\", \"Gyre-Pagella\",
  1062. \"Gyre-Termes\", and \"Latin-Modern\".
  1063. linebreaks Let MathJax perform automatic linebreaks. Valid values
  1064. are \"true\" and \"false\".
  1065. indent If align is not center, how far from the left/right side?
  1066. Valid values are \"left\" and \"right\"
  1067. multlinewidth The width of the multline environment.
  1068. autonumber How to number equations. Valid values are \"None\",
  1069. \"all\" and \"AMS Math\".
  1070. tagindent The amount tags are indented.
  1071. tagside Which side to show tags/labels on. Valid values are
  1072. \"left\" and \"right\"
  1073. You can also customize this for each buffer, using something like
  1074. #+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
  1075. For further information about MathJax options, see the MathJax documentation:
  1076. http://docs.mathjax.org/"
  1077. :group 'org-export-html
  1078. :package-version '(Org . "8.3")
  1079. :type '(list :greedy t
  1080. (list :tag "path (the path from where to load MathJax.js)"
  1081. (const :format " " path) (string))
  1082. (list :tag "scale (scaling for the displayed math)"
  1083. (const :format " " scale) (string))
  1084. (list :tag "align (alignment of displayed equations)"
  1085. (const :format " " align) (string))
  1086. (list :tag "font (used to display math)"
  1087. (const :format " " font)
  1088. (choice (const "TeX")
  1089. (const "STIX-Web")
  1090. (const "Asana-Math")
  1091. (const "Neo-Euler")
  1092. (const "Gyre-Pagella")
  1093. (const "Gyre-Termes")
  1094. (const "Latin-Modern")))
  1095. (list :tag "linebreaks (automatic line-breaking)"
  1096. (const :format " " linebreaks)
  1097. (choice (const "true")
  1098. (const "false")))
  1099. (list :tag "autonumber (when should equations be numbered)"
  1100. (const :format " " autonumber)
  1101. (choice (const "AMS")
  1102. (const "None")
  1103. (const "All")))
  1104. (list :tag "indent (indentation with left or right alignment)"
  1105. (const :format " " indent) (string))
  1106. (list :tag "multlinewidth (width to use for the multline environment)"
  1107. (const :format " " multlinewidth) (string))
  1108. (list :tag "tagindent (the indentation of tags from left or right)"
  1109. (const :format " " tagindent) (string))
  1110. (list :tag "tagside (location of tags)"
  1111. (const :format " " tagside)
  1112. (choice (const "left")
  1113. (const "right")))))
  1114. (defcustom org-html-mathjax-template
  1115. "<script type=\"text/x-mathjax-config\">
  1116. MathJax.Hub.Config({
  1117. displayAlign: \"%ALIGN\",
  1118. displayIndent: \"%INDENT\",
  1119. \"HTML-CSS\": { scale: %SCALE,
  1120. linebreaks: { automatic: \"%LINEBREAKS\" },
  1121. webFont: \"%FONT\"
  1122. },
  1123. SVG: {scale: %SCALE,
  1124. linebreaks: { automatic: \"%LINEBREAKS\" },
  1125. font: \"%FONT\"},
  1126. NativeMML: {scale: %SCALE},
  1127. TeX: { equationNumbers: {autoNumber: \"%AUTONUMBER\"},
  1128. MultLineWidth: \"%MULTLINEWIDTH\",
  1129. TagSide: \"%TAGSIDE\",
  1130. TagIndent: \"%TAGINDENT\"
  1131. }
  1132. });
  1133. </script>
  1134. <script type=\"text/javascript\"
  1135. src=\"%PATH\"></script>"
  1136. "The MathJax template. See also `org-html-mathjax-options'."
  1137. :group 'org-export-html
  1138. :type 'string)
  1139. ;;;; Template :: Postamble
  1140. (defcustom org-html-postamble 'auto
  1141. "Non-nil means insert a postamble in HTML export.
  1142. When set to `auto', check against the
  1143. `org-export-with-author/email/creator/date' variables to set the
  1144. content of the postamble. When set to a string, use this string
  1145. as the postamble. When t, insert a string as defined by the
  1146. formatting string in `org-html-postamble-format'.
  1147. When set to a function, apply this function and insert the
  1148. returned string. The function takes the property list of export
  1149. options as its only argument.
  1150. Setting :html-postamble in publishing projects will take
  1151. precedence over this variable."
  1152. :group 'org-export-html
  1153. :type '(choice (const :tag "No postamble" nil)
  1154. (const :tag "Auto postamble" auto)
  1155. (const :tag "Default formatting string" t)
  1156. (string :tag "Custom formatting string")
  1157. (function :tag "Function (must return a string)")))
  1158. (defcustom org-html-postamble-format
  1159. '(("en" "<p class=\"author\">Author: %a (%e)</p>
  1160. <p class=\"date\">Date: %d</p>
  1161. <p class=\"creator\">%c</p>
  1162. <p class=\"validation\">%v</p>"))
  1163. "Alist of languages and format strings for the HTML postamble.
  1164. The first element of each list is the language code, as used for
  1165. the LANGUAGE keyword. See `org-export-default-language'.
  1166. The second element of each list is a format string to format the
  1167. postamble itself. This format string can contain these elements:
  1168. %t stands for the title.
  1169. %s stands for the subtitle.
  1170. %a stands for the author's name.
  1171. %e stands for the author's email.
  1172. %d stands for the date.
  1173. %c will be replaced by `org-html-creator-string'.
  1174. %v will be replaced by `org-html-validation-link'.
  1175. %T will be replaced by the export time.
  1176. %C will be replaced by the last modification time.
  1177. If you need to use a \"%\" character, you need to escape it
  1178. like that: \"%%\"."
  1179. :group 'org-export-html
  1180. :type '(repeat
  1181. (list (string :tag "Language")
  1182. (string :tag "Format string"))))
  1183. (defcustom org-html-validation-link
  1184. "<a href=\"http://validator.w3.org/check?uri=referer\">Validate</a>"
  1185. "Link to HTML validation service."
  1186. :group 'org-export-html
  1187. :type 'string)
  1188. (defcustom org-html-creator-string
  1189. (format "<a href=\"https://www.gnu.org/software/emacs/\">Emacs</a> %s (<a href=\"https://orgmode.org\">Org</a> mode %s)"
  1190. emacs-version
  1191. (if (fboundp 'org-version) (org-version) "unknown version"))
  1192. "Information about the creator of the HTML document.
  1193. This option can also be set on with the CREATOR keyword."
  1194. :group 'org-export-html
  1195. :version "24.4"
  1196. :package-version '(Org . "8.0")
  1197. :type '(string :tag "Creator string"))
  1198. ;;;; Template :: Preamble
  1199. (defcustom org-html-preamble t
  1200. "Non-nil means insert a preamble in HTML export.
  1201. When t, insert a string as defined by the formatting string in
  1202. `org-html-preamble-format'. When set to a string, use this
  1203. formatting string instead (see `org-html-postamble-format' for an
  1204. example of such a formatting string).
  1205. When set to a function, apply this function and insert the
  1206. returned string. The function takes the property list of export
  1207. options as its only argument.
  1208. Setting :html-preamble in publishing projects will take
  1209. precedence over this variable."
  1210. :group 'org-export-html
  1211. :type '(choice (const :tag "No preamble" nil)
  1212. (const :tag "Default preamble" t)
  1213. (string :tag "Custom formatting string")
  1214. (function :tag "Function (must return a string)")))
  1215. (defcustom org-html-preamble-format '(("en" ""))
  1216. "Alist of languages and format strings for the HTML preamble.
  1217. The first element of each list is the language code, as used for
  1218. the LANGUAGE keyword. See `org-export-default-language'.
  1219. The second element of each list is a format string to format the
  1220. preamble itself. This format string can contain these elements:
  1221. %t stands for the title.
  1222. %s stands for the subtitle.
  1223. %a stands for the author's name.
  1224. %e stands for the author's email.
  1225. %d stands for the date.
  1226. %c will be replaced by `org-html-creator-string'.
  1227. %v will be replaced by `org-html-validation-link'.
  1228. %T will be replaced by the export time.
  1229. %C will be replaced by the last modification time.
  1230. If you need to use a \"%\" character, you need to escape it
  1231. like that: \"%%\".
  1232. See the default value of `org-html-postamble-format' for an
  1233. example."
  1234. :group 'org-export-html
  1235. :type '(repeat
  1236. (list (string :tag "Language")
  1237. (string :tag "Format string"))))
  1238. (defcustom org-html-link-up ""
  1239. "Where should the \"UP\" link of exported HTML pages lead?"
  1240. :group 'org-export-html
  1241. :type '(string :tag "File or URL"))
  1242. (defcustom org-html-link-home ""
  1243. "Where should the \"HOME\" link of exported HTML pages lead?"
  1244. :group 'org-export-html
  1245. :type '(string :tag "File or URL"))
  1246. (defcustom org-html-link-use-abs-url nil
  1247. "Should we prepend relative links with HTML_LINK_HOME?"
  1248. :group 'org-export-html
  1249. :version "24.4"
  1250. :package-version '(Org . "8.1")
  1251. :type 'boolean)
  1252. (defcustom org-html-home/up-format
  1253. "<div id=\"org-div-home-and-up\">
  1254. <a accesskey=\"h\" href=\"%s\"> UP </a>
  1255. |
  1256. <a accesskey=\"H\" href=\"%s\"> HOME </a>
  1257. </div>"
  1258. "Snippet used to insert the HOME and UP links.
  1259. This is a format string, the first %s will receive the UP link,
  1260. the second the HOME link. If both `org-html-link-up' and
  1261. `org-html-link-home' are empty, the entire snippet will be
  1262. ignored."
  1263. :group 'org-export-html
  1264. :type 'string)
  1265. ;;;; Template :: Scripts
  1266. (defcustom org-html-head-include-scripts t
  1267. "Non-nil means include the JavaScript snippets in exported HTML files.
  1268. The actual script is defined in `org-html-scripts' and should
  1269. not be modified."
  1270. :group 'org-export-html
  1271. :version "24.4"
  1272. :package-version '(Org . "8.0")
  1273. :type 'boolean)
  1274. ;;;; Template :: Styles
  1275. (defcustom org-html-head-include-default-style t
  1276. "Non-nil means include the default style in exported HTML files.
  1277. The actual style is defined in `org-html-style-default' and
  1278. should not be modified. Use `org-html-head' to use your own
  1279. style information."
  1280. :group 'org-export-html
  1281. :version "24.4"
  1282. :package-version '(Org . "8.0")
  1283. :type 'boolean)
  1284. ;;;###autoload
  1285. (put 'org-html-head-include-default-style 'safe-local-variable 'booleanp)
  1286. (defcustom org-html-head ""
  1287. "Org-wide head definitions for exported HTML files.
  1288. This variable can contain the full HTML structure to provide a
  1289. style, including the surrounding HTML tags. You can consider
  1290. including definitions for the following classes: title, todo,
  1291. done, timestamp, timestamp-kwd, tag, target.
  1292. For example, a valid value would be:
  1293. <style type=\"text/css\">
  1294. /*<![CDATA[*/
  1295. p { font-weight: normal; color: gray; }
  1296. h1 { color: black; }
  1297. .title { text-align: center; }
  1298. .todo, .timestamp-kwd { color: red; }
  1299. .done { color: green; }
  1300. /*]]>*/
  1301. </style>
  1302. If you want to refer to an external style, use something like
  1303. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\" />
  1304. As the value of this option simply gets inserted into the HTML
  1305. <head> header, you can use it to add any arbitrary text to the
  1306. header.
  1307. You can set this on a per-file basis using #+HTML_HEAD:,
  1308. or for publication projects using the :html-head property."
  1309. :group 'org-export-html
  1310. :version "24.4"
  1311. :package-version '(Org . "8.0")
  1312. :type 'string)
  1313. ;;;###autoload
  1314. (put 'org-html-head 'safe-local-variable 'stringp)
  1315. (defcustom org-html-head-extra ""
  1316. "More head information to add in the HTML output.
  1317. You can set this on a per-file basis using #+HTML_HEAD_EXTRA:,
  1318. or for publication projects using the :html-head-extra property."
  1319. :group 'org-export-html
  1320. :version "24.4"
  1321. :package-version '(Org . "8.0")
  1322. :type 'string)
  1323. ;;;###autoload
  1324. (put 'org-html-head-extra 'safe-local-variable 'stringp)
  1325. ;;;; Template :: Viewport
  1326. (defcustom org-html-viewport '((width "device-width")
  1327. (initial-scale "1")
  1328. (minimum-scale "")
  1329. (maximum-scale "")
  1330. (user-scalable ""))
  1331. "Viewport options for mobile-optimized sites.
  1332. The following values are recognized
  1333. width Size of the viewport.
  1334. initial-scale Zoom level when the page is first loaded.
  1335. minimum-scale Minimum allowed zoom level.
  1336. maximum-scale Maximum allowed zoom level.
  1337. user-scalable Whether zoom can be changed.
  1338. The viewport meta tag is inserted if this variable is non-nil.
  1339. See the following site for a reference:
  1340. https://developer.mozilla.org/en-US/docs/Mozilla/Mobile/Viewport_meta_tag"
  1341. :group 'org-export-html
  1342. :version "26.1"
  1343. :package-version '(Org . "8.3")
  1344. :type '(choice (const :tag "Disable" nil)
  1345. (list :tag "Enable"
  1346. (list :tag "Width of viewport"
  1347. (const :format " " width)
  1348. (choice (const :tag "unset" "")
  1349. (string)))
  1350. (list :tag "Initial scale"
  1351. (const :format " " initial-scale)
  1352. (choice (const :tag "unset" "")
  1353. (string)))
  1354. (list :tag "Minimum scale/zoom"
  1355. (const :format " " minimum-scale)
  1356. (choice (const :tag "unset" "")
  1357. (string)))
  1358. (list :tag "Maximum scale/zoom"
  1359. (const :format " " maximum-scale)
  1360. (choice (const :tag "unset" "")
  1361. (string)))
  1362. (list :tag "User scalable/zoomable"
  1363. (const :format " " user-scalable)
  1364. (choice (const :tag "unset" "")
  1365. (const "true")
  1366. (const "false"))))))
  1367. ;; Handle source code blocks with Klipse
  1368. (defcustom org-html-klipsify-src nil
  1369. "When non-nil, source code blocks are editable in exported presentation."
  1370. :group 'org-export-html
  1371. :package-version '(Org . "9.1")
  1372. :type 'boolean)
  1373. (defcustom org-html-klipse-css
  1374. "https://storage.googleapis.com/app.klipse.tech/css/codemirror.css"
  1375. "Location of the codemirror CSS file for use with klipse."
  1376. :group 'org-export-html
  1377. :package-version '(Org . "9.1")
  1378. :type 'string)
  1379. (defcustom org-html-klipse-js
  1380. "https://storage.googleapis.com/app.klipse.tech/plugin_prod/js/klipse_plugin.min.js"
  1381. "Location of the klipse javascript file."
  1382. :group 'org-export-html
  1383. :type 'string)
  1384. (defcustom org-html-klipse-selection-script
  1385. "window.klipse_settings = {selector_eval_html: '.src-html',
  1386. selector_eval_js: '.src-js',
  1387. selector_eval_python_client: '.src-python',
  1388. selector_eval_scheme: '.src-scheme',
  1389. selector: '.src-clojure',
  1390. selector_eval_ruby: '.src-ruby'};"
  1391. "Javascript snippet to activate klipse."
  1392. :group 'org-export-html
  1393. :package-version '(Org . "9.1")
  1394. :type 'string)
  1395. ;;;; Todos
  1396. (defcustom org-html-todo-kwd-class-prefix ""
  1397. "Prefix to class names for TODO keywords.
  1398. Each TODO keyword gets a class given by the keyword itself, with this prefix.
  1399. The default prefix is empty because it is nice to just use the keyword
  1400. as a class name. But if you get into conflicts with other, existing
  1401. CSS classes, then this prefix can be very useful."
  1402. :group 'org-export-html
  1403. :type 'string)
  1404. ;;; Internal Functions
  1405. (defun org-html-xhtml-p (info)
  1406. (let ((dt (downcase (plist-get info :html-doctype))))
  1407. (string-match-p "xhtml" dt)))
  1408. (defun org-html-html5-p (info)
  1409. (let ((dt (downcase (plist-get info :html-doctype))))
  1410. (member dt '("html5" "xhtml5" "<!doctype html>"))))
  1411. (defun org-html--html5-fancy-p (info)
  1412. "Non-nil when exporting to HTML5 with fancy elements.
  1413. INFO is the current state of the export process, as a plist."
  1414. (and (plist-get info :html-html5-fancy)
  1415. (org-html-html5-p info)))
  1416. (defun org-html-close-tag (tag attr info)
  1417. "Return close-tag for string TAG.
  1418. ATTR specifies additional attributes. INFO is a property list
  1419. containing current export state."
  1420. (concat "<" tag
  1421. (org-string-nw-p (concat " " attr))
  1422. (if (org-html-xhtml-p info) " />" ">")))
  1423. (defun org-html-doctype (info)
  1424. "Return correct HTML doctype tag.
  1425. INFO is a plist used as a communication channel. Doctype tag is
  1426. extracted from `org-html-doctype-alist', or the literal value
  1427. of :html-doctype from INFO if :html-doctype is not found in the
  1428. alist."
  1429. (let ((dt (plist-get info :html-doctype)))
  1430. (or (cdr (assoc dt org-html-doctype-alist)) dt)))
  1431. (defun org-html--make-attribute-string (attributes)
  1432. "Return a list of attributes, as a string.
  1433. ATTRIBUTES is a plist where values are either strings or nil. An
  1434. attribute with a nil value will be omitted from the result."
  1435. (let (output)
  1436. (dolist (item attributes (mapconcat 'identity (nreverse output) " "))
  1437. (cond ((null item) (pop output))
  1438. ((symbolp item) (push (substring (symbol-name item) 1) output))
  1439. (t (let ((key (car output))
  1440. (value (replace-regexp-in-string
  1441. "\"" "&quot;" (org-html-encode-plain-text item))))
  1442. (setcar output (format "%s=\"%s\"" key value))))))))
  1443. (defun org-html--wrap-image (contents info &optional caption label)
  1444. "Wrap CONTENTS string within an appropriate environment for images.
  1445. INFO is a plist used as a communication channel. When optional
  1446. arguments CAPTION and LABEL are given, use them for caption and
  1447. \"id\" attribute."
  1448. (let ((html5-fancy (org-html--html5-fancy-p info)))
  1449. (format (if html5-fancy "\n<figure%s>\n%s%s\n</figure>"
  1450. "\n<div%s class=\"figure\">\n%s%s\n</div>")
  1451. ;; ID.
  1452. (if (org-string-nw-p label) (format " id=\"%s\"" label) "")
  1453. ;; Contents.
  1454. (if html5-fancy contents (format "<p>%s</p>" contents))
  1455. ;; Caption.
  1456. (if (not (org-string-nw-p caption)) ""
  1457. (format (if html5-fancy "\n<figcaption>%s</figcaption>"
  1458. "\n<p>%s</p>")
  1459. caption)))))
  1460. (defun org-html--format-image (source attributes info)
  1461. "Return \"img\" tag with given SOURCE and ATTRIBUTES.
  1462. SOURCE is a string specifying the location of the image.
  1463. ATTRIBUTES is a plist, as returned by
  1464. `org-export-read-attribute'. INFO is a plist used as
  1465. a communication channel."
  1466. (if (string= "svg" (file-name-extension source))
  1467. (org-html--svg-image source attributes info)
  1468. (org-html-close-tag
  1469. "img"
  1470. (org-html--make-attribute-string
  1471. (org-combine-plists
  1472. (list :src source
  1473. :alt (if (string-match-p "^ltxpng/" source)
  1474. (org-html-encode-plain-text
  1475. (org-find-text-property-in-string 'org-latex-src source))
  1476. (file-name-nondirectory source)))
  1477. attributes))
  1478. info)))
  1479. (defun org-html--svg-image (source attributes info)
  1480. "Return \"object\" embedding svg file SOURCE with given ATTRIBUTES.
  1481. INFO is a plist used as a communication channel.
  1482. The special attribute \"fallback\" can be used to specify a
  1483. fallback image file to use if the object embedding is not
  1484. supported. CSS class \"org-svg\" is assigned as the class of the
  1485. object unless a different class is specified with an attribute."
  1486. (let ((fallback (plist-get attributes :fallback))
  1487. (attrs (org-html--make-attribute-string
  1488. (org-combine-plists
  1489. ;; Remove fallback attribute, which is not meant to
  1490. ;; appear directly in the attributes string, and
  1491. ;; provide a default class if none is set.
  1492. '(:class "org-svg") attributes '(:fallback nil)))))
  1493. (format "<object type=\"image/svg+xml\" data=\"%s\" %s>\n%s</object>"
  1494. source
  1495. attrs
  1496. (if fallback
  1497. (org-html-close-tag
  1498. "img" (format "src=\"%s\" %s" fallback attrs) info)
  1499. "Sorry, your browser does not support SVG."))))
  1500. (defun org-html--textarea-block (element)
  1501. "Transcode ELEMENT into a textarea block.
  1502. ELEMENT is either a source or an example block."
  1503. (let* ((code (car (org-export-unravel-code element)))
  1504. (attr (org-export-read-attribute :attr_html element)))
  1505. (format "<p>\n<textarea cols=\"%s\" rows=\"%s\">\n%s</textarea>\n</p>"
  1506. (or (plist-get attr :width) 80)
  1507. (or (plist-get attr :height) (org-count-lines code))
  1508. code)))
  1509. (defun org-html--has-caption-p (element &optional _info)
  1510. "Non-nil when ELEMENT has a caption affiliated keyword.
  1511. INFO is a plist used as a communication channel. This function
  1512. is meant to be used as a predicate for `org-export-get-ordinal' or
  1513. a value to `org-html-standalone-image-predicate'."
  1514. (org-element-property :caption element))
  1515. ;;;; Table
  1516. (defun org-html-htmlize-region-for-paste (beg end)
  1517. "Convert the region between BEG and END to HTML, using htmlize.el.
  1518. This is much like `htmlize-region-for-paste', only that it uses
  1519. the settings define in the org-... variables."
  1520. (let* ((htmlize-output-type org-html-htmlize-output-type)
  1521. (htmlize-css-name-prefix org-html-htmlize-font-prefix)
  1522. (htmlbuf (htmlize-region beg end)))
  1523. (unwind-protect
  1524. (with-current-buffer htmlbuf
  1525. (buffer-substring (plist-get htmlize-buffer-places 'content-start)
  1526. (plist-get htmlize-buffer-places 'content-end)))
  1527. (kill-buffer htmlbuf))))
  1528. ;;;###autoload
  1529. (defun org-html-htmlize-generate-css ()
  1530. "Create the CSS for all font definitions in the current Emacs session.
  1531. Use this to create face definitions in your CSS style file that can then
  1532. be used by code snippets transformed by htmlize.
  1533. This command just produces a buffer that contains class definitions for all
  1534. faces used in the current Emacs session. You can copy and paste the ones you
  1535. need into your CSS file.
  1536. If you then set `org-html-htmlize-output-type' to `css', calls
  1537. to the function `org-html-htmlize-region-for-paste' will
  1538. produce code that uses these same face definitions."
  1539. (interactive)
  1540. (unless (require 'htmlize nil t)
  1541. (error "htmlize library missing. Aborting"))
  1542. (and (get-buffer "*html*") (kill-buffer "*html*"))
  1543. (with-temp-buffer
  1544. (let ((fl (face-list))
  1545. (htmlize-css-name-prefix "org-")
  1546. (htmlize-output-type 'css)
  1547. f i)
  1548. (while (setq f (pop fl)
  1549. i (and f (face-attribute f :inherit)))
  1550. (when (and (symbolp f) (or (not i) (not (listp i))))
  1551. (insert (org-add-props (copy-sequence "1") nil 'face f))))
  1552. (htmlize-region (point-min) (point-max))))
  1553. (pop-to-buffer-same-window "*html*")
  1554. (goto-char (point-min))
  1555. (when (re-search-forward "<style" nil t)
  1556. (delete-region (point-min) (match-beginning 0)))
  1557. (when (re-search-forward "</style>" nil t)
  1558. (delete-region (1+ (match-end 0)) (point-max)))
  1559. (beginning-of-line 1)
  1560. (when (looking-at " +") (replace-match ""))
  1561. (goto-char (point-min)))
  1562. (defun org-html--make-string (n string)
  1563. "Build a string by concatenating N times STRING."
  1564. (let (out) (dotimes (_ n out) (setq out (concat string out)))))
  1565. (defun org-html-fix-class-name (kwd) ; audit callers of this function
  1566. "Turn todo keyword KWD into a valid class name.
  1567. Replaces invalid characters with \"_\"."
  1568. (replace-regexp-in-string "[^a-zA-Z0-9_]" "_" kwd nil t))
  1569. (defun org-html-footnote-section (info)
  1570. "Format the footnote section.
  1571. INFO is a plist used as a communication channel."
  1572. (pcase (org-export-collect-footnote-definitions info)
  1573. (`nil nil)
  1574. (definitions
  1575. (format
  1576. (plist-get info :html-footnotes-section)
  1577. (org-html--translate "Footnotes" info)
  1578. (format
  1579. "\n%s\n"
  1580. (mapconcat
  1581. (lambda (definition)
  1582. (pcase definition
  1583. (`(,n ,_ ,def)
  1584. ;; `org-export-collect-footnote-definitions' can return
  1585. ;; two kinds of footnote definitions: inline and blocks.
  1586. ;; Since this should not make any difference in the HTML
  1587. ;; output, we wrap the inline definitions within
  1588. ;; a "footpara" class paragraph.
  1589. (let ((inline? (not (org-element-map def org-element-all-elements
  1590. #'identity nil t)))
  1591. (anchor (org-html--anchor
  1592. (format "fn.%d" n)
  1593. n
  1594. (format " class=\"footnum\" href=\"#fnr.%d\"" n)
  1595. info))
  1596. (contents (org-trim (org-export-data def info))))
  1597. (format "<div class=\"footdef\">%s %s</div>\n"
  1598. (format (plist-get info :html-footnote-format) anchor)
  1599. (format "<div class=\"footpara\">%s</div>"
  1600. (if (not inline?) contents
  1601. (format "<p class=\"footpara\">%s</p>"
  1602. contents))))))))
  1603. definitions
  1604. "\n"))))))
  1605. ;;; Template
  1606. (defun org-html--build-meta-info (info)
  1607. "Return meta tags for exported document.
  1608. INFO is a plist used as a communication channel."
  1609. (let* ((protect-string
  1610. (lambda (str)
  1611. (replace-regexp-in-string
  1612. "\"" "&quot;" (org-html-encode-plain-text str))))
  1613. (title (org-export-data (plist-get info :title) info))
  1614. ;; Set title to an invisible character instead of leaving it
  1615. ;; empty, which is invalid.
  1616. (title (if (org-string-nw-p title) title "&lrm;"))
  1617. (author (and (plist-get info :with-author)
  1618. (let ((auth (plist-get info :author)))
  1619. (and auth
  1620. ;; Return raw Org syntax, skipping non
  1621. ;; exportable objects.
  1622. (org-element-interpret-data
  1623. (org-element-map auth
  1624. (cons 'plain-text org-element-all-objects)
  1625. 'identity info))))))
  1626. (description (plist-get info :description))
  1627. (keywords (plist-get info :keywords))
  1628. (charset (or (and org-html-coding-system
  1629. (fboundp 'coding-system-get)
  1630. (coding-system-get org-html-coding-system
  1631. 'mime-charset))
  1632. "iso-8859-1")))
  1633. (concat
  1634. (when (plist-get info :time-stamp-file)
  1635. (format-time-string
  1636. (concat "<!-- "
  1637. (plist-get info :html-metadata-timestamp-format)
  1638. " -->\n")))
  1639. (format
  1640. (if (org-html-html5-p info)
  1641. (org-html-close-tag "meta" "charset=\"%s\"" info)
  1642. (org-html-close-tag
  1643. "meta" "http-equiv=\"Content-Type\" content=\"text/html;charset=%s\""
  1644. info))
  1645. charset) "\n"
  1646. (let ((viewport-options
  1647. (cl-remove-if-not (lambda (cell) (org-string-nw-p (cadr cell)))
  1648. (plist-get info :html-viewport))))
  1649. (and viewport-options
  1650. (concat
  1651. (org-html-close-tag
  1652. "meta"
  1653. (format "name=\"viewport\" content=\"%s\""
  1654. (mapconcat
  1655. (lambda (elm) (format "%s=%s" (car elm) (cadr elm)))
  1656. viewport-options ", "))
  1657. info)
  1658. "\n")))
  1659. (format "<title>%s</title>\n" title)
  1660. (org-html-close-tag "meta" "name=\"generator\" content=\"Org mode\"" info)
  1661. "\n"
  1662. (and (org-string-nw-p author)
  1663. (concat
  1664. (org-html-close-tag "meta"
  1665. (format "name=\"author\" content=\"%s\""
  1666. (funcall protect-string author))
  1667. info)
  1668. "\n"))
  1669. (and (org-string-nw-p description)
  1670. (concat
  1671. (org-html-close-tag "meta"
  1672. (format "name=\"description\" content=\"%s\"\n"
  1673. (funcall protect-string description))
  1674. info)
  1675. "\n"))
  1676. (and (org-string-nw-p keywords)
  1677. (concat
  1678. (org-html-close-tag "meta"
  1679. (format "name=\"keywords\" content=\"%s\""
  1680. (funcall protect-string keywords))
  1681. info)
  1682. "\n")))))
  1683. (defun org-html--build-head (info)
  1684. "Return information for the <head>..</head> of the HTML output.
  1685. INFO is a plist used as a communication channel."
  1686. (org-element-normalize-string
  1687. (concat
  1688. (when (plist-get info :html-head-include-default-style)
  1689. (org-element-normalize-string org-html-style-default))
  1690. (org-element-normalize-string (plist-get info :html-head))
  1691. (org-element-normalize-string (plist-get info :html-head-extra))
  1692. (when (and (plist-get info :html-htmlized-css-url)
  1693. (eq org-html-htmlize-output-type 'css))
  1694. (org-html-close-tag "link"
  1695. (format "rel=\"stylesheet\" href=\"%s\" type=\"text/css\""
  1696. (plist-get info :html-htmlized-css-url))
  1697. info))
  1698. (when (plist-get info :html-head-include-scripts) org-html-scripts))))
  1699. (defun org-html--build-mathjax-config (info)
  1700. "Insert the user setup into the mathjax template.
  1701. INFO is a plist used as a communication channel."
  1702. (when (and (memq (plist-get info :with-latex) '(mathjax t))
  1703. (org-element-map (plist-get info :parse-tree)
  1704. '(latex-fragment latex-environment) #'identity info t nil t))
  1705. (let ((template (plist-get info :html-mathjax-template))
  1706. (options (plist-get info :html-mathjax-options))
  1707. (in-buffer (or (plist-get info :html-mathjax) "")))
  1708. (dolist (e options (org-element-normalize-string template))
  1709. (let ((name (car e))
  1710. (val (nth 1 e)))
  1711. (when (string-match (concat "\\<" (symbol-name name) ":") in-buffer)
  1712. (setq val
  1713. (car (read-from-string (substring in-buffer (match-end 0))))))
  1714. (unless (stringp val) (setq val (format "%s" val)))
  1715. (while (string-match (concat "%" (upcase (symbol-name name)))
  1716. template)
  1717. (setq template (replace-match val t t template))))))))
  1718. (defun org-html-format-spec (info)
  1719. "Return format specification for preamble and postamble.
  1720. INFO is a plist used as a communication channel."
  1721. (let ((timestamp-format (plist-get info :html-metadata-timestamp-format)))
  1722. `((?t . ,(org-export-data (plist-get info :title) info))
  1723. (?s . ,(org-export-data (plist-get info :subtitle) info))
  1724. (?d . ,(org-export-data (org-export-get-date info timestamp-format)
  1725. info))
  1726. (?T . ,(format-time-string timestamp-format))
  1727. (?a . ,(org-export-data (plist-get info :author) info))
  1728. (?e . ,(mapconcat
  1729. (lambda (e) (format "<a href=\"mailto:%s\">%s</a>" e e))
  1730. (split-string (plist-get info :email) ",+ *")
  1731. ", "))
  1732. (?c . ,(plist-get info :creator))
  1733. (?C . ,(let ((file (plist-get info :input-file)))
  1734. (format-time-string timestamp-format
  1735. (and file (nth 5 (file-attributes file))))))
  1736. (?v . ,(or (plist-get info :html-validation-link) "")))))
  1737. (defun org-html--build-pre/postamble (type info)
  1738. "Return document preamble or postamble as a string, or nil.
  1739. TYPE is either `preamble' or `postamble', INFO is a plist used as a
  1740. communication channel."
  1741. (let ((section (plist-get info (intern (format ":html-%s" type))))
  1742. (spec (org-html-format-spec info)))
  1743. (when section
  1744. (let ((section-contents
  1745. (if (functionp section) (funcall section info)
  1746. (cond
  1747. ((stringp section) (format-spec section spec))
  1748. ((eq section 'auto)
  1749. (let ((date (cdr (assq ?d spec)))
  1750. (author (cdr (assq ?a spec)))
  1751. (email (cdr (assq ?e spec)))
  1752. (creator (cdr (assq ?c spec)))
  1753. (validation-link (cdr (assq ?v spec))))
  1754. (concat
  1755. (when (and (plist-get info :with-date)
  1756. (org-string-nw-p date))
  1757. (format "<p class=\"date\">%s: %s</p>\n"
  1758. (org-html--translate "Date" info)
  1759. date))
  1760. (when (and (plist-get info :with-author)
  1761. (org-string-nw-p author))
  1762. (format "<p class=\"author\">%s: %s</p>\n"
  1763. (org-html--translate "Author" info)
  1764. author))
  1765. (when (and (plist-get info :with-email)
  1766. (org-string-nw-p email))
  1767. (format "<p class=\"email\">%s: %s</p>\n"
  1768. (org-html--translate "Email" info)
  1769. email))
  1770. (when (plist-get info :time-stamp-file)
  1771. (format
  1772. "<p class=\"date\">%s: %s</p>\n"
  1773. (org-html--translate "Created" info)
  1774. (format-time-string
  1775. (plist-get info :html-metadata-timestamp-format))))
  1776. (when (plist-get info :with-creator)
  1777. (format "<p class=\"creator\">%s</p>\n" creator))
  1778. (format "<p class=\"validation\">%s</p>\n"
  1779. validation-link))))
  1780. (t
  1781. (let ((formats (plist-get info (if (eq type 'preamble)
  1782. :html-preamble-format
  1783. :html-postamble-format)))
  1784. (language (plist-get info :language)))
  1785. (format-spec
  1786. (cadr (or (assoc-string language formats t)
  1787. (assoc-string "en" formats t)))
  1788. spec)))))))
  1789. (let ((div (assq type (plist-get info :html-divs))))
  1790. (when (org-string-nw-p section-contents)
  1791. (concat
  1792. (format "<%s id=\"%s\" class=\"%s\">\n"
  1793. (nth 1 div)
  1794. (nth 2 div)
  1795. org-html--pre/postamble-class)
  1796. (org-element-normalize-string section-contents)
  1797. (format "</%s>\n" (nth 1 div)))))))))
  1798. (defun org-html-inner-template (contents info)
  1799. "Return body of document string after HTML conversion.
  1800. CONTENTS is the transcoded contents string. INFO is a plist
  1801. holding export options."
  1802. (concat
  1803. ;; Table of contents.
  1804. (let ((depth (plist-get info :with-toc)))
  1805. (when depth (org-html-toc depth info)))
  1806. ;; Document contents.
  1807. contents
  1808. ;; Footnotes section.
  1809. (org-html-footnote-section info)))
  1810. (defun org-html-template (contents info)
  1811. "Return complete document string after HTML conversion.
  1812. CONTENTS is the transcoded contents string. INFO is a plist
  1813. holding export options."
  1814. (concat
  1815. (when (and (not (org-html-html5-p info)) (org-html-xhtml-p info))
  1816. (let* ((xml-declaration (plist-get info :html-xml-declaration))
  1817. (decl (or (and (stringp xml-declaration) xml-declaration)
  1818. (cdr (assoc (plist-get info :html-extension)
  1819. xml-declaration))
  1820. (cdr (assoc "html" xml-declaration))
  1821. "")))
  1822. (when (not (or (not decl) (string= "" decl)))
  1823. (format "%s\n"
  1824. (format decl
  1825. (or (and org-html-coding-system
  1826. (fboundp 'coding-system-get)
  1827. (coding-system-get org-html-coding-system 'mime-charset))
  1828. "iso-8859-1"))))))
  1829. (org-html-doctype info)
  1830. "\n"
  1831. (concat "<html"
  1832. (cond ((org-html-xhtml-p info)
  1833. (format
  1834. " xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"%s\" xml:lang=\"%s\""
  1835. (plist-get info :language) (plist-get info :language)))
  1836. ((org-html-html5-p info)
  1837. (format " lang=\"%s\"" (plist-get info :language))))
  1838. ">\n")
  1839. "<head>\n"
  1840. (org-html--build-meta-info info)
  1841. (org-html--build-head info)
  1842. (org-html--build-mathjax-config info)
  1843. "</head>\n"
  1844. "<body>\n"
  1845. (let ((link-up (org-trim (plist-get info :html-link-up)))
  1846. (link-home (org-trim (plist-get info :html-link-home))))
  1847. (unless (and (string= link-up "") (string= link-home ""))
  1848. (format (plist-get info :html-home/up-format)
  1849. (or link-up link-home)
  1850. (or link-home link-up))))
  1851. ;; Preamble.
  1852. (org-html--build-pre/postamble 'preamble info)
  1853. ;; Document contents.
  1854. (let ((div (assq 'content (plist-get info :html-divs))))
  1855. (format "<%s id=\"%s\">\n" (nth 1 div) (nth 2 div)))
  1856. ;; Document title.
  1857. (when (plist-get info :with-title)
  1858. (let ((title (and (plist-get info :with-title)
  1859. (plist-get info :title)))
  1860. (subtitle (plist-get info :subtitle))
  1861. (html5-fancy (org-html--html5-fancy-p info)))
  1862. (when title
  1863. (format
  1864. (if html5-fancy
  1865. "<header>\n<h1 class=\"title\">%s</h1>\n%s</header>"
  1866. "<h1 class=\"title\">%s%s</h1>\n")
  1867. (org-export-data title info)
  1868. (if subtitle
  1869. (format
  1870. (if html5-fancy
  1871. "<p class=\"subtitle\">%s</p>\n"
  1872. (concat "\n" (org-html-close-tag "br" nil info) "\n"
  1873. "<span class=\"subtitle\">%s</span>\n"))
  1874. (org-export-data subtitle info))
  1875. "")))))
  1876. contents
  1877. (format "</%s>\n" (nth 1 (assq 'content (plist-get info :html-divs))))
  1878. ;; Postamble.
  1879. (org-html--build-pre/postamble 'postamble info)
  1880. ;; Possibly use the Klipse library live code blocks.
  1881. (when (plist-get info :html-klipsify-src)
  1882. (concat "<script>" (plist-get info :html-klipse-selection-script)
  1883. "</script><script src=\""
  1884. org-html-klipse-js
  1885. "\"></script><link rel=\"stylesheet\" type=\"text/css\" href=\""
  1886. org-html-klipse-css "\"/>"))
  1887. ;; Closing document.
  1888. "</body>\n</html>"))
  1889. (defun org-html--translate (s info)
  1890. "Translate string S according to specified language.
  1891. INFO is a plist used as a communication channel."
  1892. (org-export-translate s :html info))
  1893. ;;;; Anchor
  1894. (defun org-html--anchor (id desc attributes info)
  1895. "Format a HTML anchor."
  1896. (let* ((name (and (plist-get info :html-allow-name-attribute-in-anchors) id))
  1897. (attributes (concat (and id (format " id=\"%s\"" id))
  1898. (and name (format " name=\"%s\"" name))
  1899. attributes)))
  1900. (format "<a%s>%s</a>" attributes (or desc ""))))
  1901. ;;;; Todo
  1902. (defun org-html--todo (todo info)
  1903. "Format TODO keywords into HTML."
  1904. (when todo
  1905. (format "<span class=\"%s %s%s\">%s</span>"
  1906. (if (member todo org-done-keywords) "done" "todo")
  1907. (or (plist-get info :html-todo-kwd-class-prefix) "")
  1908. (org-html-fix-class-name todo)
  1909. todo)))
  1910. ;;;; Priority
  1911. (defun org-html--priority (priority _info)
  1912. "Format a priority into HTML.
  1913. PRIORITY is the character code of the priority or nil. INFO is
  1914. a plist containing export options."
  1915. (and priority (format "<span class=\"priority\">[%c]</span>" priority)))
  1916. ;;;; Tags
  1917. (defun org-html--tags (tags info)
  1918. "Format TAGS into HTML.
  1919. INFO is a plist containing export options."
  1920. (when tags
  1921. (format "<span class=\"tag\">%s</span>"
  1922. (mapconcat
  1923. (lambda (tag)
  1924. (format "<span class=\"%s\">%s</span>"
  1925. (concat (plist-get info :html-tag-class-prefix)
  1926. (org-html-fix-class-name tag))
  1927. tag))
  1928. tags "&#xa0;"))))
  1929. ;;;; Src Code
  1930. (defun org-html-fontify-code (code lang)
  1931. "Color CODE with htmlize library.
  1932. CODE is a string representing the source code to colorize. LANG
  1933. is the language used for CODE, as a string, or nil."
  1934. (when code
  1935. (cond
  1936. ;; No language. Possibly an example block.
  1937. ((not lang) (org-html-encode-plain-text code))
  1938. ;; Plain text explicitly set.
  1939. ((not org-html-htmlize-output-type) (org-html-encode-plain-text code))
  1940. ;; No htmlize library or an inferior version of htmlize.
  1941. ((not (progn (require 'htmlize nil t)
  1942. (fboundp 'htmlize-region-for-paste)))
  1943. ;; Emit a warning.
  1944. (message "Cannot fontify source block (htmlize.el >= 1.34 required)")
  1945. (org-html-encode-plain-text code))
  1946. (t
  1947. ;; Map language
  1948. (setq lang (or (assoc-default lang org-src-lang-modes) lang))
  1949. (let* ((lang-mode (and lang (intern (format "%s-mode" lang)))))
  1950. (cond
  1951. ;; Case 1: Language is not associated with any Emacs mode
  1952. ((not (functionp lang-mode))
  1953. (org-html-encode-plain-text code))
  1954. ;; Case 2: Default. Fontify code.
  1955. (t
  1956. ;; htmlize
  1957. (setq code
  1958. (let ((output-type org-html-htmlize-output-type)
  1959. (font-prefix org-html-htmlize-font-prefix))
  1960. (with-temp-buffer
  1961. ;; Switch to language-specific mode.
  1962. (funcall lang-mode)
  1963. (insert code)
  1964. ;; Fontify buffer.
  1965. (org-font-lock-ensure)
  1966. ;; Remove formatting on newline characters.
  1967. (save-excursion
  1968. (let ((beg (point-min))
  1969. (end (point-max)))
  1970. (goto-char beg)
  1971. (while (progn (end-of-line) (< (point) end))
  1972. (put-text-property (point) (1+ (point)) 'face nil)
  1973. (forward-char 1))))
  1974. (org-src-mode)
  1975. (set-buffer-modified-p nil)
  1976. ;; Htmlize region.
  1977. (let ((org-html-htmlize-output-type output-type)
  1978. (org-html-htmlize-font-prefix font-prefix))
  1979. (org-html-htmlize-region-for-paste
  1980. (point-min) (point-max))))))
  1981. ;; Strip any enclosing <pre></pre> tags.
  1982. (let* ((beg (and (string-match "\\`<pre[^>]*>\n?" code) (match-end 0)))
  1983. (end (and beg (string-match "</pre>\\'" code))))
  1984. (if (and beg end) (substring code beg end) code)))))))))
  1985. (defun org-html-do-format-code
  1986. (code &optional lang refs retain-labels num-start)
  1987. "Format CODE string as source code.
  1988. Optional arguments LANG, REFS, RETAIN-LABELS and NUM-START are,
  1989. respectively, the language of the source code, as a string, an
  1990. alist between line numbers and references (as returned by
  1991. `org-export-unravel-code'), a boolean specifying if labels should
  1992. appear in the source code, and the number associated to the first
  1993. line of code."
  1994. (let* ((code-lines (split-string code "\n"))
  1995. (code-length (length code-lines))
  1996. (num-fmt
  1997. (and num-start
  1998. (format "%%%ds: "
  1999. (length (number-to-string (+ code-length num-start))))))
  2000. (code (org-html-fontify-code code lang)))
  2001. (org-export-format-code
  2002. code
  2003. (lambda (loc line-num ref)
  2004. (setq loc
  2005. (concat
  2006. ;; Add line number, if needed.
  2007. (when num-start
  2008. (format "<span class=\"linenr\">%s</span>"
  2009. (format num-fmt line-num)))
  2010. ;; Transcoded src line.
  2011. loc
  2012. ;; Add label, if needed.
  2013. (when (and ref retain-labels) (format " (%s)" ref))))
  2014. ;; Mark transcoded line as an anchor, if needed.
  2015. (if (not ref) loc
  2016. (format "<span id=\"coderef-%s\" class=\"coderef-off\">%s</span>"
  2017. ref loc)))
  2018. num-start refs)))
  2019. (defun org-html-format-code (element info)
  2020. "Format contents of ELEMENT as source code.
  2021. ELEMENT is either an example or a source block. INFO is a plist
  2022. used as a communication channel."
  2023. (let* ((lang (org-element-property :language element))
  2024. ;; Extract code and references.
  2025. (code-info (org-export-unravel-code element))
  2026. (code (car code-info))
  2027. (refs (cdr code-info))
  2028. ;; Does the source block contain labels?
  2029. (retain-labels (org-element-property :retain-labels element))
  2030. ;; Does it have line numbers?
  2031. (num-start (org-export-get-loc element info)))
  2032. (org-html-do-format-code code lang refs retain-labels num-start)))
  2033. ;;; Tables of Contents
  2034. (defun org-html-toc (depth info &optional scope)
  2035. "Build a table of contents.
  2036. DEPTH is an integer specifying the depth of the table. INFO is
  2037. a plist used as a communication channel. Optional argument SCOPE
  2038. is an element defining the scope of the table. Return the table
  2039. of contents as a string, or nil if it is empty."
  2040. (let ((toc-entries
  2041. (mapcar (lambda (headline)
  2042. (cons (org-html--format-toc-headline headline info)
  2043. (org-export-get-relative-level headline info)))
  2044. (org-export-collect-headlines info depth scope))))
  2045. (when toc-entries
  2046. (let ((toc (concat "<div id=\"text-table-of-contents\">"
  2047. (org-html--toc-text toc-entries)
  2048. "</div>\n")))
  2049. (if scope toc
  2050. (let ((outer-tag (if (org-html--html5-fancy-p info)
  2051. "nav"
  2052. "div")))
  2053. (concat (format "<%s id=\"table-of-contents\">\n" outer-tag)
  2054. (let ((top-level (plist-get info :html-toplevel-hlevel)))
  2055. (format "<h%d>%s</h%d>\n"
  2056. top-level
  2057. (org-html--translate "Table of Contents" info)
  2058. top-level))
  2059. toc
  2060. (format "</%s>\n" outer-tag))))))))
  2061. (defun org-html--toc-text (toc-entries)
  2062. "Return innards of a table of contents, as a string.
  2063. TOC-ENTRIES is an alist where key is an entry title, as a string,
  2064. and value is its relative level, as an integer."
  2065. (let* ((prev-level (1- (cdar toc-entries)))
  2066. (start-level prev-level))
  2067. (concat
  2068. (mapconcat
  2069. (lambda (entry)
  2070. (let ((headline (car entry))
  2071. (level (cdr entry)))
  2072. (concat
  2073. (let* ((cnt (- level prev-level))
  2074. (times (if (> cnt 0) (1- cnt) (- cnt))))
  2075. (setq prev-level level)
  2076. (concat
  2077. (org-html--make-string
  2078. times (cond ((> cnt 0) "\n<ul>\n<li>")
  2079. ((< cnt 0) "</li>\n</ul>\n")))
  2080. (if (> cnt 0) "\n<ul>\n<li>" "</li>\n<li>")))
  2081. headline)))
  2082. toc-entries "")
  2083. (org-html--make-string (- prev-level start-level) "</li>\n</ul>\n"))))
  2084. (defun org-html--format-toc-headline (headline info)
  2085. "Return an appropriate table of contents entry for HEADLINE.
  2086. INFO is a plist used as a communication channel."
  2087. (let* ((headline-number (org-export-get-headline-number headline info))
  2088. (todo (and (plist-get info :with-todo-keywords)
  2089. (let ((todo (org-element-property :todo-keyword headline)))
  2090. (and todo (org-export-data todo info)))))
  2091. (todo-type (and todo (org-element-property :todo-type headline)))
  2092. (priority (and (plist-get info :with-priority)
  2093. (org-element-property :priority headline)))
  2094. (text (org-export-data-with-backend
  2095. (org-export-get-alt-title headline info)
  2096. (org-export-toc-entry-backend 'html)
  2097. info))
  2098. (tags (and (eq (plist-get info :with-tags) t)
  2099. (org-export-get-tags headline info))))
  2100. (format "<a href=\"#%s\">%s</a>"
  2101. ;; Label.
  2102. (or (org-element-property :CUSTOM_ID headline)
  2103. (org-export-get-reference headline info))
  2104. ;; Body.
  2105. (concat
  2106. (and (not (org-export-low-level-p headline info))
  2107. (org-export-numbered-headline-p headline info)
  2108. (concat (mapconcat #'number-to-string headline-number ".")
  2109. ". "))
  2110. (apply (plist-get info :html-format-headline-function)
  2111. todo todo-type priority text tags :section-number nil)))))
  2112. (defun org-html-list-of-listings (info)
  2113. "Build a list of listings.
  2114. INFO is a plist used as a communication channel. Return the list
  2115. of listings as a string, or nil if it is empty."
  2116. (let ((lol-entries (org-export-collect-listings info)))
  2117. (when lol-entries
  2118. (concat "<div id=\"list-of-listings\">\n"
  2119. (let ((top-level (plist-get info :html-toplevel-hlevel)))
  2120. (format "<h%d>%s</h%d>\n"
  2121. top-level
  2122. (org-html--translate "List of Listings" info)
  2123. top-level))
  2124. "<div id=\"text-list-of-listings\">\n<ul>\n"
  2125. (let ((count 0)
  2126. (initial-fmt (format "<span class=\"listing-number\">%s</span>"
  2127. (org-html--translate "Listing %d:" info))))
  2128. (mapconcat
  2129. (lambda (entry)
  2130. (let ((label (and (org-element-property :name entry)
  2131. (org-export-get-reference entry info)))
  2132. (title (org-trim
  2133. (org-export-data
  2134. (or (org-export-get-caption entry t)
  2135. (org-export-get-caption entry))
  2136. info))))
  2137. (concat
  2138. "<li>"
  2139. (if (not label)
  2140. (concat (format initial-fmt (cl-incf count))
  2141. " "
  2142. title)
  2143. (format "<a href=\"#%s\">%s %s</a>"
  2144. label
  2145. (format initial-fmt (cl-incf count))
  2146. title))
  2147. "</li>")))
  2148. lol-entries "\n"))
  2149. "\n</ul>\n</div>\n</div>"))))
  2150. (defun org-html-list-of-tables (info)
  2151. "Build a list of tables.
  2152. INFO is a plist used as a communication channel. Return the list
  2153. of tables as a string, or nil if it is empty."
  2154. (let ((lol-entries (org-export-collect-tables info)))
  2155. (when lol-entries
  2156. (concat "<div id=\"list-of-tables\">\n"
  2157. (let ((top-level (plist-get info :html-toplevel-hlevel)))
  2158. (format "<h%d>%s</h%d>\n"
  2159. top-level
  2160. (org-html--translate "List of Tables" info)
  2161. top-level))
  2162. "<div id=\"text-list-of-tables\">\n<ul>\n"
  2163. (let ((count 0)
  2164. (initial-fmt (format "<span class=\"table-number\">%s</span>"
  2165. (org-html--translate "Table %d:" info))))
  2166. (mapconcat
  2167. (lambda (entry)
  2168. (let ((label (and (org-element-property :name entry)
  2169. (org-export-get-reference entry info)))
  2170. (title (org-trim
  2171. (org-export-data
  2172. (or (org-export-get-caption entry t)
  2173. (org-export-get-caption entry))
  2174. info))))
  2175. (concat
  2176. "<li>"
  2177. (if (not label)
  2178. (concat (format initial-fmt (cl-incf count))
  2179. " "
  2180. title)
  2181. (format "<a href=\"#%s\">%s %s</a>"
  2182. label
  2183. (format initial-fmt (cl-incf count))
  2184. title))
  2185. "</li>")))
  2186. lol-entries "\n"))
  2187. "\n</ul>\n</div>\n</div>"))))
  2188. ;;; Transcode Functions
  2189. ;;;; Bold
  2190. (defun org-html-bold (_bold contents info)
  2191. "Transcode BOLD from Org to HTML.
  2192. CONTENTS is the text with bold markup. INFO is a plist holding
  2193. contextual information."
  2194. (format (or (cdr (assq 'bold (plist-get info :html-text-markup-alist))) "%s")
  2195. contents))
  2196. ;;;; Center Block
  2197. (defun org-html-center-block (_center-block contents _info)
  2198. "Transcode a CENTER-BLOCK element from Org to HTML.
  2199. CONTENTS holds the contents of the block. INFO is a plist
  2200. holding contextual information."
  2201. (format "<div class=\"org-center\">\n%s</div>" contents))
  2202. ;;;; Clock
  2203. (defun org-html-clock (clock _contents _info)
  2204. "Transcode a CLOCK element from Org to HTML.
  2205. CONTENTS is nil. INFO is a plist used as a communication
  2206. channel."
  2207. (format "<p>
  2208. <span class=\"timestamp-wrapper\">
  2209. <span class=\"timestamp-kwd\">%s</span> <span class=\"timestamp\">%s</span>%s
  2210. </span>
  2211. </p>"
  2212. org-clock-string
  2213. (org-timestamp-translate (org-element-property :value clock))
  2214. (let ((time (org-element-property :duration clock)))
  2215. (and time (format " <span class=\"timestamp\">(%s)</span>" time)))))
  2216. ;;;; Code
  2217. (defun org-html-code (code _contents info)
  2218. "Transcode CODE from Org to HTML.
  2219. CONTENTS is nil. INFO is a plist holding contextual
  2220. information."
  2221. (format (or (cdr (assq 'code (plist-get info :html-text-markup-alist))) "%s")
  2222. (org-html-encode-plain-text (org-element-property :value code))))
  2223. ;;;; Drawer
  2224. (defun org-html-drawer (drawer contents info)
  2225. "Transcode a DRAWER element from Org to HTML.
  2226. CONTENTS holds the contents of the block. INFO is a plist
  2227. holding contextual information."
  2228. (funcall (plist-get info :html-format-drawer-function)
  2229. (org-element-property :drawer-name drawer)
  2230. contents))
  2231. ;;;; Dynamic Block
  2232. (defun org-html-dynamic-block (_dynamic-block contents _info)
  2233. "Transcode a DYNAMIC-BLOCK element from Org to HTML.
  2234. CONTENTS holds the contents of the block. INFO is a plist
  2235. holding contextual information. See `org-export-data'."
  2236. contents)
  2237. ;;;; Entity
  2238. (defun org-html-entity (entity _contents _info)
  2239. "Transcode an ENTITY object from Org to HTML.
  2240. CONTENTS are the definition itself. INFO is a plist holding
  2241. contextual information."
  2242. (org-element-property :html entity))
  2243. ;;;; Example Block
  2244. (defun org-html-example-block (example-block _contents info)
  2245. "Transcode a EXAMPLE-BLOCK element from Org to HTML.
  2246. CONTENTS is nil. INFO is a plist holding contextual
  2247. information."
  2248. (let ((attributes (org-export-read-attribute :attr_html example-block)))
  2249. (if (plist-get attributes :textarea)
  2250. (org-html--textarea-block example-block)
  2251. (format "<pre class=\"example\"%s>\n%s</pre>"
  2252. (let* ((name (org-element-property :name example-block))
  2253. (a (org-html--make-attribute-string
  2254. (if (or (not name) (plist-member attributes :id))
  2255. attributes
  2256. (plist-put attributes :id name)))))
  2257. (if (org-string-nw-p a) (concat " " a) ""))
  2258. (org-html-format-code example-block info)))))
  2259. ;;;; Export Snippet
  2260. (defun org-html-export-snippet (export-snippet _contents _info)
  2261. "Transcode a EXPORT-SNIPPET object from Org to HTML.
  2262. CONTENTS is nil. INFO is a plist holding contextual
  2263. information."
  2264. (when (eq (org-export-snippet-backend export-snippet) 'html)
  2265. (org-element-property :value export-snippet)))
  2266. ;;;; Export Block
  2267. (defun org-html-export-block (export-block _contents _info)
  2268. "Transcode a EXPORT-BLOCK element from Org to HTML.
  2269. CONTENTS is nil. INFO is a plist holding contextual information."
  2270. (when (string= (org-element-property :type export-block) "HTML")
  2271. (org-remove-indentation (org-element-property :value export-block))))
  2272. ;;;; Fixed Width
  2273. (defun org-html-fixed-width (fixed-width _contents _info)
  2274. "Transcode a FIXED-WIDTH element from Org to HTML.
  2275. CONTENTS is nil. INFO is a plist holding contextual information."
  2276. (format "<pre class=\"example\">\n%s</pre>"
  2277. (org-html-do-format-code
  2278. (org-remove-indentation
  2279. (org-element-property :value fixed-width)))))
  2280. ;;;; Footnote Reference
  2281. (defun org-html-footnote-reference (footnote-reference _contents info)
  2282. "Transcode a FOOTNOTE-REFERENCE element from Org to HTML.
  2283. CONTENTS is nil. INFO is a plist holding contextual information."
  2284. (concat
  2285. ;; Insert separator between two footnotes in a row.
  2286. (let ((prev (org-export-get-previous-element footnote-reference info)))
  2287. (when (eq (org-element-type prev) 'footnote-reference)
  2288. (plist-get info :html-footnote-separator)))
  2289. (let* ((n (org-export-get-footnote-number footnote-reference info))
  2290. (id (format "fnr.%d%s"
  2291. n
  2292. (if (org-export-footnote-first-reference-p
  2293. footnote-reference info)
  2294. ""
  2295. ".100"))))
  2296. (format
  2297. (plist-get info :html-footnote-format)
  2298. (org-html--anchor
  2299. id n (format " class=\"footref\" href=\"#fn.%d\"" n) info)))))
  2300. ;;;; Headline
  2301. (defun org-html-headline (headline contents info)
  2302. "Transcode a HEADLINE element from Org to HTML.
  2303. CONTENTS holds the contents of the headline. INFO is a plist
  2304. holding contextual information."
  2305. (unless (org-element-property :footnote-section-p headline)
  2306. (let* ((numberedp (org-export-numbered-headline-p headline info))
  2307. (numbers (org-export-get-headline-number headline info))
  2308. (level (+ (org-export-get-relative-level headline info)
  2309. (1- (plist-get info :html-toplevel-hlevel))))
  2310. (todo (and (plist-get info :with-todo-keywords)
  2311. (let ((todo (org-element-property :todo-keyword headline)))
  2312. (and todo (org-export-data todo info)))))
  2313. (todo-type (and todo (org-element-property :todo-type headline)))
  2314. (priority (and (plist-get info :with-priority)
  2315. (org-element-property :priority headline)))
  2316. (text (org-export-data (org-element-property :title headline) info))
  2317. (tags (and (plist-get info :with-tags)
  2318. (org-export-get-tags headline info)))
  2319. (full-text (funcall (plist-get info :html-format-headline-function)
  2320. todo todo-type priority text tags info))
  2321. (contents (or contents ""))
  2322. (id (or (org-element-property :CUSTOM_ID headline)
  2323. (org-export-get-reference headline info))))
  2324. (if (org-export-low-level-p headline info)
  2325. ;; This is a deep sub-tree: export it as a list item.
  2326. (let* ((html-type (if numberedp "ol" "ul")))
  2327. (concat
  2328. (and (org-export-first-sibling-p headline info)
  2329. (apply #'format "<%s class=\"org-%s\">\n"
  2330. (make-list 2 html-type)))
  2331. (org-html-format-list-item
  2332. contents (if numberedp 'ordered 'unordered)
  2333. nil info nil
  2334. (concat (org-html--anchor id nil nil info) full-text)) "\n"
  2335. (and (org-export-last-sibling-p headline info)
  2336. (format "</%s>\n" html-type))))
  2337. ;; Standard headline. Export it as a section.
  2338. (let ((extra-class (org-element-property :HTML_CONTAINER_CLASS headline))
  2339. (first-content (car (org-element-contents headline))))
  2340. (format "<%s id=\"%s\" class=\"%s\">%s%s</%s>\n"
  2341. (org-html--container headline info)
  2342. (concat "outline-container-"
  2343. (org-export-get-reference headline info))
  2344. (concat (format "outline-%d" level)
  2345. (and extra-class " ")
  2346. extra-class)
  2347. (format "\n<h%d id=\"%s\">%s</h%d>\n"
  2348. level
  2349. id
  2350. (concat
  2351. (and numberedp
  2352. (format
  2353. "<span class=\"section-number-%d\">%s</span> "
  2354. level
  2355. (mapconcat #'number-to-string numbers ".")))
  2356. full-text)
  2357. level)
  2358. ;; When there is no section, pretend there is an
  2359. ;; empty one to get the correct <div
  2360. ;; class="outline-...> which is needed by
  2361. ;; `org-info.js'.
  2362. (if (eq (org-element-type first-content) 'section) contents
  2363. (concat (org-html-section first-content "" info) contents))
  2364. (org-html--container headline info)))))))
  2365. (defun org-html-format-headline-default-function
  2366. (todo _todo-type priority text tags info)
  2367. "Default format function for a headline.
  2368. See `org-html-format-headline-function' for details."
  2369. (let ((todo (org-html--todo todo info))
  2370. (priority (org-html--priority priority info))
  2371. (tags (org-html--tags tags info)))
  2372. (concat todo (and todo " ")
  2373. priority (and priority " ")
  2374. text
  2375. (and tags "&#xa0;&#xa0;&#xa0;") tags)))
  2376. (defun org-html--container (headline info)
  2377. (or (org-element-property :HTML_CONTAINER headline)
  2378. (if (= 1 (org-export-get-relative-level headline info))
  2379. (plist-get info :html-container)
  2380. "div")))
  2381. ;;;; Horizontal Rule
  2382. (defun org-html-horizontal-rule (_horizontal-rule _contents info)
  2383. "Transcode an HORIZONTAL-RULE object from Org to HTML.
  2384. CONTENTS is nil. INFO is a plist holding contextual information."
  2385. (org-html-close-tag "hr" nil info))
  2386. ;;;; Inline Src Block
  2387. (defun org-html-inline-src-block (inline-src-block _contents info)
  2388. "Transcode an INLINE-SRC-BLOCK element from Org to HTML.
  2389. CONTENTS holds the contents of the item. INFO is a plist holding
  2390. contextual information."
  2391. (let* ((lang (org-element-property :language inline-src-block))
  2392. (code (org-html-fontify-code
  2393. (org-element-property :value inline-src-block)
  2394. lang))
  2395. (label
  2396. (let ((lbl (and (org-element-property :name inline-src-block)
  2397. (org-export-get-reference inline-src-block info))))
  2398. (if (not lbl) "" (format " id=\"%s\"" lbl)))))
  2399. (format "<code class=\"src src-%s\"%s>%s</code>" lang label code)))
  2400. ;;;; Inlinetask
  2401. (defun org-html-inlinetask (inlinetask contents info)
  2402. "Transcode an INLINETASK element from Org to HTML.
  2403. CONTENTS holds the contents of the block. INFO is a plist
  2404. holding contextual information."
  2405. (let* ((todo (and (plist-get info :with-todo-keywords)
  2406. (let ((todo (org-element-property :todo-keyword inlinetask)))
  2407. (and todo (org-export-data todo info)))))
  2408. (todo-type (and todo (org-element-property :todo-type inlinetask)))
  2409. (priority (and (plist-get info :with-priority)
  2410. (org-element-property :priority inlinetask)))
  2411. (text (org-export-data (org-element-property :title inlinetask) info))
  2412. (tags (and (plist-get info :with-tags)
  2413. (org-export-get-tags inlinetask info))))
  2414. (funcall (plist-get info :html-format-inlinetask-function)
  2415. todo todo-type priority text tags contents info)))
  2416. (defun org-html-format-inlinetask-default-function
  2417. (todo todo-type priority text tags contents info)
  2418. "Default format function for inlinetasks.
  2419. See `org-html-format-inlinetask-function' for details."
  2420. (format "<div class=\"inlinetask\">\n<b>%s</b>%s\n%s</div>"
  2421. (org-html-format-headline-default-function
  2422. todo todo-type priority text tags info)
  2423. (org-html-close-tag "br" nil info)
  2424. contents))
  2425. ;;;; Italic
  2426. (defun org-html-italic (_italic contents info)
  2427. "Transcode ITALIC from Org to HTML.
  2428. CONTENTS is the text with italic markup. INFO is a plist holding
  2429. contextual information."
  2430. (format
  2431. (or (cdr (assq 'italic (plist-get info :html-text-markup-alist))) "%s")
  2432. contents))
  2433. ;;;; Item
  2434. (defun org-html-checkbox (checkbox info)
  2435. "Format CHECKBOX into HTML.
  2436. INFO is a plist holding contextual information. See
  2437. `org-html-checkbox-type' for customization options."
  2438. (cdr (assq checkbox
  2439. (cdr (assq (plist-get info :html-checkbox-type)
  2440. org-html-checkbox-types)))))
  2441. (defun org-html-format-list-item (contents type checkbox info
  2442. &optional term-counter-id
  2443. headline)
  2444. "Format a list item into HTML."
  2445. (let ((class (if checkbox
  2446. (format " class=\"%s\""
  2447. (symbol-name checkbox)) ""))
  2448. (checkbox (concat (org-html-checkbox checkbox info)
  2449. (and checkbox " ")))
  2450. (br (org-html-close-tag "br" nil info))
  2451. (extra-newline (if (and (org-string-nw-p contents) headline) "\n" "")))
  2452. (concat
  2453. (pcase type
  2454. (`ordered
  2455. (let* ((counter term-counter-id)
  2456. (extra (if counter (format " value=\"%s\"" counter) "")))
  2457. (concat
  2458. (format "<li%s%s>" class extra)
  2459. (when headline (concat headline br)))))
  2460. (`unordered
  2461. (let* ((id term-counter-id)
  2462. (extra (if id (format " id=\"%s\"" id) "")))
  2463. (concat
  2464. (format "<li%s%s>" class extra)
  2465. (when headline (concat headline br)))))
  2466. (`descriptive
  2467. (let* ((term term-counter-id))
  2468. (setq term (or term "(no term)"))
  2469. ;; Check-boxes in descriptive lists are associated to tag.
  2470. (concat (format "<dt%s>%s</dt>"
  2471. class (concat checkbox term))
  2472. "<dd>"))))
  2473. (unless (eq type 'descriptive) checkbox)
  2474. extra-newline
  2475. (and (org-string-nw-p contents) (org-trim contents))
  2476. extra-newline
  2477. (pcase type
  2478. (`ordered "</li>")
  2479. (`unordered "</li>")
  2480. (`descriptive "</dd>")))))
  2481. (defun org-html-item (item contents info)
  2482. "Transcode an ITEM element from Org to HTML.
  2483. CONTENTS holds the contents of the item. INFO is a plist holding
  2484. contextual information."
  2485. (let* ((plain-list (org-export-get-parent item))
  2486. (type (org-element-property :type plain-list))
  2487. (counter (org-element-property :counter item))
  2488. (checkbox (org-element-property :checkbox item))
  2489. (tag (let ((tag (org-element-property :tag item)))
  2490. (and tag (org-export-data tag info)))))
  2491. (org-html-format-list-item
  2492. contents type checkbox info (or tag counter))))
  2493. ;;;; Keyword
  2494. (defun org-html-keyword (keyword _contents info)
  2495. "Transcode a KEYWORD element from Org to HTML.
  2496. CONTENTS is nil. INFO is a plist holding contextual information."
  2497. (let ((key (org-element-property :key keyword))
  2498. (value (org-element-property :value keyword)))
  2499. (cond
  2500. ((string= key "HTML") value)
  2501. ((string= key "TOC")
  2502. (let ((case-fold-search t))
  2503. (cond
  2504. ((string-match "\\<headlines\\>" value)
  2505. (let ((depth (and (string-match "\\<[0-9]+\\>" value)
  2506. (string-to-number (match-string 0 value))))
  2507. (localp (string-match-p "\\<local\\>" value)))
  2508. (org-html-toc depth info (and localp keyword))))
  2509. ((string= "listings" value) (org-html-list-of-listings info))
  2510. ((string= "tables" value) (org-html-list-of-tables info))))))))
  2511. ;;;; Latex Environment
  2512. (defun org-html-format-latex (latex-frag processing-type info)
  2513. "Format a LaTeX fragment LATEX-FRAG into HTML.
  2514. PROCESSING-TYPE designates the tool used for conversion. It can
  2515. be `mathjax', `verbatim', nil, t or symbols in
  2516. `org-preview-latex-process-alist', e.g., `dvipng', `dvisvgm' or
  2517. `imagemagick'. See `org-html-with-latex' for more information.
  2518. INFO is a plist containing export properties."
  2519. (let ((cache-relpath "") (cache-dir ""))
  2520. (unless (eq processing-type 'mathjax)
  2521. (let ((bfn (or (buffer-file-name)
  2522. (make-temp-name
  2523. (expand-file-name "latex" temporary-file-directory))))
  2524. (latex-header
  2525. (let ((header (plist-get info :latex-header)))
  2526. (and header
  2527. (concat (mapconcat
  2528. (lambda (line) (concat "#+LATEX_HEADER: " line))
  2529. (org-split-string header "\n")
  2530. "\n")
  2531. "\n")))))
  2532. (setq cache-relpath
  2533. (concat (file-name-as-directory org-preview-latex-image-directory)
  2534. (file-name-sans-extension
  2535. (file-name-nondirectory bfn)))
  2536. cache-dir (file-name-directory bfn))
  2537. ;; Re-create LaTeX environment from original buffer in
  2538. ;; temporary buffer so that dvipng/imagemagick can properly
  2539. ;; turn the fragment into an image.
  2540. (setq latex-frag (concat latex-header latex-frag))))
  2541. (with-temp-buffer
  2542. (insert latex-frag)
  2543. (org-format-latex cache-relpath nil nil cache-dir nil
  2544. "Creating LaTeX Image..." nil processing-type)
  2545. (buffer-string))))
  2546. (defun org-html--wrap-latex-environment (contents _ &optional caption label)
  2547. "Wrap CONTENTS string within appropriate environment for equations.
  2548. When optional arguments CAPTION and LABEL are given, use them for
  2549. caption and \"id\" attribute."
  2550. (format "\n<div%s class=\"equation-container\">\n%s%s\n</div>"
  2551. ;; ID.
  2552. (if (org-string-nw-p label) (format " id=\"%s\"" label) "")
  2553. ;; Contents.
  2554. (format "<span class=\"equation\">\n%s\n</span>" contents)
  2555. ;; Caption.
  2556. (if (not (org-string-nw-p caption)) ""
  2557. (format "\n<span class=\"equation-label\">\n%s\n</span>"
  2558. caption))))
  2559. (defun org-html--math-environment-p (element &optional _)
  2560. "Non-nil when ELEMENT is a LaTeX math environment.
  2561. Math environments match the regular expression defined in
  2562. `org-latex-math-environments-re'. This function is meant to be
  2563. used as a predicate for `org-export-get-ordinal' or a value to
  2564. `org-html-standalone-image-predicate'."
  2565. (string-match-p org-latex-math-environments-re
  2566. (org-element-property :value element)))
  2567. (defun org-html--unlabel-latex-environment (latex-frag)
  2568. "Change environment in LATEX-FRAG string to an unnumbered one.
  2569. For instance, change an 'equation' environment to 'equation*'."
  2570. (replace-regexp-in-string
  2571. "\\`[ \t]*\\\\begin{\\([^*]+?\\)}"
  2572. "\\1*"
  2573. (replace-regexp-in-string "^[ \t]*\\\\end{\\([^*]+?\\)}[ \r\t\n]*\\'"
  2574. "\\1*"
  2575. latex-frag nil nil 1)
  2576. nil nil 1))
  2577. (defun org-html-latex-environment (latex-environment _contents info)
  2578. "Transcode a LATEX-ENVIRONMENT element from Org to HTML.
  2579. CONTENTS is nil. INFO is a plist holding contextual information."
  2580. (let ((processing-type (plist-get info :with-latex))
  2581. (latex-frag (org-remove-indentation
  2582. (org-element-property :value latex-environment)))
  2583. (attributes (org-export-read-attribute :attr_html latex-environment))
  2584. (label (and (org-element-property :name latex-environment)
  2585. (org-export-get-reference latex-environment info)))
  2586. (caption (number-to-string
  2587. (org-export-get-ordinal
  2588. latex-environment info nil
  2589. #'org-html--math-environment-p))))
  2590. (cond
  2591. ((memq processing-type '(t mathjax))
  2592. (org-html-format-latex
  2593. (if (org-string-nw-p label)
  2594. (replace-regexp-in-string "\\`.*"
  2595. (format "\\&\n\\\\label{%s}" label)
  2596. latex-frag)
  2597. latex-frag)
  2598. 'mathjax info))
  2599. ((assq processing-type org-preview-latex-process-alist)
  2600. (let ((formula-link
  2601. (org-html-format-latex
  2602. (org-html--unlabel-latex-environment latex-frag)
  2603. processing-type info)))
  2604. (when (and formula-link (string-match "file:\\([^]]*\\)" formula-link))
  2605. (org-html--wrap-latex-environment
  2606. (org-html--format-image
  2607. (match-string 1 formula-link) attributes info)
  2608. info caption label))))
  2609. (t (org-html--wrap-latex-environment latex-frag info caption label)))))
  2610. ;;;; Latex Fragment
  2611. (defun org-html-latex-fragment (latex-fragment _contents info)
  2612. "Transcode a LATEX-FRAGMENT object from Org to HTML.
  2613. CONTENTS is nil. INFO is a plist holding contextual information."
  2614. (let ((latex-frag (org-element-property :value latex-fragment))
  2615. (processing-type (plist-get info :with-latex)))
  2616. (cond
  2617. ((memq processing-type '(t mathjax))
  2618. (org-html-format-latex latex-frag 'mathjax info))
  2619. ((assq processing-type org-preview-latex-process-alist)
  2620. (let ((formula-link
  2621. (org-html-format-latex latex-frag processing-type info)))
  2622. (when (and formula-link (string-match "file:\\([^]]*\\)" formula-link))
  2623. (org-html--format-image (match-string 1 formula-link) nil info))))
  2624. (t latex-frag))))
  2625. ;;;; Line Break
  2626. (defun org-html-line-break (_line-break _contents info)
  2627. "Transcode a LINE-BREAK object from Org to HTML.
  2628. CONTENTS is nil. INFO is a plist holding contextual information."
  2629. (concat (org-html-close-tag "br" nil info) "\n"))
  2630. ;;;; Link
  2631. (defun org-html-image-link-filter (data _backend info)
  2632. (org-export-insert-image-links data info org-html-inline-image-rules))
  2633. (defun org-html-inline-image-p (link info)
  2634. "Non-nil when LINK is meant to appear as an image.
  2635. INFO is a plist used as a communication channel. LINK is an
  2636. inline image when it has no description and targets an image
  2637. file (see `org-html-inline-image-rules' for more information), or
  2638. if its description is a single link targeting an image file."
  2639. (if (not (org-element-contents link))
  2640. (org-export-inline-image-p
  2641. link (plist-get info :html-inline-image-rules))
  2642. (not
  2643. (let ((link-count 0))
  2644. (org-element-map (org-element-contents link)
  2645. (cons 'plain-text org-element-all-objects)
  2646. (lambda (obj)
  2647. (pcase (org-element-type obj)
  2648. (`plain-text (org-string-nw-p obj))
  2649. (`link (if (= link-count 1) t
  2650. (cl-incf link-count)
  2651. (not (org-export-inline-image-p
  2652. obj (plist-get info :html-inline-image-rules)))))
  2653. (_ t)))
  2654. info t)))))
  2655. (defvar org-html-standalone-image-predicate)
  2656. (defun org-html-standalone-image-p (element info)
  2657. "Non-nil if ELEMENT is a standalone image.
  2658. INFO is a plist holding contextual information.
  2659. An element or object is a standalone image when
  2660. - its type is `paragraph' and its sole content, save for white
  2661. spaces, is a link that qualifies as an inline image;
  2662. - its type is `link' and its containing paragraph has no other
  2663. content save white spaces.
  2664. Bind `org-html-standalone-image-predicate' to constrain paragraph
  2665. further. For example, to check for only captioned standalone
  2666. images, set it to:
  2667. (lambda (paragraph) (org-element-property :caption paragraph))"
  2668. (let ((paragraph (pcase (org-element-type element)
  2669. (`paragraph element)
  2670. (`link (org-export-get-parent element)))))
  2671. (and (eq (org-element-type paragraph) 'paragraph)
  2672. (or (not (fboundp 'org-html-standalone-image-predicate))
  2673. (funcall org-html-standalone-image-predicate paragraph))
  2674. (catch 'exit
  2675. (let ((link-count 0))
  2676. (org-element-map (org-element-contents paragraph)
  2677. (cons 'plain-text org-element-all-objects)
  2678. (lambda (obj)
  2679. (when (pcase (org-element-type obj)
  2680. (`plain-text (org-string-nw-p obj))
  2681. (`link (or (> (cl-incf link-count) 1)
  2682. (not (org-html-inline-image-p obj info))))
  2683. (_ t))
  2684. (throw 'exit nil)))
  2685. info nil 'link)
  2686. (= link-count 1))))))
  2687. (defun org-html-link (link desc info)
  2688. "Transcode a LINK object from Org to HTML.
  2689. DESC is the description part of the link, or the empty string.
  2690. INFO is a plist holding contextual information. See
  2691. `org-export-data'."
  2692. (let* ((link-org-files-as-html-maybe
  2693. (lambda (raw-path info)
  2694. ;; Treat links to `file.org' as links to `file.html', if
  2695. ;; needed. See `org-html-link-org-files-as-html'.
  2696. (cond
  2697. ((and (plist-get info :html-link-org-files-as-html)
  2698. (string= ".org"
  2699. (downcase (file-name-extension raw-path "."))))
  2700. (concat (file-name-sans-extension raw-path) "."
  2701. (plist-get info :html-extension)))
  2702. (t raw-path))))
  2703. (type (org-element-property :type link))
  2704. (raw-path (org-element-property :path link))
  2705. ;; Ensure DESC really exists, or set it to nil.
  2706. (desc (org-string-nw-p desc))
  2707. (path
  2708. (cond
  2709. ((member type '("http" "https" "ftp" "mailto" "news"))
  2710. (url-encode-url (org-link-unescape (concat type ":" raw-path))))
  2711. ((string= type "file")
  2712. ;; During publishing, turn absolute file names belonging
  2713. ;; to base directory into relative file names. Otherwise,
  2714. ;; append "file" protocol to absolute file name.
  2715. (setq raw-path
  2716. (org-export-file-uri
  2717. (org-publish-file-relative-name raw-path info)))
  2718. ;; Possibly append `:html-link-home' to relative file
  2719. ;; name.
  2720. (let ((home (and (plist-get info :html-link-home)
  2721. (org-trim (plist-get info :html-link-home)))))
  2722. (when (and home
  2723. (plist-get info :html-link-use-abs-url)
  2724. (file-name-absolute-p raw-path))
  2725. (setq raw-path (concat (file-name-as-directory home) raw-path))))
  2726. ;; Maybe turn ".org" into ".html".
  2727. (setq raw-path (funcall link-org-files-as-html-maybe raw-path info))
  2728. ;; Add search option, if any. A search option can be
  2729. ;; relative to a custom-id, a headline title, a name or
  2730. ;; a target.
  2731. (let ((option (org-element-property :search-option link)))
  2732. (if (not option) raw-path
  2733. (let ((path (org-element-property :path link)))
  2734. (concat raw-path
  2735. "#"
  2736. (org-publish-resolve-external-link option path t))))))
  2737. (t raw-path)))
  2738. ;; Extract attributes from parent's paragraph. HACK: Only do
  2739. ;; this for the first link in parent (inner image link for
  2740. ;; inline images). This is needed as long as attributes
  2741. ;; cannot be set on a per link basis.
  2742. (attributes-plist
  2743. (let* ((parent (org-export-get-parent-element link))
  2744. (link (let ((container (org-export-get-parent link)))
  2745. (if (and (eq (org-element-type container) 'link)
  2746. (org-html-inline-image-p link info))
  2747. container
  2748. link))))
  2749. (and (eq (org-element-map parent 'link 'identity info t) link)
  2750. (org-export-read-attribute :attr_html parent))))
  2751. (attributes
  2752. (let ((attr (org-html--make-attribute-string attributes-plist)))
  2753. (if (org-string-nw-p attr) (concat " " attr) ""))))
  2754. (cond
  2755. ;; Link type is handled by a special function.
  2756. ((org-export-custom-protocol-maybe link desc 'html))
  2757. ;; Image file.
  2758. ((and (plist-get info :html-inline-images)
  2759. (org-export-inline-image-p
  2760. link (plist-get info :html-inline-image-rules)))
  2761. (org-html--format-image path attributes-plist info))
  2762. ;; Radio target: Transcode target's contents and use them as
  2763. ;; link's description.
  2764. ((string= type "radio")
  2765. (let ((destination (org-export-resolve-radio-link link info)))
  2766. (if (not destination) desc
  2767. (format "<a href=\"#%s\"%s>%s</a>"
  2768. (org-export-get-reference destination info)
  2769. attributes
  2770. desc))))
  2771. ;; Links pointing to a headline: Find destination and build
  2772. ;; appropriate referencing command.
  2773. ((member type '("custom-id" "fuzzy" "id"))
  2774. (let ((destination (if (string= type "fuzzy")
  2775. (org-export-resolve-fuzzy-link link info)
  2776. (org-export-resolve-id-link link info))))
  2777. (pcase (org-element-type destination)
  2778. ;; ID link points to an external file.
  2779. (`plain-text
  2780. (let ((fragment (concat "ID-" path))
  2781. ;; Treat links to ".org" files as ".html", if needed.
  2782. (path (funcall link-org-files-as-html-maybe
  2783. destination info)))
  2784. (format "<a href=\"%s#%s\"%s>%s</a>"
  2785. path fragment attributes (or desc destination))))
  2786. ;; Fuzzy link points nowhere.
  2787. (`nil
  2788. (format "<i>%s</i>"
  2789. (or desc
  2790. (org-export-data
  2791. (org-element-property :raw-link link) info))))
  2792. ;; Link points to a headline.
  2793. (`headline
  2794. (let ((href (or (org-element-property :CUSTOM_ID destination)
  2795. (org-export-get-reference destination info)))
  2796. ;; What description to use?
  2797. (desc
  2798. ;; Case 1: Headline is numbered and LINK has no
  2799. ;; description. Display section number.
  2800. (if (and (org-export-numbered-headline-p destination info)
  2801. (not desc))
  2802. (mapconcat #'number-to-string
  2803. (org-export-get-headline-number
  2804. destination info) ".")
  2805. ;; Case 2: Either the headline is un-numbered or
  2806. ;; LINK has a custom description. Display LINK's
  2807. ;; description or headline's title.
  2808. (or desc
  2809. (org-export-data
  2810. (org-element-property :title destination) info)))))
  2811. (format "<a href=\"#%s\"%s>%s</a>" href attributes desc)))
  2812. ;; Fuzzy link points to a target or an element.
  2813. (_
  2814. (if (and destination
  2815. (memq (plist-get info :with-latex) '(mathjax t))
  2816. (eq 'latex-environment (org-element-type destination))
  2817. (eq 'math (org-latex--environment-type destination)))
  2818. ;; Caption and labels are introduced within LaTeX
  2819. ;; environment. Use "eqref" macro to refer to those in
  2820. ;; the document.
  2821. (format "\\eqref{%s}"
  2822. (org-export-get-reference destination info))
  2823. (let* ((ref (org-export-get-reference destination info))
  2824. (org-html-standalone-image-predicate
  2825. #'org-html--has-caption-p)
  2826. (counter-predicate
  2827. (if (eq 'latex-environment (org-element-type destination))
  2828. #'org-html--math-environment-p
  2829. #'org-html--has-caption-p))
  2830. (number
  2831. (cond
  2832. (desc nil)
  2833. ((org-html-standalone-image-p destination info)
  2834. (org-export-get-ordinal
  2835. (org-element-map destination 'link #'identity info t)
  2836. info 'link 'org-html-standalone-image-p))
  2837. (t (org-export-get-ordinal
  2838. destination info nil counter-predicate))))
  2839. (desc
  2840. (cond (desc)
  2841. ((not number) "No description for this link")
  2842. ((numberp number) (number-to-string number))
  2843. (t (mapconcat #'number-to-string number ".")))))
  2844. (format "<a href=\"#%s\"%s>%s</a>" ref attributes desc)))))))
  2845. ;; Coderef: replace link with the reference name or the
  2846. ;; equivalent line number.
  2847. ((string= type "coderef")
  2848. (let ((fragment (concat "coderef-" (org-html-encode-plain-text path))))
  2849. (format "<a href=\"#%s\" %s%s>%s</a>"
  2850. fragment
  2851. (format "class=\"coderef\" onmouseover=\"CodeHighlightOn(this, \
  2852. '%s');\" onmouseout=\"CodeHighlightOff(this, '%s');\""
  2853. fragment fragment)
  2854. attributes
  2855. (format (org-export-get-coderef-format path desc)
  2856. (org-export-resolve-coderef path info)))))
  2857. ;; External link with a description part.
  2858. ((and path desc) (format "<a href=\"%s\"%s>%s</a>"
  2859. (org-html-encode-plain-text path)
  2860. attributes
  2861. desc))
  2862. ;; External link without a description part.
  2863. (path (let ((path (org-html-encode-plain-text path)))
  2864. (format "<a href=\"%s\"%s>%s</a>"
  2865. path
  2866. attributes
  2867. (org-link-unescape path))))
  2868. ;; No path, only description. Try to do something useful.
  2869. (t (format "<i>%s</i>" desc)))))
  2870. ;;;; Node Property
  2871. (defun org-html-node-property (node-property _contents _info)
  2872. "Transcode a NODE-PROPERTY element from Org to HTML.
  2873. CONTENTS is nil. INFO is a plist holding contextual
  2874. information."
  2875. (format "%s:%s"
  2876. (org-element-property :key node-property)
  2877. (let ((value (org-element-property :value node-property)))
  2878. (if value (concat " " value) ""))))
  2879. ;;;; Paragraph
  2880. (defun org-html-paragraph (paragraph contents info)
  2881. "Transcode a PARAGRAPH element from Org to HTML.
  2882. CONTENTS is the contents of the paragraph, as a string. INFO is
  2883. the plist used as a communication channel."
  2884. (let* ((parent (org-export-get-parent paragraph))
  2885. (parent-type (org-element-type parent))
  2886. (style '((footnote-definition " class=\"footpara\"")
  2887. (org-data " class=\"footpara\"")))
  2888. (attributes (org-html--make-attribute-string
  2889. (org-export-read-attribute :attr_html paragraph)))
  2890. (extra (or (cadr (assq parent-type style)) "")))
  2891. (cond
  2892. ((and (eq parent-type 'item)
  2893. (not (org-export-get-previous-element paragraph info))
  2894. (let ((followers (org-export-get-next-element paragraph info 2)))
  2895. (and (not (cdr followers))
  2896. (memq (org-element-type (car followers)) '(nil plain-list)))))
  2897. ;; First paragraph in an item has no tag if it is alone or
  2898. ;; followed, at most, by a sub-list.
  2899. contents)
  2900. ((org-html-standalone-image-p paragraph info)
  2901. ;; Standalone image.
  2902. (let ((caption
  2903. (let ((raw (org-export-data
  2904. (org-export-get-caption paragraph) info))
  2905. (org-html-standalone-image-predicate
  2906. #'org-html--has-caption-p))
  2907. (if (not (org-string-nw-p raw)) raw
  2908. (concat "<span class=\"figure-number\">"
  2909. (format (org-html--translate "Figure %d:" info)
  2910. (org-export-get-ordinal
  2911. (org-element-map paragraph 'link
  2912. #'identity info t)
  2913. info nil #'org-html-standalone-image-p))
  2914. " </span>"
  2915. raw))))
  2916. (label (and (org-element-property :name paragraph)
  2917. (org-export-get-reference paragraph info))))
  2918. (org-html--wrap-image contents info caption label)))
  2919. ;; Regular paragraph.
  2920. (t (format "<p%s%s>\n%s</p>"
  2921. (if (org-string-nw-p attributes)
  2922. (concat " " attributes) "")
  2923. extra contents)))))
  2924. ;;;; Plain List
  2925. (defun org-html-plain-list (plain-list contents _info)
  2926. "Transcode a PLAIN-LIST element from Org to HTML.
  2927. CONTENTS is the contents of the list. INFO is a plist holding
  2928. contextual information."
  2929. (let* ((type (pcase (org-element-property :type plain-list)
  2930. (`ordered "ol")
  2931. (`unordered "ul")
  2932. (`descriptive "dl")
  2933. (other (error "Unknown HTML list type: %s" other))))
  2934. (class (format "org-%s" type))
  2935. (attributes (org-export-read-attribute :attr_html plain-list)))
  2936. (format "<%s %s>\n%s</%s>"
  2937. type
  2938. (org-html--make-attribute-string
  2939. (plist-put attributes :class
  2940. (org-trim
  2941. (mapconcat #'identity
  2942. (list class (plist-get attributes :class))
  2943. " "))))
  2944. contents
  2945. type)))
  2946. ;;;; Plain Text
  2947. (defun org-html-convert-special-strings (string)
  2948. "Convert special characters in STRING to HTML."
  2949. (dolist (a org-html-special-string-regexps string)
  2950. (let ((re (car a))
  2951. (rpl (cdr a)))
  2952. (setq string (replace-regexp-in-string re rpl string t)))))
  2953. (defun org-html-encode-plain-text (text)
  2954. "Convert plain text characters from TEXT to HTML equivalent.
  2955. Possible conversions are set in `org-html-protect-char-alist'."
  2956. (dolist (pair org-html-protect-char-alist text)
  2957. (setq text (replace-regexp-in-string (car pair) (cdr pair) text t t))))
  2958. (defun org-html-plain-text (text info)
  2959. "Transcode a TEXT string from Org to HTML.
  2960. TEXT is the string to transcode. INFO is a plist holding
  2961. contextual information."
  2962. (let ((output text))
  2963. ;; Protect following characters: <, >, &.
  2964. (setq output (org-html-encode-plain-text output))
  2965. ;; Handle smart quotes. Be sure to provide original string since
  2966. ;; OUTPUT may have been modified.
  2967. (when (plist-get info :with-smart-quotes)
  2968. (setq output (org-export-activate-smart-quotes output :html info text)))
  2969. ;; Handle special strings.
  2970. (when (plist-get info :with-special-strings)
  2971. (setq output (org-html-convert-special-strings output)))
  2972. ;; Handle break preservation if required.
  2973. (when (plist-get info :preserve-breaks)
  2974. (setq output
  2975. (replace-regexp-in-string
  2976. "\\(\\\\\\\\\\)?[ \t]*\n"
  2977. (concat (org-html-close-tag "br" nil info) "\n") output)))
  2978. ;; Return value.
  2979. output))
  2980. ;; Planning
  2981. (defun org-html-planning (planning _contents info)
  2982. "Transcode a PLANNING element from Org to HTML.
  2983. CONTENTS is nil. INFO is a plist used as a communication
  2984. channel."
  2985. (format
  2986. "<p><span class=\"timestamp-wrapper\">%s</span></p>"
  2987. (org-trim
  2988. (mapconcat
  2989. (lambda (pair)
  2990. (let ((timestamp (cdr pair)))
  2991. (when timestamp
  2992. (let ((string (car pair)))
  2993. (format "<span class=\"timestamp-kwd\">%s</span> \
  2994. <span class=\"timestamp\">%s</span> "
  2995. string
  2996. (org-html-plain-text (org-timestamp-translate timestamp)
  2997. info))))))
  2998. `((,org-closed-string . ,(org-element-property :closed planning))
  2999. (,org-deadline-string . ,(org-element-property :deadline planning))
  3000. (,org-scheduled-string . ,(org-element-property :scheduled planning)))
  3001. ""))))
  3002. ;;;; Property Drawer
  3003. (defun org-html-property-drawer (_property-drawer contents _info)
  3004. "Transcode a PROPERTY-DRAWER element from Org to HTML.
  3005. CONTENTS holds the contents of the drawer. INFO is a plist
  3006. holding contextual information."
  3007. (and (org-string-nw-p contents)
  3008. (format "<pre class=\"example\">\n%s</pre>" contents)))
  3009. ;;;; Quote Block
  3010. (defun org-html-quote-block (quote-block contents _info)
  3011. "Transcode a QUOTE-BLOCK element from Org to HTML.
  3012. CONTENTS holds the contents of the block. INFO is a plist
  3013. holding contextual information."
  3014. (format "<blockquote%s>\n%s</blockquote>"
  3015. (let* ((name (org-element-property :name quote-block))
  3016. (attributes (org-export-read-attribute :attr_html quote-block))
  3017. (a (org-html--make-attribute-string
  3018. (if (or (not name) (plist-member attributes :id))
  3019. attributes
  3020. (plist-put attributes :id name)))))
  3021. (if (org-string-nw-p a) (concat " " a) ""))
  3022. contents))
  3023. ;;;; Section
  3024. (defun org-html-section (section contents info)
  3025. "Transcode a SECTION element from Org to HTML.
  3026. CONTENTS holds the contents of the section. INFO is a plist
  3027. holding contextual information."
  3028. (let ((parent (org-export-get-parent-headline section)))
  3029. ;; Before first headline: no container, just return CONTENTS.
  3030. (if (not parent) contents
  3031. ;; Get div's class and id references.
  3032. (let* ((class-num (+ (org-export-get-relative-level parent info)
  3033. (1- (plist-get info :html-toplevel-hlevel))))
  3034. (section-number
  3035. (and (org-export-numbered-headline-p parent info)
  3036. (mapconcat
  3037. #'number-to-string
  3038. (org-export-get-headline-number parent info) "-"))))
  3039. ;; Build return value.
  3040. (format "<div class=\"outline-text-%d\" id=\"text-%s\">\n%s</div>\n"
  3041. class-num
  3042. (or (org-element-property :CUSTOM_ID parent)
  3043. section-number
  3044. (org-export-get-reference parent info))
  3045. (or contents ""))))))
  3046. ;;;; Radio Target
  3047. (defun org-html-radio-target (radio-target text info)
  3048. "Transcode a RADIO-TARGET object from Org to HTML.
  3049. TEXT is the text of the target. INFO is a plist holding
  3050. contextual information."
  3051. (let ((ref (org-export-get-reference radio-target info)))
  3052. (org-html--anchor ref text nil info)))
  3053. ;;;; Special Block
  3054. (defun org-html-special-block (special-block contents info)
  3055. "Transcode a SPECIAL-BLOCK element from Org to HTML.
  3056. CONTENTS holds the contents of the block. INFO is a plist
  3057. holding contextual information."
  3058. (let* ((block-type (org-element-property :type special-block))
  3059. (html5-fancy (and (org-html--html5-fancy-p info)
  3060. (member block-type org-html-html5-elements)))
  3061. (attributes (org-export-read-attribute :attr_html special-block)))
  3062. (unless html5-fancy
  3063. (let ((class (plist-get attributes :class)))
  3064. (setq attributes (plist-put attributes :class
  3065. (if class (concat class " " block-type)
  3066. block-type)))))
  3067. (let* ((contents (or contents ""))
  3068. (name (org-element-property :name special-block))
  3069. (a (org-html--make-attribute-string
  3070. (if (or (not name) (plist-member attributes :id))
  3071. attributes
  3072. (plist-put attributes :id name))))
  3073. (str (if (org-string-nw-p a) (concat " " a) "")))
  3074. (if html5-fancy
  3075. (format "<%s%s>\n%s</%s>" block-type str contents block-type)
  3076. (format "<div%s>\n%s\n</div>" str contents)))))
  3077. ;;;; Src Block
  3078. (defun org-html-src-block (src-block _contents info)
  3079. "Transcode a SRC-BLOCK element from Org to HTML.
  3080. CONTENTS holds the contents of the item. INFO is a plist holding
  3081. contextual information."
  3082. (if (org-export-read-attribute :attr_html src-block :textarea)
  3083. (org-html--textarea-block src-block)
  3084. (let* ((lang (org-element-property :language src-block))
  3085. (code (org-html-format-code src-block info))
  3086. (label (let ((lbl (and (org-element-property :name src-block)
  3087. (org-export-get-reference src-block info))))
  3088. (if lbl (format " id=\"%s\"" lbl) "")))
  3089. (klipsify (and (plist-get info :html-klipsify-src)
  3090. (member lang '("javascript" "js"
  3091. "ruby" "scheme" "clojure" "php" "html")))))
  3092. (if (not lang) (format "<pre class=\"example\"%s>\n%s</pre>" label code)
  3093. (format "<div class=\"org-src-container\">\n%s%s\n</div>"
  3094. ;; Build caption.
  3095. (let ((caption (org-export-get-caption src-block)))
  3096. (if (not caption) ""
  3097. (let ((listing-number
  3098. (format
  3099. "<span class=\"listing-number\">%s </span>"
  3100. (format
  3101. (org-html--translate "Listing %d:" info)
  3102. (org-export-get-ordinal
  3103. src-block info nil #'org-html--has-caption-p)))))
  3104. (format "<label class=\"org-src-name\">%s%s</label>"
  3105. listing-number
  3106. (org-trim (org-export-data caption info))))))
  3107. ;; Contents.
  3108. (if klipsify
  3109. (format "<pre><code class=\"src src-%s\"%s%s>%s</code></pre>"
  3110. lang
  3111. label
  3112. (if (string= lang "html")
  3113. " data-editor-type=\"html\""
  3114. "")
  3115. code)
  3116. (format "<pre class=\"src src-%s\"%s>%s</pre>"
  3117. lang label code)))))))
  3118. ;;;; Statistics Cookie
  3119. (defun org-html-statistics-cookie (statistics-cookie _contents _info)
  3120. "Transcode a STATISTICS-COOKIE object from Org to HTML.
  3121. CONTENTS is nil. INFO is a plist holding contextual information."
  3122. (let ((cookie-value (org-element-property :value statistics-cookie)))
  3123. (format "<code>%s</code>" cookie-value)))
  3124. ;;;; Strike-Through
  3125. (defun org-html-strike-through (_strike-through contents info)
  3126. "Transcode STRIKE-THROUGH from Org to HTML.
  3127. CONTENTS is the text with strike-through markup. INFO is a plist
  3128. holding contextual information."
  3129. (format
  3130. (or (cdr (assq 'strike-through (plist-get info :html-text-markup-alist)))
  3131. "%s")
  3132. contents))
  3133. ;;;; Subscript
  3134. (defun org-html-subscript (_subscript contents _info)
  3135. "Transcode a SUBSCRIPT object from Org to HTML.
  3136. CONTENTS is the contents of the object. INFO is a plist holding
  3137. contextual information."
  3138. (format "<sub>%s</sub>" contents))
  3139. ;;;; Superscript
  3140. (defun org-html-superscript (_superscript contents _info)
  3141. "Transcode a SUPERSCRIPT object from Org to HTML.
  3142. CONTENTS is the contents of the object. INFO is a plist holding
  3143. contextual information."
  3144. (format "<sup>%s</sup>" contents))
  3145. ;;;; Table Cell
  3146. (defun org-html-table-cell (table-cell contents info)
  3147. "Transcode a TABLE-CELL element from Org to HTML.
  3148. CONTENTS is nil. INFO is a plist used as a communication
  3149. channel."
  3150. (let* ((table-row (org-export-get-parent table-cell))
  3151. (table (org-export-get-parent-table table-cell))
  3152. (cell-attrs
  3153. (if (not (plist-get info :html-table-align-individual-fields)) ""
  3154. (format (if (and (boundp 'org-html-format-table-no-css)
  3155. org-html-format-table-no-css)
  3156. " align=\"%s\"" " class=\"org-%s\"")
  3157. (org-export-table-cell-alignment table-cell info)))))
  3158. (when (or (not contents) (string= "" (org-trim contents)))
  3159. (setq contents "&#xa0;"))
  3160. (cond
  3161. ((and (org-export-table-has-header-p table info)
  3162. (= 1 (org-export-table-row-group table-row info)))
  3163. (let ((header-tags (plist-get info :html-table-header-tags)))
  3164. (concat "\n" (format (car header-tags) "col" cell-attrs)
  3165. contents
  3166. (cdr header-tags))))
  3167. ((and (plist-get info :html-table-use-header-tags-for-first-column)
  3168. (zerop (cdr (org-export-table-cell-address table-cell info))))
  3169. (let ((header-tags (plist-get info :html-table-header-tags)))
  3170. (concat "\n" (format (car header-tags) "row" cell-attrs)
  3171. contents
  3172. (cdr header-tags))))
  3173. (t (let ((data-tags (plist-get info :html-table-data-tags)))
  3174. (concat "\n" (format (car data-tags) cell-attrs)
  3175. contents
  3176. (cdr data-tags)))))))
  3177. ;;;; Table Row
  3178. (defun org-html-table-row (table-row contents info)
  3179. "Transcode a TABLE-ROW element from Org to HTML.
  3180. CONTENTS is the contents of the row. INFO is a plist used as a
  3181. communication channel."
  3182. ;; Rules are ignored since table separators are deduced from
  3183. ;; borders of the current row.
  3184. (when (eq (org-element-property :type table-row) 'standard)
  3185. (let* ((group (org-export-table-row-group table-row info))
  3186. (number (org-export-table-row-number table-row info))
  3187. (start-group-p
  3188. (org-export-table-row-starts-rowgroup-p table-row info))
  3189. (end-group-p
  3190. (org-export-table-row-ends-rowgroup-p table-row info))
  3191. (topp (and (equal start-group-p '(top))
  3192. (equal end-group-p '(below top))))
  3193. (bottomp (and (equal start-group-p '(above))
  3194. (equal end-group-p '(bottom above))))
  3195. (row-open-tag
  3196. (pcase (plist-get info :html-table-row-open-tag)
  3197. ((and accessor (pred functionp))
  3198. (funcall accessor
  3199. number group start-group-p end-group-p topp bottomp))
  3200. (accessor accessor)))
  3201. (row-close-tag
  3202. (pcase (plist-get info :html-table-row-close-tag)
  3203. ((and accessor (pred functionp))
  3204. (funcall accessor
  3205. number group start-group-p end-group-p topp bottomp))
  3206. (accessor accessor)))
  3207. (group-tags
  3208. (cond
  3209. ;; Row belongs to second or subsequent groups.
  3210. ((not (= 1 group)) '("<tbody>" . "\n</tbody>"))
  3211. ;; Row is from first group. Table has >=1 groups.
  3212. ((org-export-table-has-header-p
  3213. (org-export-get-parent-table table-row) info)
  3214. '("<thead>" . "\n</thead>"))
  3215. ;; Row is from first and only group.
  3216. (t '("<tbody>" . "\n</tbody>")))))
  3217. (concat (and start-group-p (car group-tags))
  3218. (concat "\n"
  3219. row-open-tag
  3220. contents
  3221. "\n"
  3222. row-close-tag)
  3223. (and end-group-p (cdr group-tags))))))
  3224. ;;;; Table
  3225. (defun org-html-table-first-row-data-cells (table info)
  3226. "Transcode the first row of TABLE.
  3227. INFO is a plist used as a communication channel."
  3228. (let ((table-row
  3229. (org-element-map table 'table-row
  3230. (lambda (row)
  3231. (unless (eq (org-element-property :type row) 'rule) row))
  3232. info 'first-match))
  3233. (special-column-p (org-export-table-has-special-column-p table)))
  3234. (if (not special-column-p) (org-element-contents table-row)
  3235. (cdr (org-element-contents table-row)))))
  3236. (defun org-html-table--table.el-table (table _info)
  3237. "Format table.el tables into HTML.
  3238. INFO is a plist used as a communication channel."
  3239. (when (eq (org-element-property :type table) 'table.el)
  3240. (require 'table)
  3241. (let ((outbuf (with-current-buffer
  3242. (get-buffer-create "*org-export-table*")
  3243. (erase-buffer) (current-buffer))))
  3244. (with-temp-buffer
  3245. (insert (org-element-property :value table))
  3246. (goto-char 1)
  3247. (re-search-forward "^[ \t]*|[^|]" nil t)
  3248. (table-generate-source 'html outbuf))
  3249. (with-current-buffer outbuf
  3250. (prog1 (org-trim (buffer-string))
  3251. (kill-buffer) )))))
  3252. (defun org-html-table (table contents info)
  3253. "Transcode a TABLE element from Org to HTML.
  3254. CONTENTS is the contents of the table. INFO is a plist holding
  3255. contextual information."
  3256. (if (eq (org-element-property :type table) 'table.el)
  3257. ;; "table.el" table. Convert it using appropriate tools.
  3258. (org-html-table--table.el-table table info)
  3259. ;; Standard table.
  3260. (let* ((caption (org-export-get-caption table))
  3261. (number (org-export-get-ordinal
  3262. table info nil #'org-html--has-caption-p))
  3263. (attributes
  3264. (org-html--make-attribute-string
  3265. (org-combine-plists
  3266. (and (org-element-property :name table)
  3267. (list :id (org-export-get-reference table info)))
  3268. (and (not (org-html-html5-p info))
  3269. (plist-get info :html-table-attributes))
  3270. (org-export-read-attribute :attr_html table))))
  3271. (alignspec
  3272. (if (bound-and-true-p org-html-format-table-no-css)
  3273. "align=\"%s\""
  3274. "class=\"org-%s\""))
  3275. (table-column-specs
  3276. (lambda (table info)
  3277. (mapconcat
  3278. (lambda (table-cell)
  3279. (let ((alignment (org-export-table-cell-alignment
  3280. table-cell info)))
  3281. (concat
  3282. ;; Begin a colgroup?
  3283. (when (org-export-table-cell-starts-colgroup-p
  3284. table-cell info)
  3285. "\n<colgroup>")
  3286. ;; Add a column. Also specify its alignment.
  3287. (format "\n%s"
  3288. (org-html-close-tag
  3289. "col" (concat " " (format alignspec alignment)) info))
  3290. ;; End a colgroup?
  3291. (when (org-export-table-cell-ends-colgroup-p
  3292. table-cell info)
  3293. "\n</colgroup>"))))
  3294. (org-html-table-first-row-data-cells table info) "\n"))))
  3295. (format "<table%s>\n%s\n%s\n%s</table>"
  3296. (if (equal attributes "") "" (concat " " attributes))
  3297. (if (not caption) ""
  3298. (format (if (plist-get info :html-table-caption-above)
  3299. "<caption class=\"t-above\">%s</caption>"
  3300. "<caption class=\"t-bottom\">%s</caption>")
  3301. (concat
  3302. "<span class=\"table-number\">"
  3303. (format (org-html--translate "Table %d:" info) number)
  3304. "</span> " (org-export-data caption info))))
  3305. (funcall table-column-specs table info)
  3306. contents))))
  3307. ;;;; Target
  3308. (defun org-html-target (target _contents info)
  3309. "Transcode a TARGET object from Org to HTML.
  3310. CONTENTS is nil. INFO is a plist holding contextual
  3311. information."
  3312. (let ((ref (org-export-get-reference target info)))
  3313. (org-html--anchor ref nil nil info)))
  3314. ;;;; Timestamp
  3315. (defun org-html-timestamp (timestamp _contents info)
  3316. "Transcode a TIMESTAMP object from Org to HTML.
  3317. CONTENTS is nil. INFO is a plist holding contextual
  3318. information."
  3319. (let ((value (org-html-plain-text (org-timestamp-translate timestamp) info)))
  3320. (format "<span class=\"timestamp-wrapper\"><span class=\"timestamp\">%s</span></span>"
  3321. (replace-regexp-in-string "--" "&#x2013;" value))))
  3322. ;;;; Underline
  3323. (defun org-html-underline (_underline contents info)
  3324. "Transcode UNDERLINE from Org to HTML.
  3325. CONTENTS is the text with underline markup. INFO is a plist
  3326. holding contextual information."
  3327. (format (or (cdr (assq 'underline (plist-get info :html-text-markup-alist)))
  3328. "%s")
  3329. contents))
  3330. ;;;; Verbatim
  3331. (defun org-html-verbatim (verbatim _contents info)
  3332. "Transcode VERBATIM from Org to HTML.
  3333. CONTENTS is nil. INFO is a plist holding contextual
  3334. information."
  3335. (format (or (cdr (assq 'verbatim (plist-get info :html-text-markup-alist))) "%s")
  3336. (org-html-encode-plain-text (org-element-property :value verbatim))))
  3337. ;;;; Verse Block
  3338. (defun org-html-verse-block (_verse-block contents info)
  3339. "Transcode a VERSE-BLOCK element from Org to HTML.
  3340. CONTENTS is verse block contents. INFO is a plist holding
  3341. contextual information."
  3342. (format "<p class=\"verse\">\n%s</p>"
  3343. ;; Replace leading white spaces with non-breaking spaces.
  3344. (replace-regexp-in-string
  3345. "^[ \t]+" (lambda (m) (org-html--make-string (length m) "&#xa0;"))
  3346. ;; Replace each newline character with line break. Also
  3347. ;; remove any trailing "br" close-tag so as to avoid
  3348. ;; duplicates.
  3349. (let* ((br (org-html-close-tag "br" nil info))
  3350. (re (format "\\(?:%s\\)?[ \t]*\n" (regexp-quote br))))
  3351. (replace-regexp-in-string re (concat br "\n") contents)))))
  3352. ;;; Filter Functions
  3353. (defun org-html-final-function (contents _backend info)
  3354. "Filter to indent the HTML and convert HTML entities."
  3355. (with-temp-buffer
  3356. (insert contents)
  3357. (set-auto-mode t)
  3358. (when (plist-get info :html-indent)
  3359. (indent-region (point-min) (point-max)))
  3360. (buffer-substring-no-properties (point-min) (point-max))))
  3361. ;;; End-user functions
  3362. ;;;###autoload
  3363. (defun org-html-export-as-html
  3364. (&optional async subtreep visible-only body-only ext-plist)
  3365. "Export current buffer to an HTML buffer.
  3366. If narrowing is active in the current buffer, only export its
  3367. narrowed part.
  3368. If a region is active, export that region.
  3369. A non-nil optional argument ASYNC means the process should happen
  3370. asynchronously. The resulting buffer should be accessible
  3371. through the `org-export-stack' interface.
  3372. When optional argument SUBTREEP is non-nil, export the sub-tree
  3373. at point, extracting information from the headline properties
  3374. first.
  3375. When optional argument VISIBLE-ONLY is non-nil, don't export
  3376. contents of hidden elements.
  3377. When optional argument BODY-ONLY is non-nil, only write code
  3378. between \"<body>\" and \"</body>\" tags.
  3379. EXT-PLIST, when provided, is a property list with external
  3380. parameters overriding Org default settings, but still inferior to
  3381. file-local settings.
  3382. Export is done in a buffer named \"*Org HTML Export*\", which
  3383. will be displayed when `org-export-show-temporary-export-buffer'
  3384. is non-nil."
  3385. (interactive)
  3386. (org-export-to-buffer 'html "*Org HTML Export*"
  3387. async subtreep visible-only body-only ext-plist
  3388. (lambda () (set-auto-mode t))))
  3389. ;;;###autoload
  3390. (defun org-html-convert-region-to-html ()
  3391. "Assume the current region has Org syntax, and convert it to HTML.
  3392. This can be used in any buffer. For example, you can write an
  3393. itemized list in Org syntax in an HTML buffer and use this command
  3394. to convert it."
  3395. (interactive)
  3396. (org-export-replace-region-by 'html))
  3397. ;;;###autoload
  3398. (defun org-html-export-to-html
  3399. (&optional async subtreep visible-only body-only ext-plist)
  3400. "Export current buffer to a HTML file.
  3401. If narrowing is active in the current buffer, only export its
  3402. narrowed part.
  3403. If a region is active, export that region.
  3404. A non-nil optional argument ASYNC means the process should happen
  3405. asynchronously. The resulting file should be accessible through
  3406. the `org-export-stack' interface.
  3407. When optional argument SUBTREEP is non-nil, export the sub-tree
  3408. at point, extracting information from the headline properties
  3409. first.
  3410. When optional argument VISIBLE-ONLY is non-nil, don't export
  3411. contents of hidden elements.
  3412. When optional argument BODY-ONLY is non-nil, only write code
  3413. between \"<body>\" and \"</body>\" tags.
  3414. EXT-PLIST, when provided, is a property list with external
  3415. parameters overriding Org default settings, but still inferior to
  3416. file-local settings.
  3417. Return output file's name."
  3418. (interactive)
  3419. (let* ((extension (concat "." (or (plist-get ext-plist :html-extension)
  3420. org-html-extension
  3421. "html")))
  3422. (file (org-export-output-file-name extension subtreep))
  3423. (org-export-coding-system org-html-coding-system))
  3424. (org-export-to-file 'html file
  3425. async subtreep visible-only body-only ext-plist)))
  3426. ;;;###autoload
  3427. (defun org-html-publish-to-html (plist filename pub-dir)
  3428. "Publish an org file to HTML.
  3429. FILENAME is the filename of the Org file to be published. PLIST
  3430. is the property list for the given project. PUB-DIR is the
  3431. publishing directory.
  3432. Return output file name."
  3433. (org-publish-org-to 'html filename
  3434. (concat "." (or (plist-get plist :html-extension)
  3435. org-html-extension
  3436. "html"))
  3437. plist pub-dir))
  3438. (provide 'ox-html)
  3439. ;; Local variables:
  3440. ;; generated-autoload-file: "org-loaddefs.el"
  3441. ;; End:
  3442. ;;; ox-html.el ends here