org-export.el 126 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341
  1. ;;; org-export.el --- Generic Export Engine For Org
  2. ;; Copyright (C) 2012 Free Software Foundation, Inc.
  3. ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; This program is free software; you can redistribute it and/or modify
  6. ;; it under the terms of the GNU General Public License as published by
  7. ;; the Free Software Foundation, either version 3 of the License, or
  8. ;; (at your option) any later version.
  9. ;; This program is distributed in the hope that it will be useful,
  10. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. ;; GNU General Public License for more details.
  13. ;; You should have received a copy of the GNU General Public License
  14. ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
  15. ;;; Commentary:
  16. ;; This library implements a generic export engine for Org, built on
  17. ;; its syntactical parser: Org Elements.
  18. ;; Besides that parser, the generic exporter is made of three distinct
  19. ;; parts:
  20. ;; - The communication channel consists in a property list, which is
  21. ;; created and updated during the process. Its use is to offer
  22. ;; every piece of information, would it be about initial environment
  23. ;; or contextual data, all in a single place. The exhaustive list
  24. ;; of properties is given in "The Communication Channel" section of
  25. ;; this file.
  26. ;; - The transcoder walks the parse tree, ignores or treat as plain
  27. ;; text elements and objects according to export options, and
  28. ;; eventually calls back-end specific functions to do the real
  29. ;; transcoding, concatenating their return value along the way.
  30. ;; - The filter system is activated at the very beginning and the very
  31. ;; end of the export process, and each time an element or an object
  32. ;; has been converted. It is the entry point to fine-tune standard
  33. ;; output from back-end transcoders.
  34. ;; The core function is `org-export-as'. It returns the transcoded
  35. ;; buffer as a string.
  36. ;; In order to derive an exporter out of this generic implementation,
  37. ;; one can define a transcode function for each element or object.
  38. ;; Such function should return a string for the corresponding element,
  39. ;; without any trailing space, or nil. It must accept three
  40. ;; arguments:
  41. ;; 1. the element or object itself,
  42. ;; 2. its contents, or nil when it isn't recursive,
  43. ;; 3. the property list used as a communication channel.
  44. ;; If no such function is found, that element or object type will
  45. ;; simply be ignored, along with any separating blank line. The same
  46. ;; will happen if the function returns the nil value. If that
  47. ;; function returns the empty string, the type will be ignored, but
  48. ;; the blank lines will be kept.
  49. ;; Contents, when not nil, are stripped from any global indentation
  50. ;; (although the relative one is preserved). They also always end
  51. ;; with a single newline character.
  52. ;; These functions must follow a strict naming convention:
  53. ;; `org-BACKEND-TYPE' where, obviously, BACKEND is the name of the
  54. ;; export back-end and TYPE the type of the element or object handled.
  55. ;; Moreover, two additional functions can be defined. On the one
  56. ;; hand, `org-BACKEND-template' returns the final transcoded string,
  57. ;; and can be used to add a preamble and a postamble to document's
  58. ;; body. It must accept two arguments: the transcoded string and the
  59. ;; property list containing export options. On the other hand,
  60. ;; `org-BACKEND-plain-text', when defined, is to be called on every
  61. ;; text not recognized as an element or an object. It must accept two
  62. ;; arguments: the text string and the information channel.
  63. ;; Any back-end can define its own variables. Among them, those
  64. ;; customizables should belong to the `org-export-BACKEND' group.
  65. ;; Also, a special variable, `org-BACKEND-option-alist', allows to
  66. ;; define buffer keywords and "#+options:" items specific to that
  67. ;; back-end. See `org-export-option-alist' for supported defaults and
  68. ;; syntax.
  69. ;; Tools for common tasks across back-ends are implemented in the
  70. ;; penultimate part of this file. A dispatcher for standard back-ends
  71. ;; is provided in the last one.
  72. ;;; Code:
  73. (eval-when-compile (require 'cl))
  74. (require 'org-element)
  75. ;; Require major back-ends and publishing tools
  76. (require 'org-e-ascii "../../EXPERIMENTAL/org-e-ascii.el")
  77. (require 'org-e-html "../../EXPERIMENTAL/org-e-html.el")
  78. (require 'org-e-latex "../../EXPERIMENTAL/org-e-latex.el")
  79. (require 'org-e-publish "../../EXPERIMENTAL/org-e-publish.el")
  80. ;;; Internal Variables
  81. ;; Among internal variables, the most important is
  82. ;; `org-export-option-alist'. This variable define the global export
  83. ;; options, shared between every exporter, and how they are acquired.
  84. (defconst org-export-max-depth 19
  85. "Maximum nesting depth for headlines, counting from 0.")
  86. (defconst org-export-option-alist
  87. '((:author "AUTHOR" nil user-full-name t)
  88. (:creator "CREATOR" nil org-export-creator-string)
  89. (:date "DATE" nil nil t)
  90. (:description "DESCRIPTION" nil nil newline)
  91. (:email "EMAIL" nil user-mail-address t)
  92. (:exclude-tags "EXPORT_EXCLUDE_TAGS" nil org-export-exclude-tags split)
  93. (:headline-levels nil "H" org-export-headline-levels)
  94. (:keywords "KEYWORDS" nil nil space)
  95. (:language "LANGUAGE" nil org-export-default-language t)
  96. (:preserve-breaks nil "\\n" org-export-preserve-breaks)
  97. (:section-numbers nil "num" org-export-with-section-numbers)
  98. (:select-tags "EXPORT_SELECT_TAGS" nil org-export-select-tags split)
  99. (:time-stamp-file nil "timestamp" org-export-time-stamp-file)
  100. (:title "TITLE" nil nil space)
  101. (:with-archived-trees nil "arch" org-export-with-archived-trees)
  102. (:with-author nil "author" org-export-with-author)
  103. (:with-creator nil "creator" org-export-with-creator)
  104. (:with-drawers nil "d" org-export-with-drawers)
  105. (:with-email nil "email" org-export-with-email)
  106. (:with-emphasize nil "*" org-export-with-emphasize)
  107. (:with-entities nil "e" org-export-with-entities)
  108. (:with-fixed-width nil ":" org-export-with-fixed-width)
  109. (:with-footnotes nil "f" org-export-with-footnotes)
  110. (:with-priority nil "pri" org-export-with-priority)
  111. (:with-special-strings nil "-" org-export-with-special-strings)
  112. (:with-sub-superscript nil "^" org-export-with-sub-superscripts)
  113. (:with-toc nil "toc" org-export-with-toc)
  114. (:with-tables nil "|" org-export-with-tables)
  115. (:with-tags nil "tags" org-export-with-tags)
  116. (:with-tasks nil "tasks" org-export-with-tasks)
  117. (:with-timestamps nil "<" org-export-with-timestamps)
  118. (:with-todo-keywords nil "todo" org-export-with-todo-keywords))
  119. "Alist between export properties and ways to set them.
  120. The car of the alist is the property name, and the cdr is a list
  121. like \(KEYWORD OPTION DEFAULT BEHAVIOUR\) where:
  122. KEYWORD is a string representing a buffer keyword, or nil.
  123. OPTION is a string that could be found in an #+OPTIONS: line.
  124. DEFAULT is the default value for the property.
  125. BEHAVIOUR determine how Org should handle multiple keywords for
  126. the same property. It is a symbol among:
  127. nil Keep old value and discard the new one.
  128. t Replace old value with the new one.
  129. `space' Concatenate the values, separating them with a space.
  130. `newline' Concatenate the values, separating them with
  131. a newline.
  132. `split' Split values at white spaces, and cons them to the
  133. previous list.
  134. KEYWORD and OPTION have precedence over DEFAULT.
  135. All these properties should be back-end agnostic. For back-end
  136. specific properties, define a similar variable named
  137. `org-BACKEND-option-alist', replacing BACKEND with the name of
  138. the appropriate back-end. You can also redefine properties
  139. there, as they have precedence over these.")
  140. (defconst org-export-special-keywords
  141. '("SETUP_FILE" "OPTIONS" "MACRO")
  142. "List of in-buffer keywords that require special treatment.
  143. These keywords are not directly associated to a property. The
  144. way they are handled must be hard-coded into
  145. `org-export-get-inbuffer-options' function.")
  146. (defconst org-export-filters-alist
  147. '((:filter-babel-call . org-export-filter-babel-call-functions)
  148. (:filter-center-block . org-export-filter-center-block-functions)
  149. (:filter-comment . org-export-filter-comment-functions)
  150. (:filter-comment-block . org-export-filter-comment-block-functions)
  151. (:filter-drawer . org-export-filter-drawer-functions)
  152. (:filter-dynamic-block . org-export-filter-dynamic-block-functions)
  153. (:filter-emphasis . org-export-filter-emphasis-functions)
  154. (:filter-entity . org-export-filter-entity-functions)
  155. (:filter-example-block . org-export-filter-example-block-functions)
  156. (:filter-export-block . org-export-filter-export-block-functions)
  157. (:filter-export-snippet . org-export-filter-export-snippet-functions)
  158. (:filter-final-output . org-export-filter-final-output-functions)
  159. (:filter-fixed-width . org-export-filter-fixed-width-functions)
  160. (:filter-footnote-definition . org-export-filter-footnote-definition-functions)
  161. (:filter-footnote-reference . org-export-filter-footnote-reference-functions)
  162. (:filter-headline . org-export-filter-headline-functions)
  163. (:filter-horizontal-rule . org-export-filter-horizontal-rule-functions)
  164. (:filter-inline-babel-call . org-export-filter-inline-babel-call-functions)
  165. (:filter-inline-src-block . org-export-filter-inline-src-block-functions)
  166. (:filter-inlinetask . org-export-filter-inlinetask-functions)
  167. (:filter-item . org-export-filter-item-functions)
  168. (:filter-keyword . org-export-filter-keyword-functions)
  169. (:filter-latex-environment . org-export-filter-latex-environment-functions)
  170. (:filter-latex-fragment . org-export-filter-latex-fragment-functions)
  171. (:filter-line-break . org-export-filter-line-break-functions)
  172. (:filter-link . org-export-filter-link-functions)
  173. (:filter-macro . org-export-filter-macro-functions)
  174. (:filter-paragraph . org-export-filter-paragraph-functions)
  175. (:filter-parse-tree . org-export-filter-parse-tree-functions)
  176. (:filter-plain-list . org-export-filter-plain-list-functions)
  177. (:filter-plain-text . org-export-filter-plain-text-functions)
  178. (:filter-property-drawer . org-export-filter-property-drawer-functions)
  179. (:filter-quote-block . org-export-filter-quote-block-functions)
  180. (:filter-quote-section . org-export-filter-quote-section-functions)
  181. (:filter-radio-target . org-export-filter-radio-target-functions)
  182. (:filter-section . org-export-filter-section-functions)
  183. (:filter-special-block . org-export-filter-special-block-functions)
  184. (:filter-src-block . org-export-filter-src-block-functions)
  185. (:filter-statistics-cookie . org-export-filter-statistics-cookie-functions)
  186. (:filter-subscript . org-export-filter-subscript-functions)
  187. (:filter-superscript . org-export-filter-superscript-functions)
  188. (:filter-table . org-export-filter-table-functions)
  189. (:filter-target . org-export-filter-target-functions)
  190. (:filter-time-stamp . org-export-filter-time-stamp-functions)
  191. (:filter-verbatim . org-export-filter-verbatim-functions)
  192. (:filter-verse-block . org-export-filter-verse-block-functions))
  193. "Alist between filters properties and initial values.
  194. The key of each association is a property name accessible through
  195. the communication channel its value is a configurable global
  196. variable defining initial filters.
  197. This list is meant to install user specified filters. Back-end
  198. developers may install their own filters using
  199. `org-BACKEND-filters-alist', where BACKEND is the name of the
  200. considered back-end. Filters defined there will always be
  201. prepended to the current list, so they always get applied
  202. first.")
  203. (defconst org-export-default-inline-image-rule
  204. `(("file" .
  205. ,(format "\\.%s\\'"
  206. (regexp-opt
  207. '("png" "jpeg" "jpg" "gif" "tiff" "tif" "xbm"
  208. "xpm" "pbm" "pgm" "ppm") t))))
  209. "Default rule for link matching an inline image.
  210. This rule applies to links with no description. By default, it
  211. will be considered as an inline image if it targets a local file
  212. whose extension is either \"png\", \"jpeg\", \"jpg\", \"gif\",
  213. \"tiff\", \"tif\", \"xbm\", \"xpm\", \"pbm\", \"pgm\" or \"ppm\".
  214. See `org-export-inline-image-p' for more information about
  215. rules.")
  216. ;;; User-configurable Variables
  217. ;; Configuration for the masses.
  218. ;; They should never be evaled directly, as their value is to be
  219. ;; stored in a property list (cf. `org-export-option-alist').
  220. (defgroup org-export nil
  221. "Options for exporting Org mode files."
  222. :tag "Org Export"
  223. :group 'org)
  224. (defgroup org-export-general nil
  225. "General options for export engine."
  226. :tag "Org Export General"
  227. :group 'org-export)
  228. (defcustom org-export-with-archived-trees 'headline
  229. "Whether sub-trees with the ARCHIVE tag should be exported.
  230. This can have three different values:
  231. nil Do not export, pretend this tree is not present.
  232. t Do export the entire tree.
  233. `headline' Only export the headline, but skip the tree below it.
  234. This option can also be set with the #+OPTIONS line,
  235. e.g. \"arch:nil\"."
  236. :group 'org-export-general
  237. :type '(choice
  238. (const :tag "Not at all" nil)
  239. (const :tag "Headline only" 'headline)
  240. (const :tag "Entirely" t)))
  241. (defcustom org-export-with-author t
  242. "Non-nil means insert author name into the exported file.
  243. This option can also be set with the #+OPTIONS line,
  244. e.g. \"author:nil\"."
  245. :group 'org-export-general
  246. :type 'boolean)
  247. (defcustom org-export-with-creator 'comment
  248. "Non-nil means the postamble should contain a creator sentence.
  249. The sentence can be set in `org-export-creator-string' and
  250. defaults to \"Generated by Org mode XX in Emacs XXX.\".
  251. If the value is `comment' insert it as a comment."
  252. :group 'org-export-general
  253. :type '(choice
  254. (const :tag "No creator sentence" nil)
  255. (const :tag "Sentence as a comment" 'comment)
  256. (const :tag "Insert the sentence" t)))
  257. (defcustom org-export-creator-string
  258. (format "Generated by Org mode %s in Emacs %s." org-version emacs-version)
  259. "String to insert at the end of the generated document."
  260. :group 'org-export-general
  261. :type '(string :tag "Creator string"))
  262. (defcustom org-export-with-drawers t
  263. "Non-nil means export contents of standard drawers.
  264. When t, all drawers are exported. This may also be a list of
  265. drawer names to export. This variable doesn't apply to
  266. properties drawers.
  267. This option can also be set with the #+OPTIONS line,
  268. e.g. \"d:nil\"."
  269. :group 'org-export-general
  270. :type '(choice
  271. (const :tag "All drawers" t)
  272. (const :tag "None" nil)
  273. (repeat :tag "Selected drawers"
  274. (string :tag "Drawer name"))))
  275. (defcustom org-export-with-email nil
  276. "Non-nil means insert author email into the exported file.
  277. This option can also be set with the #+OPTIONS line,
  278. e.g. \"email:t\"."
  279. :group 'org-export-general
  280. :type 'boolean)
  281. (defcustom org-export-with-emphasize t
  282. "Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
  283. If the export target supports emphasizing text, the word will be
  284. typeset in bold, italic, or underlined, respectively. Not all
  285. export backends support this.
  286. This option can also be set with the #+OPTIONS line, e.g. \"*:nil\"."
  287. :group 'org-export-general
  288. :type 'boolean)
  289. (defcustom org-export-exclude-tags '("noexport")
  290. "Tags that exclude a tree from export.
  291. All trees carrying any of these tags will be excluded from
  292. export. This is without condition, so even subtrees inside that
  293. carry one of the `org-export-select-tags' will be removed."
  294. :group 'org-export-general
  295. :type '(repeat (string :tag "Tag")))
  296. (defcustom org-export-with-fixed-width t
  297. "Non-nil means lines starting with \":\" will be in fixed width font.
  298. This can be used to have pre-formatted text, fragments of code
  299. etc. For example:
  300. : ;; Some Lisp examples
  301. : (while (defc cnt)
  302. : (ding))
  303. will be looking just like this in also HTML. See also the QUOTE
  304. keyword. Not all export backends support this.
  305. This option can also be set with the #+OPTIONS line, e.g. \"::nil\"."
  306. :group 'org-export-translation
  307. :type 'boolean)
  308. (defcustom org-export-with-footnotes t
  309. "Non-nil means Org footnotes should be exported.
  310. This option can also be set with the #+OPTIONS line,
  311. e.g. \"f:nil\"."
  312. :group 'org-export-general
  313. :type 'boolean)
  314. (defcustom org-export-headline-levels 3
  315. "The last level which is still exported as a headline.
  316. Inferior levels will produce itemize lists when exported. Note
  317. that a numeric prefix argument to an exporter function overrides
  318. this setting.
  319. This option can also be set with the #+OPTIONS line, e.g. \"H:2\"."
  320. :group 'org-export-general
  321. :type 'integer)
  322. (defcustom org-export-default-language "en"
  323. "The default language for export and clocktable translations, as a string.
  324. This may have an association in
  325. `org-clock-clocktable-language-setup'."
  326. :group 'org-export-general
  327. :type '(string :tag "Language"))
  328. (defcustom org-export-preserve-breaks nil
  329. "Non-nil means preserve all line breaks when exporting.
  330. Normally, in HTML output paragraphs will be reformatted.
  331. This option can also be set with the #+OPTIONS line,
  332. e.g. \"\\n:t\"."
  333. :group 'org-export-general
  334. :type 'boolean)
  335. (defcustom org-export-with-entities t
  336. "Non-nil means interpret entities when exporting.
  337. For example, HTML export converts \\alpha to &alpha; and \\AA to
  338. &Aring;.
  339. For a list of supported names, see the constant `org-entities'
  340. and the user option `org-entities-user'.
  341. This option can also be set with the #+OPTIONS line,
  342. e.g. \"e:nil\"."
  343. :group 'org-export-general
  344. :type 'boolean)
  345. (defcustom org-export-with-priority nil
  346. "Non-nil means include priority cookies in export.
  347. When nil, remove priority cookies for export."
  348. :group 'org-export-general
  349. :type 'boolean)
  350. (defcustom org-export-with-section-numbers t
  351. "Non-nil means add section numbers to headlines when exporting.
  352. When set to an integer n, numbering will only happen for
  353. headlines whose relative level is higher or equal to n.
  354. This option can also be set with the #+OPTIONS line,
  355. e.g. \"num:t\"."
  356. :group 'org-export-general
  357. :type 'boolean)
  358. (defcustom org-export-select-tags '("export")
  359. "Tags that select a tree for export.
  360. If any such tag is found in a buffer, all trees that do not carry
  361. one of these tags will be deleted before export. Inside trees
  362. that are selected like this, you can still deselect a subtree by
  363. tagging it with one of the `org-export-exclude-tags'."
  364. :group 'org-export-general
  365. :type '(repeat (string :tag "Tag")))
  366. (defcustom org-export-with-special-strings t
  367. "Non-nil means interpret \"\-\", \"--\" and \"---\" for export.
  368. When this option is turned on, these strings will be exported as:
  369. Org HTML LaTeX
  370. -----+----------+--------
  371. \\- &shy; \\-
  372. -- &ndash; --
  373. --- &mdash; ---
  374. ... &hellip; \ldots
  375. This option can also be set with the #+OPTIONS line,
  376. e.g. \"-:nil\"."
  377. :group 'org-export-general
  378. :type 'boolean)
  379. (defcustom org-export-with-sub-superscripts t
  380. "Non-nil means interpret \"_\" and \"^\" for export.
  381. When this option is turned on, you can use TeX-like syntax for
  382. sub- and superscripts. Several characters after \"_\" or \"^\"
  383. will be considered as a single item - so grouping with {} is
  384. normally not needed. For example, the following things will be
  385. parsed as single sub- or superscripts.
  386. 10^24 or 10^tau several digits will be considered 1 item.
  387. 10^-12 or 10^-tau a leading sign with digits or a word
  388. x^2-y^3 will be read as x^2 - y^3, because items are
  389. terminated by almost any nonword/nondigit char.
  390. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  391. Still, ambiguity is possible - so when in doubt use {} to enclose
  392. the sub/superscript. If you set this variable to the symbol
  393. `{}', the braces are *required* in order to trigger
  394. interpretations as sub/superscript. This can be helpful in
  395. documents that need \"_\" frequently in plain text.
  396. This option can also be set with the #+OPTIONS line,
  397. e.g. \"^:nil\"."
  398. :group 'org-export-general
  399. :type '(choice
  400. (const :tag "Interpret them" t)
  401. (const :tag "Curly brackets only" {})
  402. (const :tag "Do not interpret them" nil)))
  403. (defcustom org-export-with-toc t
  404. "Non-nil means create a table of contents in exported files.
  405. The TOC contains headlines with levels up
  406. to`org-export-headline-levels'. When an integer, include levels
  407. up to N in the toc, this may then be different from
  408. `org-export-headline-levels', but it will not be allowed to be
  409. larger than the number of headline levels. When nil, no table of
  410. contents is made.
  411. This option can also be set with the #+OPTIONS line,
  412. e.g. \"toc:nil\" or \"toc:3\"."
  413. :group 'org-export-general
  414. :type '(choice
  415. (const :tag "No Table of Contents" nil)
  416. (const :tag "Full Table of Contents" t)
  417. (integer :tag "TOC to level")))
  418. (defcustom org-export-with-tables t
  419. "If non-nil, lines starting with \"|\" define a table.
  420. For example:
  421. | Name | Address | Birthday |
  422. |-------------+----------+-----------|
  423. | Arthur Dent | England | 29.2.2100 |
  424. This option can also be set with the #+OPTIONS line, e.g. \"|:nil\"."
  425. :group 'org-export-general
  426. :type 'boolean)
  427. (defcustom org-export-with-tags t
  428. "If nil, do not export tags, just remove them from headlines.
  429. If this is the symbol `not-in-toc', tags will be removed from
  430. table of contents entries, but still be shown in the headlines of
  431. the document.
  432. This option can also be set with the #+OPTIONS line,
  433. e.g. \"tags:nil\"."
  434. :group 'org-export-general
  435. :type '(choice
  436. (const :tag "Off" nil)
  437. (const :tag "Not in TOC" not-in-toc)
  438. (const :tag "On" t)))
  439. (defcustom org-export-with-tasks t
  440. "Non-nil means include TODO items for export.
  441. This may have the following values:
  442. t include tasks independent of state.
  443. todo include only tasks that are not yet done.
  444. done include only tasks that are already done.
  445. nil remove all tasks before export
  446. list of keywords keep only tasks with these keywords"
  447. :group 'org-export-general
  448. :type '(choice
  449. (const :tag "All tasks" t)
  450. (const :tag "No tasks" nil)
  451. (const :tag "Not-done tasks" todo)
  452. (const :tag "Only done tasks" done)
  453. (repeat :tag "Specific TODO keywords"
  454. (string :tag "Keyword"))))
  455. (defcustom org-export-time-stamp-file t
  456. "Non-nil means insert a time stamp into the exported file.
  457. The time stamp shows when the file was created.
  458. This option can also be set with the #+OPTIONS line,
  459. e.g. \"timestamp:nil\"."
  460. :group 'org-export-general
  461. :type 'boolean)
  462. (defcustom org-export-with-timestamps t
  463. "If nil, do not export time stamps and associated keywords."
  464. :group 'org-export-general
  465. :type 'boolean)
  466. (defcustom org-export-with-todo-keywords t
  467. "Non-nil means include TODO keywords in export.
  468. When nil, remove all these keywords from the export.")
  469. (defcustom org-export-allow-BIND 'confirm
  470. "Non-nil means allow #+BIND to define local variable values for export.
  471. This is a potential security risk, which is why the user must
  472. confirm the use of these lines."
  473. :group 'org-export-general
  474. :type '(choice
  475. (const :tag "Never" nil)
  476. (const :tag "Always" t)
  477. (const :tag "Ask a confirmation for each file" confirm)))
  478. (defcustom org-export-snippet-translation-alist nil
  479. "Alist between export snippets back-ends and exporter back-ends.
  480. This variable allows to provide shortcuts for export snippets.
  481. For example, with a value of '\(\(\"h\" . \"html\"\)\), the HTML
  482. back-end will recognize the contents of \"@h{<b>}\" as HTML code
  483. while every other back-end will ignore it."
  484. :group 'org-export-general
  485. :type '(repeat
  486. (cons
  487. (string :tag "Shortcut")
  488. (string :tag "Back-end"))))
  489. (defcustom org-export-coding-system nil
  490. "Coding system for the exported file."
  491. :group 'org-export-general
  492. :type 'coding-system)
  493. (defcustom org-export-copy-to-kill-ring t
  494. "Non-nil means exported stuff will also be pushed onto the kill ring."
  495. :group 'org-export-general
  496. :type 'boolean)
  497. (defcustom org-export-initial-scope 'buffer
  498. "The initial scope when exporting with `org-export-dispatch'.
  499. This variable can be either set to `buffer' or `subtree'."
  500. :group 'org-export-general
  501. :type '(choice
  502. (const :tag "Export current buffer" 'buffer)
  503. (const :tag "Export current subtree" 'subtree)))
  504. (defcustom org-export-show-temporary-export-buffer t
  505. "Non-nil means show buffer after exporting to temp buffer.
  506. When Org exports to a file, the buffer visiting that file is ever
  507. shown, but remains buried. However, when exporting to a temporary
  508. buffer, that buffer is popped up in a second window. When this variable
  509. is nil, the buffer remains buried also in these cases."
  510. :group 'org-export-general
  511. :type 'boolean)
  512. (defcustom org-export-dispatch-use-expert-ui nil
  513. "Non-nil means using a non-intrusive `org-export-dispatch'.
  514. In that case, no help buffer is displayed. Though, an indicator
  515. for current export scope is added to the prompt \(i.e. \"b\" when
  516. output is restricted to body only, \"s\" when it is restricted to
  517. the current subtree and \"v\" when only visible elements are
  518. considered for export\). Also, \[?] allows to switch back to
  519. standard mode."
  520. :group 'org-export-general
  521. :type 'boolean)
  522. ;;; The Communication Channel
  523. ;; During export process, every function has access to a number of
  524. ;; properties. They are of three types:
  525. ;; 1. Environment options are collected once at the very beginning of
  526. ;; the process, out of the original buffer and configuration.
  527. ;; Associated to the parse tree, they make an Org closure.
  528. ;; Collecting them is handled by `org-export-get-environment'
  529. ;; function.
  530. ;;
  531. ;; Most environment options are defined through the
  532. ;; `org-export-option-alist' variable.
  533. ;;
  534. ;; 2. Tree properties are extracted directly from the parsed tree,
  535. ;; just before export, by `org-export-collect-tree-properties'.
  536. ;;
  537. ;; 3. Local options are updated during parsing, and their value
  538. ;; depends on the level of recursion. For now, only `:genealogy'
  539. ;; belongs to that category.
  540. ;; Here is the full list of properties available during transcode
  541. ;; process, with their category (option, tree or local) and their
  542. ;; value type.
  543. ;; + `:author' :: Author's name.
  544. ;; - category :: option
  545. ;; - type :: string
  546. ;; + `:back-end' :: Current back-end used for transcoding.
  547. ;; - category :: tree
  548. ;; - type :: symbol
  549. ;; + `:creator' :: String to write as creation information.
  550. ;; - category :: option
  551. ;; - type :: string
  552. ;; + `:date' :: String to use as date.
  553. ;; - category :: option
  554. ;; - type :: string
  555. ;; + `:description' :: Description text for the current data.
  556. ;; - category :: option
  557. ;; - type :: string
  558. ;; + `:email' :: Author's email.
  559. ;; - category :: option
  560. ;; - type :: string
  561. ;; + `:exclude-tags' :: Tags for exclusion of subtrees from export
  562. ;; process.
  563. ;; - category :: option
  564. ;; - type :: list of strings
  565. ;; + `:footnote-definition-alist' :: Alist between footnote labels and
  566. ;; their definition, as parsed data. Only non-inlined footnotes
  567. ;; are represented in this alist. Also, every definition isn't
  568. ;; guaranteed to be referenced in the parse tree. The purpose of
  569. ;; this property is to preserve definitions from oblivion
  570. ;; (i.e. when the parse tree comes from a part of the original
  571. ;; buffer), it isn't meant for direct use in a back-end. To
  572. ;; retrieve a definition relative to a reference, use
  573. ;; `org-export-get-footnote-definition' instead.
  574. ;; - category :: option
  575. ;; - type :: alist (STRING . LIST)
  576. ;; + `:genealogy' :: Flat list of current object or element's parents
  577. ;; from closest to farthest.
  578. ;; - category :: local
  579. ;; - type :: list of elements and objects
  580. ;; + `:headline-levels' :: Maximum level being exported as an
  581. ;; headline. Comparison is done with the relative level of
  582. ;; headlines in the parse tree, not necessarily with their
  583. ;; actual level.
  584. ;; - category :: option
  585. ;; - type :: integer
  586. ;; + `:headline-offset' :: Difference between relative and real level
  587. ;; of headlines in the parse tree. For example, a value of -1
  588. ;; means a level 2 headline should be considered as level
  589. ;; 1 (cf. `org-export-get-relative-level').
  590. ;; - category :: tree
  591. ;; - type :: integer
  592. ;; + `:headline-numbering' :: Alist between headlines' beginning
  593. ;; position and their numbering, as a list of numbers
  594. ;; (cf. `org-export-get-headline-number').
  595. ;; - category :: tree
  596. ;; - type :: alist (INTEGER . LIST)
  597. ;; + `:input-file' :: Full path to input file, if any.
  598. ;; - category :: option
  599. ;; - type :: string or nil
  600. ;; + `:keywords' :: List of keywords attached to data.
  601. ;; - category :: option
  602. ;; - type :: string
  603. ;; + `:language' :: Default language used for translations.
  604. ;; - category :: option
  605. ;; - type :: string
  606. ;; + `:macro-input-file' :: Macro returning file name of input file,
  607. ;; or nil.
  608. ;; - category :: option
  609. ;; - type :: string or nil
  610. ;; + `:parse-tree' :: Whole parse tree, available at any time during
  611. ;; transcoding.
  612. ;; - category :: global
  613. ;; - type :: list (as returned by `org-element-parse-buffer')
  614. ;; + `:preserve-breaks' :: Non-nil means transcoding should preserve
  615. ;; all line breaks.
  616. ;; - category :: option
  617. ;; - type :: symbol (nil, t)
  618. ;; + `:section-numbers' :: Non-nil means transcoding should add
  619. ;; section numbers to headlines.
  620. ;; - category :: option
  621. ;; - type :: symbol (nil, t)
  622. ;; + `:select-tags' :: List of tags enforcing inclusion of sub-trees
  623. ;; in transcoding. When such a tag is present,
  624. ;; subtrees without it are de facto excluded from
  625. ;; the process. See `use-select-tags'.
  626. ;; - category :: option
  627. ;; - type :: list of strings
  628. ;; + `:target-list' :: List of targets encountered in the parse tree.
  629. ;; This is used to partly resolve "fuzzy" links
  630. ;; (cf. `org-export-resolve-fuzzy-link').
  631. ;; - category :: tree
  632. ;; - type :: list of strings
  633. ;; + `:time-stamp-file' :: Non-nil means transcoding should insert
  634. ;; a time stamp in the output.
  635. ;; - category :: option
  636. ;; - type :: symbol (nil, t)
  637. ;; + `:use-select-tags' :: When non-nil, a select tags has been found
  638. ;; in the parse tree. Thus, any headline without one will be
  639. ;; filtered out. See `select-tags'.
  640. ;; - category :: tree
  641. ;; - type :: interger or nil
  642. ;; + `:with-archived-trees' :: Non-nil when archived subtrees should
  643. ;; also be transcoded. If it is set to the `headline' symbol,
  644. ;; only the archived headline's name is retained.
  645. ;; - category :: option
  646. ;; - type :: symbol (nil, t, `headline')
  647. ;; + `:with-author' :: Non-nil means author's name should be included
  648. ;; in the output.
  649. ;; - category :: option
  650. ;; - type :: symbol (nil, t)
  651. ;; + `:with-creator' :: Non-nild means a creation sentence should be
  652. ;; inserted at the end of the transcoded string. If the value
  653. ;; is `comment', it should be commented.
  654. ;; - category :: option
  655. ;; - type :: symbol (`comment', nil, t)
  656. ;; + `:with-drawers' :: Non-nil means drawers should be exported. If
  657. ;; its value is a list of names, only drawers with such names
  658. ;; will be transcoded.
  659. ;; - category :: option
  660. ;; - type :: symbol (nil, t) or list of strings
  661. ;; + `:with-email' :: Non-nil means output should contain author's
  662. ;; email.
  663. ;; - category :: option
  664. ;; - type :: symbol (nil, t)
  665. ;; + `:with-emphasize' :: Non-nil means emphasized text should be
  666. ;; interpreted.
  667. ;; - category :: option
  668. ;; - type :: symbol (nil, t)
  669. ;; + `:with-fixed-width' :: Non-nil if transcoder should interpret
  670. ;; strings starting with a colon as a fixed-with (verbatim) area.
  671. ;; - category :: option
  672. ;; - type :: symbol (nil, t)
  673. ;; + `:with-footnotes' :: Non-nil if transcoder should interpret
  674. ;; footnotes.
  675. ;; - category :: option
  676. ;; - type :: symbol (nil, t)
  677. ;; + `:with-priority' :: Non-nil means transcoding should include
  678. ;; priority cookies.
  679. ;; - category :: option
  680. ;; - type :: symbol (nil, t)
  681. ;; + `:with-special-strings' :: Non-nil means transcoding should
  682. ;; interpret special strings in plain text.
  683. ;; - category :: option
  684. ;; - type :: symbol (nil, t)
  685. ;; + `:with-sub-superscript' :: Non-nil means transcoding should
  686. ;; interpret subscript and superscript. With a value of "{}",
  687. ;; only interpret those using curly brackets.
  688. ;; - category :: option
  689. ;; - type :: symbol (nil, {}, t)
  690. ;; + `:with-tables' :: Non-nil means transcoding should interpret
  691. ;; tables.
  692. ;; - category :: option
  693. ;; - type :: symbol (nil, t)
  694. ;; + `:with-tags' :: Non-nil means transcoding should keep tags in
  695. ;; headlines. A `not-in-toc' value will remove them
  696. ;; from the table of contents, if any, nonetheless.
  697. ;; - category :: option
  698. ;; - type :: symbol (nil, t, `not-in-toc')
  699. ;; + `:with-tasks' :: Non-nil means transcoding should include
  700. ;; headlines with a TODO keyword. A `todo' value
  701. ;; will only include headlines with a todo type
  702. ;; keyword while a `done' value will do the
  703. ;; contrary. If a list of strings is provided, only
  704. ;; tasks with keywords belonging to that list will
  705. ;; be kept.
  706. ;; - category :: option
  707. ;; - type :: symbol (t, todo, done, nil) or list of strings
  708. ;; + `:with-timestamps' :: Non-nil means transcoding should include
  709. ;; time stamps and associated keywords. Otherwise, completely
  710. ;; remove them.
  711. ;; - category :: option
  712. ;; - type :: symbol: (t, nil)
  713. ;; + `:with-toc' :: Non-nil means that a table of contents has to be
  714. ;; added to the output. An integer value limits its
  715. ;; depth.
  716. ;; - category :: option
  717. ;; - type :: symbol (nil, t or integer)
  718. ;; + `:with-todo-keywords' :: Non-nil means transcoding should
  719. ;; include TODO keywords.
  720. ;; - category :: option
  721. ;; - type :: symbol (nil, t)
  722. ;;;; Environment Options
  723. ;; Environment options encompass all parameters defined outside the
  724. ;; scope of the parsed data. They come from five sources, in
  725. ;; increasing precedence order:
  726. ;;
  727. ;; - Global variables,
  728. ;; - Options keyword symbols,
  729. ;; - Buffer keywords,
  730. ;; - Subtree properties.
  731. ;; The central internal function with regards to environment options
  732. ;; is `org-export-get-environment'. It updates global variables with
  733. ;; "#+BIND:" keywords, then retrieve and prioritize properties from
  734. ;; the different sources.
  735. ;; The internal functions doing the retrieval are:
  736. ;; `org-export-parse-option-keyword' ,
  737. ;; `org-export-get-subtree-options' ,
  738. ;; `org-export-get-inbuffer-options' and
  739. ;; `org-export-get-global-options'.
  740. ;;
  741. ;; Some properties, which do not rely on the previous sources but
  742. ;; still depend on the original buffer, are taken care of with
  743. ;; `org-export-initial-options'.
  744. ;; Also, `org-export-confirm-letbind' and `org-export-install-letbind'
  745. ;; take care of the part relative to "#+BIND:" keywords.
  746. (defun org-export-get-environment (&optional backend subtreep ext-plist)
  747. "Collect export options from the current buffer.
  748. Optional argument BACKEND is a symbol specifying which back-end
  749. specific options to read, if any.
  750. When optional argument SUBTREEP is non-nil, assume the export is
  751. done against the current sub-tree.
  752. Third optional argument EXT-PLIST is a property list with
  753. external parameters overriding Org default settings, but still
  754. inferior to file-local settings."
  755. ;; First install #+BIND variables.
  756. (org-export-install-letbind-maybe)
  757. ;; Get and prioritize export options...
  758. (let ((options (org-combine-plists
  759. ;; ... from global variables...
  760. (org-export-get-global-options backend)
  761. ;; ... from buffer's name (default title)...
  762. `(:title
  763. ,(or (let ((file (buffer-file-name (buffer-base-buffer))))
  764. (and file
  765. (file-name-sans-extension
  766. (file-name-nondirectory file))))
  767. (buffer-name (buffer-base-buffer))))
  768. ;; ... from an external property list...
  769. ext-plist
  770. ;; ... from in-buffer settings...
  771. (org-export-get-inbuffer-options
  772. backend
  773. (and buffer-file-name
  774. (org-remove-double-quotes buffer-file-name)))
  775. ;; ... and from subtree, when appropriate.
  776. (and subtreep (org-export-get-subtree-options)))))
  777. ;; Add initial options.
  778. (setq options (append (org-export-initial-options) options))
  779. ;; Return plist.
  780. options))
  781. (defun org-export-parse-option-keyword (options &optional backend)
  782. "Parse an OPTIONS line and return values as a plist.
  783. Optional argument BACKEND is a symbol specifying which back-end
  784. specific items to read, if any."
  785. (let* ((all
  786. (append org-export-option-alist
  787. (and backend
  788. (let ((var (intern
  789. (format "org-%s-option-alist" backend))))
  790. (and (boundp var) (eval var))))))
  791. ;; Build an alist between #+OPTION: item and property-name.
  792. (alist (delq nil
  793. (mapcar (lambda (e)
  794. (when (nth 2 e) (cons (regexp-quote (nth 2 e))
  795. (car e))))
  796. all)))
  797. plist)
  798. (mapc (lambda (e)
  799. (when (string-match (concat "\\(\\`\\|[ \t]\\)"
  800. (car e)
  801. ":\\(([^)\n]+)\\|[^ \t\n\r;,.]*\\)")
  802. options)
  803. (setq plist (plist-put plist
  804. (cdr e)
  805. (car (read-from-string
  806. (match-string 2 options)))))))
  807. alist)
  808. plist))
  809. (defun org-export-get-subtree-options ()
  810. "Get export options in subtree at point.
  811. Assume point is at subtree's beginning.
  812. Return options as a plist."
  813. (let (prop plist)
  814. (when (setq prop (progn (looking-at org-todo-line-regexp)
  815. (or (save-match-data
  816. (org-entry-get (point) "EXPORT_TITLE"))
  817. (org-match-string-no-properties 3))))
  818. (setq plist
  819. (plist-put
  820. plist :title
  821. (org-element-parse-secondary-string
  822. prop
  823. (cdr (assq 'keyword org-element-string-restrictions))))))
  824. (when (setq prop (org-entry-get (point) "EXPORT_TEXT"))
  825. (setq plist (plist-put plist :text prop)))
  826. (when (setq prop (org-entry-get (point) "EXPORT_AUTHOR"))
  827. (setq plist (plist-put plist :author prop)))
  828. (when (setq prop (org-entry-get (point) "EXPORT_DATE"))
  829. (setq plist (plist-put plist :date prop)))
  830. (when (setq prop (org-entry-get (point) "EXPORT_OPTIONS"))
  831. (setq plist (org-export-add-options-to-plist plist prop)))
  832. plist))
  833. (defun org-export-get-inbuffer-options (&optional backend files)
  834. "Return current buffer export options, as a plist.
  835. Optional argument BACKEND, when non-nil, is a symbol specifying
  836. which back-end specific options should also be read in the
  837. process.
  838. Optional argument FILES is a list of setup files names read so
  839. far, used to avoid circular dependencies.
  840. Assume buffer is in Org mode. Narrowing, if any, is ignored."
  841. (org-with-wide-buffer
  842. (goto-char (point-min))
  843. (let ((case-fold-search t) plist)
  844. ;; 1. Special keywords, as in `org-export-special-keywords'.
  845. (let ((special-re (org-make-options-regexp org-export-special-keywords)))
  846. (while (re-search-forward special-re nil t)
  847. (let ((element (org-element-at-point)))
  848. (when (eq (car element) 'keyword)
  849. (let* ((key (upcase (org-element-get-property :key element)))
  850. (val (org-element-get-property :value element))
  851. (prop
  852. (cond
  853. ((string= key "SETUP_FILE")
  854. (let ((file
  855. (expand-file-name
  856. (org-remove-double-quotes (org-trim val)))))
  857. ;; Avoid circular dependencies.
  858. (unless (member file files)
  859. (with-temp-buffer
  860. (insert (org-file-contents file 'noerror))
  861. (org-mode)
  862. (org-export-get-inbuffer-options
  863. backend (cons file files))))))
  864. ((string= key "OPTIONS")
  865. (org-export-parse-option-keyword val backend))
  866. ((string= key "MACRO")
  867. (when (string-match
  868. "^\\([-a-zA-Z0-9_]+\\)\\(?:[ \t]+\\(.*?\\)[ \t]*$\\)?"
  869. val)
  870. (let ((key
  871. (intern
  872. (concat ":macro-"
  873. (downcase (match-string 1 val)))))
  874. (value (org-match-string-no-properties 2 val)))
  875. (cond
  876. ((not value) "")
  877. ;; Value will be evaled. Leave it as-is.
  878. ((string-match "\\`(eval\\>" value)
  879. (list key value))
  880. ;; Value has to be parsed for nested
  881. ;; macros.
  882. (t
  883. (list
  884. key
  885. (let ((restr
  886. (cdr
  887. (assq 'macro
  888. org-element-object-restrictions))))
  889. (org-element-parse-secondary-string
  890. ;; If user explicitly asks for
  891. ;; a newline, be sure to preserve it
  892. ;; from further filling with
  893. ;; `hard-newline'. Also replace
  894. ;; "\\n" with "\n", "\\\n" with "\\n"
  895. ;; and so on...
  896. (replace-regexp-in-string
  897. "\\(\\\\\\\\\\)n" "\\\\"
  898. (replace-regexp-in-string
  899. "\\(?:^\\|[^\\\\]\\)\\(\\\\n\\)"
  900. hard-newline value nil nil 1)
  901. nil nil 1)
  902. restr)))))))))))
  903. (setq plist (org-combine-plists plist prop)))))))
  904. ;; 2. Standard options, as in `org-export-option-alist'.
  905. (let* ((all (append org-export-option-alist
  906. ;; Also look for back-end specific options
  907. ;; if BACKEND is defined.
  908. (and backend
  909. (let ((var
  910. (intern
  911. (format "org-%s-option-alist" backend))))
  912. (and (boundp var) (eval var))))))
  913. ;; Build alist between keyword name and property name.
  914. (alist
  915. (delq nil (mapcar
  916. (lambda (e) (when (nth 1 e) (cons (nth 1 e) (car e))))
  917. all)))
  918. ;; Build regexp matching all keywords associated to export
  919. ;; options. Note: the search is case insensitive.
  920. (opt-re (org-make-options-regexp
  921. (delq nil (mapcar (lambda (e) (nth 1 e)) all)))))
  922. (goto-char (point-min))
  923. (while (re-search-forward opt-re nil t)
  924. (let ((element (org-element-at-point)))
  925. (when (eq (car element) 'keyword)
  926. (let* ((key (upcase (org-element-get-property :key element)))
  927. (val (org-element-get-property :value element))
  928. (prop (cdr (assoc key alist)))
  929. (behaviour (nth 4 (assq prop all))))
  930. (setq plist
  931. (plist-put
  932. plist prop
  933. ;; Handle value depending on specified BEHAVIOUR.
  934. (case behaviour
  935. (space
  936. (if (not (plist-get plist prop)) (org-trim val)
  937. (concat (plist-get plist prop) " " (org-trim val))))
  938. (newline
  939. (org-trim
  940. (concat (plist-get plist prop) "\n" (org-trim val))))
  941. (split
  942. `(,@(plist-get plist prop) ,@(org-split-string val)))
  943. ('t val)
  944. (otherwise (plist-get plist prop)))))))))
  945. ;; Parse keywords specified in `org-element-parsed-keywords'.
  946. (mapc
  947. (lambda (key)
  948. (let* ((prop (cdr (assoc key alist)))
  949. (value (and prop (plist-get plist prop))))
  950. (when (stringp value)
  951. (setq plist
  952. (plist-put
  953. plist prop
  954. (org-element-parse-secondary-string
  955. value
  956. (cdr (assq 'keyword org-element-string-restrictions))))))))
  957. org-element-parsed-keywords))
  958. ;; 3. Return final value.
  959. plist)))
  960. (defun org-export-get-global-options (&optional backend)
  961. "Return global export options as a plist.
  962. Optional argument BACKEND, if non-nil, is a symbol specifying
  963. which back-end specific export options should also be read in the
  964. process."
  965. (let ((all (append org-export-option-alist
  966. (and backend
  967. (let ((var (intern
  968. (format "org-%s-option-alist" backend))))
  969. (and (boundp var) (eval var))))))
  970. ;; Output value.
  971. plist)
  972. (mapc (lambda (cell)
  973. (setq plist (plist-put plist (car cell) (eval (nth 3 cell)))))
  974. all)
  975. ;; Return value.
  976. plist))
  977. (defun org-export-initial-options ()
  978. "Return a plist with properties related to input buffer."
  979. (let ((visited-file (buffer-file-name (buffer-base-buffer))))
  980. (list
  981. ;; Store full path of input file name, or nil. For internal use.
  982. :input-file visited-file
  983. ;; `:macro-date', `:macro-time' and `:macro-property' could as well
  984. ;; be initialized as tree properties, since they don't depend on
  985. ;; initial environment. Though, it may be more logical to keep
  986. ;; them close to other ":macro-" properties.
  987. :macro-date "(eval (format-time-string \"$1\"))"
  988. :macro-time "(eval (format-time-string \"$1\"))"
  989. :macro-property "(eval (org-entry-get nil \"$1\" 'selective))"
  990. :macro-modification-time
  991. (and visited-file
  992. (file-exists-p visited-file)
  993. (concat "(eval (format-time-string \"$1\" '"
  994. (prin1-to-string (nth 5 (file-attributes visited-file)))
  995. "))"))
  996. ;; Store input file name as a macro.
  997. :macro-input-file (and visited-file (file-name-nondirectory visited-file))
  998. ;; Footnotes definitions must be collected in the original buffer,
  999. ;; as there's no insurance that they will still be in the parse
  1000. ;; tree, due to some narrowing.
  1001. :footnote-definition-alist
  1002. (let (alist)
  1003. (org-with-wide-buffer
  1004. (goto-char (point-min))
  1005. (while (re-search-forward org-footnote-definition-re nil t)
  1006. (let ((def (org-footnote-at-definition-p)))
  1007. (when def
  1008. (org-skip-whitespace)
  1009. (push (cons (car def)
  1010. (save-restriction
  1011. (narrow-to-region (point) (nth 2 def))
  1012. ;; Like `org-element-parse-buffer', but
  1013. ;; makes sure the definition doesn't start
  1014. ;; with a section element.
  1015. (nconc
  1016. (list 'org-data nil)
  1017. (org-element-parse-elements
  1018. (point-min) (point-max) nil nil nil nil nil))))
  1019. alist))))
  1020. alist)))))
  1021. (defvar org-export-allow-BIND-local nil)
  1022. (defun org-export-confirm-letbind ()
  1023. "Can we use #+BIND values during export?
  1024. By default this will ask for confirmation by the user, to divert
  1025. possible security risks."
  1026. (cond
  1027. ((not org-export-allow-BIND) nil)
  1028. ((eq org-export-allow-BIND t) t)
  1029. ((local-variable-p 'org-export-allow-BIND-local) org-export-allow-BIND-local)
  1030. (t (org-set-local 'org-export-allow-BIND-local
  1031. (yes-or-no-p "Allow BIND values in this buffer? ")))))
  1032. (defun org-export-install-letbind-maybe ()
  1033. "Install the values from #+BIND lines as local variables.
  1034. Variables must be installed before in-buffer options are
  1035. retrieved."
  1036. (let (letbind pair)
  1037. (org-with-wide-buffer
  1038. (goto-char (point-min))
  1039. (while (re-search-forward (org-make-options-regexp '("BIND")) nil t)
  1040. (when (org-export-confirm-letbind)
  1041. (push (read (concat "(" (org-match-string-no-properties 2) ")"))
  1042. letbind))))
  1043. (while (setq pair (pop letbind))
  1044. (org-set-local (car pair) (nth 1 pair)))))
  1045. ;;;; Tree Properties
  1046. ;; Tree properties are infromation extracted from parse tree. They
  1047. ;; are initialized at the beginning of the transcoding process by
  1048. ;; `org-export-collect-tree-properties'.
  1049. ;; Dedicated functions focus on computing the value of specific tree
  1050. ;; properties during initialization. Thus,
  1051. ;; `org-export-use-select-tag-p' determines if an headline makes use
  1052. ;; of an export tag enforcing inclusion. `org-export-get-min-level'
  1053. ;; gets the minimal exportable level, used as a basis to compute
  1054. ;; relative level for headlines. `org-export-get-point-max' returns
  1055. ;; the maximum exportable ending position in the parse tree.
  1056. ;; Eventually `org-export-collect-headline-numbering' builds an alist
  1057. ;; between headlines' beginning position and their numbering.
  1058. (defun org-export-collect-tree-properties (data info backend)
  1059. "Extract tree properties from parse tree.
  1060. DATA is the parse tree from which information is retrieved. INFO
  1061. is a list holding export options. BACKEND is the back-end called
  1062. for transcoding, as a symbol.
  1063. Following tree properties are set:
  1064. `:back-end' Back-end used for transcoding.
  1065. `:headline-offset' Offset between true level of headlines and
  1066. local level. An offset of -1 means an headline
  1067. of level 2 should be considered as a level
  1068. 1 headline in the context.
  1069. `:headline-numbering' Alist of all headlines' beginning position
  1070. as key an the associated numbering as value.
  1071. `:parse-tree' Whole parse tree.
  1072. `:target-list' List of all targets in the parse tree.
  1073. `:use-select-tags' Non-nil when parsed tree use a special tag to
  1074. enforce transcoding of the headline."
  1075. ;; First, set `:use-select-tags' property, as it will be required
  1076. ;; for further computations.
  1077. (setq info
  1078. (org-combine-plists
  1079. info `(:use-select-tags ,(org-export-use-select-tags-p data info))))
  1080. ;; Then get `:headline-offset' in order to be able to use
  1081. ;; `org-export-get-relative-level'.
  1082. (setq info
  1083. (org-combine-plists
  1084. info `(:headline-offset ,(- 1 (org-export-get-min-level data info)))))
  1085. ;; Now, get the rest of the tree properties, now `:use-select-tags'
  1086. ;; is set...
  1087. (nconc
  1088. `(:parse-tree
  1089. ,data
  1090. :target-list
  1091. ,(org-element-map data 'target (lambda (target local) target) info)
  1092. :headline-numbering ,(org-export-collect-headline-numbering data info)
  1093. :back-end ,backend)
  1094. info))
  1095. (defun org-export-use-select-tags-p (data options)
  1096. "Non-nil when data use a tag enforcing transcoding.
  1097. DATA is parsed data as returned by `org-element-parse-buffer'.
  1098. OPTIONS is a plist holding export options."
  1099. (org-element-map
  1100. data
  1101. 'headline
  1102. (lambda (headline info)
  1103. (let ((tags (org-element-get-property :with-tags headline)))
  1104. (and tags (string-match
  1105. (format ":%s:" (plist-get info :select-tags)) tags))))
  1106. options
  1107. 'stop-at-first-match))
  1108. (defun org-export-get-min-level (data options)
  1109. "Return minimum exportable headline's level in DATA.
  1110. DATA is parsed tree as returned by `org-element-parse-buffer'.
  1111. OPTIONS is a plist holding export options."
  1112. (catch 'exit
  1113. (let ((min-level 10000))
  1114. (mapc (lambda (blob)
  1115. (when (and (eq (car blob) 'headline)
  1116. (not (org-export-skip-p blob options)))
  1117. (setq min-level
  1118. (min (org-element-get-property :level blob) min-level)))
  1119. (when (= min-level 1) (throw 'exit 1)))
  1120. (org-element-get-contents data))
  1121. ;; If no headline was found, for the sake of consistency, set
  1122. ;; minimum level to 1 nonetheless.
  1123. (if (= min-level 10000) 1 min-level))))
  1124. (defun org-export-collect-headline-numbering (data options)
  1125. "Return numbering of all exportable headlines in a parse tree.
  1126. DATA is the parse tree. OPTIONS is the plist holding export
  1127. options.
  1128. Return an alist whose key is an headline and value is its
  1129. associated numbering \(in the shape of a list of numbers\)."
  1130. (let ((numbering (make-vector org-export-max-depth 0)))
  1131. (org-element-map
  1132. data
  1133. 'headline
  1134. (lambda (headline info)
  1135. (let ((relative-level
  1136. (1- (org-export-get-relative-level headline info))))
  1137. (cons
  1138. headline
  1139. (loop for n across numbering
  1140. for idx from 0 to org-export-max-depth
  1141. when (< idx relative-level) collect n
  1142. when (= idx relative-level) collect (aset numbering idx (1+ n))
  1143. when (> idx relative-level) do (aset numbering idx 0)))))
  1144. options)))
  1145. ;;; The Transcoder
  1146. ;; This function reads Org data (obtained with, i.e.
  1147. ;; `org-element-parse-buffer') and transcodes it into a specified
  1148. ;; back-end output. It takes care of updating local properties,
  1149. ;; filtering out elements or objects according to export options and
  1150. ;; organizing the output blank lines and white space are preserved.
  1151. ;; Though, this function is inapropriate for secondary strings, which
  1152. ;; require a fresh copy of the plist passed as INFO argument. Thus,
  1153. ;; `org-export-secondary-string' is provided for that specific task.
  1154. ;; Internally, three functions handle the filtering of objects and
  1155. ;; elements during the export. More precisely, `org-export-skip-p'
  1156. ;; determines if the considered object or element should be ignored
  1157. ;; altogether, `org-export-interpret-p' tells which elements or
  1158. ;; objects should be seen as real Org syntax and `org-export-expand'
  1159. ;; transforms the others back into their original shape.
  1160. (defun org-export-data (data backend info)
  1161. "Convert DATA to a string into BACKEND format.
  1162. DATA is a nested list as returned by `org-element-parse-buffer'.
  1163. BACKEND is a symbol among supported exporters.
  1164. INFO is a plist holding export options and also used as
  1165. a communication channel between elements when walking the nested
  1166. list. See `org-export-update-info' function for more
  1167. details.
  1168. Return transcoded string."
  1169. (mapconcat
  1170. ;; BLOB can be an element, an object, a string, or nil.
  1171. (lambda (blob)
  1172. (cond
  1173. ((not blob) nil)
  1174. ;; BLOB is a string. Check if the optional transcoder for plain
  1175. ;; text exists, and call it in that case. Otherwise, simply
  1176. ;; return string. Also update INFO and call
  1177. ;; `org-export-filter-plain-text-functions'.
  1178. ((stringp blob)
  1179. (let ((transcoder (intern (format "org-%s-plain-text" backend))))
  1180. (org-export-filter-apply-functions
  1181. (plist-get info :filter-plain-text)
  1182. (if (fboundp transcoder) (funcall transcoder blob info) blob)
  1183. backend info)))
  1184. ;; BLOB is an element or an object.
  1185. (t
  1186. (let* ((type (if (stringp blob) 'plain-text (car blob)))
  1187. ;; 1. Determine the appropriate TRANSCODER.
  1188. (transcoder
  1189. (cond
  1190. ;; 1.0 A full Org document is inserted.
  1191. ((eq type 'org-data) 'identity)
  1192. ;; 1.1. BLOB should be ignored.
  1193. ((org-export-skip-p blob info) nil)
  1194. ;; 1.2. BLOB shouldn't be transcoded. Interpret it
  1195. ;; back into Org syntax.
  1196. ((not (org-export-interpret-p blob info))
  1197. 'org-export-expand)
  1198. ;; 1.3. Else apply naming convention.
  1199. (t (let ((trans (intern
  1200. (format "org-%s-%s" backend type))))
  1201. (and (fboundp trans) trans)))))
  1202. ;; 2. Compute CONTENTS of BLOB.
  1203. (contents
  1204. (cond
  1205. ;; Case 0. No transcoder defined: ignore BLOB.
  1206. ((not transcoder) nil)
  1207. ;; Case 1. Transparently export an Org document.
  1208. ((eq type 'org-data) (org-export-data blob backend info))
  1209. ;; Case 2. For a recursive object.
  1210. ((memq type org-element-recursive-objects)
  1211. (org-export-data
  1212. blob backend
  1213. (org-combine-plists
  1214. info
  1215. `(:genealogy ,(cons blob (plist-get info :genealogy))))))
  1216. ;; Case 3. For a recursive element.
  1217. ((memq type org-element-greater-elements)
  1218. ;; Ignore contents of an archived tree
  1219. ;; when `:with-archived-trees' is `headline'.
  1220. (unless (and
  1221. (eq type 'headline)
  1222. (eq (plist-get info :with-archived-trees) 'headline)
  1223. (org-element-get-property :archivedp blob))
  1224. (org-element-normalize-string
  1225. (org-export-data
  1226. blob backend
  1227. (org-combine-plists
  1228. info `(:genealogy
  1229. ,(cons blob (plist-get info :genealogy))))))))
  1230. ;; Case 4. For a paragraph.
  1231. ((eq type 'paragraph)
  1232. (let ((paragraph
  1233. (org-element-normalize-contents
  1234. blob
  1235. ;; When normalizing contents of an item or
  1236. ;; a footnote definition, ignore first line's
  1237. ;; indentation: there is none and it might be
  1238. ;; misleading.
  1239. (and (not (org-export-get-previous-element blob info))
  1240. (let ((parent (caar (plist-get info :genealogy))))
  1241. (memq parent '(footnote-definition item)))))))
  1242. (org-export-data
  1243. paragraph backend
  1244. (org-combine-plists
  1245. info `(:genealogy
  1246. ,(cons paragraph (plist-get info :genealogy)))))))))
  1247. ;; 3. Transcode BLOB into RESULTS string.
  1248. (results (cond
  1249. ((not transcoder) nil)
  1250. ((eq transcoder 'org-export-expand)
  1251. (org-export-data
  1252. `(org-data nil ,(funcall transcoder blob contents))
  1253. backend info))
  1254. (t (funcall transcoder blob contents info)))))
  1255. ;; 4. Discard nil results. Otherwise, update INFO, append
  1256. ;; the same white space between elements or objects as in
  1257. ;; the original buffer, and call appropriate filters.
  1258. (when results
  1259. ;; No filter for a full document.
  1260. (if (eq type 'org-data) results
  1261. (org-export-filter-apply-functions
  1262. (plist-get info (intern (format ":filter-%s" type)))
  1263. (let ((post-blank (org-element-get-property :post-blank blob)))
  1264. (if (memq type org-element-all-elements)
  1265. (concat (org-element-normalize-string results)
  1266. (make-string post-blank ?\n))
  1267. (concat results (make-string post-blank ? ))))
  1268. backend info)))))))
  1269. (org-element-get-contents data) ""))
  1270. (defun org-export-secondary-string (secondary backend info)
  1271. "Convert SECONDARY string into BACKEND format.
  1272. SECONDARY is a nested list as returned by
  1273. `org-element-parse-secondary-string'.
  1274. BACKEND is a symbol among supported exporters. INFO is a plist
  1275. used as a communication channel.
  1276. Return transcoded string."
  1277. ;; Make SECONDARY acceptable for `org-export-data'.
  1278. (let ((s (if (listp secondary) secondary (list secondary))))
  1279. (org-export-data `(org-data nil ,@s) backend (copy-sequence info))))
  1280. (defun org-export-skip-p (blob info)
  1281. "Non-nil when element or object BLOB should be skipped during export.
  1282. INFO is the plist holding export options."
  1283. ;; Check headline.
  1284. (unless (stringp blob)
  1285. (case (car blob)
  1286. ('headline
  1287. (let ((with-tasks (plist-get info :with-tasks))
  1288. (todo (org-element-get-property :todo-keyword blob))
  1289. (todo-type (org-element-get-property :todo-type blob))
  1290. (archived (plist-get info :with-archived-trees))
  1291. (tag-list (let ((tags (org-element-get-property :tags blob)))
  1292. (and tags (org-split-string tags ":")))))
  1293. (or
  1294. ;; Ignore subtrees with an exclude tag.
  1295. (loop for k in (plist-get info :exclude-tags)
  1296. thereis (member k tag-list))
  1297. ;; Ignore subtrees without a select tag, when such tag is found
  1298. ;; in the buffer.
  1299. (and (plist-get info :use-select-tags)
  1300. (loop for k in (plist-get info :select-tags)
  1301. never (member k tag-list)))
  1302. ;; Ignore commented sub-trees.
  1303. (org-element-get-property :commentedp blob)
  1304. ;; Ignore archived subtrees if `:with-archived-trees' is nil.
  1305. (and (not archived) (org-element-get-property :archivedp blob))
  1306. ;; Ignore tasks, if specified by `:with-tasks' property.
  1307. (and todo (not with-tasks))
  1308. (and todo
  1309. (memq with-tasks '(todo done))
  1310. (not (eq todo-type with-tasks)))
  1311. (and todo
  1312. (consp with-tasks)
  1313. (not (member todo with-tasks))))))
  1314. ;; Check time-stamp.
  1315. ('time-stamp (not (plist-get info :with-timestamps)))
  1316. ;; Check drawer.
  1317. ('drawer
  1318. (or (not (plist-get info :with-drawers))
  1319. (and (consp (plist-get info :with-drawers))
  1320. (not (member (org-element-get-property :drawer-name blob)
  1321. (plist-get info :with-drawers))))))
  1322. ;; Check export snippet.
  1323. ('export-snippet
  1324. (let* ((raw-back-end (org-element-get-property :back-end blob))
  1325. (true-back-end
  1326. (or (cdr (assoc raw-back-end org-export-snippet-translation-alist))
  1327. raw-back-end)))
  1328. (not (string= (symbol-name (plist-get info :back-end))
  1329. true-back-end)))))))
  1330. (defun org-export-interpret-p (blob info)
  1331. "Non-nil if element or object BLOB should be interpreted as Org syntax.
  1332. Check is done according to export options INFO, stored as
  1333. a plist."
  1334. (case (car blob)
  1335. ;; ... entities...
  1336. (entity (plist-get info :with-entities))
  1337. ;; ... emphasis...
  1338. (emphasis (plist-get info :with-emphasize))
  1339. ;; ... fixed-width areas.
  1340. (fixed-width (plist-get info :with-fixed-width))
  1341. ;; ... footnotes...
  1342. ((footnote-definition footnote-reference)
  1343. (plist-get info :with-footnotes))
  1344. ;; ... sub/superscripts...
  1345. ((subscript superscript)
  1346. (let ((sub/super-p (plist-get info :with-sub-superscript)))
  1347. (if (eq sub/super-p '{})
  1348. (org-element-get-property :use-brackets-p blob)
  1349. sub/super-p)))
  1350. ;; ... tables...
  1351. (table (plist-get info :with-tables))
  1352. (otherwise t)))
  1353. (defsubst org-export-expand (blob contents)
  1354. "Expand a parsed element or object to its original state.
  1355. BLOB is either an element or an object. CONTENTS is its
  1356. contents, as a string or nil."
  1357. (funcall
  1358. (intern (format "org-element-%s-interpreter" (car blob))) blob contents))
  1359. ;;; The Filter System
  1360. ;; Filters allow end-users to tweak easily the transcoded output.
  1361. ;; They are the functional counterpart of hooks, as every filter in
  1362. ;; a set is applied to the return value of the previous one.
  1363. ;; Every set is back-end agnostic. Although, a filter is always
  1364. ;; called, in addition to the string it applies to, with the back-end
  1365. ;; used as argument, so it's easy enough for the end-user to add
  1366. ;; back-end specific filters in the set. The communication channel,
  1367. ;; as a plist, is required as the third argument.
  1368. ;; Filters sets are defined below. There are of four types:
  1369. ;; - `org-export-filter-parse-tree-functions' applies directly on the
  1370. ;; complete parsed tree. It's the only filters set that doesn't
  1371. ;; apply to a string.
  1372. ;; - `org-export-filter-final-output-functions' applies to the final
  1373. ;; transcoded string.
  1374. ;; - `org-export-filter-plain-text-functions' applies to any string
  1375. ;; not recognized as Org syntax.
  1376. ;; - `org-export-filter-TYPE-functions' applies on the string returned
  1377. ;; after an element or object of type TYPE has been transcoded.
  1378. ;; All filters sets are applied through
  1379. ;; `org-export-filter-apply-functions' function. Filters in a set are
  1380. ;; applied in a LIFO fashion. It allows developers to be sure that
  1381. ;; their filters will be applied first.
  1382. ;; Filters properties are installed in communication channel just
  1383. ;; before parsing, with `org-export-install-filters' function.
  1384. ;;;; Special Filters
  1385. (defvar org-export-filter-parse-tree-functions nil
  1386. "Filter, or list of filters, applied to the parsed tree.
  1387. Each filter is called with three arguments: the parse tree, as
  1388. returned by `org-element-parse-buffer', the back-end, as
  1389. a symbol, and the communication channel, as a plist. It must
  1390. return the modified parse tree to transcode.")
  1391. (defvar org-export-filter-final-output-functions nil
  1392. "Filter, or list of filters, applied to the transcoded string.
  1393. Each filter is called with three arguments: the full transcoded
  1394. string, the back-end, as a symbol, and the communication channel,
  1395. as a plist. It must return a string that will be used as the
  1396. final export output.")
  1397. (defvar org-export-filter-plain-text-functions nil
  1398. "Filter, or list of filters, applied to plain text.
  1399. Each filter is called with three arguments: a string which
  1400. contains no Org syntax, the back-end, as a symbol, and the
  1401. communication channel, as a plist. It must return a string or
  1402. nil.")
  1403. ;;;; Elements Filters
  1404. (defvar org-export-filter-center-block-functions nil
  1405. "List of functions applied to a transcoded center block.
  1406. Each filter is called with three arguments: the transcoded center
  1407. block, as a string, the back-end, as a symbol, and the
  1408. communication channel, as a plist. It must return a string or
  1409. nil.")
  1410. (defvar org-export-filter-drawer-functions nil
  1411. "List of functions applied to a transcoded drawer.
  1412. Each filter is called with three arguments: the transcoded
  1413. drawer, as a string, the back-end, as a symbol, and the
  1414. communication channel, as a plist. It must return a string or
  1415. nil.")
  1416. (defvar org-export-filter-dynamic-block-functions nil
  1417. "List of functions applied to a transcoded dynamic-block.
  1418. Each filter is called with three arguments: the transcoded
  1419. dynamic-block, as a string, the back-end, as a symbol, and the
  1420. communication channel, as a plist. It must return a string or
  1421. nil.")
  1422. (defvar org-export-filter-headline-functions nil
  1423. "List of functions applied to a transcoded headline.
  1424. Each filter is called with three arguments: the transcoded
  1425. headline, as a string, the back-end, as a symbol, and the
  1426. communication channel, as a plist. It must return a string or
  1427. nil.")
  1428. (defvar org-export-filter-inlinetask-functions nil
  1429. "List of functions applied to a transcoded inlinetask.
  1430. Each filter is called with three arguments: the transcoded
  1431. inlinetask, as a string, the back-end, as a symbol, and the
  1432. communication channel, as a plist. It must return a string or
  1433. nil.")
  1434. (defvar org-export-filter-plain-list-functions nil
  1435. "List of functions applied to a transcoded plain-list.
  1436. Each filter is called with three arguments: the transcoded
  1437. plain-list, as a string, the back-end, as a symbol, and the
  1438. communication channel, as a plist. It must return a string or
  1439. nil.")
  1440. (defvar org-export-filter-item-functions nil
  1441. "List of functions applied to a transcoded item.
  1442. Each filter is called with three arguments: the transcoded item,
  1443. as a string, the back-end, as a symbol, and the communication
  1444. channel, as a plist. It must return a string or nil.")
  1445. (defvar org-export-filter-comment-functions nil
  1446. "List of functions applied to a transcoded comment.
  1447. Each filter is called with three arguments: the transcoded
  1448. comment, as a string, the back-end, as a symbol, and the
  1449. communication channel, as a plist. It must return a string or
  1450. nil.")
  1451. (defvar org-export-filter-comment-block-functions nil
  1452. "List of functions applied to a transcoded comment-comment.
  1453. Each filter is called with three arguments: the transcoded
  1454. comment-block, as a string, the back-end, as a symbol, and the
  1455. communication channel, as a plist. It must return a string or
  1456. nil.")
  1457. (defvar org-export-filter-example-block-functions nil
  1458. "List of functions applied to a transcoded example-block.
  1459. Each filter is called with three arguments: the transcoded
  1460. example-block, as a string, the back-end, as a symbol, and the
  1461. communication channel, as a plist. It must return a string or
  1462. nil.")
  1463. (defvar org-export-filter-export-block-functions nil
  1464. "List of functions applied to a transcoded export-block.
  1465. Each filter is called with three arguments: the transcoded
  1466. export-block, as a string, the back-end, as a symbol, and the
  1467. communication channel, as a plist. It must return a string or
  1468. nil.")
  1469. (defvar org-export-filter-fixed-width-functions nil
  1470. "List of functions applied to a transcoded fixed-width.
  1471. Each filter is called with three arguments: the transcoded
  1472. fixed-width, as a string, the back-end, as a symbol, and the
  1473. communication channel, as a plist. It must return a string or
  1474. nil.")
  1475. (defvar org-export-filter-footnote-definition-functions nil
  1476. "List of functions applied to a transcoded footnote-definition.
  1477. Each filter is called with three arguments: the transcoded
  1478. footnote-definition, as a string, the back-end, as a symbol, and
  1479. the communication channel, as a plist. It must return a string
  1480. or nil.")
  1481. (defvar org-export-filter-horizontal-rule-functions nil
  1482. "List of functions applied to a transcoded horizontal-rule.
  1483. Each filter is called with three arguments: the transcoded
  1484. horizontal-rule, as a string, the back-end, as a symbol, and the
  1485. communication channel, as a plist. It must return a string or
  1486. nil.")
  1487. (defvar org-export-filter-keyword-functions nil
  1488. "List of functions applied to a transcoded keyword.
  1489. Each filter is called with three arguments: the transcoded
  1490. keyword, as a string, the back-end, as a symbol, and the
  1491. communication channel, as a plist. It must return a string or
  1492. nil.")
  1493. (defvar org-export-filter-latex-environment-functions nil
  1494. "List of functions applied to a transcoded latex-environment.
  1495. Each filter is called with three arguments: the transcoded
  1496. latex-environment, as a string, the back-end, as a symbol, and
  1497. the communication channel, as a plist. It must return a string
  1498. or nil.")
  1499. (defvar org-export-filter-babel-call-functions nil
  1500. "List of functions applied to a transcoded babel-call.
  1501. Each filter is called with three arguments: the transcoded
  1502. babel-call, as a string, the back-end, as a symbol, and the
  1503. communication channel, as a plist. It must return a string or
  1504. nil.")
  1505. (defvar org-export-filter-paragraph-functions nil
  1506. "List of functions applied to a transcoded paragraph.
  1507. Each filter is called with three arguments: the transcoded
  1508. paragraph, as a string, the back-end, as a symbol, and the
  1509. communication channel, as a plist. It must return a string or
  1510. nil.")
  1511. (defvar org-export-filter-property-drawer-functions nil
  1512. "List of functions applied to a transcoded property-drawer.
  1513. Each filter is called with three arguments: the transcoded
  1514. property-drawer, as a string, the back-end, as a symbol, and the
  1515. communication channel, as a plist. It must return a string or
  1516. nil.")
  1517. (defvar org-export-filter-quote-block-functions nil
  1518. "List of functions applied to a transcoded quote block.
  1519. Each filter is called with three arguments: the transcoded quote
  1520. block, as a string, the back-end, as a symbol, and the
  1521. communication channel, as a plist. It must return a string or
  1522. nil.")
  1523. (defvar org-export-filter-quote-section-functions nil
  1524. "List of functions applied to a transcoded quote-section.
  1525. Each filter is called with three arguments: the transcoded
  1526. quote-section, as a string, the back-end, as a symbol, and the
  1527. communication channel, as a plist. It must return a string or
  1528. nil.")
  1529. (defvar org-export-filter-section-functions nil
  1530. "List of functions applied to a transcoded section.
  1531. Each filter is called with three arguments: the transcoded
  1532. section, as a string, the back-end, as a symbol, and the
  1533. communication channel, as a plist. It must return a string or
  1534. nil.")
  1535. (defvar org-export-filter-special-block-functions nil
  1536. "List of functions applied to a transcoded special block.
  1537. Each filter is called with three arguments: the transcoded
  1538. special block, as a string, the back-end, as a symbol, and the
  1539. communication channel, as a plist. It must return a string or
  1540. nil.")
  1541. (defvar org-export-filter-src-block-functions nil
  1542. "List of functions applied to a transcoded src-block.
  1543. Each filter is called with three arguments: the transcoded
  1544. src-block, as a string, the back-end, as a symbol, and the
  1545. communication channel, as a plist. It must return a string or
  1546. nil.")
  1547. (defvar org-export-filter-table-functions nil
  1548. "List of functions applied to a transcoded table.
  1549. Each filter is called with three arguments: the transcoded table,
  1550. as a string, the back-end, as a symbol, and the communication
  1551. channel, as a plist. It must return a string or nil.")
  1552. (defvar org-export-filter-verse-block-functions nil
  1553. "List of functions applied to a transcoded verse block.
  1554. Each filter is called with three arguments: the transcoded verse
  1555. block, as a string, the back-end, as a symbol, and the
  1556. communication channel, as a plist. It must return a string or
  1557. nil.")
  1558. ;;;; Objects Filters
  1559. (defvar org-export-filter-emphasis-functions nil
  1560. "List of functions applied to a transcoded emphasis.
  1561. Each filter is called with three arguments: the transcoded
  1562. emphasis, as a string, the back-end, as a symbol, and the
  1563. communication channel, as a plist. It must return a string or
  1564. nil.")
  1565. (defvar org-export-filter-entity-functions nil
  1566. "List of functions applied to a transcoded entity.
  1567. Each filter is called with three arguments: the transcoded
  1568. entity, as a string, the back-end, as a symbol, and the
  1569. communication channel, as a plist. It must return a string or
  1570. nil.")
  1571. (defvar org-export-filter-export-snippet-functions nil
  1572. "List of functions applied to a transcoded export-snippet.
  1573. Each filter is called with three arguments: the transcoded
  1574. export-snippet, as a string, the back-end, as a symbol, and the
  1575. communication channel, as a plist. It must return a string or
  1576. nil.")
  1577. (defvar org-export-filter-footnote-reference-functions nil
  1578. "List of functions applied to a transcoded footnote-reference.
  1579. Each filter is called with three arguments: the transcoded
  1580. footnote-reference, as a string, the back-end, as a symbol, and
  1581. the communication channel, as a plist. It must return a string
  1582. or nil.")
  1583. (defvar org-export-filter-inline-babel-call-functions nil
  1584. "List of functions applied to a transcoded inline-babel-call.
  1585. Each filter is called with three arguments: the transcoded
  1586. inline-babel-call, as a string, the back-end, as a symbol, and
  1587. the communication channel, as a plist. It must return a string
  1588. or nil.")
  1589. (defvar org-export-filter-inline-src-block-functions nil
  1590. "List of functions applied to a transcoded inline-src-block.
  1591. Each filter is called with three arguments: the transcoded
  1592. inline-src-block, as a string, the back-end, as a symbol, and the
  1593. communication channel, as a plist. It must return a string or
  1594. nil.")
  1595. (defvar org-export-filter-latex-fragment-functions nil
  1596. "List of functions applied to a transcoded latex-fragment.
  1597. Each filter is called with three arguments: the transcoded
  1598. latex-fragment, as a string, the back-end, as a symbol, and the
  1599. communication channel, as a plist. It must return a string or
  1600. nil.")
  1601. (defvar org-export-filter-line-break-functions nil
  1602. "List of functions applied to a transcoded line-break.
  1603. Each filter is called with three arguments: the transcoded
  1604. line-break, as a string, the back-end, as a symbol, and the
  1605. communication channel, as a plist. It must return a string or
  1606. nil.")
  1607. (defvar org-export-filter-link-functions nil
  1608. "List of functions applied to a transcoded link.
  1609. Each filter is called with three arguments: the transcoded link,
  1610. as a string, the back-end, as a symbol, and the communication
  1611. channel, as a plist. It must return a string or nil.")
  1612. (defvar org-export-filter-macro-functions nil
  1613. "List of functions applied to a transcoded macro.
  1614. Each filter is called with three arguments: the transcoded macro,
  1615. as a string, the back-end, as a symbol, and the communication
  1616. channel, as a plist. It must return a string or nil.")
  1617. (defvar org-export-filter-radio-target-functions nil
  1618. "List of functions applied to a transcoded radio-target.
  1619. Each filter is called with three arguments: the transcoded
  1620. radio-target, as a string, the back-end, as a symbol, and the
  1621. communication channel, as a plist. It must return a string or
  1622. nil.")
  1623. (defvar org-export-filter-statistics-cookie-functions nil
  1624. "List of functions applied to a transcoded statistics-cookie.
  1625. Each filter is called with three arguments: the transcoded
  1626. statistics-cookie, as a string, the back-end, as a symbol, and
  1627. the communication channel, as a plist. It must return a string
  1628. or nil.")
  1629. (defvar org-export-filter-subscript-functions nil
  1630. "List of functions applied to a transcoded subscript.
  1631. Each filter is called with three arguments: the transcoded
  1632. subscript, as a string, the back-end, as a symbol, and the
  1633. communication channel, as a plist. It must return a string or
  1634. nil.")
  1635. (defvar org-export-filter-superscript-functions nil
  1636. "List of functions applied to a transcoded superscript.
  1637. Each filter is called with three arguments: the transcoded
  1638. superscript, as a string, the back-end, as a symbol, and the
  1639. communication channel, as a plist. It must return a string or
  1640. nil.")
  1641. (defvar org-export-filter-target-functions nil
  1642. "List of functions applied to a transcoded target.
  1643. Each filter is called with three arguments: the transcoded
  1644. target, as a string, the back-end, as a symbol, and the
  1645. communication channel, as a plist. It must return a string or
  1646. nil.")
  1647. (defvar org-export-filter-time-stamp-functions nil
  1648. "List of functions applied to a transcoded time-stamp.
  1649. Each filter is called with three arguments: the transcoded
  1650. time-stamp, as a string, the back-end, as a symbol, and the
  1651. communication channel, as a plist. It must return a string or
  1652. nil.")
  1653. (defvar org-export-filter-verbatim-functions nil
  1654. "List of functions applied to a transcoded verbatim.
  1655. Each filter is called with three arguments: the transcoded
  1656. verbatim, as a string, the back-end, as a symbol, and the
  1657. communication channel, as a plist. It must return a string or
  1658. nil.")
  1659. (defun org-export-filter-apply-functions (filters value backend info)
  1660. "Call every function in FILTERS with arguments VALUE, BACKEND and INFO.
  1661. Functions are called in a LIFO fashion, to be sure that developer
  1662. specified filters, if any, are called first."
  1663. (loop for filter in filters
  1664. if (not value) return nil else
  1665. do (setq value (funcall filter value backend info)))
  1666. value)
  1667. (defun org-export-install-filters (backend info)
  1668. "Install filters properties in communication channel.
  1669. BACKEND is a symbol specifying which back-end specific filters to
  1670. install, if any. INFO is a plist containing the current
  1671. communication channel.
  1672. Return the updated communication channel."
  1673. (let (plist)
  1674. ;; Install user defined filters with `org-export-filters-alist'.
  1675. (mapc (lambda (p)
  1676. (setq plist (plist-put plist (car p) (eval (cdr p)))))
  1677. org-export-filters-alist)
  1678. ;; Prepend back-end specific filters to that list.
  1679. (let ((back-end-filters (intern (format "org-%s-filters-alist" backend))))
  1680. (when (boundp back-end-filters)
  1681. (mapc (lambda (p)
  1682. ;; Single values get consed, lists are prepended.
  1683. (let ((key (car p)) (value (cdr p)))
  1684. (when value
  1685. (setq plist
  1686. (plist-put
  1687. plist key
  1688. (if (atom value) (cons value (plist-get plist key))
  1689. (append value (plist-get plist key))))))))
  1690. (eval back-end-filters))))
  1691. ;; Return new communication channel.
  1692. (org-combine-plists info plist)))
  1693. ;;; Core functions
  1694. ;; This is the room for the main function, `org-export-as', along with
  1695. ;; its derivatives, `org-export-to-buffer' and `org-export-to-file'.
  1696. ;; They differ only by the way they output the resulting code.
  1697. ;; `org-export-output-file-name' is an auxiliary function meant to be
  1698. ;; used with `org-export-to-file'. With a given extension, it tries
  1699. ;; to provide a canonical file name to write export output to.
  1700. ;; Note that `org-export-as' doesn't really parse the current buffer,
  1701. ;; but a copy of it (with the same buffer-local variables and
  1702. ;; visibility), where include keywords are expanded and Babel blocks
  1703. ;; are executed, if appropriate.
  1704. ;; `org-export-with-current-buffer-copy' macro prepares that copy.
  1705. ;; File inclusion is taken care of by
  1706. ;; `org-export-expand-include-keyword' and
  1707. ;; `org-export-prepare-file-contents'. Structure wise, including
  1708. ;; a whole Org file in a buffer often makes little sense. For
  1709. ;; example, if the file contains an headline and the include keyword
  1710. ;; was within an item, the item should contain the headline. That's
  1711. ;; why file inclusion should be done before any structure can be
  1712. ;; associated to the file, that is before parsing.
  1713. (defun org-export-as
  1714. (backend &optional subtreep visible-only body-only ext-plist noexpand)
  1715. "Transcode current Org buffer into BACKEND code.
  1716. If narrowing is active in the current buffer, only transcode its
  1717. narrowed part.
  1718. If a region is active, transcode that region.
  1719. When optional argument SUBTREEP is non-nil, transcode the
  1720. sub-tree at point, extracting information from the headline
  1721. properties first.
  1722. When optional argument VISIBLE-ONLY is non-nil, don't export
  1723. contents of hidden elements.
  1724. When optional argument BODY-ONLY is non-nil, only return body
  1725. code, without preamble nor postamble.
  1726. Optional argument EXT-PLIST, when provided, is a property list
  1727. with external parameters overriding Org default settings, but
  1728. still inferior to file-local settings.
  1729. Optional argument NOEXPAND, when non-nil, prevents included files
  1730. to be expanded and Babel code to be executed.
  1731. Return code as a string."
  1732. (save-excursion
  1733. (save-restriction
  1734. ;; Narrow buffer to an appropriate region for parsing.
  1735. (when (org-region-active-p)
  1736. (narrow-to-region (region-beginning) (region-end)))
  1737. (when (and subtreep (not (org-at-heading-p)))
  1738. ;; Ensure point is at sub-tree's beginning.
  1739. (org-narrow-to-subtree))
  1740. ;; Retrieve export options (INFO) and parsed tree (RAW-DATA),
  1741. ;; Then options can be completed with tree properties. Note:
  1742. ;; Buffer isn't parsed directly. Instead, a temporary copy is
  1743. ;; created, where include keywords are expanded and code blocks
  1744. ;; are evaluated. RAW-DATA is the parsed tree of the buffer
  1745. ;; resulting from that process. Eventually call
  1746. ;; `org-export-filter-parse-tree-functions'.
  1747. (goto-char (point-min))
  1748. (let ((info (org-export-get-environment backend subtreep ext-plist)))
  1749. ;; Remove subtree's headline from contents if subtree mode is
  1750. ;; activated.
  1751. (when subtreep (forward-line) (narrow-to-region (point) (point-max)))
  1752. ;; Install filters in communication channel.
  1753. (setq info (org-export-install-filters backend info))
  1754. (let ((raw-data
  1755. (org-export-filter-apply-functions
  1756. (plist-get info :filter-parse-tree)
  1757. ;; If NOEXPAND is non-nil, simply parse current
  1758. ;; visible part of buffer.
  1759. (if noexpand (org-element-parse-buffer nil visible-only)
  1760. (org-export-with-current-buffer-copy
  1761. (org-export-expand-include-keyword nil)
  1762. (let ((org-current-export-file (current-buffer)))
  1763. (org-export-blocks-preprocess))
  1764. (org-element-parse-buffer nil visible-only)))
  1765. backend info)))
  1766. ;; Complete communication channel with tree properties.
  1767. (setq info
  1768. (org-combine-plists
  1769. info
  1770. (org-export-collect-tree-properties raw-data info backend)))
  1771. ;; Transcode RAW-DATA. Also call
  1772. ;; `org-export-filter-final-output-functions'.
  1773. (let* ((body (org-element-normalize-string
  1774. (org-export-data raw-data backend info)))
  1775. (template (intern (format "org-%s-template" backend)))
  1776. (output (org-export-filter-apply-functions
  1777. (plist-get info :filter-final-output)
  1778. (if (or (not (fboundp template)) body-only) body
  1779. (funcall template body info))
  1780. backend info)))
  1781. ;; Maybe add final OUTPUT to kill ring before returning it.
  1782. (when org-export-copy-to-kill-ring (org-kill-new output))
  1783. output))))))
  1784. (defun org-export-to-buffer
  1785. (backend buffer &optional subtreep visible-only body-only ext-plist noexpand)
  1786. "Call `org-export-as' with output to a specified buffer.
  1787. BACKEND is the back-end used for transcoding, as a symbol.
  1788. BUFFER is the output buffer. If it already exists, it will be
  1789. erased first, otherwise, it will be created.
  1790. Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
  1791. and NOEXPAND are similar to those used in `org-export-as', which
  1792. see.
  1793. Return buffer."
  1794. (let ((out (org-export-as
  1795. backend subtreep visible-only body-only ext-plist noexpand))
  1796. (buffer (get-buffer-create buffer)))
  1797. (with-current-buffer buffer
  1798. (erase-buffer)
  1799. (insert out)
  1800. (goto-char (point-min)))
  1801. buffer))
  1802. (defun org-export-to-file
  1803. (backend file &optional subtreep visible-only body-only ext-plist noexpand)
  1804. "Call `org-export-as' with output to a specified file.
  1805. BACKEND is the back-end used for transcoding, as a symbol. FILE
  1806. is the name of the output file, as a string.
  1807. Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY, EXT-PLIST
  1808. and NOEXPAND are similar to those used in `org-export-as', which
  1809. see.
  1810. Return output file's name."
  1811. ;; Checks for FILE permissions. `write-file' would do the same, but
  1812. ;; we'd rather avoid needless transcoding of parse tree.
  1813. (unless (file-writable-p file) (error "Output file not writable"))
  1814. ;; Insert contents to a temporary buffer and write it to FILE.
  1815. (let ((out (org-export-as
  1816. backend subtreep visible-only body-only ext-plist noexpand)))
  1817. (with-temp-buffer
  1818. (insert out)
  1819. (let ((coding-system-for-write org-export-coding-system))
  1820. (write-file file))))
  1821. ;; Return full path.
  1822. file)
  1823. (defun org-export-output-file-name (extension &optional subtreep pub-dir)
  1824. "Return output file's name according to buffer specifications.
  1825. EXTENSION is a string representing the output file extension,
  1826. with the leading dot.
  1827. With a non-nil optional argument SUBTREEP, try to determine
  1828. output file's name by looking for \"EXPORT_FILE_NAME\" property
  1829. of subtree at point.
  1830. When optional argument PUB-DIR is set, use it as the publishing
  1831. directory.
  1832. Return file name as a string, or nil if it couldn't be
  1833. determined."
  1834. (let ((base-name
  1835. ;; File name may come from EXPORT_FILE_NAME subtree property,
  1836. ;; assuming point is at beginning of said sub-tree.
  1837. (file-name-sans-extension
  1838. (or (and subtreep
  1839. (org-entry-get
  1840. (save-excursion
  1841. (ignore-errors
  1842. (org-back-to-heading (not visible-only)) (point)))
  1843. "EXPORT_FILE_NAME" t))
  1844. ;; File name may be extracted from buffer's associated
  1845. ;; file, if any.
  1846. (buffer-file-name (buffer-base-buffer))
  1847. ;; Can't determine file name on our own: Ask user.
  1848. (let ((read-file-name-function
  1849. (and org-completion-use-ido 'ido-read-file-name)))
  1850. (read-file-name
  1851. "Output file: " pub-dir nil nil nil
  1852. (lambda (name)
  1853. (string= (file-name-extension name t) extension))))))))
  1854. ;; Build file name. Enforce EXTENSION over whatever user may have
  1855. ;; come up with. PUB-DIR, if defined, always has precedence over
  1856. ;; any provided path.
  1857. (cond
  1858. (pub-dir
  1859. (concat (file-name-as-directory pub-dir)
  1860. (file-name-nondirectory base-name)
  1861. extension))
  1862. ((string= (file-name-nondirectory base-name) base-name)
  1863. (concat (file-name-as-directory ".") base-name extension))
  1864. (t (concat base-name extension)))))
  1865. (defmacro org-export-with-current-buffer-copy (&rest body)
  1866. "Apply BODY in a copy of the current buffer.
  1867. The copy preserves local variables and visibility of the original
  1868. buffer.
  1869. Point is at buffer's beginning when BODY is applied."
  1870. (org-with-gensyms (original-buffer offset buffer-string overlays)
  1871. `(let ((,original-buffer ,(current-buffer))
  1872. (,offset ,(1- (point-min)))
  1873. (,buffer-string ,(buffer-string))
  1874. (,overlays (mapcar
  1875. 'copy-overlay (overlays-in (point-min) (point-max)))))
  1876. (with-temp-buffer
  1877. (let ((buffer-invisibility-spec nil))
  1878. (org-clone-local-variables
  1879. ,original-buffer
  1880. "^\\(org-\\|orgtbl-\\|major-mode$\\|outline-\\(regexp\\|level\\)$\\)")
  1881. (insert ,buffer-string)
  1882. (mapc (lambda (ov)
  1883. (move-overlay
  1884. ov
  1885. (- (overlay-start ov) ,offset)
  1886. (- (overlay-end ov) ,offset)
  1887. (current-buffer)))
  1888. ,overlays)
  1889. (goto-char (point-min))
  1890. (progn ,@body))))))
  1891. (def-edebug-spec org-export-with-current-buffer-copy (body))
  1892. (defun org-export-expand-include-keyword (included)
  1893. "Expand every include keyword in buffer.
  1894. INCLUDED is a list of included file names along with their line
  1895. restriction, when appropriate. It is used to avoid infinite
  1896. recursion."
  1897. (let ((case-fold-search nil))
  1898. (goto-char (point-min))
  1899. (while (re-search-forward "^[ \t]*#\\+include: \\(.*\\)" nil t)
  1900. (when (eq (car (save-match-data (org-element-at-point))) 'keyword)
  1901. (beginning-of-line)
  1902. ;; Extract arguments from keyword's value.
  1903. (let* ((value (match-string 1))
  1904. (ind (org-get-indentation))
  1905. (file (and (string-match "^\"\\(\\S-+\\)\"" value)
  1906. (prog1 (expand-file-name (match-string 1 value))
  1907. (setq value (replace-match "" nil nil value)))))
  1908. (lines
  1909. (and (string-match
  1910. ":lines +\"\\(\\(?:[0-9]+\\)?-\\(?:[0-9]+\\)?\\)\"" value)
  1911. (prog1 (match-string 1 value)
  1912. (setq value (replace-match "" nil nil value)))))
  1913. (env (cond ((string-match "\\<example\\>" value) 'example)
  1914. ((string-match "\\<src\\(?: +\\(.*\\)\\)?" value)
  1915. (match-string 1 value))))
  1916. ;; Minimal level of included file defaults to the child
  1917. ;; level of the current headline, if any, or one. It
  1918. ;; only applies is the file is meant to be included as
  1919. ;; an Org one.
  1920. (minlevel
  1921. (and (not env)
  1922. (if (string-match ":minlevel +\\([0-9]+\\)" value)
  1923. (prog1 (string-to-number (match-string 1 value))
  1924. (setq value (replace-match "" nil nil value)))
  1925. (let ((cur (org-current-level)))
  1926. (if cur (1+ (org-reduced-level cur)) 1))))))
  1927. ;; Remove keyword.
  1928. (delete-region (point) (progn (forward-line) (point)))
  1929. (cond
  1930. ((not (file-readable-p file)) (error "Cannot include file %s" file))
  1931. ;; Check if files has already been parsed. Look after
  1932. ;; inclusion lines too, as different parts of the same file
  1933. ;; can be included too.
  1934. ((member (list file lines) included)
  1935. (error "Recursive file inclusion: %s" file))
  1936. (t
  1937. (cond
  1938. ((eq env 'example)
  1939. (insert
  1940. (let ((ind-str (make-string ind ? ))
  1941. (contents
  1942. ;; Protect sensitive contents with commas.
  1943. (replace-regexp-in-string
  1944. "\\(^\\)\\([*]\\|[ \t]*#\\+\\)" ","
  1945. (org-export-prepare-file-contents file lines)
  1946. nil nil 1)))
  1947. (format "%s#+begin_example\n%s%s#+end_example\n"
  1948. ind-str contents ind-str))))
  1949. ((stringp env)
  1950. (insert
  1951. (let ((ind-str (make-string ind ? ))
  1952. (contents
  1953. ;; Protect sensitive contents with commas.
  1954. (replace-regexp-in-string
  1955. (if (string= env "org") "\\(^\\)\\(.\\)"
  1956. "\\(^\\)\\([*]\\|[ \t]*#\\+\\)") ","
  1957. (org-export-prepare-file-contents file lines)
  1958. nil nil 1)))
  1959. (format "%s#+begin_src %s\n%s%s#+end_src\n"
  1960. ind-str env contents ind-str))))
  1961. (t
  1962. (insert
  1963. (with-temp-buffer
  1964. (org-mode)
  1965. (insert
  1966. (org-export-prepare-file-contents file lines ind minlevel))
  1967. (org-export-expand-include-keyword
  1968. (cons (list file lines) included))
  1969. (buffer-string))))))))))))
  1970. (defun org-export-prepare-file-contents (file &optional lines ind minlevel)
  1971. "Prepare the contents of FILE for inclusion and return them as a string.
  1972. When optional argument LINES is a string specifying a range of
  1973. lines, include only those lines.
  1974. Optional argument IND, when non-nil, is an integer specifying the
  1975. global indentation of returned contents. Since its purpose is to
  1976. allow an included file to stay in the same environment it was
  1977. created \(i.e. a list item), it doesn't apply past the first
  1978. headline encountered.
  1979. Optional argument MINLEVEL, when non-nil, is an integer
  1980. specifying the level that any top-level headline in the included
  1981. file should have."
  1982. (with-temp-buffer
  1983. (insert-file-contents file)
  1984. (when lines
  1985. (let* ((lines (split-string lines "-"))
  1986. (lbeg (string-to-number (car lines)))
  1987. (lend (string-to-number (cadr lines)))
  1988. (beg (if (zerop lbeg) (point-min)
  1989. (goto-char (point-min))
  1990. (forward-line (1- lbeg))
  1991. (point)))
  1992. (end (if (zerop lend) (point-max)
  1993. (goto-char (point-min))
  1994. (forward-line (1- lend))
  1995. (point))))
  1996. (narrow-to-region beg end)))
  1997. ;; Remove blank lines at beginning and end of contents. The logic
  1998. ;; behind that removal is that blank lines around include keyword
  1999. ;; override blank lines in included file.
  2000. (goto-char (point-min))
  2001. (org-skip-whitespace)
  2002. (beginning-of-line)
  2003. (delete-region (point-min) (point))
  2004. (goto-char (point-max))
  2005. (skip-chars-backward " \r\t\n")
  2006. (forward-line)
  2007. (delete-region (point) (point-max))
  2008. ;; If IND is set, preserve indentation of include keyword until
  2009. ;; the first headline encountered.
  2010. (when ind
  2011. (unless (eq major-mode 'org-mode) (org-mode))
  2012. (goto-char (point-min))
  2013. (let ((ind-str (make-string ind ? )))
  2014. (while (not (or (eobp) (looking-at org-outline-regexp-bol)))
  2015. ;; Do not move footnote definitions out of column 0.
  2016. (unless (and (looking-at org-footnote-definition-re)
  2017. (eq (car (org-element-at-point)) 'footnote-definition))
  2018. (insert ind-str))
  2019. (forward-line))))
  2020. ;; When MINLEVEL is specified, compute minimal level for headlines
  2021. ;; in the file (CUR-MIN), and remove stars to each headline so
  2022. ;; that headlines with minimal level have a level of MINLEVEL.
  2023. (when minlevel
  2024. (unless (eq major-mode 'org-mode) (org-mode))
  2025. (let ((levels (org-map-entries
  2026. (lambda () (org-reduced-level (org-current-level))))))
  2027. (when levels
  2028. (let ((offset (- minlevel (apply 'min levels))))
  2029. (unless (zerop offset)
  2030. (when org-odd-levels-only (setq offset (* offset 2)))
  2031. ;; Only change stars, don't bother moving whole
  2032. ;; sections.
  2033. (org-map-entries
  2034. (lambda () (if (< offset 0) (delete-char (abs offset))
  2035. (insert (make-string offset ?*))))))))))
  2036. (buffer-string)))
  2037. ;;; Tools For Back-Ends
  2038. ;; A whole set of tools is available to help build new exporters. Any
  2039. ;; function general enough to have its use across many back-ends
  2040. ;; should be added here.
  2041. ;; As of now, functions operating on footnotes, headlines, links,
  2042. ;; macros, references, src-blocks, tables and tables of contents are
  2043. ;; implemented.
  2044. ;;;; For Footnotes
  2045. ;; `org-export-collect-footnote-definitions' is a tool to list
  2046. ;; actually used footnotes definitions in the whole parse tree, or in
  2047. ;; an headline, in order to add footnote listings throughout the
  2048. ;; transcoded data.
  2049. ;; `org-export-footnote-first-reference-p' is a predicate used by some
  2050. ;; back-ends, when they need to attach the footnote definition only to
  2051. ;; the first occurrence of the corresponding label.
  2052. ;; `org-export-get-footnote-definition' and
  2053. ;; `org-export-get-footnote-number' provide easier access to
  2054. ;; additional information relative to a footnote reference.
  2055. (defun org-export-collect-footnote-definitions (data info)
  2056. "Return an alist between footnote numbers, labels and definitions.
  2057. DATA is the parse tree from which definitions are collected.
  2058. INFO is the plist used as a communication channel.
  2059. Definitions are sorted by order of references. They either
  2060. appear as Org data \(transcoded with `org-export-data'\) or as
  2061. a secondary string for inlined footnotes \(transcoded with
  2062. `org-export-secondary-string'\). Unreferenced definitions are
  2063. ignored."
  2064. (let (refs)
  2065. ;; Collect seen references in REFS.
  2066. (org-element-map
  2067. data 'footnote-reference
  2068. (lambda (footnote local)
  2069. (when (org-export-footnote-first-reference-p footnote local)
  2070. (list (org-export-get-footnote-number footnote local)
  2071. (org-element-get-property :label footnote)
  2072. (org-export-get-footnote-definition footnote local))))
  2073. info)))
  2074. (defun org-export-footnote-first-reference-p (footnote-reference info)
  2075. "Non-nil when a footnote reference is the first one for its label.
  2076. FOOTNOTE-REFERENCE is the footnote reference being considered.
  2077. INFO is the plist used as a communication channel."
  2078. (let ((label (org-element-get-property :label footnote-reference)))
  2079. (or (not label)
  2080. (equal
  2081. footnote-reference
  2082. (org-element-map
  2083. (plist-get info :parse-tree) 'footnote-reference
  2084. (lambda (footnote local)
  2085. (when (string= (org-element-get-property :label footnote) label)
  2086. footnote))
  2087. info 'first-match)))))
  2088. (defun org-export-get-footnote-definition (footnote-reference info)
  2089. "Return definition of FOOTNOTE-REFERENCE as parsed data.
  2090. INFO is the plist used as a communication channel."
  2091. (let ((label (org-element-get-property :label footnote-reference)))
  2092. (or (org-element-get-property :inline-definition footnote-reference)
  2093. (cdr (assoc label (plist-get info :footnote-definition-alist))))))
  2094. (defun org-export-get-footnote-number (footnote info)
  2095. "Return number associated to a footnote.
  2096. FOOTNOTE is either a footnote reference or a footnote definition.
  2097. INFO is the plist used as a communication channel."
  2098. (let ((label (org-element-get-property :label footnote)) seen-refs)
  2099. (org-element-map
  2100. (plist-get info :parse-tree) 'footnote-reference
  2101. (lambda (fn local)
  2102. (let ((fn-lbl (org-element-get-property :label fn)))
  2103. (cond
  2104. ((and (not fn-lbl) (equal fn footnote)) (1+ (length seen-refs)))
  2105. ((and label (string= label fn-lbl)) (1+ (length seen-refs)))
  2106. ;; Anonymous footnote: it's always a new one. Also, be sure
  2107. ;; to return nil from the `cond' so `first-match' doesn't
  2108. ;; get us out of the loop.
  2109. ((not fn-lbl) (push 'inline seen-refs) nil)
  2110. ;; Label not seen so far: add it so SEEN-REFS. Again,
  2111. ;; return nil to stay in the loop.
  2112. ((not (member fn-lbl seen-refs)) (push fn-lbl seen-refs) nil))))
  2113. info 'first-match)))
  2114. ;;;; For Headlines
  2115. ;; `org-export-get-relative-level' is a shortcut to get headline
  2116. ;; level, relatively to the lower headline level in the parsed tree.
  2117. ;; `org-export-get-headline-number' returns the section number of an
  2118. ;; headline, while `org-export-number-to-roman' allows to convert it
  2119. ;; to roman numbers.
  2120. ;; `org-export-low-level-p', `org-export-first-sibling-p' and
  2121. ;; `org-export-last-sibling-p' are three useful predicates when it
  2122. ;; comes to fulfill the `:headline-levels' property.
  2123. (defun org-export-get-relative-level (headline info)
  2124. "Return HEADLINE relative level within current parsed tree.
  2125. INFO is a plist holding contextual information."
  2126. (+ (org-element-get-property :level headline)
  2127. (or (plist-get info :headline-offset) 0)))
  2128. (defun org-export-low-level-p (headline info)
  2129. "Non-nil when HEADLINE is considered as low level.
  2130. INFO is a plist used as a communication channel.
  2131. A low level headlines has a relative level greater than
  2132. `:headline-levels' property value.
  2133. Return value is the difference between HEADLINE relative level
  2134. and the last level being considered as high enough, or nil."
  2135. (let ((limit (plist-get info :headline-levels)))
  2136. (when (wholenump limit)
  2137. (let ((level (org-export-get-relative-level headline info)))
  2138. (and (> level limit) (- level limit))))))
  2139. (defun org-export-get-headline-number (headline info)
  2140. "Return HEADLINE numbering as a list of numbers.
  2141. INFO is a plist holding contextual information."
  2142. (cdr (assoc headline (plist-get info :headline-numbering))))
  2143. (defun org-export-number-to-roman (n)
  2144. "Convert integer N into a roman numeral."
  2145. (let ((roman '((1000 . "M") (900 . "CM") (500 . "D") (400 . "CD")
  2146. ( 100 . "C") ( 90 . "XC") ( 50 . "L") ( 40 . "XL")
  2147. ( 10 . "X") ( 9 . "IX") ( 5 . "V") ( 4 . "IV")
  2148. ( 1 . "I")))
  2149. (res ""))
  2150. (if (<= n 0)
  2151. (number-to-string n)
  2152. (while roman
  2153. (if (>= n (caar roman))
  2154. (setq n (- n (caar roman))
  2155. res (concat res (cdar roman)))
  2156. (pop roman)))
  2157. res)))
  2158. (defun org-export-first-sibling-p (headline info)
  2159. "Non-nil when HEADLINE is the first sibling in its sub-tree.
  2160. INFO is the plist used as a communication channel."
  2161. (not (eq (car (org-export-get-previous-element headline info)) 'headline)))
  2162. (defun org-export-last-sibling-p (headline info)
  2163. "Non-nil when HEADLINE is the last sibling in its sub-tree.
  2164. INFO is the plist used as a communication channel."
  2165. (equal
  2166. (car (last (org-element-get-contents (car (plist-get info :genealogy)))))
  2167. headline))
  2168. ;;;; For Links
  2169. ;; `org-export-solidify-link-text' turns a string into a safer version
  2170. ;; for links, replacing most non-standard characters with hyphens.
  2171. ;; `org-export-get-coderef-format' returns an appropriate format
  2172. ;; string for coderefs.
  2173. ;; `org-export-inline-image-p' returns a non-nil value when the link
  2174. ;; provided should be considered as an inline image.
  2175. ;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
  2176. ;; (i.e. links with "fuzzy" as type) within the parsed tree, and
  2177. ;; returns an appropriate unique identifier when found, or nil.
  2178. ;; `org-export-resolve-id-link' returns the first headline with
  2179. ;; specified id or custom-id in parse tree, or nil when none was
  2180. ;; found.
  2181. ;; `org-export-resolve-coderef' associates a reference to a line
  2182. ;; number in the element it belongs, or returns the reference itself
  2183. ;; when the element isn't numbered.
  2184. (defun org-export-solidify-link-text (s)
  2185. "Take link text S and make a safe target out of it."
  2186. (save-match-data
  2187. (mapconcat 'identity (org-split-string s "[^a-zA-Z0-9_.-]+") "-")))
  2188. (defun org-export-get-coderef-format (path desc)
  2189. "Return format string for code reference link.
  2190. PATH is the link path. DESC is its description."
  2191. (save-match-data
  2192. (cond ((string-match (regexp-quote (concat "(" path ")")) desc)
  2193. (replace-match "%s" t t desc))
  2194. ((string= desc "") "%s")
  2195. (t desc))))
  2196. (defun org-export-inline-image-p (link &optional rules)
  2197. "Non-nil if LINK object points to an inline image.
  2198. Optional argument is a set of RULES defining inline images. It
  2199. is an alist where associations have the following shape:
  2200. \(TYPE . REGEXP)
  2201. Applying a rule means apply REGEXP against LINK's path when its
  2202. type is TYPE. The function will return a non-nil value if any of
  2203. the provided rules is non-nil. The default rule is
  2204. `org-export-default-inline-image-rule'.
  2205. This only applies to links without a description."
  2206. (and (not (org-element-get-contents link))
  2207. (let ((case-fold-search t)
  2208. (rules (or rules org-export-default-inline-image-rule)))
  2209. (some
  2210. (lambda (rule)
  2211. (and (string= (org-element-get-property :type link) (car rule))
  2212. (string-match (cdr rule)
  2213. (org-element-get-property :path link))))
  2214. rules))))
  2215. (defun org-export-resolve-fuzzy-link (link info)
  2216. "Return LINK destination.
  2217. INFO is a plist holding contextual information.
  2218. Return value can be an object, an element, or nil:
  2219. - If LINK path exactly matches any target, return the target
  2220. object.
  2221. - If LINK path exactly matches any headline name, return that
  2222. element. If more than one headline share that name, priority
  2223. will be given to the one with the closest common ancestor, if
  2224. any, or the first one in the parse tree otherwise.
  2225. - Otherwise, return nil.
  2226. Assume LINK type is \"fuzzy\"."
  2227. (let ((path (org-element-get-property :path link)))
  2228. ;; Link points to a target: return it.
  2229. (or (loop for target in (plist-get info :target-list)
  2230. when (string= (org-element-get-property :raw-value target) path)
  2231. return target)
  2232. ;; Link either points to an headline or nothing. Try to find
  2233. ;; the source, with priority given to headlines with the closest
  2234. ;; common ancestor. If such candidate is found, return its
  2235. ;; beginning position as an unique identifier, otherwise return
  2236. ;; nil.
  2237. (let ((find-headline
  2238. (function
  2239. ;; Return first headline whose `:raw-value' property
  2240. ;; is NAME in parse tree DATA, or nil.
  2241. (lambda (name data)
  2242. (org-element-map
  2243. data 'headline
  2244. (lambda (headline local)
  2245. (when (string=
  2246. (org-element-get-property :raw-value headline)
  2247. name)
  2248. headline))
  2249. info 'first-match)))))
  2250. ;; Search among headlines sharing an ancestor with link,
  2251. ;; from closest to farthest.
  2252. (or (catch 'exit
  2253. (mapc
  2254. (lambda (parent)
  2255. (when (eq (car parent) 'headline)
  2256. (let ((foundp (funcall find-headline path parent)))
  2257. (when foundp (throw 'exit foundp)))))
  2258. (plist-get info :genealogy)) nil)
  2259. ;; No match with a common ancestor: try the full parse-tree.
  2260. (funcall find-headline path (plist-get info :parse-tree)))))))
  2261. (defun org-export-resolve-id-link (link info)
  2262. "Return headline referenced as LINK destination.
  2263. INFO is a plist used as a communication channel.
  2264. Return value can be an headline element or nil. Assume LINK type
  2265. is either \"id\" or \"custom-id\"."
  2266. (let ((id (org-element-get-property :path link)))
  2267. (org-element-map
  2268. (plist-get info :parse-tree) 'headline
  2269. (lambda (headline local)
  2270. (when (or (string= (org-element-get-property :id headline) id)
  2271. (string= (org-element-get-property :custom-id headline) id))
  2272. headline))
  2273. info 'first-match)))
  2274. (defun org-export-resolve-ref-link (link info)
  2275. "Return element referenced as LINK destination.
  2276. INFO is a plist used as a communication channel.
  2277. Assume LINK type is \"ref\" and. Return value is the first
  2278. element whose `:name' property matches LINK's `:path', or nil."
  2279. (let ((name (org-element-get-property :path link)))
  2280. (org-element-map
  2281. (plist-get info :parse-tree) org-element-all-elements
  2282. (lambda (el local)
  2283. (when (string= (org-element-get-property :name el) name) el))
  2284. info 'first-match)))
  2285. (defun org-export-resolve-coderef (ref info)
  2286. "Resolve a code reference REF.
  2287. INFO is a plist used as a communication channel.
  2288. Return associated line number in source code, or REF itself,
  2289. depending on src-block or example element's switches."
  2290. (org-element-map
  2291. (plist-get info :parse-tree) '(src-block example)
  2292. (lambda (el local)
  2293. (let ((switches (or (org-element-get-property :switches el) "")))
  2294. (with-temp-buffer
  2295. (insert (org-trim (org-element-get-property :value el)))
  2296. ;; Build reference regexp.
  2297. (let* ((label
  2298. (or (and (string-match "-l +\"\\([^\"\n]+\\)\"" switches)
  2299. (match-string 1 switches))
  2300. org-coderef-label-format))
  2301. (ref-re
  2302. (format "^.*?\\S-.*?\\([ \t]*\\(%s\\)\\)[ \t]*$"
  2303. (replace-regexp-in-string "%s" ref label nil t))))
  2304. ;; Element containing REF is found. Only associate REF to
  2305. ;; a line number if element has "+n" or "-n" and "-k" or
  2306. ;; "-r" as switches. When it has "+n", count accumulated
  2307. ;; locs before, too.
  2308. (when (re-search-backward ref-re nil t)
  2309. (cond
  2310. ((not (string-match "-[kr]\\>" switches)) ref)
  2311. ((string-match "-n\\>" switches) (line-number-at-pos))
  2312. ((string-match "\\+n\\>" switches)
  2313. (+ (org-export-get-loc el local) (line-number-at-pos)))
  2314. (t ref)))))))
  2315. info 'first-match))
  2316. ;;;; For Macros
  2317. ;; `org-export-expand-macro' simply takes care of expanding macros.
  2318. (defun org-export-expand-macro (macro info)
  2319. "Expand MACRO and return it as a string.
  2320. INFO is a plist holding export options."
  2321. (let* ((key (org-element-get-property :key macro))
  2322. (args (org-element-get-property :args macro))
  2323. ;; User's macros are stored in the communication channel with
  2324. ;; a ":macro-" prefix. If it's a string leave it as-is.
  2325. ;; Otherwise, it's a secondary string that needs to be
  2326. ;; expanded recursively.
  2327. (value
  2328. (let ((val (plist-get info (intern (format ":macro-%s" key)))))
  2329. (if (stringp val) val
  2330. (org-export-secondary-string
  2331. val (plist-get info :back-end) info)))))
  2332. ;; Replace arguments in VALUE.
  2333. (let ((s 0) n)
  2334. (while (string-match "\\$\\([0-9]+\\)" value s)
  2335. (setq s (1+ (match-beginning 0))
  2336. n (string-to-number (match-string 1 value)))
  2337. (and (>= (length args) n)
  2338. (setq value (replace-match (nth (1- n) args) t t value)))))
  2339. ;; VALUE starts with "(eval": it is a s-exp, `eval' it.
  2340. (when (string-match "\\`(eval\\>" value)
  2341. (setq value (eval (read value))))
  2342. ;; Return string.
  2343. (format "%s" (or value ""))))
  2344. ;;;; For References
  2345. ;; `org-export-get-ordinal' associates a sequence number to any object
  2346. ;; or element.
  2347. (defun org-export-get-ordinal
  2348. (element info &optional types within-section predicate)
  2349. "Return ordinal number of an element or object.
  2350. ELEMENT is the element or object considered. INFO is the plist
  2351. used as a communication channel.
  2352. Optional argument TYPES, when non-nil, is a list of element or
  2353. object types, as symbols, that should also be counted in.
  2354. Otherwise, only provided element's type is considered.
  2355. When optional argument WITHIN-SECTION is non-nil, narrow counting
  2356. to the section containing ELEMENT.
  2357. Optional argument PREDICATE is a function returning a non-nil
  2358. value if the current element or object should be counted in. It
  2359. accepts one argument: the element or object being considered.
  2360. This argument allows to count only a certain type of objects,
  2361. like inline images, which are a subset of links \(in that case,
  2362. `org-export-inline-image-p' might be an useful predicate\)."
  2363. (let ((counter 0)
  2364. ;; Determine if search should apply to current section, in
  2365. ;; which case it should be retrieved first, or to full parse
  2366. ;; tree. As a special case, an element or object without
  2367. ;; a parent headline will also trigger a full search,
  2368. ;; notwithstanding WITHIN-SECTION value.
  2369. (data
  2370. (if (not within-section) (plist-get info :parse-tree)
  2371. (or (org-export-get-parent-headline element info)
  2372. (plist-get info :parse-tree)))))
  2373. ;; Increment counter until ELEMENT is found again.
  2374. (org-element-map
  2375. data (or types (car element))
  2376. (lambda (el local)
  2377. (cond
  2378. ((equal element el) (1+ counter))
  2379. ((not predicate) (incf counter) nil)
  2380. ((funcall predicate el) (incf counter) nil)))
  2381. info 'first-match)))
  2382. ;;;; For Src-Blocks
  2383. ;; `org-export-get-loc' counts number of code lines accumulated in
  2384. ;; src-block or example-block elements with a "+n" switch until
  2385. ;; a given element, excluded. Note: "-n" switches reset that count.
  2386. ;; `org-export-handle-code' takes care of line numbering and reference
  2387. ;; cleaning in source code, when appropriate.
  2388. (defun org-export-get-loc (element info)
  2389. "Return accumulated lines of code up to ELEMENT.
  2390. INFO is the plist used as a communication channel.
  2391. ELEMENT is excluded from count."
  2392. (let ((loc 0))
  2393. (org-element-map
  2394. (plist-get info :parse-tree) `(src-block example-block ,(car element))
  2395. (lambda (el local)
  2396. (cond
  2397. ;; ELEMENT is reached: Quit the loop.
  2398. ((equal el element) t)
  2399. ;; Only count lines from src-block and example-block elements
  2400. ;; with a "+n" or "-n" switch. A "-n" switch resets counter.
  2401. ((not (memq (car el) '(src-block example-block))) nil)
  2402. ((let ((switches (org-element-get-property :switches el)))
  2403. (when (and switches (string-match "\\([-+]\\)n\\>" switches))
  2404. ;; Accumulate locs or reset them.
  2405. (let ((accumulatep (string= (match-string 1 switches) "-"))
  2406. (lines (org-count-lines
  2407. (org-trim (org-element-get-property :value el)))))
  2408. (setq loc (if accumulatep lines (+ loc lines))))))
  2409. ;; Return nil to stay in the loop.
  2410. nil)))
  2411. info 'first-match)
  2412. ;; Return value.
  2413. loc))
  2414. (defun org-export-handle-code (element info &optional num-fmt ref-fmt delayed)
  2415. "Handle line numbers and code references in ELEMENT.
  2416. ELEMENT has either a `src-block' an `example-block' type. INFO
  2417. is a plist used as a communication channel.
  2418. If optional argument NUM-FMT is a string, it will be used as
  2419. a format string for numbers at beginning of each line.
  2420. If optional argument REF-FMT is a string, it will be used as
  2421. a format string for each line of code containing a reference.
  2422. When optional argument DELAYED is non-nil, `org-loc' and
  2423. `org-coderef' properties, set to an adequate value, are applied
  2424. to, respectively, numbered lines and lines with a reference. No
  2425. line numbering is done and all references are stripped from the
  2426. resulting string. Both NUM-FMT and REF-FMT arguments are ignored
  2427. in that situation.
  2428. Return new code as a string."
  2429. (let* ((switches (or (org-element-get-property :switches element) ""))
  2430. (code (org-element-get-property :value element))
  2431. (numberp (string-match "[-+]n\\>" switches))
  2432. (accumulatep (string-match "\\+n\\>" switches))
  2433. ;; Initialize loc counter when any kind of numbering is
  2434. ;; active.
  2435. (total-LOC (cond
  2436. (accumulatep (org-export-get-loc element info))
  2437. (numberp 0)))
  2438. ;; Get code and clean it. Remove blank lines at its
  2439. ;; beginning and end. Also remove protective commas.
  2440. (preserve-indent-p (or org-src-preserve-indentation
  2441. (string-match "-i\\>" switches)))
  2442. (replace-labels (when (string-match "-r\\>" switches)
  2443. (if (string-match "-k\\>" switches) 'keep t)))
  2444. (code (let ((c (replace-regexp-in-string
  2445. "\\`\\([ \t]*\n\\)+" ""
  2446. (replace-regexp-in-string
  2447. "\\(:?[ \t]*\n\\)*[ \t]*\\'" "\n" code))))
  2448. ;; If appropriate, remove global indentation.
  2449. (unless preserve-indent-p (setq c (org-remove-indentation c)))
  2450. ;; Free up the protected lines. Note: Org blocks
  2451. ;; have commas at the beginning or every line.
  2452. (if (string=
  2453. (or (org-element-get-property :language element) "")
  2454. "org")
  2455. (replace-regexp-in-string "^," "" c)
  2456. (replace-regexp-in-string
  2457. "^\\(,\\)\\(:?\\*\\|[ \t]*#\\+\\)" "" c nil nil 1))))
  2458. ;; Split code to process it line by line.
  2459. (code-lines (org-split-string code "\n"))
  2460. ;; If numbering is active, ensure line numbers will be
  2461. ;; correctly padded before applying the format string.
  2462. (num-fmt
  2463. (when (and (not delayed) numberp)
  2464. (format (if (stringp num-fmt) num-fmt "%s: ")
  2465. (format "%%%ds"
  2466. (length (number-to-string
  2467. (+ (length code-lines) total-LOC)))))))
  2468. ;; Get format used for references.
  2469. (label-fmt (or (and (string-match "-l +\"\\([^\"\n]+\\)\"" switches)
  2470. (match-string 1 switches))
  2471. org-coderef-label-format))
  2472. ;; Build a regexp matching a loc with a reference.
  2473. (with-ref-re (format "^.*?\\S-.*?\\([ \t]*\\(%s\\)\\)[ \t]*$"
  2474. (replace-regexp-in-string
  2475. "%s" "\\([-a-zA-Z0-9_ ]+\\)" label-fmt nil t))))
  2476. (org-element-normalize-string
  2477. (mapconcat
  2478. (lambda (loc)
  2479. ;; Maybe add line number to current line of code (LOC).
  2480. (when numberp
  2481. (incf total-LOC)
  2482. (setq loc (if delayed (org-add-props loc nil 'org-loc total-LOC)
  2483. (concat (format num-fmt total-LOC) loc))))
  2484. ;; Take action if at a ref line.
  2485. (when (string-match with-ref-re loc)
  2486. (let ((ref (match-string 3 loc)))
  2487. (setq loc
  2488. ;; Option "-r" without "-k" removes labels.
  2489. ;; A non-nil DELAYED removes labels unconditionally.
  2490. (if (or delayed
  2491. (and replace-labels (not (eq replace-labels 'keep))))
  2492. (replace-match "" nil nil loc 1)
  2493. (replace-match (format "(%s)" ref) nil nil loc 2)))
  2494. ;; Store REF in `org-coderef' property if DELAYED asks to.
  2495. (cond (delayed (setq loc (org-add-props loc nil 'org-coderef ref)))
  2496. ;; If REF-FMT is defined, apply it to current LOC.
  2497. ((stringp ref-fmt) (setq loc (format ref-fmt loc))))))
  2498. ;; Return updated LOC for concatenation.
  2499. loc)
  2500. code-lines "\n"))))
  2501. ;;;; For Tables
  2502. ;; `org-export-table-format-info' extracts formatting information
  2503. ;; (alignment, column groups and presence of a special column) from
  2504. ;; a raw table and returns it as a property list.
  2505. ;;
  2506. ;; `org-export-clean-table' cleans the raw table from any Org
  2507. ;; table-specific syntax.
  2508. (defun org-export-table-format-info (table)
  2509. "Extract info from TABLE.
  2510. Return a plist whose properties and values are:
  2511. `:alignment' vector of strings among \"r\", \"l\" and \"c\",
  2512. `:column-groups' vector of symbols among `start', `end', `start-end',
  2513. `:row-groups' list of integers representing row groups.
  2514. `:special-column-p' non-nil if table has a special column.
  2515. `:width' vector of integers representing desired width of
  2516. current column, or nil."
  2517. (with-temp-buffer
  2518. (insert table)
  2519. (goto-char 1)
  2520. (org-table-align)
  2521. (let ((align (vconcat (mapcar (lambda (c) (if c "r" "l"))
  2522. org-table-last-alignment)))
  2523. (width (make-vector (length org-table-last-alignment) nil))
  2524. (colgroups (make-vector (length org-table-last-alignment) nil))
  2525. (row-group 0)
  2526. (rowgroups)
  2527. (special-column-p 'empty))
  2528. (mapc (lambda (row)
  2529. (if (string-match "^[ \t]*|[-+]+|[ \t]*$" row)
  2530. (incf row-group)
  2531. ;; Determine if a special column is present by looking
  2532. ;; for special markers in the first column. More
  2533. ;; accurately, the first column is considered special
  2534. ;; if it only contains special markers and, maybe,
  2535. ;; empty cells.
  2536. (setq special-column-p
  2537. (cond
  2538. ((not special-column-p) nil)
  2539. ((string-match "^[ \t]*| *\\\\?\\([/#!$*_^]\\) *|" row)
  2540. 'special)
  2541. ((string-match "^[ \t]*| +|" row) special-column-p))))
  2542. (cond
  2543. ;; Read forced alignment and width information, if any,
  2544. ;; and determine final alignment for the table.
  2545. ((org-table-cookie-line-p row)
  2546. (let ((col 0))
  2547. (mapc (lambda (field)
  2548. (when (string-match
  2549. "<\\([lrc]\\)?\\([0-9]+\\)?>" field)
  2550. (let ((align-data (match-string 1 field)))
  2551. (when align-data (aset align col align-data)))
  2552. (let ((w-data (match-string 2 field)))
  2553. (when w-data
  2554. (aset width col (string-to-number w-data)))))
  2555. (incf col))
  2556. (org-split-string row "[ \t]*|[ \t]*"))))
  2557. ;; Read column groups information.
  2558. ((org-table-colgroup-line-p row)
  2559. (let ((col 0))
  2560. (mapc (lambda (field)
  2561. (aset colgroups col
  2562. (cond ((string= "<" field) 'start)
  2563. ((string= ">" field) 'end)
  2564. ((string= "<>" field) 'start-end)))
  2565. (incf col))
  2566. (org-split-string row "[ \t]*|[ \t]*"))))
  2567. ;; Contents line.
  2568. (t (push row-group rowgroups))))
  2569. (org-split-string table "\n"))
  2570. ;; Return plist.
  2571. (list :alignment align
  2572. :column-groups colgroups
  2573. :row-groups (reverse rowgroups)
  2574. :special-column-p (eq special-column-p 'special)
  2575. :width width))))
  2576. (defun org-export-clean-table (table specialp)
  2577. "Clean string TABLE from its formatting elements.
  2578. Remove any row containing column groups or formatting cookies and
  2579. rows starting with a special marker. If SPECIALP is non-nil,
  2580. assume the table contains a special formatting column and remove
  2581. it also."
  2582. (let ((rows (org-split-string table "\n")))
  2583. (mapconcat 'identity
  2584. (delq nil
  2585. (mapcar
  2586. (lambda (row)
  2587. (cond
  2588. ((org-table-colgroup-line-p row) nil)
  2589. ((org-table-cookie-line-p row) nil)
  2590. ;; Ignore rows starting with a special marker.
  2591. ((string-match "^[ \t]*| *[!_^/] *|" row) nil)
  2592. ;; Remove special column.
  2593. ((and specialp
  2594. (or (string-match "^\\([ \t]*\\)|-+\\+" row)
  2595. (string-match "^\\([ \t]*\\)|[^|]*|" row)))
  2596. (replace-match "\\1|" t nil row))
  2597. (t row)))
  2598. rows))
  2599. "\n")))
  2600. ;;;; For Tables Of Contents
  2601. ;; `org-export-collect-headlines' builds a list of all exportable
  2602. ;; headline elements, maybe limited to a certain depth. One can then
  2603. ;; easily parse it and transcode it.
  2604. ;; Building lists of tables, figures or listings is quite similar.
  2605. ;; Once the generic function `org-export-collect-elements' is defined,
  2606. ;; `org-export-collect-tables', `org-export-collect-figures' and
  2607. ;; `org-export-collect-listings' can be derived from it.
  2608. (defun org-export-collect-headlines (info &optional n)
  2609. "Collect headlines in order to build a table of contents.
  2610. INFO is a plist used as a communication channel.
  2611. When non-nil, optional argument N must be an integer. It
  2612. specifies the depth of the table of contents.
  2613. Return a list of all exportable headlines as parsed elements."
  2614. (org-element-map
  2615. (plist-get info :parse-tree)
  2616. 'headline
  2617. (lambda (headline local)
  2618. ;; Strip contents from HEADLINE.
  2619. (let ((relative-level (org-export-get-relative-level headline local)))
  2620. (unless (and n (> relative-level n)) headline)))
  2621. info))
  2622. (defun org-export-collect-elements (type info &optional predicate)
  2623. "Collect referenceable elements of a determined type.
  2624. TYPE can be a symbol or a list of symbols specifying element
  2625. types to search. Only elements with a caption or a name are
  2626. collected.
  2627. INFO is a plist used as a communication channel.
  2628. When non-nil, optional argument PREDICATE is a function accepting
  2629. one argument, an element of type TYPE. It returns a non-nil
  2630. value when that element should be collected.
  2631. Return a list of all elements found, in order of appearance."
  2632. (org-element-map
  2633. (plist-get info :parse-tree) type
  2634. (lambda (element local)
  2635. (and (or (org-element-get-property :caption element)
  2636. (org-element-get-property :name element))
  2637. (or (not predicate) (funcall predicate element))
  2638. element)) info))
  2639. (defun org-export-collect-tables (info)
  2640. "Build a list of tables.
  2641. INFO is a plist used as a communication channel.
  2642. Return a list of table elements with a caption or a name
  2643. affiliated keyword."
  2644. (org-export-collect-elements 'table info))
  2645. (defun org-export-collect-figures (info predicate)
  2646. "Build a list of figures.
  2647. INFO is a plist used as a communication channel. PREDICATE is
  2648. a function which accepts one argument: a paragraph element and
  2649. whose return value is non-nil when that element should be
  2650. collected.
  2651. A figure is a paragraph type element, with a caption or a name,
  2652. verifying PREDICATE. The latter has to be provided since
  2653. a \"figure\" is a vague concept that may depend on back-end.
  2654. Return a list of elements recognized as figures."
  2655. (org-export-collect-elements 'paragraph info predicate))
  2656. (defun org-export-collect-listings (info)
  2657. "Build a list of src blocks.
  2658. INFO is a plist used as a communication channel.
  2659. Return a list of src-block elements with a caption or a name
  2660. affiliated keyword."
  2661. (org-export-collect-elements 'src-block info))
  2662. ;;;; Topology
  2663. ;; Here are various functions to retrieve information about the
  2664. ;; neighbourhood of a given element or object. Neighbours of interest
  2665. ;; are parent headline (`org-export-get-parent-headline'), parent
  2666. ;; paragraph (`org-export-get-parent-paragraph'), previous element or
  2667. ;; object (`org-export-get-previous-element') and next element or
  2668. ;; object (`org-export-get-next-element').
  2669. ;; All of these functions are just a specific use of the more generic
  2670. ;; `org-export-get-genealogy', which returns the genealogy relative to
  2671. ;; the element or object.
  2672. (defun org-export-get-genealogy (blob info)
  2673. "Return genealogy relative to a given element or object.
  2674. BLOB is the element or object being considered. INFO is a plist
  2675. used as a communication channel."
  2676. ;; LOCALP tells if current `:genealogy' is sufficient to find parent
  2677. ;; headline, or if it should be computed.
  2678. (let ((localp (member blob (org-element-get-contents
  2679. (car (plist-get info :genealogy))))))
  2680. (if localp (plist-get info :genealogy)
  2681. (catch 'exit
  2682. (org-element-map
  2683. (plist-get info :parse-tree) (car blob)
  2684. (lambda (el local)
  2685. (when (equal el blob)
  2686. (throw 'exit (plist-get local :genealogy))))
  2687. info)))))
  2688. (defun org-export-get-parent-headline (blob info)
  2689. "Return closest parent headline or nil.
  2690. BLOB is the element or object being considered. INFO is a plist
  2691. used as a communication channel."
  2692. (catch 'exit
  2693. (mapc
  2694. (lambda (el) (when (eq (car el) 'headline) (throw 'exit el)))
  2695. (org-export-get-genealogy blob info))
  2696. nil))
  2697. (defun org-export-get-parent-paragraph (object info)
  2698. "Return parent paragraph or nil.
  2699. INFO is a plist used as a communication channel.
  2700. Optional argument OBJECT, when provided, is the object to consider.
  2701. Otherwise, return the paragraph containing current object.
  2702. This is useful for objects, which share attributes with the
  2703. paragraph containing them."
  2704. (catch 'exit
  2705. (mapc
  2706. (lambda (el) (when (eq (car el) 'paragraph) (throw 'exit el)))
  2707. (org-export-get-genealogy object info))
  2708. nil))
  2709. (defun org-export-get-previous-element (blob info)
  2710. "Return previous element or object.
  2711. BLOB is an element or object. INFO is a plist used as
  2712. a communication channel.
  2713. Return previous element or object, a string, or nil."
  2714. (let ((parent (car (org-export-get-genealogy blob info))))
  2715. (cadr (member blob (reverse (org-element-get-contents parent))))))
  2716. (defun org-export-get-next-element (blob info)
  2717. "Return next element or object.
  2718. BLOB is an element or object. INFO is a plist used as
  2719. a communication channel.
  2720. Return next element or object, a string, or nil."
  2721. (let ((parent (car (org-export-get-genealogy blob info))))
  2722. (cadr (member blob (org-element-get-contents parent)))))
  2723. ;;; The Dispatcher
  2724. ;; `org-export-dispatch' is the standard interactive way to start an
  2725. ;; export process. It uses `org-export-dispatch-ui' as a subroutine
  2726. ;; for its interface. Most commons back-ends should have an entry in
  2727. ;; it.
  2728. (defun org-export-dispatch ()
  2729. "Export dispatcher for Org mode.
  2730. It provides an access to common export related tasks in a buffer.
  2731. Its interface comes in two flavours: standard and expert. While
  2732. both share the same set of bindings, only the former displays the
  2733. valid keys associations. Set `org-export-dispatch-use-expert-ui'
  2734. to switch to one or the other.
  2735. Return an error if key pressed has no associated command."
  2736. (interactive)
  2737. (let* ((input (org-export-dispatch-ui
  2738. (if (listp org-export-initial-scope) org-export-initial-scope
  2739. (list org-export-initial-scope))
  2740. org-export-dispatch-use-expert-ui))
  2741. (raw-key (car input))
  2742. (optns (cdr input)))
  2743. ;; Translate "C-a", "C-b"... into "a", "b"... Then take action
  2744. ;; depending on user's key pressed.
  2745. (case (if (< raw-key 27) (+ raw-key 96) raw-key)
  2746. ;; Export with `e-ascii' back-end.
  2747. ((?A ?N ?U)
  2748. (let ((outbuf
  2749. (org-export-to-buffer
  2750. 'e-ascii "*Org E-ASCII Export*"
  2751. (memq 'subtree optns) (memq 'visible optns) (memq 'body optns)
  2752. `(:ascii-charset
  2753. ,(case raw-key (?A 'ascii) (?N 'latin1) (t 'utf-8))))))
  2754. (with-current-buffer outbuf (text-mode))
  2755. (when org-export-show-temporary-export-buffer
  2756. (switch-to-buffer-other-window outbuf))))
  2757. ((?a ?n ?u)
  2758. (org-e-ascii-export-to-ascii
  2759. (memq 'subtree optns) (memq 'visible optns) (memq 'body optns)
  2760. `(:ascii-charset ,(case raw-key (?a 'ascii) (?n 'latin1) (t 'utf-8)))))
  2761. ;; Export with `e-latex' back-end.
  2762. (?L
  2763. (let ((outbuf
  2764. (org-export-to-buffer
  2765. 'e-latex "*Org E-LaTeX Export*"
  2766. (memq 'subtree optns) (memq 'visible optns) (memq 'body optns))))
  2767. (with-current-buffer outbuf (latex-mode))
  2768. (when org-export-show-temporary-export-buffer
  2769. (switch-to-buffer-other-window outbuf))))
  2770. (?l (org-e-latex-export-to-latex
  2771. (memq 'subtree optns) (memq 'visible optns) (memq 'body optns)))
  2772. (?p (org-e-latex-export-to-pdf
  2773. (memq 'subtree optns) (memq 'visible optns) (memq 'body optns)))
  2774. (?d (org-open-file
  2775. (org-e-latex-export-to-pdf
  2776. (memq 'subtree optns) (memq 'visible optns) (memq 'body optns))))
  2777. ;; Export with `e-html' back-end.
  2778. (?H
  2779. (let ((outbuf
  2780. (org-export-to-buffer
  2781. 'e-html "*Org E-HTML Export*"
  2782. (memq 'subtree optns) (memq 'visible optns) (memq 'body optns))))
  2783. ;; set major mode
  2784. (with-current-buffer outbuf
  2785. (if (featurep 'nxhtml-mode) (nxhtml-mode) (nxml-mode)))
  2786. (when org-export-show-temporary-export-buffer
  2787. (switch-to-buffer-other-window outbuf))))
  2788. (?h (org-e-html-export-to-html
  2789. (memq 'subtree optns) (memq 'visible optns) (memq 'body optns)))
  2790. (?b (org-open-file
  2791. (org-e-html-export-to-html
  2792. (memq 'subtree optns) (memq 'visible optns) (memq 'body optns))))
  2793. ;; Publishing facilities
  2794. (?F (org-e-publish-current-file (memq 'force optns)))
  2795. (?P (org-e-publish-current-project (memq 'force optns)))
  2796. (?X (let ((project
  2797. (assoc (org-icompleting-read
  2798. "Publish project: " org-e-publish-project-alist nil t)
  2799. org-e-publish-project-alist)))
  2800. (org-e-publish project (memq 'force optns))))
  2801. (?E (org-e-publish-all (memq 'force optns)))
  2802. ;; Undefined command.
  2803. (t (error "No command associated with key %s"
  2804. (char-to-string raw-key))))))
  2805. (defun org-export-dispatch-ui (options expertp)
  2806. "Handle interface for `org-export-dispatch'.
  2807. OPTIONS is a list containing current interactive options set for
  2808. export. It can contain any of the following symbols:
  2809. `body' toggles a body-only export
  2810. `subtree' restricts export to current subtree
  2811. `visible' restricts export to visible part of buffer.
  2812. `force' force publishing files.
  2813. EXPERTP, when non-nil, triggers expert UI. In that case, no help
  2814. buffer is provided, but indications about currently active
  2815. options are given in the prompt. Moreover, \[?] allows to switch
  2816. back to standard interface.
  2817. Return value is a list with key pressed as CAR and a list of
  2818. final interactive export options as CDR."
  2819. (let ((help
  2820. (format "-------------------- General Options --------------------
  2821. \[1] Body only: %s [2] Export scope: %s
  2822. \[3] Visible only: %s [4] Force publishing: %s
  2823. -------------- ASCII/Latin-1/UTF-8 Export ---------------
  2824. \[a/n/u] to TXT file [A/N/U] to temporary buffer
  2825. --------------------- LaTeX Export ----------------------
  2826. \[l] to TEX file [L] to temporary buffer
  2827. \[p] to PDF file [d] ... and open it
  2828. --------------------- HTML Export -----------------------
  2829. \[h] to HTML file [b] ... and open it
  2830. \[H] to temporary buffer
  2831. ------------------------- Publish -------------------------
  2832. \[F] current file [P] current project
  2833. \[X] a project [E] every project"
  2834. (if (memq 'body options) "On" "Off")
  2835. (if (memq 'subtree options) "Subtree" "Buffer")
  2836. (if (memq 'visible options) "On" "Off")
  2837. (if (memq 'force options) "On" "Off")))
  2838. (standard-prompt "Export command: ")
  2839. (expert-prompt (format "Export command (%s%s%s%s): "
  2840. (if (memq 'body options) "b" "-")
  2841. (if (memq 'subtree options) "s" "-")
  2842. (if (memq 'visible options) "v" "-")
  2843. (if (memq 'force options) "f" "-")))
  2844. (handle-keypress
  2845. (function
  2846. ;; Read a character from command input, toggling interactive
  2847. ;; options when applicable. PROMPT is the displayed prompt,
  2848. ;; as a string.
  2849. (lambda (prompt)
  2850. (let ((key (read-char-exclusive prompt)))
  2851. (cond
  2852. ;; Ignore non-standard characters (i.e. "M-a").
  2853. ((not (characterp key)) (org-export-dispatch-ui options expertp))
  2854. ;; Help key: Switch back to standard interface if
  2855. ;; expert UI was active.
  2856. ((eq key ??) (org-export-dispatch-ui options nil))
  2857. ;; Toggle export options.
  2858. ((memq key '(?1 ?2 ?3 ?4))
  2859. (org-export-dispatch-ui
  2860. (let ((option (case key (?1 'body) (?2 'subtree) (?3 'visible)
  2861. (?4 'force))))
  2862. (if (memq option options) (remq option options)
  2863. (cons option options)))
  2864. expertp))
  2865. ;; Action selected: Send key and options back to
  2866. ;; `org-export-dispatch'.
  2867. (t (cons key options))))))))
  2868. ;; With expert UI, just read key with a fancy prompt. In standard
  2869. ;; UI, display an intrusive help buffer.
  2870. (if expertp (funcall handle-keypress expert-prompt)
  2871. (save-window-excursion
  2872. (delete-other-windows)
  2873. (with-output-to-temp-buffer "*Org Export/Publishing Help*" (princ help))
  2874. (org-fit-window-to-buffer
  2875. (get-buffer-window "*Org Export/Publishing Help*"))
  2876. (funcall handle-keypress standard-prompt)))))
  2877. (provide 'org-export)
  2878. ;;; org-export.el ends here