org.texi 721 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841
  1. \input texinfo
  2. @c %**start of header
  3. @setfilename ../../info/org
  4. @settitle The Org Manual
  5. @include org-version.inc
  6. @c Use proper quote and backtick for code sections in PDF output
  7. @c Cf. Texinfo manual 14.2
  8. @set txicodequoteundirected
  9. @set txicodequotebacktick
  10. @c Version and Contact Info
  11. @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page}
  12. @set AUTHOR Carsten Dominik
  13. @set MAINTAINER Bastien Guerry
  14. @set MAINTAINEREMAIL @email{bzg at gnu dot org}
  15. @set MAINTAINERCONTACT @uref{mailto:bzg at gnu dot org,contact the maintainer}
  16. @c %**end of header
  17. @finalout
  18. @c -----------------------------------------------------------------------------
  19. @c Macro definitions for commands and keys
  20. @c =======================================
  21. @c The behavior of the key/command macros will depend on the flag cmdnames
  22. @c When set, commands names are shown. When clear, they are not shown.
  23. @set cmdnames
  24. @c Below we define the following macros for Org key tables:
  25. @c orgkey{key} A key item
  26. @c orgcmd{key,cmd} Key with command name
  27. @c xorgcmd{key,cmd} Key with command name as @itemx
  28. @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
  29. @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
  30. @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
  31. @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
  32. @c different functions, so format as @itemx
  33. @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
  34. @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
  35. @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
  36. @c a key but no command
  37. @c Inserts: @item key
  38. @macro orgkey{key}
  39. @kindex \key\
  40. @item @kbd{\key\}
  41. @end macro
  42. @macro xorgkey{key}
  43. @kindex \key\
  44. @itemx @kbd{\key\}
  45. @end macro
  46. @c one key with a command
  47. @c Inserts: @item KEY COMMAND
  48. @macro orgcmd{key,command}
  49. @ifset cmdnames
  50. @kindex \key\
  51. @findex \command\
  52. @iftex
  53. @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
  54. @end iftex
  55. @ifnottex
  56. @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  57. @end ifnottex
  58. @end ifset
  59. @ifclear cmdnames
  60. @kindex \key\
  61. @item @kbd{\key\}
  62. @end ifclear
  63. @end macro
  64. @c One key with one command, formatted using @itemx
  65. @c Inserts: @itemx KEY COMMAND
  66. @macro xorgcmd{key,command}
  67. @ifset cmdnames
  68. @kindex \key\
  69. @findex \command\
  70. @iftex
  71. @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
  72. @end iftex
  73. @ifnottex
  74. @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  75. @end ifnottex
  76. @end ifset
  77. @ifclear cmdnames
  78. @kindex \key\
  79. @itemx @kbd{\key\}
  80. @end ifclear
  81. @end macro
  82. @c one key with a command, bit do not index the key
  83. @c Inserts: @item KEY COMMAND
  84. @macro orgcmdnki{key,command}
  85. @ifset cmdnames
  86. @findex \command\
  87. @iftex
  88. @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
  89. @end iftex
  90. @ifnottex
  91. @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  92. @end ifnottex
  93. @end ifset
  94. @ifclear cmdnames
  95. @item @kbd{\key\}
  96. @end ifclear
  97. @end macro
  98. @c one key with a command, and special text to replace key in item
  99. @c Inserts: @item TEXT COMMAND
  100. @macro orgcmdtkc{text,key,command}
  101. @ifset cmdnames
  102. @kindex \key\
  103. @findex \command\
  104. @iftex
  105. @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
  106. @end iftex
  107. @ifnottex
  108. @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  109. @end ifnottex
  110. @end ifset
  111. @ifclear cmdnames
  112. @kindex \key\
  113. @item @kbd{\text\}
  114. @end ifclear
  115. @end macro
  116. @c two keys with one command
  117. @c Inserts: @item KEY1 or KEY2 COMMAND
  118. @macro orgcmdkkc{key1,key2,command}
  119. @ifset cmdnames
  120. @kindex \key1\
  121. @kindex \key2\
  122. @findex \command\
  123. @iftex
  124. @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  125. @end iftex
  126. @ifnottex
  127. @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  128. @end ifnottex
  129. @end ifset
  130. @ifclear cmdnames
  131. @kindex \key1\
  132. @kindex \key2\
  133. @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
  134. @end ifclear
  135. @end macro
  136. @c Two keys with one command name, but different functions, so format as
  137. @c @itemx
  138. @c Inserts: @item KEY1
  139. @c @itemx KEY2 COMMAND
  140. @macro orgcmdkxkc{key1,key2,command}
  141. @ifset cmdnames
  142. @kindex \key1\
  143. @kindex \key2\
  144. @findex \command\
  145. @iftex
  146. @item @kbd{\key1\}
  147. @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  148. @end iftex
  149. @ifnottex
  150. @item @kbd{\key1\}
  151. @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  152. @end ifnottex
  153. @end ifset
  154. @ifclear cmdnames
  155. @kindex \key1\
  156. @kindex \key2\
  157. @item @kbd{\key1\}
  158. @itemx @kbd{\key2\}
  159. @end ifclear
  160. @end macro
  161. @c Same as previous, but use "or short"
  162. @c Inserts: @item KEY1 or short KEY2 COMMAND
  163. @macro orgcmdkskc{key1,key2,command}
  164. @ifset cmdnames
  165. @kindex \key1\
  166. @kindex \key2\
  167. @findex \command\
  168. @iftex
  169. @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  170. @end iftex
  171. @ifnottex
  172. @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  173. @end ifnottex
  174. @end ifset
  175. @ifclear cmdnames
  176. @kindex \key1\
  177. @kindex \key2\
  178. @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
  179. @end ifclear
  180. @end macro
  181. @c Same as previous, but use @itemx
  182. @c Inserts: @itemx KEY1 or short KEY2 COMMAND
  183. @macro xorgcmdkskc{key1,key2,command}
  184. @ifset cmdnames
  185. @kindex \key1\
  186. @kindex \key2\
  187. @findex \command\
  188. @iftex
  189. @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  190. @end iftex
  191. @ifnottex
  192. @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  193. @end ifnottex
  194. @end ifset
  195. @ifclear cmdnames
  196. @kindex \key1\
  197. @kindex \key2\
  198. @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
  199. @end ifclear
  200. @end macro
  201. @c two keys with two commands
  202. @c Inserts: @item KEY1 COMMAND1
  203. @c @itemx KEY2 COMMAND2
  204. @macro orgcmdkkcc{key1,key2,command1,command2}
  205. @ifset cmdnames
  206. @kindex \key1\
  207. @kindex \key2\
  208. @findex \command1\
  209. @findex \command2\
  210. @iftex
  211. @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
  212. @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
  213. @end iftex
  214. @ifnottex
  215. @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
  216. @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
  217. @end ifnottex
  218. @end ifset
  219. @ifclear cmdnames
  220. @kindex \key1\
  221. @kindex \key2\
  222. @item @kbd{\key1\}
  223. @itemx @kbd{\key2\}
  224. @end ifclear
  225. @end macro
  226. @c -----------------------------------------------------------------------------
  227. @iftex
  228. @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
  229. @end iftex
  230. @c Subheadings inside a table.
  231. @macro tsubheading{text}
  232. @ifinfo
  233. @subsubheading \text\
  234. @end ifinfo
  235. @ifnotinfo
  236. @item @b{\text\}
  237. @end ifnotinfo
  238. @end macro
  239. @copying
  240. This manual is for Org version @value{VERSION}.
  241. Copyright @copyright{} 2004--2013 Free Software Foundation, Inc.
  242. @quotation
  243. Permission is granted to copy, distribute and/or modify this document
  244. under the terms of the GNU Free Documentation License, Version 1.3 or
  245. any later version published by the Free Software Foundation; with no
  246. Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
  247. and with the Back-Cover Texts as in (a) below. A copy of the license
  248. is included in the section entitled ``GNU Free Documentation License.''
  249. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
  250. modify this GNU manual.''
  251. @end quotation
  252. @end copying
  253. @dircategory Emacs editing modes
  254. @direntry
  255. * Org Mode: (org). Outline-based notes management and organizer
  256. @end direntry
  257. @titlepage
  258. @title The Org Manual
  259. @subtitle Release @value{VERSION}
  260. @author by Carsten Dominik
  261. with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan
  262. Davison, Eric Schulte, Thomas Dye, Jambunathan K and Nicolas Goaziou.
  263. @c The following two commands start the copyright page.
  264. @page
  265. @vskip 0pt plus 1filll
  266. @insertcopying
  267. @end titlepage
  268. @c Output the table of contents at the beginning.
  269. @contents
  270. @ifnottex
  271. @c FIXME These hand-written next,prev,up node pointers make editing a lot
  272. @c harder. There should be no need for them, makeinfo can do it
  273. @c automatically for any document with a normal structure.
  274. @node Top, Introduction, (dir), (dir)
  275. @top Org Mode Manual
  276. @insertcopying
  277. @end ifnottex
  278. @menu
  279. * Introduction:: Getting started
  280. * Document Structure:: A tree works like your brain
  281. * Tables:: Pure magic for quick formatting
  282. * Hyperlinks:: Notes in context
  283. * TODO Items:: Every tree branch can be a TODO item
  284. * Tags:: Tagging headlines and matching sets of tags
  285. * Properties and Columns:: Storing information about an entry
  286. * Dates and Times:: Making items useful for planning
  287. * Capture - Refile - Archive:: The ins and outs for projects
  288. * Agenda Views:: Collecting information into views
  289. * Markup:: Prepare text for rich export
  290. * Exporting:: Sharing and publishing notes
  291. * Publishing:: Create a web site of linked Org files
  292. * Working With Source Code:: Export, evaluate, and tangle code blocks
  293. * Miscellaneous:: All the rest which did not fit elsewhere
  294. * Hacking:: How to hack your way around
  295. * MobileOrg:: Viewing and capture on a mobile device
  296. * History and Acknowledgments:: How Org came into being
  297. * GNU Free Documentation License:: The license for this documentation.
  298. * Main Index:: An index of Org's concepts and features
  299. * Key Index:: Key bindings and where they are described
  300. * Command and Function Index:: Command names and some internal functions
  301. * Variable Index:: Variables mentioned in the manual
  302. @detailmenu
  303. --- The Detailed Node Listing ---
  304. Introduction
  305. * Summary:: Brief summary of what Org does
  306. * Installation:: Installing Org
  307. * Activation:: How to activate Org for certain buffers
  308. * Feedback:: Bug reports, ideas, patches etc.
  309. * Conventions:: Typesetting conventions in the manual
  310. Document structure
  311. * Outlines:: Org is based on Outline mode
  312. * Headlines:: How to typeset Org tree headlines
  313. * Visibility cycling:: Show and hide, much simplified
  314. * Motion:: Jumping to other headlines
  315. * Structure editing:: Changing sequence and level of headlines
  316. * Sparse trees:: Matches embedded in context
  317. * Plain lists:: Additional structure within an entry
  318. * Drawers:: Tucking stuff away
  319. * Blocks:: Folding blocks
  320. * Footnotes:: How footnotes are defined in Org's syntax
  321. * Orgstruct mode:: Structure editing outside Org
  322. * Org syntax:: Formal description of Org's syntax
  323. Visibility cycling
  324. * Global and local cycling:: Cycling through various visibility states
  325. * Initial visibility:: Setting the initial visibility state
  326. * Catching invisible edits:: Preventing mistakes when editing invisible parts
  327. Global and local cycling
  328. * Initial visibility:: Setting the initial visibility state
  329. * Catching invisible edits:: Preventing mistakes when editing invisible parts
  330. Tables
  331. * Built-in table editor:: Simple tables
  332. * Column width and alignment:: Overrule the automatic settings
  333. * Column groups:: Grouping to trigger vertical lines
  334. * Orgtbl mode:: The table editor as minor mode
  335. * The spreadsheet:: The table editor has spreadsheet capabilities
  336. * Org-Plot:: Plotting from org tables
  337. The spreadsheet
  338. * References:: How to refer to another field or range
  339. * Formula syntax for Calc:: Using Calc to compute stuff
  340. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  341. * Durations and time values:: How to compute durations and time values
  342. * Field and range formulas:: Formula for specific (ranges of) fields
  343. * Column formulas:: Formulas valid for an entire column
  344. * Lookup functions:: Lookup functions for searching tables
  345. * Editing and debugging formulas:: Fixing formulas
  346. * Updating the table:: Recomputing all dependent fields
  347. * Advanced features:: Field and column names, parameters and automatic recalc
  348. Hyperlinks
  349. * Link format:: How links in Org are formatted
  350. * Internal links:: Links to other places in the current file
  351. * External links:: URL-like links to the world
  352. * Handling links:: Creating, inserting and following
  353. * Using links outside Org:: Linking from my C source code?
  354. * Link abbreviations:: Shortcuts for writing complex links
  355. * Search options:: Linking to a specific location
  356. * Custom searches:: When the default search is not enough
  357. Internal links
  358. * Radio targets:: Make targets trigger links in plain text
  359. TODO items
  360. * TODO basics:: Marking and displaying TODO entries
  361. * TODO extensions:: Workflow and assignments
  362. * Progress logging:: Dates and notes for progress
  363. * Priorities:: Some things are more important than others
  364. * Breaking down tasks:: Splitting a task into manageable pieces
  365. * Checkboxes:: Tick-off lists
  366. Extended use of TODO keywords
  367. * Workflow states:: From TODO to DONE in steps
  368. * TODO types:: I do this, Fred does the rest
  369. * Multiple sets in one file:: Mixing it all, and still finding your way
  370. * Fast access to TODO states:: Single letter selection of a state
  371. * Per-file keywords:: Different files, different requirements
  372. * Faces for TODO keywords:: Highlighting states
  373. * TODO dependencies:: When one task needs to wait for others
  374. Progress logging
  375. * Closing items:: When was this entry marked DONE?
  376. * Tracking TODO state changes:: When did the status change?
  377. * Tracking your habits:: How consistent have you been?
  378. Tags
  379. * Tag inheritance:: Tags use the tree structure of the outline
  380. * Setting tags:: How to assign tags to a headline
  381. * Tag groups:: Use one tag to search for several tags
  382. * Tag searches:: Searching for combinations of tags
  383. Properties and columns
  384. * Property syntax:: How properties are spelled out
  385. * Special properties:: Access to other Org mode features
  386. * Property searches:: Matching property values
  387. * Property inheritance:: Passing values down the tree
  388. * Column view:: Tabular viewing and editing
  389. * Property API:: Properties for Lisp programmers
  390. Column view
  391. * Defining columns:: The COLUMNS format property
  392. * Using column view:: How to create and use column view
  393. * Capturing column view:: A dynamic block for column view
  394. Defining columns
  395. * Scope of column definitions:: Where defined, where valid?
  396. * Column attributes:: Appearance and content of a column
  397. Dates and times
  398. * Timestamps:: Assigning a time to a tree entry
  399. * Creating timestamps:: Commands which insert timestamps
  400. * Deadlines and scheduling:: Planning your work
  401. * Clocking work time:: Tracking how long you spend on a task
  402. * Effort estimates:: Planning work effort in advance
  403. * Relative timer:: Notes with a running timer
  404. * Countdown timer:: Starting a countdown timer for a task
  405. Creating timestamps
  406. * The date/time prompt:: How Org mode helps you entering date and time
  407. * Custom time format:: Making dates look different
  408. Deadlines and scheduling
  409. * Inserting deadline/schedule:: Planning items
  410. * Repeated tasks:: Items that show up again and again
  411. Clocking work time
  412. * Clocking commands:: Starting and stopping a clock
  413. * The clock table:: Detailed reports
  414. * Resolving idle time:: Resolving time when you've been idle
  415. Capture - Refile - Archive
  416. * Capture:: Capturing new stuff
  417. * Attachments:: Add files to tasks
  418. * RSS Feeds:: Getting input from RSS feeds
  419. * Protocols:: External (e.g., Browser) access to Emacs and Org
  420. * Refile and copy:: Moving/copying a tree from one place to another
  421. * Archiving:: What to do with finished projects
  422. Capture
  423. * Setting up capture:: Where notes will be stored
  424. * Using capture:: Commands to invoke and terminate capture
  425. * Capture templates:: Define the outline of different note types
  426. Capture templates
  427. * Template elements:: What is needed for a complete template entry
  428. * Template expansion:: Filling in information about time and context
  429. * Templates in contexts:: Only show a template in a specific context
  430. Archiving
  431. * Moving subtrees:: Moving a tree to an archive file
  432. * Internal archiving:: Switch off a tree but keep it in the file
  433. Agenda views
  434. * Agenda files:: Files being searched for agenda information
  435. * Agenda dispatcher:: Keyboard access to agenda views
  436. * Built-in agenda views:: What is available out of the box?
  437. * Presentation and sorting:: How agenda items are prepared for display
  438. * Agenda commands:: Remote editing of Org trees
  439. * Custom agenda views:: Defining special searches and views
  440. * Exporting Agenda Views:: Writing a view to a file
  441. * Agenda column view:: Using column view for collected entries
  442. The built-in agenda views
  443. * Weekly/daily agenda:: The calendar page with current tasks
  444. * Global TODO list:: All unfinished action items
  445. * Matching tags and properties:: Structured information with fine-tuned search
  446. * Timeline:: Time-sorted view for single file
  447. * Search view:: Find entries by searching for text
  448. * Stuck projects:: Find projects you need to review
  449. Presentation and sorting
  450. * Categories:: Not all tasks are equal
  451. * Time-of-day specifications:: How the agenda knows the time
  452. * Sorting agenda items:: The order of things
  453. * Filtering/limiting agenda items:: Dynamically narrow the agenda
  454. Custom agenda views
  455. * Storing searches:: Type once, use often
  456. * Block agenda:: All the stuff you need in a single buffer
  457. * Setting Options:: Changing the rules
  458. Markup for rich export
  459. * Structural markup elements:: The basic structure as seen by the exporter
  460. * Images and tables:: Images, tables and caption mechanism
  461. * Literal examples:: Source code examples with special formatting
  462. * Include files:: Include additional files into a document
  463. * Index entries:: Making an index
  464. * Macro replacement:: Use macros to create templates
  465. * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
  466. * Special blocks:: Containers targeted at export back-ends
  467. Structural markup elements
  468. * Document title:: Where the title is taken from
  469. * Headings and sections:: The document structure as seen by the exporter
  470. * Table of contents:: The if and where of the table of contents
  471. * Lists:: Lists
  472. * Paragraphs:: Paragraphs
  473. * Footnote markup:: Footnotes
  474. * Emphasis and monospace:: Bold, italic, etc.
  475. * Horizontal rules:: Make a line
  476. * Comment lines:: What will *not* be exported
  477. Embedded @LaTeX{}
  478. * Special symbols:: Greek letters and other symbols
  479. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  480. * @LaTeX{} fragments:: Complex formulas made easy
  481. * Previewing @LaTeX{} fragments:: What will this snippet look like?
  482. * CDLaTeX mode:: Speed up entering of formulas
  483. Exporting
  484. * The Export Dispatcher:: The main exporter interface
  485. * Export back-ends:: Built-in export formats
  486. * Export settings:: Generic export settings
  487. * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
  488. * Beamer export:: Exporting as a Beamer presentation
  489. * HTML export:: Exporting to HTML
  490. * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
  491. * Markdown export:: Exporting to Markdown
  492. * OpenDocument Text export:: Exporting to OpenDocument Text
  493. * iCalendar export:: Exporting to iCalendar
  494. * Other built-in back-ends:: Exporting to @code{Texinfo}, a man page, or Org
  495. * Export in foreign buffers:: Author tables in lists in Org syntax
  496. * Advanced configuration:: Fine-tuning the export output
  497. HTML export
  498. * HTML Export commands:: How to invoke HTML export
  499. * HTML preamble and postamble:: How to insert a preamble and a postamble
  500. * Quoting HTML tags:: Using direct HTML in Org mode
  501. * Links in HTML export:: How links will be interpreted and formatted
  502. * Tables in HTML export:: How to modify the formatting of tables
  503. * Images in HTML export:: How to insert figures into HTML output
  504. * Math formatting in HTML export:: Beautiful math also on the web
  505. * Text areas in HTML export:: An alternative way to show an example
  506. * CSS support:: Changing the appearance of the output
  507. * JavaScript support:: Info and Folding in a web browser
  508. @LaTeX{} and PDF export
  509. * @LaTeX{}/PDF export commands::
  510. * Header and sectioning:: Setting up the export file structure
  511. * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
  512. * @LaTeX{} specific attributes:: Controlling @LaTeX{} output
  513. OpenDocument Text export
  514. * Pre-requisites for ODT export:: What packages ODT exporter relies on
  515. * ODT export commands:: How to invoke ODT export
  516. * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
  517. * Applying custom styles:: How to apply custom styles to the output
  518. * Links in ODT export:: How links will be interpreted and formatted
  519. * Tables in ODT export:: How Tables are exported
  520. * Images in ODT export:: How to insert images
  521. * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
  522. * Labels and captions in ODT export:: How captions are rendered
  523. * Literal examples in ODT export:: How source and example blocks are formatted
  524. * Advanced topics in ODT export:: Read this if you are a power user
  525. Math formatting in ODT export
  526. * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
  527. * Working with MathML or OpenDocument formula files:: How to embed equations in native format
  528. Advanced topics in ODT export
  529. * Configuring a document converter:: How to register a document converter
  530. * Working with OpenDocument style files:: Explore the internals
  531. * Creating one-off styles:: How to produce custom highlighting etc
  532. * Customizing tables in ODT export:: How to define and use Table templates
  533. * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
  534. Publishing
  535. * Configuration:: Defining projects
  536. * Uploading files:: How to get files up on the server
  537. * Sample configuration:: Example projects
  538. * Triggering publication:: Publication commands
  539. Configuration
  540. * Project alist:: The central configuration variable
  541. * Sources and destinations:: From here to there
  542. * Selecting files:: What files are part of the project?
  543. * Publishing action:: Setting the function doing the publishing
  544. * Publishing options:: Tweaking HTML/@LaTeX{} export
  545. * Publishing links:: Which links keep working after publishing?
  546. * Sitemap:: Generating a list of all pages
  547. * Generating an index:: An index that reaches across pages
  548. Sample configuration
  549. * Simple example:: One-component publishing
  550. * Complex example:: A multi-component publishing example
  551. Working with source code
  552. * Structure of code blocks:: Code block syntax described
  553. * Editing source code:: Language major-mode editing
  554. * Exporting code blocks:: Export contents and/or results
  555. * Extracting source code:: Create pure source code files
  556. * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
  557. * Library of Babel:: Use and contribute to a library of useful code blocks
  558. * Languages:: List of supported code block languages
  559. * Header arguments:: Configure code block functionality
  560. * Results of evaluation:: How evaluation results are handled
  561. * Noweb reference syntax:: Literate programming in Org mode
  562. * Key bindings and useful functions:: Work quickly with code blocks
  563. * Batch execution:: Call functions from the command line
  564. Header arguments
  565. * Using header arguments:: Different ways to set header arguments
  566. * Specific header arguments:: List of header arguments
  567. Using header arguments
  568. * System-wide header arguments:: Set global default values
  569. * Language-specific header arguments:: Set default values by language
  570. * Buffer-wide header arguments:: Set default values for a specific buffer
  571. * Header arguments in Org mode properties:: Set default values for a buffer or heading
  572. * Code block specific header arguments:: The most common way to set values
  573. * Header arguments in function calls:: The most specific level
  574. Specific header arguments
  575. * var:: Pass arguments to code blocks
  576. * results:: Specify the type of results and how they will
  577. be collected and handled
  578. * file:: Specify a path for file output
  579. * file-desc:: Specify a description for file results
  580. * dir:: Specify the default (possibly remote)
  581. directory for code block execution
  582. * exports:: Export code and/or results
  583. * tangle:: Toggle tangling and specify file name
  584. * mkdirp:: Toggle creation of parent directories of target
  585. files during tangling
  586. * comments:: Toggle insertion of comments in tangled
  587. code files
  588. * padline:: Control insertion of padding lines in tangled
  589. code files
  590. * no-expand:: Turn off variable assignment and noweb
  591. expansion during tangling
  592. * session:: Preserve the state of code evaluation
  593. * noweb:: Toggle expansion of noweb references
  594. * noweb-ref:: Specify block's noweb reference resolution target
  595. * noweb-sep:: String used to separate noweb references
  596. * cache:: Avoid re-evaluating unchanged code blocks
  597. * sep:: Delimiter for writing tabular results outside Org
  598. * hlines:: Handle horizontal lines in tables
  599. * colnames:: Handle column names in tables
  600. * rownames:: Handle row names in tables
  601. * shebang:: Make tangled files executable
  602. * eval:: Limit evaluation of specific code blocks
  603. * wrap:: Mark source block evaluation results
  604. * post:: Post processing of code block results
  605. Miscellaneous
  606. * Completion:: M-TAB knows what you need
  607. * Easy Templates:: Quick insertion of structural elements
  608. * Speed keys:: Electric commands at the beginning of a headline
  609. * Code evaluation security:: Org mode files evaluate inline code
  610. * Customization:: Adapting Org to your taste
  611. * In-buffer settings:: Overview of the #+KEYWORDS
  612. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  613. * Clean view:: Getting rid of leading stars in the outline
  614. * TTY keys:: Using Org on a tty
  615. * Interaction:: Other Emacs packages
  616. * org-crypt.el:: Encrypting Org files
  617. Interaction with other packages
  618. * Cooperation:: Packages Org cooperates with
  619. * Conflicts:: Packages that lead to conflicts
  620. Hacking
  621. * Hooks:: How to reach into Org's internals
  622. * Add-on packages:: Available extensions
  623. * Adding hyperlink types:: New custom link types
  624. * Adding export back-ends:: How to write new export back-ends
  625. * Context-sensitive commands:: How to add functionality to such commands
  626. * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
  627. * Dynamic blocks:: Automatically filled blocks
  628. * Special agenda views:: Customized views
  629. * Speeding up your agendas:: Tips on how to speed up your agendas
  630. * Extracting agenda information:: Post-processing of agenda information
  631. * Using the property API:: Writing programs that use entry properties
  632. * Using the mapping API:: Mapping over all or selected entries
  633. Tables and lists in arbitrary syntax
  634. * Radio tables:: Sending and receiving radio tables
  635. * A @LaTeX{} example:: Step by step, almost a tutorial
  636. * Translator functions:: Copy and modify
  637. * Radio lists:: Sending and receiving lists
  638. MobileOrg
  639. * Setting up the staging area:: Where to interact with the mobile device
  640. * Pushing to MobileOrg:: Uploading Org files and agendas
  641. * Pulling from MobileOrg:: Integrating captured and flagged items
  642. @end detailmenu
  643. @end menu
  644. @node Introduction, Document Structure, Top, Top
  645. @chapter Introduction
  646. @cindex introduction
  647. @menu
  648. * Summary:: Brief summary of what Org does
  649. * Installation:: Installing Org
  650. * Activation:: How to activate Org for certain buffers
  651. * Feedback:: Bug reports, ideas, patches etc.
  652. * Conventions:: Typesetting conventions in the manual
  653. @end menu
  654. @node Summary, Installation, Introduction, Introduction
  655. @section Summary
  656. @cindex summary
  657. Org is a mode for keeping notes, maintaining TODO lists, and doing
  658. project planning with a fast and effective plain-text system.
  659. Org develops organizational tasks around NOTES files that contain
  660. lists or information about projects as plain text. Org is
  661. implemented on top of Outline mode, which makes it possible to keep the
  662. content of large files well structured. Visibility cycling and
  663. structure editing help to work with the tree. Tables are easily created
  664. with a built-in table editor. Org supports TODO items, deadlines,
  665. timestamps, and scheduling. It dynamically compiles entries into an
  666. agenda that utilizes and smoothly integrates much of the Emacs calendar
  667. and diary. Plain text URL-like links connect to websites, emails,
  668. Usenet messages, BBDB entries, and any files related to the projects.
  669. For printing and sharing notes, an Org file can be exported as a
  670. structured ASCII file, as HTML, or (TODO and agenda items only) as an
  671. iCalendar file. It can also serve as a publishing tool for a set of
  672. linked web pages.
  673. As a project planning environment, Org works by adding metadata to outline
  674. nodes. Based on this data, specific entries can be extracted in queries and
  675. create dynamic @i{agenda views}.
  676. Org mode contains the Org Babel environment which allows you to work with
  677. embedded source code blocks in a file, to facilitate code evaluation,
  678. documentation, and literate programming techniques.
  679. Org's automatic, context-sensitive table editor with spreadsheet
  680. capabilities can be integrated into any major mode by activating the
  681. minor Orgtbl mode. Using a translation step, it can be used to maintain
  682. tables in arbitrary file types, for example in @LaTeX{}. The structure
  683. editing and list creation capabilities can be used outside Org with
  684. the minor Orgstruct mode.
  685. Org keeps simple things simple. When first fired up, it should
  686. feel like a straightforward, easy to use outliner. Complexity is not
  687. imposed, but a large amount of functionality is available when you need
  688. it. Org is a toolbox and can be used in different ways and for different
  689. ends, for example:
  690. @example
  691. @r{@bullet{} an outline extension with visibility cycling and structure editing}
  692. @r{@bullet{} an ASCII system and table editor for taking structured notes}
  693. @r{@bullet{} a TODO list editor}
  694. @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
  695. @pindex GTD, Getting Things Done
  696. @r{@bullet{} an environment in which to implement David Allen's GTD system}
  697. @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
  698. @r{@bullet{} a publishing tool to create a set of interlinked web pages}
  699. @r{@bullet{} an environment for literate programming}
  700. @end example
  701. @cindex FAQ
  702. There is a website for Org which provides links to the newest
  703. version of Org, as well as additional information, frequently asked
  704. questions (FAQ), links to tutorials, etc. This page is located at
  705. @uref{http://orgmode.org}.
  706. @cindex print edition
  707. The version 7.3 of this manual is available as a
  708. @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
  709. Theory Ltd.}
  710. @page
  711. @node Installation, Activation, Summary, Introduction
  712. @section Installation
  713. @cindex installation
  714. @cindex XEmacs
  715. Org is part of recent distributions of GNU Emacs, so you normally don't need
  716. to install it. If, for one reason or another, you want to install Org on top
  717. of this pre-packaged version, there are three ways to do it:
  718. @itemize @bullet
  719. @item By using Emacs package system.
  720. @item By downloading Org as an archive.
  721. @item By using Org's git repository.
  722. @end itemize
  723. We @b{strongly recommend} to stick to a single installation method.
  724. @subsubheading Using Emacs packaging system
  725. Recent Emacs distributions include a packaging system which lets you install
  726. Elisp libraries. You can install Org with @kbd{M-x package-install RET org}.
  727. You need to do this in a session where no @code{.org} file has been visited.
  728. Then, to make sure your Org configuration is taken into account, initialize
  729. the package system with @code{(package-initialize)} in your @file{.emacs}
  730. before setting any Org option. If you want to use Org's package repository,
  731. check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
  732. @subsubheading Downloading Org as an archive
  733. You can download Org latest release from @uref{http://orgmode.org/, Org's
  734. website}. In this case, make sure you set the load-path correctly in your
  735. @file{.emacs}:
  736. @lisp
  737. (add-to-list 'load-path "~/path/to/orgdir/lisp")
  738. @end lisp
  739. The downloaded archive contains contributed libraries that are not included
  740. in Emacs. If you want to use them, add the @file{contrib} directory to your
  741. load-path:
  742. @lisp
  743. (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
  744. @end lisp
  745. Optionally, you can compile the files and/or install them in your system.
  746. Run @code{make help} to list compilation and installation options.
  747. @subsubheading Using Org's git repository
  748. You can clone Org's repository and install Org like this:
  749. @example
  750. $ cd ~/src/
  751. $ git clone git://orgmode.org/org-mode.git
  752. $ make autoloads
  753. @end example
  754. Note that in this case, @code{make autoloads} is mandatory: it defines Org's
  755. version in @file{org-version.el} and Org's autoloads in
  756. @file{org-loaddefs.el}.
  757. Remember to add the correct load-path as described in the method above.
  758. You can also compile with @code{make}, generate the documentation with
  759. @code{make doc}, create a local configuration with @code{make config} and
  760. install Org with @code{make install}. Please run @code{make help} to get
  761. the list of compilation/installation options.
  762. For more detailed explanations on Org's build system, please check the Org
  763. Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
  764. Worg}.
  765. @node Activation, Feedback, Installation, Introduction
  766. @section Activation
  767. @cindex activation
  768. @cindex autoload
  769. @cindex ELPA
  770. @cindex global key bindings
  771. @cindex key bindings, global
  772. @findex org-agenda
  773. @findex org-capture
  774. @findex org-store-link
  775. @findex org-iswitchb
  776. Since Emacs 22.2, files with the @file{.org} extension use Org mode by
  777. default. If you are using an earlier version of Emacs, add this line to your
  778. @file{.emacs} file:
  779. @lisp
  780. (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
  781. @end lisp
  782. Org mode buffers need font-lock to be turned on: this is the default in
  783. Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
  784. with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
  785. There are compatibility issues between Org mode and some other Elisp
  786. packages, please take the time to check the list (@pxref{Conflicts}).
  787. The four Org commands @command{org-store-link}, @command{org-capture},
  788. @command{org-agenda}, and @command{org-iswitchb} should be accessible through
  789. global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
  790. suggested bindings for these keys, please modify the keys to your own
  791. liking.
  792. @lisp
  793. (global-set-key "\C-cl" 'org-store-link)
  794. (global-set-key "\C-cc" 'org-capture)
  795. (global-set-key "\C-ca" 'org-agenda)
  796. (global-set-key "\C-cb" 'org-iswitchb)
  797. @end lisp
  798. @cindex Org mode, turning on
  799. With this setup, all files with extension @samp{.org} will be put
  800. into Org mode. As an alternative, make the first line of a file look
  801. like this:
  802. @example
  803. MY PROJECTS -*- mode: org; -*-
  804. @end example
  805. @vindex org-insert-mode-line-in-empty-file
  806. @noindent which will select Org mode for this buffer no matter what
  807. the file's name is. See also the variable
  808. @var{org-insert-mode-line-in-empty-file}.
  809. Many commands in Org work on the region if the region is @i{active}. To make
  810. use of this, you need to have @code{transient-mark-mode}
  811. (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
  812. in Emacs 22 you need to do this yourself with
  813. @lisp
  814. (transient-mark-mode 1)
  815. @end lisp
  816. @noindent If you do not like @code{transient-mark-mode}, you can create an
  817. active region by using the mouse to select a region, or pressing
  818. @kbd{C-@key{SPC}} twice before moving the cursor.
  819. @node Feedback, Conventions, Activation, Introduction
  820. @section Feedback
  821. @cindex feedback
  822. @cindex bug reports
  823. @cindex maintainer
  824. @cindex author
  825. If you find problems with Org, or if you have questions, remarks, or ideas
  826. about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
  827. If you are not a member of the mailing list, your mail will be passed to the
  828. list after a moderator has approved it@footnote{Please consider subscribing
  829. to the mailing list, in order to minimize the work the mailing list
  830. moderators have to do.}.
  831. For bug reports, please first try to reproduce the bug with the latest
  832. version of Org available---if you are running an outdated version, it is
  833. quite possible that the bug has been fixed already. If the bug persists,
  834. prepare a report and provide as much information as possible, including the
  835. version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
  836. (@kbd{M-x org-version RET}), as well as the Org related setup in
  837. @file{.emacs}. The easiest way to do this is to use the command
  838. @example
  839. @kbd{M-x org-submit-bug-report RET}
  840. @end example
  841. @noindent which will put all this information into an Emacs mail buffer so
  842. that you only need to add your description. If you re not sending the Email
  843. from within Emacs, please copy and paste the content into your Email program.
  844. Sometimes you might face a problem due to an error in your Emacs or Org mode
  845. setup. Before reporting a bug, it is very helpful to start Emacs with minimal
  846. customizations and reproduce the problem. Doing so often helps you determine
  847. if the problem is with your customization or with Org mode itself. You can
  848. start a typical minimal session with a command like the example below.
  849. @example
  850. $ emacs -Q -l /path/to/minimal-org.el
  851. @end example
  852. However if you are using Org mode as distributed with Emacs, a minimal setup
  853. is not necessary. In that case it is sufficient to start Emacs as
  854. @code{emacs -Q}. The @code{minimal-org.el} setup file can have contents as
  855. shown below.
  856. @lisp
  857. ;;; Minimal setup to load latest `org-mode'
  858. ;; activate debugging
  859. (setq debug-on-error t
  860. debug-on-signal nil
  861. debug-on-quit nil)
  862. ;; add latest org-mode to load path
  863. (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
  864. (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
  865. @end lisp
  866. If an error occurs, a backtrace can be very useful (see below on how to
  867. create one). Often a small example file helps, along with clear information
  868. about:
  869. @enumerate
  870. @item What exactly did you do?
  871. @item What did you expect to happen?
  872. @item What happened instead?
  873. @end enumerate
  874. @noindent Thank you for helping to improve this program.
  875. @subsubheading How to create a useful backtrace
  876. @cindex backtrace of an error
  877. If working with Org produces an error with a message you don't
  878. understand, you may have hit a bug. The best way to report this is by
  879. providing, in addition to what was mentioned above, a @emph{backtrace}.
  880. This is information from the built-in debugger about where and how the
  881. error occurred. Here is how to produce a useful backtrace:
  882. @enumerate
  883. @item
  884. Reload uncompiled versions of all Org mode Lisp files. The backtrace
  885. contains much more information if it is produced with uncompiled code.
  886. To do this, use
  887. @example
  888. @kbd{C-u M-x org-reload RET}
  889. @end example
  890. @noindent
  891. or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
  892. menu.
  893. @item
  894. Go to the @code{Options} menu and select @code{Enter Debugger on Error}
  895. (XEmacs has this option in the @code{Troubleshooting} sub-menu).
  896. @item
  897. Do whatever you have to do to hit the error. Don't forget to
  898. document the steps you take.
  899. @item
  900. When you hit the error, a @file{*Backtrace*} buffer will appear on the
  901. screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
  902. attach it to your bug report.
  903. @end enumerate
  904. @node Conventions, , Feedback, Introduction
  905. @section Typesetting conventions used in this manual
  906. @subsubheading TODO keywords, tags, properties, etc.
  907. Org mainly uses three types of keywords: TODO keywords, tags and property
  908. names. In this manual we use the following conventions:
  909. @table @code
  910. @item TODO
  911. @itemx WAITING
  912. TODO keywords are written with all capitals, even if they are
  913. user-defined.
  914. @item boss
  915. @itemx ARCHIVE
  916. User-defined tags are written in lowercase; built-in tags with special
  917. meaning are written with all capitals.
  918. @item Release
  919. @itemx PRIORITY
  920. User-defined properties are capitalized; built-in properties with
  921. special meaning are written with all capitals.
  922. @end table
  923. Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
  924. and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
  925. environment). They are written in uppercase in the manual to enhance its
  926. readability, but you can use lowercase in your Org files@footnote{Easy
  927. templates insert lowercase keywords and Babel dynamically inserts
  928. @code{#+results}.}
  929. @subsubheading Keybindings and commands
  930. @kindex C-c a
  931. @findex org-agenda
  932. @kindex C-c c
  933. @findex org-capture
  934. The manual suggests two global keybindings: @kbd{C-c a} for @code{org-agenda}
  935. and @kbd{C-c c} for @code{org-capture}. These are only suggestions, but the
  936. rest of the manual assumes that you are using these keybindings.
  937. Also, the manual lists both the keys and the corresponding commands for
  938. accessing a functionality. Org mode often uses the same key for different
  939. functions, depending on context. The command that is bound to such keys has
  940. a generic name, like @code{org-metaright}. In the manual we will, wherever
  941. possible, give the function that is internally called by the generic command.
  942. For example, in the chapter on document structure, @kbd{M-@key{right}} will
  943. be listed to call @code{org-do-demote}, while in the chapter on tables, it
  944. will be listed to call @code{org-table-move-column-right}. If you prefer,
  945. you can compile the manual without the command names by unsetting the flag
  946. @code{cmdnames} in @file{org.texi}.
  947. @node Document Structure, Tables, Introduction, Top
  948. @chapter Document structure
  949. @cindex document structure
  950. @cindex structure of document
  951. Org is based on Outline mode and provides flexible commands to
  952. edit the structure of the document.
  953. @menu
  954. * Outlines:: Org is based on Outline mode
  955. * Headlines:: How to typeset Org tree headlines
  956. * Visibility cycling:: Show and hide, much simplified
  957. * Motion:: Jumping to other headlines
  958. * Structure editing:: Changing sequence and level of headlines
  959. * Sparse trees:: Matches embedded in context
  960. * Plain lists:: Additional structure within an entry
  961. * Drawers:: Tucking stuff away
  962. * Blocks:: Folding blocks
  963. * Footnotes:: How footnotes are defined in Org's syntax
  964. * Orgstruct mode:: Structure editing outside Org
  965. * Org syntax:: Formal description of Org's syntax
  966. @end menu
  967. @node Outlines, Headlines, Document Structure, Document Structure
  968. @section Outlines
  969. @cindex outlines
  970. @cindex Outline mode
  971. Org is implemented on top of Outline mode. Outlines allow a
  972. document to be organized in a hierarchical structure, which (at least
  973. for me) is the best representation of notes and thoughts. An overview
  974. of this structure is achieved by folding (hiding) large parts of the
  975. document to show only the general document structure and the parts
  976. currently being worked on. Org greatly simplifies the use of
  977. outlines by compressing the entire show/hide functionality into a single
  978. command, @command{org-cycle}, which is bound to the @key{TAB} key.
  979. @node Headlines, Visibility cycling, Outlines, Document Structure
  980. @section Headlines
  981. @cindex headlines
  982. @cindex outline tree
  983. @vindex org-special-ctrl-a/e
  984. @vindex org-special-ctrl-k
  985. @vindex org-ctrl-k-protect-subtree
  986. Headlines define the structure of an outline tree. The headlines in Org
  987. start with one or more stars, on the left margin@footnote{See the variables
  988. @var{org-special-ctrl-a/e}, @var{org-special-ctrl-k}, and
  989. @var{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
  990. @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
  991. headings indented less then 30 stars.}. For example:
  992. @example
  993. * Top level headline
  994. ** Second level
  995. *** 3rd level
  996. some text
  997. *** 3rd level
  998. more text
  999. * Another top level headline
  1000. @end example
  1001. @noindent Some people find the many stars too noisy and would prefer an
  1002. outline that has whitespace followed by a single star as headline
  1003. starters. @ref{Clean view}, describes a setup to realize this.
  1004. @vindex org-cycle-separator-lines
  1005. An empty line after the end of a subtree is considered part of it and
  1006. will be hidden when the subtree is folded. However, if you leave at
  1007. least two empty lines, one empty line will remain visible after folding
  1008. the subtree, in order to structure the collapsed view. See the
  1009. variable @var{org-cycle-separator-lines} to modify this behavior.
  1010. @node Visibility cycling, Motion, Headlines, Document Structure
  1011. @section Visibility cycling
  1012. @cindex cycling, visibility
  1013. @cindex visibility cycling
  1014. @cindex trees, visibility
  1015. @cindex show hidden text
  1016. @cindex hide text
  1017. @menu
  1018. * Global and local cycling:: Cycling through various visibility states
  1019. * Initial visibility:: Setting the initial visibility state
  1020. * Catching invisible edits:: Preventing mistakes when editing invisible parts
  1021. @end menu
  1022. @node Global and local cycling, Initial visibility, Visibility cycling, Visibility cycling
  1023. @subsection Global and local cycling
  1024. Outlines make it possible to hide parts of the text in the buffer.
  1025. Org uses just two commands, bound to @key{TAB} and
  1026. @kbd{S-@key{TAB}} to change the visibility in the buffer.
  1027. @cindex subtree visibility states
  1028. @cindex subtree cycling
  1029. @cindex folded, subtree visibility state
  1030. @cindex children, subtree visibility state
  1031. @cindex subtree, subtree visibility state
  1032. @table @asis
  1033. @orgcmd{@key{TAB},org-cycle}
  1034. @emph{Subtree cycling}: Rotate current subtree among the states
  1035. @example
  1036. ,-> FOLDED -> CHILDREN -> SUBTREE --.
  1037. '-----------------------------------'
  1038. @end example
  1039. @vindex org-cycle-emulate-tab
  1040. @vindex org-cycle-global-at-bob
  1041. The cursor must be on a headline for this to work@footnote{see, however,
  1042. the option @var{org-cycle-emulate-tab}.}. When the cursor is at the
  1043. beginning of the buffer and the first line is not a headline, then
  1044. @key{TAB} actually runs global cycling (see below)@footnote{see the
  1045. option @var{org-cycle-global-at-bob}.}. Also when called with a prefix
  1046. argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
  1047. @cindex global visibility states
  1048. @cindex global cycling
  1049. @cindex overview, global visibility state
  1050. @cindex contents, global visibility state
  1051. @cindex show all, global visibility state
  1052. @orgcmd{S-@key{TAB},org-global-cycle}
  1053. @itemx C-u @key{TAB}
  1054. @emph{Global cycling}: Rotate the entire buffer among the states
  1055. @example
  1056. ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
  1057. '--------------------------------------'
  1058. @end example
  1059. When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
  1060. CONTENTS view up to headlines of level N will be shown. Note that inside
  1061. tables, @kbd{S-@key{TAB}} jumps to the previous field.
  1062. @cindex show all, command
  1063. @orgcmd{C-u C-u C-u @key{TAB},show-all}
  1064. Show all, including drawers.
  1065. @cindex revealing context
  1066. @orgcmd{C-c C-r,org-reveal}
  1067. Reveal context around point, showing the current entry, the following heading
  1068. and the hierarchy above. Useful for working near a location that has been
  1069. exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
  1070. (@pxref{Agenda commands}). With a prefix argument show, on each
  1071. level, all sibling headings. With a double prefix argument, also show the
  1072. entire subtree of the parent.
  1073. @cindex show branches, command
  1074. @orgcmd{C-c C-k,show-branches}
  1075. Expose all the headings of the subtree, CONTENT view for just one subtree.
  1076. @cindex show children, command
  1077. @orgcmd{C-c @key{TAB},show-children}
  1078. Expose all direct children of the subtree. With a numeric prefix argument N,
  1079. expose all children down to level N@.
  1080. @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
  1081. Show the current subtree in an indirect buffer@footnote{The indirect
  1082. buffer
  1083. @ifinfo
  1084. (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
  1085. @end ifinfo
  1086. @ifnotinfo
  1087. (see the Emacs manual for more information about indirect buffers)
  1088. @end ifnotinfo
  1089. will contain the entire buffer, but will be narrowed to the current
  1090. tree. Editing the indirect buffer will also change the original buffer,
  1091. but without affecting visibility in that buffer.}. With a numeric
  1092. prefix argument N, go up to level N and then take that tree. If N is
  1093. negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
  1094. the previously used indirect buffer.
  1095. @orgcmd{C-c C-x v,org-copy-visible}
  1096. Copy the @i{visible} text in the region into the kill ring.
  1097. @end table
  1098. @menu
  1099. * Initial visibility:: Setting the initial visibility state
  1100. * Catching invisible edits:: Preventing mistakes when editing invisible parts
  1101. @end menu
  1102. @node Initial visibility, Catching invisible edits, Global and local cycling, Visibility cycling
  1103. @subsection Initial visibility
  1104. @cindex visibility, initialize
  1105. @vindex org-startup-folded
  1106. @vindex org-agenda-inhibit-startup
  1107. @cindex @code{overview}, STARTUP keyword
  1108. @cindex @code{content}, STARTUP keyword
  1109. @cindex @code{showall}, STARTUP keyword
  1110. @cindex @code{showeverything}, STARTUP keyword
  1111. When Emacs first visits an Org file, the global state is set to OVERVIEW,
  1112. i.e., only the top level headlines are visible@footnote{When
  1113. @var{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default
  1114. visibility state when first opening a file for the agenda (@pxref{Speeding up
  1115. your agendas}).} This can be configured through the variable
  1116. @var{org-startup-folded}, or on a per-file basis by adding one of the
  1117. following lines anywhere in the buffer:
  1118. @example
  1119. #+STARTUP: overview
  1120. #+STARTUP: content
  1121. #+STARTUP: showall
  1122. #+STARTUP: showeverything
  1123. @end example
  1124. The startup visibility options are ignored when the file is open for the
  1125. first time during the agenda generation: if you want the agenda to honor
  1126. the startup visibility, set @var{org-agenda-inhibit-startup} to @code{nil}.
  1127. @cindex property, VISIBILITY
  1128. @noindent
  1129. Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
  1130. and Columns}) will get their visibility adapted accordingly. Allowed values
  1131. for this property are @code{folded}, @code{children}, @code{content}, and
  1132. @code{all}.
  1133. @table @asis
  1134. @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
  1135. Switch back to the startup visibility of the buffer, i.e., whatever is
  1136. requested by startup options and @samp{VISIBILITY} properties in individual
  1137. entries.
  1138. @end table
  1139. @node Catching invisible edits, , Initial visibility, Visibility cycling
  1140. @subsection Catching invisible edits
  1141. @vindex org-catch-invisible-edits
  1142. @cindex edits, catching invisible
  1143. Sometimes you may inadvertently edit an invisible part of the buffer and be
  1144. confused on what as been edited and how to undo the mistake. Setting
  1145. @var{org-catch-invisible-edits} to non-@code{nil} will help prevent this. See the
  1146. docstring of this option on how Org should catch invisible edits and process
  1147. them.
  1148. @node Motion, Structure editing, Visibility cycling, Document Structure
  1149. @section Motion
  1150. @cindex motion, between headlines
  1151. @cindex jumping, to headlines
  1152. @cindex headline navigation
  1153. The following commands jump to other headlines in the buffer.
  1154. @table @asis
  1155. @orgcmd{C-c C-n,outline-next-visible-heading}
  1156. Next heading.
  1157. @orgcmd{C-c C-p,outline-previous-visible-heading}
  1158. Previous heading.
  1159. @orgcmd{C-c C-f,org-forward-same-level}
  1160. Next heading same level.
  1161. @orgcmd{C-c C-b,org-backward-same-level}
  1162. Previous heading same level.
  1163. @orgcmd{C-c C-u,outline-up-heading}
  1164. Backward to higher level heading.
  1165. @orgcmd{C-c C-j,org-goto}
  1166. Jump to a different place without changing the current outline
  1167. visibility. Shows the document structure in a temporary buffer, where
  1168. you can use the following keys to find your destination:
  1169. @vindex org-goto-auto-isearch
  1170. @example
  1171. @key{TAB} @r{Cycle visibility.}
  1172. @key{down} / @key{up} @r{Next/previous visible headline.}
  1173. @key{RET} @r{Select this location.}
  1174. @kbd{/} @r{Do a Sparse-tree search}
  1175. @r{The following keys work if you turn off @var{org-goto-auto-isearch}}
  1176. n / p @r{Next/previous visible headline.}
  1177. f / b @r{Next/previous headline same level.}
  1178. u @r{One level up.}
  1179. 0-9 @r{Digit argument.}
  1180. q @r{Quit}
  1181. @end example
  1182. @vindex org-goto-interface
  1183. @noindent
  1184. See also the option @var{org-goto-interface}.
  1185. @end table
  1186. @node Structure editing, Sparse trees, Motion, Document Structure
  1187. @section Structure editing
  1188. @cindex structure editing
  1189. @cindex headline, promotion and demotion
  1190. @cindex promotion, of subtrees
  1191. @cindex demotion, of subtrees
  1192. @cindex subtree, cut and paste
  1193. @cindex pasting, of subtrees
  1194. @cindex cutting, of subtrees
  1195. @cindex copying, of subtrees
  1196. @cindex sorting, of subtrees
  1197. @cindex subtrees, cut and paste
  1198. @table @asis
  1199. @orgcmd{M-@key{RET},org-insert-heading}
  1200. @vindex org-M-RET-may-split-line
  1201. Insert a new heading/item with the same level than the one at point.
  1202. If the cursor is in a plain list item, a new item is created
  1203. (@pxref{Plain lists}). To prevent this behavior in lists, call the
  1204. command with a prefix argument. When this command is used in the
  1205. middle of a line, the line is split and the rest of the line becomes
  1206. the new item or headline@footnote{If you do not want the line to be
  1207. split, customize the variable @var{org-M-RET-may-split-line}.}. If
  1208. the command is used at the @emph{beginning} of a headline, the new
  1209. headline is created before the current line. If the command is used
  1210. at the @emph{end} of a folded subtree (i.e., behind the ellipses at
  1211. the end of a headline), then a headline like the current one will be
  1212. inserted after the end of the subtree. Calling this command with
  1213. @kbd{C-u C-u} will unconditionally respect the headline's content and
  1214. create a new item at the end of the parent subtree.
  1215. @orgcmd{C-@key{RET},org-insert-heading-respect-content}
  1216. Just like @kbd{M-@key{RET}}, except when adding a new heading below the
  1217. current heading, the new heading is placed after the body instead of before
  1218. it. This command works from anywhere in the entry.
  1219. @orgcmd{M-S-@key{RET},org-insert-todo-heading}
  1220. @vindex org-treat-insert-todo-heading-as-state-change
  1221. Insert new TODO entry with same level as current heading. See also the
  1222. variable @var{org-treat-insert-todo-heading-as-state-change}.
  1223. @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
  1224. Insert new TODO entry with same level as current heading. Like
  1225. @kbd{C-@key{RET}}, the new headline will be inserted after the current
  1226. subtree.
  1227. @orgcmd{@key{TAB},org-cycle}
  1228. In a new entry with no text yet, the first @key{TAB} demotes the entry to
  1229. become a child of the previous one. The next @key{TAB} makes it a parent,
  1230. and so on, all the way to top level. Yet another @key{TAB}, and you are back
  1231. to the initial level.
  1232. @orgcmd{M-@key{left},org-do-promote}
  1233. Promote current heading by one level.
  1234. @orgcmd{M-@key{right},org-do-demote}
  1235. Demote current heading by one level.
  1236. @orgcmd{M-S-@key{left},org-promote-subtree}
  1237. Promote the current subtree by one level.
  1238. @orgcmd{M-S-@key{right},org-demote-subtree}
  1239. Demote the current subtree by one level.
  1240. @orgcmd{M-S-@key{up},org-move-subtree-up}
  1241. Move subtree up (swap with previous subtree of same
  1242. level).
  1243. @orgcmd{M-S-@key{down},org-move-subtree-down}
  1244. Move subtree down (swap with next subtree of same level).
  1245. @orgcmd{M-h,org-mark-element}
  1246. Mark the element at point. Hitting repeatedly will mark subsequent elements
  1247. of the one just marked. E.g., hitting @key{M-h} on a paragraph will mark it,
  1248. hitting @key{M-h} immediately again will mark the next one.
  1249. @orgcmd{C-c @@,org-mark-subtree}
  1250. Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees
  1251. of the same level than the marked subtree.
  1252. @orgcmd{C-c C-x C-w,org-cut-subtree}
  1253. Kill subtree, i.e., remove it from buffer but save in kill ring.
  1254. With a numeric prefix argument N, kill N sequential subtrees.
  1255. @orgcmd{C-c C-x M-w,org-copy-subtree}
  1256. Copy subtree to kill ring. With a numeric prefix argument N, copy the N
  1257. sequential subtrees.
  1258. @orgcmd{C-c C-x C-y,org-paste-subtree}
  1259. Yank subtree from kill ring. This does modify the level of the subtree to
  1260. make sure the tree fits in nicely at the yank position. The yank level can
  1261. also be specified with a numeric prefix argument, or by yanking after a
  1262. headline marker like @samp{****}.
  1263. @orgcmd{C-y,org-yank}
  1264. @vindex org-yank-adjusted-subtrees
  1265. @vindex org-yank-folded-subtrees
  1266. Depending on the options @var{org-yank-adjusted-subtrees} and
  1267. @var{org-yank-folded-subtrees}, Org's internal @code{yank} command will
  1268. paste subtrees folded and in a clever way, using the same command as @kbd{C-c
  1269. C-x C-y}. With the default settings, no level adjustment will take place,
  1270. but the yanked tree will be folded unless doing so would swallow text
  1271. previously visible. Any prefix argument to this command will force a normal
  1272. @code{yank} to be executed, with the prefix passed along. A good way to
  1273. force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
  1274. yank, it will yank previous kill items plainly, without adjustment and
  1275. folding.
  1276. @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
  1277. Clone a subtree by making a number of sibling copies of it. You will be
  1278. prompted for the number of copies to make, and you can also specify if any
  1279. timestamps in the entry should be shifted. This can be useful, for example,
  1280. to create a number of tasks related to a series of lectures to prepare. For
  1281. more details, see the docstring of the command
  1282. @code{org-clone-subtree-with-time-shift}.
  1283. @orgcmd{C-c C-w,org-refile}
  1284. Refile entry or region to a different location. @xref{Refile and copy}.
  1285. @orgcmd{C-c ^,org-sort}
  1286. Sort same-level entries. When there is an active region, all entries in the
  1287. region will be sorted. Otherwise the children of the current headline are
  1288. sorted. The command prompts for the sorting method, which can be
  1289. alphabetically, numerically, by time (first timestamp with active preferred,
  1290. creation time, scheduled time, deadline time), by priority, by TODO keyword
  1291. (in the sequence the keywords have been defined in the setup) or by the value
  1292. of a property. Reverse sorting is possible as well. You can also supply
  1293. your own function to extract the sorting key. With a @kbd{C-u} prefix,
  1294. sorting will be case-sensitive.
  1295. @orgcmd{C-x n s,org-narrow-to-subtree}
  1296. Narrow buffer to current subtree.
  1297. @orgcmd{C-x n b,org-narrow-to-block}
  1298. Narrow buffer to current block.
  1299. @orgcmd{C-x n w,widen}
  1300. Widen buffer to remove narrowing.
  1301. @orgcmd{C-c *,org-toggle-heading}
  1302. Turn a normal line or plain list item into a headline (so that it becomes a
  1303. subheading at its location). Also turn a headline into a normal line by
  1304. removing the stars. If there is an active region, turn all lines in the
  1305. region into headlines. If the first line in the region was an item, turn
  1306. only the item lines into headlines. Finally, if the first line is a
  1307. headline, remove the stars from all headlines in the region.
  1308. @end table
  1309. @cindex region, active
  1310. @cindex active region
  1311. @cindex transient mark mode
  1312. When there is an active region (Transient Mark mode), promotion and
  1313. demotion work on all headlines in the region. To select a region of
  1314. headlines, it is best to place both point and mark at the beginning of a
  1315. line, mark at the beginning of the first headline, and point at the line
  1316. just after the last headline to change. Note that when the cursor is
  1317. inside a table (@pxref{Tables}), the Meta-Cursor keys have different
  1318. functionality.
  1319. @node Sparse trees, Plain lists, Structure editing, Document Structure
  1320. @section Sparse trees
  1321. @cindex sparse trees
  1322. @cindex trees, sparse
  1323. @cindex folding, sparse trees
  1324. @cindex occur, command
  1325. @vindex org-show-hierarchy-above
  1326. @vindex org-show-following-heading
  1327. @vindex org-show-siblings
  1328. @vindex org-show-entry-below
  1329. An important feature of Org mode is the ability to construct @emph{sparse
  1330. trees} for selected information in an outline tree, so that the entire
  1331. document is folded as much as possible, but the selected information is made
  1332. visible along with the headline structure above it@footnote{See also the
  1333. variables @var{org-show-hierarchy-above}, @var{org-show-following-heading},
  1334. @var{org-show-siblings}, and @var{org-show-entry-below} for detailed
  1335. control on how much context is shown around each match.}. Just try it out
  1336. and you will see immediately how it works.
  1337. Org mode contains several commands creating such trees, all these
  1338. commands can be accessed through a dispatcher:
  1339. @table @asis
  1340. @orgcmd{C-c /,org-sparse-tree}
  1341. This prompts for an extra key to select a sparse-tree creating command.
  1342. @orgcmd{C-c / r,org-occur}
  1343. @vindex org-remove-highlights-with-change
  1344. Prompts for a regexp and shows a sparse tree with all matches. If
  1345. the match is in a headline, the headline is made visible. If the match is in
  1346. the body of an entry, headline and body are made visible. In order to
  1347. provide minimal context, also the full hierarchy of headlines above the match
  1348. is shown, as well as the headline following the match. Each match is also
  1349. highlighted; the highlights disappear when the buffer is changed by an
  1350. editing command@footnote{This depends on the option
  1351. @var{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
  1352. When called with a @kbd{C-u} prefix argument, previous highlights are kept,
  1353. so several calls to this command can be stacked.
  1354. @orgcmdkkc{M-g n,M-g M-n,next-error}
  1355. Jump to the next sparse tree match in this buffer.
  1356. @orgcmdkkc{M-g p,M-g M-p,previous-error}
  1357. Jump to the previous sparse tree match in this buffer.
  1358. @end table
  1359. @noindent
  1360. @vindex org-agenda-custom-commands
  1361. For frequently used sparse trees of specific search strings, you can
  1362. use the option @var{org-agenda-custom-commands} to define fast
  1363. keyboard access to specific sparse trees. These commands will then be
  1364. accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
  1365. For example:
  1366. @lisp
  1367. (setq org-agenda-custom-commands
  1368. '(("f" occur-tree "FIXME")))
  1369. @end lisp
  1370. @noindent will define the key @kbd{C-c a f} as a shortcut for creating
  1371. a sparse tree matching the string @samp{FIXME}.
  1372. The other sparse tree commands select headings based on TODO keywords,
  1373. tags, or properties and will be discussed later in this manual.
  1374. @kindex C-c C-e C-v
  1375. @cindex printing sparse trees
  1376. @cindex visible text, printing
  1377. To print a sparse tree, you can use the Emacs command
  1378. @code{ps-print-buffer-with-faces} which does not print invisible parts
  1379. of the document @footnote{This does not work under XEmacs, because
  1380. XEmacs uses selective display for outlining, not text properties.}.
  1381. Or you can use @kbd{C-c C-e C-v} to export only the visible part of
  1382. the document and print the resulting file.
  1383. @node Plain lists, Drawers, Sparse trees, Document Structure
  1384. @section Plain lists
  1385. @cindex plain lists
  1386. @cindex lists, plain
  1387. @cindex lists, ordered
  1388. @cindex ordered lists
  1389. Within an entry of the outline tree, hand-formatted lists can provide
  1390. additional structure. They also provide a way to create lists of checkboxes
  1391. (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
  1392. (@pxref{Exporting}) can parse and format them.
  1393. Org knows ordered lists, unordered lists, and description lists.
  1394. @itemize @bullet
  1395. @item
  1396. @emph{Unordered} list items start with @samp{-}, @samp{+}, or
  1397. @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
  1398. they will be seen as top-level headlines. Also, when you are hiding leading
  1399. stars to get a clean outline view, plain list items starting with a star may
  1400. be hard to distinguish from true headlines. In short: even though @samp{*}
  1401. is supported, it may be better to not use it for plain list items.} as
  1402. bullets.
  1403. @item
  1404. @vindex org-plain-list-ordered-item-terminator
  1405. @vindex org-list-allow-alphabetical
  1406. @emph{Ordered} list items start with a numeral followed by either a period or
  1407. a right parenthesis@footnote{You can filter out any of them by configuring
  1408. @var{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
  1409. @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
  1410. @samp{A)} by configuring @var{org-list-allow-alphabetical}. To minimize
  1411. confusion with normal text, those are limited to one character only. Beyond
  1412. that limit, bullets will automatically fallback to numbers.}. If you want a
  1413. list to start with a different value (e.g., 20), start the text of the item
  1414. with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
  1415. must be put @emph{before} the checkbox. If you have activated alphabetical
  1416. lists, you can also use counters like @code{[@@b]}.}. Those constructs can
  1417. be used in any item of the list in order to enforce a particular numbering.
  1418. @item
  1419. @emph{Description} list items are unordered list items, and contain the
  1420. separator @samp{ :: } to distinguish the description @emph{term} from the
  1421. description.
  1422. @end itemize
  1423. Items belonging to the same list must have the same indentation on the first
  1424. line. In particular, if an ordered list reaches number @samp{10.}, then the
  1425. 2--digit numbers must be written left-aligned with the other numbers in the
  1426. list. An item ends before the next line that is less or equally indented
  1427. than its bullet/number.
  1428. @vindex org-list-empty-line-terminates-plain-lists
  1429. A list ends whenever every item has ended, which means before any line less
  1430. or equally indented than items at top level. It also ends before two blank
  1431. lines@footnote{See also @var{org-list-empty-line-terminates-plain-lists}.}.
  1432. In that case, all items are closed. Here is an example:
  1433. @example
  1434. @group
  1435. ** Lord of the Rings
  1436. My favorite scenes are (in this order)
  1437. 1. The attack of the Rohirrim
  1438. 2. Eowyn's fight with the witch king
  1439. + this was already my favorite scene in the book
  1440. + I really like Miranda Otto.
  1441. 3. Peter Jackson being shot by Legolas
  1442. - on DVD only
  1443. He makes a really funny face when it happens.
  1444. But in the end, no individual scenes matter but the film as a whole.
  1445. Important actors in this film are:
  1446. - @b{Elijah Wood} :: He plays Frodo
  1447. - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
  1448. him very well from his role as Mikey Walsh in @i{The Goonies}.
  1449. @end group
  1450. @end example
  1451. Org supports these lists by tuning filling and wrapping commands to deal with
  1452. them correctly@footnote{Org only changes the filling settings for Emacs. For
  1453. XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
  1454. put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
  1455. properly (@pxref{Exporting}). Since indentation is what governs the
  1456. structure of these lists, many structural constructs like @code{#+BEGIN_...}
  1457. blocks can be indented to signal that they belong to a particular item.
  1458. @vindex org-list-demote-modify-bullet
  1459. @vindex org-list-indent-offset
  1460. If you find that using a different bullet for a sub-list (than that used for
  1461. the current list-level) improves readability, customize the variable
  1462. @var{org-list-demote-modify-bullet}. To get a greater difference of
  1463. indentation between items and theirs sub-items, customize
  1464. @var{org-list-indent-offset}.
  1465. @vindex org-list-automatic-rules
  1466. The following commands act on items when the cursor is in the first line of
  1467. an item (the line with the bullet or number). Some of them imply the
  1468. application of automatic rules to keep list structure intact. If some of
  1469. these actions get in your way, configure @var{org-list-automatic-rules}
  1470. to disable them individually.
  1471. @table @asis
  1472. @orgcmd{@key{TAB},org-cycle}
  1473. @cindex cycling, in plain lists
  1474. @vindex org-cycle-include-plain-lists
  1475. Items can be folded just like headline levels. Normally this works only if
  1476. the cursor is on a plain list item. For more details, see the variable
  1477. @var{org-cycle-include-plain-lists}. If this variable is set to
  1478. @code{integrate}, plain list items will be treated like low-level
  1479. headlines. The level of an item is then given by the indentation of the
  1480. bullet/number. Items are always subordinate to real headlines, however; the
  1481. hierarchies remain completely separated. In a new item with no text yet, the
  1482. first @key{TAB} demotes the item to become a child of the previous
  1483. one. Subsequent @key{TAB}s move the item to meaningful levels in the list
  1484. and eventually get it back to its initial position.
  1485. @orgcmd{M-@key{RET},org-insert-heading}
  1486. @vindex org-M-RET-may-split-line
  1487. @vindex org-list-automatic-rules
  1488. Insert new item at current level. With a prefix argument, force a new
  1489. heading (@pxref{Structure editing}). If this command is used in the middle
  1490. of an item, that item is @emph{split} in two, and the second part becomes the
  1491. new item@footnote{If you do not want the item to be split, customize the
  1492. variable @var{org-M-RET-may-split-line}.}. If this command is executed
  1493. @emph{before item's body}, the new item is created @emph{before} the current
  1494. one.
  1495. @end table
  1496. @table @kbd
  1497. @kindex M-S-@key{RET}
  1498. @item M-S-RET
  1499. Insert a new item with a checkbox (@pxref{Checkboxes}).
  1500. @kindex S-@key{down}
  1501. @item S-up
  1502. @itemx S-down
  1503. @cindex shift-selection-mode
  1504. @vindex org-support-shift-select
  1505. @vindex org-list-use-circular-motion
  1506. Jump to the previous/next item in the current list@footnote{If you want to
  1507. cycle around items that way, you may customize
  1508. @var{org-list-use-circular-motion}.}, but only if
  1509. @var{org-support-shift-select} is off. If not, you can still use paragraph
  1510. jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
  1511. similar effect.
  1512. @kindex M-@key{up}
  1513. @kindex M-@key{down}
  1514. @item M-up
  1515. @itemx M-down
  1516. Move the item including subitems up/down@footnote{See
  1517. @var{org-list-use-circular-motion} for a cyclic behavior.} (swap with
  1518. previous/next item of same indentation). If the list is ordered, renumbering
  1519. is automatic.
  1520. @kindex M-@key{left}
  1521. @kindex M-@key{right}
  1522. @item M-left
  1523. @itemx M-right
  1524. Decrease/increase the indentation of an item, leaving children alone.
  1525. @kindex M-S-@key{left}
  1526. @kindex M-S-@key{right}
  1527. @item M-S-left
  1528. @itemx M-S-right
  1529. Decrease/increase the indentation of the item, including subitems.
  1530. Initially, the item tree is selected based on current indentation. When
  1531. these commands are executed several times in direct succession, the initially
  1532. selected region is used, even if the new indentation would imply a different
  1533. hierarchy. To use the new hierarchy, break the command chain with a cursor
  1534. motion or so.
  1535. As a special case, using this command on the very first item of a list will
  1536. move the whole list. This behavior can be disabled by configuring
  1537. @var{org-list-automatic-rules}. The global indentation of a list has no
  1538. influence on the text @emph{after} the list.
  1539. @kindex C-c C-c
  1540. @item C-c C-c
  1541. If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
  1542. state of the checkbox. In any case, verify bullets and indentation
  1543. consistency in the whole list.
  1544. @kindex C-c -
  1545. @vindex org-plain-list-ordered-item-terminator
  1546. @item C-c -
  1547. Cycle the entire list level through the different itemize/enumerate bullets
  1548. (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
  1549. depending on @var{org-plain-list-ordered-item-terminator}, the type of list,
  1550. and its indentation. With a numeric prefix argument N, select the Nth bullet
  1551. from this list. If there is an active region when calling this, selected
  1552. text will be changed into an item. With a prefix argument, all lines will be
  1553. converted to list items. If the first line already was a list item, any item
  1554. marker will be removed from the list. Finally, even without an active
  1555. region, a normal line will be converted into a list item.
  1556. @kindex C-c *
  1557. @item C-c *
  1558. Turn a plain list item into a headline (so that it becomes a subheading at
  1559. its location). @xref{Structure editing}, for a detailed explanation.
  1560. @kindex C-c C-*
  1561. @item C-c C-*
  1562. Turn the whole plain list into a subtree of the current heading. Checkboxes
  1563. (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
  1564. (resp. checked).
  1565. @kindex S-@key{left}
  1566. @kindex S-@key{right}
  1567. @item S-left/right
  1568. @vindex org-support-shift-select
  1569. This command also cycles bullet styles when the cursor in on the bullet or
  1570. anywhere in an item line, details depending on
  1571. @var{org-support-shift-select}.
  1572. @kindex C-c ^
  1573. @item C-c ^
  1574. Sort the plain list. You will be prompted for the sorting method:
  1575. numerically, alphabetically, by time, or by custom function.
  1576. @end table
  1577. @node Drawers, Blocks, Plain lists, Document Structure
  1578. @section Drawers
  1579. @cindex drawers
  1580. @cindex #+DRAWERS
  1581. @cindex visibility cycling, drawers
  1582. @vindex org-drawers
  1583. @cindex org-insert-drawer
  1584. @kindex C-c C-x d
  1585. Sometimes you want to keep information associated with an entry, but you
  1586. normally don't want to see it. For this, Org mode has @emph{drawers}.
  1587. Drawers need to be configured with the option @var{org-drawers}@footnote{You
  1588. can define additional drawers on a per-file basis with a line like
  1589. @code{#+DRAWERS: HIDDEN STATE}}. Drawers look like this:
  1590. @example
  1591. ** This is a headline
  1592. Still outside the drawer
  1593. :DRAWERNAME:
  1594. This is inside the drawer.
  1595. :END:
  1596. After the drawer.
  1597. @end example
  1598. You can interactively insert drawers at point by calling
  1599. @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
  1600. region, this command will put the region inside the drawer. With a prefix
  1601. argument, this command calls @code{org-insert-property-drawer} and add a
  1602. property drawer right below the current headline. Completion over drawer
  1603. keywords is also possible using @key{M-TAB}.
  1604. Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
  1605. show the entry, but keep the drawer collapsed to a single line. In order to
  1606. look inside the drawer, you need to move the cursor to the drawer line and
  1607. press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
  1608. storing properties (@pxref{Properties and Columns}), and you can also arrange
  1609. for state change notes (@pxref{Tracking TODO state changes}) and clock times
  1610. (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
  1611. want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
  1612. @table @kbd
  1613. @kindex C-c C-z
  1614. @item C-c C-z
  1615. Add a time-stamped note to the LOGBOOK drawer.
  1616. @end table
  1617. @vindex org-export-with-drawers
  1618. You can select the name of the drawers which should be exported with
  1619. @var{org-export-with-drawers}. In that case, drawer contents will appear in
  1620. export output. Property drawers are not affected by this variable and are
  1621. never exported.
  1622. @node Blocks, Footnotes, Drawers, Document Structure
  1623. @section Blocks
  1624. @vindex org-hide-block-startup
  1625. @cindex blocks, folding
  1626. Org mode uses begin...end blocks for various purposes from including source
  1627. code examples (@pxref{Literal examples}) to capturing time logging
  1628. information (@pxref{Clocking work time}). These blocks can be folded and
  1629. unfolded by pressing TAB in the begin line. You can also get all blocks
  1630. folded at startup by configuring the option @var{org-hide-block-startup}
  1631. or on a per-file basis by using
  1632. @cindex @code{hideblocks}, STARTUP keyword
  1633. @cindex @code{nohideblocks}, STARTUP keyword
  1634. @example
  1635. #+STARTUP: hideblocks
  1636. #+STARTUP: nohideblocks
  1637. @end example
  1638. @node Footnotes, Orgstruct mode, Blocks, Document Structure
  1639. @section Footnotes
  1640. @cindex footnotes
  1641. Org mode supports the creation of footnotes. In contrast to the
  1642. @file{footnote.el} package, Org mode's footnotes are designed for work on
  1643. a larger document, not only for one-off documents like emails.
  1644. A footnote is started by a footnote marker in square brackets in column 0, no
  1645. indentation allowed. It ends at the next footnote definition, headline, or
  1646. after two consecutive empty lines. The footnote reference is simply the
  1647. marker in square brackets, inside text. For example:
  1648. @example
  1649. The Org homepage[fn:1] now looks a lot better than it used to.
  1650. ...
  1651. [fn:1] The link is: http://orgmode.org
  1652. @end example
  1653. Org mode extends the number-based syntax to @emph{named} footnotes and
  1654. optional inline definition. Using plain numbers as markers (as
  1655. @file{footnote.el} does) is supported for backward compatibility, but not
  1656. encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
  1657. @LaTeX{}}). Here are the valid references:
  1658. @table @code
  1659. @item [1]
  1660. A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
  1661. recommended because something like @samp{[1]} could easily be part of a code
  1662. snippet.
  1663. @item [fn:name]
  1664. A named footnote reference, where @code{name} is a unique label word, or, for
  1665. simplicity of automatic creation, a number.
  1666. @item [fn:: This is the inline definition of this footnote]
  1667. A @LaTeX{}-like anonymous footnote where the definition is given directly at the
  1668. reference point.
  1669. @item [fn:name: a definition]
  1670. An inline definition of a footnote, which also specifies a name for the note.
  1671. Since Org allows multiple references to the same note, you can then use
  1672. @code{[fn:name]} to create additional references.
  1673. @end table
  1674. @vindex org-footnote-auto-label
  1675. Footnote labels can be created automatically, or you can create names yourself.
  1676. This is handled by the variable @var{org-footnote-auto-label} and its
  1677. corresponding @code{#+STARTUP} keywords. See the docstring of that variable
  1678. for details.
  1679. @noindent The following command handles footnotes:
  1680. @table @kbd
  1681. @kindex C-c C-x f
  1682. @item C-c C-x f
  1683. The footnote action command.
  1684. When the cursor is on a footnote reference, jump to the definition. When it
  1685. is at a definition, jump to the (first) reference.
  1686. @vindex org-footnote-define-inline
  1687. @vindex org-footnote-section
  1688. @vindex org-footnote-auto-adjust
  1689. Otherwise, create a new footnote. Depending on the option
  1690. @var{org-footnote-define-inline}@footnote{The corresponding in-buffer
  1691. setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
  1692. definition will be placed right into the text as part of the reference, or
  1693. separately into the location determined by the option
  1694. @var{org-footnote-section}.
  1695. When this command is called with a prefix argument, a menu of additional
  1696. options is offered:
  1697. @example
  1698. s @r{Sort the footnote definitions by reference sequence. During editing,}
  1699. @r{Org makes no effort to sort footnote definitions into a particular}
  1700. @r{sequence. If you want them sorted, use this command, which will}
  1701. @r{also move entries according to @var{org-footnote-section}. Automatic}
  1702. @r{sorting after each insertion/deletion can be configured using the}
  1703. @r{option @var{org-footnote-auto-adjust}.}
  1704. r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
  1705. @r{after each insertion/deletion can be configured using the option}
  1706. @r{@var{org-footnote-auto-adjust}.}
  1707. S @r{Short for first @code{r}, then @code{s} action.}
  1708. n @r{Normalize the footnotes by collecting all definitions (including}
  1709. @r{inline definitions) into a special section, and then numbering them}
  1710. @r{in sequence. The references will then also be numbers. This is}
  1711. @r{meant to be the final step before finishing a document (e.g., sending}
  1712. @r{off an email).}
  1713. d @r{Delete the footnote at point, and all definitions of and references}
  1714. @r{to it.}
  1715. @end example
  1716. Depending on the variable @var{org-footnote-auto-adjust}@footnote{the
  1717. corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
  1718. renumbering and sorting footnotes can be automatic after each insertion or
  1719. deletion.
  1720. @kindex C-c C-c
  1721. @item C-c C-c
  1722. If the cursor is on a footnote reference, jump to the definition. If it is a
  1723. the definition, jump back to the reference. When called at a footnote
  1724. location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
  1725. @kindex C-c C-o
  1726. @kindex mouse-1
  1727. @kindex mouse-2
  1728. @item C-c C-o @r{or} mouse-1/2
  1729. Footnote labels are also links to the corresponding definition/reference, and
  1730. you can use the usual commands to follow these links.
  1731. @end table
  1732. @node Orgstruct mode, Org syntax, Footnotes, Document Structure
  1733. @section The Orgstruct minor mode
  1734. @cindex Orgstruct mode
  1735. @cindex minor mode for structure editing
  1736. If you like the intuitive way the Org mode structure editing and list
  1737. formatting works, you might want to use these commands in other modes like
  1738. Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
  1739. this possible. Toggle the mode with @kbd{M-x orgstruct-mode RET}, or
  1740. turn it on by default, for example in Message mode, with one of:
  1741. @lisp
  1742. (add-hook 'message-mode-hook 'turn-on-orgstruct)
  1743. (add-hook 'message-mode-hook 'turn-on-orgstruct++)
  1744. @end lisp
  1745. When this mode is active and the cursor is on a line that looks to Org like a
  1746. headline or the first line of a list item, most structure editing commands
  1747. will work, even if the same keys normally have different functionality in the
  1748. major mode you are using. If the cursor is not in one of those special
  1749. lines, Orgstruct mode lurks silently in the shadows.
  1750. When you use @code{orgstruct++-mode}, Org will also export indentation and
  1751. autofill settings into that mode, and detect item context after the first
  1752. line of an item.
  1753. @vindex orgstruct-heading-prefix-regexp
  1754. You can also use Org structure editing to fold and unfold headlines in
  1755. @emph{any} file, provided you defined @var{orgstruct-heading-prefix-regexp}:
  1756. the regular expression must match the local prefix to use before Org's
  1757. headlines. For example, if you set this variable to @code{"^;; "} in Emacs
  1758. Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
  1759. commented lines. Some commands like @code{org-demote} are disabled when the
  1760. prefix is set, but folding/unfolding will work correctly.
  1761. @node Org syntax, , Orgstruct mode, Document Structure
  1762. @section Org syntax
  1763. @cindex Org syntax
  1764. A reference document providing a formal description of Org's syntax is
  1765. available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
  1766. Worg}, written and maintained by Nicolas Goaziou. It defines Org's core
  1767. internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
  1768. keywords}, @code{(greater) elements} and @code{objects}. Each part of an Org
  1769. file falls into one of the categories above.
  1770. To explore the abstract structure of an Org buffer, run this in a buffer:
  1771. @lisp
  1772. M-: (org-element-parse-buffer) RET
  1773. @end lisp
  1774. It will output a list containing the buffer's content represented as an
  1775. abstract structure. The export engine relies on the information stored in
  1776. this list. Most interactive commands (e.g., for structure editing) also
  1777. rely on the syntactic meaning of the surrounding context.
  1778. @node Tables, Hyperlinks, Document Structure, Top
  1779. @chapter Tables
  1780. @cindex tables
  1781. @cindex editing tables
  1782. Org comes with a fast and intuitive table editor. Spreadsheet-like
  1783. calculations are supported using the Emacs @file{calc} package
  1784. (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
  1785. @menu
  1786. * Built-in table editor:: Simple tables
  1787. * Column width and alignment:: Overrule the automatic settings
  1788. * Column groups:: Grouping to trigger vertical lines
  1789. * Orgtbl mode:: The table editor as minor mode
  1790. * The spreadsheet:: The table editor has spreadsheet capabilities
  1791. * Org-Plot:: Plotting from org tables
  1792. @end menu
  1793. @node Built-in table editor, Column width and alignment, Tables, Tables
  1794. @section The built-in table editor
  1795. @cindex table editor, built-in
  1796. Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
  1797. the first non-whitespace character is considered part of a table. @samp{|}
  1798. is also the column separator@footnote{To insert a vertical bar into a table
  1799. field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
  1800. might look like this:
  1801. @example
  1802. | Name | Phone | Age |
  1803. |-------+-------+-----|
  1804. | Peter | 1234 | 17 |
  1805. | Anna | 4321 | 25 |
  1806. @end example
  1807. A table is re-aligned automatically each time you press @key{TAB} or
  1808. @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
  1809. the next field (@key{RET} to the next row) and creates new table rows
  1810. at the end of the table or before horizontal lines. The indentation
  1811. of the table is set by the first line. Any line starting with
  1812. @samp{|-} is considered as a horizontal separator line and will be
  1813. expanded on the next re-align to span the whole table width. So, to
  1814. create the above table, you would only type
  1815. @example
  1816. |Name|Phone|Age|
  1817. |-
  1818. @end example
  1819. @noindent and then press @key{TAB} to align the table and start filling in
  1820. fields. Even faster would be to type @code{|Name|Phone|Age} followed by
  1821. @kbd{C-c @key{RET}}.
  1822. @vindex org-enable-table-editor
  1823. @vindex org-table-auto-blank-field
  1824. When typing text into a field, Org treats @key{DEL},
  1825. @key{Backspace}, and all character keys in a special way, so that
  1826. inserting and deleting avoids shifting other fields. Also, when
  1827. typing @emph{immediately after the cursor was moved into a new field
  1828. with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
  1829. field is automatically made blank. If this behavior is too
  1830. unpredictable for you, configure the options
  1831. @var{org-enable-table-editor} and @var{org-table-auto-blank-field}.
  1832. @table @kbd
  1833. @tsubheading{Creation and conversion}
  1834. @orgcmd{C-c |,org-table-create-or-convert-from-region}
  1835. Convert the active region to table. If every line contains at least one
  1836. TAB character, the function assumes that the material is tab separated.
  1837. If every line contains a comma, comma-separated values (CSV) are assumed.
  1838. If not, lines are split at whitespace into fields. You can use a prefix
  1839. argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
  1840. C-u} forces TAB, and a numeric argument N indicates that at least N
  1841. consecutive spaces, or alternatively a TAB will be the separator.
  1842. @*
  1843. If there is no active region, this command creates an empty Org
  1844. table. But it is easier just to start typing, like
  1845. @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
  1846. @tsubheading{Re-aligning and field motion}
  1847. @orgcmd{C-c C-c,org-table-align}
  1848. Re-align the table and don't move to another field.
  1849. @c
  1850. @orgcmd{<TAB>,org-table-next-field}
  1851. Re-align the table, move to the next field. Creates a new row if
  1852. necessary.
  1853. @c
  1854. @orgcmd{S-@key{TAB},org-table-previous-field}
  1855. Re-align, move to previous field.
  1856. @c
  1857. @orgcmd{@key{RET},org-table-next-row}
  1858. Re-align the table and move down to next row. Creates a new row if
  1859. necessary. At the beginning or end of a line, @key{RET} still does
  1860. NEWLINE, so it can be used to split a table.
  1861. @c
  1862. @orgcmd{M-a,org-table-beginning-of-field}
  1863. Move to beginning of the current table field, or on to the previous field.
  1864. @orgcmd{M-e,org-table-end-of-field}
  1865. Move to end of the current table field, or on to the next field.
  1866. @tsubheading{Column and row editing}
  1867. @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
  1868. Move the current column left/right.
  1869. @c
  1870. @orgcmd{M-S-@key{left},org-table-delete-column}
  1871. Kill the current column.
  1872. @c
  1873. @orgcmd{M-S-@key{right},org-table-insert-column}
  1874. Insert a new column to the left of the cursor position.
  1875. @c
  1876. @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
  1877. Move the current row up/down.
  1878. @c
  1879. @orgcmd{M-S-@key{up},org-table-kill-row}
  1880. Kill the current row or horizontal line.
  1881. @c
  1882. @orgcmd{M-S-@key{down},org-table-insert-row}
  1883. Insert a new row above the current row. With a prefix argument, the line is
  1884. created below the current one.
  1885. @c
  1886. @orgcmd{C-c -,org-table-insert-hline}
  1887. Insert a horizontal line below current row. With a prefix argument, the line
  1888. is created above the current line.
  1889. @c
  1890. @orgcmd{C-c @key{RET},org-table-hline-and-move}
  1891. Insert a horizontal line below current row, and move the cursor into the row
  1892. below that line.
  1893. @c
  1894. @orgcmd{C-c ^,org-table-sort-lines}
  1895. Sort the table lines in the region. The position of point indicates the
  1896. column to be used for sorting, and the range of lines is the range
  1897. between the nearest horizontal separator lines, or the entire table. If
  1898. point is before the first column, you will be prompted for the sorting
  1899. column. If there is an active region, the mark specifies the first line
  1900. and the sorting column, while point should be in the last line to be
  1901. included into the sorting. The command prompts for the sorting type
  1902. (alphabetically, numerically, or by time). When called with a prefix
  1903. argument, alphabetic sorting will be case-sensitive.
  1904. @tsubheading{Regions}
  1905. @orgcmd{C-c C-x M-w,org-table-copy-region}
  1906. Copy a rectangular region from a table to a special clipboard. Point and
  1907. mark determine edge fields of the rectangle. If there is no active region,
  1908. copy just the current field. The process ignores horizontal separator lines.
  1909. @c
  1910. @orgcmd{C-c C-x C-w,org-table-cut-region}
  1911. Copy a rectangular region from a table to a special clipboard, and
  1912. blank all fields in the rectangle. So this is the ``cut'' operation.
  1913. @c
  1914. @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
  1915. Paste a rectangular region into a table.
  1916. The upper left corner ends up in the current field. All involved fields
  1917. will be overwritten. If the rectangle does not fit into the present table,
  1918. the table is enlarged as needed. The process ignores horizontal separator
  1919. lines.
  1920. @c
  1921. @orgcmd{M-@key{RET},org-table-wrap-region}
  1922. Split the current field at the cursor position and move the rest to the line
  1923. below. If there is an active region, and both point and mark are in the same
  1924. column, the text in the column is wrapped to minimum width for the given
  1925. number of lines. A numeric prefix argument may be used to change the number
  1926. of desired lines. If there is no region, but you specify a prefix argument,
  1927. the current field is made blank, and the content is appended to the field
  1928. above.
  1929. @tsubheading{Calculations}
  1930. @cindex formula, in tables
  1931. @cindex calculations, in tables
  1932. @cindex region, active
  1933. @cindex active region
  1934. @cindex transient mark mode
  1935. @orgcmd{C-c +,org-table-sum}
  1936. Sum the numbers in the current column, or in the rectangle defined by
  1937. the active region. The result is shown in the echo area and can
  1938. be inserted with @kbd{C-y}.
  1939. @c
  1940. @orgcmd{S-@key{RET},org-table-copy-down}
  1941. @vindex org-table-copy-increment
  1942. When current field is empty, copy from first non-empty field above. When not
  1943. empty, copy current field down to next row and move cursor along with it.
  1944. Depending on the option @var{org-table-copy-increment}, integer field
  1945. values will be incremented during copy. Integers that are too large will not
  1946. be incremented. Also, a @code{0} prefix argument temporarily disables the
  1947. increment. This key is also used by shift-selection and related modes
  1948. (@pxref{Conflicts}).
  1949. @tsubheading{Miscellaneous}
  1950. @orgcmd{C-c `,org-table-edit-field}
  1951. Edit the current field in a separate window. This is useful for fields that
  1952. are not fully visible (@pxref{Column width and alignment}). When called with
  1953. a @kbd{C-u} prefix, just make the full field visible, so that it can be
  1954. edited in place. When called with two @kbd{C-u} prefixes, make the editor
  1955. window follow the cursor through the table and always show the current
  1956. field. The follow mode exits automatically when the cursor leaves the table,
  1957. or when you repeat this command with @kbd{C-u C-u C-c `}.
  1958. @c
  1959. @item M-x org-table-import RET
  1960. Import a file as a table. The table should be TAB or whitespace
  1961. separated. Use, for example, to import a spreadsheet table or data
  1962. from a database, because these programs generally can write
  1963. TAB-separated text files. This command works by inserting the file into
  1964. the buffer and then converting the region to a table. Any prefix
  1965. argument is passed on to the converter, which uses it to determine the
  1966. separator.
  1967. @orgcmd{C-c |,org-table-create-or-convert-from-region}
  1968. Tables can also be imported by pasting tabular text into the Org
  1969. buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
  1970. @kbd{C-c |} command (see above under @i{Creation and conversion}).
  1971. @c
  1972. @item M-x org-table-export RET
  1973. @findex org-table-export
  1974. @vindex org-table-export-default-format
  1975. Export the table, by default as a TAB-separated file. Use for data
  1976. exchange with, for example, spreadsheet or database programs. The format
  1977. used to export the file can be configured in the option
  1978. @var{org-table-export-default-format}. You may also use properties
  1979. @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
  1980. name and the format for table export in a subtree. Org supports quite
  1981. general formats for exported tables. The exporter format is the same as the
  1982. format used by Orgtbl radio tables, see @ref{Translator functions}, for a
  1983. detailed description.
  1984. @end table
  1985. If you don't like the automatic table editor because it gets in your
  1986. way on lines which you would like to start with @samp{|}, you can turn
  1987. it off with
  1988. @lisp
  1989. (setq org-enable-table-editor nil)
  1990. @end lisp
  1991. @noindent Then the only table command that still works is
  1992. @kbd{C-c C-c} to do a manual re-align.
  1993. @node Column width and alignment, Column groups, Built-in table editor, Tables
  1994. @section Column width and alignment
  1995. @cindex narrow columns in tables
  1996. @cindex alignment in tables
  1997. The width of columns is automatically determined by the table editor. And
  1998. also the alignment of a column is determined automatically from the fraction
  1999. of number-like versus non-number fields in the column.
  2000. Sometimes a single field or a few fields need to carry more text, leading to
  2001. inconveniently wide columns. Or maybe you want to make a table with several
  2002. columns having a fixed width, regardless of content. To set@footnote{This
  2003. feature does not work on XEmacs.} the width of a column, one field anywhere
  2004. in the column may contain just the string @samp{<N>} where @samp{N} is an
  2005. integer specifying the width of the column in characters. The next re-align
  2006. will then set the width of this column to this value.
  2007. @example
  2008. @group
  2009. |---+------------------------------| |---+--------|
  2010. | | | | | <6> |
  2011. | 1 | one | | 1 | one |
  2012. | 2 | two | ----\ | 2 | two |
  2013. | 3 | This is a long chunk of text | ----/ | 3 | This=> |
  2014. | 4 | four | | 4 | four |
  2015. |---+------------------------------| |---+--------|
  2016. @end group
  2017. @end example
  2018. @noindent
  2019. Fields that are wider become clipped and end in the string @samp{=>}.
  2020. Note that the full text is still in the buffer but is hidden.
  2021. To see the full text, hold the mouse over the field---a tool-tip window
  2022. will show the full content. To edit such a field, use the command
  2023. @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
  2024. open a new window with the full field. Edit it and finish with @kbd{C-c
  2025. C-c}.
  2026. @vindex org-startup-align-all-tables
  2027. When visiting a file containing a table with narrowed columns, the
  2028. necessary character hiding has not yet happened, and the table needs to
  2029. be aligned before it looks nice. Setting the option
  2030. @var{org-startup-align-all-tables} will realign all tables in a file
  2031. upon visiting, but also slow down startup. You can also set this option
  2032. on a per-file basis with:
  2033. @example
  2034. #+STARTUP: align
  2035. #+STARTUP: noalign
  2036. @end example
  2037. If you would like to overrule the automatic alignment of number-rich columns
  2038. to the right and of string-rich column to the left, you can use @samp{<r>},
  2039. @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
  2040. effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
  2041. also combine alignment and field width like this: @samp{<r10>}.
  2042. Lines which only contain these formatting cookies will be removed
  2043. automatically when exporting the document.
  2044. @node Column groups, Orgtbl mode, Column width and alignment, Tables
  2045. @section Column groups
  2046. @cindex grouping columns in tables
  2047. When Org exports tables, it does so by default without vertical
  2048. lines because that is visually more satisfying in general. Occasionally
  2049. however, vertical lines can be useful to structure a table into groups
  2050. of columns, much like horizontal lines can do for groups of rows. In
  2051. order to specify column groups, you can use a special row where the
  2052. first field contains only @samp{/}. The further fields can either
  2053. contain @samp{<} to indicate that this column should start a group,
  2054. @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
  2055. and @samp{>}) to make a column
  2056. a group of its own. Boundaries between column groups will upon export be
  2057. marked with vertical lines. Here is an example:
  2058. @example
  2059. | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  2060. |---+-----+-----+-----+---------+------------|
  2061. | / | < | | > | < | > |
  2062. | 1 | 1 | 1 | 1 | 1 | 1 |
  2063. | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
  2064. | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
  2065. |---+-----+-----+-----+---------+------------|
  2066. #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
  2067. @end example
  2068. It is also sufficient to just insert the column group starters after
  2069. every vertical line you would like to have:
  2070. @example
  2071. | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  2072. |----+-----+-----+-----+---------+------------|
  2073. | / | < | | | < | |
  2074. @end example
  2075. @node Orgtbl mode, The spreadsheet, Column groups, Tables
  2076. @section The Orgtbl minor mode
  2077. @cindex Orgtbl mode
  2078. @cindex minor mode for tables
  2079. If you like the intuitive way the Org table editor works, you
  2080. might also want to use it in other modes like Text mode or Mail mode.
  2081. The minor mode Orgtbl mode makes this possible. You can always toggle
  2082. the mode with @kbd{M-x orgtbl-mode RET}. To turn it on by default, for
  2083. example in Message mode, use
  2084. @lisp
  2085. (add-hook 'message-mode-hook 'turn-on-orgtbl)
  2086. @end lisp
  2087. Furthermore, with some special setup, it is possible to maintain tables
  2088. in arbitrary syntax with Orgtbl mode. For example, it is possible to
  2089. construct @LaTeX{} tables with the underlying ease and power of
  2090. Orgtbl mode, including spreadsheet capabilities. For details, see
  2091. @ref{Tables in arbitrary syntax}.
  2092. @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
  2093. @section The spreadsheet
  2094. @cindex calculations, in tables
  2095. @cindex spreadsheet capabilities
  2096. @cindex @file{calc} package
  2097. The table editor makes use of the Emacs @file{calc} package to implement
  2098. spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
  2099. derive fields from other fields. While fully featured, Org's implementation
  2100. is not identical to other spreadsheets. For example, Org knows the concept
  2101. of a @emph{column formula} that will be applied to all non-header fields in a
  2102. column without having to copy the formula to each relevant field. There is
  2103. also a formula debugger, and a formula editor with features for highlighting
  2104. fields in the table corresponding to the references at the point in the
  2105. formula, moving these references by arrow keys
  2106. @menu
  2107. * References:: How to refer to another field or range
  2108. * Formula syntax for Calc:: Using Calc to compute stuff
  2109. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  2110. * Durations and time values:: How to compute durations and time values
  2111. * Field and range formulas:: Formula for specific (ranges of) fields
  2112. * Column formulas:: Formulas valid for an entire column
  2113. * Lookup functions:: Lookup functions for searching tables
  2114. * Editing and debugging formulas:: Fixing formulas
  2115. * Updating the table:: Recomputing all dependent fields
  2116. * Advanced features:: Field and column names, parameters and automatic recalc
  2117. @end menu
  2118. @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
  2119. @subsection References
  2120. @cindex references
  2121. To compute fields in the table from other fields, formulas must
  2122. reference other fields or ranges. In Org, fields can be referenced
  2123. by name, by absolute coordinates, and by relative coordinates. To find
  2124. out what the coordinates of a field are, press @kbd{C-c ?} in that
  2125. field, or press @kbd{C-c @}} to toggle the display of a grid.
  2126. @subsubheading Field references
  2127. @cindex field references
  2128. @cindex references, to fields
  2129. Formulas can reference the value of another field in two ways. Like in
  2130. any other spreadsheet, you may reference fields with a letter/number
  2131. combination like @code{B3}, meaning the 2nd field in the 3rd row.
  2132. @vindex org-table-use-standard-references
  2133. However, Org prefers@footnote{Org will understand references typed by the
  2134. user as @samp{B4}, but it will not use this syntax when offering a formula
  2135. for editing. You can customize this behavior using the option
  2136. @var{org-table-use-standard-references}.} to use another, more general
  2137. representation that looks like this:
  2138. @example
  2139. @@@var{row}$@var{column}
  2140. @end example
  2141. Column specifications can be absolute like @code{$1},
  2142. @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
  2143. column of the field which is being computed) like @code{$+1} or @code{$-2}.
  2144. @code{$<} and @code{$>} are immutable references to the first and last
  2145. column, respectively, and you can use @code{$>>>} to indicate the third
  2146. column from the right.
  2147. The row specification only counts data lines and ignores horizontal separator
  2148. lines (hlines). Like with columns, you can use absolute row numbers
  2149. @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
  2150. current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
  2151. immutable references the first and last@footnote{For backward compatibility
  2152. you can also use special names like @code{$LR5} and @code{$LR12} to refer in
  2153. a stable way to the 5th and 12th field in the last row of the table.
  2154. However, this syntax is deprecated, it should not be used for new documents.
  2155. Use @code{@@>$} instead.} row in the table, respectively. You may also
  2156. specify the row relative to one of the hlines: @code{@@I} refers to the first
  2157. hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
  2158. line above the current line, @code{@@+I} to the first such line below the
  2159. current line. You can also write @code{@@III+2} which is the second data line
  2160. after the third hline in the table.
  2161. @code{@@0} and @code{$0} refer to the current row and column, respectively,
  2162. i.e., to the row/column for the field being computed. Also, if you omit
  2163. either the column or the row part of the reference, the current row/column is
  2164. implied.
  2165. Org's references with @emph{unsigned} numbers are fixed references
  2166. in the sense that if you use the same reference in the formula for two
  2167. different fields, the same field will be referenced each time.
  2168. Org's references with @emph{signed} numbers are floating
  2169. references because the same reference operator can reference different
  2170. fields depending on the field being calculated by the formula.
  2171. Here are a few examples:
  2172. @example
  2173. @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
  2174. $5 @r{column 5 in the current row (same as @code{E&})}
  2175. @@2 @r{current column, row 2}
  2176. @@-1$-3 @r{the field one row up, three columns to the left}
  2177. @@-I$2 @r{field just under hline above current row, column 2}
  2178. @@>$5 @r{field in the last row, in column 5}
  2179. @end example
  2180. @subsubheading Range references
  2181. @cindex range references
  2182. @cindex references, to ranges
  2183. You may reference a rectangular range of fields by specifying two field
  2184. references connected by two dots @samp{..}. If both fields are in the
  2185. current row, you may simply use @samp{$2..$7}, but if at least one field
  2186. is in a different row, you need to use the general @code{@@row$column}
  2187. format at least for the first field (i.e the reference must start with
  2188. @samp{@@} in order to be interpreted correctly). Examples:
  2189. @example
  2190. $1..$3 @r{first three fields in the current row}
  2191. $P..$Q @r{range, using column names (see under Advanced)}
  2192. $<<<..$>> @r{start in third column, continue to the one but last}
  2193. @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
  2194. @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left}
  2195. @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
  2196. @end example
  2197. @noindent Range references return a vector of values that can be fed
  2198. into Calc vector functions. Empty fields in ranges are normally suppressed,
  2199. so that the vector contains only the non-empty fields. For other options
  2200. with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
  2201. for Calc}.
  2202. @subsubheading Field coordinates in formulas
  2203. @cindex field coordinates
  2204. @cindex coordinates, of field
  2205. @cindex row, of field coordinates
  2206. @cindex column, of field coordinates
  2207. For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
  2208. get the row or column number of the field where the formula result goes.
  2209. The traditional Lisp formula equivalents are @code{org-table-current-dline}
  2210. and @code{org-table-current-column}. Examples:
  2211. @example
  2212. if(@@# % 2, $#, string("")) @r{column number on odd lines only}
  2213. $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
  2214. @r{column 3 of the current table}
  2215. @end example
  2216. @noindent For the second example, table FOO must have at least as many rows
  2217. as the current table. Note that this is inefficient@footnote{The computation time scales as
  2218. O(N^2) because table FOO is parsed for each field to be copied.} for large
  2219. number of rows.
  2220. @subsubheading Named references
  2221. @cindex named references
  2222. @cindex references, named
  2223. @cindex name, of column or field
  2224. @cindex constants, in calculations
  2225. @cindex #+CONSTANTS
  2226. @vindex org-table-formula-constants
  2227. @samp{$name} is interpreted as the name of a column, parameter or
  2228. constant. Constants are defined globally through the option
  2229. @var{org-table-formula-constants}, and locally (for the file) through a
  2230. line like
  2231. @example
  2232. #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
  2233. @end example
  2234. @noindent
  2235. @vindex constants-unit-system
  2236. @pindex constants.el
  2237. Also properties (@pxref{Properties and Columns}) can be used as
  2238. constants in table formulas: for a property @samp{:Xyz:} use the name
  2239. @samp{$PROP_Xyz}, and the property will be searched in the current
  2240. outline entry and in the hierarchy above it. If you have the
  2241. @file{constants.el} package, it will also be used to resolve constants,
  2242. including natural constants like @samp{$h} for Planck's constant, and
  2243. units like @samp{$km} for kilometers@footnote{@file{constants.el} can
  2244. supply the values of constants in two different unit systems, @code{SI}
  2245. and @code{cgs}. Which one is used depends on the value of the variable
  2246. @code{constants-unit-system}. You can use the @code{#+STARTUP} options
  2247. @code{constSI} and @code{constcgs} to set this value for the current
  2248. buffer.}. Column names and parameters can be specified in special table
  2249. lines. These are described below, see @ref{Advanced features}. All
  2250. names must start with a letter, and further consist of letters and
  2251. numbers.
  2252. @subsubheading Remote references
  2253. @cindex remote references
  2254. @cindex references, remote
  2255. @cindex references, to a different table
  2256. @cindex name, of column or field
  2257. @cindex constants, in calculations
  2258. @cindex #+NAME, for table
  2259. You may also reference constants, fields and ranges from a different table,
  2260. either in the current file or even in a different file. The syntax is
  2261. @example
  2262. remote(NAME-OR-ID,REF)
  2263. @end example
  2264. @noindent
  2265. where NAME can be the name of a table in the current file as set by a
  2266. @code{#+NAME: Name} line before the table. It can also be the ID of an
  2267. entry, even in a different file, and the reference then refers to the first
  2268. table in that entry. REF is an absolute field or range reference as
  2269. described above for example @code{@@3$3} or @code{$somename}, valid in the
  2270. referenced table.
  2271. @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
  2272. @subsection Formula syntax for Calc
  2273. @cindex formula syntax, Calc
  2274. @cindex syntax, of formulas
  2275. A formula can be any algebraic expression understood by the Emacs
  2276. @file{Calc} package. @b{Note that @file{calc} has the
  2277. non-standard convention that @samp{/} has lower precedence than
  2278. @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
  2279. evaluation by @code{calc-eval} (@pxref{Calling Calc from
  2280. Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc, GNU
  2281. Emacs Calc Manual}),
  2282. variable substitution takes place according to the rules described above.
  2283. @cindex vectors, in table calculations
  2284. The range vectors can be directly fed into the Calc vector functions
  2285. like @samp{vmean} and @samp{vsum}.
  2286. @cindex format specifier
  2287. @cindex mode, for @file{calc}
  2288. @vindex org-calc-default-modes
  2289. A formula can contain an optional mode string after a semicolon. This
  2290. string consists of flags to influence Calc and other modes during
  2291. execution. By default, Org uses the standard Calc modes (precision
  2292. 12, angular units degrees, fraction and symbolic modes off). The display
  2293. format, however, has been changed to @code{(float 8)} to keep tables
  2294. compact. The default settings can be configured using the option
  2295. @var{org-calc-default-modes}.
  2296. @noindent List of modes:
  2297. @table @asis
  2298. @item @code{p20}
  2299. Set the internal Calc calculation precision to 20 digits.
  2300. @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
  2301. Normal, scientific, engineering or fixed format of the result of Calc passed
  2302. back to Org. Calc formatting is unlimited in precision as long as the Calc
  2303. calculation precision is greater.
  2304. @item @code{D}, @code{R}
  2305. Degree and radian angle modes of Calc.
  2306. @item @code{F}, @code{S}
  2307. Fraction and symbolic modes of Calc.
  2308. @item @code{T}, @code{t}
  2309. Duration computations in Calc or Lisp, @pxref{Durations and time values}.
  2310. @item @code{E}
  2311. If and how to consider empty fields. Without @samp{E} empty fields in range
  2312. references are suppressed so that the Calc vector or Lisp list contains only
  2313. the non-empty fields. With @samp{E} the empty fields are kept. For empty
  2314. fields in ranges or empty field references the value @samp{nan} (not a
  2315. number) is used in Calc formulas and the empty string is used for Lisp
  2316. formulas. Add @samp{N} to use 0 instead for both formula types. For the
  2317. value of a field the mode @samp{N} has higher precedence than @samp{E}.
  2318. @item @code{N}
  2319. Interpret all fields as numbers, use 0 for non-numbers. See the next section
  2320. to see how this is essential for computations with Lisp formulas. In Calc
  2321. formulas it is used only occasionally because there number strings are
  2322. already interpreted as numbers without @samp{N}.
  2323. @item @code{L}
  2324. Literal, for Lisp formulas only. See the next section.
  2325. @end table
  2326. @noindent
  2327. Unless you use large integer numbers or high-precision-calculation and
  2328. -display for floating point numbers you may alternatively provide a
  2329. @samp{printf} format specifier to reformat the Calc result after it has been
  2330. passed back to Org instead of letting Calc already do the
  2331. formatting@footnote{The @samp{printf} reformatting is limited in precision
  2332. because the value passed to it is converted into an @samp{integer} or
  2333. @samp{double}. The @samp{integer} is limited in size by truncating the
  2334. signed value to 32 bits. The @samp{double} is limited in precision to 64
  2335. bits overall which leaves approximately 16 significant decimal digits.}. A
  2336. few examples:
  2337. @example
  2338. $1+$2 @r{Sum of first and second field}
  2339. $1+$2;%.2f @r{Same, format result to two decimals}
  2340. exp($2)+exp($1) @r{Math functions can be used}
  2341. $0;%.1f @r{Reformat current cell to 1 decimal}
  2342. ($3-32)*5/9 @r{Degrees F -> C conversion}
  2343. $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
  2344. tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
  2345. sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
  2346. taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
  2347. @end example
  2348. Calc also contains a complete set of logical operations, (@pxref{Logical
  2349. Operations, , Logical Operations, calc, GNU Emacs Calc Manual}). For example
  2350. @table @code
  2351. @item if($1 < 20, teen, string(""))
  2352. "teen" if age $1 is less than 20, else the Org table result field is set to
  2353. empty with the empty string.
  2354. @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E
  2355. Sum of the first two columns. When at least one of the input fields is empty
  2356. the Org table result field is set to empty.
  2357. @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
  2358. Mean value of a range unless there is any empty field. Every field in the
  2359. range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
  2360. in @samp{nan}. Then @samp{typeof == 12} detects the @samp{nan} from
  2361. @samp{vmean} and the Org table result field is set to empty. Use this when
  2362. the sample set is expected to never have missing values.
  2363. @item if("$1..$7" == "[]", string(""), vmean($1..$7))
  2364. Mean value of a range with empty fields skipped. Every field in the range
  2365. that is empty is skipped. When all fields in the range are empty the mean
  2366. value is not defined and the Org table result field is set to empty. Use
  2367. this when the sample set can have a variable size.
  2368. @item vmean($1..$7); EN
  2369. To complete the example before: Mean value of a range with empty fields
  2370. counting as samples with value 0. Use this only when incomplete sample sets
  2371. should be padded with 0 to the full size.
  2372. @end table
  2373. You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
  2374. and use them in formula syntax for Calc.
  2375. @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
  2376. @subsection Emacs Lisp forms as formulas
  2377. @cindex Lisp forms, as table formulas
  2378. It is also possible to write a formula in Emacs Lisp. This can be useful
  2379. for string manipulation and control structures, if Calc's functionality is
  2380. not enough.
  2381. If a formula starts with a single-quote followed by an opening parenthesis,
  2382. then it is evaluated as a Lisp form. The evaluation should return either a
  2383. string or a number. Just as with @file{calc} formulas, you can specify modes
  2384. and a printf format after a semicolon.
  2385. With Emacs Lisp forms, you need to be conscious about the way field
  2386. references are interpolated into the form. By default, a reference will be
  2387. interpolated as a Lisp string (in double-quotes) containing the field. If
  2388. you provide the @samp{N} mode switch, all referenced elements will be numbers
  2389. (non-number fields will be zero) and interpolated as Lisp numbers, without
  2390. quotes. If you provide the @samp{L} flag, all fields will be interpolated
  2391. literally, without quotes. I.e., if you want a reference to be interpreted
  2392. as a string by the Lisp form, enclose the reference operator itself in
  2393. double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
  2394. fields, so you can embed them in list or vector syntax.
  2395. Here are a few examples---note how the @samp{N} mode is used when we do
  2396. computations in Lisp:
  2397. @table @code
  2398. @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
  2399. Swap the first two characters of the content of column 1.
  2400. @item '(+ $1 $2);N
  2401. Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
  2402. @item '(apply '+ '($1..$4));N
  2403. Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
  2404. @end table
  2405. @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
  2406. @subsection Durations and time values
  2407. @cindex Duration, computing
  2408. @cindex Time, computing
  2409. @vindex org-table-duration-custom-format
  2410. If you want to compute time values use the @code{T} flag, either in Calc
  2411. formulas or Elisp formulas:
  2412. @example
  2413. @group
  2414. | Task 1 | Task 2 | Total |
  2415. |---------+----------+----------|
  2416. | 2:12 | 1:47 | 03:59:00 |
  2417. | 3:02:20 | -2:07:00 | 0.92 |
  2418. #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
  2419. @end group
  2420. @end example
  2421. Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
  2422. are optional. With the @code{T} flag, computed durations will be displayed
  2423. as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
  2424. computed durations will be displayed according to the value of the option
  2425. @var{org-table-duration-custom-format}, which defaults to @code{'hours} and
  2426. will display the result as a fraction of hours (see the second formula in the
  2427. example above).
  2428. Negative duration values can be manipulated as well, and integers will be
  2429. considered as seconds in addition and subtraction.
  2430. @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
  2431. @subsection Field and range formulas
  2432. @cindex field formula
  2433. @cindex range formula
  2434. @cindex formula, for individual table field
  2435. @cindex formula, for range of fields
  2436. To assign a formula to a particular field, type it directly into the field,
  2437. preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
  2438. @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
  2439. the formula will be stored as the formula for this field, evaluated, and the
  2440. current field will be replaced with the result.
  2441. @cindex #+TBLFM
  2442. Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
  2443. below the table. If you type the equation in the 4th field of the 3rd data
  2444. line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
  2445. inserting/deleting/swapping column and rows with the appropriate commands,
  2446. @i{absolute references} (but not relative ones) in stored formulas are
  2447. modified in order to still reference the same field. To avoid this from
  2448. happening, in particular in range references, anchor ranges at the table
  2449. borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
  2450. using the @code{@@I} notation. Automatic adaptation of field references does
  2451. of course not happen if you edit the table structure with normal editing
  2452. commands---then you must fix the equations yourself.
  2453. Instead of typing an equation into the field, you may also use the following
  2454. command
  2455. @table @kbd
  2456. @orgcmd{C-u C-c =,org-table-eval-formula}
  2457. Install a new formula for the current field. The command prompts for a
  2458. formula with default taken from the @samp{#+TBLFM:} line, applies
  2459. it to the current field, and stores it.
  2460. @end table
  2461. The left-hand side of a formula can also be a special expression in order to
  2462. assign the formula to a number of different fields. There is no keyboard
  2463. shortcut to enter such range formulas. To add them, use the formula editor
  2464. (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
  2465. directly.
  2466. @table @code
  2467. @item $2=
  2468. Column formula, valid for the entire column. This is so common that Org
  2469. treats these formulas in a special way, see @ref{Column formulas}.
  2470. @item @@3=
  2471. Row formula, applies to all fields in the specified row. @code{@@>=} means
  2472. the last row.
  2473. @item @@1$2..@@4$3=
  2474. Range formula, applies to all fields in the given rectangular range. This
  2475. can also be used to assign a formula to some but not all fields in a row.
  2476. @item $name=
  2477. Named field, see @ref{Advanced features}.
  2478. @end table
  2479. @node Column formulas, Lookup functions, Field and range formulas, The spreadsheet
  2480. @subsection Column formulas
  2481. @cindex column formula
  2482. @cindex formula, for table column
  2483. When you assign a formula to a simple column reference like @code{$3=}, the
  2484. same formula will be used in all fields of that column, with the following
  2485. very convenient exceptions: (i) If the table contains horizontal separator
  2486. hlines with rows above and below, everything before the first such hline is
  2487. considered part of the table @emph{header} and will not be modified by column
  2488. formulas. Therefore a header is mandatory when you use column formulas and
  2489. want to add hlines to group rows, like for example to separate a total row at
  2490. the bottom from the summand rows above. (ii) Fields that already get a value
  2491. from a field/range formula will be left alone by column formulas. These
  2492. conditions make column formulas very easy to use.
  2493. To assign a formula to a column, type it directly into any field in the
  2494. column, preceded by an equal sign, like @samp{=$1+$2}. When you press
  2495. @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
  2496. the formula will be stored as the formula for the current column, evaluated
  2497. and the current field replaced with the result. If the field contains only
  2498. @samp{=}, the previously stored formula for this column is used. For each
  2499. column, Org will only remember the most recently used formula. In the
  2500. @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
  2501. left-hand side of a column formula can not be the name of column, it must be
  2502. the numeric column reference or @code{$>}.
  2503. Instead of typing an equation into the field, you may also use the
  2504. following command:
  2505. @table @kbd
  2506. @orgcmd{C-c =,org-table-eval-formula}
  2507. Install a new formula for the current column and replace current field with
  2508. the result of the formula. The command prompts for a formula, with default
  2509. taken from the @samp{#+TBLFM} line, applies it to the current field and
  2510. stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
  2511. will apply it to that many consecutive fields in the current column.
  2512. @end table
  2513. @node Lookup functions, Editing and debugging formulas, Column formulas, The spreadsheet
  2514. @subsection Lookup functions
  2515. @cindex lookup functions in tables
  2516. @cindex table lookup functions
  2517. Org has three predefined Emacs Lisp functions for lookups in tables.
  2518. @table @code
  2519. @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
  2520. @findex org-lookup-first
  2521. Searches for the first element @code{S} in list @code{S-LIST} for which
  2522. @lisp
  2523. (PREDICATE VAL S)
  2524. @end lisp
  2525. is @code{t}; returns the value from the corresponding position in list
  2526. @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
  2527. parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
  2528. order as the corresponding parameters are in the call to
  2529. @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
  2530. @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
  2531. is returned.
  2532. @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
  2533. @findex org-lookup-last
  2534. Similar to @code{org-lookup-first} above, but searches for the @i{last}
  2535. element for which @code{PREDICATE} is @code{t}.
  2536. @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
  2537. @findex org-lookup-all
  2538. Similar to @code{org-lookup-first}, but searches for @i{all} elements for
  2539. which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
  2540. values. This function can not be used by itself in a formula, because it
  2541. returns a list of values. However, powerful lookups can be built when this
  2542. function is combined with other Emacs Lisp functions.
  2543. @end table
  2544. If the ranges used in these functions contain empty fields, the @code{E} mode
  2545. for the formula should usually be specified: otherwise empty fields will not be
  2546. included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
  2547. in an incorrect mapping from an element of @code{S-LIST} to the corresponding
  2548. element of @code{R-LIST}.
  2549. These three functions can be used to implement associative arrays, count
  2550. matching cells, rank results, group data etc. For practical examples
  2551. see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
  2552. tutorial on Worg}.
  2553. @node Editing and debugging formulas, Updating the table, Lookup functions, The spreadsheet
  2554. @subsection Editing and debugging formulas
  2555. @cindex formula editing
  2556. @cindex editing, of table formulas
  2557. @vindex org-table-use-standard-references
  2558. You can edit individual formulas in the minibuffer or directly in the field.
  2559. Org can also prepare a special buffer with all active formulas of a table.
  2560. When offering a formula for editing, Org converts references to the standard
  2561. format (like @code{B3} or @code{D&}) if possible. If you prefer to only work
  2562. with the internal format (like @code{@@3$2} or @code{$4}), configure the
  2563. option @var{org-table-use-standard-references}.
  2564. @table @kbd
  2565. @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
  2566. Edit the formula associated with the current column/field in the
  2567. minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
  2568. @orgcmd{C-u C-u C-c =,org-table-eval-formula}
  2569. Re-insert the active formula (either a
  2570. field formula, or a column formula) into the current field, so that you
  2571. can edit it directly in the field. The advantage over editing in the
  2572. minibuffer is that you can use the command @kbd{C-c ?}.
  2573. @orgcmd{C-c ?,org-table-field-info}
  2574. While editing a formula in a table field, highlight the field(s)
  2575. referenced by the reference at the cursor position in the formula.
  2576. @kindex C-c @}
  2577. @findex org-table-toggle-coordinate-overlays
  2578. @item C-c @}
  2579. Toggle the display of row and column numbers for a table, using overlays
  2580. (@command{org-table-toggle-coordinate-overlays}). These are updated each
  2581. time the table is aligned; you can force it with @kbd{C-c C-c}.
  2582. @kindex C-c @{
  2583. @findex org-table-toggle-formula-debugger
  2584. @item C-c @{
  2585. Toggle the formula debugger on and off
  2586. (@command{org-table-toggle-formula-debugger}). See below.
  2587. @orgcmd{C-c ',org-table-edit-formulas}
  2588. Edit all formulas for the current table in a special buffer, where the
  2589. formulas will be displayed one per line. If the current field has an
  2590. active formula, the cursor in the formula editor will mark it.
  2591. While inside the special buffer, Org will automatically highlight
  2592. any field or range reference at the cursor position. You may edit,
  2593. remove and add formulas, and use the following commands:
  2594. @table @kbd
  2595. @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
  2596. Exit the formula editor and store the modified formulas. With @kbd{C-u}
  2597. prefix, also apply the new formulas to the entire table.
  2598. @orgcmd{C-c C-q,org-table-fedit-abort}
  2599. Exit the formula editor without installing changes.
  2600. @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
  2601. Toggle all references in the formula editor between standard (like
  2602. @code{B3}) and internal (like @code{@@3$2}).
  2603. @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
  2604. Pretty-print or indent Lisp formula at point. When in a line containing
  2605. a Lisp formula, format the formula according to Emacs Lisp rules.
  2606. Another @key{TAB} collapses the formula back again. In the open
  2607. formula, @key{TAB} re-indents just like in Emacs Lisp mode.
  2608. @orgcmd{M-@key{TAB},lisp-complete-symbol}
  2609. Complete Lisp symbols, just like in Emacs Lisp mode.
  2610. @kindex S-@key{up}
  2611. @kindex S-@key{down}
  2612. @kindex S-@key{left}
  2613. @kindex S-@key{right}
  2614. @findex org-table-fedit-ref-up
  2615. @findex org-table-fedit-ref-down
  2616. @findex org-table-fedit-ref-left
  2617. @findex org-table-fedit-ref-right
  2618. @item S-@key{up}/@key{down}/@key{left}/@key{right}
  2619. Shift the reference at point. For example, if the reference is
  2620. @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
  2621. This also works for relative references and for hline references.
  2622. @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
  2623. Move the test line for column formulas in the Org buffer up and
  2624. down.
  2625. @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
  2626. Scroll the window displaying the table.
  2627. @kindex C-c @}
  2628. @findex org-table-toggle-coordinate-overlays
  2629. @item C-c @}
  2630. Turn the coordinate grid in the table on and off.
  2631. @end table
  2632. @end table
  2633. Making a table field blank does not remove the formula associated with
  2634. the field, because that is stored in a different line (the @samp{#+TBLFM}
  2635. line)---during the next recalculation the field will be filled again.
  2636. To remove a formula from a field, you have to give an empty reply when
  2637. prompted for the formula, or to edit the @samp{#+TBLFM} line.
  2638. @kindex C-c C-c
  2639. You may edit the @samp{#+TBLFM} directly and re-apply the changed
  2640. equations with @kbd{C-c C-c} in that line or with the normal
  2641. recalculation commands in the table.
  2642. @anchor{Using multiple #+TBLFM lines}
  2643. @subsubheading Using multiple #+TBLFM lines
  2644. @cindex #+TBLFM line, multiple
  2645. @cindex #+TBLFM
  2646. @cindex #+TBLFM, switching
  2647. @kindex C-c C-c
  2648. You may apply the formula temporarily. This is useful when you
  2649. switch the formula. Place multiple @samp{#+TBLFM} lines right
  2650. after the table, and then press @kbd{C-c C-c} on the formula to
  2651. apply. Here is an example:
  2652. @example
  2653. | x | y |
  2654. |---+---|
  2655. | 1 | |
  2656. | 2 | |
  2657. #+TBLFM: $2=$1*1
  2658. #+TBLFM: $2=$1*2
  2659. @end example
  2660. @noindent
  2661. Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
  2662. @example
  2663. | x | y |
  2664. |---+---|
  2665. | 1 | 2 |
  2666. | 2 | 4 |
  2667. #+TBLFM: $2=$1*1
  2668. #+TBLFM: $2=$1*2
  2669. @end example
  2670. @noindent
  2671. Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
  2672. will get the following result of applying only the first @samp{#+TBLFM} line.
  2673. @example
  2674. | x | y |
  2675. |---+---|
  2676. | 1 | 1 |
  2677. | 2 | 2 |
  2678. #+TBLFM: $2=$1*1
  2679. #+TBLFM: $2=$1*2
  2680. @end example
  2681. @subsubheading Debugging formulas
  2682. @cindex formula debugging
  2683. @cindex debugging, of table formulas
  2684. When the evaluation of a formula leads to an error, the field content
  2685. becomes the string @samp{#ERROR}. If you would like see what is going
  2686. on during variable substitution and calculation in order to find a bug,
  2687. turn on formula debugging in the @code{Tbl} menu and repeat the
  2688. calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
  2689. field. Detailed information will be displayed.
  2690. @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
  2691. @subsection Updating the table
  2692. @cindex recomputing table fields
  2693. @cindex updating, table
  2694. Recalculation of a table is normally not automatic, but needs to be
  2695. triggered by a command. See @ref{Advanced features}, for a way to make
  2696. recalculation at least semi-automatic.
  2697. In order to recalculate a line of a table or the entire table, use the
  2698. following commands:
  2699. @table @kbd
  2700. @orgcmd{C-c *,org-table-recalculate}
  2701. Recalculate the current row by first applying the stored column formulas
  2702. from left to right, and all field/range formulas in the current row.
  2703. @c
  2704. @kindex C-u C-c *
  2705. @item C-u C-c *
  2706. @kindex C-u C-c C-c
  2707. @itemx C-u C-c C-c
  2708. Recompute the entire table, line by line. Any lines before the first
  2709. hline are left alone, assuming that these are part of the table header.
  2710. @c
  2711. @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
  2712. Iterate the table by recomputing it until no further changes occur.
  2713. This may be necessary if some computed fields use the value of other
  2714. fields that are computed @i{later} in the calculation sequence.
  2715. @item M-x org-table-recalculate-buffer-tables RET
  2716. @findex org-table-recalculate-buffer-tables
  2717. Recompute all tables in the current buffer.
  2718. @item M-x org-table-iterate-buffer-tables RET
  2719. @findex org-table-iterate-buffer-tables
  2720. Iterate all tables in the current buffer, in order to converge table-to-table
  2721. dependencies.
  2722. @end table
  2723. @node Advanced features, , Updating the table, The spreadsheet
  2724. @subsection Advanced features
  2725. If you want the recalculation of fields to happen automatically, or if you
  2726. want to be able to assign @i{names}@footnote{Such names must start by an
  2727. alphabetic character and use only alphanumeric/underscore characters.} to
  2728. fields and columns, you need to reserve the first column of the table for
  2729. special marking characters.
  2730. @table @kbd
  2731. @orgcmd{C-#,org-table-rotate-recalc-marks}
  2732. Rotate the calculation mark in first column through the states @samp{ },
  2733. @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
  2734. change all marks in the region.
  2735. @end table
  2736. Here is an example of a table that collects exam results of students and
  2737. makes use of these features:
  2738. @example
  2739. @group
  2740. |---+---------+--------+--------+--------+-------+------|
  2741. | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
  2742. |---+---------+--------+--------+--------+-------+------|
  2743. | ! | | P1 | P2 | P3 | Tot | |
  2744. | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
  2745. | ^ | | m1 | m2 | m3 | mt | |
  2746. |---+---------+--------+--------+--------+-------+------|
  2747. | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
  2748. | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
  2749. |---+---------+--------+--------+--------+-------+------|
  2750. | | Average | | | | 25.0 | |
  2751. | ^ | | | | | at | |
  2752. | $ | max=50 | | | | | |
  2753. |---+---------+--------+--------+--------+-------+------|
  2754. #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
  2755. @end group
  2756. @end example
  2757. @noindent @b{Important}: please note that for these special tables,
  2758. recalculating the table with @kbd{C-u C-c *} will only affect rows that
  2759. are marked @samp{#} or @samp{*}, and fields that have a formula assigned
  2760. to the field itself. The column formulas are not applied in rows with
  2761. empty first field.
  2762. @cindex marking characters, tables
  2763. The marking characters have the following meaning:
  2764. @table @samp
  2765. @item !
  2766. The fields in this line define names for the columns, so that you may
  2767. refer to a column as @samp{$Tot} instead of @samp{$6}.
  2768. @item ^
  2769. This row defines names for the fields @emph{above} the row. With such
  2770. a definition, any formula in the table may use @samp{$m1} to refer to
  2771. the value @samp{10}. Also, if you assign a formula to a names field, it
  2772. will be stored as @samp{$name=...}.
  2773. @item _
  2774. Similar to @samp{^}, but defines names for the fields in the row
  2775. @emph{below}.
  2776. @item $
  2777. Fields in this row can define @emph{parameters} for formulas. For
  2778. example, if a field in a @samp{$} row contains @samp{max=50}, then
  2779. formulas in this table can refer to the value 50 using @samp{$max}.
  2780. Parameters work exactly like constants, only that they can be defined on
  2781. a per-table basis.
  2782. @item #
  2783. Fields in this row are automatically recalculated when pressing
  2784. @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
  2785. is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
  2786. lines will be left alone by this command.
  2787. @item *
  2788. Selects this line for global recalculation with @kbd{C-u C-c *}, but
  2789. not for automatic recalculation. Use this when automatic
  2790. recalculation slows down editing too much.
  2791. @item @w{ }
  2792. Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
  2793. All lines that should be recalculated should be marked with @samp{#}
  2794. or @samp{*}.
  2795. @item /
  2796. Do not export this line. Useful for lines that contain the narrowing
  2797. @samp{<N>} markers or column group markers.
  2798. @end table
  2799. Finally, just to whet your appetite for what can be done with the
  2800. fantastic @file{calc.el} package, here is a table that computes the Taylor
  2801. series of degree @code{n} at location @code{x} for a couple of
  2802. functions.
  2803. @example
  2804. @group
  2805. |---+-------------+---+-----+--------------------------------------|
  2806. | | Func | n | x | Result |
  2807. |---+-------------+---+-----+--------------------------------------|
  2808. | # | exp(x) | 1 | x | 1 + x |
  2809. | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
  2810. | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
  2811. | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
  2812. | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
  2813. | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
  2814. |---+-------------+---+-----+--------------------------------------|
  2815. #+TBLFM: $5=taylor($2,$4,$3);n3
  2816. @end group
  2817. @end example
  2818. @node Org-Plot, , The spreadsheet, Tables
  2819. @section Org-Plot
  2820. @cindex graph, in tables
  2821. @cindex plot tables using Gnuplot
  2822. @cindex #+PLOT
  2823. Org-Plot can produce 2D and 3D graphs of information stored in org tables
  2824. using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
  2825. @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure
  2826. that you have both Gnuplot and Gnuplot mode installed on your system, then
  2827. call @code{org-plot/gnuplot} on the following table.
  2828. @example
  2829. @group
  2830. #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
  2831. | Sede | Max cites | H-index |
  2832. |-----------+-----------+---------|
  2833. | Chile | 257.72 | 21.39 |
  2834. | Leeds | 165.77 | 19.68 |
  2835. | Sao Paolo | 71.00 | 11.50 |
  2836. | Stockholm | 134.19 | 14.33 |
  2837. | Morelia | 257.56 | 17.67 |
  2838. @end group
  2839. @end example
  2840. Notice that Org Plot is smart enough to apply the table's headers as labels.
  2841. Further control over the labels, type, content, and appearance of plots can
  2842. be exercised through the @code{#+PLOT:} lines preceding a table. See below
  2843. for a complete list of Org-plot options. For more information and examples
  2844. see the Org-plot tutorial at
  2845. @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
  2846. @subsubheading Plot Options
  2847. @table @code
  2848. @item set
  2849. Specify any @command{gnuplot} option to be set when graphing.
  2850. @item title
  2851. Specify the title of the plot.
  2852. @item ind
  2853. Specify which column of the table to use as the @code{x} axis.
  2854. @item deps
  2855. Specify the columns to graph as a Lisp style list, surrounded by parentheses
  2856. and separated by spaces for example @code{dep:(3 4)} to graph the third and
  2857. fourth columns (defaults to graphing all other columns aside from the @code{ind}
  2858. column).
  2859. @item type
  2860. Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
  2861. @item with
  2862. Specify a @code{with} option to be inserted for every col being plotted
  2863. (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
  2864. Defaults to @code{lines}.
  2865. @item file
  2866. If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
  2867. @item labels
  2868. List of labels to be used for the @code{deps} (defaults to the column headers
  2869. if they exist).
  2870. @item line
  2871. Specify an entire line to be inserted in the Gnuplot script.
  2872. @item map
  2873. When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
  2874. flat mapping rather than a @code{3d} slope.
  2875. @item timefmt
  2876. Specify format of Org mode timestamps as they will be parsed by Gnuplot.
  2877. Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
  2878. @item script
  2879. If you want total control, you can specify a script file (place the file name
  2880. between double-quotes) which will be used to plot. Before plotting, every
  2881. instance of @code{$datafile} in the specified script will be replaced with
  2882. the path to the generated data file. Note: even if you set this option, you
  2883. may still want to specify the plot type, as that can impact the content of
  2884. the data file.
  2885. @end table
  2886. @node Hyperlinks, TODO Items, Tables, Top
  2887. @chapter Hyperlinks
  2888. @cindex hyperlinks
  2889. Like HTML, Org provides links inside a file, external links to
  2890. other files, Usenet articles, emails, and much more.
  2891. @menu
  2892. * Link format:: How links in Org are formatted
  2893. * Internal links:: Links to other places in the current file
  2894. * External links:: URL-like links to the world
  2895. * Handling links:: Creating, inserting and following
  2896. * Using links outside Org:: Linking from my C source code?
  2897. * Link abbreviations:: Shortcuts for writing complex links
  2898. * Search options:: Linking to a specific location
  2899. * Custom searches:: When the default search is not enough
  2900. @end menu
  2901. @node Link format, Internal links, Hyperlinks, Hyperlinks
  2902. @section Link format
  2903. @cindex link format
  2904. @cindex format, of links
  2905. Org will recognize plain URL-like links and activate them as
  2906. clickable links. The general link format, however, looks like this:
  2907. @example
  2908. [[link][description]] @r{or alternatively} [[link]]
  2909. @end example
  2910. @noindent
  2911. Once a link in the buffer is complete (all brackets present), Org
  2912. will change the display so that @samp{description} is displayed instead
  2913. of @samp{[[link][description]]} and @samp{link} is displayed instead of
  2914. @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
  2915. which by default is an underlined face. You can directly edit the
  2916. visible part of a link. Note that this can be either the @samp{link}
  2917. part (if there is no description) or the @samp{description} part. To
  2918. edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
  2919. cursor on the link.
  2920. If you place the cursor at the beginning or just behind the end of the
  2921. displayed text and press @key{BACKSPACE}, you will remove the
  2922. (invisible) bracket at that location. This makes the link incomplete
  2923. and the internals are again displayed as plain text. Inserting the
  2924. missing bracket hides the link internals again. To show the
  2925. internal structure of all links, use the menu entry
  2926. @code{Org->Hyperlinks->Literal links}.
  2927. @node Internal links, External links, Link format, Hyperlinks
  2928. @section Internal links
  2929. @cindex internal links
  2930. @cindex links, internal
  2931. @cindex targets, for links
  2932. @cindex property, CUSTOM_ID
  2933. If the link does not look like a URL, it is considered to be internal in the
  2934. current file. The most important case is a link like
  2935. @samp{[[#my-custom-id]]} which will link to the entry with the
  2936. @code{CUSTOM_ID} property @samp{my-custom-id}. You are responsible yourself
  2937. to make sure these custom IDs are unique in a file.
  2938. Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
  2939. lead to a text search in the current file.
  2940. The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
  2941. or with a mouse click (@pxref{Handling links}). Links to custom IDs will
  2942. point to the corresponding headline. The preferred match for a text link is
  2943. a @i{dedicated target}: the same string in double angular brackets, like
  2944. @samp{<<My Target>>}.
  2945. @cindex #+NAME
  2946. If no dedicated target exists, the link will then try to match the exact name
  2947. of an element within the buffer. Naming is done with the @code{#+NAME}
  2948. keyword, which has to be put the line before the element it refers to, as in
  2949. the following example
  2950. @example
  2951. #+NAME: My Target
  2952. | a | table |
  2953. |----+------------|
  2954. | of | four cells |
  2955. @end example
  2956. If none of the above succeeds, Org will search for a headline that is exactly
  2957. the link text but may also include a TODO keyword and tags@footnote{To insert
  2958. a link targeting a headline, in-buffer completion can be used. Just type
  2959. a star followed by a few optional letters into the buffer and press
  2960. @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
  2961. completions.}.
  2962. During export, internal links will be used to mark objects and assign them
  2963. a number. Marked objects will then be referenced by links pointing to them.
  2964. In particular, links without a description will appear as the number assigned
  2965. to the marked object@footnote{When targeting a @code{#+NAME} keyword,
  2966. @code{#+CAPTION} keyword is mandatory in order to get proper numbering
  2967. (@pxref{Images and tables}).}. In the following excerpt from an Org buffer
  2968. @example
  2969. - one item
  2970. - <<target>>another item
  2971. Here we refer to item [[target]].
  2972. @end example
  2973. @noindent
  2974. The last sentence will appear as @samp{Here we refer to item 2} when
  2975. exported.
  2976. In non-Org files, the search will look for the words in the link text. In
  2977. the above example the search would be for @samp{my target}.
  2978. Following a link pushes a mark onto Org's own mark ring. You can
  2979. return to the previous position with @kbd{C-c &}. Using this command
  2980. several times in direct succession goes back to positions recorded
  2981. earlier.
  2982. @menu
  2983. * Radio targets:: Make targets trigger links in plain text
  2984. @end menu
  2985. @node Radio targets, , Internal links, Internal links
  2986. @subsection Radio targets
  2987. @cindex radio targets
  2988. @cindex targets, radio
  2989. @cindex links, radio targets
  2990. Org can automatically turn any occurrences of certain target names
  2991. in normal text into a link. So without explicitly creating a link, the
  2992. text connects to the target radioing its position. Radio targets are
  2993. enclosed by triple angular brackets. For example, a target @samp{<<<My
  2994. Target>>>} causes each occurrence of @samp{my target} in normal text to
  2995. become activated as a link. The Org file is scanned automatically
  2996. for radio targets only when the file is first loaded into Emacs. To
  2997. update the target list during editing, press @kbd{C-c C-c} with the
  2998. cursor on or at a target.
  2999. @node External links, Handling links, Internal links, Hyperlinks
  3000. @section External links
  3001. @cindex links, external
  3002. @cindex external links
  3003. @cindex Gnus links
  3004. @cindex BBDB links
  3005. @cindex IRC links
  3006. @cindex URL links
  3007. @cindex file links
  3008. @cindex RMAIL links
  3009. @cindex MH-E links
  3010. @cindex USENET links
  3011. @cindex SHELL links
  3012. @cindex Info links
  3013. @cindex Elisp links
  3014. Org supports links to files, websites, Usenet and email messages, BBDB
  3015. database entries and links to both IRC conversations and their logs.
  3016. External links are URL-like locators. They start with a short identifying
  3017. string followed by a colon. There can be no space after the colon. The
  3018. following list shows examples for each link type.
  3019. @example
  3020. http://www.astro.uva.nl/~dominik @r{on the web}
  3021. doi:10.1000/182 @r{DOI for an electronic resource}
  3022. file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
  3023. /home/dominik/images/jupiter.jpg @r{same as above}
  3024. file:papers/last.pdf @r{file, relative path}
  3025. ./papers/last.pdf @r{same as above}
  3026. file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
  3027. /myself@@some.where:papers/last.pdf @r{same as above}
  3028. file:sometextfile::NNN @r{file, jump to line number}
  3029. file:projects.org @r{another Org file}
  3030. file:projects.org::some words @r{text search in Org file}@footnote{
  3031. The actual behavior of the search will depend on the value of
  3032. the option @var{org-link-search-must-match-exact-headline}. If its value
  3033. is @code{nil}, then a fuzzy text search will be done. If it is t, then only the
  3034. exact headline will be matched. If the value is @code{'query-to-create},
  3035. then an exact headline will be searched; if it is not found, then the user
  3036. will be queried to create it.}
  3037. file:projects.org::*task title @r{heading search in Org file}
  3038. file+sys:/path/to/file @r{open via OS, like double-click}
  3039. file+emacs:/path/to/file @r{force opening by Emacs}
  3040. docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
  3041. id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
  3042. news:comp.emacs @r{Usenet link}
  3043. mailto:adent@@galaxy.net @r{Mail link}
  3044. mhe:folder @r{MH-E folder link}
  3045. mhe:folder#id @r{MH-E message link}
  3046. rmail:folder @r{RMAIL folder link}
  3047. rmail:folder#id @r{RMAIL message link}
  3048. gnus:group @r{Gnus group link}
  3049. gnus:group#id @r{Gnus article link}
  3050. bbdb:R.*Stallman @r{BBDB link (with regexp)}
  3051. irc:/irc.com/#emacs/bob @r{IRC link}
  3052. info:org#External links @r{Info node link}
  3053. shell:ls *.org @r{A shell command}
  3054. elisp:org-agenda @r{Interactive Elisp command}
  3055. elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
  3056. @end example
  3057. @cindex VM links
  3058. @cindex WANDERLUST links
  3059. On top of these built-in link types, some are available through the
  3060. @code{contrib/} directory (@pxref{Installation}). For example, these links
  3061. to VM or Wanderlust messages are available when you load the corresponding
  3062. libraries from the @code{contrib/} directory:
  3063. @example
  3064. vm:folder @r{VM folder link}
  3065. vm:folder#id @r{VM message link}
  3066. vm://myself@@some.where.org/folder#id @r{VM on remote machine}
  3067. vm-imap:account:folder @r{VM IMAP folder link}
  3068. vm-imap:account:folder#id @r{VM IMAP message link}
  3069. wl:folder @r{WANDERLUST folder link}
  3070. wl:folder#id @r{WANDERLUST message link}
  3071. @end example
  3072. For customizing Org to add new link types @ref{Adding hyperlink types}.
  3073. A link should be enclosed in double brackets and may contain a descriptive
  3074. text to be displayed instead of the URL (@pxref{Link format}), for example:
  3075. @example
  3076. [[http://www.gnu.org/software/emacs/][GNU Emacs]]
  3077. @end example
  3078. @noindent
  3079. If the description is a file name or URL that points to an image, HTML
  3080. export (@pxref{HTML export}) will inline the image as a clickable
  3081. button. If there is no description at all and the link points to an
  3082. image,
  3083. that image will be inlined into the exported HTML file.
  3084. @cindex square brackets, around links
  3085. @cindex plain text external links
  3086. Org also finds external links in the normal text and activates them
  3087. as links. If spaces must be part of the link (for example in
  3088. @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
  3089. about the end of the link, enclose them in square brackets.
  3090. @node Handling links, Using links outside Org, External links, Hyperlinks
  3091. @section Handling links
  3092. @cindex links, handling
  3093. Org provides methods to create a link in the correct syntax, to
  3094. insert it into an Org file, and to follow the link.
  3095. @table @kbd
  3096. @orgcmd{C-c l,org-store-link}
  3097. @cindex storing links
  3098. Store a link to the current location. This is a @emph{global} command (you
  3099. must create the key binding yourself) which can be used in any buffer to
  3100. create a link. The link will be stored for later insertion into an Org
  3101. buffer (see below). What kind of link will be created depends on the current
  3102. buffer:
  3103. @b{Org mode buffers}@*
  3104. For Org files, if there is a @samp{<<target>>} at the cursor, the link points
  3105. to the target. Otherwise it points to the current headline, which will also
  3106. be the description@footnote{If the headline contains a timestamp, it will be
  3107. removed from the link and result in a wrong link---you should avoid putting
  3108. timestamp in the headline.}.
  3109. @vindex org-id-link-to-org-use-id
  3110. @cindex property, CUSTOM_ID
  3111. @cindex property, ID
  3112. If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
  3113. will be stored. In addition or alternatively (depending on the value of
  3114. @var{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
  3115. be created and/or used to construct a link@footnote{The library
  3116. @file{org-id.el} must first be loaded, either through @code{org-customize} by
  3117. enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
  3118. 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will
  3119. potentially create two links: a human-readable from the custom ID, and one
  3120. that is globally unique and works even if the entry is moved from file to
  3121. file. Later, when inserting the link, you need to decide which one to use.
  3122. @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
  3123. Pretty much all Emacs mail clients are supported. The link will point to the
  3124. current article, or, in some GNUS buffers, to the group. The description is
  3125. constructed from the author and the subject.
  3126. @b{Web browsers: W3 and W3M}@*
  3127. Here the link will be the current URL, with the page title as description.
  3128. @b{Contacts: BBDB}@*
  3129. Links created in a BBDB buffer will point to the current entry.
  3130. @b{Chat: IRC}@*
  3131. @vindex org-irc-link-to-logs
  3132. For IRC links, if you set the option @var{org-irc-link-to-logs} to @code{t},
  3133. a @samp{file:/} style link to the relevant point in the logs for the current
  3134. conversation is created. Otherwise an @samp{irc:/} style link to the
  3135. user/channel/server under the point will be stored.
  3136. @b{Other files}@*
  3137. For any other files, the link will point to the file, with a search string
  3138. (@pxref{Search options}) pointing to the contents of the current line. If
  3139. there is an active region, the selected words will form the basis of the
  3140. search string. If the automatically created link is not working correctly or
  3141. accurately enough, you can write custom functions to select the search string
  3142. and to do the search for particular file types---see @ref{Custom searches}.
  3143. The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
  3144. @b{Agenda view}@*
  3145. When the cursor is in an agenda view, the created link points to the
  3146. entry referenced by the current line.
  3147. @c
  3148. @orgcmd{C-c C-l,org-insert-link}
  3149. @cindex link completion
  3150. @cindex completion, of links
  3151. @cindex inserting links
  3152. @vindex org-keep-stored-link-after-insertion
  3153. Insert a link@footnote{ Note that you don't have to use this command to
  3154. insert a link. Links in Org are plain text, and you can type or paste them
  3155. straight into the buffer. By using this command, the links are automatically
  3156. enclosed in double brackets, and you will be asked for the optional
  3157. descriptive text.}. This prompts for a link to be inserted into the buffer.
  3158. You can just type a link, using text for an internal link, or one of the link
  3159. type prefixes mentioned in the examples above. The link will be inserted
  3160. into the buffer@footnote{After insertion of a stored link, the link will be
  3161. removed from the list of stored links. To keep it in the list later use, use
  3162. a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
  3163. @var{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
  3164. If some text was selected when this command is called, the selected text
  3165. becomes the default description.
  3166. @b{Inserting stored links}@*
  3167. All links stored during the
  3168. current session are part of the history for this prompt, so you can access
  3169. them with @key{up} and @key{down} (or @kbd{M-p/n}).
  3170. @b{Completion support}@* Completion with @key{TAB} will help you to insert
  3171. valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
  3172. defined through link abbreviations (@pxref{Link abbreviations}). If you
  3173. press @key{RET} after inserting only the @var{prefix}, Org will offer
  3174. specific completion support for some link types@footnote{This works by
  3175. calling a special function @code{org-PREFIX-complete-link}.} For
  3176. example, if you type @kbd{file @key{RET}}, file name completion (alternative
  3177. access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
  3178. @key{RET}} you can complete contact names.
  3179. @orgkey C-u C-c C-l
  3180. @cindex file name completion
  3181. @cindex completion, of file names
  3182. When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
  3183. a file will be inserted and you may use file name completion to select
  3184. the name of the file. The path to the file is inserted relative to the
  3185. directory of the current Org file, if the linked file is in the current
  3186. directory or in a sub-directory of it, or if the path is written relative
  3187. to the current directory using @samp{../}. Otherwise an absolute path
  3188. is used, if possible with @samp{~/} for your home directory. You can
  3189. force an absolute path with two @kbd{C-u} prefixes.
  3190. @c
  3191. @item C-c C-l @ @r{(with cursor on existing link)}
  3192. When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
  3193. link and description parts of the link.
  3194. @c
  3195. @cindex following links
  3196. @orgcmd{C-c C-o,org-open-at-point}
  3197. @vindex org-file-apps
  3198. @vindex org-link-frame-setup
  3199. Open link at point. This will launch a web browser for URLs (using
  3200. @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
  3201. the corresponding links, and execute the command in a shell link. When the
  3202. cursor is on an internal link, this command runs the corresponding search.
  3203. When the cursor is on a TAG list in a headline, it creates the corresponding
  3204. TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
  3205. date. Furthermore, it will visit text and remote files in @samp{file:} links
  3206. with Emacs and select a suitable application for local non-text files.
  3207. Classification of files is based on file extension only. See option
  3208. @var{org-file-apps}. If you want to override the default application and
  3209. visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
  3210. opening in Emacs, use a @kbd{C-u C-u} prefix.@*
  3211. If the cursor is on a headline, but not on a link, offer all links in the
  3212. headline and entry text. If you want to setup the frame configuration for
  3213. following links, customize @var{org-link-frame-setup}.
  3214. @orgkey @key{RET}
  3215. @vindex org-return-follows-link
  3216. When @var{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
  3217. the link at point.
  3218. @c
  3219. @kindex mouse-2
  3220. @kindex mouse-1
  3221. @item mouse-2
  3222. @itemx mouse-1
  3223. On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
  3224. would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
  3225. @c
  3226. @kindex mouse-3
  3227. @item mouse-3
  3228. @vindex org-display-internal-link-with-indirect-buffer
  3229. Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
  3230. internal links to be displayed in another window@footnote{See the
  3231. option @var{org-display-internal-link-with-indirect-buffer}}.
  3232. @c
  3233. @orgcmd{C-c C-x C-v,org-toggle-inline-images}
  3234. @cindex inlining images
  3235. @cindex images, inlining
  3236. @vindex org-startup-with-inline-images
  3237. @cindex @code{inlineimages}, STARTUP keyword
  3238. @cindex @code{noinlineimages}, STARTUP keyword
  3239. Toggle the inline display of linked images. Normally this will only inline
  3240. images that have no description part in the link, i.e., images that will also
  3241. be inlined during export. When called with a prefix argument, also display
  3242. images that do have a link description. You can ask for inline images to be
  3243. displayed at startup by configuring the variable
  3244. @var{org-startup-with-inline-images}@footnote{with corresponding
  3245. @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
  3246. @orgcmd{C-c %,org-mark-ring-push}
  3247. @cindex mark ring
  3248. Push the current position onto the mark ring, to be able to return
  3249. easily. Commands following an internal link do this automatically.
  3250. @c
  3251. @orgcmd{C-c &,org-mark-ring-goto}
  3252. @cindex links, returning to
  3253. Jump back to a recorded position. A position is recorded by the
  3254. commands following internal links, and by @kbd{C-c %}. Using this
  3255. command several times in direct succession moves through a ring of
  3256. previously recorded positions.
  3257. @c
  3258. @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
  3259. @cindex links, finding next/previous
  3260. Move forward/backward to the next link in the buffer. At the limit of
  3261. the buffer, the search fails once, and then wraps around. The key
  3262. bindings for this are really too long; you might want to bind this also
  3263. to @kbd{C-n} and @kbd{C-p}
  3264. @lisp
  3265. (add-hook 'org-load-hook
  3266. (lambda ()
  3267. (define-key org-mode-map "\C-n" 'org-next-link)
  3268. (define-key org-mode-map "\C-p" 'org-previous-link)))
  3269. @end lisp
  3270. @end table
  3271. @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
  3272. @section Using links outside Org
  3273. You can insert and follow links that have Org syntax not only in
  3274. Org, but in any Emacs buffer. For this, you should create two
  3275. global commands, like this (please select suitable global keys
  3276. yourself):
  3277. @lisp
  3278. (global-set-key "\C-c L" 'org-insert-link-global)
  3279. (global-set-key "\C-c o" 'org-open-at-point-global)
  3280. @end lisp
  3281. @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
  3282. @section Link abbreviations
  3283. @cindex link abbreviations
  3284. @cindex abbreviation, links
  3285. Long URLs can be cumbersome to type, and often many similar links are
  3286. needed in a document. For this you can use link abbreviations. An
  3287. abbreviated link looks like this
  3288. @example
  3289. [[linkword:tag][description]]
  3290. @end example
  3291. @noindent
  3292. @vindex org-link-abbrev-alist
  3293. where the tag is optional.
  3294. The @i{linkword} must be a word, starting with a letter, followed by
  3295. letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
  3296. according to the information in the variable @var{org-link-abbrev-alist}
  3297. that relates the linkwords to replacement text. Here is an example:
  3298. @smalllisp
  3299. @group
  3300. (setq org-link-abbrev-alist
  3301. '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
  3302. ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
  3303. ("google" . "http://www.google.com/search?q=")
  3304. ("gmap" . "http://maps.google.com/maps?q=%s")
  3305. ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
  3306. ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
  3307. @end group
  3308. @end smalllisp
  3309. If the replacement text contains the string @samp{%s}, it will be
  3310. replaced with the tag. Using @samp{%h} instead of @samp{%s} will
  3311. url-encode the tag (see the example above, where we need to encode
  3312. the URL parameter.) Using @samp{%(my-function)} will pass the tag
  3313. to a custom function, and replace it by the resulting string.
  3314. If the replacement text don't contain any specifier, it will simply
  3315. be appended to the string in order to create the link.
  3316. Instead of a string, you may also specify a function that will be
  3317. called with the tag as the only argument to create the link.
  3318. With the above setting, you could link to a specific bug with
  3319. @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
  3320. @code{[[google:OrgMode]]}, show the map location of the Free Software
  3321. Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
  3322. @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
  3323. what the Org author is doing besides Emacs hacking with
  3324. @code{[[ads:Dominik,C]]}.
  3325. If you need special abbreviations just for a single Org buffer, you
  3326. can define them in the file with
  3327. @cindex #+LINK
  3328. @example
  3329. #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
  3330. #+LINK: google http://www.google.com/search?q=%s
  3331. @end example
  3332. @noindent
  3333. In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
  3334. complete link abbreviations. You may also define a function
  3335. @code{org-PREFIX-complete-link} that implements special (e.g., completion)
  3336. support for inserting such a link with @kbd{C-c C-l}. Such a function should
  3337. not accept any arguments, and return the full link with prefix.
  3338. @node Search options, Custom searches, Link abbreviations, Hyperlinks
  3339. @section Search options in file links
  3340. @cindex search option in file links
  3341. @cindex file links, searching
  3342. File links can contain additional information to make Emacs jump to a
  3343. particular location in the file when following a link. This can be a
  3344. line number or a search option after a double@footnote{For backward
  3345. compatibility, line numbers can also follow a single colon.} colon. For
  3346. example, when the command @kbd{C-c l} creates a link (@pxref{Handling
  3347. links}) to a file, it encodes the words in the current line as a search
  3348. string that can be used to find this line back later when following the
  3349. link with @kbd{C-c C-o}.
  3350. Here is the syntax of the different ways to attach a search to a file
  3351. link, together with an explanation:
  3352. @example
  3353. [[file:~/code/main.c::255]]
  3354. [[file:~/xx.org::My Target]]
  3355. [[file:~/xx.org::*My Target]]
  3356. [[file:~/xx.org::#my-custom-id]]
  3357. [[file:~/xx.org::/regexp/]]
  3358. @end example
  3359. @table @code
  3360. @item 255
  3361. Jump to line 255.
  3362. @item My Target
  3363. Search for a link target @samp{<<My Target>>}, or do a text search for
  3364. @samp{my target}, similar to the search in internal links, see
  3365. @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
  3366. link will become a HTML reference to the corresponding named anchor in
  3367. the linked file.
  3368. @item *My Target
  3369. In an Org file, restrict search to headlines.
  3370. @item #my-custom-id
  3371. Link to a heading with a @code{CUSTOM_ID} property
  3372. @item /regexp/
  3373. Do a regular expression search for @code{regexp}. This uses the Emacs
  3374. command @code{occur} to list all matches in a separate window. If the
  3375. target file is in Org mode, @code{org-occur} is used to create a
  3376. sparse tree with the matches.
  3377. @c If the target file is a directory,
  3378. @c @code{grep} will be used to search all files in the directory.
  3379. @end table
  3380. As a degenerate case, a file link with an empty file name can be used
  3381. to search the current file. For example, @code{[[file:::find me]]} does
  3382. a search for @samp{find me} in the current file, just as
  3383. @samp{[[find me]]} would.
  3384. @node Custom searches, , Search options, Hyperlinks
  3385. @section Custom Searches
  3386. @cindex custom search strings
  3387. @cindex search strings, custom
  3388. The default mechanism for creating search strings and for doing the
  3389. actual search related to a file link may not work correctly in all
  3390. cases. For example, Bib@TeX{} database files have many entries like
  3391. @samp{year="1993"} which would not result in good search strings,
  3392. because the only unique identification for a Bib@TeX{} entry is the
  3393. citation key.
  3394. @vindex org-create-file-search-functions
  3395. @vindex org-execute-file-search-functions
  3396. If you come across such a problem, you can write custom functions to set
  3397. the right search string for a particular file type, and to do the search
  3398. for the string in the file. Using @code{add-hook}, these functions need
  3399. to be added to the hook variables
  3400. @var{org-create-file-search-functions} and
  3401. @var{org-execute-file-search-functions}. See the docstring for these
  3402. variables for more information. Org actually uses this mechanism
  3403. for Bib@TeX{} database files, and you can use the corresponding code as
  3404. an implementation example. See the file @file{org-bibtex.el}.
  3405. @node TODO Items, Tags, Hyperlinks, Top
  3406. @chapter TODO items
  3407. @cindex TODO items
  3408. Org mode does not maintain TODO lists as separate documents@footnote{Of
  3409. course, you can make a document that contains only long lists of TODO items,
  3410. but this is not required.}. Instead, TODO items are an integral part of the
  3411. notes file, because TODO items usually come up while taking notes! With Org
  3412. mode, simply mark any entry in a tree as being a TODO item. In this way,
  3413. information is not duplicated, and the entire context from which the TODO
  3414. item emerged is always present.
  3415. Of course, this technique for managing TODO items scatters them
  3416. throughout your notes file. Org mode compensates for this by providing
  3417. methods to give you an overview of all the things that you have to do.
  3418. @menu
  3419. * TODO basics:: Marking and displaying TODO entries
  3420. * TODO extensions:: Workflow and assignments
  3421. * Progress logging:: Dates and notes for progress
  3422. * Priorities:: Some things are more important than others
  3423. * Breaking down tasks:: Splitting a task into manageable pieces
  3424. * Checkboxes:: Tick-off lists
  3425. @end menu
  3426. @node TODO basics, TODO extensions, TODO Items, TODO Items
  3427. @section Basic TODO functionality
  3428. Any headline becomes a TODO item when it starts with the word
  3429. @samp{TODO}, for example:
  3430. @example
  3431. *** TODO Write letter to Sam Fortune
  3432. @end example
  3433. @noindent
  3434. The most important commands to work with TODO entries are:
  3435. @table @kbd
  3436. @orgcmd{C-c C-t,org-todo}
  3437. @cindex cycling, of TODO states
  3438. @vindex org-use-fast-todo-selection
  3439. Rotate the TODO state of the current item among
  3440. @example
  3441. ,-> (unmarked) -> TODO -> DONE --.
  3442. '--------------------------------'
  3443. @end example
  3444. If TODO keywords have fast access keys (see @ref{Fast access to TODO
  3445. states}), you will be prompted for a TODO keyword through the fast selection
  3446. interface; this is the default behavior when
  3447. @var{org-use-fast-todo-selection} is non-@code{nil}.
  3448. The same rotation can also be done ``remotely'' from the timeline and agenda
  3449. buffers with the @kbd{t} command key (@pxref{Agenda commands}).
  3450. @orgkey{C-u C-c C-t}
  3451. When TODO keywords have no selection keys, select a specific keyword using
  3452. completion; otherwise force cycling through TODO states with no prompt. When
  3453. @var{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
  3454. selection interface.
  3455. @kindex S-@key{right}
  3456. @kindex S-@key{left}
  3457. @item S-@key{right} @ @r{/} @ S-@key{left}
  3458. @vindex org-treat-S-cursor-todo-selection-as-state-change
  3459. Select the following/preceding TODO state, similar to cycling. Useful
  3460. mostly if more than two TODO states are possible (@pxref{TODO
  3461. extensions}). See also @ref{Conflicts}, for a discussion of the interaction
  3462. with @code{shift-selection-mode}. See also the variable
  3463. @var{org-treat-S-cursor-todo-selection-as-state-change}.
  3464. @orgcmd{C-c / t,org-show-todo-tree}
  3465. @cindex sparse tree, for TODO
  3466. @vindex org-todo-keywords
  3467. View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
  3468. entire buffer, but shows all TODO items (with not-DONE state) and the
  3469. headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
  3470. / T}), search for a specific TODO@. You will be prompted for the keyword,
  3471. and you can also give a list of keywords like @code{KWD1|KWD2|...} to list
  3472. entries that match any one of these keywords. With a numeric prefix argument
  3473. N, show the tree for the Nth keyword in the option @var{org-todo-keywords}.
  3474. With two prefix arguments, find all TODO states, both un-done and done.
  3475. @orgcmd{C-c a t,org-todo-list}
  3476. Show the global TODO list. Collects the TODO items (with not-DONE states)
  3477. from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
  3478. buffer will be in @code{agenda-mode}, which provides commands to examine and
  3479. manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
  3480. @xref{Global TODO list}, for more information.
  3481. @orgcmd{S-M-@key{RET},org-insert-todo-heading}
  3482. Insert a new TODO entry below the current one.
  3483. @end table
  3484. @noindent
  3485. @vindex org-todo-state-tags-triggers
  3486. Changing a TODO state can also trigger tag changes. See the docstring of the
  3487. option @var{org-todo-state-tags-triggers} for details.
  3488. @node TODO extensions, Progress logging, TODO basics, TODO Items
  3489. @section Extended use of TODO keywords
  3490. @cindex extended TODO keywords
  3491. @vindex org-todo-keywords
  3492. By default, marked TODO entries have one of only two states: TODO and
  3493. DONE@. Org mode allows you to classify TODO items in more complex ways
  3494. with @emph{TODO keywords} (stored in @var{org-todo-keywords}). With
  3495. special setup, the TODO keyword system can work differently in different
  3496. files.
  3497. Note that @i{tags} are another way to classify headlines in general and
  3498. TODO items in particular (@pxref{Tags}).
  3499. @menu
  3500. * Workflow states:: From TODO to DONE in steps
  3501. * TODO types:: I do this, Fred does the rest
  3502. * Multiple sets in one file:: Mixing it all, and still finding your way
  3503. * Fast access to TODO states:: Single letter selection of a state
  3504. * Per-file keywords:: Different files, different requirements
  3505. * Faces for TODO keywords:: Highlighting states
  3506. * TODO dependencies:: When one task needs to wait for others
  3507. @end menu
  3508. @node Workflow states, TODO types, TODO extensions, TODO extensions
  3509. @subsection TODO keywords as workflow states
  3510. @cindex TODO workflow
  3511. @cindex workflow states as TODO keywords
  3512. You can use TODO keywords to indicate different @emph{sequential} states
  3513. in the process of working on an item, for example@footnote{Changing
  3514. this variable only becomes effective after restarting Org mode in a
  3515. buffer.}:
  3516. @lisp
  3517. (setq org-todo-keywords
  3518. '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
  3519. @end lisp
  3520. The vertical bar separates the TODO keywords (states that @emph{need
  3521. action}) from the DONE states (which need @emph{no further action}). If
  3522. you don't provide the separator bar, the last state is used as the DONE
  3523. state.
  3524. @cindex completion, of TODO keywords
  3525. With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
  3526. to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
  3527. also use a numeric prefix argument to quickly select a specific state. For
  3528. example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
  3529. Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
  3530. define many keywords, you can use in-buffer completion
  3531. (@pxref{Completion}) or even a special one-key selection scheme
  3532. (@pxref{Fast access to TODO states}) to insert these words into the
  3533. buffer. Changing a TODO state can be logged with a timestamp, see
  3534. @ref{Tracking TODO state changes}, for more information.
  3535. @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
  3536. @subsection TODO keywords as types
  3537. @cindex TODO types
  3538. @cindex names as TODO keywords
  3539. @cindex types as TODO keywords
  3540. The second possibility is to use TODO keywords to indicate different
  3541. @emph{types} of action items. For example, you might want to indicate
  3542. that items are for ``work'' or ``home''. Or, when you work with several
  3543. people on a single project, you might want to assign action items
  3544. directly to persons, by using their names as TODO keywords. This would
  3545. be set up like this:
  3546. @lisp
  3547. (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
  3548. @end lisp
  3549. In this case, different keywords do not indicate a sequence, but rather
  3550. different types. So the normal work flow would be to assign a task to a
  3551. person, and later to mark it DONE@. Org mode supports this style by adapting
  3552. the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
  3553. @kbd{t} command in the timeline and agenda buffers.}. When used several
  3554. times in succession, it will still cycle through all names, in order to first
  3555. select the right type for a task. But when you return to the item after some
  3556. time and execute @kbd{C-c C-t} again, it will switch from any name directly
  3557. to DONE@. Use prefix arguments or completion to quickly select a specific
  3558. name. You can also review the items of a specific TODO type in a sparse tree
  3559. by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
  3560. Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
  3561. from all agenda files into a single buffer, you would use the numeric prefix
  3562. argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
  3563. @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
  3564. @subsection Multiple keyword sets in one file
  3565. @cindex TODO keyword sets
  3566. Sometimes you may want to use different sets of TODO keywords in
  3567. parallel. For example, you may want to have the basic
  3568. @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
  3569. separate state indicating that an item has been canceled (so it is not
  3570. DONE, but also does not require action). Your setup would then look
  3571. like this:
  3572. @lisp
  3573. (setq org-todo-keywords
  3574. '((sequence "TODO" "|" "DONE")
  3575. (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
  3576. (sequence "|" "CANCELED")))
  3577. @end lisp
  3578. The keywords should all be different, this helps Org mode to keep track
  3579. of which subsequence should be used for a given entry. In this setup,
  3580. @kbd{C-c C-t} only operates within a subsequence, so it switches from
  3581. @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
  3582. (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
  3583. select the correct sequence. Besides the obvious ways like typing a
  3584. keyword or using completion, you may also apply the following commands:
  3585. @table @kbd
  3586. @kindex C-S-@key{right}
  3587. @kindex C-S-@key{left}
  3588. @kindex C-u C-u C-c C-t
  3589. @item C-u C-u C-c C-t
  3590. @itemx C-S-@key{right}
  3591. @itemx C-S-@key{left}
  3592. These keys jump from one TODO subset to the next. In the above example,
  3593. @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
  3594. @code{DONE} to @code{REPORT}, and any of the words in the second row to
  3595. @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
  3596. @code{shift-selection-mode} (@pxref{Conflicts}).
  3597. @kindex S-@key{right}
  3598. @kindex S-@key{left}
  3599. @item S-@key{right}
  3600. @itemx S-@key{left}
  3601. @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
  3602. keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
  3603. from @code{DONE} to @code{REPORT} in the example above. See also
  3604. @ref{Conflicts}, for a discussion of the interaction with
  3605. @code{shift-selection-mode}.
  3606. @end table
  3607. @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
  3608. @subsection Fast access to TODO states
  3609. If you would like to quickly change an entry to an arbitrary TODO state
  3610. instead of cycling through the states, you can set up keys for single-letter
  3611. access to the states. This is done by adding the selection character after
  3612. each keyword, in parentheses@footnote{All characters are allowed except
  3613. @code{@@^!}, which have a special meaning here.}. For example:
  3614. @lisp
  3615. (setq org-todo-keywords
  3616. '((sequence "TODO(t)" "|" "DONE(d)")
  3617. (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
  3618. (sequence "|" "CANCELED(c)")))
  3619. @end lisp
  3620. @vindex org-fast-tag-selection-include-todo
  3621. If you then press @kbd{C-c C-t} followed by the selection key, the entry
  3622. will be switched to this state. @kbd{SPC} can be used to remove any TODO
  3623. keyword from an entry.@footnote{Check also the option
  3624. @var{org-fast-tag-selection-include-todo}, it allows you to change the TODO
  3625. state through the tags interface (@pxref{Setting tags}), in case you like to
  3626. mingle the two concepts. Note that this means you need to come up with
  3627. unique keys across both sets of keywords.}
  3628. @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
  3629. @subsection Setting up keywords for individual files
  3630. @cindex keyword options
  3631. @cindex per-file keywords
  3632. @cindex #+TODO
  3633. @cindex #+TYP_TODO
  3634. @cindex #+SEQ_TODO
  3635. It can be very useful to use different aspects of the TODO mechanism in
  3636. different files. For file-local settings, you need to add special lines
  3637. to the file which set the keywords and interpretation for that file
  3638. only. For example, to set one of the two examples discussed above, you
  3639. need one of the following lines, starting in column zero anywhere in the
  3640. file:
  3641. @example
  3642. #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
  3643. @end example
  3644. @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
  3645. interpretation, but it means the same as @code{#+TODO}), or
  3646. @example
  3647. #+TYP_TODO: Fred Sara Lucy Mike | DONE
  3648. @end example
  3649. A setup for using several sets in parallel would be:
  3650. @example
  3651. #+TODO: TODO | DONE
  3652. #+TODO: REPORT BUG KNOWNCAUSE | FIXED
  3653. #+TODO: | CANCELED
  3654. @end example
  3655. @cindex completion, of option keywords
  3656. @kindex M-@key{TAB}
  3657. @noindent To make sure you are using the correct keyword, type
  3658. @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
  3659. @cindex DONE, final TODO keyword
  3660. Remember that the keywords after the vertical bar (or the last keyword
  3661. if no bar is there) must always mean that the item is DONE (although you
  3662. may use a different word). After changing one of these lines, use
  3663. @kbd{C-c C-c} with the cursor still in the line to make the changes
  3664. known to Org mode@footnote{Org mode parses these lines only when
  3665. Org mode is activated after visiting a file. @kbd{C-c C-c} with the
  3666. cursor in a line starting with @samp{#+} is simply restarting Org mode
  3667. for the current buffer.}.
  3668. @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
  3669. @subsection Faces for TODO keywords
  3670. @cindex faces, for TODO keywords
  3671. @vindex org-todo @r{(face)}
  3672. @vindex org-done @r{(face)}
  3673. @vindex org-todo-keyword-faces
  3674. Org mode highlights TODO keywords with special faces: @code{org-todo}
  3675. for keywords indicating that an item still has to be acted upon, and
  3676. @code{org-done} for keywords indicating that an item is finished. If
  3677. you are using more than 2 different states, you might want to use
  3678. special faces for some of them. This can be done using the option
  3679. @var{org-todo-keyword-faces}. For example:
  3680. @lisp
  3681. @group
  3682. (setq org-todo-keyword-faces
  3683. '(("TODO" . org-warning) ("STARTED" . "yellow")
  3684. ("CANCELED" . (:foreground "blue" :weight bold))))
  3685. @end group
  3686. @end lisp
  3687. While using a list with face properties as shown for CANCELED @emph{should}
  3688. work, this does not always seem to be the case. If necessary, define a
  3689. special face and use that. A string is interpreted as a color. The option
  3690. @var{org-faces-easy-properties} determines if that color is interpreted as a
  3691. foreground or a background color.
  3692. @node TODO dependencies, , Faces for TODO keywords, TODO extensions
  3693. @subsection TODO dependencies
  3694. @cindex TODO dependencies
  3695. @cindex dependencies, of TODO states
  3696. @vindex org-enforce-todo-dependencies
  3697. @cindex property, ORDERED
  3698. The structure of Org files (hierarchy and lists) makes it easy to define TODO
  3699. dependencies. Usually, a parent TODO task should not be marked DONE until
  3700. all subtasks (defined as children tasks) are marked as DONE@. And sometimes
  3701. there is a logical sequence to a number of (sub)tasks, so that one task
  3702. cannot be acted upon before all siblings above it are done. If you customize
  3703. the option @var{org-enforce-todo-dependencies}, Org will block entries
  3704. from changing state to DONE while they have children that are not DONE@.
  3705. Furthermore, if an entry has a property @code{ORDERED}, each of its children
  3706. will be blocked until all earlier siblings are marked DONE@. Here is an
  3707. example:
  3708. @example
  3709. * TODO Blocked until (two) is done
  3710. ** DONE one
  3711. ** TODO two
  3712. * Parent
  3713. :PROPERTIES:
  3714. :ORDERED: t
  3715. :END:
  3716. ** TODO a
  3717. ** TODO b, needs to wait for (a)
  3718. ** TODO c, needs to wait for (a) and (b)
  3719. @end example
  3720. @table @kbd
  3721. @orgcmd{C-c C-x o,org-toggle-ordered-property}
  3722. @vindex org-track-ordered-property-with-tag
  3723. @cindex property, ORDERED
  3724. Toggle the @code{ORDERED} property of the current entry. A property is used
  3725. for this behavior because this should be local to the current entry, not
  3726. inherited like a tag. However, if you would like to @i{track} the value of
  3727. this property with a tag for better visibility, customize the option
  3728. @var{org-track-ordered-property-with-tag}.
  3729. @orgkey{C-u C-u C-u C-c C-t}
  3730. Change TODO state, circumventing any state blocking.
  3731. @end table
  3732. @vindex org-agenda-dim-blocked-tasks
  3733. If you set the option @var{org-agenda-dim-blocked-tasks}, TODO entries
  3734. that cannot be closed because of such dependencies will be shown in a dimmed
  3735. font or even made invisible in agenda views (@pxref{Agenda Views}).
  3736. @cindex checkboxes and TODO dependencies
  3737. @vindex org-enforce-todo-dependencies
  3738. You can also block changes of TODO states by looking at checkboxes
  3739. (@pxref{Checkboxes}). If you set the option
  3740. @var{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
  3741. checkboxes will be blocked from switching to DONE.
  3742. If you need more complex dependency structures, for example dependencies
  3743. between entries in different trees or files, check out the contributed
  3744. module @file{org-depend.el}.
  3745. @page
  3746. @node Progress logging, Priorities, TODO extensions, TODO Items
  3747. @section Progress logging
  3748. @cindex progress logging
  3749. @cindex logging, of progress
  3750. Org mode can automatically record a timestamp and possibly a note when
  3751. you mark a TODO item as DONE, or even each time you change the state of
  3752. a TODO item. This system is highly configurable; settings can be on a
  3753. per-keyword basis and can be localized to a file or even a subtree. For
  3754. information on how to clock working time for a task, see @ref{Clocking
  3755. work time}.
  3756. @menu
  3757. * Closing items:: When was this entry marked DONE?
  3758. * Tracking TODO state changes:: When did the status change?
  3759. * Tracking your habits:: How consistent have you been?
  3760. @end menu
  3761. @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
  3762. @subsection Closing items
  3763. The most basic logging is to keep track of @emph{when} a certain TODO
  3764. item was finished. This is achieved with@footnote{The corresponding
  3765. in-buffer setting is: @code{#+STARTUP: logdone}}
  3766. @lisp
  3767. (setq org-log-done 'time)
  3768. @end lisp
  3769. @vindex org-closed-keep-when-no-todo
  3770. @noindent
  3771. Then each time you turn an entry from a TODO (not-done) state into any of the
  3772. DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
  3773. the headline. If you turn the entry back into a TODO item through further
  3774. state cycling, that line will be removed again. If you turn the entry back
  3775. to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line
  3776. will also be removed, unless you set @var{org-closed-keep-when-no-todo} to
  3777. non-@code{nil}. If you want to record a note along with the timestamp,
  3778. use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
  3779. lognotedone}.}
  3780. @lisp
  3781. (setq org-log-done 'note)
  3782. @end lisp
  3783. @noindent
  3784. You will then be prompted for a note, and that note will be stored below
  3785. the entry with a @samp{Closing Note} heading.
  3786. In the timeline (@pxref{Timeline}) and in the agenda
  3787. (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
  3788. display the TODO items with a @samp{CLOSED} timestamp on each day,
  3789. giving you an overview of what has been done.
  3790. @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
  3791. @subsection Tracking TODO state changes
  3792. @cindex drawer, for state change recording
  3793. @vindex org-log-states-order-reversed
  3794. @vindex org-log-into-drawer
  3795. @cindex property, LOG_INTO_DRAWER
  3796. When TODO keywords are used as workflow states (@pxref{Workflow states}), you
  3797. might want to keep track of when a state change occurred and maybe take a
  3798. note about this change. You can either record just a timestamp, or a
  3799. time-stamped note for a change. These records will be inserted after the
  3800. headline as an itemized list, newest first@footnote{See the option
  3801. @var{org-log-states-order-reversed}}. When taking a lot of notes, you might
  3802. want to get the notes out of the way into a drawer (@pxref{Drawers}).
  3803. Customize @var{org-log-into-drawer} to get this behavior---the recommended
  3804. drawer for this is called @code{LOGBOOK}@footnote{Note that the
  3805. @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
  3806. show an entry---use @key{C-u SPC} to keep it folded here}. You can also
  3807. overrule the setting of this variable for a subtree by setting a
  3808. @code{LOG_INTO_DRAWER} property.
  3809. Since it is normally too much to record a note for every state, Org mode
  3810. expects configuration on a per-keyword basis for this. This is achieved by
  3811. adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
  3812. with timestamp) in parentheses after each keyword. For example, with the
  3813. setting
  3814. @lisp
  3815. (setq org-todo-keywords
  3816. '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
  3817. @end lisp
  3818. To record a timestamp without a note for TODO keywords configured with
  3819. @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
  3820. @noindent
  3821. @vindex org-log-done
  3822. you not only define global TODO keywords and fast access keys, but also
  3823. request that a time is recorded when the entry is set to
  3824. DONE@footnote{It is possible that Org mode will record two timestamps
  3825. when you are using both @var{org-log-done} and state change logging.
  3826. However, it will never prompt for two notes---if you have configured
  3827. both, the state change recording note will take precedence and cancel
  3828. the @samp{Closing Note}.}, and that a note is recorded when switching to
  3829. WAIT or CANCELED@. The setting for WAIT is even more special: the
  3830. @samp{!} after the slash means that in addition to the note taken when
  3831. entering the state, a timestamp should be recorded when @i{leaving} the
  3832. WAIT state, if and only if the @i{target} state does not configure
  3833. logging for entering it. So it has no effect when switching from WAIT
  3834. to DONE, because DONE is configured to record a timestamp only. But
  3835. when switching from WAIT back to TODO, the @samp{/!} in the WAIT
  3836. setting now triggers a timestamp even though TODO has no logging
  3837. configured.
  3838. You can use the exact same syntax for setting logging preferences local
  3839. to a buffer:
  3840. @example
  3841. #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
  3842. @end example
  3843. @cindex property, LOGGING
  3844. In order to define logging settings that are local to a subtree or a
  3845. single item, define a LOGGING property in this entry. Any non-empty
  3846. LOGGING property resets all logging settings to @code{nil}. You may then turn
  3847. on logging for this specific tree using STARTUP keywords like
  3848. @code{lognotedone} or @code{logrepeat}, as well as adding state specific
  3849. settings like @code{TODO(!)}. For example
  3850. @example
  3851. * TODO Log each state with only a time
  3852. :PROPERTIES:
  3853. :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
  3854. :END:
  3855. * TODO Only log when switching to WAIT, and when repeating
  3856. :PROPERTIES:
  3857. :LOGGING: WAIT(@@) logrepeat
  3858. :END:
  3859. * TODO No logging at all
  3860. :PROPERTIES:
  3861. :LOGGING: nil
  3862. :END:
  3863. @end example
  3864. @node Tracking your habits, , Tracking TODO state changes, Progress logging
  3865. @subsection Tracking your habits
  3866. @cindex habits
  3867. Org has the ability to track the consistency of a special category of TODOs,
  3868. called ``habits''. A habit has the following properties:
  3869. @enumerate
  3870. @item
  3871. You have enabled the @code{habits} module by customizing @var{org-modules}.
  3872. @item
  3873. The habit is a TODO item, with a TODO keyword representing an open state.
  3874. @item
  3875. The property @code{STYLE} is set to the value @code{habit}.
  3876. @item
  3877. The TODO has a scheduled date, usually with a @code{.+} style repeat
  3878. interval. A @code{++} style may be appropriate for habits with time
  3879. constraints, e.g., must be done on weekends, or a @code{+} style for an
  3880. unusual habit that can have a backlog, e.g., weekly reports.
  3881. @item
  3882. The TODO may also have minimum and maximum ranges specified by using the
  3883. syntax @samp{.+2d/3d}, which says that you want to do the task at least every
  3884. three days, but at most every two days.
  3885. @item
  3886. You must also have state logging for the @code{DONE} state enabled
  3887. (@pxref{Tracking TODO state changes}), in order for historical data to be
  3888. represented in the consistency graph. If it is not enabled it is not an
  3889. error, but the consistency graphs will be largely meaningless.
  3890. @end enumerate
  3891. To give you an idea of what the above rules look like in action, here's an
  3892. actual habit with some history:
  3893. @example
  3894. ** TODO Shave
  3895. SCHEDULED: <2009-10-17 Sat .+2d/4d>
  3896. - State "DONE" from "TODO" [2009-10-15 Thu]
  3897. - State "DONE" from "TODO" [2009-10-12 Mon]
  3898. - State "DONE" from "TODO" [2009-10-10 Sat]
  3899. - State "DONE" from "TODO" [2009-10-04 Sun]
  3900. - State "DONE" from "TODO" [2009-10-02 Fri]
  3901. - State "DONE" from "TODO" [2009-09-29 Tue]
  3902. - State "DONE" from "TODO" [2009-09-25 Fri]
  3903. - State "DONE" from "TODO" [2009-09-19 Sat]
  3904. - State "DONE" from "TODO" [2009-09-16 Wed]
  3905. - State "DONE" from "TODO" [2009-09-12 Sat]
  3906. :PROPERTIES:
  3907. :STYLE: habit
  3908. :LAST_REPEAT: [2009-10-19 Mon 00:36]
  3909. :END:
  3910. @end example
  3911. What this habit says is: I want to shave at most every 2 days (given by the
  3912. @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
  3913. today is the 15th, then the habit first appears in the agenda on Oct 17,
  3914. after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
  3915. after four days have elapsed.
  3916. What's really useful about habits is that they are displayed along with a
  3917. consistency graph, to show how consistent you've been at getting that task
  3918. done in the past. This graph shows every day that the task was done over the
  3919. past three weeks, with colors for each day. The colors used are:
  3920. @table @code
  3921. @item Blue
  3922. If the task wasn't to be done yet on that day.
  3923. @item Green
  3924. If the task could have been done on that day.
  3925. @item Yellow
  3926. If the task was going to be overdue the next day.
  3927. @item Red
  3928. If the task was overdue on that day.
  3929. @end table
  3930. In addition to coloring each day, the day is also marked with an asterisk if
  3931. the task was actually done that day, and an exclamation mark to show where
  3932. the current day falls in the graph.
  3933. There are several configuration variables that can be used to change the way
  3934. habits are displayed in the agenda.
  3935. @table @code
  3936. @item org-habit-graph-column
  3937. The buffer column at which the consistency graph should be drawn. This will
  3938. overwrite any text in that column, so it is a good idea to keep your habits'
  3939. titles brief and to the point.
  3940. @item org-habit-preceding-days
  3941. The amount of history, in days before today, to appear in consistency graphs.
  3942. @item org-habit-following-days
  3943. The number of days after today that will appear in consistency graphs.
  3944. @item org-habit-show-habits-only-for-today
  3945. If non-@code{nil}, only show habits in today's agenda view. This is set to true by
  3946. default.
  3947. @end table
  3948. Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
  3949. temporarily be disabled and they won't appear at all. Press @kbd{K} again to
  3950. bring them back. They are also subject to tag filtering, if you have habits
  3951. which should only be done in certain contexts, for example.
  3952. @node Priorities, Breaking down tasks, Progress logging, TODO Items
  3953. @section Priorities
  3954. @cindex priorities
  3955. If you use Org mode extensively, you may end up with enough TODO items that
  3956. it starts to make sense to prioritize them. Prioritizing can be done by
  3957. placing a @emph{priority cookie} into the headline of a TODO item, like this
  3958. @example
  3959. *** TODO [#A] Write letter to Sam Fortune
  3960. @end example
  3961. @noindent
  3962. @vindex org-priority-faces
  3963. By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
  3964. @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
  3965. treated just like priority @samp{B}. Priorities make a difference only for
  3966. sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
  3967. have no inherent meaning to Org mode. The cookies can be highlighted with
  3968. special faces by customizing @var{org-priority-faces}.
  3969. Priorities can be attached to any outline node; they do not need to be TODO
  3970. items.
  3971. @table @kbd
  3972. @item @kbd{C-c ,}
  3973. @kindex @kbd{C-c ,}
  3974. @findex org-priority
  3975. Set the priority of the current headline (@command{org-priority}). The
  3976. command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
  3977. When you press @key{SPC} instead, the priority cookie is removed from the
  3978. headline. The priorities can also be changed ``remotely'' from the timeline
  3979. and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
  3980. @c
  3981. @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
  3982. @vindex org-priority-start-cycle-with-default
  3983. Increase/decrease priority of current headline@footnote{See also the option
  3984. @var{org-priority-start-cycle-with-default}.}. Note that these keys are
  3985. also used to modify timestamps (@pxref{Creating timestamps}). See also
  3986. @ref{Conflicts}, for a discussion of the interaction with
  3987. @code{shift-selection-mode}.
  3988. @end table
  3989. @vindex org-highest-priority
  3990. @vindex org-lowest-priority
  3991. @vindex org-default-priority
  3992. You can change the range of allowed priorities by setting the options
  3993. @var{org-highest-priority}, @var{org-lowest-priority}, and
  3994. @var{org-default-priority}. For an individual buffer, you may set
  3995. these values (highest, lowest, default) like this (please make sure that
  3996. the highest priority is earlier in the alphabet than the lowest
  3997. priority):
  3998. @cindex #+PRIORITIES
  3999. @example
  4000. #+PRIORITIES: A C B
  4001. @end example
  4002. @node Breaking down tasks, Checkboxes, Priorities, TODO Items
  4003. @section Breaking tasks down into subtasks
  4004. @cindex tasks, breaking down
  4005. @cindex statistics, for TODO items
  4006. @vindex org-agenda-todo-list-sublevels
  4007. It is often advisable to break down large tasks into smaller, manageable
  4008. subtasks. You can do this by creating an outline tree below a TODO item,
  4009. with detailed subtasks on the tree@footnote{To keep subtasks out of the
  4010. global TODO list, see the @var{org-agenda-todo-list-sublevels}.}. To keep
  4011. the overview over the fraction of subtasks that are already completed, insert
  4012. either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
  4013. be updated each time the TODO status of a child changes, or when pressing
  4014. @kbd{C-c C-c} on the cookie. For example:
  4015. @example
  4016. * Organize Party [33%]
  4017. ** TODO Call people [1/2]
  4018. *** TODO Peter
  4019. *** DONE Sarah
  4020. ** TODO Buy food
  4021. ** DONE Talk to neighbor
  4022. @end example
  4023. @cindex property, COOKIE_DATA
  4024. If a heading has both checkboxes and TODO children below it, the meaning of
  4025. the statistics cookie become ambiguous. Set the property
  4026. @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
  4027. this issue.
  4028. @vindex org-hierarchical-todo-statistics
  4029. If you would like to have the statistics cookie count any TODO entries in the
  4030. subtree (not just direct children), configure
  4031. @var{org-hierarchical-todo-statistics}. To do this for a single subtree,
  4032. include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
  4033. property.
  4034. @example
  4035. * Parent capturing statistics [2/20]
  4036. :PROPERTIES:
  4037. :COOKIE_DATA: todo recursive
  4038. :END:
  4039. @end example
  4040. If you would like a TODO entry to automatically change to DONE
  4041. when all children are done, you can use the following setup:
  4042. @example
  4043. (defun org-summary-todo (n-done n-not-done)
  4044. "Switch entry to DONE when all subentries are done, to TODO otherwise."
  4045. (let (org-log-done org-log-states) ; turn off logging
  4046. (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
  4047. (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
  4048. @end example
  4049. Another possibility is the use of checkboxes to identify (a hierarchy of) a
  4050. large number of subtasks (@pxref{Checkboxes}).
  4051. @node Checkboxes, , Breaking down tasks, TODO Items
  4052. @section Checkboxes
  4053. @cindex checkboxes
  4054. @vindex org-list-automatic-rules
  4055. Every item in a plain list@footnote{With the exception of description
  4056. lists. But you can allow it by modifying @var{org-list-automatic-rules}
  4057. accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
  4058. it with the string @samp{[ ]}. This feature is similar to TODO items
  4059. (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
  4060. in the global TODO list, so they are often great to split a task into a
  4061. number of simple steps. Or you can use them in a shopping list. To toggle a
  4062. checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
  4063. @file{org-mouse.el}).
  4064. Here is an example of a checkbox list.
  4065. @example
  4066. * TODO Organize party [2/4]
  4067. - [-] call people [1/3]
  4068. - [ ] Peter
  4069. - [X] Sarah
  4070. - [ ] Sam
  4071. - [X] order food
  4072. - [ ] think about what music to play
  4073. - [X] talk to the neighbors
  4074. @end example
  4075. Checkboxes work hierarchically, so if a checkbox item has children that
  4076. are checkboxes, toggling one of the children checkboxes will make the
  4077. parent checkbox reflect if none, some, or all of the children are
  4078. checked.
  4079. @cindex statistics, for checkboxes
  4080. @cindex checkbox statistics
  4081. @cindex property, COOKIE_DATA
  4082. @vindex org-checkbox-hierarchical-statistics
  4083. The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
  4084. indicating how many checkboxes present in this entry have been checked off,
  4085. and the total number of checkboxes present. This can give you an idea on how
  4086. many checkboxes remain, even without opening a folded entry. The cookies can
  4087. be placed into a headline or into (the first line of) a plain list item.
  4088. Each cookie covers checkboxes of direct children structurally below the
  4089. headline/item on which the cookie appears@footnote{Set the option
  4090. @var{org-checkbox-hierarchical-statistics} if you want such cookies to
  4091. count all checkboxes below the cookie, not just those belonging to direct
  4092. children.}. You have to insert the cookie yourself by typing either
  4093. @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
  4094. result, as in the examples above. With @samp{[%]} you get information about
  4095. the percentage of checkboxes checked (in the above example, this would be
  4096. @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
  4097. count either checkboxes below the heading or TODO states of children, and it
  4098. will display whatever was changed last. Set the property @code{COOKIE_DATA}
  4099. to either @samp{checkbox} or @samp{todo} to resolve this issue.
  4100. @cindex blocking, of checkboxes
  4101. @cindex checkbox blocking
  4102. @cindex property, ORDERED
  4103. If the current outline node has an @code{ORDERED} property, checkboxes must
  4104. be checked off in sequence, and an error will be thrown if you try to check
  4105. off a box while there are unchecked boxes above it.
  4106. @noindent The following commands work with checkboxes:
  4107. @table @kbd
  4108. @orgcmd{C-c C-c,org-toggle-checkbox}
  4109. Toggle checkbox status or (with prefix arg) checkbox presence at point.
  4110. With a single prefix argument, add an empty checkbox or remove the current
  4111. one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
  4112. will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
  4113. considered to be an intermediate state.
  4114. @orgcmd{C-c C-x C-b,org-toggle-checkbox}
  4115. Toggle checkbox status or (with prefix arg) checkbox presence at point. With
  4116. double prefix argument, set it to @samp{[-]}, which is considered to be an
  4117. intermediate state.
  4118. @itemize @minus
  4119. @item
  4120. If there is an active region, toggle the first checkbox in the region
  4121. and set all remaining boxes to the same status as the first. With a prefix
  4122. arg, add or remove the checkbox for all items in the region.
  4123. @item
  4124. If the cursor is in a headline, toggle checkboxes in the region between
  4125. this headline and the next (so @emph{not} the entire subtree).
  4126. @item
  4127. If there is no active region, just toggle the checkbox at point.
  4128. @end itemize
  4129. @orgcmd{M-S-@key{RET},org-insert-todo-heading}
  4130. Insert a new item with a checkbox. This works only if the cursor is already
  4131. in a plain list item (@pxref{Plain lists}).
  4132. @orgcmd{C-c C-x o,org-toggle-ordered-property}
  4133. @vindex org-track-ordered-property-with-tag
  4134. @cindex property, ORDERED
  4135. Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
  4136. be checked off in sequence. A property is used for this behavior because
  4137. this should be local to the current entry, not inherited like a tag.
  4138. However, if you would like to @i{track} the value of this property with a tag
  4139. for better visibility, customize @var{org-track-ordered-property-with-tag}.
  4140. @orgcmd{C-c #,org-update-statistics-cookies}
  4141. Update the statistics cookie in the current outline entry. When called with
  4142. a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
  4143. updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
  4144. new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
  4145. changing TODO states. If you delete boxes/entries or add/change them by
  4146. hand, use this command to get things back into sync.
  4147. @end table
  4148. @node Tags, Properties and Columns, TODO Items, Top
  4149. @chapter Tags
  4150. @cindex tags
  4151. @cindex headline tagging
  4152. @cindex matching, tags
  4153. @cindex sparse tree, tag based
  4154. An excellent way to implement labels and contexts for cross-correlating
  4155. information is to assign @i{tags} to headlines. Org mode has extensive
  4156. support for tags.
  4157. @vindex org-tag-faces
  4158. Every headline can contain a list of tags; they occur at the end of the
  4159. headline. Tags are normal words containing letters, numbers, @samp{_}, and
  4160. @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
  4161. @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
  4162. Tags will by default be in bold face with the same color as the headline.
  4163. You may specify special faces for specific tags using the option
  4164. @var{org-tag-faces}, in much the same way as you can for TODO keywords
  4165. (@pxref{Faces for TODO keywords}).
  4166. @menu
  4167. * Tag inheritance:: Tags use the tree structure of the outline
  4168. * Setting tags:: How to assign tags to a headline
  4169. * Tag groups:: Use one tag to search for several tags
  4170. * Tag searches:: Searching for combinations of tags
  4171. @end menu
  4172. @node Tag inheritance, Setting tags, Tags, Tags
  4173. @section Tag inheritance
  4174. @cindex tag inheritance
  4175. @cindex inheritance, of tags
  4176. @cindex sublevels, inclusion into tags match
  4177. @i{Tags} make use of the hierarchical structure of outline trees. If a
  4178. heading has a certain tag, all subheadings will inherit the tag as
  4179. well. For example, in the list
  4180. @example
  4181. * Meeting with the French group :work:
  4182. ** Summary by Frank :boss:notes:
  4183. *** TODO Prepare slides for him :action:
  4184. @end example
  4185. @noindent
  4186. the final heading will have the tags @samp{:work:}, @samp{:boss:},
  4187. @samp{:notes:}, and @samp{:action:} even though the final heading is not
  4188. explicitly marked with those tags. You can also set tags that all entries in
  4189. a file should inherit just as if these tags were defined in a hypothetical
  4190. level zero that surrounds the entire file. Use a line like this@footnote{As
  4191. with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
  4192. changes in the line.}:
  4193. @cindex #+FILETAGS
  4194. @example
  4195. #+FILETAGS: :Peter:Boss:Secret:
  4196. @end example
  4197. @noindent
  4198. @vindex org-use-tag-inheritance
  4199. @vindex org-tags-exclude-from-inheritance
  4200. To limit tag inheritance to specific tags, use @var{org-tags-exclude-from-inheritance}.
  4201. To turn it off entirely, use @var{org-use-tag-inheritance}.
  4202. @vindex org-tags-match-list-sublevels
  4203. When a headline matches during a tags search while tag inheritance is turned
  4204. on, all the sublevels in the same tree will (for a simple match form) match
  4205. as well@footnote{This is only true if the search does not involve more
  4206. complex tests including properties (@pxref{Property searches}).}. The list
  4207. of matches may then become very long. If you only want to see the first tags
  4208. match in a subtree, configure @var{org-tags-match-list-sublevels} (not
  4209. recommended).
  4210. @vindex org-agenda-use-tag-inheritance
  4211. Tag inheritance is relevant when the agenda search tries to match a tag,
  4212. either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
  4213. types, @var{org-use-tag-inheritance} has no effect. Still, you may want to
  4214. have your tags correctly set in the agenda, so that tag filtering works fine,
  4215. with inherited tags. Set @var{org-agenda-use-tag-inheritance} to control
  4216. this: the default value includes all agenda types, but setting this to @code{nil}
  4217. can really speed up agenda generation.
  4218. @node Setting tags, Tag groups, Tag inheritance, Tags
  4219. @section Setting tags
  4220. @cindex setting tags
  4221. @cindex tags, setting
  4222. @kindex M-@key{TAB}
  4223. Tags can simply be typed into the buffer at the end of a headline.
  4224. After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
  4225. also a special command for inserting tags:
  4226. @table @kbd
  4227. @orgcmd{C-c C-q,org-set-tags-command}
  4228. @cindex completion, of tags
  4229. @vindex org-tags-column
  4230. Enter new tags for the current headline. Org mode will either offer
  4231. completion or a special single-key interface for setting tags, see
  4232. below. After pressing @key{RET}, the tags will be inserted and aligned
  4233. to @var{org-tags-column}. When called with a @kbd{C-u} prefix, all
  4234. tags in the current buffer will be aligned to that column, just to make
  4235. things look nice. TAGS are automatically realigned after promotion,
  4236. demotion, and TODO state changes (@pxref{TODO basics}).
  4237. @orgcmd{C-c C-c,org-set-tags-command}
  4238. When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
  4239. @end table
  4240. @vindex org-tag-alist
  4241. Org supports tag insertion based on a @emph{list of tags}. By
  4242. default this list is constructed dynamically, containing all tags
  4243. currently used in the buffer. You may also globally specify a hard list
  4244. of tags with the variable @var{org-tag-alist}. Finally you can set
  4245. the default tags for a given file with lines like
  4246. @cindex #+TAGS
  4247. @example
  4248. #+TAGS: @@work @@home @@tennisclub
  4249. #+TAGS: laptop car pc sailboat
  4250. @end example
  4251. If you have globally defined your preferred set of tags using the
  4252. variable @var{org-tag-alist}, but would like to use a dynamic tag list
  4253. in a specific file, add an empty TAGS option line to that file:
  4254. @example
  4255. #+TAGS:
  4256. @end example
  4257. @vindex org-tag-persistent-alist
  4258. If you have a preferred set of tags that you would like to use in every file,
  4259. in addition to those defined on a per-file basis by TAGS option lines, then
  4260. you may specify a list of tags with the variable
  4261. @var{org-tag-persistent-alist}. You may turn this off on a per-file basis
  4262. by adding a STARTUP option line to that file:
  4263. @example
  4264. #+STARTUP: noptag
  4265. @end example
  4266. By default Org mode uses the standard minibuffer completion facilities for
  4267. entering tags. However, it also implements another, quicker, tag selection
  4268. method called @emph{fast tag selection}. This allows you to select and
  4269. deselect tags with just a single key press. For this to work well you should
  4270. assign unique letters to most of your commonly used tags. You can do this
  4271. globally by configuring the variable @var{org-tag-alist} in your
  4272. @file{.emacs} file. For example, you may find the need to tag many items in
  4273. different files with @samp{:@@home:}. In this case you can set something
  4274. like:
  4275. @lisp
  4276. (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
  4277. @end lisp
  4278. @noindent If the tag is only relevant to the file you are working on, then you
  4279. can instead set the TAGS option line as:
  4280. @example
  4281. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
  4282. @end example
  4283. @noindent The tags interface will show the available tags in a splash
  4284. window. If you want to start a new line after a specific tag, insert
  4285. @samp{\n} into the tag list
  4286. @example
  4287. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
  4288. @end example
  4289. @noindent or write them in two lines:
  4290. @example
  4291. #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
  4292. #+TAGS: laptop(l) pc(p)
  4293. @end example
  4294. @noindent
  4295. You can also group together tags that are mutually exclusive by using
  4296. braces, as in:
  4297. @example
  4298. #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
  4299. @end example
  4300. @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
  4301. and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
  4302. @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
  4303. these lines to activate any changes.
  4304. @noindent
  4305. To set these mutually exclusive groups in the variable @var{org-tag-alist},
  4306. you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
  4307. of the braces. Similarly, you can use @code{:newline} to indicate a line
  4308. break. The previous example would be set globally by the following
  4309. configuration:
  4310. @lisp
  4311. (setq org-tag-alist '((:startgroup . nil)
  4312. ("@@work" . ?w) ("@@home" . ?h)
  4313. ("@@tennisclub" . ?t)
  4314. (:endgroup . nil)
  4315. ("laptop" . ?l) ("pc" . ?p)))
  4316. @end lisp
  4317. If at least one tag has a selection key then pressing @kbd{C-c C-c} will
  4318. automatically present you with a special interface, listing inherited tags,
  4319. the tags of the current headline, and a list of all valid tags with
  4320. corresponding keys@footnote{Keys will automatically be assigned to tags which
  4321. have no configured keys.}. In this interface, you can use the following
  4322. keys:
  4323. @table @kbd
  4324. @item a-z...
  4325. Pressing keys assigned to tags will add or remove them from the list of
  4326. tags in the current line. Selecting a tag in a group of mutually
  4327. exclusive tags will turn off any other tags from that group.
  4328. @kindex @key{TAB}
  4329. @item @key{TAB}
  4330. Enter a tag in the minibuffer, even if the tag is not in the predefined
  4331. list. You will be able to complete on all tags present in the buffer.
  4332. You can also add several tags: just separate them with a comma.
  4333. @kindex @key{SPC}
  4334. @item @key{SPC}
  4335. Clear all tags for this line.
  4336. @kindex @key{RET}
  4337. @item @key{RET}
  4338. Accept the modified set.
  4339. @item C-g
  4340. Abort without installing changes.
  4341. @item q
  4342. If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
  4343. @item !
  4344. Turn off groups of mutually exclusive tags. Use this to (as an
  4345. exception) assign several tags from such a group.
  4346. @item C-c
  4347. Toggle auto-exit after the next change (see below).
  4348. If you are using expert mode, the first @kbd{C-c} will display the
  4349. selection window.
  4350. @end table
  4351. @noindent
  4352. This method lets you assign tags to a headline with very few keys. With
  4353. the above setup, you could clear the current tags and set @samp{@@home},
  4354. @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
  4355. C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
  4356. @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
  4357. alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
  4358. @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
  4359. @key{RET} @key{RET}}.
  4360. @vindex org-fast-tag-selection-single-key
  4361. If you find that most of the time you need only a single key press to
  4362. modify your list of tags, set @var{org-fast-tag-selection-single-key}.
  4363. Then you no longer have to press @key{RET} to exit fast tag selection---it
  4364. will immediately exit after the first change. If you then occasionally
  4365. need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
  4366. selection process (in effect: start selection with @kbd{C-c C-c C-c}
  4367. instead of @kbd{C-c C-c}). If you set the variable to the value
  4368. @code{expert}, the special window is not even shown for single-key tag
  4369. selection, it comes up only when you press an extra @kbd{C-c}.
  4370. @node Tag groups, Tag searches, Setting tags, Tags
  4371. @section Tag groups
  4372. @cindex group tags
  4373. @cindex tags, groups
  4374. In a set of mutually exclusive tags, the first tag can be defined as a
  4375. @emph{group tag}. When you search for a group tag, it will return matches
  4376. for all members in the group. In an agenda view, filtering by a group tag
  4377. will display headlines tagged with at least one of the members of the
  4378. group. This makes tag searches and filters even more flexible.
  4379. You can set group tags by inserting a colon between the group tag and other
  4380. tags---beware that all whitespaces are mandatory so that Org can parse this
  4381. line correctly:
  4382. @example
  4383. #+TAGS: @{ @@read : @@read_book @@read_ebook @}
  4384. @end example
  4385. In this example, @samp{@@read} is a @emph{group tag} for a set of three
  4386. tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}.
  4387. You can also use the @code{:grouptags} keyword directly when setting
  4388. @var{org-tag-alist}:
  4389. @lisp
  4390. (setq org-tag-alist '((:startgroup . nil)
  4391. ("@@read" . nil)
  4392. (:grouptags . nil)
  4393. ("@@read_book" . nil)
  4394. ("@@read_ebook" . nil)
  4395. (:endgroup . nil)))
  4396. @end lisp
  4397. You cannot nest group tags or use a group tag as a tag in another group.
  4398. @kindex C-c C-x q
  4399. @vindex org-group-tags
  4400. If you want to ignore group tags temporarily, toggle group tags support
  4401. with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. If you
  4402. want to disable tag groups completely, set @var{org-group-tags} to @code{nil}.
  4403. @node Tag searches, , Tag groups, Tags
  4404. @section Tag searches
  4405. @cindex tag searches
  4406. @cindex searching for tags
  4407. Once a system of tags has been set up, it can be used to collect related
  4408. information into special lists.
  4409. @table @kbd
  4410. @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
  4411. Create a sparse tree with all headlines matching a tags search. With a
  4412. @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  4413. @orgcmd{C-c a m,org-tags-view}
  4414. Create a global list of tag matches from all agenda files.
  4415. @xref{Matching tags and properties}.
  4416. @orgcmd{C-c a M,org-tags-view}
  4417. @vindex org-tags-match-list-sublevels
  4418. Create a global list of tag matches from all agenda files, but check
  4419. only TODO items and force checking subitems (see the option
  4420. @var{org-tags-match-list-sublevels}).
  4421. @end table
  4422. These commands all prompt for a match string which allows basic Boolean logic
  4423. like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
  4424. @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
  4425. which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
  4426. string is rich and allows also matching against TODO keywords, entry levels
  4427. and properties. For a complete description with many examples, see
  4428. @ref{Matching tags and properties}.
  4429. @node Properties and Columns, Dates and Times, Tags, Top
  4430. @chapter Properties and columns
  4431. @cindex properties
  4432. A property is a key-value pair associated with an entry. Properties can be
  4433. set so they are associated with a single entry, with every entry in a tree,
  4434. or with every entry in an Org mode file.
  4435. There are two main applications for properties in Org mode. First,
  4436. properties are like tags, but with a value. Imagine maintaining a file where
  4437. you document bugs and plan releases for a piece of software. Instead of
  4438. using tags like @code{:release_1:}, @code{:release_2:}, you can use a
  4439. property, say @code{:Release:}, that in different subtrees has different
  4440. values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
  4441. implement (very basic) database capabilities in an Org buffer. Imagine
  4442. keeping track of your music CDs, where properties could be things such as the
  4443. album, artist, date of release, number of tracks, and so on.
  4444. Properties can be conveniently edited and viewed in column view
  4445. (@pxref{Column view}).
  4446. @menu
  4447. * Property syntax:: How properties are spelled out
  4448. * Special properties:: Access to other Org mode features
  4449. * Property searches:: Matching property values
  4450. * Property inheritance:: Passing values down the tree
  4451. * Column view:: Tabular viewing and editing
  4452. * Property API:: Properties for Lisp programmers
  4453. @end menu
  4454. @node Property syntax, Special properties, Properties and Columns, Properties and Columns
  4455. @section Property syntax
  4456. @cindex property syntax
  4457. @cindex drawer, for properties
  4458. Properties are key-value pairs. When they are associated with a single entry
  4459. or with a tree they need to be inserted into a special
  4460. drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
  4461. is specified on a single line, with the key (surrounded by colons)
  4462. first, and the value after it. Here is an example:
  4463. @example
  4464. * CD collection
  4465. ** Classic
  4466. *** Goldberg Variations
  4467. :PROPERTIES:
  4468. :Title: Goldberg Variations
  4469. :Composer: J.S. Bach
  4470. :Artist: Glen Gould
  4471. :Publisher: Deutsche Grammophon
  4472. :NDisks: 1
  4473. :END:
  4474. @end example
  4475. Depending on the value of @var{org-use-property-inheritance}, a property set
  4476. this way will either be associated with a single entry, or the sub-tree
  4477. defined by the entry, see @ref{Property inheritance}.
  4478. You may define the allowed values for a particular property @samp{:Xyz:}
  4479. by setting a property @samp{:Xyz_ALL:}. This special property is
  4480. @emph{inherited}, so if you set it in a level 1 entry, it will apply to
  4481. the entire tree. When allowed values are defined, setting the
  4482. corresponding property becomes easier and is less prone to typing
  4483. errors. For the example with the CD collection, we can predefine
  4484. publishers and the number of disks in a box like this:
  4485. @example
  4486. * CD collection
  4487. :PROPERTIES:
  4488. :NDisks_ALL: 1 2 3 4
  4489. :Publisher_ALL: "Deutsche Grammophon" Philips EMI
  4490. :END:
  4491. @end example
  4492. If you want to set properties that can be inherited by any entry in a
  4493. file, use a line like
  4494. @cindex property, _ALL
  4495. @cindex #+PROPERTY
  4496. @example
  4497. #+PROPERTY: NDisks_ALL 1 2 3 4
  4498. @end example
  4499. Contrary to properties set from a special drawer, you have to refresh the
  4500. buffer with @kbd{C-c C-c} to activate this changes.
  4501. If you want to add to the value of an existing property, append a @code{+} to
  4502. the property name. The following results in the property @code{var} having
  4503. the value ``foo=1 bar=2''.
  4504. @cindex property, +
  4505. @example
  4506. #+PROPERTY: var foo=1
  4507. #+PROPERTY: var+ bar=2
  4508. @end example
  4509. It is also possible to add to the values of inherited properties. The
  4510. following results in the @code{genres} property having the value ``Classic
  4511. Baroque'' under the @code{Goldberg Variations} subtree.
  4512. @cindex property, +
  4513. @example
  4514. * CD collection
  4515. ** Classic
  4516. :PROPERTIES:
  4517. :GENRES: Classic
  4518. :END:
  4519. *** Goldberg Variations
  4520. :PROPERTIES:
  4521. :Title: Goldberg Variations
  4522. :Composer: J.S. Bach
  4523. :Artist: Glen Gould
  4524. :Publisher: Deutsche Grammophon
  4525. :NDisks: 1
  4526. :GENRES+: Baroque
  4527. :END:
  4528. @end example
  4529. Note that a property can only have one entry per Drawer.
  4530. @vindex org-global-properties
  4531. Property values set with the global variable
  4532. @var{org-global-properties} can be inherited by all entries in all
  4533. Org files.
  4534. @noindent
  4535. The following commands help to work with properties:
  4536. @table @kbd
  4537. @orgcmd{M-@key{TAB},pcomplete}
  4538. After an initial colon in a line, complete property keys. All keys used
  4539. in the current file will be offered as possible completions.
  4540. @orgcmd{C-c C-x p,org-set-property}
  4541. Set a property. This prompts for a property name and a value. If
  4542. necessary, the property drawer is created as well.
  4543. @item C-u M-x org-insert-drawer RET
  4544. @cindex org-insert-drawer
  4545. Insert a property drawer into the current entry. The drawer will be
  4546. inserted early in the entry, but after the lines with planning
  4547. information like deadlines.
  4548. @orgcmd{C-c C-c,org-property-action}
  4549. With the cursor in a property drawer, this executes property commands.
  4550. @orgcmd{C-c C-c s,org-set-property}
  4551. Set a property in the current entry. Both the property and the value
  4552. can be inserted using completion.
  4553. @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
  4554. Switch property at point to the next/previous allowed value.
  4555. @orgcmd{C-c C-c d,org-delete-property}
  4556. Remove a property from the current entry.
  4557. @orgcmd{C-c C-c D,org-delete-property-globally}
  4558. Globally remove a property, from all entries in the current file.
  4559. @orgcmd{C-c C-c c,org-compute-property-at-point}
  4560. Compute the property at point, using the operator and scope from the
  4561. nearest column format definition.
  4562. @end table
  4563. @node Special properties, Property searches, Property syntax, Properties and Columns
  4564. @section Special properties
  4565. @cindex properties, special
  4566. Special properties provide an alternative access method to Org mode features,
  4567. like the TODO state or the priority of an entry, discussed in the previous
  4568. chapters. This interface exists so that you can include these states in a
  4569. column view (@pxref{Column view}), or to use them in queries. The following
  4570. property names are special and (except for @code{:CATEGORY:}) should not be
  4571. used as keys in the properties drawer:
  4572. @cindex property, special, ID
  4573. @cindex property, special, TODO
  4574. @cindex property, special, TAGS
  4575. @cindex property, special, ALLTAGS
  4576. @cindex property, special, CATEGORY
  4577. @cindex property, special, PRIORITY
  4578. @cindex property, special, DEADLINE
  4579. @cindex property, special, SCHEDULED
  4580. @cindex property, special, CLOSED
  4581. @cindex property, special, TIMESTAMP
  4582. @cindex property, special, TIMESTAMP_IA
  4583. @cindex property, special, CLOCKSUM
  4584. @cindex property, special, CLOCKSUM_T
  4585. @cindex property, special, BLOCKED
  4586. @c guessing that ITEM is needed in this area; also, should this list be sorted?
  4587. @cindex property, special, ITEM
  4588. @cindex property, special, FILE
  4589. @example
  4590. ID @r{A globally unique ID used for synchronization during}
  4591. @r{iCalendar or MobileOrg export.}
  4592. TODO @r{The TODO keyword of the entry.}
  4593. TAGS @r{The tags defined directly in the headline.}
  4594. ALLTAGS @r{All tags, including inherited ones.}
  4595. CATEGORY @r{The category of an entry.}
  4596. PRIORITY @r{The priority of the entry, a string with a single letter.}
  4597. DEADLINE @r{The deadline time string, without the angular brackets.}
  4598. SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
  4599. CLOSED @r{When was this entry closed?}
  4600. TIMESTAMP @r{The first keyword-less timestamp in the entry.}
  4601. TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
  4602. CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
  4603. @r{must be run first to compute the values in the current buffer.}
  4604. CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
  4605. @r{@code{org-clock-sum-today} must be run first to compute the}
  4606. @r{values in the current buffer.}
  4607. BLOCKED @r{"t" if task is currently blocked by children or siblings}
  4608. ITEM @r{The headline of the entry.}
  4609. FILE @r{The filename the entry is located in.}
  4610. @end example
  4611. @node Property searches, Property inheritance, Special properties, Properties and Columns
  4612. @section Property searches
  4613. @cindex properties, searching
  4614. @cindex searching, of properties
  4615. To create sparse trees and special lists with selection based on properties,
  4616. the same commands are used as for tag searches (@pxref{Tag searches}).
  4617. @table @kbd
  4618. @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
  4619. Create a sparse tree with all matching entries. With a
  4620. @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  4621. @orgcmd{C-c a m,org-tags-view}
  4622. Create a global list of tag/property matches from all agenda files.
  4623. @xref{Matching tags and properties}.
  4624. @orgcmd{C-c a M,org-tags-view}
  4625. @vindex org-tags-match-list-sublevels
  4626. Create a global list of tag matches from all agenda files, but check
  4627. only TODO items and force checking of subitems (see the option
  4628. @var{org-tags-match-list-sublevels}).
  4629. @end table
  4630. The syntax for the search string is described in @ref{Matching tags and
  4631. properties}.
  4632. There is also a special command for creating sparse trees based on a
  4633. single property:
  4634. @table @kbd
  4635. @orgkey{C-c / p}
  4636. Create a sparse tree based on the value of a property. This first
  4637. prompts for the name of a property, and then for a value. A sparse tree
  4638. is created with all entries that define this property with the given
  4639. value. If you enclose the value in curly braces, it is interpreted as
  4640. a regular expression and matched against the property values.
  4641. @end table
  4642. @node Property inheritance, Column view, Property searches, Properties and Columns
  4643. @section Property Inheritance
  4644. @cindex properties, inheritance
  4645. @cindex inheritance, of properties
  4646. @vindex org-use-property-inheritance
  4647. The outline structure of Org mode documents lends itself to an
  4648. inheritance model of properties: if the parent in a tree has a certain
  4649. property, the children can inherit this property. Org mode does not
  4650. turn this on by default, because it can slow down property searches
  4651. significantly and is often not needed. However, if you find inheritance
  4652. useful, you can turn it on by setting the variable
  4653. @var{org-use-property-inheritance}. It may be set to @code{t} to make
  4654. all properties inherited from the parent, to a list of properties
  4655. that should be inherited, or to a regular expression that matches
  4656. inherited properties. If a property has the value @code{nil}, this is
  4657. interpreted as an explicit undefine of the property, so that inheritance
  4658. search will stop at this value and return @code{nil}.
  4659. Org mode has a few properties for which inheritance is hard-coded, at
  4660. least for the special applications for which they are used:
  4661. @cindex property, COLUMNS
  4662. @table @code
  4663. @item COLUMNS
  4664. The @code{:COLUMNS:} property defines the format of column view
  4665. (@pxref{Column view}). It is inherited in the sense that the level
  4666. where a @code{:COLUMNS:} property is defined is used as the starting
  4667. point for a column view table, independently of the location in the
  4668. subtree from where columns view is turned on.
  4669. @item CATEGORY
  4670. @cindex property, CATEGORY
  4671. For agenda view, a category set through a @code{:CATEGORY:} property
  4672. applies to the entire subtree.
  4673. @item ARCHIVE
  4674. @cindex property, ARCHIVE
  4675. For archiving, the @code{:ARCHIVE:} property may define the archive
  4676. location for the entire subtree (@pxref{Moving subtrees}).
  4677. @item LOGGING
  4678. @cindex property, LOGGING
  4679. The LOGGING property may define logging settings for an entry or a
  4680. subtree (@pxref{Tracking TODO state changes}).
  4681. @end table
  4682. @node Column view, Property API, Property inheritance, Properties and Columns
  4683. @section Column view
  4684. A great way to view and edit properties in an outline tree is
  4685. @emph{column view}. In column view, each outline node is turned into a
  4686. table row. Columns in this table provide access to properties of the
  4687. entries. Org mode implements columns by overlaying a tabular structure
  4688. over the headline of each item. While the headlines have been turned
  4689. into a table row, you can still change the visibility of the outline
  4690. tree. For example, you get a compact table by switching to CONTENTS
  4691. view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
  4692. is active), but you can still open, read, and edit the entry below each
  4693. headline. Or, you can switch to column view after executing a sparse
  4694. tree command and in this way get a table only for the selected items.
  4695. Column view also works in agenda buffers (@pxref{Agenda Views}) where
  4696. queries have collected selected items, possibly from a number of files.
  4697. @menu
  4698. * Defining columns:: The COLUMNS format property
  4699. * Using column view:: How to create and use column view
  4700. * Capturing column view:: A dynamic block for column view
  4701. @end menu
  4702. @node Defining columns, Using column view, Column view, Column view
  4703. @subsection Defining columns
  4704. @cindex column view, for properties
  4705. @cindex properties, column view
  4706. Setting up a column view first requires defining the columns. This is
  4707. done by defining a column format line.
  4708. @menu
  4709. * Scope of column definitions:: Where defined, where valid?
  4710. * Column attributes:: Appearance and content of a column
  4711. @end menu
  4712. @node Scope of column definitions, Column attributes, Defining columns, Defining columns
  4713. @subsubsection Scope of column definitions
  4714. To define a column format for an entire file, use a line like
  4715. @cindex #+COLUMNS
  4716. @example
  4717. #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  4718. @end example
  4719. To specify a format that only applies to a specific tree, add a
  4720. @code{:COLUMNS:} property to the top node of that tree, for example:
  4721. @example
  4722. ** Top node for columns view
  4723. :PROPERTIES:
  4724. :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  4725. :END:
  4726. @end example
  4727. If a @code{:COLUMNS:} property is present in an entry, it defines columns
  4728. for the entry itself, and for the entire subtree below it. Since the
  4729. column definition is part of the hierarchical structure of the document,
  4730. you can define columns on level 1 that are general enough for all
  4731. sublevels, and more specific columns further down, when you edit a
  4732. deeper part of the tree.
  4733. @node Column attributes, , Scope of column definitions, Defining columns
  4734. @subsubsection Column attributes
  4735. A column definition sets the attributes of a column. The general
  4736. definition looks like this:
  4737. @example
  4738. %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
  4739. @end example
  4740. @noindent
  4741. Except for the percent sign and the property name, all items are
  4742. optional. The individual parts have the following meaning:
  4743. @example
  4744. @var{width} @r{An integer specifying the width of the column in characters.}
  4745. @r{If omitted, the width will be determined automatically.}
  4746. @var{property} @r{The property that should be edited in this column.}
  4747. @r{Special properties representing meta data are allowed here}
  4748. @r{as well (@pxref{Special properties})}
  4749. @var{title} @r{The header text for the column. If omitted, the property}
  4750. @r{name is used.}
  4751. @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
  4752. @r{parent nodes are computed from the children.}
  4753. @r{Supported summary types are:}
  4754. @{+@} @r{Sum numbers in this column.}
  4755. @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
  4756. @{$@} @r{Currency, short for @samp{+;%.2f}.}
  4757. @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
  4758. @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
  4759. @{X/@} @r{Checkbox status, @samp{[n/m]}.}
  4760. @{X%@} @r{Checkbox status, @samp{[n%]}.}
  4761. @{min@} @r{Smallest number in column.}
  4762. @{max@} @r{Largest number.}
  4763. @{mean@} @r{Arithmetic mean of numbers.}
  4764. @{:min@} @r{Smallest time value in column.}
  4765. @{:max@} @r{Largest time value.}
  4766. @{:mean@} @r{Arithmetic mean of time values.}
  4767. @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
  4768. @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
  4769. @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
  4770. @{est+@} @r{Add low-high estimates.}
  4771. @end example
  4772. @noindent
  4773. Be aware that you can only have one summary type for any property you
  4774. include. Subsequent columns referencing the same property will all display the
  4775. same summary information.
  4776. The @code{est+} summary type requires further explanation. It is used for
  4777. combining estimates, expressed as low-high ranges. For example, instead
  4778. of estimating a particular task will take 5 days, you might estimate it as
  4779. 5--6 days if you're fairly confident you know how much work is required, or
  4780. 1--10 days if you don't really know what needs to be done. Both ranges
  4781. average at 5.5 days, but the first represents a more predictable delivery.
  4782. When combining a set of such estimates, simply adding the lows and highs
  4783. produces an unrealistically wide result. Instead, @code{est+} adds the
  4784. statistical mean and variance of the sub-tasks, generating a final estimate
  4785. from the sum. For example, suppose you had ten tasks, each of which was
  4786. estimated at 0.5 to 2 days of work. Straight addition produces an estimate
  4787. of 5 to 20 days, representing what to expect if everything goes either
  4788. extremely well or extremely poorly. In contrast, @code{est+} estimates the
  4789. full job more realistically, at 10--15 days.
  4790. Here is an example for a complete columns definition, along with allowed
  4791. values.
  4792. @example
  4793. :COLUMNS: %25ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line---it is wrapped here only because of formatting constraints.}
  4794. %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
  4795. :Owner_ALL: Tammy Mark Karl Lisa Don
  4796. :Status_ALL: "In progress" "Not started yet" "Finished" ""
  4797. :Approved_ALL: "[ ]" "[X]"
  4798. @end example
  4799. @noindent
  4800. The first column, @samp{%25ITEM}, means the first 25 characters of the
  4801. item itself, i.e., of the headline. You probably always should start the
  4802. column definition with the @samp{ITEM} specifier. The other specifiers
  4803. create columns @samp{Owner} with a list of names as allowed values, for
  4804. @samp{Status} with four different possible values, and for a checkbox
  4805. field @samp{Approved}. When no width is given after the @samp{%}
  4806. character, the column will be exactly as wide as it needs to be in order
  4807. to fully display all values. The @samp{Approved} column does have a
  4808. modified title (@samp{Approved?}, with a question mark). Summaries will
  4809. be created for the @samp{Time_Estimate} column by adding time duration
  4810. expressions like HH:MM, and for the @samp{Approved} column, by providing
  4811. an @samp{[X]} status if all children have been checked. The
  4812. @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
  4813. sums of CLOCK intervals in the subtree, either for all clocks or just for
  4814. today.
  4815. @node Using column view, Capturing column view, Defining columns, Column view
  4816. @subsection Using column view
  4817. @table @kbd
  4818. @tsubheading{Turning column view on and off}
  4819. @orgcmd{C-c C-x C-c,org-columns}
  4820. @vindex org-columns-default-format
  4821. Turn on column view. If the cursor is before the first headline in the file,
  4822. column view is turned on for the entire file, using the @code{#+COLUMNS}
  4823. definition. If the cursor is somewhere inside the outline, this command
  4824. searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
  4825. defines a format. When one is found, the column view table is established
  4826. for the tree starting at the entry that contains the @code{:COLUMNS:}
  4827. property. If no such property is found, the format is taken from the
  4828. @code{#+COLUMNS} line or from the variable @var{org-columns-default-format},
  4829. and column view is established for the current entry and its subtree.
  4830. @orgcmd{r,org-columns-redo}
  4831. Recreate the column view, to include recent changes made in the buffer.
  4832. @orgcmd{g,org-columns-redo}
  4833. Same as @kbd{r}.
  4834. @orgcmd{q,org-columns-quit}
  4835. Exit column view.
  4836. @tsubheading{Editing values}
  4837. @item @key{left} @key{right} @key{up} @key{down}
  4838. Move through the column view from field to field.
  4839. @kindex S-@key{left}
  4840. @kindex S-@key{right}
  4841. @item S-@key{left}/@key{right}
  4842. Switch to the next/previous allowed value of the field. For this, you
  4843. have to have specified allowed values for a property.
  4844. @item 1..9,0
  4845. Directly select the Nth allowed value, @kbd{0} selects the 10th value.
  4846. @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
  4847. Same as @kbd{S-@key{left}/@key{right}}
  4848. @orgcmd{e,org-columns-edit-value}
  4849. Edit the property at point. For the special properties, this will
  4850. invoke the same interface that you normally use to change that
  4851. property. For example, when editing a TAGS property, the tag completion
  4852. or fast selection interface will pop up.
  4853. @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
  4854. When there is a checkbox at point, toggle it.
  4855. @orgcmd{v,org-columns-show-value}
  4856. View the full value of this property. This is useful if the width of
  4857. the column is smaller than that of the value.
  4858. @orgcmd{a,org-columns-edit-allowed}
  4859. Edit the list of allowed values for this property. If the list is found
  4860. in the hierarchy, the modified values is stored there. If no list is
  4861. found, the new value is stored in the first entry that is part of the
  4862. current column view.
  4863. @tsubheading{Modifying the table structure}
  4864. @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
  4865. Make the column narrower/wider by one character.
  4866. @orgcmd{S-M-@key{right},org-columns-new}
  4867. Insert a new column, to the left of the current column.
  4868. @orgcmd{S-M-@key{left},org-columns-delete}
  4869. Delete the current column.
  4870. @end table
  4871. @node Capturing column view, , Using column view, Column view
  4872. @subsection Capturing column view
  4873. Since column view is just an overlay over a buffer, it cannot be
  4874. exported or printed directly. If you want to capture a column view, use
  4875. a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
  4876. of this block looks like this:
  4877. @cindex #+BEGIN, columnview
  4878. @example
  4879. * The column view
  4880. #+BEGIN: columnview :hlines 1 :id "label"
  4881. #+END:
  4882. @end example
  4883. @noindent This dynamic block has the following parameters:
  4884. @table @code
  4885. @item :id
  4886. This is the most important parameter. Column view is a feature that is
  4887. often localized to a certain (sub)tree, and the capture block might be
  4888. at a different location in the file. To identify the tree whose view to
  4889. capture, you can use 4 values:
  4890. @cindex property, ID
  4891. @example
  4892. local @r{use the tree in which the capture block is located}
  4893. global @r{make a global view, including all headings in the file}
  4894. "file:@var{path-to-file}"
  4895. @r{run column view at the top of this file}
  4896. "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
  4897. @r{property with the value @i{label}. You can use}
  4898. @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
  4899. @r{the current entry and copy it to the kill-ring.}
  4900. @end example
  4901. @item :hlines
  4902. When @code{t}, insert an hline after every line. When a number @var{N}, insert
  4903. an hline before each headline with level @code{<= @var{N}}.
  4904. @item :vlines
  4905. When set to @code{t}, force column groups to get vertical lines.
  4906. @item :maxlevel
  4907. When set to a number, don't capture entries below this level.
  4908. @item :skip-empty-rows
  4909. When set to @code{t}, skip rows where the only non-empty specifier of the
  4910. column view is @code{ITEM}.
  4911. @end table
  4912. @noindent
  4913. The following commands insert or update the dynamic block:
  4914. @table @kbd
  4915. @orgcmd{C-c C-x i,org-insert-columns-dblock}
  4916. Insert a dynamic block capturing a column view. You will be prompted
  4917. for the scope or ID of the view.
  4918. @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
  4919. Update dynamic block at point. The cursor needs to be in the
  4920. @code{#+BEGIN} line of the dynamic block.
  4921. @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
  4922. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  4923. you have several clock table blocks, column-capturing blocks or other dynamic
  4924. blocks in a buffer.
  4925. @end table
  4926. You can add formulas to the column view table and you may add plotting
  4927. instructions in front of the table---these will survive an update of the
  4928. block. If there is a @code{#+TBLFM:} after the table, the table will
  4929. actually be recalculated automatically after an update.
  4930. An alternative way to capture and process property values into a table is
  4931. provided by Eric Schulte's @file{org-collector.el} which is a contributed
  4932. package@footnote{Contributed packages are not part of Emacs, but are
  4933. distributed with the main distribution of Org (visit
  4934. @uref{http://orgmode.org}).}. It provides a general API to collect
  4935. properties from entries in a certain scope, and arbitrary Lisp expressions to
  4936. process these values before inserting them into a table or a dynamic block.
  4937. @node Property API, , Column view, Properties and Columns
  4938. @section The Property API
  4939. @cindex properties, API
  4940. @cindex API, for properties
  4941. There is a full API for accessing and changing properties. This API can
  4942. be used by Emacs Lisp programs to work with properties and to implement
  4943. features based on them. For more information see @ref{Using the
  4944. property API}.
  4945. @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
  4946. @chapter Dates and times
  4947. @cindex dates
  4948. @cindex times
  4949. @cindex timestamp
  4950. @cindex date stamp
  4951. To assist project planning, TODO items can be labeled with a date and/or
  4952. a time. The specially formatted string carrying the date and time
  4953. information is called a @emph{timestamp} in Org mode. This may be a
  4954. little confusing because timestamp is often used as indicating when
  4955. something was created or last changed. However, in Org mode this term
  4956. is used in a much wider sense.
  4957. @menu
  4958. * Timestamps:: Assigning a time to a tree entry
  4959. * Creating timestamps:: Commands which insert timestamps
  4960. * Deadlines and scheduling:: Planning your work
  4961. * Clocking work time:: Tracking how long you spend on a task
  4962. * Effort estimates:: Planning work effort in advance
  4963. * Relative timer:: Notes with a running timer
  4964. * Countdown timer:: Starting a countdown timer for a task
  4965. @end menu
  4966. @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
  4967. @section Timestamps, deadlines, and scheduling
  4968. @cindex timestamps
  4969. @cindex ranges, time
  4970. @cindex date stamps
  4971. @cindex deadlines
  4972. @cindex scheduling
  4973. A timestamp is a specification of a date (possibly with a time or a range of
  4974. times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
  4975. simplest form, the day name is optional when you type the date yourself.
  4976. However, any dates inserted or modified by Org will add that day name, for
  4977. reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
  4978. Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
  4979. date/time format. To use an alternative format, see @ref{Custom time
  4980. format}.}. A timestamp can appear anywhere in the headline or body of an Org
  4981. tree entry. Its presence causes entries to be shown on specific dates in the
  4982. agenda (@pxref{Weekly/daily agenda}). We distinguish:
  4983. @table @var
  4984. @item Plain timestamp; Event; Appointment
  4985. @cindex timestamp
  4986. @cindex appointment
  4987. A simple timestamp just assigns a date/time to an item. This is just
  4988. like writing down an appointment or event in a paper agenda. In the
  4989. timeline and agenda displays, the headline of an entry associated with a
  4990. plain timestamp will be shown exactly on that date.
  4991. @example
  4992. * Meet Peter at the movies
  4993. <2006-11-01 Wed 19:15>
  4994. * Discussion on climate change
  4995. <2006-11-02 Thu 20:00-22:00>
  4996. @end example
  4997. @item Timestamp with repeater interval
  4998. @cindex timestamp, with repeater interval
  4999. A timestamp may contain a @emph{repeater interval}, indicating that it
  5000. applies not only on the given date, but again and again after a certain
  5001. interval of N days (d), weeks (w), months (m), or years (y). The
  5002. following will show up in the agenda every Wednesday:
  5003. @example
  5004. * Pick up Sam at school
  5005. <2007-05-16 Wed 12:30 +1w>
  5006. @end example
  5007. @item Diary-style sexp entries
  5008. For more complex date specifications, Org mode supports using the special
  5009. sexp diary entries implemented in the Emacs calendar/diary
  5010. package@footnote{When working with the standard diary sexp functions, you
  5011. need to be very careful with the order of the arguments. That order depend
  5012. evilly on the variable @var{calendar-date-style} (or, for older Emacs
  5013. versions, @code{european-calendar-style}). For example, to specify a date
  5014. December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
  5015. @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
  5016. the settings. This has been the source of much confusion. Org mode users
  5017. can resort to special versions of these functions like @code{org-date} or
  5018. @code{org-anniversary}. These work just like the corresponding @code{diary-}
  5019. functions, but with stable ISO order of arguments (year, month, day) wherever
  5020. applicable, independent of the value of @var{calendar-date-style}.}. For
  5021. example with optional time
  5022. @example
  5023. * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
  5024. <%%(diary-float t 4 2)>
  5025. @end example
  5026. @item Time/Date range
  5027. @cindex timerange
  5028. @cindex date range
  5029. Two timestamps connected by @samp{--} denote a range. The headline
  5030. will be shown on the first and last day of the range, and on any dates
  5031. that are displayed and fall in the range. Here is an example:
  5032. @example
  5033. ** Meeting in Amsterdam
  5034. <2004-08-23 Mon>--<2004-08-26 Thu>
  5035. @end example
  5036. @item Inactive timestamp
  5037. @cindex timestamp, inactive
  5038. @cindex inactive timestamp
  5039. Just like a plain timestamp, but with square brackets instead of
  5040. angular ones. These timestamps are inactive in the sense that they do
  5041. @emph{not} trigger an entry to show up in the agenda.
  5042. @example
  5043. * Gillian comes late for the fifth time
  5044. [2006-11-01 Wed]
  5045. @end example
  5046. @end table
  5047. @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
  5048. @section Creating timestamps
  5049. @cindex creating timestamps
  5050. @cindex timestamps, creating
  5051. For Org mode to recognize timestamps, they need to be in the specific
  5052. format. All commands listed below produce timestamps in the correct
  5053. format.
  5054. @table @kbd
  5055. @orgcmd{C-c .,org-time-stamp}
  5056. Prompt for a date and insert a corresponding timestamp. When the cursor is
  5057. at an existing timestamp in the buffer, the command is used to modify this
  5058. timestamp instead of inserting a new one. When this command is used twice in
  5059. succession, a time range is inserted.
  5060. @c
  5061. @orgcmd{C-c !,org-time-stamp-inactive}
  5062. Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
  5063. an agenda entry.
  5064. @c
  5065. @kindex C-u C-c .
  5066. @kindex C-u C-c !
  5067. @item C-u C-c .
  5068. @itemx C-u C-c !
  5069. @vindex org-time-stamp-rounding-minutes
  5070. Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
  5071. contains date and time. The default time can be rounded to multiples of 5
  5072. minutes, see the option @var{org-time-stamp-rounding-minutes}.
  5073. @c
  5074. @orgkey{C-c C-c}
  5075. Normalize timestamp, insert/fix day name if missing or wrong.
  5076. @c
  5077. @orgcmd{C-c <,org-date-from-calendar}
  5078. Insert a timestamp corresponding to the cursor date in the Calendar.
  5079. @c
  5080. @orgcmd{C-c >,org-goto-calendar}
  5081. Access the Emacs calendar for the current date. If there is a
  5082. timestamp in the current line, go to the corresponding date
  5083. instead.
  5084. @c
  5085. @orgcmd{C-c C-o,org-open-at-point}
  5086. Access the agenda for the date given by the timestamp or -range at
  5087. point (@pxref{Weekly/daily agenda}).
  5088. @c
  5089. @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
  5090. Change date at cursor by one day. These key bindings conflict with
  5091. shift-selection and related modes (@pxref{Conflicts}).
  5092. @c
  5093. @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
  5094. Change the item under the cursor in a timestamp. The cursor can be on a
  5095. year, month, day, hour or minute. When the timestamp contains a time range
  5096. like @samp{15:30-16:30}, modifying the first time will also shift the second,
  5097. shifting the time block with constant length. To change the length, modify
  5098. the second time. Note that if the cursor is in a headline and not at a
  5099. timestamp, these same keys modify the priority of an item.
  5100. (@pxref{Priorities}). The key bindings also conflict with shift-selection and
  5101. related modes (@pxref{Conflicts}).
  5102. @c
  5103. @orgcmd{C-c C-y,org-evaluate-time-range}
  5104. @cindex evaluate time range
  5105. Evaluate a time range by computing the difference between start and end.
  5106. With a prefix argument, insert result after the time range (in a table: into
  5107. the following column).
  5108. @end table
  5109. @menu
  5110. * The date/time prompt:: How Org mode helps you entering date and time
  5111. * Custom time format:: Making dates look different
  5112. @end menu
  5113. @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
  5114. @subsection The date/time prompt
  5115. @cindex date, reading in minibuffer
  5116. @cindex time, reading in minibuffer
  5117. @vindex org-read-date-prefer-future
  5118. When Org mode prompts for a date/time, the default is shown in default
  5119. date/time format, and the prompt therefore seems to ask for a specific
  5120. format. But it will in fact accept date/time information in a variety of
  5121. formats. Generally, the information should start at the beginning of the
  5122. string. Org mode will find whatever information is in
  5123. there and derive anything you have not specified from the @emph{default date
  5124. and time}. The default is usually the current date and time, but when
  5125. modifying an existing timestamp, or when entering the second stamp of a
  5126. range, it is taken from the stamp in the buffer. When filling in
  5127. information, Org mode assumes that most of the time you will want to enter a
  5128. date in the future: if you omit the month/year and the given day/month is
  5129. @i{before} today, it will assume that you mean a future date@footnote{See the
  5130. variable @var{org-read-date-prefer-future}. You may set that variable to
  5131. the symbol @code{time} to even make a time before now shift the date to
  5132. tomorrow.}. If the date has been automatically shifted into the future, the
  5133. time prompt will show this with @samp{(=>F).}
  5134. For example, let's assume that today is @b{June 13, 2006}. Here is how
  5135. various inputs will be interpreted, the items filled in by Org mode are
  5136. in @b{bold}.
  5137. @example
  5138. 3-2-5 @result{} 2003-02-05
  5139. 2/5/3 @result{} 2003-02-05
  5140. 14 @result{} @b{2006}-@b{06}-14
  5141. 12 @result{} @b{2006}-@b{07}-12
  5142. 2/5 @result{} @b{2007}-02-05
  5143. Fri @result{} nearest Friday after the default date
  5144. sep 15 @result{} @b{2006}-09-15
  5145. feb 15 @result{} @b{2007}-02-15
  5146. sep 12 9 @result{} 2009-09-12
  5147. 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
  5148. 22 sept 0:34 @result{} @b{2006}-09-22 0:34
  5149. w4 @result{} ISO week for of the current year @b{2006}
  5150. 2012 w4 fri @result{} Friday of ISO week 4 in 2012
  5151. 2012-w04-5 @result{} Same as above
  5152. @end example
  5153. Furthermore you can specify a relative date by giving, as the @emph{first}
  5154. thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
  5155. indicate change in hours, days, weeks, months, or years. With a single plus
  5156. or minus, the date is always relative to today. With a double plus or minus,
  5157. it is relative to the default date. If instead of a single letter, you use
  5158. the abbreviation of day name, the date will be the Nth such day, e.g.:
  5159. @example
  5160. +0 @result{} today
  5161. . @result{} today
  5162. +4d @result{} four days from today
  5163. +4 @result{} same as above
  5164. +2w @result{} two weeks from today
  5165. ++5 @result{} five days from default date
  5166. +2tue @result{} second Tuesday from now
  5167. -wed @result{} last Wednesday
  5168. @end example
  5169. @vindex parse-time-months
  5170. @vindex parse-time-weekdays
  5171. The function understands English month and weekday abbreviations. If
  5172. you want to use unabbreviated names and/or other languages, configure
  5173. the variables @var{parse-time-months} and @var{parse-time-weekdays}.
  5174. @vindex org-read-date-force-compatible-dates
  5175. Not all dates can be represented in a given Emacs implementation. By default
  5176. Org mode forces dates into the compatibility range 1970--2037 which works on
  5177. all Emacs implementations. If you want to use dates outside of this range,
  5178. read the docstring of the variable
  5179. @var{org-read-date-force-compatible-dates}.
  5180. You can specify a time range by giving start and end times or by giving a
  5181. start time and a duration (in HH:MM format). Use one or two dash(es) as the
  5182. separator in the former case and use '+' as the separator in the latter
  5183. case, e.g.:
  5184. @example
  5185. 11am-1:15pm @result{} 11:00-13:15
  5186. 11am--1:15pm @result{} same as above
  5187. 11am+2:15 @result{} same as above
  5188. @end example
  5189. @cindex calendar, for selecting date
  5190. @vindex org-popup-calendar-for-date-prompt
  5191. Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
  5192. you don't need/want the calendar, configure the variable
  5193. @var{org-popup-calendar-for-date-prompt}.}. When you exit the date
  5194. prompt, either by clicking on a date in the calendar, or by pressing
  5195. @key{RET}, the date selected in the calendar will be combined with the
  5196. information entered at the prompt. You can control the calendar fully
  5197. from the minibuffer:
  5198. @kindex <
  5199. @kindex >
  5200. @kindex M-v
  5201. @kindex C-v
  5202. @kindex mouse-1
  5203. @kindex S-@key{right}
  5204. @kindex S-@key{left}
  5205. @kindex S-@key{down}
  5206. @kindex S-@key{up}
  5207. @kindex M-S-@key{right}
  5208. @kindex M-S-@key{left}
  5209. @kindex @key{RET}
  5210. @example
  5211. @key{RET} @r{Choose date at cursor in calendar.}
  5212. mouse-1 @r{Select date by clicking on it.}
  5213. S-@key{right}/@key{left} @r{One day forward/backward.}
  5214. S-@key{down}/@key{up} @r{One week forward/backward.}
  5215. M-S-@key{right}/@key{left} @r{One month forward/backward.}
  5216. > / < @r{Scroll calendar forward/backward by one month.}
  5217. M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
  5218. @end example
  5219. @vindex org-read-date-display-live
  5220. The actions of the date/time prompt may seem complex, but I assure you they
  5221. will grow on you, and you will start getting annoyed by pretty much any other
  5222. way of entering a date/time out there. To help you understand what is going
  5223. on, the current interpretation of your input will be displayed live in the
  5224. minibuffer@footnote{If you find this distracting, turn the display off with
  5225. @var{org-read-date-display-live}.}.
  5226. @node Custom time format, , The date/time prompt, Creating timestamps
  5227. @subsection Custom time format
  5228. @cindex custom date/time format
  5229. @cindex time format, custom
  5230. @cindex date format, custom
  5231. @vindex org-display-custom-times
  5232. @vindex org-time-stamp-custom-formats
  5233. Org mode uses the standard ISO notation for dates and times as it is
  5234. defined in ISO 8601. If you cannot get used to this and require another
  5235. representation of date and time to keep you happy, you can get it by
  5236. customizing the options @var{org-display-custom-times} and
  5237. @var{org-time-stamp-custom-formats}.
  5238. @table @kbd
  5239. @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
  5240. Toggle the display of custom formats for dates and times.
  5241. @end table
  5242. @noindent
  5243. Org mode needs the default format for scanning, so the custom date/time
  5244. format does not @emph{replace} the default format---instead it is put
  5245. @emph{over} the default format using text properties. This has the
  5246. following consequences:
  5247. @itemize @bullet
  5248. @item
  5249. You cannot place the cursor onto a timestamp anymore, only before or
  5250. after.
  5251. @item
  5252. The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
  5253. each component of a timestamp. If the cursor is at the beginning of
  5254. the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
  5255. just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
  5256. time will be changed by one minute.
  5257. @item
  5258. If the timestamp contains a range of clock times or a repeater, these
  5259. will not be overlaid, but remain in the buffer as they were.
  5260. @item
  5261. When you delete a timestamp character-by-character, it will only
  5262. disappear from the buffer after @emph{all} (invisible) characters
  5263. belonging to the ISO timestamp have been removed.
  5264. @item
  5265. If the custom timestamp format is longer than the default and you are
  5266. using dates in tables, table alignment will be messed up. If the custom
  5267. format is shorter, things do work as expected.
  5268. @end itemize
  5269. @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
  5270. @section Deadlines and scheduling
  5271. A timestamp may be preceded by special keywords to facilitate planning:
  5272. @table @var
  5273. @item DEADLINE
  5274. @cindex DEADLINE keyword
  5275. Meaning: the task (most likely a TODO item, though not necessarily) is supposed
  5276. to be finished on that date.
  5277. @vindex org-deadline-warning-days
  5278. @vindex org-agenda-skip-deadline-prewarning-if-scheduled
  5279. On the deadline date, the task will be listed in the agenda. In
  5280. addition, the agenda for @emph{today} will carry a warning about the
  5281. approaching or missed deadline, starting
  5282. @var{org-deadline-warning-days} before the due date, and continuing
  5283. until the entry is marked DONE@. An example:
  5284. @example
  5285. *** TODO write article about the Earth for the Guide
  5286. DEADLINE: <2004-02-29 Sun>
  5287. The editor in charge is [[bbdb:Ford Prefect]]
  5288. @end example
  5289. You can specify a different lead time for warnings for a specific
  5290. deadlines using the following syntax. Here is an example with a warning
  5291. period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. This warning is
  5292. deactivated if the task get scheduled and you set
  5293. @var{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
  5294. @item SCHEDULED
  5295. @cindex SCHEDULED keyword
  5296. Meaning: you are planning to start working on that task on the given
  5297. date.
  5298. @vindex org-agenda-skip-scheduled-if-done
  5299. The headline will be listed under the given date@footnote{It will still
  5300. be listed on that date after it has been marked DONE@. If you don't like
  5301. this, set the variable @var{org-agenda-skip-scheduled-if-done}.}. In
  5302. addition, a reminder that the scheduled date has passed will be present
  5303. in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
  5304. the task will automatically be forwarded until completed.
  5305. @example
  5306. *** TODO Call Trillian for a date on New Years Eve.
  5307. SCHEDULED: <2004-12-25 Sat>
  5308. @end example
  5309. @vindex org-scheduled-delay-days
  5310. @vindex org-agenda-skip-scheduled-delay-if-deadline
  5311. If you want to @emph{delay} the display of this task in the agenda, use
  5312. @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
  5313. 25th but will appear two days later. In case the task contains a repeater,
  5314. the delay is considered to affect all occurrences; if you want the delay to
  5315. only affect the first scheduled occurrence of the task, use @code{--2d}
  5316. instead. See @var{org-scheduled-delay-days} and
  5317. @var{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
  5318. control this globally or per agenda.
  5319. @noindent
  5320. @b{Important:} Scheduling an item in Org mode should @i{not} be
  5321. understood in the same way that we understand @i{scheduling a meeting}.
  5322. Setting a date for a meeting is just a simple appointment, you should
  5323. mark this entry with a simple plain timestamp, to get this item shown
  5324. on the date where it applies. This is a frequent misunderstanding by
  5325. Org users. In Org mode, @i{scheduling} means setting a date when you
  5326. want to start working on an action item.
  5327. @end table
  5328. You may use timestamps with repeaters in scheduling and deadline
  5329. entries. Org mode will issue early and late warnings based on the
  5330. assumption that the timestamp represents the @i{nearest instance} of
  5331. the repeater. However, the use of diary sexp entries like
  5332. @c
  5333. @code{<%%(diary-float t 42)>}
  5334. @c
  5335. in scheduling and deadline timestamps is limited. Org mode does not
  5336. know enough about the internals of each sexp function to issue early and
  5337. late warnings. However, it will show the item on each day where the
  5338. sexp entry matches.
  5339. @menu
  5340. * Inserting deadline/schedule:: Planning items
  5341. * Repeated tasks:: Items that show up again and again
  5342. @end menu
  5343. @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
  5344. @subsection Inserting deadlines or schedules
  5345. The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
  5346. @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
  5347. any text between this line and the headline.} a deadline or to schedule
  5348. an item:
  5349. @table @kbd
  5350. @c
  5351. @orgcmd{C-c C-d,org-deadline}
  5352. Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
  5353. in the line directly following the headline. Any CLOSED timestamp will be
  5354. removed. When called with a prefix arg, an existing deadline will be removed
  5355. from the entry. Depending on the variable @var{org-log-redeadline}@footnote{with corresponding
  5356. @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
  5357. and @code{nologredeadline}}, a note will be taken when changing an existing
  5358. deadline.
  5359. @orgcmd{C-c C-s,org-schedule}
  5360. Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
  5361. happen in the line directly following the headline. Any CLOSED timestamp
  5362. will be removed. When called with a prefix argument, remove the scheduling
  5363. date from the entry. Depending on the variable
  5364. @var{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
  5365. keywords @code{logreschedule}, @code{lognotereschedule}, and
  5366. @code{nologreschedule}}, a note will be taken when changing an existing
  5367. scheduling time.
  5368. @c
  5369. @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
  5370. @kindex k a
  5371. @kindex k s
  5372. Mark the current entry for agenda action. After you have marked the entry
  5373. like this, you can open the agenda or the calendar to find an appropriate
  5374. date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
  5375. schedule the marked item.
  5376. @c
  5377. @orgcmd{C-c / d,org-check-deadlines}
  5378. @cindex sparse tree, for deadlines
  5379. @vindex org-deadline-warning-days
  5380. Create a sparse tree with all deadlines that are either past-due, or
  5381. which will become due within @var{org-deadline-warning-days}.
  5382. With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
  5383. prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
  5384. all deadlines due tomorrow.
  5385. @c
  5386. @orgcmd{C-c / b,org-check-before-date}
  5387. Sparse tree for deadlines and scheduled items before a given date.
  5388. @c
  5389. @orgcmd{C-c / a,org-check-after-date}
  5390. Sparse tree for deadlines and scheduled items after a given date.
  5391. @end table
  5392. Note that @code{org-schedule} and @code{org-deadline} supports
  5393. setting the date by indicating a relative time: e.g., +1d will set
  5394. the date to the next day after today, and --1w will set the date
  5395. to the previous week before any current timestamp.
  5396. @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
  5397. @subsection Repeated tasks
  5398. @cindex tasks, repeated
  5399. @cindex repeated tasks
  5400. Some tasks need to be repeated again and again. Org mode helps to
  5401. organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
  5402. or plain timestamp. In the following example
  5403. @example
  5404. ** TODO Pay the rent
  5405. DEADLINE: <2005-10-01 Sat +1m>
  5406. @end example
  5407. @noindent
  5408. the @code{+1m} is a repeater; the intended interpretation is that the task
  5409. has a deadline on <2005-10-01> and repeats itself every (one) month starting
  5410. from that time. You can use yearly, monthly, weekly, daily and hourly repeat
  5411. cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater
  5412. and a special warning period in a deadline entry, the repeater should come
  5413. first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
  5414. @vindex org-todo-repeat-to-state
  5415. Deadlines and scheduled items produce entries in the agenda when they are
  5416. over-due, so it is important to be able to mark such an entry as completed
  5417. once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
  5418. keyword DONE, it will no longer produce entries in the agenda. The problem
  5419. with this is, however, that then also the @emph{next} instance of the
  5420. repeated entry will not be active. Org mode deals with this in the following
  5421. way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
  5422. shift the base date of the repeating timestamp by the repeater interval, and
  5423. immediately set the entry state back to TODO@footnote{In fact, the target
  5424. state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
  5425. the variable @var{org-todo-repeat-to-state}. If neither of these is
  5426. specified, the target state defaults to the first state of the TODO state
  5427. sequence.}. In the example above, setting the state to DONE would actually
  5428. switch the date like this:
  5429. @example
  5430. ** TODO Pay the rent
  5431. DEADLINE: <2005-11-01 Tue +1m>
  5432. @end example
  5433. @vindex org-log-repeat
  5434. A timestamp@footnote{You can change this using the option
  5435. @var{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
  5436. @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
  5437. will also be prompted for a note.} will be added under the deadline, to keep
  5438. a record that you actually acted on the previous instance of this deadline.
  5439. As a consequence of shifting the base date, this entry will no longer be
  5440. visible in the agenda when checking past dates, but all future instances
  5441. will be visible.
  5442. With the @samp{+1m} cookie, the date shift will always be exactly one
  5443. month. So if you have not paid the rent for three months, marking this
  5444. entry DONE will still keep it as an overdue deadline. Depending on the
  5445. task, this may not be the best way to handle it. For example, if you
  5446. forgot to call your father for 3 weeks, it does not make sense to call
  5447. him 3 times in a single day to make up for it. Finally, there are tasks
  5448. like changing batteries which should always repeat a certain time
  5449. @i{after} the last time you did it. For these tasks, Org mode has
  5450. special repeaters @samp{++} and @samp{.+}. For example:
  5451. @example
  5452. ** TODO Call Father
  5453. DEADLINE: <2008-02-10 Sun ++1w>
  5454. Marking this DONE will shift the date by at least one week,
  5455. but also by as many weeks as it takes to get this date into
  5456. the future. However, it stays on a Sunday, even if you called
  5457. and marked it done on Saturday.
  5458. ** TODO Check the batteries in the smoke detectors
  5459. DEADLINE: <2005-11-01 Tue .+1m>
  5460. Marking this DONE will shift the date to one month after
  5461. today.
  5462. @end example
  5463. @vindex org-agenda-skip-scheduled-if-deadline-is-shown
  5464. You may have both scheduling and deadline information for a specific task.
  5465. If the repeater is set for the scheduling information only, you probably want
  5466. the repeater to be ignored after the deadline. If so, set the variable
  5467. @var{org-agenda-skip-scheduled-if-deadline-is-shown} to
  5468. @code{repeated-after-deadline}. If you want both scheduling and deadline
  5469. information to repeat after the same interval, set the same repeater for both
  5470. timestamps.
  5471. An alternative to using a repeater is to create a number of copies of a task
  5472. subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
  5473. created for this purpose, it is described in @ref{Structure editing}.
  5474. @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
  5475. @section Clocking work time
  5476. @cindex clocking time
  5477. @cindex time clocking
  5478. Org mode allows you to clock the time you spend on specific tasks in a
  5479. project. When you start working on an item, you can start the clock. When
  5480. you stop working on that task, or when you mark the task done, the clock is
  5481. stopped and the corresponding time interval is recorded. It also computes
  5482. the total time spent on each subtree@footnote{Clocking only works if all
  5483. headings are indented with less than 30 stars. This is a hardcoded
  5484. limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a
  5485. history or tasks recently clocked, to that you can jump quickly between a
  5486. number of tasks absorbing your time.
  5487. To save the clock history across Emacs sessions, use
  5488. @lisp
  5489. (setq org-clock-persist 'history)
  5490. (org-clock-persistence-insinuate)
  5491. @end lisp
  5492. When you clock into a new task after resuming Emacs, the incomplete
  5493. clock@footnote{To resume the clock under the assumption that you have worked
  5494. on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
  5495. will be found (@pxref{Resolving idle time}) and you will be prompted about
  5496. what to do with it.
  5497. @menu
  5498. * Clocking commands:: Starting and stopping a clock
  5499. * The clock table:: Detailed reports
  5500. * Resolving idle time:: Resolving time when you've been idle
  5501. @end menu
  5502. @node Clocking commands, The clock table, Clocking work time, Clocking work time
  5503. @subsection Clocking commands
  5504. @table @kbd
  5505. @orgcmd{C-c C-x C-i,org-clock-in}
  5506. @vindex org-clock-into-drawer
  5507. @vindex org-clock-continuously
  5508. @cindex property, LOG_INTO_DRAWER
  5509. Start the clock on the current item (clock-in). This inserts the CLOCK
  5510. keyword together with a timestamp. If this is not the first clocking of
  5511. this item, the multiple CLOCK lines will be wrapped into a
  5512. @code{:LOGBOOK:} drawer (see also the variable
  5513. @var{org-clock-into-drawer}). You can also overrule
  5514. the setting of this variable for a subtree by setting a
  5515. @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
  5516. When called with a @kbd{C-u} prefix argument,
  5517. select the task from a list of recently clocked tasks. With two @kbd{C-u
  5518. C-u} prefixes, clock into the task at point and mark it as the default task;
  5519. the default task will then always be available with letter @kbd{d} when
  5520. selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
  5521. continuous clocking by starting the clock when the last clock stopped.@*
  5522. @cindex property: CLOCK_MODELINE_TOTAL
  5523. @cindex property: LAST_REPEAT
  5524. @vindex org-clock-modeline-total
  5525. While the clock is running, the current clocking time is shown in the mode
  5526. line, along with the title of the task. The clock time shown will be all
  5527. time ever clocked for this task and its children. If the task has an effort
  5528. estimate (@pxref{Effort estimates}), the mode line displays the current
  5529. clocking time against it@footnote{To add an effort estimate ``on the fly'',
  5530. hook a function doing this to @var{org-clock-in-prepare-hook}.} If the task
  5531. is a repeating one (@pxref{Repeated tasks}), only the time since the last
  5532. reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
  5533. will be shown. More control over what time is shown can be exercised with
  5534. the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
  5535. @code{current} to show only the current clocking instance, @code{today} to
  5536. show all time clocked on this tasks today (see also the variable
  5537. @var{org-extend-today-until}), @code{all} to include all time, or
  5538. @code{auto} which is the default@footnote{See also the variable
  5539. @var{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
  5540. mode line entry will pop up a menu with clocking options.
  5541. @c
  5542. @orgcmd{C-c C-x C-o,org-clock-out}
  5543. @vindex org-log-note-clock-out
  5544. Stop the clock (clock-out). This inserts another timestamp at the same
  5545. location where the clock was last started. It also directly computes
  5546. the resulting time in inserts it after the time range as @samp{=>
  5547. HH:MM}. See the variable @var{org-log-note-clock-out} for the
  5548. possibility to record an additional note together with the clock-out
  5549. timestamp@footnote{The corresponding in-buffer setting is:
  5550. @code{#+STARTUP: lognoteclock-out}}.
  5551. @orgcmd{C-c C-x C-x,org-clock-in-last}
  5552. @vindex org-clock-continuously
  5553. Reclock the last clocked task. With one @kbd{C-u} prefix argument,
  5554. select the task from the clock history. With two @kbd{C-u} prefixes,
  5555. force continuous clocking by starting the clock when the last clock
  5556. stopped.
  5557. @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
  5558. Update the effort estimate for the current clock task.
  5559. @kindex C-c C-y
  5560. @kindex C-c C-c
  5561. @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
  5562. Recompute the time interval after changing one of the timestamps. This
  5563. is only necessary if you edit the timestamps directly. If you change
  5564. them with @kbd{S-@key{cursor}} keys, the update is automatic.
  5565. @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
  5566. On @code{CLOCK} log lines, increase/decrease both timestamps so that the
  5567. clock duration keeps the same.
  5568. @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
  5569. On @code{CLOCK} log lines, increase/decrease the timestamp at point and
  5570. the one of the previous (or the next clock) timestamp by the same duration.
  5571. For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
  5572. by five minutes, then the clocked-in timestamp of the next clock will be
  5573. increased by five minutes.
  5574. @orgcmd{C-c C-t,org-todo}
  5575. Changing the TODO state of an item to DONE automatically stops the clock
  5576. if it is running in this same item.
  5577. @orgcmd{C-c C-x C-q,org-clock-cancel}
  5578. Cancel the current clock. This is useful if a clock was started by
  5579. mistake, or if you ended up working on something else.
  5580. @orgcmd{C-c C-x C-j,org-clock-goto}
  5581. Jump to the headline of the currently clocked in task. With a @kbd{C-u}
  5582. prefix arg, select the target task from a list of recently clocked tasks.
  5583. @orgcmd{C-c C-x C-d,org-clock-display}
  5584. @vindex org-remove-highlights-with-change
  5585. Display time summaries for each subtree in the current buffer. This puts
  5586. overlays at the end of each headline, showing the total time recorded under
  5587. that heading, including the time of any subheadings. You can use visibility
  5588. cycling to study the tree, but the overlays disappear when you change the
  5589. buffer (see variable @var{org-remove-highlights-with-change}) or press
  5590. @kbd{C-c C-c}.
  5591. @end table
  5592. The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
  5593. the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
  5594. worked on or closed during a day.
  5595. @strong{Important:} note that both @code{org-clock-out} and
  5596. @code{org-clock-in-last} can have a global keybinding and will not
  5597. modify the window disposition.
  5598. @node The clock table, Resolving idle time, Clocking commands, Clocking work time
  5599. @subsection The clock table
  5600. @cindex clocktable, dynamic block
  5601. @cindex report, of clocked time
  5602. Org mode can produce quite complex reports based on the time clocking
  5603. information. Such a report is called a @emph{clock table}, because it is
  5604. formatted as one or several Org tables.
  5605. @table @kbd
  5606. @orgcmd{C-c C-x C-r,org-clock-report}
  5607. Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
  5608. report as an Org mode table into the current file. When the cursor is
  5609. at an existing clock table, just update it. When called with a prefix
  5610. argument, jump to the first clock report in the current document and
  5611. update it. The clock table always includes also trees with
  5612. @code{:ARCHIVE:} tag.
  5613. @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
  5614. Update dynamic block at point. The cursor needs to be in the
  5615. @code{#+BEGIN} line of the dynamic block.
  5616. @orgkey{C-u C-c C-x C-u}
  5617. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  5618. you have several clock table blocks in a buffer.
  5619. @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
  5620. Shift the current @code{:block} interval and update the table. The cursor
  5621. needs to be in the @code{#+BEGIN: clocktable} line for this command. If
  5622. @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
  5623. @end table
  5624. Here is an example of the frame for a clock table as it is inserted into the
  5625. buffer with the @kbd{C-c C-x C-r} command:
  5626. @cindex #+BEGIN, clocktable
  5627. @example
  5628. #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
  5629. #+END: clocktable
  5630. @end example
  5631. @noindent
  5632. @vindex org-clocktable-defaults
  5633. The @samp{BEGIN} line and specify a number of options to define the scope,
  5634. structure, and formatting of the report. Defaults for all these options can
  5635. be configured in the variable @var{org-clocktable-defaults}.
  5636. @noindent First there are options that determine which clock entries are to
  5637. be selected:
  5638. @example
  5639. :maxlevel @r{Maximum level depth to which times are listed in the table.}
  5640. @r{Clocks at deeper levels will be summed into the upper level.}
  5641. :scope @r{The scope to consider. This can be any of the following:}
  5642. nil @r{the current buffer or narrowed region}
  5643. file @r{the full current buffer}
  5644. subtree @r{the subtree where the clocktable is located}
  5645. tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
  5646. tree @r{the surrounding level 1 tree}
  5647. agenda @r{all agenda files}
  5648. ("file"..) @r{scan these files}
  5649. file-with-archives @r{current file and its archives}
  5650. agenda-with-archives @r{all agenda files, including archives}
  5651. :block @r{The time block to consider. This block is specified either}
  5652. @r{absolute, or relative to the current time and may be any of}
  5653. @r{these formats:}
  5654. 2007-12-31 @r{New year eve 2007}
  5655. 2007-12 @r{December 2007}
  5656. 2007-W50 @r{ISO-week 50 in 2007}
  5657. 2007-Q2 @r{2nd quarter in 2007}
  5658. 2007 @r{the year 2007}
  5659. today, yesterday, today-@var{N} @r{a relative day}
  5660. thisweek, lastweek, thisweek-@var{N} @r{a relative week}
  5661. thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
  5662. thisyear, lastyear, thisyear-@var{N} @r{a relative year}
  5663. @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
  5664. :tstart @r{A time string specifying when to start considering times.}
  5665. @r{Relative times like @code{"<-2w>"} can also be used. See}
  5666. @r{@ref{Matching tags and properties} for relative time syntax.}
  5667. :tend @r{A time string specifying when to stop considering times.}
  5668. @r{Relative times like @code{"<now>"} can also be used. See}
  5669. @r{@ref{Matching tags and properties} for relative time syntax.}
  5670. :wstart @r{The starting day of the week. The default is 1 for monday.}
  5671. :mstart @r{The starting day of the month. The default 1 is for the first}
  5672. @r{day of the month.}
  5673. :step @r{@code{week} or @code{day}, to split the table into chunks.}
  5674. @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
  5675. :stepskip0 @r{Do not show steps that have zero time.}
  5676. :fileskip0 @r{Do not show table sections from files which did not contribute.}
  5677. :tags @r{A tags match to select entries that should contribute. See}
  5678. @r{@ref{Matching tags and properties} for the match syntax.}
  5679. @end example
  5680. Then there are options which determine the formatting of the table. There
  5681. options are interpreted by the function @code{org-clocktable-write-default},
  5682. but you can specify your own function using the @code{:formatter} parameter.
  5683. @example
  5684. :emphasize @r{When @code{t}, emphasize level one and level two items.}
  5685. :lang @r{Language@footnote{Language terms can be set through the variable @var{org-clock-clocktable-language-setup}.} to use for descriptive cells like "Task".}
  5686. :link @r{Link the item headlines in the table to their origins.}
  5687. :narrow @r{An integer to limit the width of the headline column in}
  5688. @r{the org table. If you write it like @samp{50!}, then the}
  5689. @r{headline will also be shortened in export.}
  5690. :indent @r{Indent each headline field according to its level.}
  5691. :tcolumns @r{Number of columns to be used for times. If this is smaller}
  5692. @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
  5693. :level @r{Should a level number column be included?}
  5694. :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
  5695. @r{All are overwritten except if there is an explicit @code{:narrow}}
  5696. :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
  5697. @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
  5698. :properties @r{List of properties that should be shown in the table. Each}
  5699. @r{property will get its own column.}
  5700. :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
  5701. :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
  5702. @r{As a special case, @samp{:formula %} adds a column with % time.}
  5703. @r{If you do not specify a formula here, any existing formula}
  5704. @r{below the clock table will survive updates and be evaluated.}
  5705. :formatter @r{A function to format clock data and insert it into the buffer.}
  5706. @end example
  5707. To get a clock summary of the current level 1 tree, for the current
  5708. day, you could write
  5709. @example
  5710. #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
  5711. #+END: clocktable
  5712. @end example
  5713. @noindent
  5714. and to use a specific time range you could write@footnote{Note that all
  5715. parameters must be specified in a single line---the line is broken here
  5716. only to fit it into the manual.}
  5717. @example
  5718. #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
  5719. :tend "<2006-08-10 Thu 12:00>"
  5720. #+END: clocktable
  5721. @end example
  5722. A range starting a week ago and ending right now could be written as
  5723. @example
  5724. #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
  5725. #+END: clocktable
  5726. @end example
  5727. A summary of the current subtree with % times would be
  5728. @example
  5729. #+BEGIN: clocktable :scope subtree :link t :formula %
  5730. #+END: clocktable
  5731. @end example
  5732. A horizontally compact representation of everything clocked during last week
  5733. would be
  5734. @example
  5735. #+BEGIN: clocktable :scope agenda :block lastweek :compact t
  5736. #+END: clocktable
  5737. @end example
  5738. @node Resolving idle time, , The clock table, Clocking work time
  5739. @subsection Resolving idle time and continuous clocking
  5740. @subsubheading Resolving idle time
  5741. @cindex resolve idle time
  5742. @vindex org-clock-x11idle-program-name
  5743. @cindex idle, resolve, dangling
  5744. If you clock in on a work item, and then walk away from your
  5745. computer---perhaps to take a phone call---you often need to ``resolve'' the
  5746. time you were away by either subtracting it from the current clock, or
  5747. applying it to another one.
  5748. @vindex org-clock-idle-time
  5749. By customizing the variable @var{org-clock-idle-time} to some integer, such
  5750. as 10 or 15, Emacs can alert you when you get back to your computer after
  5751. being idle for that many minutes@footnote{On computers using Mac OS X,
  5752. idleness is based on actual user idleness, not just Emacs' idle time. For
  5753. X11, you can install a utility program @file{x11idle.c}, available in the
  5754. @code{contrib/scripts} directory of the Org git distribution, or install the
  5755. @file{xprintidle} package and set it to the variable
  5756. @var{org-clock-x11idle-program-name} if you are running Debian, to get the
  5757. same general treatment of idleness. On other systems, idle time refers to
  5758. Emacs idle time only.}, and ask what you want to do with the idle time.
  5759. There will be a question waiting for you when you get back, indicating how
  5760. much idle time has passed (constantly updated with the current amount), as
  5761. well as a set of choices to correct the discrepancy:
  5762. @table @kbd
  5763. @item k
  5764. To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
  5765. will ask how many of the minutes to keep. Press @key{RET} to keep them all,
  5766. effectively changing nothing, or enter a number to keep that many minutes.
  5767. @item K
  5768. If you use the shift key and press @kbd{K}, it will keep however many minutes
  5769. you request and then immediately clock out of that task. If you keep all of
  5770. the minutes, this is the same as just clocking out of the current task.
  5771. @item s
  5772. To keep none of the minutes, use @kbd{s} to subtract all the away time from
  5773. the clock, and then check back in from the moment you returned.
  5774. @item S
  5775. To keep none of the minutes and just clock out at the start of the away time,
  5776. use the shift key and press @kbd{S}. Remember that using shift will always
  5777. leave you clocked out, no matter which option you choose.
  5778. @item C
  5779. To cancel the clock altogether, use @kbd{C}. Note that if instead of
  5780. canceling you subtract the away time, and the resulting clock amount is less
  5781. than a minute, the clock will still be canceled rather than clutter up the
  5782. log with an empty entry.
  5783. @end table
  5784. What if you subtracted those away minutes from the current clock, and now
  5785. want to apply them to a new clock? Simply clock in to any task immediately
  5786. after the subtraction. Org will notice that you have subtracted time ``on
  5787. the books'', so to speak, and will ask if you want to apply those minutes to
  5788. the next task you clock in on.
  5789. There is one other instance when this clock resolution magic occurs. Say you
  5790. were clocked in and hacking away, and suddenly your cat chased a mouse who
  5791. scared a hamster that crashed into your UPS's power button! You suddenly
  5792. lose all your buffers, but thanks to auto-save you still have your recent Org
  5793. mode changes, including your last clock in.
  5794. If you restart Emacs and clock into any task, Org will notice that you have a
  5795. dangling clock which was never clocked out from your last session. Using
  5796. that clock's starting time as the beginning of the unaccounted-for period,
  5797. Org will ask how you want to resolve that time. The logic and behavior is
  5798. identical to dealing with away time due to idleness; it is just happening due
  5799. to a recovery event rather than a set amount of idle time.
  5800. You can also check all the files visited by your Org agenda for dangling
  5801. clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
  5802. @subsubheading Continuous clocking
  5803. @cindex continuous clocking
  5804. @vindex org-clock-continuously
  5805. You may want to start clocking from the time when you clocked out the
  5806. previous task. To enable this systematically, set @var{org-clock-continuously}
  5807. to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
  5808. last clocked entry for this session, and start the new clock from there.
  5809. If you only want this from time to time, use three universal prefix arguments
  5810. with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
  5811. @node Effort estimates, Relative timer, Clocking work time, Dates and Times
  5812. @section Effort estimates
  5813. @cindex effort estimates
  5814. @cindex property, Effort
  5815. @vindex org-effort-property
  5816. If you want to plan your work in a very detailed way, or if you need to
  5817. produce offers with quotations of the estimated work effort, you may want to
  5818. assign effort estimates to entries. If you are also clocking your work, you
  5819. may later want to compare the planned effort with the actual working time, a
  5820. great way to improve planning estimates. Effort estimates are stored in a
  5821. special property @samp{Effort}@footnote{You may change the property being
  5822. used with the variable @var{org-effort-property}.}. You can set the effort
  5823. for an entry with the following commands:
  5824. @table @kbd
  5825. @orgcmd{C-c C-x e,org-set-effort}
  5826. Set the effort estimate for the current entry. With a numeric prefix
  5827. argument, set it to the Nth allowed value (see below). This command is also
  5828. accessible from the agenda with the @kbd{e} key.
  5829. @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
  5830. Modify the effort estimate of the item currently being clocked.
  5831. @end table
  5832. Clearly the best way to work with effort estimates is through column view
  5833. (@pxref{Column view}). You should start by setting up discrete values for
  5834. effort estimates, and a @code{COLUMNS} format that displays these values
  5835. together with clock sums (if you want to clock your time). For a specific
  5836. buffer you can use
  5837. @example
  5838. #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
  5839. #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
  5840. @end example
  5841. @noindent
  5842. @vindex org-global-properties
  5843. @vindex org-columns-default-format
  5844. or, even better, you can set up these values globally by customizing the
  5845. variables @var{org-global-properties} and @var{org-columns-default-format}.
  5846. In particular if you want to use this setup also in the agenda, a global
  5847. setup may be advised.
  5848. The way to assign estimates to individual items is then to switch to column
  5849. mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
  5850. value. The values you enter will immediately be summed up in the hierarchy.
  5851. In the column next to it, any clocked time will be displayed.
  5852. @vindex org-agenda-columns-add-appointments-to-effort-sum
  5853. If you switch to column view in the daily/weekly agenda, the effort column
  5854. will summarize the estimated work effort for each day@footnote{Please note
  5855. the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
  5856. column view}).}, and you can use this to find space in your schedule. To get
  5857. an overview of the entire part of the day that is committed, you can set the
  5858. option @var{org-agenda-columns-add-appointments-to-effort-sum}. The
  5859. appointments on a day that take place over a specified time interval will
  5860. then also be added to the load estimate of the day.
  5861. Effort estimates can be used in secondary agenda filtering that is triggered
  5862. with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
  5863. these estimates defined consistently, two or three key presses will narrow
  5864. down the list to stuff that fits into an available time slot.
  5865. @node Relative timer, Countdown timer, Effort estimates, Dates and Times
  5866. @section Taking notes with a relative timer
  5867. @cindex relative timer
  5868. When taking notes during, for example, a meeting or a video viewing, it can
  5869. be useful to have access to times relative to a starting time. Org provides
  5870. such a relative timer and make it easy to create timed notes.
  5871. @table @kbd
  5872. @orgcmd{C-c C-x .,org-timer}
  5873. Insert a relative time into the buffer. The first time you use this, the
  5874. timer will be started. When called with a prefix argument, the timer is
  5875. restarted.
  5876. @orgcmd{C-c C-x -,org-timer-item}
  5877. Insert a description list item with the current relative time. With a prefix
  5878. argument, first reset the timer to 0.
  5879. @orgcmd{M-@key{RET},org-insert-heading}
  5880. Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
  5881. new timer items.
  5882. @c for key sequences with a comma, command name macros fail :(
  5883. @kindex C-c C-x ,
  5884. @item C-c C-x ,
  5885. Pause the timer, or continue it if it is already paused
  5886. (@command{org-timer-pause-or-continue}).
  5887. @c removed the sentence because it is redundant to the following item
  5888. @kindex C-u C-c C-x ,
  5889. @item C-u C-c C-x ,
  5890. Stop the timer. After this, you can only start a new timer, not continue the
  5891. old one. This command also removes the timer from the mode line.
  5892. @orgcmd{C-c C-x 0,org-timer-start}
  5893. Reset the timer without inserting anything into the buffer. By default, the
  5894. timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
  5895. specific starting offset. The user is prompted for the offset, with a
  5896. default taken from a timer string at point, if any, So this can be used to
  5897. restart taking notes after a break in the process. When called with a double
  5898. prefix argument @kbd{C-u C-u}, change all timer strings in the active region
  5899. by a certain amount. This can be used to fix timer strings if the timer was
  5900. not started at exactly the right moment.
  5901. @end table
  5902. @node Countdown timer, , Relative timer, Dates and Times
  5903. @section Countdown timer
  5904. @cindex Countdown timer
  5905. @kindex C-c C-x ;
  5906. @kindex ;
  5907. Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
  5908. timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
  5909. @code{org-timer-set-timer} prompts the user for a duration and displays a
  5910. countdown timer in the modeline. @code{org-timer-default-timer} sets the
  5911. default countdown value. Giving a prefix numeric argument overrides this
  5912. default value.
  5913. @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
  5914. @chapter Capture - Refile - Archive
  5915. @cindex capture
  5916. An important part of any organization system is the ability to quickly
  5917. capture new ideas and tasks, and to associate reference material with them.
  5918. Org does this using a process called @i{capture}. It also can store files
  5919. related to a task (@i{attachments}) in a special directory. Once in the
  5920. system, tasks and projects need to be moved around. Moving completed project
  5921. trees to an archive file keeps the system compact and fast.
  5922. @menu
  5923. * Capture:: Capturing new stuff
  5924. * Attachments:: Add files to tasks
  5925. * RSS Feeds:: Getting input from RSS feeds
  5926. * Protocols:: External (e.g., Browser) access to Emacs and Org
  5927. * Refile and copy:: Moving/copying a tree from one place to another
  5928. * Archiving:: What to do with finished projects
  5929. @end menu
  5930. @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
  5931. @section Capture
  5932. @cindex capture
  5933. Capture lets you quickly store notes with little interruption of your work
  5934. flow. Org's method for capturing new items is heavily inspired by John
  5935. Wiegley excellent @file{remember.el} package. Up to version 6.36, Org
  5936. used a special setup for @file{remember.el}, then replaced it with
  5937. @file{org-remember.el}. As of version 8.0, @file{org-remember.el} has
  5938. been completely replaced by @file{org-capture.el}.
  5939. If your configuration depends on @file{org-remember.el}, you need to update
  5940. it and use the setup described below. To convert your
  5941. @var{org-remember-templates}, run the command
  5942. @example
  5943. @kbd{M-x org-capture-import-remember-templates RET}
  5944. @end example
  5945. @noindent and then customize the new variable with @kbd{M-x
  5946. customize-variable org-capture-templates}, check the result, and save the
  5947. customization.
  5948. @menu
  5949. * Setting up capture:: Where notes will be stored
  5950. * Using capture:: Commands to invoke and terminate capture
  5951. * Capture templates:: Define the outline of different note types
  5952. @end menu
  5953. @node Setting up capture, Using capture, Capture, Capture
  5954. @subsection Setting up capture
  5955. The following customization sets a default target file for notes, and defines
  5956. a global key@footnote{Please select your own key, @kbd{C-c c} is only a
  5957. suggestion.} for capturing new material.
  5958. @vindex org-default-notes-file
  5959. @smalllisp
  5960. @group
  5961. (setq org-default-notes-file (concat org-directory "/notes.org"))
  5962. (define-key global-map "\C-cc" 'org-capture)
  5963. @end group
  5964. @end smalllisp
  5965. @node Using capture, Capture templates, Setting up capture, Capture
  5966. @subsection Using capture
  5967. @table @kbd
  5968. @orgcmd{C-c c,org-capture}
  5969. Call the command @code{org-capture}. Note that this keybinding is global and
  5970. not active by default: you need to install it. If you have templates
  5971. @cindex date tree
  5972. defined @pxref{Capture templates}, it will offer these templates for
  5973. selection or use a new Org outline node as the default template. It will
  5974. insert the template into the target file and switch to an indirect buffer
  5975. narrowed to this new node. You may then insert the information you want.
  5976. @orgcmd{C-c C-c,org-capture-finalize}
  5977. Once you have finished entering information into the capture buffer, @kbd{C-c
  5978. C-c} will return you to the window configuration before the capture process,
  5979. so that you can resume your work without further distraction. When called
  5980. with a prefix arg, finalize and then jump to the captured item.
  5981. @orgcmd{C-c C-w,org-capture-refile}
  5982. Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
  5983. a different place. Please realize that this is a normal refiling command
  5984. that will be executed---so the cursor position at the moment you run this
  5985. command is important. If you have inserted a tree with a parent and
  5986. children, first move the cursor back to the parent. Any prefix argument
  5987. given to this command will be passed on to the @code{org-refile} command.
  5988. @orgcmd{C-c C-k,org-capture-kill}
  5989. Abort the capture process and return to the previous state.
  5990. @end table
  5991. You can also call @code{org-capture} in a special way from the agenda, using
  5992. the @kbd{k c} key combination. With this access, any timestamps inserted by
  5993. the selected capture template will default to the cursor date in the agenda,
  5994. rather than to the current date.
  5995. To find the locations of the last stored capture, use @code{org-capture} with
  5996. prefix commands:
  5997. @table @kbd
  5998. @orgkey{C-u C-c c}
  5999. Visit the target location of a capture template. You get to select the
  6000. template in the usual way.
  6001. @orgkey{C-u C-u C-c c}
  6002. Visit the last stored capture item in its buffer.
  6003. @end table
  6004. @vindex org-capture-bookmark
  6005. @cindex org-capture-last-stored
  6006. You can also jump to the bookmark @var{org-capture-last-stored}, which will
  6007. automatically be created unless you set @var{org-capture-bookmark} to
  6008. @code{nil}.
  6009. To insert the capture at point in an Org buffer, call @code{org-capture} with
  6010. a @code{C-0} prefix argument.
  6011. @node Capture templates, , Using capture, Capture
  6012. @subsection Capture templates
  6013. @cindex templates, for Capture
  6014. You can use templates for different types of capture items, and
  6015. for different target locations. The easiest way to create such templates is
  6016. through the customize interface.
  6017. @table @kbd
  6018. @orgkey{C-c c C}
  6019. Customize the variable @var{org-capture-templates}.
  6020. @end table
  6021. Before we give the formal description of template definitions, let's look at
  6022. an example. Say you would like to use one template to create general TODO
  6023. entries, and you want to put these entries under the heading @samp{Tasks} in
  6024. your file @file{~/org/gtd.org}. Also, a date tree in the file
  6025. @file{journal.org} should capture journal entries. A possible configuration
  6026. would look like:
  6027. @smalllisp
  6028. @group
  6029. (setq org-capture-templates
  6030. '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
  6031. "* TODO %?\n %i\n %a")
  6032. ("j" "Journal" entry (file+datetree "~/org/journal.org")
  6033. "* %?\nEntered on %U\n %i\n %a")))
  6034. @end group
  6035. @end smalllisp
  6036. @noindent If you then press @kbd{C-c c t}, Org will prepare the template
  6037. for you like this:
  6038. @example
  6039. * TODO
  6040. [[file:@var{link to where you initiated capture}]]
  6041. @end example
  6042. @noindent
  6043. During expansion of the template, @code{%a} has been replaced by a link to
  6044. the location from where you called the capture command. This can be
  6045. extremely useful for deriving tasks from emails, for example. You fill in
  6046. the task definition, press @kbd{C-c C-c} and Org returns you to the same
  6047. place where you started the capture process.
  6048. To define special keys to capture to a particular template without going
  6049. through the interactive template selection, you can create your key binding
  6050. like this:
  6051. @lisp
  6052. (define-key global-map "\C-cx"
  6053. (lambda () (interactive) (org-capture nil "x")))
  6054. @end lisp
  6055. @menu
  6056. * Template elements:: What is needed for a complete template entry
  6057. * Template expansion:: Filling in information about time and context
  6058. * Templates in contexts:: Only show a template in a specific context
  6059. @end menu
  6060. @node Template elements, Template expansion, Capture templates, Capture templates
  6061. @subsubsection Template elements
  6062. Now lets look at the elements of a template definition. Each entry in
  6063. @var{org-capture-templates} is a list with the following items:
  6064. @table @var
  6065. @item keys
  6066. The keys that will select the template, as a string, characters
  6067. only, for example @code{"a"} for a template to be selected with a
  6068. single key, or @code{"bt"} for selection with two keys. When using
  6069. several keys, keys using the same prefix key must be sequential
  6070. in the list and preceded by a 2-element entry explaining the
  6071. prefix key, for example
  6072. @smalllisp
  6073. ("b" "Templates for marking stuff to buy")
  6074. @end smalllisp
  6075. @noindent If you do not define a template for the @kbd{C} key, this key will
  6076. be used to open the customize buffer for this complex variable.
  6077. @item description
  6078. A short string describing the template, which will be shown during
  6079. selection.
  6080. @item type
  6081. The type of entry, a symbol. Valid values are:
  6082. @table @code
  6083. @item entry
  6084. An Org mode node, with a headline. Will be filed as the child of the target
  6085. entry or as a top-level entry. The target file should be an Org mode file.
  6086. @item item
  6087. A plain list item, placed in the first plain list at the target
  6088. location. Again the target file should be an Org file.
  6089. @item checkitem
  6090. A checkbox item. This only differs from the plain list item by the
  6091. default template.
  6092. @item table-line
  6093. a new line in the first table at the target location. Where exactly the
  6094. line will be inserted depends on the properties @code{:prepend} and
  6095. @code{:table-line-pos} (see below).
  6096. @item plain
  6097. Text to be inserted as it is.
  6098. @end table
  6099. @item target
  6100. @vindex org-default-notes-file
  6101. Specification of where the captured item should be placed. In Org mode
  6102. files, targets usually define a node. Entries will become children of this
  6103. node. Other types will be added to the table or list in the body of this
  6104. node. Most target specifications contain a file name. If that file name is
  6105. the empty string, it defaults to @var{org-default-notes-file}. A file can
  6106. also be given as a variable, function, or Emacs Lisp form.
  6107. Valid values are:
  6108. @table @code
  6109. @item (file "path/to/file")
  6110. Text will be placed at the beginning or end of that file.
  6111. @item (id "id of existing org entry")
  6112. Filing as child of this entry, or in the body of the entry.
  6113. @item (file+headline "path/to/file" "node headline")
  6114. Fast configuration if the target heading is unique in the file.
  6115. @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
  6116. For non-unique headings, the full path is safer.
  6117. @item (file+regexp "path/to/file" "regexp to find location")
  6118. Use a regular expression to position the cursor.
  6119. @item (file+datetree "path/to/file")
  6120. Will create a heading in a date tree for today's date.
  6121. @item (file+datetree+prompt "path/to/file")
  6122. Will create a heading in a date tree, but will prompt for the date.
  6123. @item (file+function "path/to/file" function-finding-location)
  6124. A function to find the right location in the file.
  6125. @item (clock)
  6126. File to the entry that is currently being clocked.
  6127. @item (function function-finding-location)
  6128. Most general way, write your own function to find both
  6129. file and location.
  6130. @end table
  6131. @item template
  6132. The template for creating the capture item. If you leave this empty, an
  6133. appropriate default template will be used. Otherwise this is a string with
  6134. escape codes, which will be replaced depending on time and context of the
  6135. capture call. The string with escapes may be loaded from a template file,
  6136. using the special syntax @code{(file "path/to/template")}. See below for
  6137. more details.
  6138. @item properties
  6139. The rest of the entry is a property list of additional options.
  6140. Recognized properties are:
  6141. @table @code
  6142. @item :prepend
  6143. Normally new captured information will be appended at
  6144. the target location (last child, last table line, last list item...).
  6145. Setting this property will change that.
  6146. @item :immediate-finish
  6147. When set, do not offer to edit the information, just
  6148. file it away immediately. This makes sense if the template only needs
  6149. information that can be added automatically.
  6150. @item :empty-lines
  6151. Set this to the number of lines to insert
  6152. before and after the new item. Default 0, only common other value is 1.
  6153. @item :clock-in
  6154. Start the clock in this item.
  6155. @item :clock-keep
  6156. Keep the clock running when filing the captured entry.
  6157. @item :clock-resume
  6158. If starting the capture interrupted a clock, restart that clock when finished
  6159. with the capture. Note that @code{:clock-keep} has precedence over
  6160. @code{:clock-resume}. When setting both to @code{t}, the current clock will
  6161. run and the previous one will not be resumed.
  6162. @item :unnarrowed
  6163. Do not narrow the target buffer, simply show the full buffer. Default is to
  6164. narrow it so that you only see the new material.
  6165. @item :table-line-pos
  6166. Specification of the location in the table where the new line should be
  6167. inserted. It should be a string like @code{"II-3"} meaning that the new
  6168. line should become the third line before the second horizontal separator
  6169. line.
  6170. @item :kill-buffer
  6171. If the target file was not yet visited when capture was invoked, kill the
  6172. buffer again after capture is completed.
  6173. @end table
  6174. @end table
  6175. @node Template expansion, Templates in contexts, Template elements, Capture templates
  6176. @subsubsection Template expansion
  6177. In the template itself, special @kbd{%}-escapes@footnote{If you need one of
  6178. these sequences literally, escape the @kbd{%} with a backslash.} allow
  6179. dynamic insertion of content. The templates are expanded in the order given here:
  6180. @smallexample
  6181. %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
  6182. %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
  6183. @r{For convenience, %:keyword (see below) placeholders}
  6184. @r{within the expression will be expanded prior to this.}
  6185. @r{The sexp must return a string.}
  6186. %<...> @r{The result of format-time-string on the ... format specification.}
  6187. %t @r{Timestamp, date only.}
  6188. %T @r{Timestamp, with date and time.}
  6189. %u, %U @r{Like the above, but inactive timestamps.}
  6190. %i @r{Initial content, the region when capture is called while the}
  6191. @r{region is active.}
  6192. @r{The entire text will be indented like @code{%i} itself.}
  6193. %a @r{Annotation, normally the link created with @code{org-store-link}.}
  6194. %A @r{Like @code{%a}, but prompt for the description part.}
  6195. %l @r{Like %a, but only insert the literal link.}
  6196. %c @r{Current kill ring head.}
  6197. %x @r{Content of the X clipboard.}
  6198. %k @r{Title of the currently clocked task.}
  6199. %K @r{Link to the currently clocked task.}
  6200. %n @r{User name (taken from @var{user-full-name}).}
  6201. %f @r{File visited by current buffer when org-capture was called.}
  6202. %F @r{Full path of the file or directory visited by current buffer.}
  6203. %:keyword @r{Specific information for certain link types, see below.}
  6204. %^g @r{Prompt for tags, with completion on tags in target file.}
  6205. %^G @r{Prompt for tags, with completion all tags in all agenda files.}
  6206. %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
  6207. @r{You may define a prompt like @code{%^@{Birthday@}t}.}
  6208. %^C @r{Interactive selection of which kill or clip to use.}
  6209. %^L @r{Like @code{%^C}, but insert as link.}
  6210. %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
  6211. %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
  6212. @r{You may specify a default value and a completion table with}
  6213. @r{%^@{prompt|default|completion2|completion3...@}.}
  6214. @r{The arrow keys access a prompt-specific history.}
  6215. %\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
  6216. @r{a number, starting from 1.}
  6217. %? @r{After completing the template, position cursor here.}
  6218. @end smallexample
  6219. @noindent
  6220. For specific link types, the following keywords will be
  6221. defined@footnote{If you define your own link types (@pxref{Adding
  6222. hyperlink types}), any property you store with
  6223. @code{org-store-link-props} can be accessed in capture templates in a
  6224. similar way.}:
  6225. @vindex org-from-is-user-regexp
  6226. @smallexample
  6227. Link type | Available keywords
  6228. ---------------------------------+----------------------------------------------
  6229. bbdb | %:name %:company
  6230. irc | %:server %:port %:nick
  6231. vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id
  6232. | %:from %:fromname %:fromaddress
  6233. | %:to %:toname %:toaddress
  6234. | %:date @r{(message date header field)}
  6235. | %:date-timestamp @r{(date as active timestamp)}
  6236. | %:date-timestamp-inactive @r{(date as inactive timestamp)}
  6237. | %:fromto @r{(either "to NAME" or "from NAME")@footnote{This will always be the other, not the user. See the variable @var{org-from-is-user-regexp}.}}
  6238. gnus | %:group, @r{for messages also all email fields}
  6239. w3, w3m | %:url
  6240. info | %:file %:node
  6241. calendar | %:date
  6242. @end smallexample
  6243. @noindent
  6244. To place the cursor after template expansion use:
  6245. @smallexample
  6246. %? @r{After completing the template, position cursor here.}
  6247. @end smallexample
  6248. @node Templates in contexts, , Template expansion, Capture templates
  6249. @subsubsection Templates in contexts
  6250. @vindex org-capture-templates-contexts
  6251. To control whether a capture template should be accessible from a specific
  6252. context, you can customize @var{org-capture-templates-contexts}. Let's say
  6253. for example that you have a capture template @code{"p"} for storing Gnus
  6254. emails containing patches. Then you would configure this option like this:
  6255. @smalllisp
  6256. (setq org-capture-templates-contexts
  6257. '(("p" (in-mode . "message-mode"))))
  6258. @end smalllisp
  6259. You can also tell that the command key @code{"p"} should refer to another
  6260. template. In that case, add this command key like this:
  6261. @smalllisp
  6262. (setq org-capture-templates-contexts
  6263. '(("p" "q" (in-mode . "message-mode"))))
  6264. @end smalllisp
  6265. See the docstring of the variable for more information.
  6266. @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
  6267. @section Attachments
  6268. @cindex attachments
  6269. @vindex org-attach-directory
  6270. It is often useful to associate reference material with an outline node/task.
  6271. Small chunks of plain text can simply be stored in the subtree of a project.
  6272. Hyperlinks (@pxref{Hyperlinks}) can establish associations with
  6273. files that live elsewhere on your computer or in the cloud, like emails or
  6274. source code files belonging to a project. Another method is @i{attachments},
  6275. which are files located in a directory belonging to an outline node. Org
  6276. uses directories named by the unique ID of each entry. These directories are
  6277. located in the @file{data} directory which lives in the same directory where
  6278. your Org file lives@footnote{If you move entries or Org files from one
  6279. directory to another, you may want to configure @var{org-attach-directory}
  6280. to contain an absolute path.}. If you initialize this directory with
  6281. @code{git init}, Org will automatically commit changes when it sees them.
  6282. The attachment system has been contributed to Org by John Wiegley.
  6283. In cases where it seems better to do so, you can also attach a directory of your
  6284. choice to an entry. You can also make children inherit the attachment
  6285. directory from a parent, so that an entire subtree uses the same attached
  6286. directory.
  6287. @noindent The following commands deal with attachments:
  6288. @table @kbd
  6289. @orgcmd{C-c C-a,org-attach}
  6290. The dispatcher for commands related to the attachment system. After these
  6291. keys, a list of commands is displayed and you must press an additional key
  6292. to select a command:
  6293. @table @kbd
  6294. @orgcmdtkc{a,C-c C-a a,org-attach-attach}
  6295. @vindex org-attach-method
  6296. Select a file and move it into the task's attachment directory. The file
  6297. will be copied, moved, or linked, depending on @var{org-attach-method}.
  6298. Note that hard links are not supported on all systems.
  6299. @kindex C-c C-a c
  6300. @kindex C-c C-a m
  6301. @kindex C-c C-a l
  6302. @item c/m/l
  6303. Attach a file using the copy/move/link method.
  6304. Note that hard links are not supported on all systems.
  6305. @orgcmdtkc{n,C-c C-a n,org-attach-new}
  6306. Create a new attachment as an Emacs buffer.
  6307. @orgcmdtkc{z,C-c C-a z,org-attach-sync}
  6308. Synchronize the current task with its attachment directory, in case you added
  6309. attachments yourself.
  6310. @orgcmdtkc{o,C-c C-a o,org-attach-open}
  6311. @vindex org-file-apps
  6312. Open current task's attachment. If there is more than one, prompt for a
  6313. file name first. Opening will follow the rules set by @var{org-file-apps}.
  6314. For more details, see the information on following hyperlinks
  6315. (@pxref{Handling links}).
  6316. @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
  6317. Also open the attachment, but force opening the file in Emacs.
  6318. @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
  6319. Open the current task's attachment directory.
  6320. @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
  6321. Also open the directory, but force using @command{dired} in Emacs.
  6322. @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
  6323. Select and delete a single attachment.
  6324. @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
  6325. Delete all of a task's attachments. A safer way is to open the directory in
  6326. @command{dired} and delete from there.
  6327. @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
  6328. @cindex property, ATTACH_DIR
  6329. Set a specific directory as the entry's attachment directory. This works by
  6330. putting the directory path into the @code{ATTACH_DIR} property.
  6331. @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
  6332. @cindex property, ATTACH_DIR_INHERIT
  6333. Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
  6334. same directory for attachments as the parent does.
  6335. @end table
  6336. @end table
  6337. @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
  6338. @section RSS feeds
  6339. @cindex RSS feeds
  6340. @cindex Atom feeds
  6341. Org can add and change entries based on information found in RSS feeds and
  6342. Atom feeds. You could use this to make a task out of each new podcast in a
  6343. podcast feed. Or you could use a phone-based note-creating service on the
  6344. web to import tasks into Org. To access feeds, configure the variable
  6345. @var{org-feed-alist}. The docstring of this variable has detailed
  6346. information. Here is just an example:
  6347. @smalllisp
  6348. @group
  6349. (setq org-feed-alist
  6350. '(("Slashdot"
  6351. "http://rss.slashdot.org/Slashdot/slashdot"
  6352. "~/txt/org/feeds.org" "Slashdot Entries")))
  6353. @end group
  6354. @end smalllisp
  6355. @noindent
  6356. will configure that new items from the feed provided by
  6357. @code{rss.slashdot.org} will result in new entries in the file
  6358. @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
  6359. the following command is used:
  6360. @table @kbd
  6361. @orgcmd{C-c C-x g,org-feed-update-all}
  6362. @item C-c C-x g
  6363. Collect items from the feeds configured in @var{org-feed-alist} and act upon
  6364. them.
  6365. @orgcmd{C-c C-x G,org-feed-goto-inbox}
  6366. Prompt for a feed name and go to the inbox configured for this feed.
  6367. @end table
  6368. Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
  6369. it will store information about the status of items in the feed, to avoid
  6370. adding the same item several times. You should add @samp{FEEDSTATUS} to the
  6371. list of drawers in that file:
  6372. @example
  6373. #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
  6374. @end example
  6375. For more information, including how to read atom feeds, see
  6376. @file{org-feed.el} and the docstring of @var{org-feed-alist}.
  6377. @node Protocols, Refile and copy, RSS Feeds, Capture - Refile - Archive
  6378. @section Protocols for external access
  6379. @cindex protocols, for external access
  6380. @cindex emacsserver
  6381. You can set up Org for handling protocol calls from outside applications that
  6382. are passed to Emacs through the @file{emacsserver}. For example, you can
  6383. configure bookmarks in your web browser to send a link to the current page to
  6384. Org and create a note from it using capture (@pxref{Capture}). Or you
  6385. could create a bookmark that will tell Emacs to open the local source file of
  6386. a remote website you are looking at with the browser. See
  6387. @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
  6388. documentation and setup instructions.
  6389. @node Refile and copy, Archiving, Protocols, Capture - Refile - Archive
  6390. @section Refile and copy
  6391. @cindex refiling notes
  6392. @cindex copying notes
  6393. When reviewing the captured data, you may want to refile or to copy some of
  6394. the entries into a different list, for example into a project. Cutting,
  6395. finding the right location, and then pasting the note is cumbersome. To
  6396. simplify this process, you can use the following special command:
  6397. @table @kbd
  6398. @orgcmd{C-c M-w,org-copy}
  6399. @findex org-copy
  6400. Copying works like refiling, except that the original note is not deleted.
  6401. @orgcmd{C-c C-w,org-refile}
  6402. @findex org-refile
  6403. @vindex org-reverse-note-order
  6404. @vindex org-refile-targets
  6405. @vindex org-refile-use-outline-path
  6406. @vindex org-outline-path-complete-in-steps
  6407. @vindex org-refile-allow-creating-parent-nodes
  6408. @vindex org-log-refile
  6409. @vindex org-refile-use-cache
  6410. Refile the entry or region at point. This command offers possible locations
  6411. for refiling the entry and lets you select one with completion. The item (or
  6412. all items in the region) is filed below the target heading as a subitem.
  6413. Depending on @var{org-reverse-note-order}, it will be either the first or
  6414. last subitem.@*
  6415. By default, all level 1 headlines in the current buffer are considered to be
  6416. targets, but you can have more complex definitions across a number of files.
  6417. See the variable @var{org-refile-targets} for details. If you would like to
  6418. select a location via a file-path-like completion along the outline path, see
  6419. the variables @var{org-refile-use-outline-path} and
  6420. @var{org-outline-path-complete-in-steps}. If you would like to be able to
  6421. create new nodes as new parents for refiling on the fly, check the
  6422. variable @var{org-refile-allow-creating-parent-nodes}.
  6423. When the variable @var{org-log-refile}@footnote{with corresponding
  6424. @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
  6425. and @code{nologrefile}} is set, a timestamp or a note will be
  6426. recorded when an entry has been refiled.
  6427. @orgkey{C-u C-c C-w}
  6428. Use the refile interface to jump to a heading.
  6429. @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
  6430. Jump to the location where @code{org-refile} last moved a tree to.
  6431. @item C-2 C-c C-w
  6432. Refile as the child of the item currently being clocked.
  6433. @orgcmdtkc{C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w,C-0 C-c C-w,org-refile-cache-clear}
  6434. Clear the target cache. Caching of refile targets can be turned on by
  6435. setting @var{org-refile-use-cache}. To make the command see new possible
  6436. targets, you have to clear the cache with this command.
  6437. @end table
  6438. @node Archiving, , Refile and copy, Capture - Refile - Archive
  6439. @section Archiving
  6440. @cindex archiving
  6441. When a project represented by a (sub)tree is finished, you may want
  6442. to move the tree out of the way and to stop it from contributing to the
  6443. agenda. Archiving is important to keep your working files compact and global
  6444. searches like the construction of agenda views fast.
  6445. @table @kbd
  6446. @orgcmd{C-c C-x C-a,org-archive-subtree-default}
  6447. @vindex org-archive-default-command
  6448. Archive the current entry using the command specified in the variable
  6449. @var{org-archive-default-command}.
  6450. @end table
  6451. @menu
  6452. * Moving subtrees:: Moving a tree to an archive file
  6453. * Internal archiving:: Switch off a tree but keep it in the file
  6454. @end menu
  6455. @node Moving subtrees, Internal archiving, Archiving, Archiving
  6456. @subsection Moving a tree to the archive file
  6457. @cindex external archiving
  6458. The most common archiving action is to move a project tree to another file,
  6459. the archive file.
  6460. @table @kbd
  6461. @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
  6462. @vindex org-archive-location
  6463. Archive the subtree starting at the cursor position to the location
  6464. given by @var{org-archive-location}.
  6465. @orgkey{C-u C-c C-x C-s}
  6466. Check if any direct children of the current headline could be moved to
  6467. the archive. To do this, each subtree is checked for open TODO entries.
  6468. If none are found, the command offers to move it to the archive
  6469. location. If the cursor is @emph{not} on a headline when this command
  6470. is invoked, the level 1 trees will be checked.
  6471. @end table
  6472. @cindex archive locations
  6473. The default archive location is a file in the same directory as the
  6474. current file, with the name derived by appending @file{_archive} to the
  6475. current file name. You can also choose what heading to file archived
  6476. items under, with the possibility to add them to a datetree in a file.
  6477. For information and examples on how to specify the file and the heading,
  6478. see the documentation string of the variable
  6479. @var{org-archive-location}.
  6480. There is also an in-buffer option for setting this variable, for
  6481. example@footnote{For backward compatibility, the following also works:
  6482. If there are several such lines in a file, each specifies the archive
  6483. location for the text below it. The first such line also applies to any
  6484. text before its definition. However, using this method is
  6485. @emph{strongly} deprecated as it is incompatible with the outline
  6486. structure of the document. The correct method for setting multiple
  6487. archive locations in a buffer is using properties.}:
  6488. @cindex #+ARCHIVE
  6489. @example
  6490. #+ARCHIVE: %s_done::
  6491. @end example
  6492. @cindex property, ARCHIVE
  6493. @noindent
  6494. If you would like to have a special ARCHIVE location for a single entry
  6495. or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
  6496. location as the value (@pxref{Properties and Columns}).
  6497. @vindex org-archive-save-context-info
  6498. When a subtree is moved, it receives a number of special properties that
  6499. record context information like the file from where the entry came, its
  6500. outline path the archiving time etc. Configure the variable
  6501. @var{org-archive-save-context-info} to adjust the amount of information
  6502. added.
  6503. @node Internal archiving, , Moving subtrees, Archiving
  6504. @subsection Internal archiving
  6505. If you want to just switch off (for agenda views) certain subtrees without
  6506. moving them to a different file, you can use the @code{ARCHIVE tag}.
  6507. A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
  6508. its location in the outline tree, but behaves in the following way:
  6509. @itemize @minus
  6510. @item
  6511. @vindex org-cycle-open-archived-trees
  6512. It does not open when you attempt to do so with a visibility cycling
  6513. command (@pxref{Visibility cycling}). You can force cycling archived
  6514. subtrees with @kbd{C-@key{TAB}}, or by setting the option
  6515. @var{org-cycle-open-archived-trees}. Also normal outline commands like
  6516. @code{show-all} will open archived subtrees.
  6517. @item
  6518. @vindex org-sparse-tree-open-archived-trees
  6519. During sparse tree construction (@pxref{Sparse trees}), matches in
  6520. archived subtrees are not exposed, unless you configure the option
  6521. @var{org-sparse-tree-open-archived-trees}.
  6522. @item
  6523. @vindex org-agenda-skip-archived-trees
  6524. During agenda view construction (@pxref{Agenda Views}), the content of
  6525. archived trees is ignored unless you configure the option
  6526. @var{org-agenda-skip-archived-trees}, in which case these trees will always
  6527. be included. In the agenda you can press @kbd{v a} to get archives
  6528. temporarily included.
  6529. @item
  6530. @vindex org-export-with-archived-trees
  6531. Archived trees are not exported (@pxref{Exporting}), only the headline
  6532. is. Configure the details using the variable
  6533. @var{org-export-with-archived-trees}.
  6534. @item
  6535. @vindex org-columns-skip-archived-trees
  6536. Archived trees are excluded from column view unless the variable
  6537. @var{org-columns-skip-archived-trees} is configured to @code{nil}.
  6538. @end itemize
  6539. The following commands help manage the ARCHIVE tag:
  6540. @table @kbd
  6541. @orgcmd{C-c C-x a,org-toggle-archive-tag}
  6542. Toggle the ARCHIVE tag for the current headline. When the tag is set,
  6543. the headline changes to a shadowed face, and the subtree below it is
  6544. hidden.
  6545. @orgkey{C-u C-c C-x a}
  6546. Check if any direct children of the current headline should be archived.
  6547. To do this, each subtree is checked for open TODO entries. If none are
  6548. found, the command offers to set the ARCHIVE tag for the child. If the
  6549. cursor is @emph{not} on a headline when this command is invoked, the
  6550. level 1 trees will be checked.
  6551. @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
  6552. Cycle a tree even if it is tagged with ARCHIVE.
  6553. @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
  6554. Move the current entry to the @emph{Archive Sibling}. This is a sibling of
  6555. the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
  6556. entry becomes a child of that sibling and in this way retains a lot of its
  6557. original context, including inherited tags and approximate position in the
  6558. outline.
  6559. @end table
  6560. @node Agenda Views, Markup, Capture - Refile - Archive, Top
  6561. @chapter Agenda views
  6562. @cindex agenda views
  6563. Due to the way Org works, TODO items, time-stamped items, and
  6564. tagged headlines can be scattered throughout a file or even a number of
  6565. files. To get an overview of open action items, or of events that are
  6566. important for a particular date, this information must be collected,
  6567. sorted and displayed in an organized way.
  6568. Org can select items based on various criteria and display them
  6569. in a separate buffer. Seven different view types are provided:
  6570. @itemize @bullet
  6571. @item
  6572. an @emph{agenda} that is like a calendar and shows information
  6573. for specific dates,
  6574. @item
  6575. a @emph{TODO list} that covers all unfinished
  6576. action items,
  6577. @item
  6578. a @emph{match view}, showings headlines based on the tags, properties, and
  6579. TODO state associated with them,
  6580. @item
  6581. a @emph{timeline view} that shows all events in a single Org file,
  6582. in time-sorted view,
  6583. @item
  6584. a @emph{text search view} that shows all entries from multiple files
  6585. that contain specified keywords,
  6586. @item
  6587. a @emph{stuck projects view} showing projects that currently don't move
  6588. along, and
  6589. @item
  6590. @emph{custom views} that are special searches and combinations of different
  6591. views.
  6592. @end itemize
  6593. @noindent
  6594. The extracted information is displayed in a special @emph{agenda
  6595. buffer}. This buffer is read-only, but provides commands to visit the
  6596. corresponding locations in the original Org files, and even to
  6597. edit these files remotely.
  6598. @vindex org-agenda-window-setup
  6599. @vindex org-agenda-restore-windows-after-quit
  6600. Two variables control how the agenda buffer is displayed and whether the
  6601. window configuration is restored when the agenda exits:
  6602. @var{org-agenda-window-setup} and
  6603. @var{org-agenda-restore-windows-after-quit}.
  6604. @menu
  6605. * Agenda files:: Files being searched for agenda information
  6606. * Agenda dispatcher:: Keyboard access to agenda views
  6607. * Built-in agenda views:: What is available out of the box?
  6608. * Presentation and sorting:: How agenda items are prepared for display
  6609. * Agenda commands:: Remote editing of Org trees
  6610. * Custom agenda views:: Defining special searches and views
  6611. * Exporting Agenda Views:: Writing a view to a file
  6612. * Agenda column view:: Using column view for collected entries
  6613. @end menu
  6614. @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
  6615. @section Agenda files
  6616. @cindex agenda files
  6617. @cindex files for agenda
  6618. @vindex org-agenda-files
  6619. The information to be shown is normally collected from all @emph{agenda
  6620. files}, the files listed in the variable
  6621. @var{org-agenda-files}@footnote{If the value of that variable is not a
  6622. list, but a single file name, then the list of agenda files will be
  6623. maintained in that external file.}. If a directory is part of this list,
  6624. all files with the extension @file{.org} in this directory will be part
  6625. of the list.
  6626. Thus, even if you only work with a single Org file, that file should
  6627. be put into the list@footnote{When using the dispatcher, pressing
  6628. @kbd{<} before selecting a command will actually limit the command to
  6629. the current file, and ignore @var{org-agenda-files} until the next
  6630. dispatcher command.}. You can customize @var{org-agenda-files}, but
  6631. the easiest way to maintain it is through the following commands
  6632. @cindex files, adding to agenda list
  6633. @table @kbd
  6634. @orgcmd{C-c [,org-agenda-file-to-front}
  6635. Add current file to the list of agenda files. The file is added to
  6636. the front of the list. If it was already in the list, it is moved to
  6637. the front. With a prefix argument, file is added/moved to the end.
  6638. @orgcmd{C-c ],org-remove-file}
  6639. Remove current file from the list of agenda files.
  6640. @kindex C-,
  6641. @cindex cycling, of agenda files
  6642. @orgcmd{C-',org-cycle-agenda-files}
  6643. @itemx C-,
  6644. Cycle through agenda file list, visiting one file after the other.
  6645. @kindex M-x org-iswitchb
  6646. @item M-x org-iswitchb RET
  6647. Command to use an @code{iswitchb}-like interface to switch to and between Org
  6648. buffers.
  6649. @end table
  6650. @noindent
  6651. The Org menu contains the current list of files and can be used
  6652. to visit any of them.
  6653. If you would like to focus the agenda temporarily on a file not in
  6654. this list, or on just one file in the list, or even on only a subtree in a
  6655. file, then this can be done in different ways. For a single agenda command,
  6656. you may press @kbd{<} once or several times in the dispatcher
  6657. (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
  6658. extended period, use the following commands:
  6659. @table @kbd
  6660. @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
  6661. Permanently restrict the agenda to the current subtree. When with a
  6662. prefix argument, or with the cursor before the first headline in a file,
  6663. the agenda scope is set to the entire file. This restriction remains in
  6664. effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
  6665. or @kbd{>} in the agenda dispatcher. If there is a window displaying an
  6666. agenda view, the new restriction takes effect immediately.
  6667. @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
  6668. Remove the permanent restriction created by @kbd{C-c C-x <}.
  6669. @end table
  6670. @noindent
  6671. When working with @file{speedbar.el}, you can use the following commands in
  6672. the Speedbar frame:
  6673. @table @kbd
  6674. @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
  6675. Permanently restrict the agenda to the item---either an Org file or a subtree
  6676. in such a file---at the cursor in the Speedbar frame.
  6677. If there is a window displaying an agenda view, the new restriction takes
  6678. effect immediately.
  6679. @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
  6680. Lift the restriction.
  6681. @end table
  6682. @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
  6683. @section The agenda dispatcher
  6684. @cindex agenda dispatcher
  6685. @cindex dispatching agenda commands
  6686. The views are created through a dispatcher, which should be bound to a
  6687. global key---for example @kbd{C-c a} (@pxref{Activation}). In the
  6688. following we will assume that @kbd{C-c a} is indeed how the dispatcher
  6689. is accessed and list keyboard access to commands accordingly. After
  6690. pressing @kbd{C-c a}, an additional letter is required to execute a
  6691. command. The dispatcher offers the following default commands:
  6692. @table @kbd
  6693. @item a
  6694. Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
  6695. @item t @r{/} T
  6696. Create a list of all TODO items (@pxref{Global TODO list}).
  6697. @item m @r{/} M
  6698. Create a list of headlines matching a TAGS expression (@pxref{Matching
  6699. tags and properties}).
  6700. @item L
  6701. Create the timeline view for the current buffer (@pxref{Timeline}).
  6702. @item s
  6703. Create a list of entries selected by a boolean expression of keywords
  6704. and/or regular expressions that must or must not occur in the entry.
  6705. @item /
  6706. @vindex org-agenda-text-search-extra-files
  6707. Search for a regular expression in all agenda files and additionally in
  6708. the files listed in @var{org-agenda-text-search-extra-files}. This
  6709. uses the Emacs command @code{multi-occur}. A prefix argument can be
  6710. used to specify the number of context lines for each match, default is
  6711. 1.
  6712. @item # @r{/} !
  6713. Create a list of stuck projects (@pxref{Stuck projects}).
  6714. @item <
  6715. Restrict an agenda command to the current buffer@footnote{For backward
  6716. compatibility, you can also press @kbd{1} to restrict to the current
  6717. buffer.}. After pressing @kbd{<}, you still need to press the character
  6718. selecting the command.
  6719. @item < <
  6720. If there is an active region, restrict the following agenda command to
  6721. the region. Otherwise, restrict it to the current subtree@footnote{For
  6722. backward compatibility, you can also press @kbd{0} to restrict to the
  6723. current region/subtree.}. After pressing @kbd{< <}, you still need to press the
  6724. character selecting the command.
  6725. @item *
  6726. @vindex org-agenda-sticky
  6727. Toggle sticky agenda views. By default, Org maintains only a single agenda
  6728. buffer and rebuilds it each time you change the view, to make sure everything
  6729. is always up to date. If you switch between views often and the build time
  6730. bothers you, you can turn on sticky agenda buffers (make this the default by
  6731. customizing the variable @var{org-agenda-sticky}). With sticky agendas, the
  6732. dispatcher only switches to the selected view, you need to update it by hand
  6733. with @kbd{r} or @kbd{g}. You can toggle sticky agenda view any time with
  6734. @code{org-toggle-sticky-agenda}.
  6735. @end table
  6736. You can also define custom commands that will be accessible through the
  6737. dispatcher, just like the default commands. This includes the
  6738. possibility to create extended agenda buffers that contain several
  6739. blocks together, for example the weekly agenda, the global TODO list and
  6740. a number of special tags matches. @xref{Custom agenda views}.
  6741. @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
  6742. @section The built-in agenda views
  6743. In this section we describe the built-in views.
  6744. @menu
  6745. * Weekly/daily agenda:: The calendar page with current tasks
  6746. * Global TODO list:: All unfinished action items
  6747. * Matching tags and properties:: Structured information with fine-tuned search
  6748. * Timeline:: Time-sorted view for single file
  6749. * Search view:: Find entries by searching for text
  6750. * Stuck projects:: Find projects you need to review
  6751. @end menu
  6752. @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
  6753. @subsection The weekly/daily agenda
  6754. @cindex agenda
  6755. @cindex weekly agenda
  6756. @cindex daily agenda
  6757. The purpose of the weekly/daily @emph{agenda} is to act like a page of a
  6758. paper agenda, showing all the tasks for the current week or day.
  6759. @table @kbd
  6760. @cindex org-agenda, command
  6761. @orgcmd{C-c a a,org-agenda-list}
  6762. Compile an agenda for the current week from a list of Org files. The agenda
  6763. shows the entries for each day. With a numeric prefix@footnote{For backward
  6764. compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
  6765. listed before the agenda. This feature is deprecated, use the dedicated TODO
  6766. list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
  6767. C-c a a}) you may set the number of days to be displayed.
  6768. @end table
  6769. @vindex org-agenda-span
  6770. @vindex org-agenda-ndays
  6771. @vindex org-agenda-start-day
  6772. @vindex org-agenda-start-on-weekday
  6773. The default number of days displayed in the agenda is set by the variable
  6774. @var{org-agenda-span} (or the obsolete @var{org-agenda-ndays}). This
  6775. variable can be set to any number of days you want to see by default in the
  6776. agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
  6777. @code{year}. For weekly agendas, the default is to start on the previous
  6778. monday (see @var{org-agenda-start-on-weekday}). You can also set the start
  6779. date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
  6780. start the agenda ten days from today in the future.
  6781. Remote editing from the agenda buffer means, for example, that you can
  6782. change the dates of deadlines and appointments from the agenda buffer.
  6783. The commands available in the Agenda buffer are listed in @ref{Agenda
  6784. commands}.
  6785. @subsubheading Calendar/Diary integration
  6786. @cindex calendar integration
  6787. @cindex diary integration
  6788. Emacs contains the calendar and diary by Edward M. Reingold. The
  6789. calendar displays a three-month calendar with holidays from different
  6790. countries and cultures. The diary allows you to keep track of
  6791. anniversaries, lunar phases, sunrise/set, recurrent appointments
  6792. (weekly, monthly) and more. In this way, it is quite complementary to
  6793. Org. It can be very useful to combine output from Org with
  6794. the diary.
  6795. In order to include entries from the Emacs diary into Org mode's
  6796. agenda, you only need to customize the variable
  6797. @lisp
  6798. (setq org-agenda-include-diary t)
  6799. @end lisp
  6800. @noindent After that, everything will happen automatically. All diary
  6801. entries including holidays, anniversaries, etc., will be included in the
  6802. agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
  6803. @key{RET} can be used from the agenda buffer to jump to the diary
  6804. file in order to edit existing diary entries. The @kbd{i} command to
  6805. insert new entries for the current date works in the agenda buffer, as
  6806. well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
  6807. Sunrise/Sunset times, show lunar phases and to convert to other
  6808. calendars, respectively. @kbd{c} can be used to switch back and forth
  6809. between calendar and agenda.
  6810. If you are using the diary only for sexp entries and holidays, it is
  6811. faster to not use the above setting, but instead to copy or even move
  6812. the entries into an Org file. Org mode evaluates diary-style sexp
  6813. entries, and does it faster because there is no overhead for first
  6814. creating the diary display. Note that the sexp entries must start at
  6815. the left margin, no whitespace is allowed before them. For example,
  6816. the following segment of an Org file will be processed and entries
  6817. will be made in the agenda:
  6818. @example
  6819. * Birthdays and similar stuff
  6820. #+CATEGORY: Holiday
  6821. %%(org-calendar-holiday) ; special function for holiday names
  6822. #+CATEGORY: Ann
  6823. %%(org-anniversary 1956 5 14)@footnote{@code{org-anniversary} is just like @code{diary-anniversary}, but the argument order is always according to ISO and therefore independent of the value of @var{calendar-date-style}.} Arthur Dent is %d years old
  6824. %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
  6825. @end example
  6826. @subsubheading Anniversaries from BBDB
  6827. @cindex BBDB, anniversaries
  6828. @cindex anniversaries, from BBDB
  6829. If you are using the Big Brothers Database to store your contacts, you will
  6830. very likely prefer to store anniversaries in BBDB rather than in a
  6831. separate Org or diary file. Org supports this and will show BBDB
  6832. anniversaries as part of the agenda. All you need to do is to add the
  6833. following to one of your agenda files:
  6834. @example
  6835. * Anniversaries
  6836. :PROPERTIES:
  6837. :CATEGORY: Anniv
  6838. :END:
  6839. %%(org-bbdb-anniversaries)
  6840. @end example
  6841. You can then go ahead and define anniversaries for a BBDB record. Basically,
  6842. you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
  6843. record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
  6844. followed by a space and the class of the anniversary (@samp{birthday} or
  6845. @samp{wedding}, or a format string). If you omit the class, it will default to
  6846. @samp{birthday}. Here are a few examples, the header for the file
  6847. @file{org-bbdb.el} contains more detailed information.
  6848. @example
  6849. 1973-06-22
  6850. 06-22
  6851. 1955-08-02 wedding
  6852. 2008-04-14 %s released version 6.01 of org mode, %d years ago
  6853. @end example
  6854. After a change to BBDB, or for the first agenda display during an Emacs
  6855. session, the agenda display will suffer a short delay as Org updates its
  6856. hash with anniversaries. However, from then on things will be very fast---much
  6857. faster in fact than a long list of @samp{%%(diary-anniversary)} entries
  6858. in an Org or Diary file.
  6859. @subsubheading Appointment reminders
  6860. @cindex @file{appt.el}
  6861. @cindex appointment reminders
  6862. @cindex appointment
  6863. @cindex reminders
  6864. Org can interact with Emacs appointments notification facility. To add the
  6865. appointments of your agenda files, use the command @code{org-agenda-to-appt}.
  6866. This command lets you filter through the list of your appointments and add
  6867. only those belonging to a specific category or matching a regular expression.
  6868. It also reads a @code{APPT_WARNTIME} property which will then override the
  6869. value of @var{appt-message-warning-time} for this appointment. See the
  6870. docstring for details.
  6871. @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
  6872. @subsection The global TODO list
  6873. @cindex global TODO list
  6874. @cindex TODO list, global
  6875. The global TODO list contains all unfinished TODO items formatted and
  6876. collected into a single place.
  6877. @table @kbd
  6878. @orgcmd{C-c a t,org-todo-list}
  6879. Show the global TODO list. This collects the TODO items from all agenda
  6880. files (@pxref{Agenda Views}) into a single buffer. By default, this lists
  6881. items with a state the is not a DONE state. The buffer is in
  6882. @code{agenda-mode}, so there are commands to examine and manipulate the TODO
  6883. entries directly from that buffer (@pxref{Agenda commands}).
  6884. @orgcmd{C-c a T,org-todo-list}
  6885. @cindex TODO keyword matching
  6886. @vindex org-todo-keywords
  6887. Like the above, but allows selection of a specific TODO keyword. You can
  6888. also do this by specifying a prefix argument to @kbd{C-c a t}. You are
  6889. prompted for a keyword, and you may also specify several keywords by
  6890. separating them with @samp{|} as the boolean OR operator. With a numeric
  6891. prefix, the Nth keyword in @var{org-todo-keywords} is selected.
  6892. @kindex r
  6893. The @kbd{r} key in the agenda buffer regenerates it, and you can give
  6894. a prefix argument to this command to change the selected TODO keyword,
  6895. for example @kbd{3 r}. If you often need a search for a specific
  6896. keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
  6897. Matching specific TODO keywords can also be done as part of a tags
  6898. search (@pxref{Tag searches}).
  6899. @end table
  6900. Remote editing of TODO items means that you can change the state of a
  6901. TODO entry with a single key press. The commands available in the
  6902. TODO list are described in @ref{Agenda commands}.
  6903. @cindex sublevels, inclusion into TODO list
  6904. Normally the global TODO list simply shows all headlines with TODO
  6905. keywords. This list can become very long. There are two ways to keep
  6906. it more compact:
  6907. @itemize @minus
  6908. @item
  6909. @vindex org-agenda-todo-ignore-scheduled
  6910. @vindex org-agenda-todo-ignore-deadlines
  6911. @vindex org-agenda-todo-ignore-timestamp
  6912. @vindex org-agenda-todo-ignore-with-date
  6913. Some people view a TODO item that has been @emph{scheduled} for execution or
  6914. have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
  6915. Configure the variables @var{org-agenda-todo-ignore-scheduled},
  6916. @var{org-agenda-todo-ignore-deadlines},
  6917. @var{org-agenda-todo-ignore-timestamp} and/or
  6918. @var{org-agenda-todo-ignore-with-date} to exclude such items from the global
  6919. TODO list.
  6920. @item
  6921. @vindex org-agenda-todo-list-sublevels
  6922. TODO items may have sublevels to break up the task into subtasks. In
  6923. such cases it may be enough to list only the highest level TODO headline
  6924. and omit the sublevels from the global list. Configure the variable
  6925. @var{org-agenda-todo-list-sublevels} to get this behavior.
  6926. @end itemize
  6927. @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
  6928. @subsection Matching tags and properties
  6929. @cindex matching, of tags
  6930. @cindex matching, of properties
  6931. @cindex tags view
  6932. @cindex match view
  6933. If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
  6934. or have properties (@pxref{Properties and Columns}), you can select headlines
  6935. based on this metadata and collect them into an agenda buffer. The match
  6936. syntax described here also applies when creating sparse trees with @kbd{C-c /
  6937. m}.
  6938. @table @kbd
  6939. @orgcmd{C-c a m,org-tags-view}
  6940. Produce a list of all headlines that match a given set of tags. The
  6941. command prompts for a selection criterion, which is a boolean logic
  6942. expression with tags, like @samp{+work+urgent-withboss} or
  6943. @samp{work|home} (@pxref{Tags}). If you often need a specific search,
  6944. define a custom command for it (@pxref{Agenda dispatcher}).
  6945. @orgcmd{C-c a M,org-tags-view}
  6946. @vindex org-tags-match-list-sublevels
  6947. @vindex org-agenda-tags-todo-honor-ignore-options
  6948. Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
  6949. not-DONE state and force checking subitems (see variable
  6950. @var{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
  6951. see the variable @var{org-agenda-tags-todo-honor-ignore-options}. Matching
  6952. specific TODO keywords together with a tags match is also possible, see
  6953. @ref{Tag searches}.
  6954. @end table
  6955. The commands available in the tags list are described in @ref{Agenda
  6956. commands}.
  6957. @subsubheading Match syntax
  6958. @cindex Boolean logic, for tag/property searches
  6959. A search string can use Boolean operators @samp{&} for @code{AND} and
  6960. @samp{|} for @code{OR}@. @samp{&} binds more strongly than @samp{|}.
  6961. Parentheses are not implemented. Each element in the search is either a
  6962. tag, a regular expression matching tags, or an expression like
  6963. @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
  6964. property value. Each element may be preceded by @samp{-}, to select
  6965. against it, and @samp{+} is syntactic sugar for positive selection. The
  6966. @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
  6967. present. Here are some examples, using only tags.
  6968. @table @samp
  6969. @item work
  6970. Select headlines tagged @samp{:work:}.
  6971. @item work&boss
  6972. Select headlines tagged @samp{:work:} and @samp{:boss:}.
  6973. @item +work-boss
  6974. Select headlines tagged @samp{:work:}, but discard those also tagged
  6975. @samp{:boss:}.
  6976. @item work|laptop
  6977. Selects lines tagged @samp{:work:} or @samp{:laptop:}.
  6978. @item work|laptop+night
  6979. Like before, but require the @samp{:laptop:} lines to be tagged also
  6980. @samp{:night:}.
  6981. @end table
  6982. @cindex regular expressions, with tags search
  6983. Instead of a tag, you may also specify a regular expression enclosed in curly
  6984. braces. For example,
  6985. @samp{work+@{^boss.*@}} matches headlines that contain the tag
  6986. @samp{:work:} and any tag @i{starting} with @samp{boss}.
  6987. @cindex group tags, as regular expressions
  6988. Group tags (@pxref{Tag groups}) are expanded as regular expressions. E.g.,
  6989. if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
  6990. searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
  6991. and searching for @samp{-work} will search for all headlines but those with
  6992. one of the tag in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
  6993. @cindex TODO keyword matching, with tags search
  6994. @cindex level, require for tags/property match
  6995. @cindex category, require for tags/property match
  6996. @vindex org-odd-levels-only
  6997. You may also test for properties (@pxref{Properties and Columns}) at the same
  6998. time as matching tags. The properties may be real properties, or special
  6999. properties that represent other metadata (@pxref{Special properties}). For
  7000. example, the ``property'' @code{TODO} represents the TODO keyword of the
  7001. entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
  7002. So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
  7003. that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
  7004. DONE@. In buffers with @var{org-odd-levels-only} set, @samp{LEVEL} does not
  7005. count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
  7006. The ITEM special property cannot currently be used in tags/property
  7007. searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
  7008. ,skipping entries based on regexp}.}.
  7009. Here are more examples:
  7010. @table @samp
  7011. @item work+TODO="WAITING"
  7012. Select @samp{:work:}-tagged TODO lines with the specific TODO
  7013. keyword @samp{WAITING}.
  7014. @item work+TODO="WAITING"|home+TODO="WAITING"
  7015. Waiting tasks both at work and at home.
  7016. @end table
  7017. When matching properties, a number of different operators can be used to test
  7018. the value of a property. Here is a complex example:
  7019. @example
  7020. +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
  7021. +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
  7022. @end example
  7023. @noindent
  7024. The type of comparison will depend on how the comparison value is written:
  7025. @itemize @minus
  7026. @item
  7027. If the comparison value is a plain number, a numerical comparison is done,
  7028. and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
  7029. @samp{>=}, and @samp{<>}.
  7030. @item
  7031. If the comparison value is enclosed in double-quotes,
  7032. a string comparison is done, and the same operators are allowed.
  7033. @item
  7034. If the comparison value is enclosed in double-quotes @emph{and} angular
  7035. brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
  7036. assumed to be date/time specifications in the standard Org way, and the
  7037. comparison will be done accordingly. Special values that will be recognized
  7038. are @code{"<now>"} for now (including time), and @code{"<today>"}, and
  7039. @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
  7040. specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
  7041. @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
  7042. respectively, can be used.
  7043. @item
  7044. If the comparison value is enclosed
  7045. in curly braces, a regexp match is performed, with @samp{=} meaning that the
  7046. regexp matches the property value, and @samp{<>} meaning that it does not
  7047. match.
  7048. @end itemize
  7049. So the search string in the example finds entries tagged @samp{:work:} but
  7050. not @samp{:boss:}, which also have a priority value @samp{A}, a
  7051. @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
  7052. property that is numerically smaller than 2, a @samp{:With:} property that is
  7053. matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
  7054. on or after October 11, 2008.
  7055. Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
  7056. other properties will slow down the search. However, once you have paid the
  7057. price by accessing one property, testing additional properties is cheap
  7058. again.
  7059. You can configure Org mode to use property inheritance during a search, but
  7060. beware that this can slow down searches considerably. See @ref{Property
  7061. inheritance}, for details.
  7062. For backward compatibility, and also for typing speed, there is also a
  7063. different way to test TODO states in a search. For this, terminate the
  7064. tags/property part of the search string (which may include several terms
  7065. connected with @samp{|}) with a @samp{/} and then specify a Boolean
  7066. expression just for TODO keywords. The syntax is then similar to that for
  7067. tags, but should be applied with care: for example, a positive selection on
  7068. several TODO keywords cannot meaningfully be combined with boolean AND@.
  7069. However, @emph{negative selection} combined with AND can be meaningful. To
  7070. make sure that only lines are checked that actually have any TODO keyword
  7071. (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
  7072. part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
  7073. not match TODO keywords in a DONE state. Examples:
  7074. @table @samp
  7075. @item work/WAITING
  7076. Same as @samp{work+TODO="WAITING"}
  7077. @item work/!-WAITING-NEXT
  7078. Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
  7079. nor @samp{NEXT}
  7080. @item work/!+WAITING|+NEXT
  7081. Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
  7082. @samp{NEXT}.
  7083. @end table
  7084. @node Timeline, Search view, Matching tags and properties, Built-in agenda views
  7085. @subsection Timeline for a single file
  7086. @cindex timeline, single file
  7087. @cindex time-sorted view
  7088. The timeline summarizes all time-stamped items from a single Org mode
  7089. file in a @emph{time-sorted view}. The main purpose of this command is
  7090. to give an overview over events in a project.
  7091. @table @kbd
  7092. @orgcmd{C-c a L,org-timeline}
  7093. Show a time-sorted view of the Org file, with all time-stamped items.
  7094. When called with a @kbd{C-u} prefix, all unfinished TODO entries
  7095. (scheduled or not) are also listed under the current date.
  7096. @end table
  7097. @noindent
  7098. The commands available in the timeline buffer are listed in
  7099. @ref{Agenda commands}.
  7100. @node Search view, Stuck projects, Timeline, Built-in agenda views
  7101. @subsection Search view
  7102. @cindex search view
  7103. @cindex text search
  7104. @cindex searching, for text
  7105. This agenda view is a general text search facility for Org mode entries.
  7106. It is particularly useful to find notes.
  7107. @table @kbd
  7108. @orgcmd{C-c a s,org-search-view}
  7109. This is a special search that lets you select entries by matching a substring
  7110. or specific words using a boolean logic.
  7111. @end table
  7112. For example, the search string @samp{computer equipment} will find entries
  7113. that contain @samp{computer equipment} as a substring. If the two words are
  7114. separated by more space or a line break, the search will still match.
  7115. Search view can also search for specific keywords in the entry, using Boolean
  7116. logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
  7117. will search for note entries that contain the keywords @code{computer}
  7118. and @code{wifi}, but not the keyword @code{ethernet}, and which are also
  7119. not matched by the regular expression @code{8\.11[bg]}, meaning to
  7120. exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
  7121. word search, other @samp{+} characters are optional. For more details, see
  7122. the docstring of the command @code{org-search-view}.
  7123. @vindex org-agenda-text-search-extra-files
  7124. Note that in addition to the agenda files, this command will also search
  7125. the files listed in @var{org-agenda-text-search-extra-files}.
  7126. @node Stuck projects, , Search view, Built-in agenda views
  7127. @subsection Stuck projects
  7128. @pindex GTD, Getting Things Done
  7129. If you are following a system like David Allen's GTD to organize your
  7130. work, one of the ``duties'' you have is a regular review to make sure
  7131. that all projects move along. A @emph{stuck} project is a project that
  7132. has no defined next actions, so it will never show up in the TODO lists
  7133. Org mode produces. During the review, you need to identify such
  7134. projects and define next actions for them.
  7135. @table @kbd
  7136. @orgcmd{C-c a #,org-agenda-list-stuck-projects}
  7137. List projects that are stuck.
  7138. @kindex C-c a !
  7139. @item C-c a !
  7140. @vindex org-stuck-projects
  7141. Customize the variable @var{org-stuck-projects} to define what a stuck
  7142. project is and how to find it.
  7143. @end table
  7144. You almost certainly will have to configure this view before it will
  7145. work for you. The built-in default assumes that all your projects are
  7146. level-2 headlines, and that a project is not stuck if it has at least
  7147. one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
  7148. Let's assume that you, in your own way of using Org mode, identify
  7149. projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
  7150. indicate a project that should not be considered yet. Let's further
  7151. assume that the TODO keyword DONE marks finished projects, and that NEXT
  7152. and TODO indicate next actions. The tag @@SHOP indicates shopping and
  7153. is a next action even without the NEXT tag. Finally, if the project
  7154. contains the special word IGNORE anywhere, it should not be listed
  7155. either. In this case you would start by identifying eligible projects
  7156. with a tags/todo match@footnote{@xref{Tag searches}.}
  7157. @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
  7158. IGNORE in the subtree to identify projects that are not stuck. The
  7159. correct customization for this is
  7160. @lisp
  7161. (setq org-stuck-projects
  7162. '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
  7163. "\\<IGNORE\\>"))
  7164. @end lisp
  7165. Note that if a project is identified as non-stuck, the subtree of this entry
  7166. will still be searched for stuck projects.
  7167. @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
  7168. @section Presentation and sorting
  7169. @cindex presentation, of agenda items
  7170. @vindex org-agenda-prefix-format
  7171. @vindex org-agenda-tags-column
  7172. Before displaying items in an agenda view, Org mode visually prepares the
  7173. items and sorts them. Each item occupies a single line. The line starts
  7174. with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
  7175. of the item and other important information. You can customize in which
  7176. column tags will be displayed through @var{org-agenda-tags-column}. You can
  7177. also customize the prefix using the option @var{org-agenda-prefix-format}.
  7178. This prefix is followed by a cleaned-up version of the outline headline
  7179. associated with the item.
  7180. @menu
  7181. * Categories:: Not all tasks are equal
  7182. * Time-of-day specifications:: How the agenda knows the time
  7183. * Sorting agenda items:: The order of things
  7184. * Filtering/limiting agenda items:: Dynamically narrow the agenda
  7185. @end menu
  7186. @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
  7187. @subsection Categories
  7188. @cindex category
  7189. @cindex #+CATEGORY
  7190. The category is a broad label assigned to each agenda item. By default,
  7191. the category is simply derived from the file name, but you can also
  7192. specify it with a special line in the buffer, like this@footnote{For
  7193. backward compatibility, the following also works: if there are several
  7194. such lines in a file, each specifies the category for the text below it.
  7195. The first category also applies to any text before the first CATEGORY
  7196. line. However, using this method is @emph{strongly} deprecated as it is
  7197. incompatible with the outline structure of the document. The correct
  7198. method for setting multiple categories in a buffer is using a
  7199. property.}:
  7200. @example
  7201. #+CATEGORY: Thesis
  7202. @end example
  7203. @noindent
  7204. @cindex property, CATEGORY
  7205. If you would like to have a special CATEGORY for a single entry or a
  7206. (sub)tree, give the entry a @code{:CATEGORY:} property with the
  7207. special category you want to apply as the value.
  7208. @noindent
  7209. The display in the agenda buffer looks best if the category is not
  7210. longer than 10 characters.
  7211. @noindent
  7212. You can set up icons for category by customizing the
  7213. @var{org-agenda-category-icon-alist} variable.
  7214. @node Time-of-day specifications, Sorting agenda items, Categories, Presentation and sorting
  7215. @subsection Time-of-day specifications
  7216. @cindex time-of-day specification
  7217. Org mode checks each agenda item for a time-of-day specification. The
  7218. time can be part of the timestamp that triggered inclusion into the
  7219. agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
  7220. ranges can be specified with two timestamps, like
  7221. @c
  7222. @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
  7223. In the headline of the entry itself, a time(range) may also appear as
  7224. plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
  7225. integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
  7226. specifications in diary entries are recognized as well.
  7227. For agenda display, Org mode extracts the time and displays it in a
  7228. standard 24 hour format as part of the prefix. The example times in
  7229. the previous paragraphs would end up in the agenda like this:
  7230. @example
  7231. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  7232. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  7233. 19:00...... The Vogon reads his poem
  7234. 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
  7235. @end example
  7236. @cindex time grid
  7237. If the agenda is in single-day mode, or for the display of today, the
  7238. timed entries are embedded in a time grid, like
  7239. @example
  7240. 8:00...... ------------------
  7241. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  7242. 10:00...... ------------------
  7243. 12:00...... ------------------
  7244. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  7245. 14:00...... ------------------
  7246. 16:00...... ------------------
  7247. 18:00...... ------------------
  7248. 19:00...... The Vogon reads his poem
  7249. 20:00...... ------------------
  7250. 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
  7251. @end example
  7252. @vindex org-agenda-use-time-grid
  7253. @vindex org-agenda-time-grid
  7254. The time grid can be turned on and off with the variable
  7255. @var{org-agenda-use-time-grid}, and can be configured with
  7256. @var{org-agenda-time-grid}.
  7257. @node Sorting agenda items, Filtering/limiting agenda items, Time-of-day specifications, Presentation and sorting
  7258. @subsection Sorting agenda items
  7259. @cindex sorting, of agenda items
  7260. @cindex priorities, of agenda items
  7261. Before being inserted into a view, the items are sorted. How this is
  7262. done depends on the type of view.
  7263. @itemize @bullet
  7264. @item
  7265. @vindex org-agenda-files
  7266. For the daily/weekly agenda, the items for each day are sorted. The
  7267. default order is to first collect all items containing an explicit
  7268. time-of-day specification. These entries will be shown at the beginning
  7269. of the list, as a @emph{schedule} for the day. After that, items remain
  7270. grouped in categories, in the sequence given by @var{org-agenda-files}.
  7271. Within each category, items are sorted by priority (@pxref{Priorities}),
  7272. which is composed of the base priority (2000 for priority @samp{A}, 1000
  7273. for @samp{B}, and 0 for @samp{C}), plus additional increments for
  7274. overdue scheduled or deadline items.
  7275. @item
  7276. For the TODO list, items remain in the order of categories, but within
  7277. each category, sorting takes place according to priority
  7278. (@pxref{Priorities}). The priority used for sorting derives from the
  7279. priority cookie, with additions depending on how close an item is to its due
  7280. or scheduled date.
  7281. @item
  7282. For tags matches, items are not sorted at all, but just appear in the
  7283. sequence in which they are found in the agenda files.
  7284. @end itemize
  7285. @vindex org-agenda-sorting-strategy
  7286. Sorting can be customized using the variable
  7287. @var{org-agenda-sorting-strategy}, and may also include criteria based on
  7288. the estimated effort of an entry (@pxref{Effort estimates}).
  7289. @node Filtering/limiting agenda items, , Sorting agenda items, Presentation and sorting
  7290. @subsection Filtering/limiting agenda items
  7291. Agenda built-in or customized commands are statically defined. Agenda
  7292. filters and limits provide two ways of dynamically narrowing down the list of
  7293. agenda entries: @emph{fitlers} and @emph{limits}. Filters only act on the
  7294. display of the items, while limits take effect before the list of agenda
  7295. entries is built. Filter are more often used interactively, while limits are
  7296. mostly useful when defined as local variables within custom agenda commands.
  7297. @subsubheading Filtering in the agenda
  7298. @cindex filtering, by tag, category, top headline and effort, in agenda
  7299. @cindex tag filtering, in agenda
  7300. @cindex category filtering, in agenda
  7301. @cindex top headline filtering, in agenda
  7302. @cindex effort filtering, in agenda
  7303. @cindex query editing, in agenda
  7304. @table @kbd
  7305. @orgcmd{/,org-agenda-filter-by-tag}
  7306. @vindex org-agenda-tag-filter-preset
  7307. Filter the agenda view with respect to a tag and/or effort estimates. The
  7308. difference between this and a custom agenda command is that filtering is very
  7309. fast, so that you can switch quickly between different filters without having
  7310. to recreate the agenda.@footnote{Custom commands can preset a filter by
  7311. binding the variable @var{org-agenda-tag-filter-preset} as an option. This
  7312. filter will then be applied to the view and persist as a basic filter through
  7313. refreshes and more secondary filtering. The filter is a global property of
  7314. the entire agenda view---in a block agenda, you should only set this in the
  7315. global options section, not in the section of an individual block.}
  7316. You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
  7317. all. Pressing @key{TAB} at that prompt will offer use completion to select a
  7318. tag (including any tags that do not have a selection character). The command
  7319. then hides all entries that do not contain or inherit this tag. When called
  7320. with prefix arg, remove the entries that @emph{do} have the tag. A second
  7321. @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
  7322. If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
  7323. will be narrowed by requiring or forbidding the selected additional tag.
  7324. Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
  7325. immediately use the @kbd{\} command.
  7326. @vindex org-sort-agenda-noeffort-is-high
  7327. In order to filter for effort estimates, you should set up allowed
  7328. efforts globally, for example
  7329. @lisp
  7330. (setq org-global-properties
  7331. '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
  7332. @end lisp
  7333. You can then filter for an effort by first typing an operator, one of
  7334. @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
  7335. estimate in your array of allowed values, where @kbd{0} means the 10th value.
  7336. The filter will then restrict to entries with effort smaller-or-equal, equal,
  7337. or larger-or-equal than the selected value. If the digits 0--9 are not used
  7338. as fast access keys to tags, you can also simply press the index digit
  7339. directly without an operator. In this case, @kbd{<} will be assumed. For
  7340. application of the operator, entries without a defined effort will be treated
  7341. according to the value of @var{org-sort-agenda-noeffort-is-high}. To filter
  7342. for tasks without effort definition, press @kbd{?} as the operator.
  7343. Org also supports automatic, context-aware tag filtering. If the variable
  7344. @var{org-agenda-auto-exclude-function} is set to a user-defined function,
  7345. that function can decide which tags should be excluded from the agenda
  7346. automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
  7347. as a sub-option key and runs the auto exclusion logic. For example, let's
  7348. say you use a @code{Net} tag to identify tasks which need network access, an
  7349. @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
  7350. calls. You could auto-exclude these tags based on the availability of the
  7351. Internet, and outside of business hours, with something like this:
  7352. @smalllisp
  7353. @group
  7354. (defun org-my-auto-exclude-function (tag)
  7355. (and (cond
  7356. ((string= tag "Net")
  7357. (/= 0 (call-process "/sbin/ping" nil nil nil
  7358. "-c1" "-q" "-t1" "mail.gnu.org")))
  7359. ((or (string= tag "Errand") (string= tag "Call"))
  7360. (let ((hour (nth 2 (decode-time))))
  7361. (or (< hour 8) (> hour 21)))))
  7362. (concat "-" tag)))
  7363. (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
  7364. @end group
  7365. @end smalllisp
  7366. @orgcmd{\\,org-agenda-filter-by-tag-refine}
  7367. Narrow the current agenda filter by an additional condition. When called with
  7368. prefix arg, remove the entries that @emph{do} have the tag, or that do match
  7369. the effort criterion. You can achieve the same effect by pressing @kbd{+} or
  7370. @kbd{-} as the first key after the @kbd{/} command.
  7371. @c
  7372. @kindex [
  7373. @kindex ]
  7374. @kindex @{
  7375. @kindex @}
  7376. @item [ ] @{ @}
  7377. @table @i
  7378. @item @r{in} search view
  7379. add new search words (@kbd{[} and @kbd{]}) or new regular expressions
  7380. (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
  7381. add a positive search term prefixed by @samp{+}, indicating that this search
  7382. term @i{must} occur/match in the entry. The closing bracket/brace will add a
  7383. negative search term which @i{must not} occur/match in the entry for it to be
  7384. selected.
  7385. @end table
  7386. @orgcmd{<,org-agenda-filter-by-category}
  7387. @vindex org-agenda-category-filter-preset
  7388. Filter the current agenda view with respect to the category of the item at
  7389. point. Pressing @code{<} another time will remove this filter. You can add
  7390. a filter preset through the option @var{org-agenda-category-filter-preset}
  7391. (see below.)
  7392. @orgcmd{^,org-agenda-filter-by-top-headline}
  7393. Filter the current agenda view and only display the siblings and the parent
  7394. headline of the one at point.
  7395. @orgcmd{=,org-agenda-filter-by-regexp}
  7396. @vindex org-agenda-regexp-filter-preset
  7397. Filter the agenda view by a regular expression: only show agenda entries
  7398. matching the regular expression the user entered. When called with a prefix
  7399. argument, it will filter @emph{out} entries matching the regexp. With two
  7400. universal prefix arguments, it will remove all the regexp filters, which can
  7401. be accumulated. You can add a filter preset through the option
  7402. @var{org-agenda-category-filter-preset} (see below.)
  7403. @orgcmd{|,org-agenda-filter-remove-all}
  7404. Remove all filters in the current agenda view.
  7405. @end table
  7406. @subsubheading Setting limits for the agenda
  7407. @cindex limits, in agenda
  7408. @vindex org-agenda-max-entries
  7409. @vindex org-agenda-max-effort
  7410. @vindex org-agenda-max-todos
  7411. @vindex org-agenda-max-tags
  7412. Here is a list of options that you can set, either globally, or locally in
  7413. your custom agenda views@pxref{Custom agenda views}.
  7414. @table @var
  7415. @item org-agenda-max-entries
  7416. Limit the number of entries.
  7417. @item org-agenda-max-effort
  7418. Limit the duration of accumulated efforts (as minutes).
  7419. @item org-agenda-max-todos
  7420. Limit the number of entries with TODO keywords.
  7421. @item org-agenda-max-tags
  7422. Limit the number of tagged entries.
  7423. @end table
  7424. When set to a positive integer, each option will exclude entries from other
  7425. catogories: for example, @code{(setq org-agenda-max-effort 100)} will limit
  7426. the agenda to 100 minutes of effort and exclude any entry that as no effort
  7427. property. If you want to include entries with no effort property, use a
  7428. negative value for @var{org-agenda-max-effort}.
  7429. One useful setup is to use @var{org-agenda-max-entries} locally in a custom
  7430. command. For example, this custom command will display the next five entries
  7431. with a @code{NEXT} TODO keyword.
  7432. @smalllisp
  7433. (setq org-agenda-custom-commands
  7434. '(("n" todo "NEXT"
  7435. ((org-agenda-max-entries 5)))))
  7436. @end smalllisp
  7437. Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
  7438. will again the next five entries again, including the first entry that was
  7439. excluded so far.
  7440. You can also dynamically set temporary limits@footnote{Those temporary limits
  7441. are lost when rebuilding the agenda.}:
  7442. @table @kbd
  7443. @orgcmd{~,org-agenda-limit-interactively}
  7444. This prompts for the type of limit to apply and its value.
  7445. @end table
  7446. @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
  7447. @section Commands in the agenda buffer
  7448. @cindex commands, in agenda buffer
  7449. Entries in the agenda buffer are linked back to the Org file or diary
  7450. file where they originate. You are not allowed to edit the agenda
  7451. buffer itself, but commands are provided to show and jump to the
  7452. original entry location, and to edit the Org files ``remotely'' from
  7453. the agenda buffer. In this way, all information is stored only once,
  7454. removing the risk that your agenda and note files may diverge.
  7455. Some commands can be executed with mouse clicks on agenda lines. For
  7456. the other commands, the cursor needs to be in the desired line.
  7457. @table @kbd
  7458. @tsubheading{Motion}
  7459. @cindex motion commands in agenda
  7460. @orgcmd{n,org-agenda-next-line}
  7461. Next line (same as @key{down} and @kbd{C-n}).
  7462. @orgcmd{p,org-agenda-previous-line}
  7463. Previous line (same as @key{up} and @kbd{C-p}).
  7464. @tsubheading{View/Go to Org file}
  7465. @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
  7466. Display the original location of the item in another window.
  7467. With prefix arg, make sure that the entire entry is made visible in the
  7468. outline, not only the heading.
  7469. @c
  7470. @orgcmd{L,org-agenda-recenter}
  7471. Display original location and recenter that window.
  7472. @c
  7473. @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
  7474. Go to the original location of the item in another window.
  7475. @c
  7476. @orgcmd{@key{RET},org-agenda-switch-to}
  7477. Go to the original location of the item and delete other windows.
  7478. @c
  7479. @orgcmd{F,org-agenda-follow-mode}
  7480. @vindex org-agenda-start-with-follow-mode
  7481. Toggle Follow mode. In Follow mode, as you move the cursor through
  7482. the agenda buffer, the other window always shows the corresponding
  7483. location in the Org file. The initial setting for this mode in new
  7484. agenda buffers can be set with the variable
  7485. @var{org-agenda-start-with-follow-mode}.
  7486. @c
  7487. @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
  7488. Display the entire subtree of the current item in an indirect buffer. With a
  7489. numeric prefix argument N, go up to level N and then take that tree. If N is
  7490. negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
  7491. previously used indirect buffer.
  7492. @orgcmd{C-c C-o,org-agenda-open-link}
  7493. Follow a link in the entry. This will offer a selection of any links in the
  7494. text belonging to the referenced Org node. If there is only one link, it
  7495. will be followed without a selection prompt.
  7496. @tsubheading{Change display}
  7497. @cindex display changing, in agenda
  7498. @kindex A
  7499. @item A
  7500. Interactively select another agenda view and append it to the current view.
  7501. @c
  7502. @kindex o
  7503. @item o
  7504. Delete other windows.
  7505. @c
  7506. @orgcmdkskc{v d,d,org-agenda-day-view}
  7507. @xorgcmdkskc{v w,w,org-agenda-week-view}
  7508. @xorgcmd{v m,org-agenda-month-view}
  7509. @xorgcmd{v y,org-agenda-year-view}
  7510. @xorgcmd{v SPC,org-agenda-reset-view}
  7511. @vindex org-agenda-span
  7512. Switch to day/week/month/year view. When switching to day or week view, this
  7513. setting becomes the default for subsequent agenda refreshes. Since month and
  7514. year views are slow to create, they do not become the default. A numeric
  7515. prefix argument may be used to jump directly to a specific day of the year,
  7516. ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
  7517. February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
  7518. month view, a year may be encoded in the prefix argument as well. For
  7519. example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
  7520. specification has only one or two digits, it will be mapped to the interval
  7521. 1938--2037. @kbd{v @key{SPC}} will reset to what is set in
  7522. @var{org-agenda-span}.
  7523. @c
  7524. @orgcmd{f,org-agenda-later}
  7525. Go forward in time to display the following @var{org-agenda-current-span} days.
  7526. For example, if the display covers a week, switch to the following week.
  7527. With prefix arg, go forward that many times @var{org-agenda-current-span} days.
  7528. @c
  7529. @orgcmd{b,org-agenda-earlier}
  7530. Go backward in time to display earlier dates.
  7531. @c
  7532. @orgcmd{.,org-agenda-goto-today}
  7533. Go to today.
  7534. @c
  7535. @orgcmd{j,org-agenda-goto-date}
  7536. Prompt for a date and go there.
  7537. @c
  7538. @orgcmd{J,org-agenda-clock-goto}
  7539. Go to the currently clocked-in task @i{in the agenda buffer}.
  7540. @c
  7541. @orgcmd{D,org-agenda-toggle-diary}
  7542. Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
  7543. @c
  7544. @orgcmdkskc{v l,l,org-agenda-log-mode}
  7545. @kindex v L
  7546. @vindex org-log-done
  7547. @vindex org-agenda-log-mode-items
  7548. Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
  7549. logging was on (variable @var{org-log-done}) are shown in the agenda, as are
  7550. entries that have been clocked on that day. You can configure the entry
  7551. types that should be included in log mode using the variable
  7552. @var{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
  7553. all possible logbook entries, including state changes. When called with two
  7554. prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
  7555. @kbd{v L} is equivalent to @kbd{C-u v l}.
  7556. @c
  7557. @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
  7558. Include inactive timestamps into the current view. Only for weekly/daily
  7559. agenda and timeline views.
  7560. @c
  7561. @orgcmd{v a,org-agenda-archives-mode}
  7562. @xorgcmd{v A,org-agenda-archives-mode 'files}
  7563. Toggle Archives mode. In Archives mode, trees that are marked
  7564. @code{ARCHIVED} are also scanned when producing the agenda. When you use the
  7565. capital @kbd{A}, even all archive files are included. To exit archives mode,
  7566. press @kbd{v a} again.
  7567. @c
  7568. @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
  7569. @vindex org-agenda-start-with-clockreport-mode
  7570. @vindex org-clock-report-include-clocking-task
  7571. Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
  7572. always show a table with the clocked times for the time span and file scope
  7573. covered by the current agenda view. The initial setting for this mode in new
  7574. agenda buffers can be set with the variable
  7575. @var{org-agenda-start-with-clockreport-mode}. By using a prefix argument
  7576. when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
  7577. contributions from entries that are hidden by agenda filtering@footnote{Only
  7578. tags filtering will be respected here, effort filtering is ignored.}. See
  7579. also the variable @var{org-clock-report-include-clocking-task}.
  7580. @c
  7581. @orgkey{v c}
  7582. @vindex org-agenda-clock-consistency-checks
  7583. Show overlapping clock entries, clocking gaps, and other clocking problems in
  7584. the current agenda range. You can then visit clocking lines and fix them
  7585. manually. See the variable @var{org-agenda-clock-consistency-checks} for
  7586. information on how to customize the definition of what constituted a clocking
  7587. problem. To return to normal agenda display, press @kbd{l} to exit Logbook
  7588. mode.
  7589. @c
  7590. @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
  7591. @vindex org-agenda-start-with-entry-text-mode
  7592. @vindex org-agenda-entry-text-maxlines
  7593. Toggle entry text mode. In entry text mode, a number of lines from the Org
  7594. outline node referenced by an agenda line will be displayed below the line.
  7595. The maximum number of lines is given by the variable
  7596. @var{org-agenda-entry-text-maxlines}. Calling this command with a numeric
  7597. prefix argument will temporarily modify that number to the prefix value.
  7598. @c
  7599. @orgcmd{G,org-agenda-toggle-time-grid}
  7600. @vindex org-agenda-use-time-grid
  7601. @vindex org-agenda-time-grid
  7602. Toggle the time grid on and off. See also the variables
  7603. @var{org-agenda-use-time-grid} and @var{org-agenda-time-grid}.
  7604. @c
  7605. @orgcmd{r,org-agenda-redo}
  7606. Recreate the agenda buffer, for example to reflect the changes after
  7607. modification of the timestamps of items with @kbd{S-@key{left}} and
  7608. @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
  7609. argument is interpreted to create a selective list for a specific TODO
  7610. keyword.
  7611. @orgcmd{g,org-agenda-redo}
  7612. Same as @kbd{r}.
  7613. @c
  7614. @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
  7615. Save all Org buffers in the current Emacs session, and also the locations of
  7616. IDs.
  7617. @c
  7618. @orgcmd{C-c C-x C-c,org-agenda-columns}
  7619. @vindex org-columns-default-format
  7620. Invoke column view (@pxref{Column view}) in the agenda buffer. The column
  7621. view format is taken from the entry at point, or (if there is no entry at
  7622. point), from the first entry in the agenda view. So whatever the format for
  7623. that entry would be in the original buffer (taken from a property, from a
  7624. @code{#+COLUMNS} line, or from the default variable
  7625. @var{org-columns-default-format}), will be used in the agenda.
  7626. @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
  7627. Remove the restriction lock on the agenda, if it is currently restricted to a
  7628. file or subtree (@pxref{Agenda files}).
  7629. @tsubheading{Secondary filtering and query editing}
  7630. For a detailed description of these commands, see @pxref{Filtering/limiting
  7631. agenda items}.
  7632. @orgcmd{/,org-agenda-filter-by-tag}
  7633. @vindex org-agenda-tag-filter-preset
  7634. Filter the agenda view with respect to a tag and/or effort estimates.
  7635. @orgcmd{\\,org-agenda-filter-by-tag-refine}
  7636. Narrow the current agenda filter by an additional condition.
  7637. @orgcmd{<,org-agenda-filter-by-category}
  7638. @vindex org-agenda-category-filter-preset
  7639. Filter the current agenda view with respect to the category of the item at
  7640. point. Pressing @code{<} another time will remove this filter.
  7641. @orgcmd{^,org-agenda-filter-by-top-headline}
  7642. Filter the current agenda view and only display the siblings and the parent
  7643. headline of the one at point.
  7644. @orgcmd{=,org-agenda-filter-by-regexp}
  7645. @vindex org-agenda-regexp-filter-preset
  7646. Filter the agenda view by a regular expression: only show agenda entries
  7647. matching the regular expression the user entered. When called with a prefix
  7648. argument, it will filter @emph{out} entries matching the regexp. With two
  7649. universal prefix arguments, it will remove all the regexp filters, which can
  7650. be accumulated. You can add a filter preset through the option
  7651. @var{org-agenda-category-filter-preset} (see below.)
  7652. @orgcmd{|,org-agenda-filter-remove-all}
  7653. Remove all filters in the current agenda view.
  7654. @tsubheading{Remote editing}
  7655. @cindex remote editing, from agenda
  7656. @item 0--9
  7657. Digit argument.
  7658. @c
  7659. @cindex undoing remote-editing events
  7660. @cindex remote editing, undo
  7661. @orgcmd{C-_,org-agenda-undo}
  7662. Undo a change due to a remote editing command. The change is undone
  7663. both in the agenda buffer and in the remote buffer.
  7664. @c
  7665. @orgcmd{t,org-agenda-todo}
  7666. Change the TODO state of the item, both in the agenda and in the
  7667. original org file.
  7668. @c
  7669. @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
  7670. @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
  7671. Switch to the next/previous set of TODO keywords.
  7672. @c
  7673. @orgcmd{C-k,org-agenda-kill}
  7674. @vindex org-agenda-confirm-kill
  7675. Delete the current agenda item along with the entire subtree belonging
  7676. to it in the original Org file. If the text to be deleted remotely
  7677. is longer than one line, the kill needs to be confirmed by the user. See
  7678. variable @var{org-agenda-confirm-kill}.
  7679. @c
  7680. @orgcmd{C-c C-w,org-agenda-refile}
  7681. Refile the entry at point.
  7682. @c
  7683. @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
  7684. @vindex org-archive-default-command
  7685. Archive the subtree corresponding to the entry at point using the default
  7686. archiving command set in @var{org-archive-default-command}. When using the
  7687. @code{a} key, confirmation will be required.
  7688. @c
  7689. @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
  7690. Toggle the ARCHIVE tag for the current headline.
  7691. @c
  7692. @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
  7693. Move the subtree corresponding to the current entry to its @emph{archive
  7694. sibling}.
  7695. @c
  7696. @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
  7697. Archive the subtree corresponding to the current headline. This means the
  7698. entry will be moved to the configured archive location, most likely a
  7699. different file.
  7700. @c
  7701. @orgcmd{T,org-agenda-show-tags}
  7702. @vindex org-agenda-show-inherited-tags
  7703. Show all tags associated with the current item. This is useful if you have
  7704. turned off @var{org-agenda-show-inherited-tags}, but still want to see all
  7705. tags of a headline occasionally.
  7706. @c
  7707. @orgcmd{:,org-agenda-set-tags}
  7708. Set tags for the current headline. If there is an active region in the
  7709. agenda, change a tag for all headings in the region.
  7710. @c
  7711. @kindex ,
  7712. @item ,
  7713. Set the priority for the current item (@command{org-agenda-priority}).
  7714. Org mode prompts for the priority character. If you reply with @key{SPC},
  7715. the priority cookie is removed from the entry.
  7716. @c
  7717. @orgcmd{P,org-agenda-show-priority}
  7718. Display weighted priority of current item.
  7719. @c
  7720. @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
  7721. Increase the priority of the current item. The priority is changed in
  7722. the original buffer, but the agenda is not resorted. Use the @kbd{r}
  7723. key for this.
  7724. @c
  7725. @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
  7726. Decrease the priority of the current item.
  7727. @c
  7728. @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
  7729. @vindex org-log-into-drawer
  7730. Add a note to the entry. This note will be recorded, and then filed to the
  7731. same location where state change notes are put. Depending on
  7732. @var{org-log-into-drawer}, this may be inside a drawer.
  7733. @c
  7734. @orgcmd{C-c C-a,org-attach}
  7735. Dispatcher for all command related to attachments.
  7736. @c
  7737. @orgcmd{C-c C-s,org-agenda-schedule}
  7738. Schedule this item. With prefix arg remove the scheduling timestamp
  7739. @c
  7740. @orgcmd{C-c C-d,org-agenda-deadline}
  7741. Set a deadline for this item. With prefix arg remove the deadline.
  7742. @c
  7743. @orgcmd{S-@key{right},org-agenda-do-date-later}
  7744. Change the timestamp associated with the current line by one day into the
  7745. future. If the date is in the past, the first call to this command will move
  7746. it to today.@*
  7747. With a numeric prefix argument, change it by that many days. For example,
  7748. @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
  7749. change the time by one hour. If you immediately repeat the command, it will
  7750. continue to change hours even without the prefix arg. With a double @kbd{C-u
  7751. C-u} prefix, do the same for changing minutes.@*
  7752. The stamp is changed in the original Org file, but the change is not directly
  7753. reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
  7754. @c
  7755. @orgcmd{S-@key{left},org-agenda-do-date-earlier}
  7756. Change the timestamp associated with the current line by one day
  7757. into the past.
  7758. @c
  7759. @orgcmd{>,org-agenda-date-prompt}
  7760. Change the timestamp associated with the current line. The key @kbd{>} has
  7761. been chosen, because it is the same as @kbd{S-.} on my keyboard.
  7762. @c
  7763. @orgcmd{I,org-agenda-clock-in}
  7764. Start the clock on the current item. If a clock is running already, it
  7765. is stopped first.
  7766. @c
  7767. @orgcmd{O,org-agenda-clock-out}
  7768. Stop the previously started clock.
  7769. @c
  7770. @orgcmd{X,org-agenda-clock-cancel}
  7771. Cancel the currently running clock.
  7772. @c
  7773. @orgcmd{J,org-agenda-clock-goto}
  7774. Jump to the running clock in another window.
  7775. @c
  7776. @orgcmd{k,org-agenda-capture}
  7777. Like @code{org-capture}, but use the date at point as the default date for
  7778. the capture template. See @var{org-capture-use-agenda-date} to make this
  7779. the default behavior of @code{org-capture}.
  7780. @cindex capturing, from agenda
  7781. @vindex org-capture-use-agenda-date
  7782. @tsubheading{Bulk remote editing selected entries}
  7783. @cindex remote editing, bulk, from agenda
  7784. @vindex org-agenda-bulk-persistent-marks
  7785. @vindex org-agenda-bulk-custom-functions
  7786. @orgcmd{m,org-agenda-bulk-mark}
  7787. Mark the entry at point for bulk action. With prefix arg, mark that many
  7788. successive entries.
  7789. @c
  7790. @orgcmd{%,org-agenda-bulk-mark-regexp}
  7791. Mark entries matching a regular expression for bulk action.
  7792. @c
  7793. @orgcmd{u,org-agenda-bulk-unmark}
  7794. Unmark entry for bulk action.
  7795. @c
  7796. @orgcmd{U,org-agenda-bulk-remove-all-marks}
  7797. Unmark all marked entries for bulk action.
  7798. @c
  7799. @orgcmd{B,org-agenda-bulk-action}
  7800. Bulk action: act on all marked entries in the agenda. This will prompt for
  7801. another key to select the action to be applied. The prefix arg to @kbd{B}
  7802. will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
  7803. these special timestamps. By default, marks are removed after the bulk. If
  7804. you want them to persist, set @var{org-agenda-bulk-persistent-marks} to
  7805. @code{t} or hit @kbd{p} at the prompt.
  7806. @table @kbd
  7807. @item *
  7808. Toggle persistent marks.
  7809. @item $
  7810. Archive all selected entries.
  7811. @item A
  7812. Archive entries by moving them to their respective archive siblings.
  7813. @item t
  7814. Change TODO state. This prompts for a single TODO keyword and changes the
  7815. state of all selected entries, bypassing blocking and suppressing logging
  7816. notes (but not timestamps).
  7817. @item +
  7818. Add a tag to all selected entries.
  7819. @item -
  7820. Remove a tag from all selected entries.
  7821. @item s
  7822. Schedule all items to a new date. To shift existing schedule dates by a
  7823. fixed number of days, use something starting with double plus at the prompt,
  7824. for example @samp{++8d} or @samp{++2w}.
  7825. @item d
  7826. Set deadline to a specific date.
  7827. @item r
  7828. Prompt for a single refile target and move all entries. The entries will no
  7829. longer be in the agenda; refresh (@kbd{g}) to bring them back.
  7830. @item S
  7831. Reschedule randomly into the coming N days. N will be prompted for. With
  7832. prefix arg (@kbd{C-u B S}), scatter only across weekdays.
  7833. @item f
  7834. Apply a function@footnote{You can also create persistent custom functions
  7835. through @var{org-agenda-bulk-custom-functions}.} to marked entries. For
  7836. example, the function below sets the CATEGORY property of the entries to web.
  7837. @lisp
  7838. @group
  7839. (defun set-category ()
  7840. (interactive "P")
  7841. (let* ((marker (or (org-get-at-bol 'org-hd-marker)
  7842. (org-agenda-error)))
  7843. (buffer (marker-buffer marker)))
  7844. (with-current-buffer buffer
  7845. (save-excursion
  7846. (save-restriction
  7847. (widen)
  7848. (goto-char marker)
  7849. (org-back-to-heading t)
  7850. (org-set-property "CATEGORY" "web"))))))
  7851. @end group
  7852. @end lisp
  7853. @end table
  7854. @tsubheading{Calendar commands}
  7855. @cindex calendar commands, from agenda
  7856. @orgcmd{c,org-agenda-goto-calendar}
  7857. Open the Emacs calendar and move to the date at the agenda cursor.
  7858. @c
  7859. @orgcmd{c,org-calendar-goto-agenda}
  7860. When in the calendar, compute and show the Org mode agenda for the
  7861. date at the cursor.
  7862. @c
  7863. @cindex diary entries, creating from agenda
  7864. @orgcmd{i,org-agenda-diary-entry}
  7865. @vindex org-agenda-diary-file
  7866. Insert a new entry into the diary, using the date at the cursor and (for
  7867. block entries) the date at the mark. This will add to the Emacs diary
  7868. file@footnote{This file is parsed for the agenda when
  7869. @var{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
  7870. command in the calendar. The diary file will pop up in another window, where
  7871. you can add the entry.
  7872. If you configure @var{org-agenda-diary-file} to point to an Org mode file,
  7873. Org will create entries (in Org mode syntax) in that file instead. Most
  7874. entries will be stored in a date-based outline tree that will later make it
  7875. easy to archive appointments from previous months/years. The tree will be
  7876. built under an entry with a @code{DATE_TREE} property, or else with years as
  7877. top-level entries. Emacs will prompt you for the entry text---if you specify
  7878. it, the entry will be created in @var{org-agenda-diary-file} without further
  7879. interaction. If you directly press @key{RET} at the prompt without typing
  7880. text, the target file will be shown in another window for you to finish the
  7881. entry there. See also the @kbd{k r} command.
  7882. @c
  7883. @orgcmd{M,org-agenda-phases-of-moon}
  7884. Show the phases of the moon for the three months around current date.
  7885. @c
  7886. @orgcmd{S,org-agenda-sunrise-sunset}
  7887. Show sunrise and sunset times. The geographical location must be set
  7888. with calendar variables, see the documentation for the Emacs calendar.
  7889. @c
  7890. @orgcmd{C,org-agenda-convert-date}
  7891. Convert the date at cursor into many other cultural and historic
  7892. calendars.
  7893. @c
  7894. @orgcmd{H,org-agenda-holidays}
  7895. Show holidays for three months around the cursor date.
  7896. @item M-x org-icalendar-combine-agenda-files RET
  7897. Export a single iCalendar file containing entries from all agenda files.
  7898. This is a globally available command, and also available in the agenda menu.
  7899. @tsubheading{Exporting to a file}
  7900. @orgcmd{C-x C-w,org-agenda-write}
  7901. @cindex exporting agenda views
  7902. @cindex agenda views, exporting
  7903. @vindex org-agenda-exporter-settings
  7904. Write the agenda view to a file. Depending on the extension of the selected
  7905. file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
  7906. Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
  7907. (any other extension). When exporting to Org, only the body of original
  7908. headlines are exported, not subtrees or inherited tags. When called with a
  7909. @kbd{C-u} prefix argument, immediately open the newly created file. Use the
  7910. variable @var{org-agenda-exporter-settings} to set options for
  7911. @file{ps-print} and for @file{htmlize} to be used during export.
  7912. @tsubheading{Quit and Exit}
  7913. @orgcmd{q,org-agenda-quit}
  7914. Quit agenda, remove the agenda buffer.
  7915. @c
  7916. @cindex agenda files, removing buffers
  7917. @orgcmd{x,org-agenda-exit}
  7918. Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
  7919. for the compilation of the agenda. Buffers created by the user to
  7920. visit Org files will not be removed.
  7921. @end table
  7922. @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
  7923. @section Custom agenda views
  7924. @cindex custom agenda views
  7925. @cindex agenda views, custom
  7926. Custom agenda commands serve two purposes: to store and quickly access
  7927. frequently used TODO and tags searches, and to create special composite
  7928. agenda buffers. Custom agenda commands will be accessible through the
  7929. dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
  7930. @menu
  7931. * Storing searches:: Type once, use often
  7932. * Block agenda:: All the stuff you need in a single buffer
  7933. * Setting Options:: Changing the rules
  7934. @end menu
  7935. @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
  7936. @subsection Storing searches
  7937. The first application of custom searches is the definition of keyboard
  7938. shortcuts for frequently used searches, either creating an agenda
  7939. buffer, or a sparse tree (the latter covering of course only the current
  7940. buffer).
  7941. @kindex C-c a C
  7942. @vindex org-agenda-custom-commands
  7943. @cindex agenda views, main example
  7944. @cindex agenda, as an agenda views
  7945. @cindex agenda*, as an agenda views
  7946. @cindex tags, as an agenda view
  7947. @cindex todo, as an agenda view
  7948. @cindex tags-todo
  7949. @cindex todo-tree
  7950. @cindex occur-tree
  7951. @cindex tags-tree
  7952. Custom commands are configured in the variable
  7953. @var{org-agenda-custom-commands}. You can customize this variable, for
  7954. example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
  7955. Lisp in @file{.emacs}. The following example contains all valid agenda
  7956. views:
  7957. @lisp
  7958. @group
  7959. (setq org-agenda-custom-commands
  7960. '(("x" agenda)
  7961. ("y" agenda*)
  7962. ("w" todo "WAITING")
  7963. ("W" todo-tree "WAITING")
  7964. ("u" tags "+boss-urgent")
  7965. ("v" tags-todo "+boss-urgent")
  7966. ("U" tags-tree "+boss-urgent")
  7967. ("f" occur-tree "\\<FIXME\\>")
  7968. ("h" . "HOME+Name tags searches") ; description for "h" prefix
  7969. ("hl" tags "+home+Lisa")
  7970. ("hp" tags "+home+Peter")
  7971. ("hk" tags "+home+Kim")))
  7972. @end group
  7973. @end lisp
  7974. @noindent
  7975. The initial string in each entry defines the keys you have to press
  7976. after the dispatcher command @kbd{C-c a} in order to access the command.
  7977. Usually this will be just a single character, but if you have many
  7978. similar commands, you can also define two-letter combinations where the
  7979. first character is the same in several combinations and serves as a
  7980. prefix key@footnote{You can provide a description for a prefix key by
  7981. inserting a cons cell with the prefix and the description.}. The second
  7982. parameter is the search type, followed by the string or regular
  7983. expression to be used for the matching. The example above will
  7984. therefore define:
  7985. @table @kbd
  7986. @item C-c a x
  7987. as a global search for agenda entries planned@footnote{@emph{Planned} means
  7988. here that these entries have some planning information attached to them, like
  7989. a time-stamp, a scheduled or a deadline string. See
  7990. @var{org-agenda-entry-types} on how to set what planning information will be
  7991. taken into account.} this week/day.
  7992. @item C-c a y
  7993. as a global search for agenda entries planned this week/day, but only those
  7994. with an hour specification like @code{[h]h:mm}---think of them as appointments.
  7995. @item C-c a w
  7996. as a global search for TODO entries with @samp{WAITING} as the TODO
  7997. keyword
  7998. @item C-c a W
  7999. as the same search, but only in the current buffer and displaying the
  8000. results as a sparse tree
  8001. @item C-c a u
  8002. as a global tags search for headlines marked @samp{:boss:} but not
  8003. @samp{:urgent:}
  8004. @item C-c a v
  8005. as the same search as @kbd{C-c a u}, but limiting the search to
  8006. headlines that are also TODO items
  8007. @item C-c a U
  8008. as the same search as @kbd{C-c a u}, but only in the current buffer and
  8009. displaying the result as a sparse tree
  8010. @item C-c a f
  8011. to create a sparse tree (again: current buffer only) with all entries
  8012. containing the word @samp{FIXME}
  8013. @item C-c a h
  8014. as a prefix command for a HOME tags search where you have to press an
  8015. additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
  8016. Peter, or Kim) as additional tag to match.
  8017. @end table
  8018. Note that the @code{*-tree} agenda views need to be called from an
  8019. Org buffer as they operate on the current buffer only.
  8020. @node Block agenda, Setting Options, Storing searches, Custom agenda views
  8021. @subsection Block agenda
  8022. @cindex block agenda
  8023. @cindex agenda, with block views
  8024. Another possibility is the construction of agenda views that comprise
  8025. the results of @emph{several} commands, each of which creates a block in
  8026. the agenda buffer. The available commands include @code{agenda} for the
  8027. daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
  8028. for the global TODO list (as constructed with @kbd{C-c a t}), and the
  8029. matching commands discussed above: @code{todo}, @code{tags}, and
  8030. @code{tags-todo}. Here are two examples:
  8031. @lisp
  8032. @group
  8033. (setq org-agenda-custom-commands
  8034. '(("h" "Agenda and Home-related tasks"
  8035. ((agenda "")
  8036. (tags-todo "home")
  8037. (tags "garden")))
  8038. ("o" "Agenda and Office-related tasks"
  8039. ((agenda "")
  8040. (tags-todo "work")
  8041. (tags "office")))))
  8042. @end group
  8043. @end lisp
  8044. @noindent
  8045. This will define @kbd{C-c a h} to create a multi-block view for stuff
  8046. you need to attend to at home. The resulting agenda buffer will contain
  8047. your agenda for the current week, all TODO items that carry the tag
  8048. @samp{home}, and also all lines tagged with @samp{garden}. Finally the
  8049. command @kbd{C-c a o} provides a similar view for office tasks.
  8050. @node Setting Options, , Block agenda, Custom agenda views
  8051. @subsection Setting options for custom commands
  8052. @cindex options, for custom agenda views
  8053. @vindex org-agenda-custom-commands
  8054. Org mode contains a number of variables regulating agenda construction
  8055. and display. The global variables define the behavior for all agenda
  8056. commands, including the custom commands. However, if you want to change
  8057. some settings just for a single custom view, you can do so. Setting
  8058. options requires inserting a list of variable names and values at the
  8059. right spot in @var{org-agenda-custom-commands}. For example:
  8060. @lisp
  8061. @group
  8062. (setq org-agenda-custom-commands
  8063. '(("w" todo "WAITING"
  8064. ((org-agenda-sorting-strategy '(priority-down))
  8065. (org-agenda-prefix-format " Mixed: ")))
  8066. ("U" tags-tree "+boss-urgent"
  8067. ((org-show-following-heading nil)
  8068. (org-show-hierarchy-above nil)))
  8069. ("N" search ""
  8070. ((org-agenda-files '("~org/notes.org"))
  8071. (org-agenda-text-search-extra-files nil)))))
  8072. @end group
  8073. @end lisp
  8074. @noindent
  8075. Now the @kbd{C-c a w} command will sort the collected entries only by
  8076. priority, and the prefix format is modified to just say @samp{ Mixed: }
  8077. instead of giving the category of the entry. The sparse tags tree of
  8078. @kbd{C-c a U} will now turn out ultra-compact, because neither the
  8079. headline hierarchy above the match, nor the headline following the match
  8080. will be shown. The command @kbd{C-c a N} will do a text search limited
  8081. to only a single file.
  8082. @vindex org-agenda-custom-commands
  8083. For command sets creating a block agenda,
  8084. @var{org-agenda-custom-commands} has two separate spots for setting
  8085. options. You can add options that should be valid for just a single
  8086. command in the set, and options that should be valid for all commands in
  8087. the set. The former are just added to the command entry; the latter
  8088. must come after the list of command entries. Going back to the block
  8089. agenda example (@pxref{Block agenda}), let's change the sorting strategy
  8090. for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
  8091. the results for GARDEN tags query in the opposite order,
  8092. @code{priority-up}. This would look like this:
  8093. @lisp
  8094. @group
  8095. (setq org-agenda-custom-commands
  8096. '(("h" "Agenda and Home-related tasks"
  8097. ((agenda)
  8098. (tags-todo "home")
  8099. (tags "garden"
  8100. ((org-agenda-sorting-strategy '(priority-up)))))
  8101. ((org-agenda-sorting-strategy '(priority-down))))
  8102. ("o" "Agenda and Office-related tasks"
  8103. ((agenda)
  8104. (tags-todo "work")
  8105. (tags "office")))))
  8106. @end group
  8107. @end lisp
  8108. As you see, the values and parentheses setting is a little complex.
  8109. When in doubt, use the customize interface to set this variable---it
  8110. fully supports its structure. Just one caveat: when setting options in
  8111. this interface, the @emph{values} are just Lisp expressions. So if the
  8112. value is a string, you need to add the double-quotes around the value
  8113. yourself.
  8114. @vindex org-agenda-custom-commands-contexts
  8115. To control whether an agenda command should be accessible from a specific
  8116. context, you can customize @var{org-agenda-custom-commands-contexts}. Let's
  8117. say for example that you have an agenda commands @code{"o"} displaying a view
  8118. that you only need when reading emails. Then you would configure this option
  8119. like this:
  8120. @lisp
  8121. (setq org-agenda-custom-commands-contexts
  8122. '(("o" (in-mode . "message-mode"))))
  8123. @end lisp
  8124. You can also tell that the command key @code{"o"} should refer to another
  8125. command key @code{"r"}. In that case, add this command key like this:
  8126. @lisp
  8127. (setq org-agenda-custom-commands-contexts
  8128. '(("o" "r" (in-mode . "message-mode"))))
  8129. @end lisp
  8130. See the docstring of the variable for more information.
  8131. @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
  8132. @section Exporting Agenda Views
  8133. @cindex agenda views, exporting
  8134. If you are away from your computer, it can be very useful to have a printed
  8135. version of some agenda views to carry around. Org mode can export custom
  8136. agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
  8137. @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
  8138. ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
  8139. a PDF file will also create the postscript file.}, and iCalendar files. If
  8140. you want to do this only occasionally, use the command
  8141. @table @kbd
  8142. @orgcmd{C-x C-w,org-agenda-write}
  8143. @cindex exporting agenda views
  8144. @cindex agenda views, exporting
  8145. @vindex org-agenda-exporter-settings
  8146. Write the agenda view to a file. Depending on the extension of the selected
  8147. file name, the view will be exported as HTML (extension @file{.html} or
  8148. @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
  8149. @file{.ics}), or plain text (any other extension). Use the variable
  8150. @var{org-agenda-exporter-settings} to set options for @file{ps-print} and
  8151. for @file{htmlize} to be used during export, for example
  8152. @vindex org-agenda-add-entry-text-maxlines
  8153. @vindex htmlize-output-type
  8154. @vindex ps-number-of-columns
  8155. @vindex ps-landscape-mode
  8156. @lisp
  8157. (setq org-agenda-exporter-settings
  8158. '((ps-number-of-columns 2)
  8159. (ps-landscape-mode t)
  8160. (org-agenda-add-entry-text-maxlines 5)
  8161. (htmlize-output-type 'css)))
  8162. @end lisp
  8163. @end table
  8164. If you need to export certain agenda views frequently, you can associate
  8165. any custom agenda command with a list of output file names
  8166. @footnote{If you want to store standard views like the weekly agenda
  8167. or the global TODO list as well, you need to define custom commands for
  8168. them in order to be able to specify file names.}. Here is an example
  8169. that first defines custom commands for the agenda and the global
  8170. TODO list, together with a number of files to which to export them.
  8171. Then we define two block agenda commands and specify file names for them
  8172. as well. File names can be relative to the current working directory,
  8173. or absolute.
  8174. @lisp
  8175. @group
  8176. (setq org-agenda-custom-commands
  8177. '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
  8178. ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
  8179. ("h" "Agenda and Home-related tasks"
  8180. ((agenda "")
  8181. (tags-todo "home")
  8182. (tags "garden"))
  8183. nil
  8184. ("~/views/home.html"))
  8185. ("o" "Agenda and Office-related tasks"
  8186. ((agenda)
  8187. (tags-todo "work")
  8188. (tags "office"))
  8189. nil
  8190. ("~/views/office.ps" "~/calendars/office.ics"))))
  8191. @end group
  8192. @end lisp
  8193. The extension of the file name determines the type of export. If it is
  8194. @file{.html}, Org mode will use the @file{htmlize.el} package to convert
  8195. the buffer to HTML and save it to this file name. If the extension is
  8196. @file{.ps}, @var{ps-print-buffer-with-faces} is used to produce
  8197. Postscript output. If the extension is @file{.ics}, iCalendar export is
  8198. run export over all files that were used to construct the agenda, and
  8199. limit the export to entries listed in the agenda. Any other
  8200. extension produces a plain ASCII file.
  8201. The export files are @emph{not} created when you use one of those
  8202. commands interactively because this might use too much overhead.
  8203. Instead, there is a special command to produce @emph{all} specified
  8204. files in one step:
  8205. @table @kbd
  8206. @orgcmd{C-c a e,org-store-agenda-views}
  8207. Export all agenda views that have export file names associated with
  8208. them.
  8209. @end table
  8210. You can use the options section of the custom agenda commands to also
  8211. set options for the export commands. For example:
  8212. @lisp
  8213. (setq org-agenda-custom-commands
  8214. '(("X" agenda ""
  8215. ((ps-number-of-columns 2)
  8216. (ps-landscape-mode t)
  8217. (org-agenda-prefix-format " [ ] ")
  8218. (org-agenda-with-colors nil)
  8219. (org-agenda-remove-tags t))
  8220. ("theagenda.ps"))))
  8221. @end lisp
  8222. @noindent
  8223. This command sets two options for the Postscript exporter, to make it
  8224. print in two columns in landscape format---the resulting page can be cut
  8225. in two and then used in a paper agenda. The remaining settings modify
  8226. the agenda prefix to omit category and scheduling information, and
  8227. instead include a checkbox to check off items. We also remove the tags
  8228. to make the lines compact, and we don't want to use colors for the
  8229. black-and-white printer. Settings specified in
  8230. @var{org-agenda-exporter-settings} will also apply, but the settings
  8231. in @var{org-agenda-custom-commands} take precedence.
  8232. @noindent
  8233. From the command line you may also use
  8234. @example
  8235. emacs -eval (org-batch-store-agenda-views) -kill
  8236. @end example
  8237. @noindent
  8238. or, if you need to modify some parameters@footnote{Quoting depends on the
  8239. system you use, please check the FAQ for examples.}
  8240. @example
  8241. emacs -eval '(org-batch-store-agenda-views \
  8242. org-agenda-span (quote month) \
  8243. org-agenda-start-day "2007-11-01" \
  8244. org-agenda-include-diary nil \
  8245. org-agenda-files (quote ("~/org/project.org")))' \
  8246. -kill
  8247. @end example
  8248. @noindent
  8249. which will create the agenda views restricted to the file
  8250. @file{~/org/project.org}, without diary entries and with a 30-day
  8251. extent.
  8252. You can also extract agenda information in a way that allows further
  8253. processing by other programs. See @ref{Extracting agenda information}, for
  8254. more information.
  8255. @node Agenda column view, , Exporting Agenda Views, Agenda Views
  8256. @section Using column view in the agenda
  8257. @cindex column view, in agenda
  8258. @cindex agenda, column view
  8259. Column view (@pxref{Column view}) is normally used to view and edit
  8260. properties embedded in the hierarchical structure of an Org file. It can be
  8261. quite useful to use column view also from the agenda, where entries are
  8262. collected by certain criteria.
  8263. @table @kbd
  8264. @orgcmd{C-c C-x C-c,org-agenda-columns}
  8265. Turn on column view in the agenda.
  8266. @end table
  8267. To understand how to use this properly, it is important to realize that the
  8268. entries in the agenda are no longer in their proper outline environment.
  8269. This causes the following issues:
  8270. @enumerate
  8271. @item
  8272. @vindex org-columns-default-format
  8273. @vindex org-overriding-columns-format
  8274. Org needs to make a decision which @code{COLUMNS} format to use. Since the
  8275. entries in the agenda are collected from different files, and different files
  8276. may have different @code{COLUMNS} formats, this is a non-trivial problem.
  8277. Org first checks if the variable @var{org-agenda-overriding-columns-format} is
  8278. currently set, and if so, takes the format from there. Otherwise it takes
  8279. the format associated with the first item in the agenda, or, if that item
  8280. does not have a specific format (defined in a property, or in its file), it
  8281. uses @var{org-columns-default-format}.
  8282. @item
  8283. @cindex property, special, CLOCKSUM
  8284. If any of the columns has a summary type defined (@pxref{Column attributes}),
  8285. turning on column view in the agenda will visit all relevant agenda files and
  8286. make sure that the computations of this property are up to date. This is
  8287. also true for the special @code{CLOCKSUM} property. Org will then sum the
  8288. values displayed in the agenda. In the daily/weekly agenda, the sums will
  8289. cover a single day; in all other views they cover the entire block. It is
  8290. vital to realize that the agenda may show the same entry @emph{twice} (for
  8291. example as scheduled and as a deadline), and it may show two entries from the
  8292. same hierarchy (for example a @emph{parent} and its @emph{child}). In these
  8293. cases, the summation in the agenda will lead to incorrect results because
  8294. some values will count double.
  8295. @item
  8296. When the column view in the agenda shows the @code{CLOCKSUM}, that is always
  8297. the entire clocked time for this item. So even in the daily/weekly agenda,
  8298. the clocksum listed in column view may originate from times outside the
  8299. current view. This has the advantage that you can compare these values with
  8300. a column listing the planned total effort for a task---one of the major
  8301. applications for column view in the agenda. If you want information about
  8302. clocked time in the displayed period use clock table mode (press @kbd{R} in
  8303. the agenda).
  8304. @item
  8305. @cindex property, special, CLOCKSUM_T
  8306. When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
  8307. always today's clocked time for this item. So even in the weekly agenda,
  8308. the clocksum listed in column view only originates from today. This lets
  8309. you compare the time you spent on a task for today, with the time already
  8310. spent (via @code{CLOCKSUM}) and with the planned total effort for it.
  8311. @end enumerate
  8312. @node Markup, Exporting, Agenda Views, Top
  8313. @chapter Markup for rich export
  8314. When exporting Org mode documents, the exporter tries to reflect the
  8315. structure of the document as accurately as possible in the back-end. Since
  8316. export targets like HTML, @LaTeX{} allow much richer formatting, Org mode has
  8317. rules on how to prepare text for rich export. This section summarizes the
  8318. markup rules used in an Org mode buffer.
  8319. @menu
  8320. * Structural markup elements:: The basic structure as seen by the exporter
  8321. * Images and tables:: Images, tables and caption mechanism
  8322. * Literal examples:: Source code examples with special formatting
  8323. * Include files:: Include additional files into a document
  8324. * Index entries:: Making an index
  8325. * Macro replacement:: Use macros to create templates
  8326. * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
  8327. * Special blocks:: Containers targeted at export back-ends
  8328. @end menu
  8329. @node Structural markup elements, Images and tables, Markup, Markup
  8330. @section Structural markup elements
  8331. @menu
  8332. * Document title:: Where the title is taken from
  8333. * Headings and sections:: The document structure as seen by the exporter
  8334. * Table of contents:: The if and where of the table of contents
  8335. * Lists:: Lists
  8336. * Paragraphs:: Paragraphs
  8337. * Footnote markup:: Footnotes
  8338. * Emphasis and monospace:: Bold, italic, etc.
  8339. * Horizontal rules:: Make a line
  8340. * Comment lines:: What will *not* be exported
  8341. @end menu
  8342. @node Document title, Headings and sections, Structural markup elements, Structural markup elements
  8343. @subheading Document title
  8344. @cindex document title, markup rules
  8345. @noindent
  8346. The title of the exported document is taken from the special line
  8347. @cindex #+TITLE
  8348. @example
  8349. #+TITLE: This is the title of the document
  8350. @end example
  8351. @noindent
  8352. If this line does not exist, the title will be the name of the file
  8353. associated to buffer, without extension, or the buffer name.
  8354. @cindex property, EXPORT_TITLE
  8355. If you are exporting only a subtree by marking is as the region, the heading
  8356. of the subtree will become the title of the document. If the subtree has a
  8357. property @code{EXPORT_TITLE}, that will take precedence.
  8358. @node Headings and sections, Table of contents, Document title, Structural markup elements
  8359. @subheading Headings and sections
  8360. @cindex headings and sections, markup rules
  8361. @vindex org-export-headline-levels
  8362. The outline structure of the document as described in @ref{Document
  8363. Structure}, forms the basis for defining sections of the exported document.
  8364. However, since the outline structure is also used for (for example) lists of
  8365. tasks, only the first three outline levels will be used as headings. Deeper
  8366. levels will become itemized lists. You can change the location of this
  8367. switch globally by setting the variable @var{org-export-headline-levels}, or on a
  8368. per-file basis with a line
  8369. @cindex #+OPTIONS
  8370. @example
  8371. #+OPTIONS: H:4
  8372. @end example
  8373. @node Table of contents, Lists, Headings and sections, Structural markup elements
  8374. @subheading Table of contents
  8375. @cindex table of contents, markup rules
  8376. @cindex #+TOC
  8377. @vindex org-export-with-toc
  8378. The table of contents is normally inserted directly before the first headline
  8379. of the file. If you would like to get it to a different location, insert
  8380. @code{#+TOC: headlines} at the desired location. The depth of the table of
  8381. contents is by default the same as the number of headline levels, but you can
  8382. choose a smaller number, or turn off the table of contents entirely, by
  8383. configuring the variable @var{org-export-with-toc}, or on a per-file basis
  8384. with a line like
  8385. @example
  8386. #+OPTIONS: toc:2 (only to two levels in TOC)
  8387. #+TOC: headlines 2 (the same, at a specific location)
  8388. #+OPTIONS: toc:nil (no TOC at all)
  8389. @end example
  8390. The same @code{TOC} keyword can also generate a list of all tables (resp.@:
  8391. all listings) with a caption in the buffer.
  8392. @example
  8393. #+TOC: listings (build a list of listings)
  8394. #+TOC: tables (build a list of tables)
  8395. @end example
  8396. @cindex property, ALT_TITLE
  8397. The headline's title usually determines its corresponding entry in a table of
  8398. contents. However, it is possible to specify an alternative title by
  8399. setting @code{ALT_TITLE} property accordingly. It will then be used when
  8400. building the table.
  8401. @node Lists, Paragraphs, Table of contents, Structural markup elements
  8402. @subheading Lists
  8403. @cindex lists, markup rules
  8404. Plain lists as described in @ref{Plain lists}, are translated to the back-end's
  8405. syntax for such lists. Most back-ends support unordered, ordered, and
  8406. description lists.
  8407. @node Paragraphs, Footnote markup, Lists, Structural markup elements
  8408. @subheading Paragraphs, line breaks, and quoting
  8409. @cindex paragraphs, markup rules
  8410. Paragraphs are separated by at least one empty line. If you need to enforce
  8411. a line break within a paragraph, use @samp{\\} at the end of a line.
  8412. To keep the line breaks in a region, but otherwise use normal formatting, you
  8413. can use this construct, which can also be used to format poetry.
  8414. @cindex #+BEGIN_VERSE
  8415. @example
  8416. #+BEGIN_VERSE
  8417. Great clouds overhead
  8418. Tiny black birds rise and fall
  8419. Snow covers Emacs
  8420. -- AlexSchroeder
  8421. #+END_VERSE
  8422. @end example
  8423. When quoting a passage from another document, it is customary to format this
  8424. as a paragraph that is indented on both the left and the right margin. You
  8425. can include quotations in Org mode documents like this:
  8426. @cindex #+BEGIN_QUOTE
  8427. @example
  8428. #+BEGIN_QUOTE
  8429. Everything should be made as simple as possible,
  8430. but not any simpler -- Albert Einstein
  8431. #+END_QUOTE
  8432. @end example
  8433. If you would like to center some text, do it like this:
  8434. @cindex #+BEGIN_CENTER
  8435. @example
  8436. #+BEGIN_CENTER
  8437. Everything should be made as simple as possible, \\
  8438. but not any simpler
  8439. #+END_CENTER
  8440. @end example
  8441. @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
  8442. @subheading Footnote markup
  8443. @cindex footnotes, markup rules
  8444. @cindex @file{footnote.el}
  8445. Footnotes defined in the way described in @ref{Footnotes}, will be exported
  8446. by all back-ends. Org allows multiple references to the same note, and
  8447. multiple footnotes side by side.
  8448. @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
  8449. @subheading Emphasis and monospace
  8450. @cindex underlined text, markup rules
  8451. @cindex bold text, markup rules
  8452. @cindex italic text, markup rules
  8453. @cindex verbatim text, markup rules
  8454. @cindex code text, markup rules
  8455. @cindex strike-through text, markup rules
  8456. @vindex org-fontify-emphasized-text
  8457. @vindex org-emphasis-regexp-components
  8458. @vindex org-emphasis-alist
  8459. You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
  8460. and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
  8461. in the code and verbatim string is not processed for Org mode specific
  8462. syntax, it is exported verbatim.
  8463. To turn off fontification for marked up text, you can set
  8464. @var{org-fontify-emphasized-text} to @code{nil}. To narrow down the list of
  8465. available markup syntax, you can customize @var{org-emphasis-alist}. To fine
  8466. tune what characters are allowed before and after the markup characters, you
  8467. can tweak @var{org-emphasis-regexp-components}. Beware that changing one of
  8468. the above variables will no take effect until you reload Org, for which you
  8469. may need to restart Emacs.
  8470. @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
  8471. @subheading Horizontal rules
  8472. @cindex horizontal rules, markup rules
  8473. A line consisting of only dashes, and at least 5 of them, will be exported as
  8474. a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
  8475. @node Comment lines, , Horizontal rules, Structural markup elements
  8476. @subheading Comment lines
  8477. @cindex comment lines
  8478. @cindex exporting, not
  8479. @cindex #+BEGIN_COMMENT
  8480. Lines starting with zero or more whitespace characters followed by one
  8481. @samp{#} and a whitespace are treated as comments and will never be exported.
  8482. Also entire subtrees starting with the word @samp{COMMENT} will never be
  8483. exported. Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
  8484. ... @samp{#+END_COMMENT} will not be exported.
  8485. @table @kbd
  8486. @kindex C-c ;
  8487. @item C-c ;
  8488. Toggle the COMMENT keyword at the beginning of an entry.
  8489. @end table
  8490. @node Images and tables, Literal examples, Structural markup elements, Markup
  8491. @section Images and Tables
  8492. @cindex tables, markup rules
  8493. @cindex #+CAPTION
  8494. @cindex #+NAME
  8495. Both the native Org mode tables (@pxref{Tables}) and tables formatted with
  8496. the @file{table.el} package will be exported properly. For Org mode tables,
  8497. the lines before the first horizontal separator line will become table header
  8498. lines. You can use the following lines somewhere before the table to assign
  8499. a caption and a label for cross references, and in the text you can refer to
  8500. the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
  8501. @example
  8502. #+CAPTION: This is the caption for the next table (or link)
  8503. #+NAME: tab:basic-data
  8504. | ... | ...|
  8505. |-----|----|
  8506. @end example
  8507. Optionally, the caption can take the form:
  8508. @example
  8509. #+CAPTION[Caption for list of tables]: Caption for table.
  8510. @end example
  8511. @cindex inlined images, markup rules
  8512. Some back-ends allow you to directly include images into the exported
  8513. document. Org does this, if a link to an image files does not have
  8514. a description part, for example @code{[[./img/a.jpg]]}. If you wish to
  8515. define a caption for the image and maybe a label for internal cross
  8516. references, make sure that the link is on a line by itself and precede it
  8517. with @code{#+CAPTION} and @code{#+NAME} as follows:
  8518. @example
  8519. #+CAPTION: This is the caption for the next figure link (or table)
  8520. #+NAME: fig:SED-HR4049
  8521. [[./img/a.jpg]]
  8522. @end example
  8523. @noindent
  8524. Such images can be displayed within the buffer. @xref{Handling links,the
  8525. discussion of image links}.
  8526. Even though images and tables are prominent examples of captioned structures,
  8527. the same caption mechanism can apply to many others (e.g., @LaTeX{}
  8528. equations, source code blocks). Depending on the export back-end, those may
  8529. or may not be handled.
  8530. @node Literal examples, Include files, Images and tables, Markup
  8531. @section Literal examples
  8532. @cindex literal examples, markup rules
  8533. @cindex code line references, markup rules
  8534. You can include literal examples that should not be subjected to
  8535. markup. Such examples will be typeset in monospace, so this is well suited
  8536. for source code and similar examples.
  8537. @cindex #+BEGIN_EXAMPLE
  8538. @example
  8539. #+BEGIN_EXAMPLE
  8540. Some example from a text file.
  8541. #+END_EXAMPLE
  8542. @end example
  8543. Note that such blocks may be @i{indented} in order to align nicely with
  8544. indented text and in particular with plain list structure (@pxref{Plain
  8545. lists}). For simplicity when using small examples, you can also start the
  8546. example lines with a colon followed by a space. There may also be additional
  8547. whitespace before the colon:
  8548. @example
  8549. Here is an example
  8550. : Some example from a text file.
  8551. @end example
  8552. @cindex formatting source code, markup rules
  8553. If the example is source code from a programming language, or any other text
  8554. that can be marked up by font-lock in Emacs, you can ask for the example to
  8555. look like the fontified Emacs buffer@footnote{This works automatically for
  8556. the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
  8557. which is distributed with Org). Fontified code chunks in @LaTeX{} can be
  8558. achieved using either the listings or the
  8559. @url{http://code.google.com/p/minted, minted,} package. Refer to
  8560. @var{org-latex-listings} documentation for details.}. This is done
  8561. with the @samp{src} block, where you also need to specify the name of the
  8562. major mode that should be used to fontify the example@footnote{Code in
  8563. @samp{src} blocks may also be evaluated either interactively or on export.
  8564. See @pxref{Working With Source Code} for more information on evaluating code
  8565. blocks.}, see @ref{Easy Templates} for shortcuts to easily insert code
  8566. blocks.
  8567. @cindex #+BEGIN_SRC
  8568. @example
  8569. #+BEGIN_SRC emacs-lisp
  8570. (defun org-xor (a b)
  8571. "Exclusive or."
  8572. (if a (not b) b))
  8573. #+END_SRC
  8574. @end example
  8575. Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
  8576. switch to the end of the @code{BEGIN} line, to get the lines of the example
  8577. numbered. If you use a @code{+n} switch, the numbering from the previous
  8578. numbered snippet will be continued in the current one. In literal examples,
  8579. Org will interpret strings like @samp{(ref:name)} as labels, and use them as
  8580. targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
  8581. enclosed in single parenthesis). In HTML, hovering the mouse over such a
  8582. link will remote-highlight the corresponding code line, which is kind of
  8583. cool.
  8584. You can also add a @code{-r} switch which @i{removes} the labels from the
  8585. source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
  8586. labels in the source code while using line numbers for the links, which might
  8587. be useful to explain those in an Org mode example code.}. With the @code{-n}
  8588. switch, links to these references will be labeled by the line numbers from
  8589. the code listing, otherwise links will use the labels with no parentheses.
  8590. Here is an example:
  8591. @example
  8592. #+BEGIN_SRC emacs-lisp -n -r
  8593. (save-excursion (ref:sc)
  8594. (goto-char (point-min)) (ref:jump)
  8595. #+END_SRC
  8596. In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
  8597. jumps to point-min.
  8598. @end example
  8599. @vindex org-coderef-label-format
  8600. If the syntax for the label format conflicts with the language syntax, use a
  8601. @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
  8602. -n -r -l "((%s))"}. See also the variable @var{org-coderef-label-format}.
  8603. HTML export also allows examples to be published as text areas (@pxref{Text
  8604. areas in HTML export}).
  8605. Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
  8606. so often, shortcuts are provided using the Easy Templates facility
  8607. (@pxref{Easy Templates}).
  8608. @table @kbd
  8609. @kindex C-c '
  8610. @item C-c '
  8611. Edit the source code example at point in its native mode. This works by
  8612. switching to a temporary buffer with the source code. You need to exit by
  8613. pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
  8614. @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
  8615. from being interpreted by Org as outline nodes or special syntax. These
  8616. commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
  8617. The edited version will then replace the old version in the Org buffer.
  8618. Fixed-width regions (where each line starts with a colon followed by a space)
  8619. will be edited using @code{artist-mode}@footnote{You may select
  8620. a different-mode with the variable @var{org-edit-fixed-width-region-mode}.}
  8621. to allow creating ASCII drawings easily. Using this command in an empty line
  8622. will create a new fixed-width region.
  8623. @kindex C-c l
  8624. @item C-c l
  8625. Calling @code{org-store-link} while editing a source code example in a
  8626. temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
  8627. that it is unique in the current buffer, and insert it with the proper
  8628. formatting like @samp{(ref:label)} at the end of the current line. Then the
  8629. label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
  8630. @end table
  8631. @node Include files, Index entries, Literal examples, Markup
  8632. @section Include files
  8633. @cindex include files, markup rules
  8634. During export, you can include the content of another file. For example, to
  8635. include your @file{.emacs} file, you could use:
  8636. @cindex #+INCLUDE
  8637. @example
  8638. #+INCLUDE: "~/.emacs" src emacs-lisp
  8639. @end example
  8640. @noindent
  8641. The optional second and third parameter are the markup (e.g., @samp{quote},
  8642. @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
  8643. language for formatting the contents. The markup is optional; if it is not
  8644. given, the text will be assumed to be in Org mode format and will be
  8645. processed normally.
  8646. Contents of the included file will belong to the same structure (headline,
  8647. item) containing the @code{INCLUDE} keyword. In particular, headlines within
  8648. the file will become children of the current section. That behaviour can be
  8649. changed by providing an additional keyword parameter, @code{:minlevel}. In
  8650. that case, all headlines in the included file will be shifted so the one with
  8651. the lowest level reaches that specified level. For example, to make a file
  8652. become a sibling of the current top-level headline, use
  8653. @example
  8654. #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
  8655. @end example
  8656. You can also include a portion of a file by specifying a lines range using
  8657. the @code{:lines} parameter. The line at the upper end of the range will not
  8658. be included. The start and/or the end of the range may be omitted to use the
  8659. obvious defaults.
  8660. @example
  8661. #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
  8662. #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
  8663. #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
  8664. @end example
  8665. @table @kbd
  8666. @kindex C-c '
  8667. @item C-c '
  8668. Visit the include file at point.
  8669. @end table
  8670. @node Index entries, Macro replacement, Include files, Markup
  8671. @section Index entries
  8672. @cindex index entries, for publishing
  8673. You can specify entries that will be used for generating an index during
  8674. publishing. This is done by lines starting with @code{#+INDEX}. An entry
  8675. the contains an exclamation mark will create a sub item. See @ref{Generating
  8676. an index} for more information.
  8677. @example
  8678. * Curriculum Vitae
  8679. #+INDEX: CV
  8680. #+INDEX: Application!CV
  8681. @end example
  8682. @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
  8683. @section Macro replacement
  8684. @cindex macro replacement, during export
  8685. @cindex #+MACRO
  8686. You can define text snippets with
  8687. @example
  8688. #+MACRO: name replacement text $1, $2 are arguments
  8689. @end example
  8690. @noindent which can be referenced in
  8691. paragraphs, verse blocks, table cells and some keywords with
  8692. @code{@{@{@{name(arg1,arg2)@}@}@}}@footnote{Since commas separate arguments,
  8693. commas within arguments have to be escaped with a backslash character.
  8694. Conversely, backslash characters before a comma, and only them, need to be
  8695. escaped with another backslash character.}. In addition to defined macros,
  8696. @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc., will reference
  8697. information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and similar lines.
  8698. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
  8699. @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
  8700. and to the modification time of the file being exported, respectively.
  8701. @var{FORMAT} should be a format string understood by
  8702. @code{format-time-string}.
  8703. Macro expansion takes place during export.
  8704. @node Embedded @LaTeX{}, Special blocks, Macro replacement, Markup
  8705. @section Embedded @LaTeX{}
  8706. @cindex @TeX{} interpretation
  8707. @cindex @LaTeX{} interpretation
  8708. Plain ASCII is normally sufficient for almost all note taking. Exceptions
  8709. include scientific notes, which often require mathematical symbols and the
  8710. occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
  8711. Donald E. Knuth's @TeX{} system. Many of the features described here as
  8712. ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
  8713. distinction.} is widely used to typeset scientific documents. Org mode
  8714. supports embedding @LaTeX{} code into its files, because many academics are
  8715. used to writing and reading @LaTeX{} source code, and because it can be
  8716. readily processed to produce pretty output for a number of export back-ends.
  8717. @menu
  8718. * Special symbols:: Greek letters and other symbols
  8719. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  8720. * @LaTeX{} fragments:: Complex formulas made easy
  8721. * Previewing @LaTeX{} fragments:: What will this snippet look like?
  8722. * CDLaTeX mode:: Speed up entering of formulas
  8723. @end menu
  8724. @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
  8725. @subsection Special symbols
  8726. @cindex math symbols
  8727. @cindex special symbols
  8728. @cindex @TeX{} macros
  8729. @cindex @LaTeX{} fragments, markup rules
  8730. @cindex HTML entities
  8731. @cindex @LaTeX{} entities
  8732. You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
  8733. to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
  8734. for these symbols is available, just type @samp{\} and maybe a few letters,
  8735. and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
  8736. code, Org mode allows these symbols to be present without surrounding math
  8737. delimiters, for example:
  8738. @example
  8739. Angles are written as Greek letters \alpha, \beta and \gamma.
  8740. @end example
  8741. @vindex org-entities
  8742. During export, these symbols will be transformed into the native format of
  8743. the exporter back-end. Strings like @code{\alpha} will be exported as
  8744. @code{&alpha;} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
  8745. output. Similarly, @code{\nbsp} will become @code{&nbsp;} in HTML and
  8746. @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
  8747. like this: @samp{\Aacute@{@}stor}.
  8748. A large number of entities is provided, with names taken from both HTML and
  8749. @LaTeX{}; see the variable @var{org-entities} for the complete list.
  8750. @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
  8751. @samp{...} are all converted into special commands creating hyphens of
  8752. different lengths or a compact set of dots.
  8753. If you would like to see entities displayed as UTF-8 characters, use the
  8754. following command@footnote{You can turn this on by default by setting the
  8755. variable @var{org-pretty-entities}, or on a per-file base with the
  8756. @code{#+STARTUP} option @code{entitiespretty}.}:
  8757. @table @kbd
  8758. @cindex @code{entitiespretty}, STARTUP keyword
  8759. @kindex C-c C-x \
  8760. @item C-c C-x \
  8761. Toggle display of entities as UTF-8 characters. This does not change the
  8762. buffer content which remains plain ASCII, but it overlays the UTF-8 character
  8763. for display purposes only.
  8764. @end table
  8765. @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
  8766. @subsection Subscripts and superscripts
  8767. @cindex subscript
  8768. @cindex superscript
  8769. Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
  8770. subscripts. Again, these can be used without embedding them in math-mode
  8771. delimiters. To increase the readability of ASCII text, it is not necessary
  8772. (but OK) to surround multi-character sub- and superscripts with curly braces.
  8773. For example
  8774. @example
  8775. The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
  8776. the sun is R_@{sun@} = 6.96 x 10^8 m.
  8777. @end example
  8778. @vindex org-use-sub-superscripts
  8779. To avoid interpretation as raised or lowered text, you can quote @samp{^} and
  8780. @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
  8781. where the underscore is often used in a different context, Org's convention
  8782. to always interpret these as subscripts can get in your way. Configure the
  8783. variable @var{org-use-sub-superscripts} to change this convention. For
  8784. example, when setting this variable to @code{@{@}}, @samp{a_b} will not be
  8785. interpreted as a subscript, but @samp{a_@{b@}} will.
  8786. @table @kbd
  8787. @kindex C-c C-x \
  8788. @item C-c C-x \
  8789. In addition to showing entities as UTF-8 characters, this command will also
  8790. format sub- and superscripts in a WYSIWYM way.
  8791. @end table
  8792. @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
  8793. @subsection @LaTeX{} fragments
  8794. @cindex @LaTeX{} fragments
  8795. @vindex org-format-latex-header
  8796. Going beyond symbols and sub- and superscripts, a full formula language is
  8797. needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
  8798. to process these for several export back-ends. When exporting to @LaTeX{},
  8799. the code is obviously left as it is. When exporting to HTML, Org invokes the
  8800. @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
  8801. HTML export}) to process and display the math@footnote{If you plan to use
  8802. this regularly or on pages with significant page views, you should install
  8803. @file{MathJax} on your own server in order to limit the load of our server.}.
  8804. Finally, it can also process the mathematical expressions into
  8805. images@footnote{For this to work you need to be on a system with a working
  8806. @LaTeX{} installation. You also need the @file{dvipng} program or the
  8807. @file{convert}, respectively available at
  8808. @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick}
  8809. suite. The @LaTeX{} header that will be used when processing a fragment can
  8810. be configured with the variable @var{org-format-latex-header}.} that can be
  8811. displayed in a browser.
  8812. @LaTeX{} fragments don't need any special marking at all. The following
  8813. snippets will be identified as @LaTeX{} source code:
  8814. @itemize @bullet
  8815. @item
  8816. Environments of any kind@footnote{When @file{MathJax} is used, only the
  8817. environments recognized by @file{MathJax} will be processed. When
  8818. @file{dvipng} is used to create images, any @LaTeX{} environment will be
  8819. handled.}. The only requirement is that the @code{\begin} and @code{\end}
  8820. statements appear on a new line, at the beginning of the line or after
  8821. whitespaces only.
  8822. @item
  8823. Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
  8824. currency specifications, single @samp{$} characters are only recognized as
  8825. math delimiters if the enclosed text contains at most two line breaks, is
  8826. directly attached to the @samp{$} characters with no whitespace in between,
  8827. and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
  8828. For the other delimiters, there is no such restriction, so when in doubt, use
  8829. @samp{\(...\)} as inline math delimiters.
  8830. @end itemize
  8831. @noindent For example:
  8832. @example
  8833. \begin@{equation@}
  8834. x=\sqrt@{b@}
  8835. \end@{equation@}
  8836. If $a^2=b$ and \( b=2 \), then the solution must be
  8837. either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
  8838. @end example
  8839. @c FIXME
  8840. @c @noindent
  8841. @c @vindex org-format-latex-options
  8842. @c If you need any of the delimiter ASCII sequences for other purposes, you
  8843. @c can configure the option @code{org-format-latex-options} to deselect the
  8844. @c ones you do not wish to have interpreted by the @LaTeX{} converter.
  8845. @vindex org-export-with-latex
  8846. @LaTeX{} processing can be configured with the variable
  8847. @var{org-export-with-latex}. The default setting is @code{t} which means
  8848. @file{MathJax} for HTML, and no processing for ASCII and @LaTeX{} back-ends.
  8849. You can also set this variable on a per-file basis using one of these
  8850. lines:
  8851. @example
  8852. #+OPTIONS: tex:t @r{Do the right thing automatically (MathJax)}
  8853. #+OPTIONS: tex:dvipng @r{Force using dvipng images}
  8854. #+OPTIONS: tex:nil @r{Do not process @LaTeX{} fragments at all}
  8855. #+OPTIONS: tex:verbatim @r{Verbatim export, for jsMath or so}
  8856. @end example
  8857. @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
  8858. @subsection Previewing @LaTeX{} fragments
  8859. @cindex @LaTeX{} fragments, preview
  8860. @vindex org-latex-create-formula-image-program
  8861. If you have @file{dvipng} or @file{imagemagick} installed@footnote{Choose the
  8862. converter by setting the variable
  8863. @var{org-latex-create-formula-image-program} accordingly.}, @LaTeX{}
  8864. fragments can be processed to produce preview images of the typeset
  8865. expressions:
  8866. @table @kbd
  8867. @kindex C-c C-x C-l
  8868. @item C-c C-x C-l
  8869. Produce a preview image of the @LaTeX{} fragment at point and overlay it
  8870. over the source code. If there is no fragment at point, process all
  8871. fragments in the current entry (between two headlines). When called
  8872. with a prefix argument, process the entire subtree. When called with
  8873. two prefix arguments, or when the cursor is before the first headline,
  8874. process the entire buffer.
  8875. @kindex C-c C-c
  8876. @item C-c C-c
  8877. Remove the overlay preview images.
  8878. @end table
  8879. @vindex org-format-latex-options
  8880. You can customize the variable @var{org-format-latex-options} to influence
  8881. some aspects of the preview. In particular, the @code{:scale} (and for HTML
  8882. export, @code{:html-scale}) property can be used to adjust the size of the
  8883. preview images.
  8884. @vindex org-startup-with-latex-preview
  8885. You can turn on the previewing of all @LaTeX{} fragments in a file with
  8886. @example
  8887. #+STARTUP: latexpreview
  8888. @end example
  8889. To disable it, simply use
  8890. @example
  8891. #+STARTUP: nolatexpreview
  8892. @end example
  8893. @node CDLaTeX mode, , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
  8894. @subsection Using CD@LaTeX{} to enter math
  8895. @cindex CD@LaTeX{}
  8896. CD@LaTeX{} mode is a minor mode that is normally used in combination with a
  8897. major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
  8898. environments and math templates. Inside Org mode, you can make use of
  8899. some of the features of CD@LaTeX{} mode. You need to install
  8900. @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
  8901. AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
  8902. Don't use CD@LaTeX{} mode itself under Org mode, but use the light
  8903. version @var{org-cdlatex-mode} that comes as part of Org mode. Turn it
  8904. on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
  8905. Org files with
  8906. @lisp
  8907. (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
  8908. @end lisp
  8909. When this mode is enabled, the following features are present (for more
  8910. details see the documentation of CD@LaTeX{} mode):
  8911. @itemize @bullet
  8912. @kindex C-c @{
  8913. @item
  8914. Environment templates can be inserted with @kbd{C-c @{}.
  8915. @item
  8916. @kindex @key{TAB}
  8917. The @key{TAB} key will do template expansion if the cursor is inside a
  8918. @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
  8919. inside such a fragment, see the documentation of the function
  8920. @var{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
  8921. expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
  8922. correctly inside the first brace. Another @key{TAB} will get you into
  8923. the second brace. Even outside fragments, @key{TAB} will expand
  8924. environment abbreviations at the beginning of a line. For example, if
  8925. you write @samp{equ} at the beginning of a line and press @key{TAB},
  8926. this abbreviation will be expanded to an @code{equation} environment.
  8927. To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
  8928. @item
  8929. @kindex _
  8930. @kindex ^
  8931. @vindex cdlatex-simplify-sub-super-scripts
  8932. Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
  8933. characters together with a pair of braces. If you use @key{TAB} to move
  8934. out of the braces, and if the braces surround only a single character or
  8935. macro, they are removed again (depending on the variable
  8936. @var{cdlatex-simplify-sub-super-scripts}).
  8937. @item
  8938. @kindex `
  8939. Pressing the backquote @kbd{`} followed by a character inserts math
  8940. macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
  8941. after the backquote, a help window will pop up.
  8942. @item
  8943. @kindex '
  8944. Pressing the single-quote @kbd{'} followed by another character modifies
  8945. the symbol before point with an accent or a font. If you wait more than
  8946. 1.5 seconds after the single-quote, a help window will pop up. Character
  8947. modification will work only inside @LaTeX{} fragments; outside the quote
  8948. is normal.
  8949. @end itemize
  8950. @node Special blocks, , Embedded @LaTeX{}, Markup
  8951. @section Special blocks
  8952. @cindex Special blocks
  8953. Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal
  8954. examples}). It is also possible to create blocks containing raw code
  8955. targeted at a specific back-ends (e.g., @samp{#+BEGIN_LATEX}).
  8956. Any other block is a @emph{special block}. Each export back-end decides if
  8957. they should be exported, and how. When the block is ignored, its contents
  8958. are still exported, as if the block were not there. For example, when
  8959. exporting a @samp{#+BEGIN_TEST} block, HTML back-end wraps its contents
  8960. within @samp{<div name="test">} tag. Refer to back-end specific
  8961. documentation for more information.
  8962. @node Exporting, Publishing, Markup, Top
  8963. @chapter Exporting
  8964. @cindex exporting
  8965. The Org mode export facilities can be used to export Org documents or parts
  8966. of Org documents to a variety of other formats. In addition, these
  8967. facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode}
  8968. in foreign buffers so you can author tables and lists in Org syntax and
  8969. convert them in place to the target language.
  8970. ASCII export produces a readable and simple version of an Org file for
  8971. printing and sharing notes. HTML export allows you to easily publish notes
  8972. on the web, or to build full-fledged websites. @LaTeX{} export lets you use
  8973. Org mode and its structured editing functions to create arbitrarily complex
  8974. @LaTeX{} files for any kind of document. OpenDocument Text (ODT) export
  8975. allows seamless collaboration across organizational boundaries. Markdown
  8976. export lets you seamlessly collaborate with other developers. Finally, iCal
  8977. export can extract entries with deadlines or appointments to produce a file
  8978. in the iCalendar format.
  8979. @menu
  8980. * The Export Dispatcher:: The main exporter interface
  8981. * Export back-ends:: Built-in export formats
  8982. * Export settings:: Generic export settings
  8983. * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
  8984. * Beamer export:: Exporting as a Beamer presentation
  8985. * HTML export:: Exporting to HTML
  8986. * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
  8987. * Markdown export:: Exporting to Markdown
  8988. * OpenDocument Text export:: Exporting to OpenDocument Text
  8989. * iCalendar export:: Exporting to iCalendar
  8990. * Other built-in back-ends:: Exporting to @code{Texinfo}, a man page, or Org
  8991. * Export in foreign buffers:: Author tables in lists in Org syntax
  8992. * Advanced configuration:: Fine-tuning the export output
  8993. @end menu
  8994. @node The Export Dispatcher, Export back-ends, Exporting, Exporting
  8995. @section The Export Dispatcher
  8996. @vindex org-export-dispatch-use-expert-ui
  8997. @cindex Export, dispatcher
  8998. The main entry point for export related tasks is the dispatcher, a
  8999. hierarchical menu from which it is possible to select an export format and
  9000. toggle export options@footnote{It is also possible to use a less intrusive
  9001. interface by setting @var{org-export-dispatch-use-expert-ui} to a
  9002. non-@code{nil} value. In that case, only a prompt is visible from the
  9003. minibuffer. From there one can still switch back to regular menu by pressing
  9004. @key{?}.} from which it is possible to select an export format and to toggle
  9005. export options.
  9006. @c @quotation
  9007. @table @asis
  9008. @orgcmd{C-c C-e,org-export-dispatch}
  9009. Dispatch for export and publishing commands. When called with a @kbd{C-u}
  9010. prefix argument, repeat the last export command on the current buffer while
  9011. preserving toggled options. If the current buffer hasn't changed and subtree
  9012. export was activated, the command will affect that same subtree.
  9013. @end table
  9014. @c @end quotation
  9015. Normally the entire buffer is exported, but if there is an active region
  9016. only that part of the buffer will be exported.
  9017. Several export options (@pxref{Export settings}) can be toggled from the
  9018. export dispatcher with the following key combinations:
  9019. @table @kbd
  9020. @item C-a
  9021. @vindex org-export-async-init-file
  9022. Toggle asynchronous export. Asynchronous export uses an external Emacs
  9023. process that is configured with a specified initialization file.
  9024. While exporting asynchronously, the output is not displayed. It is stored in
  9025. a list called ``the export stack'', and can be viewed from there. The stack
  9026. can be reached by calling the dispatcher with a double @kbd{C-u} prefix
  9027. argument, or with @kbd{&} key from the dispatcher.
  9028. @vindex org-export-in-background
  9029. To make this behaviour the default, customize the variable
  9030. @var{org-export-in-background}.
  9031. @item C-b
  9032. Toggle body-only export. Its effect depends on the back-end used.
  9033. Typically, if the back-end has a header section (like @code{<head>...</head>}
  9034. in the HTML back-end), a body-only export will not include this header.
  9035. @item C-s
  9036. @vindex org-export-initial-scope
  9037. Toggle subtree export. The top heading becomes the document title.
  9038. You can change the default state of this option by setting
  9039. @var{org-export-initial-scope}.
  9040. @item C-v
  9041. Toggle visible-only export. Only export the text that is currently
  9042. visible, i.e. not hidden by outline visibility in the buffer.
  9043. @end table
  9044. @vindex org-export-copy-to-kill-ring
  9045. With the exception of asynchronous export, a successful export process writes
  9046. its output to the kill-ring. You can configure this behavior by altering the
  9047. option @var{org-export-copy-to-kill-ring}.
  9048. @node Export back-ends, Export settings, The Export Dispatcher, Exporting
  9049. @section Export back-ends
  9050. @cindex Export, back-ends
  9051. An export back-end is a library that translates Org syntax into a foreign
  9052. format. An export format is not available until the proper back-end has been
  9053. loaded.
  9054. @vindex org-export-backends
  9055. By default, the following four back-ends are loaded: @code{ascii},
  9056. @code{html}, @code{icalendar} and @code{latex}. It is possible to add more
  9057. (or remove some) by customizing @var{org-export-backends}.
  9058. Built-in back-ends include:
  9059. @itemize
  9060. @item ascii (ASCII format)
  9061. @item beamer (@LaTeX{} Beamer format)
  9062. @item html (HTML format)
  9063. @item icalendar (iCalendar format)
  9064. @item latex (@LaTeX{} format)
  9065. @item man (Man page format)
  9066. @item md (Markdown format)
  9067. @item odt (OpenDocument Text format)
  9068. @item texinfo (Texinfo format)
  9069. @end itemize
  9070. Other back-ends might be found in the @code{contrib/} directory
  9071. (@pxref{Installation}).
  9072. @node Export settings, ASCII/Latin-1/UTF-8 export, Export back-ends, Exporting
  9073. @section Export settings
  9074. @cindex Export, settings
  9075. Export options can be set: globally with variables; for an individual file by
  9076. making variables buffer-local with in-buffer settings (@pxref{In-buffer
  9077. settings}), by setting individual keywords, or by specifying them in a
  9078. compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
  9079. properties (@pxref{Properties and Columns}). Options set at a specific level
  9080. override options set at a more general level.
  9081. @cindex #+SETUPFILE
  9082. In-buffer settings may appear anywhere in the file, either directly or
  9083. indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
  9084. Option keyword sets tailored to a particular back-end can be inserted from
  9085. the export dispatcher (@pxref{The Export Dispatcher}) using the @code{Insert
  9086. template} command by pressing @key{#}. To insert keywords individually,
  9087. a good way to make sure the keyword is correct is to type @code{#+} and then
  9088. to use @kbd{M-<TAB>} for completion.
  9089. The export keywords available for every back-end, and their equivalent global
  9090. variables, include:
  9091. @table @samp
  9092. @item AUTHOR
  9093. @vindex user-full-name
  9094. The document author (@var{user-full-name}).
  9095. @item CREATOR
  9096. @vindex org-export-creator-string
  9097. Entity responsible for output generation (@var{org-export-creator-string}).
  9098. @item DATE
  9099. @vindex org-export-date-timestamp-format
  9100. A date or a time-stamp@footnote{The variable
  9101. @var{org-export-date-timestamp-format} defines how this time-stamp will be
  9102. exported.}.
  9103. @item DESCRIPTION
  9104. The page description, e.g., for the XHTML meta tag.
  9105. @item EMAIL
  9106. @vindex user-mail-address
  9107. The email address (@var{user-mail-address}).
  9108. @item KEYWORDS
  9109. The keywords defining the contents, e.g., for the XHTML meta tag.
  9110. @item LANGUAGE
  9111. @vindex org-export-default-language
  9112. The language used for translating some strings
  9113. (@var{org-export-default-language}). E.g., @samp{#+LANGUAGE: fr} will tell
  9114. Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
  9115. clocktable.
  9116. @item SELECT_TAGS
  9117. @vindex org-export-select-tags
  9118. The tags that select a tree for export (@var{org-export-select-tags}). The
  9119. default value is @code{:export:}. Within a subtree tagged with
  9120. @code{:export:}, you can still exclude entries with @code{:noexport:} (see
  9121. below).
  9122. @item EXCLUDE_TAGS
  9123. The tags that exclude a tree from export (@var{org-export-exclude-tags}).
  9124. The default value is @code{:noexport:}. Entries with the @code{:noexport:}
  9125. tag will be unconditionally excluded from the export, even if they have an
  9126. @code{:export:} tag.
  9127. @item TITLE
  9128. The title to be shown (otherwise derived from buffer's name).
  9129. @end table
  9130. The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
  9131. many options this way, you can use several @code{#+OPTIONS} lines.} form that
  9132. recognizes the following arguments:
  9133. @table @code
  9134. @item ':
  9135. @vindex org-export-with-smart-quotes
  9136. Toggle smart quotes (@var{org-export-with-smart-quotes}).
  9137. @item *:
  9138. Toggle emphasized text (@var{org-export-with-emphasize}).
  9139. @item -:
  9140. @vindex org-export-with-special-strings
  9141. Toggle conversion of special strings
  9142. (@var{org-export-with-special-strings}).
  9143. @item ::
  9144. @vindex org-export-with-fixed-width
  9145. Toggle fixed-width sections
  9146. (@var{org-export-with-fixed-width}).
  9147. @item <:
  9148. @vindex org-export-with-timestamps
  9149. Toggle inclusion of any time/date active/inactive stamps
  9150. (@var{org-export-with-timestamps}).
  9151. @item :
  9152. @vindex org-export-preserve-breaks
  9153. Toggle line-break-preservation (@var{org-export-preserve-breaks}).
  9154. @item ^:
  9155. @vindex org-export-with-sub-superscripts
  9156. Toggle @TeX{}-like syntax for sub- and superscripts. If you write "^:@{@}",
  9157. @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
  9158. it is (@var{org-export-with-sub-superscripts}).
  9159. @item arch:
  9160. @vindex org-export-with-archived-trees
  9161. Configure export of archived trees. Can be set to @code{headline} to only
  9162. process the headline, skipping its contents
  9163. (@var{org-export-with-archived-trees}).
  9164. @item author:
  9165. @vindex org-export-with-author
  9166. Toggle inclusion of author name into exported file
  9167. (@var{org-export-with-author}).
  9168. @item c:
  9169. @vindex org-export-with-clocks
  9170. Toggle inclusion of CLOCK keywords (@var{org-export-with-clocks}).
  9171. @item creator:
  9172. @vindex org-export-with-creator
  9173. Configure inclusion of creator info into exported file. It may be set to
  9174. @code{comment} (@var{org-export-with-creator}).
  9175. @item d:
  9176. @vindex org-export-with-drawers
  9177. Toggle inclusion of drawers, or list drawers to include
  9178. (@var{org-export-with-drawers}).
  9179. @item e:
  9180. @vindex org-export-with-entities
  9181. Toggle inclusion of entities (@var{org-export-with-entities}).
  9182. @item email:
  9183. @vindex org-export-with-email
  9184. Toggle inclusion of the author's e-mail into exported file
  9185. (@var{org-export-with-email}).
  9186. @item f:
  9187. @vindex org-export-with-footnotes
  9188. Toggle the inclusion of footnotes (@var{org-export-with-footnotes}).
  9189. @item H:
  9190. @vindex org-export-headline-levels
  9191. Set the number of headline levels for export
  9192. (@var{org-export-headline-levels}).
  9193. @item inline:
  9194. @vindex org-export-with-inlinetasks
  9195. Toggle inclusion of inlinetasks (@var{org-export-with-inlinetasks}).
  9196. @item num:
  9197. @vindex org-export-with-section-numbers
  9198. Toggle section-numbers (@var{org-export-with-section-numbers}).
  9199. @item p:
  9200. @vindex org-export-with-planning
  9201. Toggle export of planning information (@var{org-export-with-planning}).
  9202. ``Planning information'' is the line containing the @code{SCHEDULED:}, the
  9203. @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
  9204. @item pri:
  9205. @vindex org-export-with-priority
  9206. Toggle priority cookies (@var{org-export-with-priority}).
  9207. @item stat:
  9208. @vindex org-export-with-statistics-cookies
  9209. Toggle inclusion of statistics cookies
  9210. (@var{org-export-with-statistics-cookies}).
  9211. @item tags:
  9212. @vindex org-export-with-tags
  9213. Toggle inclusion of tags, may also be @code{not-in-toc}
  9214. (@var{org-export-with-tags}).
  9215. @item tasks:
  9216. @vindex org-export-with-tasks
  9217. Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
  9218. tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
  9219. (@var{org-export-with-tasks}).
  9220. @item tex:
  9221. @vindex org-export-with-latex
  9222. Configure export of @LaTeX{} fragments and environments. It may be set to
  9223. @code{verbatim} (@var{org-export-with-latex}).
  9224. @item timestamp:
  9225. @vindex org-export-time-stamp-file
  9226. Toggle inclusion of the creation time into exported file
  9227. (@var{org-export-time-stamp-file}).
  9228. @item toc:
  9229. @vindex org-export-with-toc
  9230. Toggle inclusion of the table of contents, or set the level limit
  9231. (@var{org-export-with-toc}).
  9232. @item todo:
  9233. @vindex org-export-with-todo-keywords
  9234. Toggle inclusion of TODO keywords into exported text
  9235. (@var{org-export-with-todo-keywords}).
  9236. @item |:
  9237. @vindex org-export-with-tables
  9238. Toggle inclusion of tables (@var{org-export-with-tables}).
  9239. @end table
  9240. @cindex #+BIND
  9241. A more general mechanism is also provided. Indeed, Emacs variables can
  9242. become buffer-local during export by using the BIND keyword. Its syntax is
  9243. @samp{#+BIND: variable value}. This is particularly useful for in-buffer
  9244. settings that cannot be changed using specific keywords.
  9245. These settings affect all buffer's export processes. Though, it is possible
  9246. to override them locally when exporting only a subtree. This is done by
  9247. adding a headline property named after the keyword with the @samp{EXPORT_}
  9248. prefix. For example, @samp{DATE} and @samp{OPTIONS} keywords become,
  9249. respectively @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS} properties.
  9250. Subtree export also supports the self-explicit @samp{EXPORT_FILE_NAME}
  9251. property@footnote{There is no buffer-wide equivalent for this property. The
  9252. file name in this case is derived from the file associated to the buffer, if
  9253. possible, or asked to the user otherwise.}.
  9254. @node ASCII/Latin-1/UTF-8 export, Beamer export, Export settings, Exporting
  9255. @section ASCII/Latin-1/UTF-8 export
  9256. @cindex ASCII export
  9257. @cindex Latin-1 export
  9258. @cindex UTF-8 export
  9259. ASCII export produces a simple and very readable version of an Org mode
  9260. file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
  9261. with special characters and symbols available in these encodings.
  9262. @vindex org-ascii-links-to-notes
  9263. Links are exported in a footnote-like style, with the descriptive part in the
  9264. text and the link in a note before the next heading. See the variable
  9265. @var{org-ascii-links-to-notes} for details and other options.
  9266. @subheading ASCII export commands
  9267. @table @kbd
  9268. @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
  9269. Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
  9270. will be @file{myfile.txt}. The file will be overwritten without warning.
  9271. When the original file is @file{myfile.txt}, the resulting file becomes
  9272. @file{myfile.txt.txt} in order to prevent data loss.
  9273. @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
  9274. Export to a temporary buffer. Do not create a file.
  9275. @end table
  9276. @subheading Header and sectioning structure
  9277. In the exported version, the first three outline levels become headlines,
  9278. defining a general document structure. Additional levels are exported as
  9279. lists. The transition can also occur at a different level (@pxref{Export
  9280. settings}).
  9281. @subheading Quoting ASCII text
  9282. You can insert text that will only appear when using @code{ASCII} back-end
  9283. with the following constructs:
  9284. @cindex #+ASCII
  9285. @cindex #+BEGIN_ASCII
  9286. @example
  9287. Text @@@@ascii:and additional text@@@@ within a paragraph.
  9288. #+ASCII: Some text
  9289. #+BEGIN_ASCII
  9290. All lines in this block will appear only when using this back-end.
  9291. #+END_ASCII
  9292. @end example
  9293. @subheading ASCII specific attributes
  9294. @cindex #+ATTR_ASCII
  9295. @cindex horizontal rules, in ASCII export
  9296. @code{ASCII} back-end only understands one attribute, @code{:width}, which
  9297. specifies the length, in characters, of a given horizontal rule. It must be
  9298. specified using an @code{ATTR_ASCII} line, directly preceding the rule.
  9299. @example
  9300. #+ATTR_ASCII: :width 10
  9301. -----
  9302. @end example
  9303. @node Beamer export, HTML export, ASCII/Latin-1/UTF-8 export, Exporting
  9304. @section Beamer export
  9305. @cindex Beamer export
  9306. The @LaTeX{} class @emph{Beamer} allows production of high quality
  9307. presentations using @LaTeX{} and pdf processing. Org mode has special
  9308. support for turning an Org mode file or tree into a Beamer presentation.
  9309. @subheading Beamer export commands
  9310. @table @kbd
  9311. @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
  9312. Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
  9313. file will be @file{myfile.tex}. The file will be overwritten without
  9314. warning.
  9315. @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
  9316. Export to a temporary buffer. Do not create a file.
  9317. @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
  9318. Export as @LaTeX{} and then process to PDF.
  9319. @item C-c C-e l O
  9320. Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
  9321. @end table
  9322. @subheading Sectioning, Frames and Blocks
  9323. Any tree with not-too-deep level nesting should in principle be exportable as
  9324. a Beamer presentation. Headlines fall into three categories: sectioning
  9325. elements, frames and blocks.
  9326. @itemize @minus
  9327. @item
  9328. @vindex org-beamer-frame-level
  9329. Headlines become frames when their level is equal to
  9330. @var{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
  9331. (@pxref{Export settings}).
  9332. @cindex property, BEAMER_ENV
  9333. Though, if a headline in the current tree has a @code{BEAMER_ENV} property
  9334. set to either to @code{frame} or @code{fullframe}, its level overrides the
  9335. variable. A @code{fullframe} is a frame with an empty (ignored) title.
  9336. @item
  9337. @vindex org-beamer-environments-default
  9338. @vindex org-beamer-environments-extra
  9339. All frame's children become @code{block} environments. Special block types
  9340. can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
  9341. this property is set, the entry will also get a @code{:B_environment:} tag to
  9342. make this visible. This tag has no semantic meaning, it is only a visual
  9343. aid.} to an appropriate value (see @var{org-beamer-environments-default} for
  9344. supported values and @var{org-beamer-environments-extra} for adding more).
  9345. @item
  9346. @cindex property, BEAMER_REF
  9347. As a special case, if the @code{BEAMER_ENV} property is set to either
  9348. @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
  9349. headline will become, respectively, an appendix, a note (within frame or
  9350. between frame, depending on its level), a note with its title ignored or an
  9351. @code{\againframe} command. In the latter case, a @code{BEAMER_REF} property
  9352. is mandatory in order to refer to the frame being resumed, and contents are
  9353. ignored.
  9354. Also, a headline with an @code{ignoreheading} environment will have its
  9355. contents only inserted in the output. This special value is useful to have
  9356. data between frames, or to properly close a @code{column} environment.
  9357. @end itemize
  9358. @cindex property, BEAMER_ACT
  9359. @cindex property, BEAMER_OPT
  9360. Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
  9361. The former is translated as an overlay/action specification, or a default
  9362. overlay specification when enclosed within square brackets. The latter
  9363. specifies options for the current frame. Though, @code{fragile} option is
  9364. added automatically if it contains source code that uses any verbatim
  9365. environment.
  9366. @cindex property, BEAMER_COL
  9367. Moreover, headlines handle the @code{BEAMER_COL} property. Its value should
  9368. be a decimal number representing the width of the column as a fraction of the
  9369. total text width. If the headline has no specific environment, its title
  9370. will be ignored and its contents will fill the column created. Otherwise,
  9371. the block will fill the whole column and the title will be preserved. Two
  9372. contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
  9373. @code{columns} @LaTeX{} environment. It will end before the next headline
  9374. without such a property. This environment is generated automatically.
  9375. Although, it can also be explicitly created, with a special @code{columns}
  9376. value for @code{BEAMER_ENV} property (if it needs to be set up with some
  9377. specific options, for example).
  9378. @subheading Beamer specific syntax
  9379. Beamer back-end is an extension of @LaTeX{} back-end. As such, all @LaTeX{}
  9380. specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
  9381. recognized. See @ref{@LaTeX{} and PDF export} for more information.
  9382. @cindex #+BEAMER_THEME
  9383. @cindex #+BEAMER_COLOR_THEME
  9384. @cindex #+BEAMER_FONT_THEME
  9385. @cindex #+BEAMER_INNER_THEME
  9386. @cindex #+BEAMER_OUTER_THEME
  9387. Beamer export introduces a number of keywords to insert code in the
  9388. document's header. Four control appearance of the presentantion:
  9389. @code{#+BEAMER_THEME}, @code{#+BEAMER_COLOR_THEME},
  9390. @code{#+BEAMER_FONT_THEME}, @code{#+BEAMER_INNER_THEME} and
  9391. @code{#+BEAMER_OUTER_THEME}. All of them accept optional arguments within
  9392. square brackets. The last one, @code{#+BEAMER_HEADER}, is more generic and
  9393. allows to append any line of code in the header.
  9394. @example
  9395. #+BEAMER_THEME: Rochester [height=20pt]
  9396. #+BEAMER_COLOR_THEME: spruce
  9397. @end example
  9398. Table of contents generated from @code{toc:t} @code{OPTION} keyword are
  9399. wrapped within a @code{frame} environment. Those generated from a @code{TOC}
  9400. keyword (@pxref{Table of contents}) are not. In that case, it is also
  9401. possible to specify options, enclosed within square brackets.
  9402. @example
  9403. #+TOC: headlines [currentsection]
  9404. @end example
  9405. Beamer specific code can be inserted with the following constructs:
  9406. @cindex #+BEAMER
  9407. @cindex #+BEGIN_BEAMER
  9408. @example
  9409. #+BEAMER: \pause
  9410. #+BEGIN_BEAMER
  9411. All lines in this block will appear only when using this back-end.
  9412. #+END_BEAMER
  9413. Text @@@@beamer:some code@@@@ within a paragraph.
  9414. @end example
  9415. In particular, this last example can be used to add overlay specifications to
  9416. objects whose type is among @code{bold}, @code{item}, @code{link},
  9417. @code{radio-target} and @code{target}, when the value is enclosed within
  9418. angular brackets and put at the beginning the object.
  9419. @example
  9420. A *@@@@beamer:<2->@@@@useful* feature
  9421. @end example
  9422. @cindex #+ATTR_BEAMER
  9423. Eventually, every plain list has support for @code{:environment},
  9424. @code{:overlay} and @code{:options} attributes through @code{ATTR_BEAMER}
  9425. affiliated keyword. The first one allows to use a different environment, the
  9426. second sets overlay specifications and the last one inserts optional
  9427. arguments in current list environment.
  9428. @example
  9429. #+ATTR_BEAMER: :overlay +-
  9430. - item 1
  9431. - item 2
  9432. @end example
  9433. @subheading Editing support
  9434. You can turn on a special minor mode @code{org-beamer-mode} for faster
  9435. editing with:
  9436. @example
  9437. #+STARTUP: beamer
  9438. @end example
  9439. @table @kbd
  9440. @orgcmd{C-c C-b,org-beamer-select-environment}
  9441. In @code{org-beamer-mode}, this key offers fast selection of a Beamer
  9442. environment or the @code{BEAMER_COL} property.
  9443. @end table
  9444. Also, a template for useful in-buffer settings or properties can be inserted
  9445. into the buffer with @kbd{M-x org-beamer-insert-options-template}. Among
  9446. other things, this will install a column view format which is very handy for
  9447. editing special properties used by Beamer.
  9448. @subheading An example
  9449. Here is a simple example Org document that is intended for Beamer export.
  9450. @smallexample
  9451. #+TITLE: Example Presentation
  9452. #+AUTHOR: Carsten Dominik
  9453. #+OPTIONS: H:2
  9454. #+LATEX_CLASS: beamer
  9455. #+LATEX_CLASS_OPTIONS: [presentation]
  9456. #+BEAMER_THEME: Madrid
  9457. #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
  9458. * This is the first structural section
  9459. ** Frame 1
  9460. *** Thanks to Eric Fraga :B_block:BMCOL:
  9461. :PROPERTIES:
  9462. :BEAMER_COL: 0.48
  9463. :BEAMER_ENV: block
  9464. :END:
  9465. for the first viable Beamer setup in Org
  9466. *** Thanks to everyone else :B_block:BMCOL:
  9467. :PROPERTIES:
  9468. :BEAMER_COL: 0.48
  9469. :BEAMER_ACT: <2->
  9470. :BEAMER_ENV: block
  9471. :END:
  9472. for contributing to the discussion
  9473. **** This will be formatted as a beamer note :B_note:
  9474. :PROPERTIES:
  9475. :BEAMER_env: note
  9476. :END:
  9477. ** Frame 2 (where we will not use columns)
  9478. *** Request
  9479. Please test this stuff!
  9480. @end smallexample
  9481. @node HTML export, @LaTeX{} and PDF export, Beamer export, Exporting
  9482. @section HTML export
  9483. @cindex HTML export
  9484. Org mode contains a HTML (XHTML 1.0 strict) exporter with extensive
  9485. HTML formatting, in ways similar to John Gruber's @emph{markdown}
  9486. language, but with additional support for tables.
  9487. @menu
  9488. * HTML Export commands:: How to invoke HTML export
  9489. * HTML preamble and postamble:: How to insert a preamble and a postamble
  9490. * Quoting HTML tags:: Using direct HTML in Org mode
  9491. * Links in HTML export:: How links will be interpreted and formatted
  9492. * Tables in HTML export:: How to modify the formatting of tables
  9493. * Images in HTML export:: How to insert figures into HTML output
  9494. * Math formatting in HTML export:: Beautiful math also on the web
  9495. * Text areas in HTML export:: An alternative way to show an example
  9496. * CSS support:: Changing the appearance of the output
  9497. * JavaScript support:: Info and Folding in a web browser
  9498. @end menu
  9499. @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
  9500. @subsection HTML export commands
  9501. @cindex region, active
  9502. @cindex active region
  9503. @cindex transient-mark-mode
  9504. @table @kbd
  9505. @orgcmd{C-c C-e h h,org-html-export-to-html}
  9506. @cindex property, EXPORT_FILE_NAME
  9507. Export as a HTML file. For an Org file @file{myfile.org},
  9508. the HTML file will be @file{myfile.html}. The file will be overwritten
  9509. without warning. If there is an active region@footnote{This requires
  9510. @var{transient-mark-mode} be turned on.}, only the region will be
  9511. exported. If the selected region is a single tree@footnote{To select the
  9512. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  9513. title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
  9514. property, that name will be used for the export.
  9515. @kbd{C-c C-e h o}
  9516. Export as a HTML file and immediately open it with a browser.
  9517. @orgcmd{C-c C-e h H,org-html-export-as-html}
  9518. Export to a temporary buffer. Do not create a file.
  9519. @item C-c C-e C-v h H/h h/h o
  9520. Export only the visible part of the document.
  9521. @end table
  9522. @c FIXME Exporting sublevels
  9523. @c @cindex headline levels, for exporting
  9524. @c In the exported version, the first 3 outline levels will become headlines,
  9525. @c defining a general document structure. Additional levels will be exported as
  9526. @c itemized lists. If you want that transition to occur at a different level,
  9527. @c specify it with a numeric prefix argument. For example,
  9528. @c @example
  9529. @c @kbd{C-2 C-c C-e b}
  9530. @c @end example
  9531. @c @noindent
  9532. @c creates two levels of headings and does the rest as items.
  9533. @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
  9534. @subsection HTML preamble and postamble
  9535. @vindex org-html-preamble
  9536. @vindex org-html-postamble
  9537. @vindex org-html-preamble-format
  9538. @vindex org-html-postamble-format
  9539. @vindex org-html-validation-link
  9540. @vindex org-export-creator-string
  9541. @vindex org-export-time-stamp-file
  9542. The HTML exporter lets you define a preamble and a postamble.
  9543. The default value for @var{org-html-preamble} is @code{t}, which means
  9544. that the preamble is inserted depending on the relevant format string in
  9545. @var{org-html-preamble-format}.
  9546. Setting @var{org-html-preamble} to a string will override the default format
  9547. string. If you set it to a function, it will insert the output of the
  9548. function, which must be a string. Setting to @code{nil} will not insert any
  9549. preamble.
  9550. The default value for @var{org-html-postamble} is @code{'auto}, which means
  9551. that the HTML exporter will look for information about the author, the email,
  9552. the creator and the date, and build the postamble from these values. Setting
  9553. @var{org-html-postamble} to @code{t} will insert the postamble from the
  9554. relevant format string found in @var{org-html-postamble-format}. Setting it
  9555. to @code{nil} will not insert any postamble.
  9556. @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
  9557. @subsection Quoting HTML tags
  9558. Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
  9559. @samp{&gt;} in HTML export. If you want to include simple HTML tags
  9560. which should be interpreted as such, mark them with @samp{@@} as in
  9561. @samp{@@<b>bold text@@</b>}. Note that this really works only for
  9562. simple tags. For more extensive HTML that should be copied verbatim to
  9563. the exported file use either
  9564. @cindex #+HTML
  9565. @cindex #+BEGIN_HTML
  9566. @example
  9567. #+HTML: Literal HTML code for export
  9568. @end example
  9569. @noindent or
  9570. @cindex #+BEGIN_HTML
  9571. @example
  9572. #+BEGIN_HTML
  9573. All lines between these markers are exported literally
  9574. #+END_HTML
  9575. @end example
  9576. @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
  9577. @subsection Links in HTML export
  9578. @cindex links, in HTML export
  9579. @cindex internal links, in HTML export
  9580. @cindex external links, in HTML export
  9581. Internal links (@pxref{Internal links}) will continue to work in HTML@. This
  9582. includes automatic links created by radio targets (@pxref{Radio
  9583. targets}). Links to external files will still work if the target file is on
  9584. the same @i{relative} path as the published Org file. Links to other
  9585. @file{.org} files will be translated into HTML links under the assumption
  9586. that a HTML version also exists of the linked file, at the same relative
  9587. path. @samp{id:} links can then be used to jump to specific entries across
  9588. files. For information related to linking files while publishing them to a
  9589. publishing directory see @ref{Publishing links}.
  9590. If you want to specify attributes for links, you can do so using a special
  9591. @code{#+ATTR_HTML} line to define attributes that will be added to the
  9592. @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
  9593. and @code{style} attributes for a link:
  9594. @cindex #+ATTR_HTML
  9595. @example
  9596. #+ATTR_HTML: :title The Org mode homepage :style color:red;
  9597. [[http://orgmode.org]]
  9598. @end example
  9599. @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
  9600. @subsection Tables
  9601. @cindex tables, in HTML
  9602. @vindex org-html-table-default-attributes
  9603. Org mode tables are exported to HTML using the table attributes defined in
  9604. @var{org-html-table-default-attributes}. The default setting makes tables
  9605. without cell borders and frame. If you would like to change this for
  9606. individual tables, place something like the following before the table:
  9607. @cindex #+CAPTION
  9608. @cindex #+ATTR_HTML
  9609. @example
  9610. #+CAPTION: This is a table with lines around and between cells
  9611. #+ATTR_HTML: :border 2 :rules all :frame border
  9612. @end example
  9613. @vindex org-html-table-row-tags
  9614. You can also modify the default tags used for each row by setting
  9615. @var{org-html-table-row-tags}. See the docstring for an example on
  9616. how to use this option.
  9617. @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
  9618. @subsection Images in HTML export
  9619. @cindex images, inline in HTML
  9620. @cindex inlining images in HTML
  9621. @vindex org-html-inline-images
  9622. HTML export can inline images given as links in the Org file, and
  9623. it can make an image the clickable part of a link. By
  9624. default@footnote{But see the variable
  9625. @var{org-html-inline-images}.}, images are inlined if a link does
  9626. not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
  9627. while @samp{[[file:myimg.jpg][the image]]} will just produce a link
  9628. @samp{the image} that points to the image. If the description part
  9629. itself is a @code{file:} link or a @code{http:} URL pointing to an
  9630. image, this image will be inlined and activated so that clicking on the
  9631. image will activate the link. For example, to include a thumbnail that
  9632. will link to a high resolution version of the image, you could use:
  9633. @example
  9634. [[file:highres.jpg][file:thumb.jpg]]
  9635. @end example
  9636. If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
  9637. In the example below we specify the @code{alt} and @code{title} attributes to
  9638. support text viewers and accessibility, and align it to the right.
  9639. @cindex #+CAPTION
  9640. @cindex #+ATTR_HTML
  9641. @example
  9642. #+CAPTION: A black cat stalking a spider
  9643. #+ATTR_HTML: :alt cat/spider image :title Action! :align right
  9644. [[./img/a.jpg]]
  9645. @end example
  9646. @noindent
  9647. You could use @code{http} addresses just as well.
  9648. @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
  9649. @subsection Math formatting in HTML export
  9650. @cindex MathJax
  9651. @cindex dvipng
  9652. @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
  9653. different ways on HTML pages. The default is to use the
  9654. @uref{http://www.mathjax.org, MathJax system} which should work out of the
  9655. box with Org mode installation because @uref{http://orgmode.org} serves
  9656. @file{MathJax} for Org mode users for small applications and for testing
  9657. purposes. @b{If you plan to use this regularly or on pages with significant
  9658. page views, you should install@footnote{Installation instructions can be
  9659. found on the MathJax website, see
  9660. @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
  9661. your own server in order to limit the load of our server.} To configure
  9662. @file{MathJax}, use the variable @var{org-html-mathjax-options} or
  9663. insert something like the following into the buffer:
  9664. @example
  9665. #+HTML_MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
  9666. @end example
  9667. @noindent See the docstring of the variable
  9668. @var{org-html-mathjax-options} for the meaning of the parameters in
  9669. this line.
  9670. If you prefer, you can also request that @LaTeX{} fragments are processed
  9671. into small images that will be inserted into the browser page. Before the
  9672. availability of MathJax, this was the default method for Org files. This
  9673. method requires that the @file{dvipng} program is available on your system.
  9674. You can still get this processing with
  9675. @example
  9676. #+OPTIONS: LaTeX:dvipng
  9677. @end example
  9678. @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
  9679. @subsection Text areas in HTML export
  9680. @cindex text areas, in HTML
  9681. An alternative way to publish literal code examples in HTML is to use text
  9682. areas, where the example can even be edited before pasting it into an
  9683. application. It is triggered by a @code{-t} switch at an @code{example} or
  9684. @code{src} block. Using this switch disables any options for syntax and
  9685. label highlighting, and line numbering, which may be present. You may also
  9686. use @code{-h} and @code{-w} switches to specify the height and width of the
  9687. text area, which default to the number of lines in the example, and 80,
  9688. respectively. For example
  9689. @example
  9690. #+BEGIN_EXAMPLE -t -w 40
  9691. (defun org-xor (a b)
  9692. "Exclusive or."
  9693. (if a (not b) b))
  9694. #+END_EXAMPLE
  9695. @end example
  9696. @node CSS support, JavaScript support, Text areas in HTML export, HTML export
  9697. @subsection CSS support
  9698. @cindex CSS, for HTML export
  9699. @cindex HTML export, CSS
  9700. @vindex org-html-todo-kwd-class-prefix
  9701. @vindex org-html-tag-class-prefix
  9702. You can also give style information for the exported file. The HTML exporter
  9703. assigns the following special CSS classes@footnote{If the classes on TODO
  9704. keywords and tags lead to conflicts, use the variables
  9705. @var{org-html-todo-kwd-class-prefix} and
  9706. @var{org-html-tag-class-prefix} to make them unique.} to appropriate
  9707. parts of the document---your style specifications may change these, in
  9708. addition to any of the standard classes like for headlines, tables, etc.
  9709. @example
  9710. p.author @r{author information, including email}
  9711. p.date @r{publishing date}
  9712. p.creator @r{creator info, about org mode version}
  9713. .title @r{document title}
  9714. .todo @r{TODO keywords, all not-done states}
  9715. .done @r{the DONE keywords, all states that count as done}
  9716. .WAITING @r{each TODO keyword also uses a class named after itself}
  9717. .timestamp @r{timestamp}
  9718. .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
  9719. .timestamp-wrapper @r{span around keyword plus timestamp}
  9720. .tag @r{tag in a headline}
  9721. ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
  9722. .target @r{target for links}
  9723. .linenr @r{the line number in a code example}
  9724. .code-highlighted @r{for highlighting referenced code lines}
  9725. div.outline-N @r{div for outline level N (headline plus text))}
  9726. div.outline-text-N @r{extra div for text at outline level N}
  9727. .section-number-N @r{section number in headlines, different for each level}
  9728. div.figure @r{how to format an inlined image}
  9729. pre.src @r{formatted source code}
  9730. pre.example @r{normal example}
  9731. p.verse @r{verse paragraph}
  9732. div.footnotes @r{footnote section headline}
  9733. p.footnote @r{footnote definition paragraph, containing a footnote}
  9734. .footref @r{a footnote reference number (always a <sup>)}
  9735. .footnum @r{footnote number in footnote definition (always <sup>)}
  9736. @end example
  9737. @vindex org-html-style-default
  9738. @vindex org-html-head-include-default-style
  9739. @vindex org-html-head
  9740. @vindex org-html-head-extra
  9741. @cindex #+HTML_INCLUDE_STYLE
  9742. Each exported file contains a compact default style that defines these
  9743. classes in a basic way@footnote{This style is defined in the constant
  9744. @var{org-html-style-default}, which you should not modify. To turn
  9745. inclusion of these defaults off, customize
  9746. @var{org-html-head-include-default-style} or set @code{#+HTML_INCLUDE_STYLE}
  9747. to @code{nil} on a per-file basis.}. You may overwrite these settings, or add to
  9748. them by using the variables @var{org-html-head} and
  9749. @var{org-html-head-extra}. You can override the global values of these
  9750. variables for each file by using these keywords:
  9751. @cindex #+HTML_HEAD
  9752. @cindex #+HTML_HEAD_EXTRA
  9753. @example
  9754. #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
  9755. #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
  9756. @end example
  9757. @noindent
  9758. For longer style definitions, you can use several such lines. You could also
  9759. directly write a @code{<style>} @code{</style>} section in this way, without
  9760. referring to an external file.
  9761. In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
  9762. property to assign a class to the tree. In order to specify CSS styles for a
  9763. particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
  9764. property.
  9765. @c FIXME: More about header and footer styles
  9766. @c FIXME: Talk about links and targets.
  9767. @node JavaScript support, , CSS support, HTML export
  9768. @subsection JavaScript supported display of web pages
  9769. @cindex Rose, Sebastian
  9770. Sebastian Rose has written a JavaScript program especially designed to
  9771. enhance the web viewing experience of HTML files created with Org. This
  9772. program allows you to view large files in two different ways. The first one
  9773. is an @emph{Info}-like mode where each section is displayed separately and
  9774. navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
  9775. as well, press @kbd{?} for an overview of the available keys). The second
  9776. view type is a @emph{folding} view much like Org provides inside Emacs. The
  9777. script is available at @url{http://orgmode.org/org-info.js} and you can find
  9778. the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
  9779. We host the script at our site, but if you use it a lot, you might not want
  9780. to be dependent on @url{http://orgmode.org} and prefer to install a local
  9781. copy on your own web server.
  9782. All it then takes to use this program is adding a single line to the Org
  9783. file:
  9784. @cindex #+INFOJS_OPT
  9785. @example
  9786. #+INFOJS_OPT: view:info toc:nil
  9787. @end example
  9788. @noindent
  9789. If this line is found, the HTML header will automatically contain the code
  9790. needed to invoke the script. Using the line above, you can set the following
  9791. viewing options:
  9792. @example
  9793. path: @r{The path to the script. The default is to grab the script from}
  9794. @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
  9795. @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
  9796. view: @r{Initial view when the website is first shown. Possible values are:}
  9797. info @r{Info-like interface with one section per page.}
  9798. overview @r{Folding interface, initially showing only top-level.}
  9799. content @r{Folding interface, starting with all headlines visible.}
  9800. showall @r{Folding interface, all headlines and text visible.}
  9801. sdepth: @r{Maximum headline level that will still become an independent}
  9802. @r{section for info and folding modes. The default is taken from}
  9803. @r{@var{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
  9804. @r{If this is smaller than in @var{org-export-headline-levels}, each}
  9805. @r{info/folding section can still contain child headlines.}
  9806. toc: @r{Should the table of contents @emph{initially} be visible?}
  9807. @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
  9808. tdepth: @r{The depth of the table of contents. The defaults are taken from}
  9809. @r{the variables @var{org-export-headline-levels} and @var{org-export-with-toc}.}
  9810. ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
  9811. @r{If yes, the toc will never be displayed as a section.}
  9812. ltoc: @r{Should there be short contents (children) in each section?}
  9813. @r{Make this @code{above} if the section should be above initial text.}
  9814. mouse: @r{Headings are highlighted when the mouse is over them. Should be}
  9815. @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
  9816. buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
  9817. @r{default), only one such button will be present.}
  9818. @end example
  9819. @noindent
  9820. @vindex org-html-infojs-options
  9821. @vindex org-html-use-infojs
  9822. You can choose default values for these options by customizing the variable
  9823. @var{org-html-infojs-options}. If you always want to apply the script to your
  9824. pages, configure the variable @var{org-html-use-infojs}.
  9825. @node @LaTeX{} and PDF export, Markdown export, HTML export, Exporting
  9826. @section @LaTeX{} and PDF export
  9827. @cindex @LaTeX{} export
  9828. @cindex PDF export
  9829. Org mode contains a @LaTeX{} exporter. With further processing@footnote{The
  9830. default @LaTeX{} output is designed for processing with @code{pdftex} or
  9831. @LaTeX{}. It includes packages that are not compatible with @code{xetex} and
  9832. possibly @code{luatex}. See the variables
  9833. @var{org-latex-default-packages-alist} and
  9834. @var{org-latex-packages-alist}.}, this back-end is also used to produce PDF
  9835. output. Since the @LaTeX{} output uses @file{hyperref} to implement links
  9836. and cross references, the PDF output file will be fully linked.
  9837. As is @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
  9838. will not be started if two contiguous syntactical elements are not separated
  9839. by an empty line.
  9840. This back-end also offers enhanced support for footnotes. Thus, it handles
  9841. nested footnotes, footnotes in tables and footnotes in items' description.
  9842. @menu
  9843. * @LaTeX{}/PDF export commands::
  9844. * Header and sectioning:: Setting up the export file structure
  9845. * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
  9846. * @LaTeX{} specific attributes:: Controlling @LaTeX{} output
  9847. @end menu
  9848. @node @LaTeX{}/PDF export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
  9849. @subsection @LaTeX{} export commands
  9850. @table @kbd
  9851. @orgcmd{C-c C-e l l,org-latex-export-to-latex}
  9852. Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
  9853. file will be @file{myfile.tex}. The file will be overwritten without
  9854. warning.
  9855. @orgcmd{C-c C-e l L,org-latex-export-as-latex}
  9856. Export to a temporary buffer. Do not create a file.
  9857. @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
  9858. Export as @LaTeX{} and then process to PDF.
  9859. @item C-c C-e l o
  9860. Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
  9861. @end table
  9862. @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{}/PDF export commands, @LaTeX{} and PDF export
  9863. @subsection Header and sectioning structure
  9864. @cindex @LaTeX{} class
  9865. @cindex @LaTeX{} sectioning structure
  9866. @cindex @LaTeX{} header
  9867. @cindex header, for @LaTeX{} files
  9868. @cindex sectioning structure, for @LaTeX{} export
  9869. The first three outline levels become headlines, defining a general document
  9870. structure. Additional levels are exported as @code{itemize} or
  9871. @code{enumerate} lists. The transition can also occur at a different level
  9872. (@pxref{Export settings}).
  9873. By default, the @LaTeX{} output uses the class @code{article}.
  9874. @vindex org-latex-default-class
  9875. @vindex org-latex-classes
  9876. @vindex org-latex-default-packages-alist
  9877. @vindex org-latex-packages-alist
  9878. You can change this globally by setting a different value for
  9879. @var{org-latex-default-class} or locally by adding an option like
  9880. @code{#+LATEX_CLASS: myclass} in your file, or with
  9881. a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
  9882. containing only this (sub)tree. The class must be listed in
  9883. @var{org-latex-classes}. This variable defines a header template for each
  9884. class@footnote{Into which the values of
  9885. @var{org-latex-default-packages-alist} and @var{org-latex-packages-alist}
  9886. are spliced.}, and allows you to define the sectioning structure for each
  9887. class. You can also define your own classes there.
  9888. @cindex #+LATEX_CLASS
  9889. @cindex #+LATEX_CLASS_OPTIONS
  9890. @cindex property, EXPORT_LATEX_CLASS
  9891. @cindex property, EXPORT_LATEX_CLASS_OPTIONS
  9892. @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
  9893. property can specify the options for the @code{\documentclass} macro. These
  9894. options have to be provided, as expected by @LaTeX{}, within square brackets.
  9895. @cindex #+LATEX_HEADER
  9896. @cindex #+LATEX_HEADER_EXTRA
  9897. You can also use @code{LATEX_HEADER} and
  9898. @code{LATEX_HEADER_EXTRA}@footnote{Unlike to @code{LATEX_HEADER}, contents
  9899. from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
  9900. @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
  9901. to add lines to the header. See the docstring of @var{org-latex-classes} for
  9902. more information.
  9903. An example is shown below.
  9904. @example
  9905. #+LATEX_CLASS: article
  9906. #+LATEX_CLASS_OPTIONS: [a4paper]
  9907. #+LATEX_HEADER: \usepackage@{xyz@}
  9908. * Headline 1
  9909. some text
  9910. @end example
  9911. @node Quoting @LaTeX{} code, @LaTeX{} specific attributes, Header and sectioning, @LaTeX{} and PDF export
  9912. @subsection Quoting @LaTeX{} code
  9913. Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
  9914. inserted into the @LaTeX{} file. Furthermore, you can add special code that
  9915. should only be present in @LaTeX{} export with the following constructs:
  9916. @cindex #+LATEX
  9917. @cindex #+BEGIN_LATEX
  9918. @example
  9919. Code within @@@@latex:some code@@@@ a paragraph.
  9920. #+LATEX: Literal @LaTeX{} code for export
  9921. #+BEGIN_LATEX
  9922. All lines between these markers are exported literally
  9923. #+END_LATEX
  9924. @end example
  9925. @node @LaTeX{} specific attributes, , Quoting @LaTeX{} code, @LaTeX{} and PDF export
  9926. @subsection @LaTeX{} specific attributes
  9927. @cindex #+ATTR_LATEX
  9928. @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line. They
  9929. affect tables, images, plain lists, special blocks and source blocks.
  9930. @subsubheading Tables in @LaTeX{} export
  9931. @cindex tables, in @LaTeX{} export
  9932. For @LaTeX{} export of a table, you can specify a label and a caption
  9933. (@pxref{Images and tables}). You can also use attributes to control table
  9934. layout and contents. Valid properties are:
  9935. @table @code
  9936. @item :mode
  9937. @vindex org-latex-default-table-mode
  9938. Nature of table's contents. It can be set to @code{table}, @code{math},
  9939. @code{inline-math} or @code{verbatim}. In particular, when in @code{math} or
  9940. @code{inline-math} mode, every cell is exported as-is, horizontal rules are
  9941. ignored and the table will be wrapped in a math environment. Also,
  9942. contiguous tables sharing the same math mode will be wrapped within the same
  9943. environment. Default mode is determined in
  9944. @var{org-latex-default-table-mode}.
  9945. @item :environment
  9946. @vindex org-latex-default-table-environment
  9947. Environment used for the table. It can be to any @LaTeX{} table
  9948. environment, like @code{tabularx}, @code{longtable}, @code{array},
  9949. @code{tabu}, @code{bmatrix}@enddots{} It defaults to
  9950. @var{org-latex-default-table-environment} value.
  9951. @item :float
  9952. Float environment for the table. Possible values are @code{sidewaystable},
  9953. @code{multicolumn} and @code{table}. If unspecified, a table with a caption
  9954. will have a @code{table} environment. Moreover, @code{:placement} attribute
  9955. can specify the positioning of the float.
  9956. @item :align
  9957. @itemx :font
  9958. @itemx :width
  9959. set, respectively, the alignment string of the table, its font size and its
  9960. width. They only apply on regular tables.
  9961. @item :spread
  9962. Boolean specific to the @code{tabu} and @code{longtabu} environments, and
  9963. only takes effect when used in conjunction with the @code{:width} attribute.
  9964. When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
  9965. value of @code{:width}.
  9966. @item :booktabs
  9967. @itemx :center
  9968. @itemx :rmlines
  9969. @vindex org-latex-tables-booktabs
  9970. @vindex org-latex-tables-centered
  9971. They toggle, respectively, @code{booktabs} usage (assuming the package is
  9972. properly loaded), table centering and removal of every horizontal rule but
  9973. the first one (in a "table.el" table only). In particular,
  9974. @var{org-latex-tables-booktabs} (resp.@: @var{org-latex-tables-centered})
  9975. activates the first (resp.@: second) attribute globally.
  9976. @item :math-prefix
  9977. @itemx :math-suffix
  9978. @itemx :math-arguments
  9979. string which will be inserted, respectively, before the table within the math
  9980. environment, after the table within the math environment, and between the
  9981. macro name and the contents of the table. The latter attribute is necessary
  9982. to matrix macros that require more than one argument (e.g.,
  9983. @code{qbordermatrix}).
  9984. @end table
  9985. Thus, attributes can be used in a wide array of situations, like writing
  9986. a table that will span over multiple pages, or a matrix product:
  9987. @example
  9988. #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
  9989. | ..... | ..... |
  9990. | ..... | ..... |
  9991. #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
  9992. | a | b |
  9993. | c | d |
  9994. #+ATTR_LATEX: :mode math :environment bmatrix
  9995. | 1 | 2 |
  9996. | 3 | 4 |
  9997. @end example
  9998. @subsubheading Images in @LaTeX{} export
  9999. @cindex images, inline in @LaTeX{}
  10000. @cindex inlining images in @LaTeX{}
  10001. Images that are linked to without a description part in the link, like
  10002. @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
  10003. output file resulting from @LaTeX{} processing. Org will use an
  10004. @code{\includegraphics} macro to insert the image@footnote{In the case of
  10005. TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
  10006. @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
  10007. You can specify specify image width or height with, respectively,
  10008. @code{:width} and @code{:height} attributes. It is also possible to add any
  10009. other option with the @code{:options} attribute, as shown in the following
  10010. example:
  10011. @example
  10012. #+ATTR_LATEX: :width 5cm :options angle=90
  10013. [[./img/sed-hr4049.pdf]]
  10014. @end example
  10015. If you have specified a caption as described in @ref{Images and tables}, the
  10016. picture will be wrapped into a @code{figure} environment and thus become
  10017. a floating element. You can also ask Org to export an image as a float
  10018. without specifying caption by setting the @code{:float} attribute. You may
  10019. also set it to:
  10020. @itemize @minus
  10021. @item
  10022. @code{wrap}: if you would like to let text flow around the image. It will
  10023. make the figure occupy the left half of the page.
  10024. @item
  10025. @code{multicolumn}: if you wish to include an image which spans multiple
  10026. columns in a page. This will export the image wrapped in a @code{figure*}
  10027. environment.
  10028. @end itemize
  10029. @noindent
  10030. To modify the placement option of any floating environment, set the
  10031. @code{placement} attribute.
  10032. @example
  10033. #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
  10034. [[./img/hst.png]]
  10035. @end example
  10036. Eventually, in the @code{:comment-include} attributes has a non-@code{nil} value,
  10037. the code actually including the image will be commented out.
  10038. @subsubheading Plain lists in @LaTeX{} export
  10039. @cindex plain lists, in @LaTeX{} export
  10040. Plain lists accept two optional attributes: @code{:environment} and
  10041. @code{:options}. The first one allows to use a non-standard environment
  10042. (e.g., @samp{inparaenum}). The second one allows to specify optional
  10043. arguments for that environment (square brackets may be omitted).
  10044. @example
  10045. #+ATTR_LATEX: :environment compactitem :options $\circ$
  10046. - you need ``paralist'' package to reproduce this example.
  10047. @end example
  10048. @subsubheading Source blocks in @LaTeX{} export
  10049. @cindex source blocks, in @LaTeX{} export
  10050. In addition to syntax defined in @ref{Literal examples}, names and captions
  10051. (@pxref{Images and tables}), source blocks also accept @code{:long-listing}
  10052. attribute, which prevents the block to become a float when non-@code{nil}.
  10053. @example
  10054. #+ATTR_LATEX: :long-listing t
  10055. #+BEGIN_SRC emacs-lisp
  10056. Code that may not fit in a single page.
  10057. #+END_SRC
  10058. @end example
  10059. @subsubheading Special blocks in @LaTeX{} export
  10060. @cindex special blocks, in @LaTeX{} export
  10061. In @LaTeX{} back-end, special blocks become environments of the same name.
  10062. Value of @code{:options} attribute will be appended as-is to that
  10063. environment's opening string. For example:
  10064. @example
  10065. #+ATTR_LATEX: :options [Proof of important theorem]
  10066. #+BEGIN_PROOF
  10067. ...
  10068. Therefore, any natural number above 4 is the sum of two primes.
  10069. #+END_PROOF
  10070. @end example
  10071. @noindent
  10072. becomes
  10073. @example
  10074. \begin@{proof@}[Proof of important theorem]
  10075. ...
  10076. Therefore, any natural number above 4 is the sum of two primes.
  10077. \end@{proof@}
  10078. @end example
  10079. @subsubheading Horizontal rules
  10080. @cindex horizontal rules, in @LaTeX{} export
  10081. Width and thickness of a given horizontal rule can be controlled with,
  10082. respectively, @code{:width} and @code{:thickness} attributes:
  10083. @example
  10084. #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
  10085. -----
  10086. @end example
  10087. @node Markdown export, OpenDocument Text export, @LaTeX{} and PDF export, Exporting
  10088. @section Markdown export
  10089. @cindex Markdown export
  10090. @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavour,
  10091. as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
  10092. mode buffer.
  10093. It is built over HTML back-end: any construct not supported by Markdown
  10094. syntax (e.g., tables) will be controlled and translated by @code{html}
  10095. back-end (@pxref{HTML export}).
  10096. @subheading Markdown export commands
  10097. @table @kbd
  10098. @orgcmd{C-c C-e m m,org-md-export-to-markdown}
  10099. Export as a text file written in Markdown syntax. For an Org file,
  10100. @file{myfile.org}, the resulting file will be @file{myfile.md}. The file
  10101. will be overwritten without warning.
  10102. @orgcmd{C-c C-e m M,org-md-export-as-markdown}
  10103. Export to a temporary buffer. Do not create a file.
  10104. @item C-c C-e m o
  10105. Export as a text file with Markdown syntax, then open it.
  10106. @end table
  10107. @subheading Header and sectioning structure
  10108. @vindex org-md-headline-style
  10109. Markdown export can generate both @code{atx} and @code{setext} types for
  10110. headlines, according to @var{org-md-headline-style}. The former introduces
  10111. a hard limit of two levels, whereas the latter pushes it to six. Headlines
  10112. below that limit are exported as lists. You can also set a soft limit before
  10113. that one (@pxref{Export settings}).
  10114. @c begin opendocument
  10115. @node OpenDocument Text export, iCalendar export, Markdown export, Exporting
  10116. @section OpenDocument Text export
  10117. @cindex ODT
  10118. @cindex OpenDocument
  10119. @cindex export, OpenDocument
  10120. @cindex LibreOffice
  10121. Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
  10122. (ODT) format. Documents created by this exporter use the
  10123. @cite{OpenDocument-v1.2
  10124. specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
  10125. Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
  10126. are compatible with LibreOffice 3.4.
  10127. @menu
  10128. * Pre-requisites for ODT export:: What packages ODT exporter relies on
  10129. * ODT export commands:: How to invoke ODT export
  10130. * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
  10131. * Applying custom styles:: How to apply custom styles to the output
  10132. * Links in ODT export:: How links will be interpreted and formatted
  10133. * Tables in ODT export:: How Tables are exported
  10134. * Images in ODT export:: How to insert images
  10135. * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
  10136. * Labels and captions in ODT export:: How captions are rendered
  10137. * Literal examples in ODT export:: How source and example blocks are formatted
  10138. * Advanced topics in ODT export:: Read this if you are a power user
  10139. @end menu
  10140. @node Pre-requisites for ODT export, ODT export commands, OpenDocument Text export, OpenDocument Text export
  10141. @subsection Pre-requisites for ODT export
  10142. @cindex zip
  10143. The ODT exporter relies on the @file{zip} program to create the final
  10144. output. Check the availability of this program before proceeding further.
  10145. @node ODT export commands, Extending ODT export, Pre-requisites for ODT export, OpenDocument Text export
  10146. @subsection ODT export commands
  10147. @subsubheading Exporting to ODT
  10148. @anchor{x-export-to-odt}
  10149. @cindex region, active
  10150. @cindex active region
  10151. @cindex transient-mark-mode
  10152. @table @kbd
  10153. @orgcmd{C-c C-e o o,org-odt-export-to-odt}
  10154. @cindex property EXPORT_FILE_NAME
  10155. Export as OpenDocument Text file.
  10156. @vindex org-odt-preferred-output-format
  10157. If @var{org-odt-preferred-output-format} is specified, automatically convert
  10158. the exported file to that format. @xref{x-export-to-other-formats, ,
  10159. Automatically exporting to other formats}.
  10160. For an Org file @file{myfile.org}, the ODT file will be
  10161. @file{myfile.odt}. The file will be overwritten without warning. If there
  10162. is an active region,@footnote{This requires @var{transient-mark-mode} to be
  10163. turned on} only the region will be exported. If the selected region is a
  10164. single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
  10165. tree head will become the document title. If the tree head entry has, or
  10166. inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
  10167. export.
  10168. @kbd{C-c C-e o O}
  10169. Export as an OpenDocument Text file and open the resulting file.
  10170. @vindex org-odt-preferred-output-format
  10171. If @var{org-odt-preferred-output-format} is specified, open the converted
  10172. file instead. @xref{x-export-to-other-formats, , Automatically exporting to
  10173. other formats}.
  10174. @end table
  10175. @node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export
  10176. @subsection Extending ODT export
  10177. The ODT exporter can interface with a variety of document
  10178. converters and supports popular converters out of the box. As a result, you
  10179. can use it to export to formats like @samp{doc} or convert a document from
  10180. one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
  10181. @cindex @file{unoconv}
  10182. @cindex LibreOffice
  10183. If you have a working installation of LibreOffice, a document converter is
  10184. pre-configured for you and you can use it right away. If you would like to
  10185. use @file{unoconv} as your preferred converter, customize the variable
  10186. @var{org-odt-convert-process} to point to @code{unoconv}. You can
  10187. also use your own favorite converter or tweak the default settings of the
  10188. @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
  10189. document converter}.
  10190. @subsubsection Automatically exporting to other formats
  10191. @anchor{x-export-to-other-formats}
  10192. @vindex org-odt-preferred-output-format
  10193. Very often, you will find yourself exporting to ODT format, only to
  10194. immediately save the exported document to other formats like @samp{doc},
  10195. @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
  10196. preferred output format by customizing the variable
  10197. @var{org-odt-preferred-output-format}. This way, the export commands
  10198. (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
  10199. format that is of immediate interest to you.
  10200. @subsubsection Converting between document formats
  10201. @anchor{x-convert-to-other-formats}
  10202. There are many document converters in the wild which support conversion to
  10203. and from various file formats, including, but not limited to the
  10204. ODT format. LibreOffice converter, mentioned above, is one such
  10205. converter. Once a converter is configured, you can interact with it using
  10206. the following command.
  10207. @vindex org-odt-convert
  10208. @table @kbd
  10209. @item M-x org-odt-convert RET
  10210. Convert an existing document from one format to another. With a prefix
  10211. argument, also open the newly produced file.
  10212. @end table
  10213. @node Applying custom styles, Links in ODT export, Extending ODT export, OpenDocument Text export
  10214. @subsection Applying custom styles
  10215. @cindex styles, custom
  10216. @cindex template, custom
  10217. The ODT exporter ships with a set of OpenDocument styles
  10218. (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
  10219. output. These factory styles, however, may not cater to your specific
  10220. tastes. To customize the output, you can either modify the above styles
  10221. files directly, or generate the required styles using an application like
  10222. LibreOffice. The latter method is suitable for expert and non-expert
  10223. users alike, and is described here.
  10224. @subsubsection Applying custom styles: the easy way
  10225. @enumerate
  10226. @item
  10227. Create a sample @file{example.org} file with the below settings and export it
  10228. to ODT format.
  10229. @example
  10230. #+OPTIONS: H:10 num:t
  10231. @end example
  10232. @item
  10233. Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
  10234. to locate the target styles---these typically have the @samp{Org} prefix---and
  10235. modify those to your taste. Save the modified file either as an
  10236. OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
  10237. @item
  10238. @cindex #+ODT_STYLES_FILE
  10239. @vindex org-odt-styles-file
  10240. Customize the variable @var{org-odt-styles-file} and point it to the
  10241. newly created file. For additional configuration options
  10242. @pxref{x-overriding-factory-styles,,Overriding factory styles}.
  10243. If you would like to choose a style on a per-file basis, you can use the
  10244. @code{#+ODT_STYLES_FILE} option. A typical setting will look like
  10245. @example
  10246. #+ODT_STYLES_FILE: "/path/to/example.ott"
  10247. @end example
  10248. or
  10249. @example
  10250. #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
  10251. @end example
  10252. @end enumerate
  10253. @subsubsection Using third-party styles and templates
  10254. You can use third-party styles and templates for customizing your output.
  10255. This will produce the desired output only if the template provides all
  10256. style names that the @samp{ODT} exporter relies on. Unless this condition is
  10257. met, the output is going to be less than satisfactory. So it is highly
  10258. recommended that you only work with templates that are directly derived from
  10259. the factory settings.
  10260. @node Links in ODT export, Tables in ODT export, Applying custom styles, OpenDocument Text export
  10261. @subsection Links in ODT export
  10262. @cindex links, in ODT export
  10263. ODT exporter creates native cross-references for internal links. It creates
  10264. Internet-style links for all other links.
  10265. A link with no description and destined to a regular (un-itemized) outline
  10266. heading is replaced with a cross-reference and section number of the heading.
  10267. A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
  10268. with a cross-reference and sequence number of the labeled entity.
  10269. @xref{Labels and captions in ODT export}.
  10270. @node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export
  10271. @subsection Tables in ODT export
  10272. @cindex tables, in ODT export
  10273. Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
  10274. tables is supported. However, export of complex @file{table.el} tables---tables
  10275. that have column or row spans---is not supported. Such tables are
  10276. stripped from the exported document.
  10277. By default, a table is exported with top and bottom frames and with rules
  10278. separating row and column groups (@pxref{Column groups}). Furthermore, all
  10279. tables are typeset to occupy the same width. If the table specifies
  10280. alignment and relative width for its columns (@pxref{Column width and
  10281. alignment}) then these are honored on export.@footnote{The column widths are
  10282. interpreted as weighted ratios with the default weight being 1}
  10283. @cindex #+ATTR_ODT
  10284. You can control the width of the table by specifying @code{:rel-width}
  10285. property using an @code{#+ATTR_ODT} line.
  10286. For example, consider the following table which makes use of all the rules
  10287. mentioned above.
  10288. @example
  10289. #+ATTR_ODT: :rel-width 50
  10290. | Area/Month | Jan | Feb | Mar | Sum |
  10291. |---------------+-------+-------+-------+-------|
  10292. | / | < | | | < |
  10293. | <l13> | <r5> | <r5> | <r5> | <r6> |
  10294. | North America | 1 | 21 | 926 | 948 |
  10295. | Middle East | 6 | 75 | 844 | 925 |
  10296. | Asia Pacific | 9 | 27 | 790 | 826 |
  10297. |---------------+-------+-------+-------+-------|
  10298. | Sum | 16 | 123 | 2560 | 2699 |
  10299. @end example
  10300. On export, the table will occupy 50% of text area. The columns will be sized
  10301. (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
  10302. and rest of the columns will be right-aligned. There will be vertical rules
  10303. after separating the header and last columns from other columns. There will
  10304. be horizontal rules separating the header and last rows from other rows.
  10305. If you are not satisfied with the above formatting options, you can create
  10306. custom table styles and associate them with a table using the
  10307. @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
  10308. @node Images in ODT export, Math formatting in ODT export, Tables in ODT export, OpenDocument Text export
  10309. @subsection Images in ODT export
  10310. @cindex images, embedding in ODT
  10311. @cindex embedding images in ODT
  10312. @subsubheading Embedding images
  10313. You can embed images within the exported document by providing a link to the
  10314. desired image file with no link description. For example, to embed
  10315. @samp{img.png} do either of the following:
  10316. @example
  10317. [[file:img.png]]
  10318. @end example
  10319. @example
  10320. [[./img.png]]
  10321. @end example
  10322. @subsubheading Embedding clickable images
  10323. You can create clickable images by providing a link whose description is a
  10324. link to an image file. For example, to embed a image
  10325. @file{org-mode-unicorn.png} which when clicked jumps to
  10326. @uref{http://Orgmode.org} website, do the following
  10327. @example
  10328. [[http://orgmode.org][./org-mode-unicorn.png]]
  10329. @end example
  10330. @subsubheading Sizing and scaling of embedded images
  10331. @cindex #+ATTR_ODT
  10332. You can control the size and scale of the embedded images using the
  10333. @code{#+ATTR_ODT} attribute.
  10334. @cindex identify, ImageMagick
  10335. @vindex org-odt-pixels-per-inch
  10336. The exporter specifies the desired size of the image in the final document in
  10337. units of centimeters. In order to scale the embedded images, the exporter
  10338. queries for pixel dimensions of the images using one of a) ImageMagick's
  10339. @file{identify} program or b) Emacs `create-image' and `image-size'
  10340. APIs@footnote{Use of @file{ImageMagick} is only desirable. However, if you
  10341. routinely produce documents that have large images or you export your Org
  10342. files that has images using a Emacs batch script, then the use of
  10343. @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
  10344. converted in to units of centimeters using
  10345. @var{org-odt-pixels-per-inch}. The default value of this variable is
  10346. set to @code{display-pixels-per-inch}. You can tweak this variable to
  10347. achieve the best results.
  10348. The examples below illustrate the various possibilities.
  10349. @table @asis
  10350. @item Explicitly size the image
  10351. To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
  10352. @example
  10353. #+ATTR_ODT: :width 10 :height 10
  10354. [[./img.png]]
  10355. @end example
  10356. @item Scale the image
  10357. To embed @file{img.png} at half its size, do the following:
  10358. @example
  10359. #+ATTR_ODT: :scale 0.5
  10360. [[./img.png]]
  10361. @end example
  10362. @item Scale the image to a specific width
  10363. To embed @file{img.png} with a width of 10 cm while retaining the original
  10364. height:width ratio, do the following:
  10365. @example
  10366. #+ATTR_ODT: :width 10
  10367. [[./img.png]]
  10368. @end example
  10369. @item Scale the image to a specific height
  10370. To embed @file{img.png} with a height of 10 cm while retaining the original
  10371. height:width ratio, do the following
  10372. @example
  10373. #+ATTR_ODT: :height 10
  10374. [[./img.png]]
  10375. @end example
  10376. @end table
  10377. @subsubheading Anchoring of images
  10378. @cindex #+ATTR_ODT
  10379. You can control the manner in which an image is anchored by setting the
  10380. @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one
  10381. of the the following three values for the @code{:anchor} property:
  10382. @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
  10383. To create an image that is anchored to a page, do the following:
  10384. @example
  10385. #+ATTR_ODT: :anchor "page"
  10386. [[./img.png]]
  10387. @end example
  10388. @node Math formatting in ODT export, Labels and captions in ODT export, Images in ODT export, OpenDocument Text export
  10389. @subsection Math formatting in ODT export
  10390. The ODT exporter has special support for handling math.
  10391. @menu
  10392. * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
  10393. * Working with MathML or OpenDocument formula files:: How to embed equations in native format
  10394. @end menu
  10395. @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in ODT export, Math formatting in ODT export
  10396. @subsubsection Working with @LaTeX{} math snippets
  10397. @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
  10398. document in one of the following ways:
  10399. @cindex MathML
  10400. @enumerate
  10401. @item MathML
  10402. This option is activated on a per-file basis with
  10403. @example
  10404. #+OPTIONS: LaTeX:t
  10405. @end example
  10406. With this option, @LaTeX{} fragments are first converted into MathML
  10407. fragments using an external @LaTeX{}-to-MathML converter program. The
  10408. resulting MathML fragments are then embedded as an OpenDocument Formula in
  10409. the exported document.
  10410. @vindex org-latex-to-mathml-convert-command
  10411. @vindex org-latex-to-mathml-jar-file
  10412. You can specify the @LaTeX{}-to-MathML converter by customizing the variables
  10413. @var{org-latex-to-mathml-convert-command} and
  10414. @var{org-latex-to-mathml-jar-file}.
  10415. If you prefer to use @file{MathToWeb}@footnote{See
  10416. @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
  10417. converter, you can configure the above variables as shown below.
  10418. @lisp
  10419. (setq org-latex-to-mathml-convert-command
  10420. "java -jar %j -unicode -force -df %o %I"
  10421. org-latex-to-mathml-jar-file
  10422. "/path/to/mathtoweb.jar")
  10423. @end lisp
  10424. You can use the following commands to quickly verify the reliability of
  10425. the @LaTeX{}-to-MathML converter.
  10426. @table @kbd
  10427. @item M-x org-odt-export-as-odf RET
  10428. Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
  10429. @item M-x org-odt-export-as-odf-and-open RET
  10430. Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
  10431. and open the formula file with the system-registered application.
  10432. @end table
  10433. @cindex dvipng
  10434. @item PNG images
  10435. This option is activated on a per-file basis with
  10436. @example
  10437. #+OPTIONS: LaTeX:dvipng
  10438. @end example
  10439. With this option, @LaTeX{} fragments are processed into PNG images and the
  10440. resulting images are embedded in the exported document. This method requires
  10441. that the @file{dvipng} program be available on your system.
  10442. @end enumerate
  10443. @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in ODT export
  10444. @subsubsection Working with MathML or OpenDocument formula files
  10445. For various reasons, you may find embedding @LaTeX{} math snippets in an
  10446. ODT document less than reliable. In that case, you can embed a
  10447. math equation by linking to its MathML (@file{.mml}) source or its
  10448. OpenDocument formula (@file{.odf}) file as shown below:
  10449. @example
  10450. [[./equation.mml]]
  10451. @end example
  10452. or
  10453. @example
  10454. [[./equation.odf]]
  10455. @end example
  10456. @node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export
  10457. @subsection Labels and captions in ODT export
  10458. You can label and caption various category of objects---an inline image, a
  10459. table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
  10460. @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
  10461. each labeled or captioned object of a given category separately. As a
  10462. result, each such object is assigned a sequence number based on order of it's
  10463. appearance in the Org file.
  10464. In the exported document, a user-provided caption is augmented with the
  10465. category and sequence number. Consider the following inline image in an Org
  10466. file.
  10467. @example
  10468. #+CAPTION: Bell curve
  10469. #+LABEL: fig:SED-HR4049
  10470. [[./img/a.png]]
  10471. @end example
  10472. It could be rendered as shown below in the exported document.
  10473. @example
  10474. Figure 2: Bell curve
  10475. @end example
  10476. @vindex org-odt-category-map-alist
  10477. You can modify the category component of the caption by customizing the
  10478. option @var{org-odt-category-map-alist}. For example, to tag all embedded
  10479. images with the string @samp{Illustration} (instead of the default
  10480. @samp{Figure}) use the following setting:
  10481. @lisp
  10482. (setq org-odt-category-map-alist
  10483. (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
  10484. @end lisp
  10485. With this, previous image will be captioned as below in the exported
  10486. document.
  10487. @example
  10488. Illustration 2: Bell curve
  10489. @end example
  10490. @node Literal examples in ODT export, Advanced topics in ODT export, Labels and captions in ODT export, OpenDocument Text export
  10491. @subsection Literal examples in ODT export
  10492. Export of literal examples (@pxref{Literal examples}) with full fontification
  10493. is supported. Internally, the exporter relies on @file{htmlfontify.el} to
  10494. generate all style definitions needed for a fancy listing.@footnote{Your
  10495. @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
  10496. fontification to be turned on.} The auto-generated styles have @samp{OrgSrc}
  10497. as prefix and inherit their color from the faces used by Emacs
  10498. @code{font-lock} library for the source language.
  10499. @vindex org-odt-fontify-srcblocks
  10500. If you prefer to use your own custom styles for fontification, you can do
  10501. so by customizing the option
  10502. @var{org-odt-create-custom-styles-for-srcblocks}.
  10503. @vindex org-odt-create-custom-styles-for-srcblocks
  10504. You can turn off fontification of literal examples by customizing the
  10505. option @var{org-odt-fontify-srcblocks}.
  10506. @node Advanced topics in ODT export, , Literal examples in ODT export, OpenDocument Text export
  10507. @subsection Advanced topics in ODT export
  10508. If you rely heavily on ODT export, you may want to exploit the full
  10509. set of features that the exporter offers. This section describes features
  10510. that would be of interest to power users.
  10511. @menu
  10512. * Configuring a document converter:: How to register a document converter
  10513. * Working with OpenDocument style files:: Explore the internals
  10514. * Creating one-off styles:: How to produce custom highlighting etc
  10515. * Customizing tables in ODT export:: How to define and use Table templates
  10516. * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
  10517. @end menu
  10518. @node Configuring a document converter, Working with OpenDocument style files, Advanced topics in ODT export, Advanced topics in ODT export
  10519. @subsubsection Configuring a document converter
  10520. @cindex convert
  10521. @cindex doc, docx, rtf
  10522. @cindex converter
  10523. The ODT exporter can work with popular converters with little or no
  10524. extra configuration from your side. @xref{Extending ODT export}.
  10525. If you are using a converter that is not supported by default or if you would
  10526. like to tweak the default converter settings, proceed as below.
  10527. @enumerate
  10528. @item Register the converter
  10529. @vindex org-odt-convert-processes
  10530. Name your converter and add it to the list of known converters by
  10531. customizing the option @var{org-odt-convert-processes}. Also specify how
  10532. the converter can be invoked via command-line to effect the conversion.
  10533. @item Configure its capabilities
  10534. @vindex org-odt-convert-capabilities
  10535. @anchor{x-odt-converter-capabilities} Specify the set of formats the
  10536. converter can handle by customizing the variable
  10537. @var{org-odt-convert-capabilities}. Use the default value for this
  10538. variable as a guide for configuring your converter. As suggested by the
  10539. default setting, you can specify the full set of formats supported by the
  10540. converter and not limit yourself to specifying formats that are related to
  10541. just the OpenDocument Text format.
  10542. @item Choose the converter
  10543. @vindex org-odt-convert-process
  10544. Select the newly added converter as the preferred one by customizing the
  10545. option @var{org-odt-convert-process}.
  10546. @end enumerate
  10547. @node Working with OpenDocument style files, Creating one-off styles, Configuring a document converter, Advanced topics in ODT export
  10548. @subsubsection Working with OpenDocument style files
  10549. @cindex styles, custom
  10550. @cindex template, custom
  10551. This section explores the internals of the ODT exporter and the
  10552. means by which it produces styled documents. Read this section if you are
  10553. interested in exploring the automatic and custom OpenDocument styles used by
  10554. the exporter.
  10555. @anchor{x-factory-styles}
  10556. @subsubheading Factory styles
  10557. The ODT exporter relies on two files for generating its output.
  10558. These files are bundled with the distribution under the directory pointed to
  10559. by the variable @var{org-odt-styles-dir}. The two files are:
  10560. @itemize
  10561. @anchor{x-orgodtstyles-xml}
  10562. @item
  10563. @file{OrgOdtStyles.xml}
  10564. This file contributes to the @file{styles.xml} file of the final @samp{ODT}
  10565. document. This file gets modified for the following purposes:
  10566. @enumerate
  10567. @item
  10568. To control outline numbering based on user settings.
  10569. @item
  10570. To add styles generated by @file{htmlfontify.el} for fontification of code
  10571. blocks.
  10572. @end enumerate
  10573. @anchor{x-orgodtcontenttemplate-xml}
  10574. @item
  10575. @file{OrgOdtContentTemplate.xml}
  10576. This file contributes to the @file{content.xml} file of the final @samp{ODT}
  10577. document. The contents of the Org outline are inserted between the
  10578. @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
  10579. Apart from serving as a template file for the final @file{content.xml}, the
  10580. file serves the following purposes:
  10581. @enumerate
  10582. @item
  10583. It contains automatic styles for formatting of tables which are referenced by
  10584. the exporter.
  10585. @item
  10586. It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
  10587. elements that control how various entities---tables, images, equations,
  10588. etc.---are numbered.
  10589. @end enumerate
  10590. @end itemize
  10591. @anchor{x-overriding-factory-styles}
  10592. @subsubheading Overriding factory styles
  10593. The following two variables control the location from which the ODT
  10594. exporter picks up the custom styles and content template files. You can
  10595. customize these variables to override the factory styles used by the
  10596. exporter.
  10597. @itemize
  10598. @anchor{x-org-odt-styles-file}
  10599. @item
  10600. @var{org-odt-styles-file}
  10601. Use this variable to specify the @file{styles.xml} that will be used in the
  10602. final output. You can specify one of the following values:
  10603. @enumerate
  10604. @item A @file{styles.xml} file
  10605. Use this file instead of the default @file{styles.xml}
  10606. @item A @file{.odt} or @file{.ott} file
  10607. Use the @file{styles.xml} contained in the specified OpenDocument Text or
  10608. Template file
  10609. @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
  10610. Use the @file{styles.xml} contained in the specified OpenDocument Text or
  10611. Template file. Additionally extract the specified member files and embed
  10612. those within the final @samp{ODT} document.
  10613. Use this option if the @file{styles.xml} file references additional files
  10614. like header and footer images.
  10615. @item @code{nil}
  10616. Use the default @file{styles.xml}
  10617. @end enumerate
  10618. @anchor{x-org-odt-content-template-file}
  10619. @item
  10620. @var{org-odt-content-template-file}
  10621. Use this variable to specify the blank @file{content.xml} that will be used
  10622. in the final output.
  10623. @end itemize
  10624. @node Creating one-off styles, Customizing tables in ODT export, Working with OpenDocument style files, Advanced topics in ODT export
  10625. @subsubsection Creating one-off styles
  10626. There are times when you would want one-off formatting in the exported
  10627. document. You can achieve this by embedding raw OpenDocument XML in the Org
  10628. file. The use of this feature is better illustrated with couple of examples.
  10629. @enumerate
  10630. @item Embedding ODT tags as part of regular text
  10631. You can include simple OpenDocument tags by prefixing them with
  10632. @samp{@@}. For example, to highlight a region of text do the following:
  10633. @example
  10634. @@<text:span text:style-name="Highlight">This is a
  10635. highlighted text@@</text:span>. But this is a
  10636. regular text.
  10637. @end example
  10638. @strong{Hint:} To see the above example in action, edit your
  10639. @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
  10640. custom @samp{Highlight} style as shown below.
  10641. @example
  10642. <style:style style:name="Highlight" style:family="text">
  10643. <style:text-properties fo:background-color="#ff0000"/>
  10644. </style:style>
  10645. @end example
  10646. @item Embedding a one-line OpenDocument XML
  10647. You can add a simple OpenDocument one-liner using the @code{#+ODT:}
  10648. directive. For example, to force a page break do the following:
  10649. @example
  10650. #+ODT: <text:p text:style-name="PageBreak"/>
  10651. @end example
  10652. @strong{Hint:} To see the above example in action, edit your
  10653. @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
  10654. custom @samp{PageBreak} style as shown below.
  10655. @example
  10656. <style:style style:name="PageBreak" style:family="paragraph"
  10657. style:parent-style-name="Text_20_body">
  10658. <style:paragraph-properties fo:break-before="page"/>
  10659. </style:style>
  10660. @end example
  10661. @item Embedding a block of OpenDocument XML
  10662. You can add a large block of OpenDocument XML using the
  10663. @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
  10664. For example, to create a one-off paragraph that uses bold text, do the
  10665. following:
  10666. @example
  10667. #+BEGIN_ODT
  10668. <text:p text:style-name="Text_20_body_20_bold">
  10669. This paragraph is specially formatted and uses bold text.
  10670. </text:p>
  10671. #+END_ODT
  10672. @end example
  10673. @end enumerate
  10674. @node Customizing tables in ODT export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in ODT export
  10675. @subsubsection Customizing tables in ODT export
  10676. @cindex tables, in ODT export
  10677. @cindex #+ATTR_ODT
  10678. You can override the default formatting of the table by specifying a custom
  10679. table style with the @code{#+ATTR_ODT} line. For a discussion on default
  10680. formatting of tables @pxref{Tables in ODT export}.
  10681. This feature closely mimics the way table templates are defined in the
  10682. OpenDocument-v1.2
  10683. specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
  10684. OpenDocument-v1.2 Specification}}
  10685. @subsubheading Custom table styles: an illustration
  10686. @vindex org-odt-table-styles
  10687. To have a quick preview of this feature, install the below setting and
  10688. export the table that follows:
  10689. @lisp
  10690. (setq org-odt-table-styles
  10691. (append org-odt-table-styles
  10692. '(("TableWithHeaderRowAndColumn" "Custom"
  10693. ((use-first-row-styles . t)
  10694. (use-first-column-styles . t)))
  10695. ("TableWithFirstRowandLastRow" "Custom"
  10696. ((use-first-row-styles . t)
  10697. (use-last-row-styles . t))))))
  10698. @end lisp
  10699. @example
  10700. #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
  10701. | Name | Phone | Age |
  10702. | Peter | 1234 | 17 |
  10703. | Anna | 4321 | 25 |
  10704. @end example
  10705. In the above example, you used a template named @samp{Custom} and installed
  10706. two table styles with the names @samp{TableWithHeaderRowAndColumn} and
  10707. @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
  10708. styles needed for producing the above template have been pre-defined for
  10709. you. These styles are available under the section marked @samp{Custom
  10710. Table Template} in @file{OrgOdtContentTemplate.xml}
  10711. (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
  10712. additional templates you have to define these styles yourselves.
  10713. @subsubheading Custom table styles: the nitty-gritty
  10714. To use this feature proceed as follows:
  10715. @enumerate
  10716. @item
  10717. Create a table template@footnote{See the @code{<table:table-template>}
  10718. element of the OpenDocument-v1.2 specification}
  10719. A table template is nothing but a set of @samp{table-cell} and
  10720. @samp{paragraph} styles for each of the following table cell categories:
  10721. @itemize @minus
  10722. @item Body
  10723. @item First column
  10724. @item Last column
  10725. @item First row
  10726. @item Last row
  10727. @item Even row
  10728. @item Odd row
  10729. @item Even column
  10730. @item Odd Column
  10731. @end itemize
  10732. The names for the above styles must be chosen based on the name of the table
  10733. template using a well-defined convention.
  10734. The naming convention is better illustrated with an example. For a table
  10735. template with the name @samp{Custom}, the needed style names are listed in
  10736. the following table.
  10737. @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
  10738. @headitem Table cell type
  10739. @tab @code{table-cell} style
  10740. @tab @code{paragraph} style
  10741. @item
  10742. @tab
  10743. @tab
  10744. @item Body
  10745. @tab @samp{CustomTableCell}
  10746. @tab @samp{CustomTableParagraph}
  10747. @item First column
  10748. @tab @samp{CustomFirstColumnTableCell}
  10749. @tab @samp{CustomFirstColumnTableParagraph}
  10750. @item Last column
  10751. @tab @samp{CustomLastColumnTableCell}
  10752. @tab @samp{CustomLastColumnTableParagraph}
  10753. @item First row
  10754. @tab @samp{CustomFirstRowTableCell}
  10755. @tab @samp{CustomFirstRowTableParagraph}
  10756. @item Last row
  10757. @tab @samp{CustomLastRowTableCell}
  10758. @tab @samp{CustomLastRowTableParagraph}
  10759. @item Even row
  10760. @tab @samp{CustomEvenRowTableCell}
  10761. @tab @samp{CustomEvenRowTableParagraph}
  10762. @item Odd row
  10763. @tab @samp{CustomOddRowTableCell}
  10764. @tab @samp{CustomOddRowTableParagraph}
  10765. @item Even column
  10766. @tab @samp{CustomEvenColumnTableCell}
  10767. @tab @samp{CustomEvenColumnTableParagraph}
  10768. @item Odd column
  10769. @tab @samp{CustomOddColumnTableCell}
  10770. @tab @samp{CustomOddColumnTableParagraph}
  10771. @end multitable
  10772. To create a table template with the name @samp{Custom}, define the above
  10773. styles in the
  10774. @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
  10775. of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
  10776. styles}).
  10777. @item
  10778. Define a table style@footnote{See the attributes @code{table:template-name},
  10779. @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
  10780. @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
  10781. @code{table:use-banding-rows-styles}, and
  10782. @code{table:use-banding-column-styles} of the @code{<table:table>} element in
  10783. the OpenDocument-v1.2 specification}
  10784. @vindex org-odt-table-styles
  10785. To define a table style, create an entry for the style in the variable
  10786. @code{org-odt-table-styles} and specify the following:
  10787. @itemize @minus
  10788. @item the name of the table template created in step (1)
  10789. @item the set of cell styles in that template that are to be activated
  10790. @end itemize
  10791. For example, the entry below defines two different table styles
  10792. @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
  10793. based on the same template @samp{Custom}. The styles achieve their intended
  10794. effect by selectively activating the individual cell styles in that template.
  10795. @lisp
  10796. (setq org-odt-table-styles
  10797. (append org-odt-table-styles
  10798. '(("TableWithHeaderRowAndColumn" "Custom"
  10799. ((use-first-row-styles . t)
  10800. (use-first-column-styles . t)))
  10801. ("TableWithFirstRowandLastRow" "Custom"
  10802. ((use-first-row-styles . t)
  10803. (use-last-row-styles . t))))))
  10804. @end lisp
  10805. @item
  10806. Associate a table with the table style
  10807. To do this, specify the table style created in step (2) as part of
  10808. the @code{ATTR_ODT} line as shown below.
  10809. @example
  10810. #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
  10811. | Name | Phone | Age |
  10812. | Peter | 1234 | 17 |
  10813. | Anna | 4321 | 25 |
  10814. @end example
  10815. @end enumerate
  10816. @node Validating OpenDocument XML, , Customizing tables in ODT export, Advanced topics in ODT export
  10817. @subsubsection Validating OpenDocument XML
  10818. Occasionally, you will discover that the document created by the
  10819. ODT exporter cannot be opened by your favorite application. One of
  10820. the common reasons for this is that the @file{.odt} file is corrupt. In such
  10821. cases, you may want to validate the document against the OpenDocument RELAX
  10822. NG Compact Syntax (RNC) schema.
  10823. For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
  10824. nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
  10825. general help with validation (and schema-sensitive editing) of XML files:
  10826. @inforef{Introduction,,nxml-mode}.
  10827. @vindex org-odt-schema-dir
  10828. If you have ready access to OpenDocument @file{.rnc} files and the needed
  10829. schema-locating rules in a single folder, you can customize the variable
  10830. @var{org-odt-schema-dir} to point to that directory. The ODT exporter
  10831. will take care of updating the @code{rng-schema-locating-files} for you.
  10832. @c end opendocument
  10833. @node iCalendar export, Other built-in back-ends, OpenDocument Text export, Exporting
  10834. @section iCalendar export
  10835. @cindex iCalendar export
  10836. @vindex org-icalendar-include-todo
  10837. @vindex org-icalendar-use-deadline
  10838. @vindex org-icalendar-use-scheduled
  10839. @vindex org-icalendar-categories
  10840. @vindex org-icalendar-alarm-time
  10841. Some people use Org mode for keeping track of projects, but still prefer a
  10842. standard calendar application for anniversaries and appointments. In this
  10843. case it can be useful to show deadlines and other time-stamped items in Org
  10844. files in the calendar application. Org mode can export calendar information
  10845. in the standard iCalendar format. If you also want to have TODO entries
  10846. included in the export, configure the variable
  10847. @var{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
  10848. and TODO items as VTODO@. It will also create events from deadlines that are
  10849. in non-TODO items. Deadlines and scheduling dates in TODO items will be used
  10850. to set the start and due dates for the TODO entry@footnote{See the variables
  10851. @var{org-icalendar-use-deadline} and @var{org-icalendar-use-scheduled}.}.
  10852. As categories, it will use the tags locally defined in the heading, and the
  10853. file/tree category@footnote{To add inherited tags or the TODO state,
  10854. configure the variable @var{org-icalendar-categories}.}. See the variable
  10855. @var{org-icalendar-alarm-time} for a way to assign alarms to entries with a
  10856. time.
  10857. @vindex org-icalendar-store-UID
  10858. @cindex property, ID
  10859. The iCalendar standard requires each entry to have a globally unique
  10860. identifier (UID). Org creates these identifiers during export. If you set
  10861. the variable @var{org-icalendar-store-UID}, the UID will be stored in the
  10862. @code{:ID:} property of the entry and re-used next time you report this
  10863. entry. Since a single entry can give rise to multiple iCalendar entries (as
  10864. a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
  10865. prefixes to the UID, depending on what triggered the inclusion of the entry.
  10866. In this way the UID remains unique, but a synchronization program can still
  10867. figure out from which entry all the different instances originate.
  10868. @table @kbd
  10869. @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
  10870. Create iCalendar entries for the current buffer and store them in the same
  10871. directory, using a file extension @file{.ics}.
  10872. @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
  10873. @vindex org-agenda-files
  10874. Like @kbd{C-c C-e c f}, but do this for all files in
  10875. @var{org-agenda-files}. For each of these files, a separate iCalendar
  10876. file will be written.
  10877. @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
  10878. @vindex org-icalendar-combined-agenda-file
  10879. Create a single large iCalendar file from all files in
  10880. @var{org-agenda-files} and write it to the file given by
  10881. @var{org-icalendar-combined-agenda-file}.
  10882. @end table
  10883. @vindex org-use-property-inheritance
  10884. @vindex org-icalendar-include-body
  10885. @cindex property, SUMMARY
  10886. @cindex property, DESCRIPTION
  10887. @cindex property, LOCATION
  10888. The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
  10889. property can be inherited from higher in the hierarchy if you configure
  10890. @var{org-use-property-inheritance} accordingly.} properties if the selected
  10891. entries have them. If not, the summary will be derived from the headline,
  10892. and the description from the body (limited to
  10893. @var{org-icalendar-include-body} characters).
  10894. How this calendar is best read and updated, depends on the application
  10895. you are using. The FAQ covers this issue.
  10896. @node Other built-in back-ends, Export in foreign buffers, iCalendar export, Exporting
  10897. @section Other built-in back-ends
  10898. @cindex export back-ends, built-in
  10899. @vindex org-export-backends
  10900. On top of the aforemetioned back-ends, Org comes with other built-in ones:
  10901. @itemize
  10902. @item @file{ox-man.el}: export to a man page.
  10903. @item @file{ox-texinfo.el}: export to @code{Texinfo} format.
  10904. @item @file{ox-org.el}: export to an Org document.
  10905. @end itemize
  10906. To activate these export back-end, customize @var{org-export-backends} or
  10907. load them directly with e.g., @code{(require 'ox-texinfo)}. This will add
  10908. new keys in the export dispatcher (@pxref{The Export Dispatcher}).
  10909. See the comment section of these files for more information on how to use
  10910. them.
  10911. @node Export in foreign buffers, Advanced configuration, Other built-in back-ends, Exporting
  10912. @section Export in foreign buffers
  10913. Most built-in back-ends come with a command to convert the selected region
  10914. into a selected format and replace this region by the exported output. Here
  10915. is a list of such conversion commands:
  10916. @table @code
  10917. @item org-html-convert-region-to-html
  10918. Convert the selected region into HTML.
  10919. @item org-latex-convert-region-to-latex
  10920. Convert the selected region into @LaTeX{}.
  10921. @item org-texinfo-convert-region-to-texinfo
  10922. Convert the selected region into @code{Texinfo}.
  10923. @item org-md-convert-region-to-md
  10924. Convert the selected region into @code{MarkDown}.
  10925. @end table
  10926. This is particularily useful for converting tables and lists in foreign
  10927. buffers. E.g., in a HTML buffer, you can turn on @code{orgstruct-mode}, then
  10928. use Org commands for editing a list, and finally select and convert the list
  10929. with @code{M-x org-html-convert-region-to-html RET}.
  10930. @node Advanced configuration, , Export in foreign buffers, Exporting
  10931. @section Advanced configuration
  10932. @subheading Hooks
  10933. @vindex org-export-before-processing-hook
  10934. @vindex org-export-before-parsing-hook
  10935. Two hooks are run during the first steps of the export process. The first
  10936. one, @var{org-export-before-processing-hook} is called before expanding
  10937. macros, Babel code and include keywords in the buffer. The second one,
  10938. @var{org-export-before-parsing-hook}, as its name suggests, happens just
  10939. before parsing the buffer. Their main use is for heavy duties, that is
  10940. duties involving structural modifications of the document. For example, one
  10941. may want to remove every headline in the buffer during export. The following
  10942. code can achieve this:
  10943. @lisp
  10944. @group
  10945. (defun my-headline-removal (backend)
  10946. "Remove all headlines in the current buffer.
  10947. BACKEND is the export back-end being used, as a symbol."
  10948. (org-map-entries
  10949. (lambda () (delete-region (point) (progn (forward-line) (point))))))
  10950. (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
  10951. @end group
  10952. @end lisp
  10953. Note that functions used in these hooks require a mandatory argument,
  10954. a symbol representing the back-end used.
  10955. @subheading Filters
  10956. @cindex Filters, exporting
  10957. Filters are lists of functions applied on a specific part of the output from
  10958. a given back-end. More explicitly, each time a back-end transforms an Org
  10959. object or element into another language, all functions within a given filter
  10960. type are called in turn on the string produced. The string returned by the
  10961. last function will be the one used in the final output.
  10962. There are filters sets for each type of element or object, for plain text,
  10963. for the parse tree, for the export options and for the final output. They
  10964. are all named after the same scheme: @code{org-export-filter-TYPE-functions},
  10965. where @code{TYPE} is the type targeted by the filter. Valid types are:
  10966. @multitable @columnfractions .33 .33 .33
  10967. @item bold
  10968. @tab babel-call
  10969. @tab center-block
  10970. @item clock
  10971. @tab code
  10972. @tab comment
  10973. @item comment-block
  10974. @tab diary-sexp
  10975. @tab drawer
  10976. @item dynamic-block
  10977. @tab entity
  10978. @tab example-block
  10979. @item export-block
  10980. @tab export-snippet
  10981. @tab final-output
  10982. @item fixed-width
  10983. @tab footnote-definition
  10984. @tab footnote-reference
  10985. @item headline
  10986. @tab horizontal-rule
  10987. @tab inline-babel-call
  10988. @item inline-src-block
  10989. @tab inlinetask
  10990. @tab italic
  10991. @item item
  10992. @tab keyword
  10993. @tab latex-environment
  10994. @item latex-fragment
  10995. @tab line-break
  10996. @tab link
  10997. @item node-property
  10998. @tab options
  10999. @tab paragraph
  11000. @item parse-tree
  11001. @tab plain-list
  11002. @tab plain-text
  11003. @item planning
  11004. @tab property-drawer
  11005. @tab quote-block
  11006. @item quote-section
  11007. @tab radio-target
  11008. @tab section
  11009. @item special-block
  11010. @tab src-block
  11011. @tab statistics-cookie
  11012. @item strike-through
  11013. @tab subscript
  11014. @tab superscript
  11015. @item table
  11016. @tab table-cell
  11017. @tab table-row
  11018. @item target
  11019. @tab timestamp
  11020. @tab underline
  11021. @item verbatim
  11022. @tab verse-block
  11023. @tab
  11024. @end multitable
  11025. For example, the following snippet allows me to use non-breaking spaces in
  11026. the Org buffer and get them translated into @LaTeX{} without using the
  11027. @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
  11028. @lisp
  11029. @group
  11030. (defun my-latex-filter-nobreaks (text backend info)
  11031. "Ensure \" \" are properly handled in LaTeX export."
  11032. (when (org-export-derived-backend-p backend 'latex)
  11033. (replace-regexp-in-string " " "~" text)))
  11034. (add-to-list 'org-export-filter-plain-text-functions
  11035. 'my-latex-filter-nobreaks)
  11036. @end group
  11037. @end lisp
  11038. Three arguments must be provided to a fiter: the code being changed, the
  11039. back-end used, and some information about the export process. You can safely
  11040. ignore the third argument for most purposes. Note the use of
  11041. @var{org-export-derived-backend-p}, which ensures that the filter will only
  11042. be applied when using @code{latex} back-end or any other back-end derived
  11043. from it (e.g., @code{beamer}).
  11044. @subheading Extending an existing back-end
  11045. This is obviously the most powerful customization, since the changes happen
  11046. at the parser level. Indeed, some export back-ends are built as extensions
  11047. of other ones (e.g. Markdown back-end an extension of HTML back-end).
  11048. Extending a back-end means that if an element type is not transcoded by the
  11049. new back-end, it will be handled by the original one. Hence you can extend
  11050. specific parts of a back-end without too much work.
  11051. As an example, imagine we want the @code{ascii} back-end to display the
  11052. language used in a source block, when it is available, but only when some
  11053. attribute is non-@code{nil}, like the following:
  11054. @example
  11055. #+ATTR_ASCII: :language t
  11056. @end example
  11057. Because that back-end is lacking in that area, we are going to create a new
  11058. back-end, @code{my-ascii} that will do the job.
  11059. @lisp
  11060. @group
  11061. (defun my-ascii-src-block (src-block contents info)
  11062. "Transcode a SRC-BLOCK element from Org to ASCII.
  11063. CONTENTS is nil. INFO is a plist used as a communication
  11064. channel."
  11065. (if (not (org-export-read-attribute :attr_ascii src-block :language))
  11066. (org-export-with-backend 'ascii src-block contents info)
  11067. (concat
  11068. (format ",--[ %s ]--\n%s`----"
  11069. (org-element-property :language src-block)
  11070. (replace-regexp-in-string
  11071. "^" "| "
  11072. (org-element-normalize-string
  11073. (org-export-format-code-default src-block info)))))))
  11074. (org-export-define-derived-backend 'my-ascii 'ascii
  11075. :translate-alist '((src-block . my-ascii-src-block)))
  11076. @end group
  11077. @end lisp
  11078. The @code{my-ascii-src-block} function looks at the attribute above the
  11079. element. If it isn’t true, it gives hand to the @code{ascii} back-end.
  11080. Otherwise, it creates a box around the code, leaving room for the language.
  11081. A new back-end is then created. It only changes its behaviour when
  11082. translating @code{src-block} type element. Now, all it takes to use the new
  11083. back-end is calling the following from an Org buffer:
  11084. @smalllisp
  11085. (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
  11086. @end smalllisp
  11087. It is obviously possible to write an interactive function for this, install
  11088. it in the export dispatcher menu, and so on.
  11089. @node Publishing, Working With Source Code, Exporting, Top
  11090. @chapter Publishing
  11091. @cindex publishing
  11092. Org includes a publishing management system that allows you to configure
  11093. automatic HTML conversion of @emph{projects} composed of interlinked org
  11094. files. You can also configure Org to automatically upload your exported HTML
  11095. pages and related attachments, such as images and source code files, to a web
  11096. server.
  11097. You can also use Org to convert files into PDF, or even combine HTML and PDF
  11098. conversion so that files are available in both formats on the server.
  11099. Publishing has been contributed to Org by David O'Toole.
  11100. @menu
  11101. * Configuration:: Defining projects
  11102. * Uploading files:: How to get files up on the server
  11103. * Sample configuration:: Example projects
  11104. * Triggering publication:: Publication commands
  11105. @end menu
  11106. @node Configuration, Uploading files, Publishing, Publishing
  11107. @section Configuration
  11108. Publishing needs significant configuration to specify files, destination
  11109. and many other properties of a project.
  11110. @menu
  11111. * Project alist:: The central configuration variable
  11112. * Sources and destinations:: From here to there
  11113. * Selecting files:: What files are part of the project?
  11114. * Publishing action:: Setting the function doing the publishing
  11115. * Publishing options:: Tweaking HTML/@LaTeX{} export
  11116. * Publishing links:: Which links keep working after publishing?
  11117. * Sitemap:: Generating a list of all pages
  11118. * Generating an index:: An index that reaches across pages
  11119. @end menu
  11120. @node Project alist, Sources and destinations, Configuration, Configuration
  11121. @subsection The variable @var{org-publish-project-alist}
  11122. @cindex org-publish-project-alist
  11123. @cindex projects, for publishing
  11124. @vindex org-publish-project-alist
  11125. Publishing is configured almost entirely through setting the value of one
  11126. variable, called @var{org-publish-project-alist}. Each element of the list
  11127. configures one project, and may be in one of the two following forms:
  11128. @lisp
  11129. ("project-name" :property value :property value ...)
  11130. @r{i.e., a well-formed property list with alternating keys and values}
  11131. @r{or}
  11132. ("project-name" :components ("project-name" "project-name" ...))
  11133. @end lisp
  11134. In both cases, projects are configured by specifying property values. A
  11135. project defines the set of files that will be published, as well as the
  11136. publishing configuration to use when publishing those files. When a project
  11137. takes the second form listed above, the individual members of the
  11138. @code{:components} property are taken to be sub-projects, which group
  11139. together files requiring different publishing options. When you publish such
  11140. a ``meta-project'', all the components will also be published, in the
  11141. sequence given.
  11142. @node Sources and destinations, Selecting files, Project alist, Configuration
  11143. @subsection Sources and destinations for files
  11144. @cindex directories, for publishing
  11145. Most properties are optional, but some should always be set. In
  11146. particular, Org needs to know where to look for source files,
  11147. and where to put published files.
  11148. @multitable @columnfractions 0.3 0.7
  11149. @item @code{:base-directory}
  11150. @tab Directory containing publishing source files
  11151. @item @code{:publishing-directory}
  11152. @tab Directory where output files will be published. You can directly
  11153. publish to a web server using a file name syntax appropriate for
  11154. the Emacs @file{tramp} package. Or you can publish to a local directory and
  11155. use external tools to upload your website (@pxref{Uploading files}).
  11156. @item @code{:preparation-function}
  11157. @tab Function or list of functions to be called before starting the
  11158. publishing process, for example, to run @code{make} for updating files to be
  11159. published. The project property list is scoped into this call as the
  11160. variable @code{project-plist}.
  11161. @item @code{:completion-function}
  11162. @tab Function or list of functions called after finishing the publishing
  11163. process, for example, to change permissions of the resulting files. The
  11164. project property list is scoped into this call as the variable
  11165. @code{project-plist}.
  11166. @end multitable
  11167. @noindent
  11168. @node Selecting files, Publishing action, Sources and destinations, Configuration
  11169. @subsection Selecting files
  11170. @cindex files, selecting for publishing
  11171. By default, all files with extension @file{.org} in the base directory
  11172. are considered part of the project. This can be modified by setting the
  11173. properties
  11174. @multitable @columnfractions 0.25 0.75
  11175. @item @code{:base-extension}
  11176. @tab Extension (without the dot!) of source files. This actually is a
  11177. regular expression. Set this to the symbol @code{any} if you want to get all
  11178. files in @code{:base-directory}, even without extension.
  11179. @item @code{:exclude}
  11180. @tab Regular expression to match file names that should not be
  11181. published, even though they have been selected on the basis of their
  11182. extension.
  11183. @item @code{:include}
  11184. @tab List of files to be included regardless of @code{:base-extension}
  11185. and @code{:exclude}.
  11186. @item @code{:recursive}
  11187. @tab non-@code{nil} means, check base-directory recursively for files to publish.
  11188. @end multitable
  11189. @node Publishing action, Publishing options, Selecting files, Configuration
  11190. @subsection Publishing action
  11191. @cindex action, for publishing
  11192. Publishing means that a file is copied to the destination directory and
  11193. possibly transformed in the process. The default transformation is to export
  11194. Org files as HTML files, and this is done by the function
  11195. @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
  11196. export}). But you also can publish your content as PDF files using
  11197. @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
  11198. using the corresponding functions.
  11199. If you want to publish the Org file as an @code{.org} file but with the
  11200. @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
  11201. function @code{org-org-publish-to-org}. This will produce @file{file.org}
  11202. and put it in the publishing directory. If you want a htmlized version of
  11203. this file, set the parameter @code{:htmlized-source} to @code{t}, it will
  11204. produce @file{file.org.html} in the publishing directory@footnote{If the
  11205. publishing directory is the same than the source directory, @file{file.org}
  11206. will be exported as @file{file.org.org}, so probably don't want to do this.}.
  11207. Other files like images only need to be copied to the publishing destination.
  11208. For this you can use @code{org-publish-attachment}. For non-org files, you
  11209. always need to specify the publishing function:
  11210. @multitable @columnfractions 0.3 0.7
  11211. @item @code{:publishing-function}
  11212. @tab Function executing the publication of a file. This may also be a
  11213. list of functions, which will all be called in turn.
  11214. @item @code{:htmlized-source}
  11215. @tab non-@code{nil} means, publish htmlized source.
  11216. @end multitable
  11217. The function must accept three arguments: a property list containing at least
  11218. a @code{:publishing-directory} property, the name of the file to be published
  11219. and the path to the publishing directory of the output file. It should take
  11220. the specified file, make the necessary transformation (if any) and place the
  11221. result into the destination folder.
  11222. @node Publishing options, Publishing links, Publishing action, Configuration
  11223. @subsection Options for the exporters
  11224. @cindex options, for publishing
  11225. The property list can be used to set many export options for the exporters.
  11226. In most cases, these properties correspond to user variables in Org. The
  11227. first table below lists these properties along with the variable they belong
  11228. to. The second table list HTML specific properties. See the documentation
  11229. string for the respective variable for details.
  11230. @vindex org-export-with-archived-trees
  11231. @vindex org-export-with-author
  11232. @vindex org-export-with-creator
  11233. @vindex org-display-custom-times
  11234. @vindex org-export-with-drawers
  11235. @vindex org-export-with-email
  11236. @vindex user-mail-address
  11237. @vindex org-export-with-emphasize
  11238. @vindex org-export-exclude-tags
  11239. @vindex org-export-with-fixed-width
  11240. @vindex org-export-with-footnotes
  11241. @vindex org-export-headline-levels
  11242. @vindex org-export-default-language
  11243. @vindex org-export-with-latex
  11244. @vindex org-export-preserve-breaks
  11245. @vindex org-export-with-priority
  11246. @vindex org-export-publishing-directory
  11247. @vindex org-export-with-section-numbers
  11248. @vindex org-export-select-tags
  11249. @vindex org-export-with-special-strings
  11250. @vindex org-export-with-sub-superscripts
  11251. @vindex org-export-with-toc
  11252. @vindex org-export-with-tables
  11253. @vindex org-export-with-tags
  11254. @vindex org-export-with-tasks
  11255. @vindex org-export-with-timestamps
  11256. @vindex org-export-with-todo-keywords
  11257. @multitable @columnfractions 0.32 0.68
  11258. @item @code{:archived-trees} @tab @var{org-export-with-archived-trees}
  11259. @item @code{:author} @tab @var{org-export-with-author}
  11260. @item @code{:creator} @tab @var{org-export-with-creator}
  11261. @item @code{:customtime} @tab @var{org-display-custom-times}
  11262. @item @code{:drawers} @tab @var{org-export-with-drawers}
  11263. @item @code{:email} @tab @var{org-export-with-email}
  11264. @item @code{:email} @tab @var{user-mail-address} : @code{addr;addr;..}
  11265. @item @code{:emphasize} @tab @var{org-export-with-emphasize}
  11266. @item @code{:exclude-tags} @tab @var{org-export-exclude-tags}
  11267. @item @code{:fixed-width} @tab @var{org-export-with-fixed-width}
  11268. @item @code{:footnotes} @tab @var{org-export-with-footnotes}
  11269. @item @code{:headline-levels} @tab @var{org-export-headline-levels}
  11270. @item @code{:language} @tab @var{org-export-default-language}
  11271. @item @code{:latex-fragments} @tab @var{org-export-with-latex}
  11272. @item @code{:preserve-breaks} @tab @var{org-export-preserve-breaks}
  11273. @item @code{:priority} @tab @var{org-export-with-priority}
  11274. @item @code{:publishing-directory} @tab @var{org-export-publishing-directory}
  11275. @item @code{:section-numbers} @tab @var{org-export-with-section-numbers}
  11276. @item @code{:select-tags} @tab @var{org-export-select-tags}
  11277. @item @code{:special-strings} @tab @var{org-export-with-special-strings}
  11278. @item @code{:sub-superscript} @tab @var{org-export-with-sub-superscripts}
  11279. @item @code{:table-of-contents} @tab @var{org-export-with-toc}
  11280. @item @code{:tables} @tab @var{org-export-with-tables}
  11281. @item @code{:tags} @tab @var{org-export-with-tags}
  11282. @item @code{:tasks} @tab @var{org-export-with-tasks}
  11283. @item @code{:timestamps} @tab @var{org-export-with-timestamps}
  11284. @item @code{:todo-keywords} @tab @var{org-export-with-todo-keywords}
  11285. @end multitable
  11286. @vindex org-html-doctype
  11287. @vindex org-html-xml-declaration
  11288. @vindex org-html-link-up
  11289. @vindex org-html-link-home
  11290. @vindex org-html-link-org-files-as-html
  11291. @vindex org-html-head
  11292. @vindex org-html-head-extra
  11293. @vindex org-html-inline-images
  11294. @vindex org-html-extension
  11295. @vindex org-html-preamble
  11296. @vindex org-html-postamble
  11297. @vindex org-html-table-default-attributes
  11298. @vindex org-html-style-include-default
  11299. @vindex org-html-style-include-scripts
  11300. @multitable @columnfractions 0.32 0.68
  11301. @item @code{:html-doctype} @tab @var{org-html-doctype}
  11302. @item @code{:html-xml-declaration} @tab @var{org-html-xml-declaration}
  11303. @item @code{:html-link-up} @tab @var{org-html-link-up}
  11304. @item @code{:html-link-home} @tab @var{org-html-link-home}
  11305. @item @code{:html-link-org-as-html} @tab @var{org-html-link-org-files-as-html}
  11306. @item @code{:html-head} @tab @var{org-html-head}
  11307. @item @code{:html-head-extra} @tab @var{org-html-head-extra}
  11308. @item @code{:html-inline-images} @tab @var{org-html-inline-images}
  11309. @item @code{:html-extension} @tab @var{org-html-extension}
  11310. @item @code{:html-preamble} @tab @var{org-html-preamble}
  11311. @item @code{:html-postamble} @tab @var{org-html-postamble}
  11312. @item @code{:html-table-attributes} @tab @var{org-html-table-default-attributes}
  11313. @item @code{:html-head-include-default-style} @tab @var{org-html-style-include-default}
  11314. @item @code{:html-head-include-scripts} @tab @var{org-html-style-include-scripts}
  11315. @end multitable
  11316. Most of the @code{org-export-with-*} variables have the same effect in each
  11317. exporter.
  11318. @vindex org-publish-project-alist
  11319. When a property is given a value in @var{org-publish-project-alist}, its
  11320. setting overrides the value of the corresponding user variable (if any)
  11321. during publishing. Options set within a file (@pxref{Export settings}),
  11322. however, override everything.
  11323. @node Publishing links, Sitemap, Publishing options, Configuration
  11324. @subsection Links between published files
  11325. @cindex links, publishing
  11326. To create a link from one Org file to another, you would use something like
  11327. @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
  11328. (@pxref{Hyperlinks}). When published, this link becomes a link to
  11329. @file{foo.html}. You can thus interlink the pages of your "org web" project
  11330. and the links will work as expected when you publish them to HTML@. If you
  11331. also publish the Org source file and want to link to it, use an @code{http:}
  11332. link instead of a @code{file:} link, because @code{file:} links are converted
  11333. to link to the corresponding @file{html} file.
  11334. You may also link to related files, such as images. Provided you are careful
  11335. with relative file names, and provided you have also configured Org to upload
  11336. the related files, these links will work too. See @ref{Complex example}, for
  11337. an example of this usage.
  11338. @node Sitemap, Generating an index, Publishing links, Configuration
  11339. @subsection Generating a sitemap
  11340. @cindex sitemap, of published pages
  11341. The following properties may be used to control publishing of
  11342. a map of files for a given project.
  11343. @multitable @columnfractions 0.35 0.65
  11344. @item @code{:auto-sitemap}
  11345. @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
  11346. or @code{org-publish-all}.
  11347. @item @code{:sitemap-filename}
  11348. @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
  11349. becomes @file{sitemap.html}).
  11350. @item @code{:sitemap-title}
  11351. @tab Title of sitemap page. Defaults to name of file.
  11352. @item @code{:sitemap-function}
  11353. @tab Plug-in function to use for generation of the sitemap.
  11354. Defaults to @code{org-publish-org-sitemap}, which generates a plain list
  11355. of links to all files in the project.
  11356. @item @code{:sitemap-sort-folders}
  11357. @tab Where folders should appear in the sitemap. Set this to @code{first}
  11358. (default) or @code{last} to display folders first or last,
  11359. respectively. Any other value will mix files and folders.
  11360. @item @code{:sitemap-sort-files}
  11361. @tab How the files are sorted in the site map. Set this to
  11362. @code{alphabetically} (default), @code{chronologically} or
  11363. @code{anti-chronologically}. @code{chronologically} sorts the files with
  11364. older date first while @code{anti-chronologically} sorts the files with newer
  11365. date first. @code{alphabetically} sorts the files alphabetically. The date of
  11366. a file is retrieved with @code{org-publish-find-date}.
  11367. @item @code{:sitemap-ignore-case}
  11368. @tab Should sorting be case-sensitive? Default @code{nil}.
  11369. @item @code{:sitemap-file-entry-format}
  11370. @tab With this option one can tell how a sitemap's entry is formatted in the
  11371. sitemap. This is a format string with some escape sequences: @code{%t} stands
  11372. for the title of the file, @code{%a} stands for the author of the file and
  11373. @code{%d} stands for the date of the file. The date is retrieved with the
  11374. @code{org-publish-find-date} function and formatted with
  11375. @code{org-publish-sitemap-date-format}. Default @code{%t}.
  11376. @item @code{:sitemap-date-format}
  11377. @tab Format string for the @code{format-time-string} function that tells how
  11378. a sitemap entry's date is to be formatted. This property bypasses
  11379. @var{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
  11380. @item @code{:sitemap-sans-extension}
  11381. @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
  11382. Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
  11383. Defaults to @code{nil}.
  11384. @end multitable
  11385. @node Generating an index, , Sitemap, Configuration
  11386. @subsection Generating an index
  11387. @cindex index, in a publishing project
  11388. Org mode can generate an index across the files of a publishing project.
  11389. @multitable @columnfractions 0.25 0.75
  11390. @item @code{:makeindex}
  11391. @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
  11392. publish it as @file{theindex.html}.
  11393. @end multitable
  11394. The file will be created when first publishing a project with the
  11395. @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
  11396. "theindex.inc"}. You can then build around this include statement by adding
  11397. a title, style information, etc.
  11398. @node Uploading files, Sample configuration, Configuration, Publishing
  11399. @section Uploading files
  11400. @cindex rsync
  11401. @cindex unison
  11402. For those people already utilizing third party sync tools such as
  11403. @command{rsync} or @command{unison}, it might be preferable not to use the built in
  11404. @i{remote} publishing facilities of Org mode which rely heavily on
  11405. Tramp. Tramp, while very useful and powerful, tends not to be
  11406. so efficient for multiple file transfer and has been known to cause problems
  11407. under heavy usage.
  11408. Specialized synchronization utilities offer several advantages. In addition
  11409. to timestamp comparison, they also do content and permissions/attribute
  11410. checks. For this reason you might prefer to publish your web to a local
  11411. directory (possibly even @i{in place} with your Org files) and then use
  11412. @file{unison} or @file{rsync} to do the synchronization with the remote host.
  11413. Since Unison (for example) can be configured as to which files to transfer to
  11414. a certain remote destination, it can greatly simplify the project publishing
  11415. definition. Simply keep all files in the correct location, process your Org
  11416. files with @code{org-publish} and let the synchronization tool do the rest.
  11417. You do not need, in this scenario, to include attachments such as @file{jpg},
  11418. @file{css} or @file{gif} files in the project definition since the 3rd party
  11419. tool syncs them.
  11420. Publishing to a local directory is also much faster than to a remote one, so
  11421. that you can afford more easily to republish entire projects. If you set
  11422. @var{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
  11423. benefit of re-including any changed external files such as source example
  11424. files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
  11425. Org is not smart enough to detect if included files have been modified.
  11426. @node Sample configuration, Triggering publication, Uploading files, Publishing
  11427. @section Sample configuration
  11428. Below we provide two example configurations. The first one is a simple
  11429. project publishing only a set of Org files. The second example is
  11430. more complex, with a multi-component project.
  11431. @menu
  11432. * Simple example:: One-component publishing
  11433. * Complex example:: A multi-component publishing example
  11434. @end menu
  11435. @node Simple example, Complex example, Sample configuration, Sample configuration
  11436. @subsection Example: simple publishing configuration
  11437. This example publishes a set of Org files to the @file{public_html}
  11438. directory on the local machine.
  11439. @lisp
  11440. (setq org-publish-project-alist
  11441. '(("org"
  11442. :base-directory "~/org/"
  11443. :publishing-directory "~/public_html"
  11444. :section-numbers nil
  11445. :table-of-contents nil
  11446. :style "<link rel=\"stylesheet\"
  11447. href=\"../other/mystyle.css\"
  11448. type=\"text/css\"/>")))
  11449. @end lisp
  11450. @node Complex example, , Simple example, Sample configuration
  11451. @subsection Example: complex publishing configuration
  11452. This more complicated example publishes an entire website, including
  11453. Org files converted to HTML, image files, Emacs Lisp source code, and
  11454. style sheets. The publishing directory is remote and private files are
  11455. excluded.
  11456. To ensure that links are preserved, care should be taken to replicate
  11457. your directory structure on the web server, and to use relative file
  11458. paths. For example, if your Org files are kept in @file{~/org} and your
  11459. publishable images in @file{~/images}, you would link to an image with
  11460. @c
  11461. @example
  11462. file:../images/myimage.png
  11463. @end example
  11464. @c
  11465. On the web server, the relative path to the image should be the
  11466. same. You can accomplish this by setting up an "images" folder in the
  11467. right place on the web server, and publishing images to it.
  11468. @lisp
  11469. (setq org-publish-project-alist
  11470. '(("orgfiles"
  11471. :base-directory "~/org/"
  11472. :base-extension "org"
  11473. :publishing-directory "/ssh:user@@host:~/html/notebook/"
  11474. :publishing-function org-html-publish-to-html
  11475. :exclude "PrivatePage.org" ;; regexp
  11476. :headline-levels 3
  11477. :section-numbers nil
  11478. :table-of-contents nil
  11479. :style "<link rel=\"stylesheet\"
  11480. href=\"../other/mystyle.css\" type=\"text/css\"/>"
  11481. :html-preamble t)
  11482. ("images"
  11483. :base-directory "~/images/"
  11484. :base-extension "jpg\\|gif\\|png"
  11485. :publishing-directory "/ssh:user@@host:~/html/images/"
  11486. :publishing-function org-publish-attachment)
  11487. ("other"
  11488. :base-directory "~/other/"
  11489. :base-extension "css\\|el"
  11490. :publishing-directory "/ssh:user@@host:~/html/other/"
  11491. :publishing-function org-publish-attachment)
  11492. ("website" :components ("orgfiles" "images" "other"))))
  11493. @end lisp
  11494. @node Triggering publication, , Sample configuration, Publishing
  11495. @section Triggering publication
  11496. Once properly configured, Org can publish with the following commands:
  11497. @table @kbd
  11498. @orgcmd{C-c C-e P x,org-publish}
  11499. Prompt for a specific project and publish all files that belong to it.
  11500. @orgcmd{C-c C-e P p,org-publish-current-project}
  11501. Publish the project containing the current file.
  11502. @orgcmd{C-c C-e P f,org-publish-current-file}
  11503. Publish only the current file.
  11504. @orgcmd{C-c C-e P a,org-publish-all}
  11505. Publish every project.
  11506. @end table
  11507. @vindex org-publish-use-timestamps-flag
  11508. Org uses timestamps to track when a file has changed. The above functions
  11509. normally only publish changed files. You can override this and force
  11510. publishing of all files by giving a prefix argument to any of the commands
  11511. above, or by customizing the variable @var{org-publish-use-timestamps-flag}.
  11512. This may be necessary in particular if files include other files via
  11513. @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
  11514. @comment node-name, next, previous, up
  11515. @comment Working With Source Code, Miscellaneous, Publishing, Top
  11516. @node Working With Source Code, Miscellaneous, Publishing, Top
  11517. @chapter Working with source code
  11518. @cindex Schulte, Eric
  11519. @cindex Davison, Dan
  11520. @cindex source code, working with
  11521. Source code can be included in Org mode documents using a @samp{src} block,
  11522. e.g.:
  11523. @example
  11524. #+BEGIN_SRC emacs-lisp
  11525. (defun org-xor (a b)
  11526. "Exclusive or."
  11527. (if a (not b) b))
  11528. #+END_SRC
  11529. @end example
  11530. Org mode provides a number of features for working with live source code,
  11531. including editing of code blocks in their native major-mode, evaluation of
  11532. code blocks, converting code blocks into source files (known as @dfn{tangling}
  11533. in literate programming), and exporting code blocks and their
  11534. results in several formats. This functionality was contributed by Eric
  11535. Schulte and Dan Davison, and was originally named Org-babel.
  11536. The following sections describe Org mode's code block handling facilities.
  11537. @menu
  11538. * Structure of code blocks:: Code block syntax described
  11539. * Editing source code:: Language major-mode editing
  11540. * Exporting code blocks:: Export contents and/or results
  11541. * Extracting source code:: Create pure source code files
  11542. * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
  11543. * Library of Babel:: Use and contribute to a library of useful code blocks
  11544. * Languages:: List of supported code block languages
  11545. * Header arguments:: Configure code block functionality
  11546. * Results of evaluation:: How evaluation results are handled
  11547. * Noweb reference syntax:: Literate programming in Org mode
  11548. * Key bindings and useful functions:: Work quickly with code blocks
  11549. * Batch execution:: Call functions from the command line
  11550. @end menu
  11551. @comment node-name, next, previous, up
  11552. @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
  11553. @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
  11554. @section Structure of code blocks
  11555. @cindex code block, structure
  11556. @cindex source code, block structure
  11557. @cindex #+NAME
  11558. @cindex #+BEGIN_SRC
  11559. Live code blocks can be specified with a @samp{src} block or
  11560. inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
  11561. @ref{Easy Templates} system} The structure of a @samp{src} block is
  11562. @example
  11563. #+NAME: <name>
  11564. #+BEGIN_SRC <language> <switches> <header arguments>
  11565. <body>
  11566. #+END_SRC
  11567. @end example
  11568. The @code{#+NAME:} line is optional, and can be used to name the code
  11569. block. Live code blocks require that a language be specified on the
  11570. @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
  11571. @cindex source code, inline
  11572. Live code blocks can also be specified inline using
  11573. @example
  11574. src_<language>@{<body>@}
  11575. @end example
  11576. or
  11577. @example
  11578. src_<language>[<header arguments>]@{<body>@}
  11579. @end example
  11580. @table @code
  11581. @item <#+NAME: name>
  11582. This line associates a name with the code block. This is similar to the
  11583. @code{#+NAME: Name} lines that can be used to name tables in Org mode
  11584. files. Referencing the name of a code block makes it possible to evaluate
  11585. the block from other places in the file, from other files, or from Org mode
  11586. table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
  11587. and the behavior of Org mode when two or more blocks share the same name is
  11588. undefined.
  11589. @cindex #+NAME
  11590. @item <language>
  11591. The language of the code in the block (see @ref{Languages}).
  11592. @cindex source code, language
  11593. @item <switches>
  11594. Optional switches control code block export (see the discussion of switches in
  11595. @ref{Literal examples})
  11596. @cindex source code, switches
  11597. @item <header arguments>
  11598. Optional header arguments control many aspects of evaluation, export and
  11599. tangling of code blocks (see @ref{Header arguments}).
  11600. Header arguments can also be set on a per-buffer or per-subtree
  11601. basis using properties.
  11602. @item source code, header arguments
  11603. @item <body>
  11604. Source code in the specified language.
  11605. @end table
  11606. @comment node-name, next, previous, up
  11607. @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
  11608. @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
  11609. @section Editing source code
  11610. @cindex code block, editing
  11611. @cindex source code, editing
  11612. @vindex org-edit-src-auto-save-idle-delay
  11613. @vindex org-edit-src-turn-on-auto-save
  11614. @kindex C-c '
  11615. Use @kbd{C-c '} to edit the current code block. This brings up a language
  11616. major-mode edit buffer containing the body of the code block. Manually
  11617. saving this buffer with @key{C-x C-s} will write the contents back to the Org
  11618. buffer. You can also set @var{org-edit-src-auto-save-idle-delay} to save the
  11619. base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
  11620. to auto-save this buffer into a separate file using @code{auto-save-mode}.
  11621. Use @kbd{C-c '} again to exit.
  11622. The @code{org-src-mode} minor mode will be active in the edit buffer. The
  11623. following variables can be used to configure the behavior of the edit
  11624. buffer. See also the customization group @code{org-edit-structure} for
  11625. further configuration options.
  11626. @table @code
  11627. @item org-src-lang-modes
  11628. If an Emacs major-mode named @code{<lang>-mode} exists, where
  11629. @code{<lang>} is the language named in the header line of the code block,
  11630. then the edit buffer will be placed in that major-mode. This variable
  11631. can be used to map arbitrary language names to existing major modes.
  11632. @item org-src-window-setup
  11633. Controls the way Emacs windows are rearranged when the edit buffer is created.
  11634. @item org-src-preserve-indentation
  11635. This variable is especially useful for tangling languages such as
  11636. Python, in which whitespace indentation in the output is critical.
  11637. @item org-src-ask-before-returning-to-edit-buffer
  11638. By default, Org will ask before returning to an open edit buffer. Set this
  11639. variable to @code{nil} to switch without asking.
  11640. @end table
  11641. To turn on native code fontification in the @emph{Org} buffer, configure the
  11642. variable @var{org-src-fontify-natively}.
  11643. @comment node-name, next, previous, up
  11644. @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
  11645. @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
  11646. @section Exporting code blocks
  11647. @cindex code block, exporting
  11648. @cindex source code, exporting
  11649. It is possible to export the @emph{code} of code blocks, the @emph{results}
  11650. of code block evaluation, @emph{both} the code and the results of code block
  11651. evaluation, or @emph{none}. For most languages, the default exports code.
  11652. However, for some languages (e.g., @code{ditaa}) the default exports the
  11653. results of code block evaluation. For information on exporting code block
  11654. bodies, see @ref{Literal examples}.
  11655. The @code{:exports} header argument can be used to specify export
  11656. behavior:
  11657. @subsubheading Header arguments:
  11658. @table @code
  11659. @item :exports code
  11660. The default in most languages. The body of the code block is exported, as
  11661. described in @ref{Literal examples}.
  11662. @item :exports results
  11663. The code block will be evaluated and the results will be placed in the
  11664. Org mode buffer for export, either updating previous results of the code
  11665. block located anywhere in the buffer or, if no previous results exist,
  11666. placing the results immediately after the code block. The body of the code
  11667. block will not be exported.
  11668. @item :exports both
  11669. Both the code block and its results will be exported.
  11670. @item :exports none
  11671. Neither the code block nor its results will be exported.
  11672. @end table
  11673. It is possible to inhibit the evaluation of code blocks during export.
  11674. Setting the @var{org-export-babel-evaluate} variable to @code{nil} will
  11675. ensure that no code blocks are evaluated as part of the export process. This
  11676. can be useful in situations where potentially untrusted Org mode files are
  11677. exported in an automated fashion, for example when Org mode is used as the
  11678. markup language for a wiki.
  11679. @comment node-name, next, previous, up
  11680. @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
  11681. @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
  11682. @section Extracting source code
  11683. @cindex tangling
  11684. @cindex source code, extracting
  11685. @cindex code block, extracting source code
  11686. Creating pure source code files by extracting code from source blocks is
  11687. referred to as ``tangling''---a term adopted from the literate programming
  11688. community. During ``tangling'' of code blocks their bodies are expanded
  11689. using @code{org-babel-expand-src-block} which can expand both variable and
  11690. ``noweb'' style references (see @ref{Noweb reference syntax}).
  11691. @subsubheading Header arguments
  11692. @table @code
  11693. @item :tangle no
  11694. The default. The code block is not included in the tangled output.
  11695. @item :tangle yes
  11696. Include the code block in the tangled output. The output file name is the
  11697. name of the org file with the extension @samp{.org} replaced by the extension
  11698. for the block language.
  11699. @item :tangle filename
  11700. Include the code block in the tangled output to file @samp{filename}.
  11701. @end table
  11702. @kindex C-c C-v t
  11703. @subsubheading Functions
  11704. @table @code
  11705. @item org-babel-tangle
  11706. Tangle the current file. Bound to @kbd{C-c C-v t}.
  11707. With prefix argument only tangle the current code block.
  11708. @item org-babel-tangle-file
  11709. Choose a file to tangle. Bound to @kbd{C-c C-v f}.
  11710. @end table
  11711. @subsubheading Hooks
  11712. @table @code
  11713. @item org-babel-post-tangle-hook
  11714. This hook is run from within code files tangled by @code{org-babel-tangle}.
  11715. Example applications could include post-processing, compilation or evaluation
  11716. of tangled code files.
  11717. @end table
  11718. @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
  11719. @section Evaluating code blocks
  11720. @cindex code block, evaluating
  11721. @cindex source code, evaluating
  11722. @cindex #+RESULTS
  11723. Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
  11724. potential for that code to do harm. Org mode provides safeguards to ensure
  11725. that code is only evaluated after explicit confirmation from the user. For
  11726. information on these safeguards (and on how to disable them) see @ref{Code
  11727. evaluation security}.} and the results of evaluation optionally placed in the
  11728. Org mode buffer. The results of evaluation are placed following a line that
  11729. begins by default with @code{#+RESULTS} and optionally a cache identifier
  11730. and/or the name of the evaluated code block. The default value of
  11731. @code{#+RESULTS} can be changed with the customizable variable
  11732. @var{org-babel-results-keyword}.
  11733. By default, the evaluation facility is only enabled for Lisp code blocks
  11734. specified as @code{emacs-lisp}. However, source code blocks in many languages
  11735. can be evaluated within Org mode (see @ref{Languages} for a list of supported
  11736. languages and @ref{Structure of code blocks} for information on the syntax
  11737. used to define a code block).
  11738. @kindex C-c C-c
  11739. There are a number of ways to evaluate code blocks. The simplest is to press
  11740. @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
  11741. option @var{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
  11742. evaluation from the @kbd{C-c C-c} key binding.}. This will call the
  11743. @code{org-babel-execute-src-block} function to evaluate the block and insert
  11744. its results into the Org mode buffer.
  11745. @cindex #+CALL
  11746. It is also possible to evaluate named code blocks from anywhere in an Org
  11747. mode buffer or an Org mode table. Live code blocks located in the current
  11748. Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
  11749. can be executed. Named code blocks can be executed with a separate
  11750. @code{#+CALL:} line or inline within a block of text.
  11751. The syntax of the @code{#+CALL:} line is
  11752. @example
  11753. #+CALL: <name>(<arguments>)
  11754. #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
  11755. @end example
  11756. The syntax for inline evaluation of named code blocks is
  11757. @example
  11758. ... call_<name>(<arguments>) ...
  11759. ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
  11760. @end example
  11761. @table @code
  11762. @item <name>
  11763. The name of the code block to be evaluated (see @ref{Structure of code blocks}).
  11764. @item <arguments>
  11765. Arguments specified in this section will be passed to the code block. These
  11766. arguments use standard function call syntax, rather than
  11767. header argument syntax. For example, a @code{#+CALL:} line that passes the
  11768. number four to a code block named @code{double}, which declares the header
  11769. argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
  11770. @item <inside header arguments>
  11771. Inside header arguments are passed through and applied to the named code
  11772. block. These arguments use header argument syntax rather than standard
  11773. function call syntax. Inside header arguments affect how the code block is
  11774. evaluated. For example, @code{[:results output]} will collect the results of
  11775. everything printed to @code{STDOUT} during execution of the code block.
  11776. @item <end header arguments>
  11777. End header arguments are applied to the calling instance and do not affect
  11778. evaluation of the named code block. They affect how the results are
  11779. incorporated into the Org mode buffer and how the call line is exported. For
  11780. example, @code{:results html} will insert the results of the call line
  11781. evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
  11782. For more examples of passing header arguments to @code{#+CALL:} lines see
  11783. @ref{Header arguments in function calls}.
  11784. @end table
  11785. @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
  11786. @section Library of Babel
  11787. @cindex babel, library of
  11788. @cindex source code, library
  11789. @cindex code block, library
  11790. The ``Library of Babel'' consists of code blocks that can be called from any
  11791. Org mode file. Code blocks defined in the ``Library of Babel'' can be called
  11792. remotely as if they were in the current Org mode buffer (see @ref{Evaluating
  11793. code blocks} for information on the syntax of remote code block evaluation).
  11794. The central repository of code blocks in the ``Library of Babel'' is housed
  11795. in an Org mode file located in the @samp{contrib} directory of Org mode.
  11796. Users can add code blocks they believe to be generally useful to their
  11797. ``Library of Babel.'' The code blocks can be stored in any Org mode file and
  11798. then loaded into the library with @code{org-babel-lob-ingest}.
  11799. @kindex C-c C-v i
  11800. Code blocks located in any Org mode file can be loaded into the ``Library of
  11801. Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
  11802. i}.
  11803. @node Languages, Header arguments, Library of Babel, Working With Source Code
  11804. @section Languages
  11805. @cindex babel, languages
  11806. @cindex source code, languages
  11807. @cindex code block, languages
  11808. Code blocks in the following languages are supported.
  11809. @multitable @columnfractions 0.28 0.3 0.22 0.2
  11810. @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
  11811. @item Asymptote @tab asymptote @tab Awk @tab awk
  11812. @item Emacs Calc @tab calc @tab C @tab C
  11813. @item C++ @tab C++ @tab Clojure @tab clojure
  11814. @item CSS @tab css @tab ditaa @tab ditaa
  11815. @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
  11816. @item gnuplot @tab gnuplot @tab Haskell @tab haskell
  11817. @item Java @tab java @tab @tab
  11818. @item Javascript @tab js @tab LaTeX @tab latex
  11819. @item Ledger @tab ledger @tab Lisp @tab lisp
  11820. @item Lilypond @tab lilypond @tab MATLAB @tab matlab
  11821. @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
  11822. @item Octave @tab octave @tab Org mode @tab org
  11823. @item Oz @tab oz @tab Perl @tab perl
  11824. @item Plantuml @tab plantuml @tab Python @tab python
  11825. @item R @tab R @tab Ruby @tab ruby
  11826. @item Sass @tab sass @tab Scheme @tab scheme
  11827. @item GNU Screen @tab screen @tab shell @tab sh
  11828. @item SQL @tab sql @tab SQLite @tab sqlite
  11829. @end multitable
  11830. Language-specific documentation is available for some languages. If
  11831. available, it can be found at
  11832. @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
  11833. The option @code{org-babel-load-languages} controls which languages are
  11834. enabled for evaluation (by default only @code{emacs-lisp} is enabled). This
  11835. variable can be set using the customization interface or by adding code like
  11836. the following to your emacs configuration.
  11837. @quotation
  11838. The following disables @code{emacs-lisp} evaluation and enables evaluation of
  11839. @code{R} code blocks.
  11840. @end quotation
  11841. @lisp
  11842. (org-babel-do-load-languages
  11843. 'org-babel-load-languages
  11844. '((emacs-lisp . nil)
  11845. (R . t)))
  11846. @end lisp
  11847. It is also possible to enable support for a language by loading the related
  11848. elisp file with @code{require}.
  11849. @quotation
  11850. The following adds support for evaluating @code{clojure} code blocks.
  11851. @end quotation
  11852. @lisp
  11853. (require 'ob-clojure)
  11854. @end lisp
  11855. @node Header arguments, Results of evaluation, Languages, Working With Source Code
  11856. @section Header arguments
  11857. @cindex code block, header arguments
  11858. @cindex source code, block header arguments
  11859. Code block functionality can be configured with header arguments. This
  11860. section provides an overview of the use of header arguments, and then
  11861. describes each header argument in detail.
  11862. @menu
  11863. * Using header arguments:: Different ways to set header arguments
  11864. * Specific header arguments:: List of header arguments
  11865. @end menu
  11866. @node Using header arguments, Specific header arguments, Header arguments, Header arguments
  11867. @subsection Using header arguments
  11868. The values of header arguments can be set in six different ways, each more
  11869. specific (and having higher priority) than the last.
  11870. @menu
  11871. * System-wide header arguments:: Set global default values
  11872. * Language-specific header arguments:: Set default values by language
  11873. * Buffer-wide header arguments:: Set default values for a specific buffer
  11874. * Header arguments in Org mode properties:: Set default values for a buffer or heading
  11875. * Code block specific header arguments:: The most common way to set values
  11876. * Header arguments in function calls:: The most specific level
  11877. @end menu
  11878. @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
  11879. @subsubheading System-wide header arguments
  11880. @vindex org-babel-default-header-args
  11881. System-wide values of header arguments can be specified by adapting the
  11882. @var{org-babel-default-header-args} variable:
  11883. @example
  11884. :session => "none"
  11885. :results => "replace"
  11886. :exports => "code"
  11887. :cache => "no"
  11888. :noweb => "no"
  11889. @end example
  11890. For example, the following example could be used to set the default value of
  11891. @code{:noweb} header arguments to @code{yes}. This would have the effect of
  11892. expanding @code{:noweb} references by default when evaluating source code
  11893. blocks.
  11894. @lisp
  11895. (setq org-babel-default-header-args
  11896. (cons '(:noweb . "yes")
  11897. (assq-delete-all :noweb org-babel-default-header-args)))
  11898. @end lisp
  11899. @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
  11900. @subsubheading Language-specific header arguments
  11901. Each language can define its own set of default header arguments. See the
  11902. language-specific documentation available online at
  11903. @uref{http://orgmode.org/worg/org-contrib/babel}.
  11904. @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
  11905. @subsubheading Buffer-wide header arguments
  11906. Buffer-wide header arguments may be specified as properties through the use
  11907. of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
  11908. @ref{Property syntax}).
  11909. For example the following would set @code{session} to @code{*R*}, and
  11910. @code{results} to @code{silent} for every code block in the buffer, ensuring
  11911. that all execution took place in the same session, and no results would be
  11912. inserted into the buffer.
  11913. @example
  11914. #+PROPERTY: session *R*
  11915. #+PROPERTY: results silent
  11916. @end example
  11917. @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
  11918. @subsubheading Header arguments in Org mode properties
  11919. Header arguments are also read from Org mode properties (see @ref{Property
  11920. syntax}), which can be set on a buffer-wide or per-heading basis. An example
  11921. of setting a header argument for all code blocks in a buffer is
  11922. @example
  11923. #+PROPERTY: tangle yes
  11924. @end example
  11925. @vindex org-use-property-inheritance
  11926. When properties are used to set default header arguments, they are looked up
  11927. with inheritance, regardless of the value of
  11928. @var{org-use-property-inheritance}. In the following example the value of
  11929. the @code{:cache} header argument will default to @code{yes} in all code
  11930. blocks in the subtree rooted at the following heading:
  11931. @example
  11932. * outline header
  11933. :PROPERTIES:
  11934. :cache: yes
  11935. :END:
  11936. @end example
  11937. @kindex C-c C-x p
  11938. @vindex org-babel-default-header-args
  11939. Properties defined in this way override the properties set in
  11940. @var{org-babel-default-header-args}. It is convenient to use the
  11941. @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
  11942. in Org mode documents.
  11943. @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
  11944. @subsubheading Code block specific header arguments
  11945. The most common way to assign values to header arguments is at the
  11946. code block level. This can be done by listing a sequence of header
  11947. arguments and their values as part of the @code{#+BEGIN_SRC} line.
  11948. Properties set in this way override both the values of
  11949. @var{org-babel-default-header-args} and header arguments specified as
  11950. properties. In the following example, the @code{:results} header argument
  11951. is set to @code{silent}, meaning the results of execution will not be
  11952. inserted in the buffer, and the @code{:exports} header argument is set to
  11953. @code{code}, meaning only the body of the code block will be
  11954. preserved on export to HTML or @LaTeX{}.
  11955. @example
  11956. #+NAME: factorial
  11957. #+BEGIN_SRC haskell :results silent :exports code :var n=0
  11958. fac 0 = 1
  11959. fac n = n * fac (n-1)
  11960. #+END_SRC
  11961. @end example
  11962. Similarly, it is possible to set header arguments for inline code blocks
  11963. @example
  11964. src_haskell[:exports both]@{fac 5@}
  11965. @end example
  11966. Code block header arguments can span multiple lines using @code{#+HEADER:} or
  11967. @code{#+HEADERS:} lines preceding a code block or nested between the
  11968. @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
  11969. @cindex #+HEADER:
  11970. @cindex #+HEADERS:
  11971. Multi-line header arguments on an un-named code block:
  11972. @example
  11973. #+HEADERS: :var data1=1
  11974. #+BEGIN_SRC emacs-lisp :var data2=2
  11975. (message "data1:%S, data2:%S" data1 data2)
  11976. #+END_SRC
  11977. #+RESULTS:
  11978. : data1:1, data2:2
  11979. @end example
  11980. Multi-line header arguments on a named code block:
  11981. @example
  11982. #+NAME: named-block
  11983. #+HEADER: :var data=2
  11984. #+BEGIN_SRC emacs-lisp
  11985. (message "data:%S" data)
  11986. #+END_SRC
  11987. #+RESULTS: named-block
  11988. : data:2
  11989. @end example
  11990. @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
  11991. @comment node-name, next, previous, up
  11992. @subsubheading Header arguments in function calls
  11993. At the most specific level, header arguments for ``Library of Babel'' or
  11994. @code{#+CALL:} lines can be set as shown in the two examples below. For more
  11995. information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
  11996. blocks}.
  11997. The following will apply the @code{:exports results} header argument to the
  11998. evaluation of the @code{#+CALL:} line.
  11999. @example
  12000. #+CALL: factorial(n=5) :exports results
  12001. @end example
  12002. The following will apply the @code{:session special} header argument to the
  12003. evaluation of the @code{factorial} code block.
  12004. @example
  12005. #+CALL: factorial[:session special](n=5)
  12006. @end example
  12007. @node Specific header arguments, , Using header arguments, Header arguments
  12008. @subsection Specific header arguments
  12009. Header arguments consist of an initial colon followed by the name of the
  12010. argument in lowercase letters. The following header arguments are defined:
  12011. @menu
  12012. * var:: Pass arguments to code blocks
  12013. * results:: Specify the type of results and how they will
  12014. be collected and handled
  12015. * file:: Specify a path for file output
  12016. * file-desc:: Specify a description for file results
  12017. * dir:: Specify the default (possibly remote)
  12018. directory for code block execution
  12019. * exports:: Export code and/or results
  12020. * tangle:: Toggle tangling and specify file name
  12021. * mkdirp:: Toggle creation of parent directories of target
  12022. files during tangling
  12023. * comments:: Toggle insertion of comments in tangled
  12024. code files
  12025. * padline:: Control insertion of padding lines in tangled
  12026. code files
  12027. * no-expand:: Turn off variable assignment and noweb
  12028. expansion during tangling
  12029. * session:: Preserve the state of code evaluation
  12030. * noweb:: Toggle expansion of noweb references
  12031. * noweb-ref:: Specify block's noweb reference resolution target
  12032. * noweb-sep:: String used to separate noweb references
  12033. * cache:: Avoid re-evaluating unchanged code blocks
  12034. * sep:: Delimiter for writing tabular results outside Org
  12035. * hlines:: Handle horizontal lines in tables
  12036. * colnames:: Handle column names in tables
  12037. * rownames:: Handle row names in tables
  12038. * shebang:: Make tangled files executable
  12039. * eval:: Limit evaluation of specific code blocks
  12040. * wrap:: Mark source block evaluation results
  12041. * post:: Post processing of code block results
  12042. @end menu
  12043. Additional header arguments are defined on a language-specific basis, see
  12044. @ref{Languages}.
  12045. @node var, results, Specific header arguments, Specific header arguments
  12046. @subsubsection @code{:var}
  12047. The @code{:var} header argument is used to pass arguments to code blocks.
  12048. The specifics of how arguments are included in a code block vary by language;
  12049. these are addressed in the language-specific documentation. However, the
  12050. syntax used to specify arguments is the same across all languages. In every
  12051. case, variables require a default value when they are declared.
  12052. The values passed to arguments can either be literal values, references, or
  12053. Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
  12054. References include anything in the Org mode file that takes a @code{#+NAME:}
  12055. or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
  12056. other code blocks and the results of other code blocks.
  12057. Note: When a reference is made to another code block, the referenced block
  12058. will be evaluated unless it has current cached results (see @ref{cache}).
  12059. Argument values can be indexed in a manner similar to arrays (see @ref{var,
  12060. Indexable variable values}).
  12061. The following syntax is used to pass arguments to code blocks using the
  12062. @code{:var} header argument.
  12063. @example
  12064. :var name=assign
  12065. @end example
  12066. The argument, @code{assign}, can either be a literal value, such as a string
  12067. @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
  12068. literal example, another code block (with or without arguments), or the
  12069. results of evaluating another code block.
  12070. Here are examples of passing values by reference:
  12071. @table @dfn
  12072. @item table
  12073. an Org mode table named with either a @code{#+NAME:} line
  12074. @example
  12075. #+NAME: example-table
  12076. | 1 |
  12077. | 2 |
  12078. | 3 |
  12079. | 4 |
  12080. #+NAME: table-length
  12081. #+BEGIN_SRC emacs-lisp :var table=example-table
  12082. (length table)
  12083. #+END_SRC
  12084. #+RESULTS: table-length
  12085. : 4
  12086. @end example
  12087. @item list
  12088. a simple list named with a @code{#+NAME:} line (note that nesting is not
  12089. carried through to the source code block)
  12090. @example
  12091. #+NAME: example-list
  12092. - simple
  12093. - not
  12094. - nested
  12095. - list
  12096. #+BEGIN_SRC emacs-lisp :var x=example-list
  12097. (print x)
  12098. #+END_SRC
  12099. #+RESULTS:
  12100. | simple | list |
  12101. @end example
  12102. @item code block without arguments
  12103. a code block name (from the example above), as assigned by @code{#+NAME:},
  12104. optionally followed by parentheses
  12105. @example
  12106. #+BEGIN_SRC emacs-lisp :var length=table-length()
  12107. (* 2 length)
  12108. #+END_SRC
  12109. #+RESULTS:
  12110. : 8
  12111. @end example
  12112. @item code block with arguments
  12113. a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
  12114. optional arguments passed within the parentheses following the
  12115. code block name using standard function call syntax
  12116. @example
  12117. #+NAME: double
  12118. #+BEGIN_SRC emacs-lisp :var input=8
  12119. (* 2 input)
  12120. #+END_SRC
  12121. #+RESULTS: double
  12122. : 16
  12123. #+NAME: squared
  12124. #+BEGIN_SRC emacs-lisp :var input=double(input=1)
  12125. (* input input)
  12126. #+END_SRC
  12127. #+RESULTS: squared
  12128. : 4
  12129. @end example
  12130. @item literal example
  12131. a literal example block named with a @code{#+NAME:} line
  12132. @example
  12133. #+NAME: literal-example
  12134. #+BEGIN_EXAMPLE
  12135. A literal example
  12136. on two lines
  12137. #+END_EXAMPLE
  12138. #+NAME: read-literal-example
  12139. #+BEGIN_SRC emacs-lisp :var x=literal-example
  12140. (concatenate 'string x " for you.")
  12141. #+END_SRC
  12142. #+RESULTS: read-literal-example
  12143. : A literal example
  12144. : on two lines for you.
  12145. @end example
  12146. @end table
  12147. @subsubheading Indexable variable values
  12148. It is possible to reference portions of variable values by ``indexing'' into
  12149. the variables. Indexes are 0 based with negative values counting back from
  12150. the end. If an index is separated by @code{,}s then each subsequent section
  12151. will index into the next deepest nesting or dimension of the value. Note
  12152. that this indexing occurs @emph{before} other table related header arguments
  12153. like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
  12154. following example assigns the last cell of the first row the table
  12155. @code{example-table} to the variable @code{data}:
  12156. @example
  12157. #+NAME: example-table
  12158. | 1 | a |
  12159. | 2 | b |
  12160. | 3 | c |
  12161. | 4 | d |
  12162. #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
  12163. data
  12164. #+END_SRC
  12165. #+RESULTS:
  12166. : a
  12167. @end example
  12168. Ranges of variable values can be referenced using two integers separated by a
  12169. @code{:}, in which case the entire inclusive range is referenced. For
  12170. example the following assigns the middle three rows of @code{example-table}
  12171. to @code{data}.
  12172. @example
  12173. #+NAME: example-table
  12174. | 1 | a |
  12175. | 2 | b |
  12176. | 3 | c |
  12177. | 4 | d |
  12178. | 5 | 3 |
  12179. #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
  12180. data
  12181. #+END_SRC
  12182. #+RESULTS:
  12183. | 2 | b |
  12184. | 3 | c |
  12185. | 4 | d |
  12186. @end example
  12187. Additionally, an empty index, or the single character @code{*}, are both
  12188. interpreted to mean the entire range and as such are equivalent to
  12189. @code{0:-1}, as shown in the following example in which the entire first
  12190. column is referenced.
  12191. @example
  12192. #+NAME: example-table
  12193. | 1 | a |
  12194. | 2 | b |
  12195. | 3 | c |
  12196. | 4 | d |
  12197. #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
  12198. data
  12199. #+END_SRC
  12200. #+RESULTS:
  12201. | 1 | 2 | 3 | 4 |
  12202. @end example
  12203. It is possible to index into the results of code blocks as well as tables.
  12204. Any number of dimensions can be indexed. Dimensions are separated from one
  12205. another by commas, as shown in the following example.
  12206. @example
  12207. #+NAME: 3D
  12208. #+BEGIN_SRC emacs-lisp
  12209. '(((1 2 3) (4 5 6) (7 8 9))
  12210. ((10 11 12) (13 14 15) (16 17 18))
  12211. ((19 20 21) (22 23 24) (25 26 27)))
  12212. #+END_SRC
  12213. #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
  12214. data
  12215. #+END_SRC
  12216. #+RESULTS:
  12217. | 11 | 14 | 17 |
  12218. @end example
  12219. @subsubheading Emacs Lisp evaluation of variables
  12220. Emacs lisp code can be used to initialize variable values. When a variable
  12221. value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
  12222. evaluated as Emacs Lisp and the result of the evaluation will be assigned as
  12223. the variable value. The following example demonstrates use of this
  12224. evaluation to reliably pass the file-name of the Org mode buffer to a code
  12225. block---note that evaluation of header arguments is guaranteed to take place
  12226. in the original Org mode file, while there is no such guarantee for
  12227. evaluation of the code block body.
  12228. @example
  12229. #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
  12230. wc -w $filename
  12231. #+END_SRC
  12232. @end example
  12233. Note that values read from tables and lists will not be evaluated as
  12234. Emacs Lisp, as shown in the following example.
  12235. @example
  12236. #+NAME: table
  12237. | (a b c) |
  12238. #+HEADERS: :var data=table[0,0]
  12239. #+BEGIN_SRC perl
  12240. $data
  12241. #+END_SRC
  12242. #+RESULTS:
  12243. : (a b c)
  12244. @end example
  12245. @node results, file, var, Specific header arguments
  12246. @subsubsection @code{:results}
  12247. There are four classes of @code{:results} header argument. Only one option
  12248. per class may be supplied per code block.
  12249. @itemize @bullet
  12250. @item
  12251. @b{collection} header arguments specify how the results should be collected
  12252. from the code block
  12253. @item
  12254. @b{type} header arguments specify what type of result the code block will
  12255. return---which has implications for how they will be processed before
  12256. insertion into the Org mode buffer
  12257. @item
  12258. @b{format} header arguments specify what type of result the code block will
  12259. return---which has implications for how they will be inserted into the
  12260. Org mode buffer
  12261. @item
  12262. @b{handling} header arguments specify how the results of evaluating the code
  12263. block should be handled.
  12264. @end itemize
  12265. @subsubheading Collection
  12266. The following options are mutually exclusive, and specify how the results
  12267. should be collected from the code block.
  12268. @itemize @bullet
  12269. @item @code{value}
  12270. This is the default. The result is the value of the last statement in the
  12271. code block. This header argument places the evaluation in functional
  12272. mode. Note that in some languages, e.g., Python, use of this result type
  12273. requires that a @code{return} statement be included in the body of the source
  12274. code block. E.g., @code{:results value}.
  12275. @item @code{output}
  12276. The result is the collection of everything printed to STDOUT during the
  12277. execution of the code block. This header argument places the
  12278. evaluation in scripting mode. E.g., @code{:results output}.
  12279. @end itemize
  12280. @subsubheading Type
  12281. The following options are mutually exclusive and specify what type of results
  12282. the code block will return. By default, results are inserted as either a
  12283. table or scalar depending on their value.
  12284. @itemize @bullet
  12285. @item @code{table}, @code{vector}
  12286. The results should be interpreted as an Org mode table. If a single value is
  12287. returned, it will be converted into a table with one row and one column.
  12288. E.g., @code{:results value table}.
  12289. @item @code{list}
  12290. The results should be interpreted as an Org mode list. If a single scalar
  12291. value is returned it will be converted into a list with only one element.
  12292. @item @code{scalar}, @code{verbatim}
  12293. The results should be interpreted literally---they will not be
  12294. converted into a table. The results will be inserted into the Org mode
  12295. buffer as quoted text. E.g., @code{:results value verbatim}.
  12296. @item @code{file}
  12297. The results will be interpreted as the path to a file, and will be inserted
  12298. into the Org mode buffer as a file link. E.g., @code{:results value file}.
  12299. @end itemize
  12300. @subsubheading Format
  12301. The following options are mutually exclusive and specify what type of results
  12302. the code block will return. By default, results are inserted according to the
  12303. type as specified above.
  12304. @itemize @bullet
  12305. @item @code{raw}
  12306. The results are interpreted as raw Org mode code and are inserted directly
  12307. into the buffer. If the results look like a table they will be aligned as
  12308. such by Org mode. E.g., @code{:results value raw}.
  12309. @item @code{org}
  12310. The results are will be enclosed in a @code{BEGIN_SRC org} block.
  12311. They are not comma-escaped by default but they will be if you hit @kbd{TAB}
  12312. in the block and/or if you export the file. E.g., @code{:results value org}.
  12313. @item @code{html}
  12314. Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
  12315. block. E.g., @code{:results value html}.
  12316. @item @code{latex}
  12317. Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
  12318. E.g., @code{:results value latex}.
  12319. @item @code{code}
  12320. Result are assumed to be parsable code and are enclosed in a code block.
  12321. E.g., @code{:results value code}.
  12322. @item @code{pp}
  12323. The result is converted to pretty-printed code and is enclosed in a code
  12324. block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
  12325. @code{:results value pp}.
  12326. @item @code{drawer}
  12327. The result is wrapped in a RESULTS drawer. This can be useful for
  12328. inserting @code{raw} or @code{org} syntax results in such a way that their
  12329. extent is known and they can be automatically removed or replaced.
  12330. @end itemize
  12331. @subsubheading Handling
  12332. The following results options indicate what happens with the
  12333. results once they are collected.
  12334. @itemize @bullet
  12335. @item @code{silent}
  12336. The results will be echoed in the minibuffer but will not be inserted into
  12337. the Org mode buffer. E.g., @code{:results output silent}.
  12338. @item @code{replace}
  12339. The default value. Any existing results will be removed, and the new results
  12340. will be inserted into the Org mode buffer in their place. E.g.,
  12341. @code{:results output replace}.
  12342. @item @code{append}
  12343. If there are pre-existing results of the code block then the new results will
  12344. be appended to the existing results. Otherwise the new results will be
  12345. inserted as with @code{replace}.
  12346. @item @code{prepend}
  12347. If there are pre-existing results of the code block then the new results will
  12348. be prepended to the existing results. Otherwise the new results will be
  12349. inserted as with @code{replace}.
  12350. @end itemize
  12351. @node file, file-desc, results, Specific header arguments
  12352. @subsubsection @code{:file}
  12353. The header argument @code{:file} is used to specify an external file in which
  12354. to save code block results. After code block evaluation an Org mode style
  12355. @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
  12356. into the Org mode buffer. Some languages including R, gnuplot, dot, and
  12357. ditaa provide special handling of the @code{:file} header argument
  12358. automatically wrapping the code block body in the boilerplate code required
  12359. to save output to the specified file. This is often useful for saving
  12360. graphical output of a code block to the specified file.
  12361. The argument to @code{:file} should be either a string specifying the path to
  12362. a file, or a list of two strings in which case the first element of the list
  12363. should be the path to a file and the second a description for the link.
  12364. @node file-desc, dir, file, Specific header arguments
  12365. @subsubsection @code{:file-desc}
  12366. The value of the @code{:file-desc} header argument is used to provide a
  12367. description for file code block results which are inserted as Org mode links
  12368. (see @ref{Link format}). If the @code{:file-desc} header argument is given
  12369. with no value the link path will be placed in both the ``link'' and the
  12370. ``description'' portion of the Org mode link.
  12371. @node dir, exports, file-desc, Specific header arguments
  12372. @subsubsection @code{:dir} and remote execution
  12373. While the @code{:file} header argument can be used to specify the path to the
  12374. output file, @code{:dir} specifies the default directory during code block
  12375. execution. If it is absent, then the directory associated with the current
  12376. buffer is used. In other words, supplying @code{:dir path} temporarily has
  12377. the same effect as changing the current directory with @kbd{M-x cd path RET}, and
  12378. then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
  12379. the value of the Emacs variable @var{default-directory}.
  12380. When using @code{:dir}, you should supply a relative path for file output
  12381. (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
  12382. case that path will be interpreted relative to the default directory.
  12383. In other words, if you want your plot to go into a folder called @file{Work}
  12384. in your home directory, you could use
  12385. @example
  12386. #+BEGIN_SRC R :file myplot.png :dir ~/Work
  12387. matplot(matrix(rnorm(100), 10), type="l")
  12388. #+END_SRC
  12389. @end example
  12390. @subsubheading Remote execution
  12391. A directory on a remote machine can be specified using tramp file syntax, in
  12392. which case the code will be evaluated on the remote machine. An example is
  12393. @example
  12394. #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
  12395. plot(1:10, main=system("hostname", intern=TRUE))
  12396. #+END_SRC
  12397. @end example
  12398. Text results will be returned to the local Org mode buffer as usual, and file
  12399. output will be created on the remote machine with relative paths interpreted
  12400. relative to the remote directory. An Org mode link to the remote file will be
  12401. created.
  12402. So, in the above example a plot will be created on the remote machine,
  12403. and a link of the following form will be inserted in the org buffer:
  12404. @example
  12405. [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
  12406. @end example
  12407. Most of this functionality follows immediately from the fact that @code{:dir}
  12408. sets the value of the Emacs variable @var{default-directory}, thanks to
  12409. tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
  12410. install tramp separately in order for these features to work correctly.
  12411. @subsubheading Further points
  12412. @itemize @bullet
  12413. @item
  12414. If @code{:dir} is used in conjunction with @code{:session}, although it will
  12415. determine the starting directory for a new session as expected, no attempt is
  12416. currently made to alter the directory associated with an existing session.
  12417. @item
  12418. @code{:dir} should typically not be used to create files during export with
  12419. @code{:exports results} or @code{:exports both}. The reason is that, in order
  12420. to retain portability of exported material between machines, during export
  12421. links inserted into the buffer will @emph{not} be expanded against @var{default
  12422. directory}. Therefore, if @var{default-directory} is altered using
  12423. @code{:dir}, it is probable that the file will be created in a location to
  12424. which the link does not point.
  12425. @end itemize
  12426. @node exports, tangle, dir, Specific header arguments
  12427. @subsubsection @code{:exports}
  12428. The @code{:exports} header argument specifies what should be included in HTML
  12429. or @LaTeX{} exports of the Org mode file.
  12430. @itemize @bullet
  12431. @item @code{code}
  12432. The default. The body of code is included into the exported file. E.g.,
  12433. @code{:exports code}.
  12434. @item @code{results}
  12435. The result of evaluating the code is included in the exported file. E.g.,
  12436. @code{:exports results}.
  12437. @item @code{both}
  12438. Both the code and results are included in the exported file. E.g.,
  12439. @code{:exports both}.
  12440. @item @code{none}
  12441. Nothing is included in the exported file. E.g., @code{:exports none}.
  12442. @end itemize
  12443. @node tangle, mkdirp, exports, Specific header arguments
  12444. @subsubsection @code{:tangle}
  12445. The @code{:tangle} header argument specifies whether or not the code
  12446. block should be included in tangled extraction of source code files.
  12447. @itemize @bullet
  12448. @item @code{tangle}
  12449. The code block is exported to a source code file named after the full path
  12450. (including the directory) and file name (w/o extension) of the Org mode file.
  12451. E.g., @code{:tangle yes}.
  12452. @item @code{no}
  12453. The default. The code block is not exported to a source code file.
  12454. E.g., @code{:tangle no}.
  12455. @item other
  12456. Any other string passed to the @code{:tangle} header argument is interpreted
  12457. as a path (directory and file name relative to the directory of the Org mode
  12458. file) to which the block will be exported. E.g., @code{:tangle path}.
  12459. @end itemize
  12460. @node mkdirp, comments, tangle, Specific header arguments
  12461. @subsubsection @code{:mkdirp}
  12462. The @code{:mkdirp} header argument can be used to create parent directories
  12463. of tangled files when missing. This can be set to @code{yes} to enable
  12464. directory creation or to @code{no} to inhibit directory creation.
  12465. @node comments, padline, mkdirp, Specific header arguments
  12466. @subsubsection @code{:comments}
  12467. By default code blocks are tangled to source-code files without any insertion
  12468. of comments beyond those which may already exist in the body of the code
  12469. block. The @code{:comments} header argument can be set as follows to control
  12470. the insertion of extra comments into the tangled code file.
  12471. @itemize @bullet
  12472. @item @code{no}
  12473. The default. No extra comments are inserted during tangling.
  12474. @item @code{link}
  12475. The code block is wrapped in comments which contain pointers back to the
  12476. original Org file from which the code was tangled.
  12477. @item @code{yes}
  12478. A synonym for ``link'' to maintain backwards compatibility.
  12479. @item @code{org}
  12480. Include text from the Org mode file as a comment.
  12481. The text is picked from the leading context of the tangled code and is
  12482. limited by the nearest headline or source block as the case may be.
  12483. @item @code{both}
  12484. Turns on both the ``link'' and ``org'' comment options.
  12485. @item @code{noweb}
  12486. Turns on the ``link'' comment option, and additionally wraps expanded noweb
  12487. references in the code block body in link comments.
  12488. @end itemize
  12489. @node padline, no-expand, comments, Specific header arguments
  12490. @subsubsection @code{:padline}
  12491. Control in insertion of padding lines around code block bodies in tangled
  12492. code files. The default value is @code{yes} which results in insertion of
  12493. newlines before and after each tangled code block. The following arguments
  12494. are accepted.
  12495. @itemize @bullet
  12496. @item @code{yes}
  12497. Insert newlines before and after each code block body in tangled code files.
  12498. @item @code{no}
  12499. Do not insert any newline padding in tangled output.
  12500. @end itemize
  12501. @node no-expand, session, padline, Specific header arguments
  12502. @subsubsection @code{:no-expand}
  12503. By default, code blocks are expanded with @code{org-babel-expand-src-block}
  12504. during tangling. This has the effect of assigning values to variables
  12505. specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
  12506. references (see @ref{Noweb reference syntax}) with their targets. The
  12507. @code{:no-expand} header argument can be used to turn off this behavior.
  12508. @node session, noweb, no-expand, Specific header arguments
  12509. @subsubsection @code{:session}
  12510. The @code{:session} header argument starts a session for an interpreted
  12511. language where state is preserved.
  12512. By default, a session is not started.
  12513. A string passed to the @code{:session} header argument will give the session
  12514. a name. This makes it possible to run concurrent sessions for each
  12515. interpreted language.
  12516. @node noweb, noweb-ref, session, Specific header arguments
  12517. @subsubsection @code{:noweb}
  12518. The @code{:noweb} header argument controls expansion of ``noweb'' syntax
  12519. references (see @ref{Noweb reference syntax}) when the code block is
  12520. evaluated, tangled, or exported. The @code{:noweb} header argument can have
  12521. one of the five values: @code{no}, @code{yes}, @code{tangle}, or
  12522. @code{no-export} @code{strip-export}.
  12523. @itemize @bullet
  12524. @item @code{no}
  12525. The default. ``Noweb'' syntax references in the body of the code block will
  12526. not be expanded before the code block is evaluated, tangled or exported.
  12527. @item @code{yes}
  12528. ``Noweb'' syntax references in the body of the code block will be
  12529. expanded before the code block is evaluated, tangled or exported.
  12530. @item @code{tangle}
  12531. ``Noweb'' syntax references in the body of the code block will be expanded
  12532. before the code block is tangled. However, ``noweb'' syntax references will
  12533. not be expanded when the code block is evaluated or exported.
  12534. @item @code{no-export}
  12535. ``Noweb'' syntax references in the body of the code block will be expanded
  12536. before the block is evaluated or tangled. However, ``noweb'' syntax
  12537. references will not be expanded when the code block is exported.
  12538. @item @code{strip-export}
  12539. ``Noweb'' syntax references in the body of the code block will be expanded
  12540. before the block is evaluated or tangled. However, ``noweb'' syntax
  12541. references will not be removed when the code block is exported.
  12542. @item @code{eval}
  12543. ``Noweb'' syntax references in the body of the code block will only be
  12544. expanded before the block is evaluated.
  12545. @end itemize
  12546. @subsubheading Noweb prefix lines
  12547. Noweb insertions are now placed behind the line prefix of the
  12548. @code{<<reference>>}.
  12549. This behavior is illustrated in the following example. Because the
  12550. @code{<<example>>} noweb reference appears behind the SQL comment syntax,
  12551. each line of the expanded noweb reference will be commented.
  12552. This code block:
  12553. @example
  12554. -- <<example>>
  12555. @end example
  12556. expands to:
  12557. @example
  12558. -- this is the
  12559. -- multi-line body of example
  12560. @end example
  12561. Note that noweb replacement text that does not contain any newlines will not
  12562. be affected by this change, so it is still possible to use inline noweb
  12563. references.
  12564. @node noweb-ref, noweb-sep, noweb, Specific header arguments
  12565. @subsubsection @code{:noweb-ref}
  12566. When expanding ``noweb'' style references the bodies of all code block with
  12567. @emph{either} a block name matching the reference name @emph{or} a
  12568. @code{:noweb-ref} header argument matching the reference name will be
  12569. concatenated together to form the replacement text.
  12570. By setting this header argument at the sub-tree or file level, simple code
  12571. block concatenation may be achieved. For example, when tangling the
  12572. following Org mode file, the bodies of code blocks will be concatenated into
  12573. the resulting pure code file@footnote{(The example needs property inheritance
  12574. to be turned on for the @code{noweb-ref} property, see @ref{Property
  12575. inheritance}).}.
  12576. @example
  12577. #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
  12578. <<fullest-disk>>
  12579. #+END_SRC
  12580. * the mount point of the fullest disk
  12581. :PROPERTIES:
  12582. :noweb-ref: fullest-disk
  12583. :END:
  12584. ** query all mounted disks
  12585. #+BEGIN_SRC sh
  12586. df \
  12587. #+END_SRC
  12588. ** strip the header row
  12589. #+BEGIN_SRC sh
  12590. |sed '1d' \
  12591. #+END_SRC
  12592. ** sort by the percent full
  12593. #+BEGIN_SRC sh
  12594. |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
  12595. #+END_SRC
  12596. ** extract the mount point
  12597. #+BEGIN_SRC sh
  12598. |awk '@{print $2@}'
  12599. #+END_SRC
  12600. @end example
  12601. The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
  12602. used to separate accumulate noweb references like those above. By default a
  12603. newline is used.
  12604. @node noweb-sep, cache, noweb-ref, Specific header arguments
  12605. @subsubsection @code{:noweb-sep}
  12606. The @code{:noweb-sep} header argument holds the string used to separate
  12607. accumulate noweb references (see @ref{noweb-ref}). By default a newline is
  12608. used.
  12609. @node cache, sep, noweb-sep, Specific header arguments
  12610. @subsubsection @code{:cache}
  12611. The @code{:cache} header argument controls the use of in-buffer caching of
  12612. the results of evaluating code blocks. It can be used to avoid re-evaluating
  12613. unchanged code blocks. Note that the @code{:cache} header argument will not
  12614. attempt to cache results when the @code{:session} header argument is used,
  12615. because the results of the code block execution may be stored in the session
  12616. outside of the Org mode buffer. The @code{:cache} header argument can have
  12617. one of two values: @code{yes} or @code{no}.
  12618. @itemize @bullet
  12619. @item @code{no}
  12620. The default. No caching takes place, and the code block will be evaluated
  12621. every time it is called.
  12622. @item @code{yes}
  12623. Every time the code block is run a SHA1 hash of the code and arguments
  12624. passed to the block will be generated. This hash is packed into the
  12625. @code{#+RESULTS:} line and will be checked on subsequent
  12626. executions of the code block. If the code block has not
  12627. changed since the last time it was evaluated, it will not be re-evaluated.
  12628. @end itemize
  12629. Code block caches notice if the value of a variable argument
  12630. to the code block has changed. If this is the case, the cache is
  12631. invalidated and the code block is re-run. In the following example,
  12632. @code{caller} will not be re-run unless the results of @code{random} have
  12633. changed since it was last run.
  12634. @example
  12635. #+NAME: random
  12636. #+BEGIN_SRC R :cache yes
  12637. runif(1)
  12638. #+END_SRC
  12639. #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
  12640. 0.4659510825295
  12641. #+NAME: caller
  12642. #+BEGIN_SRC emacs-lisp :var x=random :cache yes
  12643. x
  12644. #+END_SRC
  12645. #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
  12646. 0.254227238707244
  12647. @end example
  12648. @node sep, hlines, cache, Specific header arguments
  12649. @subsubsection @code{:sep}
  12650. The @code{:sep} header argument can be used to control the delimiter used
  12651. when writing tabular results out to files external to Org mode. This is used
  12652. either when opening tabular results of a code block by calling the
  12653. @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
  12654. or when writing code block results to an external file (see @ref{file})
  12655. header argument.
  12656. By default, when @code{:sep} is not specified output tables are tab
  12657. delimited.
  12658. @node hlines, colnames, sep, Specific header arguments
  12659. @subsubsection @code{:hlines}
  12660. Tables are frequently represented with one or more horizontal lines, or
  12661. hlines. The @code{:hlines} argument to a code block accepts the
  12662. values @code{yes} or @code{no}, with a default value of @code{no}.
  12663. @itemize @bullet
  12664. @item @code{no}
  12665. Strips horizontal lines from the input table. In most languages this is the
  12666. desired effect because an @code{hline} symbol is interpreted as an unbound
  12667. variable and raises an error. Setting @code{:hlines no} or relying on the
  12668. default value yields the following results.
  12669. @example
  12670. #+NAME: many-cols
  12671. | a | b | c |
  12672. |---+---+---|
  12673. | d | e | f |
  12674. |---+---+---|
  12675. | g | h | i |
  12676. #+NAME: echo-table
  12677. #+BEGIN_SRC python :var tab=many-cols
  12678. return tab
  12679. #+END_SRC
  12680. #+RESULTS: echo-table
  12681. | a | b | c |
  12682. | d | e | f |
  12683. | g | h | i |
  12684. @end example
  12685. @item @code{yes}
  12686. Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
  12687. @example
  12688. #+NAME: many-cols
  12689. | a | b | c |
  12690. |---+---+---|
  12691. | d | e | f |
  12692. |---+---+---|
  12693. | g | h | i |
  12694. #+NAME: echo-table
  12695. #+BEGIN_SRC python :var tab=many-cols :hlines yes
  12696. return tab
  12697. #+END_SRC
  12698. #+RESULTS: echo-table
  12699. | a | b | c |
  12700. |---+---+---|
  12701. | d | e | f |
  12702. |---+---+---|
  12703. | g | h | i |
  12704. @end example
  12705. @end itemize
  12706. @node colnames, rownames, hlines, Specific header arguments
  12707. @subsubsection @code{:colnames}
  12708. The @code{:colnames} header argument accepts the values @code{yes},
  12709. @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
  12710. Note that the behavior of the @code{:colnames} header argument may differ
  12711. across languages.
  12712. @itemize @bullet
  12713. @item @code{nil}
  12714. If an input table looks like it has column names
  12715. (because its second row is an hline), then the column
  12716. names will be removed from the table before
  12717. processing, then reapplied to the results.
  12718. @example
  12719. #+NAME: less-cols
  12720. | a |
  12721. |---|
  12722. | b |
  12723. | c |
  12724. #+NAME: echo-table-again
  12725. #+BEGIN_SRC python :var tab=less-cols
  12726. return [[val + '*' for val in row] for row in tab]
  12727. #+END_SRC
  12728. #+RESULTS: echo-table-again
  12729. | a |
  12730. |----|
  12731. | b* |
  12732. | c* |
  12733. @end example
  12734. Please note that column names are not removed before the table is indexed
  12735. using variable indexing @xref{var, Indexable variable values}.
  12736. @item @code{no}
  12737. No column name pre-processing takes place
  12738. @item @code{yes}
  12739. Column names are removed and reapplied as with @code{nil} even if the table
  12740. does not ``look like'' it has column names (i.e., the second row is not an
  12741. hline)
  12742. @end itemize
  12743. @node rownames, shebang, colnames, Specific header arguments
  12744. @subsubsection @code{:rownames}
  12745. The @code{:rownames} header argument can take on the values @code{yes} or
  12746. @code{no}, with a default value of @code{no}. Note that Emacs Lisp code
  12747. blocks ignore the @code{:rownames} header argument entirely given the ease
  12748. with which tables with row names may be handled directly in Emacs Lisp.
  12749. @itemize @bullet
  12750. @item @code{no}
  12751. No row name pre-processing will take place.
  12752. @item @code{yes}
  12753. The first column of the table is removed from the table before processing,
  12754. and is then reapplied to the results.
  12755. @example
  12756. #+NAME: with-rownames
  12757. | one | 1 | 2 | 3 | 4 | 5 |
  12758. | two | 6 | 7 | 8 | 9 | 10 |
  12759. #+NAME: echo-table-once-again
  12760. #+BEGIN_SRC python :var tab=with-rownames :rownames yes
  12761. return [[val + 10 for val in row] for row in tab]
  12762. #+END_SRC
  12763. #+RESULTS: echo-table-once-again
  12764. | one | 11 | 12 | 13 | 14 | 15 |
  12765. | two | 16 | 17 | 18 | 19 | 20 |
  12766. @end example
  12767. Please note that row names are not removed before the table is indexed using
  12768. variable indexing @xref{var, Indexable variable values}.
  12769. @end itemize
  12770. @node shebang, eval, rownames, Specific header arguments
  12771. @subsubsection @code{:shebang}
  12772. Setting the @code{:shebang} header argument to a string value
  12773. (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
  12774. first line of any tangled file holding the code block, and the file
  12775. permissions of the tangled file are set to make it executable.
  12776. @node eval, wrap, shebang, Specific header arguments
  12777. @subsubsection @code{:eval}
  12778. The @code{:eval} header argument can be used to limit the evaluation of
  12779. specific code blocks. The @code{:eval} header argument can be useful for
  12780. protecting against the evaluation of dangerous code blocks or to ensure that
  12781. evaluation will require a query regardless of the value of the
  12782. @code{org-confirm-babel-evaluate} variable. The possible values of
  12783. @code{:eval} and their effects are shown below.
  12784. @table @code
  12785. @item never or no
  12786. The code block will not be evaluated under any circumstances.
  12787. @item query
  12788. Evaluation of the code block will require a query.
  12789. @item never-export or no-export
  12790. The code block will not be evaluated during export but may still be called
  12791. interactively.
  12792. @item query-export
  12793. Evaluation of the code block during export will require a query.
  12794. @end table
  12795. If this header argument is not set then evaluation is determined by the value
  12796. of the @var{org-confirm-babel-evaluate} variable see @ref{Code evaluation
  12797. security}.
  12798. @node wrap, post, eval, Specific header arguments
  12799. @subsubsection @code{:wrap}
  12800. The @code{:wrap} header argument is used to mark the results of source block
  12801. evaluation. The header argument can be passed a string that will be appended
  12802. to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
  12803. results. If not string is specified then the results will be wrapped in a
  12804. @code{#+BEGIN/END_RESULTS} block.
  12805. @node post, , wrap, Specific header arguments
  12806. @subsubsection @code{:post}
  12807. The @code{:post} header argument is used to post-process the results of a
  12808. code block execution. When a post argument is given, the results of the code
  12809. block will temporarily be bound to the @code{*this*} variable. This variable
  12810. may then be included in header argument forms such as those used in @ref{var}
  12811. header argument specifications allowing passing of results to other code
  12812. blocks, or direct execution via Emacs Lisp.
  12813. The following example illustrates the usage of the @code{:post} header
  12814. argument.
  12815. @example
  12816. #+name: attr_wrap
  12817. #+begin_src sh :var data="" :var width="\\textwidth" :results output
  12818. echo "#+ATTR_LATEX :width $width"
  12819. echo "$data"
  12820. #+end_src
  12821. #+header: :file /tmp/it.png
  12822. #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
  12823. digraph@{
  12824. a -> b;
  12825. b -> c;
  12826. c -> a;
  12827. @}
  12828. #+end_src
  12829. #+RESULTS:
  12830. :RESULTS:
  12831. #+ATTR_LATEX :width 5cm
  12832. [[file:/tmp/it.png]]
  12833. :END:
  12834. @end example
  12835. @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
  12836. @section Results of evaluation
  12837. @cindex code block, results of evaluation
  12838. @cindex source code, results of evaluation
  12839. The way in which results are handled depends on whether a session is invoked,
  12840. as well as on whether @code{:results value} or @code{:results output} is
  12841. used. The following table shows the table possibilities. For a full listing
  12842. of the possible results header arguments see @ref{results}.
  12843. @multitable @columnfractions 0.26 0.33 0.41
  12844. @item @tab @b{Non-session} @tab @b{Session}
  12845. @item @code{:results value} @tab value of last expression @tab value of last expression
  12846. @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
  12847. @end multitable
  12848. Note: With @code{:results value}, the result in both @code{:session} and
  12849. non-session is returned to Org mode as a table (a one- or two-dimensional
  12850. vector of strings or numbers) when appropriate.
  12851. @subsection Non-session
  12852. @subsubsection @code{:results value}
  12853. This is the default. Internally, the value is obtained by wrapping the code
  12854. in a function definition in the external language, and evaluating that
  12855. function. Therefore, code should be written as if it were the body of such a
  12856. function. In particular, note that Python does not automatically return a
  12857. value from a function unless a @code{return} statement is present, and so a
  12858. @samp{return} statement will usually be required in Python.
  12859. This is the only one of the four evaluation contexts in which the code is
  12860. automatically wrapped in a function definition.
  12861. @subsubsection @code{:results output}
  12862. The code is passed to the interpreter as an external process, and the
  12863. contents of the standard output stream are returned as text. (In certain
  12864. languages this also contains the error output stream; this is an area for
  12865. future work.)
  12866. @subsection Session
  12867. @subsubsection @code{:results value}
  12868. The code is passed to an interpreter running as an interactive Emacs inferior
  12869. process. Only languages which provide tools for interactive evaluation of
  12870. code have session support, so some language (e.g., C and ditaa) do not
  12871. support the @code{:session} header argument, and in other languages (e.g.,
  12872. Python and Haskell) which have limitations on the code which may be entered
  12873. into interactive sessions, those limitations apply to the code in code blocks
  12874. using the @code{:session} header argument as well.
  12875. Unless the @code{:results output} option is supplied (see below) the result
  12876. returned is the result of the last evaluation performed by the
  12877. interpreter. (This is obtained in a language-specific manner: the value of
  12878. the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
  12879. in R).
  12880. @subsubsection @code{:results output}
  12881. The code is passed to the interpreter running as an interactive Emacs
  12882. inferior process. The result returned is the concatenation of the sequence of
  12883. (text) output from the interactive interpreter. Notice that this is not
  12884. necessarily the same as what would be sent to @code{STDOUT} if the same code
  12885. were passed to a non-interactive interpreter running as an external
  12886. process. For example, compare the following two blocks:
  12887. @example
  12888. #+BEGIN_SRC python :results output
  12889. print "hello"
  12890. 2
  12891. print "bye"
  12892. #+END_SRC
  12893. #+RESULTS:
  12894. : hello
  12895. : bye
  12896. @end example
  12897. In non-session mode, the `2' is not printed and does not appear.
  12898. @example
  12899. #+BEGIN_SRC python :results output :session
  12900. print "hello"
  12901. 2
  12902. print "bye"
  12903. #+END_SRC
  12904. #+RESULTS:
  12905. : hello
  12906. : 2
  12907. : bye
  12908. @end example
  12909. But in @code{:session} mode, the interactive interpreter receives input `2'
  12910. and prints out its value, `2'. (Indeed, the other print statements are
  12911. unnecessary here).
  12912. @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
  12913. @section Noweb reference syntax
  12914. @cindex code block, noweb reference
  12915. @cindex syntax, noweb
  12916. @cindex source code, noweb reference
  12917. The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
  12918. Programming system allows named blocks of code to be referenced by using the
  12919. familiar Noweb syntax:
  12920. @example
  12921. <<code-block-name>>
  12922. @end example
  12923. When a code block is tangled or evaluated, whether or not ``noweb''
  12924. references are expanded depends upon the value of the @code{:noweb} header
  12925. argument. If @code{:noweb yes}, then a Noweb reference is expanded before
  12926. evaluation. If @code{:noweb no}, the default, then the reference is not
  12927. expanded before evaluation. See the @ref{noweb-ref} header argument for
  12928. a more flexible way to resolve noweb references.
  12929. It is possible to include the @emph{results} of a code block rather than the
  12930. body. This is done by appending parenthesis to the code block name which may
  12931. optionally contain arguments to the code block as shown below.
  12932. @example
  12933. <<code-block-name(optional arguments)>>
  12934. @end example
  12935. Note: the default value, @code{:noweb no}, was chosen to ensure that
  12936. correct code is not broken in a language, such as Ruby, where
  12937. @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
  12938. syntactically valid in languages that you use, then please consider setting
  12939. the default value.
  12940. Note: if noweb tangling is slow in large Org mode files consider setting the
  12941. @var{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
  12942. This will result in faster noweb reference resolution at the expense of not
  12943. correctly resolving inherited values of the @code{:noweb-ref} header
  12944. argument.
  12945. @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
  12946. @section Key bindings and useful functions
  12947. @cindex code block, key bindings
  12948. Many common Org mode key sequences are re-bound depending on
  12949. the context.
  12950. Within a code block, the following key bindings
  12951. are active:
  12952. @multitable @columnfractions 0.25 0.75
  12953. @kindex C-c C-c
  12954. @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
  12955. @kindex C-c C-o
  12956. @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
  12957. @kindex C-up
  12958. @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
  12959. @kindex M-down
  12960. @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
  12961. @end multitable
  12962. In an Org mode buffer, the following key bindings are active:
  12963. @multitable @columnfractions 0.45 0.55
  12964. @kindex C-c C-v p
  12965. @kindex C-c C-v C-p
  12966. @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
  12967. @kindex C-c C-v n
  12968. @kindex C-c C-v C-n
  12969. @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
  12970. @kindex C-c C-v e
  12971. @kindex C-c C-v C-e
  12972. @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
  12973. @kindex C-c C-v o
  12974. @kindex C-c C-v C-o
  12975. @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
  12976. @kindex C-c C-v v
  12977. @kindex C-c C-v C-v
  12978. @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
  12979. @kindex C-c C-v u
  12980. @kindex C-c C-v C-u
  12981. @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
  12982. @kindex C-c C-v g
  12983. @kindex C-c C-v C-g
  12984. @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
  12985. @kindex C-c C-v r
  12986. @kindex C-c C-v C-r
  12987. @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
  12988. @kindex C-c C-v b
  12989. @kindex C-c C-v C-b
  12990. @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
  12991. @kindex C-c C-v s
  12992. @kindex C-c C-v C-s
  12993. @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
  12994. @kindex C-c C-v d
  12995. @kindex C-c C-v C-d
  12996. @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
  12997. @kindex C-c C-v t
  12998. @kindex C-c C-v C-t
  12999. @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
  13000. @kindex C-c C-v f
  13001. @kindex C-c C-v C-f
  13002. @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
  13003. @kindex C-c C-v c
  13004. @kindex C-c C-v C-c
  13005. @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
  13006. @kindex C-c C-v j
  13007. @kindex C-c C-v C-j
  13008. @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
  13009. @kindex C-c C-v l
  13010. @kindex C-c C-v C-l
  13011. @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
  13012. @kindex C-c C-v i
  13013. @kindex C-c C-v C-i
  13014. @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
  13015. @kindex C-c C-v I
  13016. @kindex C-c C-v C-I
  13017. @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
  13018. @kindex C-c C-v z
  13019. @kindex C-c C-v C-z
  13020. @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session-with-code}
  13021. @kindex C-c C-v a
  13022. @kindex C-c C-v C-a
  13023. @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
  13024. @kindex C-c C-v h
  13025. @kindex C-c C-v C-h
  13026. @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
  13027. @kindex C-c C-v x
  13028. @kindex C-c C-v C-x
  13029. @item @kbd{C-c C-v x} @ @ @r{or} @ @ @kbd{C-c C-v C-x} @tab @code{org-babel-do-key-sequence-in-edit-buffer}
  13030. @end multitable
  13031. @c When possible these keybindings were extended to work when the control key is
  13032. @c kept pressed, resulting in the following additional keybindings.
  13033. @c @multitable @columnfractions 0.25 0.75
  13034. @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
  13035. @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
  13036. @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
  13037. @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
  13038. @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
  13039. @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
  13040. @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
  13041. @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
  13042. @c @end multitable
  13043. @node Batch execution, , Key bindings and useful functions, Working With Source Code
  13044. @section Batch execution
  13045. @cindex code block, batch execution
  13046. @cindex source code, batch execution
  13047. It is possible to call functions from the command line. This shell
  13048. script calls @code{org-babel-tangle} on every one of its arguments.
  13049. Be sure to adjust the paths to fit your system.
  13050. @example
  13051. #!/bin/sh
  13052. # -*- mode: shell-script -*-
  13053. #
  13054. # tangle files with org-mode
  13055. #
  13056. DIR=`pwd`
  13057. FILES=""
  13058. # wrap each argument in the code required to call tangle on it
  13059. for i in $@@; do
  13060. FILES="$FILES \"$i\""
  13061. done
  13062. emacs -Q --batch \
  13063. --eval "(progn
  13064. (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
  13065. (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
  13066. (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
  13067. (mapc (lambda (file)
  13068. (find-file (expand-file-name file \"$DIR\"))
  13069. (org-babel-tangle)
  13070. (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
  13071. @end example
  13072. @node Miscellaneous, Hacking, Working With Source Code, Top
  13073. @chapter Miscellaneous
  13074. @menu
  13075. * Completion:: M-TAB knows what you need
  13076. * Easy Templates:: Quick insertion of structural elements
  13077. * Speed keys:: Electric commands at the beginning of a headline
  13078. * Code evaluation security:: Org mode files evaluate inline code
  13079. * Customization:: Adapting Org to your taste
  13080. * In-buffer settings:: Overview of the #+KEYWORDS
  13081. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  13082. * Clean view:: Getting rid of leading stars in the outline
  13083. * TTY keys:: Using Org on a tty
  13084. * Interaction:: Other Emacs packages
  13085. * org-crypt.el:: Encrypting Org files
  13086. @end menu
  13087. @node Completion, Easy Templates, Miscellaneous, Miscellaneous
  13088. @section Completion
  13089. @cindex completion, of @TeX{} symbols
  13090. @cindex completion, of TODO keywords
  13091. @cindex completion, of dictionary words
  13092. @cindex completion, of option keywords
  13093. @cindex completion, of tags
  13094. @cindex completion, of property keys
  13095. @cindex completion, of link abbreviations
  13096. @cindex @TeX{} symbol completion
  13097. @cindex TODO keywords completion
  13098. @cindex dictionary word completion
  13099. @cindex option keyword completion
  13100. @cindex tag completion
  13101. @cindex link abbreviations, completion of
  13102. Emacs would not be Emacs without completion, and Org mode uses it whenever it
  13103. makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
  13104. some of the completion prompts, you can specify your preference by setting at
  13105. most one of the variables @var{org-completion-use-iswitchb}
  13106. @var{org-completion-use-ido}.
  13107. Org supports in-buffer completion. This type of completion does
  13108. not make use of the minibuffer. You simply type a few letters into
  13109. the buffer and use the key to complete text right there.
  13110. @table @kbd
  13111. @kindex M-@key{TAB}
  13112. @item M-@key{TAB}
  13113. Complete word at point
  13114. @itemize @bullet
  13115. @item
  13116. At the beginning of a headline, complete TODO keywords.
  13117. @item
  13118. After @samp{\}, complete @TeX{} symbols supported by the exporter.
  13119. @item
  13120. After @samp{*}, complete headlines in the current buffer so that they
  13121. can be used in search links like @samp{[[*find this headline]]}.
  13122. @item
  13123. After @samp{:} in a headline, complete tags. The list of tags is taken
  13124. from the variable @var{org-tag-alist} (possibly set through the
  13125. @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
  13126. dynamically from all tags used in the current buffer.
  13127. @item
  13128. After @samp{:} and not in a headline, complete property keys. The list
  13129. of keys is constructed dynamically from all keys used in the current
  13130. buffer.
  13131. @item
  13132. After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
  13133. @item
  13134. After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
  13135. @samp{OPTIONS} which set file-specific options for Org mode. When the
  13136. option keyword is already complete, pressing @kbd{M-@key{TAB}} again
  13137. will insert example settings for this keyword.
  13138. @item
  13139. In the line after @samp{#+STARTUP: }, complete startup keywords,
  13140. i.e., valid keys for this line.
  13141. @item
  13142. Elsewhere, complete dictionary words using Ispell.
  13143. @end itemize
  13144. @end table
  13145. @node Easy Templates, Speed keys, Completion, Miscellaneous
  13146. @section Easy Templates
  13147. @cindex template insertion
  13148. @cindex insertion, of templates
  13149. Org mode supports insertion of empty structural elements (like
  13150. @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
  13151. strokes. This is achieved through a native template expansion mechanism.
  13152. Note that Emacs has several other template mechanisms which could be used in
  13153. a similar way, for example @file{yasnippet}.
  13154. To insert a structural element, type a @samp{<}, followed by a template
  13155. selector and @kbd{@key{TAB}}. Completion takes effect only when the above
  13156. keystrokes are typed on a line by itself.
  13157. The following template selectors are currently supported.
  13158. @multitable @columnfractions 0.1 0.9
  13159. @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
  13160. @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
  13161. @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
  13162. @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
  13163. @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
  13164. @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX}
  13165. @item @kbd{L} @tab @code{#+LaTeX:}
  13166. @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML}
  13167. @item @kbd{H} @tab @code{#+HTML:}
  13168. @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII}
  13169. @item @kbd{A} @tab @code{#+ASCII:}
  13170. @item @kbd{i} @tab @code{#+INDEX:} line
  13171. @item @kbd{I} @tab @code{#+INCLUDE:} line
  13172. @end multitable
  13173. For example, on an empty line, typing "<e" and then pressing TAB, will expand
  13174. into a complete EXAMPLE template.
  13175. You can install additional templates by customizing the variable
  13176. @code{org-structure-template-alist}. See the docstring of the variable for
  13177. additional details.
  13178. @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
  13179. @section Speed keys
  13180. @cindex speed keys
  13181. @vindex org-use-speed-commands
  13182. @vindex org-speed-commands-user
  13183. Single keys can be made to execute commands when the cursor is at the
  13184. beginning of a headline, i.e., before the first star. Configure the variable
  13185. @var{org-use-speed-commands} to activate this feature. There is a
  13186. pre-defined list of commands, and you can add more such commands using the
  13187. variable @var{org-speed-commands-user}. Speed keys do not only speed up
  13188. navigation and other commands, but they also provide an alternative way to
  13189. execute commands bound to keys that are not or not easily available on a TTY,
  13190. or on a small mobile device with a limited keyboard.
  13191. To see which commands are available, activate the feature and press @kbd{?}
  13192. with the cursor at the beginning of a headline.
  13193. @node Code evaluation security, Customization, Speed keys, Miscellaneous
  13194. @section Code evaluation and security issues
  13195. Org provides tools to work with the code snippets, including evaluating them.
  13196. Running code on your machine always comes with a security risk. Badly
  13197. written or malicious code can be executed on purpose or by accident. Org has
  13198. default settings which will only evaluate such code if you give explicit
  13199. permission to do so, and as a casual user of these features you should leave
  13200. these precautions intact.
  13201. For people who regularly work with such code, the confirmation prompts can
  13202. become annoying, and you might want to turn them off. This can be done, but
  13203. you must be aware of the risks that are involved.
  13204. Code evaluation can happen under the following circumstances:
  13205. @table @i
  13206. @item Source code blocks
  13207. Source code blocks can be evaluated during export, or when pressing @kbd{C-c
  13208. C-c} in the block. The most important thing to realize here is that Org mode
  13209. files which contain code snippets are, in a certain sense, like executable
  13210. files. So you should accept them and load them into Emacs only from trusted
  13211. sources---just like you would do with a program you install on your computer.
  13212. Make sure you know what you are doing before customizing the variables
  13213. which take off the default security brakes.
  13214. @defopt org-confirm-babel-evaluate
  13215. When t (the default), the user is asked before every code block evaluation.
  13216. When @code{nil}, the user is not asked. When set to a function, it is called with
  13217. two arguments (language and body of the code block) and should return t to
  13218. ask and @code{nil} not to ask.
  13219. @end defopt
  13220. For example, here is how to execute "ditaa" code (which is considered safe)
  13221. without asking:
  13222. @lisp
  13223. (defun my-org-confirm-babel-evaluate (lang body)
  13224. (not (string= lang "ditaa"))) ; don't ask for ditaa
  13225. (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
  13226. @end lisp
  13227. @item Following @code{shell} and @code{elisp} links
  13228. Org has two link types that can directly evaluate code (@pxref{External
  13229. links}). These links can be problematic because the code to be evaluated is
  13230. not visible.
  13231. @defopt org-confirm-shell-link-function
  13232. Function to queries user about shell link execution.
  13233. @end defopt
  13234. @defopt org-confirm-elisp-link-function
  13235. Functions to query user for Emacs Lisp link execution.
  13236. @end defopt
  13237. @item Formulas in tables
  13238. Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
  13239. either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
  13240. @end table
  13241. @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
  13242. @section Customization
  13243. @cindex customization
  13244. @cindex options, for customization
  13245. @cindex variables, for customization
  13246. There are more than 500 variables that can be used to customize
  13247. Org. For the sake of compactness of the manual, I am not
  13248. describing the variables here. A structured overview of customization
  13249. variables is available with @kbd{M-x org-customize RET}. Or select
  13250. @code{Browse Org Group} from the @code{Org->Customization} menu. Many
  13251. settings can also be activated on a per-file basis, by putting special
  13252. lines into the buffer (@pxref{In-buffer settings}).
  13253. @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
  13254. @section Summary of in-buffer settings
  13255. @cindex in-buffer settings
  13256. @cindex special keywords
  13257. Org mode uses special lines in the buffer to define settings on a
  13258. per-file basis. These lines start with a @samp{#+} followed by a
  13259. keyword, a colon, and then individual words defining a setting. Several
  13260. setting words can be in the same line, but you can also have multiple
  13261. lines for the keyword. While these settings are described throughout
  13262. the manual, here is a summary. After changing any of those lines in the
  13263. buffer, press @kbd{C-c C-c} with the cursor still in the line to
  13264. activate the changes immediately. Otherwise they become effective only
  13265. when the file is visited again in a new Emacs session.
  13266. @vindex org-archive-location
  13267. @table @kbd
  13268. @item #+ARCHIVE: %s_done::
  13269. This line sets the archive location for the agenda file. It applies for
  13270. all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
  13271. of the file. The first such line also applies to any entries before it.
  13272. The corresponding variable is @var{org-archive-location}.
  13273. @item #+CATEGORY:
  13274. This line sets the category for the agenda file. The category applies
  13275. for all subsequent lines until the next @samp{#+CATEGORY} line, or the
  13276. end of the file. The first such line also applies to any entries before it.
  13277. @item #+COLUMNS: %25ITEM .....
  13278. @cindex property, COLUMNS
  13279. Set the default format for columns view. This format applies when
  13280. columns view is invoked in locations where no @code{COLUMNS} property
  13281. applies.
  13282. @item #+CONSTANTS: name1=value1 ...
  13283. @vindex org-table-formula-constants
  13284. @vindex org-table-formula
  13285. Set file-local values for constants to be used in table formulas. This
  13286. line sets the local variable @var{org-table-formula-constants-local}.
  13287. The global version of this variable is
  13288. @var{org-table-formula-constants}.
  13289. @item #+FILETAGS: :tag1:tag2:tag3:
  13290. Set tags that can be inherited by any entry in the file, including the
  13291. top-level entries.
  13292. @item #+DRAWERS: NAME1 .....
  13293. @vindex org-drawers
  13294. Set the file-local set of additional drawers. The corresponding global
  13295. variable is @var{org-drawers}.
  13296. @item #+LINK: linkword replace
  13297. @vindex org-link-abbrev-alist
  13298. These lines (several are allowed) specify link abbreviations.
  13299. @xref{Link abbreviations}. The corresponding variable is
  13300. @var{org-link-abbrev-alist}.
  13301. @item #+PRIORITIES: highest lowest default
  13302. @vindex org-highest-priority
  13303. @vindex org-lowest-priority
  13304. @vindex org-default-priority
  13305. This line sets the limits and the default for the priorities. All three
  13306. must be either letters A--Z or numbers 0--9. The highest priority must
  13307. have a lower ASCII number than the lowest priority.
  13308. @item #+PROPERTY: Property_Name Value
  13309. This line sets a default inheritance value for entries in the current
  13310. buffer, most useful for specifying the allowed values of a property.
  13311. @cindex #+SETUPFILE
  13312. @item #+SETUPFILE: file
  13313. This line defines a file that holds more in-buffer setup. Normally this is
  13314. entirely ignored. Only when the buffer is parsed for option-setting lines
  13315. (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
  13316. settings line, or when exporting), then the contents of this file are parsed
  13317. as if they had been included in the buffer. In particular, the file can be
  13318. any other Org mode file with internal setup. You can visit the file the
  13319. cursor is in the line with @kbd{C-c '}.
  13320. @item #+STARTUP:
  13321. @cindex #+STARTUP:
  13322. This line sets options to be used at startup of Org mode, when an
  13323. Org file is being visited.
  13324. The first set of options deals with the initial visibility of the outline
  13325. tree. The corresponding variable for global default settings is
  13326. @var{org-startup-folded}, with a default value @code{t}, which means
  13327. @code{overview}.
  13328. @vindex org-startup-folded
  13329. @cindex @code{overview}, STARTUP keyword
  13330. @cindex @code{content}, STARTUP keyword
  13331. @cindex @code{showall}, STARTUP keyword
  13332. @cindex @code{showeverything}, STARTUP keyword
  13333. @example
  13334. overview @r{top-level headlines only}
  13335. content @r{all headlines}
  13336. showall @r{no folding of any entries}
  13337. showeverything @r{show even drawer contents}
  13338. @end example
  13339. @vindex org-startup-indented
  13340. @cindex @code{indent}, STARTUP keyword
  13341. @cindex @code{noindent}, STARTUP keyword
  13342. Dynamic virtual indentation is controlled by the variable
  13343. @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
  13344. @example
  13345. indent @r{start with @code{org-indent-mode} turned on}
  13346. noindent @r{start with @code{org-indent-mode} turned off}
  13347. @end example
  13348. @vindex org-startup-align-all-tables
  13349. Then there are options for aligning tables upon visiting a file. This
  13350. is useful in files containing narrowed table columns. The corresponding
  13351. variable is @var{org-startup-align-all-tables}, with a default value
  13352. @code{nil}.
  13353. @cindex @code{align}, STARTUP keyword
  13354. @cindex @code{noalign}, STARTUP keyword
  13355. @example
  13356. align @r{align all tables}
  13357. noalign @r{don't align tables on startup}
  13358. @end example
  13359. @vindex org-startup-with-inline-images
  13360. When visiting a file, inline images can be automatically displayed. The
  13361. corresponding variable is @var{org-startup-with-inline-images}, with a
  13362. default value @code{nil} to avoid delays when visiting a file.
  13363. @cindex @code{inlineimages}, STARTUP keyword
  13364. @cindex @code{noinlineimages}, STARTUP keyword
  13365. @example
  13366. inlineimages @r{show inline images}
  13367. noinlineimages @r{don't show inline images on startup}
  13368. @end example
  13369. @vindex org-startup-with-latex-preview
  13370. When visiting a file, @LaTeX{} fragments can be converted to images
  13371. automatically. The variable @var{org-startup-with-latex-preview} which
  13372. controls this behavior, is set to @code{nil} by default to avoid delays on
  13373. startup.
  13374. @cindex @code{latexpreview}, STARTUP keyword
  13375. @cindex @code{nolatexpreview}, STARTUP keyword
  13376. @example
  13377. latexpreview @r{preview @LaTeX{} fragments}
  13378. nolatexpreview @r{don't preview @LaTeX{} fragments}
  13379. @end example
  13380. @vindex org-log-done
  13381. @vindex org-log-note-clock-out
  13382. @vindex org-log-repeat
  13383. Logging the closing and reopening of TODO items and clock intervals can be
  13384. configured using these options (see variables @var{org-log-done},
  13385. @var{org-log-note-clock-out} and @var{org-log-repeat})
  13386. @cindex @code{logdone}, STARTUP keyword
  13387. @cindex @code{lognotedone}, STARTUP keyword
  13388. @cindex @code{nologdone}, STARTUP keyword
  13389. @cindex @code{lognoteclock-out}, STARTUP keyword
  13390. @cindex @code{nolognoteclock-out}, STARTUP keyword
  13391. @cindex @code{logrepeat}, STARTUP keyword
  13392. @cindex @code{lognoterepeat}, STARTUP keyword
  13393. @cindex @code{nologrepeat}, STARTUP keyword
  13394. @cindex @code{logreschedule}, STARTUP keyword
  13395. @cindex @code{lognotereschedule}, STARTUP keyword
  13396. @cindex @code{nologreschedule}, STARTUP keyword
  13397. @cindex @code{logredeadline}, STARTUP keyword
  13398. @cindex @code{lognoteredeadline}, STARTUP keyword
  13399. @cindex @code{nologredeadline}, STARTUP keyword
  13400. @cindex @code{logrefile}, STARTUP keyword
  13401. @cindex @code{lognoterefile}, STARTUP keyword
  13402. @cindex @code{nologrefile}, STARTUP keyword
  13403. @cindex @code{logdrawer}, STARTUP keyword
  13404. @cindex @code{nologdrawer}, STARTUP keyword
  13405. @cindex @code{logstatesreversed}, STARTUP keyword
  13406. @cindex @code{nologstatesreversed}, STARTUP keyword
  13407. @example
  13408. logdone @r{record a timestamp when an item is marked DONE}
  13409. lognotedone @r{record timestamp and a note when DONE}
  13410. nologdone @r{don't record when items are marked DONE}
  13411. logrepeat @r{record a time when reinstating a repeating item}
  13412. lognoterepeat @r{record a note when reinstating a repeating item}
  13413. nologrepeat @r{do not record when reinstating repeating item}
  13414. lognoteclock-out @r{record a note when clocking out}
  13415. nolognoteclock-out @r{don't record a note when clocking out}
  13416. logreschedule @r{record a timestamp when scheduling time changes}
  13417. lognotereschedule @r{record a note when scheduling time changes}
  13418. nologreschedule @r{do not record when a scheduling date changes}
  13419. logredeadline @r{record a timestamp when deadline changes}
  13420. lognoteredeadline @r{record a note when deadline changes}
  13421. nologredeadline @r{do not record when a deadline date changes}
  13422. logrefile @r{record a timestamp when refiling}
  13423. lognoterefile @r{record a note when refiling}
  13424. nologrefile @r{do not record when refiling}
  13425. logdrawer @r{store log into drawer}
  13426. nologdrawer @r{store log outside of drawer}
  13427. logstatesreversed @r{reverse the order of states notes}
  13428. nologstatesreversed @r{do not reverse the order of states notes}
  13429. @end example
  13430. @vindex org-hide-leading-stars
  13431. @vindex org-odd-levels-only
  13432. Here are the options for hiding leading stars in outline headings, and for
  13433. indenting outlines. The corresponding variables are
  13434. @var{org-hide-leading-stars} and @var{org-odd-levels-only}, both with a
  13435. default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
  13436. @cindex @code{hidestars}, STARTUP keyword
  13437. @cindex @code{showstars}, STARTUP keyword
  13438. @cindex @code{odd}, STARTUP keyword
  13439. @cindex @code{even}, STARTUP keyword
  13440. @example
  13441. hidestars @r{make all but one of the stars starting a headline invisible.}
  13442. showstars @r{show all stars starting a headline}
  13443. indent @r{virtual indentation according to outline level}
  13444. noindent @r{no virtual indentation according to outline level}
  13445. odd @r{allow only odd outline levels (1,3,...)}
  13446. oddeven @r{allow all outline levels}
  13447. @end example
  13448. @vindex org-put-time-stamp-overlays
  13449. @vindex org-time-stamp-overlay-formats
  13450. To turn on custom format overlays over timestamps (variables
  13451. @var{org-put-time-stamp-overlays} and
  13452. @var{org-time-stamp-overlay-formats}), use
  13453. @cindex @code{customtime}, STARTUP keyword
  13454. @example
  13455. customtime @r{overlay custom time format}
  13456. @end example
  13457. @vindex constants-unit-system
  13458. The following options influence the table spreadsheet (variable
  13459. @var{constants-unit-system}).
  13460. @cindex @code{constcgs}, STARTUP keyword
  13461. @cindex @code{constSI}, STARTUP keyword
  13462. @example
  13463. constcgs @r{@file{constants.el} should use the c-g-s unit system}
  13464. constSI @r{@file{constants.el} should use the SI unit system}
  13465. @end example
  13466. @vindex org-footnote-define-inline
  13467. @vindex org-footnote-auto-label
  13468. @vindex org-footnote-auto-adjust
  13469. To influence footnote settings, use the following keywords. The
  13470. corresponding variables are @var{org-footnote-define-inline},
  13471. @var{org-footnote-auto-label}, and @var{org-footnote-auto-adjust}.
  13472. @cindex @code{fninline}, STARTUP keyword
  13473. @cindex @code{nofninline}, STARTUP keyword
  13474. @cindex @code{fnlocal}, STARTUP keyword
  13475. @cindex @code{fnprompt}, STARTUP keyword
  13476. @cindex @code{fnauto}, STARTUP keyword
  13477. @cindex @code{fnconfirm}, STARTUP keyword
  13478. @cindex @code{fnplain}, STARTUP keyword
  13479. @cindex @code{fnadjust}, STARTUP keyword
  13480. @cindex @code{nofnadjust}, STARTUP keyword
  13481. @example
  13482. fninline @r{define footnotes inline}
  13483. fnnoinline @r{define footnotes in separate section}
  13484. fnlocal @r{define footnotes near first reference, but not inline}
  13485. fnprompt @r{prompt for footnote labels}
  13486. fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
  13487. fnconfirm @r{offer automatic label for editing or confirmation}
  13488. fnplain @r{create @code{[1]}-like labels automatically}
  13489. fnadjust @r{automatically renumber and sort footnotes}
  13490. nofnadjust @r{do not renumber and sort automatically}
  13491. @end example
  13492. @cindex org-hide-block-startup
  13493. To hide blocks on startup, use these keywords. The corresponding variable is
  13494. @var{org-hide-block-startup}.
  13495. @cindex @code{hideblocks}, STARTUP keyword
  13496. @cindex @code{nohideblocks}, STARTUP keyword
  13497. @example
  13498. hideblocks @r{Hide all begin/end blocks on startup}
  13499. nohideblocks @r{Do not hide blocks on startup}
  13500. @end example
  13501. @cindex org-pretty-entities
  13502. The display of entities as UTF-8 characters is governed by the variable
  13503. @var{org-pretty-entities} and the keywords
  13504. @cindex @code{entitiespretty}, STARTUP keyword
  13505. @cindex @code{entitiesplain}, STARTUP keyword
  13506. @example
  13507. entitiespretty @r{Show entities as UTF-8 characters where possible}
  13508. entitiesplain @r{Leave entities plain}
  13509. @end example
  13510. @item #+TAGS: TAG1(c1) TAG2(c2)
  13511. @vindex org-tag-alist
  13512. These lines (several such lines are allowed) specify the valid tags in
  13513. this file, and (potentially) the corresponding @emph{fast tag selection}
  13514. keys. The corresponding variable is @var{org-tag-alist}.
  13515. @cindex #+TBLFM
  13516. @item #+TBLFM:
  13517. This line contains the formulas for the table directly above the line.
  13518. Table can have multiple lines containing @samp{#+TBLFM:}. Note
  13519. that only the first line of @samp{#+TBLFM:} will be applied when
  13520. you recalculate the table. For more details see @ref{Using
  13521. multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
  13522. @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
  13523. @itemx #+OPTIONS:, #+BIND:,
  13524. @itemx #+DESCRIPTION:, #+KEYWORDS:,
  13525. @itemx #+LaTeX_HEADER:, #+LaTeX_HEADER_EXTRA:,
  13526. @itemx #+HTML_HEAD:, #+HTML_HEAD_EXTRA:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
  13527. @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
  13528. These lines provide settings for exporting files. For more details see
  13529. @ref{Export settings}.
  13530. @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
  13531. @vindex org-todo-keywords
  13532. These lines set the TODO keywords and their interpretation in the
  13533. current file. The corresponding variable is @var{org-todo-keywords}.
  13534. @end table
  13535. @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
  13536. @section The very busy C-c C-c key
  13537. @kindex C-c C-c
  13538. @cindex C-c C-c, overview
  13539. The key @kbd{C-c C-c} has many purposes in Org, which are all
  13540. mentioned scattered throughout this manual. One specific function of
  13541. this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
  13542. other circumstances it means something like @emph{``Hey Org, look
  13543. here and update according to what you see here''}. Here is a summary of
  13544. what this means in different contexts.
  13545. @itemize @minus
  13546. @item
  13547. If there are highlights in the buffer from the creation of a sparse
  13548. tree, or from clock display, remove these highlights.
  13549. @item
  13550. If the cursor is in one of the special @code{#+KEYWORD} lines, this
  13551. triggers scanning the buffer for these lines and updating the
  13552. information.
  13553. @item
  13554. If the cursor is inside a table, realign the table. This command
  13555. works even if the automatic table editor has been turned off.
  13556. @item
  13557. If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
  13558. the entire table.
  13559. @item
  13560. If the current buffer is a capture buffer, close the note and file it.
  13561. With a prefix argument, file it, without further interaction, to the
  13562. default location.
  13563. @item
  13564. If the cursor is on a @code{<<<target>>>}, update radio targets and
  13565. corresponding links in this buffer.
  13566. @item
  13567. If the cursor is in a property line or at the start or end of a property
  13568. drawer, offer property commands.
  13569. @item
  13570. If the cursor is at a footnote reference, go to the corresponding
  13571. definition, and @emph{vice versa}.
  13572. @item
  13573. If the cursor is on a statistics cookie, update it.
  13574. @item
  13575. If the cursor is in a plain list item with a checkbox, toggle the status
  13576. of the checkbox.
  13577. @item
  13578. If the cursor is on a numbered item in a plain list, renumber the
  13579. ordered list.
  13580. @item
  13581. If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
  13582. block is updated.
  13583. @item
  13584. If the cursor is at a timestamp, fix the day name in the timestamp.
  13585. @end itemize
  13586. @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
  13587. @section A cleaner outline view
  13588. @cindex hiding leading stars
  13589. @cindex dynamic indentation
  13590. @cindex odd-levels-only outlines
  13591. @cindex clean outline view
  13592. Some people find it noisy and distracting that the Org headlines start with a
  13593. potentially large number of stars, and that text below the headlines is not
  13594. indented. While this is no problem when writing a @emph{book-like} document
  13595. where the outline headings are really section headings, in a more
  13596. @emph{list-oriented} outline, indented structure is a lot cleaner:
  13597. @example
  13598. @group
  13599. * Top level headline | * Top level headline
  13600. ** Second level | * Second level
  13601. *** 3rd level | * 3rd level
  13602. some text | some text
  13603. *** 3rd level | * 3rd level
  13604. more text | more text
  13605. * Another top level headline | * Another top level headline
  13606. @end group
  13607. @end example
  13608. @noindent
  13609. If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
  13610. with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
  13611. be achieved dynamically at display time using @code{org-indent-mode}. In
  13612. this minor mode, all lines are prefixed for display with the necessary amount
  13613. of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
  13614. property, such that @code{visual-line-mode} (or purely setting
  13615. @code{word-wrap}) wraps long lines (including headlines) correctly indented.
  13616. }. Also headlines are prefixed with additional stars, so that the amount of
  13617. indentation shifts by two@footnote{See the variable
  13618. @var{org-indent-indentation-per-level}.} spaces per level. All headline
  13619. stars but the last one are made invisible using the @code{org-hide}
  13620. face@footnote{Turning on @code{org-indent-mode} sets
  13621. @var{org-hide-leading-stars} to @code{t} and @var{org-adapt-indentation} to
  13622. @code{nil}.}; see below under @samp{2.} for more information on how this
  13623. works. You can turn on @code{org-indent-mode} for all files by customizing
  13624. the variable @var{org-startup-indented}, or you can turn it on for
  13625. individual files using
  13626. @example
  13627. #+STARTUP: indent
  13628. @end example
  13629. If you want a similar effect in an earlier version of Emacs and/or Org, or if
  13630. you want the indentation to be hard space characters so that the plain text
  13631. file looks as similar as possible to the Emacs display, Org supports you in
  13632. the following way:
  13633. @enumerate
  13634. @item
  13635. @emph{Indentation of text below headlines}@*
  13636. You may indent text below each headline to make the left boundary line up
  13637. with the headline, like
  13638. @example
  13639. *** 3rd level
  13640. more text, now indented
  13641. @end example
  13642. @vindex org-adapt-indentation
  13643. Org supports this with paragraph filling, line wrapping, and structure
  13644. editing@footnote{See also the variable @var{org-adapt-indentation}.},
  13645. preserving or adapting the indentation as appropriate.
  13646. @item
  13647. @vindex org-hide-leading-stars
  13648. @emph{Hiding leading stars}@* You can modify the display in such a way that
  13649. all leading stars become invisible. To do this in a global way, configure
  13650. the variable @var{org-hide-leading-stars} or change this on a per-file basis
  13651. with
  13652. @example
  13653. #+STARTUP: hidestars
  13654. #+STARTUP: showstars
  13655. @end example
  13656. With hidden stars, the tree becomes:
  13657. @example
  13658. @group
  13659. * Top level headline
  13660. * Second level
  13661. * 3rd level
  13662. ...
  13663. @end group
  13664. @end example
  13665. @noindent
  13666. @vindex org-hide @r{(face)}
  13667. The leading stars are not truly replaced by whitespace, they are only
  13668. fontified with the face @code{org-hide} that uses the background color as
  13669. font color. If you are not using either white or black background, you may
  13670. have to customize this face to get the wanted effect. Another possibility is
  13671. to set this font such that the extra stars are @i{almost} invisible, for
  13672. example using the color @code{grey90} on a white background.
  13673. @item
  13674. @vindex org-odd-levels-only
  13675. Things become cleaner still if you skip all the even levels and use only odd
  13676. levels 1, 3, 5..., effectively adding two stars to go from one outline level
  13677. to the next@footnote{When you need to specify a level for a property search
  13678. or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
  13679. way we get the outline view shown at the beginning of this section. In order
  13680. to make the structure editing and export commands handle this convention
  13681. correctly, configure the variable @var{org-odd-levels-only}, or set this on
  13682. a per-file basis with one of the following lines:
  13683. @example
  13684. #+STARTUP: odd
  13685. #+STARTUP: oddeven
  13686. @end example
  13687. You can convert an Org file from single-star-per-level to the
  13688. double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
  13689. RET} in that file. The reverse operation is @kbd{M-x
  13690. org-convert-to-oddeven-levels}.
  13691. @end enumerate
  13692. @node TTY keys, Interaction, Clean view, Miscellaneous
  13693. @section Using Org on a tty
  13694. @cindex tty key bindings
  13695. Because Org contains a large number of commands, by default many of
  13696. Org's core commands are bound to keys that are generally not
  13697. accessible on a tty, such as the cursor keys (@key{left}, @key{right},
  13698. @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
  13699. together with modifiers like @key{Meta} and/or @key{Shift}. To access
  13700. these commands on a tty when special keys are unavailable, the following
  13701. alternative bindings can be used. The tty bindings below will likely be
  13702. more cumbersome; you may find for some of the bindings below that a
  13703. customized workaround suits you better. For example, changing a timestamp
  13704. is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
  13705. tty you would rather use @kbd{C-c .} to re-insert the timestamp.
  13706. @multitable @columnfractions 0.15 0.2 0.1 0.2
  13707. @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
  13708. @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
  13709. @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
  13710. @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
  13711. @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
  13712. @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
  13713. @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
  13714. @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
  13715. @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
  13716. @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
  13717. @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
  13718. @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
  13719. @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
  13720. @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
  13721. @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
  13722. @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
  13723. @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
  13724. @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
  13725. @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
  13726. @end multitable
  13727. @node Interaction, org-crypt.el, TTY keys, Miscellaneous
  13728. @section Interaction with other packages
  13729. @cindex packages, interaction with other
  13730. Org lives in the world of GNU Emacs and interacts in various ways
  13731. with other code out there.
  13732. @menu
  13733. * Cooperation:: Packages Org cooperates with
  13734. * Conflicts:: Packages that lead to conflicts
  13735. @end menu
  13736. @node Cooperation, Conflicts, Interaction, Interaction
  13737. @subsection Packages that Org cooperates with
  13738. @table @asis
  13739. @cindex @file{calc.el}
  13740. @cindex Gillespie, Dave
  13741. @item @file{calc.el} by Dave Gillespie
  13742. Org uses the Calc package for implementing spreadsheet
  13743. functionality in its tables (@pxref{The spreadsheet}). Org
  13744. checks for the availability of Calc by looking for the function
  13745. @code{calc-eval} which will have been autoloaded during setup if Calc has
  13746. been installed properly. As of Emacs 22, Calc is part of the Emacs
  13747. distribution. Another possibility for interaction between the two
  13748. packages is using Calc for embedded calculations. @xref{Embedded Mode,
  13749. , Embedded Mode, calc, GNU Emacs Calc Manual}.
  13750. @item @file{constants.el} by Carsten Dominik
  13751. @cindex @file{constants.el}
  13752. @cindex Dominik, Carsten
  13753. @vindex org-table-formula-constants
  13754. In a table formula (@pxref{The spreadsheet}), it is possible to use
  13755. names for natural constants or units. Instead of defining your own
  13756. constants in the variable @var{org-table-formula-constants}, install
  13757. the @file{constants} package which defines a large number of constants
  13758. and units, and lets you use unit prefixes like @samp{M} for
  13759. @samp{Mega}, etc. You will need version 2.0 of this package, available
  13760. at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
  13761. the function @code{constants-get}, which has to be autoloaded in your
  13762. setup. See the installation instructions in the file
  13763. @file{constants.el}.
  13764. @item @file{cdlatex.el} by Carsten Dominik
  13765. @cindex @file{cdlatex.el}
  13766. @cindex Dominik, Carsten
  13767. Org mode can make use of the CD@LaTeX{} package to efficiently enter
  13768. @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
  13769. @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
  13770. @cindex @file{imenu.el}
  13771. Imenu allows menu access to an index of items in a file. Org mode
  13772. supports Imenu---all you need to do to get the index is the following:
  13773. @lisp
  13774. (add-hook 'org-mode-hook
  13775. (lambda () (imenu-add-to-menubar "Imenu")))
  13776. @end lisp
  13777. @vindex org-imenu-depth
  13778. By default the index is two levels deep---you can modify the depth using
  13779. the option @var{org-imenu-depth}.
  13780. @item @file{remember.el} by John Wiegley
  13781. @cindex @file{remember.el}
  13782. @cindex Wiegley, John
  13783. Org used to use this package for capture, but no longer does.
  13784. @item @file{speedbar.el} by Eric M. Ludlam
  13785. @cindex @file{speedbar.el}
  13786. @cindex Ludlam, Eric M.
  13787. Speedbar is a package that creates a special frame displaying files and
  13788. index items in files. Org mode supports Speedbar and allows you to
  13789. drill into Org files directly from the Speedbar. It also allows you to
  13790. restrict the scope of agenda commands to a file or a subtree by using
  13791. the command @kbd{<} in the Speedbar frame.
  13792. @cindex @file{table.el}
  13793. @item @file{table.el} by Takaaki Ota
  13794. @kindex C-c C-c
  13795. @cindex table editor, @file{table.el}
  13796. @cindex @file{table.el}
  13797. @cindex Ota, Takaaki
  13798. Complex ASCII tables with automatic line wrapping, column- and row-spanning,
  13799. and alignment can be created using the Emacs table package by Takaaki Ota
  13800. (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
  13801. Org mode will recognize these tables and export them properly. Because of
  13802. interference with other Org mode functionality, you unfortunately cannot edit
  13803. these tables directly in the buffer. Instead, you need to use the command
  13804. @kbd{C-c '} to edit them, similar to source code snippets.
  13805. @table @kbd
  13806. @orgcmd{C-c ',org-edit-special}
  13807. Edit a @file{table.el} table. Works when the cursor is in a table.el table.
  13808. @c
  13809. @orgcmd{C-c ~,org-table-create-with-table.el}
  13810. Insert a @file{table.el} table. If there is already a table at point, this
  13811. command converts it between the @file{table.el} format and the Org mode
  13812. format. See the documentation string of the command
  13813. @code{org-convert-table} for the restrictions under which this is
  13814. possible.
  13815. @end table
  13816. @file{table.el} is part of Emacs since Emacs 22.
  13817. @item @file{footnote.el} by Steven L. Baur
  13818. @cindex @file{footnote.el}
  13819. @cindex Baur, Steven L.
  13820. Org mode recognizes numerical footnotes as provided by this package.
  13821. However, Org mode also has its own footnote support (@pxref{Footnotes}),
  13822. which makes using @file{footnote.el} unnecessary.
  13823. @end table
  13824. @node Conflicts, , Cooperation, Interaction
  13825. @subsection Packages that lead to conflicts with Org mode
  13826. @table @asis
  13827. @cindex @code{shift-selection-mode}
  13828. @vindex org-support-shift-select
  13829. In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
  13830. cursor motions combined with the shift key should start or enlarge regions.
  13831. This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
  13832. timestamps, TODO keywords, priorities, and item bullet types if the cursor is
  13833. at such a location. By default, @kbd{S-@key{cursor}} commands outside
  13834. special contexts don't do anything, but you can customize the variable
  13835. @var{org-support-shift-select}. Org mode then tries to accommodate shift
  13836. selection by (i) using it outside of the special contexts where special
  13837. commands apply, and by (ii) extending an existing active region even if the
  13838. cursor moves across a special context.
  13839. @item @file{CUA.el} by Kim. F. Storm
  13840. @cindex @file{CUA.el}
  13841. @cindex Storm, Kim. F.
  13842. @vindex org-replace-disputed-keys
  13843. Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
  13844. (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
  13845. region. In fact, Emacs 23 has this built-in in the form of
  13846. @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
  13847. 23, you probably don't want to use another package for this purpose. However,
  13848. if you prefer to leave these keys to a different package while working in
  13849. Org mode, configure the variable @var{org-replace-disputed-keys}. When set,
  13850. Org will move the following key bindings in Org files, and in the agenda
  13851. buffer (but not during date selection).
  13852. @example
  13853. S-UP @result{} M-p S-DOWN @result{} M-n
  13854. S-LEFT @result{} M-- S-RIGHT @result{} M-+
  13855. C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
  13856. @end example
  13857. @vindex org-disputed-keys
  13858. Yes, these are unfortunately more difficult to remember. If you want
  13859. to have other replacement keys, look at the variable
  13860. @var{org-disputed-keys}.
  13861. @item @file{filladapt.el} by Kyle Jones
  13862. @cindex @file{filladapt.el}
  13863. Org mode tries to do the right thing when filling paragraphs, list items and
  13864. other elements. Many users reported they had problems using both
  13865. @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
  13866. this:
  13867. @lisp
  13868. (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
  13869. @end lisp
  13870. @item @file{yasnippet.el}
  13871. @cindex @file{yasnippet.el}
  13872. The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
  13873. @code{"\t"}) overrules YASnippet's access to this key. The following code
  13874. fixed this problem:
  13875. @lisp
  13876. (add-hook 'org-mode-hook
  13877. (lambda ()
  13878. (org-set-local 'yas/trigger-key [tab])
  13879. (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
  13880. @end lisp
  13881. The latest version of yasnippet doesn't play well with Org mode. If the
  13882. above code does not fix the conflict, start by defining the following
  13883. function:
  13884. @lisp
  13885. (defun yas/org-very-safe-expand ()
  13886. (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
  13887. @end lisp
  13888. Then, tell Org mode what to do with the new function:
  13889. @lisp
  13890. (add-hook 'org-mode-hook
  13891. (lambda ()
  13892. (make-variable-buffer-local 'yas/trigger-key)
  13893. (setq yas/trigger-key [tab])
  13894. (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
  13895. (define-key yas/keymap [tab] 'yas/next-field)))
  13896. @end lisp
  13897. @item @file{windmove.el} by Hovav Shacham
  13898. @cindex @file{windmove.el}
  13899. This package also uses the @kbd{S-<cursor>} keys, so everything written
  13900. in the paragraph above about CUA mode also applies here. If you want make
  13901. the windmove function active in locations where Org mode does not have
  13902. special functionality on @kbd{S-@key{cursor}}, add this to your
  13903. configuration:
  13904. @lisp
  13905. ;; Make windmove work in org-mode:
  13906. (add-hook 'org-shiftup-final-hook 'windmove-up)
  13907. (add-hook 'org-shiftleft-final-hook 'windmove-left)
  13908. (add-hook 'org-shiftdown-final-hook 'windmove-down)
  13909. (add-hook 'org-shiftright-final-hook 'windmove-right)
  13910. @end lisp
  13911. @item @file{viper.el} by Michael Kifer
  13912. @cindex @file{viper.el}
  13913. @kindex C-c /
  13914. Viper uses @kbd{C-c /} and therefore makes this key not access the
  13915. corresponding Org mode command @code{org-sparse-tree}. You need to find
  13916. another key for this command, or override the key in
  13917. @var{viper-vi-global-user-map} with
  13918. @lisp
  13919. (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
  13920. @end lisp
  13921. @end table
  13922. @node org-crypt.el, , Interaction, Miscellaneous
  13923. @section org-crypt.el
  13924. @cindex @file{org-crypt.el}
  13925. @cindex @code{org-decrypt-entry}
  13926. Org-crypt will encrypt the text of an entry, but not the headline, or
  13927. properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
  13928. files.
  13929. Any text below a headline that has a @samp{:crypt:} tag will be automatically
  13930. be encrypted when the file is saved. If you want to use a different tag just
  13931. customize the @var{org-crypt-tag-matcher} setting.
  13932. To use org-crypt it is suggested that you have the following in your
  13933. @file{.emacs}:
  13934. @lisp
  13935. (require 'org-crypt)
  13936. (org-crypt-use-before-save-magic)
  13937. (setq org-tags-exclude-from-inheritance (quote ("crypt")))
  13938. (setq org-crypt-key nil)
  13939. ;; GPG key to use for encryption
  13940. ;; Either the Key ID or set to nil to use symmetric encryption.
  13941. (setq auto-save-default nil)
  13942. ;; Auto-saving does not cooperate with org-crypt.el: so you need
  13943. ;; to turn it off if you plan to use org-crypt.el quite often.
  13944. ;; Otherwise, you'll get an (annoying) message each time you
  13945. ;; start Org.
  13946. ;; To turn it off only locally, you can insert this:
  13947. ;;
  13948. ;; # -*- buffer-auto-save-file-name: nil; -*-
  13949. @end lisp
  13950. Excluding the crypt tag from inheritance prevents already encrypted text
  13951. being encrypted again.
  13952. @node Hacking, MobileOrg, Miscellaneous, Top
  13953. @appendix Hacking
  13954. @cindex hacking
  13955. This appendix covers some aspects where users can extend the functionality of
  13956. Org.
  13957. @menu
  13958. * Hooks:: How to reach into Org's internals
  13959. * Add-on packages:: Available extensions
  13960. * Adding hyperlink types:: New custom link types
  13961. * Adding export back-ends:: How to write new export back-ends
  13962. * Context-sensitive commands:: How to add functionality to such commands
  13963. * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
  13964. * Dynamic blocks:: Automatically filled blocks
  13965. * Special agenda views:: Customized views
  13966. * Speeding up your agendas:: Tips on how to speed up your agendas
  13967. * Extracting agenda information:: Post-processing of agenda information
  13968. * Using the property API:: Writing programs that use entry properties
  13969. * Using the mapping API:: Mapping over all or selected entries
  13970. @end menu
  13971. @node Hooks, Add-on packages, Hacking, Hacking
  13972. @section Hooks
  13973. @cindex hooks
  13974. Org has a large number of hook variables that can be used to add
  13975. functionality. This appendix about hacking is going to illustrate the
  13976. use of some of them. A complete list of all hooks with documentation is
  13977. maintained by the Worg project and can be found at
  13978. @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
  13979. @node Add-on packages, Adding hyperlink types, Hooks, Hacking
  13980. @section Add-on packages
  13981. @cindex add-on packages
  13982. A large number of add-on packages have been written by various authors.
  13983. These packages are not part of Emacs, but they are distributed as contributed
  13984. packages with the separate release available at @uref{http://orgmode.org}.
  13985. See the @file{contrib/README} file in the source code directory for a list of
  13986. contributed files. You may also find some more information on the Worg page:
  13987. @uref{http://orgmode.org/worg/org-contrib/}.
  13988. @node Adding hyperlink types, Adding export back-ends, Add-on packages, Hacking
  13989. @section Adding hyperlink types
  13990. @cindex hyperlinks, adding new types
  13991. Org has a large number of hyperlink types built-in
  13992. (@pxref{Hyperlinks}). If you would like to add new link types, Org
  13993. provides an interface for doing so. Let's look at an example file,
  13994. @file{org-man.el}, that will add support for creating links like
  13995. @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
  13996. Emacs:
  13997. @lisp
  13998. ;;; org-man.el - Support for links to manpages in Org
  13999. (require 'org)
  14000. (org-add-link-type "man" 'org-man-open)
  14001. (add-hook 'org-store-link-functions 'org-man-store-link)
  14002. (defcustom org-man-command 'man
  14003. "The Emacs command to be used to display a man page."
  14004. :group 'org-link
  14005. :type '(choice (const man) (const woman)))
  14006. (defun org-man-open (path)
  14007. "Visit the manpage on PATH.
  14008. PATH should be a topic that can be thrown at the man command."
  14009. (funcall org-man-command path))
  14010. (defun org-man-store-link ()
  14011. "Store a link to a manpage."
  14012. (when (memq major-mode '(Man-mode woman-mode))
  14013. ;; This is a man page, we do make this link
  14014. (let* ((page (org-man-get-page-name))
  14015. (link (concat "man:" page))
  14016. (description (format "Manpage for %s" page)))
  14017. (org-store-link-props
  14018. :type "man"
  14019. :link link
  14020. :description description))))
  14021. (defun org-man-get-page-name ()
  14022. "Extract the page name from the buffer name."
  14023. ;; This works for both `Man-mode' and `woman-mode'.
  14024. (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
  14025. (match-string 1 (buffer-name))
  14026. (error "Cannot create link to this man page")))
  14027. (provide 'org-man)
  14028. ;;; org-man.el ends here
  14029. @end lisp
  14030. @noindent
  14031. You would activate this new link type in @file{.emacs} with
  14032. @lisp
  14033. (require 'org-man)
  14034. @end lisp
  14035. @noindent
  14036. Let's go through the file and see what it does.
  14037. @enumerate
  14038. @item
  14039. It does @code{(require 'org)} to make sure that @file{org.el} has been
  14040. loaded.
  14041. @item
  14042. The next line calls @var{org-add-link-type} to define a new link type
  14043. with prefix @samp{man}. The call also contains the name of a function
  14044. that will be called to follow such a link.
  14045. @item
  14046. @vindex org-store-link-functions
  14047. The next line adds a function to @var{org-store-link-functions}, in
  14048. order to allow the command @kbd{C-c l} to record a useful link in a
  14049. buffer displaying a man page.
  14050. @end enumerate
  14051. The rest of the file defines the necessary variables and functions.
  14052. First there is a customization variable that determines which Emacs
  14053. command should be used to display man pages. There are two options,
  14054. @code{man} and @code{woman}. Then the function to follow a link is
  14055. defined. It gets the link path as an argument---in this case the link
  14056. path is just a topic for the manual command. The function calls the
  14057. value of @var{org-man-command} to display the man page.
  14058. Finally the function @code{org-man-store-link} is defined. When you try
  14059. to store a link with @kbd{C-c l}, this function will be called to
  14060. try to make a link. The function must first decide if it is supposed to
  14061. create the link for this buffer type; we do this by checking the value
  14062. of the variable @var{major-mode}. If not, the function must exit and
  14063. return the value @code{nil}. If yes, the link is created by getting the
  14064. manual topic from the buffer name and prefixing it with the string
  14065. @samp{man:}. Then it must call the command @var{org-store-link-props}
  14066. and set the @code{:type} and @code{:link} properties. Optionally you
  14067. can also set the @code{:description} property to provide a default for
  14068. the link description when the link is later inserted into an Org
  14069. buffer with @kbd{C-c C-l}.
  14070. When it makes sense for your new link type, you may also define a function
  14071. @code{org-PREFIX-complete-link} that implements special (e.g., completion)
  14072. support for inserting such a link with @kbd{C-c C-l}. Such a function should
  14073. not accept any arguments, and return the full link with prefix.
  14074. @node Adding export back-ends, Context-sensitive commands, Adding hyperlink types, Hacking
  14075. @section Adding export back-ends
  14076. @cindex Export, writing back-ends
  14077. Org 8.0 comes with a completely rewritten export engine which makes it easy
  14078. to write new export back-ends, either from scratch, or from deriving them
  14079. from existing ones.
  14080. Your two entry points are respectively @code{org-export-define-backend} and
  14081. @code{org-export-define-derived-backend}. To grok these functions, you
  14082. should first have a look at @file{ox-latex.el} (for how to define a new
  14083. back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
  14084. back-end from an existing one.
  14085. When creating a new back-end from scratch, the basic idea is to set the name
  14086. of the back-end (as a symbol) and an an alist of elements and export
  14087. functions. On top of this, you will need to set additional keywords like
  14088. @code{:menu-entry} (to display the back-end in the export dispatcher),
  14089. @code{:export-block} (to specify what blocks should not be exported by this
  14090. back-end), and @code{:options-alist} (to let the user set export options that
  14091. are specific to this back-end.)
  14092. Deriving a new back-end is similar, except that you need to set
  14093. @code{:translate-alist} to an alist of export functions that should be used
  14094. instead of the parent back-end functions.
  14095. For a complete reference documentation, see
  14096. @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
  14097. Reference on Worg}.
  14098. @node Context-sensitive commands, Tables in arbitrary syntax, Adding export back-ends, Hacking
  14099. @section Context-sensitive commands
  14100. @cindex context-sensitive commands, hooks
  14101. @cindex add-ons, context-sensitive commands
  14102. @vindex org-ctrl-c-ctrl-c-hook
  14103. Org has several commands that act differently depending on context. The most
  14104. important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
  14105. Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
  14106. Add-ons can tap into this functionality by providing a function that detects
  14107. special context for that add-on and executes functionality appropriate for
  14108. the context. Here is an example from Dan Davison's @file{org-R.el} which
  14109. allows you to evaluate commands based on the @file{R} programming language
  14110. @footnote{@file{org-R.el} has been replaced by the Org mode functionality
  14111. described in @ref{Working With Source Code} and is now obsolete.}. For this
  14112. package, special contexts are lines that start with @code{#+R:} or
  14113. @code{#+RR:}.
  14114. @lisp
  14115. (defun org-R-apply-maybe ()
  14116. "Detect if this is context for org-R and execute R commands."
  14117. (if (save-excursion
  14118. (beginning-of-line 1)
  14119. (looking-at "#\\+RR?:"))
  14120. (progn (call-interactively 'org-R-apply)
  14121. t) ;; to signal that we took action
  14122. nil)) ;; to signal that we did not
  14123. (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
  14124. @end lisp
  14125. The function first checks if the cursor is in such a line. If that is the
  14126. case, @code{org-R-apply} is called and the function returns @code{t} to
  14127. signal that action was taken, and @kbd{C-c C-c} will stop looking for other
  14128. contexts. If the function finds it should do nothing locally, it returns
  14129. @code{nil} so that other, similar functions can have a try.
  14130. @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
  14131. @section Tables and lists in arbitrary syntax
  14132. @cindex tables, in other modes
  14133. @cindex lists, in other modes
  14134. @cindex Orgtbl mode
  14135. Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
  14136. frequent feature request has been to make it work with native tables in
  14137. specific languages, for example @LaTeX{}. However, this is extremely
  14138. hard to do in a general way, would lead to a customization nightmare,
  14139. and would take away much of the simplicity of the Orgtbl mode table
  14140. editor.
  14141. This appendix describes a different approach. We keep the Orgtbl mode
  14142. table in its native format (the @i{source table}), and use a custom
  14143. function to @i{translate} the table to the correct syntax, and to
  14144. @i{install} it in the right location (the @i{target table}). This puts
  14145. the burden of writing conversion functions on the user, but it allows
  14146. for a very flexible system.
  14147. Bastien added the ability to do the same with lists, in Orgstruct mode. You
  14148. can use Org's facilities to edit and structure lists by turning
  14149. @code{orgstruct-mode} on, then locally exporting such lists in another format
  14150. (HTML, @LaTeX{} or Texinfo.)
  14151. @menu
  14152. * Radio tables:: Sending and receiving radio tables
  14153. * A @LaTeX{} example:: Step by step, almost a tutorial
  14154. * Translator functions:: Copy and modify
  14155. * Radio lists:: Sending and receiving lists
  14156. @end menu
  14157. @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
  14158. @subsection Radio tables
  14159. @cindex radio tables
  14160. To define the location of the target table, you first need to create two
  14161. lines that are comments in the current mode, but contain magic words for
  14162. Orgtbl mode to find. Orgtbl mode will insert the translated table
  14163. between these lines, replacing whatever was there before. For example:
  14164. @example
  14165. /* BEGIN RECEIVE ORGTBL table_name */
  14166. /* END RECEIVE ORGTBL table_name */
  14167. @end example
  14168. @noindent
  14169. Just above the source table, we put a special line that tells
  14170. Orgtbl mode how to translate this table and where to install it. For
  14171. example:
  14172. @cindex #+ORGTBL
  14173. @example
  14174. #+ORGTBL: SEND table_name translation_function arguments....
  14175. @end example
  14176. @noindent
  14177. @code{table_name} is the reference name for the table that is also used
  14178. in the receiver lines. @code{translation_function} is the Lisp function
  14179. that does the translation. Furthermore, the line can contain a list of
  14180. arguments (alternating key and value) at the end. The arguments will be
  14181. passed as a property list to the translation function for
  14182. interpretation. A few standard parameters are already recognized and
  14183. acted upon before the translation function is called:
  14184. @table @code
  14185. @item :skip N
  14186. Skip the first N lines of the table. Hlines do count as separate lines for
  14187. this parameter!
  14188. @item :skipcols (n1 n2 ...)
  14189. List of columns that should be skipped. If the table has a column with
  14190. calculation marks, that column is automatically discarded as well.
  14191. Please note that the translator function sees the table @emph{after} the
  14192. removal of these columns, the function never knows that there have been
  14193. additional columns.
  14194. @item :no-escape t
  14195. When non-@code{nil}, do not escape special characters @code{&%#_^} when exporting
  14196. the table. The default value is @code{nil}.
  14197. @end table
  14198. @noindent
  14199. The one problem remaining is how to keep the source table in the buffer
  14200. without disturbing the normal workings of the file, for example during
  14201. compilation of a C file or processing of a @LaTeX{} file. There are a
  14202. number of different solutions:
  14203. @itemize @bullet
  14204. @item
  14205. The table could be placed in a block comment if that is supported by the
  14206. language. For example, in C mode you could wrap the table between
  14207. @samp{/*} and @samp{*/} lines.
  14208. @item
  14209. Sometimes it is possible to put the table after some kind of @i{END}
  14210. statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
  14211. in @LaTeX{}.
  14212. @item
  14213. You can just comment the table line-by-line whenever you want to process
  14214. the file, and uncomment it whenever you need to edit the table. This
  14215. only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
  14216. makes this comment-toggling very easy, in particular if you bind it to a
  14217. key.
  14218. @end itemize
  14219. @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
  14220. @subsection A @LaTeX{} example of radio tables
  14221. @cindex @LaTeX{}, and Orgtbl mode
  14222. The best way to wrap the source table in @LaTeX{} is to use the
  14223. @code{comment} environment provided by @file{comment.sty}. It has to be
  14224. activated by placing @code{\usepackage@{comment@}} into the document
  14225. header. Orgtbl mode can insert a radio table skeleton@footnote{By
  14226. default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
  14227. variable @var{orgtbl-radio-tables} to install templates for other
  14228. modes.} with the command @kbd{M-x orgtbl-insert-radio-table RET}. You will
  14229. be prompted for a table name, let's say we use @samp{salesfigures}. You
  14230. will then get the following template:
  14231. @cindex #+ORGTBL, SEND
  14232. @example
  14233. % BEGIN RECEIVE ORGTBL salesfigures
  14234. % END RECEIVE ORGTBL salesfigures
  14235. \begin@{comment@}
  14236. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  14237. | | |
  14238. \end@{comment@}
  14239. @end example
  14240. @noindent
  14241. @vindex @LaTeX{}-verbatim-environments
  14242. The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
  14243. @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
  14244. into the receiver location with name @code{salesfigures}. You may now
  14245. fill in the table---feel free to use the spreadsheet features@footnote{If
  14246. the @samp{#+TBLFM} line contains an odd number of dollar characters,
  14247. this may cause problems with font-lock in @LaTeX{} mode. As shown in the
  14248. example you can fix this by adding an extra line inside the
  14249. @code{comment} environment that is used to balance the dollar
  14250. expressions. If you are using AUC@TeX{} with the font-latex library, a
  14251. much better solution is to add the @code{comment} environment to the
  14252. variable @var{LaTeX-verbatim-environments}.}:
  14253. @example
  14254. % BEGIN RECEIVE ORGTBL salesfigures
  14255. % END RECEIVE ORGTBL salesfigures
  14256. \begin@{comment@}
  14257. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  14258. | Month | Days | Nr sold | per day |
  14259. |-------+------+---------+---------|
  14260. | Jan | 23 | 55 | 2.4 |
  14261. | Feb | 21 | 16 | 0.8 |
  14262. | March | 22 | 278 | 12.6 |
  14263. #+TBLFM: $4=$3/$2;%.1f
  14264. % $ (optional extra dollar to keep font-lock happy, see footnote)
  14265. \end@{comment@}
  14266. @end example
  14267. @noindent
  14268. When you are done, press @kbd{C-c C-c} in the table to get the converted
  14269. table inserted between the two marker lines.
  14270. Now let's assume you want to make the table header by hand, because you
  14271. want to control how columns are aligned, etc. In this case we make sure
  14272. that the table translator skips the first 2 lines of the source
  14273. table, and tell the command to work as a @i{splice}, i.e., to not produce
  14274. header and footer commands of the target table:
  14275. @example
  14276. \begin@{tabular@}@{lrrr@}
  14277. Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
  14278. % BEGIN RECEIVE ORGTBL salesfigures
  14279. % END RECEIVE ORGTBL salesfigures
  14280. \end@{tabular@}
  14281. %
  14282. \begin@{comment@}
  14283. #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
  14284. | Month | Days | Nr sold | per day |
  14285. |-------+------+---------+---------|
  14286. | Jan | 23 | 55 | 2.4 |
  14287. | Feb | 21 | 16 | 0.8 |
  14288. | March | 22 | 278 | 12.6 |
  14289. #+TBLFM: $4=$3/$2;%.1f
  14290. \end@{comment@}
  14291. @end example
  14292. The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
  14293. Orgtbl mode. It uses a @code{tabular} environment to typeset the table
  14294. and marks horizontal lines with @code{\hline}. Furthermore, it
  14295. interprets the following parameters (see also @pxref{Translator functions}):
  14296. @table @code
  14297. @item :splice nil/t
  14298. When set to t, return only table body lines, don't wrap them into a
  14299. tabular environment. Default is @code{nil}.
  14300. @item :fmt fmt
  14301. A format to be used to wrap each field, it should contain @code{%s} for the
  14302. original field value. For example, to wrap each field value in dollars,
  14303. you could use @code{:fmt "$%s$"}. This may also be a property list with
  14304. column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
  14305. A function of one argument can be used in place of the strings; the
  14306. function must return a formatted string.
  14307. @item :efmt efmt
  14308. Use this format to print numbers with exponentials. The format should
  14309. have @code{%s} twice for inserting mantissa and exponent, for example
  14310. @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
  14311. may also be a property list with column numbers and formats, for example
  14312. @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
  14313. @code{efmt} has been applied to a value, @code{fmt} will also be
  14314. applied. Similar to @code{fmt}, functions of two arguments can be
  14315. supplied instead of strings.
  14316. @end table
  14317. @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
  14318. @subsection Translator functions
  14319. @cindex HTML, and Orgtbl mode
  14320. @cindex translator function
  14321. Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
  14322. (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
  14323. @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
  14324. Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
  14325. code that produces tables during HTML export.}, these all use a generic
  14326. translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
  14327. itself is a very short function that computes the column definitions for the
  14328. @code{tabular} environment, defines a few field and line separators and then
  14329. hands processing over to the generic translator. Here is the entire code:
  14330. @lisp
  14331. @group
  14332. (defun orgtbl-to-latex (table params)
  14333. "Convert the Orgtbl mode TABLE to LaTeX."
  14334. (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
  14335. org-table-last-alignment ""))
  14336. (params2
  14337. (list
  14338. :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
  14339. :tend "\\end@{tabular@}"
  14340. :lstart "" :lend " \\\\" :sep " & "
  14341. :efmt "%s\\,(%s)" :hline "\\hline")))
  14342. (orgtbl-to-generic table (org-combine-plists params2 params))))
  14343. @end group
  14344. @end lisp
  14345. As you can see, the properties passed into the function (variable
  14346. @var{PARAMS}) are combined with the ones newly defined in the function
  14347. (variable @var{PARAMS2}). The ones passed into the function (i.e., the
  14348. ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
  14349. would like to use the @LaTeX{} translator, but wanted the line endings to
  14350. be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
  14351. overrule the default with
  14352. @example
  14353. #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
  14354. @end example
  14355. For a new language, you can either write your own converter function in
  14356. analogy with the @LaTeX{} translator, or you can use the generic function
  14357. directly. For example, if you have a language where a table is started
  14358. with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
  14359. started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
  14360. separator is a TAB, you could call the generic translator like this (on
  14361. a single line!):
  14362. @example
  14363. #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
  14364. :lstart "!BL! " :lend " !EL!" :sep "\t"
  14365. @end example
  14366. @noindent
  14367. Please check the documentation string of the function
  14368. @code{orgtbl-to-generic} for a full list of parameters understood by
  14369. that function, and remember that you can pass each of them into
  14370. @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
  14371. using the generic function.
  14372. Of course you can also write a completely new function doing complicated
  14373. things the generic translator cannot do. A translator function takes
  14374. two arguments. The first argument is the table, a list of lines, each
  14375. line either the symbol @code{hline} or a list of fields. The second
  14376. argument is the property list containing all parameters specified in the
  14377. @samp{#+ORGTBL: SEND} line. The function must return a single string
  14378. containing the formatted table. If you write a generally useful
  14379. translator, please post it on @email{emacs-orgmode@@gnu.org} so that
  14380. others can benefit from your work.
  14381. @node Radio lists, , Translator functions, Tables in arbitrary syntax
  14382. @subsection Radio lists
  14383. @cindex radio lists
  14384. @cindex org-list-insert-radio-list
  14385. Sending and receiving radio lists works exactly the same way as sending and
  14386. receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
  14387. insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
  14388. @code{org-list-insert-radio-list}.
  14389. Here are the differences with radio tables:
  14390. @itemize @minus
  14391. @item
  14392. Orgstruct mode must be active.
  14393. @item
  14394. Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
  14395. @item
  14396. The available translation functions for radio lists don't take
  14397. parameters.
  14398. @item
  14399. @kbd{C-c C-c} will work when pressed on the first item of the list.
  14400. @end itemize
  14401. Here is a @LaTeX{} example. Let's say that you have this in your
  14402. @LaTeX{} file:
  14403. @cindex #+ORGLST
  14404. @example
  14405. % BEGIN RECEIVE ORGLST to-buy
  14406. % END RECEIVE ORGLST to-buy
  14407. \begin@{comment@}
  14408. #+ORGLST: SEND to-buy org-list-to-latex
  14409. - a new house
  14410. - a new computer
  14411. + a new keyboard
  14412. + a new mouse
  14413. - a new life
  14414. \end@{comment@}
  14415. @end example
  14416. Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
  14417. @LaTeX{} list between the two marker lines.
  14418. @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
  14419. @section Dynamic blocks
  14420. @cindex dynamic blocks
  14421. Org documents can contain @emph{dynamic blocks}. These are
  14422. specially marked regions that are updated by some user-written function.
  14423. A good example for such a block is the clock table inserted by the
  14424. command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
  14425. Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
  14426. to the block and can also specify parameters for the function producing
  14427. the content of the block.
  14428. @cindex #+BEGIN:dynamic block
  14429. @example
  14430. #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
  14431. #+END:
  14432. @end example
  14433. Dynamic blocks are updated with the following commands
  14434. @table @kbd
  14435. @orgcmd{C-c C-x C-u,org-dblock-update}
  14436. Update dynamic block at point.
  14437. @orgkey{C-u C-c C-x C-u}
  14438. Update all dynamic blocks in the current file.
  14439. @end table
  14440. Updating a dynamic block means to remove all the text between BEGIN and
  14441. END, parse the BEGIN line for parameters and then call the specific
  14442. writer function for this block to insert the new content. If you want
  14443. to use the original content in the writer function, you can use the
  14444. extra parameter @code{:content}.
  14445. For a block with name @code{myblock}, the writer function is
  14446. @code{org-dblock-write:myblock} with as only parameter a property list
  14447. with the parameters given in the begin line. Here is a trivial example
  14448. of a block that keeps track of when the block update function was last
  14449. run:
  14450. @example
  14451. #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
  14452. #+END:
  14453. @end example
  14454. @noindent
  14455. The corresponding block writer function could look like this:
  14456. @lisp
  14457. (defun org-dblock-write:block-update-time (params)
  14458. (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
  14459. (insert "Last block update at: "
  14460. (format-time-string fmt (current-time)))))
  14461. @end lisp
  14462. If you want to make sure that all dynamic blocks are always up-to-date,
  14463. you could add the function @code{org-update-all-dblocks} to a hook, for
  14464. example @var{before-save-hook}. @code{org-update-all-dblocks} is
  14465. written in a way such that it does nothing in buffers that are not in
  14466. @code{org-mode}.
  14467. You can narrow the current buffer to the current dynamic block (like any
  14468. other block) with @code{org-narrow-to-block}.
  14469. @node Special agenda views, Speeding up your agendas, Dynamic blocks, Hacking
  14470. @section Special agenda views
  14471. @cindex agenda views, user-defined
  14472. @vindex org-agenda-skip-function
  14473. @vindex org-agenda-skip-function-global
  14474. Org provides a special hook that can be used to narrow down the selection
  14475. made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
  14476. @code{agenda*} view is the same than @code{agenda} except that it only
  14477. considers @emph{appointments}, i.e., scheduled and deadline items that have a
  14478. time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
  14479. @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}. You may
  14480. specify a function that is used at each match to verify if the match should
  14481. indeed be part of the agenda view, and if not, how much should be skipped.
  14482. You can specify a global condition that will be applied to all agenda views,
  14483. this condition would be stored in the variable
  14484. @var{org-agenda-skip-function-global}. More commonly, such a definition is
  14485. applied only to specific custom searches, using
  14486. @var{org-agenda-skip-function}.
  14487. Let's say you want to produce a list of projects that contain a WAITING
  14488. tag anywhere in the project tree. Let's further assume that you have
  14489. marked all tree headings that define a project with the TODO keyword
  14490. PROJECT@. In this case you would run a TODO search for the keyword
  14491. PROJECT, but skip the match unless there is a WAITING tag anywhere in
  14492. the subtree belonging to the project line.
  14493. To achieve this, you must write a function that searches the subtree for
  14494. the tag. If the tag is found, the function must return @code{nil} to
  14495. indicate that this match should not be skipped. If there is no such
  14496. tag, return the location of the end of the subtree, to indicate that
  14497. search should continue from there.
  14498. @lisp
  14499. (defun my-skip-unless-waiting ()
  14500. "Skip trees that are not waiting"
  14501. (let ((subtree-end (save-excursion (org-end-of-subtree t))))
  14502. (if (re-search-forward ":waiting:" subtree-end t)
  14503. nil ; tag found, do not skip
  14504. subtree-end))) ; tag not found, continue after end of subtree
  14505. @end lisp
  14506. Now you may use this function in an agenda custom command, for example
  14507. like this:
  14508. @lisp
  14509. (org-add-agenda-custom-command
  14510. '("b" todo "PROJECT"
  14511. ((org-agenda-skip-function 'my-skip-unless-waiting)
  14512. (org-agenda-overriding-header "Projects waiting for something: "))))
  14513. @end lisp
  14514. @vindex org-agenda-overriding-header
  14515. Note that this also binds @var{org-agenda-overriding-header} to get a
  14516. meaningful header in the agenda view.
  14517. @vindex org-odd-levels-only
  14518. @vindex org-agenda-skip-function
  14519. A general way to create custom searches is to base them on a search for
  14520. entries with a certain level limit. If you want to study all entries with
  14521. your custom search function, simply do a search for
  14522. @samp{LEVEL>0}@footnote{Note that, when using @var{org-odd-levels-only}, a
  14523. level number corresponds to order in the hierarchy, not to the number of
  14524. stars.}, and then use @var{org-agenda-skip-function} to select the entries
  14525. you really want to have.
  14526. You may also put a Lisp form into @var{org-agenda-skip-function}. In
  14527. particular, you may use the functions @code{org-agenda-skip-entry-if}
  14528. and @code{org-agenda-skip-subtree-if} in this form, for example:
  14529. @table @code
  14530. @item (org-agenda-skip-entry-if 'scheduled)
  14531. Skip current entry if it has been scheduled.
  14532. @item (org-agenda-skip-entry-if 'notscheduled)
  14533. Skip current entry if it has not been scheduled.
  14534. @item (org-agenda-skip-entry-if 'deadline)
  14535. Skip current entry if it has a deadline.
  14536. @item (org-agenda-skip-entry-if 'scheduled 'deadline)
  14537. Skip current entry if it has a deadline, or if it is scheduled.
  14538. @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
  14539. Skip current entry if the TODO keyword is TODO or WAITING.
  14540. @item (org-agenda-skip-entry-if 'todo 'done)
  14541. Skip current entry if the TODO keyword marks a DONE state.
  14542. @item (org-agenda-skip-entry-if 'timestamp)
  14543. Skip current entry if it has any timestamp, may also be deadline or scheduled.
  14544. @anchor{x-agenda-skip-entry-regexp}
  14545. @item (org-agenda-skip-entry-if 'regexp "regular expression")
  14546. Skip current entry if the regular expression matches in the entry.
  14547. @item (org-agenda-skip-entry-if 'notregexp "regular expression")
  14548. Skip current entry unless the regular expression matches.
  14549. @item (org-agenda-skip-subtree-if 'regexp "regular expression")
  14550. Same as above, but check and skip the entire subtree.
  14551. @end table
  14552. Therefore we could also have written the search for WAITING projects
  14553. like this, even without defining a special function:
  14554. @lisp
  14555. (org-add-agenda-custom-command
  14556. '("b" todo "PROJECT"
  14557. ((org-agenda-skip-function '(org-agenda-skip-subtree-if
  14558. 'regexp ":waiting:"))
  14559. (org-agenda-overriding-header "Projects waiting for something: "))))
  14560. @end lisp
  14561. @node Speeding up your agendas, Extracting agenda information, Special agenda views, Hacking
  14562. @section Speeding up your agendas
  14563. @cindex agenda views, optimization
  14564. When your Org files grow in both number and size, agenda commands may start
  14565. to become slow. Below are some tips on how to speed up the agenda commands.
  14566. @enumerate
  14567. @item
  14568. Reduce the number of Org agenda files: this will reduce the slowliness caused
  14569. by accessing to a hard drive.
  14570. @item
  14571. Reduce the number of DONE and archived headlines: this way the agenda does
  14572. not need to skip them.
  14573. @item
  14574. @vindex org-agenda-dim-blocked-tasks
  14575. Inhibit the dimming of blocked tasks:
  14576. @lisp
  14577. (setq org-agenda-dim-blocked-tasks nil)
  14578. @end lisp
  14579. @item
  14580. @vindex org-startup-folded
  14581. @vindex org-agenda-inhibit-startup
  14582. Inhibit agenda files startup options:
  14583. @lisp
  14584. (setq org-agenda-inhibit-startup nil)
  14585. @end lisp
  14586. @item
  14587. @vindex org-agenda-show-inherited-tags
  14588. @vindex org-agenda-use-tag-inheritance
  14589. Disable tag inheritance in agenda:
  14590. @lisp
  14591. (setq org-agenda-use-tag-inheritance nil)
  14592. @end lisp
  14593. @end enumerate
  14594. You can set these options for specific agenda views only. See the docstrings
  14595. of these variables for details on why they affect the agenda generation, and
  14596. this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
  14597. page} for further explanations.
  14598. @node Extracting agenda information, Using the property API, Speeding up your agendas, Hacking
  14599. @section Extracting agenda information
  14600. @cindex agenda, pipe
  14601. @cindex Scripts, for agenda processing
  14602. @vindex org-agenda-custom-commands
  14603. Org provides commands to access agenda information for the command
  14604. line in Emacs batch mode. This extracted information can be sent
  14605. directly to a printer, or it can be read by a program that does further
  14606. processing of the data. The first of these commands is the function
  14607. @code{org-batch-agenda}, that produces an agenda view and sends it as
  14608. ASCII text to STDOUT@. The command takes a single string as parameter.
  14609. If the string has length 1, it is used as a key to one of the commands
  14610. you have configured in @var{org-agenda-custom-commands}, basically any
  14611. key you can use after @kbd{C-c a}. For example, to directly print the
  14612. current TODO list, you could use
  14613. @example
  14614. emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
  14615. @end example
  14616. If the parameter is a string with 2 or more characters, it is used as a
  14617. tags/TODO match string. For example, to print your local shopping list
  14618. (all items with the tag @samp{shop}, but excluding the tag
  14619. @samp{NewYork}), you could use
  14620. @example
  14621. emacs -batch -l ~/.emacs \
  14622. -eval '(org-batch-agenda "+shop-NewYork")' | lpr
  14623. @end example
  14624. @noindent
  14625. You may also modify parameters on the fly like this:
  14626. @example
  14627. emacs -batch -l ~/.emacs \
  14628. -eval '(org-batch-agenda "a" \
  14629. org-agenda-span (quote month) \
  14630. org-agenda-include-diary nil \
  14631. org-agenda-files (quote ("~/org/project.org")))' \
  14632. | lpr
  14633. @end example
  14634. @noindent
  14635. which will produce a 30-day agenda, fully restricted to the Org file
  14636. @file{~/org/projects.org}, not even including the diary.
  14637. If you want to process the agenda data in more sophisticated ways, you
  14638. can use the command @code{org-batch-agenda-csv} to get a comma-separated
  14639. list of values for each agenda item. Each line in the output will
  14640. contain a number of fields separated by commas. The fields in a line
  14641. are:
  14642. @example
  14643. category @r{The category of the item}
  14644. head @r{The headline, without TODO keyword, TAGS and PRIORITY}
  14645. type @r{The type of the agenda entry, can be}
  14646. todo @r{selected in TODO match}
  14647. tagsmatch @r{selected in tags match}
  14648. diary @r{imported from diary}
  14649. deadline @r{a deadline}
  14650. scheduled @r{scheduled}
  14651. timestamp @r{appointment, selected by timestamp}
  14652. closed @r{entry was closed on date}
  14653. upcoming-deadline @r{warning about nearing deadline}
  14654. past-scheduled @r{forwarded scheduled item}
  14655. block @r{entry has date block including date}
  14656. todo @r{The TODO keyword, if any}
  14657. tags @r{All tags including inherited ones, separated by colons}
  14658. date @r{The relevant date, like 2007-2-14}
  14659. time @r{The time, like 15:00-16:50}
  14660. extra @r{String with extra planning info}
  14661. priority-l @r{The priority letter if any was given}
  14662. priority-n @r{The computed numerical priority}
  14663. @end example
  14664. @noindent
  14665. Time and date will only be given if a timestamp (or deadline/scheduled)
  14666. led to the selection of the item.
  14667. A CSV list like this is very easy to use in a post-processing script.
  14668. For example, here is a Perl program that gets the TODO list from
  14669. Emacs/Org and prints all the items, preceded by a checkbox:
  14670. @example
  14671. #!/usr/bin/perl
  14672. # define the Emacs command to run
  14673. $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
  14674. # run it and capture the output
  14675. $agenda = qx@{$cmd 2>/dev/null@};
  14676. # loop over all lines
  14677. foreach $line (split(/\n/,$agenda)) @{
  14678. # get the individual values
  14679. ($category,$head,$type,$todo,$tags,$date,$time,$extra,
  14680. $priority_l,$priority_n) = split(/,/,$line);
  14681. # process and print
  14682. print "[ ] $head\n";
  14683. @}
  14684. @end example
  14685. @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
  14686. @section Using the property API
  14687. @cindex API, for properties
  14688. @cindex properties, API
  14689. Here is a description of the functions that can be used to work with
  14690. properties.
  14691. @defun org-entry-properties &optional pom which
  14692. Get all properties of the entry at point-or-marker POM.@*
  14693. This includes the TODO keyword, the tags, time strings for deadline,
  14694. scheduled, and clocking, and any additional properties defined in the
  14695. entry. The return value is an alist. Keys may occur multiple times
  14696. if the property key was used several times.@*
  14697. POM may also be @code{nil}, in which case the current entry is used.
  14698. If WHICH is @code{nil} or `all', get all properties. If WHICH is
  14699. `special' or `standard', only get that subclass.
  14700. @end defun
  14701. @vindex org-use-property-inheritance
  14702. @findex org-insert-property-drawer
  14703. @defun org-entry-get pom property &optional inherit
  14704. Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@. By default,
  14705. this only looks at properties defined locally in the entry. If @code{INHERIT}
  14706. is non-@code{nil} and the entry does not have the property, then also check
  14707. higher levels of the hierarchy. If @code{INHERIT} is the symbol
  14708. @code{selective}, use inheritance if and only if the setting of
  14709. @var{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
  14710. @end defun
  14711. @defun org-entry-delete pom property
  14712. Delete the property @code{PROPERTY} from entry at point-or-marker POM.
  14713. @end defun
  14714. @defun org-entry-put pom property value
  14715. Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
  14716. @end defun
  14717. @defun org-buffer-property-keys &optional include-specials
  14718. Get all property keys in the current buffer.
  14719. @end defun
  14720. @defun org-insert-property-drawer
  14721. Insert a property drawer for the current entry. Also
  14722. @end defun
  14723. @defun org-entry-put-multivalued-property pom property &rest values
  14724. Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
  14725. @code{VALUES} should be a list of strings. They will be concatenated, with
  14726. spaces as separators.
  14727. @end defun
  14728. @defun org-entry-get-multivalued-property pom property
  14729. Treat the value of the property @code{PROPERTY} as a whitespace-separated
  14730. list of values and return the values as a list of strings.
  14731. @end defun
  14732. @defun org-entry-add-to-multivalued-property pom property value
  14733. Treat the value of the property @code{PROPERTY} as a whitespace-separated
  14734. list of values and make sure that @code{VALUE} is in this list.
  14735. @end defun
  14736. @defun org-entry-remove-from-multivalued-property pom property value
  14737. Treat the value of the property @code{PROPERTY} as a whitespace-separated
  14738. list of values and make sure that @code{VALUE} is @emph{not} in this list.
  14739. @end defun
  14740. @defun org-entry-member-in-multivalued-property pom property value
  14741. Treat the value of the property @code{PROPERTY} as a whitespace-separated
  14742. list of values and check if @code{VALUE} is in this list.
  14743. @end defun
  14744. @defopt org-property-allowed-value-functions
  14745. Hook for functions supplying allowed values for a specific property.
  14746. The functions must take a single argument, the name of the property, and
  14747. return a flat list of allowed values. If @samp{:ETC} is one of
  14748. the values, use the values as completion help, but allow also other values
  14749. to be entered. The functions must return @code{nil} if they are not
  14750. responsible for this property.
  14751. @end defopt
  14752. @node Using the mapping API, , Using the property API, Hacking
  14753. @section Using the mapping API
  14754. @cindex API, for mapping
  14755. @cindex mapping entries, API
  14756. Org has sophisticated mapping capabilities to find all entries satisfying
  14757. certain criteria. Internally, this functionality is used to produce agenda
  14758. views, but there is also an API that can be used to execute arbitrary
  14759. functions for each or selected entries. The main entry point for this API
  14760. is:
  14761. @defun org-map-entries func &optional match scope &rest skip
  14762. Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
  14763. @code{FUNC} is a function or a Lisp form. The function will be called
  14764. without arguments, with the cursor positioned at the beginning of the
  14765. headline. The return values of all calls to the function will be collected
  14766. and returned as a list.
  14767. The call to @code{FUNC} will be wrapped into a save-excursion form, so
  14768. @code{FUNC} does not need to preserve point. After evaluation, the cursor
  14769. will be moved to the end of the line (presumably of the headline of the
  14770. processed entry) and search continues from there. Under some circumstances,
  14771. this may not produce the wanted results. For example, if you have removed
  14772. (e.g., archived) the current (sub)tree it could mean that the next entry will
  14773. be skipped entirely. In such cases, you can specify the position from where
  14774. search should continue by making @code{FUNC} set the variable
  14775. @var{org-map-continue-from} to the desired buffer position.
  14776. @code{MATCH} is a tags/property/todo match as it is used in the agenda match
  14777. view. Only headlines that are matched by this query will be considered
  14778. during the iteration. When @code{MATCH} is @code{nil} or @code{t}, all
  14779. headlines will be visited by the iteration.
  14780. @code{SCOPE} determines the scope of this command. It can be any of:
  14781. @example
  14782. nil @r{the current buffer, respecting the restriction if any}
  14783. tree @r{the subtree started with the entry at point}
  14784. region @r{The entries within the active region, if any}
  14785. file @r{the current buffer, without restriction}
  14786. file-with-archives
  14787. @r{the current buffer, and any archives associated with it}
  14788. agenda @r{all agenda files}
  14789. agenda-with-archives
  14790. @r{all agenda files with any archive files associated with them}
  14791. (file1 file2 ...)
  14792. @r{if this is a list, all files in the list will be scanned}
  14793. @end example
  14794. @noindent
  14795. The remaining args are treated as settings for the skipping facilities of
  14796. the scanner. The following items can be given here:
  14797. @vindex org-agenda-skip-function
  14798. @example
  14799. archive @r{skip trees with the archive tag}
  14800. comment @r{skip trees with the COMMENT keyword}
  14801. function or Lisp form
  14802. @r{will be used as value for @var{org-agenda-skip-function},}
  14803. @r{so whenever the function returns t, FUNC}
  14804. @r{will not be called for that entry and search will}
  14805. @r{continue from the point where the function leaves it}
  14806. @end example
  14807. @end defun
  14808. The function given to that mapping routine can really do anything you like.
  14809. It can use the property API (@pxref{Using the property API}) to gather more
  14810. information about the entry, or in order to change metadata in the entry.
  14811. Here are a couple of functions that might be handy:
  14812. @defun org-todo &optional arg
  14813. Change the TODO state of the entry. See the docstring of the functions for
  14814. the many possible values for the argument @code{ARG}.
  14815. @end defun
  14816. @defun org-priority &optional action
  14817. Change the priority of the entry. See the docstring of this function for the
  14818. possible values for @code{ACTION}.
  14819. @end defun
  14820. @defun org-toggle-tag tag &optional onoff
  14821. Toggle the tag @code{TAG} in the current entry. Setting @code{ONOFF} to
  14822. either @code{on} or @code{off} will not toggle tag, but ensure that it is
  14823. either on or off.
  14824. @end defun
  14825. @defun org-promote
  14826. Promote the current entry.
  14827. @end defun
  14828. @defun org-demote
  14829. Demote the current entry.
  14830. @end defun
  14831. Here is a simple example that will turn all entries in the current file with
  14832. a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
  14833. Entries in comment trees and in archive trees will be ignored.
  14834. @lisp
  14835. (org-map-entries
  14836. '(org-todo "UPCOMING")
  14837. "+TOMORROW" 'file 'archive 'comment)
  14838. @end lisp
  14839. The following example counts the number of entries with TODO keyword
  14840. @code{WAITING}, in all agenda files.
  14841. @lisp
  14842. (length (org-map-entries t "/+WAITING" 'agenda))
  14843. @end lisp
  14844. @node MobileOrg, History and Acknowledgments, Hacking, Top
  14845. @appendix MobileOrg
  14846. @cindex iPhone
  14847. @cindex MobileOrg
  14848. @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
  14849. available for iOS and for Android. @i{MobileOrg} offers offline viewing and
  14850. capture support for an Org mode system rooted on a ``real'' computer. It
  14851. does also allow you to record changes to existing entries.
  14852. The @uref{http://mobileorg.ncogni.to/, iOS implementation} for the
  14853. @i{iPhone/iPod Touch/iPad} series of devices, was developed by Richard
  14854. Moreland. Android users should check out
  14855. @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
  14856. by Matt Jones. The two implementations are not identical but offer similar
  14857. features.
  14858. This appendix describes the support Org has for creating agenda views in a
  14859. format that can be displayed by @i{MobileOrg}, and for integrating notes
  14860. captured and changes made by @i{MobileOrg} into the main system.
  14861. For changing tags and TODO states in MobileOrg, you should have set up the
  14862. customization variables @var{org-todo-keywords} and @var{org-tag-alist} to
  14863. cover all important tags and TODO keywords, even if individual files use only
  14864. part of these. MobileOrg will also offer you states and tags set up with
  14865. in-buffer settings, but it will understand the logistics of TODO state
  14866. @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
  14867. (@pxref{Setting tags}) only for those set in these variables.
  14868. @menu
  14869. * Setting up the staging area:: Where to interact with the mobile device
  14870. * Pushing to MobileOrg:: Uploading Org files and agendas
  14871. * Pulling from MobileOrg:: Integrating captured and flagged items
  14872. @end menu
  14873. @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
  14874. @section Setting up the staging area
  14875. MobileOrg needs to interact with Emacs through a directory on a server. If you
  14876. are using a public server, you should consider to encrypt the files that are
  14877. uploaded to the server. This can be done with Org mode 7.02 and with
  14878. @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
  14879. installation on your system. To turn on encryption, set a password in
  14880. @i{MobileOrg} and, on the Emacs side, configure the variable
  14881. @var{org-mobile-use-encryption}@footnote{If you can safely store the
  14882. password in your Emacs setup, you might also want to configure
  14883. @var{org-mobile-encryption-password}. Please read the docstring of that
  14884. variable. Note that encryption will apply only to the contents of the
  14885. @file{.org} files. The file names themselves will remain visible.}.
  14886. The easiest way to create that directory is to use a free
  14887. @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
  14888. Dropbox, or if your version of MobileOrg does not support it, you can use a
  14889. webdav server. For more information, check out the documentation of MobileOrg and also this
  14890. @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
  14891. When MobileOrg first connects to your Dropbox, it will create a directory
  14892. @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
  14893. Emacs about it:
  14894. @lisp
  14895. (setq org-mobile-directory "~/Dropbox/MobileOrg")
  14896. @end lisp
  14897. Org mode has commands to put files for @i{MobileOrg} into that directory,
  14898. and to read captured notes from there.
  14899. @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
  14900. @section Pushing to MobileOrg
  14901. This operation copies all files currently listed in @var{org-mobile-files}
  14902. to the directory @var{org-mobile-directory}. By default this list contains
  14903. all agenda files (as listed in @var{org-agenda-files}), but additional files
  14904. can be included by customizing @var{org-mobile-files}. File names will be
  14905. staged with paths relative to @var{org-directory}, so all files should be
  14906. inside this directory@footnote{Symbolic links in @var{org-directory} need to
  14907. have the same name than their targets.}.
  14908. The push operation also creates a special Org file @file{agendas.org} with
  14909. all custom agenda view defined by the user@footnote{While creating the
  14910. agendas, Org mode will force ID properties on all referenced entries, so that
  14911. these entries can be uniquely identified if @i{MobileOrg} flags them for
  14912. further action. If you do not want to get these properties in so many
  14913. entries, you can set the variable @var{org-mobile-force-id-on-agenda-items}
  14914. to @code{nil}. Org mode will then rely on outline paths, in the hope that
  14915. these will be unique enough.}.
  14916. Finally, Org writes the file @file{index.org}, containing links to all other
  14917. files. @i{MobileOrg} first reads this file from the server, and then
  14918. downloads all agendas and Org files listed in it. To speed up the download,
  14919. MobileOrg will only read files whose checksums@footnote{Checksums are stored
  14920. automatically in the file @file{checksums.dat}} have changed.
  14921. @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
  14922. @section Pulling from MobileOrg
  14923. When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
  14924. files for viewing. It also appends captured entries and pointers to flagged
  14925. and changed entries to the file @file{mobileorg.org} on the server. Org has
  14926. a @emph{pull} operation that integrates this information into an inbox file
  14927. and operates on the pointers to flagged entries. Here is how it works:
  14928. @enumerate
  14929. @item
  14930. Org moves all entries found in
  14931. @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
  14932. operation.} and appends them to the file pointed to by the variable
  14933. @var{org-mobile-inbox-for-pull}. Each captured entry and each editing event
  14934. will be a top-level entry in the inbox file.
  14935. @item
  14936. After moving the entries, Org will attempt to implement the changes made in
  14937. @i{MobileOrg}. Some changes are applied directly and without user
  14938. interaction. Examples are all changes to tags, TODO state, headline and body
  14939. text that can be cleanly applied. Entries that have been flagged for further
  14940. action will receive a tag @code{:FLAGGED:}, so that they can be easily found
  14941. again. When there is a problem finding an entry or applying the change, the
  14942. pointer entry will remain in the inbox and will be marked with an error
  14943. message. You need to later resolve these issues by hand.
  14944. @item
  14945. Org will then generate an agenda view with all flagged entries. The user
  14946. should then go through these entries and do whatever actions are necessary.
  14947. If a note has been stored while flagging an entry in @i{MobileOrg}, that note
  14948. will be displayed in the echo area when the cursor is on the corresponding
  14949. agenda line.
  14950. @table @kbd
  14951. @kindex ?
  14952. @item ?
  14953. Pressing @kbd{?} in that special agenda will display the full flagging note in
  14954. another window and also push it onto the kill ring. So you could use @kbd{?
  14955. z C-y C-c C-c} to store that flagging note as a normal note in the entry.
  14956. Pressing @kbd{?} twice in succession will offer to remove the
  14957. @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
  14958. in a property). In this way you indicate that the intended processing for
  14959. this flagged entry is finished.
  14960. @end table
  14961. @end enumerate
  14962. @kindex C-c a ?
  14963. If you are not able to process all flagged entries directly, you can always
  14964. return to this agenda view@footnote{Note, however, that there is a subtle
  14965. difference. The view created automatically by @kbd{M-x org-mobile-pull RET}
  14966. is guaranteed to search all files that have been addressed by the last pull.
  14967. This might include a file that is not currently in your list of agenda files.
  14968. If you later use @kbd{C-c a ?} to regenerate the view, only the current
  14969. agenda files will be searched.} using @kbd{C-c a ?}.
  14970. @node History and Acknowledgments, GNU Free Documentation License, MobileOrg, Top
  14971. @appendix History and acknowledgments
  14972. @cindex acknowledgments
  14973. @cindex history
  14974. @cindex thanks
  14975. @section From Carsten
  14976. Org was born in 2003, out of frustration over the user interface of the Emacs
  14977. Outline mode. I was trying to organize my notes and projects, and using
  14978. Emacs seemed to be the natural way to go. However, having to remember eleven
  14979. different commands with two or three keys per command, only to hide and show
  14980. parts of the outline tree, that seemed entirely unacceptable to me. Also,
  14981. when using outlines to take notes, I constantly wanted to restructure the
  14982. tree, organizing it parallel to my thoughts and plans. @emph{Visibility
  14983. cycling} and @emph{structure editing} were originally implemented in the
  14984. package @file{outline-magic.el}, but quickly moved to the more general
  14985. @file{org.el}. As this environment became comfortable for project planning,
  14986. the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
  14987. @emph{table support}. These areas highlighted the two main goals that Org
  14988. still has today: to be a new, outline-based, plain text mode with innovative
  14989. and intuitive editing features, and to incorporate project planning
  14990. functionality directly into a notes file.
  14991. Since the first release, literally thousands of emails to me or to
  14992. @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
  14993. reports, feedback, new ideas, and sometimes patches and add-on code.
  14994. Many thanks to everyone who has helped to improve this package. I am
  14995. trying to keep here a list of the people who had significant influence
  14996. in shaping one or more aspects of Org. The list may not be
  14997. complete, if I have forgotten someone, please accept my apologies and
  14998. let me know.
  14999. Before I get to this list, a few special mentions are in order:
  15000. @table @i
  15001. @item Bastien Guerry
  15002. Bastien has written a large number of extensions to Org (most of them
  15003. integrated into the core by now), including the @LaTeX{} exporter and the plain
  15004. list parser. His support during the early days, when he basically acted as
  15005. co-maintainer, was central to the success of this project. Bastien also
  15006. invented Worg, helped establishing the Web presence of Org, and sponsored
  15007. hosting costs for the orgmode.org website.
  15008. @item Eric Schulte and Dan Davison
  15009. Eric and Dan are jointly responsible for the Org-babel system, which turns
  15010. Org into a multi-language environment for evaluating code and doing literate
  15011. programming and reproducible research.
  15012. @item John Wiegley
  15013. John has contributed a number of great ideas and patches directly to Org,
  15014. including the attachment system (@file{org-attach.el}), integration with
  15015. Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
  15016. items, habit tracking (@file{org-habits.el}), and encryption
  15017. (@file{org-crypt.el}). Also, the capture system is really an extended copy
  15018. of his great @file{remember.el}.
  15019. @item Sebastian Rose
  15020. Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
  15021. of an ignorant amateur. Sebastian has pushed this part of Org onto a much
  15022. higher level. He also wrote @file{org-info.js}, a Java script for displaying
  15023. web pages derived from Org using an Info-like or a folding interface with
  15024. single-key navigation.
  15025. @end table
  15026. @noindent See below for the full list of contributions! Again, please
  15027. let me know what I am missing here!
  15028. @section From Bastien
  15029. I (Bastien) have been maintaining Org since January 2011. This appendix
  15030. would not be complete without adding a few more acknowledgements and thanks
  15031. to Carsten's ones above.
  15032. I am first grateful to Carsten for his trust while handing me over the
  15033. maintainership of Org. His support as been great since day one of this new
  15034. adventure, and it helped a lot.
  15035. When I took over maintainership, I knew I would have to make Org more
  15036. collaborative than ever, as I would have to rely on people that are more
  15037. knowledgeable than I am on many parts of the code. Here is a list of the
  15038. persons I could rely on, they should really be considered co-maintainers,
  15039. either of the code or the community:
  15040. @table @i
  15041. @item Eric Schulte
  15042. Eric is maintaining the Babel parts of Org. His reactivity here kept me away
  15043. from worrying about possible bugs here and let me focus on other parts.
  15044. @item Nicolas Goaziou
  15045. Nicolas is maintaining the consistency of the deepest parts of Org. His
  15046. work on @file{org-element.el} and @file{ox.el} has been outstanding, and
  15047. opened the doors for many new ideas and features. He rewrote many of the
  15048. old exporters to use the new export engine, and helped with documenting
  15049. this major change. More importantly (if that's possible), he has been more
  15050. than reliable during all the work done for Org 8.0, and always very
  15051. reactive on the mailing list.
  15052. @item Achim Gratz
  15053. Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
  15054. into a flexible and conceptually clean process. He patiently coped with the
  15055. many hiccups that such a change can create for users.
  15056. @item Nick Dokos
  15057. The Org mode mailing list would not be such a nice place without Nick, who
  15058. patiently helped users so many times. It is impossible to overestimate such
  15059. a great help, and the list would not be so active without him.
  15060. @end table
  15061. I received support from so many users that it is clearly impossible to be
  15062. fair when shortlisting a few of them, but Org's history would not be
  15063. complete if the ones above were not mentioned in this manual.
  15064. @section List of contributions
  15065. @itemize @bullet
  15066. @item
  15067. @i{Russel Adams} came up with the idea for drawers.
  15068. @item
  15069. @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
  15070. feedback on many features and several patches.
  15071. @item
  15072. @i{Luis Anaya} wrote @file{ox-man.el}.
  15073. @item
  15074. @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
  15075. @item
  15076. @i{Michael Brand} helped by reporting many bugs and testing many features.
  15077. He also implemented the distinction between empty fields and 0-value fields
  15078. in Org's spreadsheets.
  15079. @item
  15080. @i{Christophe Bataillon} created the great unicorn logo that we use on the
  15081. Org mode website.
  15082. @item
  15083. @i{Alex Bochannek} provided a patch for rounding timestamps.
  15084. @item
  15085. @i{Jan Böcker} wrote @file{org-docview.el}.
  15086. @item
  15087. @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
  15088. @item
  15089. @i{Tom Breton} wrote @file{org-choose.el}.
  15090. @item
  15091. @i{Charles Cave}'s suggestion sparked the implementation of templates
  15092. for Remember, which are now templates for capture.
  15093. @item
  15094. @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
  15095. specified time.
  15096. @item
  15097. @i{Gregory Chernov} patched support for Lisp forms into table
  15098. calculations and improved XEmacs compatibility, in particular by porting
  15099. @file{nouline.el} to XEmacs.
  15100. @item
  15101. @i{Sacha Chua} suggested copying some linking code from Planner.
  15102. @item
  15103. @i{Toby S. Cubitt} contributed to the code for clock formats.
  15104. @item
  15105. @i{Baoqiu Cui} contributed the DocBook exporter. It has been deleted from
  15106. Org 8.0: you can now export to Texinfo and export the @file{.texi} file to
  15107. DocBook using @code{makeinfo}.
  15108. @item
  15109. @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
  15110. came up with the idea of properties, and that there should be an API for
  15111. them.
  15112. @item
  15113. @i{Nick Dokos} tracked down several nasty bugs.
  15114. @item
  15115. @i{Kees Dullemond} used to edit projects lists directly in HTML and so
  15116. inspired some of the early development, including HTML export. He also
  15117. asked for a way to narrow wide table columns.
  15118. @item
  15119. @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
  15120. the Org-Babel documentation into the manual.
  15121. @item
  15122. @i{Christian Egli} converted the documentation into Texinfo format, inspired
  15123. the agenda, patched CSS formatting into the HTML exporter, and wrote
  15124. @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
  15125. @file{ox-taskjuggler.el} for Org 8.0.
  15126. @item
  15127. @i{David Emery} provided a patch for custom CSS support in exported
  15128. HTML agendas.
  15129. @item
  15130. @i{Nic Ferrier} contributed mailcap and XOXO support.
  15131. @item
  15132. @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
  15133. @item
  15134. @i{John Foerch} figured out how to make incremental search show context
  15135. around a match in a hidden outline tree.
  15136. @item
  15137. @i{Raimar Finken} wrote @file{org-git-line.el}.
  15138. @item
  15139. @i{Mikael Fornius} works as a mailing list moderator.
  15140. @item
  15141. @i{Austin Frank} works as a mailing list moderator.
  15142. @item
  15143. @i{Eric Fraga} drove the development of BEAMER export with ideas and
  15144. testing.
  15145. @item
  15146. @i{Barry Gidden} did proofreading the manual in preparation for the book
  15147. publication through Network Theory Ltd.
  15148. @item
  15149. @i{Niels Giesen} had the idea to automatically archive DONE trees.
  15150. @item
  15151. @i{Nicolas Goaziou} rewrote much of the plain list code. He also wrote
  15152. @file{org-element.el} and @file{org-export.el}, which was a huge step forward
  15153. in implementing a clean framework for Org exporters.
  15154. @item
  15155. @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
  15156. @item
  15157. @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
  15158. book.
  15159. @item
  15160. @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
  15161. task state change logging, and the clocktable. His clear explanations have
  15162. been critical when we started to adopt the Git version control system.
  15163. @item
  15164. @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
  15165. patches.
  15166. @item
  15167. @i{Phil Jackson} wrote @file{org-irc.el}.
  15168. @item
  15169. @i{Scott Jaderholm} proposed footnotes, control over whitespace between
  15170. folded entries, and column view for properties.
  15171. @item
  15172. @i{Matt Jones} wrote @i{MobileOrg Android}.
  15173. @item
  15174. @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
  15175. @item
  15176. @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
  15177. @item
  15178. @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
  15179. provided frequent feedback and some patches.
  15180. @item
  15181. @i{Matt Lundin} has proposed last-row references for table formulas and named
  15182. invisible anchors. He has also worked a lot on the FAQ.
  15183. @item
  15184. @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
  15185. and is a prolific contributor on the mailing list with competent replies,
  15186. small fixes and patches.
  15187. @item
  15188. @i{Jason F. McBrayer} suggested agenda export to CSV format.
  15189. @item
  15190. @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
  15191. @item
  15192. @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
  15193. basis.
  15194. @item
  15195. @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
  15196. happy.
  15197. @item
  15198. @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
  15199. @item
  15200. @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
  15201. and being able to quickly restrict the agenda to a subtree.
  15202. @item
  15203. @i{Todd Neal} provided patches for links to Info files and Elisp forms.
  15204. @item
  15205. @i{Greg Newman} refreshed the unicorn logo into its current form.
  15206. @item
  15207. @i{Tim O'Callaghan} suggested in-file links, search options for general
  15208. file links, and TAGS.
  15209. @item
  15210. @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
  15211. version of the reference card.
  15212. @item
  15213. @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
  15214. into Japanese.
  15215. @item
  15216. @i{Oliver Oppitz} suggested multi-state TODO items.
  15217. @item
  15218. @i{Scott Otterson} sparked the introduction of descriptive text for
  15219. links, among other things.
  15220. @item
  15221. @i{Pete Phillips} helped during the development of the TAGS feature, and
  15222. provided frequent feedback.
  15223. @item
  15224. @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
  15225. generation.
  15226. @item
  15227. @i{Martin Pohlack} provided the code snippet to bundle character insertion
  15228. into bundles of 20 for undo.
  15229. @item
  15230. @i{T.V. Raman} reported bugs and suggested improvements.
  15231. @item
  15232. @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
  15233. control.
  15234. @item
  15235. @i{Paul Rivier} provided the basic implementation of named footnotes. He
  15236. also acted as mailing list moderator for some time.
  15237. @item
  15238. @i{Kevin Rogers} contributed code to access VM files on remote hosts.
  15239. @item
  15240. @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
  15241. conflict with @file{allout.el}.
  15242. @item
  15243. @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
  15244. extensive patches.
  15245. @item
  15246. @i{Philip Rooke} created the Org reference card, provided lots
  15247. of feedback, developed and applied standards to the Org documentation.
  15248. @item
  15249. @i{Christian Schlauer} proposed angular brackets around links, among
  15250. other things.
  15251. @item
  15252. @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
  15253. enjoy folding in non-org buffers by using Org headlines in comments.
  15254. @item
  15255. @i{Paul Sexton} wrote @file{org-ctags.el}.
  15256. @item
  15257. Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
  15258. @file{organizer-mode.el}.
  15259. @item
  15260. @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
  15261. examples, and remote highlighting for referenced code lines.
  15262. @item
  15263. @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
  15264. now packaged into Org's @file{contrib} directory.
  15265. @item
  15266. @i{Daniel Sinder} came up with the idea of internal archiving by locking
  15267. subtrees.
  15268. @item
  15269. @i{Dale Smith} proposed link abbreviations.
  15270. @item
  15271. @i{James TD Smith} has contributed a large number of patches for useful
  15272. tweaks and features.
  15273. @item
  15274. @i{Adam Spiers} asked for global linking commands, inspired the link
  15275. extension system, added support for mairix, and proposed the mapping API.
  15276. @item
  15277. @i{Ulf Stegemann} created the table to translate special symbols to HTML,
  15278. @LaTeX{}, UTF-8, Latin-1 and ASCII.
  15279. @item
  15280. @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
  15281. with links transformation to Org syntax.
  15282. @item
  15283. @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
  15284. chapter about publishing.
  15285. @item
  15286. @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
  15287. @item
  15288. @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
  15289. enabled source code highlighting in Gnus.
  15290. @item
  15291. @i{Stefan Vollmar} organized a video-recorded talk at the
  15292. Max-Planck-Institute for Neurology. He also inspired the creation of a
  15293. concept index for HTML export.
  15294. @item
  15295. @i{J@"urgen Vollmer} contributed code generating the table of contents
  15296. in HTML output.
  15297. @item
  15298. @i{Samuel Wales} has provided important feedback and bug reports.
  15299. @item
  15300. @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
  15301. keyword.
  15302. @item
  15303. @i{David Wainberg} suggested archiving, and improvements to the linking
  15304. system.
  15305. @item
  15306. @i{Carsten Wimmer} suggested some changes and helped fix a bug in
  15307. linking to Gnus.
  15308. @item
  15309. @i{Roland Winkler} requested additional key bindings to make Org
  15310. work on a tty.
  15311. @item
  15312. @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
  15313. and contributed various ideas and code snippets.
  15314. @end itemize
  15315. @node GNU Free Documentation License, Main Index, History and Acknowledgments, Top
  15316. @appendix GNU Free Documentation License
  15317. @include doclicense.texi
  15318. @node Main Index, Key Index, GNU Free Documentation License, Top
  15319. @unnumbered Concept index
  15320. @printindex cp
  15321. @node Key Index, Command and Function Index, Main Index, Top
  15322. @unnumbered Key index
  15323. @printindex ky
  15324. @node Command and Function Index, Variable Index, Key Index, Top
  15325. @unnumbered Command and function index
  15326. @printindex fn
  15327. @node Variable Index, , Command and Function Index, Top
  15328. @unnumbered Variable index
  15329. This is not a complete index of variables and faces, only the ones that are
  15330. mentioned in the manual. For a more complete list, use @kbd{M-x
  15331. org-customize @key{RET}} and then click yourself through the tree.
  15332. @printindex vr
  15333. @bye
  15334. @c Local variables:
  15335. @c fill-column: 77
  15336. @c indent-tabs-mode: nil
  15337. @c paragraph-start: "\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
  15338. @c paragraph-separate: "\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
  15339. @c End:
  15340. @c LocalWords: webdavhost pre