org-exp.el 137 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014
  1. ;;; org-exp.el --- ASCII, HTML, XOXO and iCalendar export for Org-mode
  2. ;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: http://orgmode.org
  6. ;; Version: 6.03pre03
  7. ;;
  8. ;; This file is part of GNU Emacs.
  9. ;;
  10. ;; GNU Emacs is free software: you can redistribute it and/or modify
  11. ;; it under the terms of the GNU General Public License as published by
  12. ;; the Free Software Foundation, either version 3 of the License, or
  13. ;; (at your option) any later version.
  14. ;; GNU Emacs is distributed in the hope that it will be useful,
  15. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. ;; GNU General Public License for more details.
  18. ;; You should have received a copy of the GNU General Public License
  19. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  20. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  21. ;;
  22. ;;; Commentary:
  23. (require 'org)
  24. (require 'org-agenda)
  25. (eval-and-compile
  26. (require 'cl))
  27. (declare-function org-export-latex-preprocess "org-export-latex" ())
  28. (declare-function org-agenda-skip "org-agenda" ())
  29. (declare-function org-infojs-options-inbuffer-template "org-jsinfo" ())
  30. (declare-function htmlize-region "ext:htmlize" (beg end))
  31. (defvar htmlize-buffer-places) ; from htmlize.el
  32. (defgroup org-export nil
  33. "Options for exporting org-listings."
  34. :tag "Org Export"
  35. :group 'org)
  36. (defgroup org-export-general nil
  37. "General options for exporting Org-mode files."
  38. :tag "Org Export General"
  39. :group 'org-export)
  40. ;; FIXME
  41. (defvar org-export-publishing-directory nil)
  42. (defcustom org-export-run-in-background nil
  43. "Non-nil means export and publishing commands will run in background.
  44. This works by starting up a separate Emacs process visiting the same file
  45. and doing the export from there.
  46. Not all export commands are affected by this - only the ones which
  47. actually write to a file, and that do not depend on the buffer state.
  48. If this option is nil, you can still get background export by calling
  49. `org-export' with a double prefix arg: `C-u C-u C-c C-e'.
  50. If this option is t, the double prefix can be used to exceptionally
  51. force an export command into the current process."
  52. :group 'org-export-general
  53. :type 'boolean)
  54. (defcustom org-export-with-special-strings t
  55. "Non-nil means, interpret \"\-\", \"--\" and \"---\" for export.
  56. When this option is turned on, these strings will be exported as:
  57. Org HTML LaTeX
  58. -----+----------+--------
  59. \\- &shy; \\-
  60. -- &ndash; --
  61. --- &mdash; ---
  62. ... &hellip; \ldots
  63. This option can also be set with the +OPTIONS line, e.g. \"-:nil\"."
  64. :group 'org-export-translation
  65. :type 'boolean)
  66. (defcustom org-export-language-setup
  67. '(("en" "Author" "Date" "Table of Contents")
  68. ("cs" "Autor" "Datum" "Obsah")
  69. ("da" "Ophavsmand" "Dato" "Indhold")
  70. ("de" "Autor" "Datum" "Inhaltsverzeichnis")
  71. ("es" "Autor" "Fecha" "\xcdndice")
  72. ("fr" "Auteur" "Date" "Table des mati\xe8res")
  73. ("it" "Autore" "Data" "Indice")
  74. ("nl" "Auteur" "Datum" "Inhoudsopgave")
  75. ("nn" "Forfattar" "Dato" "Innhold") ;; nn = Norsk (nynorsk)
  76. ("sv" "F\xf6rfattarens" "Datum" "Inneh\xe5ll"))
  77. "Terms used in export text, translated to different languages.
  78. Use the variable `org-export-default-language' to set the language,
  79. or use the +OPTION lines for a per-file setting."
  80. :group 'org-export-general
  81. :type '(repeat
  82. (list
  83. (string :tag "HTML language tag")
  84. (string :tag "Author")
  85. (string :tag "Date")
  86. (string :tag "Table of Contents"))))
  87. (defcustom org-export-default-language "en"
  88. "The default language of HTML export, as a string.
  89. This should have an association in `org-export-language-setup'."
  90. :group 'org-export-general
  91. :type 'string)
  92. (defcustom org-export-skip-text-before-1st-heading nil
  93. "Non-nil means, skip all text before the first headline when exporting.
  94. When nil, that text is exported as well."
  95. :group 'org-export-general
  96. :type 'boolean)
  97. (defcustom org-export-headline-levels 3
  98. "The last level which is still exported as a headline.
  99. Inferior levels will produce itemize lists when exported.
  100. Note that a numeric prefix argument to an exporter function overrides
  101. this setting.
  102. This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
  103. :group 'org-export-general
  104. :type 'number)
  105. (defcustom org-export-with-section-numbers t
  106. "Non-nil means, add section numbers to headlines when exporting.
  107. This option can also be set with the +OPTIONS line, e.g. \"num:t\"."
  108. :group 'org-export-general
  109. :type 'boolean)
  110. (defcustom org-export-with-toc t
  111. "Non-nil means, create a table of contents in exported files.
  112. The TOC contains headlines with levels up to`org-export-headline-levels'.
  113. When an integer, include levels up to N in the toc, this may then be
  114. different from `org-export-headline-levels', but it will not be allowed
  115. to be larger than the number of headline levels.
  116. When nil, no table of contents is made.
  117. Headlines which contain any TODO items will be marked with \"(*)\" in
  118. ASCII export, and with red color in HTML output, if the option
  119. `org-export-mark-todo-in-toc' is set.
  120. In HTML output, the TOC will be clickable.
  121. This option can also be set with the +OPTIONS line, e.g. \"toc:nil\"
  122. or \"toc:3\"."
  123. :group 'org-export-general
  124. :type '(choice
  125. (const :tag "No Table of Contents" nil)
  126. (const :tag "Full Table of Contents" t)
  127. (integer :tag "TOC to level")))
  128. (defcustom org-export-mark-todo-in-toc nil
  129. "Non-nil means, mark TOC lines that contain any open TODO items."
  130. :group 'org-export-general
  131. :type 'boolean)
  132. (defcustom org-export-preserve-breaks nil
  133. "Non-nil means, preserve all line breaks when exporting.
  134. Normally, in HTML output paragraphs will be reformatted. In ASCII
  135. export, line breaks will always be preserved, regardless of this variable.
  136. This option can also be set with the +OPTIONS line, e.g. \"\\n:t\"."
  137. :group 'org-export-general
  138. :type 'boolean)
  139. (defcustom org-export-with-archived-trees 'headline
  140. "Whether subtrees with the ARCHIVE tag should be exported.
  141. This can have three different values
  142. nil Do not export, pretend this tree is not present
  143. t Do export the entire tree
  144. headline Only export the headline, but skip the tree below it."
  145. :group 'org-export-general
  146. :group 'org-archive
  147. :type '(choice
  148. (const :tag "not at all" nil)
  149. (const :tag "headline only" 'headline)
  150. (const :tag "entirely" t)))
  151. (defcustom org-export-author-info t
  152. "Non-nil means, insert author name and email into the exported file.
  153. This option can also be set with the +OPTIONS line,
  154. e.g. \"author-info:nil\"."
  155. :group 'org-export-general
  156. :type 'boolean)
  157. (defcustom org-export-time-stamp-file t
  158. "Non-nil means, insert a time stamp into the exported file.
  159. The time stamp shows when the file was created.
  160. This option can also be set with the +OPTIONS line,
  161. e.g. \"timestamp:nil\"."
  162. :group 'org-export-general
  163. :type 'boolean)
  164. (defcustom org-export-with-timestamps t
  165. "If nil, do not export time stamps and associated keywords."
  166. :group 'org-export-general
  167. :type 'boolean)
  168. (defcustom org-export-remove-timestamps-from-toc t
  169. "If nil, remove timestamps from the table of contents entries."
  170. :group 'org-export-general
  171. :type 'boolean)
  172. (defcustom org-export-with-tags 'not-in-toc
  173. "If nil, do not export tags, just remove them from headlines.
  174. If this is the symbol `not-in-toc', tags will be removed from table of
  175. contents entries, but still be shown in the headlines of the document.
  176. This option can also be set with the +OPTIONS line, e.g. \"tags:nil\"."
  177. :group 'org-export-general
  178. :type '(choice
  179. (const :tag "Off" nil)
  180. (const :tag "Not in TOC" not-in-toc)
  181. (const :tag "On" t)))
  182. (defcustom org-export-with-drawers nil
  183. "Non-nil means, export with drawers like the property drawer.
  184. When t, all drawers are exported. This may also be a list of
  185. drawer names to export."
  186. :group 'org-export-general
  187. :type '(choice
  188. (const :tag "All drawers" t)
  189. (const :tag "None" nil)
  190. (repeat :tag "Selected drawers"
  191. (string :tag "Drawer name"))))
  192. (defvar org-export-preprocess-hook nil
  193. "Hook for preprocessing an export buffer.
  194. Pretty much the first thing when exporting is running this hook.")
  195. (defgroup org-export-translation nil
  196. "Options for translating special ascii sequences for the export backends."
  197. :tag "Org Export Translation"
  198. :group 'org-export)
  199. (defcustom org-export-with-emphasize t
  200. "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
  201. If the export target supports emphasizing text, the word will be
  202. typeset in bold, italic, or underlined, respectively. Works only for
  203. single words, but you can say: I *really* *mean* *this*.
  204. Not all export backends support this.
  205. This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
  206. :group 'org-export-translation
  207. :type 'boolean)
  208. (defcustom org-export-with-footnotes t
  209. "If nil, export [1] as a footnote marker.
  210. Lines starting with [1] will be formatted as footnotes.
  211. This option can also be set with the +OPTIONS line, e.g. \"f:nil\"."
  212. :group 'org-export-translation
  213. :type 'boolean)
  214. (defcustom org-export-with-sub-superscripts t
  215. "Non-nil means, interpret \"_\" and \"^\" for export.
  216. When this option is turned on, you can use TeX-like syntax for sub- and
  217. superscripts. Several characters after \"_\" or \"^\" will be
  218. considered as a single item - so grouping with {} is normally not
  219. needed. For example, the following things will be parsed as single
  220. sub- or superscripts.
  221. 10^24 or 10^tau several digits will be considered 1 item.
  222. 10^-12 or 10^-tau a leading sign with digits or a word
  223. x^2-y^3 will be read as x^2 - y^3, because items are
  224. terminated by almost any nonword/nondigit char.
  225. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  226. Still, ambiguity is possible - so when in doubt use {} to enclose the
  227. sub/superscript. If you set this variable to the symbol `{}',
  228. the braces are *required* in order to trigger interpretations as
  229. sub/superscript. This can be helpful in documents that need \"_\"
  230. frequently in plain text.
  231. Not all export backends support this, but HTML does.
  232. This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
  233. :group 'org-export-translation
  234. :type '(choice
  235. (const :tag "Always interpret" t)
  236. (const :tag "Only with braces" {})
  237. (const :tag "Never interpret" nil)))
  238. (defcustom org-export-with-special-strings t
  239. "Non-nil means, interpret \"\-\", \"--\" and \"---\" for export.
  240. When this option is turned on, these strings will be exported as:
  241. \\- : &shy;
  242. -- : &ndash;
  243. --- : &mdash;
  244. Not all export backends support this, but HTML does.
  245. This option can also be set with the +OPTIONS line, e.g. \"-:nil\"."
  246. :group 'org-export-translation
  247. :type 'boolean)
  248. (defcustom org-export-with-TeX-macros t
  249. "Non-nil means, interpret simple TeX-like macros when exporting.
  250. For example, HTML export converts \\alpha to &alpha; and \\AA to &Aring;.
  251. No only real TeX macros will work here, but the standard HTML entities
  252. for math can be used as macro names as well. For a list of supported
  253. names in HTML export, see the constant `org-html-entities'.
  254. Not all export backends support this.
  255. This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
  256. :group 'org-export-translation
  257. :group 'org-export-latex
  258. :type 'boolean)
  259. (defcustom org-export-with-LaTeX-fragments nil
  260. "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
  261. When set, the exporter will find LaTeX environments if the \\begin line is
  262. the first non-white thing on a line. It will also find the math delimiters
  263. like $a=b$ and \\( a=b \\) for inline math, $$a=b$$ and \\[ a=b \\] for
  264. display math.
  265. This option can also be set with the +OPTIONS line, e.g. \"LaTeX:t\"."
  266. :group 'org-export-translation
  267. :group 'org-export-latex
  268. :type 'boolean)
  269. (defcustom org-export-with-fixed-width t
  270. "Non-nil means, lines starting with \":\" will be in fixed width font.
  271. This can be used to have pre-formatted text, fragments of code etc. For
  272. example:
  273. : ;; Some Lisp examples
  274. : (while (defc cnt)
  275. : (ding))
  276. will be looking just like this in also HTML. See also the QUOTE keyword.
  277. Not all export backends support this.
  278. This option can also be set with the +OPTIONS line, e.g. \"::nil\"."
  279. :group 'org-export-translation
  280. :type 'boolean)
  281. (defcustom org-match-sexp-depth 3
  282. "Number of stacked braces for sub/superscript matching.
  283. This has to be set before loading org.el to be effective."
  284. :group 'org-export-translation
  285. :type 'integer)
  286. (defgroup org-export-tables nil
  287. "Options for exporting tables in Org-mode."
  288. :tag "Org Export Tables"
  289. :group 'org-export)
  290. (defcustom org-export-with-tables t
  291. "If non-nil, lines starting with \"|\" define a table.
  292. For example:
  293. | Name | Address | Birthday |
  294. |-------------+----------+-----------|
  295. | Arthur Dent | England | 29.2.2100 |
  296. Not all export backends support this.
  297. This option can also be set with the +OPTIONS line, e.g. \"|:nil\"."
  298. :group 'org-export-tables
  299. :type 'boolean)
  300. (defcustom org-export-highlight-first-table-line t
  301. "Non-nil means, highlight the first table line.
  302. In HTML export, this means use <th> instead of <td>.
  303. In tables created with table.el, this applies to the first table line.
  304. In Org-mode tables, all lines before the first horizontal separator
  305. line will be formatted with <th> tags."
  306. :group 'org-export-tables
  307. :type 'boolean)
  308. (defcustom org-export-table-remove-special-lines t
  309. "Remove special lines and marking characters in calculating tables.
  310. This removes the special marking character column from tables that are set
  311. up for spreadsheet calculations. It also removes the entire lines
  312. marked with `!', `_', or `^'. The lines with `$' are kept, because
  313. the values of constants may be useful to have."
  314. :group 'org-export-tables
  315. :type 'boolean)
  316. (defcustom org-export-prefer-native-exporter-for-tables nil
  317. "Non-nil means, always export tables created with table.el natively.
  318. Natively means, use the HTML code generator in table.el.
  319. When nil, Org-mode's own HTML generator is used when possible (i.e. if
  320. the table does not use row- or column-spanning). This has the
  321. advantage, that the automatic HTML conversions for math symbols and
  322. sub/superscripts can be applied. Org-mode's HTML generator is also
  323. much faster."
  324. :group 'org-export-tables
  325. :type 'boolean)
  326. (defgroup org-export-ascii nil
  327. "Options specific for ASCII export of Org-mode files."
  328. :tag "Org Export ASCII"
  329. :group 'org-export)
  330. (defcustom org-export-ascii-underline '(?\$ ?\# ?^ ?\~ ?\= ?\-)
  331. "Characters for underlining headings in ASCII export.
  332. In the given sequence, these characters will be used for level 1, 2, ..."
  333. :group 'org-export-ascii
  334. :type '(repeat character))
  335. (defcustom org-export-ascii-bullets '(?* ?+ ?-)
  336. "Bullet characters for headlines converted to lists in ASCII export.
  337. The first character is used for the first lest level generated in this
  338. way, and so on. If there are more levels than characters given here,
  339. the list will be repeated.
  340. Note that plain lists will keep the same bullets as the have in the
  341. Org-mode file."
  342. :group 'org-export-ascii
  343. :type '(repeat character))
  344. (defgroup org-export-xml nil
  345. "Options specific for XML export of Org-mode files."
  346. :tag "Org Export XML"
  347. :group 'org-export)
  348. (defgroup org-export-html nil
  349. "Options specific for HTML export of Org-mode files."
  350. :tag "Org Export HTML"
  351. :group 'org-export)
  352. (defcustom org-export-html-coding-system nil
  353. "Coding system for HTML export, defaults to buffer-file-coding-system."
  354. :group 'org-export-html
  355. :type 'coding-system)
  356. (defcustom org-export-html-extension "html"
  357. "The extension for exported HTML files."
  358. :group 'org-export-html
  359. :type 'string)
  360. (defcustom org-export-html-link-up ""
  361. "Where should the \"UP\" link of exported HTML pages lead?"
  362. :group 'org-export-html
  363. :type '(string :tag "File or URL"))
  364. (defcustom org-export-html-link-home ""
  365. "Where should the \"HOME\" link of exported HTML pages lead?"
  366. :group 'org-export-html
  367. :type '(string :tag "File or URL"))
  368. (defcustom org-export-html-style
  369. "<style type=\"text/css\">
  370. html {
  371. font-family: Times, serif;
  372. font-size: 12pt;
  373. }
  374. .title { text-align: center; }
  375. .todo { color: red; }
  376. .done { color: green; }
  377. .timestamp { color: grey }
  378. .timestamp-kwd { color: CadetBlue }
  379. .tag { background-color:lightblue; font-weight:normal }
  380. .target { }
  381. pre {
  382. border: 1pt solid #AEBDCC;
  383. background-color: #F3F5F7;
  384. padding: 5pt;
  385. font-family: courier, monospace;
  386. }
  387. table { border-collapse: collapse; }
  388. td, th {
  389. vertical-align: top;
  390. <!--border: 1pt solid #ADB9CC;-->
  391. }
  392. dt { font-weight: bold; }
  393. </style>"
  394. "The default style specification for exported HTML files.
  395. Since there are different ways of setting style information, this variable
  396. needs to contain the full HTML structure to provide a style, including the
  397. surrounding HTML tags. The style specifications should include definitions
  398. for new classes todo, done, title, and deadline. For example, valid values
  399. would be:
  400. <style type=\"text/css\">
  401. p { font-weight: normal; color: gray; }
  402. h1 { color: black; }
  403. .title { text-align: center; }
  404. .todo, .deadline { color: red; }
  405. .done { color: green; }
  406. </style>
  407. or, if you want to keep the style in a file,
  408. <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
  409. As the value of this option simply gets inserted into the HTML <head> header,
  410. you can \"misuse\" it to add arbitrary text to the header."
  411. :group 'org-export-html
  412. :type 'string)
  413. (defcustom org-export-html-title-format "<h1 class=\"title\">%s</h1>\n"
  414. "Format for typesetting the document title in HTML export."
  415. :group 'org-export-html
  416. :type 'string)
  417. (defcustom org-export-html-toplevel-hlevel 2
  418. "The <H> level for level 1 headings in HTML export."
  419. :group 'org-export-html
  420. :type 'string)
  421. (defcustom org-export-html-link-org-files-as-html t
  422. "Non-nil means, make file links to `file.org' point to `file.html'.
  423. When org-mode is exporting an org-mode file to HTML, links to
  424. non-html files are directly put into a href tag in HTML.
  425. However, links to other Org-mode files (recognized by the
  426. extension `.org.) should become links to the corresponding html
  427. file, assuming that the linked org-mode file will also be
  428. converted to HTML.
  429. When nil, the links still point to the plain `.org' file."
  430. :group 'org-export-html
  431. :type 'boolean)
  432. (defcustom org-export-html-inline-images 'maybe
  433. "Non-nil means, inline images into exported HTML pages.
  434. This is done using an <img> tag. When nil, an anchor with href is used to
  435. link to the image. If this option is `maybe', then images in links with
  436. an empty description will be inlined, while images with a description will
  437. be linked only."
  438. :group 'org-export-html
  439. :type '(choice (const :tag "Never" nil)
  440. (const :tag "Always" t)
  441. (const :tag "When there is no description" maybe)))
  442. ;; FIXME: rename
  443. (defcustom org-export-html-expand t
  444. "Non-nil means, for HTML export, treat @<...> as HTML tag.
  445. When nil, these tags will be exported as plain text and therefore
  446. not be interpreted by a browser.
  447. This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
  448. :group 'org-export-html
  449. :type 'boolean)
  450. (defcustom org-export-html-table-tag
  451. "<table border=\"2\" cellspacing=\"0\" cellpadding=\"6\" rules=\"groups\" frame=\"hsides\">"
  452. "The HTML tag that is used to start a table.
  453. This must be a <table> tag, but you may change the options like
  454. borders and spacing."
  455. :group 'org-export-html
  456. :type 'string)
  457. (defcustom org-export-table-header-tags '("<th>" . "</th>")
  458. "The opening tag for table header fields.
  459. This is customizable so that alignment options can be specified."
  460. :group 'org-export-tables
  461. :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
  462. (defcustom org-export-table-data-tags '("<td>" . "</td>")
  463. "The opening tag for table data fields.
  464. This is customizable so that alignment options can be specified."
  465. :group 'org-export-tables
  466. :type '(cons (string :tag "Opening tag") (string :tag "Closing tag")))
  467. (defcustom org-export-html-with-timestamp nil
  468. "If non-nil, write `org-export-html-html-helper-timestamp'
  469. into the exported HTML text. Otherwise, the buffer will just be saved
  470. to a file."
  471. :group 'org-export-html
  472. :type 'boolean)
  473. (defcustom org-export-html-html-helper-timestamp
  474. "<br/><br/><hr><p><!-- hhmts start --> <!-- hhmts end --></p>\n"
  475. "The HTML tag used as timestamp delimiter for HTML-helper-mode."
  476. :group 'org-export-html
  477. :type 'string)
  478. (defgroup org-export-htmlize nil
  479. "Options for processing examples with htmlize.el."
  480. :tag "Org Export Htmlize"
  481. :group 'org-export-html)
  482. (defcustom org-export-htmlize-output-type 'inline-css
  483. "Output type to be used by htmlize when formatting code snippets.
  484. Normally this is `inline-css', but if you have defined to appropriate
  485. classes in your css style file, setting this to `css' means that the
  486. fontification will use the class names.
  487. See also the function `org-export-htmlize-generate-css'."
  488. :group 'org-export-htmlize
  489. :type '(choice (const css) (const inline-css)))
  490. (defcustom org-export-htmlize-css-font-prefix "org-"
  491. "The prefix for CSS class names for htmlize font specifications."
  492. :group 'org-export-htmlize
  493. :type 'string)
  494. (defgroup org-export-icalendar nil
  495. "Options specific for iCalendar export of Org-mode files."
  496. :tag "Org Export iCalendar"
  497. :group 'org-export)
  498. (defcustom org-combined-agenda-icalendar-file "~/org.ics"
  499. "The file name for the iCalendar file covering all agenda files.
  500. This file is created with the command \\[org-export-icalendar-all-agenda-files].
  501. The file name should be absolute, the file will be overwritten without warning."
  502. :group 'org-export-icalendar
  503. :type 'file)
  504. (defcustom org-icalendar-include-todo nil
  505. "Non-nil means, export to iCalendar files should also cover TODO items."
  506. :group 'org-export-icalendar
  507. :type '(choice
  508. (const :tag "None" nil)
  509. (const :tag "Unfinished" t)
  510. (const :tag "All" all)))
  511. (defcustom org-icalendar-include-sexps t
  512. "Non-nil means, export to iCalendar files should also cover sexp entries.
  513. These are entries like in the diary, but directly in an Org-mode file."
  514. :group 'org-export-icalendar
  515. :type 'boolean)
  516. (defcustom org-icalendar-include-body 100
  517. "Amount of text below headline to be included in iCalendar export.
  518. This is a number of characters that should maximally be included.
  519. Properties, scheduling and clocking lines will always be removed.
  520. The text will be inserted into the DESCRIPTION field."
  521. :group 'org-export-icalendar
  522. :type '(choice
  523. (const :tag "Nothing" nil)
  524. (const :tag "Everything" t)
  525. (integer :tag "Max characters")))
  526. (defcustom org-icalendar-combined-name "OrgMode"
  527. "Calendar name for the combined iCalendar representing all agenda files."
  528. :group 'org-export-icalendar
  529. :type 'string)
  530. ;;;; Exporting
  531. ;;; Variables, constants, and parameter plists
  532. (defconst org-level-max 20)
  533. (defvar org-export-html-preamble nil
  534. "Preamble, to be inserted just after <body>. Set by publishing functions.")
  535. (defvar org-export-html-postamble nil
  536. "Preamble, to be inserted just before </body>. Set by publishing functions.")
  537. (defvar org-export-html-auto-preamble t
  538. "Should default preamble be inserted? Set by publishing functions.")
  539. (defvar org-export-html-auto-postamble t
  540. "Should default postamble be inserted? Set by publishing functions.")
  541. (defvar org-current-export-file nil) ; dynamically scoped parameter
  542. (defvar org-current-export-dir nil) ; dynamically scoped parameter
  543. (defconst org-export-plist-vars
  544. '((:link-up . org-export-html-link-up)
  545. (:link-home . org-export-html-link-home)
  546. (:language . org-export-default-language)
  547. (:customtime . org-display-custom-times)
  548. (:headline-levels . org-export-headline-levels)
  549. (:section-numbers . org-export-with-section-numbers)
  550. (:table-of-contents . org-export-with-toc)
  551. (:preserve-breaks . org-export-preserve-breaks)
  552. (:archived-trees . org-export-with-archived-trees)
  553. (:emphasize . org-export-with-emphasize)
  554. (:sub-superscript . org-export-with-sub-superscripts)
  555. (:special-strings . org-export-with-special-strings)
  556. (:footnotes . org-export-with-footnotes)
  557. (:drawers . org-export-with-drawers)
  558. (:tags . org-export-with-tags)
  559. (:TeX-macros . org-export-with-TeX-macros)
  560. (:LaTeX-fragments . org-export-with-LaTeX-fragments)
  561. (:skip-before-1st-heading . org-export-skip-text-before-1st-heading)
  562. (:fixed-width . org-export-with-fixed-width)
  563. (:timestamps . org-export-with-timestamps)
  564. (:author-info . org-export-author-info)
  565. (:time-stamp-file . org-export-time-stamp-file)
  566. (:tables . org-export-with-tables)
  567. (:table-auto-headline . org-export-highlight-first-table-line)
  568. (:style . org-export-html-style)
  569. (:agenda-style . org-agenda-export-html-style)
  570. (:convert-org-links . org-export-html-link-org-files-as-html)
  571. (:inline-images . org-export-html-inline-images)
  572. (:html-extension . org-export-html-extension)
  573. (:html-table-tag . org-export-html-table-tag)
  574. (:expand-quoted-html . org-export-html-expand)
  575. (:timestamp . org-export-html-with-timestamp)
  576. (:publishing-directory . org-export-publishing-directory)
  577. (:preamble . org-export-html-preamble)
  578. (:postamble . org-export-html-postamble)
  579. (:auto-preamble . org-export-html-auto-preamble)
  580. (:auto-postamble . org-export-html-auto-postamble)
  581. (:author . user-full-name)
  582. (:email . user-mail-address)))
  583. (defun org-default-export-plist ()
  584. "Return the property list with default settings for the export variables."
  585. (let ((l org-export-plist-vars) rtn e)
  586. (while (setq e (pop l))
  587. (setq rtn (cons (car e) (cons (symbol-value (cdr e)) rtn))))
  588. rtn))
  589. (defvar org-export-inbuffer-options-extra nil
  590. "List of additional in-buffer options that should be detected.
  591. Just before export, the buffer is scanned for options like #+TITLE, #+EMAIL,
  592. etc. Extensions can add to this list to get their options detected, and they
  593. can then add a function to `org-export-options-filters' to process these
  594. options.
  595. Each element in this list must be a list, with the in-buffer keyword as car,
  596. and a property (a symbol) as the next element. All occurences of the
  597. keyword will be found, the values concatenated with a space character
  598. in between, and the result stored in the export options property list.")
  599. (defvar org-export-options-filters nil
  600. "Functions to be called to finalize the export/publishing options.
  601. All these options are stored in a property list, and each of the functions
  602. in this hook gets a chance to modify this property list. Each function
  603. must accept the property list as an argument, and must return the (possibly
  604. modified) list.")
  605. (defun org-infile-export-plist ()
  606. "Return the property list with file-local settings for export."
  607. (save-excursion
  608. (save-restriction
  609. (widen)
  610. (goto-char (point-min))
  611. (let ((re (org-make-options-regexp
  612. (append
  613. '("TITLE" "AUTHOR" "DATE" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"
  614. "LINK_UP" "LINK_HOME" "SETUPFILE")
  615. (mapcar 'car org-export-inbuffer-options-extra))))
  616. p key val text options js-up js-main js-css js-opt a pr
  617. ext-setup-or-nil setup-contents (start 0))
  618. (while (or (and ext-setup-or-nil
  619. (string-match re ext-setup-or-nil start)
  620. (setq start (match-end 0)))
  621. (and (setq ext-setup-or-nil nil start 0)
  622. (re-search-forward re nil t)))
  623. (setq key (upcase (org-match-string-no-properties 1 ext-setup-or-nil))
  624. val (org-match-string-no-properties 2 ext-setup-or-nil))
  625. (cond
  626. ((setq a (assoc key org-export-inbuffer-options-extra))
  627. (setq pr (nth 1 a))
  628. (setq p (plist-put p pr (concat (plist-get p pr) " " val))))
  629. ((string-equal key "TITLE") (setq p (plist-put p :title val)))
  630. ((string-equal key "AUTHOR")(setq p (plist-put p :author val)))
  631. ((string-equal key "EMAIL") (setq p (plist-put p :email val)))
  632. ((string-equal key "DATE") (setq p (plist-put p :date val)))
  633. ((string-equal key "LANGUAGE") (setq p (plist-put p :language val)))
  634. ((string-equal key "TEXT")
  635. (setq text (if text (concat text "\n" val) val)))
  636. ((string-equal key "OPTIONS")
  637. (setq options (concat val " " options)))
  638. ((string-equal key "LINK_UP")
  639. (setq p (plist-put p :link-up val)))
  640. ((string-equal key "LINK_HOME")
  641. (setq p (plist-put p :link-home val)))
  642. ((equal key "SETUPFILE")
  643. (setq setup-contents (org-file-contents
  644. (expand-file-name
  645. (org-remove-double-quotes
  646. (org-trim val)))
  647. 'noerror))
  648. (if (not ext-setup-or-nil)
  649. (setq ext-setup-or-nil setup-contents start 0)
  650. (setq ext-setup-or-nil
  651. (concat (substring ext-setup-or-nil 0 start)
  652. "\n" setup-contents "\n"
  653. (substring ext-setup-or-nil start)))))))
  654. (setq p (plist-put p :text text))
  655. (when options
  656. (let ((op '(("H" . :headline-levels)
  657. ("num" . :section-numbers)
  658. ("toc" . :table-of-contents)
  659. ("\\n" . :preserve-breaks)
  660. ("@" . :expand-quoted-html)
  661. (":" . :fixed-width)
  662. ("|" . :tables)
  663. ("^" . :sub-superscript)
  664. ("-" . :special-strings)
  665. ("f" . :footnotes)
  666. ("d" . :drawers)
  667. ("tags" . :tags)
  668. ("*" . :emphasize)
  669. ("TeX" . :TeX-macros)
  670. ("LaTeX" . :LaTeX-fragments)
  671. ("skip" . :skip-before-1st-heading)
  672. ("author" . :author-info)
  673. ("timestamp" . :time-stamp-file)))
  674. o)
  675. (while (setq o (pop op))
  676. (if (string-match (concat (regexp-quote (car o))
  677. ":\\([^ \t\n\r;,.]*\\)")
  678. options)
  679. (setq p (plist-put p (cdr o)
  680. (car (read-from-string
  681. (match-string 1 options)))))))))
  682. p))))
  683. (defun org-export-directory (type plist)
  684. (let* ((val (plist-get plist :publishing-directory))
  685. (dir (if (listp val)
  686. (or (cdr (assoc type val)) ".")
  687. val)))
  688. dir))
  689. (defun org-export-process-option-filters (plist)
  690. (let ((functions org-export-options-filters) f)
  691. (while (setq f (pop functions))
  692. (setq plist (funcall f plist))))
  693. plist)
  694. ;;;###autoload
  695. (defun org-export (&optional arg)
  696. "Export dispatcher for Org-mode.
  697. When `org-export-run-in-background' is non-nil, try to run the command
  698. in the background. This will be done only for commands that write
  699. to a file. For details see the docstring of `org-export-run-in-background'.
  700. The prefix argument ARG will be passed to the exporter. However, if
  701. ARG is a double universal prefix `C-u C-u', that means to inverse the
  702. value of `org-export-run-in-background'."
  703. (interactive "P")
  704. (let* ((bg (org-xor (equal arg '(16)) org-export-run-in-background))
  705. (help "[t] insert the export option template
  706. \[v] limit export to visible part of outline tree
  707. \[a] export as ASCII
  708. \[h] export as HTML
  709. \[H] export as HTML to temporary buffer
  710. \[R] export region as HTML
  711. \[b] export as HTML and browse immediately
  712. \[x] export as XOXO
  713. \[l] export as LaTeX
  714. \[L] export as LaTeX to temporary buffer
  715. \[i] export current file as iCalendar file
  716. \[I] export all agenda files as iCalendar files
  717. \[c] export agenda files into combined iCalendar file
  718. \[F] publish current file
  719. \[P] publish current project
  720. \[X] publish... (project will be prompted for)
  721. \[A] publish all projects")
  722. (cmds
  723. '((?t org-insert-export-options-template nil)
  724. (?v org-export-visible nil)
  725. (?a org-export-as-ascii t)
  726. (?h org-export-as-html t)
  727. (?b org-export-as-html-and-open t)
  728. (?H org-export-as-html-to-buffer nil)
  729. (?R org-export-region-as-html nil)
  730. (?x org-export-as-xoxo t)
  731. (?l org-export-as-latex t)
  732. (?L org-export-as-latex-to-buffer nil)
  733. (?i org-export-icalendar-this-file t)
  734. (?I org-export-icalendar-all-agenda-files t)
  735. (?c org-export-icalendar-combine-agenda-files t)
  736. (?F org-publish-current-file t)
  737. (?P org-publish-current-project t)
  738. (?X org-publish t)
  739. (?A org-publish-all t)))
  740. r1 r2 ass)
  741. (save-window-excursion
  742. (delete-other-windows)
  743. (with-output-to-temp-buffer "*Org Export/Publishing Help*"
  744. (princ help))
  745. (message "Select command: ")
  746. (setq r1 (read-char-exclusive)))
  747. (setq r2 (if (< r1 27) (+ r1 96) r1))
  748. (unless (setq ass (assq r2 cmds))
  749. (error "No command associated with key %c" r1))
  750. (if (and bg (nth 2 ass))
  751. ;; execute in background
  752. (let ((p (start-process
  753. (concat "Exporting " (file-name-nondirectory (buffer-file-name)))
  754. "*Org Processes*"
  755. (expand-file-name invocation-name invocation-directory)
  756. "-batch"
  757. "-l" user-init-file
  758. "--eval" "(require 'org-exp)"
  759. "--eval" "(setq org-wait .2)"
  760. (buffer-file-name)
  761. "-f" (symbol-name (nth 1 ass)))))
  762. (set-process-sentinel p 'org-export-process-sentinel)
  763. (message "Background process \"%s\": started" p))
  764. ;; background processing not requested, or not possible
  765. (call-interactively (nth 1 ass)))))
  766. (defun org-export-process-sentinel (process status)
  767. (if (string-match "\n+\\'" status)
  768. (setq status (substring status 0 -1)))
  769. (message "Background process \"%s\": %s" process status))
  770. (defconst org-html-entities
  771. '(("nbsp")
  772. ("iexcl")
  773. ("cent")
  774. ("pound")
  775. ("curren")
  776. ("yen")
  777. ("brvbar")
  778. ("vert" . "&#124;")
  779. ("sect")
  780. ("uml")
  781. ("copy")
  782. ("ordf")
  783. ("laquo")
  784. ("not")
  785. ("shy")
  786. ("reg")
  787. ("macr")
  788. ("deg")
  789. ("plusmn")
  790. ("sup2")
  791. ("sup3")
  792. ("acute")
  793. ("micro")
  794. ("para")
  795. ("middot")
  796. ("odot"."o")
  797. ("star"."*")
  798. ("cedil")
  799. ("sup1")
  800. ("ordm")
  801. ("raquo")
  802. ("frac14")
  803. ("frac12")
  804. ("frac34")
  805. ("iquest")
  806. ("Agrave")
  807. ("Aacute")
  808. ("Acirc")
  809. ("Atilde")
  810. ("Auml")
  811. ("Aring") ("AA"."&Aring;")
  812. ("AElig")
  813. ("Ccedil")
  814. ("Egrave")
  815. ("Eacute")
  816. ("Ecirc")
  817. ("Euml")
  818. ("Igrave")
  819. ("Iacute")
  820. ("Icirc")
  821. ("Iuml")
  822. ("ETH")
  823. ("Ntilde")
  824. ("Ograve")
  825. ("Oacute")
  826. ("Ocirc")
  827. ("Otilde")
  828. ("Ouml")
  829. ("times")
  830. ("Oslash")
  831. ("Ugrave")
  832. ("Uacute")
  833. ("Ucirc")
  834. ("Uuml")
  835. ("Yacute")
  836. ("THORN")
  837. ("szlig")
  838. ("agrave")
  839. ("aacute")
  840. ("acirc")
  841. ("atilde")
  842. ("auml")
  843. ("aring")
  844. ("aelig")
  845. ("ccedil")
  846. ("egrave")
  847. ("eacute")
  848. ("ecirc")
  849. ("euml")
  850. ("igrave")
  851. ("iacute")
  852. ("icirc")
  853. ("iuml")
  854. ("eth")
  855. ("ntilde")
  856. ("ograve")
  857. ("oacute")
  858. ("ocirc")
  859. ("otilde")
  860. ("ouml")
  861. ("divide")
  862. ("oslash")
  863. ("ugrave")
  864. ("uacute")
  865. ("ucirc")
  866. ("uuml")
  867. ("yacute")
  868. ("thorn")
  869. ("yuml")
  870. ("fnof")
  871. ("Alpha")
  872. ("Beta")
  873. ("Gamma")
  874. ("Delta")
  875. ("Epsilon")
  876. ("Zeta")
  877. ("Eta")
  878. ("Theta")
  879. ("Iota")
  880. ("Kappa")
  881. ("Lambda")
  882. ("Mu")
  883. ("Nu")
  884. ("Xi")
  885. ("Omicron")
  886. ("Pi")
  887. ("Rho")
  888. ("Sigma")
  889. ("Tau")
  890. ("Upsilon")
  891. ("Phi")
  892. ("Chi")
  893. ("Psi")
  894. ("Omega")
  895. ("alpha")
  896. ("beta")
  897. ("gamma")
  898. ("delta")
  899. ("epsilon")
  900. ("varepsilon"."&epsilon;")
  901. ("zeta")
  902. ("eta")
  903. ("theta")
  904. ("iota")
  905. ("kappa")
  906. ("lambda")
  907. ("mu")
  908. ("nu")
  909. ("xi")
  910. ("omicron")
  911. ("pi")
  912. ("rho")
  913. ("sigmaf") ("varsigma"."&sigmaf;")
  914. ("sigma")
  915. ("tau")
  916. ("upsilon")
  917. ("phi")
  918. ("chi")
  919. ("psi")
  920. ("omega")
  921. ("thetasym") ("vartheta"."&thetasym;")
  922. ("upsih")
  923. ("piv")
  924. ("bull") ("bullet"."&bull;")
  925. ("hellip") ("dots"."&hellip;")
  926. ("prime")
  927. ("Prime")
  928. ("oline")
  929. ("frasl")
  930. ("weierp")
  931. ("image")
  932. ("real")
  933. ("trade")
  934. ("alefsym")
  935. ("larr") ("leftarrow"."&larr;") ("gets"."&larr;")
  936. ("uarr") ("uparrow"."&uarr;")
  937. ("rarr") ("to"."&rarr;") ("rightarrow"."&rarr;")
  938. ("darr")("downarrow"."&darr;")
  939. ("harr") ("leftrightarrow"."&harr;")
  940. ("crarr") ("hookleftarrow"."&crarr;") ; has round hook, not quite CR
  941. ("lArr") ("Leftarrow"."&lArr;")
  942. ("uArr") ("Uparrow"."&uArr;")
  943. ("rArr") ("Rightarrow"."&rArr;")
  944. ("dArr") ("Downarrow"."&dArr;")
  945. ("hArr") ("Leftrightarrow"."&hArr;")
  946. ("forall")
  947. ("part") ("partial"."&part;")
  948. ("exist") ("exists"."&exist;")
  949. ("empty") ("emptyset"."&empty;")
  950. ("nabla")
  951. ("isin") ("in"."&isin;")
  952. ("notin")
  953. ("ni")
  954. ("prod")
  955. ("sum")
  956. ("minus")
  957. ("lowast") ("ast"."&lowast;")
  958. ("radic")
  959. ("prop") ("proptp"."&prop;")
  960. ("infin") ("infty"."&infin;")
  961. ("ang") ("angle"."&ang;")
  962. ("and") ("wedge"."&and;")
  963. ("or") ("vee"."&or;")
  964. ("cap")
  965. ("cup")
  966. ("int")
  967. ("there4")
  968. ("sim")
  969. ("cong") ("simeq"."&cong;")
  970. ("asymp")("approx"."&asymp;")
  971. ("ne") ("neq"."&ne;")
  972. ("equiv")
  973. ("le")
  974. ("ge")
  975. ("sub") ("subset"."&sub;")
  976. ("sup") ("supset"."&sup;")
  977. ("nsub")
  978. ("sube")
  979. ("supe")
  980. ("oplus")
  981. ("otimes")
  982. ("perp")
  983. ("sdot") ("cdot"."&sdot;")
  984. ("lceil")
  985. ("rceil")
  986. ("lfloor")
  987. ("rfloor")
  988. ("lang")
  989. ("rang")
  990. ("loz") ("Diamond"."&loz;")
  991. ("spades") ("spadesuit"."&spades;")
  992. ("clubs") ("clubsuit"."&clubs;")
  993. ("hearts") ("diamondsuit"."&hearts;")
  994. ("diams") ("diamondsuit"."&diams;")
  995. ("smile"."&#9786;") ("blacksmile"."&#9787;") ("sad"."&#9785;")
  996. ("quot")
  997. ("amp")
  998. ("lt")
  999. ("gt")
  1000. ("OElig")
  1001. ("oelig")
  1002. ("Scaron")
  1003. ("scaron")
  1004. ("Yuml")
  1005. ("circ")
  1006. ("tilde")
  1007. ("ensp")
  1008. ("emsp")
  1009. ("thinsp")
  1010. ("zwnj")
  1011. ("zwj")
  1012. ("lrm")
  1013. ("rlm")
  1014. ("ndash")
  1015. ("mdash")
  1016. ("lsquo")
  1017. ("rsquo")
  1018. ("sbquo")
  1019. ("ldquo")
  1020. ("rdquo")
  1021. ("bdquo")
  1022. ("dagger")
  1023. ("Dagger")
  1024. ("permil")
  1025. ("lsaquo")
  1026. ("rsaquo")
  1027. ("euro")
  1028. ("arccos"."arccos")
  1029. ("arcsin"."arcsin")
  1030. ("arctan"."arctan")
  1031. ("arg"."arg")
  1032. ("cos"."cos")
  1033. ("cosh"."cosh")
  1034. ("cot"."cot")
  1035. ("coth"."coth")
  1036. ("csc"."csc")
  1037. ("deg"."deg")
  1038. ("det"."det")
  1039. ("dim"."dim")
  1040. ("exp"."exp")
  1041. ("gcd"."gcd")
  1042. ("hom"."hom")
  1043. ("inf"."inf")
  1044. ("ker"."ker")
  1045. ("lg"."lg")
  1046. ("lim"."lim")
  1047. ("liminf"."liminf")
  1048. ("limsup"."limsup")
  1049. ("ln"."ln")
  1050. ("log"."log")
  1051. ("max"."max")
  1052. ("min"."min")
  1053. ("Pr"."Pr")
  1054. ("sec"."sec")
  1055. ("sin"."sin")
  1056. ("sinh"."sinh")
  1057. ("sup"."sup")
  1058. ("tan"."tan")
  1059. ("tanh"."tanh")
  1060. )
  1061. "Entities for TeX->HTML translation.
  1062. Entries can be like (\"ent\"), in which case \"\\ent\" will be translated to
  1063. \"&ent;\". An entry can also be a dotted pair like (\"ent\".\"&other;\").
  1064. In that case, \"\\ent\" will be translated to \"&other;\".
  1065. The list contains HTML entities for Latin-1, Greek and other symbols.
  1066. It is supplemented by a number of commonly used TeX macros with appropriate
  1067. translations. There is currently no way for users to extend this.")
  1068. ;;; General functions for all backends
  1069. (defun org-export-preprocess-string (string &rest parameters)
  1070. "Cleanup STRING so that that the true exported has a more consistent source.
  1071. This function takes STRING, which should be a buffer-string of an org-file
  1072. to export. It then creates a temporary buffer where it does its job.
  1073. The result is then again returned as a string, and the exporter works
  1074. on this string to produce the exported version."
  1075. (interactive)
  1076. (let* ((re-radio (and org-target-link-regexp
  1077. (concat "\\([^<]\\)\\(" org-target-link-regexp "\\)")))
  1078. (re-plain-link (concat "\\([^[<]\\)" org-plain-link-re))
  1079. (re-angle-link (concat "\\([^[]\\)" org-angle-link-re))
  1080. (re-archive (concat ":" org-archive-tag ":"))
  1081. (re-quote (concat "^\\*+[ \t]+" org-quote-string "\\>"))
  1082. (re-commented (concat "^\\*+[ \t]+" org-comment-string "\\>"))
  1083. (htmlp (plist-get parameters :for-html))
  1084. (asciip (plist-get parameters :for-ascii))
  1085. (latexp (plist-get parameters :for-LaTeX))
  1086. (commentsp (plist-get parameters :comments))
  1087. (archived-trees (plist-get parameters :archived-trees))
  1088. (inhibit-read-only t)
  1089. (drawers org-drawers)
  1090. (exp-drawers (plist-get parameters :drawers))
  1091. (outline-regexp "\\*+ ")
  1092. target-alist tmp target level
  1093. a b xx rtn p)
  1094. (with-current-buffer (get-buffer-create " org-mode-tmp")
  1095. (erase-buffer)
  1096. (insert string)
  1097. (setq case-fold-search t)
  1098. ;; Call the hook
  1099. (run-hooks 'org-export-preprocess-hook)
  1100. ;; Remove license-to-kill stuff
  1101. ;; The caller markes some stuff fo killing, stuff that has been
  1102. ;; used to create the page title, for example.
  1103. (while (setq p (text-property-any (point-min) (point-max)
  1104. :org-license-to-kill t))
  1105. (delete-region p (next-single-property-change p :org-license-to-kill)))
  1106. (let ((org-inhibit-startup t)) (org-mode))
  1107. (setq case-fold-search t)
  1108. (untabify (point-min) (point-max))
  1109. ;; Handle incude files
  1110. (org-export-handle-include-files)
  1111. ;; Handle source code snippets
  1112. (org-export-replace-src-segments)
  1113. ;; Get rid of drawers
  1114. (unless (eq t exp-drawers)
  1115. (goto-char (point-min))
  1116. (let ((re (concat "^[ \t]*:\\("
  1117. (mapconcat
  1118. 'identity
  1119. (org-delete-all exp-drawers
  1120. (copy-sequence drawers))
  1121. "\\|")
  1122. "\\):[ \t]*\n\\([^@]*?\n\\)?[ \t]*:END:[ \t]*\n")))
  1123. (while (re-search-forward re nil t)
  1124. (replace-match ""))))
  1125. ;; Get the correct stuff before the first headline
  1126. (when (plist-get parameters :skip-before-1st-heading)
  1127. (goto-char (point-min))
  1128. (when (re-search-forward "^\\*+[ \t]" nil t)
  1129. (delete-region (point-min) (match-beginning 0))
  1130. (goto-char (point-min))
  1131. (insert "\n")))
  1132. (when (plist-get parameters :add-text)
  1133. (goto-char (point-min))
  1134. (insert (plist-get parameters :add-text) "\n"))
  1135. ;; Get rid of archived trees
  1136. (when (not (eq archived-trees t))
  1137. (goto-char (point-min))
  1138. (while (re-search-forward re-archive nil t)
  1139. (if (not (org-on-heading-p t))
  1140. (org-end-of-subtree t)
  1141. (beginning-of-line 1)
  1142. (setq a (if archived-trees
  1143. (1+ (point-at-eol)) (point))
  1144. b (org-end-of-subtree t))
  1145. (if (> b a) (delete-region a b)))))
  1146. ;; Find all headings and compute the targets for them
  1147. (goto-char (point-min))
  1148. (org-init-section-numbers)
  1149. (let ((re (concat "^" org-outline-regexp)))
  1150. (while (re-search-forward re nil t)
  1151. (setq level (org-reduced-level
  1152. (save-excursion (goto-char (point-at-bol))
  1153. (org-outline-level))))
  1154. (setq target (org-solidify-link-text
  1155. (format "sec-%s" (org-section-number level))))
  1156. (push (cons target target) target-alist)
  1157. (add-text-properties
  1158. (point-at-bol) (point-at-eol)
  1159. (list 'target target))))
  1160. ;; Find targets in comments and move them out of comments,
  1161. ;; but mark them as targets that should be invisible
  1162. (goto-char (point-min))
  1163. (while (re-search-forward "^#.*?\\(<<<?\\([^>\r\n]+\\)>>>?\\).*" nil t)
  1164. ;; Check if the line before or after is a headline with a target
  1165. (if (setq target (or (get-text-property (point-at-bol 0) 'target)
  1166. (get-text-property (point-at-bol 2) 'target)))
  1167. (progn
  1168. ;; use the existing target in a neighboring line
  1169. (setq tmp (match-string 2))
  1170. (replace-match "")
  1171. (and (looking-at "\n") (delete-char 1))
  1172. (push (cons (org-solidify-link-text tmp) target)
  1173. target-alist))
  1174. ;; Make an invisible target
  1175. (replace-match "\\1(INVISIBLE)")))
  1176. ;; Protect backend specific stuff, throw away the others.
  1177. (let ((formatters
  1178. `((,htmlp "HTML" "BEGIN_HTML" "END_HTML")
  1179. (,asciip "ASCII" "BEGIN_ASCII" "END_ASCII")
  1180. (,latexp "LaTeX" "BEGIN_LaTeX" "END_LaTeX")))
  1181. fmt)
  1182. (goto-char (point-min))
  1183. (while (re-search-forward "^#\\+BEGIN_EXAMPLE[ \t]*\n" nil t)
  1184. (goto-char (match-end 0))
  1185. (while (not (looking-at "#\\+END_EXAMPLE"))
  1186. (insert ": ")
  1187. (beginning-of-line 2)))
  1188. (goto-char (point-min))
  1189. (while (re-search-forward "^[ \t]*:.*\\(\n[ \t]*:.*\\)*" nil t)
  1190. (add-text-properties (match-beginning 0) (match-end 0)
  1191. '(org-protected t)))
  1192. (while formatters
  1193. (setq fmt (pop formatters))
  1194. (when (car fmt)
  1195. (goto-char (point-min))
  1196. (while (re-search-forward (concat "^#\\+" (cadr fmt)
  1197. ":[ \t]*\\(.*\\)") nil t)
  1198. (replace-match "\\1" t)
  1199. (add-text-properties
  1200. (point-at-bol) (min (1+ (point-at-eol)) (point-max))
  1201. '(org-protected t))))
  1202. (goto-char (point-min))
  1203. (while (re-search-forward
  1204. (concat "^#\\+"
  1205. (caddr fmt) "\\>.*\\(\\(\n.*\\)*?\n\\)#\\+"
  1206. (cadddr fmt) "\\>.*\n?") nil t)
  1207. (if (car fmt)
  1208. (add-text-properties (match-beginning 1) (1+ (match-end 1))
  1209. '(org-protected t))
  1210. (delete-region (match-beginning 0) (match-end 0))))))
  1211. ;; Protect quoted subtrees
  1212. (goto-char (point-min))
  1213. (while (re-search-forward re-quote nil t)
  1214. (goto-char (match-beginning 0))
  1215. (end-of-line 1)
  1216. (add-text-properties (point) (org-end-of-subtree t)
  1217. '(org-protected t)))
  1218. ;; Protect verbatim elements
  1219. (goto-char (point-min))
  1220. (while (re-search-forward org-verbatim-re nil t)
  1221. (add-text-properties (match-beginning 4) (match-end 4)
  1222. '(org-protected t))
  1223. (goto-char (1+ (match-end 4))))
  1224. ;; Blockquotes
  1225. (goto-char (point-min))
  1226. (while (re-search-forward "^#\\+\\(begin\\|end\\)_\\(block\\)?quote\\>.*" nil t)
  1227. (replace-match (if (equal (downcase (match-string 1)) "end")
  1228. "ORG-BLOCKQUOTE-END" "ORG-BLOCKQUOTE-START")
  1229. t t))
  1230. ;; Verse
  1231. (goto-char (point-min))
  1232. (while (re-search-forward "^#\\+\\(begin\\|end\\)_verse\\>.*" nil t)
  1233. (replace-match (if (equal (downcase (match-string 1)) "end")
  1234. "ORG-VERSE-END" "ORG-VERSE-START")
  1235. t t))
  1236. ;; Remove comment environment
  1237. (goto-char (point-min))
  1238. (while (re-search-forward
  1239. "^#\\+BEGIN_COMMENT[ \t]*\n[^\000]*?^#\\+END_COMMENT\\>.*" nil t)
  1240. (replace-match "" t t))
  1241. ;; Remove subtrees that are commented
  1242. (goto-char (point-min))
  1243. (while (re-search-forward re-commented nil t)
  1244. (goto-char (match-beginning 0))
  1245. (delete-region (point) (org-end-of-subtree t)))
  1246. ;; Remove special table lines
  1247. (when org-export-table-remove-special-lines
  1248. (goto-char (point-min))
  1249. (while (re-search-forward "^[ \t]*|" nil t)
  1250. (beginning-of-line 1)
  1251. (if (or (looking-at "[ \t]*| *[!_^] *|")
  1252. (and (looking-at ".*?| *<[0-9]+> *|")
  1253. (not (looking-at ".*?| *[^ <|]"))))
  1254. (delete-region (max (point-min) (1- (point-at-bol)))
  1255. (point-at-eol))
  1256. (end-of-line 1))))
  1257. ;; Specific LaTeX stuff
  1258. (when latexp
  1259. (require 'org-export-latex nil)
  1260. (org-export-latex-preprocess))
  1261. (when asciip
  1262. (org-export-ascii-clean-string))
  1263. ;; Specific HTML stuff
  1264. (when htmlp
  1265. ;; Convert LaTeX fragments to images
  1266. (when (plist-get parameters :LaTeX-fragments)
  1267. (org-format-latex
  1268. (concat "ltxpng/" (file-name-sans-extension
  1269. (file-name-nondirectory
  1270. org-current-export-file)))
  1271. org-current-export-dir nil "Creating LaTeX image %s"))
  1272. (message "Exporting..."))
  1273. ;; Remove or replace comments
  1274. (goto-char (point-min))
  1275. (while (re-search-forward "^#\\(.*\n?\\)" nil t)
  1276. (if commentsp
  1277. (progn (add-text-properties
  1278. (match-beginning 0) (match-end 0) '(org-protected t))
  1279. (replace-match (format commentsp (match-string 1)) t t))
  1280. (replace-match "")))
  1281. ;; Find matches for radio targets and turn them into internal links
  1282. (goto-char (point-min))
  1283. (when re-radio
  1284. (while (re-search-forward re-radio nil t)
  1285. (org-if-unprotected
  1286. (replace-match "\\1[[\\2]]"))))
  1287. ;; Find all links that contain a newline and put them into a single line
  1288. (goto-char (point-min))
  1289. (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
  1290. (org-if-unprotected
  1291. (replace-match "\\1 \\3")
  1292. (goto-char (match-beginning 0))))
  1293. ;; Find all internal links. If they have a fuzzy match (i.e. not
  1294. ;; a *dedicated* target match, let the link point to the
  1295. ;; correspinding section.
  1296. (goto-char (point-min))
  1297. (while (re-search-forward org-bracket-link-regexp nil t)
  1298. (org-if-unprotected
  1299. (let* ((md (match-data))
  1300. (desc (match-end 2))
  1301. (link (org-link-unescape (match-string 1)))
  1302. (slink (org-solidify-link-text link))
  1303. found props pos
  1304. (target
  1305. (or (cdr (assoc slink target-alist))
  1306. (save-excursion
  1307. (unless (string-match org-link-types-re link)
  1308. (setq found (condition-case nil (org-link-search link)
  1309. (error nil)))
  1310. (when (and found
  1311. (or (org-on-heading-p)
  1312. (not (eq found 'dedicated))))
  1313. (or (get-text-property (point) 'target)
  1314. (get-text-property
  1315. (max (point-min)
  1316. (1- (previous-single-property-change
  1317. (point) 'target)))
  1318. 'target))))))))
  1319. (when target
  1320. (set-match-data md)
  1321. (goto-char (match-beginning 1))
  1322. (setq props (text-properties-at (point)))
  1323. (delete-region (match-beginning 1) (match-end 1))
  1324. (setq pos (point))
  1325. (insert target)
  1326. (unless desc (insert "][" link))
  1327. (add-text-properties pos (point) props)))))
  1328. ;; Normalize links: Convert angle and plain links into bracket links
  1329. ;; Expand link abbreviations
  1330. (goto-char (point-min))
  1331. (while (re-search-forward re-plain-link nil t)
  1332. (goto-char (1- (match-end 0)))
  1333. (org-if-unprotected
  1334. (let* ((s (concat (match-string 1) "[[" (match-string 2)
  1335. ":" (match-string 3) "]]")))
  1336. ;; added 'org-link face to links
  1337. (put-text-property 0 (length s) 'face 'org-link s)
  1338. (replace-match s t t))))
  1339. (goto-char (point-min))
  1340. (while (re-search-forward re-angle-link nil t)
  1341. (goto-char (1- (match-end 0)))
  1342. (org-if-unprotected
  1343. (let* ((s (concat (match-string 1) "[[" (match-string 2)
  1344. ":" (match-string 3) "]]")))
  1345. (put-text-property 0 (length s) 'face 'org-link s)
  1346. (replace-match s t t))))
  1347. (goto-char (point-min))
  1348. (while (re-search-forward org-bracket-link-regexp nil t)
  1349. (org-if-unprotected
  1350. (let* ((s (concat "[[" (setq xx (save-match-data
  1351. (org-link-expand-abbrev (match-string 1))))
  1352. "]"
  1353. (if (match-end 3)
  1354. (match-string 2)
  1355. (concat "[" xx "]"))
  1356. "]")))
  1357. (put-text-property 0 (length s) 'face 'org-link s)
  1358. (replace-match s t t))))
  1359. ;; Find multiline emphasis and put them into single line
  1360. (when (plist-get parameters :emph-multiline)
  1361. (goto-char (point-min))
  1362. (while (re-search-forward org-emph-re nil t)
  1363. (if (not (= (char-after (match-beginning 3))
  1364. (char-after (match-beginning 4))))
  1365. (org-if-unprotected
  1366. (subst-char-in-region (match-beginning 0) (match-end 0)
  1367. ?\n ?\ t)
  1368. (goto-char (1- (match-end 0))))
  1369. (goto-char (1+ (match-beginning 0))))))
  1370. (setq rtn (buffer-string)))
  1371. (kill-buffer " org-mode-tmp")
  1372. rtn))
  1373. (defun org-export-grab-title-from-buffer ()
  1374. "Get a title for the current document, from looking at the buffer."
  1375. (let ((inhibit-read-only t))
  1376. (save-excursion
  1377. (goto-char (point-min))
  1378. (let ((end (save-excursion (outline-next-heading) (point))))
  1379. (when (re-search-forward "^[ \t]*[^|# \t\r\n].*\n" end t)
  1380. ;; Mark the line so that it will not be exported as normal text.
  1381. (org-unmodified
  1382. (add-text-properties (match-beginning 0) (match-end 0)
  1383. (list :org-license-to-kill t)))
  1384. ;; Return the title string
  1385. (org-trim (match-string 0)))))))
  1386. (defun org-export-get-title-from-subtree ()
  1387. "Return subtree title and exclude it from export."
  1388. (let (title (m (mark)))
  1389. (save-excursion
  1390. (goto-char (region-beginning))
  1391. (when (and (org-at-heading-p)
  1392. (>= (org-end-of-subtree t t) (region-end)))
  1393. ;; This is a subtree, we take the title from the first heading
  1394. (goto-char (region-beginning))
  1395. (looking-at org-todo-line-regexp)
  1396. (setq title (match-string 3))
  1397. (org-unmodified
  1398. (add-text-properties (point) (1+ (point-at-eol))
  1399. (list :org-license-to-kill t)))))
  1400. title))
  1401. (defun org-solidify-link-text (s &optional alist)
  1402. "Take link text and make a safe target out of it."
  1403. (save-match-data
  1404. (let* ((rtn
  1405. (mapconcat
  1406. 'identity
  1407. (org-split-string s "[ \t\r\n]+") "=="))
  1408. (a (assoc rtn alist)))
  1409. (or (cdr a) rtn))))
  1410. (defun org-get-min-level (lines)
  1411. "Get the minimum level in LINES."
  1412. (let ((re "^\\(\\*+\\) ") l min)
  1413. (catch 'exit
  1414. (while (setq l (pop lines))
  1415. (if (string-match re l)
  1416. (throw 'exit (org-tr-level (length (match-string 1 l))))))
  1417. 1)))
  1418. ;; Variable holding the vector with section numbers
  1419. (defvar org-section-numbers (make-vector org-level-max 0))
  1420. (defun org-init-section-numbers ()
  1421. "Initialize the vector for the section numbers."
  1422. (let* ((level -1)
  1423. (numbers (nreverse (org-split-string "" "\\.")))
  1424. (depth (1- (length org-section-numbers)))
  1425. (i depth) number-string)
  1426. (while (>= i 0)
  1427. (if (> i level)
  1428. (aset org-section-numbers i 0)
  1429. (setq number-string (or (car numbers) "0"))
  1430. (if (string-match "\\`[A-Z]\\'" number-string)
  1431. (aset org-section-numbers i
  1432. (- (string-to-char number-string) ?A -1))
  1433. (aset org-section-numbers i (string-to-number number-string)))
  1434. (pop numbers))
  1435. (setq i (1- i)))))
  1436. (defun org-section-number (&optional level)
  1437. "Return a string with the current section number.
  1438. When LEVEL is non-nil, increase section numbers on that level."
  1439. (let* ((depth (1- (length org-section-numbers))) idx n (string ""))
  1440. (when level
  1441. (when (> level -1)
  1442. (aset org-section-numbers
  1443. level (1+ (aref org-section-numbers level))))
  1444. (setq idx (1+ level))
  1445. (while (<= idx depth)
  1446. (if (not (= idx 1))
  1447. (aset org-section-numbers idx 0))
  1448. (setq idx (1+ idx))))
  1449. (setq idx 0)
  1450. (while (<= idx depth)
  1451. (setq n (aref org-section-numbers idx))
  1452. (setq string (concat string (if (not (string= string "")) "." "")
  1453. (int-to-string n)))
  1454. (setq idx (1+ idx)))
  1455. (save-match-data
  1456. (if (string-match "\\`\\([@0]\\.\\)+" string)
  1457. (setq string (replace-match "" t nil string)))
  1458. (if (string-match "\\(\\.0\\)+\\'" string)
  1459. (setq string (replace-match "" t nil string))))
  1460. string))
  1461. ;;; Include files
  1462. (defun org-export-handle-include-files ()
  1463. "Include the contents of include files, with proper formatting."
  1464. (let ((case-fold-search t)
  1465. params file markup lang start end)
  1466. (goto-char (point-min))
  1467. (while (re-search-forward "^#\\+INCLUDE:?[ \t]+\\(.*\\)" nil t)
  1468. (setq params (read (concat "(" (match-string 1) ")"))
  1469. file (org-symname-or-string (pop params))
  1470. markup (org-symname-or-string (pop params))
  1471. lang (org-symname-or-string (pop params)))
  1472. (delete-region (match-beginning 0) (match-end 0))
  1473. (if (or (not file)
  1474. (not (file-exists-p file))
  1475. (not (file-readable-p file)))
  1476. (insert (format "CANNOT INCLUDE FILE %s" file))
  1477. (when markup
  1478. (if (equal (downcase markup) "src")
  1479. (setq start (format "#+begin_src %s\n" (or lang "fundamental"))
  1480. end "#+end_src")
  1481. (setq start (format "#+begin_%s\n" markup)
  1482. end (format "#+end_%s" markup))))
  1483. (insert (or start ""))
  1484. (forward-char (nth 1 (insert-file-contents (expand-file-name file))))
  1485. (or (bolp) (newline))
  1486. (insert (or end ""))))))
  1487. (defun org-symname-or-string (s)
  1488. (if (symbolp s)
  1489. (if s (symbol-name s) s)
  1490. s))
  1491. ;;; Fontification of code
  1492. ;; Currently only for th HTML backend, but who knows....
  1493. (defun org-export-replace-src-segments ()
  1494. "Replace source code segments with special code for export."
  1495. (let ((case-fold-search t)
  1496. lang code trans)
  1497. (goto-char (point-min))
  1498. (while (re-search-forward
  1499. "^#\\+BEGIN_SRC:?[ \t]+\\([^ \t\n]+\\)[ \t]*\n\\([^\000]+?\n\\)#\\+END_SRC.*"
  1500. nil t)
  1501. (setq lang (match-string 1) code (match-string 2)
  1502. trans (org-export-format-source-code lang code))
  1503. (replace-match trans t t))))
  1504. (defvar htmlp) ;; dynamically scoped from org-exp.el
  1505. (defun org-export-format-source-code (lang code)
  1506. "Format CODE from language LANG and return it formatted for export.
  1507. Currently, this only does something for HTML export, for all other
  1508. backends, it converts the segment into an EXAMPLE segment."
  1509. (save-match-data
  1510. (cond
  1511. (htmlp
  1512. ;; We are exporting to HTML
  1513. (condition-case nil (require 'htmlize) (nil t))
  1514. (if (not (fboundp 'htmlize-region-for-paste))
  1515. (progn
  1516. ;; we do not have htmlize.el, or an old version of it
  1517. (message
  1518. "htmlize.el 1.34 or later is needed for source code formatting")
  1519. (concat "#+BEGIN_EXAMPLE\n" code
  1520. (if (string-match "\n\\'" code) "" "\n")
  1521. "#+END_EXAMPLE\n"))
  1522. ;; ok, we are good to go
  1523. (let* ((mode (and lang (intern (concat lang "-mode"))))
  1524. (org-inhibit-startup t)
  1525. (org-startup-folded nil)
  1526. (htmltext
  1527. (with-temp-buffer
  1528. (insert code)
  1529. ;; Free up the protected stuff
  1530. (goto-char (point-min))
  1531. (while (re-search-forward "^," nil t)
  1532. (replace-match ""))
  1533. (if (functionp mode)
  1534. (funcall mode)
  1535. (fundamental-mode))
  1536. (font-lock-fontify-buffer)
  1537. (org-export-htmlize-region-for-paste
  1538. (point-min) (point-max)))))
  1539. (if (string-match "<pre\\([^>]*\\)>\n?" htmltext)
  1540. (setq htmltext (replace-match "<pre class=\"src\">"
  1541. t t htmltext)))
  1542. (concat "#+BEGIN_HTML\n" htmltext "\n#+END_HTML\n"))))
  1543. (t
  1544. ;; This is not HTML, so just make it an example.
  1545. (concat "#+BEGIN_EXAMPLE\n" code
  1546. (if (string-match "\n\\'" code) "" "\n")
  1547. "#+END_EXAMPLE\n")))))
  1548. ;;; ASCII export
  1549. (defvar org-last-level nil) ; dynamically scoped variable
  1550. (defvar org-min-level nil) ; dynamically scoped variable
  1551. (defvar org-levels-open nil) ; dynamically scoped parameter
  1552. (defvar org-ascii-current-indentation nil) ; For communication
  1553. ;;;###autoload
  1554. (defun org-export-as-ascii (arg)
  1555. "Export the outline as a pretty ASCII file.
  1556. If there is an active region, export only the region.
  1557. The prefix ARG specifies how many levels of the outline should become
  1558. underlined headlines. The default is 3."
  1559. (interactive "P")
  1560. (setq-default org-todo-line-regexp org-todo-line-regexp)
  1561. (let* ((opt-plist (org-combine-plists (org-default-export-plist)
  1562. (org-infile-export-plist)))
  1563. (region-p (org-region-active-p))
  1564. (subtree-p
  1565. (when region-p
  1566. (save-excursion
  1567. (goto-char (region-beginning))
  1568. (and (org-at-heading-p)
  1569. (>= (org-end-of-subtree t t) (region-end))))))
  1570. (custom-times org-display-custom-times)
  1571. (org-ascii-current-indentation '(0 . 0))
  1572. (level 0) line txt
  1573. (umax nil)
  1574. (umax-toc nil)
  1575. (case-fold-search nil)
  1576. (filename (concat (file-name-as-directory
  1577. (org-export-directory :ascii opt-plist))
  1578. (file-name-sans-extension
  1579. (or (and subtree-p
  1580. (org-entry-get (region-beginning)
  1581. "EXPORT_FILE_NAME" t))
  1582. (file-name-nondirectory buffer-file-name)))
  1583. ".txt"))
  1584. (filename (if (equal (file-truename filename)
  1585. (file-truename buffer-file-name))
  1586. (concat filename ".txt")
  1587. filename))
  1588. (buffer (find-file-noselect filename))
  1589. (org-levels-open (make-vector org-level-max nil))
  1590. (odd org-odd-levels-only)
  1591. (date (plist-get opt-plist :date))
  1592. (author (plist-get opt-plist :author))
  1593. (title (or (and subtree-p (org-export-get-title-from-subtree))
  1594. (plist-get opt-plist :title)
  1595. (and (not
  1596. (plist-get opt-plist :skip-before-1st-heading))
  1597. (org-export-grab-title-from-buffer))
  1598. (file-name-sans-extension
  1599. (file-name-nondirectory buffer-file-name))))
  1600. (email (plist-get opt-plist :email))
  1601. (language (plist-get opt-plist :language))
  1602. (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
  1603. ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
  1604. (todo nil)
  1605. (lang-words nil)
  1606. (region
  1607. (buffer-substring
  1608. (if (org-region-active-p) (region-beginning) (point-min))
  1609. (if (org-region-active-p) (region-end) (point-max))))
  1610. (lines (org-split-string
  1611. (org-export-preprocess-string
  1612. region
  1613. :for-ascii t
  1614. :skip-before-1st-heading
  1615. (plist-get opt-plist :skip-before-1st-heading)
  1616. :drawers (plist-get opt-plist :drawers)
  1617. :verbatim-multiline t
  1618. :archived-trees
  1619. (plist-get opt-plist :archived-trees)
  1620. :add-text (plist-get opt-plist :text))
  1621. "\n"))
  1622. thetoc have-headings first-heading-pos
  1623. table-open table-buffer)
  1624. (let ((inhibit-read-only t))
  1625. (org-unmodified
  1626. (remove-text-properties (point-min) (point-max)
  1627. '(:org-license-to-kill t))))
  1628. (setq org-min-level (org-get-min-level lines))
  1629. (setq org-last-level org-min-level)
  1630. (org-init-section-numbers)
  1631. (find-file-noselect filename)
  1632. (setq lang-words (or (assoc language org-export-language-setup)
  1633. (assoc "en" org-export-language-setup)))
  1634. (switch-to-buffer-other-window buffer)
  1635. (erase-buffer)
  1636. (fundamental-mode)
  1637. ;; create local variables for all options, to make sure all called
  1638. ;; functions get the correct information
  1639. (mapc (lambda (x)
  1640. (set (make-local-variable (cdr x))
  1641. (plist-get opt-plist (car x))))
  1642. org-export-plist-vars)
  1643. (org-set-local 'org-odd-levels-only odd)
  1644. (setq umax (if arg (prefix-numeric-value arg)
  1645. org-export-headline-levels))
  1646. (setq umax-toc (if (integerp org-export-with-toc)
  1647. (min org-export-with-toc umax)
  1648. umax))
  1649. ;; File header
  1650. (if title (org-insert-centered title ?=))
  1651. (insert "\n")
  1652. (if (and (or author email)
  1653. org-export-author-info)
  1654. (insert (concat (nth 1 lang-words) ": " (or author "")
  1655. (if email (concat " <" email ">") "")
  1656. "\n")))
  1657. (cond
  1658. ((and date (string-match "%" date))
  1659. (setq date (format-time-string date)))
  1660. (date)
  1661. (t (setq date (format-time-string "%Y/%m/%d %X"))))
  1662. (if (and date org-export-time-stamp-file)
  1663. (insert (concat (nth 2 lang-words) ": " date"\n")))
  1664. (insert "\n\n")
  1665. (if org-export-with-toc
  1666. (progn
  1667. (push (concat (nth 3 lang-words) "\n") thetoc)
  1668. (push (concat (make-string (length (nth 3 lang-words)) ?=) "\n") thetoc)
  1669. (mapc '(lambda (line)
  1670. (if (string-match org-todo-line-regexp
  1671. line)
  1672. ;; This is a headline
  1673. (progn
  1674. (setq have-headings t)
  1675. (setq level (- (match-end 1) (match-beginning 1))
  1676. level (org-tr-level level)
  1677. txt (match-string 3 line)
  1678. todo
  1679. (or (and org-export-mark-todo-in-toc
  1680. (match-beginning 2)
  1681. (not (member (match-string 2 line)
  1682. org-done-keywords)))
  1683. ; TODO, not DONE
  1684. (and org-export-mark-todo-in-toc
  1685. (= level umax-toc)
  1686. (org-search-todo-below
  1687. line lines level))))
  1688. (setq txt (org-html-expand-for-ascii txt))
  1689. (while (string-match org-bracket-link-regexp txt)
  1690. (setq txt
  1691. (replace-match
  1692. (match-string (if (match-end 2) 3 1) txt)
  1693. t t txt)))
  1694. (if (and (memq org-export-with-tags '(not-in-toc nil))
  1695. (string-match
  1696. (org-re "[ \t]+:[[:alnum:]_@:]+:[ \t]*$")
  1697. txt))
  1698. (setq txt (replace-match "" t t txt)))
  1699. (if (string-match quote-re0 txt)
  1700. (setq txt (replace-match "" t t txt)))
  1701. (if org-export-with-section-numbers
  1702. (setq txt (concat (org-section-number level)
  1703. " " txt)))
  1704. (if (<= level umax-toc)
  1705. (progn
  1706. (push
  1707. (concat
  1708. (make-string
  1709. (* (max 0 (- level org-min-level)) 4) ?\ )
  1710. (format (if todo "%s (*)\n" "%s\n") txt))
  1711. thetoc)
  1712. (setq org-last-level level))
  1713. ))))
  1714. lines)
  1715. (setq thetoc (if have-headings (nreverse thetoc) nil))))
  1716. (org-init-section-numbers)
  1717. (while (setq line (pop lines))
  1718. ;; Remove the quoted HTML tags.
  1719. (setq line (org-html-expand-for-ascii line))
  1720. ;; Remove targets
  1721. (while (string-match "<<<?[^<>]*>>>?[ \t]*\n?" line)
  1722. (setq line (replace-match "" t t line)))
  1723. ;; Replace internal links
  1724. (while (string-match org-bracket-link-regexp line)
  1725. (setq line (replace-match
  1726. (if (match-end 3) "[\\3]" "[\\1]")
  1727. t nil line)))
  1728. (when custom-times
  1729. (setq line (org-translate-time line)))
  1730. (cond
  1731. ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
  1732. ;; a Headline
  1733. (setq first-heading-pos (or first-heading-pos (point)))
  1734. (setq level (org-tr-level (- (match-end 1) (match-beginning 1)))
  1735. txt (match-string 2 line))
  1736. (org-ascii-level-start level txt umax lines))
  1737. ((and org-export-with-tables
  1738. (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
  1739. (if (not table-open)
  1740. ;; New table starts
  1741. (setq table-open t table-buffer nil))
  1742. ;; Accumulate lines
  1743. (setq table-buffer (cons line table-buffer))
  1744. (when (or (not lines)
  1745. (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
  1746. (car lines))))
  1747. (setq table-open nil
  1748. table-buffer (nreverse table-buffer))
  1749. (insert (mapconcat
  1750. (lambda (x)
  1751. (org-fix-indentation x org-ascii-current-indentation))
  1752. (org-format-table-ascii table-buffer)
  1753. "\n") "\n")))
  1754. (t
  1755. (setq line (org-fix-indentation line org-ascii-current-indentation))
  1756. (if (and org-export-with-fixed-width
  1757. (string-match "^\\([ \t]*\\)\\(:\\)" line))
  1758. (setq line (replace-match "\\1" nil nil line)))
  1759. (insert line "\n"))))
  1760. (normal-mode)
  1761. ;; insert the table of contents
  1762. (when thetoc
  1763. (goto-char (point-min))
  1764. (if (re-search-forward "^[ \t]*\\[TABLE-OF-CONTENTS\\][ \t]*$" nil t)
  1765. (progn
  1766. (goto-char (match-beginning 0))
  1767. (replace-match ""))
  1768. (goto-char first-heading-pos))
  1769. (mapc 'insert thetoc)
  1770. (or (looking-at "[ \t]*\n[ \t]*\n")
  1771. (insert "\n\n")))
  1772. ;; Convert whitespace place holders
  1773. (goto-char (point-min))
  1774. (let (beg end)
  1775. (while (setq beg (next-single-property-change (point) 'org-whitespace))
  1776. (setq end (next-single-property-change beg 'org-whitespace))
  1777. (goto-char beg)
  1778. (delete-region beg end)
  1779. (insert (make-string (- end beg) ?\ ))))
  1780. (save-buffer)
  1781. ;; remove display and invisible chars
  1782. (let (beg end)
  1783. (goto-char (point-min))
  1784. (while (setq beg (next-single-property-change (point) 'display))
  1785. (setq end (next-single-property-change beg 'display))
  1786. (delete-region beg end)
  1787. (goto-char beg)
  1788. (insert "=>"))
  1789. (goto-char (point-min))
  1790. (while (setq beg (next-single-property-change (point) 'org-cwidth))
  1791. (setq end (next-single-property-change beg 'org-cwidth))
  1792. (delete-region beg end)
  1793. (goto-char beg)))
  1794. (goto-char (point-min))))
  1795. (defun org-export-ascii-clean-string ()
  1796. "Do extra work for ASCII export"
  1797. (goto-char (point-min))
  1798. (while (re-search-forward org-verbatim-re nil t)
  1799. (goto-char (match-end 2))
  1800. (backward-delete-char 1) (insert "'")
  1801. (goto-char (match-beginning 2))
  1802. (delete-char 1) (insert "`")
  1803. (goto-char (match-end 2))))
  1804. (defun org-search-todo-below (line lines level)
  1805. "Search the subtree below LINE for any TODO entries."
  1806. (let ((rest (cdr (memq line lines)))
  1807. (re org-todo-line-regexp)
  1808. line lv todo)
  1809. (catch 'exit
  1810. (while (setq line (pop rest))
  1811. (if (string-match re line)
  1812. (progn
  1813. (setq lv (- (match-end 1) (match-beginning 1))
  1814. todo (and (match-beginning 2)
  1815. (not (member (match-string 2 line)
  1816. org-done-keywords))))
  1817. ; TODO, not DONE
  1818. (if (<= lv level) (throw 'exit nil))
  1819. (if todo (throw 'exit t))))))))
  1820. (defun org-html-expand-for-ascii (line)
  1821. "Handle quoted HTML for ASCII export."
  1822. (if org-export-html-expand
  1823. (while (string-match "@<[^<>\n]*>" line)
  1824. ;; We just remove the tags for now.
  1825. (setq line (replace-match "" nil nil line))))
  1826. line)
  1827. (defun org-insert-centered (s &optional underline)
  1828. "Insert the string S centered and underline it with character UNDERLINE."
  1829. (let ((ind (max (/ (- 80 (string-width s)) 2) 0)))
  1830. (insert (make-string ind ?\ ) s "\n")
  1831. (if underline
  1832. (insert (make-string ind ?\ )
  1833. (make-string (string-width s) underline)
  1834. "\n"))))
  1835. (defun org-ascii-level-start (level title umax &optional lines)
  1836. "Insert a new level in ASCII export."
  1837. (let (char (n (- level umax 1)) (ind 0))
  1838. (if (> level umax)
  1839. (progn
  1840. (insert (make-string (* 2 n) ?\ )
  1841. (char-to-string (nth (% n (length org-export-ascii-bullets))
  1842. org-export-ascii-bullets))
  1843. " " title "\n")
  1844. ;; find the indentation of the next non-empty line
  1845. (catch 'stop
  1846. (while lines
  1847. (if (string-match "^\\* " (car lines)) (throw 'stop nil))
  1848. (if (string-match "^\\([ \t]*\\)\\S-" (car lines))
  1849. (throw 'stop (setq ind (org-get-indentation (car lines)))))
  1850. (pop lines)))
  1851. (setq org-ascii-current-indentation (cons (* 2 (1+ n)) ind)))
  1852. (if (or (not (equal (char-before) ?\n))
  1853. (not (equal (char-before (1- (point))) ?\n)))
  1854. (insert "\n"))
  1855. (setq char (nth (- umax level) (reverse org-export-ascii-underline)))
  1856. (unless org-export-with-tags
  1857. (if (string-match (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title)
  1858. (setq title (replace-match "" t t title))))
  1859. (if org-export-with-section-numbers
  1860. (setq title (concat (org-section-number level) " " title)))
  1861. (insert title "\n" (make-string (string-width title) char) "\n")
  1862. (setq org-ascii-current-indentation '(0 . 0)))))
  1863. ;;;###autoload
  1864. (defun org-export-visible (type arg)
  1865. "Create a copy of the visible part of the current buffer, and export it.
  1866. The copy is created in a temporary buffer and removed after use.
  1867. TYPE is the final key (as a string) that also select the export command in
  1868. the `C-c C-e' export dispatcher.
  1869. As a special case, if the you type SPC at the prompt, the temporary
  1870. org-mode file will not be removed but presented to you so that you can
  1871. continue to use it. The prefix arg ARG is passed through to the exporting
  1872. command."
  1873. (interactive
  1874. (list (progn
  1875. (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
  1876. (read-char-exclusive))
  1877. current-prefix-arg))
  1878. (if (not (member type '(?a ?\C-a ?b ?\C-b ?h ?x ?\ )))
  1879. (error "Invalid export key"))
  1880. (let* ((binding (cdr (assoc type
  1881. '((?a . org-export-as-ascii)
  1882. (?\C-a . org-export-as-ascii)
  1883. (?b . org-export-as-html-and-open)
  1884. (?\C-b . org-export-as-html-and-open)
  1885. (?h . org-export-as-html)
  1886. (?H . org-export-as-html-to-buffer)
  1887. (?R . org-export-region-as-html)
  1888. (?x . org-export-as-xoxo)))))
  1889. (keepp (equal type ?\ ))
  1890. (file buffer-file-name)
  1891. (buffer (get-buffer-create "*Org Export Visible*"))
  1892. s e)
  1893. ;; Need to hack the drawers here.
  1894. (save-excursion
  1895. (goto-char (point-min))
  1896. (while (re-search-forward org-drawer-regexp nil t)
  1897. (goto-char (match-beginning 1))
  1898. (or (org-invisible-p) (org-flag-drawer nil))))
  1899. (with-current-buffer buffer (erase-buffer))
  1900. (save-excursion
  1901. (setq s (goto-char (point-min)))
  1902. (while (not (= (point) (point-max)))
  1903. (goto-char (org-find-invisible))
  1904. (append-to-buffer buffer s (point))
  1905. (setq s (goto-char (org-find-visible))))
  1906. (org-cycle-hide-drawers 'all)
  1907. (goto-char (point-min))
  1908. (unless keepp
  1909. ;; Copy all comment lines to the end, to make sure #+ settings are
  1910. ;; still available for the second export step. Kind of a hack, but
  1911. ;; does do the trick.
  1912. (if (looking-at "#[^\r\n]*")
  1913. (append-to-buffer buffer (match-beginning 0) (1+ (match-end 0))))
  1914. (while (re-search-forward "[\n\r]#[^\n\r]*" nil t)
  1915. (append-to-buffer buffer (1+ (match-beginning 0))
  1916. (min (point-max) (1+ (match-end 0))))))
  1917. (set-buffer buffer)
  1918. (let ((buffer-file-name file)
  1919. (org-inhibit-startup t))
  1920. (org-mode)
  1921. (show-all)
  1922. (unless keepp (funcall binding arg))))
  1923. (if (not keepp)
  1924. (kill-buffer buffer)
  1925. (switch-to-buffer-other-window buffer)
  1926. (goto-char (point-min)))))
  1927. (defun org-find-visible ()
  1928. (let ((s (point)))
  1929. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  1930. (get-char-property s 'invisible)))
  1931. s))
  1932. (defun org-find-invisible ()
  1933. (let ((s (point)))
  1934. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  1935. (not (get-char-property s 'invisible))))
  1936. s))
  1937. ;;; HTML export
  1938. (defvar org-archive-location) ;; gets loades with the org-archive require.
  1939. (defun org-get-current-options ()
  1940. "Return a string with current options as keyword options.
  1941. Does include HTML export options as well as TODO and CATEGORY stuff."
  1942. (require 'org-archive)
  1943. (format
  1944. "#+TITLE: %s
  1945. #+AUTHOR: %s
  1946. #+EMAIL: %s
  1947. #+DATE: %s
  1948. #+LANGUAGE: %s
  1949. #+TEXT: Some descriptive text to be emitted. Several lines OK.
  1950. #+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s -:%s f:%s *:%s TeX:%s LaTeX:%s skip:%s d:%s tags:%s
  1951. %s
  1952. #+LINK_UP: %s
  1953. #+LINK_HOME: %s
  1954. #+CATEGORY: %s
  1955. #+SEQ_TODO: %s
  1956. #+TYP_TODO: %s
  1957. #+PRIORITIES: %c %c %c
  1958. #+DRAWERS: %s
  1959. #+STARTUP: %s %s %s %s %s
  1960. #+TAGS: %s
  1961. #+ARCHIVE: %s
  1962. #+LINK: %s
  1963. "
  1964. (buffer-name) (user-full-name) user-mail-address
  1965. (format-time-string (car org-time-stamp-formats))
  1966. org-export-default-language
  1967. org-export-headline-levels
  1968. org-export-with-section-numbers
  1969. org-export-with-toc
  1970. org-export-preserve-breaks
  1971. org-export-html-expand
  1972. org-export-with-fixed-width
  1973. org-export-with-tables
  1974. org-export-with-sub-superscripts
  1975. org-export-with-special-strings
  1976. org-export-with-footnotes
  1977. org-export-with-emphasize
  1978. org-export-with-TeX-macros
  1979. org-export-with-LaTeX-fragments
  1980. org-export-skip-text-before-1st-heading
  1981. org-export-with-drawers
  1982. org-export-with-tags
  1983. (if (featurep 'org-jsinfo) (org-infojs-options-inbuffer-template) "")
  1984. org-export-html-link-up
  1985. org-export-html-link-home
  1986. (file-name-nondirectory buffer-file-name)
  1987. "TODO FEEDBACK VERIFY DONE"
  1988. "Me Jason Marie DONE"
  1989. org-highest-priority org-lowest-priority org-default-priority
  1990. (mapconcat 'identity org-drawers " ")
  1991. (cdr (assoc org-startup-folded
  1992. '((nil . "showall") (t . "overview") (content . "content"))))
  1993. (if org-odd-levels-only "odd" "oddeven")
  1994. (if org-hide-leading-stars "hidestars" "showstars")
  1995. (if org-startup-align-all-tables "align" "noalign")
  1996. (cond ((eq org-log-done t) "logdone")
  1997. ((equal org-log-done 'note) "lognotedone")
  1998. ((not org-log-done) "nologdone"))
  1999. (or (mapconcat (lambda (x)
  2000. (cond
  2001. ((equal '(:startgroup) x) "{")
  2002. ((equal '(:endgroup) x) "}")
  2003. ((cdr x) (format "%s(%c)" (car x) (cdr x)))
  2004. (t (car x))))
  2005. (or org-tag-alist (org-get-buffer-tags)) " ") "")
  2006. org-archive-location
  2007. "org file:~/org/%s.org"
  2008. ))
  2009. ;;;###autoload
  2010. (defun org-insert-export-options-template ()
  2011. "Insert into the buffer a template with information for exporting."
  2012. (interactive)
  2013. (if (not (bolp)) (newline))
  2014. (let ((s (org-get-current-options)))
  2015. (and (string-match "#\\+CATEGORY" s)
  2016. (setq s (substring s 0 (match-beginning 0))))
  2017. (insert s)))
  2018. ;;;###autoload
  2019. (defun org-export-as-html-and-open (arg)
  2020. "Export the outline as HTML and immediately open it with a browser.
  2021. If there is an active region, export only the region.
  2022. The prefix ARG specifies how many levels of the outline should become
  2023. headlines. The default is 3. Lower levels will become bulleted lists."
  2024. (interactive "P")
  2025. (org-export-as-html arg 'hidden)
  2026. (org-open-file buffer-file-name))
  2027. ;;;###autoload
  2028. (defun org-export-as-html-batch ()
  2029. "Call `org-export-as-html', may be used in batch processing as
  2030. emacs --batch
  2031. --load=$HOME/lib/emacs/org.el
  2032. --eval \"(setq org-export-headline-levels 2)\"
  2033. --visit=MyFile --funcall org-export-as-html-batch"
  2034. (org-export-as-html org-export-headline-levels 'hidden))
  2035. ;;;###autoload
  2036. (defun org-export-as-html-to-buffer (arg)
  2037. "Call `org-exort-as-html` with output to a temporary buffer.
  2038. No file is created. The prefix ARG is passed through to `org-export-as-html'."
  2039. (interactive "P")
  2040. (org-export-as-html arg nil nil "*Org HTML Export*")
  2041. (switch-to-buffer-other-window "*Org HTML Export*"))
  2042. ;;;###autoload
  2043. (defun org-replace-region-by-html (beg end)
  2044. "Assume the current region has org-mode syntax, and convert it to HTML.
  2045. This can be used in any buffer. For example, you could write an
  2046. itemized list in org-mode syntax in an HTML buffer and then use this
  2047. command to convert it."
  2048. (interactive "r")
  2049. (let (reg html buf pop-up-frames)
  2050. (save-window-excursion
  2051. (if (org-mode-p)
  2052. (setq html (org-export-region-as-html
  2053. beg end t 'string))
  2054. (setq reg (buffer-substring beg end)
  2055. buf (get-buffer-create "*Org tmp*"))
  2056. (with-current-buffer buf
  2057. (erase-buffer)
  2058. (insert reg)
  2059. (org-mode)
  2060. (setq html (org-export-region-as-html
  2061. (point-min) (point-max) t 'string)))
  2062. (kill-buffer buf)))
  2063. (delete-region beg end)
  2064. (insert html)))
  2065. ;;;###autoload
  2066. (defun org-export-region-as-html (beg end &optional body-only buffer)
  2067. "Convert region from BEG to END in org-mode buffer to HTML.
  2068. If prefix arg BODY-ONLY is set, omit file header, footer, and table of
  2069. contents, and only produce the region of converted text, useful for
  2070. cut-and-paste operations.
  2071. If BUFFER is a buffer or a string, use/create that buffer as a target
  2072. of the converted HTML. If BUFFER is the symbol `string', return the
  2073. produced HTML as a string and leave not buffer behind. For example,
  2074. a Lisp program could call this function in the following way:
  2075. (setq html (org-export-region-as-html beg end t 'string))
  2076. When called interactively, the output buffer is selected, and shown
  2077. in a window. A non-interactive call will only return the buffer."
  2078. (interactive "r\nP")
  2079. (when (interactive-p)
  2080. (setq buffer "*Org HTML Export*"))
  2081. (let ((transient-mark-mode t) (zmacs-regions t)
  2082. rtn)
  2083. (goto-char end)
  2084. (set-mark (point)) ;; to activate the region
  2085. (goto-char beg)
  2086. (setq rtn (org-export-as-html
  2087. nil nil nil
  2088. buffer body-only))
  2089. (if (fboundp 'deactivate-mark) (deactivate-mark))
  2090. (if (and (interactive-p) (bufferp rtn))
  2091. (switch-to-buffer-other-window rtn)
  2092. rtn)))
  2093. (defvar html-table-tag nil) ; dynamically scoped into this.
  2094. ;;;###autoload
  2095. (defun org-export-as-html (arg &optional hidden ext-plist
  2096. to-buffer body-only pub-dir)
  2097. "Export the outline as a pretty HTML file.
  2098. If there is an active region, export only the region. The prefix
  2099. ARG specifies how many levels of the outline should become
  2100. headlines. The default is 3. Lower levels will become bulleted
  2101. lists. When HIDDEN is non-nil, don't display the HTML buffer.
  2102. EXT-PLIST is a property list with external parameters overriding
  2103. org-mode's default settings, but still inferior to file-local
  2104. settings. When TO-BUFFER is non-nil, create a buffer with that
  2105. name and export to that buffer. If TO-BUFFER is the symbol
  2106. `string', don't leave any buffer behind but just return the
  2107. resulting HTML as a string. When BODY-ONLY is set, don't produce
  2108. the file header and footer, simply return the content of
  2109. <body>...</body>, without even the body tags themselves. When
  2110. PUB-DIR is set, use this as the publishing directory."
  2111. (interactive "P")
  2112. ;; Make sure we have a file name when we need it.
  2113. (when (and (not (or to-buffer body-only))
  2114. (not buffer-file-name))
  2115. (if (buffer-base-buffer)
  2116. (org-set-local 'buffer-file-name
  2117. (with-current-buffer (buffer-base-buffer)
  2118. buffer-file-name))
  2119. (error "Need a file name to be able to export.")))
  2120. (message "Exporting...")
  2121. (setq-default org-todo-line-regexp org-todo-line-regexp)
  2122. (setq-default org-deadline-line-regexp org-deadline-line-regexp)
  2123. (setq-default org-done-keywords org-done-keywords)
  2124. (setq-default org-maybe-keyword-time-regexp org-maybe-keyword-time-regexp)
  2125. (let* ((opt-plist
  2126. (org-export-process-option-filters
  2127. (org-combine-plists (org-default-export-plist)
  2128. ext-plist
  2129. (org-infile-export-plist))))
  2130. (style (plist-get opt-plist :style))
  2131. (html-extension (plist-get opt-plist :html-extension))
  2132. (link-validate (plist-get opt-plist :link-validation-function))
  2133. valid thetoc have-headings first-heading-pos
  2134. (odd org-odd-levels-only)
  2135. (region-p (org-region-active-p))
  2136. (subtree-p
  2137. (when region-p
  2138. (save-excursion
  2139. (goto-char (region-beginning))
  2140. (and (org-at-heading-p)
  2141. (>= (org-end-of-subtree t t) (region-end))))))
  2142. ;; The following two are dynamically scoped into other
  2143. ;; routines below.
  2144. (org-current-export-dir
  2145. (or pub-dir (org-export-directory :html opt-plist)))
  2146. (org-current-export-file buffer-file-name)
  2147. (level 0) (line "") (origline "") txt todo
  2148. (umax nil)
  2149. (umax-toc nil)
  2150. (filename (if to-buffer nil
  2151. (expand-file-name
  2152. (concat
  2153. (file-name-sans-extension
  2154. (or (and subtree-p
  2155. (org-entry-get (region-beginning)
  2156. "EXPORT_FILE_NAME" t))
  2157. (file-name-nondirectory buffer-file-name)))
  2158. "." html-extension)
  2159. (file-name-as-directory
  2160. (or pub-dir (org-export-directory :html opt-plist))))))
  2161. (current-dir (if buffer-file-name
  2162. (file-name-directory buffer-file-name)
  2163. default-directory))
  2164. (buffer (if to-buffer
  2165. (cond
  2166. ((eq to-buffer 'string) (get-buffer-create "*Org HTML Export*"))
  2167. (t (get-buffer-create to-buffer)))
  2168. (find-file-noselect filename)))
  2169. (org-levels-open (make-vector org-level-max nil))
  2170. (date (plist-get opt-plist :date))
  2171. (author (plist-get opt-plist :author))
  2172. (title (or (and subtree-p (org-export-get-title-from-subtree))
  2173. (plist-get opt-plist :title)
  2174. (and (not
  2175. (plist-get opt-plist :skip-before-1st-heading))
  2176. (org-export-grab-title-from-buffer))
  2177. (and buffer-file-name
  2178. (file-name-sans-extension
  2179. (file-name-nondirectory buffer-file-name)))
  2180. "UNTITLED"))
  2181. (html-table-tag (plist-get opt-plist :html-table-tag))
  2182. (quote-re0 (concat "^[ \t]*" org-quote-string "\\>"))
  2183. (quote-re (concat "^\\(\\*+\\)\\([ \t]+" org-quote-string "\\>\\)"))
  2184. (inquote nil)
  2185. (infixed nil)
  2186. (in-local-list nil)
  2187. (local-list-type nil)
  2188. (local-list-indent nil)
  2189. (llt org-plain-list-ordered-item-terminator)
  2190. (email (plist-get opt-plist :email))
  2191. (language (plist-get opt-plist :language))
  2192. (lang-words nil)
  2193. (head-count 0) cnt
  2194. (start 0)
  2195. (coding-system (and (boundp 'buffer-file-coding-system)
  2196. buffer-file-coding-system))
  2197. (coding-system-for-write (or org-export-html-coding-system
  2198. coding-system))
  2199. (save-buffer-coding-system (or org-export-html-coding-system
  2200. coding-system))
  2201. (charset (and coding-system-for-write
  2202. (fboundp 'coding-system-get)
  2203. (coding-system-get coding-system-for-write
  2204. 'mime-charset)))
  2205. (region
  2206. (buffer-substring
  2207. (if region-p (region-beginning) (point-min))
  2208. (if region-p (region-end) (point-max))))
  2209. (lines
  2210. (org-split-string
  2211. (org-export-preprocess-string
  2212. region
  2213. :emph-multiline t
  2214. :for-html t
  2215. :skip-before-1st-heading
  2216. (plist-get opt-plist :skip-before-1st-heading)
  2217. :drawers (plist-get opt-plist :drawers)
  2218. :archived-trees
  2219. (plist-get opt-plist :archived-trees)
  2220. :add-text
  2221. (plist-get opt-plist :text)
  2222. :LaTeX-fragments
  2223. (plist-get opt-plist :LaTeX-fragments))
  2224. "[\r\n]"))
  2225. table-open type
  2226. table-buffer table-orig-buffer
  2227. ind item-type starter didclose
  2228. rpl path desc descp desc1 desc2 link
  2229. snumber fnc item-tag
  2230. )
  2231. (let ((inhibit-read-only t))
  2232. (org-unmodified
  2233. (remove-text-properties (point-min) (point-max)
  2234. '(:org-license-to-kill t))))
  2235. (message "Exporting...")
  2236. (setq org-min-level (org-get-min-level lines))
  2237. (setq org-last-level org-min-level)
  2238. (org-init-section-numbers)
  2239. (cond
  2240. ((and date (string-match "%" date))
  2241. (setq date (format-time-string date)))
  2242. (date)
  2243. (t (setq date (format-time-string "%Y/%m/%d %X"))))
  2244. ;; Get the language-dependent settings
  2245. (setq lang-words (or (assoc language org-export-language-setup)
  2246. (assoc "en" org-export-language-setup)))
  2247. ;; Switch to the output buffer
  2248. (set-buffer buffer)
  2249. (let ((inhibit-read-only t)) (erase-buffer))
  2250. (fundamental-mode)
  2251. (and (fboundp 'set-buffer-file-coding-system)
  2252. (set-buffer-file-coding-system coding-system-for-write))
  2253. (let ((case-fold-search nil)
  2254. (org-odd-levels-only odd))
  2255. ;; create local variables for all options, to make sure all called
  2256. ;; functions get the correct information
  2257. (mapc (lambda (x)
  2258. (set (make-local-variable (cdr x))
  2259. (plist-get opt-plist (car x))))
  2260. org-export-plist-vars)
  2261. (setq umax (if arg (prefix-numeric-value arg)
  2262. org-export-headline-levels))
  2263. (setq umax-toc (if (integerp org-export-with-toc)
  2264. (min org-export-with-toc umax)
  2265. umax))
  2266. (unless body-only
  2267. ;; File header
  2268. (insert (format
  2269. "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
  2270. \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
  2271. <html xmlns=\"http://www.w3.org/1999/xhtml\"
  2272. lang=\"%s\" xml:lang=\"%s\">
  2273. <head>
  2274. <title>%s</title>
  2275. <meta http-equiv=\"Content-Type\" content=\"text/html;charset=%s\"/>
  2276. <meta name=\"generator\" content=\"Org-mode\"/>
  2277. <meta name=\"generated\" content=\"%s\"/>
  2278. <meta name=\"author\" content=\"%s\"/>
  2279. %s
  2280. </head><body>
  2281. "
  2282. language language (org-html-expand title)
  2283. (or charset "iso-8859-1") date author style))
  2284. (insert (or (plist-get opt-plist :preamble) ""))
  2285. (when (plist-get opt-plist :auto-preamble)
  2286. (if title (insert (format org-export-html-title-format
  2287. (org-html-expand title))))))
  2288. (if (and org-export-with-toc (not body-only))
  2289. (progn
  2290. (push (format "<h%d>%s</h%d>\n"
  2291. org-export-html-toplevel-hlevel
  2292. (nth 3 lang-words)
  2293. org-export-html-toplevel-hlevel)
  2294. thetoc)
  2295. (push "<div id=\"text-table-of-contents\">\n" thetoc)
  2296. (push "<ul>\n<li>" thetoc)
  2297. (setq lines
  2298. (mapcar '(lambda (line)
  2299. (if (string-match org-todo-line-regexp line)
  2300. ;; This is a headline
  2301. (progn
  2302. (setq have-headings t)
  2303. (setq level (- (match-end 1) (match-beginning 1))
  2304. level (org-tr-level level)
  2305. txt (save-match-data
  2306. (org-html-expand
  2307. (org-export-cleanup-toc-line
  2308. (match-string 3 line))))
  2309. todo
  2310. (or (and org-export-mark-todo-in-toc
  2311. (match-beginning 2)
  2312. (not (member (match-string 2 line)
  2313. org-done-keywords)))
  2314. ; TODO, not DONE
  2315. (and org-export-mark-todo-in-toc
  2316. (= level umax-toc)
  2317. (org-search-todo-below
  2318. line lines level))))
  2319. (if (string-match
  2320. (org-re "[ \t]+:\\([[:alnum:]_@:]+\\):[ \t]*$") txt)
  2321. (setq txt (replace-match "&nbsp;&nbsp;&nbsp;<span class=\"tag\"> \\1</span>" t nil txt)))
  2322. (if (string-match quote-re0 txt)
  2323. (setq txt (replace-match "" t t txt)))
  2324. (setq snumber (org-section-number level))
  2325. (if org-export-with-section-numbers
  2326. (setq txt (concat snumber " " txt)))
  2327. (if (<= level (max umax umax-toc))
  2328. (setq head-count (+ head-count 1)))
  2329. (if (<= level umax-toc)
  2330. (progn
  2331. (if (> level org-last-level)
  2332. (progn
  2333. (setq cnt (- level org-last-level))
  2334. (while (>= (setq cnt (1- cnt)) 0)
  2335. (push "\n<ul>\n<li>" thetoc))
  2336. (push "\n" thetoc)))
  2337. (if (< level org-last-level)
  2338. (progn
  2339. (setq cnt (- org-last-level level))
  2340. (while (>= (setq cnt (1- cnt)) 0)
  2341. (push "</li>\n</ul>" thetoc))
  2342. (push "\n" thetoc)))
  2343. ;; Check for targets
  2344. (while (string-match org-any-target-regexp line)
  2345. (setq line (replace-match
  2346. (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
  2347. t t line)))
  2348. (while (string-match "&lt;\\(&lt;\\)+\\|&gt;\\(&gt;\\)+" txt)
  2349. (setq txt (replace-match "" t t txt)))
  2350. (push
  2351. (format
  2352. (if todo
  2353. "</li>\n<li><a href=\"#sec-%s\"><span class=\"todo\">%s</span></a>"
  2354. "</li>\n<li><a href=\"#sec-%s\">%s</a>")
  2355. snumber txt) thetoc)
  2356. (setq org-last-level level))
  2357. )))
  2358. line)
  2359. lines))
  2360. (while (> org-last-level (1- org-min-level))
  2361. (setq org-last-level (1- org-last-level))
  2362. (push "</li>\n</ul>\n" thetoc))
  2363. (push "</div>\n" thetoc)
  2364. (setq thetoc (if have-headings (nreverse thetoc) nil))))
  2365. (setq head-count 0)
  2366. (org-init-section-numbers)
  2367. (while (setq line (pop lines) origline line)
  2368. (catch 'nextline
  2369. ;; end of quote section?
  2370. (when (and inquote (string-match "^\\*+ " line))
  2371. (insert "</pre>\n")
  2372. (setq inquote nil))
  2373. ;; inside a quote section?
  2374. (when inquote
  2375. (insert (org-html-protect line) "\n")
  2376. (throw 'nextline nil))
  2377. ;; verbatim lines
  2378. (when (and org-export-with-fixed-width
  2379. (string-match "^[ \t]*:\\(.*\\)" line))
  2380. (when (not infixed)
  2381. (setq infixed t)
  2382. (insert "<pre>\n"))
  2383. (insert (org-html-protect (match-string 1 line)) "\n")
  2384. (when (and lines
  2385. (not (string-match "^[ \t]*\\(:.*\\)"
  2386. (car lines))))
  2387. (setq infixed nil)
  2388. (insert "</pre>\n"))
  2389. (throw 'nextline nil))
  2390. ;; Protected HTML
  2391. (when (get-text-property 0 'org-protected line)
  2392. (let (par)
  2393. (when (re-search-backward
  2394. "\\(<p>\\)\\([ \t\r\n]*\\)\\=" (- (point) 100) t)
  2395. (setq par (match-string 1))
  2396. (replace-match "\\2\n"))
  2397. (insert line "\n")
  2398. (while (and lines
  2399. (not (string-match "^[ \t]*:" (car lines)))
  2400. (or (= (length (car lines)) 0)
  2401. (get-text-property 0 'org-protected (car lines))))
  2402. (insert (pop lines) "\n"))
  2403. (and par (insert "<p>\n")))
  2404. (throw 'nextline nil))
  2405. ;; Horizontal line
  2406. (when (string-match "^[ \t]*-\\{5,\\}[ \t]*$" line)
  2407. (insert "\n<hr/>\n")
  2408. (throw 'nextline nil))
  2409. ;; Blockquotes and verse
  2410. (when (equal "ORG-BLOCKQUOTE-START" line)
  2411. (insert "<blockquote>\n<p>\n")
  2412. (throw 'nextline nil))
  2413. (when (equal "ORG-BLOCKQUOTE-END" line)
  2414. (insert "</p>\n</blockquote>\n")
  2415. (throw 'nextline nil))
  2416. (when (equal "ORG-VERSE-START" line)
  2417. (insert "<verse>\n<p>\n")
  2418. (throw 'nextline nil))
  2419. (when (equal "ORG-VERSE-END" line)
  2420. (insert "</p>\n</verse>\n")
  2421. (throw 'nextline nil))
  2422. ;; make targets to anchors
  2423. (while (string-match "<<<?\\([^<>]*\\)>>>?\\((INVISIBLE)\\)?[ \t]*\n?" line)
  2424. (cond
  2425. ((match-end 2)
  2426. (setq line (replace-match
  2427. (concat "@<a name=\""
  2428. (org-solidify-link-text (match-string 1 line))
  2429. "\">\\nbsp@</a>")
  2430. t t line)))
  2431. ((and org-export-with-toc (equal (string-to-char line) ?*))
  2432. ;; FIXME: NOT DEPENDENT on TOC?????????????????????
  2433. (setq line (replace-match
  2434. (concat "@<span class=\"target\">" (match-string 1 line) "@</span> ")
  2435. ; (concat "@<i>" (match-string 1 line) "@</i> ")
  2436. t t line)))
  2437. (t
  2438. (setq line (replace-match
  2439. (concat "@<a name=\""
  2440. (org-solidify-link-text (match-string 1 line))
  2441. "\" class=\"target\">" (match-string 1 line) "@</a> ")
  2442. t t line)))))
  2443. (setq line (org-html-handle-time-stamps line))
  2444. ;; replace "&" by "&amp;", "<" and ">" by "&lt;" and "&gt;"
  2445. ;; handle @<..> HTML tags (replace "@&gt;..&lt;" by "<..>")
  2446. ;; Also handle sub_superscripts and checkboxes
  2447. (or (string-match org-table-hline-regexp line)
  2448. (setq line (org-html-expand line)))
  2449. ;; Format the links
  2450. (setq start 0)
  2451. (while (string-match org-bracket-link-analytic-regexp line start)
  2452. (setq start (match-beginning 0))
  2453. (setq type (if (match-end 2) (match-string 2 line) "internal"))
  2454. (setq path (match-string 3 line))
  2455. (setq desc1 (if (match-end 5) (match-string 5 line))
  2456. desc2 (if (match-end 2) (concat type ":" path) path)
  2457. descp (and desc1 (not (equal desc1 desc2)))
  2458. desc (or desc1 desc2))
  2459. ;; Make an image out of the description if that is so wanted
  2460. (when (and descp (org-file-image-p desc))
  2461. (save-match-data
  2462. (if (string-match "^file:" desc)
  2463. (setq desc (substring desc (match-end 0)))))
  2464. (setq desc (concat "<img src=\"" desc "\"/>")))
  2465. ;; FIXME: do we need to unescape here somewhere?
  2466. (cond
  2467. ((equal type "internal")
  2468. (setq rpl
  2469. (concat
  2470. "<a href=\"#"
  2471. (org-solidify-link-text
  2472. (save-match-data (org-link-unescape path)) nil)
  2473. "\">" desc "</a>")))
  2474. ((member type '("http" "https"))
  2475. ;; standard URL, just check if we need to inline an image
  2476. (if (and (or (eq t org-export-html-inline-images)
  2477. (and org-export-html-inline-images (not descp)))
  2478. (org-file-image-p path))
  2479. (setq rpl (concat "<img src=\"" type ":" path "\"/>"))
  2480. (setq link (concat type ":" path))
  2481. (setq rpl (concat "<a href=\"" link "\">" desc "</a>"))))
  2482. ((member type '("ftp" "mailto" "news"))
  2483. ;; standard URL
  2484. (setq link (concat type ":" path))
  2485. (setq rpl (concat "<a href=\"" link "\">" desc "</a>")))
  2486. ((string= type "file")
  2487. ;; FILE link
  2488. (let* ((filename path)
  2489. (abs-p (file-name-absolute-p filename))
  2490. thefile file-is-image-p search)
  2491. (save-match-data
  2492. (if (string-match "::\\(.*\\)" filename)
  2493. (setq search (match-string 1 filename)
  2494. filename (replace-match "" t nil filename)))
  2495. (setq valid
  2496. (if (functionp link-validate)
  2497. (funcall link-validate filename current-dir)
  2498. t))
  2499. (setq file-is-image-p (org-file-image-p filename))
  2500. (setq thefile (if abs-p (expand-file-name filename) filename))
  2501. (when (and org-export-html-link-org-files-as-html
  2502. (string-match "\\.org$" thefile))
  2503. (setq thefile (concat (substring thefile 0
  2504. (match-beginning 0))
  2505. "." html-extension))
  2506. (if (and search
  2507. ;; make sure this is can be used as target search
  2508. (not (string-match "^[0-9]*$" search))
  2509. (not (string-match "^\\*" search))
  2510. (not (string-match "^/.*/$" search)))
  2511. (setq thefile (concat thefile "#"
  2512. (org-solidify-link-text
  2513. (org-link-unescape search)))))
  2514. (when (string-match "^file:" desc)
  2515. (setq desc (replace-match "" t t desc))
  2516. (if (string-match "\\.org$" desc)
  2517. (setq desc (replace-match "" t t desc))))))
  2518. (setq rpl (if (and file-is-image-p
  2519. (or (eq t org-export-html-inline-images)
  2520. (and org-export-html-inline-images
  2521. (not descp))))
  2522. (concat "<img src=\"" thefile "\"/>")
  2523. (concat "<a href=\"" thefile "\">" desc "</a>")))
  2524. (if (not valid) (setq rpl desc))))
  2525. ((functionp (setq fnc (nth 2 (assoc type org-link-protocols))))
  2526. (setq rpl
  2527. (save-match-data
  2528. (funcall fnc (org-link-unescape path) desc1 'html))))
  2529. (t
  2530. ;; just publish the path, as default
  2531. (setq rpl (concat "<i>&lt;" type ":"
  2532. (save-match-data (org-link-unescape path))
  2533. "&gt;</i>"))))
  2534. (setq line (replace-match rpl t t line)
  2535. start (+ start (length rpl))))
  2536. ;; TODO items
  2537. (if (and (string-match org-todo-line-regexp line)
  2538. (match-beginning 2))
  2539. (setq line
  2540. (concat (substring line 0 (match-beginning 2))
  2541. "<span class=\""
  2542. (if (member (match-string 2 line)
  2543. org-done-keywords)
  2544. "done" "todo")
  2545. "\">" (match-string 2 line)
  2546. "</span>" (substring line (match-end 2)))))
  2547. ;; Does this contain a reference to a footnote?
  2548. (when org-export-with-footnotes
  2549. (setq start 0)
  2550. (while (string-match "\\([^* \t].*?\\)\\[\\([0-9]+\\)\\]" line start)
  2551. (if (get-text-property (match-beginning 2) 'org-protected line)
  2552. (setq start (match-end 2))
  2553. (let ((n (match-string 2 line)))
  2554. (setq line
  2555. (replace-match
  2556. (format
  2557. "%s<sup><a class=\"footref\" name=\"fnr.%s\" href=\"#fn.%s\">%s</a></sup>"
  2558. (match-string 1 line) n n n)
  2559. t t line))))))
  2560. (cond
  2561. ((string-match "^\\(\\*+\\)[ \t]+\\(.*\\)" line)
  2562. ;; This is a headline
  2563. (setq level (org-tr-level (- (match-end 1) (match-beginning 1)))
  2564. txt (match-string 2 line))
  2565. (if (string-match quote-re0 txt)
  2566. (setq txt (replace-match "" t t txt)))
  2567. (if (<= level (max umax umax-toc))
  2568. (setq head-count (+ head-count 1)))
  2569. (when in-local-list
  2570. ;; Close any local lists before inserting a new header line
  2571. (while local-list-type
  2572. (org-close-li (car local-list-type))
  2573. (insert (format "</%sl>\n" (car local-list-type)))
  2574. (pop local-list-type))
  2575. (setq local-list-indent nil
  2576. in-local-list nil))
  2577. (setq first-heading-pos (or first-heading-pos (point)))
  2578. (org-html-level-start level txt umax
  2579. (and org-export-with-toc (<= level umax))
  2580. head-count)
  2581. ;; QUOTES
  2582. (when (string-match quote-re line)
  2583. (insert "<pre>")
  2584. (setq inquote t)))
  2585. ((and org-export-with-tables
  2586. (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
  2587. (if (not table-open)
  2588. ;; New table starts
  2589. (setq table-open t table-buffer nil table-orig-buffer nil))
  2590. ;; Accumulate lines
  2591. (setq table-buffer (cons line table-buffer)
  2592. table-orig-buffer (cons origline table-orig-buffer))
  2593. (when (or (not lines)
  2594. (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
  2595. (car lines))))
  2596. (setq table-open nil
  2597. table-buffer (nreverse table-buffer)
  2598. table-orig-buffer (nreverse table-orig-buffer))
  2599. (org-close-par-maybe)
  2600. (insert (org-format-table-html table-buffer table-orig-buffer))))
  2601. (t
  2602. ;; Normal lines
  2603. (when (string-match
  2604. (cond
  2605. ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
  2606. ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
  2607. ((= llt ?\)) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+)\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
  2608. (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))
  2609. line)
  2610. (setq ind (org-get-string-indentation line)
  2611. item-type (if (match-beginning 4) "o" "u")
  2612. starter (if (match-beginning 2)
  2613. (substring (match-string 2 line) 0 -1))
  2614. line (substring line (match-beginning 5))
  2615. item-tag nil)
  2616. (if (and starter (string-match "\\(.*?\\) ::[ \t]*" line))
  2617. (setq item-type "d"
  2618. item-tag (match-string 1 line)
  2619. line (substring line (match-end 0))))
  2620. (when (and (not (equal item-type "d"))
  2621. (not (string-match "[^ \t]" line)))
  2622. ;; empty line. Pretend indentation is large.
  2623. (setq ind (if org-empty-line-terminates-plain-lists
  2624. 0
  2625. (1+ (or (car local-list-indent) 1)))))
  2626. (setq didclose nil)
  2627. (while (and in-local-list
  2628. (or (and (= ind (car local-list-indent))
  2629. (not starter))
  2630. (< ind (car local-list-indent))))
  2631. (setq didclose t)
  2632. (org-close-li (car local-list-type))
  2633. (insert (format "</%sl>\n" (car local-list-type)))
  2634. (pop local-list-type) (pop local-list-indent)
  2635. (setq in-local-list local-list-indent))
  2636. (cond
  2637. ((and starter
  2638. (or (not in-local-list)
  2639. (> ind (car local-list-indent))))
  2640. ;; Start new (level of) list
  2641. (org-close-par-maybe)
  2642. (insert (cond
  2643. ((equal item-type "u") "<ul>\n<li>\n")
  2644. ((equal item-type "o") "<ol>\n<li>\n")
  2645. ((equal item-type "d")
  2646. (format "<dl>\n<dt>%s</dt><dd>\n" item-tag))))
  2647. (push item-type local-list-type)
  2648. (push ind local-list-indent)
  2649. (setq in-local-list t))
  2650. (starter
  2651. ;; continue current list
  2652. (org-close-li (car local-list-type))
  2653. (insert (cond
  2654. ((equal (car local-list-type) "d")
  2655. (format "<dt>%s</dt><dd>\n" (or item-tag "???")))
  2656. (t "<li>\n"))))
  2657. (didclose
  2658. ;; we did close a list, normal text follows: need <p>
  2659. (org-open-par)))
  2660. (if (string-match "^[ \t]*\\[\\([X ]\\)\\]" line)
  2661. (setq line
  2662. (replace-match
  2663. (if (equal (match-string 1 line) "X")
  2664. "<b>[X]</b>"
  2665. "<b>[<span style=\"visibility:hidden;\">X</span>]</b>")
  2666. t t line))))
  2667. ;; Empty lines start a new paragraph. If hand-formatted lists
  2668. ;; are not fully interpreted, lines starting with "-", "+", "*"
  2669. ;; also start a new paragraph.
  2670. (if (string-match "^ [-+*]-\\|^[ \t]*$" line) (org-open-par))
  2671. ;; Is this the start of a footnote?
  2672. (when org-export-with-footnotes
  2673. (when (string-match "^[ \t]*\\[\\([0-9]+\\)\\]" line)
  2674. (org-close-par-maybe)
  2675. (let ((n (match-string 1 line)))
  2676. (setq line (replace-match
  2677. (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
  2678. ;; Check if the line break needs to be conserved
  2679. (cond
  2680. ((string-match "\\\\\\\\[ \t]*$" line)
  2681. (setq line (replace-match "<br/>" t t line)))
  2682. (org-export-preserve-breaks
  2683. (setq line (concat line "<br/>"))))
  2684. (insert line "\n")))))
  2685. ;; Properly close all local lists and other lists
  2686. (when inquote (insert "</pre>\n"))
  2687. (when in-local-list
  2688. ;; Close any local lists before inserting a new header line
  2689. (while local-list-type
  2690. (org-close-li (car local-list-type))
  2691. (insert (format "</%sl>\n" (car local-list-type)))
  2692. (pop local-list-type))
  2693. (setq local-list-indent nil
  2694. in-local-list nil))
  2695. (org-html-level-start 1 nil umax
  2696. (and org-export-with-toc (<= level umax))
  2697. head-count)
  2698. ;; the </div> to lose the last text-... div.
  2699. (insert "</div>\n")
  2700. (unless body-only
  2701. (when (plist-get opt-plist :auto-postamble)
  2702. (insert "<div id=\"postamble\">")
  2703. (when (and org-export-author-info author)
  2704. (insert "<p class=\"author\"> "
  2705. (nth 1 lang-words) ": " author "\n")
  2706. (when email
  2707. (if (listp (split-string email ",+ *"))
  2708. (mapc (lambda(e)
  2709. (insert "<a href=\"mailto:" e "\">&lt;"
  2710. e "&gt;</a>\n"))
  2711. (split-string email ",+ *"))
  2712. (insert "<a href=\"mailto:" email "\">&lt;"
  2713. email "&gt;</a>\n")))
  2714. (insert "</p>\n"))
  2715. (when (and date org-export-time-stamp-file)
  2716. (insert "<p class=\"date\"> "
  2717. (nth 2 lang-words) ": "
  2718. date "</p>\n"))
  2719. (insert "</div>"))
  2720. (if org-export-html-with-timestamp
  2721. (insert org-export-html-html-helper-timestamp))
  2722. (insert (or (plist-get opt-plist :postamble) ""))
  2723. (insert "</body>\n</html>\n"))
  2724. (normal-mode)
  2725. (if (eq major-mode default-major-mode) (html-mode))
  2726. ;; insert the table of contents
  2727. (goto-char (point-min))
  2728. (when thetoc
  2729. (if (or (re-search-forward
  2730. "<p>\\s-*\\[TABLE-OF-CONTENTS\\]\\s-*</p>" nil t)
  2731. (re-search-forward
  2732. "\\[TABLE-OF-CONTENTS\\]" nil t))
  2733. (progn
  2734. (goto-char (match-beginning 0))
  2735. (replace-match ""))
  2736. (goto-char first-heading-pos)
  2737. (when (looking-at "\\s-*</p>")
  2738. (goto-char (match-end 0))
  2739. (insert "\n")))
  2740. (insert "<div id=\"table-of-contents\">\n")
  2741. (mapc 'insert thetoc)
  2742. (insert "</div>\n"))
  2743. ;; remove empty paragraphs and lists
  2744. (goto-char (point-min))
  2745. (while (re-search-forward "<p>[ \r\n\t]*</p>" nil t)
  2746. (replace-match ""))
  2747. (goto-char (point-min))
  2748. (while (re-search-forward "<li>[ \r\n\t]*</li>\n?" nil t)
  2749. (replace-match ""))
  2750. (goto-char (point-min))
  2751. (while (re-search-forward "</ul>\\s-*<ul>\n?" nil t)
  2752. (replace-match ""))
  2753. ;; Convert whitespace place holders
  2754. (goto-char (point-min))
  2755. (let (beg end n)
  2756. (while (setq beg (next-single-property-change (point) 'org-whitespace))
  2757. (setq n (get-text-property beg 'org-whitespace)
  2758. end (next-single-property-change beg 'org-whitespace))
  2759. (goto-char beg)
  2760. (delete-region beg end)
  2761. (insert (format "<span style=\"visibility:hidden;\">%s</span>"
  2762. (make-string n ?x)))))
  2763. (or to-buffer (save-buffer))
  2764. (goto-char (point-min))
  2765. (message "Exporting... done")
  2766. (if (eq to-buffer 'string)
  2767. (prog1 (buffer-substring (point-min) (point-max))
  2768. (kill-buffer (current-buffer)))
  2769. (current-buffer)))))
  2770. (defvar org-table-colgroup-info nil)
  2771. (defun org-format-table-ascii (lines)
  2772. "Format a table for ascii export."
  2773. (if (stringp lines)
  2774. (setq lines (org-split-string lines "\n")))
  2775. (if (not (string-match "^[ \t]*|" (car lines)))
  2776. ;; Table made by table.el - test for spanning
  2777. lines
  2778. ;; A normal org table
  2779. ;; Get rid of hlines at beginning and end
  2780. (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  2781. (setq lines (nreverse lines))
  2782. (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  2783. (setq lines (nreverse lines))
  2784. (when org-export-table-remove-special-lines
  2785. ;; Check if the table has a marking column. If yes remove the
  2786. ;; column and the special lines
  2787. (setq lines (org-table-clean-before-export lines)))
  2788. ;; Get rid of the vertical lines except for grouping
  2789. (let ((vl (org-colgroup-info-to-vline-list org-table-colgroup-info))
  2790. rtn line vl1 start)
  2791. (while (setq line (pop lines))
  2792. (if (string-match org-table-hline-regexp line)
  2793. (and (string-match "|\\(.*\\)|" line)
  2794. (setq line (replace-match " \\1" t nil line)))
  2795. (setq start 0 vl1 vl)
  2796. (while (string-match "|" line start)
  2797. (setq start (match-end 0))
  2798. (or (pop vl1) (setq line (replace-match " " t t line)))))
  2799. (push line rtn))
  2800. (nreverse rtn))))
  2801. (defun org-colgroup-info-to-vline-list (info)
  2802. (let (vl new last)
  2803. (while info
  2804. (setq last new new (pop info))
  2805. (if (or (memq last '(:end :startend))
  2806. (memq new '(:start :startend)))
  2807. (push t vl)
  2808. (push nil vl)))
  2809. (setq vl (nreverse vl))
  2810. (and vl (setcar vl nil))
  2811. vl))
  2812. (defvar org-table-number-regexp) ; defined in org-table.el
  2813. (defun org-format-table-html (lines olines)
  2814. "Find out which HTML converter to use and return the HTML code."
  2815. (if (stringp lines)
  2816. (setq lines (org-split-string lines "\n")))
  2817. (if (string-match "^[ \t]*|" (car lines))
  2818. ;; A normal org table
  2819. (org-format-org-table-html lines)
  2820. ;; Table made by table.el - test for spanning
  2821. (let* ((hlines (delq nil (mapcar
  2822. (lambda (x)
  2823. (if (string-match "^[ \t]*\\+-" x) x
  2824. nil))
  2825. lines)))
  2826. (first (car hlines))
  2827. (ll (and (string-match "\\S-+" first)
  2828. (match-string 0 first)))
  2829. (re (concat "^[ \t]*" (regexp-quote ll)))
  2830. (spanning (delq nil (mapcar (lambda (x) (not (string-match re x)))
  2831. hlines))))
  2832. (if (and (not spanning)
  2833. (not org-export-prefer-native-exporter-for-tables))
  2834. ;; We can use my own converter with HTML conversions
  2835. (org-format-table-table-html lines)
  2836. ;; Need to use the code generator in table.el, with the original text.
  2837. (org-format-table-table-html-using-table-generate-source olines)))))
  2838. (defvar org-table-number-fraction) ; defined in org-table.el
  2839. (defun org-format-org-table-html (lines &optional splice)
  2840. "Format a table into HTML."
  2841. (require 'org-table)
  2842. ;; Get rid of hlines at beginning and end
  2843. (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  2844. (setq lines (nreverse lines))
  2845. (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  2846. (setq lines (nreverse lines))
  2847. (when org-export-table-remove-special-lines
  2848. ;; Check if the table has a marking column. If yes remove the
  2849. ;; column and the special lines
  2850. (setq lines (org-table-clean-before-export lines)))
  2851. (let ((head (and org-export-highlight-first-table-line
  2852. (delq nil (mapcar
  2853. (lambda (x) (string-match "^[ \t]*|-" x))
  2854. (cdr lines)))))
  2855. (nlines 0) fnum i
  2856. tbopen line fields html gr colgropen)
  2857. (if splice (setq head nil))
  2858. (unless splice (push (if head "<thead>" "<tbody>") html))
  2859. (setq tbopen t)
  2860. (while (setq line (pop lines))
  2861. (catch 'next-line
  2862. (if (string-match "^[ \t]*|-" line)
  2863. (progn
  2864. (unless splice
  2865. (push (if head "</thead>" "</tbody>") html)
  2866. (if lines (push "<tbody>" html) (setq tbopen nil)))
  2867. (setq head nil) ;; head ends here, first time around
  2868. ;; ignore this line
  2869. (throw 'next-line t)))
  2870. ;; Break the line into fields
  2871. (setq fields (org-split-string line "[ \t]*|[ \t]*"))
  2872. (unless fnum (setq fnum (make-vector (length fields) 0)))
  2873. (setq nlines (1+ nlines) i -1)
  2874. (push (concat "<tr>"
  2875. (mapconcat
  2876. (lambda (x)
  2877. (setq i (1+ i))
  2878. (if (and (< i nlines)
  2879. (string-match org-table-number-regexp x))
  2880. (incf (aref fnum i)))
  2881. (if head
  2882. (concat (car org-export-table-header-tags) x
  2883. (cdr org-export-table-header-tags))
  2884. (concat (car org-export-table-data-tags) x
  2885. (cdr org-export-table-data-tags))))
  2886. fields "")
  2887. "</tr>")
  2888. html)))
  2889. (unless splice (if tbopen (push "</tbody>" html)))
  2890. (unless splice (push "</table>\n" html))
  2891. (setq html (nreverse html))
  2892. (unless splice
  2893. ;; Put in col tags with the alignment (unfortuntely often ignored...)
  2894. (push (mapconcat
  2895. (lambda (x)
  2896. (setq gr (pop org-table-colgroup-info))
  2897. (format "%s<col align=\"%s\"></col>%s"
  2898. (if (memq gr '(:start :startend))
  2899. (prog1
  2900. (if colgropen "</colgroup>\n<colgroup>" "<colgroup>")
  2901. (setq colgropen t))
  2902. "")
  2903. (if (> (/ (float x) nlines) org-table-number-fraction)
  2904. "right" "left")
  2905. (if (memq gr '(:end :startend))
  2906. (progn (setq colgropen nil) "</colgroup>")
  2907. "")))
  2908. fnum "")
  2909. html)
  2910. (if colgropen (setq html (cons (car html) (cons "</colgroup>" (cdr html)))))
  2911. (push html-table-tag html))
  2912. (concat (mapconcat 'identity html "\n") "\n")))
  2913. (defun org-table-clean-before-export (lines)
  2914. "Check if the table has a marking column.
  2915. If yes remove the column and the special lines."
  2916. (setq org-table-colgroup-info nil)
  2917. (if (memq nil
  2918. (mapcar
  2919. (lambda (x) (or (string-match "^[ \t]*|-" x)
  2920. (string-match "^[ \t]*| *\\([#!$*_^ /]\\) *|" x)))
  2921. lines))
  2922. (progn
  2923. (setq org-table-clean-did-remove-column nil)
  2924. (delq nil
  2925. (mapcar
  2926. (lambda (x)
  2927. (cond
  2928. ((string-match "^[ \t]*| */ *|" x)
  2929. (setq org-table-colgroup-info
  2930. (mapcar (lambda (x)
  2931. (cond ((member x '("<" "&lt;")) :start)
  2932. ((member x '(">" "&gt;")) :end)
  2933. ((member x '("<>" "&lt;&gt;")) :startend)
  2934. (t nil)))
  2935. (org-split-string x "[ \t]*|[ \t]*")))
  2936. nil)
  2937. (t x)))
  2938. lines)))
  2939. (setq org-table-clean-did-remove-column t)
  2940. (delq nil
  2941. (mapcar
  2942. (lambda (x)
  2943. (cond
  2944. ((string-match "^[ \t]*| */ *|" x)
  2945. (setq org-table-colgroup-info
  2946. (mapcar (lambda (x)
  2947. (cond ((member x '("<" "&lt;")) :start)
  2948. ((member x '(">" "&gt;")) :end)
  2949. ((member x '("<>" "&lt;&gt;")) :startend)
  2950. (t nil)))
  2951. (cdr (org-split-string x "[ \t]*|[ \t]*"))))
  2952. nil)
  2953. ((string-match "^[ \t]*| *[!_^/] *|" x)
  2954. nil) ; ignore this line
  2955. ((or (string-match "^\\([ \t]*\\)|-+\\+" x)
  2956. (string-match "^\\([ \t]*\\)|[^|]*|" x))
  2957. ;; remove the first column
  2958. (replace-match "\\1|" t nil x))))
  2959. lines))))
  2960. (defun org-format-table-table-html (lines)
  2961. "Format a table generated by table.el into HTML.
  2962. This conversion does *not* use `table-generate-source' from table.el.
  2963. This has the advantage that Org-mode's HTML conversions can be used.
  2964. But it has the disadvantage, that no cell- or row-spanning is allowed."
  2965. (let (line field-buffer
  2966. (head org-export-highlight-first-table-line)
  2967. fields html empty)
  2968. (setq html (concat html-table-tag "\n"))
  2969. (while (setq line (pop lines))
  2970. (setq empty "&nbsp;")
  2971. (catch 'next-line
  2972. (if (string-match "^[ \t]*\\+-" line)
  2973. (progn
  2974. (if field-buffer
  2975. (progn
  2976. (setq
  2977. html
  2978. (concat
  2979. html
  2980. "<tr>"
  2981. (mapconcat
  2982. (lambda (x)
  2983. (if (equal x "") (setq x empty))
  2984. (if head
  2985. (concat (car org-export-table-header-tags) x
  2986. (cdr org-export-table-header-tags))
  2987. (concat (car org-export-table-data-tags) x
  2988. (cdr org-export-table-data-tags))))
  2989. field-buffer "\n")
  2990. "</tr>\n"))
  2991. (setq head nil)
  2992. (setq field-buffer nil)))
  2993. ;; Ignore this line
  2994. (throw 'next-line t)))
  2995. ;; Break the line into fields and store the fields
  2996. (setq fields (org-split-string line "[ \t]*|[ \t]*"))
  2997. (if field-buffer
  2998. (setq field-buffer (mapcar
  2999. (lambda (x)
  3000. (concat x "<br/>" (pop fields)))
  3001. field-buffer))
  3002. (setq field-buffer fields))))
  3003. (setq html (concat html "</table>\n"))
  3004. html))
  3005. (defun org-format-table-table-html-using-table-generate-source (lines)
  3006. "Format a table into html, using `table-generate-source' from table.el.
  3007. This has the advantage that cell- or row-spanning is allowed.
  3008. But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
  3009. (require 'table)
  3010. (with-current-buffer (get-buffer-create " org-tmp1 ")
  3011. (erase-buffer)
  3012. (insert (mapconcat 'identity lines "\n"))
  3013. (goto-char (point-min))
  3014. (if (not (re-search-forward "|[^+]" nil t))
  3015. (error "Error processing table"))
  3016. (table-recognize-table)
  3017. (with-current-buffer (get-buffer-create " org-tmp2 ") (erase-buffer))
  3018. (table-generate-source 'html " org-tmp2 ")
  3019. (set-buffer " org-tmp2 ")
  3020. (buffer-substring (point-min) (point-max))))
  3021. (defun org-html-handle-time-stamps (s)
  3022. "Format time stamps in string S, or remove them."
  3023. (catch 'exit
  3024. (let (r b)
  3025. (while (string-match org-maybe-keyword-time-regexp s)
  3026. (if (and (match-end 1) (equal (match-string 1 s) org-clock-string))
  3027. ;; never export CLOCK
  3028. (throw 'exit ""))
  3029. (or b (setq b (substring s 0 (match-beginning 0))))
  3030. (if (not org-export-with-timestamps)
  3031. (setq r (concat r (substring s 0 (match-beginning 0)))
  3032. s (substring s (match-end 0)))
  3033. (setq r (concat
  3034. r (substring s 0 (match-beginning 0))
  3035. (if (match-end 1)
  3036. (format "@<span class=\"timestamp-kwd\">%s @</span>"
  3037. (match-string 1 s)))
  3038. (format " @<span class=\"timestamp\">%s@</span>"
  3039. (substring
  3040. (org-translate-time (match-string 3 s)) 1 -1)))
  3041. s (substring s (match-end 0)))))
  3042. ;; Line break if line started and ended with time stamp stuff
  3043. (if (not r)
  3044. s
  3045. (setq r (concat r s))
  3046. (unless (string-match "\\S-" (concat b s))
  3047. (setq r (concat r "@<br/>")))
  3048. r))))
  3049. (defun org-export-htmlize-region-for-paste (beg end)
  3050. "Convert the region to HTML, using htmlize.el.
  3051. This is much like `htmlize-region-for-paste', only that it uses
  3052. the settings define in the org-... variables."
  3053. (let* ((htmlize-output-type org-export-htmlize-output-type)
  3054. (htmlize-css-name-prefix org-export-htmlize-css-font-prefix)
  3055. (htmlbuf (htmlize-region beg end)))
  3056. (unwind-protect
  3057. (with-current-buffer htmlbuf
  3058. (buffer-substring (plist-get htmlize-buffer-places 'content-start)
  3059. (plist-get htmlize-buffer-places 'content-end)))
  3060. (kill-buffer htmlbuf))))
  3061. ;;;###autoload
  3062. (defun org-export-htmlize-generate-css ()
  3063. "Create the CSS for all font definitions in the current Emacs session.
  3064. Use this to create face definitions in your CSS style file that can then
  3065. be used by code snippets transformed by htmlize.
  3066. This command just produces a buffer that contains class definitions for all
  3067. faces used in the current Emacs session. You can copy and paste the ones you
  3068. need into your CSS file.
  3069. If you then set `org-export-htmlize-output-type' to `css', calls to
  3070. the function `org-export-htmlize-region-for-paste' will produce code
  3071. that uses these same face definitions."
  3072. (interactive)
  3073. (require 'htmlize)
  3074. (and (get-buffer "*html*") (kill-buffer "*html*"))
  3075. (with-temp-buffer
  3076. (let ((fl (face-list))
  3077. (htmlize-css-name-prefix "org-")
  3078. (htmlize-output-type 'css)
  3079. f i)
  3080. (while (setq f (pop fl)
  3081. i (and f (face-attribute f :inherit)))
  3082. (when (and (symbolp f) (or (not i) (not (listp i))))
  3083. (insert (org-add-props (copy-sequence "1") nil 'face f))))
  3084. (htmlize-region (point-min) (point-max))))
  3085. (switch-to-buffer "*html*")
  3086. (goto-char (point-min))
  3087. (if (re-search-forward "<style" nil t)
  3088. (delete-region (point-min) (match-beginning 0)))
  3089. (if (re-search-forward "</style>" nil t)
  3090. (delete-region (1+ (match-end 0)) (point-max)))
  3091. (beginning-of-line 1)
  3092. (if (looking-at " +") (replace-match ""))
  3093. (goto-char (point-min)))
  3094. (defun org-html-protect (s)
  3095. ;; convert & to &amp;, < to &lt; and > to &gt;
  3096. (let ((start 0))
  3097. (while (string-match "&" s start)
  3098. (setq s (replace-match "&amp;" t t s)
  3099. start (1+ (match-beginning 0))))
  3100. (while (string-match "<" s)
  3101. (setq s (replace-match "&lt;" t t s)))
  3102. (while (string-match ">" s)
  3103. (setq s (replace-match "&gt;" t t s))))
  3104. s)
  3105. (defun org-export-cleanup-toc-line (s)
  3106. "Remove tags and time staps from lines going into the toc."
  3107. (when (memq org-export-with-tags '(not-in-toc nil))
  3108. (if (string-match (org-re " +:[[:alnum:]_@:]+: *$") s)
  3109. (setq s (replace-match "" t t s))))
  3110. (when org-export-remove-timestamps-from-toc
  3111. (while (string-match org-maybe-keyword-time-regexp s)
  3112. (setq s (replace-match "" t t s))))
  3113. (while (string-match org-bracket-link-regexp s)
  3114. (setq s (replace-match (match-string (if (match-end 3) 3 1) s)
  3115. t t s)))
  3116. s)
  3117. (defun org-html-expand (string)
  3118. "Prepare STRING for HTML export. Applies all active conversions.
  3119. If there are links in the string, don't modify these."
  3120. (let* ((re (concat org-bracket-link-regexp "\\|"
  3121. (org-re "[ \t]+\\(:[[:alnum:]_@:]+:\\)[ \t]*$")))
  3122. m s l res)
  3123. (while (setq m (string-match re string))
  3124. (setq s (substring string 0 m)
  3125. l (match-string 0 string)
  3126. string (substring string (match-end 0)))
  3127. (push (org-html-do-expand s) res)
  3128. (push l res))
  3129. (push (org-html-do-expand string) res)
  3130. (apply 'concat (nreverse res))))
  3131. (defun org-html-do-expand (s)
  3132. "Apply all active conversions to translate special ASCII to HTML."
  3133. (setq s (org-html-protect s))
  3134. (if org-export-html-expand
  3135. (let ((start 0))
  3136. (while (string-match "@&lt;\\([^&]*\\)&gt;" s)
  3137. (setq s (replace-match "<\\1>" t nil s)))))
  3138. (if org-export-with-emphasize
  3139. (setq s (org-export-html-convert-emphasize s)))
  3140. (if org-export-with-special-strings
  3141. (setq s (org-export-html-convert-special-strings s)))
  3142. (if org-export-with-sub-superscripts
  3143. (setq s (org-export-html-convert-sub-super s)))
  3144. (if org-export-with-TeX-macros
  3145. (let ((start 0) wd ass)
  3146. (while (setq start (string-match "\\\\\\([a-zA-Z]+\\)" s start))
  3147. (if (get-text-property (match-beginning 0) 'org-protected s)
  3148. (setq start (match-end 0))
  3149. (setq wd (match-string 1 s))
  3150. (if (setq ass (assoc wd org-html-entities))
  3151. (setq s (replace-match (or (cdr ass)
  3152. (concat "&" (car ass) ";"))
  3153. t t s))
  3154. (setq start (+ start (length wd))))))))
  3155. s)
  3156. (defun org-create-multibrace-regexp (left right n)
  3157. "Create a regular expression which will match a balanced sexp.
  3158. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  3159. as single character strings.
  3160. The regexp returned will match the entire expression including the
  3161. delimiters. It will also define a single group which contains the
  3162. match except for the outermost delimiters. The maximum depth of
  3163. stacked delimiters is N. Escaping delimiters is not possible."
  3164. (let* ((nothing (concat "[^" "\\" left "\\" right "]*?"))
  3165. (or "\\|")
  3166. (re nothing)
  3167. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  3168. (while (> n 1)
  3169. (setq n (1- n)
  3170. re (concat re or next)
  3171. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  3172. (concat left "\\(" re "\\)" right)))
  3173. (defvar org-match-substring-regexp
  3174. (concat
  3175. "\\([^\\]\\)\\([_^]\\)\\("
  3176. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  3177. "\\|"
  3178. "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  3179. "\\|"
  3180. "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
  3181. "The regular expression matching a sub- or superscript.")
  3182. (defvar org-match-substring-with-braces-regexp
  3183. (concat
  3184. "\\([^\\]\\)\\([_^]\\)\\("
  3185. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  3186. "\\)")
  3187. "The regular expression matching a sub- or superscript, forcing braces.")
  3188. (defconst org-export-html-special-string-regexps
  3189. '(("\\\\-" . "&shy;")
  3190. ("---\\([^-]\\)" . "&mdash;\\1")
  3191. ("--\\([^-]\\)" . "&ndash;\\1")
  3192. ("\\.\\.\\." . "&hellip;"))
  3193. "Regular expressions for special string conversion.")
  3194. (defun org-export-html-convert-special-strings (string)
  3195. "Convert special characters in STRING to HTML."
  3196. (let ((all org-export-html-special-string-regexps)
  3197. e a re rpl start)
  3198. (while (setq a (pop all))
  3199. (setq re (car a) rpl (cdr a) start 0)
  3200. (while (string-match re string start)
  3201. (if (get-text-property (match-beginning 0) 'org-protected string)
  3202. (setq start (match-end 0))
  3203. (setq string (replace-match rpl t nil string)))))
  3204. string))
  3205. (defun org-export-html-convert-sub-super (string)
  3206. "Convert sub- and superscripts in STRING to HTML."
  3207. (let (key c (s 0) (requireb (eq org-export-with-sub-superscripts '{})))
  3208. (while (string-match org-match-substring-regexp string s)
  3209. (cond
  3210. ((and requireb (match-end 8)) (setq s (match-end 2)))
  3211. ((get-text-property (match-beginning 2) 'org-protected string)
  3212. (setq s (match-end 2)))
  3213. (t
  3214. (setq s (match-end 1)
  3215. key (if (string= (match-string 2 string) "_") "sub" "sup")
  3216. c (or (match-string 8 string)
  3217. (match-string 6 string)
  3218. (match-string 5 string))
  3219. string (replace-match
  3220. (concat (match-string 1 string)
  3221. "<" key ">" c "</" key ">")
  3222. t t string)))))
  3223. (while (string-match "\\\\\\([_^]\\)" string)
  3224. (setq string (replace-match (match-string 1 string) t t string)))
  3225. string))
  3226. (defun org-export-html-convert-emphasize (string)
  3227. "Apply emphasis."
  3228. (let ((s 0) rpl)
  3229. (while (string-match org-emph-re string s)
  3230. (if (not (equal
  3231. (substring string (match-beginning 3) (1+ (match-beginning 3)))
  3232. (substring string (match-beginning 4) (1+ (match-beginning 4)))))
  3233. (setq s (match-beginning 0)
  3234. rpl
  3235. (concat
  3236. (match-string 1 string)
  3237. (nth 2 (assoc (match-string 3 string) org-emphasis-alist))
  3238. (match-string 4 string)
  3239. (nth 3 (assoc (match-string 3 string)
  3240. org-emphasis-alist))
  3241. (match-string 5 string))
  3242. string (replace-match rpl t t string)
  3243. s (+ s (- (length rpl) 2)))
  3244. (setq s (1+ s))))
  3245. string))
  3246. (defvar org-par-open nil)
  3247. (defun org-open-par ()
  3248. "Insert <p>, but first close previous paragraph if any."
  3249. (org-close-par-maybe)
  3250. (insert "\n<p>")
  3251. (setq org-par-open t))
  3252. (defun org-close-par-maybe ()
  3253. "Close paragraph if there is one open."
  3254. (when org-par-open
  3255. (insert "</p>")
  3256. (setq org-par-open nil)))
  3257. (defun org-close-li (&optional type)
  3258. "Close <li> if necessary."
  3259. (org-close-par-maybe)
  3260. (insert (if (equal type "d") "</dd>\n" "</li>\n")))
  3261. (defvar body-only) ; dynamically scoped into this.
  3262. (defun org-html-level-start (level title umax with-toc head-count)
  3263. "Insert a new level in HTML export.
  3264. When TITLE is nil, just close all open levels."
  3265. (org-close-par-maybe)
  3266. (let ((target (and title (org-get-text-property-any 0 'target title)))
  3267. (l org-level-max)
  3268. snumber)
  3269. (while (>= l level)
  3270. (if (aref org-levels-open (1- l))
  3271. (progn
  3272. (org-html-level-close l umax)
  3273. (aset org-levels-open (1- l) nil)))
  3274. (setq l (1- l)))
  3275. (when title
  3276. ;; If title is nil, this means this function is called to close
  3277. ;; all levels, so the rest is done only if title is given
  3278. (when (string-match (org-re "\\(:[[:alnum:]_@:]+:\\)[ \t]*$") title)
  3279. (setq title (replace-match
  3280. (if org-export-with-tags
  3281. (save-match-data
  3282. (concat
  3283. "&nbsp;&nbsp;&nbsp;<span class=\"tag\">"
  3284. (mapconcat 'identity (org-split-string
  3285. (match-string 1 title) ":")
  3286. "&nbsp;")
  3287. "</span>"))
  3288. "")
  3289. t t title)))
  3290. (if (> level umax)
  3291. (progn
  3292. (if (aref org-levels-open (1- level))
  3293. (progn
  3294. (org-close-li)
  3295. (if target
  3296. (insert (format "<li id=\"%s\">" target) title "<br/>\n")
  3297. (insert "<li>" title "<br/>\n")))
  3298. (aset org-levels-open (1- level) t)
  3299. (org-close-par-maybe)
  3300. (if target
  3301. (insert (format "<ul>\n<li id=\"%s\">" target)
  3302. title "<br/>\n")
  3303. (insert "<ul>\n<li>" title "<br/>\n"))))
  3304. (aset org-levels-open (1- level) t)
  3305. (setq snumber (org-section-number level))
  3306. (if (and org-export-with-section-numbers (not body-only))
  3307. (setq title (concat snumber " " title)))
  3308. (setq level (+ level org-export-html-toplevel-hlevel -1))
  3309. (unless (= head-count 1) (insert "\n</div>\n"))
  3310. (insert (format "\n<div id=\"outline-container-%s\" class=\"outline-%d\">\n<h%d id=\"sec-%s\">%s</h%d>\n<div id=\"text-%s\">\n"
  3311. snumber level level snumber title level snumber))
  3312. (org-open-par)))))
  3313. (defun org-get-text-property-any (pos prop &optional object)
  3314. (or (get-text-property pos prop object)
  3315. (and (setq pos (next-single-property-change pos prop object))
  3316. (get-text-property pos prop object))))
  3317. (defun org-html-level-close (level max-outline-level)
  3318. "Terminate one level in HTML export."
  3319. (if (<= level max-outline-level)
  3320. (insert "</div>\n")
  3321. (org-close-li)
  3322. (insert "</ul>\n")))
  3323. ;;; iCalendar export
  3324. ;;;###autoload
  3325. (defun org-export-icalendar-this-file ()
  3326. "Export current file as an iCalendar file.
  3327. The iCalendar file will be located in the same directory as the Org-mode
  3328. file, but with extension `.ics'."
  3329. (interactive)
  3330. (org-export-icalendar nil buffer-file-name))
  3331. ;;;###autoload
  3332. (defun org-export-icalendar-all-agenda-files ()
  3333. "Export all files in `org-agenda-files' to iCalendar .ics files.
  3334. Each iCalendar file will be located in the same directory as the Org-mode
  3335. file, but with extension `.ics'."
  3336. (interactive)
  3337. (apply 'org-export-icalendar nil (org-agenda-files t)))
  3338. ;;;###autoload
  3339. (defun org-export-icalendar-combine-agenda-files ()
  3340. "Export all files in `org-agenda-files' to a single combined iCalendar file.
  3341. The file is stored under the name `org-combined-agenda-icalendar-file'."
  3342. (interactive)
  3343. (apply 'org-export-icalendar t (org-agenda-files t)))
  3344. (defun org-export-icalendar (combine &rest files)
  3345. "Create iCalendar files for all elements of FILES.
  3346. If COMBINE is non-nil, combine all calendar entries into a single large
  3347. file and store it under the name `org-combined-agenda-icalendar-file'."
  3348. (save-excursion
  3349. (org-prepare-agenda-buffers files)
  3350. (let* ((dir (org-export-directory
  3351. :ical (list :publishing-directory
  3352. org-export-publishing-directory)))
  3353. file ical-file ical-buffer category started org-agenda-new-buffers)
  3354. (and (get-buffer "*ical-tmp*") (kill-buffer "*ical-tmp*"))
  3355. (when combine
  3356. (setq ical-file
  3357. (if (file-name-absolute-p org-combined-agenda-icalendar-file)
  3358. org-combined-agenda-icalendar-file
  3359. (expand-file-name org-combined-agenda-icalendar-file dir))
  3360. ical-buffer (org-get-agenda-file-buffer ical-file))
  3361. (set-buffer ical-buffer) (erase-buffer))
  3362. (while (setq file (pop files))
  3363. (catch 'nextfile
  3364. (org-check-agenda-file file)
  3365. (set-buffer (org-get-agenda-file-buffer file))
  3366. (unless combine
  3367. (setq ical-file (concat (file-name-as-directory dir)
  3368. (file-name-sans-extension
  3369. (file-name-nondirectory buffer-file-name))
  3370. ".ics"))
  3371. (setq ical-buffer (org-get-agenda-file-buffer ical-file))
  3372. (with-current-buffer ical-buffer (erase-buffer)))
  3373. (setq category (or org-category
  3374. (file-name-sans-extension
  3375. (file-name-nondirectory buffer-file-name))))
  3376. (if (symbolp category) (setq category (symbol-name category)))
  3377. (let ((standard-output ical-buffer))
  3378. (if combine
  3379. (and (not started) (setq started t)
  3380. (org-start-icalendar-file org-icalendar-combined-name))
  3381. (org-start-icalendar-file category))
  3382. (org-print-icalendar-entries combine)
  3383. (when (or (and combine (not files)) (not combine))
  3384. (org-finish-icalendar-file)
  3385. (set-buffer ical-buffer)
  3386. (save-buffer)
  3387. (run-hooks 'org-after-save-iCalendar-file-hook)
  3388. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
  3389. ))))
  3390. (org-release-buffers org-agenda-new-buffers))))
  3391. (defvar org-after-save-iCalendar-file-hook nil
  3392. "Hook run after an iCalendar file has been saved.
  3393. The iCalendar buffer is still current when this hook is run.
  3394. A good way to use this is to tell a desktop calenndar application to re-read
  3395. the iCalendar file.")
  3396. (defvar org-agenda-default-appointment-duration) ; defined in org-agenda.el
  3397. (defun org-print-icalendar-entries (&optional combine)
  3398. "Print iCalendar entries for the current Org-mode file to `standard-output'.
  3399. When COMBINE is non nil, add the category to each line."
  3400. (require 'org-agenda)
  3401. (let ((re1 (concat org-ts-regexp "\\|<%%([^>\n]+>"))
  3402. (re2 (concat "--?-?\\(" org-ts-regexp "\\)"))
  3403. (dts (org-ical-ts-to-string
  3404. (format-time-string (cdr org-time-stamp-formats) (current-time))
  3405. "DTSTART"))
  3406. hd ts ts2 state status (inc t) pos b sexp rrule
  3407. scheduledp deadlinep tmp pri category entry location summary desc
  3408. (sexp-buffer (get-buffer-create "*ical-tmp*")))
  3409. (org-refresh-category-properties)
  3410. (save-excursion
  3411. (goto-char (point-min))
  3412. (while (re-search-forward re1 nil t)
  3413. (catch :skip
  3414. (org-agenda-skip)
  3415. (when (boundp 'org-icalendar-verify-function)
  3416. (unless (funcall org-icalendar-verify-function)
  3417. (outline-next-heading)
  3418. (backward-char 1)
  3419. (throw :skip nil)))
  3420. (setq pos (match-beginning 0)
  3421. ts (match-string 0)
  3422. inc t
  3423. hd (condition-case nil
  3424. (org-icalendar-cleanup-string
  3425. (org-get-heading))
  3426. (error (throw :skip nil)))
  3427. summary (org-icalendar-cleanup-string
  3428. (org-entry-get nil "SUMMARY"))
  3429. desc (org-icalendar-cleanup-string
  3430. (or (org-entry-get nil "DESCRIPTION")
  3431. (and org-icalendar-include-body (org-get-entry)))
  3432. t org-icalendar-include-body)
  3433. location (org-icalendar-cleanup-string
  3434. (org-entry-get nil "LOCATION"))
  3435. category (org-get-category))
  3436. (if (looking-at re2)
  3437. (progn
  3438. (goto-char (match-end 0))
  3439. (setq ts2 (match-string 1)
  3440. inc (not (string-match "[0-9]\\{1,2\\}:[0-9][0-9]" ts2))))
  3441. (setq tmp (buffer-substring (max (point-min)
  3442. (- pos org-ds-keyword-length))
  3443. pos)
  3444. ts2 (if (string-match "[0-9]\\{1,2\\}:[0-9][0-9]-\\([0-9]\\{1,2\\}:[0-9][0-9]\\)" ts)
  3445. (progn
  3446. (setq inc nil)
  3447. (replace-match "\\1" t nil ts))
  3448. ts)
  3449. deadlinep (string-match org-deadline-regexp tmp)
  3450. scheduledp (string-match org-scheduled-regexp tmp)
  3451. ;; donep (org-entry-is-done-p)
  3452. ))
  3453. (if (or (string-match org-tr-regexp hd)
  3454. (string-match org-ts-regexp hd))
  3455. (setq hd (replace-match "" t t hd)))
  3456. (if (string-match "\\+\\([0-9]+\\)\\([dwmy]\\)>" ts)
  3457. (setq rrule
  3458. (concat "\nRRULE:FREQ="
  3459. (cdr (assoc
  3460. (match-string 2 ts)
  3461. '(("d" . "DAILY")("w" . "WEEKLY")
  3462. ("m" . "MONTHLY")("y" . "YEARLY"))))
  3463. ";INTERVAL=" (match-string 1 ts)))
  3464. (setq rrule ""))
  3465. (setq summary (or summary hd))
  3466. (if (string-match org-bracket-link-regexp summary)
  3467. (setq summary
  3468. (replace-match (if (match-end 3)
  3469. (match-string 3 summary)
  3470. (match-string 1 summary))
  3471. t t summary)))
  3472. (if deadlinep (setq summary (concat "DL: " summary)))
  3473. (if scheduledp (setq summary (concat "S: " summary)))
  3474. (if (string-match "\\`<%%" ts)
  3475. (with-current-buffer sexp-buffer
  3476. (insert (substring ts 1 -1) " " summary "\n"))
  3477. (princ (format "BEGIN:VEVENT
  3478. %s
  3479. %s%s
  3480. SUMMARY:%s%s%s
  3481. CATEGORIES:%s
  3482. END:VEVENT\n"
  3483. (org-ical-ts-to-string ts "DTSTART")
  3484. (org-ical-ts-to-string ts2 "DTEND" inc)
  3485. rrule summary
  3486. (if (and desc (string-match "\\S-" desc))
  3487. (concat "\nDESCRIPTION: " desc) "")
  3488. (if (and location (string-match "\\S-" location))
  3489. (concat "\nLOCATION: " location) "")
  3490. category)))))
  3491. (when (and org-icalendar-include-sexps
  3492. (condition-case nil (require 'icalendar) (error nil))
  3493. (fboundp 'icalendar-export-region))
  3494. ;; Get all the literal sexps
  3495. (goto-char (point-min))
  3496. (while (re-search-forward "^&?%%(" nil t)
  3497. (catch :skip
  3498. (org-agenda-skip)
  3499. (setq b (match-beginning 0))
  3500. (goto-char (1- (match-end 0)))
  3501. (forward-sexp 1)
  3502. (end-of-line 1)
  3503. (setq sexp (buffer-substring b (point)))
  3504. (with-current-buffer sexp-buffer
  3505. (insert sexp "\n"))
  3506. (princ (org-diary-to-ical-string sexp-buffer)))))
  3507. (when org-icalendar-include-todo
  3508. (goto-char (point-min))
  3509. (while (re-search-forward org-todo-line-regexp nil t)
  3510. (catch :skip
  3511. (org-agenda-skip)
  3512. (when (boundp 'org-icalendar-verify-function)
  3513. (unless (funcall org-icalendar-verify-function)
  3514. (outline-next-heading)
  3515. (backward-char 1)
  3516. (throw :skip nil)))
  3517. (setq state (match-string 2))
  3518. (setq status (if (member state org-done-keywords)
  3519. "COMPLETED" "NEEDS-ACTION"))
  3520. (when (and state
  3521. (or (not (member state org-done-keywords))
  3522. (eq org-icalendar-include-todo 'all))
  3523. (not (member org-archive-tag (org-get-tags-at)))
  3524. )
  3525. (setq hd (match-string 3)
  3526. summary (org-icalendar-cleanup-string
  3527. (org-entry-get nil "SUMMARY"))
  3528. desc (org-icalendar-cleanup-string
  3529. (or (org-entry-get nil "DESCRIPTION")
  3530. (and org-icalendar-include-body (org-get-entry)))
  3531. t org-icalendar-include-body)
  3532. location (org-icalendar-cleanup-string
  3533. (org-entry-get nil "LOCATION")))
  3534. (if (string-match org-bracket-link-regexp hd)
  3535. (setq hd (replace-match (if (match-end 3) (match-string 3 hd)
  3536. (match-string 1 hd))
  3537. t t hd)))
  3538. (if (string-match org-priority-regexp hd)
  3539. (setq pri (string-to-char (match-string 2 hd))
  3540. hd (concat (substring hd 0 (match-beginning 1))
  3541. (substring hd (match-end 1))))
  3542. (setq pri org-default-priority))
  3543. (setq pri (floor (1+ (* 8. (/ (float (- org-lowest-priority pri))
  3544. (- org-lowest-priority org-highest-priority))))))
  3545. (princ (format "BEGIN:VTODO
  3546. %s
  3547. SUMMARY:%s%s%s
  3548. CATEGORIES:%s
  3549. SEQUENCE:1
  3550. PRIORITY:%d
  3551. STATUS:%s
  3552. END:VTODO\n"
  3553. dts
  3554. (or summary hd)
  3555. (if (and location (string-match "\\S-" location))
  3556. (concat "\nLOCATION: " location) "")
  3557. (if (and desc (string-match "\\S-" desc))
  3558. (concat "\nDESCRIPTION: " desc) "")
  3559. category pri status)))))))))
  3560. (defun org-icalendar-cleanup-string (s &optional is-body maxlength)
  3561. "Take out stuff and quote what needs to be quoted.
  3562. When IS-BODY is non-nil, assume that this is the body of an item, clean up
  3563. whitespace, newlines, drawers, and timestamps, and cut it down to MAXLENGTH
  3564. characters."
  3565. (if (not s)
  3566. nil
  3567. (when is-body
  3568. (let ((re (concat "\\(" org-drawer-regexp "\\)[^\000]*?:END:.*\n?"))
  3569. (re2 (concat "^[ \t]*" org-keyword-time-regexp ".*\n?")))
  3570. (while (string-match re s) (setq s (replace-match "" t t s)))
  3571. (while (string-match re2 s) (setq s (replace-match "" t t s)))))
  3572. (let ((start 0))
  3573. (while (string-match "\\([,;]\\)" s start)
  3574. (setq start (+ (match-beginning 0) 2)
  3575. s (replace-match "\\\\\\1" nil nil s))))
  3576. (when is-body
  3577. (while (string-match "[ \t]*\n[ \t]*" s)
  3578. (setq s (replace-match "\\n" t t s))))
  3579. (setq s (org-trim s))
  3580. (if is-body
  3581. (if maxlength
  3582. (if (and (numberp maxlength)
  3583. (> (length s) maxlength))
  3584. (setq s (substring s 0 maxlength)))))
  3585. s))
  3586. (defun org-get-entry ()
  3587. "Clean-up description string."
  3588. (save-excursion
  3589. (org-back-to-heading t)
  3590. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  3591. (defun org-start-icalendar-file (name)
  3592. "Start an iCalendar file by inserting the header."
  3593. (let ((user user-full-name)
  3594. (name (or name "unknown"))
  3595. (timezone (cadr (current-time-zone))))
  3596. (princ
  3597. (format "BEGIN:VCALENDAR
  3598. VERSION:2.0
  3599. X-WR-CALNAME:%s
  3600. PRODID:-//%s//Emacs with Org-mode//EN
  3601. X-WR-TIMEZONE:%s
  3602. CALSCALE:GREGORIAN\n" name user timezone))))
  3603. (defun org-finish-icalendar-file ()
  3604. "Finish an iCalendar file by inserting the END statement."
  3605. (princ "END:VCALENDAR\n"))
  3606. (defun org-ical-ts-to-string (s keyword &optional inc)
  3607. "Take a time string S and convert it to iCalendar format.
  3608. KEYWORD is added in front, to make a complete line like DTSTART....
  3609. When INC is non-nil, increase the hour by two (if time string contains
  3610. a time), or the day by one (if it does not contain a time)."
  3611. (let ((t1 (org-parse-time-string s 'nodefault))
  3612. t2 fmt have-time time)
  3613. (if (and (car t1) (nth 1 t1) (nth 2 t1))
  3614. (setq t2 t1 have-time t)
  3615. (setq t2 (org-parse-time-string s)))
  3616. (let ((s (car t2)) (mi (nth 1 t2)) (h (nth 2 t2))
  3617. (d (nth 3 t2)) (m (nth 4 t2)) (y (nth 5 t2)))
  3618. (when inc
  3619. (if have-time
  3620. (if org-agenda-default-appointment-duration
  3621. (setq mi (+ org-agenda-default-appointment-duration mi))
  3622. (setq h (+ 2 h)))
  3623. (setq d (1+ d))))
  3624. (setq time (encode-time s mi h d m y)))
  3625. (setq fmt (if have-time ":%Y%m%dT%H%M%S" ";VALUE=DATE:%Y%m%d"))
  3626. (concat keyword (format-time-string fmt time))))
  3627. ;;; XOXO export
  3628. (defun org-export-as-xoxo-insert-into (buffer &rest output)
  3629. (with-current-buffer buffer
  3630. (apply 'insert output)))
  3631. (put 'org-export-as-xoxo-insert-into 'lisp-indent-function 1)
  3632. ;;;###autoload
  3633. (defun org-export-as-xoxo (&optional buffer)
  3634. "Export the org buffer as XOXO.
  3635. The XOXO buffer is named *xoxo-<source buffer name>*"
  3636. (interactive (list (current-buffer)))
  3637. ;; A quickie abstraction
  3638. ;; Output everything as XOXO
  3639. (with-current-buffer (get-buffer buffer)
  3640. (let* ((pos (point))
  3641. (opt-plist (org-combine-plists (org-default-export-plist)
  3642. (org-infile-export-plist)))
  3643. (filename (concat (file-name-as-directory
  3644. (org-export-directory :xoxo opt-plist))
  3645. (file-name-sans-extension
  3646. (file-name-nondirectory buffer-file-name))
  3647. ".html"))
  3648. (out (find-file-noselect filename))
  3649. (last-level 1)
  3650. (hanging-li nil))
  3651. (goto-char (point-min)) ;; CD: beginning-of-buffer is not allowed.
  3652. ;; Check the output buffer is empty.
  3653. (with-current-buffer out (erase-buffer))
  3654. ;; Kick off the output
  3655. (org-export-as-xoxo-insert-into out "<ol class='xoxo'>\n")
  3656. (while (re-search-forward "^\\(\\*+\\)[ \t]+\\(.+\\)" (point-max) 't)
  3657. (let* ((hd (match-string-no-properties 1))
  3658. (level (length hd))
  3659. (text (concat
  3660. (match-string-no-properties 2)
  3661. (save-excursion
  3662. (goto-char (match-end 0))
  3663. (let ((str ""))
  3664. (catch 'loop
  3665. (while 't
  3666. (forward-line)
  3667. (if (looking-at "^[ \t]\\(.*\\)")
  3668. (setq str (concat str (match-string-no-properties 1)))
  3669. (throw 'loop str)))))))))
  3670. ;; Handle level rendering
  3671. (cond
  3672. ((> level last-level)
  3673. (org-export-as-xoxo-insert-into out "\n<ol>\n"))
  3674. ((< level last-level)
  3675. (dotimes (- (- last-level level) 1)
  3676. (if hanging-li
  3677. (org-export-as-xoxo-insert-into out "</li>\n"))
  3678. (org-export-as-xoxo-insert-into out "</ol>\n"))
  3679. (when hanging-li
  3680. (org-export-as-xoxo-insert-into out "</li>\n")
  3681. (setq hanging-li nil)))
  3682. ((equal level last-level)
  3683. (if hanging-li
  3684. (org-export-as-xoxo-insert-into out "</li>\n")))
  3685. )
  3686. (setq last-level level)
  3687. ;; And output the new li
  3688. (setq hanging-li 't)
  3689. (if (equal ?+ (elt text 0))
  3690. (org-export-as-xoxo-insert-into out "<li class='" (substring text 1) "'>")
  3691. (org-export-as-xoxo-insert-into out "<li>" text))))
  3692. ;; Finally finish off the ol
  3693. (dotimes (- last-level 1)
  3694. (if hanging-li
  3695. (org-export-as-xoxo-insert-into out "</li>\n"))
  3696. (org-export-as-xoxo-insert-into out "</ol>\n"))
  3697. (goto-char pos)
  3698. ;; Finish the buffer off and clean it up.
  3699. (switch-to-buffer-other-window out)
  3700. (indent-region (point-min) (point-max) nil)
  3701. (save-buffer)
  3702. (goto-char (point-min))
  3703. )))
  3704. (provide 'org-exp)
  3705. ;; arch-tag: 65985fe9-095c-49c7-a7b6-cb4ee15c0a95
  3706. ;;; org-exp.el ends here