org-exp.el 107 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916
  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&#x015b;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. (:latex-minted nil org-export-latex-minted)
  514. (:skip-before-1st-heading "skip" org-export-skip-text-before-1st-heading)
  515. (:fixed-width ":" org-export-with-fixed-width)
  516. (:timestamps "<" org-export-with-timestamps)
  517. (:author-info "author" org-export-author-info)
  518. (:email-info "email" org-export-email-info)
  519. (:creator-info "creator" org-export-creator-info)
  520. (:time-stamp-file "timestamp" org-export-time-stamp-file)
  521. (:tables "|" org-export-with-tables)
  522. (:table-auto-headline nil org-export-highlight-first-table-line)
  523. (:style-include-default nil org-export-html-style-include-default)
  524. (:style-include-scripts nil org-export-html-style-include-scripts)
  525. (:style nil org-export-html-style)
  526. (:style-extra nil org-export-html-style-extra)
  527. (:agenda-style nil org-agenda-export-html-style)
  528. (:convert-org-links nil org-export-html-link-org-files-as-html)
  529. (:inline-images nil org-export-html-inline-images)
  530. (:html-extension nil org-export-html-extension)
  531. (:xml-declaration nil org-export-html-xml-declaration)
  532. (:html-table-tag nil org-export-html-table-tag)
  533. (:expand-quoted-html "@" org-export-html-expand)
  534. (:timestamp nil org-export-html-with-timestamp)
  535. (:publishing-directory nil org-export-publishing-directory)
  536. (:preamble nil org-export-html-preamble)
  537. (:postamble nil org-export-html-postamble)
  538. (:auto-preamble nil org-export-html-auto-preamble)
  539. (:auto-postamble nil org-export-html-auto-postamble)
  540. (:author nil user-full-name)
  541. (:email nil user-mail-address)
  542. (:select-tags nil org-export-select-tags)
  543. (:exclude-tags nil org-export-exclude-tags)
  544. (:latex-image-options nil org-export-latex-image-default-option))
  545. "List of properties that represent export/publishing variables.
  546. Each element is a list of 3 items:
  547. 1. The property that is used internally, and also for org-publish-project-alist
  548. 2. The string that can be used in the OPTION lines to set this option,
  549. or nil if this option cannot be changed in this way
  550. 3. The customization variable that sets the default for this option."
  551. )
  552. (defun org-default-export-plist ()
  553. "Return the property list with default settings for the export variables."
  554. (let* ((infile (org-infile-export-plist))
  555. (letbind (plist-get infile :let-bind))
  556. (l org-export-plist-vars) rtn e s v)
  557. (while (setq e (pop l))
  558. (setq s (nth 2 e)
  559. v (cond
  560. ((assq s letbind) (nth 1 (assq s letbind)))
  561. ((boundp s) (symbol-value s))
  562. (t nil))
  563. rtn (cons (car e) (cons v rtn))))
  564. rtn))
  565. (defvar org-export-inbuffer-options-extra nil
  566. "List of additional in-buffer options that should be detected.
  567. Just before export, the buffer is scanned for options like #+TITLE, #+EMAIL,
  568. etc. Extensions can add to this list to get their options detected, and they
  569. can then add a function to `org-export-options-filters' to process these
  570. options.
  571. Each element in this list must be a list, with the in-buffer keyword as car,
  572. and a property (a symbol) as the next element. All occurrences of the
  573. keyword will be found, the values concatenated with a space character
  574. in between, and the result stored in the export options property list.")
  575. (defvar org-export-options-filters nil
  576. "Functions to be called to finalize the export/publishing options.
  577. All these options are stored in a property list, and each of the functions
  578. in this hook gets a chance to modify this property list. Each function
  579. must accept the property list as an argument, and must return the (possibly
  580. modified) list.")
  581. ;; FIXME: should we fold case here?
  582. (defun org-infile-export-plist ()
  583. "Return the property list with file-local settings for export."
  584. (save-excursion
  585. (save-restriction
  586. (widen)
  587. (goto-char (point-min))
  588. (let ((re (org-make-options-regexp
  589. (append
  590. '("TITLE" "AUTHOR" "DATE" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"
  591. "MATHJAX"
  592. "LINK_UP" "LINK_HOME" "SETUPFILE" "STYLE"
  593. "LATEX_HEADER" "LATEX_CLASS"
  594. "EXPORT_SELECT_TAGS" "EXPORT_EXCLUDE_TAGS"
  595. "KEYWORDS" "DESCRIPTION" "MACRO" "BIND" "XSLT")
  596. (mapcar 'car org-export-inbuffer-options-extra))))
  597. (case-fold-search t)
  598. p key val text options mathjax a pr style
  599. latex-header latex-class macros letbind
  600. ext-setup-or-nil setup-contents (start 0))
  601. (while (or (and ext-setup-or-nil
  602. (string-match re ext-setup-or-nil start)
  603. (setq start (match-end 0)))
  604. (and (setq ext-setup-or-nil nil start 0)
  605. (re-search-forward re nil t)))
  606. (setq key (upcase (org-match-string-no-properties 1 ext-setup-or-nil))
  607. val (org-match-string-no-properties 2 ext-setup-or-nil))
  608. (cond
  609. ((setq a (assoc key org-export-inbuffer-options-extra))
  610. (setq pr (nth 1 a))
  611. (setq p (plist-put p pr (concat (plist-get p pr) " " val))))
  612. ((string-equal key "TITLE") (setq p (plist-put p :title val)))
  613. ((string-equal key "AUTHOR")(setq p (plist-put p :author val)))
  614. ((string-equal key "EMAIL") (setq p (plist-put p :email val)))
  615. ((string-equal key "DATE") (setq p (plist-put p :date val)))
  616. ((string-equal key "KEYWORDS") (setq p (plist-put p :keywords val)))
  617. ((string-equal key "DESCRIPTION")
  618. (setq p (plist-put p :description val)))
  619. ((string-equal key "LANGUAGE") (setq p (plist-put p :language val)))
  620. ((string-equal key "STYLE")
  621. (setq style (concat style "\n" val)))
  622. ((string-equal key "LATEX_HEADER")
  623. (setq latex-header (concat latex-header "\n" val)))
  624. ((string-equal key "LATEX_CLASS")
  625. (setq latex-class val))
  626. ((string-equal key "TEXT")
  627. (setq text (if text (concat text "\n" val) val)))
  628. ((string-equal key "OPTIONS")
  629. (setq options (concat val " " options)))
  630. ((string-equal key "MATHJAX")
  631. (setq mathjax (concat val " " mathjax)))
  632. ((string-equal key "BIND")
  633. (push (read (concat "(" val ")")) letbind))
  634. ((string-equal key "XSLT")
  635. (setq p (plist-put p :xslt val)))
  636. ((string-equal key "LINK_UP")
  637. (setq p (plist-put p :link-up val)))
  638. ((string-equal key "LINK_HOME")
  639. (setq p (plist-put p :link-home val)))
  640. ((string-equal key "EXPORT_SELECT_TAGS")
  641. (setq p (plist-put p :select-tags (org-split-string val))))
  642. ((string-equal key "EXPORT_EXCLUDE_TAGS")
  643. (setq p (plist-put p :exclude-tags (org-split-string val))))
  644. ((string-equal key "MACRO")
  645. (push val macros))
  646. ((equal key "SETUPFILE")
  647. (setq setup-contents (org-file-contents
  648. (expand-file-name
  649. (org-remove-double-quotes
  650. (org-trim val)))
  651. 'noerror))
  652. (if (not ext-setup-or-nil)
  653. (setq ext-setup-or-nil setup-contents start 0)
  654. (setq ext-setup-or-nil
  655. (concat (substring ext-setup-or-nil 0 start)
  656. "\n" setup-contents "\n"
  657. (substring ext-setup-or-nil start)))))))
  658. (setq p (plist-put p :text text))
  659. (when (and letbind (org-export-confirm-letbind))
  660. (setq p (plist-put p :let-bind letbind)))
  661. (when style (setq p (plist-put p :style-extra style)))
  662. (when latex-header
  663. (setq p (plist-put p :latex-header-extra (substring latex-header 1))))
  664. (when latex-class
  665. (setq p (plist-put p :latex-class latex-class)))
  666. (when options
  667. (setq p (org-export-add-options-to-plist p options)))
  668. (when mathjax
  669. (setq p (plist-put p :mathjax mathjax)))
  670. ;; Add macro definitions
  671. (setq p (plist-put p :macro-date "(eval (format-time-string \"$1\"))"))
  672. (setq p (plist-put p :macro-time "(eval (format-time-string \"$1\"))"))
  673. (setq p (plist-put p :macro-property "(eval (org-entry-get nil \"$1\" 'selective))"))
  674. (setq p (plist-put
  675. p :macro-modification-time
  676. (and (buffer-file-name)
  677. (file-exists-p (buffer-file-name))
  678. (concat
  679. "(eval (format-time-string \"$1\" '"
  680. (prin1-to-string (nth 5 (file-attributes
  681. (buffer-file-name))))
  682. "))"))))
  683. (setq p (plist-put p :macro-input-file (and (buffer-file-name)
  684. (file-name-nondirectory
  685. (buffer-file-name)))))
  686. (while (setq val (pop macros))
  687. (when (string-match "^\\([-a-zA-Z0-9_]+\\)[ \t]+\\(.*?[ \t]*$\\)" val)
  688. (setq p (plist-put
  689. p (intern
  690. (concat ":macro-" (downcase (match-string 1 val))))
  691. (org-export-interpolate-newlines (match-string 2 val))))))
  692. p))))
  693. (defun org-export-interpolate-newlines (s)
  694. (while (string-match "\\\\n" s)
  695. (setq s (replace-match "\n" t t s)))
  696. s)
  697. (defvar org-export-allow-BIND-local nil)
  698. (defun org-export-confirm-letbind ()
  699. "Can we use #+BIND values during export?
  700. By default this will ask fro confirmation by the user, to divert possible
  701. security risks."
  702. (cond
  703. ((not org-export-allow-BIND) nil)
  704. ((eq org-export-allow-BIND t) t)
  705. ((local-variable-p 'org-export-allow-BIND-local (current-buffer))
  706. org-export-allow-BIND-local)
  707. (t (org-set-local 'org-export-allow-BIND-local
  708. (yes-or-no-p "Allow BIND values in this buffer? ")))))
  709. (defun org-install-letbind ()
  710. "Install the values from #+BIND lines as local variables."
  711. (let ((letbind (plist-get org-export-opt-plist :let-bind))
  712. pair)
  713. (while (setq pair (pop letbind))
  714. (org-set-local (car pair) (nth 1 pair)))))
  715. (defun org-export-add-options-to-plist (p options)
  716. "Parse an OPTIONS line and set values in the property list P."
  717. (let (o)
  718. (when options
  719. (let ((op org-export-plist-vars))
  720. (while (setq o (pop op))
  721. (if (and (nth 1 o)
  722. (string-match (concat (regexp-quote (nth 1 o))
  723. ":\\([^ \t\n\r;,.]*\\)")
  724. options))
  725. (setq p (plist-put p (car o)
  726. (car (read-from-string
  727. (match-string 1 options))))))))))
  728. p)
  729. (defun org-export-add-subtree-options (p pos)
  730. "Add options in subtree at position POS to property list P."
  731. (save-excursion
  732. (goto-char pos)
  733. (when (org-at-heading-p)
  734. (let (a)
  735. ;; This is actually read in `org-export-get-title-from-subtree'
  736. ;; (when (setq a (org-entry-get pos "EXPORT_TITLE"))
  737. ;; (setq p (plist-put p :title a)))
  738. (when (setq a (org-entry-get pos "EXPORT_TEXT"))
  739. (setq p (plist-put p :text a)))
  740. (when (setq a (org-entry-get pos "EXPORT_AUTHOR"))
  741. (setq p (plist-put p :author a)))
  742. (when (setq a (org-entry-get pos "EXPORT_DATE"))
  743. (setq p (plist-put p :date a)))
  744. (when (setq a (org-entry-get pos "EXPORT_OPTIONS"))
  745. (setq p (org-export-add-options-to-plist p a)))))
  746. p))
  747. (defun org-export-directory (type plist)
  748. (let* ((val (plist-get plist :publishing-directory))
  749. (dir (if (listp val)
  750. (or (cdr (assoc type val)) ".")
  751. val)))
  752. dir))
  753. (defun org-export-process-option-filters (plist)
  754. (let ((functions org-export-options-filters) f)
  755. (while (setq f (pop functions))
  756. (setq plist (funcall f plist))))
  757. plist)
  758. ;;;###autoload
  759. (defun org-export (&optional arg)
  760. "Export dispatcher for Org-mode.
  761. When `org-export-run-in-background' is non-nil, try to run the command
  762. in the background. This will be done only for commands that write
  763. to a file. For details see the docstring of `org-export-run-in-background'.
  764. The prefix argument ARG will be passed to the exporter. However, if
  765. ARG is a double universal prefix \\[universal-argument] \\[universal-argument], \
  766. that means to inverse the
  767. value of `org-export-run-in-background'."
  768. (interactive "P")
  769. (let* ((bg (org-xor (equal arg '(16)) org-export-run-in-background))
  770. subtree-p
  771. (help "[t] insert the export option template
  772. \[v] limit export to visible part of outline tree
  773. \[1] only export the current subtree
  774. \[SPC] publish enclosing subtree (with LaTeX_CLASS or EXPORT_FILE_NAME prop)
  775. \[a/n/u] export as ASCII/Latin-1/UTF-8 [A/N/U] to temporary buffer
  776. \[h] export as HTML [H] to temporary buffer [R] export region
  777. \[b] export as HTML and open in browser
  778. \[l] export as LaTeX [L] to temporary buffer
  779. \[p] export as LaTeX and process to PDF [d] ... and open PDF file
  780. \[D] export as DocBook [V] export as DocBook, process to PDF, and open
  781. \[j] export as TaskJuggler [J] ... and open
  782. \[m] export as Freemind mind map
  783. \[x] export as XOXO
  784. \[g] export using Wes Hardaker's generic exporter
  785. \[i] export current file as iCalendar file
  786. \[I] export all agenda files as iCalendar files [c] ...as one combined file
  787. \[F] publish current file [P] publish current project
  788. \[X] publish a project... [E] publish every projects")
  789. (cmds
  790. '((?t org-insert-export-options-template nil)
  791. (?v org-export-visible nil)
  792. (?a org-export-as-ascii t)
  793. (?A org-export-as-ascii-to-buffer t)
  794. (?n org-export-as-latin1 t)
  795. (?N org-export-as-latin1-to-buffer t)
  796. (?u org-export-as-utf8 t)
  797. (?U org-export-as-utf8-to-buffer t)
  798. (?h org-export-as-html t)
  799. (?b org-export-as-html-and-open t)
  800. (?H org-export-as-html-to-buffer nil)
  801. (?R org-export-region-as-html nil)
  802. (?x org-export-as-xoxo t)
  803. (?g org-export-generic t)
  804. (?D org-export-as-docbook t)
  805. (?V org-export-as-docbook-pdf-and-open t)
  806. (?j org-export-as-taskjuggler t)
  807. (?J org-export-as-taskjuggler-and-open t)
  808. (?m org-export-as-freemind t)
  809. (?l org-export-as-latex t)
  810. (?p org-export-as-pdf t)
  811. (?d org-export-as-pdf-and-open t)
  812. (?L org-export-as-latex-to-buffer nil)
  813. (?i org-export-icalendar-this-file t)
  814. (?I org-export-icalendar-all-agenda-files t)
  815. (?c org-export-icalendar-combine-agenda-files t)
  816. (?F org-publish-current-file t)
  817. (?P org-publish-current-project t)
  818. (?X org-publish t)
  819. (?E org-publish-all t)))
  820. r1 r2 ass
  821. (cpos (point)) (cbuf (current-buffer)) bpos)
  822. (save-excursion
  823. (save-window-excursion
  824. (delete-other-windows)
  825. (with-output-to-temp-buffer "*Org Export/Publishing Help*"
  826. (princ help))
  827. (org-fit-window-to-buffer (get-buffer-window
  828. "*Org Export/Publishing Help*"))
  829. (message "Select command: ")
  830. (setq r1 (read-char-exclusive))
  831. (when (eq r1 ?1)
  832. (setq subtree-p t)
  833. (message "Select command (for subtree): ")
  834. (setq r1 (read-char-exclusive)))
  835. (when (eq r1 ?\ )
  836. (let ((case-fold-search t))
  837. (if (re-search-backward
  838. "^[ \t]+\\(:latex_class:\\|:export_title:\\)[ \t]+\\S-"
  839. nil t)
  840. (progn
  841. (org-back-to-heading t)
  842. (setq subtree-p t)
  843. (setq bpos (point))
  844. (message "Select command (for subtree): ")
  845. (setq r1 (read-char-exclusive)))
  846. (error "No enclosing node with LaTeX_CLASS or EXPORT_FILE_NAME")
  847. )))))
  848. (and bpos (goto-char bpos))
  849. (setq r2 (if (< r1 27) (+ r1 96) r1))
  850. (unless (setq ass (assq r2 cmds))
  851. (error "No command associated with key %c" r1))
  852. (if (and bg (nth 2 ass)
  853. (not (buffer-base-buffer))
  854. (not (org-region-active-p)))
  855. ;; execute in background
  856. (let ((p (start-process
  857. (concat "Exporting " (file-name-nondirectory (buffer-file-name)))
  858. "*Org Processes*"
  859. (expand-file-name invocation-name invocation-directory)
  860. "-batch"
  861. "-l" user-init-file
  862. "--eval" "(require 'org-exp)"
  863. "--eval" "(setq org-wait .2)"
  864. (buffer-file-name)
  865. "-f" (symbol-name (nth 1 ass)))))
  866. (set-process-sentinel p 'org-export-process-sentinel)
  867. (message "Background process \"%s\": started" p))
  868. ;; background processing not requested, or not possible
  869. (if subtree-p (progn (outline-mark-subtree) (activate-mark)))
  870. (call-interactively (nth 1 ass))
  871. (when (and bpos (get-buffer-window cbuf))
  872. (let ((cw (selected-window)))
  873. (select-window (get-buffer-window cbuf))
  874. (goto-char cpos)
  875. (deactivate-mark)
  876. (select-window cw))))))
  877. (defun org-export-process-sentinel (process status)
  878. (if (string-match "\n+\\'" status)
  879. (setq status (substring status 0 -1)))
  880. (message "Background process \"%s\": %s" process status))
  881. ;;; General functions for all backends
  882. (defvar org-export-target-aliases nil
  883. "Alist of targets with invisible aliases.")
  884. (defvar org-export-preferred-target-alist nil
  885. "Alist of section id's with preferred aliases.")
  886. (defvar org-export-id-target-alist nil
  887. "Alist of section id's with preferred aliases.")
  888. (defvar org-export-code-refs nil
  889. "Alist of code references and line numbers.")
  890. (defun org-export-preprocess-string (string &rest parameters)
  891. "Cleanup STRING so that that the true exported has a more consistent source.
  892. This function takes STRING, which should be a buffer-string of an org-file
  893. to export. It then creates a temporary buffer where it does its job.
  894. The result is then again returned as a string, and the exporter works
  895. on this string to produce the exported version."
  896. (interactive)
  897. (let* ((htmlp (plist-get parameters :for-html))
  898. (asciip (plist-get parameters :for-ascii))
  899. (latexp (plist-get parameters :for-LaTeX))
  900. (docbookp (plist-get parameters :for-docbook))
  901. (backend (cond (htmlp 'html)
  902. (latexp 'latex)
  903. (asciip 'ascii)
  904. (docbookp 'docbook)))
  905. (archived-trees (plist-get parameters :archived-trees))
  906. (inhibit-read-only t)
  907. (drawers org-drawers)
  908. (outline-regexp "\\*+ ")
  909. target-alist rtn)
  910. (setq org-export-target-aliases nil
  911. org-export-preferred-target-alist nil
  912. org-export-id-target-alist nil
  913. org-export-code-refs nil)
  914. (with-current-buffer (get-buffer-create " org-mode-tmp")
  915. (erase-buffer)
  916. (insert string)
  917. (setq case-fold-search t)
  918. (let ((inhibit-read-only t))
  919. (remove-text-properties (point-min) (point-max)
  920. '(read-only t)))
  921. ;; Remove license-to-kill stuff
  922. ;; The caller marks some stuff for killing, stuff that has been
  923. ;; used to create the page title, for example.
  924. (org-export-kill-licensed-text)
  925. (let ((org-inhibit-startup t)) (org-mode))
  926. (setq case-fold-search t)
  927. (org-install-letbind)
  928. ;; Call the hook
  929. (run-hooks 'org-export-preprocess-hook)
  930. ;; Process the macros
  931. (org-export-preprocess-apply-macros)
  932. (run-hooks 'org-export-preprocess-after-macros-hook)
  933. (untabify (point-min) (point-max))
  934. ;; Handle include files, and call a hook
  935. (org-export-handle-include-files-recurse)
  936. (run-hooks 'org-export-preprocess-after-include-files-hook)
  937. ;; Get rid of archived trees
  938. (org-export-remove-archived-trees archived-trees)
  939. ;; Remove comment environment and comment subtrees
  940. (org-export-remove-comment-blocks-and-subtrees)
  941. ;; Get rid of excluded trees, and call a hook
  942. (org-export-handle-export-tags (plist-get parameters :select-tags)
  943. (plist-get parameters :exclude-tags))
  944. (run-hooks 'org-export-preprocess-after-tree-selection-hook)
  945. ;; Mark end of lists
  946. (org-export-mark-list-ending backend)
  947. ;; Handle source code snippets
  948. (org-export-replace-src-segments-and-examples backend)
  949. ;; Protect short examples marked by a leading colon
  950. (org-export-protect-colon-examples)
  951. ;; Normalize footnotes
  952. (when (plist-get parameters :footnotes)
  953. (org-footnote-normalize nil t))
  954. ;; Find all headings and compute the targets for them
  955. (setq target-alist (org-export-define-heading-targets target-alist))
  956. (run-hooks 'org-export-preprocess-after-headline-targets-hook)
  957. ;; Find HTML special classes for headlines
  958. (org-export-remember-html-container-classes)
  959. ;; Get rid of drawers
  960. (org-export-remove-or-extract-drawers
  961. drawers (plist-get parameters :drawers) backend)
  962. ;; Get the correct stuff before the first headline
  963. (when (plist-get parameters :skip-before-1st-heading)
  964. (goto-char (point-min))
  965. (when (re-search-forward "^\\(#.*\n\\)?\\*+[ \t]" nil t)
  966. (delete-region (point-min) (match-beginning 0))
  967. (goto-char (point-min))
  968. (insert "\n")))
  969. (when (plist-get parameters :add-text)
  970. (goto-char (point-min))
  971. (insert (plist-get parameters :add-text) "\n"))
  972. ;; Remove todo-keywords before exporting, if the user has requested so
  973. (org-export-remove-headline-metadata parameters)
  974. ;; Find targets in comments and move them out of comments,
  975. ;; but mark them as targets that should be invisible
  976. (setq target-alist (org-export-handle-invisible-targets target-alist))
  977. ;; Select and protect backend specific stuff, throw away stuff
  978. ;; that is specific for other backends
  979. (run-hooks 'org-export-preprocess-before-selecting-backend-code-hook)
  980. (org-export-select-backend-specific-text backend)
  981. ;; Protect quoted subtrees
  982. (org-export-protect-quoted-subtrees)
  983. ;; Remove clock lines
  984. (org-export-remove-clock-lines)
  985. ;; Protect verbatim elements
  986. (org-export-protect-verbatim)
  987. ;; Blockquotes, verse, and center
  988. (org-export-mark-blockquote-verse-center)
  989. (run-hooks 'org-export-preprocess-after-blockquote-hook)
  990. ;; Remove timestamps, if the user has requested so
  991. (unless (plist-get parameters :timestamps)
  992. (org-export-remove-timestamps))
  993. ;; Attach captions to the correct object
  994. (setq target-alist (org-export-attach-captions-and-attributes
  995. backend target-alist))
  996. ;; Find matches for radio targets and turn them into internal links
  997. (org-export-mark-radio-links)
  998. (run-hooks 'org-export-preprocess-after-radio-targets-hook)
  999. ;; Find all links that contain a newline and put them into a single line
  1000. (org-export-concatenate-multiline-links)
  1001. ;; Normalize links: Convert angle and plain links into bracket links
  1002. ;; and expand link abbreviations
  1003. (run-hooks 'org-export-preprocess-before-normalizing-links-hook)
  1004. (org-export-normalize-links)
  1005. ;; Find all internal links. If they have a fuzzy match (i.e. not
  1006. ;; a *dedicated* target match, let the link point to the
  1007. ;; corresponding section.
  1008. (org-export-target-internal-links target-alist)
  1009. ;; Find multiline emphasis and put them into single line
  1010. (when (plist-get parameters :emph-multiline)
  1011. (org-export-concatenate-multiline-emphasis))
  1012. ;; Remove special table lines, and store alignment information
  1013. (org-store-forced-table-alignment)
  1014. (when org-export-table-remove-special-lines
  1015. (org-export-remove-special-table-lines))
  1016. ;; Another hook
  1017. (run-hooks 'org-export-preprocess-before-backend-specifics-hook)
  1018. ;; LaTeX-specific preprocessing
  1019. (when latexp
  1020. (require 'org-latex nil)
  1021. (org-export-latex-preprocess parameters))
  1022. ;; ASCII-specific preprocessing
  1023. (when asciip
  1024. (org-export-ascii-preprocess parameters))
  1025. ;; HTML-specific preprocessing
  1026. (when htmlp
  1027. (org-export-html-preprocess parameters))
  1028. ;; DocBook-specific preprocessing
  1029. (when docbookp
  1030. (require 'org-docbook nil)
  1031. (org-export-docbook-preprocess parameters))
  1032. ;; Remove or replace comments
  1033. (org-export-handle-comments (plist-get parameters :comments))
  1034. ;; Remove #+TBLFM and #+TBLNAME lines
  1035. (org-export-handle-table-metalines)
  1036. ;; Run the final hook
  1037. (run-hooks 'org-export-preprocess-final-hook)
  1038. (setq rtn (buffer-string)))
  1039. (kill-buffer " org-mode-tmp")
  1040. rtn))
  1041. (defun org-export-kill-licensed-text ()
  1042. "Remove all text that is marked with a :org-license-to-kill property."
  1043. (let (p)
  1044. (while (setq p (text-property-any (point-min) (point-max)
  1045. :org-license-to-kill t))
  1046. (delete-region
  1047. p (or (next-single-property-change p :org-license-to-kill)
  1048. (point-max))))))
  1049. (defvar org-export-define-heading-targets-headline-hook nil
  1050. "Hook that is run when a headline was matched during target search.
  1051. This is part of the preprocessing for export.")
  1052. (defun org-export-define-heading-targets (target-alist)
  1053. "Find all headings and define the targets for them.
  1054. The new targets are added to TARGET-ALIST, which is also returned.
  1055. Also find all ID and CUSTOM_ID properties and store them."
  1056. (goto-char (point-min))
  1057. (org-init-section-numbers)
  1058. (let ((re (concat "^" org-outline-regexp
  1059. "\\|"
  1060. "^[ \t]*:\\(ID\\|CUSTOM_ID\\):[ \t]*\\([^ \t\r\n]+\\)"))
  1061. level target last-section-target a id)
  1062. (while (re-search-forward re nil t)
  1063. (org-if-unprotected-at (match-beginning 0)
  1064. (if (match-end 2)
  1065. (progn
  1066. (setq id (org-match-string-no-properties 2))
  1067. (push (cons id target) target-alist)
  1068. (setq a (or (assoc last-section-target org-export-target-aliases)
  1069. (progn
  1070. (push (list last-section-target)
  1071. org-export-target-aliases)
  1072. (car org-export-target-aliases))))
  1073. (push (caar target-alist) (cdr a))
  1074. (when (equal (match-string 1) "CUSTOM_ID")
  1075. (if (not (assoc last-section-target
  1076. org-export-preferred-target-alist))
  1077. (push (cons last-section-target id)
  1078. org-export-preferred-target-alist)))
  1079. (when (equal (match-string 1) "ID")
  1080. (if (not (assoc last-section-target
  1081. org-export-id-target-alist))
  1082. (push (cons last-section-target (concat "ID-" id))
  1083. org-export-id-target-alist))))
  1084. (setq level (org-reduced-level
  1085. (save-excursion (goto-char (point-at-bol))
  1086. (org-outline-level))))
  1087. (setq target (org-solidify-link-text
  1088. (format "sec-%s" (replace-regexp-in-string
  1089. "\\." "_"
  1090. (org-section-number level)))))
  1091. (setq last-section-target target)
  1092. (push (cons target target) target-alist)
  1093. (add-text-properties
  1094. (point-at-bol) (point-at-eol)
  1095. (list 'target target))
  1096. (run-hooks 'org-export-define-heading-targets-headline-hook)))))
  1097. target-alist)
  1098. (defun org-export-handle-invisible-targets (target-alist)
  1099. "Find targets in comments and move them out of comments.
  1100. Mark them as invisible targets."
  1101. (let (target tmp a)
  1102. (goto-char (point-min))
  1103. (while (re-search-forward "^#.*?\\(<<<?\\([^>\r\n]+\\)>>>?\\).*" nil t)
  1104. ;; Check if the line before or after is a headline with a target
  1105. (if (setq target (or (get-text-property (point-at-bol 0) 'target)
  1106. (get-text-property (point-at-bol 2) 'target)))
  1107. (progn
  1108. ;; use the existing target in a neighboring line
  1109. (setq tmp (match-string 2))
  1110. (replace-match "")
  1111. (and (looking-at "\n") (delete-char 1))
  1112. (push (cons (setq tmp (org-solidify-link-text tmp)) target)
  1113. target-alist)
  1114. (setq a (or (assoc target org-export-target-aliases)
  1115. (progn
  1116. (push (list target) org-export-target-aliases)
  1117. (car org-export-target-aliases))))
  1118. (push tmp (cdr a)))
  1119. ;; Make an invisible target
  1120. (replace-match "\\1(INVISIBLE)"))))
  1121. target-alist)
  1122. (defun org-export-target-internal-links (target-alist)
  1123. "Find all internal links and assign targets to them.
  1124. If a link has a fuzzy match (i.e. not a *dedicated* target match),
  1125. let the link point to the corresponding section.
  1126. This function also handles the id links, if they have a match in
  1127. the current file."
  1128. (goto-char (point-min))
  1129. (while (re-search-forward org-bracket-link-regexp nil t)
  1130. (org-if-unprotected-at (1+ (match-beginning 0))
  1131. (let* ((md (match-data))
  1132. (desc (match-end 2))
  1133. (link (org-link-unescape (match-string 1)))
  1134. (slink (org-solidify-link-text link))
  1135. found props pos cref
  1136. (target
  1137. (cond
  1138. ((= (string-to-char link) ?#)
  1139. ;; user wants exactly this link
  1140. link)
  1141. ((cdr (assoc slink target-alist))
  1142. (or (cdr (assoc (assoc slink target-alist)
  1143. org-export-preferred-target-alist))
  1144. (cdr (assoc slink target-alist))))
  1145. ((and (string-match "^id:" link)
  1146. (cdr (assoc (substring link 3) target-alist))))
  1147. ((string-match "^(\\(.*\\))$" link)
  1148. (setq cref (match-string 1 link))
  1149. (concat "coderef:" cref))
  1150. ((string-match org-link-types-re link) nil)
  1151. ((or (file-name-absolute-p link)
  1152. (string-match "^\\." link))
  1153. nil)
  1154. (t
  1155. (let ((org-link-search-inhibit-query t))
  1156. (save-excursion
  1157. (setq found (condition-case nil (org-link-search link)
  1158. (error nil)))
  1159. (when (and found
  1160. (or (org-on-heading-p)
  1161. (not (eq found 'dedicated))))
  1162. (or (get-text-property (point) 'target)
  1163. (get-text-property
  1164. (max (point-min)
  1165. (1- (or (previous-single-property-change
  1166. (point) 'target) 0)))
  1167. 'target)))))))))
  1168. (when target
  1169. (set-match-data md)
  1170. (goto-char (match-beginning 1))
  1171. (setq props (text-properties-at (point)))
  1172. (delete-region (match-beginning 1) (match-end 1))
  1173. (setq pos (point))
  1174. (insert target)
  1175. (unless desc (insert "][" link))
  1176. (add-text-properties pos (point) props))))))
  1177. (defun org-export-remember-html-container-classes ()
  1178. "Store the HTML_CONTAINER_CLASS properties in a text property."
  1179. (goto-char (point-min))
  1180. (let (class)
  1181. (while (re-search-forward
  1182. "^[ \t]*:HTML_CONTAINER_CLASS:[ \t]+\\(.+\\)$" nil t)
  1183. (setq class (match-string 1))
  1184. (save-excursion
  1185. (org-back-to-heading t)
  1186. (put-text-property (point-at-bol) (point-at-eol) 'html-container-class class)))))
  1187. (defvar org-export-format-drawer-function nil
  1188. "Function to be called to format the contents of a drawer.
  1189. The function must accept three parameters:
  1190. NAME the drawer name, like \"PROPERTIES\"
  1191. CONTENT the content of the drawer.
  1192. BACKEND one of the symbols html, docbook, latex, ascii, xoxo
  1193. The function should return the text to be inserted into the buffer.
  1194. If this is nil, `org-export-format-drawer' is used as a default.")
  1195. (defun org-export-remove-or-extract-drawers (all-drawers exp-drawers backend)
  1196. "Remove drawers, or extract and format the content.
  1197. ALL-DRAWERS is a list of all drawer names valid in the current buffer.
  1198. EXP-DRAWERS can be t to keep all drawer contents, or a list of drawers
  1199. whose content to keep. Any drawers that are in ALL-DRAWERS but not in
  1200. EXP-DRAWERS will be removed.
  1201. BACKEND is the current export backend."
  1202. (goto-char (point-min))
  1203. (let ((re (concat "^[ \t]*:\\("
  1204. (mapconcat 'identity all-drawers "\\|")
  1205. "\\):[ \t]*$"))
  1206. name beg beg-content eol content)
  1207. (while (re-search-forward re nil t)
  1208. (org-if-unprotected
  1209. (setq name (match-string 1))
  1210. (setq beg (match-beginning 0)
  1211. beg-content (1+ (point-at-eol))
  1212. eol (point-at-eol))
  1213. (if (not (and (re-search-forward
  1214. "^\\([ \t]*:END:[ \t]*\n?\\)\\|^\\*+[ \t]" nil t)
  1215. (match-end 1)))
  1216. (goto-char eol)
  1217. (goto-char (match-beginning 0))
  1218. (and (looking-at ".*\n?") (replace-match ""))
  1219. (setq content (buffer-substring beg-content (point)))
  1220. (delete-region beg (point))
  1221. (when (or (eq exp-drawers t)
  1222. (member name exp-drawers))
  1223. (setq content (funcall (or org-export-format-drawer-function
  1224. 'org-export-format-drawer)
  1225. name content backend))
  1226. (insert content)))))))
  1227. (defun org-export-format-drawer (name content backend)
  1228. "Format the content of a drawer as a colon example."
  1229. (if (string-match "[ \t]+\\'" content)
  1230. (setq content (substring content (match-beginning 0))))
  1231. (while (string-match "\\`[ \t]*\n" content)
  1232. (setq content (substring content (match-end 0))))
  1233. (setq content (org-remove-indentation content))
  1234. (setq content (concat ": " (mapconcat 'identity
  1235. (org-split-string content "\n")
  1236. "\n: ")
  1237. "\n"))
  1238. (setq content (concat " : " (upcase name) "\n" content))
  1239. (org-add-props content nil 'org-protected t))
  1240. (defun org-export-handle-export-tags (select-tags exclude-tags)
  1241. "Modify the buffer, honoring SELECT-TAGS and EXCLUDE-TAGS.
  1242. Both arguments are lists of tags.
  1243. If any of SELECT-TAGS is found, all trees not marked by a SELECT-TAG
  1244. will be removed.
  1245. After that, all subtrees that are marked by EXCLUDE-TAGS will be
  1246. removed as well."
  1247. (remove-text-properties (point-min) (point-max) '(:org-delete t))
  1248. (let* ((re-sel (concat ":\\(" (mapconcat 'regexp-quote
  1249. select-tags "\\|")
  1250. "\\):"))
  1251. (re-excl (concat ":\\(" (mapconcat 'regexp-quote
  1252. exclude-tags "\\|")
  1253. "\\):"))
  1254. beg end cont)
  1255. (goto-char (point-min))
  1256. (when (and select-tags
  1257. (re-search-forward
  1258. (concat "^\\*+[ \t].*" re-sel "[^ \t\n]*[ \t]*$") nil t))
  1259. ;; At least one tree is marked for export, this means
  1260. ;; all the unmarked stuff needs to go.
  1261. ;; Dig out the trees that should be exported
  1262. (goto-char (point-min))
  1263. (outline-next-heading)
  1264. (setq beg (point))
  1265. (put-text-property beg (point-max) :org-delete t)
  1266. (while (re-search-forward re-sel nil t)
  1267. (when (org-on-heading-p)
  1268. (org-back-to-heading)
  1269. (remove-text-properties
  1270. (max (1- (point)) (point-min))
  1271. (setq cont (save-excursion (org-end-of-subtree t t)))
  1272. '(:org-delete t))
  1273. (while (and (org-up-heading-safe)
  1274. (get-text-property (point) :org-delete))
  1275. (remove-text-properties (max (1- (point)) (point-min))
  1276. (point-at-eol) '(:org-delete t)))
  1277. (goto-char cont))))
  1278. ;; Remove the trees explicitly marked for noexport
  1279. (when exclude-tags
  1280. (goto-char (point-min))
  1281. (while (re-search-forward re-excl nil t)
  1282. (when (org-at-heading-p)
  1283. (org-back-to-heading t)
  1284. (setq beg (point))
  1285. (org-end-of-subtree t t)
  1286. (delete-region beg (point))
  1287. (when (featurep 'org-inlinetask)
  1288. (org-inlinetask-remove-END-maybe)))))
  1289. ;; Remove everything that is now still marked for deletion
  1290. (goto-char (point-min))
  1291. (while (setq beg (text-property-any (point-min) (point-max) :org-delete t))
  1292. (setq end (or (next-single-property-change beg :org-delete)
  1293. (point-max)))
  1294. (delete-region beg end))))
  1295. (defun org-export-remove-archived-trees (export-archived-trees)
  1296. "Remove archived trees.
  1297. When EXPORT-ARCHIVED-TREES is `headline;, only the headline will be exported.
  1298. When it is t, the entire archived tree will be exported.
  1299. When it is nil the entire tree including the headline will be removed
  1300. from the buffer."
  1301. (let ((re-archive (concat ":" org-archive-tag ":"))
  1302. a b)
  1303. (when (not (eq export-archived-trees t))
  1304. (goto-char (point-min))
  1305. (while (re-search-forward re-archive nil t)
  1306. (if (not (org-on-heading-p t))
  1307. (org-end-of-subtree t)
  1308. (beginning-of-line 1)
  1309. (setq a (if export-archived-trees
  1310. (1+ (point-at-eol)) (point))
  1311. b (org-end-of-subtree t))
  1312. (if (> b a) (delete-region a b)))))))
  1313. (defun org-export-remove-headline-metadata (opts)
  1314. "Remove meta data from the headline, according to user options."
  1315. (let ((re org-complex-heading-regexp)
  1316. (todo (plist-get opts :todo-keywords))
  1317. (tags (plist-get opts :tags))
  1318. (pri (plist-get opts :priority))
  1319. (elts '(1 2 3 4 5))
  1320. rpl)
  1321. (setq elts (delq nil (list 1 (if todo 2) (if pri 3) 4 (if tags 5))))
  1322. (when (or (not todo) (not tags) (not pri))
  1323. (goto-char (point-min))
  1324. (while (re-search-forward re nil t)
  1325. (org-if-unprotected
  1326. (setq rpl (mapconcat (lambda (i) (if (match-end i) (match-string i) ""))
  1327. elts " "))
  1328. (replace-match rpl t t))))))
  1329. (defun org-export-remove-timestamps ()
  1330. "Remove timestamps and keywords for export."
  1331. (goto-char (point-min))
  1332. (while (re-search-forward org-maybe-keyword-time-regexp nil t)
  1333. (backward-char 1)
  1334. (org-if-unprotected
  1335. (unless (save-match-data (org-at-table-p))
  1336. (replace-match "")
  1337. (beginning-of-line 1)
  1338. (if (looking-at "[- \t]*\\(=>[- \t0-9:]*\\)?[ \t]*\n")
  1339. (replace-match ""))))))
  1340. (defun org-export-remove-clock-lines ()
  1341. "Remove clock lines for export."
  1342. (goto-char (point-min))
  1343. (let ((re (concat "^[ \t]*" org-clock-string ".*\n?")))
  1344. (while (re-search-forward re nil t)
  1345. (org-if-unprotected
  1346. (replace-match "")))))
  1347. (defun org-export-protect-quoted-subtrees ()
  1348. "Mark quoted subtrees with the protection property."
  1349. (let ((re-quote (concat "^\\*+[ \t]+" org-quote-string "\\>")))
  1350. (goto-char (point-min))
  1351. (while (re-search-forward re-quote nil t)
  1352. (goto-char (match-beginning 0))
  1353. (end-of-line 1)
  1354. (add-text-properties (point) (org-end-of-subtree t)
  1355. '(org-protected t)))))
  1356. (defun org-export-protect-verbatim ()
  1357. "Mark verbatim snippets with the protection property."
  1358. (goto-char (point-min))
  1359. (while (re-search-forward org-verbatim-re nil t)
  1360. (org-if-unprotected
  1361. (add-text-properties (match-beginning 4) (match-end 4)
  1362. '(org-protected t org-verbatim-emph t))
  1363. (goto-char (1+ (match-end 4))))))
  1364. (defun org-export-protect-colon-examples ()
  1365. "Protect lines starting with a colon."
  1366. (goto-char (point-min))
  1367. (let ((re "^[ \t]*:\\([ \t]\\|$\\)") beg)
  1368. (while (re-search-forward re nil t)
  1369. (beginning-of-line 1)
  1370. (setq beg (point))
  1371. (while (looking-at re)
  1372. (end-of-line 1)
  1373. (or (eobp) (forward-char 1)))
  1374. (add-text-properties beg (if (bolp) (1- (point)) (point))
  1375. '(org-protected t)))))
  1376. (defun org-export-select-backend-specific-text (backend)
  1377. (let ((formatters
  1378. '((docbook "DOCBOOK" "BEGIN_DOCBOOK" "END_DOCBOOK")
  1379. (html "HTML" "BEGIN_HTML" "END_HTML")
  1380. (beamer "BEAMER" "BEGIN_BEAMER" "END_BEAMER")
  1381. (ascii "ASCII" "BEGIN_ASCII" "END_ASCII")
  1382. (latex "LaTeX" "BEGIN_LaTeX" "END_LaTeX")))
  1383. (case-fold-search t)
  1384. fmt beg beg-content end end-content)
  1385. (while formatters
  1386. (setq fmt (pop formatters))
  1387. ;; Handle #+Backend: stuff
  1388. (goto-char (point-min))
  1389. (while (re-search-forward (concat "^\\([ \t]*\\)#\\+" (cadr fmt)
  1390. ":[ \t]*\\(.*\\)") nil t)
  1391. (if (not (eq (car fmt) backend))
  1392. (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
  1393. (replace-match "\\1\\2" t)
  1394. (add-text-properties
  1395. (point-at-bol) (min (1+ (point-at-eol)) (point-max))
  1396. '(org-protected t))))
  1397. ;; Delete #+attr_Backend: stuff of another backend. Those
  1398. ;; matching the current backend will be taken care of by
  1399. ;; `org-export-attach-captions-and-attributes'
  1400. (goto-char (point-min))
  1401. (while (re-search-forward (concat "^\\([ \t]*\\)#\\+attr_" (cadr fmt)
  1402. ":[ \t]*\\(.*\\)") nil t)
  1403. (when (not (eq (car fmt) backend))
  1404. (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
  1405. ;; Handle #+begin_Backend and #+end_Backend stuff
  1406. (goto-char (point-min))
  1407. (while (re-search-forward (concat "^[ \t]*#\\+" (caddr fmt) "\\>.*\n?")
  1408. nil t)
  1409. (setq beg (match-beginning 0) beg-content (match-end 0))
  1410. (when (re-search-forward (concat "^[ \t]*#\\+" (cadddr fmt) "\\>.*\n?")
  1411. nil t)
  1412. (setq end (match-end 0) end-content (match-beginning 0))
  1413. (if (eq (car fmt) backend)
  1414. ;; yes, keep this
  1415. (progn
  1416. (add-text-properties beg-content end-content '(org-protected t))
  1417. (delete-region (match-beginning 0) (match-end 0))
  1418. (save-excursion
  1419. (goto-char beg)
  1420. (delete-region (point) (1+ (point-at-eol)))))
  1421. ;; No, this is for a different backend, kill it
  1422. (delete-region beg end)))))))
  1423. (defun org-export-mark-blockquote-verse-center ()
  1424. "Mark block quote and verse environments with special cookies.
  1425. These special cookies will later be interpreted by the backend."
  1426. ;; Blockquotes
  1427. (let (type t1 ind beg end beg1 end1 content)
  1428. (goto-char (point-min))
  1429. (while (re-search-forward
  1430. "^\\([ \t]*\\)#\\+\\(begin_\\(\\(block\\)?quote\\|verse\\|center\\)\\>.*\\)"
  1431. nil t)
  1432. (setq ind (length (match-string 1))
  1433. type (downcase (match-string 3))
  1434. t1 (if (equal type "quote") "blockquote" type))
  1435. (setq beg (match-beginning 0)
  1436. beg1 (1+ (match-end 0)))
  1437. (when (re-search-forward (concat "^[ \t]*#\\+end_" type "\\>.*") nil t)
  1438. (setq end1 (1- (match-beginning 0))
  1439. end (+ (point-at-eol) (if (looking-at "\n$") 1 0)))
  1440. (setq content (org-remove-indentation (buffer-substring beg1 end1)))
  1441. (setq content (concat "ORG-" (upcase t1) "-START\n"
  1442. content "\n"
  1443. "ORG-" (upcase t1) "-END\n"))
  1444. (delete-region beg end)
  1445. (insert (org-add-props content nil 'original-indentation ind))))))
  1446. (defun org-export-mark-list-ending (backend)
  1447. "Mark list endings with special cookies.
  1448. These special cookies will later be interpreted by the backend.
  1449. `org-list-end-re' is replaced by a blank line in the process."
  1450. (let ((process-buffer
  1451. (lambda (end-list-marker)
  1452. (goto-char (point-min))
  1453. (while (org-search-forward-unenclosed org-item-beginning-re nil t)
  1454. (goto-char (org-list-bottom-point))
  1455. (when (and (not (eq org-list-ending-method 'indent))
  1456. (looking-at (org-list-end-re)))
  1457. (replace-match "\n"))
  1458. (insert end-list-marker)))))
  1459. ;; We need to divide backends into 3 categories.
  1460. (cond
  1461. ;; 1. Backends using `org-list-parse-list' do not need markers.
  1462. ((memq backend '(latex))
  1463. nil)
  1464. ;; 2. Line-processing backends need to be told where lists end.
  1465. ((memq backend '(html docbook))
  1466. (funcall process-buffer "ORG-LIST-END\n"))
  1467. ;; 3. Others backends do not need to know this: clean list enders.
  1468. (t
  1469. (funcall process-buffer "")))))
  1470. (defun org-export-attach-captions-and-attributes (backend target-alist)
  1471. "Move #+CAPTION, #+ATTR_BACKEND, and #+LABEL text into text properties.
  1472. If the next thing following is a table, add the text properties to the first
  1473. table line. If it is a link, add it to the line containing the link."
  1474. (goto-char (point-min))
  1475. (remove-text-properties (point-min) (point-max)
  1476. '(org-caption nil org-attributes nil))
  1477. (let ((case-fold-search t)
  1478. (re (concat "^[ \t]*#\\+caption:[ \t]+\\(.*\\)"
  1479. "\\|"
  1480. "^[ \t]*#\\+attr_" (symbol-name backend) ":[ \t]+\\(.*\\)"
  1481. "\\|"
  1482. "^[ \t]*#\\+label:[ \t]+\\(.*\\)"
  1483. "\\|"
  1484. "^[ \t]*\\(|[^-]\\)"
  1485. "\\|"
  1486. "^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
  1487. cap shortn attr label end)
  1488. (while (re-search-forward re nil t)
  1489. (cond
  1490. ((match-end 1)
  1491. (progn
  1492. (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))
  1493. (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap)
  1494. (setq shortn (match-string 1 cap)
  1495. cap (match-string 2 cap)))
  1496. (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
  1497. ((match-end 2)
  1498. (progn
  1499. (setq attr (concat attr (if attr " " "") (org-trim (match-string 2))))
  1500. (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
  1501. ((match-end 3)
  1502. (progn
  1503. (setq label (org-trim (match-string 3)))
  1504. (delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
  1505. (t
  1506. (setq end (if (match-end 4)
  1507. (let ((ee (org-table-end)))
  1508. (prog1 (1- (marker-position ee)) (move-marker ee nil)))
  1509. (point-at-eol)))
  1510. (add-text-properties (point-at-bol) end
  1511. (list 'org-caption cap
  1512. 'org-caption-shortn shortn
  1513. 'org-attributes attr
  1514. 'org-label label))
  1515. (if label (push (cons label label) target-alist))
  1516. (goto-char end)
  1517. (setq cap nil attr nil label nil)))))
  1518. target-alist)
  1519. (defun org-export-remove-comment-blocks-and-subtrees ()
  1520. "Remove the comment environment, and also commented subtrees."
  1521. (let ((re-commented (concat "^\\*+[ \t]+" org-comment-string "\\>"))
  1522. case-fold-search)
  1523. ;; Remove comment environment
  1524. (goto-char (point-min))
  1525. (setq case-fold-search t)
  1526. (while (re-search-forward
  1527. "^#\\+begin_comment[ \t]*\n[^\000]*?^#\\+end_comment\\>.*" nil t)
  1528. (replace-match "" t t))
  1529. ;; Remove subtrees that are commented
  1530. (goto-char (point-min))
  1531. (setq case-fold-search nil)
  1532. (while (re-search-forward re-commented nil t)
  1533. (goto-char (match-beginning 0))
  1534. (delete-region (point) (org-end-of-subtree t)))))
  1535. (defun org-export-handle-comments (commentsp)
  1536. "Remove comments, or convert to backend-specific format.
  1537. COMMENTSP can be a format string for publishing comments.
  1538. When it is nil, all comments will be removed."
  1539. (let ((re "^\\(#\\|[ \t]*#\\+ \\)\\(.*\n?\\)")
  1540. pos)
  1541. (goto-char (point-min))
  1542. (while (or (looking-at re)
  1543. (re-search-forward re nil t))
  1544. (setq pos (match-beginning 0))
  1545. (if (get-text-property pos 'org-protected)
  1546. (goto-char (1+ pos))
  1547. (if (and commentsp
  1548. (not (equal (char-before (match-end 1)) ?+)))
  1549. (progn (add-text-properties
  1550. (match-beginning 0) (match-end 0) '(org-protected t))
  1551. (replace-match (format commentsp (match-string 2)) t t))
  1552. (goto-char (1+ pos))
  1553. (replace-match "")
  1554. (goto-char (max (point-min) (1- pos))))))))
  1555. (defun org-export-handle-table-metalines ()
  1556. "Remove table specific metalines #+TBLNAME: and #+TBLFM:."
  1557. (let ((re "^[ \t]*#\\+TBL\\(NAME\\|FM\\):\\(.*\n?\\)")
  1558. pos)
  1559. (goto-char (point-min))
  1560. (while (or (looking-at re)
  1561. (re-search-forward re nil t))
  1562. (setq pos (match-beginning 0))
  1563. (if (get-text-property (match-beginning 1) 'org-protected)
  1564. (goto-char (1+ pos))
  1565. (goto-char (1+ pos))
  1566. (replace-match "")
  1567. (goto-char (max (point-min) (1- pos)))))))
  1568. (defun org-export-mark-radio-links ()
  1569. "Find all matches for radio targets and turn them into internal links."
  1570. (let ((re-radio (and org-target-link-regexp
  1571. (concat "\\([^<]\\)\\(" org-target-link-regexp "\\)"))))
  1572. (goto-char (point-min))
  1573. (when re-radio
  1574. (while (re-search-forward re-radio nil t)
  1575. (unless
  1576. (save-match-data
  1577. (or (org-in-regexp org-bracket-link-regexp)
  1578. (org-in-regexp org-plain-link-re)
  1579. (org-in-regexp "<<[^<>]+>>")))
  1580. (org-if-unprotected
  1581. (replace-match "\\1[[\\2]]")))))))
  1582. (defun org-store-forced-table-alignment ()
  1583. "Find table lines which force alignment, store the results in properties."
  1584. (let (line cnt aligns)
  1585. (goto-char (point-min))
  1586. (while (re-search-forward "|[ \t]*<[lrc][0-9]*>[ \t]*|" nil t)
  1587. ;; OK, this looks like a table line with an alignment cookie
  1588. (org-if-unprotected
  1589. (setq line (buffer-substring (point-at-bol) (point-at-eol)))
  1590. (when (and (org-at-table-p)
  1591. (org-table-cookie-line-p line))
  1592. (setq cnt 0 aligns nil)
  1593. (mapc
  1594. (lambda (x)
  1595. (setq cnt (1+ cnt))
  1596. (if (string-match "\\`<\\([lrc]\\)" x)
  1597. (push (cons cnt (downcase (match-string 1 x))) aligns)))
  1598. (org-split-string line "[ \t]*|[ \t]*"))
  1599. (add-text-properties (org-table-begin) (org-table-end)
  1600. (list 'org-forced-aligns aligns))))
  1601. (goto-char (point-at-eol)))))
  1602. (defun org-export-remove-special-table-lines ()
  1603. "Remove tables lines that are used for internal purposes.
  1604. Also, store forcedalignment information found in such lines."
  1605. (goto-char (point-min))
  1606. (while (re-search-forward "^[ \t]*|" nil t)
  1607. (org-if-unprotected-at (1- (point))
  1608. (beginning-of-line 1)
  1609. (if (or (looking-at "[ \t]*| *[!_^] *|")
  1610. (not
  1611. (memq
  1612. nil
  1613. (mapcar
  1614. (lambda (f)
  1615. (or (= (length f) 0)
  1616. (string-match
  1617. "\\`<\\([0-9]\\|[lrc]\\|[lrc][0-9]+\\)>\\'" f)))
  1618. (org-split-string ;; FIXME, can't we do without splitting???
  1619. (buffer-substring (point-at-bol) (point-at-eol))
  1620. "[ \t]*|[ \t]*")))))
  1621. (delete-region (max (point-min) (1- (point-at-bol)))
  1622. (point-at-eol))
  1623. (end-of-line 1)))))
  1624. (defun org-export-protect-sub-super (s)
  1625. (save-match-data
  1626. (while (string-match "\\([^\\\\]\\)\\([_^]\\)" s)
  1627. (setq s (replace-match "\\1\\\\\\2" nil nil s)))
  1628. s))
  1629. (defun org-export-normalize-links ()
  1630. "Convert all links to bracket links, and expand link abbreviations."
  1631. (let ((re-plain-link (concat "\\([^[<]\\)" org-plain-link-re))
  1632. (re-angle-link (concat "\\([^[]\\)" org-angle-link-re))
  1633. nodesc)
  1634. (goto-char (point-min))
  1635. (while (re-search-forward re-plain-link nil t)
  1636. (goto-char (1- (match-end 0)))
  1637. (org-if-unprotected-at (1+ (match-beginning 0))
  1638. (let* ((s (concat (match-string 1)
  1639. "[[" (match-string 2) ":" (match-string 3)
  1640. "][" (match-string 2) ":" (org-export-protect-sub-super
  1641. (match-string 3))
  1642. "]]")))
  1643. ;; added 'org-link face to links
  1644. (put-text-property 0 (length s) 'face 'org-link s)
  1645. (replace-match s t t))))
  1646. (goto-char (point-min))
  1647. (while (re-search-forward re-angle-link nil t)
  1648. (goto-char (1- (match-end 0)))
  1649. (org-if-unprotected
  1650. (let* ((s (concat (match-string 1)
  1651. "[[" (match-string 2) ":" (match-string 3)
  1652. "][" (match-string 2) ":" (org-export-protect-sub-super
  1653. (match-string 3))
  1654. "]]")))
  1655. (put-text-property 0 (length s) 'face 'org-link s)
  1656. (replace-match s t t))))
  1657. (goto-char (point-min))
  1658. (while (re-search-forward org-bracket-link-regexp nil t)
  1659. (goto-char (1- (match-end 0)))
  1660. (setq nodesc (not (match-end 3)))
  1661. (org-if-unprotected
  1662. (let* ((xx (save-match-data
  1663. (org-translate-link
  1664. (org-link-expand-abbrev (match-string 1)))))
  1665. (s (concat
  1666. "[[" (org-add-props (copy-sequence xx)
  1667. nil 'org-protected t 'org-no-description nodesc)
  1668. "]"
  1669. (if (match-end 3)
  1670. (match-string 2)
  1671. (concat "[" (copy-sequence xx)
  1672. "]"))
  1673. "]")))
  1674. (put-text-property 0 (length s) 'face 'org-link s)
  1675. (replace-match s t t))))))
  1676. (defun org-export-concatenate-multiline-links ()
  1677. "Find multi-line links and put it all into a single line.
  1678. This is to make sure that the line-processing export backends
  1679. can work correctly."
  1680. (goto-char (point-min))
  1681. (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
  1682. (org-if-unprotected-at (match-beginning 1)
  1683. (replace-match "\\1 \\3")
  1684. (goto-char (match-beginning 0)))))
  1685. (defun org-export-concatenate-multiline-emphasis ()
  1686. "Find multi-line emphasis and put it all into a single line.
  1687. This is to make sure that the line-processing export backends
  1688. can work correctly."
  1689. (goto-char (point-min))
  1690. (while (re-search-forward org-emph-re nil t)
  1691. (if (and (not (= (char-after (match-beginning 3))
  1692. (char-after (match-beginning 4))))
  1693. (save-excursion (goto-char (match-beginning 0))
  1694. (save-match-data
  1695. (and (not (org-at-table-p))
  1696. (not (org-at-heading-p))))))
  1697. (org-if-unprotected
  1698. (subst-char-in-region (match-beginning 0) (match-end 0)
  1699. ?\n ?\ t)
  1700. (goto-char (1- (match-end 0))))
  1701. (goto-char (1+ (match-beginning 0))))))
  1702. (defun org-export-grab-title-from-buffer ()
  1703. "Get a title for the current document, from looking at the buffer."
  1704. (let ((inhibit-read-only t))
  1705. (save-excursion
  1706. (goto-char (point-min))
  1707. (let ((end (if (looking-at org-outline-regexp)
  1708. (point)
  1709. (save-excursion (outline-next-heading) (point)))))
  1710. (when (re-search-forward "^[ \t]*[^|# \t\r\n].*\n" end t)
  1711. ;; Mark the line so that it will not be exported as normal text.
  1712. (org-unmodified
  1713. (add-text-properties (match-beginning 0) (match-end 0)
  1714. (list :org-license-to-kill t)))
  1715. ;; Return the title string
  1716. (org-trim (match-string 0)))))))
  1717. (defun org-export-get-title-from-subtree ()
  1718. "Return subtree title and exclude it from export."
  1719. (let (title (rbeg (region-beginning)) (rend (region-end)))
  1720. (save-excursion
  1721. (goto-char rbeg)
  1722. (when (and (org-at-heading-p)
  1723. (>= (org-end-of-subtree t t) rend))
  1724. ;; This is a subtree, we take the title from the first heading
  1725. (goto-char rbeg)
  1726. (looking-at org-todo-line-regexp)
  1727. (setq title (match-string 3))
  1728. (org-unmodified
  1729. (add-text-properties (point) (1+ (point-at-eol))
  1730. (list :org-license-to-kill t)))
  1731. (setq title (or (org-entry-get nil "EXPORT_TITLE") title))))
  1732. title))
  1733. (defun org-solidify-link-text (s &optional alist)
  1734. "Take link text and make a safe target out of it."
  1735. (save-match-data
  1736. (let* ((rtn
  1737. (mapconcat
  1738. 'identity
  1739. (org-split-string s "[ \t\r\n]+") "=="))
  1740. (a (assoc rtn alist)))
  1741. (or (cdr a) rtn))))
  1742. (defun org-get-min-level (lines &optional offset)
  1743. "Get the minimum level in LINES."
  1744. (let ((re "^\\(\\*+\\) ") l)
  1745. (catch 'exit
  1746. (while (setq l (pop lines))
  1747. (if (string-match re l)
  1748. (throw 'exit (org-tr-level (- (length (match-string 1 l))
  1749. (or offset 0))))))
  1750. 1)))
  1751. ;; Variable holding the vector with section numbers
  1752. (defvar org-section-numbers (make-vector org-level-max 0))
  1753. (defun org-init-section-numbers ()
  1754. "Initialize the vector for the section numbers."
  1755. (let* ((level -1)
  1756. (numbers (nreverse (org-split-string "" "\\.")))
  1757. (depth (1- (length org-section-numbers)))
  1758. (i depth) number-string)
  1759. (while (>= i 0)
  1760. (if (> i level)
  1761. (aset org-section-numbers i 0)
  1762. (setq number-string (or (car numbers) "0"))
  1763. (if (string-match "\\`[A-Z]\\'" number-string)
  1764. (aset org-section-numbers i
  1765. (- (string-to-char number-string) ?A -1))
  1766. (aset org-section-numbers i (string-to-number number-string)))
  1767. (pop numbers))
  1768. (setq i (1- i)))))
  1769. (defun org-section-number (&optional level)
  1770. "Return a string with the current section number.
  1771. When LEVEL is non-nil, increase section numbers on that level."
  1772. (let* ((depth (1- (length org-section-numbers)))
  1773. (string "")
  1774. (fmts (car org-export-section-number-format))
  1775. (term (cdr org-export-section-number-format))
  1776. (sep "")
  1777. ctype fmt idx n)
  1778. (when level
  1779. (when (> level -1)
  1780. (aset org-section-numbers
  1781. level (1+ (aref org-section-numbers level))))
  1782. (setq idx (1+ level))
  1783. (while (<= idx depth)
  1784. (if (not (= idx 1))
  1785. (aset org-section-numbers idx 0))
  1786. (setq idx (1+ idx))))
  1787. (setq idx 0)
  1788. (while (<= idx depth)
  1789. (when (> (aref org-section-numbers idx) 0)
  1790. (setq fmt (or (pop fmts) fmt)
  1791. ctype (car fmt)
  1792. n (aref org-section-numbers idx)
  1793. string (if (> n 0)
  1794. (concat string sep (org-number-to-counter n ctype))
  1795. (concat string ".0"))
  1796. sep (nth 1 fmt)))
  1797. (setq idx (1+ idx)))
  1798. (save-match-data
  1799. (if (string-match "\\`\\([@0]\\.\\)+" string)
  1800. (setq string (replace-match "" t nil string)))
  1801. (if (string-match "\\(\\.0\\)+\\'" string)
  1802. (setq string (replace-match "" t nil string))))
  1803. (concat string term)))
  1804. (defun org-number-to-counter (n type)
  1805. "Concert number N to a string counter, according to TYPE.
  1806. TYPE must be a string, any of:
  1807. 1 number
  1808. A A,B,....
  1809. a a,b,....
  1810. I upper case roman numeral
  1811. i lower case roman numeral"
  1812. (cond
  1813. ((equal type "1") (number-to-string n))
  1814. ((equal type "A") (char-to-string (+ ?A n -1)))
  1815. ((equal type "a") (char-to-string (+ ?a n -1)))
  1816. ((equal type "I") (org-number-to-roman n))
  1817. ((equal type "i") (downcase (org-number-to-roman n)))
  1818. (t (error "Invalid counter type `%s'" type))))
  1819. (defun org-number-to-roman (n)
  1820. "Convert integer N into a roman numeral."
  1821. (let ((roman '((1000 . "M") (900 . "CM") (500 . "D") (400 . "CD")
  1822. ( 100 . "C") ( 90 . "XC") ( 50 . "L") ( 40 . "XL")
  1823. ( 10 . "X") ( 9 . "IX") ( 5 . "V") ( 4 . "IV")
  1824. ( 1 . "I")))
  1825. (res ""))
  1826. (if (<= n 0)
  1827. (number-to-string n)
  1828. (while roman
  1829. (if (>= n (caar roman))
  1830. (setq n (- n (caar roman))
  1831. res (concat res (cdar roman)))
  1832. (pop roman)))
  1833. res)))
  1834. ;;; Macros
  1835. (defun org-export-preprocess-apply-macros ()
  1836. "Replace macro references."
  1837. (goto-char (point-min))
  1838. (let (sy val key args args2 s n)
  1839. (while (re-search-forward
  1840. "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}"
  1841. nil t)
  1842. (unless (save-match-data
  1843. (save-excursion
  1844. (goto-char (point-at-bol))
  1845. (looking-at "[ \t]*#\\+macro")))
  1846. (setq key (downcase (match-string 1))
  1847. args (match-string 3))
  1848. (when (setq val (or (plist-get org-export-opt-plist
  1849. (intern (concat ":macro-" key)))
  1850. (plist-get org-export-opt-plist
  1851. (intern (concat ":" key)))))
  1852. (save-match-data
  1853. (when args
  1854. (setq args (org-split-string args ",") args2 nil)
  1855. (while args
  1856. (while (string-match "\\\\\\'" (car args))
  1857. ;; repair bad splits
  1858. (setcar (cdr args) (concat (substring (car args) 0 -1)
  1859. "," (nth 1 args)))
  1860. (pop args))
  1861. (push (pop args) args2))
  1862. (setq args (mapcar 'org-trim (nreverse args2)))
  1863. (setq s 0)
  1864. (while (string-match "\\$\\([0-9]+\\)" val s)
  1865. (setq s (1+ (match-beginning 0))
  1866. n (string-to-number (match-string 1 val)))
  1867. (and (>= (length args) n)
  1868. (setq val (replace-match (nth (1- n) args) t t val)))))
  1869. (when (string-match "\\`(eval\\>" val)
  1870. (setq val (eval (read val))))
  1871. (if (and val (not (stringp val)))
  1872. (setq val (format "%s" val))))
  1873. (and (stringp val)
  1874. (prog1 (replace-match val t t)
  1875. (goto-char (match-beginning 0)))))))))
  1876. (defun org-export-apply-macros-in-string (s)
  1877. "Apply the macros in string S."
  1878. (when s
  1879. (with-temp-buffer
  1880. (insert s)
  1881. (org-export-preprocess-apply-macros)
  1882. (buffer-string))))
  1883. ;;; Include files
  1884. (defun org-export-handle-include-files ()
  1885. "Include the contents of include files, with proper formatting."
  1886. (let ((case-fold-search t)
  1887. params file markup lang start end prefix prefix1 switches all)
  1888. (goto-char (point-min))
  1889. (while (re-search-forward "^#\\+INCLUDE:?[ \t]+\\(.*\\)" nil t)
  1890. (setq params (read (concat "(" (match-string 1) ")"))
  1891. prefix (org-get-and-remove-property 'params :prefix)
  1892. prefix1 (org-get-and-remove-property 'params :prefix1)
  1893. file (org-symname-or-string (pop params))
  1894. markup (org-symname-or-string (pop params))
  1895. lang (and (member markup '("src" "SRC"))
  1896. (org-symname-or-string (pop params)))
  1897. switches (mapconcat '(lambda (x) (format "%s" x)) params " ")
  1898. start nil end nil)
  1899. (delete-region (match-beginning 0) (match-end 0))
  1900. (if (or (not file)
  1901. (not (file-exists-p file))
  1902. (not (file-readable-p file)))
  1903. (insert (format "CANNOT INCLUDE FILE %s" file))
  1904. (setq all (cons file all))
  1905. (when markup
  1906. (if (equal (downcase markup) "src")
  1907. (setq start (format "#+begin_src %s %s\n"
  1908. (or lang "fundamental")
  1909. (or switches ""))
  1910. end "#+end_src")
  1911. (setq start (format "#+begin_%s %s\n" markup switches)
  1912. end (format "#+end_%s" markup))))
  1913. (insert (or start ""))
  1914. (insert (org-get-file-contents (expand-file-name file)
  1915. prefix prefix1 markup))
  1916. (or (bolp) (newline))
  1917. (insert (or end ""))))
  1918. all))
  1919. (defun org-export-handle-include-files-recurse ()
  1920. "Recursively include files aborting on circular inclusion."
  1921. (let ((now (list org-current-export-file)) all)
  1922. (while now
  1923. (setq all (append now all))
  1924. (setq now (org-export-handle-include-files))
  1925. (let ((intersection
  1926. (delq nil
  1927. (mapcar (lambda (el) (when (member el all) el)) now))))
  1928. (when intersection
  1929. (error "Recursive #+INCLUDE: %S" intersection))))))
  1930. (defun org-get-file-contents (file &optional prefix prefix1 markup)
  1931. "Get the contents of FILE and return them as a string.
  1932. If PREFIX is a string, prepend it to each line. If PREFIX1
  1933. is a string, prepend it to the first line instead of PREFIX.
  1934. If MARKUP, don't protect org-like lines, the exporter will
  1935. take care of the block they are in."
  1936. (if (stringp markup) (setq markup (downcase markup)))
  1937. (with-temp-buffer
  1938. (insert-file-contents file)
  1939. (when (or prefix prefix1)
  1940. (goto-char (point-min))
  1941. (while (not (eobp))
  1942. (insert (or prefix1 prefix))
  1943. (setq prefix1 "")
  1944. (beginning-of-line 2)))
  1945. (buffer-string)
  1946. (when (member markup '("src" "example"))
  1947. (goto-char (point-min))
  1948. (while (re-search-forward "^\\([*#]\\|[ \t]*#\\+\\)" nil t)
  1949. (goto-char (match-beginning 0))
  1950. (insert ",")
  1951. (end-of-line 1)))
  1952. (buffer-string)))
  1953. (defun org-get-and-remove-property (listvar prop)
  1954. "Check if the value of LISTVAR contains PROP as a property.
  1955. If yes, return the value of that property (i.e. the element following
  1956. in the list) and remove property and value from the list in LISTVAR."
  1957. (let ((list (symbol-value listvar)) m v)
  1958. (when (setq m (member prop list))
  1959. (setq v (nth 1 m))
  1960. (if (equal (car list) prop)
  1961. (set listvar (cddr list))
  1962. (setcdr (nthcdr (- (length list) (length m) 1) list)
  1963. (cddr m))
  1964. (set listvar list)))
  1965. v))
  1966. (defun org-symname-or-string (s)
  1967. (if (symbolp s)
  1968. (if s (symbol-name s) s)
  1969. s))
  1970. ;;; Fontification and line numbers for code examples
  1971. (defvar org-export-last-code-line-counter-value 0)
  1972. (defun org-export-replace-src-segments-and-examples (backend)
  1973. "Replace source code segments with special code for export."
  1974. (setq org-export-last-code-line-counter-value 0)
  1975. (let ((case-fold-search t)
  1976. lang code trans opts indent caption)
  1977. (goto-char (point-min))
  1978. (while (re-search-forward
  1979. "\\(^\\([ \t]*\\)#\\+BEGIN_SRC:?\\([ \t]+\\([^ \t\n]+\\)\\)?\\(.*\\)\n\\([^\000]+?\n\\)[ \t]*#\\+END_SRC.*\n?\\)\\|\\(^\\([ \t]*\\)#\\+BEGIN_EXAMPLE:?\\(?:[ \t]+\\(.*\\)\\)?\n\\([^\000]+?\n\\)[ \t]*#\\+END_EXAMPLE.*\n?\\)"
  1980. nil t)
  1981. (if (match-end 1)
  1982. (if (not (match-string 4))
  1983. (error "Source block missing language specification: %s"
  1984. (let* ((body (match-string 6))
  1985. (nothing (message "body:%s" body))
  1986. (preview (or (and (string-match
  1987. "^[ \t]*\\([^\n\r]*\\)" body)
  1988. (match-string 1 body)) body)))
  1989. (if (> (length preview) 35)
  1990. (concat (substring preview 0 32) "...")
  1991. preview)))
  1992. ;; src segments
  1993. (setq lang (match-string 4)
  1994. opts (match-string 5)
  1995. code (match-string 6)
  1996. indent (length (match-string 2))
  1997. caption (get-text-property 0 'org-caption (match-string 0))))
  1998. (setq lang nil
  1999. opts (match-string 9)
  2000. code (match-string 10)
  2001. indent (length (match-string 8))
  2002. caption (get-text-property 0 'org-caption (match-string 0))))
  2003. (setq trans (org-export-format-source-code-or-example
  2004. backend lang code opts indent caption))
  2005. (replace-match trans t t))))
  2006. (defvar htmlp) ;; dynamically scoped
  2007. (defvar latexp) ;; dynamically scoped
  2008. (defvar org-export-latex-verbatim-wrap) ;; defined in org-latex.el
  2009. (defvar org-export-latex-listings) ;; defined in org-latex.el
  2010. (defvar org-export-latex-listings-langs) ;; defined in org-latex.el
  2011. (defvar org-export-latex-listings-w-names) ;; defined in org-latex.el
  2012. (defvar org-export-latex-minted) ;; defined in org-latex.el
  2013. (defvar org-export-latex-minted-langs) ;; defined in org-latex.el
  2014. (defvar org-export-latex-minted-with-line-numbers) ;; defined in org-latex.el
  2015. (defun org-export-format-source-code-or-example
  2016. (backend lang code &optional opts indent caption)
  2017. "Format CODE from language LANG and return it formatted for export.
  2018. If LANG is nil, do not add any fontification.
  2019. OPTS contains formatting options, like `-n' for triggering numbering lines,
  2020. and `+n' for continuing previous numbering.
  2021. Code formatting according to language currently only works for HTML.
  2022. Numbering lines works for all three major backends (html, latex, and ascii).
  2023. INDENT was the original indentation of the block."
  2024. (save-match-data
  2025. (let (num cont rtn rpllbl keepp textareap preserve-indentp cols rows fmt)
  2026. (setq opts (or opts "")
  2027. num (string-match "[-+]n\\>" opts)
  2028. cont (string-match "\\+n\\>" opts)
  2029. rpllbl (string-match "-r\\>" opts)
  2030. keepp (string-match "-k\\>" opts)
  2031. textareap (string-match "-t\\>" opts)
  2032. preserve-indentp (or org-src-preserve-indentation
  2033. (string-match "-i\\>" opts))
  2034. cols (if (string-match "-w[ \t]+\\([0-9]+\\)" opts)
  2035. (string-to-number (match-string 1 opts))
  2036. 80)
  2037. rows (if (string-match "-h[ \t]+\\([0-9]+\\)" opts)
  2038. (string-to-number (match-string 1 opts))
  2039. (org-count-lines code))
  2040. fmt (if (string-match "-l[ \t]+\"\\([^\"\n]+\\)\"" opts)
  2041. (match-string 1 opts)))
  2042. (when (and textareap (eq backend 'html))
  2043. ;; we cannot use numbering or highlighting.
  2044. (setq num nil cont nil lang nil))
  2045. (if keepp (setq rpllbl 'keep))
  2046. (setq rtn (if preserve-indentp code (org-remove-indentation code)))
  2047. (when (string-match "^," rtn)
  2048. (setq rtn (with-temp-buffer
  2049. (insert rtn)
  2050. ;; Free up the protected lines
  2051. (goto-char (point-min))
  2052. (while (re-search-forward "^," nil t)
  2053. (if (or (equal lang "org")
  2054. (save-match-data
  2055. (looking-at "\\([*#]\\|[ \t]*#\\+\\)")))
  2056. (replace-match ""))
  2057. (end-of-line 1))
  2058. (buffer-string))))
  2059. ;; Now backend-specific coding
  2060. (setq rtn
  2061. (cond
  2062. ((eq backend 'docbook)
  2063. (setq rtn (org-export-number-lines rtn 'docbook 0 0 num cont rpllbl fmt))
  2064. (concat "\n#+BEGIN_DOCBOOK\n"
  2065. (org-add-props (concat "<programlisting><![CDATA["
  2066. rtn
  2067. "]]></programlisting>\n")
  2068. '(org-protected t org-example t))
  2069. "#+END_DOCBOOK\n"))
  2070. ((eq backend 'html)
  2071. ;; We are exporting to HTML
  2072. (when lang
  2073. (if (featurep 'xemacs)
  2074. (require 'htmlize)
  2075. (require 'htmlize nil t))
  2076. (when (not (fboundp 'htmlize-region-for-paste))
  2077. ;; we do not have htmlize.el, or an old version of it
  2078. (setq lang nil)
  2079. (message
  2080. "htmlize.el 1.34 or later is needed for source code formatting")))
  2081. (if lang
  2082. (let* ((lang-m (when lang
  2083. (or (cdr (assoc lang org-src-lang-modes))
  2084. lang)))
  2085. (mode (and lang-m (intern
  2086. (concat
  2087. (if (symbolp lang-m)
  2088. (symbol-name lang-m)
  2089. lang-m)
  2090. "-mode"))))
  2091. (org-inhibit-startup t)
  2092. (org-startup-folded nil))
  2093. (setq rtn
  2094. (with-temp-buffer
  2095. (insert rtn)
  2096. (if (functionp mode)
  2097. (funcall mode)
  2098. (fundamental-mode))
  2099. (font-lock-fontify-buffer)
  2100. (org-src-mode)
  2101. (set-buffer-modified-p nil)
  2102. (org-export-htmlize-region-for-paste
  2103. (point-min) (point-max))))
  2104. (if (string-match "<pre\\([^>]*\\)>\n*" rtn)
  2105. (setq rtn
  2106. (concat
  2107. (if caption
  2108. (concat
  2109. "<div class=\"org-src-container\">"
  2110. (format
  2111. "<label class=\"org-src-name\">%s</label>"
  2112. caption))
  2113. "")
  2114. (replace-match
  2115. (format "<pre class=\"src src-%s\">\n" lang)
  2116. t t rtn)
  2117. (if caption "</div>" "")))))
  2118. (if textareap
  2119. (setq rtn (concat
  2120. (format "<p>\n<textarea cols=\"%d\" rows=\"%d\">"
  2121. cols rows)
  2122. rtn "</textarea>\n</p>\n"))
  2123. (with-temp-buffer
  2124. (insert rtn)
  2125. (goto-char (point-min))
  2126. (while (re-search-forward "[<>&]" nil t)
  2127. (replace-match (cdr (assq (char-before)
  2128. '((?&."&amp;")(?<."&lt;")(?>."&gt;"))))
  2129. t t))
  2130. (setq rtn (buffer-string)))
  2131. (setq rtn (concat "<pre class=\"example\">\n" rtn "</pre>\n"))))
  2132. (unless textareap
  2133. (setq rtn (org-export-number-lines rtn 'html 1 1 num
  2134. cont rpllbl fmt)))
  2135. (if (string-match "\\(\\`<[^>]*>\\)\n" rtn)
  2136. (setq rtn (replace-match "\\1" t nil rtn)))
  2137. (concat "\n#+BEGIN_HTML\n" (org-add-props rtn '(org-protected t org-example t)) "\n#+END_HTML\n\n"))
  2138. ((eq backend 'latex)
  2139. (setq rtn (org-export-number-lines rtn 'latex 0 0 num cont rpllbl fmt))
  2140. (concat "#+BEGIN_LaTeX\n"
  2141. (org-add-props
  2142. (cond
  2143. (org-export-latex-listings
  2144. (concat
  2145. (if lang
  2146. (let*
  2147. ((lang-sym (intern lang))
  2148. (lstlang
  2149. (or (cadr
  2150. (assq
  2151. lang-sym
  2152. org-export-latex-listings-langs))
  2153. lang)))
  2154. (format "\\lstset{language=%s}\n" lstlang))
  2155. "\n")
  2156. (when (and caption
  2157. org-export-latex-listings-w-names)
  2158. (format "\n%s $\\equiv$ \n"
  2159. (replace-regexp-in-string
  2160. "_" "\\\\_" caption)))
  2161. "\\begin{lstlisting}\n"
  2162. rtn "\\end{lstlisting}\n"))
  2163. (org-export-latex-minted
  2164. (if lang
  2165. (let*
  2166. ((lang-sym (intern lang))
  2167. (minted-lang
  2168. (or (cadr
  2169. (assq
  2170. lang-sym
  2171. org-export-latex-minted-langs))
  2172. (downcase lang))))
  2173. (concat
  2174. (when (and caption
  2175. org-export-latex-listings-w-names)
  2176. (format "\n%s $\\equiv$ \n"
  2177. (replace-regexp-in-string
  2178. "_" "\\\\_" caption)))
  2179. (format
  2180. "\\begin{minted}[mathescape,%s\nnumbersep=5pt,\nframe=lines,\nframesep=2mm]{%s}\n" (if org-export-latex-minted-with-line-numbers "\nlinenos," "") minted-lang)
  2181. rtn "\\end{minted}\n"))))
  2182. (t (concat (car org-export-latex-verbatim-wrap)
  2183. rtn (cdr org-export-latex-verbatim-wrap))))
  2184. '(org-protected t org-example t))
  2185. "#+END_LaTeX\n"))
  2186. ((eq backend 'ascii)
  2187. ;; This is not HTML or LaTeX, so just make it an example.
  2188. (setq rtn (org-export-number-lines rtn 'ascii 0 0 num cont rpllbl fmt))
  2189. (concat caption "\n"
  2190. "#+BEGIN_ASCII\n"
  2191. (org-add-props
  2192. (concat
  2193. (mapconcat
  2194. (lambda (l) (concat " " l))
  2195. (org-split-string rtn "\n")
  2196. "\n")
  2197. "\n")
  2198. '(org-protected t org-example t))
  2199. "#+END_ASCII\n"))))
  2200. (org-add-props rtn nil 'original-indentation indent))))
  2201. (defun org-export-number-lines (text backend
  2202. &optional skip1 skip2 number cont
  2203. replace-labels label-format)
  2204. (setq skip1 (or skip1 0) skip2 (or skip2 0))
  2205. (if (not cont) (setq org-export-last-code-line-counter-value 0))
  2206. (with-temp-buffer
  2207. (insert text)
  2208. (goto-char (point-max))
  2209. (skip-chars-backward " \t\n\r")
  2210. (delete-region (point) (point-max))
  2211. (beginning-of-line (- 1 skip2))
  2212. (let* ((last (org-current-line))
  2213. (n org-export-last-code-line-counter-value)
  2214. (nmax (+ n (- last skip1)))
  2215. (fmt (format "%%%dd: " (length (number-to-string nmax))))
  2216. (fm
  2217. (cond
  2218. ((eq backend 'html) (format "<span class=\"linenr\">%s</span>"
  2219. fmt))
  2220. ((eq backend 'ascii) fmt)
  2221. ((eq backend 'latex) fmt)
  2222. ((eq backend 'docbook) fmt)
  2223. (t "")))
  2224. (label-format (or label-format org-coderef-label-format))
  2225. (label-pre (if (string-match "%s" label-format)
  2226. (substring label-format 0 (match-beginning 0))
  2227. label-format))
  2228. (label-post (if (string-match "%s" label-format)
  2229. (substring label-format (match-end 0))
  2230. ""))
  2231. (lbl-re
  2232. (concat
  2233. ".*?\\S-.*?\\([ \t]*\\("
  2234. (regexp-quote label-pre)
  2235. "\\([-a-zA-Z0-9_ ]+\\)"
  2236. (regexp-quote label-post)
  2237. "\\)\\)"))
  2238. ref)
  2239. (org-goto-line (1+ skip1))
  2240. (while (and (re-search-forward "^" nil t) (not (eobp)) (< n nmax))
  2241. (if number
  2242. (insert (format fm (incf n)))
  2243. (forward-char 1))
  2244. (when (looking-at lbl-re)
  2245. (setq ref (match-string 3))
  2246. (cond ((numberp replace-labels)
  2247. ;; remove labels; use numbers for references when lines
  2248. ;; are numbered, use labels otherwise
  2249. (delete-region (match-beginning 1) (match-end 1))
  2250. (push (cons ref (if (> n 0) n ref)) org-export-code-refs))
  2251. ((eq replace-labels 'keep)
  2252. ;; don't remove labels; use numbers for references when
  2253. ;; lines are numbered, use labels otherwise
  2254. (goto-char (match-beginning 2))
  2255. (delete-region (match-beginning 2) (match-end 2))
  2256. (insert "(" ref ")")
  2257. (push (cons ref (if (> n 0) n (concat "(" ref ")")))
  2258. org-export-code-refs))
  2259. (t
  2260. ;; don't remove labels and don't use numbers for
  2261. ;; references
  2262. (goto-char (match-beginning 2))
  2263. (delete-region (match-beginning 2) (match-end 2))
  2264. (insert "(" ref ")")
  2265. (push (cons ref (concat "(" ref ")")) org-export-code-refs)))
  2266. (when (eq backend 'html)
  2267. (save-excursion
  2268. (beginning-of-line 1)
  2269. (insert (format "<span id=\"coderef-%s\" class=\"coderef-off\">"
  2270. ref))
  2271. (end-of-line 1)
  2272. (insert "</span>")))))
  2273. (setq org-export-last-code-line-counter-value n)
  2274. (goto-char (point-max))
  2275. (newline)
  2276. (buffer-string))))
  2277. (defun org-search-todo-below (line lines level)
  2278. "Search the subtree below LINE for any TODO entries."
  2279. (let ((rest (cdr (memq line lines)))
  2280. (re org-todo-line-regexp)
  2281. line lv todo)
  2282. (catch 'exit
  2283. (while (setq line (pop rest))
  2284. (if (string-match re line)
  2285. (progn
  2286. (setq lv (- (match-end 1) (match-beginning 1))
  2287. todo (and (match-beginning 2)
  2288. (not (member (match-string 2 line)
  2289. org-done-keywords))))
  2290. ; TODO, not DONE
  2291. (if (<= lv level) (throw 'exit nil))
  2292. (if todo (throw 'exit t))))))))
  2293. ;;;###autoload
  2294. (defun org-export-visible (type arg)
  2295. "Create a copy of the visible part of the current buffer, and export it.
  2296. The copy is created in a temporary buffer and removed after use.
  2297. TYPE is the final key (as a string) that also selects the export command in
  2298. the \\<org-mode-map>\\[org-export] export dispatcher.
  2299. As a special case, if the you type SPC at the prompt, the temporary
  2300. org-mode file will not be removed but presented to you so that you can
  2301. continue to use it. The prefix arg ARG is passed through to the exporting
  2302. command."
  2303. (interactive
  2304. (list (progn
  2305. (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")
  2306. (read-char-exclusive))
  2307. current-prefix-arg))
  2308. (if (not (member type '(?a ?n ?u ?\C-a ?b ?\C-b ?h ?D ?x ?\ ?l ?p ?d ?L)))
  2309. (error "Invalid export key"))
  2310. (let* ((binding (cdr (assoc type
  2311. '(
  2312. (?a . org-export-as-ascii)
  2313. (?A . org-export-as-ascii-to-buffer)
  2314. (?n . org-export-as-latin1)
  2315. (?N . org-export-as-latin1-to-buffer)
  2316. (?u . org-export-as-utf8)
  2317. (?U . org-export-as-utf8-to-buffer)
  2318. (?\C-a . org-export-as-ascii)
  2319. (?b . org-export-as-html-and-open)
  2320. (?\C-b . org-export-as-html-and-open)
  2321. (?h . org-export-as-html)
  2322. (?H . org-export-as-html-to-buffer)
  2323. (?R . org-export-region-as-html)
  2324. (?D . org-export-as-docbook)
  2325. (?l . org-export-as-latex)
  2326. (?p . org-export-as-pdf)
  2327. (?d . org-export-as-pdf-and-open)
  2328. (?L . org-export-as-latex-to-buffer)
  2329. (?x . org-export-as-xoxo)))))
  2330. (keepp (equal type ?\ ))
  2331. (file buffer-file-name)
  2332. (buffer (get-buffer-create "*Org Export Visible*"))
  2333. s e)
  2334. ;; Need to hack the drawers here.
  2335. (save-excursion
  2336. (goto-char (point-min))
  2337. (while (re-search-forward org-drawer-regexp nil t)
  2338. (goto-char (match-beginning 1))
  2339. (or (org-invisible-p) (org-flag-drawer nil))))
  2340. (with-current-buffer buffer (erase-buffer))
  2341. (save-excursion
  2342. (setq s (goto-char (point-min)))
  2343. (while (not (= (point) (point-max)))
  2344. (goto-char (org-find-invisible))
  2345. (append-to-buffer buffer s (point))
  2346. (setq s (goto-char (org-find-visible))))
  2347. (org-cycle-hide-drawers 'all)
  2348. (goto-char (point-min))
  2349. (unless keepp
  2350. ;; Copy all comment lines to the end, to make sure #+ settings are
  2351. ;; still available for the second export step. Kind of a hack, but
  2352. ;; does do the trick.
  2353. (if (looking-at "#[^\r\n]*")
  2354. (append-to-buffer buffer (match-beginning 0) (1+ (match-end 0))))
  2355. (while (re-search-forward "[\n\r]#[^\n\r]*" nil t)
  2356. (append-to-buffer buffer (1+ (match-beginning 0))
  2357. (min (point-max) (1+ (match-end 0))))))
  2358. (set-buffer buffer)
  2359. (let ((buffer-file-name file)
  2360. (org-inhibit-startup t))
  2361. (org-mode)
  2362. (show-all)
  2363. (unless keepp (funcall binding arg))))
  2364. (if (not keepp)
  2365. (kill-buffer buffer)
  2366. (switch-to-buffer-other-window buffer)
  2367. (goto-char (point-min)))))
  2368. (defun org-find-visible ()
  2369. (let ((s (point)))
  2370. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  2371. (get-char-property s 'invisible)))
  2372. s))
  2373. (defun org-find-invisible ()
  2374. (let ((s (point)))
  2375. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  2376. (not (get-char-property s 'invisible))))
  2377. s))
  2378. (defvar org-export-htmlized-org-css-url) ;; defined in org-html.el
  2379. ;;;###autoload
  2380. (defun org-export-as-org (arg &optional hidden ext-plist
  2381. to-buffer body-only pub-dir)
  2382. "Make a copy with not-exporting stuff removed.
  2383. The purpose of this function is to provide a way to export the source
  2384. Org file of a webpage in Org format, but with sensitive and/or irrelevant
  2385. stuff removed. This command will remove the following:
  2386. - archived trees (if the variable `org-export-with-archived-trees' is nil)
  2387. - comment blocks and trees starting with the COMMENT keyword
  2388. - only trees that are consistent with `org-export-select-tags'
  2389. and `org-export-exclude-tags'.
  2390. The only arguments that will be used are EXT-PLIST and PUB-DIR,
  2391. all the others will be ignored (but are present so that the general
  2392. mechanism to call publishing functions will work).
  2393. EXT-PLIST is a property list with external parameters overriding
  2394. org-mode's default settings, but still inferior to file-local
  2395. settings. When PUB-DIR is set, use this as the publishing
  2396. directory."
  2397. (interactive "P")
  2398. (let* ((opt-plist (org-combine-plists (org-default-export-plist)
  2399. ext-plist
  2400. (org-infile-export-plist)))
  2401. (bfname (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
  2402. (filename (concat (file-name-as-directory
  2403. (or pub-dir
  2404. (org-export-directory :org opt-plist)))
  2405. (file-name-sans-extension
  2406. (file-name-nondirectory bfname))
  2407. ".org"))
  2408. (filename (and filename
  2409. (if (equal (file-truename filename)
  2410. (file-truename bfname))
  2411. (concat (file-name-sans-extension filename)
  2412. "-source."
  2413. (file-name-extension filename))
  2414. filename)))
  2415. (backup-inhibited t)
  2416. (buffer (find-file-noselect filename))
  2417. (region (buffer-string))
  2418. str-ret)
  2419. (save-excursion
  2420. (switch-to-buffer buffer)
  2421. (erase-buffer)
  2422. (insert region)
  2423. (let ((org-inhibit-startup t)) (org-mode))
  2424. (org-install-letbind)
  2425. ;; Get rid of archived trees
  2426. (org-export-remove-archived-trees (plist-get opt-plist :archived-trees))
  2427. ;; Remove comment environment and comment subtrees
  2428. (org-export-remove-comment-blocks-and-subtrees)
  2429. ;; Get rid of excluded trees
  2430. (org-export-handle-export-tags (plist-get opt-plist :select-tags)
  2431. (plist-get opt-plist :exclude-tags))
  2432. (when (or (plist-get opt-plist :plain-source)
  2433. (not (or (plist-get opt-plist :plain-source)
  2434. (plist-get opt-plist :htmlized-source))))
  2435. ;; Either nothing special is requested (default call)
  2436. ;; or the plain source is explicitly requested
  2437. ;; so: save it
  2438. (save-buffer))
  2439. (when (plist-get opt-plist :htmlized-source)
  2440. ;; Make the htmlized version
  2441. (require 'htmlize)
  2442. (require 'org-html)
  2443. (font-lock-fontify-buffer)
  2444. (let* ((htmlize-output-type 'css)
  2445. (newbuf (htmlize-buffer)))
  2446. (with-current-buffer newbuf
  2447. (when org-export-htmlized-org-css-url
  2448. (goto-char (point-min))
  2449. (and (re-search-forward
  2450. "<style type=\"text/css\">[^\000]*?\n[ \t]*</style>.*"
  2451. nil t)
  2452. (replace-match
  2453. (format
  2454. "<link rel=\"stylesheet\" type=\"text/css\" href=\"%s\">"
  2455. org-export-htmlized-org-css-url)
  2456. t t)))
  2457. (write-file (concat filename ".html")))
  2458. (kill-buffer newbuf)))
  2459. (set-buffer-modified-p nil)
  2460. (if (equal to-buffer 'string)
  2461. (progn (setq str-ret (buffer-string))
  2462. (kill-buffer (current-buffer))
  2463. str-ret)
  2464. (kill-buffer (current-buffer))))))
  2465. (defvar org-archive-location) ;; gets loaded with the org-archive require.
  2466. (defun org-get-current-options ()
  2467. "Return a string with current options as keyword options.
  2468. Does include HTML export options as well as TODO and CATEGORY stuff."
  2469. (require 'org-archive)
  2470. (format
  2471. "#+TITLE: %s
  2472. #+AUTHOR: %s
  2473. #+EMAIL: %s
  2474. #+DATE: %s
  2475. #+DESCRIPTION:
  2476. #+KEYWORDS:
  2477. #+LANGUAGE: %s
  2478. #+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s -:%s f:%s *:%s <:%s
  2479. #+OPTIONS: TeX:%s LaTeX:%s skip:%s d:%s todo:%s pri:%s tags:%s
  2480. %s
  2481. #+EXPORT_SELECT_TAGS: %s
  2482. #+EXPORT_EXCLUDE_TAGS: %s
  2483. #+LINK_UP: %s
  2484. #+LINK_HOME: %s
  2485. #+XSLT:
  2486. #+CATEGORY: %s
  2487. #+SEQ_TODO: %s
  2488. #+TYP_TODO: %s
  2489. #+PRIORITIES: %c %c %c
  2490. #+DRAWERS: %s
  2491. #+STARTUP: %s %s %s %s %s
  2492. #+TAGS: %s
  2493. #+FILETAGS: %s
  2494. #+ARCHIVE: %s
  2495. #+LINK: %s
  2496. "
  2497. (buffer-name) (user-full-name) user-mail-address
  2498. (format-time-string (substring (car org-time-stamp-formats) 1 -1))
  2499. org-export-default-language
  2500. org-export-headline-levels
  2501. org-export-with-section-numbers
  2502. org-export-with-toc
  2503. org-export-preserve-breaks
  2504. org-export-html-expand
  2505. org-export-with-fixed-width
  2506. org-export-with-tables
  2507. org-export-with-sub-superscripts
  2508. org-export-with-special-strings
  2509. org-export-with-footnotes
  2510. org-export-with-emphasize
  2511. org-export-with-timestamps
  2512. org-export-with-TeX-macros
  2513. org-export-with-LaTeX-fragments
  2514. org-export-skip-text-before-1st-heading
  2515. org-export-with-drawers
  2516. org-export-with-todo-keywords
  2517. org-export-with-priority
  2518. org-export-with-tags
  2519. (if (featurep 'org-jsinfo) (org-infojs-options-inbuffer-template) "")
  2520. (mapconcat 'identity org-export-select-tags " ")
  2521. (mapconcat 'identity org-export-exclude-tags " ")
  2522. org-export-html-link-up
  2523. org-export-html-link-home
  2524. (or (ignore-errors
  2525. (file-name-sans-extension
  2526. (file-name-nondirectory (buffer-file-name (buffer-base-buffer)))))
  2527. "NOFILENAME")
  2528. "TODO FEEDBACK VERIFY DONE"
  2529. "Me Jason Marie DONE"
  2530. org-highest-priority org-lowest-priority org-default-priority
  2531. (mapconcat 'identity org-drawers " ")
  2532. (cdr (assoc org-startup-folded
  2533. '((nil . "showall") (t . "overview") (content . "content"))))
  2534. (if org-odd-levels-only "odd" "oddeven")
  2535. (if org-hide-leading-stars "hidestars" "showstars")
  2536. (if org-startup-align-all-tables "align" "noalign")
  2537. (cond ((eq org-log-done t) "logdone")
  2538. ((equal org-log-done 'note) "lognotedone")
  2539. ((not org-log-done) "nologdone"))
  2540. (or (mapconcat (lambda (x)
  2541. (cond
  2542. ((equal :startgroup (car x)) "{")
  2543. ((equal :endgroup (car x)) "}")
  2544. ((equal :newline (car x)) "")
  2545. ((cdr x) (format "%s(%c)" (car x) (cdr x)))
  2546. (t (car x))))
  2547. (or org-tag-alist (org-get-buffer-tags)) " ") "")
  2548. (mapconcat 'identity org-file-tags " ")
  2549. org-archive-location
  2550. "org file:~/org/%s.org"
  2551. ))
  2552. ;;;###autoload
  2553. (defun org-insert-export-options-template ()
  2554. "Insert into the buffer a template with information for exporting."
  2555. (interactive)
  2556. (if (not (bolp)) (newline))
  2557. (let ((s (org-get-current-options)))
  2558. (and (string-match "#\\+CATEGORY" s)
  2559. (setq s (substring s 0 (match-beginning 0))))
  2560. (insert s)))
  2561. (defvar org-table-colgroup-info nil)
  2562. (defun org-table-clean-before-export (lines &optional maybe-quoted)
  2563. "Check if the table has a marking column.
  2564. If yes remove the column and the special lines."
  2565. (setq org-table-colgroup-info nil)
  2566. (if (memq nil
  2567. (mapcar
  2568. (lambda (x) (or (string-match "^[ \t]*|-" x)
  2569. (string-match
  2570. (if maybe-quoted
  2571. "^[ \t]*| *\\\\?\\([\#!$*_^ /]\\) *|"
  2572. "^[ \t]*| *\\([\#!$*_^ /]\\) *|")
  2573. x)))
  2574. lines))
  2575. ;; No special marking column
  2576. (progn
  2577. (setq org-table-clean-did-remove-column nil)
  2578. (delq nil
  2579. (mapcar
  2580. (lambda (x)
  2581. (cond
  2582. ((org-table-colgroup-line-p x)
  2583. ;; This line contains colgroup info, extract it
  2584. ;; and then discard the line
  2585. (setq org-table-colgroup-info
  2586. (mapcar (lambda (x)
  2587. (cond ((member x '("<" "&lt;")) :start)
  2588. ((member x '(">" "&gt;")) :end)
  2589. ((member x '("<>" "&lt;&gt;")) :startend)
  2590. (t nil)))
  2591. (org-split-string x "[ \t]*|[ \t]*")))
  2592. nil)
  2593. ((org-table-cookie-line-p x)
  2594. ;; This line contains formatting cookies, discard it
  2595. nil)
  2596. (t x)))
  2597. lines)))
  2598. ;; there is a special marking column
  2599. (setq org-table-clean-did-remove-column t)
  2600. (delq nil
  2601. (mapcar
  2602. (lambda (x)
  2603. (cond
  2604. ((org-table-colgroup-line-p x)
  2605. ;; This line contains colgroup info, extract it
  2606. ;; and then discard the line
  2607. (setq org-table-colgroup-info
  2608. (mapcar (lambda (x)
  2609. (cond ((member x '("<" "&lt;")) :start)
  2610. ((member x '(">" "&gt;")) :end)
  2611. ((member x '("<>" "&lt;&gt;")) :startend)
  2612. (t nil)))
  2613. (cdr (org-split-string x "[ \t]*|[ \t]*"))))
  2614. nil)
  2615. ((org-table-cookie-line-p x)
  2616. ;; This line contains formatting cookies, discard it
  2617. nil)
  2618. ((string-match "^[ \t]*| *[!_^/] *|" x)
  2619. ;; ignore this line
  2620. nil)
  2621. ((or (string-match "^\\([ \t]*\\)|-+\\+" x)
  2622. (string-match "^\\([ \t]*\\)|[^|]*|" x))
  2623. ;; remove the first column
  2624. (replace-match "\\1|" t nil x))))
  2625. lines))))
  2626. (defun org-export-cleanup-toc-line (s)
  2627. "Remove tags and timestamps from lines going into the toc."
  2628. (when (memq org-export-with-tags '(not-in-toc nil))
  2629. (if (string-match (org-re " +:[[:alnum:]_@#%:]+: *$") s)
  2630. (setq s (replace-match "" t t s))))
  2631. (when org-export-remove-timestamps-from-toc
  2632. (while (string-match org-maybe-keyword-time-regexp s)
  2633. (setq s (replace-match "" t t s))))
  2634. (while (string-match org-bracket-link-regexp s)
  2635. (setq s (replace-match (match-string (if (match-end 3) 3 1) s)
  2636. t t s)))
  2637. (while (string-match "\\[\\([0-9]\\|fn:[^]]*\\)\\]" s)
  2638. (setq s (replace-match "" t t s)))
  2639. s)
  2640. (defun org-get-text-property-any (pos prop &optional object)
  2641. (or (get-text-property pos prop object)
  2642. (and (setq pos (next-single-property-change pos prop object))
  2643. (get-text-property pos prop object))))
  2644. (defun org-export-get-coderef-format (path desc)
  2645. (save-match-data
  2646. (if (and desc (string-match
  2647. (regexp-quote (concat "(" path ")"))
  2648. desc))
  2649. (replace-match "%s" t t desc)
  2650. (or desc "%s"))))
  2651. (defun org-export-push-to-kill-ring (format)
  2652. "Push buffer content to kill ring.
  2653. The depends on the variable `org-export-copy-to-kill'."
  2654. (when org-export-copy-to-kill-ring
  2655. (org-kill-new (buffer-string))
  2656. (when (fboundp 'x-set-selection)
  2657. (ignore-errors (x-set-selection 'PRIMARY (buffer-string)))
  2658. (ignore-errors (x-set-selection 'CLIPBOARD (buffer-string))))
  2659. (message "%s export done, pushed to kill ring and clipboard" format)))
  2660. (provide 'org-exp)
  2661. ;; arch-tag: 65985fe9-095c-49c7-a7b6-cb4ee15c0a95
  2662. ;;; org-exp.el ends here