org 208 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925
  1. This is org, produced by makeinfo version 4.8 from org.texi.
  2. INFO-DIR-SECTION Emacs
  3. START-INFO-DIR-ENTRY
  4. * Org Mode: (org). outline-based notes management and organizer
  5. END-INFO-DIR-ENTRY
  6. This manual is for Org-mode (version 4.37).
  7. Copyright (C) 2004, 2005, 2006 Free Software Foundation
  8. Permission is granted to copy, distribute and/or modify this
  9. document under the terms of the GNU Free Documentation License,
  10. Version 1.1 or any later version published by the Free Software
  11. Foundation; with no Invariant Sections, with the Front-Cover texts
  12. being "A GNU Manual," and with the Back-Cover Texts as in (a)
  13. below. A copy of the license is included in the section entitled
  14. "GNU Free Documentation License."
  15. (a) The FSF's Back-Cover Text is: "You have freedom to copy and
  16. modify this GNU Manual, like GNU software. Copies published by
  17. the Free Software Foundation raise funds for GNU development."
  18. 
  19. File: org, Node: Top, Next: Introduction, Prev: (dir), Up: (dir)
  20. Org Mode Manual
  21. ***************
  22. This manual is for Org-mode (version 4.37).
  23. Copyright (C) 2004, 2005, 2006 Free Software Foundation
  24. Permission is granted to copy, distribute and/or modify this
  25. document under the terms of the GNU Free Documentation License,
  26. Version 1.1 or any later version published by the Free Software
  27. Foundation; with no Invariant Sections, with the Front-Cover texts
  28. being "A GNU Manual," and with the Back-Cover Texts as in (a)
  29. below. A copy of the license is included in the section entitled
  30. "GNU Free Documentation License."
  31. (a) The FSF's Back-Cover Text is: "You have freedom to copy and
  32. modify this GNU Manual, like GNU software. Copies published by
  33. the Free Software Foundation raise funds for GNU development."
  34. * Menu:
  35. * Introduction:: Getting started
  36. * Document structure:: A tree works like your brain
  37. * Tables:: Pure magic for quick formatting
  38. * Hyperlinks:: Notes in context
  39. * TODO items:: Every tree branch can be a TODO item
  40. * Timestamps:: Assign date and time to items
  41. * Tags:: Tagging headlines and matching sets of tags
  42. * Agenda views:: Collecting information into views
  43. * Exporting:: Sharing and publishing of notes
  44. * Publishing:: Create a web site of linked Org-mode files
  45. * Miscellaneous:: All the rest which did not fit elsewhere
  46. * Index:: The fast road to specific information
  47. * Key Index:: Key bindings and where they are described
  48. --- The Detailed Node Listing ---
  49. Introduction
  50. * Summary:: Brief summary of what Org-mode does
  51. * Installation and activation:: How to install Org-mode
  52. * Feedback:: Bug reports, ideas, patches etc.
  53. Document Structure
  54. * Outlines:: Org-mode is based on outline-mode
  55. * Headlines:: How to typeset org-tree headlines
  56. * Visibility cycling:: Show and hide, much simplified
  57. * Motion:: Jumping to other headlines
  58. * Structure editing:: Changing sequence and level of headlines
  59. * Archiving:: Move done task trees to a different place
  60. * Sparse trees:: Matches embedded in context
  61. * Plain lists:: Editing hand-formatted lists
  62. Tables
  63. * Built-in table editor:: Simple tables
  64. * Narrow columns:: Stop wasting space in tables
  65. * Table calculations:: Compute a field from other fields
  66. * orgtbl-mode:: The table editor as minor mode
  67. * table.el:: Complex tables
  68. Calculations in tables
  69. * Formula syntax:: How to write a formula
  70. * Lisp formulas:: An alternative way to write formulas
  71. * Column formulas:: Formulas valid for all fields in a column
  72. * Advanced features:: Field names, parameters and automatic recalc
  73. * Named-field formulas:: Formulas valid in single fields
  74. * Editing/debugging formulas:: Changing a stored formula
  75. * Appetizer:: Taste the power of calc
  76. Hyperlinks
  77. * Link format:: How links in Org-mode are formatted
  78. * Internal links:: Links to other places in the current file
  79. * External links:: URL-like links to the world
  80. * Handling links:: Creating, inserting and following
  81. * Search options:: Linking to a specific location
  82. * Custom searches:: When the default search is not enough
  83. * Remember:: Org-trees store quick notes
  84. Internal links
  85. * Radio targets:: Make targets trigger links in plain text.
  86. * CamelCase links:: Activating CamelCase words as links
  87. TODO items
  88. * TODO basics:: Marking and displaying TODO entries
  89. * TODO extensions:: Workflow and assignments
  90. * Priorities:: Some things are more important than others
  91. Extended use of TODO keywords
  92. * Workflow states:: From TODO to DONE in steps
  93. * TODO types:: I do this, Fred the rest
  94. * Per file keywords:: Different files, different requirements
  95. Timestamps
  96. * Time stamps:: Assigning a time to a tree entry
  97. * Creating timestamps:: Commands which insert timestamps
  98. * Progress logging:: Documenting when what work was done.
  99. Progress Logging
  100. * Closing items:: When was this entry makred DONE?
  101. * Clocking work time:: When exactly did you work on this item?
  102. Tags
  103. * Tag inheritance:: Tags use the tree structure of the outline
  104. * Setting tags:: How to assign tags to a headline
  105. * Tag searches:: Searching for combinations of tags
  106. Agenda Views
  107. * Agenda files:: Files being searched for agenda information
  108. * Agenda dispatcher:: Keyboard access to agenda views
  109. * Weekly/Daily agenda:: The calendar page with current tasks
  110. * Global TODO list:: All unfinished action items
  111. * Matching headline tags:: Structured information with fine-tuned search
  112. * Timeline:: Time-sorted view for single file
  113. * Agenda commands:: Remote editing of org trees
  114. The weekly/daily agenda
  115. * Categories:: Not all tasks are equal
  116. * Time-of-day specifications:: How the agenda knows the time
  117. * Calendar/Diary integration:: Integrating Anniversaries and more
  118. * Sorting of agenda items:: The order of things
  119. Exporting
  120. * ASCII export:: Exporting to plain ASCII
  121. * HTML export:: Exporting to HTML
  122. * XOXO export:: Exporting to XOXO
  123. * iCalendar export:: Exporting in iCalendar format
  124. * Text interpretation:: How the exporter looks at the file
  125. Text interpretation by the exporter
  126. * Comment lines:: Some lines will not be exported
  127. * Enhancing text:: Subscripts, symbols and more
  128. * Export options:: How to influence the export settings
  129. Publishing
  130. * Configuration:: Defining projects
  131. * Sample configuration:: Example projects
  132. * Triggering publication:: Publication commands
  133. Configuration
  134. * Project alist:: The central configuration variable
  135. * File sources and destinations:: From here to there
  136. * Selecting files:: What files are part of the project?
  137. * Publishing action:: Setting the function doing the publishing
  138. * Publishing options:: Tweaking HTML export
  139. * Publishing links:: Which links keep working after publishing?
  140. * Project page index:: Publishing a list of project files
  141. Sample configuration
  142. * Simple example:: One-component publishing
  143. * Complex example:: A multi-component publishing example
  144. Miscellaneous
  145. * Completion:: M-TAB knows what you need
  146. * Customization:: Adapting Org-mode to your taste
  147. * Summary of in-buffer settings:: Using special lines to set options
  148. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  149. * Clean view:: Getting rid of leading stars in the outline
  150. * TTY keys:: Using Org-mode on a tty
  151. * FAQ:: Frequently asked questions
  152. * Interaction:: Other Emacs packages
  153. * Bugs:: Things which do not work perfectly
  154. * Acknowledgments:: These people provided feedback and more
  155. Interaction with other packages
  156. * Extensions:: Third-party extensions for Org-mode
  157. * Cooperation:: Packages Org-mode cooperates with
  158. * Conflicts:: Packages that lead to conflicts
  159. 
  160. File: org, Node: Introduction, Next: Document structure, Prev: Top, Up: Top
  161. 1 Introduction
  162. **************
  163. * Menu:
  164. * Summary:: Brief summary of what Org-mode does
  165. * Installation and activation:: How to install Org-mode
  166. * Feedback:: Bug reports, ideas, patches etc.
  167. 
  168. File: org, Node: Summary, Next: Installation and activation, Prev: Introduction, Up: Introduction
  169. 1.1 Summary
  170. ===========
  171. Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
  172. project planning with a fast and effective plain-text system.
  173. Org-mode develops organizational tasks around NOTES files that
  174. contain information about projects as plain text. Org-mode is
  175. implemented on top of outline-mode, which makes it possible to keep the
  176. content of large files well structured. Visibility cycling and
  177. structure editing help to work with the tree. Tables are easily
  178. created with a built-in table editor. Org-mode supports ToDo items,
  179. deadlines, time stamps, and scheduling. It dynamically compiles
  180. entries into an agenda that utilizes and smoothly integrates much of
  181. the Emacs calendar and diary. Plain text URL-like links connect to
  182. websites, emails, Usenet messages, BBDB entries, and any files related
  183. to the projects. For printing and sharing of notes, an Org-mode file
  184. can be exported as a structured ASCII file, as HTML, or (todo and
  185. agenda items only) as an iCalendar file. It can also serve as a
  186. publishing tool for a set of linked webpages.
  187. Org-mode keeps simple things simple. When first fired up, it should
  188. feel like a straightforward, easy to use outliner. Complexity is not
  189. imposed, but a large amount of functionality is available when you need
  190. it. Org-mode can be used on different levels and in different ways, for
  191. example:
  192. * as an outline extension with visibility cycling and structure editing
  193. * as an ASCII system and table editor for taking structured notes
  194. * as an ASCII table editor with spreadsheet-like capabilities
  195. * as a TODO list editor
  196. * as a full agenda and planner with deadlines and work scheduling
  197. * as a simple hypertext system, with HTML export
  198. * as a publishing tool to create a set of interlinked webpages
  199. The Org-mode table editor can be integrated into any major mode by
  200. activating the minor Orgtbl-mode.
  201. There is a website for Org-mode which provides links to the newest
  202. version of Org-mode, as well as additional information, screen shots
  203. and example files. This page is located at
  204. `http://www.astro.uva.nl/~dominik/Tools/org/'.
  205. 
  206. File: org, Node: Installation and activation, Next: Feedback, Prev: Summary, Up: Introduction
  207. 1.2 Installation and Activation
  208. ===============================
  209. If Org-mode is part of the Emacs distribution or an XEmacs package, you
  210. only need to copy the following lines to your `.emacs' file. The last
  211. two lines define _global_ keys for the commands `org-store-link' and
  212. `org-agenda' - please choose suitable keys yourself.
  213. ;; The following lines are always needed. Choose your own keys.
  214. (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
  215. (define-key global-map "\C-cl" 'org-store-link)
  216. (define-key global-map "\C-ca" 'org-agenda)
  217. Furthermore, you must activate `font-lock-mode' in org-mode buffers,
  218. because significant functionality depends on font-locking being active.
  219. You can do this with either one of the following two lines:
  220. (global-font-lock-mode 1) ; for all buffers
  221. (add-hook 'org-mode-hook 'turn-on-font-lock) ; org-mode buffers only
  222. If you have downloaded Org-mode from the Web, you must take
  223. additional action: Byte-compile `org.el' and `org-publish.el' and put
  224. them together with `org-install.el' on your load path. Then add to
  225. `.emacs':
  226. ;; This line only if org-mode is not part of the X/Emacs distribution.
  227. (require 'org-install)
  228. With this setup, all files with extension `.org' will be put into
  229. Org-mode. As an alternative, make the first line of a file look like
  230. this:
  231. MY PROJECTS -*- mode: org; -*-
  232. which will select Org-mode for this buffer no matter what the file's
  233. name is. See also the variable `org-insert-mode-line-in-empty-file'.
  234. 
  235. File: org, Node: Feedback, Prev: Installation and activation, Up: Introduction
  236. 1.3 Feedback
  237. ============
  238. If you find problems with Org-mode, or if you have questions, remarks,
  239. or ideas about it, please contact the maintainer Carsten Dominik at
  240. <dominik@science.uva.nl>.
  241. For bug reports, please provide as much information as possible,
  242. including the version information of Emacs (`C-h v emacs-version
  243. <RET>') and Org-mode (`C-h v org-version <RET>'), as well as the
  244. Org-mode related setup in `.emacs'. If an error occurs, a traceback
  245. can be very useful. Often a small example file helps, along with clear
  246. information about:
  247. 1. What exactly did you do?
  248. 2. What did you expect to happen?
  249. 3. What happened instead?
  250. Thank you for helping to improve this mode.
  251. 
  252. File: org, Node: Document structure, Next: Tables, Prev: Introduction, Up: Top
  253. 2 Document Structure
  254. ********************
  255. Org-mode is based on outline mode and provides flexible commands to
  256. edit the structure of the document.
  257. * Menu:
  258. * Outlines:: Org-mode is based on outline-mode
  259. * Headlines:: How to typeset org-tree headlines
  260. * Visibility cycling:: Show and hide, much simplified
  261. * Motion:: Jumping to other headlines
  262. * Structure editing:: Changing sequence and level of headlines
  263. * Archiving:: Move done task trees to a different place
  264. * Sparse trees:: Matches embedded in context
  265. * Plain lists:: Editing hand-formatted lists
  266. 
  267. File: org, Node: Outlines, Next: Headlines, Prev: Document structure, Up: Document structure
  268. 2.1 Outlines
  269. ============
  270. Org-mode is implemented on top of outline-mode. Outlines allow to
  271. organize a document in a hierarchical structure, which (at least for
  272. me) is the best representation of notes and thoughts. Overview over
  273. this structure is achieved by folding (hiding) large parts of the
  274. document to show only the general document structure and the parts
  275. currently being worked on. Org-mode greatly simplifies the use of
  276. outlines by compressing the entire show/hide functionality into a
  277. single command `org-cycle', which is bound to the <TAB> key.
  278. 
  279. File: org, Node: Headlines, Next: Visibility cycling, Prev: Outlines, Up: Document structure
  280. 2.2 Headlines
  281. =============
  282. Headlines define the structure of an outline tree. The headlines in
  283. Org-mode start with one or more stars, on the left margin. For example:
  284. * Top level headline
  285. ** Second level
  286. *** 3rd level
  287. some text
  288. *** 3rd level
  289. more text
  290. * Another top level headline
  291. Some people find the many stars too noisy and would prefer an outline
  292. that has whitespace followed by a single star as headline starters.
  293. *Note Clean view:: describes a setup to realize this.
  294. 
  295. File: org, Node: Visibility cycling, Next: Motion, Prev: Headlines, Up: Document structure
  296. 2.3 Visibility cycling
  297. ======================
  298. Outlines make it possible to hide parts of the text in the buffer.
  299. Org-mode uses just two commands, bound to <TAB> and `S-<TAB>' to change
  300. the visibility in the buffer.
  301. `<TAB>'
  302. _Subtree cycling_: Rotate current subtree between the states
  303. ,-> FOLDED -> CHILDREN -> SUBTREE --.
  304. '-----------------------------------'
  305. The cursor must be on a headline for this to work(1). When the
  306. cursor is at the beginning of the buffer and the first line is not
  307. a headline, then <TAB> actually runs global cycling (see
  308. below)(2). Also when called with a prefix argument (`C-u <TAB>'),
  309. global cycling is invoked.
  310. `S-<TAB>'
  311. `C-u <TAB>'
  312. _Global cycling_: Rotate the entire buffer between the states
  313. ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
  314. '--------------------------------------'
  315. Note that inside tables, `S-<TAB>' jumps to the previous field.
  316. `C-c C-a'
  317. Show all.
  318. When Emacs first visits an Org-mode file, the global state is set to
  319. OVERVIEW, i.e. only the top level headlines are visible. This can be
  320. configured through the variable `org-startup-folded', or on a per-file
  321. basis by adding one of the following lines anywhere in the buffer:
  322. #+STARTUP: overview
  323. #+STARTUP: content
  324. #+STARTUP: showall
  325. ---------- Footnotes ----------
  326. (1) see, however, the option `org-cycle-emulate-tab'.
  327. (2) see the option `org-cycle-global-at-bob'.
  328. 
  329. File: org, Node: Motion, Next: Structure editing, Prev: Visibility cycling, Up: Document structure
  330. 2.4 Motion
  331. ==========
  332. The following commands jump to other headlines in the buffer.
  333. `C-c C-n'
  334. Next heading.
  335. `C-c C-p'
  336. Previous heading.
  337. `C-c C-f'
  338. Next heading same level.
  339. `C-c C-b'
  340. Previous heading same level.
  341. `C-c C-u'
  342. Backward to higher level heading.
  343. `C-c C-j'
  344. Jump to a different place without changing the current outline
  345. visibility. Shows the document structure in a temporary buffer,
  346. where you can use visibility cycling (<TAB>) to find your
  347. destination. After pressing <RET>, the cursor moves to the
  348. selected location in the original buffer, and the headings
  349. hierarchy above it is made visible.
  350. 
  351. File: org, Node: Structure editing, Next: Archiving, Prev: Motion, Up: Document structure
  352. 2.5 Structure editing
  353. =====================
  354. `M-<RET>'
  355. Insert new heading with same level as current. If the cursor is
  356. in a plain list item, a new item is created (*note Plain lists::).
  357. To force creation of a new headline, use a prefix arg, or first
  358. press <RET> to get to the beginning of the next line. When this
  359. command is used in the middle of a line, the line is split and the
  360. rest of the line becomes the new headline. If the command is used
  361. at the beginning of a headline, the new headline is created before
  362. the current line. If at the beginning of any other line, the
  363. content of that line is made the new heading.
  364. `M-S-<RET>'
  365. Insert new TODO entry with same level as current heading.
  366. `M-<left>'
  367. Promote current heading by one level.
  368. `M-<right>'
  369. Demote current heading by one level.
  370. `M-S-<left>'
  371. Promote the current subtree by one level.
  372. `M-S-<right>'
  373. Demote the current subtree by one level.
  374. `M-S-<up>'
  375. Move subtree up (swap with previous subtree of same level).
  376. `M-S-<down>'
  377. Move subtree down (swap with next subtree of same level).
  378. `C-c C-x C-w'
  379. `C-c C-x C-k'
  380. Kill subtree, i.e. remove it from buffer but save in kill ring.
  381. `C-c C-x M-w'
  382. Copy subtree to kill ring.
  383. `C-c C-x C-y'
  384. Yank subtree from kill ring. This does modify the level of the
  385. subtree to make sure the tree fits in nicely at the yank position.
  386. The yank level can also be specified with a prefix arg, or by
  387. yanking after a headline marker like `****'.
  388. When there is an active region (transient-mark-mode), promotion and
  389. demotion work on all headlines in the region. To select a region of
  390. headlines, it is best to place both point and mark at the beginning of a
  391. line, mark at the beginning of the first headline, and point at the line
  392. just after the last headline to change. Note that when the cursor is
  393. inside a table (*note Tables::), the Meta-Cursor keys have different
  394. functionality.
  395. 
  396. File: org, Node: Archiving, Next: Sparse trees, Prev: Structure editing, Up: Document structure
  397. 2.6 Archiving
  398. =============
  399. When a project represented by a (sub)tree is finished, you may want to
  400. move the tree to an archive place, either in the same file under a
  401. special top-level heading, or even to a different file.
  402. `C-c $'
  403. Archive the subtree starting at the cursor position to the location
  404. given by `org-archive-location'.
  405. The default archive is a file in the same directory as the current
  406. file, with the name derived by appending `_archive' to the current file
  407. name. For information and examples on how to change this, see the
  408. documentation string of the variable `org-archive-location'. If you
  409. are also using the Org-mode agenda, archiving to a different file is a
  410. good way to keep archived trees from contributing agenda items.
  411. 
  412. File: org, Node: Sparse trees, Next: Plain lists, Prev: Archiving, Up: Document structure
  413. 2.7 Sparse trees
  414. ================
  415. An important feature of Org-mode is the ability to construct _sparse
  416. trees_ for selected information in an outline tree. A sparse tree
  417. means that the entire document is folded as much as possible, but the
  418. selected information is made visible along with the headline structure
  419. above it(1). Just try it out and you will see immediately how it works.
  420. Org-mode contains several commands creating such trees. The most
  421. basic one is `org-occur':
  422. `C-c /'
  423. Occur. Prompts for a regexp and shows a sparse tree with all
  424. matches. If the match is in a headline, the headline is made
  425. visible. If the match is in the body of an entry, headline and
  426. body are made visible. In order to provide minimal context, also
  427. the full hierarchy of headlines above the match is shown, as well
  428. as the headline following the match. Each match is also
  429. highlighted; the highlights disappear when the buffer is changed
  430. with an editing command.
  431. For frequently used sparse trees of specific search strings, you can
  432. use the variable `org-agenda-custom-commands' to define fast keyboard
  433. access to specific sparse trees. These commands will then be
  434. accessible through the agenda dispatcher (*note Agenda dispatcher::).
  435. For example:
  436. (setq org-agenda-custom-commands
  437. '(("f" occur-tree "FIXME")))
  438. will define the key `C-c a f' as a shortcut for creating a sparse tree
  439. matching the string `FIXME'.
  440. Other commands use sparse trees as well. For example `C-c C-v'
  441. creates a sparse TODO tree (*note TODO basics::).
  442. To print a sparse tree, you can use the Emacs command
  443. `ps-print-buffer-with-faces' which does not print invisible parts of
  444. the document (2). Or you can use the command `C-c C-x v' to export
  445. only the visible part of the document and print the resulting file.
  446. ---------- Footnotes ----------
  447. (1) See also the variables `org-show-hierarchy-above' and
  448. `org-show-following-heading'.
  449. (2) This does not work under XEmacs, because XEmacs uses selective
  450. display for outlining, not text properties.
  451. 
  452. File: org, Node: Plain lists, Prev: Sparse trees, Up: Document structure
  453. 2.8 Plain lists
  454. ===============
  455. Headlines define both the structure of the Org-mode file, and also lists
  456. (for example, TODO items (*note TODO items::) should be created using
  457. headline levels). When taking notes, however, the plain text is
  458. sometimes easier to read with hand-formatted lists. Org-mode supports
  459. editing such lists, and the HTML exporter (*note Exporting::) does
  460. parse and format them.
  461. Org-mode knows ordered and unordered lists. Unordered list items
  462. start with `-', `+', or `*'(1) as bullets. Ordered list items start
  463. with `1.' or `1)'. Items belonging to the same list must have the same
  464. indentation on the first line. In particular, if an ordered list
  465. reaches number `10.', then the 2-digit numbers must be written
  466. left-aligned with the other numbers in the list. Indentation also
  467. determines the end of a list item. It ends before the next line that
  468. is indented like the bullet/number, or less. For example:
  469. ** Lord of the Rings
  470. My favorite scenes are (in this order)
  471. 1. Eowyns fight with the witch king
  472. + this was already my favorite scene in the book
  473. + I really like Miranda Otto.
  474. 2. The attack of the Rohirrim
  475. 3. Peter Jackson being shot by Legolas
  476. - on DVD only
  477. He makes a really funny face when it happens.
  478. But in the end, not individual scenes matter but the film as a whole.
  479. Org-mode supports these lists by tuning filling and wrapping commands
  480. to deal with them correctly.
  481. Every item in a plain list can be made a checkbox by starting it with
  482. the string `[ ]'. The checkbox status can conveniently be toggled with
  483. `C-c C-c'.
  484. * Stupid mistakes when distributing a new version
  485. - [ ] update also Emacs CVS
  486. - [X] forget to update index.html on the website
  487. - [X] leaving a `(debug)' form in the code
  488. The following commands act on items when the cursor is in the first
  489. line of an item (the line with the bullet or number).
  490. `<TAB>'
  491. Items can be folded just like headline levels if you set the
  492. variable `org-cycle-include-plain-lists'. The level of an item is
  493. then given by the indentation of the bullet/number. Items are
  494. always subordinate to real headlines, however; the hierarchies
  495. remain completely separated.
  496. `M-<RET>'
  497. Insert new item at current level. With prefix arg, force a new
  498. heading (*note Structure editing::). If this command is used in
  499. the middle of a line, the line is _split_ and the rest of the line
  500. becomes the new item. If this command is executed in the
  501. _whitespace before a bullet or number_, the new item is created
  502. _before_ the current item. If the command is executed in the
  503. white space before the text that is part of an item but does not
  504. contain the bullet, a bullet is added to the current line.
  505. `M-S-<RET>'
  506. Insert a new item with a checkbox.
  507. `S-<up>'
  508. `S-<down>'
  509. Jump to the previous/next item in the current list.
  510. `M-S-<up>'
  511. `M-S-<down>'
  512. Move the item including subitems up/down (swap with previous/next
  513. item of same indentation). If the list is ordered, renumbering is
  514. automatic.
  515. `M-S-<left>'
  516. `M-S-<right>'
  517. Decrease/increase the indentation of the item, including subitems.
  518. Initially, the item tree is selected based on current indentation.
  519. When these commands are executed several times in direct
  520. succession, the initially selected region is used, even if the new
  521. indentation would imply a different hierarchy. To use the new
  522. hierarchy, break the command chain with a cursor motion or so.
  523. `C-c C-c'
  524. If there is a checkbox in the item line, toggle the state of the
  525. checkbox. Otherwise, if this is an ordered list, renumber the
  526. ordered list at the cursor.
  527. ---------- Footnotes ----------
  528. (1) When using `*' as a bullet, lines must be indented or they will
  529. be seen as top-level headlines. Also, when you are hiding leading
  530. stars to get a clean outline view, plain list items starting with a
  531. star are visually indistinguishable from true headlines. In short:
  532. even though `*' is supported, it may be better not to use it for plain
  533. list items
  534. 
  535. File: org, Node: Tables, Next: Hyperlinks, Prev: Document structure, Up: Top
  536. 3 Tables
  537. ********
  538. Org-mode has a very fast and intuitive table editor built-in.
  539. Spreadsheet-like calculations are supported in connection with the
  540. Emacs `calc' package.
  541. * Menu:
  542. * Built-in table editor:: Simple tables
  543. * Narrow columns:: Stop wasting space in tables
  544. * Table calculations:: Compute a field from other fields
  545. * orgtbl-mode:: The table editor as minor mode
  546. * table.el:: Complex tables
  547. 
  548. File: org, Node: Built-in table editor, Next: Narrow columns, Prev: Tables, Up: Tables
  549. 3.1 The built-in table editor
  550. =============================
  551. Org-mode makes it easy to format tables in plain ASCII. Any line with
  552. `|' as the first non-white character is considered part of a table.
  553. `|' is also the column separator. A table might look like this:
  554. | Name | Phone | Age |
  555. |-------+-------+-----|
  556. | Peter | 1234 | 17 |
  557. | Anna | 4321 | 25 |
  558. A table is re-aligned automatically each time you press <TAB> or
  559. <RET> or `C-c C-c' inside the table. <TAB> also moves to the next
  560. field (<RET> to the next row) and creates new table rows at the end of
  561. the table or before horizontal lines. The indentation of the table is
  562. set by the first line. Any line starting with `|-' is considered as a
  563. horizontal separator line and will be expanded on the next re-align to
  564. span the whole table width. So, to create the above table, you would
  565. only type
  566. |Name|Phone|Age
  567. |-
  568. and then press <TAB> to align the table and start filling in fields.
  569. When typing text into a field, Org-mode treats <DEL>, <Backspace>,
  570. and all character keys in a special way, so that inserting and deleting
  571. avoids shifting other fields. Also, when typing _immediately after the
  572. cursor was moved into a new field with `<TAB>', `S-<TAB>' or `<RET>'_,
  573. the field is automatically made blank. If this behavior is too
  574. unpredictable for you, configure the variables
  575. `org-enable-table-editor' and `org-table-auto-blank-field'.
  576. Creation and conversion
  577. .......................
  578. `C-c |'
  579. Convert the active region to table. If every line contains at
  580. least one TAB character, the function assumes that the material is
  581. tab separated. If not, lines are split at whitespace into fields.
  582. You can use a prefix argument to indicate the minimum number of
  583. consecutive spaces required to identify a field separator
  584. (default: just one).
  585. If there is no active region, this command creates an empty
  586. Org-mode table. But it's easier just to start typing, like
  587. `|Name|Phone|Age <RET> |- <TAB>'.
  588. Re-aligning and field motion
  589. ............................
  590. `C-c C-c'
  591. Re-align the table without moving the cursor.
  592. `<TAB>'
  593. Re-align the table, move to the next field. Creates a new row if
  594. necessary.
  595. `S-<TAB>'
  596. Re-align, move to previous field.
  597. `<RET>'
  598. Re-align the table and move down to next row. Creates a new row if
  599. necessary. At the beginning or end of a line, <RET> still does
  600. NEWLINE, so it can be used to split a table.
  601. Column and row editing
  602. ......................
  603. `M-<left>'
  604. `M-<right>'
  605. Move the current column left/right.
  606. `M-S-<left>'
  607. Kill the current column.
  608. `M-S-<right>'
  609. Insert a new column to the left of the cursor position.
  610. `M-<up>'
  611. `M-<down>'
  612. Move the current row up/down.
  613. `M-S-<up>'
  614. Kill the current row or horizontal line.
  615. `M-S-<down>'
  616. Insert a new row above (with arg: below) the current row.
  617. `C-c -'
  618. Insert a horizontal line below current row. With prefix arg, the
  619. line is created above the current line.
  620. `C-c ^'
  621. Sort the table lines in the region. Point and mark must be in the
  622. first and last line to be included, and must be in the column that
  623. should be used for sorting. The command prompts for numerical
  624. versus alphanumerical sorting.
  625. Regions
  626. .......
  627. `C-c C-x M-w'
  628. Copy a rectangular region from a table to a special clipboard.
  629. Point and mark determine edge fields of the rectangle. The
  630. process ignores horizontal separator lines.
  631. `C-c C-x C-w'
  632. Copy a rectangular region from a table to a special clipboard, and
  633. blank all fields in the rectangle. So this is the "cut" operation.
  634. `C-c C-x C-y'
  635. Paste a rectangular region into a table. The upper right corner
  636. ends up in the current field. All involved fields will be
  637. overwritten. If the rectangle does not fit into the present table,
  638. the table is enlarged as needed. The process ignores horizontal
  639. separator lines.
  640. `C-c C-q'
  641. Wrap several fields in a column like a paragraph. If there is an
  642. active region, and both point and mark are in the same column, the
  643. text in the column is wrapped to minimum width for the given
  644. number of lines. A prefix ARG may be used to change the number of
  645. desired lines. If there is no region, the current field is split
  646. at the cursor position and the text fragment to the right of the
  647. cursor is prepended to the field one line down. If there is no
  648. region, but you specify a prefix ARG, the current field is made
  649. blank, and the content is appended to the field above.
  650. Calculations
  651. ............
  652. `C-c ='
  653. Install a new formula for the current column and replace current
  654. field with the result of the formula.
  655. `C-u C-c ='
  656. Install a new formula for the current field, which must be a named
  657. field. Evaluate the formula and replace the field content with the
  658. result.
  659. `C-c ''
  660. Edit all formulas associated with the current table in a separate
  661. buffer.
  662. `C-c *'
  663. Recalculate the current row by applying the stored formulas from
  664. left to right. When called with a `C-u' prefix, recalculate the
  665. entire table, starting with the first non-header line (i.e. below
  666. the first horizontal separator line). For details, see *Note
  667. Table calculations::.
  668. `C-#'
  669. Rotate the calculation mark in first column through the states `',
  670. `#', `*', `!', `$'. For the meaning of these marks see *Note
  671. Advanced features::. When there is an active region, change all
  672. marks in the region.
  673. `C-c ?'
  674. Which table column is the cursor in? Displays number >0 in echo
  675. area.
  676. `C-c +'
  677. Sum the numbers in the current column, or in the rectangle defined
  678. by the active region. The result is shown in the echo area and can
  679. be inserted with `C-y'.
  680. `S-<RET>'
  681. When current field is empty, copy from first non-empty field above.
  682. When not empty, copy current field down to next row and move cursor
  683. along with it. Depending on the variable
  684. `org-table-copy-increment', integer field values will be
  685. incremented during copy. This key is also used by CUA-mode (*note
  686. Cooperation::).
  687. Miscellaneous
  688. .............
  689. `C-c `'
  690. Edit the current field in a separate window. This is useful for
  691. fields that are not fully visible (*note Narrow columns::). When
  692. called with a `C-u' prefix, just make the full field visible, so
  693. that it can be edited in place.
  694. `C-c <TAB>'
  695. This is an alias for `C-u C-c `' to make the current field fully
  696. visible.
  697. `M-x org-table-import'
  698. Import a file as a table. The table should be TAB- or whitespace
  699. separated. Useful, for example, to import an Excel table or data
  700. from a database, because these programs generally can write
  701. TAB-separated text files. This command works by inserting the
  702. file into the buffer and then converting the region to a table.
  703. Any prefix argument is passed on to the converter, which uses it
  704. to determine the separator.
  705. `M-x org-table-export'
  706. Export the table as a TAB-separated file. Useful for data
  707. exchange with, for example, Excel or database programs.
  708. If you don't like the automatic table editor because it gets in your
  709. way on lines which you would like to start with `|', you can turn it
  710. off with
  711. (setq org-enable-table-editor nil)
  712. Then the only table command that still works is `C-c C-c' to do a
  713. manual re-align.
  714. 
  715. File: org, Node: Narrow columns, Next: Table calculations, Prev: Built-in table editor, Up: Tables
  716. 3.2 Narrow columns
  717. ==================
  718. The width of columns is automatically determined by the table editor.
  719. Sometimes a single field or a few fields need to carry more text,
  720. leading to inconveniently wide columns. To limit(1) the width of a
  721. column, one field anywhere in the column may contain just the string
  722. `<N>' where `N' is an integer specifying the width of the column in
  723. characters. The next re-align will then set the width of this column
  724. to no more than this value.
  725. |---+------------------------------| |---+--------|
  726. | | | | | <6> |
  727. | 1 | one | | 1 | one |
  728. | 2 | two | ----\ | 2 | two |
  729. | 3 | This is a long chunk of text | ----/ | 3 | This=> |
  730. | 4 | four | | 4 | four |
  731. |---+------------------------------| |---+--------|
  732. Fields that are wider become clipped and end in the string `=>'. Note
  733. that the full text is still in the buffer, it is only invisible. To
  734. see the full text, hold the mouse over the field - a tooltip window
  735. will show the full content. To edit such a field, use the command `C-c
  736. `' (that is `C-c' followed by the backquote). This will open a new
  737. window with the full field. Edit it and finish with `C-c C-c'.
  738. When visiting a file containing a table with narrowed columns, the
  739. necessary character hiding has not yet happened, and the table needs to
  740. be aligned before it looks nice. Setting the option
  741. `org-startup-align-all-tables' will realign all tables in a file upon
  742. visiting, but also slow down startup. You can also set this option on
  743. a per-file basis with:
  744. #+STARTUP: align
  745. #+STARTUP: noalign
  746. ---------- Footnotes ----------
  747. (1) This feature does not work on XEmacs.
  748. 
  749. File: org, Node: Table calculations, Next: orgtbl-mode, Prev: Narrow columns, Up: Tables
  750. 3.3 Calculations in tables
  751. ==========================
  752. The table editor makes use of the Emacs `calc' package to implement
  753. spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
  754. derive fields from other fields. Org-mode has two levels of complexity
  755. for table calculations. On the basic level, tables do only horizontal
  756. computations, so a field can be computed from other fields _in the same
  757. row_, and Org-mode assumes that there is only one formula for each
  758. column. This is very efficient to work with and enough for many tasks.
  759. On the complex level, columns and individual fields can be named for
  760. easier referencing in formulas, individual named fields can have their
  761. own formula associated with them, and recalculation can be automated.
  762. * Menu:
  763. * Formula syntax:: How to write a formula
  764. * Lisp formulas:: An alternative way to write formulas
  765. * Column formulas:: Formulas valid for all fields in a column
  766. * Advanced features:: Field names, parameters and automatic recalc
  767. * Named-field formulas:: Formulas valid in single fields
  768. * Editing/debugging formulas:: Changing a stored formula
  769. * Appetizer:: Taste the power of calc
  770. 
  771. File: org, Node: Formula syntax, Next: Lisp formulas, Prev: Table calculations, Up: Table calculations
  772. 3.3.1 Formula syntax
  773. --------------------
  774. A formula can be any algebraic expression understood by the Emacs
  775. `calc' package. Note that `calc' has the slightly non-standard
  776. convention that `/' has lower precedence than `*', so that `a/b*c' is
  777. interpreted as `a/(b*c)'. Before evaluation by `calc-eval' (*note
  778. calc-eval: (calc)Calling Calc from Your Programs.), variable
  779. substitution takes place:
  780. $ refers to the current field
  781. $3 refers to the field in column 3 of the current row
  782. $3..$7 a vector of the fields in columns 3-7 of current row
  783. $P1..$P3 vector of column range, using column names
  784. &2 second data field above the current, in same column
  785. &5-2 vector from fifth to second field above current
  786. &III-II vector of fields between 2nd and 3rd hline above
  787. &III vector of fields between third hline above and current field
  788. $name a named field, parameter or constant
  789. The range vectors can be directly fed into the calc vector functions
  790. like `vmean' and `vsum'.
  791. `$name' is interpreted as the name of a column, parameter or
  792. constant. Constants are defined globally through the variable
  793. `org-table-formula-constants'. If you have the `constants.el' package,
  794. it will also be used to resolve constants, including natural constants
  795. like `$h' for Planck's constant, and units like `$km' for kilometers.
  796. Column names and parameters can be specified in special table lines.
  797. These are described below, see *Note Advanced features::.
  798. A formula can contain an optional mode string after a semicolon.
  799. This string consists of flags to influence calc's modes(1) during
  800. execution, e.g. `p20' to switch the internal precision to 20 digits,
  801. `n3', `s3', `e2' or `f4' to switch to normal, scientific, engineering,
  802. or fixed display format, respectively, and `D', `R', `F', and `S' to
  803. turn on degrees, radians, fraction and symbolic modes, respectively.
  804. In addition, you may provide a `printf' format specifier to reformat
  805. the final result. A few examples:
  806. $1+$2 Sum of first and second field
  807. $1+$2;%.2f Same, format result to two decimals
  808. exp($2)+exp($1) Math functions can be used
  809. $;%.1f Reformat current cell to 1 decimal
  810. ($3-32)*5/9 Degrees F -> C conversion
  811. $c/$1/$cm Hz -> cm conversion, using `constants.el'
  812. tan($1);Dp3s1 Compute in degrees, precision 3, display SCI 1
  813. sin($1);Dp3%.1e Same, but use printf specifier for display
  814. vmean($2..$7) Compute column range mean, using vector function
  815. vsum(&III) Sum numbers from 3rd hline above, up to here
  816. taylor($3,x=7,2) taylor series of $3, at x=7, second degree
  817. ---------- Footnotes ----------
  818. (1) By default, Org-mode uses the standard calc modes (precision 12,
  819. angular units degrees, fraction and symbolic modes off). The display
  820. format, however, has been changed to `(float 5)' to keep tables compact.
  821. The default settings can be configured using the variable
  822. `org-calc-default-modes'.
  823. 
  824. File: org, Node: Lisp formulas, Next: Column formulas, Prev: Formula syntax, Up: Table calculations
  825. 3.3.2 Emacs Lisp forms as formulas
  826. ----------------------------------
  827. It is also possible to write a formula in Emacs lisp; this can be useful
  828. for string manipulation and control structures. If a formula starts
  829. with a single quote followed by an opening parenthesis, then it is
  830. evaluated as a lisp form. The evaluation should return either a string
  831. or a number. Just as with `calc' formulas, you can provide a format
  832. specifier after a semicolon. A few examples:
  833. swap the first two characters of the content of column 1
  834. '(concat (substring "$1" 1 2) (substring "$1" 0 1) (substring "$1" 2))
  835. Add columns 1 and 2, equivalent to the calc's `$1+$2'
  836. '(+ $1 $2)
  837. 
  838. File: org, Node: Column formulas, Next: Advanced features, Prev: Lisp formulas, Up: Table calculations
  839. 3.3.3 Column formulas
  840. ---------------------
  841. To apply a formula to a field, type it directly into the field,
  842. preceded by an equal sign, like `=$1+$2'. When you press <TAB> or
  843. <RET> or `C-c C-c' with the cursor still in the field, the formula will
  844. be stored as the formula for the current column, evaluated and the
  845. current field replaced with the result. If the field contains only
  846. `=', the previously stored formula for this column is used.
  847. For each column, Org-mode will remember the most recently used
  848. formula. The information is stored in a special line starting with
  849. `#+TBLFM' directly below the table. When adding/deleting/moving
  850. columns with the appropriate commands, the stored equations will be
  851. modified accordingly. When a column used in a calculation is removed,
  852. references to this column become invalid and will cause an error upon
  853. applying the equation.
  854. Instead of typing an equation into the field, you may also use the
  855. command `C-c ='. It prompts for a formula (with default taken from the
  856. `#+TBLFM:' line) and applies it to the current field. A numerical
  857. prefix (e.g. `C-5 C-c =') will apply it to that many consecutive fields
  858. in the current column.
  859. To recompute all the fields in a line, use the command `C-c *'. It
  860. re-applies all stored equations to the current row, from left to right.
  861. With a `C-u' prefix, this will be done to every line in the table, so
  862. use this command it you want to make sure the entire table is
  863. up-to-date. `C-u C-c C-c' is another way to update the entire table.
  864. Global updating does not touch the line(s) above the first horizontal
  865. separator line, assuming that this is the table header.
  866. 
  867. File: org, Node: Advanced features, Next: Named-field formulas, Prev: Column formulas, Up: Table calculations
  868. 3.3.4 Advanced features
  869. -----------------------
  870. If you want the recalculation of fields to happen automatically, or if
  871. you want to be able to assign a formula to an individual field (instead
  872. of an entire column) you need to reserve the first column of the table
  873. for special marking characters. Here is an example of a table that
  874. collects exam results of students and makes use of these features:
  875. |---+---------+--------+--------+--------+-------+------|
  876. | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
  877. |---+---------+--------+--------+--------+-------+------|
  878. | ! | | P1 | P2 | P3 | Tot | |
  879. | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
  880. | ^ | | m1 | m2 | m3 | mt | |
  881. |---+---------+--------+--------+--------+-------+------|
  882. | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
  883. | # | Sara | 6 | 14 | 19 | 39 | 7.8 |
  884. | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
  885. |---+---------+--------+--------+--------+-------+------|
  886. | | Average | | | | 29.7 | |
  887. | ^ | | | | | at | |
  888. | $ | max=50 | | | | | |
  889. |---+---------+--------+--------+--------+-------+------|
  890. #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(&II);%.1f
  891. Important: Please note that for these special tables, recalculating the
  892. table with `C-u C-c *' will only affect rows that are marked `#' or
  893. `*', and named fields. The column formulas are not applied in rows
  894. with empty first field.
  895. The marking characters have the following meaning:
  896. `!'
  897. The fields in this line define names for the columns, so that you
  898. may refer to a column as `$Tot' instead of `$6'.
  899. `^'
  900. This row defines names for the fields _above_ the row. With such
  901. a definition, any formula in the table may use `$m1' to refer to
  902. the value `10'. Also, named fields can have their own formula
  903. associated with them.
  904. `_'
  905. Similar to `^', but defines names for the fields in the row
  906. _below_.
  907. `$'
  908. Fields in this row can define _parameters_ for formulas. For
  909. example, if a field in a `$' row contains `max=50', then formulas
  910. in this table can refer to the value 50 using `$max'. Parameters
  911. work exactly like constants, only that they can be defined on a
  912. per-table basis. Changing a parameter and then recalculating the
  913. table can be useful.
  914. `#'
  915. Fields in this row are automatically recalculated when pressing
  916. <TAB> or <RET> or `S-<TAB>' in this row. Also, this row is
  917. selected for a global recalculation with `C-u C-c *'. Unmarked
  918. lines will be left alone by this command.
  919. `*'
  920. Selects this line for global recalculation with `C-u C-c *', but
  921. not for automatic recalculation. Use this when automatic
  922. recalculation slows down editing too much.
  923. `'
  924. Unmarked lines are exempt from recalculation with `C-u C-c *'.
  925. All lines that should be recalculated should be marked with `#' or
  926. `*'.
  927. 
  928. File: org, Node: Named-field formulas, Next: Editing/debugging formulas, Prev: Advanced features, Up: Table calculations
  929. 3.3.5 Named-field formulas
  930. --------------------------
  931. A named field can have its own formula associated with it. In the
  932. example above, this is used for the `at' field that contains the
  933. average result of the students. To enter a formula for a named field,
  934. just type it into the buffer, preceded by `:='. Or use `C-u C-c ='.
  935. This equation will be stored below the table like `$name=...'. Any
  936. recalculation in the table (even if only requested for the current
  937. line) will also update all named field formulas.
  938. 
  939. File: org, Node: Editing/debugging formulas, Next: Appetizer, Prev: Named-field formulas, Up: Table calculations
  940. 3.3.6 Editing and debugging formulas
  941. ------------------------------------
  942. To edit a column or field formula, use the commands `C-c =' and `C-u
  943. C-c =', respectively. The currently active expression is then
  944. presented as default in the minibuffer, where it may be edited.
  945. Note that making a table field blank does not remove the formula
  946. associated with the field - during the next recalculation the field
  947. will be filled again. To remove a formula from a field, you have to
  948. give an empty reply when prompted for the formula, or to edit the
  949. `#+TBLFM' line.
  950. You may edit the `#+TBLFM' directly and re-apply the changed
  951. equations with `C-c C-c' in that line, or with the normal recalculation
  952. commands in the table.
  953. In particular for large tables with many formulas, it is convenient
  954. to use the command `C-c '' to edit the formulas of the current table in
  955. a separate buffer. That buffer will show the formulas one per line,
  956. and you are free to edit, add and remove formulas. Press `C-c ?' on a
  957. `$...' expression to get information about its interpretation.
  958. Exiting the buffer with `C-c C-c' only stores the modified formulas
  959. below the table. Exiting with `C-u C-c C-c' also applies them to the
  960. entire table. `C-c C-q' exits without installing the changes.
  961. When the evaluation of a formula leads to an error, the field content
  962. becomes the string `#ERROR'. If you would like see what is going on
  963. during variable substitution and calculation in order to find a bug,
  964. turn on formula debugging in the menu and repeat the calculation, for
  965. example by pressing `C-c = <RET>' in a field. Detailed information
  966. will be displayed.
  967. 
  968. File: org, Node: Appetizer, Prev: Editing/debugging formulas, Up: Table calculations
  969. 3.3.7 Appetizer
  970. ---------------
  971. Finally, just to whet your appetite on what can be done with the
  972. fantastic `calc' package, here is a table that computes the Taylor
  973. series for a couple of functions (homework: try that with Excel :-)
  974. |---+-------------+---+-----+--------------------------------------|
  975. | | Func | n | x | Result |
  976. |---+-------------+---+-----+--------------------------------------|
  977. | # | exp(x) | 1 | x | 1 + x |
  978. | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
  979. | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
  980. | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
  981. | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
  982. | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
  983. |---+-------------+---+-----+--------------------------------------|
  984. #+TBLFM: $5=taylor($2,$4,$3);n3
  985. 
  986. File: org, Node: orgtbl-mode, Next: table.el, Prev: Table calculations, Up: Tables
  987. 3.4 The Orgtbl minor mode
  988. =========================
  989. If you like the intuitive way the Org-mode table editor works, you
  990. might also want to use it in other modes like text-mode or mail-mode.
  991. The minor mode Orgtbl-mode makes this possible. You can always toggle
  992. the mode with `M-x orgtbl-mode'. To turn it on by default, for example
  993. in mail mode, use
  994. (add-hook 'mail-mode-hook 'turn-on-orgtbl)
  995. 
  996. File: org, Node: table.el, Prev: orgtbl-mode, Up: Tables
  997. 3.5 The `table.el' package
  998. ==========================
  999. Complex ASCII tables with automatic line wrapping, column- and
  1000. row-spanning, and alignment can be created using the Emacs table
  1001. package by Takaaki Ota (`http://sourceforge.net/projects/table', and
  1002. also part of Emacs 22). When <TAB> or `C-c C-c' is pressed in such a
  1003. table, Org-mode will call `table-recognize-table' and move the cursor
  1004. into the table. Inside a table, the keymap of Org-mode is inactive.
  1005. In order to execute Org-mode-related commands, leave the table.
  1006. `C-c C-c'
  1007. Recognize `table.el' table. Works when the cursor is in a
  1008. table.el table.
  1009. `C-c ~'
  1010. Insert a table.el table. If there is already a table at point,
  1011. this command converts it between the table.el format and the
  1012. Org-mode format. See the documentation string of the command
  1013. `org-convert-table' for the restrictions under which this is
  1014. possible.
  1015. 
  1016. File: org, Node: Hyperlinks, Next: TODO items, Prev: Tables, Up: Top
  1017. 4 Hyperlinks
  1018. ************
  1019. Just like HTML, Org-mode provides links inside a file, and external
  1020. links to other files, Usenet articles, emails, and much more.
  1021. * Menu:
  1022. * Link format:: How links in Org-mode are formatted
  1023. * Internal links:: Links to other places in the current file
  1024. * External links:: URL-like links to the world
  1025. * Handling links:: Creating, inserting and following
  1026. * Search options:: Linking to a specific location
  1027. * Custom searches:: When the default search is not enough
  1028. * Remember:: Org-trees store quick notes
  1029. 
  1030. File: org, Node: Link format, Next: Internal links, Prev: Hyperlinks, Up: Hyperlinks
  1031. 4.1 Link format
  1032. ===============
  1033. Org-mode will recognize plain URL-like links and activate them as
  1034. clickable links. The general link format, however, looks like this:
  1035. [[link][description]] or alternatively [[link]]
  1036. Once a link in the buffer is complete (all brackets present),
  1037. Org-mode will change the display so that `description' is displayed
  1038. instead of `[[link][description]]' and `link' is displayed instead of
  1039. `[[link]]'. Links will be highlighted in the face `org-link', which by
  1040. default is an underlined face. You can directly edit the visible part
  1041. of a link. Note that this can be either the `link' part (if there is
  1042. no description) or the `description' part. To edit also the invisible
  1043. `link' part, use `C-c C-l' with the cursor on the link.
  1044. If you place the cursor at the beginning or just behind the end of
  1045. the displayed text and press <BACKSPACE>, you will remove the
  1046. (invisible) bracket at that location. This makes the link incomplete
  1047. and the internals are again displayed as plain text. Inserting the
  1048. missing bracket hides the link internals again. To show the internal
  1049. structure of all links, use the menu entry `Org->Hyperlinks->Literal
  1050. links'.
  1051. 
  1052. File: org, Node: Internal links, Next: External links, Prev: Link format, Up: Hyperlinks
  1053. 4.2 Internal links
  1054. ==================
  1055. If the link does not look like a URL, it is considered to be internal in
  1056. the current file. Links such as `[[My Target]]' or `[[My Target][Find
  1057. my target]]' lead to a text search in the current file. The link can
  1058. be followed with `C-c C-o' when the cursor is on the link, or with a
  1059. mouse click (*note Handling links::). The preferred match for such a
  1060. link is a dedicated target: the same string in double angular brackets.
  1061. Targets may be located anywhere; often it is convenient to put them
  1062. into a comment line. For example
  1063. # <<My Target>>
  1064. In HTML export (*note HTML export::), such targets will become named
  1065. anchors for direct access through `http' links(1).
  1066. If no dedicated target exists, Org-mode will search for the words in
  1067. the link. In the above example the search would be for `my target'.
  1068. Links starting with a star like `*My Target' restrict the search to
  1069. headlines. When searching, Org-mode will first try an exact match, but
  1070. then move on to more and more lenient searches. For example, the link
  1071. `[[*My Targets]]' will find any of the following:
  1072. ** My targets
  1073. ** TODO my targets are bright
  1074. ** my 20 targets are
  1075. To insert a link targeting a headline, in-buffer completion can be
  1076. used. Just type a star followed by a few optional letters into the
  1077. buffer and press `M-<TAB>'. All headlines in the current buffer will be
  1078. offered as completions. *Note Handling links::, for more commands
  1079. creating links.
  1080. Following a link pushes a mark onto Org-mode's own mark ring. You
  1081. can return to the previous position with `C-c &'. Using this command
  1082. several times in direct succession goes back to positions recorded
  1083. earlier.
  1084. * Menu:
  1085. * Radio targets:: Make targets trigger links in plain text.
  1086. * CamelCase links:: Activating CamelCase words as links
  1087. ---------- Footnotes ----------
  1088. (1) Note that text before the first headline will never be exported,
  1089. so the first such target must be after the first headline.
  1090. 
  1091. File: org, Node: Radio targets, Next: CamelCase links, Prev: Internal links, Up: Internal links
  1092. 4.2.1 Radio targets
  1093. -------------------
  1094. You can configure Org-mode to link any occurrences of certain target
  1095. names in normal text. So without explicitly creating a link, the text
  1096. connects to the target radioing its position. Radio targets are
  1097. enclosed by triple angular brackets. For example, a target `<<<My
  1098. Target>>>' causes each occurrence of `my target' in normal text to
  1099. become activated as a link. The Org-mode file is scanned automatically
  1100. for radio targets only when the file is first loaded into Emacs. To
  1101. update the target list during editing, press `C-c C-c' with the cursor
  1102. on or at a target.
  1103. 
  1104. File: org, Node: CamelCase links, Prev: Radio targets, Up: Internal links
  1105. 4.2.2 CamelCase words as links
  1106. ------------------------------
  1107. Org-mode also supports CamelCase words as links. This feature is not
  1108. turned on by default because of the inconsistencies this system suffers
  1109. from. To activate CamelCase words as links, you need to customize the
  1110. option `org-activate-links'. A CamelCase word then leads to a text
  1111. search such that `CamelCaseLink' is equivalent to `[[camel case link]]'.
  1112. 
  1113. File: org, Node: External links, Next: Handling links, Prev: Internal links, Up: Hyperlinks
  1114. 4.3 External links
  1115. ==================
  1116. Org-mode supports links to files, websites, Usenet and email messages,
  1117. and BBDB database entries. External links are URL-like locators. They
  1118. start with a short identifying string followed by a colon. There can be
  1119. no space after the colon. The following list shows examples for each
  1120. link type.
  1121. http://www.astro.uva.nl/~dominik on the web
  1122. file:/home/dominik/images/jupiter.jpg file, absolute path
  1123. file:papers/last.pdf file, relative path
  1124. news:comp.emacs Usenet link
  1125. mailto:adent@galaxy.net Mail link
  1126. vm:folder VM folder link
  1127. vm:folder#id VM message link
  1128. vm://myself@some.where.org/folder#id VM on remote machine
  1129. wl:folder WANDERLUST folder link
  1130. wl:folder#id WANDERLUST message link
  1131. mhe:folder MH-E folder link
  1132. mhe:folder#id MH-E message link
  1133. rmail:folder RMAIL folder link
  1134. rmail:folder#id RMAIL message link
  1135. gnus:group GNUS group link
  1136. gnus:group#id GNUS article link
  1137. bbdb:Richard Stallman BBDB link
  1138. shell:ls *.org A shell command
  1139. elisp:(find-file-other-frame "Elisp.org") An elisp form to evaluate
  1140. A link should be enclosed in double brackets and may contain a
  1141. descriptive text to be displayed instead of the url (*note Link
  1142. format::), for example:
  1143. [[http://www.gnu.org/software/emacs/][GNU Emacs]]
  1144. Org-mode also finds external links in the normal text and activates
  1145. them as links. If spaces must be part of the link (for example in
  1146. `bbdb:Richard Stallman'), or you need to remove ambiguities about the
  1147. end of the link, enclose them in angular brackets.
  1148. 
  1149. File: org, Node: Handling links, Next: Search options, Prev: External links, Up: Hyperlinks
  1150. 4.4 Handling links
  1151. ==================
  1152. Org-mode provides methods to create a link in the correct syntax, to
  1153. insert it into an org-mode file, and to follow the link.
  1154. `C-c l'
  1155. Store a link to the current location. This is a _global_ command
  1156. which can be used in any buffer to create a link. The link will be
  1157. stored for later insertion into an Org-mode buffer (see below).
  1158. For Org-mode files, if there is a `<<target>>' at the cursor, the
  1159. link points to the target. Otherwise it points to the current
  1160. headline. For VM, RMAIL, WANDERLUST, MH-E, GNUS and BBDB buffers,
  1161. the link will indicate the current article/entry. For W3 and W3M
  1162. buffers, the link goes to the current URL. For any other files,
  1163. the link will point to the file, with a search string (*note
  1164. Search options::) pointing to the contents of the current line.
  1165. If there is an active region, the selected words will form the
  1166. basis of the search string. If the automatically created link is
  1167. not working correctly or accurately enough, you can write custom
  1168. functions to select the search string and to do the search for
  1169. particular file types - see *Note Custom searches::. The key
  1170. binding `C-c l' is only a suggestion - see *Note Installation and
  1171. activation::.
  1172. `C-c C-l'
  1173. Insert a link. This prompts for a link to be inserted into the
  1174. buffer. You can just type a link, using text for an internal
  1175. link, or one of the link type prefixes mentioned in the examples
  1176. above. Through completion, all links stored during the current
  1177. session can be accessed. The link will be inserted into the
  1178. buffer, along with a descriptive text. Note that you don't have
  1179. to use this command to insert a link. Links in Org-mode are plain
  1180. text, and you can type or paste them straight into the buffer. By
  1181. using this command, the links are automatically enclosed in double
  1182. brackets, and you will be asked for the optional descriptive text.
  1183. If the link is a `file:' link and the linked file is located in
  1184. the same directory as the current file or a subdirectory of it, the
  1185. path of the file will be inserted relative to the current
  1186. directory.
  1187. `C-u C-c C-l'
  1188. When `C-c C-l' is called with a `C-u' prefix argument, a link to a
  1189. file will be inserted and you may use file name completion to
  1190. select the name of the file. The path to the file is inserted
  1191. relative to the directory of the current org file, if the linked
  1192. file is in the current directory or in a subdirectory of it, or if
  1193. the path is written relative to the current directory using `../'.
  1194. Otherwise an absolute path is used, if possible with `~/' for
  1195. your home directory. You can force an absolute path with two
  1196. `C-u' prefixes.
  1197. `C-c C-l with cursor on existing link'
  1198. When the cursor is on an existing link, `C-c C-l' allows you to
  1199. edit the link and description parts of the link.
  1200. `C-c C-o'
  1201. Open link at point. This will launch a web browser for URLs (using
  1202. `browse-url-at-point'), run vm/mh-e/wanderlust/rmail/gnus/bbdb for
  1203. the corresponding links, and execute the command in a shell link.
  1204. When the cursor is on an internal link, this commands runs the
  1205. corresponding search. When the cursor is on a TAG list in a
  1206. headline, it creates the corresponding TAGS view. If the cursor
  1207. is on a time stamp, it compiles the agenda for that date.
  1208. Furthermore, it will visit text files in `file:' links with Emacs
  1209. and select a suitable application for non-text files.
  1210. Classification of files is based on file extension only. See
  1211. option `org-file-apps'. If you want to override the default
  1212. application and visit the file with Emacs, use a `C-u' prefix.
  1213. `mouse-2'
  1214. `mouse-1'
  1215. On links, `mouse-2' will open the link just as `C-c C-o' would.
  1216. Under Emacs 22, also `mouse-1' will follow a link.
  1217. `mouse-3'
  1218. Like `mouse-2', but force file links to be opened with Emacs.
  1219. `C-c %'
  1220. Push the current position onto the mark ring, to be able to return
  1221. easily. Commands following an internal link do this automatically.
  1222. `C-c &'
  1223. Jump back to a recorded position. A position is recorded by the
  1224. commands following internal links, and by `C-c %'. Using this
  1225. command several times in direct succession moves through a ring of
  1226. previously recorded positions.
  1227. 
  1228. File: org, Node: Search options, Next: Custom searches, Prev: Handling links, Up: Hyperlinks
  1229. 4.5 Search options in file links
  1230. ================================
  1231. File links can contain additional information to make Emacs jump to a
  1232. particular location in the file when following a link. This can be a
  1233. line number or a search option after a double(1) colon. For example,
  1234. when the command `C-c l' creates a link (*note Handling links::) to a
  1235. file, it encodes the words in the current line as a search string that
  1236. can be used to find this line back later when following the link with
  1237. `C-c C-o'.
  1238. Here is the syntax of the different ways to attach a search to a file
  1239. link, together with an explanation:
  1240. [[file:~/code/main.c::255]]
  1241. [[file:~/xx.org::My Target]]
  1242. [[file:~/xx.org::*My Target]]
  1243. [[file:~/xx.org::/regexp/]]
  1244. `255'
  1245. Jump to line 255.
  1246. `My Target'
  1247. Search for a link target `<<My Target>>', or do a text search for
  1248. `my target', similar to the search in internal links, see *Note
  1249. Internal links::. In HTML export (*note HTML export::), such a
  1250. file link will become an HTML reference to the corresponding named
  1251. anchor in the linked file.
  1252. `*My Target'
  1253. In an Org-mode file, restrict search to headlines.
  1254. `/regexp/'
  1255. Do a regular expression search for `regexp'. This uses the Emacs
  1256. command `occur' to list all matches in a separate window. If the
  1257. target file is in Org-mode, `org-occur' is used to create a sparse
  1258. tree with the matches.
  1259. As a degenerate case, a file link with an empty file name can be used
  1260. to search the current file. For example, `<file:::find me>' does a
  1261. search for `find me' in the current file, just as `[[find me]]' would.
  1262. ---------- Footnotes ----------
  1263. (1) For backward compatibility, line numbers can also follow a
  1264. single colon.
  1265. 
  1266. File: org, Node: Custom searches, Next: Remember, Prev: Search options, Up: Hyperlinks
  1267. 4.6 Custom Searches
  1268. ===================
  1269. The default mechanism for creating search strings and for doing the
  1270. actual search related to a file link may not work correctly in all
  1271. cases. For example, BibTeX database files have many entries like
  1272. `year="1993"' which would not result in good search strings, because
  1273. the only unique identification for a BibTeX entry is the citation key.
  1274. If you come across such a problem, you can write custom functions to
  1275. set the right search string for a particular file type, and to do the
  1276. search for the string in the file. Using `add-hook', these functions
  1277. need to be added to the hook variables
  1278. `org-create-file-search-functions' and
  1279. `org-execute-file-search-functions'. See the docstring for these
  1280. variables for more information. Org-mode actually uses this mechanism
  1281. for BibTeX database files, and you can use the corresponding code as an
  1282. implementation example. Search for `BibTeX links' in the source file.
  1283. 
  1284. File: org, Node: Remember, Prev: Custom searches, Up: Hyperlinks
  1285. 4.7 Remember
  1286. ============
  1287. Another way to create org entries with links to other files is through
  1288. the _Remember_ package by John Wiegley. _Remember_ lets you store
  1289. quick notes with little interruption of your work flow. See
  1290. `http://www.emacswiki.org/cgi-bin/wiki/RememberMode' for more
  1291. information. The notes produced by _Remember_ can be stored in
  1292. different ways, and Org-mode files are a good target. Org-mode allows
  1293. you to file away notes either to a default file, or directly to the
  1294. correct location in your Org-mode outline tree. The following
  1295. customization will tell _Remember_ to use org files as target, and to
  1296. create annotations compatible with Org-mode links.
  1297. (setq org-directory "~/path/to/my/orgfiles/")
  1298. (setq org-default-notes-file "~/.notes")
  1299. (setq remember-annotation-functions '(org-remember-annotation))
  1300. (setq remember-handler-functions '(org-remember-handler))
  1301. (add-hook 'remember-mode-hook 'org-remember-apply-template)
  1302. In combination with Org-mode, you can use templates to generate
  1303. different types of remember notes. For example, if you would like to
  1304. use one template to create general TODO entries, and another one for
  1305. journal entries, you could use:
  1306. (setq org-remember-templates
  1307. '((?t "* TODO %?\n %i\n %a" "~/org/TODO.org")
  1308. (?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")))
  1309. In these entries, the character specifies how to select the template,
  1310. the first string specifies the template, and the (optional) second
  1311. string specifies a default file (overruling `org-default-notes-file')
  1312. as a target for this note.
  1313. When you call `M-x remember' to remember something, org will prompt
  1314. for a key to select the template and then prepare the buffer like
  1315. * TODO
  1316. <file:link to where you called remember>
  1317. or
  1318. * [2006-03-21 Tue 15:37]
  1319. <file:link to where you called remember>
  1320. See the variable `org-remember-templates' for more details.
  1321. When you are finished composing a note with remember, you have to
  1322. press `C-c C-c' to file the note away. The handler first prompts for a
  1323. target file - if you press <RET>, the value of `org-default-notes-file'
  1324. is used. Then the command offers the headings tree of the selected
  1325. file. You can either immediately press <RET> to get the note appended
  1326. to the file. Or you can use vertical cursor motion (<up> and <down>)
  1327. and visibility cycling (<TAB>) to find a better place. Pressing <RET>
  1328. or <left> or <right> leads to the following result.
  1329. Cursor Key Note gets inserted
  1330. position
  1331. buffer-start <RET> as level 2 heading at end of file
  1332. on headline <RET> as sublevel of the heading at cursor
  1333. <left> as same level, before current heading
  1334. <right> as same level, after current heading
  1335. not on <RET> at cursor position, level taken from context.
  1336. headline Or use prefix arg to specify level
  1337. manually.
  1338. So a fast way to store the note is to press `C-c C-c <RET> <RET>' to
  1339. append it to the default file. Even shorter would be `C-u C-c C-c',
  1340. which does the same without even showing the tree. But with little
  1341. extra effort, you can push it directly to the correct location.
  1342. Before inserting the text into a tree, the function ensures that the
  1343. text has a headline, i.e. a first line that starts with a `*'. If not,
  1344. a headline is constructed from the current date and some additional
  1345. data. If the variable `org-adapt-indentation' is non-nil, the entire
  1346. text is also indented so that it starts in the same column as the
  1347. headline (after the asterisks).
  1348. 
  1349. File: org, Node: TODO items, Next: Timestamps, Prev: Hyperlinks, Up: Top
  1350. 5 TODO items
  1351. ************
  1352. Org-mode does not maintain TODO lists as a separate document. TODO
  1353. items are an integral part of the notes file, because TODO items
  1354. usually come up while taking notes! With Org-mode, you simply mark any
  1355. entry in a tree as being a TODO item. In this way, the information is
  1356. not duplicated, and the entire context from which the item emerged is
  1357. always present when you check.
  1358. Of course, this technique causes TODO items to be scattered
  1359. throughout your file. Org-mode provides methods to give you an
  1360. overview over all things you have to do.
  1361. * Menu:
  1362. * TODO basics:: Marking and displaying TODO entries
  1363. * TODO extensions:: Workflow and assignments
  1364. * Priorities:: Some things are more important than others
  1365. 
  1366. File: org, Node: TODO basics, Next: TODO extensions, Prev: TODO items, Up: TODO items
  1367. 5.1 Basic TODO functionality
  1368. ============================
  1369. Any headline can become a TODO item by starting it with the word TODO,
  1370. for example:
  1371. *** TODO Write letter to Sam Fortune
  1372. The most important commands to work with TODO entries are:
  1373. `C-c C-t'
  1374. Rotate the TODO state of the current item between
  1375. ,-> (unmarked) -> TODO -> DONE --.
  1376. '--------------------------------'
  1377. The same rotation can also be done "remotely" from the timeline and
  1378. agenda buffers with the `t' command key (*note Agenda commands::).
  1379. `S-<right>'
  1380. `S-<left>'
  1381. Select the following/preceding TODO state, similar to cycling.
  1382. Mostly useful if more than two TODO states are possible (*note
  1383. TODO extensions::).
  1384. `C-c C-v'
  1385. View TODO items in a _sparse tree_ (*note Sparse trees::). Folds
  1386. the entire buffer, but shows all TODO items and the headings
  1387. hierarchy above them. With prefix arg, show also the DONE
  1388. entries. With numerical prefix N, show the tree for the Nth
  1389. keyword in the variable `org-todo-keywords'.
  1390. `C-c a t'
  1391. Show the global TODO list. This collects the TODO items from all
  1392. agenda files (*note Agenda views::) into a single buffer. The
  1393. buffer is in `agenda-mode', so there are commands to examine and
  1394. manipulate the TODO entries directly from that buffer (*note
  1395. Agenda commands::). *Note Global TODO list::, for more
  1396. information.
  1397. 
  1398. File: org, Node: TODO extensions, Next: Priorities, Prev: TODO basics, Up: TODO items
  1399. 5.2 Extended use of TODO keywords
  1400. =================================
  1401. The default implementation of TODO entries is just two states: TODO and
  1402. DONE. You can, however, use the TODO feature for more complicated
  1403. things by configuring the variables `org-todo-keywords' and
  1404. `org-todo-interpretation'. Using special setup, you can even use TODO
  1405. keywords in different ways in different org files.
  1406. Note that tags are another way to classify headlines in general and
  1407. TODO items in particular (*note Tags::).
  1408. * Menu:
  1409. * Workflow states:: From TODO to DONE in steps
  1410. * TODO types:: I do this, Fred the rest
  1411. * Per file keywords:: Different files, different requirements
  1412. 
  1413. File: org, Node: Workflow states, Next: TODO types, Prev: TODO extensions, Up: TODO extensions
  1414. 5.2.1 TODO keywords as workflow states
  1415. --------------------------------------
  1416. You can use TODO keywords to indicate different states in the process
  1417. of working on an item, for example:
  1418. (setq org-todo-keywords '("TODO" "FEEDBACK" "VERIFY" "DONE")
  1419. org-todo-interpretation 'sequence)
  1420. Changing these variables only becomes effective in a new Emacs
  1421. session. With this setup, the command `C-c C-t' will cycle an entry
  1422. from TODO to FEEDBACK, then to VERIFY, and finally to DONE. You may
  1423. also use a prefix argument to quickly select a specific state. For
  1424. example `C-3 C-c C-t' will change the state immediately to VERIFY. If
  1425. you define many keywords, you can use in-buffer completion (see *Note
  1426. Completion::) to insert these words into the buffer.
  1427. 
  1428. File: org, Node: TODO types, Next: Per file keywords, Prev: Workflow states, Up: TODO extensions
  1429. 5.2.2 TODO keywords as types
  1430. ----------------------------
  1431. The second possibility is to use TODO keywords to indicate different
  1432. types of action items. For example, you might want to indicate that
  1433. items are for "work" or "home". If you are into David Allen's _Getting
  1434. Things DONE_, you might want to use todo types `NEXTACTION', `WAITING',
  1435. `MAYBE'. Or, when you work with several people on a single project,
  1436. you might want to assign action items directly to persons, by using
  1437. their names as TODO keywords. This would be set up like this:
  1438. (setq org-todo-keywords '("Fred" "Sara" "Lucy" "Mike" "DONE")
  1439. org-todo-interpretation 'type)
  1440. In this case, different keywords do not indicate a sequence, but
  1441. rather different types. So it is normally not useful to change from
  1442. one type to another. Therefore, in this case the behavior of the
  1443. command `C-c C-t' is changed slightly(1). When used several times in
  1444. succession, it will still cycle through all names. But when you return
  1445. to the item after some time and execute `C-c C-t' again, it will switch
  1446. from each name directly to DONE. Use prefix arguments or completion to
  1447. quickly select a specific name. You can also review the items of a
  1448. specific TODO type in a sparse tree by using a numeric prefix to `C-c
  1449. C-v'. For example, to see all things Lucy has to do, you would use
  1450. `C-3 C-c C-v'. To collect Lucy's items from all agenda files into a
  1451. single buffer, you would use the prefix arg as well when creating the
  1452. global todo list: `C-3 C-c t'.
  1453. ---------- Footnotes ----------
  1454. (1) This is also true for the `t' command in the timeline and agenda
  1455. buffers.
  1456. 
  1457. File: org, Node: Per file keywords, Prev: TODO types, Up: TODO extensions
  1458. 5.2.3 Setting up TODO keywords for individual files
  1459. ---------------------------------------------------
  1460. It can be very useful to use different aspects of the TODO mechanism in
  1461. different files, which is not possible with the global settings
  1462. described above. For file-local settings, you need to add special
  1463. lines to the file which set the keywords and interpretation for that
  1464. file only. For example, to set one of the two examples discussed
  1465. above, you need one of the following lines, starting in column zero
  1466. anywhere in the file:
  1467. #+SEQ_TODO: TODO FEEDBACK VERIFY DONE
  1468. #+TYP_TODO: Fred Sara Lucy Mike DONE
  1469. To make sure you are using the correct keyword, type `#+' into the
  1470. buffer and then use `M-<TAB>' completion.
  1471. Remember that the last keyword must always mean that the item is DONE
  1472. (although you may use a different word). Also note that in each file,
  1473. only one of the two aspects of TODO keywords can be used. After
  1474. changing one of these lines, use `C-c C-c' with the cursor still in the
  1475. line to make the changes known to Org-mode(1).
  1476. If you want to use very many keywords, for example when working with
  1477. a large group of people, you may split the names over several lines:
  1478. #+TYP_TODO: Fred Sara Lucy Mike
  1479. #+TYP_TODO: Luis George Jules Jessica
  1480. #+TYP_TODO: Kim Arnold Peter
  1481. #+TYP_TODO: DONE
  1482. ---------- Footnotes ----------
  1483. (1) Org-mode parses these lines only when Org-mode is activated
  1484. after visiting a file. `C-c C-c' with the cursor in a line starting
  1485. with `#+' is simply restarting Org-mode, making sure that these changes
  1486. will be respected.
  1487. 
  1488. File: org, Node: Priorities, Prev: TODO extensions, Up: TODO items
  1489. 5.3 Priorities
  1490. ==============
  1491. If you use Org-mode extensively to organize your work, you may end up
  1492. with a number of TODO entries so large that you'd like to prioritize
  1493. them. This can be done by placing a _priority cookie_ into the
  1494. headline, like this
  1495. *** TODO [#A] Write letter to Sam Fortune
  1496. With its standard setup, Org-mode supports priorities `A', `B', and
  1497. `C'. `A' is the highest priority. An entry without a cookie is
  1498. treated as priority `B'. Priorities make a difference only in the
  1499. agenda (*note Weekly/Daily agenda::).
  1500. `C-c ,'
  1501. Set the priority of the current headline. The command prompts for
  1502. a priority character `A', `B' or `C'. When you press <SPC>
  1503. instead, the priority cookie is removed from the headline. The
  1504. priorities can also be changed "remotely" from the timeline and
  1505. agenda buffer with the `,' command (*note Agenda commands::).
  1506. `S-<up>'
  1507. `S-<down>'
  1508. Increase/decrease priority of current headline. Note that these
  1509. keys are also used to modify time stamps (*note Creating
  1510. timestamps::). Furthermore, these keys are also used by CUA-mode
  1511. (*note Conflicts::).
  1512. 
  1513. File: org, Node: Timestamps, Next: Tags, Prev: TODO items, Up: Top
  1514. 6 Timestamps
  1515. ************
  1516. Items can be labeled with timestamps to make them useful for project
  1517. planning.
  1518. * Menu:
  1519. * Time stamps:: Assigning a time to a tree entry
  1520. * Creating timestamps:: Commands which insert timestamps
  1521. * Progress logging:: Documenting when what work was done.
  1522. 
  1523. File: org, Node: Time stamps, Next: Creating timestamps, Prev: Timestamps, Up: Timestamps
  1524. 6.1 Time stamps, deadlines and scheduling
  1525. =========================================
  1526. A time stamp is a specification of a date (possibly with time) in a
  1527. special format, either `<2003-09-16 Tue>' or `<2003-09-16 Tue 09:39>'.
  1528. A time stamp can appear anywhere in the headline or body of an org-tree
  1529. entry. Its presence allows entries to be shown on specific dates in
  1530. the agenda (*note Weekly/Daily agenda::). We distinguish:
  1531. PLAIN TIME STAMP
  1532. A simple time stamp just assigns a date/time to an item. This is
  1533. just like writing down an appointment in a paper agenda, or like
  1534. writing down an event in a diary, when you want to take note of
  1535. when something happened. In the timeline and agenda displays, the
  1536. headline of an entry associated with a plain time stamp will be
  1537. shown exactly on that date.
  1538. TIME STAMP RANGE
  1539. Two time stamps connected by `--' denote a time range. The
  1540. headline will be shown on the first and last day of the range, and
  1541. on any dates that are displayed and fall in the range. Here is an
  1542. example:
  1543. ** Meeting in Amsterdam
  1544. <2004-08-23 Mon>--<2004-08-26 Thu>
  1545. TIME STAMP WITH SCHEDULED KEYWORD
  1546. If a time stamp is preceded by the word `SCHEDULED:', it means you
  1547. are planning to start working on that task on the given date. So
  1548. this is not about recording an event, but about planning your
  1549. work. The headline will be listed under the given date. In
  1550. addition, a reminder that the scheduled date has passed will be
  1551. present in the compilation for _today_, until the entry is marked
  1552. DONE. I.e., the task will automatically be forwarded until
  1553. completed.
  1554. *** TODO Call Trillian for a date on New Years Eve.
  1555. SCHEDULED: <2004-12-25 Sat>
  1556. TIME STAMP WITH DEADLINE KEYWORD
  1557. If a time stamp is preceded by the word `DEADLINE:', the task
  1558. (most likely a TODO item) is supposed to be finished on that date,
  1559. and it will be listed then. In addition, the compilation for
  1560. _today_ will carry a warning about the approaching or missed
  1561. deadline, starting `org-deadline-warning-days' before the due
  1562. date, and continuing until the entry is marked DONE. An example:
  1563. *** TODO write article about the Earth for the Guide
  1564. The editor in charge is <bbdb:Ford Prefect>
  1565. DEADLINE: <2004-02-29 Sun>
  1566. TIME STAMP WITH CLOSED KEYWORD
  1567. When `org-log-done' is non-nil, Org-mode will automatically insert
  1568. a special time stamp each time a TODO entry is marked done (*note
  1569. Progress logging::). This time stamp is enclosed in square
  1570. brackets instead of angular brackets.
  1571. TIME RANGE WITH CLOCK KEYWORD
  1572. When using the clock to time the work that is being done on
  1573. specific items, time ranges preceeded by the CLOCK keyword are
  1574. inserted automatically into the file. The time stamps are
  1575. enclosed in square brackets instead of angular brackets. *Note
  1576. Clocking work time::.
  1577. 
  1578. File: org, Node: Creating timestamps, Next: Progress logging, Prev: Time stamps, Up: Timestamps
  1579. 6.2 Creating timestamps
  1580. =======================
  1581. For Org-mode to recognize time stamps, they need to be in the specific
  1582. format. All commands listed below produce time stamps in the correct
  1583. format.
  1584. `C-c .'
  1585. Prompt for a date and insert a corresponding time stamp. When the
  1586. cursor is at a previously used time stamp, it is updated to NOW.
  1587. When this command is used twice in succession, a time range is
  1588. inserted.
  1589. `C-u C-c .'
  1590. Like `C-c .', but use the alternative format which contains date
  1591. and time. The default time can be rounded to multiples of 5
  1592. minutes, see the option `org-time-stamp-rounding-minutes'.
  1593. `C-c !'
  1594. Like `C-c .', but insert an inactive time stamp not triggering the
  1595. agenda.
  1596. `C-c <'
  1597. Insert a time stamp corresponding to the cursor date in the
  1598. Calendar.
  1599. `C-c >'
  1600. Access the Emacs calendar for the current date. If there is a
  1601. timestamp in the current line, goto the corresponding date instead.
  1602. `C-c C-o'
  1603. Access the agenda for the date given by the time stamp at point
  1604. (*note Weekly/Daily agenda::).
  1605. `C-c C-d'
  1606. Insert `DEADLINE' keyword along with a stamp. The insertion will
  1607. happen in the line directly following the headline.
  1608. `C-c C-w'
  1609. Create a sparse tree with all deadlines that are either past-due,
  1610. or which will become due within `org-deadline-warning-days'. With
  1611. `C-u' prefix, show all deadlines in the file. With a numeric
  1612. prefix, check that many days. For example, `C-1 C-c C-w' shows
  1613. all deadlines due tomorrow.
  1614. `C-c C-s'
  1615. Insert `SCHEDULED' keyword along with a stamp. The insertion will
  1616. happen in the line directly following the headline. Any CLOSED
  1617. timestamp will be removed.
  1618. `S-<left>'
  1619. `S-<right>'
  1620. Change date at cursor by one day. These key bindings conflict with
  1621. CUA-mode (*note Conflicts::).
  1622. `S-<up>'
  1623. `S-<down>'
  1624. Change the item under the cursor in a timestamp. The cursor can
  1625. be on a year, month, day, hour or minute. Note that if the cursor
  1626. is not at a time stamp, these same keys modify the priority of an
  1627. item. (*note Priorities::). The key bindings also conflict with
  1628. CUA-mode (*note Conflicts::).
  1629. `C-c C-y'
  1630. Evaluate a time range by computing the difference between start and
  1631. end. With prefix arg, insert result after the time range (in a
  1632. table: into the following column).
  1633. When Org-mode prompts for a date/time, the function reading your
  1634. input will replace anything you choose not to specify with the current
  1635. date and time. For details, see the documentation string of
  1636. `org-read-date'. Also, a calender will pop up to allow selecting a
  1637. date. The calendar can be fully controlled from the minibuffer, and a
  1638. date can be selected with the following commands:
  1639. `<'
  1640. Scroll calendar backwards by one month.
  1641. `>'
  1642. Scroll calendar forwards by one month.
  1643. `mouse-1'
  1644. Select date by clicking on it.
  1645. `S-<right>'
  1646. One day forward.
  1647. `S-<left>'
  1648. One day back.
  1649. `S-<down>'
  1650. One week forward.
  1651. `S-<up>'
  1652. One week back.
  1653. `M-S-<right>'
  1654. One month forward.
  1655. `M-S-<left>'
  1656. One month back.
  1657. `<RET>'
  1658. Choose date in calendar (only if nothing typed into minibuffer).
  1659. 
  1660. File: org, Node: Progress logging, Prev: Creating timestamps, Up: Timestamps
  1661. 6.3 Progress Logging
  1662. ====================
  1663. Org-mode can automatically record a time stamp when you mark a TODO item
  1664. as DONE. You can also measure precisely the time you spent on specific
  1665. items in a project by starting and stopping a clock when you start and
  1666. stop working on an aspect of a project.
  1667. * Menu:
  1668. * Closing items:: When was this entry makred DONE?
  1669. * Clocking work time:: When exactly did you work on this item?
  1670. 
  1671. File: org, Node: Closing items, Next: Clocking work time, Prev: Progress logging, Up: Progress logging
  1672. 6.3.1 Closing items
  1673. -------------------
  1674. If you want to keep track of _when_ a certain TODO item was finished,
  1675. turn on logging with
  1676. (setq org-log-done t)
  1677. Then each time you turn a TODO entry into DONE using either `C-c C-t'
  1678. in the Org-mode buffer or `t' in the agenda buffer, a line `CLOSED:
  1679. [timestamp]' will be inserted just after the headline. If you turn the
  1680. entry back into a TODO item again through further state cycling, that
  1681. line will be removed again. In the timeline (*note Timeline::) and in
  1682. the agenda (*note Weekly/Daily agenda::), you can then use the `l' key
  1683. to display the TODO items closed on each day, giving you an overview of
  1684. what has been done on a day.
  1685. 
  1686. File: org, Node: Clocking work time, Prev: Closing items, Up: Progress logging
  1687. 6.3.2 Clocking work time
  1688. ------------------------
  1689. Org-mode allows you to clock the time you spent on specific tasks in a
  1690. project. When you start working on an item, you can start the clock.
  1691. When you stop working on that tast, or when you makr the task done, the
  1692. clock is stoppend and the corresponding time interval is recorded. It
  1693. also computes the total time spent on each subtree of a project.
  1694. `C-c C-x C-i'
  1695. Start the clock on the current item (clock-in). This inserts the
  1696. CLOCK keyword together with a timestamp.
  1697. `C-c C-x C-o'
  1698. Stop the clock (clock-out). The inserts another timestamp at the
  1699. same location where the clock was last started. It also directly
  1700. computes the resulting time in inserts it after the time range as
  1701. `=> HH:MM'.
  1702. `C-c C-t'
  1703. Changing the TODO state of an item to DONE automatically stops the
  1704. clock if it is running in this same item.
  1705. `C-c C-x C-x'
  1706. Cancel the current clock. This is useful if a clock was started by
  1707. mistake, or if you ended up working on something else.
  1708. `C-c C-x C-d'
  1709. Display time summaries for each subtree in the current buffer.
  1710. This puts overlays at the end of each headline, showing the total
  1711. time recorded under that heading, including the time of any
  1712. subheadings. You can use visibility cycling to study the tree, but
  1713. the overlays disappear automatically when the buffer is changed.
  1714. The `l' key may be used in the timeline (*note Timeline::) and in
  1715. the agenda (*note Weekly/Daily agenda::) to show which tasks have been
  1716. worked on or closed during a day.
  1717. 
  1718. File: org, Node: Tags, Next: Agenda views, Prev: Timestamps, Up: Top
  1719. 7 Tags
  1720. ******
  1721. If you wish to implement a system of labels and contexts for
  1722. cross-correlating information, an excellent way is to assign tags to
  1723. headlines. Org-mode has extensive support for using tags.
  1724. Every headline can contain a list of tags, at the end of the
  1725. headline. Tags are normal words containing letters, numbers, `_', and
  1726. `@'. Tags must be preceded and followed by a single colon; like
  1727. `:WORK:'. Several tags can be specified like `:WORK:URGENT:'.
  1728. * Menu:
  1729. * Tag inheritance:: Tags use the tree structure of the outline
  1730. * Setting tags:: How to assign tags to a headline
  1731. * Tag searches:: Searching for combinations of tags
  1732. 
  1733. File: org, Node: Tag inheritance, Next: Setting tags, Prev: Tags, Up: Tags
  1734. 7.1 Tag inheritance
  1735. ===================
  1736. Tags make use of the hierarchical structure of outline trees. If a
  1737. heading has a certain tag, all subheadings will inherit the tag as
  1738. well. For example, in the list
  1739. * Meeting with the French group :WORK:
  1740. ** Summary by Frank :BOSS:NOTES:
  1741. *** TODO Prepare slides for him :ACTION:
  1742. the final heading will have the tags `:WORK:', `:BOSS:', `:NOTES:', and
  1743. `:ACTION:'. When executing tag searches and Org-mode finds that a
  1744. certain headline matches the search criterion, it will not check any
  1745. sublevel headline, assuming that these likely also match, and that the
  1746. list of matches can become very long. This may not be what you want,
  1747. however, and you can influence inheritance and searching using the
  1748. variables `org-use-tag-inheritance' and `org-tags-match-list-sublevels'.
  1749. 
  1750. File: org, Node: Setting tags, Next: Tag searches, Prev: Tag inheritance, Up: Tags
  1751. 7.2 Setting tags
  1752. ================
  1753. Tags can simply be typed into the buffer at the end of a headline.
  1754. After a colon, `M-<TAB>' offers completion on tags. There is also a
  1755. special command for inserting tags:
  1756. `C-c C-c'
  1757. Enter new tags for the current headline. Org-mode will either
  1758. offer completion or a special single-key interface for setting
  1759. tags, see below. After pressing <RET>, the tags will be inserted
  1760. and aligned to `org-tags-column'. When called with a `C-u'
  1761. prefix, all tags in the current buffer will be aligned to that
  1762. column, just to make things look nice. TAGS are automatically
  1763. realigned after promotion, demotion, and TODO state changes (*note
  1764. TODO basics::).
  1765. Org will support tag insertion based on a _list of tags_. By
  1766. default this list is constructed dynamically, containing all tags
  1767. currently used in the buffer. You may also globally specify a hard list
  1768. of tags with the variable `org-tag-alist'. Finally you can set the
  1769. allowed tags for a given file with lines like
  1770. #+TAGS: @WORK @HOME @TENNISCLUB
  1771. #+TAGS: Laptop Car PC Sailboat
  1772. The default support method is minibuffer completion. However,
  1773. Org-mode also implements a much better method: _fast tag selection_.
  1774. This method allows to select and deselect tags with a single key per
  1775. tag. To function efficiently, you should assign unique keys to all
  1776. tags. This can be done globally with
  1777. (setq org-tag-alist '(("@WORK" . ?w) ("@HOME" . ?h) ("Laptop" . ?l)))
  1778. or on a per-file basis with
  1779. #+TAGS: @WORK(w) @HOME(h) @TENNISCLUB(t) Laptop(l) PC(p)
  1780. You can also group together tags that are mutually exclusive. With
  1781. curly braces(1)
  1782. #+TAGS: { @WORK(w) @HOME(h) @TENNISCLUB(t) } Laptop(l) PC(p)
  1783. you indicate that at most one of `@WORK', `@HOME', and `@SAILBOAT'
  1784. should be selected.
  1785. Don't forget to press `C-c C-c' with the cursor in one of these lines
  1786. to activate any changes.
  1787. If at least one tag has a selection key, pressing `C-c C-c' will
  1788. automatically present you with a special interface, listing inherited
  1789. tags, the tags of the current headline, and a list of all legal tags
  1790. with corresponding keys(2). Pressing keys for the tags will add or
  1791. remove them from the list of tags in the current line. Selecting a tag
  1792. in a group of mutually exclusive tags will turn off any other tags from
  1793. that group. <SPC> clears all tags for this line, `RET' accepts the
  1794. modified set, and `C-g' aborts without installing changes. This method
  1795. lets you assign tags to a headline with very few keys. With the above
  1796. setup, you could clear the current tags and set `@HOME', `Laptop' and
  1797. `PC' tags with just the following keys: `C-c C-c <SPC> h l p <RET>'.
  1798. Switching from `@HOME' to `@WORK' would be done with `C-c C-c w <RET>'.
  1799. What if you have globally defined your preferred set of tags using
  1800. the variable `org-tag-alist', but would like to use a dynamic tag list
  1801. in a specific file? Just add an empty TAGS option line to that file:
  1802. #+TAGS:
  1803. ---------- Footnotes ----------
  1804. (1) In `org-mode-alist' use `'(:startgroup)' and `'(:endgroup)',
  1805. respectively. Several groups are allowed.
  1806. (2) Keys will automatically assigned to tags which have no
  1807. configured keys.
  1808. 
  1809. File: org, Node: Tag searches, Prev: Setting tags, Up: Tags
  1810. 7.3 Tag searches
  1811. ================
  1812. Once a tags system has been set up, it can be used to collect related
  1813. information into special lists.
  1814. `C-c \'
  1815. Create a sparse tree with all headlines matching a tags search.
  1816. `C-c a m'
  1817. Create a global list of tag matches from all agenda files. *Note
  1818. Matching headline tags::.
  1819. `C-c a M'
  1820. Create a global list of tag matches from all agenda files, but
  1821. check only TODO items and force checking subitems (see variable
  1822. `org-tags-match-list-sublevels').
  1823. A tags search string can use Boolean operators `&' for AND and `|'
  1824. for OR. `&' binds more strongly than `|'. Parenthesis are currently
  1825. not implemented. A tag may also be preceded by `-', to select against
  1826. it, and `+' is syntactic sugar for positive selection. The AND
  1827. operator `&' is optional when `+' or `-' is present. For example,
  1828. `+WORK-BOSS' would select all headlines that are tagged `:WORK:', but
  1829. discard those also tagged `:BOSS:'. The search string `WORK|LAPTOP'
  1830. selects all lines tagged `:WORK:' or `:LAPTOP:'. The string
  1831. `WORK|LAPTOP&NIGHT' requires that the `:LAPTOP:' lines are also tagged
  1832. `NIGHT'.
  1833. 
  1834. File: org, Node: Agenda views, Next: Exporting, Prev: Tags, Up: Top
  1835. 8 Agenda Views
  1836. **************
  1837. Due to the way Org-mode works, TODO items, time-stamped items, and
  1838. tagged headlines can be scattered throughout a file or even a number of
  1839. files. To get an overview over open action items, or over events that
  1840. are important for a particular date, this information must be collected,
  1841. sorted and displayed in an organized way.
  1842. Org-mode can select items based on various criteria, and display them
  1843. in a separate buffer. Three different views are provided:
  1844. * an _agenda_ that is like a calendar and shows information for
  1845. specific dates
  1846. * a _TODO list_ that covers all unfinished action items, and
  1847. * a _tags view_ that shows information based on the tags associated
  1848. with headlines in the outline tree.
  1849. The extracted information is displayed in a special _agenda buffer_.
  1850. This buffer is read-only, but provides commands to visit the
  1851. corresponding locations in the original Org-mode files, and even to
  1852. edit these files remotely.
  1853. * Menu:
  1854. * Agenda files:: Files being searched for agenda information
  1855. * Agenda dispatcher:: Keyboard access to agenda views
  1856. * Weekly/Daily agenda:: The calendar page with current tasks
  1857. * Global TODO list:: All unfinished action items
  1858. * Matching headline tags:: Structured information with fine-tuned search
  1859. * Timeline:: Time-sorted view for single file
  1860. * Agenda commands:: Remote editing of org trees
  1861. 
  1862. File: org, Node: Agenda files, Next: Agenda dispatcher, Prev: Agenda views, Up: Agenda views
  1863. 8.1 Agenda files
  1864. ================
  1865. The information to be shown is collected from all _agenda files_, the
  1866. files listed in the variable `org-agenda-files'(1). Thus even if you
  1867. only work with a single Org-mode file, this file should be put into
  1868. that list(2). You can customize `org-agenda-files', but the easiest
  1869. way to maintain it is through the following commands
  1870. `C-c ['
  1871. Add current file to the list of agenda files. The file is added to
  1872. the front of the list. If it was already in the list, it is moved
  1873. to the front. With prefix arg, file is added/moved to the end.
  1874. `C-c ]'
  1875. Remove current file from the list of agenda files.
  1876. `C-,'
  1877. Cycle through agenda file list, visiting one file after the other.
  1878. The Org menu contains the current list of files and can be used to
  1879. visit any of them.
  1880. ---------- Footnotes ----------
  1881. (1) If the value of that variable is not a list, but a single file
  1882. name, then the list of agenda files will be maintained in that external
  1883. file.
  1884. (2) When using the dispatcher pressing `1' before selecting a
  1885. command will actually limit the command to the current file, and ignore
  1886. `org-agenda-files' until the next dispatcher command.
  1887. 
  1888. File: org, Node: Agenda dispatcher, Next: Weekly/Daily agenda, Prev: Agenda files, Up: Agenda views
  1889. 8.2 The agenda dispatcher
  1890. =========================
  1891. The views are created through a dispatcher that should be bound to a
  1892. global key, for example `C-c a' (*note Installation and activation::).
  1893. In the following we will assume that `C-c a' is indeed how the
  1894. dispatcher is accessed and list keyboard access to commands
  1895. accordingly. After pressing `C-c a', an additional letter is required
  1896. to execute a command. The dispatcher offers the following default
  1897. commands:
  1898. `a'
  1899. Create the calendar-like agenda (*note Weekly/Daily agenda::).
  1900. `t / T'
  1901. Create a list of all TODO items (*note Global TODO list::).
  1902. `m / M'
  1903. Create a list of headlines matching a TAGS expression (*note
  1904. Matching headline tags::).
  1905. You can also define custom commands that will be accessible through
  1906. the dispatcher, just like the default commands. Custom commands are
  1907. global searches for tags and specific TODO keywords, or a variety of
  1908. sparse tree creating commands (*note Sparse trees::). As sparse trees
  1909. are only defined for a single org-mode file, these latter commands act
  1910. on the current buffer instead of the list of agenda files.
  1911. Custom commands are configured in the variable
  1912. `org-agenda-custom-commands'. You can customize this variable, for
  1913. example by pressing `C-c a C'. You can also directly set it with Emacs
  1914. Lisp in `.emacs'. For example:
  1915. (setq org-agenda-custom-commands
  1916. '(("w" todo "WAITING")
  1917. ("u" tags "+BOSS-URGENT")
  1918. ("U" tags-tree "+BOSS-URGENT")
  1919. ("f" occur-tree "\\<FIXME\\>")))
  1920. will define `C-c a w' as a global search for TODO entries with
  1921. `WAITING' as the TODO keyword, `C-c a u' as a global tags search for
  1922. headlines marked `:BOSS:' but not `:URGENT:', `C-c a U' to do the same
  1923. search but only in the current buffer and display the result as a
  1924. sparse tree, and `C-c a f' to create a sparse tree with all entries
  1925. containing the word `FIXME'. For more information, look at the
  1926. documentation string of the variable `org-agenda-custom-commands'.
  1927. 
  1928. File: org, Node: Weekly/Daily agenda, Next: Global TODO list, Prev: Agenda dispatcher, Up: Agenda views
  1929. 8.3 The weekly/daily agenda
  1930. ===========================
  1931. The purpose of the weekly/daily _agenda_ is to act like a page of a
  1932. paper agenda, showing all the tasks for the current week or day.
  1933. `C-c a a'
  1934. Compile an agenda for the current week from a list of org files.
  1935. The agenda shows the entries for each day. With a `C-u' prefix (or
  1936. when the variable `org-agenda-include-all-todo' is `t'), all
  1937. unfinished TODO items (including those without a date) are also
  1938. listed at the beginning of the buffer, before the first date.
  1939. Remote editing from the agenda buffer means, for example, that you
  1940. can change the dates of deadlines and appointments from the agenda
  1941. buffer. The commands available in the Agenda buffer are listed in
  1942. *Note Agenda commands::.
  1943. * Menu:
  1944. * Categories:: Not all tasks are equal
  1945. * Time-of-day specifications:: How the agenda knows the time
  1946. * Calendar/Diary integration:: Integrating Anniversaries and more
  1947. * Sorting of agenda items:: The order of things
  1948. 
  1949. File: org, Node: Categories, Next: Time-of-day specifications, Prev: Weekly/Daily agenda, Up: Weekly/Daily agenda
  1950. 8.3.1 Categories
  1951. ----------------
  1952. In the agenda buffer, each entry is preceded by a _category_, which is
  1953. derived from the file name. The category can also be set with a
  1954. special line anywhere in the buffer, looking like this:
  1955. #+CATEGORY: Thesis
  1956. If there are several such lines in a file, each specifies the
  1957. category for the text below it (but the first category also applies to
  1958. any text before the first CATEGORY line). The display in the agenda
  1959. buffer looks best if the category is not longer than 10 characters.
  1960. 
  1961. File: org, Node: Time-of-day specifications, Next: Calendar/Diary integration, Prev: Categories, Up: Weekly/Daily agenda
  1962. 8.3.2 Time-of-Day Specifications
  1963. --------------------------------
  1964. Org-mode checks each agenda item for a time-of-day specification. The
  1965. time can be part of the time stamp that triggered inclusion into the
  1966. agenda, for example as in `<2005-05-10 Tue 19:00>'. Time ranges can be
  1967. specified with two time stamps, like
  1968. `<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>'.
  1969. In the headline of the entry itself, a time(range) may also appear as
  1970. plain text (like `12:45' or a `8:30-1pm'. If the agenda integrates the
  1971. Emacs diary (*note Calendar/Diary integration::), time specifications
  1972. in diary entries are recognized as well.
  1973. For agenda display, Org-mode extracts the time and displays it in a
  1974. standard 24 hour format as part of the prefix. The example times in
  1975. the previous paragraphs would end up in the agenda like this:
  1976. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  1977. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  1978. 19:00...... The Vogon reads his poem
  1979. 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
  1980. If the agenda is in single-day mode, or for the display of today, the
  1981. timed entries are embedded in a time grid, like
  1982. 8:00...... ------------------
  1983. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  1984. 10:00...... ------------------
  1985. 12:00...... ------------------
  1986. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  1987. 14:00...... ------------------
  1988. 16:00...... ------------------
  1989. 18:00...... ------------------
  1990. 19:00...... The Vogon reads his poem
  1991. 20:00...... ------------------
  1992. 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
  1993. The time grid can be turned on and off with the variable
  1994. `org-agenda-use-time-grid', and can be configured with
  1995. `org-agenda-time-grid'.
  1996. 
  1997. File: org, Node: Calendar/Diary integration, Next: Sorting of agenda items, Prev: Time-of-day specifications, Up: Weekly/Daily agenda
  1998. 8.3.3 Calendar/Diary integration
  1999. --------------------------------
  2000. Emacs contains the calendar and diary by Edward M. Reingold. The
  2001. calendar displays a three-month calendar with holidays from different
  2002. countries and cultures. The diary allows you to keep track of
  2003. anniversaries, lunar phases, sunrise/set, recurrent appointments
  2004. (weekly, monthly) and more. In this way, it is quite complementary to
  2005. Org-mode. It can be very useful to combine output from Org-mode with
  2006. the diary.
  2007. In order to include entries from the Emacs diary into Org-mode's
  2008. agenda, you only need to customize the variable
  2009. (setq org-agenda-include-diary t)
  2010. After that, everything will happen automatically. All diary entries
  2011. including holidays, anniversaries etc will be included in the agenda
  2012. buffer created by Org-mode. <SPC>, <TAB>, and <RET> can be used from
  2013. the agenda buffer to jump to the diary file in order to edit existing
  2014. diary entries. The `i' command to insert new entries for the current
  2015. date works in the agenda buffer, as well as the commands `S', `M', and
  2016. `C' to display Sunrise/Sunset times, show lunar phases and to convert
  2017. to other calendars, respectively. `c' can be used to switch back and
  2018. forth between calendar and agenda.
  2019. 
  2020. File: org, Node: Sorting of agenda items, Prev: Calendar/Diary integration, Up: Weekly/Daily agenda
  2021. 8.3.4 Sorting of agenda items
  2022. -----------------------------
  2023. The entries for each day are sorted. The default order is to first
  2024. collect all items containing an explicit time-of-day specification.
  2025. These entries will be shown at the beginning of the list, as a
  2026. _schedule_ for the day. After that, items remain grouped in
  2027. categories, in the sequence given by `org-agenda-files'. Within each
  2028. category, items are sorted by priority (*note Priorities::).
  2029. The priority is a numerical quantity composed of the base priority
  2030. (2000 for priority `A', 1000 for `B', and 0 for `C'), plus additional
  2031. increments for overdue scheduled or deadline items.
  2032. Sorting can be customized using the variable
  2033. `org-agenda-sorting-strategy'.
  2034. 
  2035. File: org, Node: Global TODO list, Next: Matching headline tags, Prev: Weekly/Daily agenda, Up: Agenda views
  2036. 8.4 The global TODO list
  2037. ========================
  2038. The global TODO list contains all unfinished TODO items, formatted and
  2039. collected into a single place.
  2040. `C-c a t'
  2041. Show the global TODO list. This collects the TODO items from all
  2042. agenda files (*note Agenda views::) into a single buffer. The
  2043. buffer is in `agenda-mode', so there are commands to examine and
  2044. manipulate the TODO entries directly from that buffer (*note
  2045. Agenda commands::).
  2046. `C-c a T'
  2047. Like the above, but allows selection of a specific TODO keyword.
  2048. You can also do this by specifying a prefix argument to `C-c a t'.
  2049. With a `C-u' prefix you are prompted for a keyword. With a
  2050. numeric prefix, the Nth keyword in `org-todo-keywords' is selected. The
  2051. `r' key in the agenda buffer regenerates it, and you can give a
  2052. prefix argument to this command to change the selected TODO
  2053. keyword, for example `3 r'. If you often need a search for a
  2054. specific keyword, define a custom command for it (*note Agenda
  2055. dispatcher::).
  2056. Remote editing of TODO items means that you can change the state of a
  2057. TODO entry with a single key press. The commands available in the TODO
  2058. list are described in *Note Agenda commands::.
  2059. 
  2060. File: org, Node: Matching headline tags, Next: Timeline, Prev: Global TODO list, Up: Agenda views
  2061. 8.5 Matching headline tags
  2062. ==========================
  2063. If headlines in the agenda files are marked with _tags_ (*note Tags::),
  2064. you can select headlines based on the tags that apply to them and
  2065. collect them into an agenda buffer.
  2066. `C-c a m'
  2067. Produce a list of all headlines that match a given set of tags.
  2068. The command prompts for a selection criterion, which is a boolean
  2069. logic expression with tags, like `+WORK+URGENT-WITHBOSS' or
  2070. `WORK|HOME' (*note Tags::). If you often need a specific search,
  2071. define a custom command for it (*note Agenda dispatcher::).
  2072. `C-c a M'
  2073. Like `C-c a m', but only select headlines that are also TODO items
  2074. and force checking subitems (see variable
  2075. `org-tags-match-list-sublevels'.
  2076. The commands available in the tags list are described in *Note
  2077. Agenda commands::.
  2078. 
  2079. File: org, Node: Timeline, Next: Agenda commands, Prev: Matching headline tags, Up: Agenda views
  2080. 8.6 Timeline for a single file
  2081. ==============================
  2082. The timeline is not really an agenda view, because it only summarizes
  2083. items from a single Org-mode file. But it also uses the agenda buffer
  2084. and provides similar commands, so we discuss it here. The timeline
  2085. shows all time-stamped items in a single Org-mode file (or the selected
  2086. part of it), in a _time-sorted view_. The main purpose of this command
  2087. is to give an overview over events in a project.
  2088. `C-c C-r'
  2089. Show a time-sorted view of the org file, with all time-stamped
  2090. items. When called with a `C-u' prefix, all unfinished TODO
  2091. entries (scheduled or not) are also listed under the current date.
  2092. The commands available in the timeline buffer are listed in *Note
  2093. Agenda commands::.
  2094. 
  2095. File: org, Node: Agenda commands, Prev: Timeline, Up: Agenda views
  2096. 8.7 Commands in the agenda buffer
  2097. =================================
  2098. Entries in the agenda buffer are linked back to the org file or diary
  2099. file where they originate. You are not allowed to edit the agenda
  2100. buffer itself, but commands are provided to show and jump to the
  2101. original entry location, and to edit the org-files "remotely" from the
  2102. agenda buffer. In this way, all information is stored only once,
  2103. removing the risk that your agenda and note files may diverge.
  2104. Some commands can be executed with mouse clicks on agenda lines. For
  2105. the other commands, the cursor needs to be in the desired line.
  2106. Motion
  2107. ......
  2108. `n'
  2109. Next line (same as <up>).
  2110. `p'
  2111. Previous line (same as <down>).
  2112. View/GoTo org file
  2113. ..................
  2114. `mouse-3'
  2115. `<SPC>'
  2116. Display the original location of the item in another window.
  2117. `L'
  2118. Display original location and recenter that window.
  2119. `mouse-2'
  2120. `mouse-1'
  2121. `<TAB>'
  2122. Go to the original location of the item in another window. Under
  2123. Emacs 22, `mouse-1' will also works for this.
  2124. `<RET>'
  2125. Go to the original location of the item and delete other windows.
  2126. `f'
  2127. Toggle Follow mode. In Follow mode, as you move the cursor through
  2128. the agenda buffer, the other window always shows the corresponding
  2129. location in the org file. The initial setting for this mode in new
  2130. agenda buffers can be set with the variable
  2131. `org-agenda-start-with-follow-mode'.
  2132. `l'
  2133. Toggle Logbook mode. In Logbook mode, entries that where marked
  2134. DONE while logging was on (variable `org-log-done') are shown in
  2135. the agenda, as are entries that have been clocked on that day.
  2136. Change display
  2137. ..............
  2138. `o'
  2139. Delete other windows.
  2140. `w'
  2141. Switch to weekly view (7 days displayed together).
  2142. `d'
  2143. Switch to daily view (just one day displayed).
  2144. `D'
  2145. Toggle the inclusion of diary entries. See *Note Calendar/Diary
  2146. integration::.
  2147. `g'
  2148. Toggle the time grid on and off. See also the variables
  2149. `org-agenda-use-time-grid' and `org-agenda-time-grid'.
  2150. `r'
  2151. Recreate the agenda buffer, for example to reflect the changes
  2152. after modification of the time stamps of items with S-<left> and
  2153. S-<right>. When the buffer is the global todo list, a prefix
  2154. argument is interpreted to create a selective list for a specific
  2155. TODO keyword.
  2156. `<right>'
  2157. Display the following `org-agenda-ndays' days. For example, if
  2158. the display covers a week, switch to the following week. With
  2159. prefix arg, go forward that many times `org-agenda-ndays' days.
  2160. `<left>'
  2161. Display the previous dates.
  2162. `.'
  2163. Goto today.
  2164. Remote editing
  2165. ..............
  2166. `0-9'
  2167. Digit argument.
  2168. `t'
  2169. Change the TODO state of the item, both in the agenda and in the
  2170. original org file.
  2171. `T'
  2172. Show all tags associated with the current item. Because of
  2173. inheritance, this may be more than the tags listed in the line
  2174. itself.
  2175. `:'
  2176. Set tags for the current headline.
  2177. `,'
  2178. Set the priority for the current item. Org-mode prompts for the
  2179. priority character. If you reply with <SPC>, the priority cookie
  2180. is removed from the entry.
  2181. `p'
  2182. Display weighted priority of current item.
  2183. `+'
  2184. `S-<up>'
  2185. Increase the priority of the current item. The priority is
  2186. changed in the original buffer, but the agenda is not resorted.
  2187. Use the `r' key for this.
  2188. `-'
  2189. `S-<down>'
  2190. Decrease the priority of the current item.
  2191. `C-c C-s'
  2192. Schedule this item
  2193. `C-c C-d'
  2194. Set a deadline for this item.
  2195. `S-<right>'
  2196. Change the time stamp associated with the current line by one day
  2197. into the future. With prefix argument, change it by that many
  2198. days. For example, `3 6 5 S-<right>' will change it by a year.
  2199. The stamp is changed in the original org file, but the change is
  2200. not directly reflected in the agenda buffer. Use the `r' key to
  2201. update the buffer.
  2202. `S-<left>'
  2203. Change the time stamp associated with the current line by one day
  2204. into the past.
  2205. `>'
  2206. Change the time stamp associated with the current line to today.
  2207. The key `>' has been chosen, because it is the same as `S-.' on my
  2208. keyboard.
  2209. `I'
  2210. Start the clock on the current item. If a clock is running
  2211. already, it is stopped first.
  2212. `O'
  2213. Stop the previously started clock.
  2214. `X'
  2215. Cancel the currently running clock.
  2216. Calendar commands
  2217. .................
  2218. `c'
  2219. Open the Emacs calendar and move to the date at the agenda cursor.
  2220. `c'
  2221. When in the calendar, compute and show the Org-mode agenda for the
  2222. date at the cursor.
  2223. `i'
  2224. Insert a new entry into the diary. Prompts for the type of entry
  2225. (day, weekly, monthly, yearly, anniversary, cyclic) and creates a
  2226. new entry in the diary, just as `i d' etc. would do in the
  2227. calendar. The date is taken from the cursor position.
  2228. `M'
  2229. Show the phases of the moon for the three months around current
  2230. date.
  2231. `S'
  2232. Show sunrise and sunset times. The geographical location must be
  2233. set with calendar variables, see documentation of the Emacs
  2234. calendar.
  2235. `C'
  2236. Convert the date at cursor into many other cultural and historic
  2237. calendars.
  2238. `H'
  2239. Show holidays for three month around the cursor date.
  2240. `C-c C-x C-c'
  2241. Export a single iCalendar file containing entries from all agenda
  2242. files.
  2243. Quit and Exit
  2244. .............
  2245. `q'
  2246. Quit agenda, remove the agenda buffer.
  2247. `x'
  2248. Exit agenda, remove the agenda buffer and all buffers loaded by
  2249. Emacs for the compilation of the agenda. Buffers created by the
  2250. user to visit org files will not be removed.
  2251. 
  2252. File: org, Node: Exporting, Next: Publishing, Prev: Agenda views, Up: Top
  2253. 9 Exporting
  2254. ***********
  2255. Org-mode documents can be exported into a variety of other formats. For
  2256. printing and sharing of notes, ASCII export produces a readable and
  2257. simple version of an Org-mode file. HTML export allows you to publish a
  2258. notes file on the web, while the XOXO format provides a solid base for
  2259. exchange with a broad range of other applications. To incorporate
  2260. entries with associated times like deadlines or appointments into a
  2261. desktop calendar program like iCal, Org-mode can also produce extracts
  2262. in the iCalendar format. Currently Org-mode only supports export, not
  2263. import of these different formats.
  2264. When exporting, Org-mode uses special conventions to enrich the
  2265. output produced. *Note Text interpretation::, for more details.
  2266. * Menu:
  2267. * ASCII export:: Exporting to plain ASCII
  2268. * HTML export:: Exporting to HTML
  2269. * XOXO export:: Exporting to XOXO
  2270. * iCalendar export:: Exporting in iCalendar format
  2271. * Text interpretation:: How the exporter looks at the file
  2272. 
  2273. File: org, Node: ASCII export, Next: HTML export, Prev: Exporting, Up: Exporting
  2274. 9.1 ASCII export
  2275. ================
  2276. ASCII export produces a simple and very readable version of an Org-mode
  2277. file.
  2278. `C-c C-x a'
  2279. Export as ASCII file. If there is an active region, only the
  2280. region will be exported. For an org file `myfile.org', the ASCII
  2281. file will be `myfile.txt'. The file will be overwritten without
  2282. warning.
  2283. `C-c C-x v a'
  2284. Export only the visible part of the document.
  2285. In the exported version, the first 3 outline levels will become
  2286. headlines, defining a general document structure. Additional levels
  2287. will be exported as itemized lists. If you want that transition to
  2288. occur at a different level, specify it with a prefix argument. For
  2289. example,
  2290. C-1 C-c C-x a
  2291. creates only top level headlines and does the rest as items. When
  2292. headlines are converted to items, the indentation of the text following
  2293. the headline is changed to fit nicely under the item. This is done with
  2294. the assumption that the first bodyline indicates the base indenation of
  2295. the body text. Any indenation larger than this is adjusted to preserve
  2296. the layout relative to the first line. Should there be lines with less
  2297. indentation than the first, these are left alone.
  2298. 
  2299. File: org, Node: HTML export, Next: XOXO export, Prev: ASCII export, Up: Exporting
  2300. 9.2 HTML export
  2301. ===============
  2302. Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
  2303. HTML formatting, in ways similar to John Grubers _markdown_ language,
  2304. but with additional support for tables.
  2305. `C-c C-x h'
  2306. Export as HTML file `myfile.html'.
  2307. `C-c C-x b'
  2308. Export as HTML file and open it with a browser.
  2309. `C-c C-x v h'
  2310. `C-c C-x v b'
  2311. Export only the visible part of the document.
  2312. In the exported version, the first 3 outline levels will become
  2313. headlines, defining a general document structure. Additional levels
  2314. will be exported as itemized lists. If you want that transition to
  2315. occur at a different level, specify it with a prefix argument. For
  2316. example,
  2317. C-2 C-c C-x b
  2318. creates two levels of headings and does the rest as items.
  2319. If you want to include HTML tags which should be interpreted as such,
  2320. mark them with `@' as in `@<b>bold text@</b>'. Plain `<' and `>' are
  2321. always transformed to `&lt;' and `&gt;' in HTML export.
  2322. Internal links (*note Internal links::) will continue to work in HTML
  2323. files only if they match a dedicated `<<target>>'. Automatic links
  2324. created by radio targets (*note Radio targets::) will also work in the
  2325. HTML file. Links to external files will still work if the HTML file is
  2326. in the same directory as the Org-mode file. Links to other `.org'
  2327. files will be translated into HTML links under the assumption that an
  2328. HTML version also exists of the linked file. For information related to
  2329. linking files while publishing them to a publishing directory see *Note
  2330. Publishing links::.
  2331. You can also give style information for the exported file. The HTML
  2332. exporter assigns the following CSS classes to appropriate parts of the
  2333. document - your style specifications may change these:
  2334. .todo TODO keywords
  2335. .done the DONE keyword
  2336. .timestamp time stamp
  2337. .timestamp-kwd keyword associated with a time stamp, like SCHEDULED
  2338. .tag tag in a headline
  2339. .target target for links
  2340. The default style specification can be configured through the option
  2341. `org-export-html-style'. If you want to use a file-local style, you
  2342. may use file variables, best wrapped into a COMMENT section at the end
  2343. of the outline tree. For example:
  2344. * COMMENT HTML style specifications
  2345. # Local Variables:
  2346. # org-export-html-style: " <style type=\"text/css\">
  2347. # p {font-weight: normal; color: gray; }
  2348. # h1 {color: black; }
  2349. # </style>"
  2350. # End:
  2351. Remember to execute `M-x normal-mode' after changing this to make
  2352. the new style visible to Emacs. This command restarts org-mode for the
  2353. current buffer and forces Emacs to re-evaluate the local variables
  2354. section in the buffer.
  2355. 
  2356. File: org, Node: XOXO export, Next: iCalendar export, Prev: HTML export, Up: Exporting
  2357. 9.3 XOXO export
  2358. ===============
  2359. Org-mode contains an exporter that produces XOXO-style output.
  2360. Currently, this exporter only handles the general outline structure and
  2361. does not interpret any additional Org-mode features.
  2362. `C-c C-x C-x'
  2363. Export as XOXO file `myfile.html'.
  2364. `C-c C-x v x'
  2365. Export only the visible part of the document.
  2366. 
  2367. File: org, Node: iCalendar export, Next: Text interpretation, Prev: XOXO export, Up: Exporting
  2368. 9.4 iCalendar export
  2369. ====================
  2370. Some people like to use Org-mode for keeping track of projects, but
  2371. still prefer a standard calendar application for anniversaries and
  2372. appointments. In this case it can be useful to have deadlines and
  2373. other time-stamped items in Org-mode files show up in the calendar
  2374. application. Org-mode can export calendar information in the standard
  2375. iCalendar format.
  2376. `C-c C-x i'
  2377. Create iCalendar entries for the current file and store them in
  2378. the same directory, using a file extension `.ics'.
  2379. `C-c C-x C-i'
  2380. Like `C-c C-x i', but do this for all files in `org-agenda-files'.
  2381. For each of these files, a separate iCalendar file will be
  2382. written.
  2383. `C-c C-x c'
  2384. Create a single large iCalendar file from all files in
  2385. `org-agenda-files' and write it to the file given by
  2386. `org-combined-agenda-icalendar-file'.
  2387. How this calendar is best read and updated, depends on the
  2388. application you are using. For example, when using iCal under Apple
  2389. MacOS X, you could create a new calendar `OrgMode' (the default name
  2390. for the calendar created by `C-c C-x c', see the variables
  2391. `org-icalendar-combined-name' and
  2392. `org-combined-agenda-icalendar-file'). Then set Org-mode to overwrite
  2393. the corresponding file `~/Library/Calendars/OrgMode.ics'. You may even
  2394. use AppleScript to make iCal re-read the calendar files each time a new
  2395. version of `OrgMode.ics' is produced. Here is the setup needed for
  2396. this:
  2397. (setq org-combined-agenda-icalendar-file
  2398. "~/Library/Calendars/OrgMode.ics")
  2399. (add-hook 'org-after-save-iCalendar-file-hook
  2400. (lambda ()
  2401. (shell-command
  2402. "osascript -e 'tell application \"iCal\" to reload calendars'")))
  2403. 
  2404. File: org, Node: Text interpretation, Prev: iCalendar export, Up: Exporting
  2405. 9.5 Text interpretation by the exporter
  2406. =======================================
  2407. The exporter backends interpret additional structure in the Org-mode
  2408. file in order to produce better output.
  2409. * Menu:
  2410. * Comment lines:: Some lines will not be exported
  2411. * Enhancing text:: Subscripts, symbols and more
  2412. * Export options:: How to influence the export settings
  2413. 
  2414. File: org, Node: Comment lines, Next: Enhancing text, Prev: Text interpretation, Up: Text interpretation
  2415. 9.5.1 Comment lines
  2416. -------------------
  2417. Lines starting with `#' in column zero are treated as comments and will
  2418. never be exported. Also entire subtrees starting with the word
  2419. `COMMENT' will never be exported. Finally, any text before the first
  2420. headline will not be exported either.
  2421. `C-c ;'
  2422. Toggle the COMMENT keyword at the beginning of an entry.
  2423. 
  2424. File: org, Node: Enhancing text, Next: Export options, Prev: Comment lines, Up: Text interpretation
  2425. 9.5.2 Enhancing text for export
  2426. -------------------------------
  2427. Some of the export backends of Org-mode allow for sophisticated text
  2428. formatting, this is true in particular for the HTML backend. Org-mode
  2429. has a number of typing conventions that allow to produce a richly
  2430. formatted output.
  2431. * Plain lists `-', `*' or `+' as bullet, or with `1.' or `2)' as
  2432. enumerator will be recognized and transformed if the backend
  2433. supports lists. See *Note Plain lists::.
  2434. * You can make words *bold*, /italic/, and _underlined_
  2435. * Simple TeX-like math constructs are interpreted:
  2436. - `10^22' and `J_n' are super- and subscripts. You can quote
  2437. `^' and `_' with a backslash: `\_' and `\^'
  2438. - `\alpha' indicates a Greek letter, `\to' an arrow. You can
  2439. use completion for these macros, just type `\' and maybe a few
  2440. letters, and press `M-<TAB>' to see possible completions.
  2441. * Tables are transformed into native tables under the exporter, if
  2442. the export backend supports this. Data fields before the first
  2443. horizontal separator line will be formatted as table header fields.
  2444. * If a headline starts with the word `QUOTE', the text below the
  2445. headline will be typeset as fixed-width, to allow quoting of
  2446. computer codes etc. Lines starting with `:' are also typeset in
  2447. fixed-width font.
  2448. `C-c :'
  2449. Toggle fixed-width for entry (QUOTE) or region, see below.
  2450. * A double backslash _at the end of a line_ enforces a line break at
  2451. this position.
  2452. If these conversions conflict with your habits of typing ASCII text,
  2453. they can all be turned off with corresponding variables (see the
  2454. customization group `org-export-general', and the following section
  2455. which explains how to set export options with special lines in a buffer.
  2456. 
  2457. File: org, Node: Export options, Prev: Enhancing text, Up: Text interpretation
  2458. 9.5.3 Export options
  2459. --------------------
  2460. The exporter recognizes special lines in the buffer which provide
  2461. additional information. These lines may be put anywhere in the file.
  2462. The whole set of lines can be inserted into the buffer with `C-c C-x
  2463. t'. For individual lines, a good way to make sure the keyword is
  2464. correct is to type `#+' and then use `M-<TAB>' completion (*note
  2465. Completion::).
  2466. `C-c C-x t'
  2467. Insert template with export options, see example below.
  2468. #+TITLE: the title to be shown (default is the buffer name)
  2469. #+AUTHOR: the author (default taken from `user-full-name')
  2470. #+EMAIL: his/her email address (default from `user-mail-address')
  2471. #+LANGUAGE: language for HTML, e.g. `en' (`org-export-default-language')
  2472. #+TEXT: Some descriptive text to be inserted at the beginning.
  2473. #+TEXT: Several lines may be given.
  2474. #+OPTIONS: H:2 num:t toc:t \n:nil t ::t |:t ^:t *:nil TeX:t
  2475. The OPTIONS line is a compact form to specify export settings. Here
  2476. you can:
  2477. H: set the number of headline levels for export
  2478. num: turn on/off section-numbers
  2479. toc: turn on/off table of contents
  2480. \n: turn on/off linebreak-preservation
  2481. @: turn on/off quoted HTML tags
  2482. :: turn on/off fixed-width sections
  2483. |: turn on/off tables
  2484. ^: turn on/off TeX-like syntax for sub- and superscripts.
  2485. *: turn on/off emphasized text (bold, italic, underlined)
  2486. TeX: turn on/off TeX macros
  2487. 
  2488. File: org, Node: Publishing, Next: Miscellaneous, Prev: Exporting, Up: Top
  2489. 10 Publishing
  2490. *************
  2491. Org-mode includes(1) a publishing management system that allows you to
  2492. configure automatic HTML conversion of _projects_ composed of
  2493. interlinked org files. This system is called _org-publish_. You can
  2494. also configure org-publish to automatically upload your exported HTML
  2495. pages and related attachments, such as images and source code files, to
  2496. a web server. Org-publish turns org-mode into a web-site authoring
  2497. tool.
  2498. Org-publish has been contributed to Org-mode by David O'Toole.
  2499. * Menu:
  2500. * Configuration:: Defining projects
  2501. * Sample configuration:: Example projects
  2502. * Triggering publication:: Publication commands
  2503. ---------- Footnotes ----------
  2504. (1) `org-publish.el' is not yet part of emacs, so if you are using
  2505. `org.el' as it comes with Emacs, you need to download this file
  2506. separately. Also make sure org.el is at least version 4.27.
  2507. 
  2508. File: org, Node: Configuration, Next: Sample configuration, Prev: Publishing, Up: Publishing
  2509. 10.1 Configuration
  2510. ==================
  2511. Publishing needs significant configuration to specify files, destination
  2512. and many other properties of a project.
  2513. * Menu:
  2514. * Project alist:: The central configuration variable
  2515. * File sources and destinations:: From here to there
  2516. * Selecting files:: What files are part of the project?
  2517. * Publishing action:: Setting the function doing the publishing
  2518. * Publishing options:: Tweaking HTML export
  2519. * Publishing links:: Which links keep working after publishing?
  2520. * Project page index:: Publishing a list of project files
  2521. 
  2522. File: org, Node: Project alist, Next: File sources and destinations, Prev: Configuration, Up: Configuration
  2523. 10.1.1 The variable `org-publish-project-alist'
  2524. -----------------------------------------------
  2525. Org-publish is configured almost entirely through setting the value of
  2526. one variable, called `org-publish-project-alist'. Each element of the
  2527. list configures one project, and may be in one of the two following
  2528. forms:
  2529. ("project-name" :property value :property value ...)
  2530. or
  2531. ("project-name" :components ("project-name" "project-name" ...))
  2532. In both cases, projects are configured by specifying property values.
  2533. A project defines the set of files that will be published, as well as
  2534. the publishing configuration to use when publishing those files. When
  2535. a project takes the second form listed above, the individual members of
  2536. the "components" property are taken to be components of the project,
  2537. which group together files requiring different publishing options. When
  2538. you publish such a "meta-project" all the components will also publish.
  2539. 
  2540. File: org, Node: File sources and destinations, Next: Selecting files, Prev: Project alist, Up: Configuration
  2541. 10.1.2 Sources and destinations for files
  2542. -----------------------------------------
  2543. Most properties are optional, but some should always be set. In
  2544. particular, org-publish needs to know where to look for source files,
  2545. and where to put published files.
  2546. `:base-directory' Directory containing publishing source files
  2547. `:publishing-directory'Directory (possibly remote) where output files
  2548. will be published.
  2549. 
  2550. File: org, Node: Selecting files, Next: Publishing action, Prev: File sources and destinations, Up: Configuration
  2551. 10.1.3 Selecting files
  2552. ----------------------
  2553. By default, all files with extension `.org' in the base directory are
  2554. considered part of the project. This can be modified by setting the
  2555. properties
  2556. `:base-extension' Extension (without the dot!) of source files. This
  2557. actually is a regular expression.
  2558. `:exclude' Regular expression to match file names that should
  2559. not be published, even though they have been selected
  2560. on the basis of their extension.
  2561. `:include' List of files to be included regardless of
  2562. `:base-extension' and `:exclude'.
  2563. 
  2564. File: org, Node: Publishing action, Next: Publishing options, Prev: Selecting files, Up: Configuration
  2565. 10.1.4 Publishing Action
  2566. ------------------------
  2567. Publishing means that a file is copied to the destination directory and
  2568. possibly transformed in the process. The default transformation is to
  2569. export Org-mode files as HTML files, and this is done by the function
  2570. `org-publish-org-to-html' which calls the HTML exporter (*note HTML
  2571. export::). Other files like images only need to be copied to the
  2572. publishing destination. For non-Org-mode files, you need to specify
  2573. the publishing function.
  2574. `:publishing-function' Function executing the publication of a file.
  2575. The function must accept two arguments: a property list containing at
  2576. least a `:publishing-directory' property, and the name of the file to
  2577. be published. It should take the specified file, make the necessary
  2578. transformation (if any) and place the result into the destination
  2579. folder. You can write your own publishing function, but `org-publish'
  2580. provides one for attachments (files that only need to be copied):
  2581. `org-publish-attachment'.
  2582. 
  2583. File: org, Node: Publishing options, Next: Publishing links, Prev: Publishing action, Up: Configuration
  2584. 10.1.5 Options for the HTML exporter
  2585. ------------------------------------
  2586. The property list can be used to set many export options for the HTML
  2587. exporter. In most cases, these properties correspond to user variables
  2588. in Org-mode. The table below lists these properties along with the
  2589. variable they belong to. See the documentation string for the
  2590. respective variable for details.
  2591. `:language' `org-export-default-language'
  2592. `:headline-levels' `org-export-headline-levels'
  2593. `:section-numbers' `org-export-with-section-numbers'
  2594. `:table-of-contents' `org-export-with-toc'
  2595. `:emphasize' `org-export-with-emphasize'
  2596. `:sub-superscript' `org-export-with-sub-superscripts'
  2597. `:TeX-macros' `org-export-with-TeX-macros'
  2598. `:fixed-width' `org-export-with-fixed-width'
  2599. `:timestamps' `org-export-with-timestamps'
  2600. .
  2601. `:tags' `org-export-with-tags'
  2602. .
  2603. `:tables' `org-export-with-tables'
  2604. `:table-auto-headline' `org-export-highlight-first-table-line'
  2605. `:style' `org-export-html-style'
  2606. `:convert-org-links' `org-export-html-link-org-files-as-html'
  2607. `:inline-images' `org-export-html-inline-images'
  2608. `:expand-quoted-html' `org-export-html-expand'
  2609. `:timestamp' `org-export-html-with-timestamp'
  2610. `:publishing-directory'`org-export-publishing-directory'
  2611. `:preamble' `org-export-html-preamble'
  2612. `:postamble' `org-export-html-postamble'
  2613. `:auto-preamble' `org-export-html-auto-preamble'
  2614. `:auto-postamble' `org-export-html-auto-postamble'
  2615. `:author' `user-full-name'
  2616. `:email' `user-mail-address'
  2617. When a property is given a value in org-publish-project-alist, its
  2618. setting overrides the value of the corresponding user variable (if any)
  2619. during publishing. options set within a file (*note Export options::),
  2620. however, override everything.
  2621. 
  2622. File: org, Node: Publishing links, Next: Project page index, Prev: Publishing options, Up: Configuration
  2623. 10.1.6 Links between published files
  2624. ------------------------------------
  2625. To create a link from one Org-mode file to another, you would use
  2626. something like `[[file:foo.org][The foo]]' or simply `file:foo.org.'
  2627. (*note Hyperlinks::). Upon publishing this link becomes a link to
  2628. `foo.html'. In this way, you can interlink the pages of your "org web"
  2629. project and the links will work as expected when you publish them to
  2630. HTML.
  2631. You may also link to related files, such as images. Provided you are
  2632. careful with relative pathnames, and provided you have also configured
  2633. org-publish to upload the related files, these links will work too.
  2634. *Note Complex example:: for an example of this usage.
  2635. 
  2636. File: org, Node: Project page index, Prev: Publishing links, Up: Configuration
  2637. 10.1.7 Project page index
  2638. -------------------------
  2639. The following properties may be used to control publishing of an index
  2640. of files or summary page for a given project.
  2641. `:auto-index' When non-nil, publish an index during
  2642. org-publish-current-project or org-publish-all.
  2643. `:index-filename' Filename for output of index. Defaults to `index.org'
  2644. (which becomes `index.html').
  2645. `:index-title' Title of index page. Defaults to name of file.
  2646. `:index-function' Plugin function to use for generation of index.
  2647. Defaults to `org-publish-org-index', which generates
  2648. a plain list of links to all files in the project.
  2649. 
  2650. File: org, Node: Sample configuration, Next: Triggering publication, Prev: Configuration, Up: Publishing
  2651. 10.2 Sample configuration
  2652. =========================
  2653. Below we provide two example configurations. The first one is a simple
  2654. project publishing only a set of Org-mode files. The second example is
  2655. more complex, with a multi-component project.
  2656. * Menu:
  2657. * Simple example:: One-component publishing
  2658. * Complex example:: A multi-component publishing example
  2659. 
  2660. File: org, Node: Simple example, Next: Complex example, Prev: Sample configuration, Up: Sample configuration
  2661. 10.2.1 Example: simple publishing configuration
  2662. -----------------------------------------------
  2663. This example publishes a set of Org-mode files to the `public_html'
  2664. directory on the local machine.
  2665. (setq org-publish-project-alist
  2666. '(("org"
  2667. :base-directory "~/org/"
  2668. :publishing-directory "~/public_html"
  2669. :section-numbers nil
  2670. :table-of-contents nil
  2671. :style "<link rel=stylesheet
  2672. href=\"../other/mystyle.css\"
  2673. type=\"text/css\">")))
  2674. 
  2675. File: org, Node: Complex example, Prev: Simple example, Up: Sample configuration
  2676. 10.2.2 Example: complex publishing configuration
  2677. ------------------------------------------------
  2678. This more complicated example publishes an entire website, including
  2679. org files converted to HTML, image files, emacs lisp source code, and
  2680. stylesheets. The publishing-directory is remote and private files are
  2681. excluded.
  2682. To ensure that links are preserved, care should be taken to replicate
  2683. your directory structure on the web server, and to use relative file
  2684. paths. For example, if your org files are kept in `~/org' and your
  2685. publishable images in `~/images', you'd link to an image with
  2686. file:../images/myimage.png
  2687. On the web server, the relative path to the image should be the
  2688. same. You can accomplish this by setting up an "images" folder in the
  2689. right place on the webserver, and publishing images to it.
  2690. (setq org-publish-project-alist
  2691. '(("orgfiles"
  2692. :base-directory "~/org/"
  2693. :base-extension "org"
  2694. :publishing-directory "/ssh:user@host:~/html/notebook/"
  2695. :publishing-function org-publish-org-to-html
  2696. :exclude "PrivatePage.org" ;; regexp
  2697. :headline-levels 3
  2698. :section-numbers nil
  2699. :table-of-contents nil
  2700. :style "<link rel=stylesheet
  2701. href=\"../other/mystyle.css\" type=\"text/css\">"
  2702. :auto-preamble t
  2703. :auto-postamble nil)
  2704. ("images"
  2705. :base-directory "~/images/"
  2706. :base-extension "jpg\\|gif\\|png"
  2707. :publishing-directory "/ssh:user@host:~/html/images/"
  2708. :publishing-function org-publish-attachment)
  2709. ("other"
  2710. :base-directory "~/other/"
  2711. :base-extension "css\\|el"
  2712. :publishing-directory "/ssh:user@host:~/html/other/"
  2713. :publishing-function org-publish-attachment)
  2714. ("website" :components ("orgfiles" "images" "other"))))
  2715. 
  2716. File: org, Node: Triggering publication, Prev: Sample configuration, Up: Publishing
  2717. 10.3 Triggering publication
  2718. ===========================
  2719. Once org-publish is properly configured, you can publish with the
  2720. following functions:
  2721. `C-c C-e c'
  2722. Prompts for a specific project to publish.
  2723. `C-c C-e p'
  2724. Publishes the project the current file is part of.
  2725. `C-c C-e f'
  2726. Publishes only the current file.
  2727. `C-c C-e a'
  2728. Publish all projects.
  2729. Org uses timestamps to track when a file has changed. The above
  2730. functions normally only publish changed files. You can override this and
  2731. force publishing of all files by giving a prefix argument.
  2732. 
  2733. File: org, Node: Miscellaneous, Next: Index, Prev: Publishing, Up: Top
  2734. 11 Miscellaneous
  2735. ****************
  2736. * Menu:
  2737. * Completion:: M-TAB knows what you need
  2738. * Customization:: Adapting Org-mode to your taste
  2739. * Summary of in-buffer settings:: Using special lines to set options
  2740. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  2741. * Clean view:: Getting rid of leading stars in the outline
  2742. * TTY keys:: Using Org-mode on a tty
  2743. * FAQ:: Frequently asked questions
  2744. * Interaction:: Other Emacs packages
  2745. * Bugs:: Things which do not work perfectly
  2746. * Acknowledgments:: These people provided feedback and more
  2747. 
  2748. File: org, Node: Completion, Next: Customization, Prev: Miscellaneous, Up: Miscellaneous
  2749. 11.1 Completion
  2750. ===============
  2751. Org-mode supports in-buffer completion. This type of completion does
  2752. not make use of the minibuffer. You simply type a few letters into the
  2753. buffer and use the key to complete text right there.
  2754. `M-<TAB>'
  2755. Complete word at point
  2756. * At the beginning of a headline, complete TODO keywords.
  2757. * After `\', complete TeX symbols supported by the exporter.
  2758. * After `*', complete CamelCase versions of all headlines in the
  2759. buffer.
  2760. * After `:', complete tags used elsewhere in the buffer.
  2761. * After `#+', complete the special keywords like `TYP_TODO' or
  2762. `OPTIONS' which set file-specific options for Org-mode. When
  2763. the option keyword is already complete, pressing `M-<TAB>'
  2764. again will insert example settings for this keyword.
  2765. * Elsewhere, complete dictionary words using ispell.
  2766. 
  2767. File: org, Node: Customization, Next: Summary of in-buffer settings, Prev: Completion, Up: Miscellaneous
  2768. 11.2 Customization
  2769. ==================
  2770. There are more than 100 variables that can be used to customize
  2771. Org-mode. For the sake of compactness of the manual, we are not
  2772. describing the variables here. A structured overview of customization
  2773. variables is available with `M-x org-customize'. Or select `Browse Org
  2774. Group' from the `Org->Customization' menu. Many settings can also be
  2775. activated on a per-file basis, by putting special lines into the buffer
  2776. (*note Summary of in-buffer settings::).
  2777. 
  2778. File: org, Node: Summary of in-buffer settings, Next: The very busy C-c C-c key, Prev: Customization, Up: Miscellaneous
  2779. 11.3 Summary of in-buffer settings
  2780. ==================================
  2781. Org-mode uses special lines in the buffer to define settings on a
  2782. per-file basis. These lines start with a `#+' followed by a keyword, a
  2783. colon, and then individual words defining a setting. Several setting
  2784. words can be in the same line, but you can also have multiple lines for
  2785. the keyword. While these settings are described throughout the manual,
  2786. here is a summary. After changing any of those lines in the buffer,
  2787. press `C-c C-c' with the cursor still in the line to activate the
  2788. changes immediately. Otherwise they become effective only when the
  2789. file is visited again in a new Emacs session.
  2790. `#+STARTUP:'
  2791. This line sets options to be used at startup of org-mode, when an
  2792. Org-mode file is being visited. The first set of options deals
  2793. with the initial visibility of the outline tree. The
  2794. corresponding variable for global default settings is
  2795. `org-startup-folded', with a default value `t', which means
  2796. `overview'.
  2797. overview top-level headlines only
  2798. content all headlines
  2799. showall no folding at all, show everything
  2800. Then there are options for aligning tables upon visiting a file.
  2801. This is useful in files containing narrowed table columns. The
  2802. corresponding variable is `org-startup-align-all-tables', with a
  2803. default value `nil'.
  2804. align align all tables
  2805. noalign don't align tables on startup
  2806. Logging when a TODO item is marked DONE (variable `org-log-done')
  2807. can be configured using these options.
  2808. logging record a timestamp when an item is marked DONE
  2809. nologging don't record when items are marked DONE
  2810. Here are the options for hiding leading stars in outline headings.
  2811. The corresponding variables are `org-hide-leading-stars' and
  2812. `org-odd-levels-only', both with a default setting `nil' (meaning
  2813. `showstars' and `oddeven').
  2814. hidestars make all but one of the stars starting a headline invisible.
  2815. showstars show all stars starting a headline
  2816. odd allow only odd outline levels (1,3,...)
  2817. oddeven allow all outline levels
  2818. `#+SEQ_TODO: #+TYP_TODO:'
  2819. These lines set the TODO keywords and their interpretation in the
  2820. current file. The corresponding variables are `org-todo-keywords'
  2821. and `org-todo-interpretation'.
  2822. `#+TAGS: TAG1(c1) TAG2(c2)'
  2823. These lines (several such lines are allowed) specify the legal
  2824. tags in this file, and (potentially) the corresponding _fast tag
  2825. selection_ keys. The corresponding variable is `org-tag-alist'.
  2826. `#+CATEGORY:'
  2827. This line sets the category for the agenda file. The category
  2828. applies for all subsequent lines until the next `#+CATEGORY' line,
  2829. or the end of the file.
  2830. `#+TBLFM:'
  2831. This line contains the formulas for the table directly above the
  2832. line.
  2833. `#+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS:'
  2834. These lines provide settings for exporting files. For more
  2835. details see *Note Export options::.
  2836. 
  2837. File: org, Node: The very busy C-c C-c key, Next: Clean view, Prev: Summary of in-buffer settings, Up: Miscellaneous
  2838. 11.4 The very busy C-c C-c key
  2839. ==============================
  2840. The key `C-c C-c' has many purposes in org-mode, which are all
  2841. mentioned scattered throughout this manual. One specific function of
  2842. this key is to add _tags_ to a headline (*note Tags::). In many other
  2843. circumstances it means something like _Hey Org-mode, look here and
  2844. update according to what you see here_. Here is a summary of what this
  2845. means in different contexts.
  2846. - If the cursor is in one of the special `#+KEYWORD' lines, this
  2847. triggers scanning the buffer for these lines and updating the
  2848. information.
  2849. - If the cursor is inside a table, realign the table. This command
  2850. works even if the automatic table editor has been turned off.
  2851. - If the cursor is on a `#+TBLFM' line, re-apply the formulas to the
  2852. entire table.
  2853. - If the cursor is inside a table created by the `table.el' package,
  2854. activate that table.
  2855. - If the current buffer is a remember buffer, close note and file it.
  2856. with a prefix argument, file it without further interaction to the
  2857. default location.
  2858. - If the cursor is on a `<<<target>>>', update radio targets and
  2859. corresponding links in this buffer.
  2860. - If the cursor is in a plain list item with a checkbox, toggle the
  2861. status of the checkbox.
  2862. - If the cursor is on a numbered item in a plain list, renumber the
  2863. ordered list.
  2864. 
  2865. File: org, Node: Clean view, Next: TTY keys, Prev: The very busy C-c C-c key, Up: Miscellaneous
  2866. 11.5 A cleaner outline view
  2867. ===========================
  2868. Some people find it noisy and distracting that the Org-mode headlines
  2869. are starting with a potentially large number of stars. For example the
  2870. tree from *Note Headlines:::
  2871. * Top level headline
  2872. ** Second level
  2873. *** 3rd level
  2874. some text
  2875. *** 3rd level
  2876. more text
  2877. * Another top level headline
  2878. Unfortunately this is deeply ingrained into the code of Org-mode and
  2879. cannot be easily changed. You can, however, modify the display in such
  2880. a way that all leading stars become invisible and the outline more easy
  2881. to read. To do this, customize the variable `org-hide-leading-stars'
  2882. like this:
  2883. (setq org-hide-leading-stars t)
  2884. or change this on a per-file basis with one of the lines (anywhere in
  2885. the buffer)
  2886. #+STARTUP: showstars
  2887. #+STARTUP: hidestars
  2888. Press `C-c C-c' with the cursor in a `STARTUP' line to activate the
  2889. modifications.
  2890. With stars hidden, the tree becomes:
  2891. * Top level headline
  2892. * Second level
  2893. * 3rd level
  2894. some text
  2895. * 3rd level
  2896. more text
  2897. * Another top level headline
  2898. Note that the leading stars are not truly replaced by whitespace, they
  2899. are only fontified with the face `org-hide' that uses the background
  2900. color as font color. If are are not using either white or black
  2901. background, you may have to customize this face to get the wanted
  2902. effect. Another possibility is to set this font such that the extra
  2903. stars are almost invisible, for example using the color `grey90' on a
  2904. white background.
  2905. Things become cleaner still if you skip all the even levels and use
  2906. only odd levels 1, 3, 5..., effectively adding two stars to go from one
  2907. outline level to the next:
  2908. * Top level headline
  2909. * Second level
  2910. * 3rd level
  2911. some text
  2912. * 3rd level
  2913. more text
  2914. * Another top level headline
  2915. In order to make the structure editing and export commands handle this
  2916. convention correctly, use
  2917. (setq org-odd-levels-only t)
  2918. or set this on a per-file basis with one of the following lines (don't
  2919. forget to press `C-c C-c' with the cursor in the startup line to
  2920. activate changes immediately).
  2921. #+STARTUP: odd
  2922. #+STARTUP: oddeven
  2923. You can convert an Org-mode file from single-star-per-level to the
  2924. double-star-per-level convention with `M-x org-convert-to-odd-levels
  2925. RET' in that file. The reverse operation is `M-x
  2926. org-convert-to-oddeven-levels'.
  2927. 
  2928. File: org, Node: TTY keys, Next: FAQ, Prev: Clean view, Up: Miscellaneous
  2929. 11.6 Using org-mode on a tty
  2930. ============================
  2931. Org-mode uses a number of keys that are not accessible on a tty. This
  2932. applies to most special keys like cursor keys, <TAB> and <RET>, when
  2933. these are combined with modifier keys like <Meta> and/or <Shift>.
  2934. Org-mode uses these bindings because it needs to provide keys for a
  2935. large number of commands, and because these keys appeared particularly
  2936. easy to remember. In order to still be able to access the core
  2937. functionality of Org-mode on a tty, alternative bindings are provided.
  2938. Here is a complete list of these bindings, which are obviously more
  2939. cumbersome to use. Note that sometimes a work-around can be better.
  2940. For example changing a time stamp is really only fun with `S-<cursor>'
  2941. keys. On a tty you would rather use `C-c .' to re-insert the
  2942. timestamp.
  2943. Default Alternative 1 Alternative 2
  2944. `S-<TAB>' `C-u <TAB>'
  2945. `M-<left>' `C-c C-x l' `<Esc> <left>'
  2946. `M-S-<left>'`C-c C-x L'
  2947. `M-<right>' `C-c C-x r' `<Esc>
  2948. <right>'
  2949. `M-S-<right>'`C-c C-x R'
  2950. `M-<up>' `C-c C-x u' `<Esc> <up>'
  2951. `M-S-<up>' `C-c C-x U'
  2952. `M-<down>' `C-c C-x d' `<Esc> <down>'
  2953. `M-S-<down>'`C-c C-x D'
  2954. `S-<RET>' `C-c C-x c'
  2955. `M-<RET>' `C-c C-x m' `<Esc> <RET>'
  2956. `M-S-<RET>' `C-c C-x M'
  2957. `S-<left>' `C-c C-x
  2958. <left>'
  2959. `S-<right>' `C-c C-x
  2960. <right>'
  2961. `S-<up>' `C-c C-x
  2962. <up>'
  2963. `S-<down>' `C-c C-x
  2964. <down>'
  2965. 
  2966. File: org, Node: FAQ, Next: Interaction, Prev: TTY keys, Up: Miscellaneous
  2967. 11.7 Frequently asked questions
  2968. ===============================
  2969. 1. When I try to use Org-mode, I always get `(wrong-type-argument
  2970. keymapp nil)'.
  2971. This is a conflict with an outdated version of the `allout.el'.
  2972. See *Note Conflicts::.
  2973. 2. Org-mode seems to be a useful default mode for the various
  2974. `README' files I have scattered through my directories. How do I
  2975. turn it on for all `README' files?
  2976. (add-to-list 'auto-mode-alist '("README$" . org-mode))
  2977. 3. I would like to use editing features of org-mode in other modes,
  2978. is this possible?
  2979. Not really. For tables there is `orgtbl-mode' which implements the
  2980. table editor as a minor mode. For other features you need to
  2981. switch to Org-mode temporarily, or prepare text in a different
  2982. buffer.
  2983. 4. Can I get the visibility-cycling features in outline-mode and
  2984. outline-minor-mode?
  2985. Yes, these functions are written in a way that they are
  2986. independent of the outline setup. The following setup provides
  2987. standard Org-mode functionality in outline-mode on <TAB> and
  2988. `S-<TAB>'. For outline-minor-mode, we use `C-<TAB>' instead of
  2989. <TAB>, because <TAB> usually has mode-specific tasks.
  2990. (add-hook 'outline-minor-mode-hook
  2991. (lambda ()
  2992. (define-key outline-minor-mode-map [(control tab)] 'org-cycle)
  2993. (define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle)))
  2994. (add-hook 'outline-mode-hook
  2995. (lambda ()
  2996. (define-key outline-mode-map [(tab)] 'org-cycle)
  2997. (define-key outline-mode-map [(shift tab)] 'org-global-cycle)))
  2998. Or check out `outline-magic.el', which does this and also provides
  2999. promotion and demotion functionality. `outline-magic.el' is
  3000. available at `http://www.astro.uva.nl/~dominik/Tools/OutlineMagic'.
  3001. 5. Some of my links stopped working after I upgraded to a version
  3002. 4.20 or later. Why is this, and how can I fix it?
  3003. These must be links in plain text, containing white space, such as
  3004. `bbdb:Richard Stallman'. You need to protect these links by
  3005. putting double brackets around them, like `[[bbdb:Richard
  3006. Stallman]]'.
  3007. 6. I see that Org-mode now creates links using the double bracket
  3008. convention that hides the link part and the brackets, only showing
  3009. the description part. How can I convert my old links to this new
  3010. format?
  3011. Execute once in each Org-mode file: `M-x org-upgrade-old-links'.
  3012. This replaces angular brackets with the new link format.
  3013. 7. I don't care if you find the new bracket links great, I am
  3014. attached to the old style using angular brackets and no hiding of
  3015. the link text. Please give them back to me, don't tell me it is
  3016. not possible!
  3017. Would I let you down like that? If you must, you can do this
  3018. (setq org-link-style 'plain
  3019. org-link-format "<%s>")
  3020. 8. When I am executing shell/elisp links I always get a confirmation
  3021. prompt and need to type `yes <RET>', that's 4 key presses! Can I
  3022. get rid of this?
  3023. The confirmation is there to protect you from unwantingly execute
  3024. potentially dangerous commands. For example, imagine a link
  3025. `[[shell:rm -rf ~/*][Google Search]]'. In an Org-mode buffer, this
  3026. command would look like `Google Search', but really it would remove
  3027. your home directory. If you wish, you can make it easier to
  3028. respond to the query by setting `org-confirm-shell-link-function'
  3029. and/or `org-confirm-elisp-link-function' to `y-or-n-p'. Then a
  3030. single `y' keypress will be enough to confirm those links. It is
  3031. also possible to turn off this check entirely, but I do not
  3032. recommend to do this. Be warned.
  3033. 9. All these stars are driving me mad, I just find the Emacs outlines
  3034. unreadable. Can't you just put white space and a single star as a
  3035. starter for headlines?
  3036. See *Note Clean view::.
  3037. 10. I would like to have two windows on the same Org-mode file, but
  3038. with different outline visibility. Is that possible?
  3039. In GNU Emacs, you may use _indirect buffers_ which do exactly this.
  3040. See the documentation on the command `make-indirect-buffer'. In
  3041. XEmacs, this is currently not possible because of the different
  3042. outline implementation.
  3043. 11. When I export my TODO list, every TODO item becomes a separate
  3044. section. How do I enforce these items to be exported as an
  3045. itemized list?
  3046. If you plan to use ASCII or HTML export, make sure things you want
  3047. to be exported as item lists are level 4 at least, even if that
  3048. does mean there is a level jump. For example:
  3049. * Todays top priorities
  3050. **** TODO write a letter to xyz
  3051. **** TODO Finish the paper
  3052. **** Pick up kids at the school
  3053. Alternatively, if you need a specific value for the heading/item
  3054. transition in a particular file, use the `+OPTIONS' line to
  3055. configure the `H' switch.
  3056. +OPTIONS: H:2; ...
  3057. 12. I would like to export only a subtree of my file to HTML. How?
  3058. If you want to export a subtree, mark the subtree as region and
  3059. then export. Marking can be done with `C-c @ C-x C-x', for
  3060. example.
  3061. 13. Org-mode takes over the S-cursor keys. I also want to use
  3062. CUA-mode, is there a way to fix this conflict?
  3063. Yes, see *Note Conflicts::.
  3064. 14. One of my table columns has started to fill up with `#ERROR'.
  3065. What is going on?
  3066. Org-mode tried to compute the column from other fields using a
  3067. formula stored in the `#+TBLFM:' line just below the table, and
  3068. the evaluation of the formula fails. Fix the fields used in the
  3069. formula, or fix the formula, or remove it!
  3070. 15. When I am in the last column of a table and just above a
  3071. horizontal line in the table, pressing TAB creates a new table line
  3072. before the horizontal line. How can I quickly move to the line
  3073. below the horizontal line instead?
  3074. Press <down> (to get on the separator line) and then <TAB>. Or
  3075. configure the variable `org-table-tab-jumps-over-hlines'.
  3076. 16. How can I change the indentation of an entire table without fixing
  3077. every line by hand?
  3078. The indentation of a table is set by the first line. So just fix
  3079. the indentation of the first line and realign with <TAB>.
  3080. 17. Is it possible to include entries from org-mode files into my
  3081. emacs diary?
  3082. Since the org-mode agenda is much more powerful and can contain the
  3083. diary (*note Calendar/Diary integration::), you should think twice
  3084. before deciding to do this. Integrating Org-mode information into
  3085. the diary is, however, possible. You need to turn on _fancy diary
  3086. display_ by setting in `.emacs':
  3087. (add-hook 'diary-display-hook 'fancy-diary-display)
  3088. Then include the following line into your `~/diary' file, in order
  3089. to get the entries from all files listed in the variable
  3090. `org-agenda-files':
  3091. &%%(org-diary)
  3092. You may also select specific files with
  3093. &%%(org-diary) ~/path/to/some/org-file.org
  3094. &%%(org-diary) ~/path/to/another/org-file.org
  3095. If you now launch the calendar and press `d' to display a diary,
  3096. the headlines of entries containing a timestamp, date range,
  3097. schedule, or deadline referring to the selected date will be
  3098. listed. Just like Org-mode's agenda view, the diary for _today_
  3099. contains additional entries for overdue deadlines and scheduled
  3100. items. See also the documentation of the `org-diary' function.
  3101. Under XEmacs, it is not possible to jump back from the diary to
  3102. the org, this works only in the agenda buffer.
  3103. 
  3104. File: org, Node: Interaction, Next: Bugs, Prev: FAQ, Up: Miscellaneous
  3105. 11.8 Interaction with other packages
  3106. ====================================
  3107. Org-mode lives in the world of GNU Emacs and interacts in various ways
  3108. with other code out there.
  3109. * Menu:
  3110. * Extensions:: Third-party extensions for Org-mode
  3111. * Cooperation:: Packages Org-mode cooperates with
  3112. * Conflicts:: Packages that lead to conflicts
  3113. 
  3114. File: org, Node: Extensions, Next: Cooperation, Prev: Interaction, Up: Interaction
  3115. 11.8.1 Third-party extensions for Org-mode
  3116. ------------------------------------------
  3117. The following extensions for Org-mode have been written by other people:
  3118. `org-mouse.el' by Piotr Zielinski
  3119. This package implements extended mouse functionality for Org-mode.
  3120. It allows you to cycle visibility and to edit the document
  3121. structure with the mouse. Best of all, it provides a
  3122. context-sensitive menu on <mouse-3> that changes depending on the
  3123. context of a mouse-click. `org-mouse.el' is freely available at
  3124. `http://www.cl.cam.ac.uk/~pz215/files/org-mouse.el'.
  3125. `org-publish.el' by David O'Toole
  3126. This package provides facilities for publishing related sets of
  3127. Org-mode files together with linked files like images as a
  3128. webpages. It is highly configurable and can be used for other
  3129. publishing purposes as well. As of Org-mode version 4.30,
  3130. `org-publish.el' is part of the Org-mode distribution. It is not
  3131. yet part of Emacs, however, due to a pending copyright assignment.
  3132. In the mean time, `org-publish.el' can be downloaded from David's
  3133. site: `http://dto.freeshell.org/e/org-publish.el'.
  3134. 
  3135. File: org, Node: Cooperation, Next: Conflicts, Prev: Extensions, Up: Interaction
  3136. 11.8.2 Packages that Org-mode cooperates with
  3137. ---------------------------------------------
  3138. `calc.el' by Dave Gillespie
  3139. Org-mode uses the calc package for implementing spreadsheet
  3140. functionality in its tables (*note Table calculations::).
  3141. Org-modes checks for the availability of calc by looking for the
  3142. function `calc-eval' which should be autoloaded in your setup if
  3143. calc has been installed properly. As of Emacs 22, calc is part of
  3144. the Emacs distribution. Another possibility for interaction
  3145. between the two packages is using calc for embedded calculations.
  3146. *Note Embedded Mode: (calc)Embedded Mode.
  3147. `constants.el' by Carsten Dominik
  3148. In a table formula (*note Table calculations::), it is possible to
  3149. use names for natural constants or units. Instead of defining
  3150. your own constants in the variable `org-table-formula-constants',
  3151. install the `constants' package which defines a large number of
  3152. constants and units, and lets you use unit prefixes like `M' for
  3153. `Mega' etc. You will need version 2.0 of this package, available
  3154. at `http://www.astro.uva.nl/~dominik/Tools'. Org-mode checks for
  3155. the function `constants-get', which has to be autoloaded in your
  3156. setup. See the installation instructions in the file
  3157. `constants.el'.
  3158. `remember.el' by John Wiegley
  3159. Org mode cooperates with remember, see *Note Remember::.
  3160. `Remember.el' is not part of Emacs, find it on the web.
  3161. `table.el' by Takaaki Ota
  3162. Org mode cooperates with table.el, see *Note table.el::.
  3163. `table.el' is part of Emacs 22.
  3164. 
  3165. File: org, Node: Conflicts, Prev: Cooperation, Up: Interaction
  3166. 11.8.3 Packages that lead to conflicts with Org-mode
  3167. ----------------------------------------------------
  3168. `allout.el' by Ken Manheimer
  3169. Startup of Org-mode may fail with the error message
  3170. `(wrong-type-argument keymapp nil)' when there is an outdated
  3171. version `allout.el' on the load path, for example the version
  3172. distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem
  3173. will disappear. If for some reason you cannot do this, make sure
  3174. that org.el is loaded _before_ `allout.el', for example by putting
  3175. `(require 'org)' early enough into your `.emacs' file.
  3176. `CUA.el' by Kim. F. Storm
  3177. Keybindings in Org-mode conflict with the `S-<cursor>' keys used
  3178. by CUA-mode (as well as pc-select-mode and s-region-mode) to
  3179. select and extend the region. If you want to use one of these
  3180. packages along with Org-mode, configure the variable
  3181. `org-CUA-compatible'. When set, Org-mode will move the following
  3182. keybindings in org-mode files, and in the agenda buffer (but not
  3183. during date selection).
  3184. S-UP -> M-p S-DOWN -> M-n
  3185. S-LEFT -> M-- S-RIGHT -> M-+
  3186. S-RET -> C-S-RET
  3187. Yes, these are unfortunately more difficult to remember. If you
  3188. want to have other replacement keys, look at the variable
  3189. `org-disputed-keys'.
  3190. `windmove.el' by Hovav Shacham
  3191. Also this package uses the `S-<cursor>' keys, so everything written
  3192. in the paragraph above about CUA mode also applies here.
  3193. 
  3194. File: org, Node: Bugs, Next: Acknowledgments, Prev: Interaction, Up: Miscellaneous
  3195. 11.9 Bugs
  3196. =========
  3197. Here is a list of things that should work differently, but which I have
  3198. found too hard to fix.
  3199. * If a table field starts with a link, and if the corresponding table
  3200. column is narrowed (*note Narrow columns::) to a width too small to
  3201. display the link, the field would look entirely empty even though
  3202. it is not. To prevent this, Org-mode throws an error. The
  3203. work-around is to make the column wide enough to fit the link, or
  3204. to add some text (at least 2 characters) before the link in the
  3205. same field.
  3206. * Narrowing table columns does not work on XEmacs, because the
  3207. `format' function does not transport text properties.
  3208. * Text in an entry protected with the `QUOTE' keyword should not
  3209. autowrap.
  3210. * When the application called by `C-c C-o' to open a file link fails
  3211. (for example because the application does not exist or refuses to
  3212. open the file), it does so silently. No error message is
  3213. displayed.
  3214. * Plain list items should be able to hold a TODO item.
  3215. Unfortunately this has so many technical problems that I will only
  3216. consider this change for the next major release (5.0).
  3217. * The remote-editing commands in the agenda buffer cannot be undone
  3218. with `undo' called from within the agenda buffer. But you can go
  3219. to the corresponding buffer (using <TAB> or <RET> and execute
  3220. `undo' there.
  3221. * Recalculating a table line applies the formulas from left to right.
  3222. If a formula uses _calculated_ fields further down the row,
  3223. multiple recalculation may be needed to get all fields consistent.
  3224. * Several words in a row may *be made bold*, but this does not work
  3225. if the string is distributed over two lines.
  3226. * The exporters work well, but could be made more efficient.
  3227. 
  3228. File: org, Node: Acknowledgments, Prev: Bugs, Up: Miscellaneous
  3229. 11.10 Acknowledgments
  3230. =====================
  3231. Org-mode was created by Carsten Dominik, who still maintains it at the
  3232. Org-mode homepage `http://www.astro.uva.nl/~dominik/Tools/org/'. The
  3233. following people (in alphabetic order) have helped the development
  3234. along with ideas, suggestions and patches. Many thanks to all of you,
  3235. Org-mode would not be what it is without your input.
  3236. * Thomas Baumann contributed the code for links to the MH-E email
  3237. system.
  3238. * Alex Bochannek provided a patch for rounding time stamps.
  3239. * Charles Cave's suggestion sparked the implementation of templates
  3240. for Remember.
  3241. * Pavel Chalmoviansky influenced the agenda treatment of items with
  3242. specified time.
  3243. * Gregory Chenov patched support for lisp forms into table
  3244. calculations and improved XEmacs compatibility.
  3245. * Sacha Chua suggested to copy some linking code from Planner.
  3246. * Kees Dullemond inspired the use of narrowed tabled columns.
  3247. * Christian Egli converted the documentation into TeXInfo format,
  3248. patched CSS formatting into the HTML exporter, and inspired the
  3249. agenda.
  3250. * Nic Ferrier contributed mailcap and XOXO support.
  3251. * Kai Grossjohann pointed out key-binding conflicts caused by
  3252. Org-mode.
  3253. * Stefan Monnier provided a patch to keep the Emacs-Lisp compiler
  3254. happy.
  3255. * Todd Neal provided patches for links to Info files and elisp forms.
  3256. * Tim O'Callaghan suggested in-file links, search options for general
  3257. file links, and TAGS.
  3258. * Oliver Oppitz suggested multi-state TODO items.
  3259. * Scott Otterson sparked the introduction of descriptive text for
  3260. links, among other things.
  3261. * Pete Phillips helped the development of the TAGS feature.
  3262. * T.V. Raman reported bugs and suggested improvements.
  3263. * Matthias Rempe (Oelde) provided ideas, Windows support, and quality
  3264. control.
  3265. * Kevin Rogers contributed code to access VM files on remote hosts.
  3266. * Frank Ruell solved the mystery of the `keymapp nil' bug, a
  3267. conflict with `allout.el'.
  3268. * Philip Rooke created the Org-mode reference card and provided lots
  3269. of feedback.
  3270. * Christian Schlauer proposed angular brackets around links, among
  3271. other things.
  3272. * Linking to VM/BBDB/GNUS was inspired by Tom Shannon's
  3273. `organizer-mode.el'.
  3274. * David O'Toole wrote `org-publish.el' and drafted the manual
  3275. chapter about publishing.
  3276. * Ju"rgen Vollmer contributed code generating the table of contents
  3277. in HTML output.
  3278. * Chris Wallace provided a patch implementing the `QUOTE' keyword.
  3279. * David Wainberg suggested archiving, and improvements to the linking
  3280. system.
  3281. * John Wiegley wrote `emacs-wiki.el' and `planner.el'. The
  3282. development of Org-mode was fully independent, and both systems are
  3283. really different beasts in their basic ideas and implementation
  3284. details. I later looked at John's code, however, and learned from
  3285. his implementation of (i) links where the link itself is hidden
  3286. and only a description is shown, and (ii) popping up a calendar to
  3287. select a date.
  3288. * Carsten Wimmer suggested some changes and helped fix a bug in
  3289. linking to GNUS.
  3290. * Roland Winkler requested additional keybindings to make Org-mode
  3291. work on a tty.
  3292. * Piotr Zielinski wrote `org-mouse.el' and showed how to follow
  3293. links with mouse-1.
  3294. 
  3295. File: org, Node: Index, Next: Key Index, Prev: Miscellaneous, Up: Top
  3296. 12 Index
  3297. ********
  3298. �[index�]
  3299. * Menu:
  3300. * acknowledgments: Acknowledgments. (line 6)
  3301. * active region <1>: HTML export. (line 10)
  3302. * active region <2>: ASCII export. (line 9)
  3303. * active region <3>: Built-in table editor.
  3304. (line 165)
  3305. * active region: Structure editing. (line 51)
  3306. * agenda: Weekly/Daily agenda. (line 6)
  3307. * agenda commands, custom: Agenda dispatcher. (line 6)
  3308. * agenda dispatcher: Agenda dispatcher. (line 6)
  3309. * agenda files, removing buffers: Agenda commands. (line 205)
  3310. * agenda views: Agenda views. (line 6)
  3311. * agenda, for single file: Timeline. (line 6)
  3312. * allout.el: Conflicts. (line 6)
  3313. * allout.el, conflict with: FAQ. (line 8)
  3314. * angular brackets, around links: External links. (line 38)
  3315. * applescript, for calendar update: iCalendar export. (line 38)
  3316. * archive locations: Archiving. (line 13)
  3317. * archiving: Archiving. (line 6)
  3318. * ASCII export: ASCII export. (line 6)
  3319. * author: Feedback. (line 6)
  3320. * autoload: Installation and activation.
  3321. (line 6)
  3322. * BBDB links: External links. (line 6)
  3323. * bold text: Enhancing text. (line 15)
  3324. * bug reports: Feedback. (line 6)
  3325. * bugs: Bugs. (line 6)
  3326. * calc package: Table calculations. (line 6)
  3327. * calc.el: Cooperation. (line 6)
  3328. * calculations, in tables <1>: Table calculations. (line 6)
  3329. * calculations, in tables: Built-in table editor.
  3330. (line 135)
  3331. * calendar integration: Calendar/Diary integration.
  3332. (line 6)
  3333. * calendar, for selecting date: Creating timestamps. (line 71)
  3334. * CamelCase link completion: Completion. (line 6)
  3335. * CamelCase links: Internal links. (line 6)
  3336. * CamelCase links, completion of: CamelCase links. (line 6)
  3337. * category: Categories. (line 6)
  3338. * checkboxes: Plain lists. (line 36)
  3339. * children, subtree visibility state: Visibility cycling. (line 10)
  3340. * clean outline view: Clean view. (line 6)
  3341. * CLOCK keyword: Time stamps. (line 61)
  3342. * CLOSED keyword: Time stamps. (line 55)
  3343. * column formula: Column formulas. (line 6)
  3344. * commands, in agenda buffer: Agenda commands. (line 6)
  3345. * comment lines: Comment lines. (line 6)
  3346. * completion, of CamelCase links <1>: Completion. (line 6)
  3347. * completion, of CamelCase links: CamelCase links. (line 6)
  3348. * completion, of dictionary words: Completion. (line 6)
  3349. * completion, of file names: Handling links. (line 44)
  3350. * completion, of links: Handling links. (line 28)
  3351. * completion, of option keywords <1>: Completion. (line 6)
  3352. * completion, of option keywords: Export options. (line 6)
  3353. * Completion, of option keywords: Per file keywords. (line 17)
  3354. * completion, of tags <1>: Completion. (line 6)
  3355. * completion, of tags: Setting tags. (line 11)
  3356. * completion, of TeX symbols <1>: Completion. (line 6)
  3357. * completion, of TeX symbols: Enhancing text. (line 19)
  3358. * completion, of TODO keywords <1>: Completion. (line 6)
  3359. * completion, of TODO keywords: Workflow states. (line 12)
  3360. * constants, in calculations: Formula syntax. (line 26)
  3361. * constants.el: Cooperation. (line 14)
  3362. * contents, global visibility state: Visibility cycling. (line 22)
  3363. * copying, of subtrees: Structure editing. (line 6)
  3364. * creating timestamps: Creating timestamps. (line 6)
  3365. * CUA.el: Conflicts. (line 15)
  3366. * custom agenda commands: Agenda dispatcher. (line 6)
  3367. * custom search strings: Custom searches. (line 6)
  3368. * customization: Customization. (line 6)
  3369. * cutting, of subtrees: Structure editing. (line 6)
  3370. * cycling, of TODO states: TODO basics. (line 13)
  3371. * cycling, visibility: Visibility cycling. (line 6)
  3372. * dangerous commands: FAQ. (line 70)
  3373. * date stamps: Time stamps. (line 6)
  3374. * date, reading in minibuffer: Creating timestamps. (line 71)
  3375. * DEADLINE keyword: Time stamps. (line 43)
  3376. * deadlines: Time stamps. (line 6)
  3377. * demotion, of subtrees: Structure editing. (line 6)
  3378. * diary entries, creating from agenda: Agenda commands. (line 173)
  3379. * diary integration: Calendar/Diary integration.
  3380. (line 6)
  3381. * dictionary word completion: Completion. (line 6)
  3382. * dispatching agenda commands: Agenda dispatcher. (line 6)
  3383. * document structure: Document structure. (line 6)
  3384. * DONE, final TODO keyword: Per file keywords. (line 20)
  3385. * editing tables: Tables. (line 6)
  3386. * editing, of table formulas: Editing/debugging formulas.
  3387. (line 6)
  3388. * elisp links: External links. (line 6)
  3389. * emphasized text: Export options. (line 25)
  3390. * enhancing text: Enhancing text. (line 6)
  3391. * evaluate time range: Creating timestamps. (line 66)
  3392. * exporting: Exporting. (line 6)
  3393. * exporting a subtree: FAQ. (line 112)
  3394. * exporting, not: Comment lines. (line 6)
  3395. * extended TODO keywords: TODO extensions. (line 6)
  3396. * external links: External links. (line 6)
  3397. * external links, in HTML export: HTML export. (line 35)
  3398. * FAQ: FAQ. (line 6)
  3399. * feedback: Feedback. (line 6)
  3400. * file links: External links. (line 6)
  3401. * file links, searching: Search options. (line 6)
  3402. * file name completion: Handling links. (line 44)
  3403. * files, adding to agenda list: Agenda files. (line 12)
  3404. * filing subtrees: Archiving. (line 6)
  3405. * fixed width: Enhancing text. (line 30)
  3406. * fixed-width sections: Export options. (line 25)
  3407. * folded, subtree visibility state: Visibility cycling. (line 10)
  3408. * folding, sparse trees: Sparse trees. (line 6)
  3409. * following links: Handling links. (line 59)
  3410. * format specifier: Formula syntax. (line 34)
  3411. * format, of links: Link format. (line 6)
  3412. * formula editing: Editing/debugging formulas.
  3413. (line 6)
  3414. * formula syntax: Formula syntax. (line 6)
  3415. * formula, for named table field: Named-field formulas.
  3416. (line 6)
  3417. * formula, for table column: Column formulas. (line 6)
  3418. * formula, in tables: Built-in table editor.
  3419. (line 135)
  3420. * global cycling: Visibility cycling. (line 22)
  3421. * global keybindings: Installation and activation.
  3422. (line 6)
  3423. * global TODO list: Global TODO list. (line 6)
  3424. * global visibility states: Visibility cycling. (line 22)
  3425. * GNUS links: External links. (line 6)
  3426. * hand-formatted lists: Enhancing text. (line 11)
  3427. * headline levels: Export options. (line 25)
  3428. * headline levels, for exporting <1>: HTML export. (line 21)
  3429. * headline levels, for exporting: ASCII export. (line 18)
  3430. * headline navigation: Motion. (line 6)
  3431. * headline tagging: Tags. (line 6)
  3432. * headline, promotion and demotion: Structure editing. (line 6)
  3433. * headlines: Headlines. (line 6)
  3434. * hide text: Visibility cycling. (line 6)
  3435. * hiding leading stars: Clean view. (line 6)
  3436. * HTML export: HTML export. (line 6)
  3437. * hyperlinks: Hyperlinks. (line 6)
  3438. * iCalendar export: iCalendar export. (line 6)
  3439. * in-buffer settings: Summary of in-buffer settings.
  3440. (line 6)
  3441. * indentation, of tables: FAQ. (line 136)
  3442. * indirect buffers: FAQ. (line 88)
  3443. * Info links: External links. (line 6)
  3444. * inheritance, of tags: Tag inheritance. (line 6)
  3445. * inserting links: Handling links. (line 28)
  3446. * installation: Installation and activation.
  3447. (line 6)
  3448. * internal links: Internal links. (line 6)
  3449. * internal links, in HTML export: HTML export. (line 35)
  3450. * introduction: Introduction. (line 6)
  3451. * italic text: Enhancing text. (line 15)
  3452. * jumping, to headlines: Motion. (line 6)
  3453. * keybindings, global: Installation and activation.
  3454. (line 6)
  3455. * keymapp nil error: FAQ. (line 6)
  3456. * keyword options: Per file keywords. (line 6)
  3457. * linebreak preservation: Export options. (line 25)
  3458. * linebreak, forced: Enhancing text. (line 37)
  3459. * link completion: Handling links. (line 28)
  3460. * link format: Link format. (line 6)
  3461. * links, external: External links. (line 6)
  3462. * links, in HTML export: HTML export. (line 35)
  3463. * links, internal: Internal links. (line 6)
  3464. * links, returning to: Handling links. (line 85)
  3465. * Lisp forms, as table formulas: Lisp formulas. (line 6)
  3466. * lists, hand-formatted: Enhancing text. (line 11)
  3467. * lists, ordered: Plain lists. (line 6)
  3468. * lists, plain: Plain lists. (line 6)
  3469. * logging, of progress: Progress logging. (line 6)
  3470. * maintainer: Feedback. (line 6)
  3471. * make-indirect-buffer: FAQ. (line 88)
  3472. * mark ring: Handling links. (line 81)
  3473. * marking characters, tables: Advanced features. (line 34)
  3474. * matching, of tags: Matching headline tags.
  3475. (line 6)
  3476. * matching, tags: Tags. (line 6)
  3477. * MH-E links: External links. (line 6)
  3478. * minor mode for tables: orgtbl-mode. (line 6)
  3479. * mode, for calc: Formula syntax. (line 34)
  3480. * motion, between headlines: Motion. (line 6)
  3481. * name, of column or field: Formula syntax. (line 26)
  3482. * named field formula: Named-field formulas.
  3483. (line 6)
  3484. * names as TODO keywords: TODO types. (line 6)
  3485. * narrow columns in tables: Narrow columns. (line 6)
  3486. * occur, command: Sparse trees. (line 6)
  3487. * option keyword completion: Completion. (line 6)
  3488. * options, for customization: Customization. (line 6)
  3489. * options, for export: Export options. (line 6)
  3490. * ordered lists: Plain lists. (line 6)
  3491. * org-agenda, command: Weekly/Daily agenda. (line 9)
  3492. * org-mode, turning on: Installation and activation.
  3493. (line 30)
  3494. * org-mouse.el: Extensions. (line 8)
  3495. * org-publish.el: Extensions. (line 14)
  3496. * orgtbl-mode: orgtbl-mode. (line 6)
  3497. * outline tree: Headlines. (line 6)
  3498. * outline-mode: Outlines. (line 6)
  3499. * outlines: Outlines. (line 6)
  3500. * overview, global visibility state: Visibility cycling. (line 22)
  3501. * packages, interaction with other: Interaction. (line 6)
  3502. * pasting, of subtrees: Structure editing. (line 6)
  3503. * per file keywords: Per file keywords. (line 6)
  3504. * plain lists: Plain lists. (line 6)
  3505. * plain text external links: External links. (line 38)
  3506. * printing sparse trees: Sparse trees. (line 39)
  3507. * priorities: Priorities. (line 6)
  3508. * priorities, of agenda items: Sorting of agenda items.
  3509. (line 6)
  3510. * progress logging: Progress logging. (line 6)
  3511. * promotion, of subtrees: Structure editing. (line 6)
  3512. * quoted HTML tags: Export options. (line 25)
  3513. * ranges, time: Time stamps. (line 6)
  3514. * recomputing table fields: Column formulas. (line 27)
  3515. * region, active <1>: HTML export. (line 10)
  3516. * region, active <2>: ASCII export. (line 9)
  3517. * region, active <3>: Built-in table editor.
  3518. (line 165)
  3519. * region, active: Structure editing. (line 51)
  3520. * remember.el <1>: Cooperation. (line 29)
  3521. * remember.el: Remember. (line 6)
  3522. * richer text: Enhancing text. (line 6)
  3523. * RMAIL links: External links. (line 6)
  3524. * SCHEDULED keyword: Time stamps. (line 30)
  3525. * scheduling: Time stamps. (line 6)
  3526. * search option in file links: Search options. (line 6)
  3527. * section-numbers: Export options. (line 25)
  3528. * setting tags: Setting tags. (line 6)
  3529. * SHELL links: External links. (line 6)
  3530. * shell links, confirmation: FAQ. (line 70)
  3531. * show all, command: Visibility cycling. (line 31)
  3532. * show all, global visibility state: Visibility cycling. (line 22)
  3533. * show hidden text: Visibility cycling. (line 6)
  3534. * single file summary: Timeline. (line 6)
  3535. * sorting, of agenda items: Sorting of agenda items.
  3536. (line 6)
  3537. * sparse tree, for deadlines: Creating timestamps. (line 41)
  3538. * sparse tree, for TODO: TODO basics. (line 26)
  3539. * sparse tree, tag based: Tags. (line 6)
  3540. * sparse trees: Sparse trees. (line 6)
  3541. * special keywords: Summary of in-buffer settings.
  3542. (line 6)
  3543. * spreadsheet capabilities: Table calculations. (line 6)
  3544. * storing links: Handling links. (line 9)
  3545. * structure editing: Structure editing. (line 6)
  3546. * structure of document: Document structure. (line 6)
  3547. * subtree cycling: Visibility cycling. (line 10)
  3548. * subtree visibility states: Visibility cycling. (line 10)
  3549. * subtree, cut and paste: Structure editing. (line 6)
  3550. * subtree, subtree visibility state: Visibility cycling. (line 10)
  3551. * subtrees, cut and paste: Structure editing. (line 6)
  3552. * summary: Summary. (line 6)
  3553. * syntax, of formulas: Formula syntax. (line 6)
  3554. * table editor, builtin: Built-in table editor.
  3555. (line 6)
  3556. * table editor, table.el: table.el. (line 6)
  3557. * table of contents: Export options. (line 25)
  3558. * table.el <1>: Cooperation. (line 30)
  3559. * table.el: table.el. (line 6)
  3560. * tables <1>: Export options. (line 25)
  3561. * tables: Tables. (line 6)
  3562. * tables, export: Enhancing text. (line 26)
  3563. * tag completion: Completion. (line 6)
  3564. * tag searches: Tag searches. (line 6)
  3565. * tags: Tags. (line 6)
  3566. * tags view: Matching headline tags.
  3567. (line 6)
  3568. * templates, for remember: Remember. (line 23)
  3569. * TeX interpretation: Enhancing text. (line 17)
  3570. * TeX macros: Export options. (line 25)
  3571. * TeX symbol completion: Completion. (line 6)
  3572. * TeX-like syntax for sub- and superscripts: Export options. (line 25)
  3573. * thanks: Acknowledgments. (line 6)
  3574. * time stamps: Time stamps. (line 6)
  3575. * time, reading in minibuffer: Creating timestamps. (line 71)
  3576. * time-sorted view: Timeline. (line 6)
  3577. * timeline, single file: Timeline. (line 6)
  3578. * timerange: Time stamps. (line 21)
  3579. * timestamp: Time stamps. (line 13)
  3580. * timestamps, creating: Creating timestamps. (line 6)
  3581. * TODO items: TODO items. (line 6)
  3582. * TODO keywords completion: Completion. (line 6)
  3583. * TODO list, global: Global TODO list. (line 6)
  3584. * TODO types: TODO types. (line 6)
  3585. * TODO workflow: Workflow states. (line 6)
  3586. * transient-mark-mode <1>: HTML export. (line 10)
  3587. * transient-mark-mode <2>: ASCII export. (line 9)
  3588. * transient-mark-mode <3>: Built-in table editor.
  3589. (line 165)
  3590. * transient-mark-mode: Structure editing. (line 51)
  3591. * trees, sparse: Sparse trees. (line 6)
  3592. * trees, visibility: Visibility cycling. (line 6)
  3593. * tty keybindings: TTY keys. (line 6)
  3594. * types as TODO keywords: TODO types. (line 6)
  3595. * underlined text: Enhancing text. (line 15)
  3596. * URL links: External links. (line 6)
  3597. * USENET links: External links. (line 6)
  3598. * variables, for customization: Customization. (line 6)
  3599. * vectors, in table calculations: Formula syntax. (line 23)
  3600. * visibility cycling: Visibility cycling. (line 6)
  3601. * visible text, printing: Sparse trees. (line 39)
  3602. * VM links: External links. (line 6)
  3603. * WANDERLUST links: External links. (line 6)
  3604. * windmove.el: Conflicts. (line 33)
  3605. * workflow states as TODO keywords: Workflow states. (line 6)
  3606. * XOXO export: XOXO export. (line 6)
  3607. 
  3608. File: org, Node: Key Index, Prev: Index, Up: Top
  3609. 13 Key Index
  3610. ************
  3611. �[index�]
  3612. * Menu:
  3613. * +: Agenda commands. (line 120)
  3614. * ,: Agenda commands. (line 112)
  3615. * -: Agenda commands. (line 126)
  3616. * .: Agenda commands. (line 91)
  3617. * :: Agenda commands. (line 109)
  3618. * <: Creating timestamps. (line 78)
  3619. * <left>: Agenda commands. (line 88)
  3620. * <RET> <1>: Agenda commands. (line 41)
  3621. * <RET> <2>: Creating timestamps. (line 103)
  3622. * <RET>: Built-in table editor.
  3623. (line 64)
  3624. * <right>: Agenda commands. (line 83)
  3625. * <SPC>: Agenda commands. (line 28)
  3626. * <TAB> <1>: Agenda commands. (line 35)
  3627. * <TAB> <2>: Built-in table editor.
  3628. (line 57)
  3629. * <TAB> <3>: Plain lists. (line 48)
  3630. * <TAB>: Visibility cycling. (line 10)
  3631. * > <1>: Agenda commands. (line 148)
  3632. * >: Creating timestamps. (line 79)
  3633. * C: Agenda commands. (line 188)
  3634. * c: Agenda commands. (line 166)
  3635. * C-#: Built-in table editor.
  3636. (line 155)
  3637. * C-,: Agenda files. (line 18)
  3638. * C-c !: Creating timestamps. (line 21)
  3639. * C-c $: Archiving. (line 9)
  3640. * C-c %: Handling links. (line 81)
  3641. * C-c &: Handling links. (line 85)
  3642. * C-c ' <1>: Editing/debugging formulas.
  3643. (line 20)
  3644. * C-c ': Built-in table editor.
  3645. (line 144)
  3646. * C-c *: Built-in table editor.
  3647. (line 148)
  3648. * C-c +: Built-in table editor.
  3649. (line 165)
  3650. * C-c ,: Priorities. (line 18)
  3651. * C-c -: Built-in table editor.
  3652. (line 92)
  3653. * C-c .: Creating timestamps. (line 10)
  3654. * C-c /: Sparse trees. (line 15)
  3655. * C-c :: Enhancing text. (line 34)
  3656. * C-c ;: Comment lines. (line 11)
  3657. * C-c <: Creating timestamps. (line 25)
  3658. * C-c <TAB>: Built-in table editor.
  3659. (line 187)
  3660. * C-c =: Built-in table editor.
  3661. (line 135)
  3662. * C-c >: Creating timestamps. (line 29)
  3663. * C-c ? <1>: Editing/debugging formulas.
  3664. (line 20)
  3665. * C-c ?: Built-in table editor.
  3666. (line 161)
  3667. * C-c [: Agenda files. (line 12)
  3668. * C-c \: Tag searches. (line 9)
  3669. * C-c ]: Agenda files. (line 15)
  3670. * C-c ^: Built-in table editor.
  3671. (line 96)
  3672. * C-c `: Built-in table editor.
  3673. (line 181)
  3674. * C-c a a: Weekly/Daily agenda. (line 9)
  3675. * C-c a C: Agenda dispatcher. (line 30)
  3676. * C-c a M: Matching headline tags.
  3677. (line 15)
  3678. * C-c a m: Matching headline tags.
  3679. (line 10)
  3680. * C-c a M: Tag searches. (line 14)
  3681. * C-c a m: Tag searches. (line 10)
  3682. * C-c a T: Global TODO list. (line 14)
  3683. * C-c a t <1>: Global TODO list. (line 9)
  3684. * C-c a t: TODO basics. (line 33)
  3685. * C-c C-a: Visibility cycling. (line 31)
  3686. * C-c C-b: Motion. (line 15)
  3687. * C-c C-c <1>: The very busy C-c C-c key.
  3688. (line 6)
  3689. * C-c C-c <2>: Setting tags. (line 10)
  3690. * C-c C-c <3>: table.el. (line 6)
  3691. * C-c C-c <4>: Editing/debugging formulas.
  3692. (line 16)
  3693. * C-c C-c <5>: Built-in table editor.
  3694. (line 54)
  3695. * C-c C-c: Plain lists. (line 85)
  3696. * C-c C-d <1>: Agenda commands. (line 133)
  3697. * C-c C-d: Creating timestamps. (line 37)
  3698. * C-c C-f: Motion. (line 12)
  3699. * C-c C-j: Motion. (line 21)
  3700. * C-c C-l: Handling links. (line 28)
  3701. * C-c C-n: Motion. (line 8)
  3702. * C-c C-o <1>: Creating timestamps. (line 33)
  3703. * C-c C-o: Handling links. (line 59)
  3704. * C-c C-p: Motion. (line 9)
  3705. * C-c C-q <1>: Editing/debugging formulas.
  3706. (line 20)
  3707. * C-c C-q: Built-in table editor.
  3708. (line 119)
  3709. * C-c C-r: Timeline. (line 13)
  3710. * C-c C-s <1>: Agenda commands. (line 130)
  3711. * C-c C-s: Creating timestamps. (line 48)
  3712. * C-c C-t <1>: Clocking work time. (line 20)
  3713. * C-c C-t: TODO basics. (line 13)
  3714. * C-c C-u: Motion. (line 18)
  3715. * C-c C-v: TODO basics. (line 26)
  3716. * C-c C-w: Creating timestamps. (line 41)
  3717. * C-c C-x a: ASCII export. (line 9)
  3718. * C-c C-x b: HTML export. (line 11)
  3719. * C-c C-x c: iCalendar export. (line 20)
  3720. * C-c C-x C-c: Agenda commands. (line 195)
  3721. * C-c C-x C-d: Clocking work time. (line 28)
  3722. * C-c C-x C-i <1>: iCalendar export. (line 15)
  3723. * C-c C-x C-i: Clocking work time. (line 12)
  3724. * C-c C-x C-k: Structure editing. (line 36)
  3725. * C-c C-x C-o: Clocking work time. (line 14)
  3726. * C-c C-x C-w <1>: Built-in table editor.
  3727. (line 108)
  3728. * C-c C-x C-w: Structure editing. (line 36)
  3729. * C-c C-x C-x <1>: XOXO export. (line 10)
  3730. * C-c C-x C-x: Clocking work time. (line 24)
  3731. * C-c C-x C-y <1>: Built-in table editor.
  3732. (line 112)
  3733. * C-c C-x C-y: Structure editing. (line 43)
  3734. * C-c C-x h: HTML export. (line 10)
  3735. * C-c C-x i: iCalendar export. (line 13)
  3736. * C-c C-x M-w <1>: Built-in table editor.
  3737. (line 105)
  3738. * C-c C-x M-w: Structure editing. (line 40)
  3739. * C-c C-x t: Export options. (line 13)
  3740. * C-c C-x v <1>: XOXO export. (line 11)
  3741. * C-c C-x v: Sparse trees. (line 39)
  3742. * C-c C-x v a: ASCII export. (line 13)
  3743. * C-c C-x v b: HTML export. (line 14)
  3744. * C-c C-x v h: HTML export. (line 14)
  3745. * C-c C-y: Creating timestamps. (line 66)
  3746. * C-c l: Handling links. (line 9)
  3747. * C-c |: Built-in table editor.
  3748. (line 40)
  3749. * C-c ~: table.el. (line 18)
  3750. * C-u C-c .: Creating timestamps. (line 16)
  3751. * C-u C-c =: Built-in table editor.
  3752. (line 139)
  3753. * C-u C-c C-l: Handling links. (line 44)
  3754. * D: Agenda commands. (line 68)
  3755. * d: Agenda commands. (line 65)
  3756. * f: Agenda commands. (line 44)
  3757. * g: Agenda commands. (line 72)
  3758. * H: Agenda commands. (line 192)
  3759. * i: Agenda commands. (line 173)
  3760. * I: Agenda commands. (line 153)
  3761. * l: Agenda commands. (line 51)
  3762. * L: Agenda commands. (line 32)
  3763. * M: Agenda commands. (line 179)
  3764. * M-<down>: Built-in table editor.
  3765. (line 82)
  3766. * M-<left> <1>: Built-in table editor.
  3767. (line 72)
  3768. * M-<left>: Structure editing. (line 18)
  3769. * M-<RET> <1>: Plain lists. (line 53)
  3770. * M-<RET>: Structure editing. (line 6)
  3771. * M-<right> <1>: Built-in table editor.
  3772. (line 72)
  3773. * M-<right>: Structure editing. (line 21)
  3774. * M-<TAB> <1>: Completion. (line 10)
  3775. * M-<TAB> <2>: Setting tags. (line 6)
  3776. * M-<TAB>: Per file keywords. (line 17)
  3777. * M-<up>: Built-in table editor.
  3778. (line 82)
  3779. * M-S-<down> <1>: Built-in table editor.
  3780. (line 89)
  3781. * M-S-<down> <2>: Plain lists. (line 70)
  3782. * M-S-<down>: Structure editing. (line 33)
  3783. * M-S-<left> <1>: Creating timestamps. (line 100)
  3784. * M-S-<left> <2>: Built-in table editor.
  3785. (line 76)
  3786. * M-S-<left> <3>: Plain lists. (line 76)
  3787. * M-S-<left>: Structure editing. (line 24)
  3788. * M-S-<RET> <1>: Plain lists. (line 63)
  3789. * M-S-<RET>: Structure editing. (line 15)
  3790. * M-S-<right> <1>: Creating timestamps. (line 97)
  3791. * M-S-<right> <2>: Built-in table editor.
  3792. (line 79)
  3793. * M-S-<right> <3>: Plain lists. (line 76)
  3794. * M-S-<right>: Structure editing. (line 27)
  3795. * M-S-<up> <1>: Built-in table editor.
  3796. (line 86)
  3797. * M-S-<up> <2>: Plain lists. (line 70)
  3798. * M-S-<up>: Structure editing. (line 30)
  3799. * mouse-1 <1>: Agenda commands. (line 35)
  3800. * mouse-1 <2>: Creating timestamps. (line 82)
  3801. * mouse-1: Handling links. (line 73)
  3802. * mouse-2 <1>: Agenda commands. (line 35)
  3803. * mouse-2: Handling links. (line 73)
  3804. * mouse-3 <1>: Agenda commands. (line 28)
  3805. * mouse-3: Handling links. (line 78)
  3806. * n: Agenda commands. (line 19)
  3807. * O: Agenda commands. (line 155)
  3808. * o: Agenda commands. (line 59)
  3809. * P: Agenda commands. (line 117)
  3810. * p: Agenda commands. (line 20)
  3811. * q: Agenda commands. (line 202)
  3812. * r <1>: Agenda commands. (line 76)
  3813. * r: Global TODO list. (line 20)
  3814. * S: Agenda commands. (line 183)
  3815. * S-<down> <1>: Agenda commands. (line 126)
  3816. * S-<down> <2>: Creating timestamps. (line 58)
  3817. * S-<down> <3>: Priorities. (line 25)
  3818. * S-<down>: Plain lists. (line 66)
  3819. * S-<left> <1>: Agenda commands. (line 144)
  3820. * S-<left> <2>: Creating timestamps. (line 53)
  3821. * S-<left>: TODO basics. (line 20)
  3822. * S-<RET>: Built-in table editor.
  3823. (line 170)
  3824. * S-<right> <1>: Agenda commands. (line 136)
  3825. * S-<right> <2>: Creating timestamps. (line 53)
  3826. * S-<right>: TODO basics. (line 20)
  3827. * S-<TAB> <1>: Built-in table editor.
  3828. (line 61)
  3829. * S-<TAB>: Visibility cycling. (line 22)
  3830. * S-<up> <1>: Agenda commands. (line 120)
  3831. * S-<up> <2>: Creating timestamps. (line 58)
  3832. * S-<up> <3>: Priorities. (line 25)
  3833. * S-<up>: Plain lists. (line 66)
  3834. * T: Agenda commands. (line 104)
  3835. * t: Agenda commands. (line 100)
  3836. * w: Agenda commands. (line 62)
  3837. * x: Agenda commands. (line 205)
  3838. * X: Agenda commands. (line 158)
  3839. 
  3840. Tag Table:
  3841. Node: Top959
  3842. Node: Introduction8845
  3843. Node: Summary9159
  3844. Node: Installation and activation11415
  3845. Node: Feedback13073
  3846. Node: Document structure13859
  3847. Node: Outlines14625
  3848. Node: Headlines15285
  3849. Node: Visibility cycling15908
  3850. Ref: Visibility cycling-Footnote-117383
  3851. Ref: Visibility cycling-Footnote-217441
  3852. Node: Motion17491
  3853. Node: Structure editing18275
  3854. Node: Archiving20384
  3855. Node: Sparse trees21244
  3856. Ref: Sparse trees-Footnote-123223
  3857. Ref: Sparse trees-Footnote-223315
  3858. Node: Plain lists23430
  3859. Ref: Plain lists-Footnote-127328
  3860. Node: Tables27685
  3861. Node: Built-in table editor28233
  3862. Node: Narrow columns35840
  3863. Ref: Narrow columns-Footnote-137779
  3864. Node: Table calculations37825
  3865. Node: Formula syntax39145
  3866. Ref: Formula syntax-Footnote-142050
  3867. Node: Lisp formulas42350
  3868. Node: Column formulas43139
  3869. Node: Advanced features44901
  3870. Node: Named-field formulas48155
  3871. Node: Editing/debugging formulas48795
  3872. Node: Appetizer50553
  3873. Node: orgtbl-mode51656
  3874. Node: table.el52147
  3875. Node: Hyperlinks53124
  3876. Node: Link format53829
  3877. Node: Internal links55122
  3878. Ref: Internal links-Footnote-157111
  3879. Node: Radio targets57243
  3880. Node: CamelCase links57958
  3881. Node: External links58456
  3882. Node: Handling links60587
  3883. Node: Search options65137
  3884. Ref: Search options-Footnote-166911
  3885. Node: Custom searches66992
  3886. Node: Remember68040
  3887. Node: TODO items71730
  3888. Node: TODO basics72594
  3889. Node: TODO extensions74121
  3890. Node: Workflow states74916
  3891. Node: TODO types75784
  3892. Ref: TODO types-Footnote-177442
  3893. Node: Per file keywords77524
  3894. Ref: Per file keywords-Footnote-178978
  3895. Node: Priorities79206
  3896. Node: Timestamps80422
  3897. Node: Time stamps80812
  3898. Node: Creating timestamps83910
  3899. Node: Progress logging87256
  3900. Node: Closing items87786
  3901. Node: Clocking work time88581
  3902. Node: Tags90266
  3903. Node: Tag inheritance91028
  3904. Node: Setting tags91965
  3905. Ref: Setting tags-Footnote-195095
  3906. Ref: Setting tags-Footnote-295207
  3907. Node: Tag searches95287
  3908. Node: Agenda views96496
  3909. Node: Agenda files98035
  3910. Ref: Agenda files-Footnote-198995
  3911. Ref: Agenda files-Footnote-299144
  3912. Node: Agenda dispatcher99336
  3913. Node: Weekly/Daily agenda101466
  3914. Node: Categories102601
  3915. Node: Time-of-day specifications103249
  3916. Node: Calendar/Diary integration105225
  3917. Node: Sorting of agenda items106602
  3918. Node: Global TODO list107434
  3919. Node: Matching headline tags108795
  3920. Node: Timeline109738
  3921. Node: Agenda commands110611
  3922. Node: Exporting116330
  3923. Node: ASCII export117463
  3924. Node: HTML export118749
  3925. Node: XOXO export121583
  3926. Node: iCalendar export122022
  3927. Node: Text interpretation123845
  3928. Node: Comment lines124322
  3929. Node: Enhancing text124791
  3930. Node: Export options126715
  3931. Node: Publishing128317
  3932. Ref: Publishing-Footnote-1129113
  3933. Node: Configuration129309
  3934. Node: Project alist130030
  3935. Node: File sources and destinations131101
  3936. Node: Selecting files131653
  3937. Node: Publishing action132406
  3938. Node: Publishing options133521
  3939. Node: Publishing links135560
  3940. Node: Project page index136363
  3941. Node: Sample configuration137141
  3942. Node: Simple example137633
  3943. Node: Complex example138306
  3944. Node: Triggering publication140382
  3945. Node: Miscellaneous141038
  3946. Node: Completion141797
  3947. Node: Customization142793
  3948. Node: Summary of in-buffer settings143400
  3949. Node: The very busy C-c C-c key146642
  3950. Node: Clean view148157
  3951. Node: TTY keys150734
  3952. Node: FAQ152335
  3953. Node: Interaction160133
  3954. Node: Extensions160593
  3955. Node: Cooperation161845
  3956. Node: Conflicts163539
  3957. Node: Bugs165131
  3958. Node: Acknowledgments167029
  3959. Node: Index170467
  3960. Node: Key Index192859
  3961. 
  3962. End Tag Table