org-exp.el 104 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839
  1. ;;; org-exp.el --- ASCII, HTML, XOXO and iCalendar export for Org-mode
  2. ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
  3. ;; Free Software Foundation, Inc.
  4. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  5. ;; Keywords: outlines, hypermedia, calendar, wp
  6. ;; Homepage: http://orgmode.org
  7. ;; Version: 7.01trans
  8. ;;
  9. ;; This file is part of GNU Emacs.
  10. ;;
  11. ;; GNU Emacs is free software: you can redistribute it and/or modify
  12. ;; it under the terms of the GNU General Public License as published by
  13. ;; the Free Software Foundation, either version 3 of the License, or
  14. ;; (at your option) any later version.
  15. ;; GNU Emacs is distributed in the hope that it will be useful,
  16. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. ;; GNU General Public License for more details.
  19. ;; You should have received a copy of the GNU General Public License
  20. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  21. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  22. ;;
  23. ;;; Commentary:
  24. ;;; Code:
  25. (require 'org)
  26. (require 'org-macs)
  27. (require 'org-agenda)
  28. (require 'org-exp-blocks)
  29. (require 'ob-exp)
  30. (require 'org-src)
  31. (eval-when-compile
  32. (require 'cl))
  33. (declare-function org-export-latex-preprocess "org-latex" (parameters))
  34. (declare-function org-export-ascii-preprocess "org-ascii" (parameters))
  35. (declare-function org-export-html-preprocess "org-html" (parameters))
  36. (declare-function org-export-docbook-preprocess "org-docbook" (parameters))
  37. (declare-function org-infojs-options-inbuffer-template "org-jsinfo" ())
  38. (declare-function org-export-htmlize-region-for-paste "org-html" (beg end))
  39. (declare-function htmlize-buffer "ext:htmlize" (&optional buffer))
  40. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  41. (declare-function org-table-cookie-line-p "org-table" (line))
  42. (declare-function org-table-colgroup-line-p "org-table" (line))
  43. (autoload 'org-export-generic "org-export-generic" "Export using the generic exporter" t)
  44. (defgroup org-export nil
  45. "Options for exporting org-listings."
  46. :tag "Org Export"
  47. :group 'org)
  48. (defgroup org-export-general nil
  49. "General options for exporting Org-mode files."
  50. :tag "Org Export General"
  51. :group 'org-export)
  52. (defcustom org-export-allow-BIND 'confirm
  53. "Non-nil means allow #+BIND to define local variable values for export.
  54. This is a potential security risk, which is why the user must confirm the
  55. use of these lines."
  56. :group 'org-export-general
  57. :type '(choice
  58. (const :tag "Never" nil)
  59. (const :tag "Always" t)
  60. (const :tag "Make the user confirm for each file" confirm)))
  61. ;; FIXME
  62. (defvar org-export-publishing-directory nil)
  63. (defcustom org-export-show-temporary-export-buffer t
  64. "Non-nil means show buffer after exporting to temp buffer.
  65. When Org exports to a file, the buffer visiting that file is ever
  66. shown, but remains buried. However, when exporting to a temporary
  67. buffer, that buffer is popped up in a second window. When this variable
  68. is nil, the buffer remains buried also in these cases."
  69. :group 'org-export-general
  70. :type 'boolean)
  71. (defcustom org-export-copy-to-kill-ring t
  72. "Non-nil means exported stuff will also be pushed onto the kill ring."
  73. :group 'org-export-general
  74. :type 'boolean)
  75. (defcustom org-export-kill-product-buffer-when-displayed nil
  76. "Non-nil means kill the product buffer if it is displayed immediately.
  77. This applied to the commands `org-export-html-and-open' and
  78. `org-export-as-pdf-and-open'."
  79. :group 'org-export-general
  80. :type 'boolean)
  81. (defcustom org-export-run-in-background nil
  82. "Non-nil means export and publishing commands will run in background.
  83. This works by starting up a separate Emacs process visiting the same file
  84. and doing the export from there.
  85. Not all export commands are affected by this - only the ones which
  86. actually write to a file, and that do not depend on the buffer state.
  87. \\<org-mode-map>
  88. If this option is nil, you can still get background export by calling
  89. `org-export' with a double prefix arg: \
  90. \\[universal-argument] \\[universal-argument] \\[org-export].
  91. If this option is t, the double prefix can be used to exceptionally
  92. force an export command into the current process."
  93. :group 'org-export-general
  94. :type 'boolean)
  95. (defcustom org-export-select-tags '("export")
  96. "Tags that select a tree for export.
  97. If any such tag is found in a buffer, all trees that do not carry one
  98. of these tags will be deleted before export.
  99. Inside trees that are selected like this, you can still deselect a
  100. subtree by tagging it with one of the `org-export-exclude-tags'."
  101. :group 'org-export-general
  102. :type '(repeat (string :tag "Tag")))
  103. (defcustom org-export-exclude-tags '("noexport")
  104. "Tags that exclude a tree from export.
  105. All trees carrying any of these tags will be excluded from export.
  106. This is without condition, so even subtrees inside that carry one of the
  107. `org-export-select-tags' will be removed."
  108. :group 'org-export-general
  109. :type '(repeat (string :tag "Tag")))
  110. ;; FIXME: rename, this is a general variable
  111. (defcustom org-export-html-expand t
  112. "Non-nil means for HTML export, treat @<...> as HTML tag.
  113. When nil, these tags will be exported as plain text and therefore
  114. not be interpreted by a browser.
  115. This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
  116. :group 'org-export-html
  117. :group 'org-export-general
  118. :type 'boolean)
  119. (defcustom org-export-with-special-strings t
  120. "Non-nil means interpret \"\-\", \"--\" and \"---\" for export.
  121. When this option is turned on, these strings will be exported as:
  122. Org HTML LaTeX
  123. -----+----------+--------
  124. \\- &shy; \\-
  125. -- &ndash; --
  126. --- &mdash; ---
  127. ... &hellip; \ldots
  128. This option can also be set with the +OPTIONS line, e.g. \"-:nil\"."
  129. :group 'org-export-translation
  130. :type 'boolean)
  131. (defcustom org-export-html-link-up ""
  132. "Where should the \"UP\" link of exported HTML pages lead?"
  133. :group 'org-export-html
  134. :group 'org-export-general
  135. :type '(string :tag "File or URL"))
  136. (defcustom org-export-html-link-home ""
  137. "Where should the \"HOME\" link of exported HTML pages lead?"
  138. :group 'org-export-html
  139. :group 'org-export-general
  140. :type '(string :tag "File or URL"))
  141. (defcustom org-export-language-setup
  142. '(("en" "Author" "Date" "Table of Contents" "Footnotes")
  143. ("ca" "Autor" "Data" "&Iacute;ndex" "Peus de p&agrave;gina")
  144. ("cs" "Autor" "Datum" "Obsah" "Pozn\xe1mky pod carou")
  145. ("da" "Ophavsmand" "Dato" "Indhold" "Fodnoter")
  146. ("de" "Autor" "Datum" "Inhaltsverzeichnis" "Fu&szlig;noten")
  147. ("eo" "A&#365;toro" "Dato" "Enhavo" "Piednotoj")
  148. ("es" "Autor" "Fecha" "&Iacute;ndice" "Pies de p&aacute;gina")
  149. ("fi" "Tekij&auml;" "P&auml;iv&auml;m&auml;&auml;r&auml;" "Sis&auml;llysluettelo" "Alaviitteet")
  150. ("fr" "Auteur" "Date" "Table des mati&egrave;res" "Notes de bas de page")
  151. ("hu" "Szerz&otilde;" "D&aacute;tum" "Tartalomjegyz&eacute;k" "L&aacute;bjegyzet")
  152. ("is" "H&ouml;fundur" "Dagsetning" "Efnisyfirlit" "Aftanm&aacute;lsgreinar")
  153. ("it" "Autore" "Data" "Indice" "Note a pi&egrave; di pagina")
  154. ("nl" "Auteur" "Datum" "Inhoudsopgave" "Voetnoten")
  155. ("no" "Forfatter" "Dato" "Innhold" "Fotnoter")
  156. ("nb" "Forfatter" "Dato" "Innhold" "Fotnoter") ;; nb = Norsk (bokm.l)
  157. ("nn" "Forfattar" "Dato" "Innhald" "Fotnotar") ;; nn = Norsk (nynorsk)
  158. ("pl" "Autor" "Data" "Spis tre&sacute;ci" "Przypis")
  159. ("sv" "F&ouml;rfattare" "Datum" "Inneh&aring;ll" "Fotnoter"))
  160. "Terms used in export text, translated to different languages.
  161. Use the variable `org-export-default-language' to set the language,
  162. or use the +OPTION lines for a per-file setting."
  163. :group 'org-export-general
  164. :type '(repeat
  165. (list
  166. (string :tag "HTML language tag")
  167. (string :tag "Author")
  168. (string :tag "Date")
  169. (string :tag "Table of Contents")
  170. (string :tag "Footnotes"))))
  171. (defcustom org-export-default-language "en"
  172. "The default language of HTML export, as a string.
  173. This should have an association in `org-export-language-setup'."
  174. :group 'org-export-general
  175. :type 'string)
  176. (defvar org-export-page-description ""
  177. "The page description, for the XHTML meta tag.
  178. This is best set with the #+DESCRIPTION line in a file, it does not make
  179. sense to set this globally.")
  180. (defvar org-export-page-keywords ""
  181. "The page description, for the XHTML meta tag.
  182. This is best set with the #+KEYWORDS line in a file, it does not make
  183. sense to set this globally.")
  184. (defcustom org-export-skip-text-before-1st-heading nil
  185. "Non-nil means skip all text before the first headline when exporting.
  186. When nil, that text is exported as well."
  187. :group 'org-export-general
  188. :type 'boolean)
  189. (defcustom org-export-headline-levels 3
  190. "The last level which is still exported as a headline.
  191. Inferior levels will produce itemize lists when exported.
  192. Note that a numeric prefix argument to an exporter function overrides
  193. this setting.
  194. This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
  195. :group 'org-export-general
  196. :type 'integer)
  197. (defcustom org-export-with-section-numbers t
  198. "Non-nil means add section numbers to headlines when exporting.
  199. This option can also be set with the +OPTIONS line, e.g. \"num:t\"."
  200. :group 'org-export-general
  201. :type 'boolean)
  202. (defcustom org-export-section-number-format '((("1" ".")) . "")
  203. "Format of section numbers for export.
  204. The variable has two components.
  205. 1. A list of lists, each indicating a counter type and a separator.
  206. The counter type can be any of \"1\", \"A\", \"a\", \"I\", or \"i\".
  207. It causes causes numeric, alphabetic, or roman counters, respectively.
  208. The separator is only used if another counter for a subsection is being
  209. added.
  210. If there are more numbered section levels than entries in this lists,
  211. then the last entry will be reused.
  212. 2. A terminator string that will be added after the entire
  213. section number."
  214. :group 'org-export-general
  215. :type '(cons
  216. (repeat
  217. (list
  218. (string :tag "Counter Type")
  219. (string :tag "Separator ")))
  220. (string :tag "Terminator")))
  221. (defcustom org-export-with-toc t
  222. "Non-nil means create a table of contents in exported files.
  223. The TOC contains headlines with levels up to`org-export-headline-levels'.
  224. When an integer, include levels up to N in the toc, this may then be
  225. different from `org-export-headline-levels', but it will not be allowed
  226. to be larger than the number of headline levels.
  227. When nil, no table of contents is made.
  228. Headlines which contain any TODO items will be marked with \"(*)\" in
  229. ASCII export, and with red color in HTML output, if the option
  230. `org-export-mark-todo-in-toc' is set.
  231. In HTML output, the TOC will be clickable.
  232. This option can also be set with the +OPTIONS line, e.g. \"toc:nil\"
  233. or \"toc:3\"."
  234. :group 'org-export-general
  235. :type '(choice
  236. (const :tag "No Table of Contents" nil)
  237. (const :tag "Full Table of Contents" t)
  238. (integer :tag "TOC to level")))
  239. (defcustom org-export-mark-todo-in-toc nil
  240. "Non-nil means mark TOC lines that contain any open TODO items."
  241. :group 'org-export-general
  242. :type 'boolean)
  243. (defcustom org-export-with-todo-keywords t
  244. "Non-nil means include TODO keywords in export.
  245. When nil, remove all these keywords from the export."
  246. :group 'org-export-general
  247. :type 'boolean)
  248. (defcustom org-export-with-priority nil
  249. "Non-nil means include priority cookies in export.
  250. When nil, remove priority cookies for export."
  251. :group 'org-export-general
  252. :type 'boolean)
  253. (defcustom org-export-preserve-breaks nil
  254. "Non-nil means preserve all line breaks when exporting.
  255. Normally, in HTML output paragraphs will be reformatted. In ASCII
  256. export, line breaks will always be preserved, regardless of this variable.
  257. This option can also be set with the +OPTIONS line, e.g. \"\\n:t\"."
  258. :group 'org-export-general
  259. :type 'boolean)
  260. (defcustom org-export-with-archived-trees 'headline
  261. "Whether subtrees with the ARCHIVE tag should be exported.
  262. This can have three different values
  263. nil Do not export, pretend this tree is not present
  264. t Do export the entire tree
  265. headline Only export the headline, but skip the tree below it."
  266. :group 'org-export-general
  267. :group 'org-archive
  268. :type '(choice
  269. (const :tag "not at all" nil)
  270. (const :tag "headline only" 'headline)
  271. (const :tag "entirely" t)))
  272. (defcustom org-export-author-info t
  273. "Non-nil means insert author name and email into the exported file.
  274. This option can also be set with the +OPTIONS line,
  275. e.g. \"author:nil\"."
  276. :group 'org-export-general
  277. :type 'boolean)
  278. (defcustom org-export-email-info nil
  279. "Non-nil means insert author name and email into the exported file.
  280. This option can also be set with the +OPTIONS line,
  281. e.g. \"email:t\"."
  282. :group 'org-export-general
  283. :type 'boolean)
  284. (defcustom org-export-creator-info t
  285. "Non-nil means the postamble should contain a creator sentence.
  286. This sentence is \"HTML generated by org-mode XX in emacs XXX\"."
  287. :group 'org-export-general
  288. :type 'boolean)
  289. (defcustom org-export-time-stamp-file t
  290. "Non-nil means insert a time stamp into the exported file.
  291. The time stamp shows when the file was created.
  292. This option can also be set with the +OPTIONS line,
  293. e.g. \"timestamp:nil\"."
  294. :group 'org-export-general
  295. :type 'boolean)
  296. (defcustom org-export-with-timestamps t
  297. "If nil, do not export time stamps and associated keywords."
  298. :group 'org-export-general
  299. :type 'boolean)
  300. (defcustom org-export-remove-timestamps-from-toc t
  301. "If t, remove timestamps from the table of contents entries."
  302. :group 'org-export-general
  303. :type 'boolean)
  304. (defcustom org-export-with-tags 'not-in-toc
  305. "If nil, do not export tags, just remove them from headlines.
  306. If this is the symbol `not-in-toc', tags will be removed from table of
  307. contents entries, but still be shown in the headlines of the document.
  308. This option can also be set with the +OPTIONS line, e.g. \"tags:nil\"."
  309. :group 'org-export-general
  310. :type '(choice
  311. (const :tag "Off" nil)
  312. (const :tag "Not in TOC" not-in-toc)
  313. (const :tag "On" t)))
  314. (defcustom org-export-with-drawers nil
  315. "Non-nil means export with drawers like the property drawer.
  316. When t, all drawers are exported. This may also be a list of
  317. drawer names to export."
  318. :group 'org-export-general
  319. :type '(choice
  320. (const :tag "All drawers" t)
  321. (const :tag "None" nil)
  322. (repeat :tag "Selected drawers"
  323. (string :tag "Drawer name"))))
  324. (defvar org-export-first-hook nil
  325. "Hook called as the first thing in each exporter.
  326. Point will be still in the original buffer.
  327. Good for general initialization")
  328. (defvar org-export-preprocess-hook nil
  329. "Hook for preprocessing an export buffer.
  330. Pretty much the first thing when exporting is running this hook.
  331. Point will be in a temporary buffer that contains a copy of
  332. the original buffer, or of the section that is being export.
  333. All the other hooks in the org-export-preprocess... category
  334. also work in that temporary buffer, already modified by various
  335. stages of the processing.")
  336. (defvar org-export-preprocess-after-include-files-hook nil
  337. "Hook for preprocessing an export buffer.
  338. This is run after the contents of included files have been inserted.")
  339. (defvar org-export-preprocess-after-tree-selection-hook nil
  340. "Hook for preprocessing an export buffer.
  341. This is run after selection of trees to be exported has happened.
  342. This selection includes tags-based selection, as well as removal
  343. of commented and archived trees.")
  344. (defvar org-export-preprocess-after-headline-targets-hook nil
  345. "Hook for preprocessing export buffer.
  346. This is run just after the headline targets have been defined and
  347. the target-alist has been set up.")
  348. (defvar org-export-preprocess-before-selecting-backend-code-hook nil
  349. "Hook for preprocessing an export buffer.
  350. This is run just before backend-specific blocks get selected.")
  351. (defvar org-export-preprocess-after-blockquote-hook nil
  352. "Hook for preprocessing an export buffer.
  353. This is run after blockquote/quote/verse/center have been marked
  354. with cookies.")
  355. (defvar org-export-preprocess-after-radio-targets-hook nil
  356. "Hook for preprocessing an export buffer.
  357. This is run after radio target processing.")
  358. (defvar org-export-preprocess-before-normalizing-links-hook nil
  359. "Hook for preprocessing an export buffer.
  360. This hook is run before links are normalized.")
  361. (defvar org-export-preprocess-before-backend-specifics-hook nil
  362. "Hook run before backend-specific functions are called during preprocessing.")
  363. (defvar org-export-preprocess-final-hook nil
  364. "Hook for preprocessing an export buffer.
  365. This is run as the last thing in the preprocessing buffer, just before
  366. returning the buffer string to the backend.")
  367. (defgroup org-export-translation nil
  368. "Options for translating special ascii sequences for the export backends."
  369. :tag "Org Export Translation"
  370. :group 'org-export)
  371. (defcustom org-export-with-emphasize t
  372. "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
  373. If the export target supports emphasizing text, the word will be
  374. typeset in bold, italic, or underlined, respectively. Works only for
  375. single words, but you can say: I *really* *mean* *this*.
  376. Not all export backends support this.
  377. This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
  378. :group 'org-export-translation
  379. :type 'boolean)
  380. (defcustom org-export-with-footnotes t
  381. "If nil, export [1] as a footnote marker.
  382. Lines starting with [1] will be formatted as footnotes.
  383. This option can also be set with the +OPTIONS line, e.g. \"f:nil\"."
  384. :group 'org-export-translation
  385. :type 'boolean)
  386. (defcustom org-export-with-TeX-macros t
  387. "Non-nil means interpret simple TeX-like macros when exporting.
  388. For example, HTML export converts \\alpha to &alpha; and \\AA to &Aring;.
  389. Not only real TeX macros will work here, but the standard HTML entities
  390. for math can be used as macro names as well. For a list of supported
  391. names in HTML export, see the constant `org-entities' and the user option
  392. `org-entities-user'.
  393. Not all export backends support this.
  394. This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
  395. :group 'org-export-translation
  396. :group 'org-export-latex
  397. :type 'boolean)
  398. (defcustom org-export-with-LaTeX-fragments t
  399. "Non-nil means process LaTeX math fragments for HTML display.
  400. When set, the exporter will find and process LaTeX environments if the
  401. \\begin line is the first non-white thing on a line. It will also find
  402. and process the math delimiters like $a=b$ and \\( a=b \\) for inline math,
  403. $$a=b$$ and \\[ a=b \\] for display math.
  404. This option can also be set with the +OPTIONS line, e.g. \"LaTeX:mathjax\".
  405. Allowed values are:
  406. nil Don't do anything.
  407. verbatim Keep eveything in verbatim
  408. dvipng Process the LaTeX fragments to images.
  409. This will also include processing of non-math environments.
  410. t Do MathJax preprocessing if there is at least on math snippet,
  411. and arrange for MathJax.js to be loaded.
  412. The default is nil, because this option needs the `dvipng' program which
  413. is not available on all systems."
  414. :group 'org-export-translation
  415. :group 'org-export-latex
  416. :type '(choice
  417. (const :tag "Do not process math in any way" nil)
  418. (const :tag "Obsolete, use dvipng setting" t)
  419. (const :tag "Use dvipng to make images" dvipng)
  420. (const :tag "Use MathJax to display math" mathjax)
  421. (const :tag "Leave math verbatim" verbatim)))
  422. (defcustom org-export-with-fixed-width t
  423. "Non-nil means lines starting with \":\" will be in fixed width font.
  424. This can be used to have pre-formatted text, fragments of code etc. For
  425. example:
  426. : ;; Some Lisp examples
  427. : (while (defc cnt)
  428. : (ding))
  429. will be looking just like this in also HTML. See also the QUOTE keyword.
  430. Not all export backends support this.
  431. This option can also be set with the +OPTIONS line, e.g. \"::nil\"."
  432. :group 'org-export-translation
  433. :type 'boolean)
  434. (defgroup org-export-tables nil
  435. "Options for exporting tables in Org-mode."
  436. :tag "Org Export Tables"
  437. :group 'org-export)
  438. (defcustom org-export-with-tables t
  439. "If non-nil, lines starting with \"|\" define a table.
  440. For example:
  441. | Name | Address | Birthday |
  442. |-------------+----------+-----------|
  443. | Arthur Dent | England | 29.2.2100 |
  444. Not all export backends support this.
  445. This option can also be set with the +OPTIONS line, e.g. \"|:nil\"."
  446. :group 'org-export-tables
  447. :type 'boolean)
  448. (defcustom org-export-highlight-first-table-line t
  449. "Non-nil means highlight the first table line.
  450. In HTML export, this means use <th> instead of <td>.
  451. In tables created with table.el, this applies to the first table line.
  452. In Org-mode tables, all lines before the first horizontal separator
  453. line will be formatted with <th> tags."
  454. :group 'org-export-tables
  455. :type 'boolean)
  456. (defcustom org-export-table-remove-special-lines t
  457. "Remove special lines and marking characters in calculating tables.
  458. This removes the special marking character column from tables that are set
  459. up for spreadsheet calculations. It also removes the entire lines
  460. marked with `!', `_', or `^'. The lines with `$' are kept, because
  461. the values of constants may be useful to have."
  462. :group 'org-export-tables
  463. :type 'boolean)
  464. (defcustom org-export-prefer-native-exporter-for-tables nil
  465. "Non-nil means always export tables created with table.el natively.
  466. Natively means use the HTML code generator in table.el.
  467. When nil, Org-mode's own HTML generator is used when possible (i.e. if
  468. the table does not use row- or column-spanning). This has the
  469. advantage, that the automatic HTML conversions for math symbols and
  470. sub/superscripts can be applied. Org-mode's HTML generator is also
  471. much faster. The LaTeX exporter always use the native exporter for
  472. table.el tables."
  473. :group 'org-export-tables
  474. :type 'boolean)
  475. (defgroup org-export-xml nil
  476. "Options specific for XML export of Org-mode files."
  477. :tag "Org Export XML"
  478. :group 'org-export)
  479. ;;;; Exporting
  480. ;;; Variables, constants, and parameter plists
  481. (defconst org-level-max 20)
  482. (defvar org-current-export-file nil) ; dynamically scoped parameter
  483. (defvar org-current-export-dir nil) ; dynamically scoped parameter
  484. (defvar org-export-opt-plist nil
  485. "Contains the current option plist.")
  486. (defvar org-last-level nil) ; dynamically scoped variable
  487. (defvar org-min-level nil) ; dynamically scoped variable
  488. (defvar org-levels-open nil) ; dynamically scoped parameter
  489. (defconst org-export-plist-vars
  490. '((:link-up nil org-export-html-link-up)
  491. (:link-home nil org-export-html-link-home)
  492. (:language nil org-export-default-language)
  493. (:keywords nil org-export-page-keywords)
  494. (:description nil org-export-page-description)
  495. (:customtime nil org-display-custom-times)
  496. (:headline-levels "H" org-export-headline-levels)
  497. (:section-numbers "num" org-export-with-section-numbers)
  498. (:section-number-format nil org-export-section-number-format)
  499. (:table-of-contents "toc" org-export-with-toc)
  500. (:preserve-breaks "\\n" org-export-preserve-breaks)
  501. (:archived-trees nil org-export-with-archived-trees)
  502. (:emphasize "*" org-export-with-emphasize)
  503. (:sub-superscript "^" org-export-with-sub-superscripts)
  504. (:special-strings "-" org-export-with-special-strings)
  505. (:footnotes "f" org-export-with-footnotes)
  506. (:drawers "d" org-export-with-drawers)
  507. (:tags "tags" org-export-with-tags)
  508. (:todo-keywords "todo" org-export-with-todo-keywords)
  509. (:priority "pri" org-export-with-priority)
  510. (:TeX-macros "TeX" org-export-with-TeX-macros)
  511. (:LaTeX-fragments "LaTeX" org-export-with-LaTeX-fragments)
  512. (:latex-listings nil org-export-latex-listings)
  513. (:skip-before-1st-heading "skip" org-export-skip-text-before-1st-heading)
  514. (:fixed-width ":" org-export-with-fixed-width)
  515. (:timestamps "<" org-export-with-timestamps)
  516. (:author-info "author" org-export-author-info)
  517. (:email-info "email" org-export-email-info)
  518. (:creator-info "creator" org-export-creator-info)
  519. (:time-stamp-file "timestamp" org-export-time-stamp-file)
  520. (:tables "|" org-export-with-tables)
  521. (:table-auto-headline nil org-export-highlight-first-table-line)
  522. (:style-include-default nil org-export-html-style-include-default)
  523. (:style-include-scripts nil org-export-html-style-include-scripts)
  524. (:style nil org-export-html-style)
  525. (:style-extra nil org-export-html-style-extra)
  526. (:agenda-style nil org-agenda-export-html-style)
  527. (:convert-org-links nil org-export-html-link-org-files-as-html)
  528. (:inline-images nil org-export-html-inline-images)
  529. (:html-extension nil org-export-html-extension)
  530. (:xml-declaration nil org-export-html-xml-declaration)
  531. (:html-table-tag nil org-export-html-table-tag)
  532. (:expand-quoted-html "@" org-export-html-expand)
  533. (:timestamp nil org-export-html-with-timestamp)
  534. (:publishing-directory nil org-export-publishing-directory)
  535. (:preamble nil org-export-html-preamble)
  536. (:postamble nil org-export-html-postamble)
  537. (:auto-preamble nil org-export-html-auto-preamble)
  538. (:auto-postamble nil org-export-html-auto-postamble)
  539. (:author nil user-full-name)
  540. (:email nil user-mail-address)
  541. (:select-tags nil org-export-select-tags)
  542. (:exclude-tags nil org-export-exclude-tags)
  543. (:latex-image-options nil org-export-latex-image-default-option))
  544. "List of properties that represent export/publishing variables.
  545. Each element is a list of 3 items:
  546. 1. The property that is used internally, and also for org-publish-project-alist
  547. 2. The string that can be used in the OPTION lines to set this option,
  548. or nil if this option cannot be changed in this way
  549. 3. The customization variable that sets the default for this option."
  550. )
  551. (defun org-default-export-plist ()
  552. "Return the property list with default settings for the export variables."
  553. (let* ((infile (org-infile-export-plist))
  554. (letbind (plist-get infile :let-bind))
  555. (l org-export-plist-vars) rtn e s v)
  556. (while (setq e (pop l))
  557. (setq s (nth 2 e)
  558. v (cond
  559. ((assq s letbind) (nth 1 (assq s letbind)))
  560. ((boundp s) (symbol-value s))
  561. (t nil))
  562. rtn (cons (car e) (cons v rtn))))
  563. rtn))
  564. (defvar org-export-inbuffer-options-extra nil
  565. "List of additional in-buffer options that should be detected.
  566. Just before export, the buffer is scanned for options like #+TITLE, #+EMAIL,
  567. etc. Extensions can add to this list to get their options detected, and they
  568. can then add a function to `org-export-options-filters' to process these
  569. options.
  570. Each element in this list must be a list, with the in-buffer keyword as car,
  571. and a property (a symbol) as the next element. All occurrences of the
  572. keyword will be found, the values concatenated with a space character
  573. in between, and the result stored in the export options property list.")
  574. (defvar org-export-options-filters nil
  575. "Functions to be called to finalize the export/publishing options.
  576. All these options are stored in a property list, and each of the functions
  577. in this hook gets a chance to modify this property list. Each function
  578. must accept the property list as an argument, and must return the (possibly
  579. modified) list.")
  580. ;; FIXME: should we fold case here?
  581. (defun org-infile-export-plist ()
  582. "Return the property list with file-local settings for export."
  583. (save-excursion
  584. (save-restriction
  585. (widen)
  586. (goto-char (point-min))
  587. (let ((re (org-make-options-regexp
  588. (append
  589. '("TITLE" "AUTHOR" "DATE" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"
  590. "MATHJAX"
  591. "LINK_UP" "LINK_HOME" "SETUPFILE" "STYLE"
  592. "LATEX_HEADER" "LATEX_CLASS"
  593. "EXPORT_SELECT_TAGS" "EXPORT_EXCLUDE_TAGS"
  594. "KEYWORDS" "DESCRIPTION" "MACRO" "BIND" "XSLT")
  595. (mapcar 'car org-export-inbuffer-options-extra))))
  596. p key val text options mathjax a pr style
  597. latex-header latex-class macros letbind
  598. ext-setup-or-nil setup-contents (start 0))
  599. (while (or (and ext-setup-or-nil
  600. (string-match re ext-setup-or-nil start)
  601. (setq start (match-end 0)))
  602. (and (setq ext-setup-or-nil nil start 0)
  603. (re-search-forward re nil t)))
  604. (setq key (upcase (org-match-string-no-properties 1 ext-setup-or-nil))
  605. val (org-match-string-no-properties 2 ext-setup-or-nil))
  606. (cond
  607. ((setq a (assoc key org-export-inbuffer-options-extra))
  608. (setq pr (nth 1 a))
  609. (setq p (plist-put p pr (concat (plist-get p pr) " " val))))
  610. ((string-equal key "TITLE") (setq p (plist-put p :title val)))
  611. ((string-equal key "AUTHOR")(setq p (plist-put p :author val)))
  612. ((string-equal key "EMAIL") (setq p (plist-put p :email val)))
  613. ((string-equal key "DATE") (setq p (plist-put p :date val)))
  614. ((string-equal key "KEYWORDS") (setq p (plist-put p :keywords val)))
  615. ((string-equal key "DESCRIPTION")
  616. (setq p (plist-put p :description val)))
  617. ((string-equal key "LANGUAGE") (setq p (plist-put p :language val)))
  618. ((string-equal key "STYLE")
  619. (setq style (concat style "\n" val)))
  620. ((string-equal key "LATEX_HEADER")
  621. (setq latex-header (concat latex-header "\n" val)))
  622. ((string-equal key "LATEX_CLASS")
  623. (setq latex-class val))
  624. ((string-equal key "TEXT")
  625. (setq text (if text (concat text "\n" val) val)))
  626. ((string-equal key "OPTIONS")
  627. (setq options (concat val " " options)))
  628. ((string-equal key "MATHJAX")
  629. (setq mathjax (concat val " " mathjax)))
  630. ((string-equal key "BIND")
  631. (push (read (concat "(" val ")")) letbind))
  632. ((string-equal key "XSLT")
  633. (setq p (plist-put p :xslt val)))
  634. ((string-equal key "LINK_UP")
  635. (setq p (plist-put p :link-up val)))
  636. ((string-equal key "LINK_HOME")
  637. (setq p (plist-put p :link-home val)))
  638. ((string-equal key "EXPORT_SELECT_TAGS")
  639. (setq p (plist-put p :select-tags (org-split-string val))))
  640. ((string-equal key "EXPORT_EXCLUDE_TAGS")
  641. (setq p (plist-put p :exclude-tags (org-split-string val))))
  642. ((string-equal key "MACRO")
  643. (push val macros))
  644. ((equal key "SETUPFILE")
  645. (setq setup-contents (org-file-contents
  646. (expand-file-name
  647. (org-remove-double-quotes
  648. (org-trim val)))
  649. 'noerror))
  650. (if (not ext-setup-or-nil)
  651. (setq ext-setup-or-nil setup-contents start 0)
  652. (setq ext-setup-or-nil
  653. (concat (substring ext-setup-or-nil 0 start)
  654. "\n" setup-contents "\n"
  655. (substring ext-setup-or-nil start)))))))
  656. (setq p (plist-put p :text text))
  657. (when (and letbind (org-export-confirm-letbind))
  658. (setq p (plist-put p :let-bind letbind)))
  659. (when style (setq p (plist-put p :style-extra style)))
  660. (when latex-header
  661. (setq p (plist-put p :latex-header-extra (substring latex-header 1))))
  662. (when latex-class
  663. (setq p (plist-put p :latex-class latex-class)))
  664. (when options
  665. (setq p (org-export-add-options-to-plist p options)))
  666. (when mathjax
  667. (setq p (plist-put p :mathjax mathjax)))
  668. ;; Add macro definitions
  669. (setq p (plist-put p :macro-date "(eval (format-time-string \"$1\"))"))
  670. (setq p (plist-put p :macro-time "(eval (format-time-string \"$1\"))"))
  671. (setq p (plist-put
  672. p :macro-modification-time
  673. (and (buffer-file-name)
  674. (file-exists-p (buffer-file-name))
  675. (concat
  676. "(eval (format-time-string \"$1\" '"
  677. (prin1-to-string (nth 5 (file-attributes
  678. (buffer-file-name))))
  679. "))"))))
  680. (setq p (plist-put p :macro-input-file (and (buffer-file-name)
  681. (file-name-nondirectory
  682. (buffer-file-name)))))
  683. (while (setq val (pop macros))
  684. (when (string-match "^\\([-a-zA-Z0-9_]+\\)[ \t]+\\(.*?[ \t]*$\\)" val)
  685. (setq p (plist-put
  686. p (intern
  687. (concat ":macro-" (downcase (match-string 1 val))))
  688. (org-export-interpolate-newlines (match-string 2 val))))))
  689. p))))
  690. (defun org-export-interpolate-newlines (s)
  691. (while (string-match "\\\\n" s)
  692. (setq s (replace-match "\n" t t s)))
  693. s)
  694. (defvar org-export-allow-BIND-local nil)
  695. (defun org-export-confirm-letbind ()
  696. "Can we use #+BIND values during export?
  697. By default this will ask fro confirmation by the user, to divert possible
  698. security risks."
  699. (cond
  700. ((not org-export-allow-BIND) nil)
  701. ((eq org-export-allow-BIND t) t)
  702. ((local-variable-p 'org-export-allow-BIND-local (current-buffer))
  703. org-export-allow-BIND-local)
  704. (t (org-set-local 'org-export-allow-BIND-local
  705. (yes-or-no-p "Allow BIND values in this buffer? ")))))
  706. (defun org-install-letbind ()
  707. "Install the values from #+BIND lines as local variables."
  708. (let ((letbind (plist-get org-export-opt-plist :let-bind))
  709. pair)
  710. (while (setq pair (pop letbind))
  711. (org-set-local (car pair) (nth 1 pair)))))
  712. (defun org-export-add-options-to-plist (p options)
  713. "Parse an OPTIONS line and set values in the property list P."
  714. (let (o)
  715. (when options
  716. (let ((op org-export-plist-vars))
  717. (while (setq o (pop op))
  718. (if (and (nth 1 o)
  719. (string-match (concat (regexp-quote (nth 1 o))
  720. ":\\([^ \t\n\r;,.]*\\)")
  721. options))
  722. (setq p (plist-put p (car o)
  723. (car (read-from-string
  724. (match-string 1 options))))))))))
  725. p)
  726. (defun org-export-add-subtree-options (p pos)
  727. "Add options in subtree at position POS to property list P."
  728. (save-excursion
  729. (goto-char pos)
  730. (when (org-at-heading-p)
  731. (let (a)
  732. ;; This is actually read in `org-export-get-title-from-subtree'
  733. ;; (when (setq a (org-entry-get pos "EXPORT_TITLE"))
  734. ;; (setq p (plist-put p :title a)))
  735. (when (setq a (org-entry-get pos "EXPORT_TEXT"))
  736. (setq p (plist-put p :text a)))
  737. (when (setq a (org-entry-get pos "EXPORT_AUTHOR"))
  738. (setq p (plist-put p :author a)))
  739. (when (setq a (org-entry-get pos "EXPORT_DATE"))
  740. (setq p (plist-put p :date a)))
  741. (when (setq a (org-entry-get pos "EXPORT_OPTIONS"))
  742. (setq p (org-export-add-options-to-plist p a)))))
  743. p))
  744. (defun org-export-directory (type plist)
  745. (let* ((val (plist-get plist :publishing-directory))
  746. (dir (if (listp val)
  747. (or (cdr (assoc type val)) ".")
  748. val)))
  749. dir))
  750. (defun org-export-process-option-filters (plist)
  751. (let ((functions org-export-options-filters) f)
  752. (while (setq f (pop functions))
  753. (setq plist (funcall f plist))))
  754. plist)
  755. ;;;###autoload
  756. (defun org-export (&optional arg)
  757. "Export dispatcher for Org-mode.
  758. When `org-export-run-in-background' is non-nil, try to run the command
  759. in the background. This will be done only for commands that write
  760. to a file. For details see the docstring of `org-export-run-in-background'.
  761. The prefix argument ARG will be passed to the exporter. However, if
  762. ARG is a double universal prefix \\[universal-argument] \\[universal-argument], \
  763. that means to inverse the
  764. value of `org-export-run-in-background'."
  765. (interactive "P")
  766. (let* ((bg (org-xor (equal arg '(16)) org-export-run-in-background))
  767. subtree-p
  768. (help "[t] insert the export option template
  769. \[v] limit export to visible part of outline tree
  770. \[1] only export the current subtree
  771. \[SPC] publish enclosing subtree (with LaTeX_CLASS or EXPORT_FILE_NAME prop)
  772. \[a/n/u] export as ASCII/Latin-1/UTF-8 [A/N/U] to temporary buffer
  773. \[h] export as HTML [H] to temporary buffer [R] export region
  774. \[b] export as HTML and open in browser
  775. \[l] export as LaTeX [L] to temporary buffer
  776. \[p] export as LaTeX and process to PDF [d] ... and open PDF file
  777. \[D] export as DocBook [V] export as DocBook, process to PDF, and open
  778. \[j] export as TaskJuggler [J] ... and open
  779. \[m] export as Freemind mind map
  780. \[x] export as XOXO
  781. \[g] export using Wes Hardaker's generic exporter
  782. \[i] export current file as iCalendar file
  783. \[I] export all agenda files as iCalendar files [c] ...as one combined file
  784. \[F] publish current file [P] publish current project
  785. \[X] publish a project... [E] publish every projects")
  786. (cmds
  787. '((?t org-insert-export-options-template nil)
  788. (?v org-export-visible nil)
  789. (?a org-export-as-ascii t)
  790. (?A org-export-as-ascii-to-buffer t)
  791. (?n org-export-as-latin1 t)
  792. (?N org-export-as-latin1-to-buffer t)
  793. (?u org-export-as-utf8 t)
  794. (?U org-export-as-utf8-to-buffer t)
  795. (?h org-export-as-html t)
  796. (?b org-export-as-html-and-open t)
  797. (?H org-export-as-html-to-buffer nil)
  798. (?R org-export-region-as-html nil)
  799. (?x org-export-as-xoxo t)
  800. (?g org-export-generic t)
  801. (?D org-export-as-docbook t)
  802. (?V org-export-as-docbook-pdf-and-open t)
  803. (?j org-export-as-taskjuggler t)
  804. (?J org-export-as-taskjuggler-and-open t)
  805. (?m org-export-as-freemind t)
  806. (?l org-export-as-latex t)
  807. (?p org-export-as-pdf t)
  808. (?d org-export-as-pdf-and-open t)
  809. (?L org-export-as-latex-to-buffer nil)
  810. (?i org-export-icalendar-this-file t)
  811. (?I org-export-icalendar-all-agenda-files t)
  812. (?c org-export-icalendar-combine-agenda-files t)
  813. (?F org-publish-current-file t)
  814. (?P org-publish-current-project t)
  815. (?X org-publish t)
  816. (?E org-publish-all t)))
  817. r1 r2 ass
  818. (cpos (point)) (cbuf (current-buffer)) bpos)
  819. (save-excursion
  820. (save-window-excursion
  821. (delete-other-windows)
  822. (with-output-to-temp-buffer "*Org Export/Publishing Help*"
  823. (princ help))
  824. (org-fit-window-to-buffer (get-buffer-window
  825. "*Org Export/Publishing Help*"))
  826. (message "Select command: ")
  827. (setq r1 (read-char-exclusive))
  828. (when (eq r1 ?1)
  829. (setq subtree-p t)
  830. (message "Select command (for subtree): ")
  831. (setq r1 (read-char-exclusive)))
  832. (when (eq r1 ?\ )
  833. (let ((case-fold-search t))
  834. (if (re-search-backward
  835. "^[ \t]+\\(:latex_class:\\|:export_title:\\)[ \t]+\\S-"
  836. nil t)
  837. (progn
  838. (org-back-to-heading t)
  839. (setq subtree-p t)
  840. (setq bpos (point))
  841. (message "Select command (for subtree): ")
  842. (setq r1 (read-char-exclusive)))
  843. (error "No enclosing node with LaTeX_CLASS or EXPORT_FILE_NAME")
  844. )))))
  845. (and bpos (goto-char bpos))
  846. (setq r2 (if (< r1 27) (+ r1 96) r1))
  847. (unless (setq ass (assq r2 cmds))
  848. (error "No command associated with key %c" r1))
  849. (if (and bg (nth 2 ass)
  850. (not (buffer-base-buffer))
  851. (not (org-region-active-p)))
  852. ;; execute in background
  853. (let ((p (start-process
  854. (concat "Exporting " (file-name-nondirectory (buffer-file-name)))
  855. "*Org Processes*"
  856. (expand-file-name invocation-name invocation-directory)
  857. "-batch"
  858. "-l" user-init-file
  859. "--eval" "(require 'org-exp)"
  860. "--eval" "(setq org-wait .2)"
  861. (buffer-file-name)
  862. "-f" (symbol-name (nth 1 ass)))))
  863. (set-process-sentinel p 'org-export-process-sentinel)
  864. (message "Background process \"%s\": started" p))
  865. ;; background processing not requested, or not possible
  866. (if subtree-p (progn (outline-mark-subtree) (activate-mark)))
  867. (call-interactively (nth 1 ass))
  868. (when (and bpos (get-buffer-window cbuf))
  869. (let ((cw (selected-window)))
  870. (select-window (get-buffer-window cbuf))
  871. (goto-char cpos)
  872. (deactivate-mark)
  873. (select-window cw))))))
  874. (defun org-export-process-sentinel (process status)
  875. (if (string-match "\n+\\'" status)
  876. (setq status (substring status 0 -1)))
  877. (message "Background process \"%s\": %s" process status))
  878. ;;; General functions for all backends
  879. (defvar org-export-target-aliases nil
  880. "Alist of targets with invisible aliases.")
  881. (defvar org-export-preferred-target-alist nil
  882. "Alist of section id's with preferred aliases.")
  883. (defvar org-export-id-target-alist nil
  884. "Alist of section id's with preferred aliases.")
  885. (defvar org-export-code-refs nil
  886. "Alist of code references and line numbers.")
  887. (defun org-export-preprocess-string (string &rest parameters)
  888. "Cleanup STRING so that that the true exported has a more consistent source.
  889. This function takes STRING, which should be a buffer-string of an org-file
  890. to export. It then creates a temporary buffer where it does its job.
  891. The result is then again returned as a string, and the exporter works
  892. on this string to produce the exported version."
  893. (interactive)
  894. (let* ((htmlp (plist-get parameters :for-html))
  895. (asciip (plist-get parameters :for-ascii))
  896. (latexp (plist-get parameters :for-LaTeX))
  897. (docbookp (plist-get parameters :for-docbook))
  898. (backend (cond (htmlp 'html)
  899. (latexp 'latex)
  900. (asciip 'ascii)
  901. (docbookp 'docbook)))
  902. (archived-trees (plist-get parameters :archived-trees))
  903. (inhibit-read-only t)
  904. (drawers org-drawers)
  905. (outline-regexp "\\*+ ")
  906. target-alist rtn)
  907. (setq org-export-target-aliases nil
  908. org-export-preferred-target-alist nil
  909. org-export-id-target-alist nil
  910. org-export-code-refs nil)
  911. (with-current-buffer (get-buffer-create " org-mode-tmp")
  912. (erase-buffer)
  913. (insert string)
  914. (setq case-fold-search t)
  915. (let ((inhibit-read-only t))
  916. (remove-text-properties (point-min) (point-max)
  917. '(read-only t)))
  918. ;; Remove license-to-kill stuff
  919. ;; The caller marks some stuff for killing, stuff that has been
  920. ;; used to create the page title, for example.
  921. (org-export-kill-licensed-text)
  922. (let ((org-inhibit-startup t)) (org-mode))
  923. (setq case-fold-search t)
  924. (org-install-letbind)
  925. ;; Call the hook
  926. (run-hooks 'org-export-preprocess-hook)
  927. ;; Process the macros
  928. (org-export-preprocess-apply-macros)
  929. (run-hooks 'org-export-preprocess-after-macros-hook)
  930. (untabify (point-min) (point-max))
  931. ;; Handle include files, and call a hook
  932. (org-export-handle-include-files-recurse)
  933. (run-hooks 'org-export-preprocess-after-include-files-hook)
  934. ;; Get rid of archived trees
  935. (org-export-remove-archived-trees archived-trees)
  936. ;; Remove comment environment and comment subtrees
  937. (org-export-remove-comment-blocks-and-subtrees)
  938. ;; Get rid of excluded trees, and call a hook
  939. (org-export-handle-export-tags (plist-get parameters :select-tags)
  940. (plist-get parameters :exclude-tags))
  941. (run-hooks 'org-export-preprocess-after-tree-selection-hook)
  942. ;; Handle source code snippets
  943. (org-export-replace-src-segments-and-examples backend)
  944. ;; Protect short examples marked by a leading colon
  945. (org-export-protect-colon-examples)
  946. ;; Normalize footnotes
  947. (when (plist-get parameters :footnotes)
  948. (org-footnote-normalize nil t))
  949. ;; Find all headings and compute the targets for them
  950. (setq target-alist (org-export-define-heading-targets target-alist))
  951. (run-hooks 'org-export-preprocess-after-headline-targets-hook)
  952. ;; Find HTML special classes for headlines
  953. (org-export-remember-html-container-classes)
  954. ;; Get rid of drawers
  955. (org-export-remove-or-extract-drawers
  956. drawers (plist-get parameters :drawers) backend)
  957. ;; Get the correct stuff before the first headline
  958. (when (plist-get parameters :skip-before-1st-heading)
  959. (goto-char (point-min))
  960. (when (re-search-forward "^\\(#.*\n\\)?\\*+[ \t]" nil t)
  961. (delete-region (point-min) (match-beginning 0))
  962. (goto-char (point-min))
  963. (insert "\n")))
  964. (when (plist-get parameters :add-text)
  965. (goto-char (point-min))
  966. (insert (plist-get parameters :add-text) "\n"))
  967. ;; Remove todo-keywords before exporting, if the user has requested so
  968. (org-export-remove-headline-metadata parameters)
  969. ;; Find targets in comments and move them out of comments,
  970. ;; but mark them as targets that should be invisible
  971. (setq target-alist (org-export-handle-invisible-targets target-alist))
  972. ;; Select and protect backend specific stuff, throw away stuff
  973. ;; that is specific for other backends
  974. (run-hooks 'org-export-preprocess-before-selecting-backend-code-hook)
  975. (org-export-select-backend-specific-text backend)
  976. ;; Protect quoted subtrees
  977. (org-export-protect-quoted-subtrees)
  978. ;; Remove clock lines
  979. (org-export-remove-clock-lines)
  980. ;; Protect verbatim elements
  981. (org-export-protect-verbatim)
  982. ;; Blockquotes, verse, and center
  983. (org-export-mark-blockquote-verse-center)
  984. (run-hooks 'org-export-preprocess-after-blockquote-hook)
  985. ;; Remove timestamps, if the user has requested so
  986. (unless (plist-get parameters :timestamps)
  987. (org-export-remove-timestamps))
  988. ;; Attach captions to the correct object
  989. (setq target-alist (org-export-attach-captions-and-attributes
  990. backend target-alist))
  991. ;; Find matches for radio targets and turn them into internal links
  992. (org-export-mark-radio-links)
  993. (run-hooks 'org-export-preprocess-after-radio-targets-hook)
  994. ;; Find all links that contain a newline and put them into a single line
  995. (org-export-concatenate-multiline-links)
  996. ;; Normalize links: Convert angle and plain links into bracket links
  997. ;; and expand link abbreviations
  998. (run-hooks 'org-export-preprocess-before-normalizing-links-hook)
  999. (org-export-normalize-links)
  1000. ;; Find all internal links. If they have a fuzzy match (i.e. not
  1001. ;; a *dedicated* target match, let the link point to the
  1002. ;; corresponding section.
  1003. (org-export-target-internal-links target-alist)
  1004. ;; Find multiline emphasis and put them into single line
  1005. (when (plist-get parameters :emph-multiline)
  1006. (org-export-concatenate-multiline-emphasis))
  1007. ;; Remove special table lines
  1008. (when org-export-table-remove-special-lines
  1009. (org-export-remove-special-table-lines))
  1010. ;; Another hook
  1011. (run-hooks 'org-export-preprocess-before-backend-specifics-hook)
  1012. ;; LaTeX-specific preprocessing
  1013. (when latexp
  1014. (require 'org-latex nil)
  1015. (org-export-latex-preprocess parameters))
  1016. ;; ASCII-specific preprocessing
  1017. (when asciip
  1018. (org-export-ascii-preprocess parameters))
  1019. ;; HTML-specific preprocessing
  1020. (when htmlp
  1021. (org-export-html-preprocess parameters))
  1022. ;; DocBook-specific preprocessing
  1023. (when docbookp
  1024. (require 'org-docbook nil)
  1025. (org-export-docbook-preprocess parameters))
  1026. ;; Remove or replace comments
  1027. (org-export-handle-comments (plist-get parameters :comments))
  1028. ;; Remove #+TBLFM and #+TBLNAME lines
  1029. (org-export-handle-table-metalines)
  1030. ;; Run the final hook
  1031. (run-hooks 'org-export-preprocess-final-hook)
  1032. (setq rtn (buffer-string)))
  1033. (kill-buffer " org-mode-tmp")
  1034. rtn))
  1035. (defun org-export-kill-licensed-text ()
  1036. "Remove all text that is marked with a :org-license-to-kill property."
  1037. (let (p)
  1038. (while (setq p (text-property-any (point-min) (point-max)
  1039. :org-license-to-kill t))
  1040. (delete-region
  1041. p (or (next-single-property-change p :org-license-to-kill)
  1042. (point-max))))))
  1043. (defvar org-export-define-heading-targets-headline-hook nil
  1044. "Hook that is run when a headline was matched during target search.
  1045. This is part of the preprocessing for export.")
  1046. (defun org-export-define-heading-targets (target-alist)
  1047. "Find all headings and define the targets for them.
  1048. The new targets are added to TARGET-ALIST, which is also returned.
  1049. Also find all ID and CUSTOM_ID properties and store them."
  1050. (goto-char (point-min))
  1051. (org-init-section-numbers)
  1052. (let ((re (concat "^" org-outline-regexp
  1053. "\\|"
  1054. "^[ \t]*:\\(ID\\|CUSTOM_ID\\):[ \t]*\\([^ \t\r\n]+\\)"))
  1055. level target last-section-target a id)
  1056. (while (re-search-forward re nil t)
  1057. (org-if-unprotected-at (match-beginning 0)
  1058. (if (match-end 2)
  1059. (progn
  1060. (setq id (org-match-string-no-properties 2))
  1061. (push (cons id target) target-alist)
  1062. (setq a (or (assoc last-section-target org-export-target-aliases)
  1063. (progn
  1064. (push (list last-section-target)
  1065. org-export-target-aliases)
  1066. (car org-export-target-aliases))))
  1067. (push (caar target-alist) (cdr a))
  1068. (when (equal (match-string 1) "CUSTOM_ID")
  1069. (if (not (assoc last-section-target
  1070. org-export-preferred-target-alist))
  1071. (push (cons last-section-target id)
  1072. org-export-preferred-target-alist)))
  1073. (when (equal (match-string 1) "ID")
  1074. (if (not (assoc last-section-target
  1075. org-export-id-target-alist))
  1076. (push (cons last-section-target (concat "ID-" id))
  1077. org-export-id-target-alist))))
  1078. (setq level (org-reduced-level
  1079. (save-excursion (goto-char (point-at-bol))
  1080. (org-outline-level))))
  1081. (setq target (org-solidify-link-text
  1082. (format "sec-%s" (replace-regexp-in-string
  1083. "\\." "_"
  1084. (org-section-number level)))))
  1085. (setq last-section-target target)
  1086. (push (cons target target) target-alist)
  1087. (add-text-properties
  1088. (point-at-bol) (point-at-eol)
  1089. (list 'target target))
  1090. (run-hooks 'org-export-define-heading-targets-headline-hook)))))
  1091. target-alist)
  1092. (defun org-export-handle-invisible-targets (target-alist)
  1093. "Find targets in comments and move them out of comments.
  1094. Mark them as invisible targets."
  1095. (let (target tmp a)
  1096. (goto-char (point-min))
  1097. (while (re-search-forward "^#.*?\\(<<<?\\([^>\r\n]+\\)>>>?\\).*" nil t)
  1098. ;; Check if the line before or after is a headline with a target
  1099. (if (setq target (or (get-text-property (point-at-bol 0) 'target)
  1100. (get-text-property (point-at-bol 2) 'target)))
  1101. (progn
  1102. ;; use the existing target in a neighboring line
  1103. (setq tmp (match-string 2))
  1104. (replace-match "")
  1105. (and (looking-at "\n") (delete-char 1))
  1106. (push (cons (setq tmp (org-solidify-link-text tmp)) target)
  1107. target-alist)
  1108. (setq a (or (assoc target org-export-target-aliases)
  1109. (progn
  1110. (push (list target) org-export-target-aliases)
  1111. (car org-export-target-aliases))))
  1112. (push tmp (cdr a)))
  1113. ;; Make an invisible target
  1114. (replace-match "\\1(INVISIBLE)"))))
  1115. target-alist)
  1116. (defun org-export-target-internal-links (target-alist)
  1117. "Find all internal links and assign targets to them.
  1118. If a link has a fuzzy match (i.e. not a *dedicated* target match),
  1119. let the link point to the corresponding section.
  1120. This function also handles the id links, if they have a match in
  1121. the current file."
  1122. (goto-char (point-min))
  1123. (while (re-search-forward org-bracket-link-regexp nil t)
  1124. (org-if-unprotected-at (1+ (match-beginning 0))
  1125. (let* ((md (match-data))
  1126. (desc (match-end 2))
  1127. (link (org-link-unescape (match-string 1)))
  1128. (slink (org-solidify-link-text link))
  1129. found props pos cref
  1130. (target
  1131. (cond
  1132. ((= (string-to-char link) ?#)
  1133. ;; user wants exactly this link
  1134. link)
  1135. ((cdr (assoc slink target-alist))
  1136. (or (cdr (assoc (assoc slink target-alist)
  1137. org-export-preferred-target-alist))
  1138. (cdr (assoc slink target-alist))))
  1139. ((and (string-match "^id:" link)
  1140. (cdr (assoc (substring link 3) target-alist))))
  1141. ((string-match "^(\\(.*\\))$" link)
  1142. (setq cref (match-string 1 link))
  1143. (concat "coderef:" cref))
  1144. ((string-match org-link-types-re link) nil)
  1145. ((or (file-name-absolute-p link)
  1146. (string-match "^\\." link))
  1147. nil)
  1148. (t
  1149. (let ((org-link-search-inhibit-query t))
  1150. (save-excursion
  1151. (setq found (condition-case nil (org-link-search link)
  1152. (error nil)))
  1153. (when (and found
  1154. (or (org-on-heading-p)
  1155. (not (eq found 'dedicated))))
  1156. (or (get-text-property (point) 'target)
  1157. (get-text-property
  1158. (max (point-min)
  1159. (1- (or (previous-single-property-change
  1160. (point) 'target) 0)))
  1161. 'target)))))))))
  1162. (when target
  1163. (set-match-data md)
  1164. (goto-char (match-beginning 1))
  1165. (setq props (text-properties-at (point)))
  1166. (delete-region (match-beginning 1) (match-end 1))
  1167. (setq pos (point))
  1168. (insert target)
  1169. (unless desc (insert "][" link))
  1170. (add-text-properties pos (point) props))))))
  1171. (defun org-export-remember-html-container-classes ()
  1172. "Store the HTML_CONTAINER_CLASS properties in a text property."
  1173. (goto-char (point-min))
  1174. (let (class)
  1175. (while (re-search-forward
  1176. "^[ \t]*:HTML_CONTAINER_CLASS:[ \t]+\\(.+\\)$" nil t)
  1177. (setq class (match-string 1))
  1178. (save-excursion
  1179. (org-back-to-heading t)
  1180. (put-text-property (point-at-bol) (point-at-eol) 'html-container-class class)))))
  1181. (defvar org-export-format-drawer-function nil
  1182. "Function to be called to format the contents of a drawer.
  1183. The function must accept three parameters:
  1184. NAME the drawer name, like \"PROPERTIES\"
  1185. CONTENT the content of the drawer.
  1186. BACKEND one of the symbols html, docbook, latex, ascii, xoxo
  1187. The function should return the text to be inserted into the buffer.
  1188. If this is nil, `org-export-format-drawer' is used as a default.")
  1189. (defun org-export-remove-or-extract-drawers (all-drawers exp-drawers backend)
  1190. "Remove drawers, or extract and format the content.
  1191. ALL-DRAWERS is a list of all drawer names valid in the current buffer.
  1192. EXP-DRAWERS can be t to keep all drawer contents, or a list of drawers
  1193. whose content to keep. Any drawers that are in ALL-DRAWERS but not in
  1194. EXP-DRAWERS will be removed.
  1195. BACKEND is the current export backend."
  1196. (goto-char (point-min))
  1197. (let ((re (concat "^[ \t]*:\\("
  1198. (mapconcat 'identity all-drawers "\\|")
  1199. "\\):[ \t]*$"))
  1200. name beg beg-content eol content)
  1201. (while (re-search-forward re nil t)
  1202. (org-if-unprotected
  1203. (setq name (match-string 1))
  1204. (setq beg (match-beginning 0)
  1205. beg-content (1+ (point-at-eol))
  1206. eol (point-at-eol))
  1207. (if (not (and (re-search-forward
  1208. "^\\([ \t]*:END:[ \t]*\n?\\)\\|^\\*+[ \t]" nil t)
  1209. (match-end 1)))
  1210. (goto-char eol)
  1211. (goto-char (match-beginning 0))
  1212. (and (looking-at ".*\n?") (replace-match ""))
  1213. (setq content (buffer-substring beg-content (point)))
  1214. (delete-region beg (point))
  1215. (when (or (eq exp-drawers t)
  1216. (member name exp-drawers))
  1217. (setq content (funcall (or org-export-format-drawer-function
  1218. 'org-export-format-drawer)
  1219. name content backend))
  1220. (insert content)))))))
  1221. (defun org-export-format-drawer (name content backend)
  1222. "Format the content of a drawer as a colon example."
  1223. (if (string-match "[ \t]+\\'" content)
  1224. (setq content (substring content (match-beginning 0))))
  1225. (while (string-match "\\`[ \t]*\n" content)
  1226. (setq content (substring content (match-end 0))))
  1227. (setq content (org-remove-indentation content))
  1228. (setq content (concat ": " (mapconcat 'identity
  1229. (org-split-string content "\n")
  1230. "\n: ")
  1231. "\n"))
  1232. (setq content (concat " : " (upcase name) "\n" content))
  1233. (org-add-props content nil 'org-protected t))
  1234. (defun org-export-handle-export-tags (select-tags exclude-tags)
  1235. "Modify the buffer, honoring SELECT-TAGS and EXCLUDE-TAGS.
  1236. Both arguments are lists of tags.
  1237. If any of SELECT-TAGS is found, all trees not marked by a SELECT-TAG
  1238. will be removed.
  1239. After that, all subtrees that are marked by EXCLUDE-TAGS will be
  1240. removed as well."
  1241. (remove-text-properties (point-min) (point-max) '(:org-delete t))
  1242. (let* ((re-sel (concat ":\\(" (mapconcat 'regexp-quote
  1243. select-tags "\\|")
  1244. "\\):"))
  1245. (re-excl (concat ":\\(" (mapconcat 'regexp-quote
  1246. exclude-tags "\\|")
  1247. "\\):"))
  1248. beg end cont)
  1249. (goto-char (point-min))
  1250. (when (and select-tags
  1251. (re-search-forward
  1252. (concat "^\\*+[ \t].*" re-sel "[^ \t\n]*[ \t]*$") nil t))
  1253. ;; At least one tree is marked for export, this means
  1254. ;; all the unmarked stuff needs to go.
  1255. ;; Dig out the trees that should be exported
  1256. (goto-char (point-min))
  1257. (outline-next-heading)
  1258. (setq beg (point))
  1259. (put-text-property beg (point-max) :org-delete t)
  1260. (while (re-search-forward re-sel nil t)
  1261. (when (org-on-heading-p)
  1262. (org-back-to-heading)
  1263. (remove-text-properties
  1264. (max (1- (point)) (point-min))
  1265. (setq cont (save-excursion (org-end-of-subtree t t)))
  1266. '(:org-delete t))
  1267. (while (and (org-up-heading-safe)
  1268. (get-text-property (point) :org-delete))
  1269. (remove-text-properties (max (1- (point)) (point-min))
  1270. (point-at-eol) '(:org-delete t)))
  1271. (goto-char cont))))
  1272. ;; Remove the trees explicitly marked for noexport
  1273. (when exclude-tags
  1274. (goto-char (point-min))
  1275. (while (re-search-forward re-excl nil t)
  1276. (when (org-at-heading-p)
  1277. (org-back-to-heading t)
  1278. (setq beg (point))
  1279. (org-end-of-subtree t t)
  1280. (delete-region beg (point))
  1281. (when (featurep 'org-inlinetask)
  1282. (org-inlinetask-remove-END-maybe)))))
  1283. ;; Remove everything that is now still marked for deletion
  1284. (goto-char (point-min))
  1285. (while (setq beg (text-property-any (point-min) (point-max) :org-delete t))
  1286. (setq end (or (next-single-property-change beg :org-delete)
  1287. (point-max)))
  1288. (delete-region beg end))))
  1289. (defun org-export-remove-archived-trees (export-archived-trees)
  1290. "Remove archived trees.
  1291. When EXPORT-ARCHIVED-TREES is `headline;, only the headline will be exported.
  1292. When it is t, the entire archived tree will be exported.
  1293. When it is nil the entire tree including the headline will be removed
  1294. from the buffer."
  1295. (let ((re-archive (concat ":" org-archive-tag ":"))
  1296. a b)
  1297. (when (not (eq export-archived-trees t))
  1298. (goto-char (point-min))
  1299. (while (re-search-forward re-archive nil t)
  1300. (if (not (org-on-heading-p t))
  1301. (org-end-of-subtree t)
  1302. (beginning-of-line 1)
  1303. (setq a (if export-archived-trees
  1304. (1+ (point-at-eol)) (point))
  1305. b (org-end-of-subtree t))
  1306. (if (> b a) (delete-region a b)))))))
  1307. (defun org-export-remove-headline-metadata (opts)
  1308. "Remove meta data from the headline, according to user options."
  1309. (let ((re org-complex-heading-regexp)
  1310. (todo (plist-get opts :todo-keywords))
  1311. (tags (plist-get opts :tags))
  1312. (pri (plist-get opts :priority))
  1313. (elts '(1 2 3 4 5))
  1314. rpl)
  1315. (setq elts (delq nil (list 1 (if todo 2) (if pri 3) 4 (if tags 5))))
  1316. (when (or (not todo) (not tags) (not pri))
  1317. (goto-char (point-min))
  1318. (while (re-search-forward re nil t)
  1319. (org-if-unprotected
  1320. (setq rpl (mapconcat (lambda (i) (if (match-end i) (match-string i) ""))
  1321. elts " "))
  1322. (replace-match rpl t t))))))
  1323. (defun org-export-remove-timestamps ()
  1324. "Remove timestamps and keywords for export."
  1325. (goto-char (point-min))
  1326. (while (re-search-forward org-maybe-keyword-time-regexp nil t)
  1327. (backward-char 1)
  1328. (org-if-unprotected
  1329. (unless (save-match-data (org-at-table-p))
  1330. (replace-match "")
  1331. (beginning-of-line 1)
  1332. (if (looking-at "[- \t]*\\(=>[- \t0-9:]*\\)?[ \t]*\n")
  1333. (replace-match ""))))))
  1334. (defun org-export-remove-clock-lines ()
  1335. "Remove clock lines for export."
  1336. (goto-char (point-min))
  1337. (let ((re (concat "^[ \t]*" org-clock-string ".*\n?")))
  1338. (while (re-search-forward re nil t)
  1339. (org-if-unprotected
  1340. (replace-match "")))))
  1341. (defun org-export-protect-quoted-subtrees ()
  1342. "Mark quoted subtrees with the protection property."
  1343. (let ((re-quote (concat "^\\*+[ \t]+" org-quote-string "\\>")))
  1344. (goto-char (point-min))
  1345. (while (re-search-forward re-quote nil t)
  1346. (goto-char (match-beginning 0))
  1347. (end-of-line 1)
  1348. (add-text-properties (point) (org-end-of-subtree t)
  1349. '(org-protected t)))))
  1350. (defun org-export-protect-verbatim ()
  1351. "Mark verbatim snippets with the protection property."
  1352. (goto-char (point-min))
  1353. (while (re-search-forward org-verbatim-re nil t)
  1354. (org-if-unprotected
  1355. (add-text-properties (match-beginning 4) (match-end 4)
  1356. '(org-protected t org-verbatim-emph t))
  1357. (goto-char (1+ (match-end 4))))))
  1358. (defun org-export-protect-colon-examples ()
  1359. "Protect lines starting with a colon."
  1360. (goto-char (point-min))
  1361. (let ((re "^[ \t]*:\\([ \t]\\|$\\)") beg)
  1362. (while (re-search-forward re nil t)
  1363. (beginning-of-line 1)
  1364. (setq beg (point))
  1365. (while (looking-at re)
  1366. (end-of-line 1)
  1367. (or (eobp) (forward-char 1)))
  1368. (add-text-properties beg (if (bolp) (1- (point)) (point))
  1369. '(org-protected t)))))
  1370. (defun org-export-select-backend-specific-text (backend)
  1371. (let ((formatters
  1372. '((docbook "DOCBOOK" "BEGIN_DOCBOOK" "END_DOCBOOK")
  1373. (html "HTML" "BEGIN_HTML" "END_HTML")
  1374. (beamer "BEAMER" "BEGIN_BEAMER" "END_BEAMER")
  1375. (ascii "ASCII" "BEGIN_ASCII" "END_ASCII")
  1376. (latex "LaTeX" "BEGIN_LaTeX" "END_LaTeX")))
  1377. (case-fold-search t)
  1378. fmt beg beg-content end end-content)
  1379. (while formatters
  1380. (setq fmt (pop formatters))
  1381. ;; Handle #+Backend: stuff
  1382. (goto-char (point-min))
  1383. (while (re-search-forward (concat "^\\([ \t]*\\)#\\+" (cadr fmt)
  1384. ":[ \t]*\\(.*\\)") nil t)
  1385. (if (not (eq (car fmt) backend))
  1386. (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
  1387. (replace-match "\\1\\2" t)
  1388. (add-text-properties
  1389. (point-at-bol) (min (1+ (point-at-eol)) (point-max))
  1390. '(org-protected t))))
  1391. ;; Delete #+attr_Backend: stuff of another backend. Those
  1392. ;; matching the current backend will be taken care of by
  1393. ;; `org-export-attach-captions-and-attributes'
  1394. (goto-char (point-min))
  1395. (while (re-search-forward (concat "^\\([ \t]*\\)#\\+attr_" (cadr fmt)
  1396. ":[ \t]*\\(.*\\)") nil t)
  1397. (when (not (eq (car fmt) backend))
  1398. (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
  1399. ;; Handle #+begin_Backend and #+end_Backend stuff
  1400. (goto-char (point-min))
  1401. (while (re-search-forward (concat "^[ \t]*#\\+" (caddr fmt) "\\>.*\n?")
  1402. nil t)
  1403. (setq beg (match-beginning 0) beg-content (match-end 0))
  1404. (when (re-search-forward (concat "^[ \t]*#\\+" (cadddr fmt) "\\>.*\n?")
  1405. nil t)
  1406. (setq end (match-end 0) end-content (match-beginning 0))
  1407. (if (eq (car fmt) backend)
  1408. ;; yes, keep this
  1409. (progn
  1410. (add-text-properties beg-content end-content '(org-protected t))
  1411. (delete-region (match-beginning 0) (match-end 0))
  1412. (save-excursion
  1413. (goto-char beg)
  1414. (delete-region (point) (1+ (point-at-eol)))))
  1415. ;; No, this is for a different backend, kill it
  1416. (delete-region beg end)))))))
  1417. (defun org-export-mark-blockquote-verse-center ()
  1418. "Mark block quote and verse environments with special cookies.
  1419. These special cookies will later be interpreted by the backend."
  1420. ;; Blockquotes
  1421. (let (type t1 ind beg end beg1 end1 content)
  1422. (goto-char (point-min))
  1423. (while (re-search-forward
  1424. "^\\([ \t]*\\)#\\+\\(begin_\\(\\(block\\)?quote\\|verse\\|center\\)\\>.*\\)"
  1425. nil t)
  1426. (setq ind (length (match-string 1))
  1427. type (downcase (match-string 3))
  1428. t1 (if (equal type "quote") "blockquote" type))
  1429. (setq beg (match-beginning 0)
  1430. beg1 (1+ (match-end 0)))
  1431. (when (re-search-forward (concat "^[ \t]*#\\+end_" type "\\>.*") nil t)
  1432. (setq end1 (1- (match-beginning 0))
  1433. end (+ (point-at-eol) (if (looking-at "\n$") 1 0)))
  1434. (setq content (org-remove-indentation (buffer-substring beg1 end1)))
  1435. (setq content (concat "ORG-" (upcase t1) "-START\n"
  1436. content "\n"
  1437. "ORG-" (upcase t1) "-END\n"))
  1438. (delete-region beg end)
  1439. (insert (org-add-props content nil 'original-indentation ind))))))
  1440. (defun org-export-attach-captions-and-attributes (backend target-alist)
  1441. "Move #+CAPTION, #+ATTR_BACKEND, and #+LABEL text into text properties.
  1442. If the next thing following is a table, add the text properties to the first
  1443. table line. If it is a link, add it to the line containing the link."
  1444. (goto-char (point-min))
  1445. (remove-text-properties (point-min) (point-max)
  1446. '(org-caption nil org-attributes nil))
  1447. (let ((case-fold-search t)
  1448. (re (concat "^[ \t]*#\\+caption:[ \t]+\\(.*\\)"
  1449. "\\|"
  1450. "^[ \t]*#\\+attr_" (symbol-name backend) ":[ \t]+\\(.*\\)"
  1451. "\\|"
  1452. "^[ \t]*#\\+label:[ \t]+\\(.*\\)"
  1453. "\\|"
  1454. "^[ \t]*\\(|[^-]\\)"
  1455. "\\|"
  1456. "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
  1457. cap shortn attr label end)
  1458. (while (re-search-forward re nil t)
  1459. (cond
  1460. ((match-end 1)
  1461. (progn
  1462. (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))
  1463. (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap)
  1464. (setq shortn (match-string 1 cap)
  1465. cap (match-string 2 cap)))
  1466. (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
  1467. ((match-end 2)
  1468. (progn
  1469. (setq attr (concat attr (if attr " " "") (org-trim (match-string 2))))
  1470. (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
  1471. ((match-end 3)
  1472. (progn
  1473. (setq label (org-trim (match-string 3)))
  1474. (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
  1475. (t
  1476. (setq end (if (match-end 4)
  1477. (let ((ee (org-table-end)))
  1478. (prog1 (1- (marker-position ee)) (move-marker ee nil)))
  1479. (point-at-eol)))
  1480. (add-text-properties (point-at-bol) end
  1481. (list 'org-caption cap
  1482. 'org-caption-shortn shortn
  1483. 'org-attributes attr
  1484. 'org-label label))
  1485. (if label (push (cons label label) target-alist))
  1486. (goto-char end)
  1487. (setq cap nil attr nil label nil)))))
  1488. target-alist)
  1489. (defun org-export-remove-comment-blocks-and-subtrees ()
  1490. "Remove the comment environment, and also commented subtrees."
  1491. (let ((re-commented (concat "^\\*+[ \t]+" org-comment-string "\\>"))
  1492. case-fold-search)
  1493. ;; Remove comment environment
  1494. (goto-char (point-min))
  1495. (setq case-fold-search t)
  1496. (while (re-search-forward
  1497. "^#\\+begin_comment[ \t]*\n[^\000]*?^#\\+end_comment\\>.*" nil t)
  1498. (replace-match "" t t))
  1499. ;; Remove subtrees that are commented
  1500. (goto-char (point-min))
  1501. (setq case-fold-search nil)
  1502. (while (re-search-forward re-commented nil t)
  1503. (goto-char (match-beginning 0))
  1504. (delete-region (point) (org-end-of-subtree t)))))
  1505. (defun org-export-handle-comments (commentsp)
  1506. "Remove comments, or convert to backend-specific format.
  1507. COMMENTSP can be a format string for publishing comments.
  1508. When it is nil, all comments will be removed."
  1509. (let ((re "^\\(#\\|[ \t]*#\\+ \\)\\(.*\n?\\)")
  1510. pos)
  1511. (goto-char (point-min))
  1512. (while (or (looking-at re)
  1513. (re-search-forward re nil t))
  1514. (setq pos (match-beginning 0))
  1515. (if (get-text-property pos 'org-protected)
  1516. (goto-char (1+ pos))
  1517. (if (and commentsp
  1518. (not (equal (char-before (match-end 1)) ?+)))
  1519. (progn (add-text-properties
  1520. (match-beginning 0) (match-end 0) '(org-protected t))
  1521. (replace-match (format commentsp (match-string 2)) t t))
  1522. (goto-char (1+ pos))
  1523. (replace-match "")
  1524. (goto-char (max (point-min) (1- pos))))))))
  1525. (defun org-export-handle-table-metalines ()
  1526. "Remove table specific metalines #+TBLNAME: and #+TBLFM:."
  1527. (let ((re "^[ \t]*#\\+TBL\\(NAME\\|FM\\):\\(.*\n?\\)")
  1528. pos)
  1529. (goto-char (point-min))
  1530. (while (or (looking-at re)
  1531. (re-search-forward re nil t))
  1532. (setq pos (match-beginning 0))
  1533. (if (get-text-property (match-beginning 1) 'org-protected)
  1534. (goto-char (1+ pos))
  1535. (goto-char (1+ pos))
  1536. (replace-match "")
  1537. (goto-char (max (point-min) (1- pos)))))))
  1538. (defun org-export-mark-radio-links ()
  1539. "Find all matches for radio targets and turn them into internal links."
  1540. (let ((re-radio (and org-target-link-regexp
  1541. (concat "\\([^<]\\)\\(" org-target-link-regexp "\\)"))))
  1542. (goto-char (point-min))
  1543. (when re-radio
  1544. (while (re-search-forward re-radio nil t)
  1545. (unless
  1546. (save-match-data
  1547. (or (org-in-regexp org-bracket-link-regexp)
  1548. (org-in-regexp org-plain-link-re)
  1549. (org-in-regexp "<<[^<>]+>>")))
  1550. (org-if-unprotected
  1551. (replace-match "\\1[[\\2]]")))))))
  1552. (defun org-export-remove-special-table-lines ()
  1553. "Remove tables lines that are used for internal purposes."
  1554. (goto-char (point-min))
  1555. (while (re-search-forward "^[ \t]*|" nil t)
  1556. (org-if-unprotected-at (1- (point))
  1557. (beginning-of-line 1)
  1558. (if (or (looking-at "[ \t]*| *[!_^] *|")
  1559. (not
  1560. (memq
  1561. nil
  1562. (mapcar
  1563. (lambda (f)
  1564. (or (= (length f) 0)
  1565. (string-match
  1566. "\\`<\\([0-9]\\|[rl]\\|[rl][0-9]+\\)>\\'" f)))
  1567. (org-split-string ;; FIXME, can't we do without splitting???
  1568. (buffer-substring (point-at-bol) (point-at-eol))
  1569. "[ \t]*|[ \t]*")))))
  1570. (delete-region (max (point-min) (1- (point-at-bol)))
  1571. (point-at-eol))
  1572. (end-of-line 1)))))
  1573. (defun org-export-protect-sub-super (s)
  1574. (save-match-data
  1575. (while (string-match "\\([^\\\\]\\)\\([_^]\\)" s)
  1576. (setq s (replace-match "\\1\\\\\\2" nil nil s)))
  1577. s))
  1578. (defun org-export-normalize-links ()
  1579. "Convert all links to bracket links, and expand link abbreviations."
  1580. (let ((re-plain-link (concat "\\([^[<]\\)" org-plain-link-re))
  1581. (re-angle-link (concat "\\([^[]\\)" org-angle-link-re))
  1582. nodesc)
  1583. (goto-char (point-min))
  1584. (while (re-search-forward re-plain-link nil t)
  1585. (goto-char (1- (match-end 0)))
  1586. (org-if-unprotected-at (1+ (match-beginning 0))
  1587. (let* ((s (concat (match-string 1)
  1588. "[[" (match-string 2) ":" (match-string 3)
  1589. "][" (match-string 2) ":" (org-export-protect-sub-super
  1590. (match-string 3))
  1591. "]]")))
  1592. ;; added 'org-link face to links
  1593. (put-text-property 0 (length s) 'face 'org-link s)
  1594. (replace-match s t t))))
  1595. (goto-char (point-min))
  1596. (while (re-search-forward re-angle-link nil t)
  1597. (goto-char (1- (match-end 0)))
  1598. (org-if-unprotected
  1599. (let* ((s (concat (match-string 1)
  1600. "[[" (match-string 2) ":" (match-string 3)
  1601. "][" (match-string 2) ":" (org-export-protect-sub-super
  1602. (match-string 3))
  1603. "]]")))
  1604. (put-text-property 0 (length s) 'face 'org-link s)
  1605. (replace-match s t t))))
  1606. (goto-char (point-min))
  1607. (while (re-search-forward org-bracket-link-regexp nil t)
  1608. (goto-char (1- (match-end 0)))
  1609. (setq nodesc (not (match-end 3)))
  1610. (org-if-unprotected
  1611. (let* ((xx (save-match-data
  1612. (org-translate-link
  1613. (org-link-expand-abbrev (match-string 1)))))
  1614. (s (concat
  1615. "[[" (org-add-props (copy-sequence xx)
  1616. nil 'org-protected t 'org-no-description nodesc)
  1617. "]"
  1618. (if (match-end 3)
  1619. (match-string 2)
  1620. (concat "[" (copy-sequence xx)
  1621. "]"))
  1622. "]")))
  1623. (put-text-property 0 (length s) 'face 'org-link s)
  1624. (replace-match s t t))))))
  1625. (defun org-export-concatenate-multiline-links ()
  1626. "Find multi-line links and put it all into a single line.
  1627. This is to make sure that the line-processing export backends
  1628. can work correctly."
  1629. (goto-char (point-min))
  1630. (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
  1631. (org-if-unprotected-at (match-beginning 1)
  1632. (replace-match "\\1 \\3")
  1633. (goto-char (match-beginning 0)))))
  1634. (defun org-export-concatenate-multiline-emphasis ()
  1635. "Find multi-line emphasis and put it all into a single line.
  1636. This is to make sure that the line-processing export backends
  1637. can work correctly."
  1638. (goto-char (point-min))
  1639. (while (re-search-forward org-emph-re nil t)
  1640. (if (and (not (= (char-after (match-beginning 3))
  1641. (char-after (match-beginning 4))))
  1642. (save-excursion (goto-char (match-beginning 0))
  1643. (save-match-data (not (org-at-table-p)))))
  1644. (org-if-unprotected
  1645. (subst-char-in-region (match-beginning 0) (match-end 0)
  1646. ?\n ?\ t)
  1647. (goto-char (1- (match-end 0))))
  1648. (goto-char (1+ (match-beginning 0))))))
  1649. (defun org-export-grab-title-from-buffer ()
  1650. "Get a title for the current document, from looking at the buffer."
  1651. (let ((inhibit-read-only t))
  1652. (save-excursion
  1653. (goto-char (point-min))
  1654. (let ((end (if (looking-at org-outline-regexp)
  1655. (point)
  1656. (save-excursion (outline-next-heading) (point)))))
  1657. (when (re-search-forward "^[ \t]*[^|# \t\r\n].*\n" end t)
  1658. ;; Mark the line so that it will not be exported as normal text.
  1659. (org-unmodified
  1660. (add-text-properties (match-beginning 0) (match-end 0)
  1661. (list :org-license-to-kill t)))
  1662. ;; Return the title string
  1663. (org-trim (match-string 0)))))))
  1664. (defun org-export-get-title-from-subtree ()
  1665. "Return subtree title and exclude it from export."
  1666. (let (title (rbeg (region-beginning)) (rend (region-end)))
  1667. (save-excursion
  1668. (goto-char rbeg)
  1669. (when (and (org-at-heading-p)
  1670. (>= (org-end-of-subtree t t) rend))
  1671. ;; This is a subtree, we take the title from the first heading
  1672. (goto-char rbeg)
  1673. (looking-at org-todo-line-regexp)
  1674. (setq title (match-string 3))
  1675. (org-unmodified
  1676. (add-text-properties (point) (1+ (point-at-eol))
  1677. (list :org-license-to-kill t)))
  1678. (setq title (or (org-entry-get nil "EXPORT_TITLE") title))))
  1679. title))
  1680. (defun org-solidify-link-text (s &optional alist)
  1681. "Take link text and make a safe target out of it."
  1682. (save-match-data
  1683. (let* ((rtn
  1684. (mapconcat
  1685. 'identity
  1686. (org-split-string s "[ \t\r\n]+") "=="))
  1687. (a (assoc rtn alist)))
  1688. (or (cdr a) rtn))))
  1689. (defun org-get-min-level (lines &optional offset)
  1690. "Get the minimum level in LINES."
  1691. (let ((re "^\\(\\*+\\) ") l)
  1692. (catch 'exit
  1693. (while (setq l (pop lines))
  1694. (if (string-match re l)
  1695. (throw 'exit (org-tr-level (- (length (match-string 1 l))
  1696. (or offset 0))))))
  1697. 1)))
  1698. ;; Variable holding the vector with section numbers
  1699. (defvar org-section-numbers (make-vector org-level-max 0))
  1700. (defun org-init-section-numbers ()
  1701. "Initialize the vector for the section numbers."
  1702. (let* ((level -1)
  1703. (numbers (nreverse (org-split-string "" "\\.")))
  1704. (depth (1- (length org-section-numbers)))
  1705. (i depth) number-string)
  1706. (while (>= i 0)
  1707. (if (> i level)
  1708. (aset org-section-numbers i 0)
  1709. (setq number-string (or (car numbers) "0"))
  1710. (if (string-match "\\`[A-Z]\\'" number-string)
  1711. (aset org-section-numbers i
  1712. (- (string-to-char number-string) ?A -1))
  1713. (aset org-section-numbers i (string-to-number number-string)))
  1714. (pop numbers))
  1715. (setq i (1- i)))))
  1716. (defun org-section-number (&optional level)
  1717. "Return a string with the current section number.
  1718. When LEVEL is non-nil, increase section numbers on that level."
  1719. (let* ((depth (1- (length org-section-numbers)))
  1720. (string "")
  1721. (fmts (car org-export-section-number-format))
  1722. (term (cdr org-export-section-number-format))
  1723. (sep "")
  1724. ctype fmt idx n)
  1725. (when level
  1726. (when (> level -1)
  1727. (aset org-section-numbers
  1728. level (1+ (aref org-section-numbers level))))
  1729. (setq idx (1+ level))
  1730. (while (<= idx depth)
  1731. (if (not (= idx 1))
  1732. (aset org-section-numbers idx 0))
  1733. (setq idx (1+ idx))))
  1734. (setq idx 0)
  1735. (while (<= idx depth)
  1736. (when (> (aref org-section-numbers idx) 0)
  1737. (setq fmt (or (pop fmts) fmt)
  1738. ctype (car fmt)
  1739. n (aref org-section-numbers idx)
  1740. string (if (> n 0)
  1741. (concat string sep (org-number-to-counter n ctype))
  1742. (concat string ".0"))
  1743. sep (nth 1 fmt)))
  1744. (setq idx (1+ idx)))
  1745. (save-match-data
  1746. (if (string-match "\\`\\([@0]\\.\\)+" string)
  1747. (setq string (replace-match "" t nil string)))
  1748. (if (string-match "\\(\\.0\\)+\\'" string)
  1749. (setq string (replace-match "" t nil string))))
  1750. (concat string term)))
  1751. (defun org-number-to-counter (n type)
  1752. "Concert number N to a string counter, according to TYPE.
  1753. TYPE must be a string, any of:
  1754. 1 number
  1755. A A,B,....
  1756. a a,b,....
  1757. I upper case roman numeral
  1758. i lower case roman numeral"
  1759. (cond
  1760. ((equal type "1") (number-to-string n))
  1761. ((equal type "A") (char-to-string (+ ?A n -1)))
  1762. ((equal type "a") (char-to-string (+ ?a n -1)))
  1763. ((equal type "I") (org-number-to-roman n))
  1764. ((equal type "i") (downcase (org-number-to-roman n)))
  1765. (t (error "Invalid counter type `%s'" type))))
  1766. (defun org-number-to-roman (n)
  1767. "Convert integer N into a roman numeral."
  1768. (let ((roman '((1000 . "M") (900 . "CM") (500 . "D") (400 . "CD")
  1769. ( 100 . "C") ( 90 . "XC") ( 50 . "L") ( 40 . "XL")
  1770. ( 10 . "X") ( 9 . "IX") ( 5 . "V") ( 4 . "IV")
  1771. ( 1 . "I")))
  1772. (res ""))
  1773. (if (<= n 0)
  1774. (number-to-string n)
  1775. (while roman
  1776. (if (>= n (caar roman))
  1777. (setq n (- n (caar roman))
  1778. res (concat res (cdar roman)))
  1779. (pop roman)))
  1780. res)))
  1781. ;;; Macros
  1782. (defun org-export-preprocess-apply-macros ()
  1783. "Replace macro references."
  1784. (goto-char (point-min))
  1785. (let (sy val key args args2 s n)
  1786. (while (re-search-forward
  1787. "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}"
  1788. nil t)
  1789. (unless (save-match-data
  1790. (save-excursion
  1791. (goto-char (point-at-bol))
  1792. (looking-at "[ \t]*#\\+macro")))
  1793. (setq key (downcase (match-string 1))
  1794. args (match-string 3))
  1795. (when (setq val (or (plist-get org-export-opt-plist
  1796. (intern (concat ":macro-" key)))
  1797. (plist-get org-export-opt-plist
  1798. (intern (concat ":" key)))))
  1799. (save-match-data
  1800. (when args
  1801. (setq args (org-split-string args ",[ \t\n]*") args2 nil)
  1802. (setq args (mapcar 'org-trim args))
  1803. (while args
  1804. (while (string-match "\\\\\\'" (car args))
  1805. ;; repair bad splits
  1806. (setcar (cdr args) (concat (substring (car args) 0 -1)
  1807. ";" (nth 1 args)))
  1808. (pop args))
  1809. (push (pop args) args2))
  1810. (setq args (nreverse args2))
  1811. (setq s 0)
  1812. (while (string-match "\\$\\([0-9]+\\)" val s)
  1813. (setq s (1+ (match-beginning 0))
  1814. n (string-to-number (match-string 1 val)))
  1815. (and (>= (length args) n)
  1816. (setq val (replace-match (nth (1- n) args) t t val)))))
  1817. (when (string-match "\\`(eval\\>" val)
  1818. (setq val (eval (read val))))
  1819. (if (and val (not (stringp val)))
  1820. (setq val (format "%s" val))))
  1821. (and (stringp val)
  1822. (prog1 (replace-match val t t)
  1823. (goto-char (match-beginning 0)))))))))
  1824. (defun org-export-apply-macros-in-string (s)
  1825. "Apply the macros in string S."
  1826. (when s
  1827. (with-temp-buffer
  1828. (insert s)
  1829. (org-export-preprocess-apply-macros)
  1830. (buffer-string))))
  1831. ;;; Include files
  1832. (defun org-export-handle-include-files ()
  1833. "Include the contents of include files, with proper formatting."
  1834. (let ((case-fold-search t)
  1835. params file markup lang start end prefix prefix1 switches all)
  1836. (goto-char (point-min))
  1837. (while (re-search-forward "^#\\+INCLUDE:?[ \t]+\\(.*\\)" nil t)
  1838. (setq params (read (concat "(" (match-string 1) ")"))
  1839. prefix (org-get-and-remove-property 'params :prefix)
  1840. prefix1 (org-get-and-remove-property 'params :prefix1)
  1841. file (org-symname-or-string (pop params))
  1842. markup (org-symname-or-string (pop params))
  1843. lang (and (member markup '("src" "SRC"))
  1844. (org-symname-or-string (pop params)))
  1845. switches (mapconcat '(lambda (x) (format "%s" x)) params " ")
  1846. start nil end nil)
  1847. (delete-region (match-beginning 0) (match-end 0))
  1848. (if (or (not file)
  1849. (not (file-exists-p file))
  1850. (not (file-readable-p file)))
  1851. (insert (format "CANNOT INCLUDE FILE %s" file))
  1852. (setq all (cons file all))
  1853. (when markup
  1854. (if (equal (downcase markup) "src")
  1855. (setq start (format "#+begin_src %s %s\n"
  1856. (or lang "fundamental")
  1857. (or switches ""))
  1858. end "#+end_src")
  1859. (setq start (format "#+begin_%s %s\n" markup switches)
  1860. end (format "#+end_%s" markup))))
  1861. (insert (or start ""))
  1862. (insert (org-get-file-contents (expand-file-name file)
  1863. prefix prefix1 markup))
  1864. (or (bolp) (newline))
  1865. (insert (or end ""))))
  1866. all))
  1867. (defun org-export-handle-include-files-recurse ()
  1868. "Recursively include files aborting on circular inclusion."
  1869. (let ((now (list org-current-export-file)) all)
  1870. (while now
  1871. (setq all (append now all))
  1872. (setq now (org-export-handle-include-files))
  1873. (let ((intersection
  1874. (delq nil
  1875. (mapcar (lambda (el) (when (member el all) el)) now))))
  1876. (when intersection
  1877. (error "Recursive #+INCLUDE: %S" intersection))))))
  1878. (defun org-get-file-contents (file &optional prefix prefix1 markup)
  1879. "Get the contents of FILE and return them as a string.
  1880. If PREFIX is a string, prepend it to each line. If PREFIX1
  1881. is a string, prepend it to the first line instead of PREFIX.
  1882. If MARKUP, don't protect org-like lines, the exporter will
  1883. take care of the block they are in."
  1884. (if (stringp markup) (setq markup (downcase markup)))
  1885. (with-temp-buffer
  1886. (insert-file-contents file)
  1887. (when (or prefix prefix1)
  1888. (goto-char (point-min))
  1889. (while (not (eobp))
  1890. (insert (or prefix1 prefix))
  1891. (setq prefix1 "")
  1892. (beginning-of-line 2)))
  1893. (buffer-string)
  1894. (when (member markup '("src" "example"))
  1895. (goto-char (point-min))
  1896. (while (re-search-forward "^\\([*#]\\|[ \t]*#\\+\\)" nil t)
  1897. (goto-char (match-beginning 0))
  1898. (insert ",")
  1899. (end-of-line 1)))
  1900. (buffer-string)))
  1901. (defun org-get-and-remove-property (listvar prop)
  1902. "Check if the value of LISTVAR contains PROP as a property.
  1903. If yes, return the value of that property (i.e. the element following
  1904. in the list) and remove property and value from the list in LISTVAR."
  1905. (let ((list (symbol-value listvar)) m v)
  1906. (when (setq m (member prop list))
  1907. (setq v (nth 1 m))
  1908. (if (equal (car list) prop)
  1909. (set listvar (cddr list))
  1910. (setcdr (nthcdr (- (length list) (length m) 1) list)
  1911. (cddr m))
  1912. (set listvar list)))
  1913. v))
  1914. (defun org-symname-or-string (s)
  1915. (if (symbolp s)
  1916. (if s (symbol-name s) s)
  1917. s))
  1918. ;;; Fontification and line numbers for code examples
  1919. (defvar org-export-last-code-line-counter-value 0)
  1920. (defun org-export-replace-src-segments-and-examples (backend)
  1921. "Replace source code segments with special code for export."
  1922. (setq org-export-last-code-line-counter-value 0)
  1923. (let ((case-fold-search t)
  1924. lang code trans opts indent caption)
  1925. (goto-char (point-min))
  1926. (while (re-search-forward
  1927. "\\(^\\([ \t]*\\)#\\+BEGIN_SRC:?\\([ \t]+\\([^ \t\n]+\\)\\)?\\(.*\\)\n\\([^\000]+?\n\\)[ \t]*#\\+END_SRC.*\n?\\)\\|\\(^\\([ \t]*\\)#\\+BEGIN_EXAMPLE:?\\(?:[ \t]+\\(.*\\)\\)?\n\\([^\000]+?\n\\)[ \t]*#\\+END_EXAMPLE.*\n?\\)"
  1928. nil t)
  1929. (if (match-end 1)
  1930. (if (not (match-string 4))
  1931. (error "Source block missing language specification: %s"
  1932. (let* ((body (match-string 6))
  1933. (nothing (message "body:%s" body))
  1934. (preview (or (and (string-match
  1935. "^[ \t]*\\([^\n\r]*\\)" body)
  1936. (match-string 1 body)) body)))
  1937. (if (> (length preview) 35)
  1938. (concat (substring preview 0 32) "...")
  1939. preview)))
  1940. ;; src segments
  1941. (setq lang (match-string 4)
  1942. opts (match-string 5)
  1943. code (match-string 6)
  1944. indent (length (match-string 2))
  1945. caption (get-text-property 0 'org-caption (match-string 0))))
  1946. (setq lang nil
  1947. opts (match-string 9)
  1948. code (match-string 10)
  1949. indent (length (match-string 8))
  1950. caption (get-text-property 0 'org-caption (match-string 0))))
  1951. (setq trans (org-export-format-source-code-or-example
  1952. backend lang code opts indent caption))
  1953. (replace-match trans t t))))
  1954. (defvar htmlp) ;; dynamically scoped
  1955. (defvar latexp) ;; dynamically scoped
  1956. (defvar org-export-latex-verbatim-wrap) ;; defined in org-latex.el
  1957. (defvar org-export-latex-listings) ;; defined in org-latex.el
  1958. (defvar org-export-latex-listings-langs) ;; defined in org-latex.el
  1959. (defvar org-export-latex-listings-w-names) ;; defined in org-latex.el
  1960. (defun org-export-format-source-code-or-example
  1961. (backend lang code &optional opts indent caption)
  1962. "Format CODE from language LANG and return it formatted for export.
  1963. If LANG is nil, do not add any fontification.
  1964. OPTS contains formatting options, like `-n' for triggering numbering lines,
  1965. and `+n' for continuing previous numbering.
  1966. Code formatting according to language currently only works for HTML.
  1967. Numbering lines works for all three major backends (html, latex, and ascii).
  1968. INDENT was the original indentation of the block."
  1969. (save-match-data
  1970. (let (num cont rtn rpllbl keepp textareap preserve-indentp cols rows fmt)
  1971. (setq opts (or opts "")
  1972. num (string-match "[-+]n\\>" opts)
  1973. cont (string-match "\\+n\\>" opts)
  1974. rpllbl (string-match "-r\\>" opts)
  1975. keepp (string-match "-k\\>" opts)
  1976. textareap (string-match "-t\\>" opts)
  1977. preserve-indentp (or org-src-preserve-indentation
  1978. (string-match "-i\\>" opts))
  1979. cols (if (string-match "-w[ \t]+\\([0-9]+\\)" opts)
  1980. (string-to-number (match-string 1 opts))
  1981. 80)
  1982. rows (if (string-match "-h[ \t]+\\([0-9]+\\)" opts)
  1983. (string-to-number (match-string 1 opts))
  1984. (org-count-lines code))
  1985. fmt (if (string-match "-l[ \t]+\"\\([^\"\n]+\\)\"" opts)
  1986. (match-string 1 opts)))
  1987. (when (and textareap (eq backend 'html))
  1988. ;; we cannot use numbering or highlighting.
  1989. (setq num nil cont nil lang nil))
  1990. (if keepp (setq rpllbl 'keep))
  1991. (setq rtn (if preserve-indentp code (org-remove-indentation code)))
  1992. (when (string-match "^," rtn)
  1993. (setq rtn (with-temp-buffer
  1994. (insert rtn)
  1995. ;; Free up the protected lines
  1996. (goto-char (point-min))
  1997. (while (re-search-forward "^," nil t)
  1998. (if (or (equal lang "org")
  1999. (save-match-data
  2000. (looking-at "\\([*#]\\|[ \t]*#\\+\\)")))
  2001. (replace-match ""))
  2002. (end-of-line 1))
  2003. (buffer-string))))
  2004. ;; Now backend-specific coding
  2005. (setq rtn
  2006. (cond
  2007. ((eq backend 'docbook)
  2008. (setq rtn (org-export-number-lines rtn 'docbook 0 0 num cont rpllbl fmt))
  2009. (concat "\n#+BEGIN_DOCBOOK\n"
  2010. (org-add-props (concat "<programlisting><![CDATA["
  2011. rtn
  2012. "]]></programlisting>\n")
  2013. '(org-protected t org-example t))
  2014. "#+END_DOCBOOK\n"))
  2015. ((eq backend 'html)
  2016. ;; We are exporting to HTML
  2017. (when lang
  2018. (if (featurep 'xemacs)
  2019. (require 'htmlize)
  2020. (require 'htmlize nil t))
  2021. (when (not (fboundp 'htmlize-region-for-paste))
  2022. ;; we do not have htmlize.el, or an old version of it
  2023. (setq lang nil)
  2024. (message
  2025. "htmlize.el 1.34 or later is needed for source code formatting")))
  2026. (if lang
  2027. (let* ((lang-m (when lang
  2028. (or (cdr (assoc lang org-src-lang-modes))
  2029. lang)))
  2030. (mode (and lang-m (intern
  2031. (concat
  2032. (if (symbolp lang-m)
  2033. (symbol-name lang-m)
  2034. lang-m)
  2035. "-mode"))))
  2036. (org-inhibit-startup t)
  2037. (org-startup-folded nil))
  2038. (setq rtn
  2039. (with-temp-buffer
  2040. (insert rtn)
  2041. (if (functionp mode)
  2042. (funcall mode)
  2043. (fundamental-mode))
  2044. (font-lock-fontify-buffer)
  2045. (org-src-mode)
  2046. (set-buffer-modified-p nil)
  2047. (org-export-htmlize-region-for-paste
  2048. (point-min) (point-max))))
  2049. (if (string-match "<pre\\([^>]*\\)>\n*" rtn)
  2050. (setq rtn
  2051. (concat
  2052. (if caption
  2053. (concat
  2054. "<div class=\"org-src-container\">"
  2055. (format
  2056. "<label class=\"org-src-name\">%s</label>"
  2057. caption))
  2058. "")
  2059. (replace-match
  2060. (format "<pre class=\"src src-%s\">\n" lang)
  2061. t t rtn)
  2062. (if caption "</div>" "")))))
  2063. (if textareap
  2064. (setq rtn (concat
  2065. (format "<p>\n<textarea cols=\"%d\" rows=\"%d\">"
  2066. cols rows)
  2067. rtn "</textarea>\n</p>\n"))
  2068. (with-temp-buffer
  2069. (insert rtn)
  2070. (goto-char (point-min))
  2071. (while (re-search-forward "[<>&]" nil t)
  2072. (replace-match (cdr (assq (char-before)
  2073. '((?&."&amp;")(?<."&lt;")(?>."&gt;"))))
  2074. t t))
  2075. (setq rtn (buffer-string)))
  2076. (setq rtn (concat "<pre class=\"example\">\n" rtn "</pre>\n"))))
  2077. (unless textareap
  2078. (setq rtn (org-export-number-lines rtn 'html 1 1 num
  2079. cont rpllbl fmt)))
  2080. (if (string-match "\\(\\`<[^>]*>\\)\n" rtn)
  2081. (setq rtn (replace-match "\\1" t nil rtn)))
  2082. (concat "\n#+BEGIN_HTML\n" (org-add-props rtn '(org-protected t org-example t)) "\n#+END_HTML\n\n"))
  2083. ((eq backend 'latex)
  2084. (setq rtn (org-export-number-lines rtn 'latex 0 0 num cont rpllbl fmt))
  2085. (concat "#+BEGIN_LaTeX\n"
  2086. (org-add-props
  2087. (if org-export-latex-listings
  2088. (concat
  2089. (if lang
  2090. (let*
  2091. ((lang-sym (intern lang))
  2092. (lstlang
  2093. (or (cadr
  2094. (assq
  2095. lang-sym
  2096. org-export-latex-listings-langs))
  2097. lang)))
  2098. (format "\\lstset{language=%s}\n" lstlang))
  2099. "\n")
  2100. (when (and caption
  2101. org-export-latex-listings-w-names)
  2102. (format "\n%s $\\equiv$ \n"
  2103. (replace-regexp-in-string
  2104. "_" "\\\\_" caption)))
  2105. "\\begin{lstlisting}\n"
  2106. rtn "\\end{lstlisting}\n")
  2107. (concat (car org-export-latex-verbatim-wrap)
  2108. rtn (cdr org-export-latex-verbatim-wrap)))
  2109. '(org-protected t org-example t))
  2110. "#+END_LaTeX\n"))
  2111. ((eq backend 'ascii)
  2112. ;; This is not HTML or LaTeX, so just make it an example.
  2113. (setq rtn (org-export-number-lines rtn 'ascii 0 0 num cont rpllbl fmt))
  2114. (concat caption "\n"
  2115. "#+BEGIN_ASCII\n"
  2116. (org-add-props
  2117. (concat
  2118. (mapconcat
  2119. (lambda (l) (concat " " l))
  2120. (org-split-string rtn "\n")
  2121. "\n")
  2122. "\n")
  2123. '(org-protected t org-example t))
  2124. "#+END_ASCII\n"))))
  2125. (org-add-props rtn nil 'original-indentation indent))))
  2126. (defun org-export-number-lines (text backend
  2127. &optional skip1 skip2 number cont
  2128. replace-labels label-format)
  2129. (setq skip1 (or skip1 0) skip2 (or skip2 0))
  2130. (if (not cont) (setq org-export-last-code-line-counter-value 0))
  2131. (with-temp-buffer
  2132. (insert text)
  2133. (goto-char (point-max))
  2134. (skip-chars-backward " \t\n\r")
  2135. (delete-region (point) (point-max))
  2136. (beginning-of-line (- 1 skip2))
  2137. (let* ((last (org-current-line))
  2138. (n org-export-last-code-line-counter-value)
  2139. (nmax (+ n (- last skip1)))
  2140. (fmt (format "%%%dd: " (length (number-to-string nmax))))
  2141. (fm
  2142. (cond
  2143. ((eq backend 'html) (format "<span class=\"linenr\">%s</span>"
  2144. fmt))
  2145. ((eq backend 'ascii) fmt)
  2146. ((eq backend 'latex) fmt)
  2147. ((eq backend 'docbook) fmt)
  2148. (t "")))
  2149. (label-format (or label-format org-coderef-label-format))
  2150. (label-pre (if (string-match "%s" label-format)
  2151. (substring label-format 0 (match-beginning 0))
  2152. label-format))
  2153. (label-post (if (string-match "%s" label-format)
  2154. (substring label-format (match-end 0))
  2155. ""))
  2156. (lbl-re
  2157. (concat
  2158. ".*?\\S-.*?\\([ \t]*\\("
  2159. (regexp-quote label-pre)
  2160. "\\([-a-zA-Z0-9_ ]+\\)"
  2161. (regexp-quote label-post)
  2162. "\\)\\)"))
  2163. ref)
  2164. (org-goto-line (1+ skip1))
  2165. (while (and (re-search-forward "^" nil t) (not (eobp)) (< n nmax))
  2166. (if number
  2167. (insert (format fm (incf n)))
  2168. (forward-char 1))
  2169. (when (looking-at lbl-re)
  2170. (setq ref (match-string 3))
  2171. (cond ((numberp replace-labels)
  2172. ;; remove labels; use numbers for references when lines
  2173. ;; are numbered, use labels otherwise
  2174. (delete-region (match-beginning 1) (match-end 1))
  2175. (push (cons ref (if (> n 0) n ref)) org-export-code-refs))
  2176. ((eq replace-labels 'keep)
  2177. ;; don't remove labels; use numbers for references when
  2178. ;; lines are numbered, use labels otherwise
  2179. (goto-char (match-beginning 2))
  2180. (delete-region (match-beginning 2) (match-end 2))
  2181. (insert "(" ref ")")
  2182. (push (cons ref (if (> n 0) n (concat "(" ref ")")))
  2183. org-export-code-refs))
  2184. (t
  2185. ;; don't remove labels and don't use numbers for
  2186. ;; references
  2187. (goto-char (match-beginning 2))
  2188. (delete-region (match-beginning 2) (match-end 2))
  2189. (insert "(" ref ")")
  2190. (push (cons ref (concat "(" ref ")")) org-export-code-refs)))
  2191. (when (eq backend 'html)
  2192. (save-excursion
  2193. (beginning-of-line 1)
  2194. (insert (format "<span id=\"coderef-%s\" class=\"coderef-off\">"
  2195. ref))
  2196. (end-of-line 1)
  2197. (insert "</span>")))))
  2198. (setq org-export-last-code-line-counter-value n)
  2199. (goto-char (point-max))
  2200. (newline)
  2201. (buffer-string))))
  2202. (defun org-search-todo-below (line lines level)
  2203. "Search the subtree below LINE for any TODO entries."
  2204. (let ((rest (cdr (memq line lines)))
  2205. (re org-todo-line-regexp)
  2206. line lv todo)
  2207. (catch 'exit
  2208. (while (setq line (pop rest))
  2209. (if (string-match re line)
  2210. (progn
  2211. (setq lv (- (match-end 1) (match-beginning 1))
  2212. todo (and (match-beginning 2)
  2213. (not (member (match-string 2 line)
  2214. org-done-keywords))))
  2215. ; TODO, not DONE
  2216. (if (<= lv level) (throw 'exit nil))
  2217. (if todo (throw 'exit t))))))))
  2218. ;;;###autoload
  2219. (defun org-export-visible (type arg)
  2220. "Create a copy of the visible part of the current buffer, and export it.
  2221. The copy is created in a temporary buffer and removed after use.
  2222. TYPE is the final key (as a string) that also selects the export command in
  2223. the \\<org-mode-map>\\[org-export] export dispatcher.
  2224. As a special case, if the you type SPC at the prompt, the temporary
  2225. org-mode file will not be removed but presented to you so that you can
  2226. continue to use it. The prefix arg ARG is passed through to the exporting
  2227. command."
  2228. (interactive
  2229. (list (progn
  2230. (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]buffer with HTML [D]ocBook [l]atex [p]df [d]view pdf [L]atex buffer [x]OXO [ ]keep buffer")
  2231. (read-char-exclusive))
  2232. current-prefix-arg))
  2233. (if (not (member type '(?a ?n ?u ?\C-a ?b ?\C-b ?h ?D ?x ?\ ?l ?p ?d ?L)))
  2234. (error "Invalid export key"))
  2235. (let* ((binding (cdr (assoc type
  2236. '(
  2237. (?a . org-export-as-ascii)
  2238. (?A . org-export-as-ascii-to-buffer)
  2239. (?n . org-export-as-latin1)
  2240. (?N . org-export-as-latin1-to-buffer)
  2241. (?u . org-export-as-utf8)
  2242. (?U . org-export-as-utf8-to-buffer)
  2243. (?\C-a . org-export-as-ascii)
  2244. (?b . org-export-as-html-and-open)
  2245. (?\C-b . org-export-as-html-and-open)
  2246. (?h . org-export-as-html)
  2247. (?H . org-export-as-html-to-buffer)
  2248. (?R . org-export-region-as-html)
  2249. (?D . org-export-as-docbook)
  2250. (?l . org-export-as-latex)
  2251. (?p . org-export-as-pdf)
  2252. (?d . org-export-as-pdf-and-open)
  2253. (?L . org-export-as-latex-to-buffer)
  2254. (?x . org-export-as-xoxo)))))
  2255. (keepp (equal type ?\ ))
  2256. (file buffer-file-name)
  2257. (buffer (get-buffer-create "*Org Export Visible*"))
  2258. s e)
  2259. ;; Need to hack the drawers here.
  2260. (save-excursion
  2261. (goto-char (point-min))
  2262. (while (re-search-forward org-drawer-regexp nil t)
  2263. (goto-char (match-beginning 1))
  2264. (or (org-invisible-p) (org-flag-drawer nil))))
  2265. (with-current-buffer buffer (erase-buffer))
  2266. (save-excursion
  2267. (setq s (goto-char (point-min)))
  2268. (while (not (= (point) (point-max)))
  2269. (goto-char (org-find-invisible))
  2270. (append-to-buffer buffer s (point))
  2271. (setq s (goto-char (org-find-visible))))
  2272. (org-cycle-hide-drawers 'all)
  2273. (goto-char (point-min))
  2274. (unless keepp
  2275. ;; Copy all comment lines to the end, to make sure #+ settings are
  2276. ;; still available for the second export step. Kind of a hack, but
  2277. ;; does do the trick.
  2278. (if (looking-at "#[^\r\n]*")
  2279. (append-to-buffer buffer (match-beginning 0) (1+ (match-end 0))))
  2280. (while (re-search-forward "[\n\r]#[^\n\r]*" nil t)
  2281. (append-to-buffer buffer (1+ (match-beginning 0))
  2282. (min (point-max) (1+ (match-end 0))))))
  2283. (set-buffer buffer)
  2284. (let ((buffer-file-name file)
  2285. (org-inhibit-startup t))
  2286. (org-mode)
  2287. (show-all)
  2288. (unless keepp (funcall binding arg))))
  2289. (if (not keepp)
  2290. (kill-buffer buffer)
  2291. (switch-to-buffer-other-window buffer)
  2292. (goto-char (point-min)))))
  2293. (defun org-find-visible ()
  2294. (let ((s (point)))
  2295. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  2296. (get-char-property s 'invisible)))
  2297. s))
  2298. (defun org-find-invisible ()
  2299. (let ((s (point)))
  2300. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  2301. (not (get-char-property s 'invisible))))
  2302. s))
  2303. (defvar org-export-htmlized-org-css-url) ;; defined in org-html.el
  2304. ;;;###autoload
  2305. (defun org-export-as-org (arg &optional hidden ext-plist
  2306. to-buffer body-only pub-dir)
  2307. "Make a copy with not-exporting stuff removed.
  2308. The purpose of this function is to provide a way to export the source
  2309. Org file of a webpage in Org format, but with sensitive and/or irrelevant
  2310. stuff removed. This command will remove the following:
  2311. - archived trees (if the variable `org-export-with-archived-trees' is nil)
  2312. - comment blocks and trees starting with the COMMENT keyword
  2313. - only trees that are consistent with `org-export-select-tags'
  2314. and `org-export-exclude-tags'.
  2315. The only arguments that will be used are EXT-PLIST and PUB-DIR,
  2316. all the others will be ignored (but are present so that the general
  2317. mechanism to call publishing functions will work).
  2318. EXT-PLIST is a property list with external parameters overriding
  2319. org-mode's default settings, but still inferior to file-local
  2320. settings. When PUB-DIR is set, use this as the publishing
  2321. directory."
  2322. (interactive "P")
  2323. (let* ((opt-plist (org-combine-plists (org-default-export-plist)
  2324. ext-plist
  2325. (org-infile-export-plist)))
  2326. (bfname (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
  2327. (filename (concat (file-name-as-directory
  2328. (or pub-dir
  2329. (org-export-directory :org opt-plist)))
  2330. (file-name-sans-extension
  2331. (file-name-nondirectory bfname))
  2332. ".org"))
  2333. (filename (and filename
  2334. (if (equal (file-truename filename)
  2335. (file-truename bfname))
  2336. (concat (file-name-sans-extension filename)
  2337. "-source."
  2338. (file-name-extension filename))
  2339. filename)))
  2340. (backup-inhibited t)
  2341. (buffer (find-file-noselect filename))
  2342. (region (buffer-string))
  2343. str-ret)
  2344. (save-excursion
  2345. (switch-to-buffer buffer)
  2346. (erase-buffer)
  2347. (insert region)
  2348. (let ((org-inhibit-startup t)) (org-mode))
  2349. (org-install-letbind)
  2350. ;; Get rid of archived trees
  2351. (org-export-remove-archived-trees (plist-get opt-plist :archived-trees))
  2352. ;; Remove comment environment and comment subtrees
  2353. (org-export-remove-comment-blocks-and-subtrees)
  2354. ;; Get rid of excluded trees
  2355. (org-export-handle-export-tags (plist-get opt-plist :select-tags)
  2356. (plist-get opt-plist :exclude-tags))
  2357. (when (or (plist-get opt-plist :plain-source)
  2358. (not (or (plist-get opt-plist :plain-source)
  2359. (plist-get opt-plist :htmlized-source))))
  2360. ;; Either nothing special is requested (default call)
  2361. ;; or the plain source is explicitly requested
  2362. ;; so: save it
  2363. (save-buffer))
  2364. (when (plist-get opt-plist :htmlized-source)
  2365. ;; Make the htmlized version
  2366. (require 'htmlize)
  2367. (require 'org-html)
  2368. (font-lock-fontify-buffer)
  2369. (let* ((htmlize-output-type 'css)
  2370. (newbuf (htmlize-buffer)))
  2371. (with-current-buffer newbuf
  2372. (when org-export-htmlized-org-css-url
  2373. (goto-char (point-min))
  2374. (and (re-search-forward
  2375. "<style type=\"text/css\">[^\000]*?\n[ \t]*</style>.*"
  2376. nil t)
  2377. (replace-match
  2378. (format
  2379. "<link rel=\"stylesheet\" type=\"text/css\" href=\"%s\">"
  2380. org-export-htmlized-org-css-url)
  2381. t t)))
  2382. (write-file (concat filename ".html")))
  2383. (kill-buffer newbuf)))
  2384. (set-buffer-modified-p nil)
  2385. (if (equal to-buffer 'string)
  2386. (progn (setq str-ret (buffer-string))
  2387. (kill-buffer (current-buffer))
  2388. str-ret)
  2389. (kill-buffer (current-buffer))))))
  2390. (defvar org-archive-location) ;; gets loaded with the org-archive require.
  2391. (defun org-get-current-options ()
  2392. "Return a string with current options as keyword options.
  2393. Does include HTML export options as well as TODO and CATEGORY stuff."
  2394. (require 'org-archive)
  2395. (format
  2396. "#+TITLE: %s
  2397. #+AUTHOR: %s
  2398. #+EMAIL: %s
  2399. #+DATE: %s
  2400. #+DESCRIPTION:
  2401. #+KEYWORDS:
  2402. #+LANGUAGE: %s
  2403. #+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s -:%s f:%s *:%s <:%s
  2404. #+OPTIONS: TeX:%s LaTeX:%s skip:%s d:%s todo:%s pri:%s tags:%s
  2405. %s
  2406. #+EXPORT_SELECT_TAGS: %s
  2407. #+EXPORT_EXCLUDE_TAGS: %s
  2408. #+LINK_UP: %s
  2409. #+LINK_HOME: %s
  2410. #+XSLT:
  2411. #+CATEGORY: %s
  2412. #+SEQ_TODO: %s
  2413. #+TYP_TODO: %s
  2414. #+PRIORITIES: %c %c %c
  2415. #+DRAWERS: %s
  2416. #+STARTUP: %s %s %s %s %s
  2417. #+TAGS: %s
  2418. #+FILETAGS: %s
  2419. #+ARCHIVE: %s
  2420. #+LINK: %s
  2421. "
  2422. (buffer-name) (user-full-name) user-mail-address
  2423. (format-time-string (substring (car org-time-stamp-formats) 1 -1))
  2424. org-export-default-language
  2425. org-export-headline-levels
  2426. org-export-with-section-numbers
  2427. org-export-with-toc
  2428. org-export-preserve-breaks
  2429. org-export-html-expand
  2430. org-export-with-fixed-width
  2431. org-export-with-tables
  2432. org-export-with-sub-superscripts
  2433. org-export-with-special-strings
  2434. org-export-with-footnotes
  2435. org-export-with-emphasize
  2436. org-export-with-timestamps
  2437. org-export-with-TeX-macros
  2438. org-export-with-LaTeX-fragments
  2439. org-export-skip-text-before-1st-heading
  2440. org-export-with-drawers
  2441. org-export-with-todo-keywords
  2442. org-export-with-priority
  2443. org-export-with-tags
  2444. (if (featurep 'org-jsinfo) (org-infojs-options-inbuffer-template) "")
  2445. (mapconcat 'identity org-export-select-tags " ")
  2446. (mapconcat 'identity org-export-exclude-tags " ")
  2447. org-export-html-link-up
  2448. org-export-html-link-home
  2449. (or (ignore-errors
  2450. (file-name-sans-extension
  2451. (file-name-nondirectory (buffer-file-name (buffer-base-buffer)))))
  2452. "NOFILENAME")
  2453. "TODO FEEDBACK VERIFY DONE"
  2454. "Me Jason Marie DONE"
  2455. org-highest-priority org-lowest-priority org-default-priority
  2456. (mapconcat 'identity org-drawers " ")
  2457. (cdr (assoc org-startup-folded
  2458. '((nil . "showall") (t . "overview") (content . "content"))))
  2459. (if org-odd-levels-only "odd" "oddeven")
  2460. (if org-hide-leading-stars "hidestars" "showstars")
  2461. (if org-startup-align-all-tables "align" "noalign")
  2462. (cond ((eq org-log-done t) "logdone")
  2463. ((equal org-log-done 'note) "lognotedone")
  2464. ((not org-log-done) "nologdone"))
  2465. (or (mapconcat (lambda (x)
  2466. (cond
  2467. ((equal :startgroup (car x)) "{")
  2468. ((equal :endgroup (car x)) "}")
  2469. ((equal :newline (car x)) "")
  2470. ((cdr x) (format "%s(%c)" (car x) (cdr x)))
  2471. (t (car x))))
  2472. (or org-tag-alist (org-get-buffer-tags)) " ") "")
  2473. (mapconcat 'identity org-file-tags " ")
  2474. org-archive-location
  2475. "org file:~/org/%s.org"
  2476. ))
  2477. ;;;###autoload
  2478. (defun org-insert-export-options-template ()
  2479. "Insert into the buffer a template with information for exporting."
  2480. (interactive)
  2481. (if (not (bolp)) (newline))
  2482. (let ((s (org-get-current-options)))
  2483. (and (string-match "#\\+CATEGORY" s)
  2484. (setq s (substring s 0 (match-beginning 0))))
  2485. (insert s)))
  2486. (defvar org-table-colgroup-info nil)
  2487. (defun org-table-clean-before-export (lines &optional maybe-quoted)
  2488. "Check if the table has a marking column.
  2489. If yes remove the column and the special lines."
  2490. (setq org-table-colgroup-info nil)
  2491. (if (memq nil
  2492. (mapcar
  2493. (lambda (x) (or (string-match "^[ \t]*|-" x)
  2494. (string-match
  2495. (if maybe-quoted
  2496. "^[ \t]*| *\\\\?\\([\#!$*_^ /]\\) *|"
  2497. "^[ \t]*| *\\([\#!$*_^ /]\\) *|")
  2498. x)))
  2499. lines))
  2500. ;; No special marking column
  2501. (progn
  2502. (setq org-table-clean-did-remove-column nil)
  2503. (delq nil
  2504. (mapcar
  2505. (lambda (x)
  2506. (cond
  2507. ((org-table-colgroup-line-p x)
  2508. ;; This line contains colgroup info, extract it
  2509. ;; and then discard the line
  2510. (setq org-table-colgroup-info
  2511. (mapcar (lambda (x)
  2512. (cond ((member x '("<" "&lt;")) :start)
  2513. ((member x '(">" "&gt;")) :end)
  2514. ((member x '("<>" "&lt;&gt;")) :startend)
  2515. (t nil)))
  2516. (org-split-string x "[ \t]*|[ \t]*")))
  2517. nil)
  2518. ((org-table-cookie-line-p x)
  2519. ;; This line contains formatting cookies, discard it
  2520. nil)
  2521. (t x)))
  2522. lines)))
  2523. ;; there is a special marking column
  2524. (setq org-table-clean-did-remove-column t)
  2525. (delq nil
  2526. (mapcar
  2527. (lambda (x)
  2528. (cond
  2529. ((org-table-colgroup-line-p x)
  2530. ;; This line contains colgroup info, extract it
  2531. ;; and then discard the line
  2532. (setq org-table-colgroup-info
  2533. (mapcar (lambda (x)
  2534. (cond ((member x '("<" "&lt;")) :start)
  2535. ((member x '(">" "&gt;")) :end)
  2536. ((member x '("<>" "&lt;&gt;")) :startend)
  2537. (t nil)))
  2538. (cdr (org-split-string x "[ \t]*|[ \t]*"))))
  2539. nil)
  2540. ((org-table-cookie-line-p x)
  2541. ;; This line contains formatting cookies, discard it
  2542. nil)
  2543. ((string-match "^[ \t]*| *[!_^/] *|" x)
  2544. ;; ignore this line
  2545. nil)
  2546. ((or (string-match "^\\([ \t]*\\)|-+\\+" x)
  2547. (string-match "^\\([ \t]*\\)|[^|]*|" x))
  2548. ;; remove the first column
  2549. (replace-match "\\1|" t nil x))))
  2550. lines))))
  2551. (defun org-export-cleanup-toc-line (s)
  2552. "Remove tags and timestamps from lines going into the toc."
  2553. (when (memq org-export-with-tags '(not-in-toc nil))
  2554. (if (string-match (org-re " +:[[:alnum:]_@:]+: *$") s)
  2555. (setq s (replace-match "" t t s))))
  2556. (when org-export-remove-timestamps-from-toc
  2557. (while (string-match org-maybe-keyword-time-regexp s)
  2558. (setq s (replace-match "" t t s))))
  2559. (while (string-match org-bracket-link-regexp s)
  2560. (setq s (replace-match (match-string (if (match-end 3) 3 1) s)
  2561. t t s)))
  2562. (while (string-match "\\[\\([0-9]\\|fn:[^]]*\\)\\]" s)
  2563. (setq s (replace-match "" t t s)))
  2564. s)
  2565. (defun org-get-text-property-any (pos prop &optional object)
  2566. (or (get-text-property pos prop object)
  2567. (and (setq pos (next-single-property-change pos prop object))
  2568. (get-text-property pos prop object))))
  2569. (defun org-export-get-coderef-format (path desc)
  2570. (save-match-data
  2571. (if (and desc (string-match
  2572. (regexp-quote (concat "(" path ")"))
  2573. desc))
  2574. (replace-match "%s" t t desc)
  2575. (or desc "%s"))))
  2576. (defun org-export-push-to-kill-ring (format)
  2577. "Push buffer content to kill ring.
  2578. The depends on the variable `org-export-copy-to-kill'."
  2579. (when org-export-copy-to-kill-ring
  2580. (org-kill-new (buffer-string))
  2581. (when (fboundp 'x-set-selection)
  2582. (ignore-errors (x-set-selection 'PRIMARY (buffer-string)))
  2583. (ignore-errors (x-set-selection 'CLIPBOARD (buffer-string))))
  2584. (message "%s export done, pushed to kill ring and clipboard" format)))
  2585. (provide 'org-exp)
  2586. ;; arch-tag: 65985fe9-095c-49c7-a7b6-cb4ee15c0a95
  2587. ;;; org-exp.el ends here