org.texi 677 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535
  1. \input texinfo
  2. @c %**start of header
  3. @setfilename ../../info/org
  4. @settitle The Org Manual
  5. @set VERSION 7.8.03
  6. @set DATE January 2012
  7. @c Use proper quote and backtick for code sections in PDF output
  8. @c Cf. Texinfo manual 14.2
  9. @set txicodequoteundirected
  10. @set txicodequotebacktick
  11. @c Version and Contact Info
  12. @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
  13. @set AUTHOR Carsten Dominik
  14. @set MAINTAINER Carsten Dominik
  15. @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
  16. @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
  17. @c %**end of header
  18. @finalout
  19. @c -----------------------------------------------------------------------------
  20. @c Macro definitions for commands and keys
  21. @c =======================================
  22. @c The behavior of the key/command macros will depend on the flag cmdnames
  23. @c When set, commands names are shown. When clear, they are not shown.
  24. @set cmdnames
  25. @c Below we define the following macros for Org key tables:
  26. @c orgkey{key} A key item
  27. @c orgcmd{key,cmd} Key with command name
  28. @c xorgcmd{key,cmd} Key with command name as @itemx
  29. @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
  30. @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
  31. @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
  32. @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
  33. @c different functions, so format as @itemx
  34. @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
  35. @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
  36. @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
  37. @c a key but no command
  38. @c Inserts: @item key
  39. @macro orgkey{key}
  40. @kindex \key\
  41. @item @kbd{\key\}
  42. @end macro
  43. @macro xorgkey{key}
  44. @kindex \key\
  45. @itemx @kbd{\key\}
  46. @end macro
  47. @c one key with a command
  48. @c Inserts: @item KEY COMMAND
  49. @macro orgcmd{key,command}
  50. @ifset cmdnames
  51. @kindex \key\
  52. @findex \command\
  53. @iftex
  54. @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
  55. @end iftex
  56. @ifnottex
  57. @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  58. @end ifnottex
  59. @end ifset
  60. @ifclear cmdnames
  61. @kindex \key\
  62. @item @kbd{\key\}
  63. @end ifclear
  64. @end macro
  65. @c One key with one command, formatted using @itemx
  66. @c Inserts: @itemx KEY COMMAND
  67. @macro xorgcmd{key,command}
  68. @ifset cmdnames
  69. @kindex \key\
  70. @findex \command\
  71. @iftex
  72. @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
  73. @end iftex
  74. @ifnottex
  75. @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  76. @end ifnottex
  77. @end ifset
  78. @ifclear cmdnames
  79. @kindex \key\
  80. @itemx @kbd{\key\}
  81. @end ifclear
  82. @end macro
  83. @c one key with a command, bit do not index the key
  84. @c Inserts: @item KEY COMMAND
  85. @macro orgcmdnki{key,command}
  86. @ifset cmdnames
  87. @findex \command\
  88. @iftex
  89. @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
  90. @end iftex
  91. @ifnottex
  92. @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  93. @end ifnottex
  94. @end ifset
  95. @ifclear cmdnames
  96. @item @kbd{\key\}
  97. @end ifclear
  98. @end macro
  99. @c one key with a command, and special text to replace key in item
  100. @c Inserts: @item TEXT COMMAND
  101. @macro orgcmdtkc{text,key,command}
  102. @ifset cmdnames
  103. @kindex \key\
  104. @findex \command\
  105. @iftex
  106. @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
  107. @end iftex
  108. @ifnottex
  109. @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  110. @end ifnottex
  111. @end ifset
  112. @ifclear cmdnames
  113. @kindex \key\
  114. @item @kbd{\text\}
  115. @end ifclear
  116. @end macro
  117. @c two keys with one command
  118. @c Inserts: @item KEY1 or KEY2 COMMAND
  119. @macro orgcmdkkc{key1,key2,command}
  120. @ifset cmdnames
  121. @kindex \key1\
  122. @kindex \key2\
  123. @findex \command\
  124. @iftex
  125. @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  126. @end iftex
  127. @ifnottex
  128. @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  129. @end ifnottex
  130. @end ifset
  131. @ifclear cmdnames
  132. @kindex \key1\
  133. @kindex \key2\
  134. @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
  135. @end ifclear
  136. @end macro
  137. @c Two keys with one command name, but different functions, so format as
  138. @c @itemx
  139. @c Inserts: @item KEY1
  140. @c @itemx KEY2 COMMAND
  141. @macro orgcmdkxkc{key1,key2,command}
  142. @ifset cmdnames
  143. @kindex \key1\
  144. @kindex \key2\
  145. @findex \command\
  146. @iftex
  147. @item @kbd{\key1\}
  148. @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  149. @end iftex
  150. @ifnottex
  151. @item @kbd{\key1\}
  152. @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  153. @end ifnottex
  154. @end ifset
  155. @ifclear cmdnames
  156. @kindex \key1\
  157. @kindex \key2\
  158. @item @kbd{\key1\}
  159. @itemx @kbd{\key2\}
  160. @end ifclear
  161. @end macro
  162. @c Same as previous, but use "or short"
  163. @c Inserts: @item KEY1 or short KEY2 COMMAND
  164. @macro orgcmdkskc{key1,key2,command}
  165. @ifset cmdnames
  166. @kindex \key1\
  167. @kindex \key2\
  168. @findex \command\
  169. @iftex
  170. @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  171. @end iftex
  172. @ifnottex
  173. @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  174. @end ifnottex
  175. @end ifset
  176. @ifclear cmdnames
  177. @kindex \key1\
  178. @kindex \key2\
  179. @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
  180. @end ifclear
  181. @end macro
  182. @c Same as previous, but use @itemx
  183. @c Inserts: @itemx KEY1 or short KEY2 COMMAND
  184. @macro xorgcmdkskc{key1,key2,command}
  185. @ifset cmdnames
  186. @kindex \key1\
  187. @kindex \key2\
  188. @findex \command\
  189. @iftex
  190. @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  191. @end iftex
  192. @ifnottex
  193. @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  194. @end ifnottex
  195. @end ifset
  196. @ifclear cmdnames
  197. @kindex \key1\
  198. @kindex \key2\
  199. @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
  200. @end ifclear
  201. @end macro
  202. @c two keys with two commands
  203. @c Inserts: @item KEY1 COMMAND1
  204. @c @itemx KEY2 COMMAND2
  205. @macro orgcmdkkcc{key1,key2,command1,command2}
  206. @ifset cmdnames
  207. @kindex \key1\
  208. @kindex \key2\
  209. @findex \command1\
  210. @findex \command2\
  211. @iftex
  212. @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
  213. @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
  214. @end iftex
  215. @ifnottex
  216. @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
  217. @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
  218. @end ifnottex
  219. @end ifset
  220. @ifclear cmdnames
  221. @kindex \key1\
  222. @kindex \key2\
  223. @item @kbd{\key1\}
  224. @itemx @kbd{\key2\}
  225. @end ifclear
  226. @end macro
  227. @c -----------------------------------------------------------------------------
  228. @iftex
  229. @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
  230. @end iftex
  231. @c Subheadings inside a table.
  232. @macro tsubheading{text}
  233. @ifinfo
  234. @subsubheading \text\
  235. @end ifinfo
  236. @ifnotinfo
  237. @item @b{\text\}
  238. @end ifnotinfo
  239. @end macro
  240. @copying
  241. This manual is for Org version @value{VERSION}.
  242. Copyright @copyright{} 2004-2012 Free Software Foundation, Inc.
  243. @quotation
  244. Permission is granted to copy, distribute and/or modify this document
  245. under the terms of the GNU Free Documentation License, Version 1.3 or
  246. any later version published by the Free Software Foundation; with no
  247. Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
  248. and with the Back-Cover Texts as in (a) below. A copy of the license
  249. is included in the section entitled ``GNU Free Documentation License.''
  250. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
  251. modify this GNU manual. Buying copies from the FSF supports it in
  252. developing GNU and promoting software freedom.''
  253. This document is part of a collection distributed under the GNU Free
  254. Documentation License. If you want to distribute this document
  255. separately from the collection, you can do so by adding a copy of the
  256. license to the document, as described in section 6 of the license.
  257. @end quotation
  258. @end copying
  259. @dircategory Emacs
  260. @direntry
  261. * Org Mode: (org). Outline-based notes management and organizer
  262. @end direntry
  263. @titlepage
  264. @title The Org Manual
  265. @subtitle Release @value{VERSION}
  266. @author by Carsten Dominik
  267. with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, Thomas Dye and Jambunathan K.
  268. @c The following two commands start the copyright page.
  269. @page
  270. @vskip 0pt plus 1filll
  271. @insertcopying
  272. @end titlepage
  273. @c Output the table of contents at the beginning.
  274. @contents
  275. @ifnottex
  276. @node Top, Introduction, (dir), (dir)
  277. @top Org Mode Manual
  278. @insertcopying
  279. @end ifnottex
  280. @menu
  281. * Introduction:: Getting started
  282. * Document Structure:: A tree works like your brain
  283. * Tables:: Pure magic for quick formatting
  284. * Hyperlinks:: Notes in context
  285. * TODO Items:: Every tree branch can be a TODO item
  286. * Tags:: Tagging headlines and matching sets of tags
  287. * Properties and Columns:: Storing information about an entry
  288. * Dates and Times:: Making items useful for planning
  289. * Capture - Refile - Archive:: The ins and outs for projects
  290. * Agenda Views:: Collecting information into views
  291. * Markup:: Prepare text for rich export
  292. * Exporting:: Sharing and publishing of notes
  293. * Publishing:: Create a web site of linked Org files
  294. * Working With Source Code:: Export, evaluate, and tangle code blocks
  295. * Miscellaneous:: All the rest which did not fit elsewhere
  296. * Hacking:: How to hack your way around
  297. * MobileOrg:: Viewing and capture on a mobile device
  298. * History and Acknowledgments:: How Org came into being
  299. * Main Index:: An index of Org's concepts and features
  300. * Key Index:: Key bindings and where they are described
  301. * Command and Function Index:: Command names and some internal functions
  302. * Variable Index:: Variables mentioned in the manual
  303. @detailmenu
  304. --- The Detailed Node Listing ---
  305. Introduction
  306. * Summary:: Brief summary of what Org does
  307. * Installation:: How to install a downloaded version of Org
  308. * Activation:: How to activate Org for certain buffers
  309. * Feedback:: Bug reports, ideas, patches etc.
  310. * Conventions:: Type-setting conventions in the manual
  311. Document structure
  312. * Outlines:: Org is based on Outline mode
  313. * Headlines:: How to typeset Org tree headlines
  314. * Visibility cycling:: Show and hide, much simplified
  315. * Motion:: Jumping to other headlines
  316. * Structure editing:: Changing sequence and level of headlines
  317. * Sparse trees:: Matches embedded in context
  318. * Plain lists:: Additional structure within an entry
  319. * Drawers:: Tucking stuff away
  320. * Blocks:: Folding blocks
  321. * Footnotes:: How footnotes are defined in Org's syntax
  322. * Orgstruct mode:: Structure editing outside Org
  323. Tables
  324. * Built-in table editor:: Simple tables
  325. * Column width and alignment:: Overrule the automatic settings
  326. * Column groups:: Grouping to trigger vertical lines
  327. * Orgtbl mode:: The table editor as minor mode
  328. * The spreadsheet:: The table editor has spreadsheet capabilities
  329. * Org-Plot:: Plotting from org tables
  330. The spreadsheet
  331. * References:: How to refer to another field or range
  332. * Formula syntax for Calc:: Using Calc to compute stuff
  333. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  334. * Durations and time values:: How to compute durations and time values
  335. * Field and range formulas:: Formula for specific (ranges of) fields
  336. * Column formulas:: Formulas valid for an entire column
  337. * Editing and debugging formulas:: Fixing formulas
  338. * Updating the table:: Recomputing all dependent fields
  339. * Advanced features:: Field and column names, parameters and automatic recalc
  340. Hyperlinks
  341. * Link format:: How links in Org are formatted
  342. * Internal links:: Links to other places in the current file
  343. * External links:: URL-like links to the world
  344. * Handling links:: Creating, inserting and following
  345. * Using links outside Org:: Linking from my C source code?
  346. * Link abbreviations:: Shortcuts for writing complex links
  347. * Search options:: Linking to a specific location
  348. * Custom searches:: When the default search is not enough
  349. Internal links
  350. * Radio targets:: Make targets trigger links in plain text
  351. TODO items
  352. * TODO basics:: Marking and displaying TODO entries
  353. * TODO extensions:: Workflow and assignments
  354. * Progress logging:: Dates and notes for progress
  355. * Priorities:: Some things are more important than others
  356. * Breaking down tasks:: Splitting a task into manageable pieces
  357. * Checkboxes:: Tick-off lists
  358. Extended use of TODO keywords
  359. * Workflow states:: From TODO to DONE in steps
  360. * TODO types:: I do this, Fred does the rest
  361. * Multiple sets in one file:: Mixing it all, and still finding your way
  362. * Fast access to TODO states:: Single letter selection of a state
  363. * Per-file keywords:: Different files, different requirements
  364. * Faces for TODO keywords:: Highlighting states
  365. * TODO dependencies:: When one task needs to wait for others
  366. Progress logging
  367. * Closing items:: When was this entry marked DONE?
  368. * Tracking TODO state changes:: When did the status change?
  369. * Tracking your habits:: How consistent have you been?
  370. Tags
  371. * Tag inheritance:: Tags use the tree structure of the outline
  372. * Setting tags:: How to assign tags to a headline
  373. * Tag searches:: Searching for combinations of tags
  374. Properties and columns
  375. * Property syntax:: How properties are spelled out
  376. * Special properties:: Access to other Org mode features
  377. * Property searches:: Matching property values
  378. * Property inheritance:: Passing values down the tree
  379. * Column view:: Tabular viewing and editing
  380. * Property API:: Properties for Lisp programmers
  381. Column view
  382. * Defining columns:: The COLUMNS format property
  383. * Using column view:: How to create and use column view
  384. * Capturing column view:: A dynamic block for column view
  385. Defining columns
  386. * Scope of column definitions:: Where defined, where valid?
  387. * Column attributes:: Appearance and content of a column
  388. Dates and times
  389. * Timestamps:: Assigning a time to a tree entry
  390. * Creating timestamps:: Commands which insert timestamps
  391. * Deadlines and scheduling:: Planning your work
  392. * Clocking work time:: Tracking how long you spend on a task
  393. * Effort estimates:: Planning work effort in advance
  394. * Relative timer:: Notes with a running timer
  395. * Countdown timer:: Starting a countdown timer for a task
  396. Creating timestamps
  397. * The date/time prompt:: How Org mode helps you entering date and time
  398. * Custom time format:: Making dates look different
  399. Deadlines and scheduling
  400. * Inserting deadline/schedule:: Planning items
  401. * Repeated tasks:: Items that show up again and again
  402. Clocking work time
  403. * Clocking commands:: Starting and stopping a clock
  404. * The clock table:: Detailed reports
  405. * Resolving idle time:: Resolving time when you've been idle
  406. Capture - Refile - Archive
  407. * Capture:: Capturing new stuff
  408. * Attachments:: Add files to tasks
  409. * RSS Feeds:: Getting input from RSS feeds
  410. * Protocols:: External (e.g.@: Browser) access to Emacs and Org
  411. * Refiling notes:: Moving a tree from one place to another
  412. * Archiving:: What to do with finished projects
  413. Capture
  414. * Setting up capture:: Where notes will be stored
  415. * Using capture:: Commands to invoke and terminate capture
  416. * Capture templates:: Define the outline of different note types
  417. Capture templates
  418. * Template elements:: What is needed for a complete template entry
  419. * Template expansion:: Filling in information about time and context
  420. Archiving
  421. * Moving subtrees:: Moving a tree to an archive file
  422. * Internal archiving:: Switch off a tree but keep it in the file
  423. Agenda views
  424. * Agenda files:: Files being searched for agenda information
  425. * Agenda dispatcher:: Keyboard access to agenda views
  426. * Built-in agenda views:: What is available out of the box?
  427. * Presentation and sorting:: How agenda items are prepared for display
  428. * Agenda commands:: Remote editing of Org trees
  429. * Custom agenda views:: Defining special searches and views
  430. * Exporting Agenda Views:: Writing a view to a file
  431. * Agenda column view:: Using column view for collected entries
  432. The built-in agenda views
  433. * Weekly/daily agenda:: The calendar page with current tasks
  434. * Global TODO list:: All unfinished action items
  435. * Matching tags and properties:: Structured information with fine-tuned search
  436. * Timeline:: Time-sorted view for single file
  437. * Search view:: Find entries by searching for text
  438. * Stuck projects:: Find projects you need to review
  439. Presentation and sorting
  440. * Categories:: Not all tasks are equal
  441. * Time-of-day specifications:: How the agenda knows the time
  442. * Sorting of agenda items:: The order of things
  443. Custom agenda views
  444. * Storing searches:: Type once, use often
  445. * Block agenda:: All the stuff you need in a single buffer
  446. * Setting Options:: Changing the rules
  447. Markup for rich export
  448. * Structural markup elements:: The basic structure as seen by the exporter
  449. * Images and tables:: Tables and Images will be included
  450. * Literal examples:: Source code examples with special formatting
  451. * Include files:: Include additional files into a document
  452. * Index entries:: Making an index
  453. * Macro replacement:: Use macros to create complex output
  454. * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
  455. Structural markup elements
  456. * Document title:: Where the title is taken from
  457. * Headings and sections:: The document structure as seen by the exporter
  458. * Table of contents:: The if and where of the table of contents
  459. * Initial text:: Text before the first heading?
  460. * Lists:: Lists
  461. * Paragraphs:: Paragraphs
  462. * Footnote markup:: Footnotes
  463. * Emphasis and monospace:: Bold, italic, etc.
  464. * Horizontal rules:: Make a line
  465. * Comment lines:: What will *not* be exported
  466. Embedded @LaTeX{}
  467. * Special symbols:: Greek letters and other symbols
  468. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  469. * @LaTeX{} fragments:: Complex formulas made easy
  470. * Previewing @LaTeX{} fragments:: What will this snippet look like?
  471. * CDLaTeX mode:: Speed up entering of formulas
  472. Exporting
  473. * Selective export:: Using tags to select and exclude trees
  474. * Export options:: Per-file export settings
  475. * The export dispatcher:: How to access exporter commands
  476. * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
  477. * HTML export:: Exporting to HTML
  478. * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
  479. * DocBook export:: Exporting to DocBook
  480. * OpenDocument Text export:: Exporting to OpenDocument Text
  481. * TaskJuggler export:: Exporting to TaskJuggler
  482. * Freemind export:: Exporting to Freemind mind maps
  483. * XOXO export:: Exporting to XOXO
  484. * iCalendar export:: Exporting in iCalendar format
  485. HTML export
  486. * HTML Export commands:: How to invoke HTML export
  487. * HTML preamble and postamble:: How to insert a preamble and a postamble
  488. * Quoting HTML tags:: Using direct HTML in Org mode
  489. * Links in HTML export:: How links will be interpreted and formatted
  490. * Tables in HTML export:: How to modify the formatting of tables
  491. * Images in HTML export:: How to insert figures into HTML output
  492. * Math formatting in HTML export:: Beautiful math also on the web
  493. * Text areas in HTML export:: An alternative way to show an example
  494. * CSS support:: Changing the appearance of the output
  495. * JavaScript support:: Info and Folding in a web browser
  496. @LaTeX{} and PDF export
  497. * @LaTeX{}/PDF export commands::
  498. * Header and sectioning:: Setting up the export file structure
  499. * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
  500. * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
  501. * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
  502. * Beamer class export:: Turning the file into a presentation
  503. DocBook export
  504. * DocBook export commands:: How to invoke DocBook export
  505. * Quoting DocBook code:: Incorporating DocBook code in Org files
  506. * Recursive sections:: Recursive sections in DocBook
  507. * Tables in DocBook export:: Tables are exported as HTML tables
  508. * Images in DocBook export:: How to insert figures into DocBook output
  509. * Special characters:: How to handle special characters
  510. OpenDocument Text export
  511. * Pre-requisites for @acronym{ODT} export:: What packages @acronym{ODT} exporter relies on
  512. * @acronym{ODT} export commands:: How to invoke @acronym{ODT} export
  513. * Applying custom styles:: How to apply custom styles to the output
  514. * Links in @acronym{ODT} export:: How links will be interpreted and formatted
  515. * Tables in @acronym{ODT} export:: How Tables are exported
  516. * Images in @acronym{ODT} export:: How to insert images
  517. * Math formatting in @acronym{ODT} export:: How @LaTeX{} fragments are formatted
  518. * Literal examples in @acronym{ODT} export:: How source and example blocks are formatted
  519. * Advanced topics in @acronym{ODT} export:: Read this if you are a power user
  520. Math formatting in @acronym{ODT} export
  521. * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
  522. * Working with MathML or OpenDocument formula files:: How to embed equations in native format
  523. Advanced topics in @acronym{ODT} export
  524. * Exporting and converting to other formats:: How to produce @samp{pdf} and other formats
  525. * Working with OpenDocument style files:: Explore the internals
  526. * Creating one-off styles:: How to produce custom highlighting etc
  527. * Customizing tables in @acronym{ODT} export:: How to define and use Table templates
  528. * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
  529. Publishing
  530. * Configuration:: Defining projects
  531. * Uploading files:: How to get files up on the server
  532. * Sample configuration:: Example projects
  533. * Triggering publication:: Publication commands
  534. Configuration
  535. * Project alist:: The central configuration variable
  536. * Sources and destinations:: From here to there
  537. * Selecting files:: What files are part of the project?
  538. * Publishing action:: Setting the function doing the publishing
  539. * Publishing options:: Tweaking HTML/@LaTeX{} export
  540. * Publishing links:: Which links keep working after publishing?
  541. * Sitemap:: Generating a list of all pages
  542. * Generating an index:: An index that reaches across pages
  543. Sample configuration
  544. * Simple example:: One-component publishing
  545. * Complex example:: A multi-component publishing example
  546. Working with source code
  547. * Structure of code blocks:: Code block syntax described
  548. * Editing source code:: Language major-mode editing
  549. * Exporting code blocks:: Export contents and/or results
  550. * Extracting source code:: Create pure source code files
  551. * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
  552. * Library of Babel:: Use and contribute to a library of useful code blocks
  553. * Languages:: List of supported code block languages
  554. * Header arguments:: Configure code block functionality
  555. * Results of evaluation:: How evaluation results are handled
  556. * Noweb reference syntax:: Literate programming in Org mode
  557. * Key bindings and useful functions:: Work quickly with code blocks
  558. * Batch execution:: Call functions from the command line
  559. Header arguments
  560. * Using header arguments:: Different ways to set header arguments
  561. * Specific header arguments:: List of header arguments
  562. Using header arguments
  563. * System-wide header arguments:: Set global default values
  564. * Language-specific header arguments:: Set default values by language
  565. * Buffer-wide header arguments:: Set default values for a specific buffer
  566. * Header arguments in Org mode properties:: Set default values for a buffer or heading
  567. * Code block specific header arguments:: The most common way to set values
  568. * Header arguments in function calls:: The most specific level
  569. Specific header arguments
  570. * var:: Pass arguments to code blocks
  571. * results:: Specify the type of results and how they will
  572. be collected and handled
  573. * file:: Specify a path for file output
  574. * dir:: Specify the default (possibly remote)
  575. directory for code block execution
  576. * exports:: Export code and/or results
  577. * tangle:: Toggle tangling and specify file name
  578. * mkdirp:: Toggle creation of parent directories of target
  579. files during tangling
  580. * comments:: Toggle insertion of comments in tangled
  581. code files
  582. * padline:: Control insertion of padding lines in tangled
  583. code files
  584. * no-expand:: Turn off variable assignment and noweb
  585. expansion during tangling
  586. * session:: Preserve the state of code evaluation
  587. * noweb:: Toggle expansion of noweb references
  588. * noweb-ref:: Specify block's noweb reference resolution target
  589. * cache:: Avoid re-evaluating unchanged code blocks
  590. * sep:: Delimiter for writing tabular results outside Org
  591. * hlines:: Handle horizontal lines in tables
  592. * colnames:: Handle column names in tables
  593. * rownames:: Handle row names in tables
  594. * shebang:: Make tangled files executable
  595. * eval:: Limit evaluation of specific code blocks
  596. * wrap:: Mark source block evaluation results
  597. Miscellaneous
  598. * Completion:: M-TAB knows what you need
  599. * Easy Templates:: Quick insertion of structural elements
  600. * Speed keys:: Electric commands at the beginning of a headline
  601. * Code evaluation security:: Org mode files evaluate inline code
  602. * Customization:: Adapting Org to your taste
  603. * In-buffer settings:: Overview of the #+KEYWORDS
  604. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  605. * Clean view:: Getting rid of leading stars in the outline
  606. * TTY keys:: Using Org on a tty
  607. * Interaction:: Other Emacs packages
  608. * org-crypt.el:: Encrypting Org files
  609. Interaction with other packages
  610. * Cooperation:: Packages Org cooperates with
  611. * Conflicts:: Packages that lead to conflicts
  612. Hacking
  613. * Hooks:: Who to reach into Org's internals
  614. * Add-on packages:: Available extensions
  615. * Adding hyperlink types:: New custom link types
  616. * Context-sensitive commands:: How to add functionality to such commands
  617. * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
  618. * Dynamic blocks:: Automatically filled blocks
  619. * Special agenda views:: Customized views
  620. * Extracting agenda information:: Postprocessing of agenda information
  621. * Using the property API:: Writing programs that use entry properties
  622. * Using the mapping API:: Mapping over all or selected entries
  623. Tables and lists in arbitrary syntax
  624. * Radio tables:: Sending and receiving radio tables
  625. * A @LaTeX{} example:: Step by step, almost a tutorial
  626. * Translator functions:: Copy and modify
  627. * Radio lists:: Doing the same for lists
  628. MobileOrg
  629. * Setting up the staging area:: Where to interact with the mobile device
  630. * Pushing to MobileOrg:: Uploading Org files and agendas
  631. * Pulling from MobileOrg:: Integrating captured and flagged items
  632. @end detailmenu
  633. @end menu
  634. @node Introduction, Document Structure, Top, Top
  635. @chapter Introduction
  636. @cindex introduction
  637. @menu
  638. * Summary:: Brief summary of what Org does
  639. * Installation:: How to install a downloaded version of Org
  640. * Activation:: How to activate Org for certain buffers
  641. * Feedback:: Bug reports, ideas, patches etc.
  642. * Conventions:: Type-setting conventions in the manual
  643. @end menu
  644. @node Summary, Installation, Introduction, Introduction
  645. @section Summary
  646. @cindex summary
  647. Org is a mode for keeping notes, maintaining TODO lists, and doing
  648. project planning with a fast and effective plain-text system.
  649. Org develops organizational tasks around NOTES files that contain
  650. lists or information about projects as plain text. Org is
  651. implemented on top of Outline mode, which makes it possible to keep the
  652. content of large files well structured. Visibility cycling and
  653. structure editing help to work with the tree. Tables are easily created
  654. with a built-in table editor. Org supports TODO items, deadlines,
  655. timestamps, and scheduling. It dynamically compiles entries into an
  656. agenda that utilizes and smoothly integrates much of the Emacs calendar
  657. and diary. Plain text URL-like links connect to websites, emails,
  658. Usenet messages, BBDB entries, and any files related to the projects.
  659. For printing and sharing of notes, an Org file can be exported as a
  660. structured ASCII file, as HTML, or (TODO and agenda items only) as an
  661. iCalendar file. It can also serve as a publishing tool for a set of
  662. linked web pages.
  663. As a project planning environment, Org works by adding metadata to outline
  664. nodes. Based on this data, specific entries can be extracted in queries and
  665. create dynamic @i{agenda views}.
  666. Org mode contains the Org Babel environment which allows you to work with
  667. embedded source code blocks in a file, to facilitate code evaluation,
  668. documentation, and literate programming techniques.
  669. Org's automatic, context-sensitive table editor with spreadsheet
  670. capabilities can be integrated into any major mode by activating the
  671. minor Orgtbl mode. Using a translation step, it can be used to maintain
  672. tables in arbitrary file types, for example in @LaTeX{}. The structure
  673. editing and list creation capabilities can be used outside Org with
  674. the minor Orgstruct mode.
  675. Org keeps simple things simple. When first fired up, it should
  676. feel like a straightforward, easy to use outliner. Complexity is not
  677. imposed, but a large amount of functionality is available when you need
  678. it. Org is a toolbox and can be used in different ways and for different
  679. ends, for example:
  680. @example
  681. @r{@bullet{} an outline extension with visibility cycling and structure editing}
  682. @r{@bullet{} an ASCII system and table editor for taking structured notes}
  683. @r{@bullet{} a TODO list editor}
  684. @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
  685. @pindex GTD, Getting Things Done
  686. @r{@bullet{} an environment in which to implement David Allen's GTD system}
  687. @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
  688. @r{@bullet{} a publishing tool to create a set of interlinked webpages}
  689. @r{@bullet{} an environment for literate programming}
  690. @end example
  691. @cindex FAQ
  692. There is a website for Org which provides links to the newest
  693. version of Org, as well as additional information, frequently asked
  694. questions (FAQ), links to tutorials, etc@. This page is located at
  695. @uref{http://orgmode.org}.
  696. @cindex print edition
  697. The version 7.3 of this manual is available as a
  698. @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
  699. Theory Ltd.}
  700. @page
  701. @node Installation, Activation, Summary, Introduction
  702. @section Installation
  703. @cindex installation
  704. @cindex XEmacs
  705. @b{Important:} @i{If you are using a version of Org that is part of the Emacs
  706. distribution or an XEmacs package, please skip this section and go directly
  707. to @ref{Activation}. To see what version of Org (if any) is part of your
  708. Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x
  709. org-version}.}
  710. If you have downloaded Org from the Web, either as a distribution @file{.zip}
  711. or @file{.tar} file, or as a Git archive, you must take the following steps
  712. to install it: go into the unpacked Org distribution directory and edit the
  713. top section of the file @file{Makefile}. You must set the name of the Emacs
  714. binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
  715. directories where local Lisp and Info files are kept. If you don't have
  716. access to the system-wide directories, you can simply run Org directly from
  717. the distribution directory by adding the @file{lisp} subdirectory to the
  718. Emacs load path. To do this, add the following line to @file{.emacs}:
  719. @example
  720. (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
  721. @end example
  722. @noindent
  723. If you plan to use code from the @file{contrib} subdirectory, do a similar
  724. step for this directory:
  725. @example
  726. (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
  727. @end example
  728. @noindent Now byte-compile the Lisp files with the shell command:
  729. @example
  730. make
  731. @end example
  732. @noindent If you are running Org from the distribution directory, this is
  733. all. If you want to install Org into the system directories, use (as
  734. administrator)
  735. @example
  736. make install
  737. @end example
  738. Installing Info files is system dependent, because of differences in the
  739. @file{install-info} program. The following should correctly install the Info
  740. files on most systems, please send a bug report if not@footnote{The output
  741. from install-info (if any) is also system dependent. In particular Debian
  742. and its derivatives use two different versions of install-info and you may
  743. see the message:
  744. @example
  745. This is not dpkg install-info anymore, but GNU install-info
  746. See the man page for ginstall-info for command line arguments
  747. @end example
  748. @noindent which can be safely ignored.}.
  749. @example
  750. make install-info
  751. @end example
  752. Then add the following line to @file{.emacs}. It is needed so that
  753. Emacs can autoload functions that are located in files not immediately loaded
  754. when Org mode starts.
  755. @lisp
  756. (require 'org-install)
  757. @end lisp
  758. Do not forget to activate Org as described in the following section.
  759. @page
  760. @node Activation, Feedback, Installation, Introduction
  761. @section Activation
  762. @cindex activation
  763. @cindex autoload
  764. @cindex global key bindings
  765. @cindex key bindings, global
  766. To make sure files with extension @file{.org} use Org mode, add the following
  767. line to your @file{.emacs} file.
  768. @lisp
  769. (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
  770. @end lisp
  771. @noindent Org mode buffers need font-lock to be turned on - this is the
  772. default in Emacs@footnote{If you don't use font-lock globally, turn it on in
  773. Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
  774. The four Org commands @command{org-store-link}, @command{org-capture},
  775. @command{org-agenda}, and @command{org-iswitchb} should be accessible through
  776. global keys (i.e.@: anywhere in Emacs, not just in Org buffers). Here are
  777. suggested bindings for these keys, please modify the keys to your own
  778. liking.
  779. @lisp
  780. (global-set-key "\C-cl" 'org-store-link)
  781. (global-set-key "\C-cc" 'org-capture)
  782. (global-set-key "\C-ca" 'org-agenda)
  783. (global-set-key "\C-cb" 'org-iswitchb)
  784. @end lisp
  785. @cindex Org mode, turning on
  786. With this setup, all files with extension @samp{.org} will be put
  787. into Org mode. As an alternative, make the first line of a file look
  788. like this:
  789. @example
  790. MY PROJECTS -*- mode: org; -*-
  791. @end example
  792. @vindex org-insert-mode-line-in-empty-file
  793. @noindent which will select Org mode for this buffer no matter what
  794. the file's name is. See also the variable
  795. @code{org-insert-mode-line-in-empty-file}.
  796. Many commands in Org work on the region if the region is @i{active}. To make
  797. use of this, you need to have @code{transient-mark-mode}
  798. (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
  799. in Emacs 22 you need to do this yourself with
  800. @lisp
  801. (transient-mark-mode 1)
  802. @end lisp
  803. @noindent If you do not like @code{transient-mark-mode}, you can create an
  804. active region by using the mouse to select a region, or pressing
  805. @kbd{C-@key{SPC}} twice before moving the cursor.
  806. @node Feedback, Conventions, Activation, Introduction
  807. @section Feedback
  808. @cindex feedback
  809. @cindex bug reports
  810. @cindex maintainer
  811. @cindex author
  812. If you find problems with Org, or if you have questions, remarks, or ideas
  813. about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
  814. If you are not a member of the mailing list, your mail will be passed to the
  815. list after a moderator has approved it@footnote{Please consider subscribing
  816. to the mailing list, in order to minimize the work the mailing list
  817. moderators have to do.}.
  818. For bug reports, please first try to reproduce the bug with the latest
  819. version of Org available---if you are running an outdated version, it is
  820. quite possible that the bug has been fixed already. If the bug persists,
  821. prepare a report and provide as much information as possible, including the
  822. version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
  823. (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
  824. @file{.emacs}. The easiest way to do this is to use the command
  825. @example
  826. @kbd{M-x org-submit-bug-report}
  827. @end example
  828. @noindent which will put all this information into an Emacs mail buffer so
  829. that you only need to add your description. If you re not sending the Email
  830. from within Emacs, please copy and paste the content into your Email program.
  831. Sometimes you might face a problem due to an error in your Emacs or Org mode
  832. setup. Before reporting a bug, it is very helpful to start Emacs with minimal
  833. customisations and reproduce the problem. Doing so often helps you determine
  834. if the problem is with your customization or with Org mode itself. You can
  835. start a typical minimal session with a command like the example below.
  836. @example
  837. $ emacs -Q -l /path/to/minimal-org.el
  838. @end example
  839. However if you are using Org mode as distributed with Emacs, a minimal setup
  840. is not necessary. In that case it is sufficient to start Emacs as @code{emacs
  841. -Q}. The @code{minimal-org.el} setup file can have contents as shown below.
  842. @example
  843. ;;; Minimal setup to load latest `org-mode'
  844. ;; activate debugging
  845. (setq debug-on-error t
  846. debug-on-signal nil
  847. debug-on-quit nil)
  848. ;; add latest org-mode to load path
  849. (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
  850. (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp"))
  851. ;; activate org
  852. (require 'org-install)
  853. @end example
  854. If an error occurs, a backtrace can be very useful (see below on how to
  855. create one). Often a small example file helps, along with clear information
  856. about:
  857. @enumerate
  858. @item What exactly did you do?
  859. @item What did you expect to happen?
  860. @item What happened instead?
  861. @end enumerate
  862. @noindent Thank you for helping to improve this program.
  863. @subsubheading How to create a useful backtrace
  864. @cindex backtrace of an error
  865. If working with Org produces an error with a message you don't
  866. understand, you may have hit a bug. The best way to report this is by
  867. providing, in addition to what was mentioned above, a @emph{backtrace}.
  868. This is information from the built-in debugger about where and how the
  869. error occurred. Here is how to produce a useful backtrace:
  870. @enumerate
  871. @item
  872. Reload uncompiled versions of all Org mode Lisp files. The backtrace
  873. contains much more information if it is produced with uncompiled code.
  874. To do this, use
  875. @example
  876. C-u M-x org-reload RET
  877. @end example
  878. @noindent
  879. or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
  880. menu.
  881. @item
  882. Go to the @code{Options} menu and select @code{Enter Debugger on Error}
  883. (XEmacs has this option in the @code{Troubleshooting} sub-menu).
  884. @item
  885. Do whatever you have to do to hit the error. Don't forget to
  886. document the steps you take.
  887. @item
  888. When you hit the error, a @file{*Backtrace*} buffer will appear on the
  889. screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
  890. attach it to your bug report.
  891. @end enumerate
  892. @node Conventions, , Feedback, Introduction
  893. @section Typesetting conventions used in this manual
  894. Org uses three types of keywords: TODO keywords, tags and property
  895. names. In this manual we use the following conventions:
  896. @table @code
  897. @item TODO
  898. @itemx WAITING
  899. TODO keywords are written with all capitals, even if they are
  900. user-defined.
  901. @item boss
  902. @itemx ARCHIVE
  903. User-defined tags are written in lowercase; built-in tags with special
  904. meaning are written with all capitals.
  905. @item Release
  906. @itemx PRIORITY
  907. User-defined properties are capitalized; built-in properties with
  908. special meaning are written with all capitals.
  909. @end table
  910. Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
  911. and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
  912. environment). They are written in uppercase in the manual to enhance its
  913. readability, but you can use lowercase in your Org files@footnote{Easy
  914. templates insert lowercase keywords and Babel dynamically inserts
  915. @code{#+results}.}
  916. The manual lists both the keys and the corresponding commands for accessing a
  917. functionality. Org mode often uses the same key for different functions,
  918. depending on context. The command that is bound to such keys has a generic
  919. name, like @code{org-metaright}. In the manual we will, wherever possible,
  920. give the function that is internally called by the generic command. For
  921. example, in the chapter on document structure, @kbd{M-@key{right}} will be
  922. listed to call @code{org-do-demote}, while in the chapter on tables, it will
  923. be listed to call org-table-move-column-right.
  924. If you prefer, you can compile the manual without the command names by
  925. unsetting the flag @code{cmdnames} in @file{org.texi}.
  926. @node Document Structure, Tables, Introduction, Top
  927. @chapter Document structure
  928. @cindex document structure
  929. @cindex structure of document
  930. Org is based on Outline mode and provides flexible commands to
  931. edit the structure of the document.
  932. @menu
  933. * Outlines:: Org is based on Outline mode
  934. * Headlines:: How to typeset Org tree headlines
  935. * Visibility cycling:: Show and hide, much simplified
  936. * Motion:: Jumping to other headlines
  937. * Structure editing:: Changing sequence and level of headlines
  938. * Sparse trees:: Matches embedded in context
  939. * Plain lists:: Additional structure within an entry
  940. * Drawers:: Tucking stuff away
  941. * Blocks:: Folding blocks
  942. * Footnotes:: How footnotes are defined in Org's syntax
  943. * Orgstruct mode:: Structure editing outside Org
  944. @end menu
  945. @node Outlines, Headlines, Document Structure, Document Structure
  946. @section Outlines
  947. @cindex outlines
  948. @cindex Outline mode
  949. Org is implemented on top of Outline mode. Outlines allow a
  950. document to be organized in a hierarchical structure, which (at least
  951. for me) is the best representation of notes and thoughts. An overview
  952. of this structure is achieved by folding (hiding) large parts of the
  953. document to show only the general document structure and the parts
  954. currently being worked on. Org greatly simplifies the use of
  955. outlines by compressing the entire show/hide functionality into a single
  956. command, @command{org-cycle}, which is bound to the @key{TAB} key.
  957. @node Headlines, Visibility cycling, Outlines, Document Structure
  958. @section Headlines
  959. @cindex headlines
  960. @cindex outline tree
  961. @vindex org-special-ctrl-a/e
  962. @vindex org-special-ctrl-k
  963. @vindex org-ctrl-k-protect-subtree
  964. Headlines define the structure of an outline tree. The headlines in Org
  965. start with one or more stars, on the left margin@footnote{See the variables
  966. @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
  967. @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
  968. @kbd{C-e}, and @kbd{C-k} in headlines.}. For example:
  969. @example
  970. * Top level headline
  971. ** Second level
  972. *** 3rd level
  973. some text
  974. *** 3rd level
  975. more text
  976. * Another top level headline
  977. @end example
  978. @noindent Some people find the many stars too noisy and would prefer an
  979. outline that has whitespace followed by a single star as headline
  980. starters. @ref{Clean view}, describes a setup to realize this.
  981. @vindex org-cycle-separator-lines
  982. An empty line after the end of a subtree is considered part of it and
  983. will be hidden when the subtree is folded. However, if you leave at
  984. least two empty lines, one empty line will remain visible after folding
  985. the subtree, in order to structure the collapsed view. See the
  986. variable @code{org-cycle-separator-lines} to modify this behavior.
  987. @node Visibility cycling, Motion, Headlines, Document Structure
  988. @section Visibility cycling
  989. @cindex cycling, visibility
  990. @cindex visibility cycling
  991. @cindex trees, visibility
  992. @cindex show hidden text
  993. @cindex hide text
  994. Outlines make it possible to hide parts of the text in the buffer.
  995. Org uses just two commands, bound to @key{TAB} and
  996. @kbd{S-@key{TAB}} to change the visibility in the buffer.
  997. @cindex subtree visibility states
  998. @cindex subtree cycling
  999. @cindex folded, subtree visibility state
  1000. @cindex children, subtree visibility state
  1001. @cindex subtree, subtree visibility state
  1002. @table @asis
  1003. @orgcmd{@key{TAB},org-cycle}
  1004. @emph{Subtree cycling}: Rotate current subtree among the states
  1005. @example
  1006. ,-> FOLDED -> CHILDREN -> SUBTREE --.
  1007. '-----------------------------------'
  1008. @end example
  1009. @vindex org-cycle-emulate-tab
  1010. @vindex org-cycle-global-at-bob
  1011. The cursor must be on a headline for this to work@footnote{see, however,
  1012. the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
  1013. beginning of the buffer and the first line is not a headline, then
  1014. @key{TAB} actually runs global cycling (see below)@footnote{see the
  1015. option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
  1016. argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
  1017. @cindex global visibility states
  1018. @cindex global cycling
  1019. @cindex overview, global visibility state
  1020. @cindex contents, global visibility state
  1021. @cindex show all, global visibility state
  1022. @orgcmd{S-@key{TAB},org-global-cycle}
  1023. @itemx C-u @key{TAB}
  1024. @emph{Global cycling}: Rotate the entire buffer among the states
  1025. @example
  1026. ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
  1027. '--------------------------------------'
  1028. @end example
  1029. When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
  1030. CONTENTS view up to headlines of level N will be shown. Note that inside
  1031. tables, @kbd{S-@key{TAB}} jumps to the previous field.
  1032. @cindex show all, command
  1033. @orgcmd{C-u C-u C-u @key{TAB},show-all}
  1034. Show all, including drawers.
  1035. @orgcmd{C-c C-r,org-reveal}
  1036. Reveal context around point, showing the current entry, the following heading
  1037. and the hierarchy above. Useful for working near a location that has been
  1038. exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
  1039. (@pxref{Agenda commands}). With a prefix argument show, on each
  1040. level, all sibling headings. With a double prefix argument, also show the
  1041. entire subtree of the parent.
  1042. @orgcmd{C-c C-k,show-branches}
  1043. Expose all the headings of the subtree, CONTENT view for just one subtree.
  1044. @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
  1045. Show the current subtree in an indirect buffer@footnote{The indirect
  1046. buffer
  1047. @ifinfo
  1048. (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
  1049. @end ifinfo
  1050. @ifnotinfo
  1051. (see the Emacs manual for more information about indirect buffers)
  1052. @end ifnotinfo
  1053. will contain the entire buffer, but will be narrowed to the current
  1054. tree. Editing the indirect buffer will also change the original buffer,
  1055. but without affecting visibility in that buffer.}. With a numeric
  1056. prefix argument N, go up to level N and then take that tree. If N is
  1057. negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
  1058. the previously used indirect buffer.
  1059. @orgcmd{C-c C-x v,org-copy-visible}
  1060. Copy the @i{visible} text in the region into the kill ring.
  1061. @end table
  1062. @vindex org-startup-folded
  1063. @cindex @code{overview}, STARTUP keyword
  1064. @cindex @code{content}, STARTUP keyword
  1065. @cindex @code{showall}, STARTUP keyword
  1066. @cindex @code{showeverything}, STARTUP keyword
  1067. When Emacs first visits an Org file, the global state is set to
  1068. OVERVIEW, i.e.@: only the top level headlines are visible. This can be
  1069. configured through the variable @code{org-startup-folded}, or on a
  1070. per-file basis by adding one of the following lines anywhere in the
  1071. buffer:
  1072. @example
  1073. #+STARTUP: overview
  1074. #+STARTUP: content
  1075. #+STARTUP: showall
  1076. #+STARTUP: showeverything
  1077. @end example
  1078. @cindex property, VISIBILITY
  1079. @noindent
  1080. Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
  1081. and Columns}) will get their visibility adapted accordingly. Allowed values
  1082. for this property are @code{folded}, @code{children}, @code{content}, and
  1083. @code{all}.
  1084. @table @asis
  1085. @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
  1086. Switch back to the startup visibility of the buffer, i.e.@: whatever is
  1087. requested by startup options and @samp{VISIBILITY} properties in individual
  1088. entries.
  1089. @end table
  1090. @node Motion, Structure editing, Visibility cycling, Document Structure
  1091. @section Motion
  1092. @cindex motion, between headlines
  1093. @cindex jumping, to headlines
  1094. @cindex headline navigation
  1095. The following commands jump to other headlines in the buffer.
  1096. @table @asis
  1097. @orgcmd{C-c C-n,outline-next-visible-heading}
  1098. Next heading.
  1099. @orgcmd{C-c C-p,outline-previous-visible-heading}
  1100. Previous heading.
  1101. @orgcmd{C-c C-f,org-forward-same-level}
  1102. Next heading same level.
  1103. @orgcmd{C-c C-b,org-backward-same-level}
  1104. Previous heading same level.
  1105. @orgcmd{C-c C-u,outline-up-heading}
  1106. Backward to higher level heading.
  1107. @orgcmd{C-c C-j,org-goto}
  1108. Jump to a different place without changing the current outline
  1109. visibility. Shows the document structure in a temporary buffer, where
  1110. you can use the following keys to find your destination:
  1111. @vindex org-goto-auto-isearch
  1112. @example
  1113. @key{TAB} @r{Cycle visibility.}
  1114. @key{down} / @key{up} @r{Next/previous visible headline.}
  1115. @key{RET} @r{Select this location.}
  1116. @kbd{/} @r{Do a Sparse-tree search}
  1117. @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
  1118. n / p @r{Next/previous visible headline.}
  1119. f / b @r{Next/previous headline same level.}
  1120. u @r{One level up.}
  1121. 0-9 @r{Digit argument.}
  1122. q @r{Quit}
  1123. @end example
  1124. @vindex org-goto-interface
  1125. @noindent
  1126. See also the variable @code{org-goto-interface}.
  1127. @end table
  1128. @node Structure editing, Sparse trees, Motion, Document Structure
  1129. @section Structure editing
  1130. @cindex structure editing
  1131. @cindex headline, promotion and demotion
  1132. @cindex promotion, of subtrees
  1133. @cindex demotion, of subtrees
  1134. @cindex subtree, cut and paste
  1135. @cindex pasting, of subtrees
  1136. @cindex cutting, of subtrees
  1137. @cindex copying, of subtrees
  1138. @cindex sorting, of subtrees
  1139. @cindex subtrees, cut and paste
  1140. @table @asis
  1141. @orgcmd{M-@key{RET},org-insert-heading}
  1142. @vindex org-M-RET-may-split-line
  1143. Insert new heading with same level as current. If the cursor is in a plain
  1144. list item, a new item is created (@pxref{Plain lists}). To force creation of
  1145. a new headline, use a prefix argument. When this command is used in the
  1146. middle of a line, the line is split and the rest of the line becomes the new
  1147. headline@footnote{If you do not want the line to be split, customize the
  1148. variable @code{org-M-RET-may-split-line}.}. If the command is used at the
  1149. beginning of a headline, the new headline is created before the current line.
  1150. If at the beginning of any other line, the content of that line is made the
  1151. new heading. If the command is used at the end of a folded subtree (i.e.@:
  1152. behind the ellipses at the end of a headline), then a headline like the
  1153. current one will be inserted after the end of the subtree.
  1154. @orgcmd{C-@key{RET},org-insert-heading-respect-content}
  1155. Just like @kbd{M-@key{RET}}, except when adding a new heading below the
  1156. current heading, the new heading is placed after the body instead of before
  1157. it. This command works from anywhere in the entry.
  1158. @orgcmd{M-S-@key{RET},org-insert-todo-heading}
  1159. @vindex org-treat-insert-todo-heading-as-state-change
  1160. Insert new TODO entry with same level as current heading. See also the
  1161. variable @code{org-treat-insert-todo-heading-as-state-change}.
  1162. @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
  1163. Insert new TODO entry with same level as current heading. Like
  1164. @kbd{C-@key{RET}}, the new headline will be inserted after the current
  1165. subtree.
  1166. @orgcmd{@key{TAB},org-cycle}
  1167. In a new entry with no text yet, the first @key{TAB} demotes the entry to
  1168. become a child of the previous one. The next @key{TAB} makes it a parent,
  1169. and so on, all the way to top level. Yet another @key{TAB}, and you are back
  1170. to the initial level.
  1171. @orgcmd{M-@key{left},org-do-promote}
  1172. Promote current heading by one level.
  1173. @orgcmd{M-@key{right},org-do-demote}
  1174. Demote current heading by one level.
  1175. @orgcmd{M-S-@key{left},org-promote-subtree}
  1176. Promote the current subtree by one level.
  1177. @orgcmd{M-S-@key{right},org-demote-subtree}
  1178. Demote the current subtree by one level.
  1179. @orgcmd{M-S-@key{up},org-move-subtree-up}
  1180. Move subtree up (swap with previous subtree of same
  1181. level).
  1182. @orgcmd{M-S-@key{down},org-move-subtree-down}
  1183. Move subtree down (swap with next subtree of same level).
  1184. @orgcmd{C-c C-x C-w,org-cut-subtree}
  1185. Kill subtree, i.e.@: remove it from buffer but save in kill ring.
  1186. With a numeric prefix argument N, kill N sequential subtrees.
  1187. @orgcmd{C-c C-x M-w,org-copy-subtree}
  1188. Copy subtree to kill ring. With a numeric prefix argument N, copy the N
  1189. sequential subtrees.
  1190. @orgcmd{C-c C-x C-y,org-paste-subtree}
  1191. Yank subtree from kill ring. This does modify the level of the subtree to
  1192. make sure the tree fits in nicely at the yank position. The yank level can
  1193. also be specified with a numeric prefix argument, or by yanking after a
  1194. headline marker like @samp{****}.
  1195. @orgcmd{C-y,org-yank}
  1196. @vindex org-yank-adjusted-subtrees
  1197. @vindex org-yank-folded-subtrees
  1198. Depending on the variables @code{org-yank-adjusted-subtrees} and
  1199. @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
  1200. paste subtrees folded and in a clever way, using the same command as @kbd{C-c
  1201. C-x C-y}. With the default settings, no level adjustment will take place,
  1202. but the yanked tree will be folded unless doing so would swallow text
  1203. previously visible. Any prefix argument to this command will force a normal
  1204. @code{yank} to be executed, with the prefix passed along. A good way to
  1205. force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
  1206. yank, it will yank previous kill items plainly, without adjustment and
  1207. folding.
  1208. @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
  1209. Clone a subtree by making a number of sibling copies of it. You will be
  1210. prompted for the number of copies to make, and you can also specify if any
  1211. timestamps in the entry should be shifted. This can be useful, for example,
  1212. to create a number of tasks related to a series of lectures to prepare. For
  1213. more details, see the docstring of the command
  1214. @code{org-clone-subtree-with-time-shift}.
  1215. @orgcmd{C-c C-w,org-refile}
  1216. Refile entry or region to a different location. @xref{Refiling notes}.
  1217. @orgcmd{C-c ^,org-sort}
  1218. Sort same-level entries. When there is an active region, all entries in the
  1219. region will be sorted. Otherwise the children of the current headline are
  1220. sorted. The command prompts for the sorting method, which can be
  1221. alphabetically, numerically, by time (first timestamp with active preferred,
  1222. creation time, scheduled time, deadline time), by priority, by TODO keyword
  1223. (in the sequence the keywords have been defined in the setup) or by the value
  1224. of a property. Reverse sorting is possible as well. You can also supply
  1225. your own function to extract the sorting key. With a @kbd{C-u} prefix,
  1226. sorting will be case-sensitive.
  1227. @orgcmd{C-x n s,org-narrow-to-subtree}
  1228. Narrow buffer to current subtree.
  1229. @orgcmd{C-x n b,org-narrow-to-block}
  1230. Narrow buffer to current block.
  1231. @orgcmd{C-x n w,widen}
  1232. Widen buffer to remove narrowing.
  1233. @orgcmd{C-c *,org-toggle-heading}
  1234. Turn a normal line or plain list item into a headline (so that it becomes a
  1235. subheading at its location). Also turn a headline into a normal line by
  1236. removing the stars. If there is an active region, turn all lines in the
  1237. region into headlines. If the first line in the region was an item, turn
  1238. only the item lines into headlines. Finally, if the first line is a
  1239. headline, remove the stars from all headlines in the region.
  1240. @end table
  1241. @cindex region, active
  1242. @cindex active region
  1243. @cindex transient mark mode
  1244. When there is an active region (Transient Mark mode), promotion and
  1245. demotion work on all headlines in the region. To select a region of
  1246. headlines, it is best to place both point and mark at the beginning of a
  1247. line, mark at the beginning of the first headline, and point at the line
  1248. just after the last headline to change. Note that when the cursor is
  1249. inside a table (@pxref{Tables}), the Meta-Cursor keys have different
  1250. functionality.
  1251. @node Sparse trees, Plain lists, Structure editing, Document Structure
  1252. @section Sparse trees
  1253. @cindex sparse trees
  1254. @cindex trees, sparse
  1255. @cindex folding, sparse trees
  1256. @cindex occur, command
  1257. @vindex org-show-hierarchy-above
  1258. @vindex org-show-following-heading
  1259. @vindex org-show-siblings
  1260. @vindex org-show-entry-below
  1261. An important feature of Org mode is the ability to construct @emph{sparse
  1262. trees} for selected information in an outline tree, so that the entire
  1263. document is folded as much as possible, but the selected information is made
  1264. visible along with the headline structure above it@footnote{See also the
  1265. variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
  1266. @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
  1267. control on how much context is shown around each match.}. Just try it out
  1268. and you will see immediately how it works.
  1269. Org mode contains several commands creating such trees, all these
  1270. commands can be accessed through a dispatcher:
  1271. @table @asis
  1272. @orgcmd{C-c /,org-sparse-tree}
  1273. This prompts for an extra key to select a sparse-tree creating command.
  1274. @orgcmd{C-c / r,org-occur}
  1275. @vindex org-remove-highlights-with-change
  1276. Prompts for a regexp and shows a sparse tree with all matches. If
  1277. the match is in a headline, the headline is made visible. If the match is in
  1278. the body of an entry, headline and body are made visible. In order to
  1279. provide minimal context, also the full hierarchy of headlines above the match
  1280. is shown, as well as the headline following the match. Each match is also
  1281. highlighted; the highlights disappear when the buffer is changed by an
  1282. editing command@footnote{This depends on the option
  1283. @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
  1284. When called with a @kbd{C-u} prefix argument, previous highlights are kept,
  1285. so several calls to this command can be stacked.
  1286. @orgcmdkkc{M-g n,M-g M-n,next-error}
  1287. Jump to the next sparse tree match in this buffer.
  1288. @orgcmdkkc{M-g p,M-g M-p,previous-error}
  1289. Jump to the previous sparse tree match in this buffer.
  1290. @end table
  1291. @noindent
  1292. @vindex org-agenda-custom-commands
  1293. For frequently used sparse trees of specific search strings, you can
  1294. use the variable @code{org-agenda-custom-commands} to define fast
  1295. keyboard access to specific sparse trees. These commands will then be
  1296. accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
  1297. For example:
  1298. @lisp
  1299. (setq org-agenda-custom-commands
  1300. '(("f" occur-tree "FIXME")))
  1301. @end lisp
  1302. @noindent will define the key @kbd{C-c a f} as a shortcut for creating
  1303. a sparse tree matching the string @samp{FIXME}.
  1304. The other sparse tree commands select headings based on TODO keywords,
  1305. tags, or properties and will be discussed later in this manual.
  1306. @kindex C-c C-e v
  1307. @cindex printing sparse trees
  1308. @cindex visible text, printing
  1309. To print a sparse tree, you can use the Emacs command
  1310. @code{ps-print-buffer-with-faces} which does not print invisible parts
  1311. of the document @footnote{This does not work under XEmacs, because
  1312. XEmacs uses selective display for outlining, not text properties.}.
  1313. Or you can use the command @kbd{C-c C-e v} to export only the visible
  1314. part of the document and print the resulting file.
  1315. @node Plain lists, Drawers, Sparse trees, Document Structure
  1316. @section Plain lists
  1317. @cindex plain lists
  1318. @cindex lists, plain
  1319. @cindex lists, ordered
  1320. @cindex ordered lists
  1321. Within an entry of the outline tree, hand-formatted lists can provide
  1322. additional structure. They also provide a way to create lists of checkboxes
  1323. (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
  1324. (@pxref{Exporting}) can parse and format them.
  1325. Org knows ordered lists, unordered lists, and description lists.
  1326. @itemize @bullet
  1327. @item
  1328. @emph{Unordered} list items start with @samp{-}, @samp{+}, or
  1329. @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
  1330. they will be seen as top-level headlines. Also, when you are hiding leading
  1331. stars to get a clean outline view, plain list items starting with a star may
  1332. be hard to distinguish from true headlines. In short: even though @samp{*}
  1333. is supported, it may be better to not use it for plain list items.} as
  1334. bullets.
  1335. @item
  1336. @vindex org-plain-list-ordered-item-terminator
  1337. @vindex org-alphabetical-lists
  1338. @emph{Ordered} list items start with a numeral followed by either a period or
  1339. a right parenthesis@footnote{You can filter out any of them by configuring
  1340. @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
  1341. @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
  1342. @samp{A)} by configuring @code{org-alphabetical-lists}. To minimize
  1343. confusion with normal text, those are limited to one character only. Beyond
  1344. that limit, bullets will automatically fallback to numbers.}. If you want a
  1345. list to start with a different value (e.g.@: 20), start the text of the item
  1346. with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
  1347. must be put @emph{before} the checkbox. If you have activated alphabetical
  1348. lists, you can also use counters like @code{[@@b]}.}. Those constructs can
  1349. be used in any item of the list in order to enforce a particular numbering.
  1350. @item
  1351. @emph{Description} list items are unordered list items, and contain the
  1352. separator @samp{ :: } to distinguish the description @emph{term} from the
  1353. description.
  1354. @end itemize
  1355. Items belonging to the same list must have the same indentation on the first
  1356. line. In particular, if an ordered list reaches number @samp{10.}, then the
  1357. 2--digit numbers must be written left-aligned with the other numbers in the
  1358. list. An item ends before the next line that is less or equally indented
  1359. than its bullet/number.
  1360. @vindex org-list-ending-method
  1361. @vindex org-list-end-regexp
  1362. @vindex org-empty-line-terminates-plain-lists
  1363. Two methods@footnote{To disable either of them, configure
  1364. @code{org-list-ending-method}.} are provided to terminate lists. A list ends
  1365. whenever every item has ended, which means before any line less or equally
  1366. indented than items at top level. It also ends before two blank
  1367. lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In
  1368. that case, all items are closed. For finer control, you can end lists with
  1369. any pattern set in @code{org-list-end-regexp}. Here is an example:
  1370. @example
  1371. @group
  1372. ** Lord of the Rings
  1373. My favorite scenes are (in this order)
  1374. 1. The attack of the Rohirrim
  1375. 2. Eowyn's fight with the witch king
  1376. + this was already my favorite scene in the book
  1377. + I really like Miranda Otto.
  1378. 3. Peter Jackson being shot by Legolas
  1379. - on DVD only
  1380. He makes a really funny face when it happens.
  1381. But in the end, no individual scenes matter but the film as a whole.
  1382. Important actors in this film are:
  1383. - @b{Elijah Wood} :: He plays Frodo
  1384. - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
  1385. him very well from his role as Mikey Walsh in @i{The Goonies}.
  1386. @end group
  1387. @end example
  1388. Org supports these lists by tuning filling and wrapping commands to deal with
  1389. them correctly@footnote{Org only changes the filling settings for Emacs. For
  1390. XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
  1391. put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
  1392. properly (@pxref{Exporting}). Since indentation is what governs the
  1393. structure of these lists, many structural constructs like @code{#+BEGIN_...}
  1394. blocks can be indented to signal that they belong to a particular item.
  1395. @vindex org-list-demote-modify-bullet
  1396. @vindex org-list-indent-offset
  1397. If you find that using a different bullet for a sub-list (than that used for
  1398. the current list-level) improves readability, customize the variable
  1399. @code{org-list-demote-modify-bullet}. To get a greater difference of
  1400. indentation between items and theirs sub-items, customize
  1401. @code{org-list-indent-offset}.
  1402. @vindex org-list-automatic-rules
  1403. The following commands act on items when the cursor is in the first line of
  1404. an item (the line with the bullet or number). Some of them imply the
  1405. application of automatic rules to keep list structure intact. If some of
  1406. these actions get in your way, configure @code{org-list-automatic-rules}
  1407. to disable them individually.
  1408. @table @asis
  1409. @orgcmd{@key{TAB},org-cycle}
  1410. @cindex cycling, in plain lists
  1411. @vindex org-cycle-include-plain-lists
  1412. Items can be folded just like headline levels. Normally this works only if
  1413. the cursor is on a plain list item. For more details, see the variable
  1414. @code{org-cycle-include-plain-lists}. If this variable is set to
  1415. @code{integrate}, plain list items will be treated like low-level
  1416. headlines. The level of an item is then given by the indentation of the
  1417. bullet/number. Items are always subordinate to real headlines, however; the
  1418. hierarchies remain completely separated. In a new item with no text yet, the
  1419. first @key{TAB} demotes the item to become a child of the previous
  1420. one. Subsequent @key{TAB}s move the item to meaningful levels in the list
  1421. and eventually get it back to its initial position.
  1422. @orgcmd{M-@key{RET},org-insert-heading}
  1423. @vindex org-M-RET-may-split-line
  1424. @vindex org-list-automatic-rules
  1425. Insert new item at current level. With a prefix argument, force a new
  1426. heading (@pxref{Structure editing}). If this command is used in the middle
  1427. of an item, that item is @emph{split} in two, and the second part becomes the
  1428. new item@footnote{If you do not want the item to be split, customize the
  1429. variable @code{org-M-RET-may-split-line}.}. If this command is executed
  1430. @emph{before item's body}, the new item is created @emph{before} the current
  1431. one.
  1432. @end table
  1433. @table @kbd
  1434. @kindex M-S-@key{RET}
  1435. @item M-S-RET
  1436. Insert a new item with a checkbox (@pxref{Checkboxes}).
  1437. @kindex S-@key{down}
  1438. @item S-up
  1439. @itemx S-down
  1440. @cindex shift-selection-mode
  1441. @vindex org-support-shift-select
  1442. @vindex org-list-use-circular-motion
  1443. Jump to the previous/next item in the current list@footnote{If you want to
  1444. cycle around items that way, you may customize
  1445. @code{org-list-use-circular-motion}.}, but only if
  1446. @code{org-support-shift-select} is off. If not, you can still use paragraph
  1447. jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
  1448. similar effect.
  1449. @kindex M-@key{up}
  1450. @kindex M-@key{down}
  1451. @item M-up
  1452. @itemx M-down
  1453. Move the item including subitems up/down@footnote{See
  1454. @code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with
  1455. previous/next item of same indentation). If the list is ordered, renumbering
  1456. is automatic.
  1457. @kindex M-@key{left}
  1458. @kindex M-@key{right}
  1459. @item M-left
  1460. @itemx M-right
  1461. Decrease/increase the indentation of an item, leaving children alone.
  1462. @kindex M-S-@key{left}
  1463. @kindex M-S-@key{right}
  1464. @item M-S-left
  1465. @itemx M-S-right
  1466. Decrease/increase the indentation of the item, including subitems.
  1467. Initially, the item tree is selected based on current indentation. When
  1468. these commands are executed several times in direct succession, the initially
  1469. selected region is used, even if the new indentation would imply a different
  1470. hierarchy. To use the new hierarchy, break the command chain with a cursor
  1471. motion or so.
  1472. As a special case, using this command on the very first item of a list will
  1473. move the whole list. This behavior can be disabled by configuring
  1474. @code{org-list-automatic-rules}. The global indentation of a list has no
  1475. influence on the text @emph{after} the list.
  1476. @kindex C-c C-c
  1477. @item C-c C-c
  1478. If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
  1479. state of the checkbox. In any case, verify bullets and indentation
  1480. consistency in the whole list.
  1481. @kindex C-c -
  1482. @vindex org-plain-list-ordered-item-terminator
  1483. @vindex org-list-automatic-rules
  1484. @item C-c -
  1485. Cycle the entire list level through the different itemize/enumerate bullets
  1486. (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
  1487. depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
  1488. and its position@footnote{See @code{bullet} rule in
  1489. @code{org-list-automatic-rules} for more information.}. With a numeric
  1490. prefix argument N, select the Nth bullet from this list. If there is an
  1491. active region when calling this, selected text will be changed into an item.
  1492. With a prefix argument, all lines will be converted to list items. If the
  1493. first line already was a list item, any item marker will be removed from the
  1494. list. Finally, even without an active region, a normal line will be
  1495. converted into a list item.
  1496. @kindex C-c *
  1497. @item C-c *
  1498. Turn a plain list item into a headline (so that it becomes a subheading at
  1499. its location). @xref{Structure editing}, for a detailed explanation.
  1500. @kindex C-c C-*
  1501. @item C-c C-*
  1502. Turn the whole plain list into a subtree of the current heading. Checkboxes
  1503. (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
  1504. (resp. checked).
  1505. @kindex S-@key{left}
  1506. @kindex S-@key{right}
  1507. @item S-left/right
  1508. @vindex org-support-shift-select
  1509. This command also cycles bullet styles when the cursor in on the bullet or
  1510. anywhere in an item line, details depending on
  1511. @code{org-support-shift-select}.
  1512. @kindex C-c ^
  1513. @item C-c ^
  1514. Sort the plain list. You will be prompted for the sorting method:
  1515. numerically, alphabetically, by time, or by custom function.
  1516. @end table
  1517. @node Drawers, Blocks, Plain lists, Document Structure
  1518. @section Drawers
  1519. @cindex drawers
  1520. @cindex #+DRAWERS
  1521. @cindex visibility cycling, drawers
  1522. @vindex org-drawers
  1523. Sometimes you want to keep information associated with an entry, but you
  1524. normally don't want to see it. For this, Org mode has @emph{drawers}.
  1525. Drawers need to be configured with the variable
  1526. @code{org-drawers}@footnote{You can define drawers on a per-file basis
  1527. with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
  1528. look like this:
  1529. @example
  1530. ** This is a headline
  1531. Still outside the drawer
  1532. :DRAWERNAME:
  1533. This is inside the drawer.
  1534. :END:
  1535. After the drawer.
  1536. @end example
  1537. Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
  1538. show the entry, but keep the drawer collapsed to a single line. In order to
  1539. look inside the drawer, you need to move the cursor to the drawer line and
  1540. press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
  1541. storing properties (@pxref{Properties and Columns}), and you can also arrange
  1542. for state change notes (@pxref{Tracking TODO state changes}) and clock times
  1543. (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
  1544. want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
  1545. @table @kbd
  1546. @kindex C-c C-z
  1547. @item C-c C-z
  1548. Add a time-stamped note to the LOGBOOK drawer.
  1549. @end table
  1550. @node Blocks, Footnotes, Drawers, Document Structure
  1551. @section Blocks
  1552. @vindex org-hide-block-startup
  1553. @cindex blocks, folding
  1554. Org mode uses begin...end blocks for various purposes from including source
  1555. code examples (@pxref{Literal examples}) to capturing time logging
  1556. information (@pxref{Clocking work time}). These blocks can be folded and
  1557. unfolded by pressing TAB in the begin line. You can also get all blocks
  1558. folded at startup by configuring the variable @code{org-hide-block-startup}
  1559. or on a per-file basis by using
  1560. @cindex @code{hideblocks}, STARTUP keyword
  1561. @cindex @code{nohideblocks}, STARTUP keyword
  1562. @example
  1563. #+STARTUP: hideblocks
  1564. #+STARTUP: nohideblocks
  1565. @end example
  1566. @node Footnotes, Orgstruct mode, Blocks, Document Structure
  1567. @section Footnotes
  1568. @cindex footnotes
  1569. Org mode supports the creation of footnotes. In contrast to the
  1570. @file{footnote.el} package, Org mode's footnotes are designed for work on a
  1571. larger document, not only for one-off documents like emails. The basic
  1572. syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is
  1573. defined in a paragraph that is started by a footnote marker in square
  1574. brackets in column 0, no indentation allowed. If you need a paragraph break
  1575. inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
  1576. is simply the marker in square brackets, inside text. For example:
  1577. @example
  1578. The Org homepage[fn:1] now looks a lot better than it used to.
  1579. ...
  1580. [fn:1] The link is: http://orgmode.org
  1581. @end example
  1582. Org mode extends the number-based syntax to @emph{named} footnotes and
  1583. optional inline definition. Using plain numbers as markers (as
  1584. @file{footnote.el} does) is supported for backward compatibility, but not
  1585. encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
  1586. @LaTeX{}}). Here are the valid references:
  1587. @table @code
  1588. @item [1]
  1589. A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
  1590. recommended because something like @samp{[1]} could easily be part of a code
  1591. snippet.
  1592. @item [fn:name]
  1593. A named footnote reference, where @code{name} is a unique label word, or, for
  1594. simplicity of automatic creation, a number.
  1595. @item [fn:: This is the inline definition of this footnote]
  1596. A @LaTeX{}-like anonymous footnote where the definition is given directly at the
  1597. reference point.
  1598. @item [fn:name: a definition]
  1599. An inline definition of a footnote, which also specifies a name for the note.
  1600. Since Org allows multiple references to the same note, you can then use
  1601. @code{[fn:name]} to create additional references.
  1602. @end table
  1603. @vindex org-footnote-auto-label
  1604. Footnote labels can be created automatically, or you can create names yourself.
  1605. This is handled by the variable @code{org-footnote-auto-label} and its
  1606. corresponding @code{#+STARTUP} keywords. See the docstring of that variable
  1607. for details.
  1608. @noindent The following command handles footnotes:
  1609. @table @kbd
  1610. @kindex C-c C-x f
  1611. @item C-c C-x f
  1612. The footnote action command.
  1613. When the cursor is on a footnote reference, jump to the definition. When it
  1614. is at a definition, jump to the (first) reference.
  1615. @vindex org-footnote-define-inline
  1616. @vindex org-footnote-section
  1617. @vindex org-footnote-auto-adjust
  1618. Otherwise, create a new footnote. Depending on the variable
  1619. @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
  1620. setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
  1621. definition will be placed right into the text as part of the reference, or
  1622. separately into the location determined by the variable
  1623. @code{org-footnote-section}.
  1624. When this command is called with a prefix argument, a menu of additional
  1625. options is offered:
  1626. @example
  1627. s @r{Sort the footnote definitions by reference sequence. During editing,}
  1628. @r{Org makes no effort to sort footnote definitions into a particular}
  1629. @r{sequence. If you want them sorted, use this command, which will}
  1630. @r{also move entries according to @code{org-footnote-section}. Automatic}
  1631. @r{sorting after each insertion/deletion can be configured using the}
  1632. @r{variable @code{org-footnote-auto-adjust}.}
  1633. r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
  1634. @r{after each insertion/deletion can be configured using the variable}
  1635. @r{@code{org-footnote-auto-adjust}.}
  1636. S @r{Short for first @code{r}, then @code{s} action.}
  1637. n @r{Normalize the footnotes by collecting all definitions (including}
  1638. @r{inline definitions) into a special section, and then numbering them}
  1639. @r{in sequence. The references will then also be numbers. This is}
  1640. @r{meant to be the final step before finishing a document (e.g.@: sending}
  1641. @r{off an email). The exporters do this automatically, and so could}
  1642. @r{something like @code{message-send-hook}.}
  1643. d @r{Delete the footnote at point, and all definitions of and references}
  1644. @r{to it.}
  1645. @end example
  1646. Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
  1647. corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
  1648. renumbering and sorting footnotes can be automatic after each insertion or
  1649. deletion.
  1650. @kindex C-c C-c
  1651. @item C-c C-c
  1652. If the cursor is on a footnote reference, jump to the definition. If it is a
  1653. the definition, jump back to the reference. When called at a footnote
  1654. location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
  1655. @kindex C-c C-o
  1656. @kindex mouse-1
  1657. @kindex mouse-2
  1658. @item C-c C-o @r{or} mouse-1/2
  1659. Footnote labels are also links to the corresponding definition/reference, and
  1660. you can use the usual commands to follow these links.
  1661. @end table
  1662. @node Orgstruct mode, , Footnotes, Document Structure
  1663. @section The Orgstruct minor mode
  1664. @cindex Orgstruct mode
  1665. @cindex minor mode for structure editing
  1666. If you like the intuitive way the Org mode structure editing and list
  1667. formatting works, you might want to use these commands in other modes like
  1668. Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
  1669. this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
  1670. turn it on by default, for example in Message mode, with one of:
  1671. @lisp
  1672. (add-hook 'message-mode-hook 'turn-on-orgstruct)
  1673. (add-hook 'message-mode-hook 'turn-on-orgstruct++)
  1674. @end lisp
  1675. When this mode is active and the cursor is on a line that looks to Org like a
  1676. headline or the first line of a list item, most structure editing commands
  1677. will work, even if the same keys normally have different functionality in the
  1678. major mode you are using. If the cursor is not in one of those special
  1679. lines, Orgstruct mode lurks silently in the shadows. When you use
  1680. @code{orgstruct++-mode}, Org will also export indentation and autofill
  1681. settings into that mode, and detect item context after the first line of an
  1682. item.
  1683. @node Tables, Hyperlinks, Document Structure, Top
  1684. @chapter Tables
  1685. @cindex tables
  1686. @cindex editing tables
  1687. Org comes with a fast and intuitive table editor. Spreadsheet-like
  1688. calculations are supported using the Emacs @file{calc} package
  1689. @ifinfo
  1690. (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
  1691. @end ifinfo
  1692. @ifnotinfo
  1693. (see the Emacs Calculator manual for more information about the Emacs
  1694. calculator).
  1695. @end ifnotinfo
  1696. @menu
  1697. * Built-in table editor:: Simple tables
  1698. * Column width and alignment:: Overrule the automatic settings
  1699. * Column groups:: Grouping to trigger vertical lines
  1700. * Orgtbl mode:: The table editor as minor mode
  1701. * The spreadsheet:: The table editor has spreadsheet capabilities
  1702. * Org-Plot:: Plotting from org tables
  1703. @end menu
  1704. @node Built-in table editor, Column width and alignment, Tables, Tables
  1705. @section The built-in table editor
  1706. @cindex table editor, built-in
  1707. Org makes it easy to format tables in plain ASCII. Any line with @samp{|} as
  1708. the first non-whitespace character is considered part of a table. @samp{|}
  1709. is also the column separator@footnote{To insert a vertical bar into a table
  1710. field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
  1711. might look like this:
  1712. @example
  1713. | Name | Phone | Age |
  1714. |-------+-------+-----|
  1715. | Peter | 1234 | 17 |
  1716. | Anna | 4321 | 25 |
  1717. @end example
  1718. A table is re-aligned automatically each time you press @key{TAB} or
  1719. @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
  1720. the next field (@key{RET} to the next row) and creates new table rows
  1721. at the end of the table or before horizontal lines. The indentation
  1722. of the table is set by the first line. Any line starting with
  1723. @samp{|-} is considered as a horizontal separator line and will be
  1724. expanded on the next re-align to span the whole table width. So, to
  1725. create the above table, you would only type
  1726. @example
  1727. |Name|Phone|Age|
  1728. |-
  1729. @end example
  1730. @noindent and then press @key{TAB} to align the table and start filling in
  1731. fields. Even faster would be to type @code{|Name|Phone|Age} followed by
  1732. @kbd{C-c @key{RET}}.
  1733. @vindex org-enable-table-editor
  1734. @vindex org-table-auto-blank-field
  1735. When typing text into a field, Org treats @key{DEL},
  1736. @key{Backspace}, and all character keys in a special way, so that
  1737. inserting and deleting avoids shifting other fields. Also, when
  1738. typing @emph{immediately after the cursor was moved into a new field
  1739. with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
  1740. field is automatically made blank. If this behavior is too
  1741. unpredictable for you, configure the variables
  1742. @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
  1743. @table @kbd
  1744. @tsubheading{Creation and conversion}
  1745. @orgcmd{C-c |,org-table-create-or-convert-from-region}
  1746. Convert the active region to table. If every line contains at least one
  1747. TAB character, the function assumes that the material is tab separated.
  1748. If every line contains a comma, comma-separated values (CSV) are assumed.
  1749. If not, lines are split at whitespace into fields. You can use a prefix
  1750. argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
  1751. C-u} forces TAB, and a numeric argument N indicates that at least N
  1752. consecutive spaces, or alternatively a TAB will be the separator.
  1753. @*
  1754. If there is no active region, this command creates an empty Org
  1755. table. But it is easier just to start typing, like
  1756. @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
  1757. @tsubheading{Re-aligning and field motion}
  1758. @orgcmd{C-c C-c,org-table-align}
  1759. Re-align the table without moving the cursor.
  1760. @c
  1761. @orgcmd{<TAB>,org-table-next-field}
  1762. Re-align the table, move to the next field. Creates a new row if
  1763. necessary.
  1764. @c
  1765. @orgcmd{S-@key{TAB},org-table-previous-field}
  1766. Re-align, move to previous field.
  1767. @c
  1768. @orgcmd{@key{RET},org-table-next-row}
  1769. Re-align the table and move down to next row. Creates a new row if
  1770. necessary. At the beginning or end of a line, @key{RET} still does
  1771. NEWLINE, so it can be used to split a table.
  1772. @c
  1773. @orgcmd{M-a,org-table-beginning-of-field}
  1774. Move to beginning of the current table field, or on to the previous field.
  1775. @orgcmd{M-e,org-table-end-of-field}
  1776. Move to end of the current table field, or on to the next field.
  1777. @tsubheading{Column and row editing}
  1778. @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
  1779. Move the current column left/right.
  1780. @c
  1781. @orgcmd{M-S-@key{left},org-table-delete-column}
  1782. Kill the current column.
  1783. @c
  1784. @orgcmd{M-S-@key{right},org-table-insert-column}
  1785. Insert a new column to the left of the cursor position.
  1786. @c
  1787. @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
  1788. Move the current row up/down.
  1789. @c
  1790. @orgcmd{M-S-@key{up},org-table-kill-row}
  1791. Kill the current row or horizontal line.
  1792. @c
  1793. @orgcmd{M-S-@key{down},org-table-insert-row}
  1794. Insert a new row above the current row. With a prefix argument, the line is
  1795. created below the current one.
  1796. @c
  1797. @orgcmd{C-c -,org-table-insert-hline}
  1798. Insert a horizontal line below current row. With a prefix argument, the line
  1799. is created above the current line.
  1800. @c
  1801. @orgcmd{C-c @key{RET},org-table-hline-and-move}
  1802. Insert a horizontal line below current row, and move the cursor into the row
  1803. below that line.
  1804. @c
  1805. @orgcmd{C-c ^,org-table-sort-lines}
  1806. Sort the table lines in the region. The position of point indicates the
  1807. column to be used for sorting, and the range of lines is the range
  1808. between the nearest horizontal separator lines, or the entire table. If
  1809. point is before the first column, you will be prompted for the sorting
  1810. column. If there is an active region, the mark specifies the first line
  1811. and the sorting column, while point should be in the last line to be
  1812. included into the sorting. The command prompts for the sorting type
  1813. (alphabetically, numerically, or by time). When called with a prefix
  1814. argument, alphabetic sorting will be case-sensitive.
  1815. @tsubheading{Regions}
  1816. @orgcmd{C-c C-x M-w,org-table-copy-region}
  1817. Copy a rectangular region from a table to a special clipboard. Point and
  1818. mark determine edge fields of the rectangle. If there is no active region,
  1819. copy just the current field. The process ignores horizontal separator lines.
  1820. @c
  1821. @orgcmd{C-c C-x C-w,org-table-cut-region}
  1822. Copy a rectangular region from a table to a special clipboard, and
  1823. blank all fields in the rectangle. So this is the ``cut'' operation.
  1824. @c
  1825. @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
  1826. Paste a rectangular region into a table.
  1827. The upper left corner ends up in the current field. All involved fields
  1828. will be overwritten. If the rectangle does not fit into the present table,
  1829. the table is enlarged as needed. The process ignores horizontal separator
  1830. lines.
  1831. @c
  1832. @orgcmd{M-@key{RET},org-table-wrap-region}
  1833. Split the current field at the cursor position and move the rest to the line
  1834. below. If there is an active region, and both point and mark are in the same
  1835. column, the text in the column is wrapped to minimum width for the given
  1836. number of lines. A numeric prefix argument may be used to change the number
  1837. of desired lines. If there is no region, but you specify a prefix argument,
  1838. the current field is made blank, and the content is appended to the field
  1839. above.
  1840. @tsubheading{Calculations}
  1841. @cindex formula, in tables
  1842. @cindex calculations, in tables
  1843. @cindex region, active
  1844. @cindex active region
  1845. @cindex transient mark mode
  1846. @orgcmd{C-c +,org-table-sum}
  1847. Sum the numbers in the current column, or in the rectangle defined by
  1848. the active region. The result is shown in the echo area and can
  1849. be inserted with @kbd{C-y}.
  1850. @c
  1851. @orgcmd{S-@key{RET},org-table-copy-down}
  1852. @vindex org-table-copy-increment
  1853. When current field is empty, copy from first non-empty field above. When not
  1854. empty, copy current field down to next row and move cursor along with it.
  1855. Depending on the variable @code{org-table-copy-increment}, integer field
  1856. values will be incremented during copy. Integers that are too large will not
  1857. be incremented. Also, a @code{0} prefix argument temporarily disables the
  1858. increment. This key is also used by shift-selection and related modes
  1859. (@pxref{Conflicts}).
  1860. @tsubheading{Miscellaneous}
  1861. @orgcmd{C-c `,org-table-edit-field}
  1862. Edit the current field in a separate window. This is useful for fields that
  1863. are not fully visible (@pxref{Column width and alignment}). When called with
  1864. a @kbd{C-u} prefix, just make the full field visible, so that it can be
  1865. edited in place. When called with two @kbd{C-u} prefixes, make the editor
  1866. window follow the cursor through the table and always show the current
  1867. field. The follow mode exits automatically when the cursor leaves the table,
  1868. or when you repeat this command with @kbd{C-u C-u C-c `}.
  1869. @c
  1870. @item M-x org-table-import
  1871. Import a file as a table. The table should be TAB or whitespace
  1872. separated. Use, for example, to import a spreadsheet table or data
  1873. from a database, because these programs generally can write
  1874. TAB-separated text files. This command works by inserting the file into
  1875. the buffer and then converting the region to a table. Any prefix
  1876. argument is passed on to the converter, which uses it to determine the
  1877. separator.
  1878. @orgcmd{C-c |,org-table-create-or-convert-from-region}
  1879. Tables can also be imported by pasting tabular text into the Org
  1880. buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
  1881. @kbd{C-c |} command (see above under @i{Creation and conversion}).
  1882. @c
  1883. @item M-x org-table-export
  1884. @findex org-table-export
  1885. @vindex org-table-export-default-format
  1886. Export the table, by default as a TAB-separated file. Use for data
  1887. exchange with, for example, spreadsheet or database programs. The format
  1888. used to export the file can be configured in the variable
  1889. @code{org-table-export-default-format}. You may also use properties
  1890. @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
  1891. name and the format for table export in a subtree. Org supports quite
  1892. general formats for exported tables. The exporter format is the same as the
  1893. format used by Orgtbl radio tables, see @ref{Translator functions}, for a
  1894. detailed description.
  1895. @end table
  1896. If you don't like the automatic table editor because it gets in your
  1897. way on lines which you would like to start with @samp{|}, you can turn
  1898. it off with
  1899. @lisp
  1900. (setq org-enable-table-editor nil)
  1901. @end lisp
  1902. @noindent Then the only table command that still works is
  1903. @kbd{C-c C-c} to do a manual re-align.
  1904. @node Column width and alignment, Column groups, Built-in table editor, Tables
  1905. @section Column width and alignment
  1906. @cindex narrow columns in tables
  1907. @cindex alignment in tables
  1908. The width of columns is automatically determined by the table editor. And
  1909. also the alignment of a column is determined automatically from the fraction
  1910. of number-like versus non-number fields in the column.
  1911. Sometimes a single field or a few fields need to carry more text, leading to
  1912. inconveniently wide columns. Or maybe you want to make a table with several
  1913. columns having a fixed width, regardless of content. To set@footnote{This
  1914. feature does not work on XEmacs.} the width of a column, one field anywhere
  1915. in the column may contain just the string @samp{<N>} where @samp{N} is an
  1916. integer specifying the width of the column in characters. The next re-align
  1917. will then set the width of this column to this value.
  1918. @example
  1919. @group
  1920. |---+------------------------------| |---+--------|
  1921. | | | | | <6> |
  1922. | 1 | one | | 1 | one |
  1923. | 2 | two | ----\ | 2 | two |
  1924. | 3 | This is a long chunk of text | ----/ | 3 | This=> |
  1925. | 4 | four | | 4 | four |
  1926. |---+------------------------------| |---+--------|
  1927. @end group
  1928. @end example
  1929. @noindent
  1930. Fields that are wider become clipped and end in the string @samp{=>}.
  1931. Note that the full text is still in the buffer but is hidden.
  1932. To see the full text, hold the mouse over the field---a tool-tip window
  1933. will show the full content. To edit such a field, use the command
  1934. @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
  1935. open a new window with the full field. Edit it and finish with @kbd{C-c
  1936. C-c}.
  1937. @vindex org-startup-align-all-tables
  1938. When visiting a file containing a table with narrowed columns, the
  1939. necessary character hiding has not yet happened, and the table needs to
  1940. be aligned before it looks nice. Setting the option
  1941. @code{org-startup-align-all-tables} will realign all tables in a file
  1942. upon visiting, but also slow down startup. You can also set this option
  1943. on a per-file basis with:
  1944. @example
  1945. #+STARTUP: align
  1946. #+STARTUP: noalign
  1947. @end example
  1948. If you would like to overrule the automatic alignment of number-rich columns
  1949. to the right and of string-rich column to the left, you can use @samp{<r>},
  1950. @samp{c}@footnote{Centering does not work inside Emacs, but it does have an
  1951. effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
  1952. also combine alignment and field width like this: @samp{<l10>}.
  1953. Lines which only contain these formatting cookies will be removed
  1954. automatically when exporting the document.
  1955. @node Column groups, Orgtbl mode, Column width and alignment, Tables
  1956. @section Column groups
  1957. @cindex grouping columns in tables
  1958. When Org exports tables, it does so by default without vertical
  1959. lines because that is visually more satisfying in general. Occasionally
  1960. however, vertical lines can be useful to structure a table into groups
  1961. of columns, much like horizontal lines can do for groups of rows. In
  1962. order to specify column groups, you can use a special row where the
  1963. first field contains only @samp{/}. The further fields can either
  1964. contain @samp{<} to indicate that this column should start a group,
  1965. @samp{>} to indicate the end of a column, or @samp{<>} to make a column
  1966. a group of its own. Boundaries between column groups will upon export be
  1967. marked with vertical lines. Here is an example:
  1968. @example
  1969. | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  1970. |---+-----+-----+-----+---------+------------|
  1971. | / | < | | > | < | > |
  1972. | 1 | 1 | 1 | 1 | 1 | 1 |
  1973. | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
  1974. | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
  1975. |---+-----+-----+-----+---------+------------|
  1976. #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
  1977. @end example
  1978. It is also sufficient to just insert the column group starters after
  1979. every vertical line you would like to have:
  1980. @example
  1981. | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  1982. |----+-----+-----+-----+---------+------------|
  1983. | / | < | | | < | |
  1984. @end example
  1985. @node Orgtbl mode, The spreadsheet, Column groups, Tables
  1986. @section The Orgtbl minor mode
  1987. @cindex Orgtbl mode
  1988. @cindex minor mode for tables
  1989. If you like the intuitive way the Org table editor works, you
  1990. might also want to use it in other modes like Text mode or Mail mode.
  1991. The minor mode Orgtbl mode makes this possible. You can always toggle
  1992. the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
  1993. example in Message mode, use
  1994. @lisp
  1995. (add-hook 'message-mode-hook 'turn-on-orgtbl)
  1996. @end lisp
  1997. Furthermore, with some special setup, it is possible to maintain tables
  1998. in arbitrary syntax with Orgtbl mode. For example, it is possible to
  1999. construct @LaTeX{} tables with the underlying ease and power of
  2000. Orgtbl mode, including spreadsheet capabilities. For details, see
  2001. @ref{Tables in arbitrary syntax}.
  2002. @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
  2003. @section The spreadsheet
  2004. @cindex calculations, in tables
  2005. @cindex spreadsheet capabilities
  2006. @cindex @file{calc} package
  2007. The table editor makes use of the Emacs @file{calc} package to implement
  2008. spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
  2009. derive fields from other fields. While fully featured, Org's implementation
  2010. is not identical to other spreadsheets. For example, Org knows the concept
  2011. of a @emph{column formula} that will be applied to all non-header fields in a
  2012. column without having to copy the formula to each relevant field. There is
  2013. also a formula debugger, and a formula editor with features for highlighting
  2014. fields in the table corresponding to the references at the point in the
  2015. formula, moving these references by arrow keys
  2016. @menu
  2017. * References:: How to refer to another field or range
  2018. * Formula syntax for Calc:: Using Calc to compute stuff
  2019. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  2020. * Durations and time values:: How to compute durations and time values
  2021. * Field and range formulas:: Formula for specific (ranges of) fields
  2022. * Column formulas:: Formulas valid for an entire column
  2023. * Editing and debugging formulas:: Fixing formulas
  2024. * Updating the table:: Recomputing all dependent fields
  2025. * Advanced features:: Field and column names, parameters and automatic recalc
  2026. @end menu
  2027. @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
  2028. @subsection References
  2029. @cindex references
  2030. To compute fields in the table from other fields, formulas must
  2031. reference other fields or ranges. In Org, fields can be referenced
  2032. by name, by absolute coordinates, and by relative coordinates. To find
  2033. out what the coordinates of a field are, press @kbd{C-c ?} in that
  2034. field, or press @kbd{C-c @}} to toggle the display of a grid.
  2035. @subsubheading Field references
  2036. @cindex field references
  2037. @cindex references, to fields
  2038. Formulas can reference the value of another field in two ways. Like in
  2039. any other spreadsheet, you may reference fields with a letter/number
  2040. combination like @code{B3}, meaning the 2nd field in the 3rd row.
  2041. @vindex org-table-use-standard-references
  2042. However, Org prefers@footnote{Org will understand references typed by the
  2043. user as @samp{B4}, but it will not use this syntax when offering a formula
  2044. for editing. You can customize this behavior using the variable
  2045. @code{org-table-use-standard-references}.} to use another, more general
  2046. representation that looks like this:
  2047. @example
  2048. @@@var{row}$@var{column}
  2049. @end example
  2050. Column specifications can be absolute like @code{$1},
  2051. @code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the
  2052. column of the field which is being computed) like @code{$+1} or @code{$-2}.
  2053. @code{$<} and @code{$>} are immutable references to the first and last
  2054. column, respectively, and you can use @code{$>>>} to indicate the third
  2055. column from the right.
  2056. The row specification only counts data lines and ignores horizontal separator
  2057. lines (hlines). Like with columns, you can use absolute row numbers
  2058. @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
  2059. current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
  2060. immutable references the first and last@footnote{For backward compatibility
  2061. you can also use special names like @code{$LR5} and @code{$LR12} to refer in
  2062. a stable way to the 5th and 12th field in the last row of the table.
  2063. However, this syntax is deprecated, it should not be used for new documents.
  2064. Use @code{@@>$} instead.} row in the table, respectively. You may also
  2065. specify the row relative to one of the hlines: @code{@@I} refers to the first
  2066. hline, @code{@@II} to the second, etc@. @code{@@-I} refers to the first such
  2067. line above the current line, @code{@@+I} to the first such line below the
  2068. current line. You can also write @code{@@III+2} which is the second data line
  2069. after the third hline in the table.
  2070. @code{@@0} and @code{$0} refer to the current row and column, respectively,
  2071. i.e. to the row/column for the field being computed. Also, if you omit
  2072. either the column or the row part of the reference, the current row/column is
  2073. implied.
  2074. Org's references with @emph{unsigned} numbers are fixed references
  2075. in the sense that if you use the same reference in the formula for two
  2076. different fields, the same field will be referenced each time.
  2077. Org's references with @emph{signed} numbers are floating
  2078. references because the same reference operator can reference different
  2079. fields depending on the field being calculated by the formula.
  2080. Here are a few examples:
  2081. @example
  2082. @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
  2083. $5 @r{column 5 in the current row (same as @code{E&})}
  2084. @@2 @r{current column, row 2}
  2085. @@-1$-3 @r{the field one row up, three columns to the left}
  2086. @@-I$2 @r{field just under hline above current row, column 2}
  2087. @@>$5 @r{field in the last row, in column 5}
  2088. @end example
  2089. @subsubheading Range references
  2090. @cindex range references
  2091. @cindex references, to ranges
  2092. You may reference a rectangular range of fields by specifying two field
  2093. references connected by two dots @samp{..}. If both fields are in the
  2094. current row, you may simply use @samp{$2..$7}, but if at least one field
  2095. is in a different row, you need to use the general @code{@@row$column}
  2096. format at least for the first field (i.e the reference must start with
  2097. @samp{@@} in order to be interpreted correctly). Examples:
  2098. @example
  2099. $1..$3 @r{first three fields in the current row}
  2100. $P..$Q @r{range, using column names (see under Advanced)}
  2101. $<<<..$>> @r{start in third column, continue to the one but last}
  2102. @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
  2103. @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
  2104. @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
  2105. @end example
  2106. @noindent Range references return a vector of values that can be fed
  2107. into Calc vector functions. Empty fields in ranges are normally
  2108. suppressed, so that the vector contains only the non-empty fields (but
  2109. see the @samp{E} mode switch below). If there are no non-empty fields,
  2110. @samp{[0]} is returned to avoid syntax errors in formulas.
  2111. @subsubheading Field coordinates in formulas
  2112. @cindex field coordinates
  2113. @cindex coordinates, of field
  2114. @cindex row, of field coordinates
  2115. @cindex column, of field coordinates
  2116. For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
  2117. get the row or column number of the field where the formula result goes.
  2118. The traditional Lisp formula equivalents are @code{org-table-current-dline}
  2119. and @code{org-table-current-column}. Examples:
  2120. @example
  2121. if(@@# % 2, $#, string("")) @r{column number on odd lines only}
  2122. $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
  2123. @r{column 3 of the current table}
  2124. @end example
  2125. @noindent For the second example, table FOO must have at least as many rows
  2126. as the current table. Note that this is inefficient@footnote{The computation time scales as
  2127. O(N^2) because table FOO is parsed for each field to be copied.} for large
  2128. number of rows.
  2129. @subsubheading Named references
  2130. @cindex named references
  2131. @cindex references, named
  2132. @cindex name, of column or field
  2133. @cindex constants, in calculations
  2134. @cindex #+CONSTANTS
  2135. @vindex org-table-formula-constants
  2136. @samp{$name} is interpreted as the name of a column, parameter or
  2137. constant. Constants are defined globally through the variable
  2138. @code{org-table-formula-constants}, and locally (for the file) through a
  2139. line like
  2140. @example
  2141. #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
  2142. @end example
  2143. @noindent
  2144. @vindex constants-unit-system
  2145. @pindex constants.el
  2146. Also properties (@pxref{Properties and Columns}) can be used as
  2147. constants in table formulas: for a property @samp{:Xyz:} use the name
  2148. @samp{$PROP_Xyz}, and the property will be searched in the current
  2149. outline entry and in the hierarchy above it. If you have the
  2150. @file{constants.el} package, it will also be used to resolve constants,
  2151. including natural constants like @samp{$h} for Planck's constant, and
  2152. units like @samp{$km} for kilometers@footnote{@file{constants.el} can
  2153. supply the values of constants in two different unit systems, @code{SI}
  2154. and @code{cgs}. Which one is used depends on the value of the variable
  2155. @code{constants-unit-system}. You can use the @code{#+STARTUP} options
  2156. @code{constSI} and @code{constcgs} to set this value for the current
  2157. buffer.}. Column names and parameters can be specified in special table
  2158. lines. These are described below, see @ref{Advanced features}. All
  2159. names must start with a letter, and further consist of letters and
  2160. numbers.
  2161. @subsubheading Remote references
  2162. @cindex remote references
  2163. @cindex references, remote
  2164. @cindex references, to a different table
  2165. @cindex name, of column or field
  2166. @cindex constants, in calculations
  2167. @cindex #+TBLNAME
  2168. You may also reference constants, fields and ranges from a different table,
  2169. either in the current file or even in a different file. The syntax is
  2170. @example
  2171. remote(NAME-OR-ID,REF)
  2172. @end example
  2173. @noindent
  2174. where NAME can be the name of a table in the current file as set by a
  2175. @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
  2176. entry, even in a different file, and the reference then refers to the first
  2177. table in that entry. REF is an absolute field or range reference as
  2178. described above for example @code{@@3$3} or @code{$somename}, valid in the
  2179. referenced table.
  2180. @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
  2181. @subsection Formula syntax for Calc
  2182. @cindex formula syntax, Calc
  2183. @cindex syntax, of formulas
  2184. A formula can be any algebraic expression understood by the Emacs
  2185. @file{Calc} package. @b{Note that @file{calc} has the
  2186. non-standard convention that @samp{/} has lower precedence than
  2187. @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
  2188. evaluation by @code{calc-eval} (@pxref{Calling Calc from
  2189. Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
  2190. Emacs Calc Manual}),
  2191. @c FIXME: The link to the Calc manual in HTML does not work.
  2192. variable substitution takes place according to the rules described above.
  2193. @cindex vectors, in table calculations
  2194. The range vectors can be directly fed into the Calc vector functions
  2195. like @samp{vmean} and @samp{vsum}.
  2196. @cindex format specifier
  2197. @cindex mode, for @file{calc}
  2198. @vindex org-calc-default-modes
  2199. A formula can contain an optional mode string after a semicolon. This
  2200. string consists of flags to influence Calc and other modes during
  2201. execution. By default, Org uses the standard Calc modes (precision
  2202. 12, angular units degrees, fraction and symbolic modes off). The display
  2203. format, however, has been changed to @code{(float 8)} to keep tables
  2204. compact. The default settings can be configured using the variable
  2205. @code{org-calc-default-modes}.
  2206. @example
  2207. p20 @r{set the internal Calc calculation precision to 20 digits}
  2208. n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
  2209. @r{format of the result of Calc passed back to Org.}
  2210. @r{Calc formatting is unlimited in precision as}
  2211. @r{long as the Calc calculation precision is greater.}
  2212. D R @r{angle modes: degrees, radians}
  2213. F S @r{fraction and symbolic modes}
  2214. N @r{interpret all fields as numbers, use 0 for non-numbers}
  2215. E @r{keep empty fields in ranges}
  2216. L @r{literal}
  2217. @end example
  2218. @noindent
  2219. Unless you use large integer numbers or high-precision-calculation
  2220. and -display for floating point numbers you may alternatively provide a
  2221. @code{printf} format specifier to reformat the Calc result after it has been
  2222. passed back to Org instead of letting Calc already do the
  2223. formatting@footnote{The @code{printf} reformatting is limited in precision
  2224. because the value passed to it is converted into an @code{integer} or
  2225. @code{double}. The @code{integer} is limited in size by truncating the
  2226. signed value to 32 bits. The @code{double} is limited in precision to 64
  2227. bits overall which leaves approximately 16 significant decimal digits.}.
  2228. A few examples:
  2229. @example
  2230. $1+$2 @r{Sum of first and second field}
  2231. $1+$2;%.2f @r{Same, format result to two decimals}
  2232. exp($2)+exp($1) @r{Math functions can be used}
  2233. $0;%.1f @r{Reformat current cell to 1 decimal}
  2234. ($3-32)*5/9 @r{Degrees F -> C conversion}
  2235. $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
  2236. tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
  2237. sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
  2238. vmean($2..$7) @r{Compute column range mean, using vector function}
  2239. vmean($2..$7);EN @r{Same, but treat empty fields as 0}
  2240. taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
  2241. @end example
  2242. Calc also contains a complete set of logical operations. For example
  2243. @example
  2244. if($1<20,teen,string("")) @r{"teen" if age $1 less than 20, else empty}
  2245. @end example
  2246. Note that you can also use two org-specific flags @code{T} and @code{t} for
  2247. durations computations @ref{Durations and time values}.
  2248. @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
  2249. @subsection Emacs Lisp forms as formulas
  2250. @cindex Lisp forms, as table formulas
  2251. It is also possible to write a formula in Emacs Lisp; this can be useful for
  2252. string manipulation and control structures, if Calc's functionality is not
  2253. enough. If a formula starts with a single-quote followed by an opening
  2254. parenthesis, then it is evaluated as a Lisp form. The evaluation should
  2255. return either a string or a number. Just as with @file{calc} formulas, you
  2256. can specify modes and a printf format after a semicolon. With Emacs Lisp
  2257. forms, you need to be conscious about the way field references are
  2258. interpolated into the form. By default, a reference will be interpolated as
  2259. a Lisp string (in double-quotes) containing the field. If you provide the
  2260. @samp{N} mode switch, all referenced elements will be numbers (non-number
  2261. fields will be zero) and interpolated as Lisp numbers, without quotes. If
  2262. you provide the @samp{L} flag, all fields will be interpolated literally,
  2263. without quotes. I.e., if you want a reference to be interpreted as a string
  2264. by the Lisp form, enclose the reference operator itself in double-quotes,
  2265. like @code{"$3"}. Ranges are inserted as space-separated fields, so you can
  2266. embed them in list or vector syntax. Here are a few examples---note how the
  2267. @samp{N} mode is used when we do computations in Lisp:
  2268. @example
  2269. @r{Swap the first two characters of the content of column 1}
  2270. '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
  2271. @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
  2272. '(+ $1 $2);N
  2273. @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
  2274. '(apply '+ '($1..$4));N
  2275. @end example
  2276. @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
  2277. @subsection Durations and time values
  2278. @cindex Duration, computing
  2279. @cindex Time, computing
  2280. @vindex org-table-duration-custom-format
  2281. If you want to compute time values use the @code{T} flag, either in Calc
  2282. formulas or Elisp formulas:
  2283. @example
  2284. @group
  2285. | Task 1 | Task 2 | Total |
  2286. |---------+----------+----------|
  2287. | 2:12 | 1:47 | 03:59:00 |
  2288. | 3:02:20 | -2:07:00 | 0.92 |
  2289. #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
  2290. @end group
  2291. @end example
  2292. Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
  2293. are optional. With the @code{T} flag, computed durations will be displayed
  2294. as @code{[HH:MM:SS} (see the first formula above). With the @code{t} flag,
  2295. computed durations will be displayed according to the value of the variable
  2296. @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
  2297. will display the result as a fraction of hours (see the second formula in the
  2298. example above).
  2299. Negative duration values can be manipulated as well, and integers will be
  2300. considered as seconds in addition and subtraction.
  2301. @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
  2302. @subsection Field and range formulas
  2303. @cindex field formula
  2304. @cindex range formula
  2305. @cindex formula, for individual table field
  2306. @cindex formula, for range of fields
  2307. To assign a formula to a particular field, type it directly into the field,
  2308. preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
  2309. @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
  2310. the formula will be stored as the formula for this field, evaluated, and the
  2311. current field will be replaced with the result.
  2312. @cindex #+TBLFM
  2313. Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
  2314. below the table. If you type the equation in the 4th field of the 3rd data
  2315. line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
  2316. inserting/deleting/swapping column and rows with the appropriate commands,
  2317. @i{absolute references} (but not relative ones) in stored formulas are
  2318. modified in order to still reference the same field. To avoid this from
  2319. happening, in particular in range references, anchor ranges at the table
  2320. borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
  2321. using the @code{@@I} notation. Automatic adaptation of field references does
  2322. of cause not happen if you edit the table structure with normal editing
  2323. commands---then you must fix the equations yourself.
  2324. Instead of typing an equation into the field, you may also use the following
  2325. command
  2326. @table @kbd
  2327. @orgcmd{C-u C-c =,org-table-eval-formula}
  2328. Install a new formula for the current field. The command prompts for a
  2329. formula with default taken from the @samp{#+TBLFM:} line, applies
  2330. it to the current field, and stores it.
  2331. @end table
  2332. The left-hand side of a formula can also be a special expression in order to
  2333. assign the formula to a number of different fields. There is no keyboard
  2334. shortcut to enter such range formulas. To add them, use the formula editor
  2335. (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
  2336. directly.
  2337. @table @code
  2338. @item $2=
  2339. Column formula, valid for the entire column. This is so common that Org
  2340. treats these formulas in a special way, see @ref{Column formulas}.
  2341. @item @@3=
  2342. Row formula, applies to all fields in the specified row. @code{@@>=} means
  2343. the last row.
  2344. @item @@1$2..@@4$3=
  2345. Range formula, applies to all fields in the given rectangular range. This
  2346. can also be used to assign a formula to some but not all fields in a row.
  2347. @item $name=
  2348. Named field, see @ref{Advanced features}.
  2349. @end table
  2350. @node Column formulas, Editing and debugging formulas, Field and range formulas, The spreadsheet
  2351. @subsection Column formulas
  2352. @cindex column formula
  2353. @cindex formula, for table column
  2354. When you assign a formula to a simple column reference like @code{$3=}, the
  2355. same formula will be used in all fields of that column, with the following
  2356. very convenient exceptions: (i) If the table contains horizontal separator
  2357. hlines, everything before the first such line is considered part of the table
  2358. @emph{header} and will not be modified by column formulas. (ii) Fields that
  2359. already get a value from a field/range formula will be left alone by column
  2360. formulas. These conditions make column formulas very easy to use.
  2361. To assign a formula to a column, type it directly into any field in the
  2362. column, preceded by an equal sign, like @samp{=$1+$2}. When you press
  2363. @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
  2364. the formula will be stored as the formula for the current column, evaluated
  2365. and the current field replaced with the result. If the field contains only
  2366. @samp{=}, the previously stored formula for this column is used. For each
  2367. column, Org will only remember the most recently used formula. In the
  2368. @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
  2369. left-hand side of a column formula can not be the name of column, it must be
  2370. the numeric column reference or @code{$>}.
  2371. Instead of typing an equation into the field, you may also use the
  2372. following command:
  2373. @table @kbd
  2374. @orgcmd{C-c =,org-table-eval-formula}
  2375. Install a new formula for the current column and replace current field with
  2376. the result of the formula. The command prompts for a formula, with default
  2377. taken from the @samp{#+TBLFM} line, applies it to the current field and
  2378. stores it. With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command
  2379. will apply it to that many consecutive fields in the current column.
  2380. @end table
  2381. @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
  2382. @subsection Editing and debugging formulas
  2383. @cindex formula editing
  2384. @cindex editing, of table formulas
  2385. @vindex org-table-use-standard-references
  2386. You can edit individual formulas in the minibuffer or directly in the
  2387. field. Org can also prepare a special buffer with all active
  2388. formulas of a table. When offering a formula for editing, Org
  2389. converts references to the standard format (like @code{B3} or @code{D&})
  2390. if possible. If you prefer to only work with the internal format (like
  2391. @code{@@3$2} or @code{$4}), configure the variable
  2392. @code{org-table-use-standard-references}.
  2393. @table @kbd
  2394. @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
  2395. Edit the formula associated with the current column/field in the
  2396. minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
  2397. @orgcmd{C-u C-u C-c =,org-table-eval-formula}
  2398. Re-insert the active formula (either a
  2399. field formula, or a column formula) into the current field, so that you
  2400. can edit it directly in the field. The advantage over editing in the
  2401. minibuffer is that you can use the command @kbd{C-c ?}.
  2402. @orgcmd{C-c ?,org-table-field-info}
  2403. While editing a formula in a table field, highlight the field(s)
  2404. referenced by the reference at the cursor position in the formula.
  2405. @kindex C-c @}
  2406. @findex org-table-toggle-coordinate-overlays
  2407. @item C-c @}
  2408. Toggle the display of row and column numbers for a table, using overlays
  2409. (@command{org-table-toggle-coordinate-overlays}). These are updated each
  2410. time the table is aligned; you can force it with @kbd{C-c C-c}.
  2411. @kindex C-c @{
  2412. @findex org-table-toggle-formula-debugger
  2413. @item C-c @{
  2414. Toggle the formula debugger on and off
  2415. (@command{org-table-toggle-formula-debugger}). See below.
  2416. @orgcmd{C-c ',org-table-edit-formulas}
  2417. Edit all formulas for the current table in a special buffer, where the
  2418. formulas will be displayed one per line. If the current field has an
  2419. active formula, the cursor in the formula editor will mark it.
  2420. While inside the special buffer, Org will automatically highlight
  2421. any field or range reference at the cursor position. You may edit,
  2422. remove and add formulas, and use the following commands:
  2423. @table @kbd
  2424. @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
  2425. Exit the formula editor and store the modified formulas. With @kbd{C-u}
  2426. prefix, also apply the new formulas to the entire table.
  2427. @orgcmd{C-c C-q,org-table-fedit-abort}
  2428. Exit the formula editor without installing changes.
  2429. @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
  2430. Toggle all references in the formula editor between standard (like
  2431. @code{B3}) and internal (like @code{@@3$2}).
  2432. @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
  2433. Pretty-print or indent Lisp formula at point. When in a line containing
  2434. a Lisp formula, format the formula according to Emacs Lisp rules.
  2435. Another @key{TAB} collapses the formula back again. In the open
  2436. formula, @key{TAB} re-indents just like in Emacs Lisp mode.
  2437. @orgcmd{M-@key{TAB},lisp-complete-symbol}
  2438. Complete Lisp symbols, just like in Emacs Lisp mode.
  2439. @kindex S-@key{up}
  2440. @kindex S-@key{down}
  2441. @kindex S-@key{left}
  2442. @kindex S-@key{right}
  2443. @findex org-table-fedit-ref-up
  2444. @findex org-table-fedit-ref-down
  2445. @findex org-table-fedit-ref-left
  2446. @findex org-table-fedit-ref-right
  2447. @item S-@key{up}/@key{down}/@key{left}/@key{right}
  2448. Shift the reference at point. For example, if the reference is
  2449. @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
  2450. This also works for relative references and for hline references.
  2451. @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
  2452. Move the test line for column formulas in the Org buffer up and
  2453. down.
  2454. @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
  2455. Scroll the window displaying the table.
  2456. @kindex C-c @}
  2457. @findex org-table-toggle-coordinate-overlays
  2458. @item C-c @}
  2459. Turn the coordinate grid in the table on and off.
  2460. @end table
  2461. @end table
  2462. Making a table field blank does not remove the formula associated with
  2463. the field, because that is stored in a different line (the @samp{#+TBLFM}
  2464. line)---during the next recalculation the field will be filled again.
  2465. To remove a formula from a field, you have to give an empty reply when
  2466. prompted for the formula, or to edit the @samp{#+TBLFM} line.
  2467. @kindex C-c C-c
  2468. You may edit the @samp{#+TBLFM} directly and re-apply the changed
  2469. equations with @kbd{C-c C-c} in that line or with the normal
  2470. recalculation commands in the table.
  2471. @subsubheading Debugging formulas
  2472. @cindex formula debugging
  2473. @cindex debugging, of table formulas
  2474. When the evaluation of a formula leads to an error, the field content
  2475. becomes the string @samp{#ERROR}. If you would like see what is going
  2476. on during variable substitution and calculation in order to find a bug,
  2477. turn on formula debugging in the @code{Tbl} menu and repeat the
  2478. calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
  2479. field. Detailed information will be displayed.
  2480. @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
  2481. @subsection Updating the table
  2482. @cindex recomputing table fields
  2483. @cindex updating, table
  2484. Recalculation of a table is normally not automatic, but needs to be
  2485. triggered by a command. See @ref{Advanced features}, for a way to make
  2486. recalculation at least semi-automatic.
  2487. In order to recalculate a line of a table or the entire table, use the
  2488. following commands:
  2489. @table @kbd
  2490. @orgcmd{C-c *,org-table-recalculate}
  2491. Recalculate the current row by first applying the stored column formulas
  2492. from left to right, and all field/range formulas in the current row.
  2493. @c
  2494. @kindex C-u C-c *
  2495. @item C-u C-c *
  2496. @kindex C-u C-c C-c
  2497. @itemx C-u C-c C-c
  2498. Recompute the entire table, line by line. Any lines before the first
  2499. hline are left alone, assuming that these are part of the table header.
  2500. @c
  2501. @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
  2502. Iterate the table by recomputing it until no further changes occur.
  2503. This may be necessary if some computed fields use the value of other
  2504. fields that are computed @i{later} in the calculation sequence.
  2505. @item M-x org-table-recalculate-buffer-tables
  2506. @findex org-table-recalculate-buffer-tables
  2507. Recompute all tables in the current buffer.
  2508. @item M-x org-table-iterate-buffer-tables
  2509. @findex org-table-iterate-buffer-tables
  2510. Iterate all tables in the current buffer, in order to converge table-to-table
  2511. dependencies.
  2512. @end table
  2513. @node Advanced features, , Updating the table, The spreadsheet
  2514. @subsection Advanced features
  2515. If you want the recalculation of fields to happen automatically, or if you
  2516. want to be able to assign @i{names}@footnote{Such names must start by an
  2517. alphabetic character and use only alphanumeric/underscore characters.} to
  2518. fields and columns, you need to reserve the first column of the table for
  2519. special marking characters.
  2520. @table @kbd
  2521. @orgcmd{C-#,org-table-rotate-recalc-marks}
  2522. Rotate the calculation mark in first column through the states @samp{ },
  2523. @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
  2524. change all marks in the region.
  2525. @end table
  2526. Here is an example of a table that collects exam results of students and
  2527. makes use of these features:
  2528. @example
  2529. @group
  2530. |---+---------+--------+--------+--------+-------+------|
  2531. | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
  2532. |---+---------+--------+--------+--------+-------+------|
  2533. | ! | | P1 | P2 | P3 | Tot | |
  2534. | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
  2535. | ^ | | m1 | m2 | m3 | mt | |
  2536. |---+---------+--------+--------+--------+-------+------|
  2537. | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
  2538. | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
  2539. |---+---------+--------+--------+--------+-------+------|
  2540. | | Average | | | | 29.7 | |
  2541. | ^ | | | | | at | |
  2542. | $ | max=50 | | | | | |
  2543. |---+---------+--------+--------+--------+-------+------|
  2544. #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
  2545. @end group
  2546. @end example
  2547. @noindent @b{Important}: please note that for these special tables,
  2548. recalculating the table with @kbd{C-u C-c *} will only affect rows that
  2549. are marked @samp{#} or @samp{*}, and fields that have a formula assigned
  2550. to the field itself. The column formulas are not applied in rows with
  2551. empty first field.
  2552. @cindex marking characters, tables
  2553. The marking characters have the following meaning:
  2554. @table @samp
  2555. @item !
  2556. The fields in this line define names for the columns, so that you may
  2557. refer to a column as @samp{$Tot} instead of @samp{$6}.
  2558. @item ^
  2559. This row defines names for the fields @emph{above} the row. With such
  2560. a definition, any formula in the table may use @samp{$m1} to refer to
  2561. the value @samp{10}. Also, if you assign a formula to a names field, it
  2562. will be stored as @samp{$name=...}.
  2563. @item _
  2564. Similar to @samp{^}, but defines names for the fields in the row
  2565. @emph{below}.
  2566. @item $
  2567. Fields in this row can define @emph{parameters} for formulas. For
  2568. example, if a field in a @samp{$} row contains @samp{max=50}, then
  2569. formulas in this table can refer to the value 50 using @samp{$max}.
  2570. Parameters work exactly like constants, only that they can be defined on
  2571. a per-table basis.
  2572. @item #
  2573. Fields in this row are automatically recalculated when pressing
  2574. @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
  2575. is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
  2576. lines will be left alone by this command.
  2577. @item *
  2578. Selects this line for global recalculation with @kbd{C-u C-c *}, but
  2579. not for automatic recalculation. Use this when automatic
  2580. recalculation slows down editing too much.
  2581. @item
  2582. Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
  2583. All lines that should be recalculated should be marked with @samp{#}
  2584. or @samp{*}.
  2585. @item /
  2586. Do not export this line. Useful for lines that contain the narrowing
  2587. @samp{<N>} markers or column group markers.
  2588. @end table
  2589. Finally, just to whet your appetite for what can be done with the
  2590. fantastic @file{calc.el} package, here is a table that computes the Taylor
  2591. series of degree @code{n} at location @code{x} for a couple of
  2592. functions.
  2593. @example
  2594. @group
  2595. |---+-------------+---+-----+--------------------------------------|
  2596. | | Func | n | x | Result |
  2597. |---+-------------+---+-----+--------------------------------------|
  2598. | # | exp(x) | 1 | x | 1 + x |
  2599. | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
  2600. | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
  2601. | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
  2602. | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
  2603. | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
  2604. |---+-------------+---+-----+--------------------------------------|
  2605. #+TBLFM: $5=taylor($2,$4,$3);n3
  2606. @end group
  2607. @end example
  2608. @node Org-Plot, , The spreadsheet, Tables
  2609. @section Org-Plot
  2610. @cindex graph, in tables
  2611. @cindex plot tables using Gnuplot
  2612. @cindex #+PLOT
  2613. Org-Plot can produce 2D and 3D graphs of information stored in org tables
  2614. using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
  2615. @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
  2616. this in action, ensure that you have both Gnuplot and Gnuplot mode installed
  2617. on your system, then call @code{org-plot/gnuplot} on the following table.
  2618. @example
  2619. @group
  2620. #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
  2621. | Sede | Max cites | H-index |
  2622. |-----------+-----------+---------|
  2623. | Chile | 257.72 | 21.39 |
  2624. | Leeds | 165.77 | 19.68 |
  2625. | Sao Paolo | 71.00 | 11.50 |
  2626. | Stockholm | 134.19 | 14.33 |
  2627. | Morelia | 257.56 | 17.67 |
  2628. @end group
  2629. @end example
  2630. Notice that Org Plot is smart enough to apply the table's headers as labels.
  2631. Further control over the labels, type, content, and appearance of plots can
  2632. be exercised through the @code{#+PLOT:} lines preceding a table. See below
  2633. for a complete list of Org-plot options. For more information and examples
  2634. see the Org-plot tutorial at
  2635. @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
  2636. @subsubheading Plot Options
  2637. @table @code
  2638. @item set
  2639. Specify any @command{gnuplot} option to be set when graphing.
  2640. @item title
  2641. Specify the title of the plot.
  2642. @item ind
  2643. Specify which column of the table to use as the @code{x} axis.
  2644. @item deps
  2645. Specify the columns to graph as a Lisp style list, surrounded by parentheses
  2646. and separated by spaces for example @code{dep:(3 4)} to graph the third and
  2647. fourth columns (defaults to graphing all other columns aside from the @code{ind}
  2648. column).
  2649. @item type
  2650. Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
  2651. @item with
  2652. Specify a @code{with} option to be inserted for every col being plotted
  2653. (e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
  2654. Defaults to @code{lines}.
  2655. @item file
  2656. If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
  2657. @item labels
  2658. List of labels to be used for the @code{deps} (defaults to the column headers
  2659. if they exist).
  2660. @item line
  2661. Specify an entire line to be inserted in the Gnuplot script.
  2662. @item map
  2663. When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
  2664. flat mapping rather than a @code{3d} slope.
  2665. @item timefmt
  2666. Specify format of Org mode timestamps as they will be parsed by Gnuplot.
  2667. Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
  2668. @item script
  2669. If you want total control, you can specify a script file (place the file name
  2670. between double-quotes) which will be used to plot. Before plotting, every
  2671. instance of @code{$datafile} in the specified script will be replaced with
  2672. the path to the generated data file. Note: even if you set this option, you
  2673. may still want to specify the plot type, as that can impact the content of
  2674. the data file.
  2675. @end table
  2676. @node Hyperlinks, TODO Items, Tables, Top
  2677. @chapter Hyperlinks
  2678. @cindex hyperlinks
  2679. Like HTML, Org provides links inside a file, external links to
  2680. other files, Usenet articles, emails, and much more.
  2681. @menu
  2682. * Link format:: How links in Org are formatted
  2683. * Internal links:: Links to other places in the current file
  2684. * External links:: URL-like links to the world
  2685. * Handling links:: Creating, inserting and following
  2686. * Using links outside Org:: Linking from my C source code?
  2687. * Link abbreviations:: Shortcuts for writing complex links
  2688. * Search options:: Linking to a specific location
  2689. * Custom searches:: When the default search is not enough
  2690. @end menu
  2691. @node Link format, Internal links, Hyperlinks, Hyperlinks
  2692. @section Link format
  2693. @cindex link format
  2694. @cindex format, of links
  2695. Org will recognize plain URL-like links and activate them as
  2696. clickable links. The general link format, however, looks like this:
  2697. @example
  2698. [[link][description]] @r{or alternatively} [[link]]
  2699. @end example
  2700. @noindent
  2701. Once a link in the buffer is complete (all brackets present), Org
  2702. will change the display so that @samp{description} is displayed instead
  2703. of @samp{[[link][description]]} and @samp{link} is displayed instead of
  2704. @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
  2705. which by default is an underlined face. You can directly edit the
  2706. visible part of a link. Note that this can be either the @samp{link}
  2707. part (if there is no description) or the @samp{description} part. To
  2708. edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
  2709. cursor on the link.
  2710. If you place the cursor at the beginning or just behind the end of the
  2711. displayed text and press @key{BACKSPACE}, you will remove the
  2712. (invisible) bracket at that location. This makes the link incomplete
  2713. and the internals are again displayed as plain text. Inserting the
  2714. missing bracket hides the link internals again. To show the
  2715. internal structure of all links, use the menu entry
  2716. @code{Org->Hyperlinks->Literal links}.
  2717. @node Internal links, External links, Link format, Hyperlinks
  2718. @section Internal links
  2719. @cindex internal links
  2720. @cindex links, internal
  2721. @cindex targets, for links
  2722. @cindex property, CUSTOM_ID
  2723. If the link does not look like a URL, it is considered to be internal in the
  2724. current file. The most important case is a link like
  2725. @samp{[[#my-custom-id]]} which will link to the entry with the
  2726. @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
  2727. for HTML export (@pxref{HTML export}) where they produce pretty section
  2728. links. You are responsible yourself to make sure these custom IDs are unique
  2729. in a file.
  2730. Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
  2731. lead to a text search in the current file.
  2732. The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
  2733. or with a mouse click (@pxref{Handling links}). Links to custom IDs will
  2734. point to the corresponding headline. The preferred match for a text link is
  2735. a @i{dedicated target}: the same string in double angular brackets. Targets
  2736. may be located anywhere; sometimes it is convenient to put them into a
  2737. comment line. For example
  2738. @example
  2739. # <<My Target>>
  2740. @end example
  2741. @noindent In HTML export (@pxref{HTML export}), such targets will become
  2742. named anchors for direct access through @samp{http} links@footnote{Note that
  2743. text before the first headline is usually not exported, so the first such
  2744. target should be after the first headline, or in the line directly before the
  2745. first headline.}.
  2746. If no dedicated target exists, Org will search for a headline that is exactly
  2747. the link text but may also include a TODO keyword and tags@footnote{To insert
  2748. a link targeting a headline, in-buffer completion can be used. Just type a
  2749. star followed by a few optional letters into the buffer and press
  2750. @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
  2751. completions.}. In non-Org files, the search will look for the words in the
  2752. link text. In the above example the search would be for @samp{my target}.
  2753. Following a link pushes a mark onto Org's own mark ring. You can
  2754. return to the previous position with @kbd{C-c &}. Using this command
  2755. several times in direct succession goes back to positions recorded
  2756. earlier.
  2757. @menu
  2758. * Radio targets:: Make targets trigger links in plain text
  2759. @end menu
  2760. @node Radio targets, , Internal links, Internal links
  2761. @subsection Radio targets
  2762. @cindex radio targets
  2763. @cindex targets, radio
  2764. @cindex links, radio targets
  2765. Org can automatically turn any occurrences of certain target names
  2766. in normal text into a link. So without explicitly creating a link, the
  2767. text connects to the target radioing its position. Radio targets are
  2768. enclosed by triple angular brackets. For example, a target @samp{<<<My
  2769. Target>>>} causes each occurrence of @samp{my target} in normal text to
  2770. become activated as a link. The Org file is scanned automatically
  2771. for radio targets only when the file is first loaded into Emacs. To
  2772. update the target list during editing, press @kbd{C-c C-c} with the
  2773. cursor on or at a target.
  2774. @node External links, Handling links, Internal links, Hyperlinks
  2775. @section External links
  2776. @cindex links, external
  2777. @cindex external links
  2778. @cindex links, external
  2779. @cindex Gnus links
  2780. @cindex BBDB links
  2781. @cindex IRC links
  2782. @cindex URL links
  2783. @cindex file links
  2784. @cindex VM links
  2785. @cindex RMAIL links
  2786. @cindex WANDERLUST links
  2787. @cindex MH-E links
  2788. @cindex USENET links
  2789. @cindex SHELL links
  2790. @cindex Info links
  2791. @cindex Elisp links
  2792. Org supports links to files, websites, Usenet and email messages,
  2793. BBDB database entries and links to both IRC conversations and their
  2794. logs. External links are URL-like locators. They start with a short
  2795. identifying string followed by a colon. There can be no space after
  2796. the colon. The following list shows examples for each link type.
  2797. @example
  2798. http://www.astro.uva.nl/~dominik @r{on the web}
  2799. doi:10.1000/182 @r{DOI for an electronic resource}
  2800. file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
  2801. /home/dominik/images/jupiter.jpg @r{same as above}
  2802. file:papers/last.pdf @r{file, relative path}
  2803. ./papers/last.pdf @r{same as above}
  2804. file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
  2805. /myself@@some.where:papers/last.pdf @r{same as above}
  2806. file:sometextfile::NNN @r{file, jump to line number}
  2807. file:projects.org @r{another Org file}
  2808. file:projects.org::some words @r{text search in Org file}@footnote{
  2809. The actual behavior of the search will depend on the value of
  2810. the variable @code{org-link-search-must-match-exact-headline}. If its value
  2811. is nil, then a fuzzy text search will be done. If it is t, then only the
  2812. exact headline will be matched. If the value is @code{'query-to-create},
  2813. then an exact headline will be searched; if it is not found, then the user
  2814. will be queried to create it.}
  2815. file:projects.org::*task title @r{heading search in Org file}
  2816. file+sys:/path/to/file @r{open via OS, like double-click}
  2817. file+emacs:/path/to/file @r{force opening by Emacs}
  2818. docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
  2819. id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
  2820. news:comp.emacs @r{Usenet link}
  2821. mailto:adent@@galaxy.net @r{Mail link}
  2822. vm:folder @r{VM folder link}
  2823. vm:folder#id @r{VM message link}
  2824. vm://myself@@some.where.org/folder#id @r{VM on remote machine}
  2825. vm-imap:account:folder @r{VM IMAP folder link}
  2826. vm-imap:account:folder#id @r{VM IMAP message link}
  2827. wl:folder @r{WANDERLUST folder link}
  2828. wl:folder#id @r{WANDERLUST message link}
  2829. mhe:folder @r{MH-E folder link}
  2830. mhe:folder#id @r{MH-E message link}
  2831. rmail:folder @r{RMAIL folder link}
  2832. rmail:folder#id @r{RMAIL message link}
  2833. gnus:group @r{Gnus group link}
  2834. gnus:group#id @r{Gnus article link}
  2835. bbdb:R.*Stallman @r{BBDB link (with regexp)}
  2836. irc:/irc.com/#emacs/bob @r{IRC link}
  2837. info:org#External links @r{Info node link}
  2838. shell:ls *.org @r{A shell command}
  2839. elisp:org-agenda @r{Interactive Elisp command}
  2840. elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
  2841. @end example
  2842. For customizing Org to add new link types @ref{Adding hyperlink types}.
  2843. A link should be enclosed in double brackets and may contain a
  2844. descriptive text to be displayed instead of the URL (@pxref{Link
  2845. format}), for example:
  2846. @example
  2847. [[http://www.gnu.org/software/emacs/][GNU Emacs]]
  2848. @end example
  2849. @noindent
  2850. If the description is a file name or URL that points to an image, HTML
  2851. export (@pxref{HTML export}) will inline the image as a clickable
  2852. button. If there is no description at all and the link points to an
  2853. image,
  2854. that image will be inlined into the exported HTML file.
  2855. @cindex square brackets, around links
  2856. @cindex plain text external links
  2857. Org also finds external links in the normal text and activates them
  2858. as links. If spaces must be part of the link (for example in
  2859. @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
  2860. about the end of the link, enclose them in square brackets.
  2861. @node Handling links, Using links outside Org, External links, Hyperlinks
  2862. @section Handling links
  2863. @cindex links, handling
  2864. Org provides methods to create a link in the correct syntax, to
  2865. insert it into an Org file, and to follow the link.
  2866. @table @kbd
  2867. @orgcmd{C-c l,org-store-link}
  2868. @cindex storing links
  2869. Store a link to the current location. This is a @emph{global} command (you
  2870. must create the key binding yourself) which can be used in any buffer to
  2871. create a link. The link will be stored for later insertion into an Org
  2872. buffer (see below). What kind of link will be created depends on the current
  2873. buffer:
  2874. @b{Org mode buffers}@*
  2875. For Org files, if there is a @samp{<<target>>} at the cursor, the link points
  2876. to the target. Otherwise it points to the current headline, which will also
  2877. be the description@footnote{If the headline contains a timestamp, it will be
  2878. removed from the link and result in a wrong link -- you should avoid putting
  2879. timestamp in the headline.}.
  2880. @vindex org-link-to-org-use-id
  2881. @cindex property, CUSTOM_ID
  2882. @cindex property, ID
  2883. If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
  2884. will be stored. In addition or alternatively (depending on the value of
  2885. @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
  2886. created and/or used to construct a link. So using this command in Org
  2887. buffers will potentially create two links: a human-readable from the custom
  2888. ID, and one that is globally unique and works even if the entry is moved from
  2889. file to file. Later, when inserting the link, you need to decide which one
  2890. to use.
  2891. @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
  2892. Pretty much all Emacs mail clients are supported. The link will point to the
  2893. current article, or, in some GNUS buffers, to the group. The description is
  2894. constructed from the author and the subject.
  2895. @b{Web browsers: W3 and W3M}@*
  2896. Here the link will be the current URL, with the page title as description.
  2897. @b{Contacts: BBDB}@*
  2898. Links created in a BBDB buffer will point to the current entry.
  2899. @b{Chat: IRC}@*
  2900. @vindex org-irc-link-to-logs
  2901. For IRC links, if you set the variable @code{org-irc-link-to-logs} to
  2902. @code{t}, a @samp{file:/} style link to the relevant point in the logs for
  2903. the current conversation is created. Otherwise an @samp{irc:/} style link to
  2904. the user/channel/server under the point will be stored.
  2905. @b{Other files}@*
  2906. For any other files, the link will point to the file, with a search string
  2907. (@pxref{Search options}) pointing to the contents of the current line. If
  2908. there is an active region, the selected words will form the basis of the
  2909. search string. If the automatically created link is not working correctly or
  2910. accurately enough, you can write custom functions to select the search string
  2911. and to do the search for particular file types---see @ref{Custom searches}.
  2912. The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
  2913. @b{Agenda view}@*
  2914. When the cursor is in an agenda view, the created link points to the
  2915. entry referenced by the current line.
  2916. @c
  2917. @orgcmd{C-c C-l,org-insert-link}
  2918. @cindex link completion
  2919. @cindex completion, of links
  2920. @cindex inserting links
  2921. @vindex org-keep-stored-link-after-insertion
  2922. Insert a link@footnote{ Note that you don't have to use this command to
  2923. insert a link. Links in Org are plain text, and you can type or paste them
  2924. straight into the buffer. By using this command, the links are automatically
  2925. enclosed in double brackets, and you will be asked for the optional
  2926. descriptive text.}. This prompts for a link to be inserted into the buffer.
  2927. You can just type a link, using text for an internal link, or one of the link
  2928. type prefixes mentioned in the examples above. The link will be inserted
  2929. into the buffer@footnote{After insertion of a stored link, the link will be
  2930. removed from the list of stored links. To keep it in the list later use, use
  2931. a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
  2932. @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
  2933. If some text was selected when this command is called, the selected text
  2934. becomes the default description.
  2935. @b{Inserting stored links}@*
  2936. All links stored during the
  2937. current session are part of the history for this prompt, so you can access
  2938. them with @key{up} and @key{down} (or @kbd{M-p/n}).
  2939. @b{Completion support}@* Completion with @key{TAB} will help you to insert
  2940. valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
  2941. defined through link abbreviations (@pxref{Link abbreviations}). If you
  2942. press @key{RET} after inserting only the @var{prefix}, Org will offer
  2943. specific completion support for some link types@footnote{This works by
  2944. calling a special function @code{org-PREFIX-complete-link}.} For
  2945. example, if you type @kbd{file @key{RET}}, file name completion (alternative
  2946. access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
  2947. @key{RET}} you can complete contact names.
  2948. @orgkey C-u C-c C-l
  2949. @cindex file name completion
  2950. @cindex completion, of file names
  2951. When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
  2952. a file will be inserted and you may use file name completion to select
  2953. the name of the file. The path to the file is inserted relative to the
  2954. directory of the current Org file, if the linked file is in the current
  2955. directory or in a sub-directory of it, or if the path is written relative
  2956. to the current directory using @samp{../}. Otherwise an absolute path
  2957. is used, if possible with @samp{~/} for your home directory. You can
  2958. force an absolute path with two @kbd{C-u} prefixes.
  2959. @c
  2960. @item C-c C-l @ @r{(with cursor on existing link)}
  2961. When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
  2962. link and description parts of the link.
  2963. @c
  2964. @cindex following links
  2965. @orgcmd{C-c C-o,org-open-at-point}
  2966. @vindex org-file-apps
  2967. @vindex org-link-frame-setup
  2968. Open link at point. This will launch a web browser for URLs (using
  2969. @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
  2970. the corresponding links, and execute the command in a shell link. When the
  2971. cursor is on an internal link, this command runs the corresponding search.
  2972. When the cursor is on a TAG list in a headline, it creates the corresponding
  2973. TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
  2974. date. Furthermore, it will visit text and remote files in @samp{file:} links
  2975. with Emacs and select a suitable application for local non-text files.
  2976. Classification of files is based on file extension only. See option
  2977. @code{org-file-apps}. If you want to override the default application and
  2978. visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
  2979. opening in Emacs, use a @kbd{C-u C-u} prefix.@*
  2980. If the cursor is on a headline, but not on a link, offer all links in the
  2981. headline and entry text. If you want to setup the frame configuration for
  2982. following links, customize @code{org-link-frame-setup}.
  2983. @orgkey @key{RET}
  2984. @vindex org-return-follows-link
  2985. When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
  2986. the link at point.
  2987. @c
  2988. @kindex mouse-2
  2989. @kindex mouse-1
  2990. @item mouse-2
  2991. @itemx mouse-1
  2992. On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
  2993. would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
  2994. @c
  2995. @kindex mouse-3
  2996. @item mouse-3
  2997. @vindex org-display-internal-link-with-indirect-buffer
  2998. Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
  2999. internal links to be displayed in another window@footnote{See the
  3000. variable @code{org-display-internal-link-with-indirect-buffer}}.
  3001. @c
  3002. @orgcmd{C-c C-x C-v,org-toggle-inline-images}
  3003. @cindex inlining images
  3004. @cindex images, inlining
  3005. @vindex org-startup-with-inline-images
  3006. @cindex @code{inlineimages}, STARTUP keyword
  3007. @cindex @code{noinlineimages}, STARTUP keyword
  3008. Toggle the inline display of linked images. Normally this will only inline
  3009. images that have no description part in the link, i.e.@: images that will also
  3010. be inlined during export. When called with a prefix argument, also display
  3011. images that do have a link description. You can ask for inline images to be
  3012. displayed at startup by configuring the variable
  3013. @code{org-startup-with-inline-images}@footnote{with corresponding
  3014. @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
  3015. @orgcmd{C-c %,org-mark-ring-push}
  3016. @cindex mark ring
  3017. Push the current position onto the mark ring, to be able to return
  3018. easily. Commands following an internal link do this automatically.
  3019. @c
  3020. @orgcmd{C-c &,org-mark-ring-goto}
  3021. @cindex links, returning to
  3022. Jump back to a recorded position. A position is recorded by the
  3023. commands following internal links, and by @kbd{C-c %}. Using this
  3024. command several times in direct succession moves through a ring of
  3025. previously recorded positions.
  3026. @c
  3027. @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
  3028. @cindex links, finding next/previous
  3029. Move forward/backward to the next link in the buffer. At the limit of
  3030. the buffer, the search fails once, and then wraps around. The key
  3031. bindings for this are really too long; you might want to bind this also
  3032. to @kbd{C-n} and @kbd{C-p}
  3033. @lisp
  3034. (add-hook 'org-load-hook
  3035. (lambda ()
  3036. (define-key org-mode-map "\C-n" 'org-next-link)
  3037. (define-key org-mode-map "\C-p" 'org-previous-link)))
  3038. @end lisp
  3039. @end table
  3040. @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
  3041. @section Using links outside Org
  3042. You can insert and follow links that have Org syntax not only in
  3043. Org, but in any Emacs buffer. For this, you should create two
  3044. global commands, like this (please select suitable global keys
  3045. yourself):
  3046. @lisp
  3047. (global-set-key "\C-c L" 'org-insert-link-global)
  3048. (global-set-key "\C-c o" 'org-open-at-point-global)
  3049. @end lisp
  3050. @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
  3051. @section Link abbreviations
  3052. @cindex link abbreviations
  3053. @cindex abbreviation, links
  3054. Long URLs can be cumbersome to type, and often many similar links are
  3055. needed in a document. For this you can use link abbreviations. An
  3056. abbreviated link looks like this
  3057. @example
  3058. [[linkword:tag][description]]
  3059. @end example
  3060. @noindent
  3061. @vindex org-link-abbrev-alist
  3062. where the tag is optional.
  3063. The @i{linkword} must be a word, starting with a letter, followed by
  3064. letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
  3065. according to the information in the variable @code{org-link-abbrev-alist}
  3066. that relates the linkwords to replacement text. Here is an example:
  3067. @smalllisp
  3068. @group
  3069. (setq org-link-abbrev-alist
  3070. '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
  3071. ("google" . "http://www.google.com/search?q=")
  3072. ("gmap" . "http://maps.google.com/maps?q=%s")
  3073. ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
  3074. ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
  3075. @end group
  3076. @end smalllisp
  3077. If the replacement text contains the string @samp{%s}, it will be
  3078. replaced with the tag. Otherwise the tag will be appended to the string
  3079. in order to create the link. You may also specify a function that will
  3080. be called with the tag as the only argument to create the link.
  3081. With the above setting, you could link to a specific bug with
  3082. @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
  3083. @code{[[google:OrgMode]]}, show the map location of the Free Software
  3084. Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
  3085. @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
  3086. what the Org author is doing besides Emacs hacking with
  3087. @code{[[ads:Dominik,C]]}.
  3088. If you need special abbreviations just for a single Org buffer, you
  3089. can define them in the file with
  3090. @cindex #+LINK
  3091. @example
  3092. #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
  3093. #+LINK: google http://www.google.com/search?q=%s
  3094. @end example
  3095. @noindent
  3096. In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
  3097. complete link abbreviations. You may also define a function
  3098. @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
  3099. support for inserting such a link with @kbd{C-c C-l}. Such a function should
  3100. not accept any arguments, and return the full link with prefix.
  3101. @node Search options, Custom searches, Link abbreviations, Hyperlinks
  3102. @section Search options in file links
  3103. @cindex search option in file links
  3104. @cindex file links, searching
  3105. File links can contain additional information to make Emacs jump to a
  3106. particular location in the file when following a link. This can be a
  3107. line number or a search option after a double@footnote{For backward
  3108. compatibility, line numbers can also follow a single colon.} colon. For
  3109. example, when the command @kbd{C-c l} creates a link (@pxref{Handling
  3110. links}) to a file, it encodes the words in the current line as a search
  3111. string that can be used to find this line back later when following the
  3112. link with @kbd{C-c C-o}.
  3113. Here is the syntax of the different ways to attach a search to a file
  3114. link, together with an explanation:
  3115. @example
  3116. [[file:~/code/main.c::255]]
  3117. [[file:~/xx.org::My Target]]
  3118. [[file:~/xx.org::*My Target]]
  3119. [[file:~/xx.org::#my-custom-id]]
  3120. [[file:~/xx.org::/regexp/]]
  3121. @end example
  3122. @table @code
  3123. @item 255
  3124. Jump to line 255.
  3125. @item My Target
  3126. Search for a link target @samp{<<My Target>>}, or do a text search for
  3127. @samp{my target}, similar to the search in internal links, see
  3128. @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
  3129. link will become an HTML reference to the corresponding named anchor in
  3130. the linked file.
  3131. @item *My Target
  3132. In an Org file, restrict search to headlines.
  3133. @item #my-custom-id
  3134. Link to a heading with a @code{CUSTOM_ID} property
  3135. @item /regexp/
  3136. Do a regular expression search for @code{regexp}. This uses the Emacs
  3137. command @code{occur} to list all matches in a separate window. If the
  3138. target file is in Org mode, @code{org-occur} is used to create a
  3139. sparse tree with the matches.
  3140. @c If the target file is a directory,
  3141. @c @code{grep} will be used to search all files in the directory.
  3142. @end table
  3143. As a degenerate case, a file link with an empty file name can be used
  3144. to search the current file. For example, @code{[[file:::find me]]} does
  3145. a search for @samp{find me} in the current file, just as
  3146. @samp{[[find me]]} would.
  3147. @node Custom searches, , Search options, Hyperlinks
  3148. @section Custom Searches
  3149. @cindex custom search strings
  3150. @cindex search strings, custom
  3151. The default mechanism for creating search strings and for doing the
  3152. actual search related to a file link may not work correctly in all
  3153. cases. For example, Bib@TeX{} database files have many entries like
  3154. @samp{year="1993"} which would not result in good search strings,
  3155. because the only unique identification for a Bib@TeX{} entry is the
  3156. citation key.
  3157. @vindex org-create-file-search-functions
  3158. @vindex org-execute-file-search-functions
  3159. If you come across such a problem, you can write custom functions to set
  3160. the right search string for a particular file type, and to do the search
  3161. for the string in the file. Using @code{add-hook}, these functions need
  3162. to be added to the hook variables
  3163. @code{org-create-file-search-functions} and
  3164. @code{org-execute-file-search-functions}. See the docstring for these
  3165. variables for more information. Org actually uses this mechanism
  3166. for Bib@TeX{} database files, and you can use the corresponding code as
  3167. an implementation example. See the file @file{org-bibtex.el}.
  3168. @node TODO Items, Tags, Hyperlinks, Top
  3169. @chapter TODO items
  3170. @cindex TODO items
  3171. Org mode does not maintain TODO lists as separate documents@footnote{Of
  3172. course, you can make a document that contains only long lists of TODO items,
  3173. but this is not required.}. Instead, TODO items are an integral part of the
  3174. notes file, because TODO items usually come up while taking notes! With Org
  3175. mode, simply mark any entry in a tree as being a TODO item. In this way,
  3176. information is not duplicated, and the entire context from which the TODO
  3177. item emerged is always present.
  3178. Of course, this technique for managing TODO items scatters them
  3179. throughout your notes file. Org mode compensates for this by providing
  3180. methods to give you an overview of all the things that you have to do.
  3181. @menu
  3182. * TODO basics:: Marking and displaying TODO entries
  3183. * TODO extensions:: Workflow and assignments
  3184. * Progress logging:: Dates and notes for progress
  3185. * Priorities:: Some things are more important than others
  3186. * Breaking down tasks:: Splitting a task into manageable pieces
  3187. * Checkboxes:: Tick-off lists
  3188. @end menu
  3189. @node TODO basics, TODO extensions, TODO Items, TODO Items
  3190. @section Basic TODO functionality
  3191. Any headline becomes a TODO item when it starts with the word
  3192. @samp{TODO}, for example:
  3193. @example
  3194. *** TODO Write letter to Sam Fortune
  3195. @end example
  3196. @noindent
  3197. The most important commands to work with TODO entries are:
  3198. @table @kbd
  3199. @orgcmd{C-c C-t,org-todo}
  3200. @cindex cycling, of TODO states
  3201. Rotate the TODO state of the current item among
  3202. @example
  3203. ,-> (unmarked) -> TODO -> DONE --.
  3204. '--------------------------------'
  3205. @end example
  3206. The same rotation can also be done ``remotely'' from the timeline and
  3207. agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
  3208. @orgkey{C-u C-c C-t}
  3209. Select a specific keyword using completion or (if it has been set up)
  3210. the fast selection interface. For the latter, you need to assign keys
  3211. to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
  3212. more information.
  3213. @kindex S-@key{right}
  3214. @kindex S-@key{left}
  3215. @item S-@key{right} @ @r{/} @ S-@key{left}
  3216. @vindex org-treat-S-cursor-todo-selection-as-state-change
  3217. Select the following/preceding TODO state, similar to cycling. Useful
  3218. mostly if more than two TODO states are possible (@pxref{TODO
  3219. extensions}). See also @ref{Conflicts}, for a discussion of the interaction
  3220. with @code{shift-selection-mode}. See also the variable
  3221. @code{org-treat-S-cursor-todo-selection-as-state-change}.
  3222. @orgcmd{C-c / t,org-show-todo-key}
  3223. @cindex sparse tree, for TODO
  3224. @vindex org-todo-keywords
  3225. View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
  3226. entire buffer, but shows all TODO items (with not-DONE state) and the
  3227. headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
  3228. / T}), search for a specific TODO. You will be prompted for the keyword, and
  3229. you can also give a list of keywords like @code{KWD1|KWD2|...} to list
  3230. entries that match any one of these keywords. With a numeric prefix argument
  3231. N, show the tree for the Nth keyword in the variable
  3232. @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
  3233. both un-done and done.
  3234. @orgcmd{C-c a t,org-todo-list}
  3235. Show the global TODO list. Collects the TODO items (with not-DONE states)
  3236. from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
  3237. buffer will be in @code{agenda-mode}, which provides commands to examine and
  3238. manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
  3239. @xref{Global TODO list}, for more information.
  3240. @orgcmd{S-M-@key{RET},org-insert-todo-heading}
  3241. Insert a new TODO entry below the current one.
  3242. @end table
  3243. @noindent
  3244. @vindex org-todo-state-tags-triggers
  3245. Changing a TODO state can also trigger tag changes. See the docstring of the
  3246. option @code{org-todo-state-tags-triggers} for details.
  3247. @node TODO extensions, Progress logging, TODO basics, TODO Items
  3248. @section Extended use of TODO keywords
  3249. @cindex extended TODO keywords
  3250. @vindex org-todo-keywords
  3251. By default, marked TODO entries have one of only two states: TODO and
  3252. DONE. Org mode allows you to classify TODO items in more complex ways
  3253. with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
  3254. special setup, the TODO keyword system can work differently in different
  3255. files.
  3256. Note that @i{tags} are another way to classify headlines in general and
  3257. TODO items in particular (@pxref{Tags}).
  3258. @menu
  3259. * Workflow states:: From TODO to DONE in steps
  3260. * TODO types:: I do this, Fred does the rest
  3261. * Multiple sets in one file:: Mixing it all, and still finding your way
  3262. * Fast access to TODO states:: Single letter selection of a state
  3263. * Per-file keywords:: Different files, different requirements
  3264. * Faces for TODO keywords:: Highlighting states
  3265. * TODO dependencies:: When one task needs to wait for others
  3266. @end menu
  3267. @node Workflow states, TODO types, TODO extensions, TODO extensions
  3268. @subsection TODO keywords as workflow states
  3269. @cindex TODO workflow
  3270. @cindex workflow states as TODO keywords
  3271. You can use TODO keywords to indicate different @emph{sequential} states
  3272. in the process of working on an item, for example@footnote{Changing
  3273. this variable only becomes effective after restarting Org mode in a
  3274. buffer.}:
  3275. @lisp
  3276. (setq org-todo-keywords
  3277. '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
  3278. @end lisp
  3279. The vertical bar separates the TODO keywords (states that @emph{need
  3280. action}) from the DONE states (which need @emph{no further action}). If
  3281. you don't provide the separator bar, the last state is used as the DONE
  3282. state.
  3283. @cindex completion, of TODO keywords
  3284. With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
  3285. to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
  3286. also use a numeric prefix argument to quickly select a specific state. For
  3287. example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
  3288. Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
  3289. define many keywords, you can use in-buffer completion
  3290. (@pxref{Completion}) or even a special one-key selection scheme
  3291. (@pxref{Fast access to TODO states}) to insert these words into the
  3292. buffer. Changing a TODO state can be logged with a timestamp, see
  3293. @ref{Tracking TODO state changes}, for more information.
  3294. @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
  3295. @subsection TODO keywords as types
  3296. @cindex TODO types
  3297. @cindex names as TODO keywords
  3298. @cindex types as TODO keywords
  3299. The second possibility is to use TODO keywords to indicate different
  3300. @emph{types} of action items. For example, you might want to indicate
  3301. that items are for ``work'' or ``home''. Or, when you work with several
  3302. people on a single project, you might want to assign action items
  3303. directly to persons, by using their names as TODO keywords. This would
  3304. be set up like this:
  3305. @lisp
  3306. (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
  3307. @end lisp
  3308. In this case, different keywords do not indicate a sequence, but rather
  3309. different types. So the normal work flow would be to assign a task to a
  3310. person, and later to mark it DONE. Org mode supports this style by adapting
  3311. the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
  3312. @kbd{t} command in the timeline and agenda buffers.}. When used several
  3313. times in succession, it will still cycle through all names, in order to first
  3314. select the right type for a task. But when you return to the item after some
  3315. time and execute @kbd{C-c C-t} again, it will switch from any name directly
  3316. to DONE. Use prefix arguments or completion to quickly select a specific
  3317. name. You can also review the items of a specific TODO type in a sparse tree
  3318. by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
  3319. Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
  3320. from all agenda files into a single buffer, you would use the numeric prefix
  3321. argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
  3322. @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
  3323. @subsection Multiple keyword sets in one file
  3324. @cindex TODO keyword sets
  3325. Sometimes you may want to use different sets of TODO keywords in
  3326. parallel. For example, you may want to have the basic
  3327. @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
  3328. separate state indicating that an item has been canceled (so it is not
  3329. DONE, but also does not require action). Your setup would then look
  3330. like this:
  3331. @lisp
  3332. (setq org-todo-keywords
  3333. '((sequence "TODO" "|" "DONE")
  3334. (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
  3335. (sequence "|" "CANCELED")))
  3336. @end lisp
  3337. The keywords should all be different, this helps Org mode to keep track
  3338. of which subsequence should be used for a given entry. In this setup,
  3339. @kbd{C-c C-t} only operates within a subsequence, so it switches from
  3340. @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
  3341. (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
  3342. select the correct sequence. Besides the obvious ways like typing a
  3343. keyword or using completion, you may also apply the following commands:
  3344. @table @kbd
  3345. @kindex C-S-@key{right}
  3346. @kindex C-S-@key{left}
  3347. @kindex C-u C-u C-c C-t
  3348. @item C-u C-u C-c C-t
  3349. @itemx C-S-@key{right}
  3350. @itemx C-S-@key{left}
  3351. These keys jump from one TODO subset to the next. In the above example,
  3352. @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
  3353. @code{DONE} to @code{REPORT}, and any of the words in the second row to
  3354. @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
  3355. @code{shift-selection-mode} (@pxref{Conflicts}).
  3356. @kindex S-@key{right}
  3357. @kindex S-@key{left}
  3358. @item S-@key{right}
  3359. @itemx S-@key{left}
  3360. @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
  3361. keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
  3362. from @code{DONE} to @code{REPORT} in the example above. See also
  3363. @ref{Conflicts}, for a discussion of the interaction with
  3364. @code{shift-selection-mode}.
  3365. @end table
  3366. @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
  3367. @subsection Fast access to TODO states
  3368. If you would like to quickly change an entry to an arbitrary TODO state
  3369. instead of cycling through the states, you can set up keys for
  3370. single-letter access to the states. This is done by adding the section
  3371. key after each keyword, in parentheses. For example:
  3372. @lisp
  3373. (setq org-todo-keywords
  3374. '((sequence "TODO(t)" "|" "DONE(d)")
  3375. (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
  3376. (sequence "|" "CANCELED(c)")))
  3377. @end lisp
  3378. @vindex org-fast-tag-selection-include-todo
  3379. If you then press @kbd{C-c C-t} followed by the selection key, the entry
  3380. will be switched to this state. @kbd{SPC} can be used to remove any TODO
  3381. keyword from an entry.@footnote{Check also the variable
  3382. @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
  3383. state through the tags interface (@pxref{Setting tags}), in case you like to
  3384. mingle the two concepts. Note that this means you need to come up with
  3385. unique keys across both sets of keywords.}
  3386. @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
  3387. @subsection Setting up keywords for individual files
  3388. @cindex keyword options
  3389. @cindex per-file keywords
  3390. @cindex #+TODO
  3391. @cindex #+TYP_TODO
  3392. @cindex #+SEQ_TODO
  3393. It can be very useful to use different aspects of the TODO mechanism in
  3394. different files. For file-local settings, you need to add special lines
  3395. to the file which set the keywords and interpretation for that file
  3396. only. For example, to set one of the two examples discussed above, you
  3397. need one of the following lines, starting in column zero anywhere in the
  3398. file:
  3399. @example
  3400. #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
  3401. @end example
  3402. @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
  3403. interpretation, but it means the same as @code{#+TODO}), or
  3404. @example
  3405. #+TYP_TODO: Fred Sara Lucy Mike | DONE
  3406. @end example
  3407. A setup for using several sets in parallel would be:
  3408. @example
  3409. #+TODO: TODO | DONE
  3410. #+TODO: REPORT BUG KNOWNCAUSE | FIXED
  3411. #+TODO: | CANCELED
  3412. @end example
  3413. @cindex completion, of option keywords
  3414. @kindex M-@key{TAB}
  3415. @noindent To make sure you are using the correct keyword, type
  3416. @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
  3417. @cindex DONE, final TODO keyword
  3418. Remember that the keywords after the vertical bar (or the last keyword
  3419. if no bar is there) must always mean that the item is DONE (although you
  3420. may use a different word). After changing one of these lines, use
  3421. @kbd{C-c C-c} with the cursor still in the line to make the changes
  3422. known to Org mode@footnote{Org mode parses these lines only when
  3423. Org mode is activated after visiting a file. @kbd{C-c C-c} with the
  3424. cursor in a line starting with @samp{#+} is simply restarting Org mode
  3425. for the current buffer.}.
  3426. @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
  3427. @subsection Faces for TODO keywords
  3428. @cindex faces, for TODO keywords
  3429. @vindex org-todo @r{(face)}
  3430. @vindex org-done @r{(face)}
  3431. @vindex org-todo-keyword-faces
  3432. Org mode highlights TODO keywords with special faces: @code{org-todo}
  3433. for keywords indicating that an item still has to be acted upon, and
  3434. @code{org-done} for keywords indicating that an item is finished. If
  3435. you are using more than 2 different states, you might want to use
  3436. special faces for some of them. This can be done using the variable
  3437. @code{org-todo-keyword-faces}. For example:
  3438. @lisp
  3439. @group
  3440. (setq org-todo-keyword-faces
  3441. '(("TODO" . org-warning) ("STARTED" . "yellow")
  3442. ("CANCELED" . (:foreground "blue" :weight bold))))
  3443. @end group
  3444. @end lisp
  3445. While using a list with face properties as shown for CANCELED @emph{should}
  3446. work, this does not always seem to be the case. If necessary, define a
  3447. special face and use that. A string is interpreted as a color. The variable
  3448. @code{org-faces-easy-properties} determines if that color is interpreted as a
  3449. foreground or a background color.
  3450. @node TODO dependencies, , Faces for TODO keywords, TODO extensions
  3451. @subsection TODO dependencies
  3452. @cindex TODO dependencies
  3453. @cindex dependencies, of TODO states
  3454. @vindex org-enforce-todo-dependencies
  3455. @cindex property, ORDERED
  3456. The structure of Org files (hierarchy and lists) makes it easy to define TODO
  3457. dependencies. Usually, a parent TODO task should not be marked DONE until
  3458. all subtasks (defined as children tasks) are marked as DONE. And sometimes
  3459. there is a logical sequence to a number of (sub)tasks, so that one task
  3460. cannot be acted upon before all siblings above it are done. If you customize
  3461. the variable @code{org-enforce-todo-dependencies}, Org will block entries
  3462. from changing state to DONE while they have children that are not DONE.
  3463. Furthermore, if an entry has a property @code{ORDERED}, each of its children
  3464. will be blocked until all earlier siblings are marked DONE. Here is an
  3465. example:
  3466. @example
  3467. * TODO Blocked until (two) is done
  3468. ** DONE one
  3469. ** TODO two
  3470. * Parent
  3471. :PROPERTIES:
  3472. :ORDERED: t
  3473. :END:
  3474. ** TODO a
  3475. ** TODO b, needs to wait for (a)
  3476. ** TODO c, needs to wait for (a) and (b)
  3477. @end example
  3478. @table @kbd
  3479. @orgcmd{C-c C-x o,org-toggle-ordered-property}
  3480. @vindex org-track-ordered-property-with-tag
  3481. @cindex property, ORDERED
  3482. Toggle the @code{ORDERED} property of the current entry. A property is used
  3483. for this behavior because this should be local to the current entry, not
  3484. inherited like a tag. However, if you would like to @i{track} the value of
  3485. this property with a tag for better visibility, customize the variable
  3486. @code{org-track-ordered-property-with-tag}.
  3487. @orgkey{C-u C-u C-u C-c C-t}
  3488. Change TODO state, circumventing any state blocking.
  3489. @end table
  3490. @vindex org-agenda-dim-blocked-tasks
  3491. If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
  3492. that cannot be closed because of such dependencies will be shown in a dimmed
  3493. font or even made invisible in agenda views (@pxref{Agenda Views}).
  3494. @cindex checkboxes and TODO dependencies
  3495. @vindex org-enforce-todo-dependencies
  3496. You can also block changes of TODO states by looking at checkboxes
  3497. (@pxref{Checkboxes}). If you set the variable
  3498. @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
  3499. checkboxes will be blocked from switching to DONE.
  3500. If you need more complex dependency structures, for example dependencies
  3501. between entries in different trees or files, check out the contributed
  3502. module @file{org-depend.el}.
  3503. @page
  3504. @node Progress logging, Priorities, TODO extensions, TODO Items
  3505. @section Progress logging
  3506. @cindex progress logging
  3507. @cindex logging, of progress
  3508. Org mode can automatically record a timestamp and possibly a note when
  3509. you mark a TODO item as DONE, or even each time you change the state of
  3510. a TODO item. This system is highly configurable, settings can be on a
  3511. per-keyword basis and can be localized to a file or even a subtree. For
  3512. information on how to clock working time for a task, see @ref{Clocking
  3513. work time}.
  3514. @menu
  3515. * Closing items:: When was this entry marked DONE?
  3516. * Tracking TODO state changes:: When did the status change?
  3517. * Tracking your habits:: How consistent have you been?
  3518. @end menu
  3519. @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
  3520. @subsection Closing items
  3521. The most basic logging is to keep track of @emph{when} a certain TODO
  3522. item was finished. This is achieved with@footnote{The corresponding
  3523. in-buffer setting is: @code{#+STARTUP: logdone}}
  3524. @lisp
  3525. (setq org-log-done 'time)
  3526. @end lisp
  3527. @noindent
  3528. Then each time you turn an entry from a TODO (not-done) state into any
  3529. of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
  3530. just after the headline. If you turn the entry back into a TODO item
  3531. through further state cycling, that line will be removed again. If you
  3532. want to record a note along with the timestamp, use@footnote{The
  3533. corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
  3534. @lisp
  3535. (setq org-log-done 'note)
  3536. @end lisp
  3537. @noindent
  3538. You will then be prompted for a note, and that note will be stored below
  3539. the entry with a @samp{Closing Note} heading.
  3540. In the timeline (@pxref{Timeline}) and in the agenda
  3541. (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
  3542. display the TODO items with a @samp{CLOSED} timestamp on each day,
  3543. giving you an overview of what has been done.
  3544. @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
  3545. @subsection Tracking TODO state changes
  3546. @cindex drawer, for state change recording
  3547. @vindex org-log-states-order-reversed
  3548. @vindex org-log-into-drawer
  3549. @cindex property, LOG_INTO_DRAWER
  3550. When TODO keywords are used as workflow states (@pxref{Workflow states}), you
  3551. might want to keep track of when a state change occurred and maybe take a
  3552. note about this change. You can either record just a timestamp, or a
  3553. time-stamped note for a change. These records will be inserted after the
  3554. headline as an itemized list, newest first@footnote{See the variable
  3555. @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
  3556. want to get the notes out of the way into a drawer (@pxref{Drawers}).
  3557. Customize the variable @code{org-log-into-drawer} to get this
  3558. behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
  3559. also overrule the setting of this variable for a subtree by setting a
  3560. @code{LOG_INTO_DRAWER} property.
  3561. Since it is normally too much to record a note for every state, Org mode
  3562. expects configuration on a per-keyword basis for this. This is achieved by
  3563. adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
  3564. with timestamp) in parentheses after each keyword. For example, with the
  3565. setting
  3566. @lisp
  3567. (setq org-todo-keywords
  3568. '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
  3569. @end lisp
  3570. To record a timestamp without a note for TODO keywords configured with
  3571. @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
  3572. @noindent
  3573. @vindex org-log-done
  3574. you not only define global TODO keywords and fast access keys, but also
  3575. request that a time is recorded when the entry is set to
  3576. DONE@footnote{It is possible that Org mode will record two timestamps
  3577. when you are using both @code{org-log-done} and state change logging.
  3578. However, it will never prompt for two notes---if you have configured
  3579. both, the state change recording note will take precedence and cancel
  3580. the @samp{Closing Note}.}, and that a note is recorded when switching to
  3581. WAIT or CANCELED. The setting for WAIT is even more special: the
  3582. @samp{!} after the slash means that in addition to the note taken when
  3583. entering the state, a timestamp should be recorded when @i{leaving} the
  3584. WAIT state, if and only if the @i{target} state does not configure
  3585. logging for entering it. So it has no effect when switching from WAIT
  3586. to DONE, because DONE is configured to record a timestamp only. But
  3587. when switching from WAIT back to TODO, the @samp{/!} in the WAIT
  3588. setting now triggers a timestamp even though TODO has no logging
  3589. configured.
  3590. You can use the exact same syntax for setting logging preferences local
  3591. to a buffer:
  3592. @example
  3593. #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
  3594. @end example
  3595. @cindex property, LOGGING
  3596. In order to define logging settings that are local to a subtree or a
  3597. single item, define a LOGGING property in this entry. Any non-empty
  3598. LOGGING property resets all logging settings to nil. You may then turn
  3599. on logging for this specific tree using STARTUP keywords like
  3600. @code{lognotedone} or @code{logrepeat}, as well as adding state specific
  3601. settings like @code{TODO(!)}. For example
  3602. @example
  3603. * TODO Log each state with only a time
  3604. :PROPERTIES:
  3605. :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
  3606. :END:
  3607. * TODO Only log when switching to WAIT, and when repeating
  3608. :PROPERTIES:
  3609. :LOGGING: WAIT(@@) logrepeat
  3610. :END:
  3611. * TODO No logging at all
  3612. :PROPERTIES:
  3613. :LOGGING: nil
  3614. :END:
  3615. @end example
  3616. @node Tracking your habits, , Tracking TODO state changes, Progress logging
  3617. @subsection Tracking your habits
  3618. @cindex habits
  3619. Org has the ability to track the consistency of a special category of TODOs,
  3620. called ``habits''. A habit has the following properties:
  3621. @enumerate
  3622. @item
  3623. You have enabled the @code{habits} module by customizing the variable
  3624. @code{org-modules}.
  3625. @item
  3626. The habit is a TODO item, with a TODO keyword representing an open state.
  3627. @item
  3628. The property @code{STYLE} is set to the value @code{habit}.
  3629. @item
  3630. The TODO has a scheduled date, usually with a @code{.+} style repeat
  3631. interval. A @code{++} style may be appropriate for habits with time
  3632. constraints, e.g., must be done on weekends, or a @code{+} style for an
  3633. unusual habit that can have a backlog, e.g., weekly reports.
  3634. @item
  3635. The TODO may also have minimum and maximum ranges specified by using the
  3636. syntax @samp{.+2d/3d}, which says that you want to do the task at least every
  3637. three days, but at most every two days.
  3638. @item
  3639. You must also have state logging for the @code{DONE} state enabled, in order
  3640. for historical data to be represented in the consistency graph. If it is not
  3641. enabled it is not an error, but the consistency graphs will be largely
  3642. meaningless.
  3643. @end enumerate
  3644. To give you an idea of what the above rules look like in action, here's an
  3645. actual habit with some history:
  3646. @example
  3647. ** TODO Shave
  3648. SCHEDULED: <2009-10-17 Sat .+2d/4d>
  3649. - State "DONE" from "TODO" [2009-10-15 Thu]
  3650. - State "DONE" from "TODO" [2009-10-12 Mon]
  3651. - State "DONE" from "TODO" [2009-10-10 Sat]
  3652. - State "DONE" from "TODO" [2009-10-04 Sun]
  3653. - State "DONE" from "TODO" [2009-10-02 Fri]
  3654. - State "DONE" from "TODO" [2009-09-29 Tue]
  3655. - State "DONE" from "TODO" [2009-09-25 Fri]
  3656. - State "DONE" from "TODO" [2009-09-19 Sat]
  3657. - State "DONE" from "TODO" [2009-09-16 Wed]
  3658. - State "DONE" from "TODO" [2009-09-12 Sat]
  3659. :PROPERTIES:
  3660. :STYLE: habit
  3661. :LAST_REPEAT: [2009-10-19 Mon 00:36]
  3662. :END:
  3663. @end example
  3664. What this habit says is: I want to shave at most every 2 days (given by the
  3665. @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
  3666. today is the 15th, then the habit first appears in the agenda on Oct 17,
  3667. after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
  3668. after four days have elapsed.
  3669. What's really useful about habits is that they are displayed along with a
  3670. consistency graph, to show how consistent you've been at getting that task
  3671. done in the past. This graph shows every day that the task was done over the
  3672. past three weeks, with colors for each day. The colors used are:
  3673. @table @code
  3674. @item Blue
  3675. If the task wasn't to be done yet on that day.
  3676. @item Green
  3677. If the task could have been done on that day.
  3678. @item Yellow
  3679. If the task was going to be overdue the next day.
  3680. @item Red
  3681. If the task was overdue on that day.
  3682. @end table
  3683. In addition to coloring each day, the day is also marked with an asterisk if
  3684. the task was actually done that day, and an exclamation mark to show where
  3685. the current day falls in the graph.
  3686. There are several configuration variables that can be used to change the way
  3687. habits are displayed in the agenda.
  3688. @table @code
  3689. @item org-habit-graph-column
  3690. The buffer column at which the consistency graph should be drawn. This will
  3691. overwrite any text in that column, so it is a good idea to keep your habits'
  3692. titles brief and to the point.
  3693. @item org-habit-preceding-days
  3694. The amount of history, in days before today, to appear in consistency graphs.
  3695. @item org-habit-following-days
  3696. The number of days after today that will appear in consistency graphs.
  3697. @item org-habit-show-habits-only-for-today
  3698. If non-nil, only show habits in today's agenda view. This is set to true by
  3699. default.
  3700. @end table
  3701. Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
  3702. temporarily be disabled and they won't appear at all. Press @kbd{K} again to
  3703. bring them back. They are also subject to tag filtering, if you have habits
  3704. which should only be done in certain contexts, for example.
  3705. @node Priorities, Breaking down tasks, Progress logging, TODO Items
  3706. @section Priorities
  3707. @cindex priorities
  3708. If you use Org mode extensively, you may end up with enough TODO items that
  3709. it starts to make sense to prioritize them. Prioritizing can be done by
  3710. placing a @emph{priority cookie} into the headline of a TODO item, like this
  3711. @example
  3712. *** TODO [#A] Write letter to Sam Fortune
  3713. @end example
  3714. @noindent
  3715. @vindex org-priority-faces
  3716. By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
  3717. @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
  3718. treated just like priority @samp{B}. Priorities make a difference only for
  3719. sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
  3720. have no inherent meaning to Org mode. The cookies can be highlighted with
  3721. special faces by customizing the variable @code{org-priority-faces}.
  3722. Priorities can be attached to any outline node; they do not need to be TODO
  3723. items.
  3724. @table @kbd
  3725. @item @kbd{C-c ,}
  3726. @kindex @kbd{C-c ,}
  3727. @findex org-priority
  3728. Set the priority of the current headline (@command{org-priority}). The
  3729. command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
  3730. When you press @key{SPC} instead, the priority cookie is removed from the
  3731. headline. The priorities can also be changed ``remotely'' from the timeline
  3732. and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
  3733. @c
  3734. @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
  3735. @vindex org-priority-start-cycle-with-default
  3736. Increase/decrease priority of current headline@footnote{See also the option
  3737. @code{org-priority-start-cycle-with-default}.}. Note that these keys are
  3738. also used to modify timestamps (@pxref{Creating timestamps}). See also
  3739. @ref{Conflicts}, for a discussion of the interaction with
  3740. @code{shift-selection-mode}.
  3741. @end table
  3742. @vindex org-highest-priority
  3743. @vindex org-lowest-priority
  3744. @vindex org-default-priority
  3745. You can change the range of allowed priorities by setting the variables
  3746. @code{org-highest-priority}, @code{org-lowest-priority}, and
  3747. @code{org-default-priority}. For an individual buffer, you may set
  3748. these values (highest, lowest, default) like this (please make sure that
  3749. the highest priority is earlier in the alphabet than the lowest
  3750. priority):
  3751. @cindex #+PRIORITIES
  3752. @example
  3753. #+PRIORITIES: A C B
  3754. @end example
  3755. @node Breaking down tasks, Checkboxes, Priorities, TODO Items
  3756. @section Breaking tasks down into subtasks
  3757. @cindex tasks, breaking down
  3758. @cindex statistics, for TODO items
  3759. @vindex org-agenda-todo-list-sublevels
  3760. It is often advisable to break down large tasks into smaller, manageable
  3761. subtasks. You can do this by creating an outline tree below a TODO item,
  3762. with detailed subtasks on the tree@footnote{To keep subtasks out of the
  3763. global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
  3764. the overview over the fraction of subtasks that are already completed, insert
  3765. either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
  3766. be updated each time the TODO status of a child changes, or when pressing
  3767. @kbd{C-c C-c} on the cookie. For example:
  3768. @example
  3769. * Organize Party [33%]
  3770. ** TODO Call people [1/2]
  3771. *** TODO Peter
  3772. *** DONE Sarah
  3773. ** TODO Buy food
  3774. ** DONE Talk to neighbor
  3775. @end example
  3776. @cindex property, COOKIE_DATA
  3777. If a heading has both checkboxes and TODO children below it, the meaning of
  3778. the statistics cookie become ambiguous. Set the property
  3779. @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
  3780. this issue.
  3781. @vindex org-hierarchical-todo-statistics
  3782. If you would like to have the statistics cookie count any TODO entries in the
  3783. subtree (not just direct children), configure the variable
  3784. @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
  3785. include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
  3786. property.
  3787. @example
  3788. * Parent capturing statistics [2/20]
  3789. :PROPERTIES:
  3790. :COOKIE_DATA: todo recursive
  3791. :END:
  3792. @end example
  3793. If you would like a TODO entry to automatically change to DONE
  3794. when all children are done, you can use the following setup:
  3795. @example
  3796. (defun org-summary-todo (n-done n-not-done)
  3797. "Switch entry to DONE when all subentries are done, to TODO otherwise."
  3798. (let (org-log-done org-log-states) ; turn off logging
  3799. (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
  3800. (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
  3801. @end example
  3802. Another possibility is the use of checkboxes to identify (a hierarchy of) a
  3803. large number of subtasks (@pxref{Checkboxes}).
  3804. @node Checkboxes, , Breaking down tasks, TODO Items
  3805. @section Checkboxes
  3806. @cindex checkboxes
  3807. @vindex org-list-automatic-rules
  3808. Every item in a plain list@footnote{With the exception of description
  3809. lists. But you can allow it by modifying @code{org-list-automatic-rules}
  3810. accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
  3811. it with the string @samp{[ ]}. This feature is similar to TODO items
  3812. (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
  3813. into the global TODO list, so they are often great to split a task into a
  3814. number of simple steps. Or you can use them in a shopping list. To toggle a
  3815. checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
  3816. @file{org-mouse.el}).
  3817. Here is an example of a checkbox list.
  3818. @example
  3819. * TODO Organize party [2/4]
  3820. - [-] call people [1/3]
  3821. - [ ] Peter
  3822. - [X] Sarah
  3823. - [ ] Sam
  3824. - [X] order food
  3825. - [ ] think about what music to play
  3826. - [X] talk to the neighbors
  3827. @end example
  3828. Checkboxes work hierarchically, so if a checkbox item has children that
  3829. are checkboxes, toggling one of the children checkboxes will make the
  3830. parent checkbox reflect if none, some, or all of the children are
  3831. checked.
  3832. @cindex statistics, for checkboxes
  3833. @cindex checkbox statistics
  3834. @cindex property, COOKIE_DATA
  3835. @vindex org-hierarchical-checkbox-statistics
  3836. The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
  3837. indicating how many checkboxes present in this entry have been checked off,
  3838. and the total number of checkboxes present. This can give you an idea on how
  3839. many checkboxes remain, even without opening a folded entry. The cookies can
  3840. be placed into a headline or into (the first line of) a plain list item.
  3841. Each cookie covers checkboxes of direct children structurally below the
  3842. headline/item on which the cookie appears@footnote{Set the variable
  3843. @code{org-hierarchical-checkbox-statistics} if you want such cookies to
  3844. count all checkboxes below the cookie, not just those belonging to direct
  3845. children.}. You have to insert the cookie yourself by typing either
  3846. @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
  3847. result, as in the examples above. With @samp{[%]} you get information about
  3848. the percentage of checkboxes checked (in the above example, this would be
  3849. @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
  3850. count either checkboxes below the heading or TODO states of children, and it
  3851. will display whatever was changed last. Set the property @code{COOKIE_DATA}
  3852. to either @samp{checkbox} or @samp{todo} to resolve this issue.
  3853. @cindex blocking, of checkboxes
  3854. @cindex checkbox blocking
  3855. @cindex property, ORDERED
  3856. If the current outline node has an @code{ORDERED} property, checkboxes must
  3857. be checked off in sequence, and an error will be thrown if you try to check
  3858. off a box while there are unchecked boxes above it.
  3859. @noindent The following commands work with checkboxes:
  3860. @table @kbd
  3861. @orgcmd{C-c C-c,org-toggle-checkbox}
  3862. Toggle checkbox status or (with prefix arg) checkbox presence at point.
  3863. With a single prefix argument, add an empty checkbox or remove the current
  3864. one@footnote{`C-u C-c C-c' on the @emph{first} item of a list with no checkbox
  3865. will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
  3866. considered to be an intermediate state.
  3867. @orgcmd{C-c C-x C-b,org-toggle-checkbox}
  3868. Toggle checkbox status or (with prefix arg) checkbox presence at point. With
  3869. double prefix argument, set it to @samp{[-]}, which is considered to be an
  3870. intermediate state.
  3871. @itemize @minus
  3872. @item
  3873. If there is an active region, toggle the first checkbox in the region
  3874. and set all remaining boxes to the same status as the first. With a prefix
  3875. arg, add or remove the checkbox for all items in the region.
  3876. @item
  3877. If the cursor is in a headline, toggle checkboxes in the region between
  3878. this headline and the next (so @emph{not} the entire subtree).
  3879. @item
  3880. If there is no active region, just toggle the checkbox at point.
  3881. @end itemize
  3882. @orgcmd{M-S-@key{RET},org-insert-todo-heading}
  3883. Insert a new item with a checkbox. This works only if the cursor is already
  3884. in a plain list item (@pxref{Plain lists}).
  3885. @orgcmd{C-c C-x o,org-toggle-ordered-property}
  3886. @vindex org-track-ordered-property-with-tag
  3887. @cindex property, ORDERED
  3888. Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
  3889. be checked off in sequence. A property is used for this behavior because
  3890. this should be local to the current entry, not inherited like a tag.
  3891. However, if you would like to @i{track} the value of this property with a tag
  3892. for better visibility, customize the variable
  3893. @code{org-track-ordered-property-with-tag}.
  3894. @orgcmd{C-c #,org-update-statistics-cookies}
  3895. Update the statistics cookie in the current outline entry. When called with
  3896. a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
  3897. updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
  3898. new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
  3899. changing TODO states. If you delete boxes/entries or add/change them by
  3900. hand, use this command to get things back into sync.
  3901. @end table
  3902. @node Tags, Properties and Columns, TODO Items, Top
  3903. @chapter Tags
  3904. @cindex tags
  3905. @cindex headline tagging
  3906. @cindex matching, tags
  3907. @cindex sparse tree, tag based
  3908. An excellent way to implement labels and contexts for cross-correlating
  3909. information is to assign @i{tags} to headlines. Org mode has extensive
  3910. support for tags.
  3911. @vindex org-tag-faces
  3912. Every headline can contain a list of tags; they occur at the end of the
  3913. headline. Tags are normal words containing letters, numbers, @samp{_}, and
  3914. @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
  3915. @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
  3916. Tags will by default be in bold face with the same color as the headline.
  3917. You may specify special faces for specific tags using the variable
  3918. @code{org-tag-faces}, in much the same way as you can for TODO keywords
  3919. (@pxref{Faces for TODO keywords}).
  3920. @menu
  3921. * Tag inheritance:: Tags use the tree structure of the outline
  3922. * Setting tags:: How to assign tags to a headline
  3923. * Tag searches:: Searching for combinations of tags
  3924. @end menu
  3925. @node Tag inheritance, Setting tags, Tags, Tags
  3926. @section Tag inheritance
  3927. @cindex tag inheritance
  3928. @cindex inheritance, of tags
  3929. @cindex sublevels, inclusion into tags match
  3930. @i{Tags} make use of the hierarchical structure of outline trees. If a
  3931. heading has a certain tag, all subheadings will inherit the tag as
  3932. well. For example, in the list
  3933. @example
  3934. * Meeting with the French group :work:
  3935. ** Summary by Frank :boss:notes:
  3936. *** TODO Prepare slides for him :action:
  3937. @end example
  3938. @noindent
  3939. the final heading will have the tags @samp{:work:}, @samp{:boss:},
  3940. @samp{:notes:}, and @samp{:action:} even though the final heading is not
  3941. explicitly marked with those tags. You can also set tags that all entries in
  3942. a file should inherit just as if these tags were defined in a hypothetical
  3943. level zero that surrounds the entire file. Use a line like this@footnote{As
  3944. with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
  3945. changes in the line.}:
  3946. @cindex #+FILETAGS
  3947. @example
  3948. #+FILETAGS: :Peter:Boss:Secret:
  3949. @end example
  3950. @noindent
  3951. @vindex org-use-tag-inheritance
  3952. @vindex org-tags-exclude-from-inheritance
  3953. To limit tag inheritance to specific tags, or to turn it off entirely, use
  3954. the variables @code{org-use-tag-inheritance} and
  3955. @code{org-tags-exclude-from-inheritance}.
  3956. @vindex org-tags-match-list-sublevels
  3957. When a headline matches during a tags search while tag inheritance is turned
  3958. on, all the sublevels in the same tree will (for a simple match form) match
  3959. as well@footnote{This is only true if the search does not involve more
  3960. complex tests including properties (@pxref{Property searches}).}. The list
  3961. of matches may then become very long. If you only want to see the first tags
  3962. match in a subtree, configure the variable
  3963. @code{org-tags-match-list-sublevels} (not recommended).
  3964. @node Setting tags, Tag searches, Tag inheritance, Tags
  3965. @section Setting tags
  3966. @cindex setting tags
  3967. @cindex tags, setting
  3968. @kindex M-@key{TAB}
  3969. Tags can simply be typed into the buffer at the end of a headline.
  3970. After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
  3971. also a special command for inserting tags:
  3972. @table @kbd
  3973. @orgcmd{C-c C-q,org-set-tags-command}
  3974. @cindex completion, of tags
  3975. @vindex org-tags-column
  3976. Enter new tags for the current headline. Org mode will either offer
  3977. completion or a special single-key interface for setting tags, see
  3978. below. After pressing @key{RET}, the tags will be inserted and aligned
  3979. to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
  3980. tags in the current buffer will be aligned to that column, just to make
  3981. things look nice. TAGS are automatically realigned after promotion,
  3982. demotion, and TODO state changes (@pxref{TODO basics}).
  3983. @orgcmd{C-c C-c,org-set-tags-command}
  3984. When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
  3985. @end table
  3986. @vindex org-tag-alist
  3987. Org supports tag insertion based on a @emph{list of tags}. By
  3988. default this list is constructed dynamically, containing all tags
  3989. currently used in the buffer. You may also globally specify a hard list
  3990. of tags with the variable @code{org-tag-alist}. Finally you can set
  3991. the default tags for a given file with lines like
  3992. @cindex #+TAGS
  3993. @example
  3994. #+TAGS: @@work @@home @@tennisclub
  3995. #+TAGS: laptop car pc sailboat
  3996. @end example
  3997. If you have globally defined your preferred set of tags using the
  3998. variable @code{org-tag-alist}, but would like to use a dynamic tag list
  3999. in a specific file, add an empty TAGS option line to that file:
  4000. @example
  4001. #+TAGS:
  4002. @end example
  4003. @vindex org-tag-persistent-alist
  4004. If you have a preferred set of tags that you would like to use in every file,
  4005. in addition to those defined on a per-file basis by TAGS option lines, then
  4006. you may specify a list of tags with the variable
  4007. @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
  4008. by adding a STARTUP option line to that file:
  4009. @example
  4010. #+STARTUP: noptag
  4011. @end example
  4012. By default Org mode uses the standard minibuffer completion facilities for
  4013. entering tags. However, it also implements another, quicker, tag selection
  4014. method called @emph{fast tag selection}. This allows you to select and
  4015. deselect tags with just a single key press. For this to work well you should
  4016. assign unique letters to most of your commonly used tags. You can do this
  4017. globally by configuring the variable @code{org-tag-alist} in your
  4018. @file{.emacs} file. For example, you may find the need to tag many items in
  4019. different files with @samp{:@@home:}. In this case you can set something
  4020. like:
  4021. @lisp
  4022. (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
  4023. @end lisp
  4024. @noindent If the tag is only relevant to the file you are working on, then you
  4025. can instead set the TAGS option line as:
  4026. @example
  4027. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
  4028. @end example
  4029. @noindent The tags interface will show the available tags in a splash
  4030. window. If you want to start a new line after a specific tag, insert
  4031. @samp{\n} into the tag list
  4032. @example
  4033. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
  4034. @end example
  4035. @noindent or write them in two lines:
  4036. @example
  4037. #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
  4038. #+TAGS: laptop(l) pc(p)
  4039. @end example
  4040. @noindent
  4041. You can also group together tags that are mutually exclusive by using
  4042. braces, as in:
  4043. @example
  4044. #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
  4045. @end example
  4046. @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
  4047. and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
  4048. @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
  4049. these lines to activate any changes.
  4050. @noindent
  4051. To set these mutually exclusive groups in the variable @code{org-tags-alist},
  4052. you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
  4053. of the braces. Similarly, you can use @code{:newline} to indicate a line
  4054. break. The previous example would be set globally by the following
  4055. configuration:
  4056. @lisp
  4057. (setq org-tag-alist '((:startgroup . nil)
  4058. ("@@work" . ?w) ("@@home" . ?h)
  4059. ("@@tennisclub" . ?t)
  4060. (:endgroup . nil)
  4061. ("laptop" . ?l) ("pc" . ?p)))
  4062. @end lisp
  4063. If at least one tag has a selection key then pressing @kbd{C-c C-c} will
  4064. automatically present you with a special interface, listing inherited tags,
  4065. the tags of the current headline, and a list of all valid tags with
  4066. corresponding keys@footnote{Keys will automatically be assigned to tags which
  4067. have no configured keys.}. In this interface, you can use the following
  4068. keys:
  4069. @table @kbd
  4070. @item a-z...
  4071. Pressing keys assigned to tags will add or remove them from the list of
  4072. tags in the current line. Selecting a tag in a group of mutually
  4073. exclusive tags will turn off any other tags from that group.
  4074. @kindex @key{TAB}
  4075. @item @key{TAB}
  4076. Enter a tag in the minibuffer, even if the tag is not in the predefined
  4077. list. You will be able to complete on all tags present in the buffer.
  4078. You can also add several tags: just separate them with a comma.
  4079. @kindex @key{SPC}
  4080. @item @key{SPC}
  4081. Clear all tags for this line.
  4082. @kindex @key{RET}
  4083. @item @key{RET}
  4084. Accept the modified set.
  4085. @item C-g
  4086. Abort without installing changes.
  4087. @item q
  4088. If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
  4089. @item !
  4090. Turn off groups of mutually exclusive tags. Use this to (as an
  4091. exception) assign several tags from such a group.
  4092. @item C-c
  4093. Toggle auto-exit after the next change (see below).
  4094. If you are using expert mode, the first @kbd{C-c} will display the
  4095. selection window.
  4096. @end table
  4097. @noindent
  4098. This method lets you assign tags to a headline with very few keys. With
  4099. the above setup, you could clear the current tags and set @samp{@@home},
  4100. @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
  4101. C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
  4102. @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
  4103. alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
  4104. @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
  4105. @key{RET} @key{RET}}.
  4106. @vindex org-fast-tag-selection-single-key
  4107. If you find that most of the time you need only a single key press to
  4108. modify your list of tags, set the variable
  4109. @code{org-fast-tag-selection-single-key}. Then you no longer have to
  4110. press @key{RET} to exit fast tag selection---it will immediately exit
  4111. after the first change. If you then occasionally need more keys, press
  4112. @kbd{C-c} to turn off auto-exit for the current tag selection process
  4113. (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
  4114. C-c}). If you set the variable to the value @code{expert}, the special
  4115. window is not even shown for single-key tag selection, it comes up only
  4116. when you press an extra @kbd{C-c}.
  4117. @node Tag searches, , Setting tags, Tags
  4118. @section Tag searches
  4119. @cindex tag searches
  4120. @cindex searching for tags
  4121. Once a system of tags has been set up, it can be used to collect related
  4122. information into special lists.
  4123. @table @kbd
  4124. @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
  4125. Create a sparse tree with all headlines matching a tags search. With a
  4126. @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  4127. @orgcmd{C-c a m,org-tags-view}
  4128. Create a global list of tag matches from all agenda files.
  4129. @xref{Matching tags and properties}.
  4130. @orgcmd{C-c a M,org-tags-view}
  4131. @vindex org-tags-match-list-sublevels
  4132. Create a global list of tag matches from all agenda files, but check
  4133. only TODO items and force checking subitems (see variable
  4134. @code{org-tags-match-list-sublevels}).
  4135. @end table
  4136. These commands all prompt for a match string which allows basic Boolean logic
  4137. like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
  4138. @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
  4139. which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
  4140. string is rich and allows also matching against TODO keywords, entry levels
  4141. and properties. For a complete description with many examples, see
  4142. @ref{Matching tags and properties}.
  4143. @node Properties and Columns, Dates and Times, Tags, Top
  4144. @chapter Properties and columns
  4145. @cindex properties
  4146. A property is a key-value pair associated with an entry. Properties can be
  4147. set so they are associated with a single entry, with every entry in a tree,
  4148. or with every entry in an Org mode file.
  4149. There are two main applications for properties in Org mode. First,
  4150. properties are like tags, but with a value. Imagine maintaining a file where
  4151. you document bugs and plan releases for a piece of software. Instead of
  4152. using tags like @code{:release_1:}, @code{:release_2:}, you can use a
  4153. property, say @code{:Release:}, that in different subtrees has different
  4154. values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
  4155. implement (very basic) database capabilities in an Org buffer. Imagine
  4156. keeping track of your music CDs, where properties could be things such as the
  4157. album, artist, date of release, number of tracks, and so on.
  4158. Properties can be conveniently edited and viewed in column view
  4159. (@pxref{Column view}).
  4160. @menu
  4161. * Property syntax:: How properties are spelled out
  4162. * Special properties:: Access to other Org mode features
  4163. * Property searches:: Matching property values
  4164. * Property inheritance:: Passing values down the tree
  4165. * Column view:: Tabular viewing and editing
  4166. * Property API:: Properties for Lisp programmers
  4167. @end menu
  4168. @node Property syntax, Special properties, Properties and Columns, Properties and Columns
  4169. @section Property syntax
  4170. @cindex property syntax
  4171. @cindex drawer, for properties
  4172. Properties are key-value pairs. When they are associated with a single entry
  4173. or with a tree they need to be inserted into a special
  4174. drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
  4175. is specified on a single line, with the key (surrounded by colons)
  4176. first, and the value after it. Here is an example:
  4177. @example
  4178. * CD collection
  4179. ** Classic
  4180. *** Goldberg Variations
  4181. :PROPERTIES:
  4182. :Title: Goldberg Variations
  4183. :Composer: J.S. Bach
  4184. :Artist: Glen Gould
  4185. :Publisher: Deutsche Grammophon
  4186. :NDisks: 1
  4187. :END:
  4188. @end example
  4189. Depending on the value of @code{org-use-property-inheritance}, a property set
  4190. this way will either be associated with a single entry, or the sub-tree
  4191. defined by the entry, see @ref{Property inheritance}.
  4192. You may define the allowed values for a particular property @samp{:Xyz:}
  4193. by setting a property @samp{:Xyz_ALL:}. This special property is
  4194. @emph{inherited}, so if you set it in a level 1 entry, it will apply to
  4195. the entire tree. When allowed values are defined, setting the
  4196. corresponding property becomes easier and is less prone to typing
  4197. errors. For the example with the CD collection, we can predefine
  4198. publishers and the number of disks in a box like this:
  4199. @example
  4200. * CD collection
  4201. :PROPERTIES:
  4202. :NDisks_ALL: 1 2 3 4
  4203. :Publisher_ALL: "Deutsche Grammophon" Philips EMI
  4204. :END:
  4205. @end example
  4206. If you want to set properties that can be inherited by any entry in a
  4207. file, use a line like
  4208. @cindex property, _ALL
  4209. @cindex #+PROPERTY
  4210. @example
  4211. #+PROPERTY: NDisks_ALL 1 2 3 4
  4212. @end example
  4213. If you want to add to the value of an existing property, append a @code{+} to
  4214. the property name. The following results in the property @code{var} having
  4215. the value ``foo=1 bar=2''.
  4216. @cindex property, +
  4217. @example
  4218. #+PROPERTY: var foo=1
  4219. #+PROPERTY: var+ bar=2
  4220. @end example
  4221. It is also possible to add to the values of inherited properties. The
  4222. following results in the @code{genres} property having the value ``Classic
  4223. Baroque'' under the @code{Goldberg Variations} subtree.
  4224. @cindex property, +
  4225. @example
  4226. * CD collection
  4227. ** Classic
  4228. :PROPERTIES:
  4229. :GENRES: Classic
  4230. :END:
  4231. *** Goldberg Variations
  4232. :PROPERTIES:
  4233. :Title: Goldberg Variations
  4234. :Composer: J.S. Bach
  4235. :Artist: Glen Gould
  4236. :Publisher: Deutsche Grammophon
  4237. :NDisks: 1
  4238. :GENRES+: Baroque
  4239. :END:
  4240. @end example
  4241. Note that a property can only have one entry per Drawer.
  4242. @vindex org-global-properties
  4243. Property values set with the global variable
  4244. @code{org-global-properties} can be inherited by all entries in all
  4245. Org files.
  4246. @noindent
  4247. The following commands help to work with properties:
  4248. @table @kbd
  4249. @orgcmd{M-@key{TAB},pcomplete}
  4250. After an initial colon in a line, complete property keys. All keys used
  4251. in the current file will be offered as possible completions.
  4252. @orgcmd{C-c C-x p,org-set-property}
  4253. Set a property. This prompts for a property name and a value. If
  4254. necessary, the property drawer is created as well.
  4255. @item M-x org-insert-property-drawer
  4256. @findex org-insert-property-drawer
  4257. Insert a property drawer into the current entry. The drawer will be
  4258. inserted early in the entry, but after the lines with planning
  4259. information like deadlines.
  4260. @orgcmd{C-c C-c,org-property-action}
  4261. With the cursor in a property drawer, this executes property commands.
  4262. @orgcmd{C-c C-c s,org-set-property}
  4263. Set a property in the current entry. Both the property and the value
  4264. can be inserted using completion.
  4265. @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
  4266. Switch property at point to the next/previous allowed value.
  4267. @orgcmd{C-c C-c d,org-delete-property}
  4268. Remove a property from the current entry.
  4269. @orgcmd{C-c C-c D,org-delete-property-globally}
  4270. Globally remove a property, from all entries in the current file.
  4271. @orgcmd{C-c C-c c,org-compute-property-at-point}
  4272. Compute the property at point, using the operator and scope from the
  4273. nearest column format definition.
  4274. @end table
  4275. @node Special properties, Property searches, Property syntax, Properties and Columns
  4276. @section Special properties
  4277. @cindex properties, special
  4278. Special properties provide an alternative access method to Org mode features,
  4279. like the TODO state or the priority of an entry, discussed in the previous
  4280. chapters. This interface exists so that you can include these states in a
  4281. column view (@pxref{Column view}), or to use them in queries. The following
  4282. property names are special and (except for @code{:CATEGORY:}) should not be
  4283. used as keys in the properties drawer:
  4284. @cindex property, special, TODO
  4285. @cindex property, special, TAGS
  4286. @cindex property, special, ALLTAGS
  4287. @cindex property, special, CATEGORY
  4288. @cindex property, special, PRIORITY
  4289. @cindex property, special, DEADLINE
  4290. @cindex property, special, SCHEDULED
  4291. @cindex property, special, CLOSED
  4292. @cindex property, special, TIMESTAMP
  4293. @cindex property, special, TIMESTAMP_IA
  4294. @cindex property, special, CLOCKSUM
  4295. @cindex property, special, BLOCKED
  4296. @c guessing that ITEM is needed in this area; also, should this list be sorted?
  4297. @cindex property, special, ITEM
  4298. @cindex property, special, FILE
  4299. @example
  4300. TODO @r{The TODO keyword of the entry.}
  4301. TAGS @r{The tags defined directly in the headline.}
  4302. ALLTAGS @r{All tags, including inherited ones.}
  4303. CATEGORY @r{The category of an entry.}
  4304. PRIORITY @r{The priority of the entry, a string with a single letter.}
  4305. DEADLINE @r{The deadline time string, without the angular brackets.}
  4306. SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
  4307. CLOSED @r{When was this entry closed?}
  4308. TIMESTAMP @r{The first keyword-less timestamp in the entry.}
  4309. TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
  4310. CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
  4311. @r{must be run first to compute the values in the current buffer.}
  4312. BLOCKED @r{"t" if task is currently blocked by children or siblings}
  4313. ITEM @r{The content of the entry.}
  4314. FILE @r{The filename the entry is located in.}
  4315. @end example
  4316. @node Property searches, Property inheritance, Special properties, Properties and Columns
  4317. @section Property searches
  4318. @cindex properties, searching
  4319. @cindex searching, of properties
  4320. To create sparse trees and special lists with selection based on properties,
  4321. the same commands are used as for tag searches (@pxref{Tag searches}).
  4322. @table @kbd
  4323. @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
  4324. Create a sparse tree with all matching entries. With a
  4325. @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  4326. @orgcmd{C-c a m,org-tags-view}
  4327. Create a global list of tag/property matches from all agenda files.
  4328. @xref{Matching tags and properties}.
  4329. @orgcmd{C-c a M,org-tags-view}
  4330. @vindex org-tags-match-list-sublevels
  4331. Create a global list of tag matches from all agenda files, but check
  4332. only TODO items and force checking of subitems (see variable
  4333. @code{org-tags-match-list-sublevels}).
  4334. @end table
  4335. The syntax for the search string is described in @ref{Matching tags and
  4336. properties}.
  4337. There is also a special command for creating sparse trees based on a
  4338. single property:
  4339. @table @kbd
  4340. @orgkey{C-c / p}
  4341. Create a sparse tree based on the value of a property. This first
  4342. prompts for the name of a property, and then for a value. A sparse tree
  4343. is created with all entries that define this property with the given
  4344. value. If you enclose the value in curly braces, it is interpreted as
  4345. a regular expression and matched against the property values.
  4346. @end table
  4347. @node Property inheritance, Column view, Property searches, Properties and Columns
  4348. @section Property Inheritance
  4349. @cindex properties, inheritance
  4350. @cindex inheritance, of properties
  4351. @vindex org-use-property-inheritance
  4352. The outline structure of Org mode documents lends itself to an
  4353. inheritance model of properties: if the parent in a tree has a certain
  4354. property, the children can inherit this property. Org mode does not
  4355. turn this on by default, because it can slow down property searches
  4356. significantly and is often not needed. However, if you find inheritance
  4357. useful, you can turn it on by setting the variable
  4358. @code{org-use-property-inheritance}. It may be set to @code{t} to make
  4359. all properties inherited from the parent, to a list of properties
  4360. that should be inherited, or to a regular expression that matches
  4361. inherited properties. If a property has the value @samp{nil}, this is
  4362. interpreted as an explicit undefine of the property, so that inheritance
  4363. search will stop at this value and return @code{nil}.
  4364. Org mode has a few properties for which inheritance is hard-coded, at
  4365. least for the special applications for which they are used:
  4366. @cindex property, COLUMNS
  4367. @table @code
  4368. @item COLUMNS
  4369. The @code{:COLUMNS:} property defines the format of column view
  4370. (@pxref{Column view}). It is inherited in the sense that the level
  4371. where a @code{:COLUMNS:} property is defined is used as the starting
  4372. point for a column view table, independently of the location in the
  4373. subtree from where columns view is turned on.
  4374. @item CATEGORY
  4375. @cindex property, CATEGORY
  4376. For agenda view, a category set through a @code{:CATEGORY:} property
  4377. applies to the entire subtree.
  4378. @item ARCHIVE
  4379. @cindex property, ARCHIVE
  4380. For archiving, the @code{:ARCHIVE:} property may define the archive
  4381. location for the entire subtree (@pxref{Moving subtrees}).
  4382. @item LOGGING
  4383. @cindex property, LOGGING
  4384. The LOGGING property may define logging settings for an entry or a
  4385. subtree (@pxref{Tracking TODO state changes}).
  4386. @end table
  4387. @node Column view, Property API, Property inheritance, Properties and Columns
  4388. @section Column view
  4389. A great way to view and edit properties in an outline tree is
  4390. @emph{column view}. In column view, each outline node is turned into a
  4391. table row. Columns in this table provide access to properties of the
  4392. entries. Org mode implements columns by overlaying a tabular structure
  4393. over the headline of each item. While the headlines have been turned
  4394. into a table row, you can still change the visibility of the outline
  4395. tree. For example, you get a compact table by switching to CONTENTS
  4396. view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
  4397. is active), but you can still open, read, and edit the entry below each
  4398. headline. Or, you can switch to column view after executing a sparse
  4399. tree command and in this way get a table only for the selected items.
  4400. Column view also works in agenda buffers (@pxref{Agenda Views}) where
  4401. queries have collected selected items, possibly from a number of files.
  4402. @menu
  4403. * Defining columns:: The COLUMNS format property
  4404. * Using column view:: How to create and use column view
  4405. * Capturing column view:: A dynamic block for column view
  4406. @end menu
  4407. @node Defining columns, Using column view, Column view, Column view
  4408. @subsection Defining columns
  4409. @cindex column view, for properties
  4410. @cindex properties, column view
  4411. Setting up a column view first requires defining the columns. This is
  4412. done by defining a column format line.
  4413. @menu
  4414. * Scope of column definitions:: Where defined, where valid?
  4415. * Column attributes:: Appearance and content of a column
  4416. @end menu
  4417. @node Scope of column definitions, Column attributes, Defining columns, Defining columns
  4418. @subsubsection Scope of column definitions
  4419. To define a column format for an entire file, use a line like
  4420. @cindex #+COLUMNS
  4421. @example
  4422. #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  4423. @end example
  4424. To specify a format that only applies to a specific tree, add a
  4425. @code{:COLUMNS:} property to the top node of that tree, for example:
  4426. @example
  4427. ** Top node for columns view
  4428. :PROPERTIES:
  4429. :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  4430. :END:
  4431. @end example
  4432. If a @code{:COLUMNS:} property is present in an entry, it defines columns
  4433. for the entry itself, and for the entire subtree below it. Since the
  4434. column definition is part of the hierarchical structure of the document,
  4435. you can define columns on level 1 that are general enough for all
  4436. sublevels, and more specific columns further down, when you edit a
  4437. deeper part of the tree.
  4438. @node Column attributes, , Scope of column definitions, Defining columns
  4439. @subsubsection Column attributes
  4440. A column definition sets the attributes of a column. The general
  4441. definition looks like this:
  4442. @example
  4443. %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
  4444. @end example
  4445. @noindent
  4446. Except for the percent sign and the property name, all items are
  4447. optional. The individual parts have the following meaning:
  4448. @example
  4449. @var{width} @r{An integer specifying the width of the column in characters.}
  4450. @r{If omitted, the width will be determined automatically.}
  4451. @var{property} @r{The property that should be edited in this column.}
  4452. @r{Special properties representing meta data are allowed here}
  4453. @r{as well (@pxref{Special properties})}
  4454. @var{title} @r{The header text for the column. If omitted, the property}
  4455. @r{name is used.}
  4456. @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
  4457. @r{parent nodes are computed from the children.}
  4458. @r{Supported summary types are:}
  4459. @{+@} @r{Sum numbers in this column.}
  4460. @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
  4461. @{$@} @r{Currency, short for @samp{+;%.2f}.}
  4462. @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
  4463. @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
  4464. @{X/@} @r{Checkbox status, @samp{[n/m]}.}
  4465. @{X%@} @r{Checkbox status, @samp{[n%]}.}
  4466. @{min@} @r{Smallest number in column.}
  4467. @{max@} @r{Largest number.}
  4468. @{mean@} @r{Arithmetic mean of numbers.}
  4469. @{:min@} @r{Smallest time value in column.}
  4470. @{:max@} @r{Largest time value.}
  4471. @{:mean@} @r{Arithmetic mean of time values.}
  4472. @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
  4473. @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
  4474. @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
  4475. @{est+@} @r{Add low-high estimates.}
  4476. @end example
  4477. @noindent
  4478. Be aware that you can only have one summary type for any property you
  4479. include. Subsequent columns referencing the same property will all display the
  4480. same summary information.
  4481. The @code{est+} summary type requires further explanation. It is used for
  4482. combining estimates, expressed as low-high ranges. For example, instead
  4483. of estimating a particular task will take 5 days, you might estimate it as
  4484. 5-6 days if you're fairly confident you know how much work is required, or
  4485. 1-10 days if you don't really know what needs to be done. Both ranges
  4486. average at 5.5 days, but the first represents a more predictable delivery.
  4487. When combining a set of such estimates, simply adding the lows and highs
  4488. produces an unrealistically wide result. Instead, @code{est+} adds the
  4489. statistical mean and variance of the sub-tasks, generating a final estimate
  4490. from the sum. For example, suppose you had ten tasks, each of which was
  4491. estimated at 0.5 to 2 days of work. Straight addition produces an estimate
  4492. of 5 to 20 days, representing what to expect if everything goes either
  4493. extremely well or extremely poorly. In contrast, @code{est+} estimates the
  4494. full job more realistically, at 10-15 days.
  4495. Here is an example for a complete columns definition, along with allowed
  4496. values.
  4497. @example
  4498. :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.}
  4499. %10Time_Estimate@{:@} %CLOCKSUM
  4500. :Owner_ALL: Tammy Mark Karl Lisa Don
  4501. :Status_ALL: "In progress" "Not started yet" "Finished" ""
  4502. :Approved_ALL: "[ ]" "[X]"
  4503. @end example
  4504. @noindent
  4505. The first column, @samp{%25ITEM}, means the first 25 characters of the
  4506. item itself, i.e.@: of the headline. You probably always should start the
  4507. column definition with the @samp{ITEM} specifier. The other specifiers
  4508. create columns @samp{Owner} with a list of names as allowed values, for
  4509. @samp{Status} with four different possible values, and for a checkbox
  4510. field @samp{Approved}. When no width is given after the @samp{%}
  4511. character, the column will be exactly as wide as it needs to be in order
  4512. to fully display all values. The @samp{Approved} column does have a
  4513. modified title (@samp{Approved?}, with a question mark). Summaries will
  4514. be created for the @samp{Time_Estimate} column by adding time duration
  4515. expressions like HH:MM, and for the @samp{Approved} column, by providing
  4516. an @samp{[X]} status if all children have been checked. The
  4517. @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
  4518. in the subtree.
  4519. @node Using column view, Capturing column view, Defining columns, Column view
  4520. @subsection Using column view
  4521. @table @kbd
  4522. @tsubheading{Turning column view on and off}
  4523. @orgcmd{C-c C-x C-c,org-columns}
  4524. @vindex org-columns-default-format
  4525. Turn on column view. If the cursor is before the first headline in the file,
  4526. column view is turned on for the entire file, using the @code{#+COLUMNS}
  4527. definition. If the cursor is somewhere inside the outline, this command
  4528. searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
  4529. defines a format. When one is found, the column view table is established
  4530. for the tree starting at the entry that contains the @code{:COLUMNS:}
  4531. property. If no such property is found, the format is taken from the
  4532. @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
  4533. and column view is established for the current entry and its subtree.
  4534. @orgcmd{r,org-columns-redo}
  4535. Recreate the column view, to include recent changes made in the buffer.
  4536. @orgcmd{g,org-columns-redo}
  4537. Same as @kbd{r}.
  4538. @orgcmd{q,org-columns-quit}
  4539. Exit column view.
  4540. @tsubheading{Editing values}
  4541. @item @key{left} @key{right} @key{up} @key{down}
  4542. Move through the column view from field to field.
  4543. @kindex S-@key{left}
  4544. @kindex S-@key{right}
  4545. @item S-@key{left}/@key{right}
  4546. Switch to the next/previous allowed value of the field. For this, you
  4547. have to have specified allowed values for a property.
  4548. @item 1..9,0
  4549. Directly select the Nth allowed value, @kbd{0} selects the 10th value.
  4550. @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
  4551. Same as @kbd{S-@key{left}/@key{right}}
  4552. @orgcmd{e,org-columns-edit-value}
  4553. Edit the property at point. For the special properties, this will
  4554. invoke the same interface that you normally use to change that
  4555. property. For example, when editing a TAGS property, the tag completion
  4556. or fast selection interface will pop up.
  4557. @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
  4558. When there is a checkbox at point, toggle it.
  4559. @orgcmd{v,org-columns-show-value}
  4560. View the full value of this property. This is useful if the width of
  4561. the column is smaller than that of the value.
  4562. @orgcmd{a,org-columns-edit-allowed}
  4563. Edit the list of allowed values for this property. If the list is found
  4564. in the hierarchy, the modified values is stored there. If no list is
  4565. found, the new value is stored in the first entry that is part of the
  4566. current column view.
  4567. @tsubheading{Modifying the table structure}
  4568. @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
  4569. Make the column narrower/wider by one character.
  4570. @orgcmd{S-M-@key{right},org-columns-new}
  4571. Insert a new column, to the left of the current column.
  4572. @orgcmd{S-M-@key{left},org-columns-delete}
  4573. Delete the current column.
  4574. @end table
  4575. @node Capturing column view, , Using column view, Column view
  4576. @subsection Capturing column view
  4577. Since column view is just an overlay over a buffer, it cannot be
  4578. exported or printed directly. If you want to capture a column view, use
  4579. a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
  4580. of this block looks like this:
  4581. @cindex #+BEGIN, columnview
  4582. @example
  4583. * The column view
  4584. #+BEGIN: columnview :hlines 1 :id "label"
  4585. #+END:
  4586. @end example
  4587. @noindent This dynamic block has the following parameters:
  4588. @table @code
  4589. @item :id
  4590. This is the most important parameter. Column view is a feature that is
  4591. often localized to a certain (sub)tree, and the capture block might be
  4592. at a different location in the file. To identify the tree whose view to
  4593. capture, you can use 4 values:
  4594. @cindex property, ID
  4595. @example
  4596. local @r{use the tree in which the capture block is located}
  4597. global @r{make a global view, including all headings in the file}
  4598. "file:@var{path-to-file}"
  4599. @r{run column view at the top of this file}
  4600. "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
  4601. @r{property with the value @i{label}. You can use}
  4602. @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
  4603. @r{the current entry and copy it to the kill-ring.}
  4604. @end example
  4605. @item :hlines
  4606. When @code{t}, insert an hline after every line. When a number @var{N}, insert
  4607. an hline before each headline with level @code{<= @var{N}}.
  4608. @item :vlines
  4609. When set to @code{t}, force column groups to get vertical lines.
  4610. @item :maxlevel
  4611. When set to a number, don't capture entries below this level.
  4612. @item :skip-empty-rows
  4613. When set to @code{t}, skip rows where the only non-empty specifier of the
  4614. column view is @code{ITEM}.
  4615. @end table
  4616. @noindent
  4617. The following commands insert or update the dynamic block:
  4618. @table @kbd
  4619. @orgcmd{C-c C-x i,org-insert-columns-dblock}
  4620. Insert a dynamic block capturing a column view. You will be prompted
  4621. for the scope or ID of the view.
  4622. @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
  4623. Update dynamic block at point. The cursor needs to be in the
  4624. @code{#+BEGIN} line of the dynamic block.
  4625. @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
  4626. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  4627. you have several clock table blocks, column-capturing blocks or other dynamic
  4628. blocks in a buffer.
  4629. @end table
  4630. You can add formulas to the column view table and you may add plotting
  4631. instructions in front of the table---these will survive an update of the
  4632. block. If there is a @code{#+TBLFM:} after the table, the table will
  4633. actually be recalculated automatically after an update.
  4634. An alternative way to capture and process property values into a table is
  4635. provided by Eric Schulte's @file{org-collector.el} which is a contributed
  4636. package@footnote{Contributed packages are not part of Emacs, but are
  4637. distributed with the main distribution of Org (visit
  4638. @uref{http://orgmode.org}).}. It provides a general API to collect
  4639. properties from entries in a certain scope, and arbitrary Lisp expressions to
  4640. process these values before inserting them into a table or a dynamic block.
  4641. @node Property API, , Column view, Properties and Columns
  4642. @section The Property API
  4643. @cindex properties, API
  4644. @cindex API, for properties
  4645. There is a full API for accessing and changing properties. This API can
  4646. be used by Emacs Lisp programs to work with properties and to implement
  4647. features based on them. For more information see @ref{Using the
  4648. property API}.
  4649. @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
  4650. @chapter Dates and times
  4651. @cindex dates
  4652. @cindex times
  4653. @cindex timestamp
  4654. @cindex date stamp
  4655. To assist project planning, TODO items can be labeled with a date and/or
  4656. a time. The specially formatted string carrying the date and time
  4657. information is called a @emph{timestamp} in Org mode. This may be a
  4658. little confusing because timestamp is often used as indicating when
  4659. something was created or last changed. However, in Org mode this term
  4660. is used in a much wider sense.
  4661. @menu
  4662. * Timestamps:: Assigning a time to a tree entry
  4663. * Creating timestamps:: Commands which insert timestamps
  4664. * Deadlines and scheduling:: Planning your work
  4665. * Clocking work time:: Tracking how long you spend on a task
  4666. * Effort estimates:: Planning work effort in advance
  4667. * Relative timer:: Notes with a running timer
  4668. * Countdown timer:: Starting a countdown timer for a task
  4669. @end menu
  4670. @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
  4671. @section Timestamps, deadlines, and scheduling
  4672. @cindex timestamps
  4673. @cindex ranges, time
  4674. @cindex date stamps
  4675. @cindex deadlines
  4676. @cindex scheduling
  4677. A timestamp is a specification of a date (possibly with a time or a range of
  4678. times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
  4679. simplest form, the day name is optional when you type the date yourself.
  4680. However, any dates inserted or modified by Org will add that day name, for
  4681. reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
  4682. Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
  4683. date/time format. To use an alternative format, see @ref{Custom time
  4684. format}.}. A timestamp can appear anywhere in the headline or body of an Org
  4685. tree entry. Its presence causes entries to be shown on specific dates in the
  4686. agenda (@pxref{Weekly/daily agenda}). We distinguish:
  4687. @table @var
  4688. @item Plain timestamp; Event; Appointment
  4689. @cindex timestamp
  4690. @cindex appointment
  4691. A simple timestamp just assigns a date/time to an item. This is just
  4692. like writing down an appointment or event in a paper agenda. In the
  4693. timeline and agenda displays, the headline of an entry associated with a
  4694. plain timestamp will be shown exactly on that date.
  4695. @example
  4696. * Meet Peter at the movies <2006-11-01 Wed 19:15>
  4697. * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
  4698. @end example
  4699. @item Timestamp with repeater interval
  4700. @cindex timestamp, with repeater interval
  4701. A timestamp may contain a @emph{repeater interval}, indicating that it
  4702. applies not only on the given date, but again and again after a certain
  4703. interval of N days (d), weeks (w), months (m), or years (y). The
  4704. following will show up in the agenda every Wednesday:
  4705. @example
  4706. * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
  4707. @end example
  4708. @item Diary-style sexp entries
  4709. For more complex date specifications, Org mode supports using the special
  4710. sexp diary entries implemented in the Emacs calendar/diary
  4711. package@footnote{When working with the standard diary sexp functions, you
  4712. need to be very careful with the order of the arguments. That order depend
  4713. evilly on the variable @code{calendar-date-style} (or, for older Emacs
  4714. versions, @code{european-calendar-style}). For example, to specify a date
  4715. December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
  4716. @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
  4717. the settings. This has been the source of much confusion. Org mode users
  4718. can resort to special versions of these functions like @code{org-date} or
  4719. @code{org-anniversary}. These work just like the corresponding @code{diary-}
  4720. functions, but with stable ISO order of arguments (year, month, day) wherever
  4721. applicable, independent of the value of @code{calendar-date-style}.}. For
  4722. example with optional time
  4723. @example
  4724. * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
  4725. <%%(org-float t 4 2)>
  4726. @end example
  4727. @item Time/Date range
  4728. @cindex timerange
  4729. @cindex date range
  4730. Two timestamps connected by @samp{--} denote a range. The headline
  4731. will be shown on the first and last day of the range, and on any dates
  4732. that are displayed and fall in the range. Here is an example:
  4733. @example
  4734. ** Meeting in Amsterdam
  4735. <2004-08-23 Mon>--<2004-08-26 Thu>
  4736. @end example
  4737. @item Inactive timestamp
  4738. @cindex timestamp, inactive
  4739. @cindex inactive timestamp
  4740. Just like a plain timestamp, but with square brackets instead of
  4741. angular ones. These timestamps are inactive in the sense that they do
  4742. @emph{not} trigger an entry to show up in the agenda.
  4743. @example
  4744. * Gillian comes late for the fifth time [2006-11-01 Wed]
  4745. @end example
  4746. @end table
  4747. @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
  4748. @section Creating timestamps
  4749. @cindex creating timestamps
  4750. @cindex timestamps, creating
  4751. For Org mode to recognize timestamps, they need to be in the specific
  4752. format. All commands listed below produce timestamps in the correct
  4753. format.
  4754. @table @kbd
  4755. @orgcmd{C-c .,org-time-stamp}
  4756. Prompt for a date and insert a corresponding timestamp. When the cursor is
  4757. at an existing timestamp in the buffer, the command is used to modify this
  4758. timestamp instead of inserting a new one. When this command is used twice in
  4759. succession, a time range is inserted.
  4760. @c
  4761. @orgcmd{C-c !,org-time-stamp-inactive}
  4762. Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
  4763. an agenda entry.
  4764. @c
  4765. @kindex C-u C-c .
  4766. @kindex C-u C-c !
  4767. @item C-u C-c .
  4768. @itemx C-u C-c !
  4769. @vindex org-time-stamp-rounding-minutes
  4770. Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
  4771. contains date and time. The default time can be rounded to multiples of 5
  4772. minutes, see the option @code{org-time-stamp-rounding-minutes}.
  4773. @c
  4774. @orgkey{C-c C-c}
  4775. Normalize timestamp, insert/fix day name if missing or wrong.
  4776. @c
  4777. @orgcmd{C-c <,org-date-from-calendar}
  4778. Insert a timestamp corresponding to the cursor date in the Calendar.
  4779. @c
  4780. @orgcmd{C-c >,org-goto-calendar}
  4781. Access the Emacs calendar for the current date. If there is a
  4782. timestamp in the current line, go to the corresponding date
  4783. instead.
  4784. @c
  4785. @orgcmd{C-c C-o,org-open-at-point}
  4786. Access the agenda for the date given by the timestamp or -range at
  4787. point (@pxref{Weekly/daily agenda}).
  4788. @c
  4789. @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
  4790. Change date at cursor by one day. These key bindings conflict with
  4791. shift-selection and related modes (@pxref{Conflicts}).
  4792. @c
  4793. @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
  4794. Change the item under the cursor in a timestamp. The cursor can be on a
  4795. year, month, day, hour or minute. When the timestamp contains a time range
  4796. like @samp{15:30-16:30}, modifying the first time will also shift the second,
  4797. shifting the time block with constant length. To change the length, modify
  4798. the second time. Note that if the cursor is in a headline and not at a
  4799. timestamp, these same keys modify the priority of an item.
  4800. (@pxref{Priorities}). The key bindings also conflict with shift-selection and
  4801. related modes (@pxref{Conflicts}).
  4802. @c
  4803. @orgcmd{C-c C-y,org-evaluate-time-range}
  4804. @cindex evaluate time range
  4805. Evaluate a time range by computing the difference between start and end.
  4806. With a prefix argument, insert result after the time range (in a table: into
  4807. the following column).
  4808. @end table
  4809. @menu
  4810. * The date/time prompt:: How Org mode helps you entering date and time
  4811. * Custom time format:: Making dates look different
  4812. @end menu
  4813. @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
  4814. @subsection The date/time prompt
  4815. @cindex date, reading in minibuffer
  4816. @cindex time, reading in minibuffer
  4817. @vindex org-read-date-prefer-future
  4818. When Org mode prompts for a date/time, the default is shown in default
  4819. date/time format, and the prompt therefore seems to ask for a specific
  4820. format. But it will in fact accept any string containing some date and/or
  4821. time information, and it is really smart about interpreting your input. You
  4822. can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
  4823. copied from an email message. Org mode will find whatever information is in
  4824. there and derive anything you have not specified from the @emph{default date
  4825. and time}. The default is usually the current date and time, but when
  4826. modifying an existing timestamp, or when entering the second stamp of a
  4827. range, it is taken from the stamp in the buffer. When filling in
  4828. information, Org mode assumes that most of the time you will want to enter a
  4829. date in the future: if you omit the month/year and the given day/month is
  4830. @i{before} today, it will assume that you mean a future date@footnote{See the
  4831. variable @code{org-read-date-prefer-future}. You may set that variable to
  4832. the symbol @code{time} to even make a time before now shift the date to
  4833. tomorrow.}. If the date has been automatically shifted into the future, the
  4834. time prompt will show this with @samp{(=>F).}
  4835. For example, let's assume that today is @b{June 13, 2006}. Here is how
  4836. various inputs will be interpreted, the items filled in by Org mode are
  4837. in @b{bold}.
  4838. @example
  4839. 3-2-5 @result{} 2003-02-05
  4840. 2/5/3 @result{} 2003-02-05
  4841. 14 @result{} @b{2006}-@b{06}-14
  4842. 12 @result{} @b{2006}-@b{07}-12
  4843. 2/5 @result{} @b{2007}-02-05
  4844. Fri @result{} nearest Friday (default date or later)
  4845. sep 15 @result{} @b{2006}-09-15
  4846. feb 15 @result{} @b{2007}-02-15
  4847. sep 12 9 @result{} 2009-09-12
  4848. 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
  4849. 22 sept 0:34 @result{} @b{2006}-09-22 0:34
  4850. w4 @result{} ISO week for of the current year @b{2006}
  4851. 2012 w4 fri @result{} Friday of ISO week 4 in 2012
  4852. 2012-w04-5 @result{} Same as above
  4853. @end example
  4854. Furthermore you can specify a relative date by giving, as the
  4855. @emph{first} thing in the input: a plus/minus sign, a number and a
  4856. letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
  4857. single plus or minus, the date is always relative to today. With a
  4858. double plus or minus, it is relative to the default date. If instead of
  4859. a single letter, you use the abbreviation of day name, the date will be
  4860. the Nth such day, e.g.@:
  4861. @example
  4862. +0 @result{} today
  4863. . @result{} today
  4864. +4d @result{} four days from today
  4865. +4 @result{} same as above
  4866. +2w @result{} two weeks from today
  4867. ++5 @result{} five days from default date
  4868. +2tue @result{} second Tuesday from now.
  4869. @end example
  4870. @vindex parse-time-months
  4871. @vindex parse-time-weekdays
  4872. The function understands English month and weekday abbreviations. If
  4873. you want to use unabbreviated names and/or other languages, configure
  4874. the variables @code{parse-time-months} and @code{parse-time-weekdays}.
  4875. @vindex org-read-date-force-compatible-dates
  4876. Not all dates can be represented in a given Emacs implementation. By default
  4877. Org mode forces dates into the compatibility range 1970--2037 which works on
  4878. all Emacs implementations. If you want to use dates outside of this range,
  4879. read the docstring of the variable
  4880. @code{org-read-date-force-compatible-dates}.
  4881. You can specify a time range by giving start and end times or by giving a
  4882. start time and a duration (in HH:MM format). Use one or two dash(es) as the
  4883. separator in the former case and use '+' as the separator in the latter
  4884. case, e.g.@:
  4885. @example
  4886. 11am-1:15pm @result{} 11:00-13:15
  4887. 11am--1:15pm @result{} same as above
  4888. 11am+2:15 @result{} same as above
  4889. @end example
  4890. @cindex calendar, for selecting date
  4891. @vindex org-popup-calendar-for-date-prompt
  4892. Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
  4893. you don't need/want the calendar, configure the variable
  4894. @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
  4895. prompt, either by clicking on a date in the calendar, or by pressing
  4896. @key{RET}, the date selected in the calendar will be combined with the
  4897. information entered at the prompt. You can control the calendar fully
  4898. from the minibuffer:
  4899. @kindex <
  4900. @kindex >
  4901. @kindex M-v
  4902. @kindex C-v
  4903. @kindex mouse-1
  4904. @kindex S-@key{right}
  4905. @kindex S-@key{left}
  4906. @kindex S-@key{down}
  4907. @kindex S-@key{up}
  4908. @kindex M-S-@key{right}
  4909. @kindex M-S-@key{left}
  4910. @kindex @key{RET}
  4911. @example
  4912. @key{RET} @r{Choose date at cursor in calendar.}
  4913. mouse-1 @r{Select date by clicking on it.}
  4914. S-@key{right}/@key{left} @r{One day forward/backward.}
  4915. S-@key{down}/@key{up} @r{One week forward/backward.}
  4916. M-S-@key{right}/@key{left} @r{One month forward/backward.}
  4917. > / < @r{Scroll calendar forward/backward by one month.}
  4918. M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
  4919. @end example
  4920. @vindex org-read-date-display-live
  4921. The actions of the date/time prompt may seem complex, but I assure you they
  4922. will grow on you, and you will start getting annoyed by pretty much any other
  4923. way of entering a date/time out there. To help you understand what is going
  4924. on, the current interpretation of your input will be displayed live in the
  4925. minibuffer@footnote{If you find this distracting, turn the display of with
  4926. @code{org-read-date-display-live}.}.
  4927. @node Custom time format, , The date/time prompt, Creating timestamps
  4928. @subsection Custom time format
  4929. @cindex custom date/time format
  4930. @cindex time format, custom
  4931. @cindex date format, custom
  4932. @vindex org-display-custom-times
  4933. @vindex org-time-stamp-custom-formats
  4934. Org mode uses the standard ISO notation for dates and times as it is
  4935. defined in ISO 8601. If you cannot get used to this and require another
  4936. representation of date and time to keep you happy, you can get it by
  4937. customizing the variables @code{org-display-custom-times} and
  4938. @code{org-time-stamp-custom-formats}.
  4939. @table @kbd
  4940. @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
  4941. Toggle the display of custom formats for dates and times.
  4942. @end table
  4943. @noindent
  4944. Org mode needs the default format for scanning, so the custom date/time
  4945. format does not @emph{replace} the default format---instead it is put
  4946. @emph{over} the default format using text properties. This has the
  4947. following consequences:
  4948. @itemize @bullet
  4949. @item
  4950. You cannot place the cursor onto a timestamp anymore, only before or
  4951. after.
  4952. @item
  4953. The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
  4954. each component of a timestamp. If the cursor is at the beginning of
  4955. the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
  4956. just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
  4957. time will be changed by one minute.
  4958. @item
  4959. If the timestamp contains a range of clock times or a repeater, these
  4960. will not be overlaid, but remain in the buffer as they were.
  4961. @item
  4962. When you delete a timestamp character-by-character, it will only
  4963. disappear from the buffer after @emph{all} (invisible) characters
  4964. belonging to the ISO timestamp have been removed.
  4965. @item
  4966. If the custom timestamp format is longer than the default and you are
  4967. using dates in tables, table alignment will be messed up. If the custom
  4968. format is shorter, things do work as expected.
  4969. @end itemize
  4970. @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
  4971. @section Deadlines and scheduling
  4972. A timestamp may be preceded by special keywords to facilitate planning:
  4973. @table @var
  4974. @item DEADLINE
  4975. @cindex DEADLINE keyword
  4976. Meaning: the task (most likely a TODO item, though not necessarily) is supposed
  4977. to be finished on that date.
  4978. @vindex org-deadline-warning-days
  4979. On the deadline date, the task will be listed in the agenda. In
  4980. addition, the agenda for @emph{today} will carry a warning about the
  4981. approaching or missed deadline, starting
  4982. @code{org-deadline-warning-days} before the due date, and continuing
  4983. until the entry is marked DONE. An example:
  4984. @example
  4985. *** TODO write article about the Earth for the Guide
  4986. The editor in charge is [[bbdb:Ford Prefect]]
  4987. DEADLINE: <2004-02-29 Sun>
  4988. @end example
  4989. You can specify a different lead time for warnings for a specific
  4990. deadlines using the following syntax. Here is an example with a warning
  4991. period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
  4992. @item SCHEDULED
  4993. @cindex SCHEDULED keyword
  4994. Meaning: you are planning to start working on that task on the given
  4995. date.
  4996. @vindex org-agenda-skip-scheduled-if-done
  4997. The headline will be listed under the given date@footnote{It will still
  4998. be listed on that date after it has been marked DONE. If you don't like
  4999. this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
  5000. addition, a reminder that the scheduled date has passed will be present
  5001. in the compilation for @emph{today}, until the entry is marked DONE, i.e.@:
  5002. the task will automatically be forwarded until completed.
  5003. @example
  5004. *** TODO Call Trillian for a date on New Years Eve.
  5005. SCHEDULED: <2004-12-25 Sat>
  5006. @end example
  5007. @noindent
  5008. @b{Important:} Scheduling an item in Org mode should @i{not} be
  5009. understood in the same way that we understand @i{scheduling a meeting}.
  5010. Setting a date for a meeting is just a simple appointment, you should
  5011. mark this entry with a simple plain timestamp, to get this item shown
  5012. on the date where it applies. This is a frequent misunderstanding by
  5013. Org users. In Org mode, @i{scheduling} means setting a date when you
  5014. want to start working on an action item.
  5015. @end table
  5016. You may use timestamps with repeaters in scheduling and deadline
  5017. entries. Org mode will issue early and late warnings based on the
  5018. assumption that the timestamp represents the @i{nearest instance} of
  5019. the repeater. However, the use of diary sexp entries like
  5020. @c
  5021. @code{<%%(org-float t 42)>}
  5022. @c
  5023. in scheduling and deadline timestamps is limited. Org mode does not
  5024. know enough about the internals of each sexp function to issue early and
  5025. late warnings. However, it will show the item on each day where the
  5026. sexp entry matches.
  5027. @menu
  5028. * Inserting deadline/schedule:: Planning items
  5029. * Repeated tasks:: Items that show up again and again
  5030. @end menu
  5031. @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
  5032. @subsection Inserting deadlines or schedules
  5033. The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
  5034. @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
  5035. any text between this line and the headline.} a deadline or to schedule
  5036. an item:
  5037. @table @kbd
  5038. @c
  5039. @orgcmd{C-c C-d,org-deadline}
  5040. Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
  5041. in the line directly following the headline. Any CLOSED timestamp will be
  5042. removed. When called with a prefix arg, an existing deadline will be removed
  5043. from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
  5044. @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
  5045. and @code{nologredeadline}}, a note will be taken when changing an existing
  5046. deadline.
  5047. @orgcmd{C-c C-s,org-schedule}
  5048. Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
  5049. happen in the line directly following the headline. Any CLOSED timestamp
  5050. will be removed. When called with a prefix argument, remove the scheduling
  5051. date from the entry. Depending on the variable
  5052. @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
  5053. keywords @code{logreschedule}, @code{lognotereschedule}, and
  5054. @code{nologreschedule}}, a note will be taken when changing an existing
  5055. scheduling time.
  5056. @c
  5057. @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
  5058. @kindex k a
  5059. @kindex k s
  5060. Mark the current entry for agenda action. After you have marked the entry
  5061. like this, you can open the agenda or the calendar to find an appropriate
  5062. date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
  5063. schedule the marked item.
  5064. @c
  5065. @orgcmd{C-c / d,org-check-deadlines}
  5066. @cindex sparse tree, for deadlines
  5067. @vindex org-deadline-warning-days
  5068. Create a sparse tree with all deadlines that are either past-due, or
  5069. which will become due within @code{org-deadline-warning-days}.
  5070. With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
  5071. prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
  5072. all deadlines due tomorrow.
  5073. @c
  5074. @orgcmd{C-c / b,org-check-before-date}
  5075. Sparse tree for deadlines and scheduled items before a given date.
  5076. @c
  5077. @orgcmd{C-c / a,org-check-after-date}
  5078. Sparse tree for deadlines and scheduled items after a given date.
  5079. @end table
  5080. Note that @code{org-schedule} and @code{org-deadline} supports
  5081. setting the date by indicating a relative time: e.g. +1d will set
  5082. the date to the next day after today, and --1w will set the date
  5083. to the previous week before any current timestamp.
  5084. @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
  5085. @subsection Repeated tasks
  5086. @cindex tasks, repeated
  5087. @cindex repeated tasks
  5088. Some tasks need to be repeated again and again. Org mode helps to
  5089. organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
  5090. or plain timestamp. In the following example
  5091. @example
  5092. ** TODO Pay the rent
  5093. DEADLINE: <2005-10-01 Sat +1m>
  5094. @end example
  5095. @noindent
  5096. the @code{+1m} is a repeater; the intended interpretation is that the task
  5097. has a deadline on <2005-10-01> and repeats itself every (one) month starting
  5098. from that time. If you need both a repeater and a special warning period in
  5099. a deadline entry, the repeater should come first and the warning period last:
  5100. @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
  5101. @vindex org-todo-repeat-to-state
  5102. Deadlines and scheduled items produce entries in the agenda when they are
  5103. over-due, so it is important to be able to mark such an entry as completed
  5104. once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
  5105. keyword DONE, it will no longer produce entries in the agenda. The problem
  5106. with this is, however, that then also the @emph{next} instance of the
  5107. repeated entry will not be active. Org mode deals with this in the following
  5108. way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
  5109. shift the base date of the repeating timestamp by the repeater interval, and
  5110. immediately set the entry state back to TODO@footnote{In fact, the target
  5111. state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
  5112. the variable @code{org-todo-repeat-to-state}. If neither of these is
  5113. specified, the target state defaults to the first state of the TODO state
  5114. sequence.}. In the example above, setting the state to DONE would actually
  5115. switch the date like this:
  5116. @example
  5117. ** TODO Pay the rent
  5118. DEADLINE: <2005-11-01 Tue +1m>
  5119. @end example
  5120. @vindex org-log-repeat
  5121. A timestamp@footnote{You can change this using the option
  5122. @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
  5123. @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
  5124. will also be prompted for a note.} will be added under the deadline, to keep
  5125. a record that you actually acted on the previous instance of this deadline.
  5126. As a consequence of shifting the base date, this entry will no longer be
  5127. visible in the agenda when checking past dates, but all future instances
  5128. will be visible.
  5129. With the @samp{+1m} cookie, the date shift will always be exactly one
  5130. month. So if you have not paid the rent for three months, marking this
  5131. entry DONE will still keep it as an overdue deadline. Depending on the
  5132. task, this may not be the best way to handle it. For example, if you
  5133. forgot to call your father for 3 weeks, it does not make sense to call
  5134. him 3 times in a single day to make up for it. Finally, there are tasks
  5135. like changing batteries which should always repeat a certain time
  5136. @i{after} the last time you did it. For these tasks, Org mode has
  5137. special repeaters @samp{++} and @samp{.+}. For example:
  5138. @example
  5139. ** TODO Call Father
  5140. DEADLINE: <2008-02-10 Sun ++1w>
  5141. Marking this DONE will shift the date by at least one week,
  5142. but also by as many weeks as it takes to get this date into
  5143. the future. However, it stays on a Sunday, even if you called
  5144. and marked it done on Saturday.
  5145. ** TODO Check the batteries in the smoke detectors
  5146. DEADLINE: <2005-11-01 Tue .+1m>
  5147. Marking this DONE will shift the date to one month after
  5148. today.
  5149. @end example
  5150. You may have both scheduling and deadline information for a specific
  5151. task---just make sure that the repeater intervals on both are the same.
  5152. An alternative to using a repeater is to create a number of copies of a task
  5153. subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
  5154. created for this purpose, it is described in @ref{Structure editing}.
  5155. @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
  5156. @section Clocking work time
  5157. @cindex clocking time
  5158. @cindex time clocking
  5159. Org mode allows you to clock the time you spend on specific tasks in a
  5160. project. When you start working on an item, you can start the clock.
  5161. When you stop working on that task, or when you mark the task done, the
  5162. clock is stopped and the corresponding time interval is recorded. It
  5163. also computes the total time spent on each subtree of a project. And it
  5164. remembers a history or tasks recently clocked, to that you can jump quickly
  5165. between a number of tasks absorbing your time.
  5166. To save the clock history across Emacs sessions, use
  5167. @lisp
  5168. (setq org-clock-persist 'history)
  5169. (org-clock-persistence-insinuate)
  5170. @end lisp
  5171. When you clock into a new task after resuming Emacs, the incomplete
  5172. clock@footnote{To resume the clock under the assumption that you have worked
  5173. on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
  5174. will be found (@pxref{Resolving idle time}) and you will be prompted about
  5175. what to do with it.
  5176. @menu
  5177. * Clocking commands:: Starting and stopping a clock
  5178. * The clock table:: Detailed reports
  5179. * Resolving idle time:: Resolving time when you've been idle
  5180. @end menu
  5181. @node Clocking commands, The clock table, Clocking work time, Clocking work time
  5182. @subsection Clocking commands
  5183. @table @kbd
  5184. @orgcmd{C-c C-x C-i,org-clock-in}
  5185. @vindex org-clock-into-drawer
  5186. @cindex property, LOG_INTO_DRAWER
  5187. Start the clock on the current item (clock-in). This inserts the CLOCK
  5188. keyword together with a timestamp. If this is not the first clocking of
  5189. this item, the multiple CLOCK lines will be wrapped into a
  5190. @code{:LOGBOOK:} drawer (see also the variable
  5191. @code{org-clock-into-drawer}). You can also overrule
  5192. the setting of this variable for a subtree by setting a
  5193. @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
  5194. When called with a @kbd{C-u} prefix argument,
  5195. select the task from a list of recently clocked tasks. With two @kbd{C-u
  5196. C-u} prefixes, clock into the task at point and mark it as the default task.
  5197. The default task will always be available when selecting a clocking task,
  5198. with letter @kbd{d}.@*
  5199. @cindex property: CLOCK_MODELINE_TOTAL
  5200. @cindex property: LAST_REPEAT
  5201. @vindex org-clock-modeline-total
  5202. While the clock is running, the current clocking time is shown in the mode
  5203. line, along with the title of the task. The clock time shown will be all
  5204. time ever clocked for this task and its children. If the task has an effort
  5205. estimate (@pxref{Effort estimates}), the mode line displays the current
  5206. clocking time against it@footnote{To add an effort estimate ``on the fly'',
  5207. hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
  5208. is a repeating one (@pxref{Repeated tasks}), only the time since the last
  5209. reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
  5210. will be shown. More control over what time is shown can be exercised with
  5211. the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
  5212. @code{current} to show only the current clocking instance, @code{today} to
  5213. show all time clocked on this tasks today (see also the variable
  5214. @code{org-extend-today-until}), @code{all} to include all time, or
  5215. @code{auto} which is the default@footnote{See also the variable
  5216. @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
  5217. mode line entry will pop up a menu with clocking options.
  5218. @c
  5219. @orgcmd{C-c C-x C-o,org-clock-out}
  5220. @vindex org-log-note-clock-out
  5221. Stop the clock (clock-out). This inserts another timestamp at the same
  5222. location where the clock was last started. It also directly computes
  5223. the resulting time in inserts it after the time range as @samp{=>
  5224. HH:MM}. See the variable @code{org-log-note-clock-out} for the
  5225. possibility to record an additional note together with the clock-out
  5226. timestamp@footnote{The corresponding in-buffer setting is:
  5227. @code{#+STARTUP: lognoteclock-out}}.
  5228. @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
  5229. Update the effort estimate for the current clock task.
  5230. @kindex C-c C-y
  5231. @kindex C-c C-c
  5232. @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
  5233. Recompute the time interval after changing one of the timestamps. This
  5234. is only necessary if you edit the timestamps directly. If you change
  5235. them with @kbd{S-@key{cursor}} keys, the update is automatic.
  5236. @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
  5237. On @code{CLOCK} log lines, increase/decrease both timestamps at the same
  5238. time so that duration keeps the same.
  5239. @orgcmd{C-c C-t,org-todo}
  5240. Changing the TODO state of an item to DONE automatically stops the clock
  5241. if it is running in this same item.
  5242. @orgcmd{C-c C-x C-x,org-clock-cancel}
  5243. Cancel the current clock. This is useful if a clock was started by
  5244. mistake, or if you ended up working on something else.
  5245. @orgcmd{C-c C-x C-j,org-clock-goto}
  5246. Jump to the headline of the currently clocked in task. With a @kbd{C-u}
  5247. prefix arg, select the target task from a list of recently clocked tasks.
  5248. @orgcmd{C-c C-x C-d,org-clock-display}
  5249. @vindex org-remove-highlights-with-change
  5250. Display time summaries for each subtree in the current buffer. This puts
  5251. overlays at the end of each headline, showing the total time recorded under
  5252. that heading, including the time of any subheadings. You can use visibility
  5253. cycling to study the tree, but the overlays disappear when you change the
  5254. buffer (see variable @code{org-remove-highlights-with-change}) or press
  5255. @kbd{C-c C-c}.
  5256. @end table
  5257. The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
  5258. the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
  5259. worked on or closed during a day.
  5260. @node The clock table, Resolving idle time, Clocking commands, Clocking work time
  5261. @subsection The clock table
  5262. @cindex clocktable, dynamic block
  5263. @cindex report, of clocked time
  5264. Org mode can produce quite complex reports based on the time clocking
  5265. information. Such a report is called a @emph{clock table}, because it is
  5266. formatted as one or several Org tables.
  5267. @table @kbd
  5268. @orgcmd{C-c C-x C-r,org-clock-report}
  5269. Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
  5270. report as an Org mode table into the current file. When the cursor is
  5271. at an existing clock table, just update it. When called with a prefix
  5272. argument, jump to the first clock report in the current document and
  5273. update it. The clock table always includes also trees with
  5274. @code{:ARCHIVE:} tag.
  5275. @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
  5276. Update dynamic block at point. The cursor needs to be in the
  5277. @code{#+BEGIN} line of the dynamic block.
  5278. @orgkey{C-u C-c C-x C-u}
  5279. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  5280. you have several clock table blocks in a buffer.
  5281. @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
  5282. Shift the current @code{:block} interval and update the table. The cursor
  5283. needs to be in the @code{#+BEGIN: clocktable} line for this command. If
  5284. @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
  5285. @end table
  5286. Here is an example of the frame for a clock table as it is inserted into the
  5287. buffer with the @kbd{C-c C-x C-r} command:
  5288. @cindex #+BEGIN, clocktable
  5289. @example
  5290. #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
  5291. #+END: clocktable
  5292. @end example
  5293. @noindent
  5294. @vindex org-clocktable-defaults
  5295. The @samp{BEGIN} line and specify a number of options to define the scope,
  5296. structure, and formatting of the report. Defaults for all these options can
  5297. be configured in the variable @code{org-clocktable-defaults}.
  5298. @noindent First there are options that determine which clock entries are to
  5299. be selected:
  5300. @example
  5301. :maxlevel @r{Maximum level depth to which times are listed in the table.}
  5302. @r{Clocks at deeper levels will be summed into the upper level.}
  5303. :scope @r{The scope to consider. This can be any of the following:}
  5304. nil @r{the current buffer or narrowed region}
  5305. file @r{the full current buffer}
  5306. subtree @r{the subtree where the clocktable is located}
  5307. tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
  5308. tree @r{the surrounding level 1 tree}
  5309. agenda @r{all agenda files}
  5310. ("file"..) @r{scan these files}
  5311. file-with-archives @r{current file and its archives}
  5312. agenda-with-archives @r{all agenda files, including archives}
  5313. :block @r{The time block to consider. This block is specified either}
  5314. @r{absolute, or relative to the current time and may be any of}
  5315. @r{these formats:}
  5316. 2007-12-31 @r{New year eve 2007}
  5317. 2007-12 @r{December 2007}
  5318. 2007-W50 @r{ISO-week 50 in 2007}
  5319. 2007-Q2 @r{2nd quarter in 2007}
  5320. 2007 @r{the year 2007}
  5321. today, yesterday, today-@var{N} @r{a relative day}
  5322. thisweek, lastweek, thisweek-@var{N} @r{a relative week}
  5323. thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
  5324. thisyear, lastyear, thisyear-@var{N} @r{a relative year}
  5325. @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
  5326. :tstart @r{A time string specifying when to start considering times.}
  5327. :tend @r{A time string specifying when to stop considering times.}
  5328. :step @r{@code{week} or @code{day}, to split the table into chunks.}
  5329. @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
  5330. :stepskip0 @r{Do not show steps that have zero time.}
  5331. :fileskip0 @r{Do not show table sections from files which did not contribute.}
  5332. :tags @r{A tags match to select entries that should contribute. See}
  5333. @r{@ref{Matching tags and properties} for the match syntax.}
  5334. @end example
  5335. Then there are options which determine the formatting of the table. There
  5336. options are interpreted by the function @code{org-clocktable-write-default},
  5337. but you can specify your own function using the @code{:formatter} parameter.
  5338. @example
  5339. :emphasize @r{When @code{t}, emphasize level one and level two items.}
  5340. :lang @r{Language@footnote{Language terms can be set through the variable @code{org-clock-clocktable-language-setup}.} to use for descriptive cells like "Task".}
  5341. :link @r{Link the item headlines in the table to their origins.}
  5342. :narrow @r{An integer to limit the width of the headline column in}
  5343. @r{the org table. If you write it like @samp{50!}, then the}
  5344. @r{headline will also be shortened in export.}
  5345. :indent @r{Indent each headline field according to its level.}
  5346. :tcolumns @r{Number of columns to be used for times. If this is smaller}
  5347. @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
  5348. :level @r{Should a level number column be included?}
  5349. :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
  5350. @r{All are overwritten except if there is an explicit @code{:narrow}}
  5351. :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
  5352. @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
  5353. :properties @r{List of properties that should be shown in the table. Each}
  5354. @r{property will get its own column.}
  5355. :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
  5356. :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
  5357. @r{As a special case, @samp{:formula %} adds a column with % time.}
  5358. @r{If you do not specify a formula here, any existing formula}
  5359. @r{below the clock table will survive updates and be evaluated.}
  5360. :formatter @r{A function to format clock data and insert it into the buffer.}
  5361. @end example
  5362. To get a clock summary of the current level 1 tree, for the current
  5363. day, you could write
  5364. @example
  5365. #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
  5366. #+END: clocktable
  5367. @end example
  5368. @noindent
  5369. and to use a specific time range you could write@footnote{Note that all
  5370. parameters must be specified in a single line---the line is broken here
  5371. only to fit it into the manual.}
  5372. @example
  5373. #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
  5374. :tend "<2006-08-10 Thu 12:00>"
  5375. #+END: clocktable
  5376. @end example
  5377. A summary of the current subtree with % times would be
  5378. @example
  5379. #+BEGIN: clocktable :scope subtree :link t :formula %
  5380. #+END: clocktable
  5381. @end example
  5382. A horizontally compact representation of everything clocked during last week
  5383. would be
  5384. @example
  5385. #+BEGIN: clocktable :scope agenda :block lastweek :compact t
  5386. #+END: clocktable
  5387. @end example
  5388. @node Resolving idle time, , The clock table, Clocking work time
  5389. @subsection Resolving idle time
  5390. @cindex resolve idle time
  5391. @cindex idle, resolve, dangling
  5392. If you clock in on a work item, and then walk away from your
  5393. computer---perhaps to take a phone call---you often need to ``resolve'' the
  5394. time you were away by either subtracting it from the current clock, or
  5395. applying it to another one.
  5396. @vindex org-clock-idle-time
  5397. By customizing the variable @code{org-clock-idle-time} to some integer, such
  5398. as 10 or 15, Emacs can alert you when you get back to your computer after
  5399. being idle for that many minutes@footnote{On computers using Mac OS X,
  5400. idleness is based on actual user idleness, not just Emacs' idle time. For
  5401. X11, you can install a utility program @file{x11idle.c}, available in the
  5402. UTILITIES directory of the Org git distribution, to get the same general
  5403. treatment of idleness. On other systems, idle time refers to Emacs idle time
  5404. only.}, and ask what you want to do with the idle time. There will be a
  5405. question waiting for you when you get back, indicating how much idle time has
  5406. passed (constantly updated with the current amount), as well as a set of
  5407. choices to correct the discrepancy:
  5408. @table @kbd
  5409. @item k
  5410. To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
  5411. will ask how many of the minutes to keep. Press @key{RET} to keep them all,
  5412. effectively changing nothing, or enter a number to keep that many minutes.
  5413. @item K
  5414. If you use the shift key and press @kbd{K}, it will keep however many minutes
  5415. you request and then immediately clock out of that task. If you keep all of
  5416. the minutes, this is the same as just clocking out of the current task.
  5417. @item s
  5418. To keep none of the minutes, use @kbd{s} to subtract all the away time from
  5419. the clock, and then check back in from the moment you returned.
  5420. @item S
  5421. To keep none of the minutes and just clock out at the start of the away time,
  5422. use the shift key and press @kbd{S}. Remember that using shift will always
  5423. leave you clocked out, no matter which option you choose.
  5424. @item C
  5425. To cancel the clock altogether, use @kbd{C}. Note that if instead of
  5426. canceling you subtract the away time, and the resulting clock amount is less
  5427. than a minute, the clock will still be canceled rather than clutter up the
  5428. log with an empty entry.
  5429. @end table
  5430. What if you subtracted those away minutes from the current clock, and now
  5431. want to apply them to a new clock? Simply clock in to any task immediately
  5432. after the subtraction. Org will notice that you have subtracted time ``on
  5433. the books'', so to speak, and will ask if you want to apply those minutes to
  5434. the next task you clock in on.
  5435. There is one other instance when this clock resolution magic occurs. Say you
  5436. were clocked in and hacking away, and suddenly your cat chased a mouse who
  5437. scared a hamster that crashed into your UPS's power button! You suddenly
  5438. lose all your buffers, but thanks to auto-save you still have your recent Org
  5439. mode changes, including your last clock in.
  5440. If you restart Emacs and clock into any task, Org will notice that you have a
  5441. dangling clock which was never clocked out from your last session. Using
  5442. that clock's starting time as the beginning of the unaccounted-for period,
  5443. Org will ask how you want to resolve that time. The logic and behavior is
  5444. identical to dealing with away time due to idleness; it is just happening due
  5445. to a recovery event rather than a set amount of idle time.
  5446. You can also check all the files visited by your Org agenda for dangling
  5447. clocks at any time using @kbd{M-x org-resolve-clocks}.
  5448. @node Effort estimates, Relative timer, Clocking work time, Dates and Times
  5449. @section Effort estimates
  5450. @cindex effort estimates
  5451. @cindex property, Effort
  5452. @vindex org-effort-property
  5453. If you want to plan your work in a very detailed way, or if you need to
  5454. produce offers with quotations of the estimated work effort, you may want to
  5455. assign effort estimates to entries. If you are also clocking your work, you
  5456. may later want to compare the planned effort with the actual working time, a
  5457. great way to improve planning estimates. Effort estimates are stored in a
  5458. special property @samp{Effort}@footnote{You may change the property being
  5459. used with the variable @code{org-effort-property}.}. You can set the effort
  5460. for an entry with the following commands:
  5461. @table @kbd
  5462. @orgcmd{C-c C-x e,org-set-effort}
  5463. Set the effort estimate for the current entry. With a numeric prefix
  5464. argument, set it to the Nth allowed value (see below). This command is also
  5465. accessible from the agenda with the @kbd{e} key.
  5466. @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
  5467. Modify the effort estimate of the item currently being clocked.
  5468. @end table
  5469. Clearly the best way to work with effort estimates is through column view
  5470. (@pxref{Column view}). You should start by setting up discrete values for
  5471. effort estimates, and a @code{COLUMNS} format that displays these values
  5472. together with clock sums (if you want to clock your time). For a specific
  5473. buffer you can use
  5474. @example
  5475. #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
  5476. #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
  5477. @end example
  5478. @noindent
  5479. @vindex org-global-properties
  5480. @vindex org-columns-default-format
  5481. or, even better, you can set up these values globally by customizing the
  5482. variables @code{org-global-properties} and @code{org-columns-default-format}.
  5483. In particular if you want to use this setup also in the agenda, a global
  5484. setup may be advised.
  5485. The way to assign estimates to individual items is then to switch to column
  5486. mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
  5487. value. The values you enter will immediately be summed up in the hierarchy.
  5488. In the column next to it, any clocked time will be displayed.
  5489. @vindex org-agenda-columns-add-appointments-to-effort-sum
  5490. If you switch to column view in the daily/weekly agenda, the effort column
  5491. will summarize the estimated work effort for each day@footnote{Please note
  5492. the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
  5493. column view}).}, and you can use this to find space in your schedule. To get
  5494. an overview of the entire part of the day that is committed, you can set the
  5495. option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
  5496. appointments on a day that take place over a specified time interval will
  5497. then also be added to the load estimate of the day.
  5498. Effort estimates can be used in secondary agenda filtering that is triggered
  5499. with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
  5500. these estimates defined consistently, two or three key presses will narrow
  5501. down the list to stuff that fits into an available time slot.
  5502. @node Relative timer, Countdown timer, Effort estimates, Dates and Times
  5503. @section Taking notes with a relative timer
  5504. @cindex relative timer
  5505. When taking notes during, for example, a meeting or a video viewing, it can
  5506. be useful to have access to times relative to a starting time. Org provides
  5507. such a relative timer and make it easy to create timed notes.
  5508. @table @kbd
  5509. @orgcmd{C-c C-x .,org-timer}
  5510. Insert a relative time into the buffer. The first time you use this, the
  5511. timer will be started. When called with a prefix argument, the timer is
  5512. restarted.
  5513. @orgcmd{C-c C-x -,org-timer-item}
  5514. Insert a description list item with the current relative time. With a prefix
  5515. argument, first reset the timer to 0.
  5516. @orgcmd{M-@key{RET},org-insert-heading}
  5517. Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
  5518. new timer items.
  5519. @c for key sequences with a comma, command name macros fail :(
  5520. @kindex C-c C-x ,
  5521. @item C-c C-x ,
  5522. Pause the timer, or continue it if it is already paused
  5523. (@command{org-timer-pause-or-continue}).
  5524. @c removed the sentence because it is redundant to the following item
  5525. @kindex C-u C-c C-x ,
  5526. @item C-u C-c C-x ,
  5527. Stop the timer. After this, you can only start a new timer, not continue the
  5528. old one. This command also removes the timer from the mode line.
  5529. @orgcmd{C-c C-x 0,org-timer-start}
  5530. Reset the timer without inserting anything into the buffer. By default, the
  5531. timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
  5532. specific starting offset. The user is prompted for the offset, with a
  5533. default taken from a timer string at point, if any, So this can be used to
  5534. restart taking notes after a break in the process. When called with a double
  5535. prefix argument @kbd{C-u C-u}, change all timer strings in the active region
  5536. by a certain amount. This can be used to fix timer strings if the timer was
  5537. not started at exactly the right moment.
  5538. @end table
  5539. @node Countdown timer, , Relative timer, Dates and Times
  5540. @section Countdown timer
  5541. @cindex Countdown timer
  5542. @kindex C-c C-x ;
  5543. @kindex ;
  5544. Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
  5545. timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
  5546. @code{org-timer-set-timer} prompts the user for a duration and displays a
  5547. countdown timer in the modeline. @code{org-timer-default-timer} sets the
  5548. default countdown value. Giving a prefix numeric argument overrides this
  5549. default value.
  5550. @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
  5551. @chapter Capture - Refile - Archive
  5552. @cindex capture
  5553. An important part of any organization system is the ability to quickly
  5554. capture new ideas and tasks, and to associate reference material with them.
  5555. Org does this using a process called @i{capture}. It also can store files
  5556. related to a task (@i{attachments}) in a special directory. Once in the
  5557. system, tasks and projects need to be moved around. Moving completed project
  5558. trees to an archive file keeps the system compact and fast.
  5559. @menu
  5560. * Capture:: Capturing new stuff
  5561. * Attachments:: Add files to tasks
  5562. * RSS Feeds:: Getting input from RSS feeds
  5563. * Protocols:: External (e.g.@: Browser) access to Emacs and Org
  5564. * Refiling notes:: Moving a tree from one place to another
  5565. * Archiving:: What to do with finished projects
  5566. @end menu
  5567. @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
  5568. @section Capture
  5569. @cindex capture
  5570. Org's method for capturing new items is heavily inspired by John Wiegley
  5571. excellent remember package. Up to version 6.36 Org used a special setup
  5572. for @file{remember.el}. @file{org-remember.el} is still part of Org mode for
  5573. backward compatibility with existing setups. You can find the documentation
  5574. for org-remember at @url{http://orgmode.org/org-remember.pdf}.
  5575. The new capturing setup described here is preferred and should be used by new
  5576. users. To convert your @code{org-remember-templates}, run the command
  5577. @example
  5578. @kbd{M-x org-capture-import-remember-templates @key{RET}}
  5579. @end example
  5580. @noindent and then customize the new variable with @kbd{M-x
  5581. customize-variable org-capture-templates}, check the result, and save the
  5582. customization. You can then use both remember and capture until
  5583. you are familiar with the new mechanism.
  5584. Capture lets you quickly store notes with little interruption of your work
  5585. flow. The basic process of capturing is very similar to remember, but Org
  5586. does enhance it with templates and more.
  5587. @menu
  5588. * Setting up capture:: Where notes will be stored
  5589. * Using capture:: Commands to invoke and terminate capture
  5590. * Capture templates:: Define the outline of different note types
  5591. @end menu
  5592. @node Setting up capture, Using capture, Capture, Capture
  5593. @subsection Setting up capture
  5594. The following customization sets a default target file for notes, and defines
  5595. a global key@footnote{Please select your own key, @kbd{C-c c} is only a
  5596. suggestion.} for capturing new material.
  5597. @vindex org-default-notes-file
  5598. @example
  5599. (setq org-default-notes-file (concat org-directory "/notes.org"))
  5600. (define-key global-map "\C-cc" 'org-capture)
  5601. @end example
  5602. @node Using capture, Capture templates, Setting up capture, Capture
  5603. @subsection Using capture
  5604. @table @kbd
  5605. @orgcmd{C-c c,org-capture}
  5606. Call the command @code{org-capture}. Note that this keybinding is global and
  5607. not active by default - you need to install it. If you have templates
  5608. @cindex date tree
  5609. defined @pxref{Capture templates}, it will offer these templates for
  5610. selection or use a new Org outline node as the default template. It will
  5611. insert the template into the target file and switch to an indirect buffer
  5612. narrowed to this new node. You may then insert the information you want.
  5613. @orgcmd{C-c C-c,org-capture-finalize}
  5614. Once you have finished entering information into the capture buffer, @kbd{C-c
  5615. C-c} will return you to the window configuration before the capture process,
  5616. so that you can resume your work without further distraction. When called
  5617. with a prefix arg, finalize and then jump to the captured item.
  5618. @orgcmd{C-c C-w,org-capture-refile}
  5619. Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
  5620. a different place. Please realize that this is a normal refiling command
  5621. that will be executed---so the cursor position at the moment you run this
  5622. command is important. If you have inserted a tree with a parent and
  5623. children, first move the cursor back to the parent. Any prefix argument
  5624. given to this command will be passed on to the @code{org-refile} command.
  5625. @orgcmd{C-c C-k,org-capture-kill}
  5626. Abort the capture process and return to the previous state.
  5627. @end table
  5628. You can also call @code{org-capture} in a special way from the agenda, using
  5629. the @kbd{k c} key combination. With this access, any timestamps inserted by
  5630. the selected capture template will default to the cursor date in the agenda,
  5631. rather than to the current date.
  5632. To find the locations of the last stored capture, use @code{org-capture} with
  5633. prefix commands:
  5634. @table @kbd
  5635. @orgkey{C-u C-c c}
  5636. Visit the target location of a capture template. You get to select the
  5637. template in the usual way.
  5638. @orgkey{C-u C-u C-c c}
  5639. Visit the last stored capture item in its buffer.
  5640. @end table
  5641. @node Capture templates, , Using capture, Capture
  5642. @subsection Capture templates
  5643. @cindex templates, for Capture
  5644. You can use templates for different types of capture items, and
  5645. for different target locations. The easiest way to create such templates is
  5646. through the customize interface.
  5647. @table @kbd
  5648. @orgkey{C-c c C}
  5649. Customize the variable @code{org-capture-templates}.
  5650. @end table
  5651. Before we give the formal description of template definitions, let's look at
  5652. an example. Say you would like to use one template to create general TODO
  5653. entries, and you want to put these entries under the heading @samp{Tasks} in
  5654. your file @file{~/org/gtd.org}. Also, a date tree in the file
  5655. @file{journal.org} should capture journal entries. A possible configuration
  5656. would look like:
  5657. @example
  5658. (setq org-capture-templates
  5659. '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
  5660. "* TODO %?\n %i\n %a")
  5661. ("j" "Journal" entry (file+datetree "~/org/journal.org")
  5662. "* %?\nEntered on %U\n %i\n %a")))
  5663. @end example
  5664. @noindent If you then press @kbd{C-c c t}, Org will prepare the template
  5665. for you like this:
  5666. @example
  5667. * TODO
  5668. [[file:@var{link to where you initiated capture}]]
  5669. @end example
  5670. @noindent
  5671. During expansion of the template, @code{%a} has been replaced by a link to
  5672. the location from where you called the capture command. This can be
  5673. extremely useful for deriving tasks from emails, for example. You fill in
  5674. the task definition, press @code{C-c C-c} and Org returns you to the same
  5675. place where you started the capture process.
  5676. To define special keys to capture to a particular template without going
  5677. through the interactive template selection, you can create your key binding
  5678. like this:
  5679. @lisp
  5680. (define-key global-map "\C-cx"
  5681. (lambda () (interactive) (org-capture nil "x")))
  5682. @end lisp
  5683. @menu
  5684. * Template elements:: What is needed for a complete template entry
  5685. * Template expansion:: Filling in information about time and context
  5686. @end menu
  5687. @node Template elements, Template expansion, Capture templates, Capture templates
  5688. @subsubsection Template elements
  5689. Now lets look at the elements of a template definition. Each entry in
  5690. @code{org-capture-templates} is a list with the following items:
  5691. @table @var
  5692. @item keys
  5693. The keys that will select the template, as a string, characters
  5694. only, for example @code{"a"} for a template to be selected with a
  5695. single key, or @code{"bt"} for selection with two keys. When using
  5696. several keys, keys using the same prefix key must be sequential
  5697. in the list and preceded by a 2-element entry explaining the
  5698. prefix key, for example
  5699. @example
  5700. ("b" "Templates for marking stuff to buy")
  5701. @end example
  5702. @noindent If you do not define a template for the @kbd{C} key, this key will
  5703. be used to open the customize buffer for this complex variable.
  5704. @item description
  5705. A short string describing the template, which will be shown during
  5706. selection.
  5707. @item type
  5708. The type of entry, a symbol. Valid values are:
  5709. @table @code
  5710. @item entry
  5711. An Org mode node, with a headline. Will be filed as the child of the target
  5712. entry or as a top-level entry. The target file should be an Org mode file.
  5713. @item item
  5714. A plain list item, placed in the first plain list at the target
  5715. location. Again the target file should be an Org file.
  5716. @item checkitem
  5717. A checkbox item. This only differs from the plain list item by the
  5718. default template.
  5719. @item table-line
  5720. a new line in the first table at the target location. Where exactly the
  5721. line will be inserted depends on the properties @code{:prepend} and
  5722. @code{:table-line-pos} (see below).
  5723. @item plain
  5724. Text to be inserted as it is.
  5725. @end table
  5726. @item target
  5727. @vindex org-default-notes-file
  5728. Specification of where the captured item should be placed. In Org mode
  5729. files, targets usually define a node. Entries will become children of this
  5730. node. Other types will be added to the table or list in the body of this
  5731. node. Most target specifications contain a file name. If that file name is
  5732. the empty string, it defaults to @code{org-default-notes-file}. A file can
  5733. also be given as a variable, function, or Emacs Lisp form.
  5734. Valid values are:
  5735. @table @code
  5736. @item (file "path/to/file")
  5737. Text will be placed at the beginning or end of that file.
  5738. @item (id "id of existing org entry")
  5739. Filing as child of this entry, or in the body of the entry.
  5740. @item (file+headline "path/to/file" "node headline")
  5741. Fast configuration if the target heading is unique in the file.
  5742. @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
  5743. For non-unique headings, the full path is safer.
  5744. @item (file+regexp "path/to/file" "regexp to find location")
  5745. Use a regular expression to position the cursor.
  5746. @item (file+datetree "path/to/file")
  5747. Will create a heading in a date tree for today's date.
  5748. @item (file+datetree+prompt "path/to/file")
  5749. Will create a heading in a date tree, but will prompt for the date.
  5750. @item (file+function "path/to/file" function-finding-location)
  5751. A function to find the right location in the file.
  5752. @item (clock)
  5753. File to the entry that is currently being clocked.
  5754. @item (function function-finding-location)
  5755. Most general way, write your own function to find both
  5756. file and location.
  5757. @end table
  5758. @item template
  5759. The template for creating the capture item. If you leave this empty, an
  5760. appropriate default template will be used. Otherwise this is a string with
  5761. escape codes, which will be replaced depending on time and context of the
  5762. capture call. The string with escapes may be loaded from a template file,
  5763. using the special syntax @code{(file "path/to/template")}. See below for
  5764. more details.
  5765. @item properties
  5766. The rest of the entry is a property list of additional options.
  5767. Recognized properties are:
  5768. @table @code
  5769. @item :prepend
  5770. Normally new captured information will be appended at
  5771. the target location (last child, last table line, last list item...).
  5772. Setting this property will change that.
  5773. @item :immediate-finish
  5774. When set, do not offer to edit the information, just
  5775. file it away immediately. This makes sense if the template only needs
  5776. information that can be added automatically.
  5777. @item :empty-lines
  5778. Set this to the number of lines to insert
  5779. before and after the new item. Default 0, only common other value is 1.
  5780. @item :clock-in
  5781. Start the clock in this item.
  5782. @item :clock-keep
  5783. Keep the clock running when filing the captured entry.
  5784. @item :clock-resume
  5785. If starting the capture interrupted a clock, restart that clock when finished
  5786. with the capture. Note that @code{:clock-keep} has precedence over
  5787. @code{:clock-resume}. When setting both to @code{t}, the current clock will
  5788. run and the previous one will not be resumed.
  5789. @item :unnarrowed
  5790. Do not narrow the target buffer, simply show the full buffer. Default is to
  5791. narrow it so that you only see the new material.
  5792. @item :table-line-pos
  5793. Specification of the location in the table where the new line should be
  5794. inserted. It should be a string like @code{"II-3"} meaning that the new
  5795. line should become the third line before the second horizontal separator
  5796. line.
  5797. @item :kill-buffer
  5798. If the target file was not yet visited when capture was invoked, kill the
  5799. buffer again after capture is completed.
  5800. @end table
  5801. @end table
  5802. @node Template expansion, , Template elements, Capture templates
  5803. @subsubsection Template expansion
  5804. In the template itself, special @kbd{%}-escapes@footnote{If you need one of
  5805. these sequences literally, escape the @kbd{%} with a backslash.} allow
  5806. dynamic insertion of content. The templates are expanded in the order given here:
  5807. @smallexample
  5808. %[@var{file}] @r{insert the contents of the file given by @var{file}.}
  5809. %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result.}
  5810. %<...> @r{the result of format-time-string on the ... format specification.}
  5811. %t @r{timestamp, date only.}
  5812. %T @r{timestamp with date and time.}
  5813. %u, %U @r{like the above, but inactive timestamps.}
  5814. %a @r{annotation, normally the link created with @code{org-store-link}.}
  5815. %i @r{initial content, the region when capture is called while the}
  5816. @r{region is active.}
  5817. @r{The entire text will be indented like @code{%i} itself.}
  5818. %A @r{like @code{%a}, but prompt for the description part.}
  5819. %c @r{Current kill ring head.}
  5820. %x @r{Content of the X clipboard.}
  5821. %k @r{title of the currently clocked task.}
  5822. %K @r{link to the currently clocked task.}
  5823. %n @r{user name (taken from @code{user-full-name}).}
  5824. %f @r{file visited by current buffer when org-capture was called.}
  5825. %F @r{full path of the file or directory visited by current buffer.}
  5826. %:keyword @r{specific information for certain link types, see below.}
  5827. %^g @r{prompt for tags, with completion on tags in target file.}
  5828. %^G @r{prompt for tags, with completion all tags in all agenda files.}
  5829. %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
  5830. @r{You may define a prompt like @code{%^@{Birthday@}t}.}
  5831. %^C @r{Interactive selection of which kill or clip to use.}
  5832. %^L @r{Like @code{%^C}, but insert as link.}
  5833. %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
  5834. %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
  5835. @r{You may specify a default value and a completion table with}
  5836. @r{%^@{prompt|default|completion2|completion3...@}.}
  5837. @r{The arrow keys access a prompt-specific history.}
  5838. @end smallexample
  5839. @noindent
  5840. For specific link types, the following keywords will be
  5841. defined@footnote{If you define your own link types (@pxref{Adding
  5842. hyperlink types}), any property you store with
  5843. @code{org-store-link-props} can be accessed in capture templates in a
  5844. similar way.}:
  5845. @vindex org-from-is-user-regexp
  5846. @smallexample
  5847. Link type | Available keywords
  5848. ---------------------------------+----------------------------------------------
  5849. bbdb | %:name %:company
  5850. irc | %:server %:port %:nick
  5851. vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id
  5852. | %:from %:fromname %:fromaddress
  5853. | %:to %:toname %:toaddress
  5854. | %:date @r{(message date header field)}
  5855. | %:date-timestamp @r{(date as active timestamp)}
  5856. | %:date-timestamp-inactive @r{(date as inactive timestamp)}
  5857. | %:fromto @r{(either "to NAME" or "from NAME")@footnote{This will always be the other, not the user. See the variable @code{org-from-is-user-regexp}.}}
  5858. gnus | %:group, @r{for messages also all email fields}
  5859. w3, w3m | %:url
  5860. info | %:file %:node
  5861. calendar | %:date
  5862. @end smallexample
  5863. @noindent
  5864. To place the cursor after template expansion use:
  5865. @smallexample
  5866. %? @r{After completing the template, position cursor here.}
  5867. @end smallexample
  5868. @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
  5869. @section Attachments
  5870. @cindex attachments
  5871. @vindex org-attach-directory
  5872. It is often useful to associate reference material with an outline node/task.
  5873. Small chunks of plain text can simply be stored in the subtree of a project.
  5874. Hyperlinks (@pxref{Hyperlinks}) can establish associations with
  5875. files that live elsewhere on your computer or in the cloud, like emails or
  5876. source code files belonging to a project. Another method is @i{attachments},
  5877. which are files located in a directory belonging to an outline node. Org
  5878. uses directories named by the unique ID of each entry. These directories are
  5879. located in the @file{data} directory which lives in the same directory where
  5880. your Org file lives@footnote{If you move entries or Org files from one
  5881. directory to another, you may want to configure @code{org-attach-directory}
  5882. to contain an absolute path.}. If you initialize this directory with
  5883. @code{git init}, Org will automatically commit changes when it sees them.
  5884. The attachment system has been contributed to Org by John Wiegley.
  5885. In cases where it seems better to do so, you can also attach a directory of your
  5886. choice to an entry. You can also make children inherit the attachment
  5887. directory from a parent, so that an entire subtree uses the same attached
  5888. directory.
  5889. @noindent The following commands deal with attachments:
  5890. @table @kbd
  5891. @orgcmd{C-c C-a,org-attach}
  5892. The dispatcher for commands related to the attachment system. After these
  5893. keys, a list of commands is displayed and you must press an additional key
  5894. to select a command:
  5895. @table @kbd
  5896. @orgcmdtkc{a,C-c C-a a,org-attach-attach}
  5897. @vindex org-attach-method
  5898. Select a file and move it into the task's attachment directory. The file
  5899. will be copied, moved, or linked, depending on @code{org-attach-method}.
  5900. Note that hard links are not supported on all systems.
  5901. @kindex C-c C-a c
  5902. @kindex C-c C-a m
  5903. @kindex C-c C-a l
  5904. @item c/m/l
  5905. Attach a file using the copy/move/link method.
  5906. Note that hard links are not supported on all systems.
  5907. @orgcmdtkc{n,C-c C-a n,org-attach-new}
  5908. Create a new attachment as an Emacs buffer.
  5909. @orgcmdtkc{z,C-c C-a z,org-attach-sync}
  5910. Synchronize the current task with its attachment directory, in case you added
  5911. attachments yourself.
  5912. @orgcmdtkc{o,C-c C-a o,org-attach-open}
  5913. @vindex org-file-apps
  5914. Open current task's attachment. If there is more than one, prompt for a
  5915. file name first. Opening will follow the rules set by @code{org-file-apps}.
  5916. For more details, see the information on following hyperlinks
  5917. (@pxref{Handling links}).
  5918. @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
  5919. Also open the attachment, but force opening the file in Emacs.
  5920. @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
  5921. Open the current task's attachment directory.
  5922. @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
  5923. Also open the directory, but force using @command{dired} in Emacs.
  5924. @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
  5925. Select and delete a single attachment.
  5926. @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
  5927. Delete all of a task's attachments. A safer way is to open the directory in
  5928. @command{dired} and delete from there.
  5929. @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
  5930. @cindex property, ATTACH_DIR
  5931. Set a specific directory as the entry's attachment directory. This works by
  5932. putting the directory path into the @code{ATTACH_DIR} property.
  5933. @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
  5934. @cindex property, ATTACH_DIR_INHERIT
  5935. Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
  5936. same directory for attachments as the parent does.
  5937. @end table
  5938. @end table
  5939. @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
  5940. @section RSS feeds
  5941. @cindex RSS feeds
  5942. @cindex Atom feeds
  5943. Org can add and change entries based on information found in RSS feeds and
  5944. Atom feeds. You could use this to make a task out of each new podcast in a
  5945. podcast feed. Or you could use a phone-based note-creating service on the
  5946. web to import tasks into Org. To access feeds, configure the variable
  5947. @code{org-feed-alist}. The docstring of this variable has detailed
  5948. information. Here is just an example:
  5949. @example
  5950. (setq org-feed-alist
  5951. '(("Slashdot"
  5952. "http://rss.slashdot.org/Slashdot/slashdot"
  5953. "~/txt/org/feeds.org" "Slashdot Entries")))
  5954. @end example
  5955. @noindent
  5956. will configure that new items from the feed provided by
  5957. @code{rss.slashdot.org} will result in new entries in the file
  5958. @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
  5959. the following command is used:
  5960. @table @kbd
  5961. @orgcmd{C-c C-x g,org-feed-update-all}
  5962. @item C-c C-x g
  5963. Collect items from the feeds configured in @code{org-feed-alist} and act upon
  5964. them.
  5965. @orgcmd{C-c C-x G,org-feed-goto-inbox}
  5966. Prompt for a feed name and go to the inbox configured for this feed.
  5967. @end table
  5968. Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
  5969. it will store information about the status of items in the feed, to avoid
  5970. adding the same item several times. You should add @samp{FEEDSTATUS} to the
  5971. list of drawers in that file:
  5972. @example
  5973. #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
  5974. @end example
  5975. For more information, including how to read atom feeds, see
  5976. @file{org-feed.el} and the docstring of @code{org-feed-alist}.
  5977. @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
  5978. @section Protocols for external access
  5979. @cindex protocols, for external access
  5980. @cindex emacsserver
  5981. You can set up Org for handling protocol calls from outside applications that
  5982. are passed to Emacs through the @file{emacsserver}. For example, you can
  5983. configure bookmarks in your web browser to send a link to the current page to
  5984. Org and create a note from it using capture (@pxref{Capture}). Or you
  5985. could create a bookmark that will tell Emacs to open the local source file of
  5986. a remote website you are looking at with the browser. See
  5987. @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
  5988. documentation and setup instructions.
  5989. @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
  5990. @section Refiling notes
  5991. @cindex refiling notes
  5992. When reviewing the captured data, you may want to refile some of the entries
  5993. into a different list, for example into a project. Cutting, finding the
  5994. right location, and then pasting the note is cumbersome. To simplify this
  5995. process, you can use the following special command:
  5996. @table @kbd
  5997. @orgcmd{C-c C-w,org-refile}
  5998. @vindex org-reverse-note-order
  5999. @vindex org-refile-targets
  6000. @vindex org-refile-use-outline-path
  6001. @vindex org-outline-path-complete-in-steps
  6002. @vindex org-refile-allow-creating-parent-nodes
  6003. @vindex org-log-refile
  6004. @vindex org-refile-use-cache
  6005. Refile the entry or region at point. This command offers possible locations
  6006. for refiling the entry and lets you select one with completion. The item (or
  6007. all items in the region) is filed below the target heading as a subitem.
  6008. Depending on @code{org-reverse-note-order}, it will be either the first or
  6009. last subitem.@*
  6010. By default, all level 1 headlines in the current buffer are considered to be
  6011. targets, but you can have more complex definitions across a number of files.
  6012. See the variable @code{org-refile-targets} for details. If you would like to
  6013. select a location via a file-path-like completion along the outline path, see
  6014. the variables @code{org-refile-use-outline-path} and
  6015. @code{org-outline-path-complete-in-steps}. If you would like to be able to
  6016. create new nodes as new parents for refiling on the fly, check the
  6017. variable @code{org-refile-allow-creating-parent-nodes}.
  6018. When the variable @code{org-log-refile}@footnote{with corresponding
  6019. @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
  6020. and @code{nologrefile}} is set, a timestamp or a note will be
  6021. recorded when an entry has been refiled.
  6022. @orgkey{C-u C-c C-w}
  6023. Use the refile interface to jump to a heading.
  6024. @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
  6025. Jump to the location where @code{org-refile} last moved a tree to.
  6026. @item C-2 C-c C-w
  6027. Refile as the child of the item currently being clocked.
  6028. @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
  6029. @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}
  6030. Clear the target cache. Caching of refile targets can be turned on by
  6031. setting @code{org-refile-use-cache}. To make the command see new possible
  6032. targets, you have to clear the cache with this command.
  6033. @end table
  6034. @node Archiving, , Refiling notes, Capture - Refile - Archive
  6035. @section Archiving
  6036. @cindex archiving
  6037. When a project represented by a (sub)tree is finished, you may want
  6038. to move the tree out of the way and to stop it from contributing to the
  6039. agenda. Archiving is important to keep your working files compact and global
  6040. searches like the construction of agenda views fast.
  6041. @table @kbd
  6042. @orgcmd{C-c C-x C-a,org-archive-subtree-default}
  6043. @vindex org-archive-default-command
  6044. Archive the current entry using the command specified in the variable
  6045. @code{org-archive-default-command}.
  6046. @end table
  6047. @menu
  6048. * Moving subtrees:: Moving a tree to an archive file
  6049. * Internal archiving:: Switch off a tree but keep it in the file
  6050. @end menu
  6051. @node Moving subtrees, Internal archiving, Archiving, Archiving
  6052. @subsection Moving a tree to the archive file
  6053. @cindex external archiving
  6054. The most common archiving action is to move a project tree to another file,
  6055. the archive file.
  6056. @table @kbd
  6057. @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
  6058. @vindex org-archive-location
  6059. Archive the subtree starting at the cursor position to the location
  6060. given by @code{org-archive-location}.
  6061. @orgkey{C-u C-c C-x C-s}
  6062. Check if any direct children of the current headline could be moved to
  6063. the archive. To do this, each subtree is checked for open TODO entries.
  6064. If none are found, the command offers to move it to the archive
  6065. location. If the cursor is @emph{not} on a headline when this command
  6066. is invoked, the level 1 trees will be checked.
  6067. @end table
  6068. @cindex archive locations
  6069. The default archive location is a file in the same directory as the
  6070. current file, with the name derived by appending @file{_archive} to the
  6071. current file name. For information and examples on how to change this,
  6072. see the documentation string of the variable
  6073. @code{org-archive-location}. There is also an in-buffer option for
  6074. setting this variable, for example@footnote{For backward compatibility,
  6075. the following also works: If there are several such lines in a file,
  6076. each specifies the archive location for the text below it. The first
  6077. such line also applies to any text before its definition. However,
  6078. using this method is @emph{strongly} deprecated as it is incompatible
  6079. with the outline structure of the document. The correct method for
  6080. setting multiple archive locations in a buffer is using properties.}:
  6081. @cindex #+ARCHIVE
  6082. @example
  6083. #+ARCHIVE: %s_done::
  6084. @end example
  6085. @cindex property, ARCHIVE
  6086. @noindent
  6087. If you would like to have a special ARCHIVE location for a single entry
  6088. or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
  6089. location as the value (@pxref{Properties and Columns}).
  6090. @vindex org-archive-save-context-info
  6091. When a subtree is moved, it receives a number of special properties that
  6092. record context information like the file from where the entry came, its
  6093. outline path the archiving time etc. Configure the variable
  6094. @code{org-archive-save-context-info} to adjust the amount of information
  6095. added.
  6096. @node Internal archiving, , Moving subtrees, Archiving
  6097. @subsection Internal archiving
  6098. If you want to just switch off (for agenda views) certain subtrees without
  6099. moving them to a different file, you can use the @code{ARCHIVE tag}.
  6100. A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
  6101. its location in the outline tree, but behaves in the following way:
  6102. @itemize @minus
  6103. @item
  6104. @vindex org-cycle-open-archived-trees
  6105. It does not open when you attempt to do so with a visibility cycling
  6106. command (@pxref{Visibility cycling}). You can force cycling archived
  6107. subtrees with @kbd{C-@key{TAB}}, or by setting the option
  6108. @code{org-cycle-open-archived-trees}. Also normal outline commands like
  6109. @code{show-all} will open archived subtrees.
  6110. @item
  6111. @vindex org-sparse-tree-open-archived-trees
  6112. During sparse tree construction (@pxref{Sparse trees}), matches in
  6113. archived subtrees are not exposed, unless you configure the option
  6114. @code{org-sparse-tree-open-archived-trees}.
  6115. @item
  6116. @vindex org-agenda-skip-archived-trees
  6117. During agenda view construction (@pxref{Agenda Views}), the content of
  6118. archived trees is ignored unless you configure the option
  6119. @code{org-agenda-skip-archived-trees}, in which case these trees will always
  6120. be included. In the agenda you can press @kbd{v a} to get archives
  6121. temporarily included.
  6122. @item
  6123. @vindex org-export-with-archived-trees
  6124. Archived trees are not exported (@pxref{Exporting}), only the headline
  6125. is. Configure the details using the variable
  6126. @code{org-export-with-archived-trees}.
  6127. @item
  6128. @vindex org-columns-skip-archived-trees
  6129. Archived trees are excluded from column view unless the variable
  6130. @code{org-columns-skip-archived-trees} is configured to @code{nil}.
  6131. @end itemize
  6132. The following commands help manage the ARCHIVE tag:
  6133. @table @kbd
  6134. @orgcmd{C-c C-x a,org-toggle-archive-tag}
  6135. Toggle the ARCHIVE tag for the current headline. When the tag is set,
  6136. the headline changes to a shadowed face, and the subtree below it is
  6137. hidden.
  6138. @orgkey{C-u C-c C-x a}
  6139. Check if any direct children of the current headline should be archived.
  6140. To do this, each subtree is checked for open TODO entries. If none are
  6141. found, the command offers to set the ARCHIVE tag for the child. If the
  6142. cursor is @emph{not} on a headline when this command is invoked, the
  6143. level 1 trees will be checked.
  6144. @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
  6145. Cycle a tree even if it is tagged with ARCHIVE.
  6146. @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
  6147. Move the current entry to the @emph{Archive Sibling}. This is a sibling of
  6148. the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
  6149. entry becomes a child of that sibling and in this way retains a lot of its
  6150. original context, including inherited tags and approximate position in the
  6151. outline.
  6152. @end table
  6153. @node Agenda Views, Markup, Capture - Refile - Archive, Top
  6154. @chapter Agenda views
  6155. @cindex agenda views
  6156. Due to the way Org works, TODO items, time-stamped items, and
  6157. tagged headlines can be scattered throughout a file or even a number of
  6158. files. To get an overview of open action items, or of events that are
  6159. important for a particular date, this information must be collected,
  6160. sorted and displayed in an organized way.
  6161. Org can select items based on various criteria and display them
  6162. in a separate buffer. Seven different view types are provided:
  6163. @itemize @bullet
  6164. @item
  6165. an @emph{agenda} that is like a calendar and shows information
  6166. for specific dates,
  6167. @item
  6168. a @emph{TODO list} that covers all unfinished
  6169. action items,
  6170. @item
  6171. a @emph{match view}, showings headlines based on the tags, properties, and
  6172. TODO state associated with them,
  6173. @item
  6174. a @emph{timeline view} that shows all events in a single Org file,
  6175. in time-sorted view,
  6176. @item
  6177. a @emph{text search view} that shows all entries from multiple files
  6178. that contain specified keywords,
  6179. @item
  6180. a @emph{stuck projects view} showing projects that currently don't move
  6181. along, and
  6182. @item
  6183. @emph{custom views} that are special searches and combinations of different
  6184. views.
  6185. @end itemize
  6186. @noindent
  6187. The extracted information is displayed in a special @emph{agenda
  6188. buffer}. This buffer is read-only, but provides commands to visit the
  6189. corresponding locations in the original Org files, and even to
  6190. edit these files remotely.
  6191. @vindex org-agenda-window-setup
  6192. @vindex org-agenda-restore-windows-after-quit
  6193. Two variables control how the agenda buffer is displayed and whether the
  6194. window configuration is restored when the agenda exits:
  6195. @code{org-agenda-window-setup} and
  6196. @code{org-agenda-restore-windows-after-quit}.
  6197. @menu
  6198. * Agenda files:: Files being searched for agenda information
  6199. * Agenda dispatcher:: Keyboard access to agenda views
  6200. * Built-in agenda views:: What is available out of the box?
  6201. * Presentation and sorting:: How agenda items are prepared for display
  6202. * Agenda commands:: Remote editing of Org trees
  6203. * Custom agenda views:: Defining special searches and views
  6204. * Exporting Agenda Views:: Writing a view to a file
  6205. * Agenda column view:: Using column view for collected entries
  6206. @end menu
  6207. @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
  6208. @section Agenda files
  6209. @cindex agenda files
  6210. @cindex files for agenda
  6211. @vindex org-agenda-files
  6212. The information to be shown is normally collected from all @emph{agenda
  6213. files}, the files listed in the variable
  6214. @code{org-agenda-files}@footnote{If the value of that variable is not a
  6215. list, but a single file name, then the list of agenda files will be
  6216. maintained in that external file.}. If a directory is part of this list,
  6217. all files with the extension @file{.org} in this directory will be part
  6218. of the list.
  6219. Thus, even if you only work with a single Org file, that file should
  6220. be put into the list@footnote{When using the dispatcher, pressing
  6221. @kbd{<} before selecting a command will actually limit the command to
  6222. the current file, and ignore @code{org-agenda-files} until the next
  6223. dispatcher command.}. You can customize @code{org-agenda-files}, but
  6224. the easiest way to maintain it is through the following commands
  6225. @cindex files, adding to agenda list
  6226. @table @kbd
  6227. @orgcmd{C-c [,org-agenda-file-to-front}
  6228. Add current file to the list of agenda files. The file is added to
  6229. the front of the list. If it was already in the list, it is moved to
  6230. the front. With a prefix argument, file is added/moved to the end.
  6231. @orgcmd{C-c ],org-remove-file}
  6232. Remove current file from the list of agenda files.
  6233. @kindex C-,
  6234. @cindex cycling, of agenda files
  6235. @orgcmd{C-',org-cycle-agenda-files}
  6236. @itemx C-,
  6237. Cycle through agenda file list, visiting one file after the other.
  6238. @kindex M-x org-iswitchb
  6239. @item M-x org-iswitchb
  6240. Command to use an @code{iswitchb}-like interface to switch to and between Org
  6241. buffers.
  6242. @end table
  6243. @noindent
  6244. The Org menu contains the current list of files and can be used
  6245. to visit any of them.
  6246. If you would like to focus the agenda temporarily on a file not in
  6247. this list, or on just one file in the list, or even on only a subtree in a
  6248. file, then this can be done in different ways. For a single agenda command,
  6249. you may press @kbd{<} once or several times in the dispatcher
  6250. (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
  6251. extended period, use the following commands:
  6252. @table @kbd
  6253. @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
  6254. Permanently restrict the agenda to the current subtree. When with a
  6255. prefix argument, or with the cursor before the first headline in a file,
  6256. the agenda scope is set to the entire file. This restriction remains in
  6257. effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
  6258. or @kbd{>} in the agenda dispatcher. If there is a window displaying an
  6259. agenda view, the new restriction takes effect immediately.
  6260. @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
  6261. Remove the permanent restriction created by @kbd{C-c C-x <}.
  6262. @end table
  6263. @noindent
  6264. When working with @file{speedbar.el}, you can use the following commands in
  6265. the Speedbar frame:
  6266. @table @kbd
  6267. @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
  6268. Permanently restrict the agenda to the item---either an Org file or a subtree
  6269. in such a file---at the cursor in the Speedbar frame.
  6270. If there is a window displaying an agenda view, the new restriction takes
  6271. effect immediately.
  6272. @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
  6273. Lift the restriction.
  6274. @end table
  6275. @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
  6276. @section The agenda dispatcher
  6277. @cindex agenda dispatcher
  6278. @cindex dispatching agenda commands
  6279. The views are created through a dispatcher, which should be bound to a
  6280. global key---for example @kbd{C-c a} (@pxref{Activation}). In the
  6281. following we will assume that @kbd{C-c a} is indeed how the dispatcher
  6282. is accessed and list keyboard access to commands accordingly. After
  6283. pressing @kbd{C-c a}, an additional letter is required to execute a
  6284. command. The dispatcher offers the following default commands:
  6285. @table @kbd
  6286. @item a
  6287. Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
  6288. @item t @r{/} T
  6289. Create a list of all TODO items (@pxref{Global TODO list}).
  6290. @item m @r{/} M
  6291. Create a list of headlines matching a TAGS expression (@pxref{Matching
  6292. tags and properties}).
  6293. @item L
  6294. Create the timeline view for the current buffer (@pxref{Timeline}).
  6295. @item s
  6296. Create a list of entries selected by a boolean expression of keywords
  6297. and/or regular expressions that must or must not occur in the entry.
  6298. @item /
  6299. @vindex org-agenda-text-search-extra-files
  6300. Search for a regular expression in all agenda files and additionally in
  6301. the files listed in @code{org-agenda-text-search-extra-files}. This
  6302. uses the Emacs command @code{multi-occur}. A prefix argument can be
  6303. used to specify the number of context lines for each match, default is
  6304. 1.
  6305. @item # @r{/} !
  6306. Create a list of stuck projects (@pxref{Stuck projects}).
  6307. @item <
  6308. Restrict an agenda command to the current buffer@footnote{For backward
  6309. compatibility, you can also press @kbd{1} to restrict to the current
  6310. buffer.}. After pressing @kbd{<}, you still need to press the character
  6311. selecting the command.
  6312. @item < <
  6313. If there is an active region, restrict the following agenda command to
  6314. the region. Otherwise, restrict it to the current subtree@footnote{For
  6315. backward compatibility, you can also press @kbd{0} to restrict to the
  6316. current region/subtree.}. After pressing @kbd{< <}, you still need to press the
  6317. character selecting the command.
  6318. @end table
  6319. You can also define custom commands that will be accessible through the
  6320. dispatcher, just like the default commands. This includes the
  6321. possibility to create extended agenda buffers that contain several
  6322. blocks together, for example the weekly agenda, the global TODO list and
  6323. a number of special tags matches. @xref{Custom agenda views}.
  6324. @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
  6325. @section The built-in agenda views
  6326. In this section we describe the built-in views.
  6327. @menu
  6328. * Weekly/daily agenda:: The calendar page with current tasks
  6329. * Global TODO list:: All unfinished action items
  6330. * Matching tags and properties:: Structured information with fine-tuned search
  6331. * Timeline:: Time-sorted view for single file
  6332. * Search view:: Find entries by searching for text
  6333. * Stuck projects:: Find projects you need to review
  6334. @end menu
  6335. @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
  6336. @subsection The weekly/daily agenda
  6337. @cindex agenda
  6338. @cindex weekly agenda
  6339. @cindex daily agenda
  6340. The purpose of the weekly/daily @emph{agenda} is to act like a page of a
  6341. paper agenda, showing all the tasks for the current week or day.
  6342. @table @kbd
  6343. @cindex org-agenda, command
  6344. @orgcmd{C-c a a,org-agenda-list}
  6345. Compile an agenda for the current week from a list of Org files. The agenda
  6346. shows the entries for each day. With a numeric prefix@footnote{For backward
  6347. compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
  6348. listed before the agenda. This feature is deprecated, use the dedicated TODO
  6349. list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
  6350. C-c a a}) you may set the number of days to be displayed.
  6351. @end table
  6352. @vindex org-agenda-span
  6353. @vindex org-agenda-ndays
  6354. The default number of days displayed in the agenda is set by the variable
  6355. @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
  6356. variable can be set to any number of days you want to see by default in the
  6357. agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
  6358. @code{year}.
  6359. Remote editing from the agenda buffer means, for example, that you can
  6360. change the dates of deadlines and appointments from the agenda buffer.
  6361. The commands available in the Agenda buffer are listed in @ref{Agenda
  6362. commands}.
  6363. @subsubheading Calendar/Diary integration
  6364. @cindex calendar integration
  6365. @cindex diary integration
  6366. Emacs contains the calendar and diary by Edward M. Reingold. The
  6367. calendar displays a three-month calendar with holidays from different
  6368. countries and cultures. The diary allows you to keep track of
  6369. anniversaries, lunar phases, sunrise/set, recurrent appointments
  6370. (weekly, monthly) and more. In this way, it is quite complementary to
  6371. Org. It can be very useful to combine output from Org with
  6372. the diary.
  6373. In order to include entries from the Emacs diary into Org mode's
  6374. agenda, you only need to customize the variable
  6375. @lisp
  6376. (setq org-agenda-include-diary t)
  6377. @end lisp
  6378. @noindent After that, everything will happen automatically. All diary
  6379. entries including holidays, anniversaries, etc., will be included in the
  6380. agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
  6381. @key{RET} can be used from the agenda buffer to jump to the diary
  6382. file in order to edit existing diary entries. The @kbd{i} command to
  6383. insert new entries for the current date works in the agenda buffer, as
  6384. well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
  6385. Sunrise/Sunset times, show lunar phases and to convert to other
  6386. calendars, respectively. @kbd{c} can be used to switch back and forth
  6387. between calendar and agenda.
  6388. If you are using the diary only for sexp entries and holidays, it is
  6389. faster to not use the above setting, but instead to copy or even move
  6390. the entries into an Org file. Org mode evaluates diary-style sexp
  6391. entries, and does it faster because there is no overhead for first
  6392. creating the diary display. Note that the sexp entries must start at
  6393. the left margin, no whitespace is allowed before them. For example,
  6394. the following segment of an Org file will be processed and entries
  6395. will be made in the agenda:
  6396. @example
  6397. * Birthdays and similar stuff
  6398. #+CATEGORY: Holiday
  6399. %%(org-calendar-holiday) ; special function for holiday names
  6400. #+CATEGORY: Ann
  6401. %%(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 @code{calendar-date-style}.} Arthur Dent is %d years old
  6402. %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
  6403. @end example
  6404. @subsubheading Anniversaries from BBDB
  6405. @cindex BBDB, anniversaries
  6406. @cindex anniversaries, from BBDB
  6407. If you are using the Big Brothers Database to store your contacts, you will
  6408. very likely prefer to store anniversaries in BBDB rather than in a
  6409. separate Org or diary file. Org supports this and will show BBDB
  6410. anniversaries as part of the agenda. All you need to do is to add the
  6411. following to one of your agenda files:
  6412. @example
  6413. * Anniversaries
  6414. :PROPERTIES:
  6415. :CATEGORY: Anniv
  6416. :END:
  6417. %%(org-bbdb-anniversaries)
  6418. @end example
  6419. You can then go ahead and define anniversaries for a BBDB record. Basically,
  6420. you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
  6421. record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
  6422. followed by a space and the class of the anniversary (@samp{birthday} or
  6423. @samp{wedding}, or a format string). If you omit the class, it will default to
  6424. @samp{birthday}. Here are a few examples, the header for the file
  6425. @file{org-bbdb.el} contains more detailed information.
  6426. @example
  6427. 1973-06-22
  6428. 06-22
  6429. 1955-08-02 wedding
  6430. 2008-04-14 %s released version 6.01 of org mode, %d years ago
  6431. @end example
  6432. After a change to BBDB, or for the first agenda display during an Emacs
  6433. session, the agenda display will suffer a short delay as Org updates its
  6434. hash with anniversaries. However, from then on things will be very fast---much
  6435. faster in fact than a long list of @samp{%%(diary-anniversary)} entries
  6436. in an Org or Diary file.
  6437. @subsubheading Appointment reminders
  6438. @cindex @file{appt.el}
  6439. @cindex appointment reminders
  6440. @cindex appointment
  6441. @cindex reminders
  6442. Org can interact with Emacs appointments notification facility. To add all
  6443. the appointments of your agenda files, use the command
  6444. @code{org-agenda-to-appt}. This command also lets you filter through the
  6445. list of your appointments and add only those belonging to a specific category
  6446. or matching a regular expression. See the docstring for details.
  6447. @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
  6448. @subsection The global TODO list
  6449. @cindex global TODO list
  6450. @cindex TODO list, global
  6451. The global TODO list contains all unfinished TODO items formatted and
  6452. collected into a single place.
  6453. @table @kbd
  6454. @orgcmd{C-c a t,org-todo-list}
  6455. Show the global TODO list. This collects the TODO items from all agenda
  6456. files (@pxref{Agenda Views}) into a single buffer. By default, this lists
  6457. items with a state the is not a DONE state. The buffer is in
  6458. @code{agenda-mode}, so there are commands to examine and manipulate the TODO
  6459. entries directly from that buffer (@pxref{Agenda commands}).
  6460. @orgcmd{C-c a T,org-todo-list}
  6461. @cindex TODO keyword matching
  6462. @vindex org-todo-keywords
  6463. Like the above, but allows selection of a specific TODO keyword. You can
  6464. also do this by specifying a prefix argument to @kbd{C-c a t}. You are
  6465. prompted for a keyword, and you may also specify several keywords by
  6466. separating them with @samp{|} as the boolean OR operator. With a numeric
  6467. prefix, the Nth keyword in @code{org-todo-keywords} is selected.
  6468. @kindex r
  6469. The @kbd{r} key in the agenda buffer regenerates it, and you can give
  6470. a prefix argument to this command to change the selected TODO keyword,
  6471. for example @kbd{3 r}. If you often need a search for a specific
  6472. keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
  6473. Matching specific TODO keywords can also be done as part of a tags
  6474. search (@pxref{Tag searches}).
  6475. @end table
  6476. Remote editing of TODO items means that you can change the state of a
  6477. TODO entry with a single key press. The commands available in the
  6478. TODO list are described in @ref{Agenda commands}.
  6479. @cindex sublevels, inclusion into TODO list
  6480. Normally the global TODO list simply shows all headlines with TODO
  6481. keywords. This list can become very long. There are two ways to keep
  6482. it more compact:
  6483. @itemize @minus
  6484. @item
  6485. @vindex org-agenda-todo-ignore-scheduled
  6486. @vindex org-agenda-todo-ignore-deadlines
  6487. @vindex org-agenda-todo-ignore-timestamp
  6488. @vindex org-agenda-todo-ignore-with-date
  6489. Some people view a TODO item that has been @emph{scheduled} for execution or
  6490. have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
  6491. Configure the variables @code{org-agenda-todo-ignore-scheduled},
  6492. @code{org-agenda-todo-ignore-deadlines},
  6493. @code{org-agenda-todo-ignore-timestamp} and/or
  6494. @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
  6495. TODO list.
  6496. @item
  6497. @vindex org-agenda-todo-list-sublevels
  6498. TODO items may have sublevels to break up the task into subtasks. In
  6499. such cases it may be enough to list only the highest level TODO headline
  6500. and omit the sublevels from the global list. Configure the variable
  6501. @code{org-agenda-todo-list-sublevels} to get this behavior.
  6502. @end itemize
  6503. @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
  6504. @subsection Matching tags and properties
  6505. @cindex matching, of tags
  6506. @cindex matching, of properties
  6507. @cindex tags view
  6508. @cindex match view
  6509. If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
  6510. or have properties (@pxref{Properties and Columns}), you can select headlines
  6511. based on this metadata and collect them into an agenda buffer. The match
  6512. syntax described here also applies when creating sparse trees with @kbd{C-c /
  6513. m}.
  6514. @table @kbd
  6515. @orgcmd{C-c a m,org-tags-view}
  6516. Produce a list of all headlines that match a given set of tags. The
  6517. command prompts for a selection criterion, which is a boolean logic
  6518. expression with tags, like @samp{+work+urgent-withboss} or
  6519. @samp{work|home} (@pxref{Tags}). If you often need a specific search,
  6520. define a custom command for it (@pxref{Agenda dispatcher}).
  6521. @orgcmd{C-c a M,org-tags-view}
  6522. @vindex org-tags-match-list-sublevels
  6523. @vindex org-agenda-tags-todo-honor-ignore-options
  6524. Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
  6525. not-DONE state and force checking subitems (see variable
  6526. @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
  6527. see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
  6528. specific TODO keywords together with a tags match is also possible, see
  6529. @ref{Tag searches}.
  6530. @end table
  6531. The commands available in the tags list are described in @ref{Agenda
  6532. commands}.
  6533. @subsubheading Match syntax
  6534. @cindex Boolean logic, for tag/property searches
  6535. A search string can use Boolean operators @samp{&} for AND and @samp{|} for
  6536. OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
  6537. not implemented. Each element in the search is either a tag, a regular
  6538. expression matching tags, or an expression like @code{PROPERTY OPERATOR
  6539. VALUE} with a comparison operator, accessing a property value. Each element
  6540. may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
  6541. sugar for positive selection. The AND operator @samp{&} is optional when
  6542. @samp{+} or @samp{-} is present. Here are some examples, using only tags.
  6543. @table @samp
  6544. @item +work-boss
  6545. Select headlines tagged @samp{:work:}, but discard those also tagged
  6546. @samp{:boss:}.
  6547. @item work|laptop
  6548. Selects lines tagged @samp{:work:} or @samp{:laptop:}.
  6549. @item work|laptop+night
  6550. Like before, but require the @samp{:laptop:} lines to be tagged also
  6551. @samp{:night:}.
  6552. @end table
  6553. @cindex regular expressions, with tags search
  6554. Instead of a tag, you may also specify a regular expression enclosed in curly
  6555. braces. For example,
  6556. @samp{work+@{^boss.*@}} matches headlines that contain the tag
  6557. @samp{:work:} and any tag @i{starting} with @samp{boss}.
  6558. @cindex TODO keyword matching, with tags search
  6559. @cindex level, require for tags/property match
  6560. @cindex category, require for tags/property match
  6561. @vindex org-odd-levels-only
  6562. You may also test for properties (@pxref{Properties and Columns}) at the same
  6563. time as matching tags. The properties may be real properties, or special
  6564. properties that represent other metadata (@pxref{Special properties}). For
  6565. example, the ``property'' @code{TODO} represents the TODO keyword of the
  6566. entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
  6567. So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
  6568. that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
  6569. DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
  6570. count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
  6571. Here are more examples:
  6572. @table @samp
  6573. @item work+TODO="WAITING"
  6574. Select @samp{:work:}-tagged TODO lines with the specific TODO
  6575. keyword @samp{WAITING}.
  6576. @item work+TODO="WAITING"|home+TODO="WAITING"
  6577. Waiting tasks both at work and at home.
  6578. @end table
  6579. When matching properties, a number of different operators can be used to test
  6580. the value of a property. Here is a complex example:
  6581. @example
  6582. +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
  6583. +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
  6584. @end example
  6585. @noindent
  6586. The type of comparison will depend on how the comparison value is written:
  6587. @itemize @minus
  6588. @item
  6589. If the comparison value is a plain number, a numerical comparison is done,
  6590. and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
  6591. @samp{>=}, and @samp{<>}.
  6592. @item
  6593. If the comparison value is enclosed in double-quotes,
  6594. a string comparison is done, and the same operators are allowed.
  6595. @item
  6596. If the comparison value is enclosed in double-quotes @emph{and} angular
  6597. brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
  6598. assumed to be date/time specifications in the standard Org way, and the
  6599. comparison will be done accordingly. Special values that will be recognized
  6600. are @code{"<now>"} for now (including time), and @code{"<today>"}, and
  6601. @code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time
  6602. specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
  6603. @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
  6604. respectively, can be used.
  6605. @item
  6606. If the comparison value is enclosed
  6607. in curly braces, a regexp match is performed, with @samp{=} meaning that the
  6608. regexp matches the property value, and @samp{<>} meaning that it does not
  6609. match.
  6610. @end itemize
  6611. So the search string in the example finds entries tagged @samp{:work:} but
  6612. not @samp{:boss:}, which also have a priority value @samp{A}, a
  6613. @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
  6614. property that is numerically smaller than 2, a @samp{:With:} property that is
  6615. matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
  6616. on or after October 11, 2008.
  6617. Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
  6618. other properties will slow down the search. However, once you have paid the
  6619. price by accessing one property, testing additional properties is cheap
  6620. again.
  6621. You can configure Org mode to use property inheritance during a search, but
  6622. beware that this can slow down searches considerably. See @ref{Property
  6623. inheritance}, for details.
  6624. For backward compatibility, and also for typing speed, there is also a
  6625. different way to test TODO states in a search. For this, terminate the
  6626. tags/property part of the search string (which may include several terms
  6627. connected with @samp{|}) with a @samp{/} and then specify a Boolean
  6628. expression just for TODO keywords. The syntax is then similar to that for
  6629. tags, but should be applied with care: for example, a positive selection on
  6630. several TODO keywords cannot meaningfully be combined with boolean AND.
  6631. However, @emph{negative selection} combined with AND can be meaningful. To
  6632. make sure that only lines are checked that actually have any TODO keyword
  6633. (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
  6634. part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
  6635. not match TODO keywords in a DONE state. Examples:
  6636. @table @samp
  6637. @item work/WAITING
  6638. Same as @samp{work+TODO="WAITING"}
  6639. @item work/!-WAITING-NEXT
  6640. Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
  6641. nor @samp{NEXT}
  6642. @item work/!+WAITING|+NEXT
  6643. Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
  6644. @samp{NEXT}.
  6645. @end table
  6646. @node Timeline, Search view, Matching tags and properties, Built-in agenda views
  6647. @subsection Timeline for a single file
  6648. @cindex timeline, single file
  6649. @cindex time-sorted view
  6650. The timeline summarizes all time-stamped items from a single Org mode
  6651. file in a @emph{time-sorted view}. The main purpose of this command is
  6652. to give an overview over events in a project.
  6653. @table @kbd
  6654. @orgcmd{C-c a L,org-timeline}
  6655. Show a time-sorted view of the Org file, with all time-stamped items.
  6656. When called with a @kbd{C-u} prefix, all unfinished TODO entries
  6657. (scheduled or not) are also listed under the current date.
  6658. @end table
  6659. @noindent
  6660. The commands available in the timeline buffer are listed in
  6661. @ref{Agenda commands}.
  6662. @node Search view, Stuck projects, Timeline, Built-in agenda views
  6663. @subsection Search view
  6664. @cindex search view
  6665. @cindex text search
  6666. @cindex searching, for text
  6667. This agenda view is a general text search facility for Org mode entries.
  6668. It is particularly useful to find notes.
  6669. @table @kbd
  6670. @orgcmd{C-c a s,org-search-view}
  6671. This is a special search that lets you select entries by matching a substring
  6672. or specific words using a boolean logic.
  6673. @end table
  6674. For example, the search string @samp{computer equipment} will find entries
  6675. that contain @samp{computer equipment} as a substring. If the two words are
  6676. separated by more space or a line break, the search will still match.
  6677. Search view can also search for specific keywords in the entry, using Boolean
  6678. logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
  6679. will search for note entries that contain the keywords @code{computer}
  6680. and @code{wifi}, but not the keyword @code{ethernet}, and which are also
  6681. not matched by the regular expression @code{8\.11[bg]}, meaning to
  6682. exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
  6683. word search, other @samp{+} characters are optional. For more details, see
  6684. the docstring of the command @code{org-search-view}.
  6685. @vindex org-agenda-text-search-extra-files
  6686. Note that in addition to the agenda files, this command will also search
  6687. the files listed in @code{org-agenda-text-search-extra-files}.
  6688. @node Stuck projects, , Search view, Built-in agenda views
  6689. @subsection Stuck projects
  6690. @pindex GTD, Getting Things Done
  6691. If you are following a system like David Allen's GTD to organize your
  6692. work, one of the ``duties'' you have is a regular review to make sure
  6693. that all projects move along. A @emph{stuck} project is a project that
  6694. has no defined next actions, so it will never show up in the TODO lists
  6695. Org mode produces. During the review, you need to identify such
  6696. projects and define next actions for them.
  6697. @table @kbd
  6698. @orgcmd{C-c a #,org-agenda-list-stuck-projects}
  6699. List projects that are stuck.
  6700. @kindex C-c a !
  6701. @item C-c a !
  6702. @vindex org-stuck-projects
  6703. Customize the variable @code{org-stuck-projects} to define what a stuck
  6704. project is and how to find it.
  6705. @end table
  6706. You almost certainly will have to configure this view before it will
  6707. work for you. The built-in default assumes that all your projects are
  6708. level-2 headlines, and that a project is not stuck if it has at least
  6709. one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
  6710. Let's assume that you, in your own way of using Org mode, identify
  6711. projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
  6712. indicate a project that should not be considered yet. Let's further
  6713. assume that the TODO keyword DONE marks finished projects, and that NEXT
  6714. and TODO indicate next actions. The tag @@SHOP indicates shopping and
  6715. is a next action even without the NEXT tag. Finally, if the project
  6716. contains the special word IGNORE anywhere, it should not be listed
  6717. either. In this case you would start by identifying eligible projects
  6718. with a tags/todo match@footnote{@xref{Tag searches}.}
  6719. @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
  6720. IGNORE in the subtree to identify projects that are not stuck. The
  6721. correct customization for this is
  6722. @lisp
  6723. (setq org-stuck-projects
  6724. '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
  6725. "\\<IGNORE\\>"))
  6726. @end lisp
  6727. Note that if a project is identified as non-stuck, the subtree of this entry
  6728. will still be searched for stuck projects.
  6729. @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
  6730. @section Presentation and sorting
  6731. @cindex presentation, of agenda items
  6732. @vindex org-agenda-prefix-format
  6733. @vindex org-agenda-tags-column
  6734. Before displaying items in an agenda view, Org mode visually prepares the
  6735. items and sorts them. Each item occupies a single line. The line starts
  6736. with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
  6737. of the item and other important information. You can customize in which
  6738. column tags will be displayed through @code{org-agenda-tags-column}. You can
  6739. also customize the prefix using the option @code{org-agenda-prefix-format}.
  6740. This prefix is followed by a cleaned-up version of the outline headline
  6741. associated with the item.
  6742. @menu
  6743. * Categories:: Not all tasks are equal
  6744. * Time-of-day specifications:: How the agenda knows the time
  6745. * Sorting of agenda items:: The order of things
  6746. @end menu
  6747. @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
  6748. @subsection Categories
  6749. @cindex category
  6750. @cindex #+CATEGORY
  6751. The category is a broad label assigned to each agenda item. By default,
  6752. the category is simply derived from the file name, but you can also
  6753. specify it with a special line in the buffer, like this@footnote{For
  6754. backward compatibility, the following also works: if there are several
  6755. such lines in a file, each specifies the category for the text below it.
  6756. The first category also applies to any text before the first CATEGORY
  6757. line. However, using this method is @emph{strongly} deprecated as it is
  6758. incompatible with the outline structure of the document. The correct
  6759. method for setting multiple categories in a buffer is using a
  6760. property.}:
  6761. @example
  6762. #+CATEGORY: Thesis
  6763. @end example
  6764. @noindent
  6765. @cindex property, CATEGORY
  6766. If you would like to have a special CATEGORY for a single entry or a
  6767. (sub)tree, give the entry a @code{:CATEGORY:} property with the
  6768. special category you want to apply as the value.
  6769. @noindent
  6770. The display in the agenda buffer looks best if the category is not
  6771. longer than 10 characters.
  6772. @noindent
  6773. You can set up icons for category by customizing the
  6774. @code{org-agenda-category-icon-alist} variable.
  6775. @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
  6776. @subsection Time-of-day specifications
  6777. @cindex time-of-day specification
  6778. Org mode checks each agenda item for a time-of-day specification. The
  6779. time can be part of the timestamp that triggered inclusion into the
  6780. agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
  6781. ranges can be specified with two timestamps, like
  6782. @c
  6783. @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
  6784. In the headline of the entry itself, a time(range) may also appear as
  6785. plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
  6786. integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
  6787. specifications in diary entries are recognized as well.
  6788. For agenda display, Org mode extracts the time and displays it in a
  6789. standard 24 hour format as part of the prefix. The example times in
  6790. the previous paragraphs would end up in the agenda like this:
  6791. @example
  6792. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  6793. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  6794. 19:00...... The Vogon reads his poem
  6795. 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
  6796. @end example
  6797. @cindex time grid
  6798. If the agenda is in single-day mode, or for the display of today, the
  6799. timed entries are embedded in a time grid, like
  6800. @example
  6801. 8:00...... ------------------
  6802. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  6803. 10:00...... ------------------
  6804. 12:00...... ------------------
  6805. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  6806. 14:00...... ------------------
  6807. 16:00...... ------------------
  6808. 18:00...... ------------------
  6809. 19:00...... The Vogon reads his poem
  6810. 20:00...... ------------------
  6811. 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
  6812. @end example
  6813. @vindex org-agenda-use-time-grid
  6814. @vindex org-agenda-time-grid
  6815. The time grid can be turned on and off with the variable
  6816. @code{org-agenda-use-time-grid}, and can be configured with
  6817. @code{org-agenda-time-grid}.
  6818. @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
  6819. @subsection Sorting of agenda items
  6820. @cindex sorting, of agenda items
  6821. @cindex priorities, of agenda items
  6822. Before being inserted into a view, the items are sorted. How this is
  6823. done depends on the type of view.
  6824. @itemize @bullet
  6825. @item
  6826. @vindex org-agenda-files
  6827. For the daily/weekly agenda, the items for each day are sorted. The
  6828. default order is to first collect all items containing an explicit
  6829. time-of-day specification. These entries will be shown at the beginning
  6830. of the list, as a @emph{schedule} for the day. After that, items remain
  6831. grouped in categories, in the sequence given by @code{org-agenda-files}.
  6832. Within each category, items are sorted by priority (@pxref{Priorities}),
  6833. which is composed of the base priority (2000 for priority @samp{A}, 1000
  6834. for @samp{B}, and 0 for @samp{C}), plus additional increments for
  6835. overdue scheduled or deadline items.
  6836. @item
  6837. For the TODO list, items remain in the order of categories, but within
  6838. each category, sorting takes place according to priority
  6839. (@pxref{Priorities}). The priority used for sorting derives from the
  6840. priority cookie, with additions depending on how close an item is to its due
  6841. or scheduled date.
  6842. @item
  6843. For tags matches, items are not sorted at all, but just appear in the
  6844. sequence in which they are found in the agenda files.
  6845. @end itemize
  6846. @vindex org-agenda-sorting-strategy
  6847. Sorting can be customized using the variable
  6848. @code{org-agenda-sorting-strategy}, and may also include criteria based on
  6849. the estimated effort of an entry (@pxref{Effort estimates}).
  6850. @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
  6851. @section Commands in the agenda buffer
  6852. @cindex commands, in agenda buffer
  6853. Entries in the agenda buffer are linked back to the Org file or diary
  6854. file where they originate. You are not allowed to edit the agenda
  6855. buffer itself, but commands are provided to show and jump to the
  6856. original entry location, and to edit the Org files ``remotely'' from
  6857. the agenda buffer. In this way, all information is stored only once,
  6858. removing the risk that your agenda and note files may diverge.
  6859. Some commands can be executed with mouse clicks on agenda lines. For
  6860. the other commands, the cursor needs to be in the desired line.
  6861. @table @kbd
  6862. @tsubheading{Motion}
  6863. @cindex motion commands in agenda
  6864. @orgcmd{n,org-agenda-next-line}
  6865. Next line (same as @key{up} and @kbd{C-p}).
  6866. @orgcmd{p,org-agenda-previous-line}
  6867. Previous line (same as @key{down} and @kbd{C-n}).
  6868. @tsubheading{View/Go to Org file}
  6869. @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
  6870. Display the original location of the item in another window.
  6871. With prefix arg, make sure that the entire entry is made visible in the
  6872. outline, not only the heading.
  6873. @c
  6874. @orgcmd{L,org-agenda-recenter}
  6875. Display original location and recenter that window.
  6876. @c
  6877. @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
  6878. Go to the original location of the item in another window.
  6879. @c
  6880. @orgcmd{@key{RET},org-agenda-switch-to}
  6881. Go to the original location of the item and delete other windows.
  6882. @c
  6883. @orgcmd{F,org-agenda-follow-mode}
  6884. @vindex org-agenda-start-with-follow-mode
  6885. Toggle Follow mode. In Follow mode, as you move the cursor through
  6886. the agenda buffer, the other window always shows the corresponding
  6887. location in the Org file. The initial setting for this mode in new
  6888. agenda buffers can be set with the variable
  6889. @code{org-agenda-start-with-follow-mode}.
  6890. @c
  6891. @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
  6892. Display the entire subtree of the current item in an indirect buffer. With a
  6893. numeric prefix argument N, go up to level N and then take that tree. If N is
  6894. negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
  6895. previously used indirect buffer.
  6896. @orgcmd{C-c C-o,org-agenda-open-link}
  6897. Follow a link in the entry. This will offer a selection of any links in the
  6898. text belonging to the referenced Org node. If there is only one link, it
  6899. will be followed without a selection prompt.
  6900. @tsubheading{Change display}
  6901. @cindex display changing, in agenda
  6902. @kindex A
  6903. @item A
  6904. Interactively select another agenda view and append it to the current view.
  6905. @c
  6906. @kindex o
  6907. @item o
  6908. Delete other windows.
  6909. @c
  6910. @orgcmdkskc{v d,d,org-agenda-day-view}
  6911. @xorgcmdkskc{v w,w,org-agenda-day-view}
  6912. @xorgcmd{v m,org-agenda-month-view}
  6913. @xorgcmd{v y,org-agenda-month-year}
  6914. @xorgcmd{v SPC,org-agenda-reset-view}
  6915. @vindex org-agenda-span
  6916. Switch to day/week/month/year view. When switching to day or week view, this
  6917. setting becomes the default for subsequent agenda refreshes. Since month and
  6918. year views are slow to create, they do not become the default. A numeric
  6919. prefix argument may be used to jump directly to a specific day of the year,
  6920. ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
  6921. February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
  6922. month view, a year may be encoded in the prefix argument as well. For
  6923. example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
  6924. specification has only one or two digits, it will be mapped to the interval
  6925. 1938-2037. @kbd{v @key{SPC}} will reset to what is set in
  6926. @code{org-agenda-span}.
  6927. @c
  6928. @orgcmd{f,org-agenda-later}
  6929. Go forward in time to display the following @code{org-agenda-current-span} days.
  6930. For example, if the display covers a week, switch to the following week.
  6931. With prefix arg, go forward that many times @code{org-agenda-current-span} days.
  6932. @c
  6933. @orgcmd{b,org-agenda-earlier}
  6934. Go backward in time to display earlier dates.
  6935. @c
  6936. @orgcmd{.,org-agenda-goto-today}
  6937. Go to today.
  6938. @c
  6939. @orgcmd{j,org-agenda-goto-date}
  6940. Prompt for a date and go there.
  6941. @c
  6942. @orgcmd{J,org-agenda-clock-goto}
  6943. Go to the currently clocked-in task @i{in the agenda buffer}.
  6944. @c
  6945. @orgcmd{D,org-agenda-toggle-diary}
  6946. Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
  6947. @c
  6948. @orgcmdkskc{v l,l,org-agenda-log-mode}
  6949. @kindex v L
  6950. @vindex org-log-done
  6951. @vindex org-agenda-log-mode-items
  6952. Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
  6953. logging was on (variable @code{org-log-done}) are shown in the agenda, as are
  6954. entries that have been clocked on that day. You can configure the entry
  6955. types that should be included in log mode using the variable
  6956. @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
  6957. all possible logbook entries, including state changes. When called with two
  6958. prefix args @kbd{C-u C-u}, show only logging information, nothing else.
  6959. @kbd{v L} is equivalent to @kbd{C-u v l}.
  6960. @c
  6961. @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
  6962. Include inactive timestamps into the current view. Only for weekly/daily
  6963. agenda and timeline views.
  6964. @c
  6965. @orgcmd{v a,org-agenda-archives-mode}
  6966. @xorgcmd{v A,org-agenda-archives-mode 'files}
  6967. Toggle Archives mode. In Archives mode, trees that are marked
  6968. @code{ARCHIVED} are also scanned when producing the agenda. When you use the
  6969. capital @kbd{A}, even all archive files are included. To exit archives mode,
  6970. press @kbd{v a} again.
  6971. @c
  6972. @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
  6973. @vindex org-agenda-start-with-clockreport-mode
  6974. @vindex org-clock-report-include-clocking-task
  6975. Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
  6976. always show a table with the clocked times for the timespan and file scope
  6977. covered by the current agenda view. The initial setting for this mode in new
  6978. agenda buffers can be set with the variable
  6979. @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
  6980. when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show
  6981. contributions from entries that are hidden by agenda filtering@footnote{Only
  6982. tags filtering will be respected here, effort filtering is ignored.}. See
  6983. also the variable @code{org-clock-report-include-clocking-task}.
  6984. @c
  6985. @orgkey{v c}
  6986. @vindex org-agenda-clock-consistency-checks
  6987. Show overlapping clock entries, clocking gaps, and other clocking problems in
  6988. the current agenda range. You can then visit clocking lines and fix them
  6989. manually. See the variable @code{org-agenda-clock-consistency-checks} for
  6990. information on how to customize the definition of what constituted a clocking
  6991. problem. To return to normal agenda display, press @kbd{l} to exit Logbook
  6992. mode.
  6993. @c
  6994. @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
  6995. @vindex org-agenda-start-with-entry-text-mode
  6996. @vindex org-agenda-entry-text-maxlines
  6997. Toggle entry text mode. In entry text mode, a number of lines from the Org
  6998. outline node referenced by an agenda line will be displayed below the line.
  6999. The maximum number of lines is given by the variable
  7000. @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
  7001. prefix argument will temporarily modify that number to the prefix value.
  7002. @c
  7003. @orgcmd{G,org-agenda-toggle-time-grid}
  7004. @vindex org-agenda-use-time-grid
  7005. @vindex org-agenda-time-grid
  7006. Toggle the time grid on and off. See also the variables
  7007. @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
  7008. @c
  7009. @orgcmd{r,org-agenda-redo}
  7010. Recreate the agenda buffer, for example to reflect the changes after
  7011. modification of the timestamps of items with @kbd{S-@key{left}} and
  7012. @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
  7013. argument is interpreted to create a selective list for a specific TODO
  7014. keyword.
  7015. @orgcmd{g,org-agenda-redo}
  7016. Same as @kbd{r}.
  7017. @c
  7018. @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
  7019. Save all Org buffers in the current Emacs session, and also the locations of
  7020. IDs.
  7021. @c
  7022. @orgcmd{C-c C-x C-c,org-agenda-columns}
  7023. @vindex org-columns-default-format
  7024. Invoke column view (@pxref{Column view}) in the agenda buffer. The column
  7025. view format is taken from the entry at point, or (if there is no entry at
  7026. point), from the first entry in the agenda view. So whatever the format for
  7027. that entry would be in the original buffer (taken from a property, from a
  7028. @code{#+COLUMNS} line, or from the default variable
  7029. @code{org-columns-default-format}), will be used in the agenda.
  7030. @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
  7031. Remove the restriction lock on the agenda, if it is currently restricted to a
  7032. file or subtree (@pxref{Agenda files}).
  7033. @tsubheading{Secondary filtering and query editing}
  7034. @cindex filtering, by tag category and effort, in agenda
  7035. @cindex tag filtering, in agenda
  7036. @cindex category filtering, in agenda
  7037. @cindex effort filtering, in agenda
  7038. @cindex query editing, in agenda
  7039. @orgcmd{<,org-agenda-filter-by-category}
  7040. @vindex org-agenda-category-filter-preset
  7041. Filter the current agenda view with respect to the category of the item at
  7042. point. Pressing @code{<} another time will remove this filter. You can add
  7043. a filter preset through the option @code{org-agenda-category-filter-preset}
  7044. (see below.)
  7045. @orgcmd{/,org-agenda-filter-by-tag}
  7046. @vindex org-agenda-tag-filter-preset
  7047. Filter the current agenda view with respect to a tag and/or effort estimates.
  7048. The difference between this and a custom agenda command is that filtering is
  7049. very fast, so that you can switch quickly between different filters without
  7050. having to recreate the agenda.@footnote{Custom commands can preset a filter by
  7051. binding the variable @code{org-agenda-tag-filter-preset} as an option. This
  7052. filter will then be applied to the view and persist as a basic filter through
  7053. refreshes and more secondary filtering. The filter is a global property of
  7054. the entire agenda view---in a block agenda, you should only set this in the
  7055. global options section, not in the section of an individual block.}
  7056. You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
  7057. all. Pressing @key{TAB} at that prompt will offer use completion to select a
  7058. tag (including any tags that do not have a selection character). The command
  7059. then hides all entries that do not contain or inherit this tag. When called
  7060. with prefix arg, remove the entries that @emph{do} have the tag. A second
  7061. @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
  7062. If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
  7063. will be narrowed by requiring or forbidding the selected additional tag.
  7064. Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
  7065. immediately use the @kbd{\} command.
  7066. @vindex org-sort-agenda-noeffort-is-high
  7067. In order to filter for effort estimates, you should set up allowed
  7068. efforts globally, for example
  7069. @lisp
  7070. (setq org-global-properties
  7071. '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
  7072. @end lisp
  7073. You can then filter for an effort by first typing an operator, one of
  7074. @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
  7075. estimate in your array of allowed values, where @kbd{0} means the 10th value.
  7076. The filter will then restrict to entries with effort smaller-or-equal, equal,
  7077. or larger-or-equal than the selected value. If the digits 0-9 are not used
  7078. as fast access keys to tags, you can also simply press the index digit
  7079. directly without an operator. In this case, @kbd{<} will be assumed. For
  7080. application of the operator, entries without a defined effort will be treated
  7081. according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
  7082. for tasks without effort definition, press @kbd{?} as the operator.
  7083. Org also supports automatic, context-aware tag filtering. If the variable
  7084. @code{org-agenda-auto-exclude-function} is set to a user-defined function,
  7085. that function can decide which tags should be excluded from the agenda
  7086. automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
  7087. as a sub-option key and runs the auto exclusion logic. For example, let's
  7088. say you use a @code{Net} tag to identify tasks which need network access, an
  7089. @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
  7090. calls. You could auto-exclude these tags based on the availability of the
  7091. Internet, and outside of business hours, with something like this:
  7092. @lisp
  7093. @group
  7094. (defun org-my-auto-exclude-function (tag)
  7095. (and (cond
  7096. ((string= tag "Net")
  7097. (/= 0 (call-process "/sbin/ping" nil nil nil
  7098. "-c1" "-q" "-t1" "mail.gnu.org")))
  7099. ((or (string= tag "Errand") (string= tag "Call"))
  7100. (let ((hour (nth 2 (decode-time))))
  7101. (or (< hour 8) (> hour 21)))))
  7102. (concat "-" tag)))
  7103. (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
  7104. @end group
  7105. @end lisp
  7106. @orgcmd{\\,org-agenda-filter-by-tag-refine}
  7107. Narrow the current agenda filter by an additional condition. When called with
  7108. prefix arg, remove the entries that @emph{do} have the tag, or that do match
  7109. the effort criterion. You can achieve the same effect by pressing @kbd{+} or
  7110. @kbd{-} as the first key after the @kbd{/} command.
  7111. @c
  7112. @kindex [
  7113. @kindex ]
  7114. @kindex @{
  7115. @kindex @}
  7116. @item [ ] @{ @}
  7117. @table @i
  7118. @item @r{in} search view
  7119. add new search words (@kbd{[} and @kbd{]}) or new regular expressions
  7120. (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
  7121. add a positive search term prefixed by @samp{+}, indicating that this search
  7122. term @i{must} occur/match in the entry. The closing bracket/brace will add a
  7123. negative search term which @i{must not} occur/match in the entry for it to be
  7124. selected.
  7125. @end table
  7126. @tsubheading{Remote editing}
  7127. @cindex remote editing, from agenda
  7128. @item 0-9
  7129. Digit argument.
  7130. @c
  7131. @cindex undoing remote-editing events
  7132. @cindex remote editing, undo
  7133. @orgcmd{C-_,org-agenda-undo}
  7134. Undo a change due to a remote editing command. The change is undone
  7135. both in the agenda buffer and in the remote buffer.
  7136. @c
  7137. @orgcmd{t,org-agenda-todo}
  7138. Change the TODO state of the item, both in the agenda and in the
  7139. original org file.
  7140. @c
  7141. @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
  7142. @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
  7143. Switch to the next/previous set of TODO keywords.
  7144. @c
  7145. @orgcmd{C-k,org-agenda-kill}
  7146. @vindex org-agenda-confirm-kill
  7147. Delete the current agenda item along with the entire subtree belonging
  7148. to it in the original Org file. If the text to be deleted remotely
  7149. is longer than one line, the kill needs to be confirmed by the user. See
  7150. variable @code{org-agenda-confirm-kill}.
  7151. @c
  7152. @orgcmd{C-c C-w,org-agenda-refile}
  7153. Refile the entry at point.
  7154. @c
  7155. @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
  7156. @vindex org-archive-default-command
  7157. Archive the subtree corresponding to the entry at point using the default
  7158. archiving command set in @code{org-archive-default-command}. When using the
  7159. @code{a} key, confirmation will be required.
  7160. @c
  7161. @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
  7162. Toggle the ARCHIVE tag for the current headline.
  7163. @c
  7164. @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
  7165. Move the subtree corresponding to the current entry to its @emph{archive
  7166. sibling}.
  7167. @c
  7168. @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
  7169. Archive the subtree corresponding to the current headline. This means the
  7170. entry will be moved to the configured archive location, most likely a
  7171. different file.
  7172. @c
  7173. @orgcmd{T,org-agenda-show-tags}
  7174. @vindex org-agenda-show-inherited-tags
  7175. Show all tags associated with the current item. This is useful if you have
  7176. turned off @code{org-agenda-show-inherited-tags}, but still want to see all
  7177. tags of a headline occasionally.
  7178. @c
  7179. @orgcmd{:,org-agenda-set-tags}
  7180. Set tags for the current headline. If there is an active region in the
  7181. agenda, change a tag for all headings in the region.
  7182. @c
  7183. @kindex ,
  7184. @item ,
  7185. Set the priority for the current item (@command{org-agenda-priority}).
  7186. Org mode prompts for the priority character. If you reply with @key{SPC},
  7187. the priority cookie is removed from the entry.
  7188. @c
  7189. @orgcmd{P,org-agenda-show-priority}
  7190. Display weighted priority of current item.
  7191. @c
  7192. @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
  7193. Increase the priority of the current item. The priority is changed in
  7194. the original buffer, but the agenda is not resorted. Use the @kbd{r}
  7195. key for this.
  7196. @c
  7197. @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
  7198. Decrease the priority of the current item.
  7199. @c
  7200. @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
  7201. @vindex org-log-into-drawer
  7202. Add a note to the entry. This note will be recorded, and then filed to the
  7203. same location where state change notes are put. Depending on
  7204. @code{org-log-into-drawer}, this may be inside a drawer.
  7205. @c
  7206. @orgcmd{C-c C-a,org-attach}
  7207. Dispatcher for all command related to attachments.
  7208. @c
  7209. @orgcmd{C-c C-s,org-agenda-schedule}
  7210. Schedule this item. With prefix arg remove the scheduling timestamp
  7211. @c
  7212. @orgcmd{C-c C-d,org-agenda-deadline}
  7213. Set a deadline for this item. With prefix arg remove the deadline.
  7214. @c
  7215. @orgcmd{k,org-agenda-action}
  7216. Agenda actions, to set dates for selected items to the cursor date.
  7217. This command also works in the calendar! The command prompts for an
  7218. additional key:
  7219. @example
  7220. m @r{Mark the entry at point for action. You can also make entries}
  7221. @r{in Org files with @kbd{C-c C-x C-k}.}
  7222. d @r{Set the deadline of the marked entry to the date at point.}
  7223. s @r{Schedule the marked entry at the date at point.}
  7224. r @r{Call @code{org-capture} with the cursor date as default date.}
  7225. @end example
  7226. @noindent
  7227. Press @kbd{r} afterward to refresh the agenda and see the effect of the
  7228. command.
  7229. @c
  7230. @orgcmd{S-@key{right},org-agenda-do-date-later}
  7231. Change the timestamp associated with the current line by one day into the
  7232. future. If the date is in the past, the first call to this command will move
  7233. it to today.@*
  7234. With a numeric prefix argument, change it by that many days. For example,
  7235. @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
  7236. change the time by one hour. If you immediately repeat the command, it will
  7237. continue to change hours even without the prefix arg. With a double @kbd{C-u
  7238. C-u} prefix, do the same for changing minutes.@*
  7239. The stamp is changed in the original Org file, but the change is not directly
  7240. reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
  7241. @c
  7242. @orgcmd{S-@key{left},org-agenda-do-date-earlier}
  7243. Change the timestamp associated with the current line by one day
  7244. into the past.
  7245. @c
  7246. @orgcmd{>,org-agenda-date-prompt}
  7247. Change the timestamp associated with the current line. The key @kbd{>} has
  7248. been chosen, because it is the same as @kbd{S-.} on my keyboard.
  7249. @c
  7250. @orgcmd{I,org-agenda-clock-in}
  7251. Start the clock on the current item. If a clock is running already, it
  7252. is stopped first.
  7253. @c
  7254. @orgcmd{O,org-agenda-clock-out}
  7255. Stop the previously started clock.
  7256. @c
  7257. @orgcmd{X,org-agenda-clock-cancel}
  7258. Cancel the currently running clock.
  7259. @c
  7260. @orgcmd{J,org-agenda-clock-goto}
  7261. Jump to the running clock in another window.
  7262. @tsubheading{Bulk remote editing selected entries}
  7263. @cindex remote editing, bulk, from agenda
  7264. @orgcmd{m,org-agenda-bulk-mark}
  7265. Mark the entry at point for bulk action. With prefix arg, mark that many
  7266. successive entries.
  7267. @c
  7268. @orgcmd{%,org-agenda-bulk-mark-regexp}
  7269. Mark entries matching a regular expression for bulk action.
  7270. @c
  7271. @orgcmd{u,org-agenda-bulk-unmark}
  7272. Unmark entry for bulk action.
  7273. @c
  7274. @orgcmd{U,org-agenda-bulk-remove-all-marks}
  7275. Unmark all marked entries for bulk action.
  7276. @c
  7277. @orgcmd{B,org-agenda-bulk-action}
  7278. Bulk action: act on all marked entries in the agenda. This will prompt for
  7279. another key to select the action to be applied. The prefix arg to @kbd{B}
  7280. will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
  7281. these special timestamps.
  7282. @example
  7283. r @r{Prompt for a single refile target and move all entries. The entries}
  7284. @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
  7285. $ @r{Archive all selected entries.}
  7286. A @r{Archive entries by moving them to their respective archive siblings.}
  7287. t @r{Change TODO state. This prompts for a single TODO keyword and}
  7288. @r{changes the state of all selected entries, bypassing blocking and}
  7289. @r{suppressing logging notes (but not timestamps).}
  7290. + @r{Add a tag to all selected entries.}
  7291. - @r{Remove a tag from all selected entries.}
  7292. s @r{Schedule all items to a new date. To shift existing schedule dates}
  7293. @r{by a fixed number of days, use something starting with double plus}
  7294. @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
  7295. S @r{Reschedule randomly into the coming N days. N will be prompted for.}
  7296. @r{With prefix arg (@kbd{C-u B S}), scatter only across weekdays.}
  7297. d @r{Set deadline to a specific date.}
  7298. f @r{Apply a function to marked entries.}
  7299. @r{For example, the function below sets the CATEGORY property of the}
  7300. @r{entries to web.}
  7301. @r{(defun set-category ()}
  7302. @r{ (interactive "P")}
  7303. @r{ (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
  7304. @r{ (org-agenda-error)))}
  7305. @r{ (buffer (marker-buffer marker)))}
  7306. @r{ (with-current-buffer buffer}
  7307. @r{ (save-excursion}
  7308. @r{ (save-restriction}
  7309. @r{ (widen)}
  7310. @r{ (goto-char marker)}
  7311. @r{ (org-back-to-heading t)}
  7312. @r{ (org-set-property "CATEGORY" "web"))))))}
  7313. @end example
  7314. @tsubheading{Calendar commands}
  7315. @cindex calendar commands, from agenda
  7316. @orgcmd{c,org-agenda-goto-calendar}
  7317. Open the Emacs calendar and move to the date at the agenda cursor.
  7318. @c
  7319. @orgcmd{c,org-calendar-goto-agenda}
  7320. When in the calendar, compute and show the Org mode agenda for the
  7321. date at the cursor.
  7322. @c
  7323. @cindex diary entries, creating from agenda
  7324. @orgcmd{i,org-agenda-diary-entry}
  7325. @vindex org-agenda-diary-file
  7326. Insert a new entry into the diary, using the date at the cursor and (for
  7327. block entries) the date at the mark. This will add to the Emacs diary
  7328. file@footnote{This file is parsed for the agenda when
  7329. @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
  7330. command in the calendar. The diary file will pop up in another window, where
  7331. you can add the entry.
  7332. If you configure @code{org-agenda-diary-file} to point to an Org mode file,
  7333. Org will create entries (in Org mode syntax) in that file instead. Most
  7334. entries will be stored in a date-based outline tree that will later make it
  7335. easy to archive appointments from previous months/years. The tree will be
  7336. built under an entry with a @code{DATE_TREE} property, or else with years as
  7337. top-level entries. Emacs will prompt you for the entry text---if you specify
  7338. it, the entry will be created in @code{org-agenda-diary-file} without further
  7339. interaction. If you directly press @key{RET} at the prompt without typing
  7340. text, the target file will be shown in another window for you to finish the
  7341. entry there. See also the @kbd{k r} command.
  7342. @c
  7343. @orgcmd{M,org-agenda-phases-of-moon}
  7344. Show the phases of the moon for the three months around current date.
  7345. @c
  7346. @orgcmd{S,org-agenda-sunrise-sunset}
  7347. Show sunrise and sunset times. The geographical location must be set
  7348. with calendar variables, see the documentation for the Emacs calendar.
  7349. @c
  7350. @orgcmd{C,org-agenda-convert-date}
  7351. Convert the date at cursor into many other cultural and historic
  7352. calendars.
  7353. @c
  7354. @orgcmd{H,org-agenda-holidays}
  7355. Show holidays for three months around the cursor date.
  7356. @item M-x org-export-icalendar-combine-agenda-files
  7357. Export a single iCalendar file containing entries from all agenda files.
  7358. This is a globally available command, and also available in the agenda menu.
  7359. @tsubheading{Exporting to a file}
  7360. @orgcmd{C-x C-w,org-write-agenda}
  7361. @cindex exporting agenda views
  7362. @cindex agenda views, exporting
  7363. @vindex org-agenda-exporter-settings
  7364. Write the agenda view to a file. Depending on the extension of the selected
  7365. file name, the view will be exported as HTML (extension @file{.html} or
  7366. @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
  7367. and plain text (any other extension). When called with a @kbd{C-u} prefix
  7368. argument, immediately open the newly created file. Use the variable
  7369. @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
  7370. for @file{htmlize} to be used during export.
  7371. @tsubheading{Quit and Exit}
  7372. @orgcmd{q,org-agenda-quit}
  7373. Quit agenda, remove the agenda buffer.
  7374. @c
  7375. @cindex agenda files, removing buffers
  7376. @orgcmd{x,org-agenda-exit}
  7377. Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
  7378. for the compilation of the agenda. Buffers created by the user to
  7379. visit Org files will not be removed.
  7380. @end table
  7381. @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
  7382. @section Custom agenda views
  7383. @cindex custom agenda views
  7384. @cindex agenda views, custom
  7385. Custom agenda commands serve two purposes: to store and quickly access
  7386. frequently used TODO and tags searches, and to create special composite
  7387. agenda buffers. Custom agenda commands will be accessible through the
  7388. dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
  7389. @menu
  7390. * Storing searches:: Type once, use often
  7391. * Block agenda:: All the stuff you need in a single buffer
  7392. * Setting Options:: Changing the rules
  7393. @end menu
  7394. @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
  7395. @subsection Storing searches
  7396. The first application of custom searches is the definition of keyboard
  7397. shortcuts for frequently used searches, either creating an agenda
  7398. buffer, or a sparse tree (the latter covering of course only the current
  7399. buffer).
  7400. @kindex C-c a C
  7401. @vindex org-agenda-custom-commands
  7402. Custom commands are configured in the variable
  7403. @code{org-agenda-custom-commands}. You can customize this variable, for
  7404. example by pressing @kbd{C-c a C}. You can also directly set it with
  7405. Emacs Lisp in @file{.emacs}. The following example contains all valid
  7406. search types:
  7407. @lisp
  7408. @group
  7409. (setq org-agenda-custom-commands
  7410. '(("w" todo "WAITING")
  7411. ("W" todo-tree "WAITING")
  7412. ("u" tags "+boss-urgent")
  7413. ("v" tags-todo "+boss-urgent")
  7414. ("U" tags-tree "+boss-urgent")
  7415. ("f" occur-tree "\\<FIXME\\>")
  7416. ("h" . "HOME+Name tags searches") ; description for "h" prefix
  7417. ("hl" tags "+home+Lisa")
  7418. ("hp" tags "+home+Peter")
  7419. ("hk" tags "+home+Kim")))
  7420. @end group
  7421. @end lisp
  7422. @noindent
  7423. The initial string in each entry defines the keys you have to press
  7424. after the dispatcher command @kbd{C-c a} in order to access the command.
  7425. Usually this will be just a single character, but if you have many
  7426. similar commands, you can also define two-letter combinations where the
  7427. first character is the same in several combinations and serves as a
  7428. prefix key@footnote{You can provide a description for a prefix key by
  7429. inserting a cons cell with the prefix and the description.}. The second
  7430. parameter is the search type, followed by the string or regular
  7431. expression to be used for the matching. The example above will
  7432. therefore define:
  7433. @table @kbd
  7434. @item C-c a w
  7435. as a global search for TODO entries with @samp{WAITING} as the TODO
  7436. keyword
  7437. @item C-c a W
  7438. as the same search, but only in the current buffer and displaying the
  7439. results as a sparse tree
  7440. @item C-c a u
  7441. as a global tags search for headlines marked @samp{:boss:} but not
  7442. @samp{:urgent:}
  7443. @item C-c a v
  7444. as the same search as @kbd{C-c a u}, but limiting the search to
  7445. headlines that are also TODO items
  7446. @item C-c a U
  7447. as the same search as @kbd{C-c a u}, but only in the current buffer and
  7448. displaying the result as a sparse tree
  7449. @item C-c a f
  7450. to create a sparse tree (again: current buffer only) with all entries
  7451. containing the word @samp{FIXME}
  7452. @item C-c a h
  7453. as a prefix command for a HOME tags search where you have to press an
  7454. additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
  7455. Peter, or Kim) as additional tag to match.
  7456. @end table
  7457. @node Block agenda, Setting Options, Storing searches, Custom agenda views
  7458. @subsection Block agenda
  7459. @cindex block agenda
  7460. @cindex agenda, with block views
  7461. Another possibility is the construction of agenda views that comprise
  7462. the results of @emph{several} commands, each of which creates a block in
  7463. the agenda buffer. The available commands include @code{agenda} for the
  7464. daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
  7465. for the global TODO list (as constructed with @kbd{C-c a t}), and the
  7466. matching commands discussed above: @code{todo}, @code{tags}, and
  7467. @code{tags-todo}. Here are two examples:
  7468. @lisp
  7469. @group
  7470. (setq org-agenda-custom-commands
  7471. '(("h" "Agenda and Home-related tasks"
  7472. ((agenda "")
  7473. (tags-todo "home")
  7474. (tags "garden")))
  7475. ("o" "Agenda and Office-related tasks"
  7476. ((agenda "")
  7477. (tags-todo "work")
  7478. (tags "office")))))
  7479. @end group
  7480. @end lisp
  7481. @noindent
  7482. This will define @kbd{C-c a h} to create a multi-block view for stuff
  7483. you need to attend to at home. The resulting agenda buffer will contain
  7484. your agenda for the current week, all TODO items that carry the tag
  7485. @samp{home}, and also all lines tagged with @samp{garden}. Finally the
  7486. command @kbd{C-c a o} provides a similar view for office tasks.
  7487. @node Setting Options, , Block agenda, Custom agenda views
  7488. @subsection Setting options for custom commands
  7489. @cindex options, for custom agenda views
  7490. @vindex org-agenda-custom-commands
  7491. Org mode contains a number of variables regulating agenda construction
  7492. and display. The global variables define the behavior for all agenda
  7493. commands, including the custom commands. However, if you want to change
  7494. some settings just for a single custom view, you can do so. Setting
  7495. options requires inserting a list of variable names and values at the
  7496. right spot in @code{org-agenda-custom-commands}. For example:
  7497. @lisp
  7498. @group
  7499. (setq org-agenda-custom-commands
  7500. '(("w" todo "WAITING"
  7501. ((org-agenda-sorting-strategy '(priority-down))
  7502. (org-agenda-prefix-format " Mixed: ")))
  7503. ("U" tags-tree "+boss-urgent"
  7504. ((org-show-following-heading nil)
  7505. (org-show-hierarchy-above nil)))
  7506. ("N" search ""
  7507. ((org-agenda-files '("~org/notes.org"))
  7508. (org-agenda-text-search-extra-files nil)))))
  7509. @end group
  7510. @end lisp
  7511. @noindent
  7512. Now the @kbd{C-c a w} command will sort the collected entries only by
  7513. priority, and the prefix format is modified to just say @samp{ Mixed: }
  7514. instead of giving the category of the entry. The sparse tags tree of
  7515. @kbd{C-c a U} will now turn out ultra-compact, because neither the
  7516. headline hierarchy above the match, nor the headline following the match
  7517. will be shown. The command @kbd{C-c a N} will do a text search limited
  7518. to only a single file.
  7519. @vindex org-agenda-custom-commands
  7520. For command sets creating a block agenda,
  7521. @code{org-agenda-custom-commands} has two separate spots for setting
  7522. options. You can add options that should be valid for just a single
  7523. command in the set, and options that should be valid for all commands in
  7524. the set. The former are just added to the command entry; the latter
  7525. must come after the list of command entries. Going back to the block
  7526. agenda example (@pxref{Block agenda}), let's change the sorting strategy
  7527. for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
  7528. the results for GARDEN tags query in the opposite order,
  7529. @code{priority-up}. This would look like this:
  7530. @lisp
  7531. @group
  7532. (setq org-agenda-custom-commands
  7533. '(("h" "Agenda and Home-related tasks"
  7534. ((agenda)
  7535. (tags-todo "home")
  7536. (tags "garden"
  7537. ((org-agenda-sorting-strategy '(priority-up)))))
  7538. ((org-agenda-sorting-strategy '(priority-down))))
  7539. ("o" "Agenda and Office-related tasks"
  7540. ((agenda)
  7541. (tags-todo "work")
  7542. (tags "office")))))
  7543. @end group
  7544. @end lisp
  7545. As you see, the values and parentheses setting is a little complex.
  7546. When in doubt, use the customize interface to set this variable---it
  7547. fully supports its structure. Just one caveat: when setting options in
  7548. this interface, the @emph{values} are just Lisp expressions. So if the
  7549. value is a string, you need to add the double-quotes around the value
  7550. yourself.
  7551. @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
  7552. @section Exporting Agenda Views
  7553. @cindex agenda views, exporting
  7554. If you are away from your computer, it can be very useful to have a printed
  7555. version of some agenda views to carry around. Org mode can export custom
  7556. agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
  7557. @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
  7558. ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
  7559. a PDF file will also create the postscript file.}, and iCalendar files. If
  7560. you want to do this only occasionally, use the command
  7561. @table @kbd
  7562. @orgcmd{C-x C-w,org-write-agenda}
  7563. @cindex exporting agenda views
  7564. @cindex agenda views, exporting
  7565. @vindex org-agenda-exporter-settings
  7566. Write the agenda view to a file. Depending on the extension of the selected
  7567. file name, the view will be exported as HTML (extension @file{.html} or
  7568. @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
  7569. @file{.ics}), or plain text (any other extension). Use the variable
  7570. @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
  7571. for @file{htmlize} to be used during export, for example
  7572. @vindex org-agenda-add-entry-text-maxlines
  7573. @vindex htmlize-output-type
  7574. @vindex ps-number-of-columns
  7575. @vindex ps-landscape-mode
  7576. @lisp
  7577. (setq org-agenda-exporter-settings
  7578. '((ps-number-of-columns 2)
  7579. (ps-landscape-mode t)
  7580. (org-agenda-add-entry-text-maxlines 5)
  7581. (htmlize-output-type 'css)))
  7582. @end lisp
  7583. @end table
  7584. If you need to export certain agenda views frequently, you can associate
  7585. any custom agenda command with a list of output file names
  7586. @footnote{If you want to store standard views like the weekly agenda
  7587. or the global TODO list as well, you need to define custom commands for
  7588. them in order to be able to specify file names.}. Here is an example
  7589. that first defines custom commands for the agenda and the global
  7590. TODO list, together with a number of files to which to export them.
  7591. Then we define two block agenda commands and specify file names for them
  7592. as well. File names can be relative to the current working directory,
  7593. or absolute.
  7594. @lisp
  7595. @group
  7596. (setq org-agenda-custom-commands
  7597. '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
  7598. ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
  7599. ("h" "Agenda and Home-related tasks"
  7600. ((agenda "")
  7601. (tags-todo "home")
  7602. (tags "garden"))
  7603. nil
  7604. ("~/views/home.html"))
  7605. ("o" "Agenda and Office-related tasks"
  7606. ((agenda)
  7607. (tags-todo "work")
  7608. (tags "office"))
  7609. nil
  7610. ("~/views/office.ps" "~/calendars/office.ics"))))
  7611. @end group
  7612. @end lisp
  7613. The extension of the file name determines the type of export. If it is
  7614. @file{.html}, Org mode will use the @file{htmlize.el} package to convert
  7615. the buffer to HTML and save it to this file name. If the extension is
  7616. @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
  7617. Postscript output. If the extension is @file{.ics}, iCalendar export is
  7618. run export over all files that were used to construct the agenda, and
  7619. limit the export to entries listed in the agenda. Any other
  7620. extension produces a plain ASCII file.
  7621. The export files are @emph{not} created when you use one of those
  7622. commands interactively because this might use too much overhead.
  7623. Instead, there is a special command to produce @emph{all} specified
  7624. files in one step:
  7625. @table @kbd
  7626. @orgcmd{C-c a e,org-store-agenda-views}
  7627. Export all agenda views that have export file names associated with
  7628. them.
  7629. @end table
  7630. You can use the options section of the custom agenda commands to also
  7631. set options for the export commands. For example:
  7632. @lisp
  7633. (setq org-agenda-custom-commands
  7634. '(("X" agenda ""
  7635. ((ps-number-of-columns 2)
  7636. (ps-landscape-mode t)
  7637. (org-agenda-prefix-format " [ ] ")
  7638. (org-agenda-with-colors nil)
  7639. (org-agenda-remove-tags t))
  7640. ("theagenda.ps"))))
  7641. @end lisp
  7642. @noindent
  7643. This command sets two options for the Postscript exporter, to make it
  7644. print in two columns in landscape format---the resulting page can be cut
  7645. in two and then used in a paper agenda. The remaining settings modify
  7646. the agenda prefix to omit category and scheduling information, and
  7647. instead include a checkbox to check off items. We also remove the tags
  7648. to make the lines compact, and we don't want to use colors for the
  7649. black-and-white printer. Settings specified in
  7650. @code{org-agenda-exporter-settings} will also apply, but the settings
  7651. in @code{org-agenda-custom-commands} take precedence.
  7652. @noindent
  7653. From the command line you may also use
  7654. @example
  7655. emacs -eval (org-batch-store-agenda-views) -kill
  7656. @end example
  7657. @noindent
  7658. or, if you need to modify some parameters@footnote{Quoting depends on the
  7659. system you use, please check the FAQ for examples.}
  7660. @example
  7661. emacs -eval '(org-batch-store-agenda-views \
  7662. org-agenda-span (quote month) \
  7663. org-agenda-start-day "2007-11-01" \
  7664. org-agenda-include-diary nil \
  7665. org-agenda-files (quote ("~/org/project.org")))' \
  7666. -kill
  7667. @end example
  7668. @noindent
  7669. which will create the agenda views restricted to the file
  7670. @file{~/org/project.org}, without diary entries and with a 30-day
  7671. extent.
  7672. You can also extract agenda information in a way that allows further
  7673. processing by other programs. See @ref{Extracting agenda information}, for
  7674. more information.
  7675. @node Agenda column view, , Exporting Agenda Views, Agenda Views
  7676. @section Using column view in the agenda
  7677. @cindex column view, in agenda
  7678. @cindex agenda, column view
  7679. Column view (@pxref{Column view}) is normally used to view and edit
  7680. properties embedded in the hierarchical structure of an Org file. It can be
  7681. quite useful to use column view also from the agenda, where entries are
  7682. collected by certain criteria.
  7683. @table @kbd
  7684. @orgcmd{C-c C-x C-c,org-agenda-columns}
  7685. Turn on column view in the agenda.
  7686. @end table
  7687. To understand how to use this properly, it is important to realize that the
  7688. entries in the agenda are no longer in their proper outline environment.
  7689. This causes the following issues:
  7690. @enumerate
  7691. @item
  7692. @vindex org-columns-default-format
  7693. @vindex org-overriding-columns-format
  7694. Org needs to make a decision which @code{COLUMNS} format to use. Since the
  7695. entries in the agenda are collected from different files, and different files
  7696. may have different @code{COLUMNS} formats, this is a non-trivial problem.
  7697. Org first checks if the variable @code{org-agenda-overriding-columns-format} is
  7698. currently set, and if so, takes the format from there. Otherwise it takes
  7699. the format associated with the first item in the agenda, or, if that item
  7700. does not have a specific format (defined in a property, or in its file), it
  7701. uses @code{org-columns-default-format}.
  7702. @item
  7703. @cindex property, special, CLOCKSUM
  7704. If any of the columns has a summary type defined (@pxref{Column attributes}),
  7705. turning on column view in the agenda will visit all relevant agenda files and
  7706. make sure that the computations of this property are up to date. This is
  7707. also true for the special @code{CLOCKSUM} property. Org will then sum the
  7708. values displayed in the agenda. In the daily/weekly agenda, the sums will
  7709. cover a single day; in all other views they cover the entire block. It is
  7710. vital to realize that the agenda may show the same entry @emph{twice} (for
  7711. example as scheduled and as a deadline), and it may show two entries from the
  7712. same hierarchy (for example a @emph{parent} and its @emph{child}). In these
  7713. cases, the summation in the agenda will lead to incorrect results because
  7714. some values will count double.
  7715. @item
  7716. When the column view in the agenda shows the @code{CLOCKSUM}, that is always
  7717. the entire clocked time for this item. So even in the daily/weekly agenda,
  7718. the clocksum listed in column view may originate from times outside the
  7719. current view. This has the advantage that you can compare these values with
  7720. a column listing the planned total effort for a task---one of the major
  7721. applications for column view in the agenda. If you want information about
  7722. clocked time in the displayed period use clock table mode (press @kbd{R} in
  7723. the agenda).
  7724. @end enumerate
  7725. @node Markup, Exporting, Agenda Views, Top
  7726. @chapter Markup for rich export
  7727. When exporting Org mode documents, the exporter tries to reflect the
  7728. structure of the document as accurately as possible in the backend. Since
  7729. export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
  7730. Org mode has rules on how to prepare text for rich export. This section
  7731. summarizes the markup rules used in an Org mode buffer.
  7732. @menu
  7733. * Structural markup elements:: The basic structure as seen by the exporter
  7734. * Images and tables:: Tables and Images will be included
  7735. * Literal examples:: Source code examples with special formatting
  7736. * Include files:: Include additional files into a document
  7737. * Index entries:: Making an index
  7738. * Macro replacement:: Use macros to create complex output
  7739. * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
  7740. @end menu
  7741. @node Structural markup elements, Images and tables, Markup, Markup
  7742. @section Structural markup elements
  7743. @menu
  7744. * Document title:: Where the title is taken from
  7745. * Headings and sections:: The document structure as seen by the exporter
  7746. * Table of contents:: The if and where of the table of contents
  7747. * Initial text:: Text before the first heading?
  7748. * Lists:: Lists
  7749. * Paragraphs:: Paragraphs
  7750. * Footnote markup:: Footnotes
  7751. * Emphasis and monospace:: Bold, italic, etc.
  7752. * Horizontal rules:: Make a line
  7753. * Comment lines:: What will *not* be exported
  7754. @end menu
  7755. @node Document title, Headings and sections, Structural markup elements, Structural markup elements
  7756. @subheading Document title
  7757. @cindex document title, markup rules
  7758. @noindent
  7759. The title of the exported document is taken from the special line
  7760. @cindex #+TITLE
  7761. @example
  7762. #+TITLE: This is the title of the document
  7763. @end example
  7764. @noindent
  7765. If this line does not exist, the title is derived from the first non-empty,
  7766. non-comment line in the buffer. If no such line exists, or if you have
  7767. turned off exporting of the text before the first headline (see below), the
  7768. title will be the file name without extension.
  7769. @cindex property, EXPORT_TITLE
  7770. If you are exporting only a subtree by marking is as the region, the heading
  7771. of the subtree will become the title of the document. If the subtree has a
  7772. property @code{EXPORT_TITLE}, that will take precedence.
  7773. @node Headings and sections, Table of contents, Document title, Structural markup elements
  7774. @subheading Headings and sections
  7775. @cindex headings and sections, markup rules
  7776. @vindex org-export-headline-levels
  7777. The outline structure of the document as described in @ref{Document
  7778. Structure}, forms the basis for defining sections of the exported document.
  7779. However, since the outline structure is also used for (for example) lists of
  7780. tasks, only the first three outline levels will be used as headings. Deeper
  7781. levels will become itemized lists. You can change the location of this
  7782. switch globally by setting the variable @code{org-export-headline-levels}, or on a
  7783. per-file basis with a line
  7784. @cindex #+OPTIONS
  7785. @example
  7786. #+OPTIONS: H:4
  7787. @end example
  7788. @node Table of contents, Initial text, Headings and sections, Structural markup elements
  7789. @subheading Table of contents
  7790. @cindex table of contents, markup rules
  7791. @vindex org-export-with-toc
  7792. The table of contents is normally inserted directly before the first headline
  7793. of the file. If you would like to get it to a different location, insert the
  7794. string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
  7795. location. The depth of the table of contents is by default the same as the
  7796. number of headline levels, but you can choose a smaller number, or turn off
  7797. the table of contents entirely, by configuring the variable
  7798. @code{org-export-with-toc}, or on a per-file basis with a line like
  7799. @example
  7800. #+OPTIONS: toc:2 (only to two levels in TOC)
  7801. #+OPTIONS: toc:nil (no TOC at all)
  7802. @end example
  7803. @node Initial text, Lists, Table of contents, Structural markup elements
  7804. @subheading Text before the first headline
  7805. @cindex text before first headline, markup rules
  7806. @cindex #+TEXT
  7807. Org mode normally exports the text before the first headline, and even uses
  7808. the first line as the document title. The text will be fully marked up. If
  7809. you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
  7810. constructs described below in the sections for the individual exporters.
  7811. @vindex org-export-skip-text-before-1st-heading
  7812. Some people like to use the space before the first headline for setup and
  7813. internal links and therefore would like to control the exported text before
  7814. the first headline in a different way. You can do so by setting the variable
  7815. @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
  7816. basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
  7817. @noindent
  7818. If you still want to have some text before the first headline, use the
  7819. @code{#+TEXT} construct:
  7820. @example
  7821. #+OPTIONS: skip:t
  7822. #+TEXT: This text will go before the *first* headline.
  7823. #+TEXT: [TABLE-OF-CONTENTS]
  7824. #+TEXT: This goes between the table of contents and the *first* headline
  7825. @end example
  7826. @node Lists, Paragraphs, Initial text, Structural markup elements
  7827. @subheading Lists
  7828. @cindex lists, markup rules
  7829. Plain lists as described in @ref{Plain lists}, are translated to the backend's
  7830. syntax for such lists. Most backends support unordered, ordered, and
  7831. description lists.
  7832. @node Paragraphs, Footnote markup, Lists, Structural markup elements
  7833. @subheading Paragraphs, line breaks, and quoting
  7834. @cindex paragraphs, markup rules
  7835. Paragraphs are separated by at least one empty line. If you need to enforce
  7836. a line break within a paragraph, use @samp{\\} at the end of a line.
  7837. To keep the line breaks in a region, but otherwise use normal formatting, you
  7838. can use this construct, which can also be used to format poetry.
  7839. @cindex #+BEGIN_VERSE
  7840. @example
  7841. #+BEGIN_VERSE
  7842. Great clouds overhead
  7843. Tiny black birds rise and fall
  7844. Snow covers Emacs
  7845. -- AlexSchroeder
  7846. #+END_VERSE
  7847. @end example
  7848. When quoting a passage from another document, it is customary to format this
  7849. as a paragraph that is indented on both the left and the right margin. You
  7850. can include quotations in Org mode documents like this:
  7851. @cindex #+BEGIN_QUOTE
  7852. @example
  7853. #+BEGIN_QUOTE
  7854. Everything should be made as simple as possible,
  7855. but not any simpler -- Albert Einstein
  7856. #+END_QUOTE
  7857. @end example
  7858. If you would like to center some text, do it like this:
  7859. @cindex #+BEGIN_CENTER
  7860. @example
  7861. #+BEGIN_CENTER
  7862. Everything should be made as simple as possible, \\
  7863. but not any simpler
  7864. #+END_CENTER
  7865. @end example
  7866. @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
  7867. @subheading Footnote markup
  7868. @cindex footnotes, markup rules
  7869. @cindex @file{footnote.el}
  7870. Footnotes defined in the way described in @ref{Footnotes}, will be exported
  7871. by all backends. Org allows multiple references to the same note, and
  7872. multiple footnotes side by side.
  7873. @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
  7874. @subheading Emphasis and monospace
  7875. @cindex underlined text, markup rules
  7876. @cindex bold text, markup rules
  7877. @cindex italic text, markup rules
  7878. @cindex verbatim text, markup rules
  7879. @cindex code text, markup rules
  7880. @cindex strike-through text, markup rules
  7881. You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
  7882. and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
  7883. in the code and verbatim string is not processed for Org mode specific
  7884. syntax; it is exported verbatim.
  7885. @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
  7886. @subheading Horizontal rules
  7887. @cindex horizontal rules, markup rules
  7888. A line consisting of only dashes, and at least 5 of them, will be exported as
  7889. a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
  7890. @node Comment lines, , Horizontal rules, Structural markup elements
  7891. @subheading Comment lines
  7892. @cindex comment lines
  7893. @cindex exporting, not
  7894. @cindex #+BEGIN_COMMENT
  7895. Lines starting with @samp{#} in column zero are treated as comments and will
  7896. never be exported. If you want an indented line to be treated as a comment,
  7897. start it with @samp{#+ }. Also entire subtrees starting with the word
  7898. @samp{COMMENT} will never be exported. Finally, regions surrounded by
  7899. @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
  7900. @table @kbd
  7901. @kindex C-c ;
  7902. @item C-c ;
  7903. Toggle the COMMENT keyword at the beginning of an entry.
  7904. @end table
  7905. @node Images and tables, Literal examples, Structural markup elements, Markup
  7906. @section Images and Tables
  7907. @cindex tables, markup rules
  7908. @cindex #+CAPTION
  7909. @cindex #+LABEL
  7910. Both the native Org mode tables (@pxref{Tables}) and tables formatted with
  7911. the @file{table.el} package will be exported properly. For Org mode tables,
  7912. the lines before the first horizontal separator line will become table header
  7913. lines. You can use the following lines somewhere before the table to assign
  7914. a caption and a label for cross references, and in the text you can refer to
  7915. the object with @code{\ref@{tab:basic-data@}}:
  7916. @example
  7917. #+CAPTION: This is the caption for the next table (or link)
  7918. #+LABEL: tab:basic-data
  7919. | ... | ...|
  7920. |-----|----|
  7921. @end example
  7922. Optionally, the caption can take the form:
  7923. @example
  7924. #+CAPTION: [Caption for list of figures]@{Caption for table (or link).@}
  7925. @end example
  7926. @cindex inlined images, markup rules
  7927. Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
  7928. images into the exported document. Org does this, if a link to an image
  7929. files does not have a description part, for example @code{[[./img/a.jpg]]}.
  7930. If you wish to define a caption for the image and maybe a label for internal
  7931. cross references, make sure that the link is on a line by itself and precede
  7932. it with @code{#+CAPTION} and @code{#+LABEL} as follows:
  7933. @example
  7934. #+CAPTION: This is the caption for the next figure link (or table)
  7935. #+LABEL: fig:SED-HR4049
  7936. [[./img/a.jpg]]
  7937. @end example
  7938. You may also define additional attributes for the figure. As this is
  7939. backend-specific, see the sections about the individual backends for more
  7940. information.
  7941. @xref{Handling links,the discussion of image links}.
  7942. @node Literal examples, Include files, Images and tables, Markup
  7943. @section Literal examples
  7944. @cindex literal examples, markup rules
  7945. @cindex code line references, markup rules
  7946. You can include literal examples that should not be subjected to
  7947. markup. Such examples will be typeset in monospace, so this is well suited
  7948. for source code and similar examples.
  7949. @cindex #+BEGIN_EXAMPLE
  7950. @example
  7951. #+BEGIN_EXAMPLE
  7952. Some example from a text file.
  7953. #+END_EXAMPLE
  7954. @end example
  7955. Note that such blocks may be @i{indented} in order to align nicely with
  7956. indented text and in particular with plain list structure (@pxref{Plain
  7957. lists}). For simplicity when using small examples, you can also start the
  7958. example lines with a colon followed by a space. There may also be additional
  7959. whitespace before the colon:
  7960. @example
  7961. Here is an example
  7962. : Some example from a text file.
  7963. @end example
  7964. @cindex formatting source code, markup rules
  7965. If the example is source code from a programming language, or any other text
  7966. that can be marked up by font-lock in Emacs, you can ask for the example to
  7967. look like the fontified Emacs buffer@footnote{This works automatically for
  7968. the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
  7969. which is distributed with Org). Fontified code chunks in @LaTeX{} can be
  7970. achieved using either the listings or the
  7971. @url{http://code.google.com/p/minted, minted,} package. To use listings, turn
  7972. on the variable @code{org-export-latex-listings} and ensure that the listings
  7973. package is included by the @LaTeX{} header (e.g.@: by configuring
  7974. @code{org-export-latex-packages-alist}). See the listings documentation for
  7975. configuration options, including obtaining colored output. For minted it is
  7976. necessary to install the program @url{http://pygments.org, pygments}, in
  7977. addition to setting @code{org-export-latex-minted}, ensuring that the minted
  7978. package is included by the @LaTeX{} header, and ensuring that the
  7979. @code{-shell-escape} option is passed to @file{pdflatex} (see
  7980. @code{org-latex-to-pdf-process}). See the documentation of the variables
  7981. @code{org-export-latex-listings} and @code{org-export-latex-minted} for
  7982. further details.}. This is done with the @samp{src} block, where you also
  7983. need to specify the name of the major mode that should be used to fontify the
  7984. example@footnote{Code in @samp{src} blocks may also be evaluated either
  7985. interactively or on export. See @pxref{Working With Source Code} for more
  7986. information on evaluating code blocks.}, see @ref{Easy Templates} for
  7987. shortcuts to easily insert code blocks.
  7988. @cindex #+BEGIN_SRC
  7989. @example
  7990. #+BEGIN_SRC emacs-lisp
  7991. (defun org-xor (a b)
  7992. "Exclusive or."
  7993. (if a (not b) b))
  7994. #+END_SRC
  7995. @end example
  7996. Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
  7997. switch to the end of the @code{BEGIN} line, to get the lines of the example
  7998. numbered. If you use a @code{+n} switch, the numbering from the previous
  7999. numbered snippet will be continued in the current one. In literal examples,
  8000. Org will interpret strings like @samp{(ref:name)} as labels, and use them as
  8001. targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name
  8002. enclosed in single parenthesis). In HTML, hovering the mouse over such a
  8003. link will remote-highlight the corresponding code line, which is kind of
  8004. cool.
  8005. You can also add a @code{-r} switch which @i{removes} the labels from the
  8006. source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
  8007. labels in the source code while using line numbers for the links, which might
  8008. be useful to explain those in an Org mode example code.}. With the @code{-n}
  8009. switch, links to these references will be labeled by the line numbers from
  8010. the code listing, otherwise links will use the labels with no parentheses.
  8011. Here is an example:
  8012. @example
  8013. #+BEGIN_SRC emacs-lisp -n -r
  8014. (save-excursion (ref:sc)
  8015. (goto-char (point-min)) (ref:jump)
  8016. #+END_SRC
  8017. In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
  8018. jumps to point-min.
  8019. @end example
  8020. @vindex org-coderef-label-format
  8021. If the syntax for the label format conflicts with the language syntax, use a
  8022. @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
  8023. -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
  8024. HTML export also allows examples to be published as text areas (@pxref{Text
  8025. areas in HTML export}).
  8026. Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
  8027. so often, shortcuts are provided using the Easy Templates facility
  8028. (@pxref{Easy Templates}).
  8029. @table @kbd
  8030. @kindex C-c '
  8031. @item C-c '
  8032. Edit the source code example at point in its native mode. This works by
  8033. switching to a temporary buffer with the source code. You need to exit by
  8034. pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
  8035. or @samp{#} will get a comma prepended, to keep them from being interpreted
  8036. by Org as outline nodes or special comments. These commas will be stripped
  8037. for editing with @kbd{C-c '}, and also for export.}. The edited version will
  8038. then replace the old version in the Org buffer. Fixed-width regions
  8039. (where each line starts with a colon followed by a space) will be edited
  8040. using @code{artist-mode}@footnote{You may select a different-mode with the
  8041. variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
  8042. drawings easily. Using this command in an empty line will create a new
  8043. fixed-width region.
  8044. @kindex C-c l
  8045. @item C-c l
  8046. Calling @code{org-store-link} while editing a source code example in a
  8047. temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
  8048. that it is unique in the current buffer, and insert it with the proper
  8049. formatting like @samp{(ref:label)} at the end of the current line. Then the
  8050. label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
  8051. @end table
  8052. @node Include files, Index entries, Literal examples, Markup
  8053. @section Include files
  8054. @cindex include files, markup rules
  8055. During export, you can include the content of another file. For example, to
  8056. include your @file{.emacs} file, you could use:
  8057. @cindex #+INCLUDE
  8058. @example
  8059. #+INCLUDE: "~/.emacs" src emacs-lisp
  8060. @end example
  8061. @noindent
  8062. The optional second and third parameter are the markup (e.g.@: @samp{quote},
  8063. @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
  8064. language for formatting the contents. The markup is optional; if it is not
  8065. given, the text will be assumed to be in Org mode format and will be
  8066. processed normally. The include line will also allow additional keyword
  8067. parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
  8068. first line and for each following line, @code{:minlevel} in order to get
  8069. Org mode content demoted to a specified level, as well as any options
  8070. accepted by the selected markup. For example, to include a file as an item,
  8071. use
  8072. @example
  8073. #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
  8074. @end example
  8075. You can also include a portion of a file by specifying a lines range using
  8076. the @code{:lines} parameter. The line at the upper end of the range will not
  8077. be included. The start and/or the end of the range may be omitted to use the
  8078. obvious defaults.
  8079. @example
  8080. #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
  8081. #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
  8082. #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
  8083. @end example
  8084. @table @kbd
  8085. @kindex C-c '
  8086. @item C-c '
  8087. Visit the include file at point.
  8088. @end table
  8089. @node Index entries, Macro replacement, Include files, Markup
  8090. @section Index entries
  8091. @cindex index entries, for publishing
  8092. You can specify entries that will be used for generating an index during
  8093. publishing. This is done by lines starting with @code{#+INDEX}. An entry
  8094. the contains an exclamation mark will create a sub item. See @ref{Generating
  8095. an index} for more information.
  8096. @example
  8097. * Curriculum Vitae
  8098. #+INDEX: CV
  8099. #+INDEX: Application!CV
  8100. @end example
  8101. @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
  8102. @section Macro replacement
  8103. @cindex macro replacement, during export
  8104. @cindex #+MACRO
  8105. You can define text snippets with
  8106. @example
  8107. #+MACRO: name replacement text $1, $2 are arguments
  8108. @end example
  8109. @noindent which can be referenced anywhere in the document (even in
  8110. code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
  8111. defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
  8112. will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
  8113. similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
  8114. @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
  8115. and to the modification time of the file being exported, respectively.
  8116. @var{FORMAT} should be a format string understood by
  8117. @code{format-time-string}.
  8118. Macro expansion takes place during export, and some people use it to
  8119. construct complex HTML code.
  8120. @node Embedded @LaTeX{}, , Macro replacement, Markup
  8121. @section Embedded @LaTeX{}
  8122. @cindex @TeX{} interpretation
  8123. @cindex @LaTeX{} interpretation
  8124. Plain ASCII is normally sufficient for almost all note taking. Exceptions
  8125. include scientific notes, which often require mathematical symbols and the
  8126. occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
  8127. Donald E. Knuth's @TeX{} system. Many of the features described here as
  8128. ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
  8129. distinction.} is widely used to typeset scientific documents. Org mode
  8130. supports embedding @LaTeX{} code into its files, because many academics are
  8131. used to writing and reading @LaTeX{} source code, and because it can be
  8132. readily processed to produce pretty output for a number of export backends.
  8133. @menu
  8134. * Special symbols:: Greek letters and other symbols
  8135. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  8136. * @LaTeX{} fragments:: Complex formulas made easy
  8137. * Previewing @LaTeX{} fragments:: What will this snippet look like?
  8138. * CDLaTeX mode:: Speed up entering of formulas
  8139. @end menu
  8140. @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
  8141. @subsection Special symbols
  8142. @cindex math symbols
  8143. @cindex special symbols
  8144. @cindex @TeX{} macros
  8145. @cindex @LaTeX{} fragments, markup rules
  8146. @cindex HTML entities
  8147. @cindex @LaTeX{} entities
  8148. You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
  8149. indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
  8150. for these macros is available, just type @samp{\} and maybe a few letters,
  8151. and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
  8152. code, Org mode allows these macros to be present without surrounding math
  8153. delimiters, for example:
  8154. @example
  8155. Angles are written as Greek letters \alpha, \beta and \gamma.
  8156. @end example
  8157. @vindex org-entities
  8158. During export, these symbols will be transformed into the native format of
  8159. the exporter backend. Strings like @code{\alpha} will be exported as
  8160. @code{&alpha;} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
  8161. output. Similarly, @code{\nbsp} will become @code{&nbsp;} in HTML and
  8162. @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
  8163. like this: @samp{\Aacute@{@}stor}.
  8164. A large number of entities is provided, with names taken from both HTML and
  8165. @LaTeX{}; see the variable @code{org-entities} for the complete list.
  8166. @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
  8167. @samp{...} are all converted into special commands creating hyphens of
  8168. different lengths or a compact set of dots.
  8169. If you would like to see entities displayed as UTF8 characters, use the
  8170. following command@footnote{You can turn this on by default by setting the
  8171. variable @code{org-pretty-entities}, or on a per-file base with the
  8172. @code{#+STARTUP} option @code{entitiespretty}.}:
  8173. @table @kbd
  8174. @kindex C-c C-x \
  8175. @item C-c C-x \
  8176. Toggle display of entities as UTF-8 characters. This does not change the
  8177. buffer content which remains plain ASCII, but it overlays the UTF-8 character
  8178. for display purposes only.
  8179. @end table
  8180. @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
  8181. @subsection Subscripts and superscripts
  8182. @cindex subscript
  8183. @cindex superscript
  8184. Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
  8185. and subscripts. Again, these can be used without embedding them in
  8186. math-mode delimiters. To increase the readability of ASCII text, it is
  8187. not necessary (but OK) to surround multi-character sub- and superscripts
  8188. with curly braces. For example
  8189. @example
  8190. The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
  8191. the sun is R_@{sun@} = 6.96 x 10^8 m.
  8192. @end example
  8193. @vindex org-export-with-sub-superscripts
  8194. To avoid interpretation as raised or lowered text, you can quote @samp{^} and
  8195. @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
  8196. where the underscore is often used in a different context, Org's convention
  8197. to always interpret these as subscripts can get in your way. Configure the
  8198. variable @code{org-export-with-sub-superscripts} to globally change this
  8199. convention, or use, on a per-file basis:
  8200. @example
  8201. #+OPTIONS: ^:@{@}
  8202. @end example
  8203. @noindent With this setting, @samp{a_b} will not be interpreted as a
  8204. subscript, but @samp{a_@{b@}} will.
  8205. @table @kbd
  8206. @kindex C-c C-x \
  8207. @item C-c C-x \
  8208. In addition to showing entities as UTF-8 characters, this command will also
  8209. format sub- and superscripts in a WYSIWYM way.
  8210. @end table
  8211. @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
  8212. @subsection @LaTeX{} fragments
  8213. @cindex @LaTeX{} fragments
  8214. @vindex org-format-latex-header
  8215. Going beyond symbols and sub- and superscripts, a full formula language is
  8216. needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
  8217. to process these for several export backends. When exporting to @LaTeX{},
  8218. the code is obviously left as it is. When exporting to HTML, Org invokes the
  8219. @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
  8220. HTML export}) to process and display the math@footnote{If you plan to use
  8221. this regularly or on pages with significant page views, you should install
  8222. @file{MathJax} on your own
  8223. server in order to limit the load of our server.}. Finally, it can also
  8224. process the mathematical expressions into images@footnote{For this to work
  8225. you need to be on a system with a working @LaTeX{} installation. You also
  8226. need the @file{dvipng} program, available at
  8227. @url{http://sourceforge.net/projects/dvipng/}. The @LaTeX{} header that will
  8228. be used when processing a fragment can be configured with the variable
  8229. @code{org-format-latex-header}.} that can be displayed in a browser or in
  8230. DocBook documents.
  8231. @LaTeX{} fragments don't need any special marking at all. The following
  8232. snippets will be identified as @LaTeX{} source code:
  8233. @itemize @bullet
  8234. @item
  8235. Environments of any kind@footnote{When @file{MathJax} is used, only the
  8236. environment recognized by @file{MathJax} will be processed. When
  8237. @file{dvipng} is used to create images, any @LaTeX{} environments will be
  8238. handled.}. The only requirement is that the @code{\begin} statement appears
  8239. on a new line, preceded by only whitespace.
  8240. @item
  8241. Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
  8242. currency specifications, single @samp{$} characters are only recognized as
  8243. math delimiters if the enclosed text contains at most two line breaks, is
  8244. directly attached to the @samp{$} characters with no whitespace in between,
  8245. and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
  8246. For the other delimiters, there is no such restriction, so when in doubt, use
  8247. @samp{\(...\)} as inline math delimiters.
  8248. @end itemize
  8249. @noindent For example:
  8250. @example
  8251. \begin@{equation@} % arbitrary environments,
  8252. x=\sqrt@{b@} % even tables, figures
  8253. \end@{equation@} % etc
  8254. If $a^2=b$ and \( b=2 \), then the solution must be
  8255. either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
  8256. @end example
  8257. @noindent
  8258. @vindex org-format-latex-options
  8259. If you need any of the delimiter ASCII sequences for other purposes, you
  8260. can configure the option @code{org-format-latex-options} to deselect the
  8261. ones you do not wish to have interpreted by the @LaTeX{} converter.
  8262. @vindex org-export-with-LaTeX-fragments
  8263. @LaTeX{} processing can be configured with the variable
  8264. @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
  8265. which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
  8266. @LaTeX{} backends. You can also set this variable on a per-file basis using one
  8267. of these lines:
  8268. @example
  8269. #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
  8270. #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
  8271. #+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
  8272. #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
  8273. @end example
  8274. @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
  8275. @subsection Previewing @LaTeX{} fragments
  8276. @cindex @LaTeX{} fragments, preview
  8277. If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
  8278. produce preview images of the typeset expressions:
  8279. @table @kbd
  8280. @kindex C-c C-x C-l
  8281. @item C-c C-x C-l
  8282. Produce a preview image of the @LaTeX{} fragment at point and overlay it
  8283. over the source code. If there is no fragment at point, process all
  8284. fragments in the current entry (between two headlines). When called
  8285. with a prefix argument, process the entire subtree. When called with
  8286. two prefix arguments, or when the cursor is before the first headline,
  8287. process the entire buffer.
  8288. @kindex C-c C-c
  8289. @item C-c C-c
  8290. Remove the overlay preview images.
  8291. @end table
  8292. @vindex org-format-latex-options
  8293. You can customize the variable @code{org-format-latex-options} to influence
  8294. some aspects of the preview. In particular, the @code{:scale} (and for HTML
  8295. export, @code{:html-scale}) property can be used to adjust the size of the
  8296. preview images.
  8297. @node CDLaTeX mode, , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
  8298. @subsection Using CD@LaTeX{} to enter math
  8299. @cindex CD@LaTeX{}
  8300. CD@LaTeX{} mode is a minor mode that is normally used in combination with a
  8301. major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
  8302. environments and math templates. Inside Org mode, you can make use of
  8303. some of the features of CD@LaTeX{} mode. You need to install
  8304. @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
  8305. AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
  8306. Don't use CD@LaTeX{} mode itself under Org mode, but use the light
  8307. version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
  8308. on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
  8309. Org files with
  8310. @lisp
  8311. (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
  8312. @end lisp
  8313. When this mode is enabled, the following features are present (for more
  8314. details see the documentation of CD@LaTeX{} mode):
  8315. @itemize @bullet
  8316. @kindex C-c @{
  8317. @item
  8318. Environment templates can be inserted with @kbd{C-c @{}.
  8319. @item
  8320. @kindex @key{TAB}
  8321. The @key{TAB} key will do template expansion if the cursor is inside a
  8322. @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
  8323. inside such a fragment, see the documentation of the function
  8324. @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
  8325. expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
  8326. correctly inside the first brace. Another @key{TAB} will get you into
  8327. the second brace. Even outside fragments, @key{TAB} will expand
  8328. environment abbreviations at the beginning of a line. For example, if
  8329. you write @samp{equ} at the beginning of a line and press @key{TAB},
  8330. this abbreviation will be expanded to an @code{equation} environment.
  8331. To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
  8332. @item
  8333. @kindex _
  8334. @kindex ^
  8335. @vindex cdlatex-simplify-sub-super-scripts
  8336. Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
  8337. characters together with a pair of braces. If you use @key{TAB} to move
  8338. out of the braces, and if the braces surround only a single character or
  8339. macro, they are removed again (depending on the variable
  8340. @code{cdlatex-simplify-sub-super-scripts}).
  8341. @item
  8342. @kindex `
  8343. Pressing the backquote @kbd{`} followed by a character inserts math
  8344. macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
  8345. after the backquote, a help window will pop up.
  8346. @item
  8347. @kindex '
  8348. Pressing the single-quote @kbd{'} followed by another character modifies
  8349. the symbol before point with an accent or a font. If you wait more than
  8350. 1.5 seconds after the single-quote, a help window will pop up. Character
  8351. modification will work only inside @LaTeX{} fragments; outside the quote
  8352. is normal.
  8353. @end itemize
  8354. @node Exporting, Publishing, Markup, Top
  8355. @chapter Exporting
  8356. @cindex exporting
  8357. Org mode documents can be exported into a variety of other formats. For
  8358. printing and sharing of notes, ASCII export produces a readable and simple
  8359. version of an Org file. HTML export allows you to publish a notes file on
  8360. the web, while the XOXO format provides a solid base for exchange with a
  8361. broad range of other applications. @LaTeX{} export lets you use Org mode and
  8362. its structured editing functions to easily create @LaTeX{} files. DocBook
  8363. export makes it possible to convert Org files to many other formats using
  8364. DocBook tools. OpenDocument Text(@acronym{ODT}) export allows seamless
  8365. collaboration across organizational boundaries. For project management you
  8366. can create gantt and resource charts by using TaskJuggler export. To
  8367. incorporate entries with associated times like deadlines or appointments into
  8368. a desktop calendar program like iCal, Org mode can also produce extracts in
  8369. the iCalendar format. Currently Org mode only supports export, not import of
  8370. these different formats.
  8371. Org supports export of selected regions when @code{transient-mark-mode} is
  8372. enabled (default in Emacs 23).
  8373. @menu
  8374. * Selective export:: Using tags to select and exclude trees
  8375. * Export options:: Per-file export settings
  8376. * The export dispatcher:: How to access exporter commands
  8377. * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
  8378. * HTML export:: Exporting to HTML
  8379. * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
  8380. * DocBook export:: Exporting to DocBook
  8381. * OpenDocument Text export:: Exporting to OpenDocument Text
  8382. * TaskJuggler export:: Exporting to TaskJuggler
  8383. * Freemind export:: Exporting to Freemind mind maps
  8384. * XOXO export:: Exporting to XOXO
  8385. * iCalendar export:: Exporting in iCalendar format
  8386. @end menu
  8387. @node Selective export, Export options, Exporting, Exporting
  8388. @section Selective export
  8389. @cindex export, selective by tags or TODO keyword
  8390. @vindex org-export-select-tags
  8391. @vindex org-export-exclude-tags
  8392. @cindex org-export-with-tasks
  8393. You may use tags to select the parts of a document that should be exported,
  8394. or to exclude parts from export. This behavior is governed by two variables:
  8395. @code{org-export-select-tags} and @code{org-export-exclude-tags},
  8396. respectively defaulting to @code{'(:export:)} and @code{'(:noexport:)}.
  8397. @enumerate
  8398. @item
  8399. Org first checks if any of the @emph{select} tags is present in the
  8400. buffer. If yes, all trees that do not carry one of these tags will be
  8401. excluded. If a selected tree is a subtree, the heading hierarchy above it
  8402. will also be selected for export, but not the text below those headings.
  8403. @item
  8404. If none of the select tags is found, the whole buffer will be selected for
  8405. export.
  8406. @item
  8407. Finally, all subtrees that are marked by any of the @emph{exclude} tags will
  8408. be removed from the export buffer.
  8409. @end enumerate
  8410. The variable @code{org-export-with-tasks} can be configured to select which
  8411. kind of tasks should be included for export. See the docstring of the
  8412. variable for more information.
  8413. @node Export options, The export dispatcher, Selective export, Exporting
  8414. @section Export options
  8415. @cindex options, for export
  8416. @cindex completion, of option keywords
  8417. The exporter recognizes special lines in the buffer which provide
  8418. additional information. These lines may be put anywhere in the file.
  8419. The whole set of lines can be inserted into the buffer with @kbd{C-c
  8420. C-e t}. For individual lines, a good way to make sure the keyword is
  8421. correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
  8422. (@pxref{Completion}). For a summary of other in-buffer settings not
  8423. specifically related to export, see @ref{In-buffer settings}.
  8424. In particular, note that you can place commonly-used (export) options in
  8425. a separate file which can be included using @code{#+SETUPFILE}.
  8426. @table @kbd
  8427. @orgcmd{C-c C-e t,org-insert-export-options-template}
  8428. Insert template with export options, see example below.
  8429. @end table
  8430. @cindex #+TITLE
  8431. @cindex #+AUTHOR
  8432. @cindex #+DATE
  8433. @cindex #+EMAIL
  8434. @cindex #+DESCRIPTION
  8435. @cindex #+KEYWORDS
  8436. @cindex #+LANGUAGE
  8437. @cindex #+TEXT
  8438. @cindex #+OPTIONS
  8439. @cindex #+BIND
  8440. @cindex #+LINK_UP
  8441. @cindex #+LINK_HOME
  8442. @cindex #+EXPORT_SELECT_TAGS
  8443. @cindex #+EXPORT_EXCLUDE_TAGS
  8444. @cindex #+XSLT
  8445. @cindex #+LaTeX_HEADER
  8446. @vindex user-full-name
  8447. @vindex user-mail-address
  8448. @vindex org-export-default-language
  8449. @vindex org-export-date-timestamp-format
  8450. @example
  8451. #+TITLE: the title to be shown (default is the buffer name)
  8452. #+AUTHOR: the author (default taken from @code{user-full-name})
  8453. #+DATE: a date, an Org timestamp@footnote{@code{org-export-date-timestamp-format} defines how this timestamp will be exported.}, or a format string for @code{format-time-string}
  8454. #+EMAIL: his/her email address (default from @code{user-mail-address})
  8455. #+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
  8456. #+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag
  8457. #+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
  8458. #+TEXT: Some descriptive text to be inserted at the beginning.
  8459. #+TEXT: Several lines may be given.
  8460. #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
  8461. #+BIND: lisp-var lisp-val, e.g.@:: @code{org-export-latex-low-levels itemize}
  8462. @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
  8463. #+LINK_UP: the ``up'' link of an exported page
  8464. #+LINK_HOME: the ``home'' link of an exported page
  8465. #+LaTeX_HEADER: extra line(s) for the @LaTeX{} header, like \usepackage@{xyz@}
  8466. #+EXPORT_SELECT_TAGS: Tags that select a tree for export
  8467. #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
  8468. #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
  8469. @end example
  8470. @noindent
  8471. The @code{#+OPTIONS} line is a compact@footnote{If you want to configure many options
  8472. this way, you can use several @code{#+OPTIONS} lines.} form to specify export
  8473. settings. Here you can:
  8474. @cindex headline levels
  8475. @cindex section-numbers
  8476. @cindex table of contents
  8477. @cindex line-break preservation
  8478. @cindex quoted HTML tags
  8479. @cindex fixed-width sections
  8480. @cindex tables
  8481. @cindex @TeX{}-like syntax for sub- and superscripts
  8482. @cindex footnotes
  8483. @cindex special strings
  8484. @cindex emphasized text
  8485. @cindex @TeX{} macros
  8486. @cindex @LaTeX{} fragments
  8487. @cindex author info, in export
  8488. @cindex time info, in export
  8489. @vindex org-export-plist-vars
  8490. @vindex org-export-author-info
  8491. @vindex org-export-creator-info
  8492. @vindex org-export-email-info
  8493. @vindex org-export-time-stamp-file
  8494. @example
  8495. H: @r{set the number of headline levels for export}
  8496. num: @r{turn on/off section-numbers}
  8497. toc: @r{turn on/off table of contents, or set level limit (integer)}
  8498. \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
  8499. @@: @r{turn on/off quoted HTML tags}
  8500. :: @r{turn on/off fixed-width sections}
  8501. |: @r{turn on/off tables}
  8502. ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
  8503. @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
  8504. @r{the simple @code{a_b} will be left as it is.}
  8505. -: @r{turn on/off conversion of special strings.}
  8506. f: @r{turn on/off footnotes like this[1].}
  8507. todo: @r{turn on/off inclusion of TODO keywords into exported text}
  8508. tasks: @r{turn on/off inclusion of tasks (TODO items), can be nil to remove}
  8509. @r{all tasks, @code{todo} to remove DONE tasks, or list of kwds to keep}
  8510. pri: @r{turn on/off priority cookies}
  8511. tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
  8512. <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
  8513. *: @r{turn on/off emphasized text (bold, italic, underlined)}
  8514. TeX: @r{turn on/off simple @TeX{} macros in plain text}
  8515. LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
  8516. skip: @r{turn on/off skipping the text before the first heading}
  8517. author: @r{turn on/off inclusion of author name/email into exported file}
  8518. email: @r{turn on/off inclusion of author email into exported file}
  8519. creator: @r{turn on/off inclusion of creator info into exported file}
  8520. timestamp: @r{turn on/off inclusion creation time into exported file}
  8521. d: @r{turn on/off inclusion of drawers}
  8522. @end example
  8523. @noindent
  8524. These options take effect in both the HTML and @LaTeX{} export, except for
  8525. @code{TeX} and @code{LaTeX} options, which are respectively @code{t} and
  8526. @code{nil} for the @LaTeX{} export.
  8527. The default values for these and many other options are given by a set of
  8528. variables. For a list of such variables, the corresponding OPTIONS keys and
  8529. also the publishing keys (@pxref{Project alist}), see the constant
  8530. @code{org-export-plist-vars}.
  8531. When exporting only a single subtree by selecting it with @kbd{C-c @@} before
  8532. calling an export command, the subtree can overrule some of the file's export
  8533. settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
  8534. @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
  8535. @code{EXPORT_OPTIONS}.
  8536. @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
  8537. @section The export dispatcher
  8538. @cindex dispatcher, for export commands
  8539. All export commands can be reached using the export dispatcher, which is a
  8540. prefix key that prompts for an additional key specifying the command.
  8541. Normally the entire file is exported, but if there is an active region that
  8542. contains one outline tree, the first heading is used as document title and
  8543. the subtrees are exported.
  8544. @table @kbd
  8545. @orgcmd{C-c C-e,org-export}
  8546. @vindex org-export-run-in-background
  8547. Dispatcher for export and publishing commands. Displays a help-window
  8548. listing the additional key(s) needed to launch an export or publishing
  8549. command. The prefix arg is passed through to the exporter. A double prefix
  8550. @kbd{C-u C-u} causes most commands to be executed in the background, in a
  8551. separate Emacs process@footnote{To make this behavior the default, customize
  8552. the variable @code{org-export-run-in-background}.}.
  8553. @orgcmd{C-c C-e v,org-export-visible}
  8554. Like @kbd{C-c C-e}, but only export the text that is currently visible
  8555. (i.e.@: not hidden by outline visibility).
  8556. @orgcmd{C-u C-u C-c C-e,org-export}
  8557. @vindex org-export-run-in-background
  8558. Call the exporter, but reverse the setting of
  8559. @code{org-export-run-in-background}, i.e.@: request background processing if
  8560. not set, or force processing in the current Emacs process if set.
  8561. @end table
  8562. @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
  8563. @section ASCII/Latin-1/UTF-8 export
  8564. @cindex ASCII export
  8565. @cindex Latin-1 export
  8566. @cindex UTF-8 export
  8567. ASCII export produces a simple and very readable version of an Org mode
  8568. file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
  8569. with special characters and symbols available in these encodings.
  8570. @cindex region, active
  8571. @cindex active region
  8572. @cindex transient-mark-mode
  8573. @table @kbd
  8574. @orgcmd{C-c C-e a,org-export-as-ascii}
  8575. @cindex property, EXPORT_FILE_NAME
  8576. Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
  8577. will be @file{myfile.txt}. The file will be overwritten without
  8578. warning. If there is an active region@footnote{This requires
  8579. @code{transient-mark-mode} be turned on.}, only the region will be
  8580. exported. If the selected region is a single tree@footnote{To select the
  8581. current subtree, use @kbd{C-c @@}.}, the tree head will
  8582. become the document title. If the tree head entry has or inherits an
  8583. @code{EXPORT_FILE_NAME} property, that name will be used for the
  8584. export.
  8585. @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
  8586. Export to a temporary buffer. Do not create a file.
  8587. @orgcmd{C-c C-e n,org-export-as-latin1}
  8588. @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
  8589. Like the above commands, but use Latin-1 encoding.
  8590. @orgcmd{C-c C-e u,org-export-as-utf8}
  8591. @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
  8592. Like the above commands, but use UTF-8 encoding.
  8593. @item C-c C-e v a/n/u
  8594. Export only the visible part of the document.
  8595. @end table
  8596. @cindex headline levels, for exporting
  8597. In the exported version, the first 3 outline levels will become
  8598. headlines, defining a general document structure. Additional levels
  8599. will be exported as itemized lists. If you want that transition to occur
  8600. at a different level, specify it with a prefix argument. For example,
  8601. @example
  8602. @kbd{C-1 C-c C-e a}
  8603. @end example
  8604. @noindent
  8605. creates only top level headlines and does the rest as items. When
  8606. headlines are converted to items, the indentation of the text following
  8607. the headline is changed to fit nicely under the item. This is done with
  8608. the assumption that the first body line indicates the base indentation of
  8609. the body text. Any indentation larger than this is adjusted to preserve
  8610. the layout relative to the first line. Should there be lines with less
  8611. indentation than the first, these are left alone.
  8612. @vindex org-export-ascii-links-to-notes
  8613. Links will be exported in a footnote-like style, with the descriptive part in
  8614. the text and the link in a note before the next heading. See the variable
  8615. @code{org-export-ascii-links-to-notes} for details and other options.
  8616. @node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
  8617. @section HTML export
  8618. @cindex HTML export
  8619. Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
  8620. HTML formatting, in ways similar to John Gruber's @emph{markdown}
  8621. language, but with additional support for tables.
  8622. @menu
  8623. * HTML Export commands:: How to invoke HTML export
  8624. * HTML preamble and postamble:: How to insert a preamble and a postamble
  8625. * Quoting HTML tags:: Using direct HTML in Org mode
  8626. * Links in HTML export:: How links will be interpreted and formatted
  8627. * Tables in HTML export:: How to modify the formatting of tables
  8628. * Images in HTML export:: How to insert figures into HTML output
  8629. * Math formatting in HTML export:: Beautiful math also on the web
  8630. * Text areas in HTML export:: An alternative way to show an example
  8631. * CSS support:: Changing the appearance of the output
  8632. * JavaScript support:: Info and Folding in a web browser
  8633. @end menu
  8634. @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
  8635. @subsection HTML export commands
  8636. @cindex region, active
  8637. @cindex active region
  8638. @cindex transient-mark-mode
  8639. @table @kbd
  8640. @orgcmd{C-c C-e h,org-export-as-html}
  8641. @cindex property, EXPORT_FILE_NAME
  8642. Export as HTML file. For an Org file @file{myfile.org},
  8643. the HTML file will be @file{myfile.html}. The file will be overwritten
  8644. without warning. If there is an active region@footnote{This requires
  8645. @code{transient-mark-mode} be turned on.}, only the region will be
  8646. exported. If the selected region is a single tree@footnote{To select the
  8647. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  8648. title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
  8649. property, that name will be used for the export.
  8650. @orgcmd{C-c C-e b,org-export-as-html-and-open}
  8651. Export as HTML file and immediately open it with a browser.
  8652. @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
  8653. Export to a temporary buffer. Do not create a file.
  8654. @orgcmd{C-c C-e R,org-export-region-as-html}
  8655. Export the active region to a temporary buffer. With a prefix argument, do
  8656. not produce the file header and footer, but just the plain HTML section for
  8657. the region. This is good for cut-and-paste operations.
  8658. @item C-c C-e v h/b/H/R
  8659. Export only the visible part of the document.
  8660. @item M-x org-export-region-as-html
  8661. Convert the region to HTML under the assumption that it was Org mode
  8662. syntax before. This is a global command that can be invoked in any
  8663. buffer.
  8664. @item M-x org-replace-region-by-HTML
  8665. Replace the active region (assumed to be in Org mode syntax) by HTML
  8666. code.
  8667. @end table
  8668. @cindex headline levels, for exporting
  8669. In the exported version, the first 3 outline levels will become headlines,
  8670. defining a general document structure. Additional levels will be exported as
  8671. itemized lists. If you want that transition to occur at a different level,
  8672. specify it with a numeric prefix argument. For example,
  8673. @example
  8674. @kbd{C-2 C-c C-e b}
  8675. @end example
  8676. @noindent
  8677. creates two levels of headings and does the rest as items.
  8678. @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
  8679. @subsection HTML preamble and postamble
  8680. @vindex org-export-html-preamble
  8681. @vindex org-export-html-postamble
  8682. @vindex org-export-html-preamble-format
  8683. @vindex org-export-html-postamble-format
  8684. @vindex org-export-html-validation-link
  8685. @vindex org-export-author-info
  8686. @vindex org-export-email-info
  8687. @vindex org-export-creator-info
  8688. @vindex org-export-time-stamp-file
  8689. The HTML exporter lets you define a preamble and a postamble.
  8690. The default value for @code{org-export-html-preamble} is @code{t}, which
  8691. means that the preamble is inserted depending on the relevant formatting
  8692. string in @code{org-export-html-preamble-format}.
  8693. Setting @code{org-export-html-preamble} to a string will override the default
  8694. formatting string. Setting it to a function, will insert the output of the
  8695. function, which must be a string; such a function takes no argument but you
  8696. can check against the value of @code{opt-plist}, which contains the list of
  8697. publishing properties for the current file. Setting to @code{nil} will not
  8698. insert any preamble.
  8699. The default value for @code{org-export-html-postamble} is @code{'auto}, which
  8700. means that the HTML exporter will look for the value of
  8701. @code{org-export-author-info}, @code{org-export-email-info},
  8702. @code{org-export-creator-info} and @code{org-export-time-stamp-file},
  8703. @code{org-export-html-validation-link} and build the postamble from these
  8704. values. Setting @code{org-export-html-postamble} to @code{t} will insert the
  8705. postamble from the relevant formatting string found in
  8706. @code{org-export-html-postamble-format}. Setting it to @code{nil} will not
  8707. insert any postamble.
  8708. @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
  8709. @subsection Quoting HTML tags
  8710. Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
  8711. @samp{&gt;} in HTML export. If you want to include simple HTML tags
  8712. which should be interpreted as such, mark them with @samp{@@} as in
  8713. @samp{@@<b>bold text@@</b>}. Note that this really works only for
  8714. simple tags. For more extensive HTML that should be copied verbatim to
  8715. the exported file use either
  8716. @cindex #+HTML
  8717. @cindex #+BEGIN_HTML
  8718. @example
  8719. #+HTML: Literal HTML code for export
  8720. @end example
  8721. @noindent or
  8722. @cindex #+BEGIN_HTML
  8723. @example
  8724. #+BEGIN_HTML
  8725. All lines between these markers are exported literally
  8726. #+END_HTML
  8727. @end example
  8728. @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
  8729. @subsection Links in HTML export
  8730. @cindex links, in HTML export
  8731. @cindex internal links, in HTML export
  8732. @cindex external links, in HTML export
  8733. Internal links (@pxref{Internal links}) will continue to work in HTML. This
  8734. includes automatic links created by radio targets (@pxref{Radio
  8735. targets}). Links to external files will still work if the target file is on
  8736. the same @i{relative} path as the published Org file. Links to other
  8737. @file{.org} files will be translated into HTML links under the assumption
  8738. that an HTML version also exists of the linked file, at the same relative
  8739. path. @samp{id:} links can then be used to jump to specific entries across
  8740. files. For information related to linking files while publishing them to a
  8741. publishing directory see @ref{Publishing links}.
  8742. If you want to specify attributes for links, you can do so using a special
  8743. @code{#+ATTR_HTML} line to define attributes that will be added to the
  8744. @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
  8745. and @code{style} attributes for a link:
  8746. @cindex #+ATTR_HTML
  8747. @example
  8748. #+ATTR_HTML: title="The Org mode homepage" style="color:red;"
  8749. [[http://orgmode.org]]
  8750. @end example
  8751. @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
  8752. @subsection Tables
  8753. @cindex tables, in HTML
  8754. @vindex org-export-html-table-tag
  8755. Org mode tables are exported to HTML using the table tag defined in
  8756. @code{org-export-html-table-tag}. The default setting makes tables without
  8757. cell borders and frame. If you would like to change this for individual
  8758. tables, place something like the following before the table:
  8759. @cindex #+CAPTION
  8760. @cindex #+ATTR_HTML
  8761. @example
  8762. #+CAPTION: This is a table with lines around and between cells
  8763. #+ATTR_HTML: border="2" rules="all" frame="border"
  8764. @end example
  8765. @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
  8766. @subsection Images in HTML export
  8767. @cindex images, inline in HTML
  8768. @cindex inlining images in HTML
  8769. @vindex org-export-html-inline-images
  8770. HTML export can inline images given as links in the Org file, and
  8771. it can make an image the clickable part of a link. By
  8772. default@footnote{But see the variable
  8773. @code{org-export-html-inline-images}.}, images are inlined if a link does
  8774. not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
  8775. while @samp{[[file:myimg.jpg][the image]]} will just produce a link
  8776. @samp{the image} that points to the image. If the description part
  8777. itself is a @code{file:} link or a @code{http:} URL pointing to an
  8778. image, this image will be inlined and activated so that clicking on the
  8779. image will activate the link. For example, to include a thumbnail that
  8780. will link to a high resolution version of the image, you could use:
  8781. @example
  8782. [[file:highres.jpg][file:thumb.jpg]]
  8783. @end example
  8784. If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
  8785. In the example below we specify the @code{alt} and @code{title} attributes to
  8786. support text viewers and accessibility, and align it to the right.
  8787. @cindex #+CAPTION
  8788. @cindex #+ATTR_HTML
  8789. @example
  8790. #+CAPTION: A black cat stalking a spider
  8791. #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
  8792. [[./img/a.jpg]]
  8793. @end example
  8794. @noindent
  8795. You could use @code{http} addresses just as well.
  8796. @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
  8797. @subsection Math formatting in HTML export
  8798. @cindex MathJax
  8799. @cindex dvipng
  8800. @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
  8801. different ways on HTML pages. The default is to use the
  8802. @uref{http://www.mathjax.org, MathJax system} which should work out of the
  8803. box with Org mode installation because @code{http://orgmode.org} serves
  8804. @file{MathJax} for Org mode users for small applications and for testing
  8805. purposes. @b{If you plan to use this regularly or on pages with significant
  8806. page views, you should install@footnote{Installation instructions can be
  8807. found on the MathJax website, see
  8808. @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
  8809. your own server in order to limit the load of our server.} To configure
  8810. @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
  8811. insert something like the following into the buffer:
  8812. @example
  8813. #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
  8814. @end example
  8815. @noindent See the docstring of the variable
  8816. @code{org-export-html-mathjax-options} for the meaning of the parameters in
  8817. this line.
  8818. If you prefer, you can also request that @LaTeX{} fragments are processed
  8819. into small images that will be inserted into the browser page. Before the
  8820. availability of MathJax, this was the default method for Org files. This
  8821. method requires that the @file{dvipng} program is available on your system.
  8822. You can still get this processing with
  8823. @example
  8824. #+OPTIONS: LaTeX:dvipng
  8825. @end example
  8826. @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
  8827. @subsection Text areas in HTML export
  8828. @cindex text areas, in HTML
  8829. An alternative way to publish literal code examples in HTML is to use text
  8830. areas, where the example can even be edited before pasting it into an
  8831. application. It is triggered by a @code{-t} switch at an @code{example} or
  8832. @code{src} block. Using this switch disables any options for syntax and
  8833. label highlighting, and line numbering, which may be present. You may also
  8834. use @code{-h} and @code{-w} switches to specify the height and width of the
  8835. text area, which default to the number of lines in the example, and 80,
  8836. respectively. For example
  8837. @example
  8838. #+BEGIN_EXAMPLE -t -w 40
  8839. (defun org-xor (a b)
  8840. "Exclusive or."
  8841. (if a (not b) b))
  8842. #+END_EXAMPLE
  8843. @end example
  8844. @node CSS support, JavaScript support, Text areas in HTML export, HTML export
  8845. @subsection CSS support
  8846. @cindex CSS, for HTML export
  8847. @cindex HTML export, CSS
  8848. @vindex org-export-html-todo-kwd-class-prefix
  8849. @vindex org-export-html-tag-class-prefix
  8850. You can also give style information for the exported file. The HTML exporter
  8851. assigns the following special CSS classes@footnote{If the classes on TODO
  8852. keywords and tags lead to conflicts, use the variables
  8853. @code{org-export-html-todo-kwd-class-prefix} and
  8854. @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
  8855. parts of the document---your style specifications may change these, in
  8856. addition to any of the standard classes like for headlines, tables, etc.
  8857. @example
  8858. p.author @r{author information, including email}
  8859. p.date @r{publishing date}
  8860. p.creator @r{creator info, about org mode version}
  8861. .title @r{document title}
  8862. .todo @r{TODO keywords, all not-done states}
  8863. .done @r{the DONE keywords, all states that count as done}
  8864. .WAITING @r{each TODO keyword also uses a class named after itself}
  8865. .timestamp @r{timestamp}
  8866. .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
  8867. .timestamp-wrapper @r{span around keyword plus timestamp}
  8868. .tag @r{tag in a headline}
  8869. ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
  8870. .target @r{target for links}
  8871. .linenr @r{the line number in a code example}
  8872. .code-highlighted @r{for highlighting referenced code lines}
  8873. div.outline-N @r{div for outline level N (headline plus text))}
  8874. div.outline-text-N @r{extra div for text at outline level N}
  8875. .section-number-N @r{section number in headlines, different for each level}
  8876. div.figure @r{how to format an inlined image}
  8877. pre.src @r{formatted source code}
  8878. pre.example @r{normal example}
  8879. p.verse @r{verse paragraph}
  8880. div.footnotes @r{footnote section headline}
  8881. p.footnote @r{footnote definition paragraph, containing a footnote}
  8882. .footref @r{a footnote reference number (always a <sup>)}
  8883. .footnum @r{footnote number in footnote definition (always <sup>)}
  8884. @end example
  8885. @vindex org-export-html-style-default
  8886. @vindex org-export-html-style-include-default
  8887. @vindex org-export-html-style
  8888. @vindex org-export-html-extra
  8889. @vindex org-export-html-style-default
  8890. Each exported file contains a compact default style that defines these
  8891. classes in a basic way@footnote{This style is defined in the constant
  8892. @code{org-export-html-style-default}, which you should not modify. To turn
  8893. inclusion of these defaults off, customize
  8894. @code{org-export-html-style-include-default}}. You may overwrite these
  8895. settings, or add to them by using the variables @code{org-export-html-style}
  8896. (for Org-wide settings) and @code{org-export-html-style-extra} (for more
  8897. fine-grained settings, like file-local settings). To set the latter variable
  8898. individually for each file, you can use
  8899. @cindex #+STYLE
  8900. @example
  8901. #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
  8902. @end example
  8903. @noindent
  8904. For longer style definitions, you can use several such lines. You could also
  8905. directly write a @code{<style>} @code{</style>} section in this way, without
  8906. referring to an external file.
  8907. In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
  8908. property to assign a class to the tree. In order to specify CSS styles for a
  8909. particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
  8910. property.
  8911. @c FIXME: More about header and footer styles
  8912. @c FIXME: Talk about links and targets.
  8913. @node JavaScript support, , CSS support, HTML export
  8914. @subsection JavaScript supported display of web pages
  8915. @cindex Rose, Sebastian
  8916. Sebastian Rose has written a JavaScript program especially designed to
  8917. enhance the web viewing experience of HTML files created with Org. This
  8918. program allows you to view large files in two different ways. The first one
  8919. is an @emph{Info}-like mode where each section is displayed separately and
  8920. navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
  8921. as well, press @kbd{?} for an overview of the available keys). The second
  8922. view type is a @emph{folding} view much like Org provides inside Emacs. The
  8923. script is available at @url{http://orgmode.org/org-info.js} and you can find
  8924. the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
  8925. We host the script at our site, but if you use it a lot, you might
  8926. not want to be dependent on @url{orgmode.org} and prefer to install a local
  8927. copy on your own web server.
  8928. To use the script, you need to make sure that the @file{org-jsinfo.el} module
  8929. gets loaded. It should be loaded by default, but you can try @kbd{M-x
  8930. customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
  8931. this is indeed the case. All it then takes to make use of the program is
  8932. adding a single line to the Org file:
  8933. @cindex #+INFOJS_OPT
  8934. @example
  8935. #+INFOJS_OPT: view:info toc:nil
  8936. @end example
  8937. @noindent
  8938. If this line is found, the HTML header will automatically contain the code
  8939. needed to invoke the script. Using the line above, you can set the following
  8940. viewing options:
  8941. @example
  8942. path: @r{The path to the script. The default is to grab the script from}
  8943. @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
  8944. @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
  8945. view: @r{Initial view when website is first shown. Possible values are:}
  8946. info @r{Info-like interface with one section per page.}
  8947. overview @r{Folding interface, initially showing only top-level.}
  8948. content @r{Folding interface, starting with all headlines visible.}
  8949. showall @r{Folding interface, all headlines and text visible.}
  8950. sdepth: @r{Maximum headline level that will still become an independent}
  8951. @r{section for info and folding modes. The default is taken from}
  8952. @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
  8953. @r{If this is smaller than in @code{org-export-headline-levels}, each}
  8954. @r{info/folding section can still contain child headlines.}
  8955. toc: @r{Should the table of contents @emph{initially} be visible?}
  8956. @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
  8957. tdepth: @r{The depth of the table of contents. The defaults are taken from}
  8958. @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
  8959. ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
  8960. @r{If yes, the toc will never be displayed as a section.}
  8961. ltoc: @r{Should there be short contents (children) in each section?}
  8962. @r{Make this @code{above} if the section should be above initial text.}
  8963. mouse: @r{Headings are highlighted when the mouse is over them. Should be}
  8964. @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
  8965. buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
  8966. @r{default), only one such button will be present.}
  8967. @end example
  8968. @noindent
  8969. @vindex org-infojs-options
  8970. @vindex org-export-html-use-infojs
  8971. You can choose default values for these options by customizing the variable
  8972. @code{org-infojs-options}. If you always want to apply the script to your
  8973. pages, configure the variable @code{org-export-html-use-infojs}.
  8974. @node @LaTeX{} and PDF export, DocBook export, HTML export, Exporting
  8975. @section @LaTeX{} and PDF export
  8976. @cindex @LaTeX{} export
  8977. @cindex PDF export
  8978. @cindex Guerry, Bastien
  8979. Org mode contains a @LaTeX{} exporter written by Bastien Guerry. With
  8980. further processing@footnote{The default @LaTeX{} output is designed for
  8981. processing with @code{pdftex} or @LaTeX{}. It includes packages that are not
  8982. compatible with @code{xetex} and possibly @code{luatex}. See the variables
  8983. @code{org-export-latex-default-packages-alist} and
  8984. @code{org-export-latex-packages-alist}.}, this backend is also used to
  8985. produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to
  8986. implement links and cross references, the PDF output file will be fully
  8987. linked. Beware of the fact that your @code{org} file has to be properly
  8988. structured in order to be correctly exported: respect the hierarchy of
  8989. sections.
  8990. @menu
  8991. * @LaTeX{}/PDF export commands::
  8992. * Header and sectioning:: Setting up the export file structure
  8993. * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
  8994. * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
  8995. * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
  8996. * Beamer class export:: Turning the file into a presentation
  8997. @end menu
  8998. @node @LaTeX{}/PDF export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
  8999. @subsection @LaTeX{} export commands
  9000. @cindex region, active
  9001. @cindex active region
  9002. @cindex transient-mark-mode
  9003. @table @kbd
  9004. @orgcmd{C-c C-e l,org-export-as-latex}
  9005. @cindex property EXPORT_FILE_NAME
  9006. Export as @LaTeX{} file. For an Org file
  9007. @file{myfile.org}, the @LaTeX{} file will be @file{myfile.tex}. The file will
  9008. be overwritten without warning. If there is an active region@footnote{This
  9009. requires @code{transient-mark-mode} be turned on.}, only the region will be
  9010. exported. If the selected region is a single tree@footnote{To select the
  9011. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  9012. title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
  9013. property, that name will be used for the export.
  9014. @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
  9015. Export to a temporary buffer. Do not create a file.
  9016. @item C-c C-e v l/L
  9017. Export only the visible part of the document.
  9018. @item M-x org-export-region-as-latex
  9019. Convert the region to @LaTeX{} under the assumption that it was Org mode
  9020. syntax before. This is a global command that can be invoked in any
  9021. buffer.
  9022. @item M-x org-replace-region-by-latex
  9023. Replace the active region (assumed to be in Org mode syntax) by @LaTeX{}
  9024. code.
  9025. @orgcmd{C-c C-e p,org-export-as-pdf}
  9026. Export as @LaTeX{} and then process to PDF.
  9027. @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
  9028. Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
  9029. @end table
  9030. @cindex headline levels, for exporting
  9031. @vindex org-latex-low-levels
  9032. In the exported version, the first 3 outline levels will become
  9033. headlines, defining a general document structure. Additional levels
  9034. will be exported as description lists. The exporter can ignore them or
  9035. convert them to a custom string depending on
  9036. @code{org-latex-low-levels}.
  9037. If you want that transition to occur at a different level, specify it
  9038. with a numeric prefix argument. For example,
  9039. @example
  9040. @kbd{C-2 C-c C-e l}
  9041. @end example
  9042. @noindent
  9043. creates two levels of headings and does the rest as items.
  9044. @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{}/PDF export commands, @LaTeX{} and PDF export
  9045. @subsection Header and sectioning structure
  9046. @cindex @LaTeX{} class
  9047. @cindex @LaTeX{} sectioning structure
  9048. @cindex @LaTeX{} header
  9049. @cindex header, for @LaTeX{} files
  9050. @cindex sectioning structure, for @LaTeX{} export
  9051. By default, the @LaTeX{} output uses the class @code{article}.
  9052. @vindex org-export-latex-default-class
  9053. @vindex org-export-latex-classes
  9054. @vindex org-export-latex-default-packages-alist
  9055. @vindex org-export-latex-packages-alist
  9056. @cindex #+LaTeX_HEADER
  9057. @cindex #+LaTeX_CLASS
  9058. @cindex #+LaTeX_CLASS_OPTIONS
  9059. @cindex property, LaTeX_CLASS
  9060. @cindex property, LaTeX_CLASS_OPTIONS
  9061. You can change this globally by setting a different value for
  9062. @code{org-export-latex-default-class} or locally by adding an option like
  9063. @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
  9064. property that applies when exporting a region containing only this (sub)tree.
  9065. The class must be listed in @code{org-export-latex-classes}. This variable
  9066. defines a header template for each class@footnote{Into which the values of
  9067. @code{org-export-latex-default-packages-alist} and
  9068. @code{org-export-latex-packages-alist} are spliced.}, and allows you to
  9069. define the sectioning structure for each class. You can also define your own
  9070. classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
  9071. property can specify the options for the @code{\documentclass} macro. You
  9072. can also use @code{#+LaTeX_HEADER: \usepackage@{xyz@}} to add lines to the
  9073. header. See the docstring of @code{org-export-latex-classes} for more
  9074. information.
  9075. @node Quoting @LaTeX{} code, Tables in @LaTeX{} export, Header and sectioning, @LaTeX{} and PDF export
  9076. @subsection Quoting @LaTeX{} code
  9077. Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
  9078. inserted into the @LaTeX{} file. This includes simple macros like
  9079. @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
  9080. you can add special code that should only be present in @LaTeX{} export with
  9081. the following constructs:
  9082. @cindex #+LaTeX
  9083. @cindex #+BEGIN_LaTeX
  9084. @example
  9085. #+LaTeX: Literal @LaTeX{} code for export
  9086. @end example
  9087. @noindent or
  9088. @cindex #+BEGIN_LaTeX
  9089. @example
  9090. #+BEGIN_LaTeX
  9091. All lines between these markers are exported literally
  9092. #+END_LaTeX
  9093. @end example
  9094. @node Tables in @LaTeX{} export, Images in @LaTeX{} export, Quoting @LaTeX{} code, @LaTeX{} and PDF export
  9095. @subsection Tables in @LaTeX{} export
  9096. @cindex tables, in @LaTeX{} export
  9097. For @LaTeX{} export of a table, you can specify a label, a caption and
  9098. placement options (@pxref{Images and tables}). You can also use the
  9099. @code{ATTR_LaTeX} line to request a @code{longtable} environment for the
  9100. table, so that it may span several pages, or to change the default table
  9101. environment from @code{table} to @code{table*} or to change the default inner
  9102. tabular environment to @code{tabularx} or @code{tabulary}. Finally, you can
  9103. set the alignment string, and (with @code{tabularx} or @code{tabulary}) the
  9104. width:
  9105. @cindex #+CAPTION
  9106. @cindex #+LABEL
  9107. @cindex #+ATTR_LaTeX
  9108. @example
  9109. #+CAPTION: A long table
  9110. #+LABEL: tbl:long
  9111. #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
  9112. | ..... | ..... |
  9113. | ..... | ..... |
  9114. @end example
  9115. or to specify a multicolumn table with @code{tabulary}
  9116. @cindex #+CAPTION
  9117. @cindex #+LABEL
  9118. @cindex #+ATTR_LaTeX
  9119. @example
  9120. #+CAPTION: A wide table with tabulary
  9121. #+LABEL: tbl:wide
  9122. #+ATTR_LaTeX: table* tabulary width=\textwidth
  9123. | ..... | ..... |
  9124. | ..... | ..... |
  9125. @end example
  9126. @node Images in @LaTeX{} export, Beamer class export, Tables in @LaTeX{} export, @LaTeX{} and PDF export
  9127. @subsection Images in @LaTeX{} export
  9128. @cindex images, inline in @LaTeX{}
  9129. @cindex inlining images in @LaTeX{}
  9130. Images that are linked to without a description part in the link, like
  9131. @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
  9132. output file resulting from @LaTeX{} processing. Org will use an
  9133. @code{\includegraphics} macro to insert the image. If you have specified a
  9134. caption and/or a label as described in @ref{Images and tables}, the figure
  9135. will be wrapped into a @code{figure} environment and thus become a floating
  9136. element. You can use an @code{#+ATTR_LaTeX:} line to specify various other
  9137. options. You can ask org to export an image as a float without specifying
  9138. a label or a caption by using the keyword @code{float} in this line. Various
  9139. optional arguments to the @code{\includegraphics} macro can also be specified
  9140. in this fashion. To modify the placement option of the floating environment,
  9141. add something like @samp{placement=[h!]} to the attributes. It is to be noted
  9142. this option can be used with tables as well@footnote{One can also take
  9143. advantage of this option to pass other, unrelated options into the figure or
  9144. table environment. For an example see the section ``Exporting org files'' in
  9145. @url{http://orgmode.org/worg/org-hacks.html}}. For example the
  9146. @code{#+ATTR_LaTeX:} line below is exported as the @code{figure} environment
  9147. below it.
  9148. If you would like to let text flow around the image, add the word @samp{wrap}
  9149. to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
  9150. half of the page. To fine-tune, the @code{placement} field will be the set
  9151. of additional arguments needed by the @code{wrapfigure} environment. Note
  9152. that if you change the size of the image, you need to use compatible settings
  9153. for @code{\includegraphics} and @code{wrapfigure}.
  9154. @cindex #+CAPTION
  9155. @cindex #+LABEL
  9156. @cindex #+ATTR_LaTeX
  9157. @example
  9158. #+CAPTION: The black-body emission of the disk around HR 4049
  9159. #+LABEL: fig:SED-HR4049
  9160. #+ATTR_LaTeX: width=5cm,angle=90
  9161. [[./img/sed-hr4049.pdf]]
  9162. #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
  9163. [[./img/hst.png]]
  9164. @end example
  9165. If you wish to include an image which spans multiple columns in a page, you
  9166. can use the keyword @code{multicolumn} in the @code{#+ATTR_LaTeX} line. This
  9167. will export the image wrapped in a @code{figure*} environment.
  9168. If you need references to a label created in this way, write
  9169. @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
  9170. @node Beamer class export, , Images in @LaTeX{} export, @LaTeX{} and PDF export
  9171. @subsection Beamer class export
  9172. The @LaTeX{} class @file{beamer} allows production of high quality presentations
  9173. using @LaTeX{} and pdf processing. Org mode has special support for turning an
  9174. Org mode file or tree into a @file{beamer} presentation.
  9175. When the @LaTeX{} class for the current buffer (as set with @code{#+LaTeX_CLASS:
  9176. beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
  9177. @code{beamer}, a special export mode will turn the file or tree into a beamer
  9178. presentation. Any tree with not-too-deep level nesting should in principle be
  9179. exportable as a beamer presentation. By default, the top-level entries (or
  9180. the first level below the selected subtree heading) will be turned into
  9181. frames, and the outline structure below this level will become itemize lists.
  9182. You can also configure the variable @code{org-beamer-frame-level} to a
  9183. different level---then the hierarchy above frames will produce the sectioning
  9184. structure of the presentation.
  9185. A template for useful in-buffer settings or properties can be inserted into
  9186. the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
  9187. things, this will install a column view format which is very handy for
  9188. editing special properties used by beamer.
  9189. You can influence the structure of the presentation using the following
  9190. properties:
  9191. @table @code
  9192. @item BEAMER_env
  9193. The environment that should be used to format this entry. Valid environments
  9194. are defined in the constant @code{org-beamer-environments-default}, and you
  9195. can define more in @code{org-beamer-environments-extra}. If this property is
  9196. set, the entry will also get a @code{:B_environment:} tag to make this
  9197. visible. This tag has no semantic meaning, it is only a visual aid.
  9198. @item BEAMER_envargs
  9199. The beamer-special arguments that should be used for the environment, like
  9200. @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
  9201. property is also set, something like @code{C[t]} can be added here as well to
  9202. set an options argument for the implied @code{columns} environment.
  9203. @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
  9204. environment.
  9205. @item BEAMER_col
  9206. The width of a column that should start with this entry. If this property is
  9207. set, the entry will also get a @code{:BMCOL:} property to make this visible.
  9208. Also this tag is only a visual aid. When this is a plain number, it will be
  9209. interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
  9210. that you have specified the units, like @samp{3cm}. The first such property
  9211. in a frame will start a @code{columns} environment to surround the columns.
  9212. This environment is closed when an entry has a @code{BEAMER_col} property
  9213. with value 0 or 1, or automatically at the end of the frame.
  9214. @item BEAMER_extra
  9215. Additional commands that should be inserted after the environment has been
  9216. opened. For example, when creating a frame, this can be used to specify
  9217. transitions.
  9218. @end table
  9219. Frames will automatically receive a @code{fragile} option if they contain
  9220. source code that uses the verbatim environment. Special @file{beamer}
  9221. specific code can be inserted using @code{#+BEAMER:} and
  9222. @code{#+BEGIN_BEAMER...#+END_BEAMER} constructs, similar to other export
  9223. backends, but with the difference that @code{#+LaTeX:} stuff will be included
  9224. in the presentation as well.
  9225. Outline nodes with @code{BEAMER_env} property value @samp{note} or
  9226. @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
  9227. into @code{\note@{...@}}. The former will include the heading as part of the
  9228. note text, the latter will ignore the heading of that node. To simplify note
  9229. generation, it is actually enough to mark the note with a @emph{tag} (either
  9230. @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
  9231. @code{BEAMER_env} property.
  9232. You can turn on a special minor mode @code{org-beamer-mode} for editing
  9233. support with
  9234. @example
  9235. #+STARTUP: beamer
  9236. @end example
  9237. @table @kbd
  9238. @orgcmd{C-c C-b,org-beamer-select-environment}
  9239. In @code{org-beamer-mode}, this key offers fast selection of a beamer
  9240. environment or the @code{BEAMER_col} property.
  9241. @end table
  9242. Column view provides a great way to set the environment of a node and other
  9243. important parameters. Make sure you are using a COLUMN format that is geared
  9244. toward this special purpose. The command @kbd{M-x
  9245. org-insert-beamer-options-template} defines such a format.
  9246. Here is a simple example Org document that is intended for beamer export.
  9247. @smallexample
  9248. #+LaTeX_CLASS: beamer
  9249. #+TITLE: Example Presentation
  9250. #+AUTHOR: Carsten Dominik
  9251. #+LaTeX_CLASS_OPTIONS: [presentation]
  9252. #+BEAMER_FRAME_LEVEL: 2
  9253. #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
  9254. #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
  9255. * This is the first structural section
  9256. ** Frame 1 \\ with a subtitle
  9257. *** Thanks to Eric Fraga :BMCOL:B_block:
  9258. :PROPERTIES:
  9259. :BEAMER_env: block
  9260. :BEAMER_envargs: C[t]
  9261. :BEAMER_col: 0.5
  9262. :END:
  9263. for the first viable beamer setup in Org
  9264. *** Thanks to everyone else :BMCOL:B_block:
  9265. :PROPERTIES:
  9266. :BEAMER_col: 0.5
  9267. :BEAMER_env: block
  9268. :BEAMER_envargs: <2->
  9269. :END:
  9270. for contributing to the discussion
  9271. **** This will be formatted as a beamer note :B_note:
  9272. ** Frame 2 \\ where we will not use columns
  9273. *** Request :B_block:
  9274. Please test this stuff!
  9275. :PROPERTIES:
  9276. :BEAMER_env: block
  9277. :END:
  9278. @end smallexample
  9279. For more information, see the documentation on Worg.
  9280. @node DocBook export, OpenDocument Text export, @LaTeX{} and PDF export, Exporting
  9281. @section DocBook export
  9282. @cindex DocBook export
  9283. @cindex PDF export
  9284. @cindex Cui, Baoqiu
  9285. Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
  9286. exported to DocBook format, it can be further processed to produce other
  9287. formats, including PDF, HTML, man pages, etc., using many available DocBook
  9288. tools and stylesheets.
  9289. Currently DocBook exporter only supports DocBook V5.0.
  9290. @menu
  9291. * DocBook export commands:: How to invoke DocBook export
  9292. * Quoting DocBook code:: Incorporating DocBook code in Org files
  9293. * Recursive sections:: Recursive sections in DocBook
  9294. * Tables in DocBook export:: Tables are exported as HTML tables
  9295. * Images in DocBook export:: How to insert figures into DocBook output
  9296. * Special characters:: How to handle special characters
  9297. @end menu
  9298. @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
  9299. @subsection DocBook export commands
  9300. @cindex region, active
  9301. @cindex active region
  9302. @cindex transient-mark-mode
  9303. @table @kbd
  9304. @orgcmd{C-c C-e D,org-export-as-docbook}
  9305. @cindex property EXPORT_FILE_NAME
  9306. Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
  9307. file will be @file{myfile.xml}. The file will be overwritten without
  9308. warning. If there is an active region@footnote{This requires
  9309. @code{transient-mark-mode} to be turned on}, only the region will be
  9310. exported. If the selected region is a single tree@footnote{To select the
  9311. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  9312. title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
  9313. property, that name will be used for the export.
  9314. @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
  9315. Export as DocBook file, process to PDF, then open the resulting PDF file.
  9316. @vindex org-export-docbook-xslt-proc-command
  9317. @vindex org-export-docbook-xsl-fo-proc-command
  9318. Note that, in order to produce PDF output based on exported DocBook file, you
  9319. need to have XSLT processor and XSL-FO processor software installed on your
  9320. system. Check variables @code{org-export-docbook-xslt-proc-command} and
  9321. @code{org-export-docbook-xsl-fo-proc-command}.
  9322. @vindex org-export-docbook-xslt-stylesheet
  9323. The stylesheet argument @code{%s} in variable
  9324. @code{org-export-docbook-xslt-proc-command} is replaced by the value of
  9325. variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
  9326. the user. You can also overrule this global setting on a per-file basis by
  9327. adding an in-buffer setting @code{#+XSLT:} to the Org file.
  9328. @orgkey{C-c C-e v D}
  9329. Export only the visible part of the document.
  9330. @end table
  9331. @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
  9332. @subsection Quoting DocBook code
  9333. You can quote DocBook code in Org files and copy it verbatim into exported
  9334. DocBook file with the following constructs:
  9335. @cindex #+DOCBOOK
  9336. @cindex #+BEGIN_DOCBOOK
  9337. @example
  9338. #+DOCBOOK: Literal DocBook code for export
  9339. @end example
  9340. @noindent or
  9341. @cindex #+BEGIN_DOCBOOK
  9342. @example
  9343. #+BEGIN_DOCBOOK
  9344. All lines between these markers are exported by DocBook exporter
  9345. literally.
  9346. #+END_DOCBOOK
  9347. @end example
  9348. For example, you can use the following lines to include a DocBook warning
  9349. admonition. As to what this warning says, you should pay attention to the
  9350. document context when quoting DocBook code in Org files. You may make
  9351. exported DocBook XML files invalid by not quoting DocBook code correctly.
  9352. @example
  9353. #+BEGIN_DOCBOOK
  9354. <warning>
  9355. <para>You should know what you are doing when quoting DocBook XML code
  9356. in your Org file. Invalid DocBook XML may be generated by
  9357. DocBook exporter if you are not careful!</para>
  9358. </warning>
  9359. #+END_DOCBOOK
  9360. @end example
  9361. @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
  9362. @subsection Recursive sections
  9363. @cindex DocBook recursive sections
  9364. DocBook exporter exports Org files as articles using the @code{article}
  9365. element in DocBook. Recursive sections, i.e.@: @code{section} elements, are
  9366. used in exported articles. Top level headlines in Org files are exported as
  9367. top level sections, and lower level headlines are exported as nested
  9368. sections. The entire structure of Org files will be exported completely, no
  9369. matter how many nested levels of headlines there are.
  9370. Using recursive sections makes it easy to port and reuse exported DocBook
  9371. code in other DocBook document types like @code{book} or @code{set}.
  9372. @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
  9373. @subsection Tables in DocBook export
  9374. @cindex tables, in DocBook export
  9375. Tables in Org files are exported as HTML tables, which have been supported since
  9376. DocBook V4.3.
  9377. If a table does not have a caption, an informal table is generated using the
  9378. @code{informaltable} element; otherwise, a formal table will be generated
  9379. using the @code{table} element.
  9380. @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
  9381. @subsection Images in DocBook export
  9382. @cindex images, inline in DocBook
  9383. @cindex inlining images in DocBook
  9384. Images that are linked to without a description part in the link, like
  9385. @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
  9386. using @code{mediaobject} elements. Each @code{mediaobject} element contains
  9387. an @code{imageobject} that wraps an @code{imagedata} element. If you have
  9388. specified a caption for an image as described in @ref{Images and tables}, a
  9389. @code{caption} element will be added in @code{mediaobject}. If a label is
  9390. also specified, it will be exported as an @code{xml:id} attribute of the
  9391. @code{mediaobject} element.
  9392. @vindex org-export-docbook-default-image-attributes
  9393. Image attributes supported by the @code{imagedata} element, like @code{align}
  9394. or @code{width}, can be specified in two ways: you can either customize
  9395. variable @code{org-export-docbook-default-image-attributes} or use the
  9396. @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
  9397. @code{org-export-docbook-default-image-attributes} are applied to all inline
  9398. images in the Org file to be exported (unless they are overridden by image
  9399. attributes specified in @code{#+ATTR_DOCBOOK:} lines).
  9400. The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
  9401. attributes or override default image attributes for individual images. If
  9402. the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
  9403. variable @code{org-export-docbook-default-image-attributes}, the former
  9404. takes precedence. Here is an example about how image attributes can be
  9405. set:
  9406. @cindex #+CAPTION
  9407. @cindex #+LABEL
  9408. @cindex #+ATTR_DOCBOOK
  9409. @example
  9410. #+CAPTION: The logo of Org mode
  9411. #+LABEL: unicorn-svg
  9412. #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
  9413. [[./img/org-mode-unicorn.svg]]
  9414. @end example
  9415. @vindex org-export-docbook-inline-image-extensions
  9416. By default, DocBook exporter recognizes the following image file types:
  9417. @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
  9418. customize variable @code{org-export-docbook-inline-image-extensions} to add
  9419. more types to this list as long as DocBook supports them.
  9420. @node Special characters, , Images in DocBook export, DocBook export
  9421. @subsection Special characters in DocBook export
  9422. @cindex Special characters in DocBook export
  9423. @vindex org-export-docbook-doctype
  9424. @vindex org-entities
  9425. Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
  9426. @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
  9427. characters are rewritten to XML entities, like @code{&alpha;},
  9428. @code{&Gamma;}, and @code{&Zeta;}, based on the list saved in variable
  9429. @code{org-entities}. As long as the generated DocBook file includes the
  9430. corresponding entities, these special characters are recognized.
  9431. You can customize variable @code{org-export-docbook-doctype} to include the
  9432. entities you need. For example, you can set variable
  9433. @code{org-export-docbook-doctype} to the following value to recognize all
  9434. special characters included in XHTML entities:
  9435. @example
  9436. "<!DOCTYPE article [
  9437. <!ENTITY % xhtml1-symbol PUBLIC
  9438. \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
  9439. \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
  9440. >
  9441. %xhtml1-symbol;
  9442. ]>
  9443. "
  9444. @end example
  9445. @c begin opendocument
  9446. @node OpenDocument Text export, TaskJuggler export, DocBook export, Exporting
  9447. @section OpenDocument Text export
  9448. @cindex K, Jambunathan
  9449. @cindex ODT
  9450. @cindex OpenDocument
  9451. @cindex export, OpenDocument
  9452. @cindex LibreOffice
  9453. @cindex org-odt.el
  9454. @cindex org-modules
  9455. Orgmode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
  9456. (@acronym{ODT}) format using the @file{org-odt.el} module. Documents created
  9457. by this exporter use the @cite{OpenDocument-v1.2
  9458. specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
  9459. Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
  9460. are compatible with LibreOffice 3.4.
  9461. @menu
  9462. * Pre-requisites for @acronym{ODT} export:: What packages @acronym{ODT} exporter relies on
  9463. * @acronym{ODT} export commands:: How to invoke @acronym{ODT} export
  9464. * Applying custom styles:: How to apply custom styles to the output
  9465. * Links in @acronym{ODT} export:: How links will be interpreted and formatted
  9466. * Tables in @acronym{ODT} export:: How Tables are exported
  9467. * Images in @acronym{ODT} export:: How to insert images
  9468. * Math formatting in @acronym{ODT} export:: How @LaTeX{} fragments are formatted
  9469. * Literal examples in @acronym{ODT} export:: How source and example blocks are formatted
  9470. * Advanced topics in @acronym{ODT} export:: Read this if you are a power user
  9471. @end menu
  9472. @node Pre-requisites for @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export, OpenDocument Text export
  9473. @subsection Pre-requisites for @acronym{ODT} export
  9474. @cindex zip
  9475. The @acronym{ODT} exporter relies on the @file{zip} program to create the final
  9476. output. Check the availability of this program before proceeding further.
  9477. @node @acronym{ODT} export commands, Applying custom styles, Pre-requisites for @acronym{ODT} export, OpenDocument Text export
  9478. @subsection @acronym{ODT} export commands
  9479. @subsubheading Exporting to @acronym{ODT}
  9480. @anchor{x-export-to-odt}
  9481. @cindex region, active
  9482. @cindex active region
  9483. @cindex transient-mark-mode
  9484. @table @kbd
  9485. @orgcmd{C-c C-e o,org-export-as-odt}
  9486. @cindex property EXPORT_FILE_NAME
  9487. Export as OpenDocument Text file.
  9488. @vindex org-export-odt-preferred-output-format
  9489. If @code{org-export-odt-preferred-output-format} is specified, automatically
  9490. convert the exported file to that format.
  9491. @xref{x-export-to-other-formats,,Automatically exporting to other formats}.
  9492. For an Org file @file{myfile.org}, the @acronym{ODT} file will be
  9493. @file{myfile.odt}. The file will be overwritten without warning. If there
  9494. is an active region,@footnote{This requires @code{transient-mark-mode} to be
  9495. turned on} only the region will be exported. If the selected region is a
  9496. single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
  9497. tree head will become the document title. If the tree head entry has, or
  9498. inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
  9499. export.
  9500. @orgcmd{C-c C-e O,org-export-as-odt-and-open}
  9501. Export as OpenDocument Text file and open the resulting file.
  9502. @vindex org-export-odt-preferred-output-format
  9503. If @code{org-export-odt-preferred-output-format} is specified, open the
  9504. converted file instead.
  9505. @xref{x-export-to-other-formats,,Automatically exporting to other formats}.
  9506. @end table
  9507. @subsubheading Automatically exporting to other formats
  9508. @anchor{x-export-to-other-formats}
  9509. @vindex org-export-odt-preferred-output-format
  9510. Very often, you will find yourself exporting to @acronym{ODT} format, only to
  9511. immediately save the exported document to a different format like @samp{pdf}.
  9512. In such cases, you will find it convenient to configure a converter
  9513. (@pxref{Exporting and converting to other formats}) and specify your
  9514. preferred output format by customizing the variable
  9515. @code{org-export-odt-preferred-output-format}. This way, the export commands
  9516. (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to also export to
  9517. the preferred format.
  9518. @node Applying custom styles, Links in @acronym{ODT} export, @acronym{ODT} export commands, OpenDocument Text export
  9519. @subsection Applying custom styles
  9520. @cindex styles, custom
  9521. @cindex template, custom
  9522. The @acronym{ODT} exporter ships with a set of OpenDocument styles
  9523. (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
  9524. output. These factory styles, however, may not cater to your specific
  9525. tastes. To customize the output, you can either modify the above styles
  9526. files directly, or generate the required styles using an application like
  9527. LibreOffice. The latter method is suitable for expert and non-expert
  9528. users alike, and is described here.
  9529. @subsubsection Applying custom styles - the easy way
  9530. @enumerate
  9531. @item
  9532. Create a sample @file{example.org} file with the below settings and export it
  9533. to @acronym{ODT} format.
  9534. @example
  9535. #+OPTIONS: H:10 num:t
  9536. @end example
  9537. @item
  9538. Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
  9539. to locate the target styles - these typically have the @samp{Org} prefix -
  9540. and modify those to your taste. Save the modified file either as an
  9541. OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
  9542. @item
  9543. @cindex #+ODT_STYLES_FILE
  9544. @vindex org-export-odt-styles-file
  9545. Customize the variable @code{org-export-odt-styles-file} and point it to the
  9546. newly created file. For additional configuration options
  9547. @pxref{x-overriding-factory-styles,,Overriding factory styles}.
  9548. If you would like to choose a style on a per-file basis, you can use the
  9549. @code{#+ODT_STYLES_FILE} option. A typical setting will look like
  9550. @example
  9551. #+ODT_STYLES_FILE: "/path/to/example.ott"
  9552. @end example
  9553. or
  9554. @example
  9555. #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
  9556. @end example
  9557. @end enumerate
  9558. @subsubsection Using third-party styles and templates
  9559. You can use third-party styles and templates for customizing your output.
  9560. This will produce the desired output only if the template provides all
  9561. style names that the @samp{ODT} exporter relies on. Unless this condition is
  9562. met, the output is going to be less than satisfactory. So it is highly
  9563. recommended that you only work with templates that are directly derived from
  9564. the factory settings.
  9565. @node Links in @acronym{ODT} export, Tables in @acronym{ODT} export, Applying custom styles, OpenDocument Text export
  9566. @subsection Links in @acronym{ODT} export
  9567. @cindex tables, in DocBook export
  9568. The @acronym{ODT} exporter creates cross-references (aka bookmarks) for
  9569. internal links. It creates Internet-style links for all other links.
  9570. @node Tables in @acronym{ODT} export, Images in @acronym{ODT} export, Links in @acronym{ODT} export, OpenDocument Text export
  9571. @subsection Tables in @acronym{ODT} export
  9572. @cindex tables, in DocBook export
  9573. Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
  9574. tables is supported. However, export of complex @file{table.el} tables -
  9575. tables that have column or row spans - is not supported. Such tables are
  9576. stripped from the exported document.
  9577. By default, a table is exported with top and bottom frames and with
  9578. rules separating row and column groups (@pxref{Column groups}). If the table
  9579. specifies alignment and relative width for its columns (@pxref{Column width
  9580. and alignment}) then these are honored on export.@footnote{The column widths
  9581. are interpreted as weighted ratios with the default weight being 1}
  9582. @cindex #+ATTR_ODT
  9583. If you are not satisfied with the default formatting of tables, you can
  9584. create custom table styles and associate them with a table using
  9585. the @code{#+ATTR_ODT} line. @xref{Customizing tables in @acronym{ODT} export}.
  9586. @node Images in @acronym{ODT} export, Math formatting in @acronym{ODT} export, Tables in @acronym{ODT} export, OpenDocument Text export
  9587. @subsection Images in @acronym{ODT} export
  9588. @cindex images, embedding in @acronym{ODT}
  9589. @cindex embedding images in @acronym{ODT}
  9590. @subsubheading Embedding images
  9591. You can embed images within the exported document by providing a link to the
  9592. desired image file with no link description. For example, to embed
  9593. @samp{img.png} do either of the following:
  9594. @example
  9595. [[file:img.png]]
  9596. @end example
  9597. @example
  9598. [[./img.png]]
  9599. @end example
  9600. @subsubheading Embedding clickable images
  9601. You can create clickable images by providing a link whose description is a
  9602. link to an image file. For example, to embed a image
  9603. @file{org-mode-unicorn.png} which when clicked jumps to
  9604. @uref{http://Orgmode.org} website, do the following
  9605. @example
  9606. [[http://orgmode.org][./org-mode-unicorn.png]]
  9607. @end example
  9608. @subsubheading Sizing and scaling of embedded images
  9609. You can control the size and scale of the embedded images using the
  9610. @code{#+ATTR_ODT} attribute.
  9611. @vindex org-export-odt-pixels-per-inch
  9612. Note that the exporter specifies the desired size of the image in the final
  9613. document in units of centimeters. In order to scale the embedded images, the
  9614. exporter needs to compute the size of the image. This is done by retrieving
  9615. the image size in pixels and converting the pixel units to centimeters using
  9616. @code{org-export-odt-pixels-per-inch}. The default value of this variable is
  9617. set to @code{display-pixels-per-inch}. You can tweak this variable to
  9618. achieve the best results.
  9619. The examples below illustrate the various possibilities.
  9620. @table @asis
  9621. @item Explicitly size the image
  9622. To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
  9623. @example
  9624. #+ATTR_ODT: :width 10 :height 10
  9625. [[./img.png]]
  9626. @end example
  9627. @item Scale the image
  9628. To embed @file{img.png} at half its size, do the following:
  9629. @example
  9630. #+ATTR_ODT: :scale 0.5
  9631. [[./img.png]]
  9632. @end example
  9633. @item Scale the image to a specific width
  9634. To embed @file{img.png} with a width of 10 cm while retaining the original
  9635. height:width ratio, do the following:
  9636. @example
  9637. #+ATTR_ODT: :width 10
  9638. [[./img.png]]
  9639. @end example
  9640. @item Scale the image to a specific height
  9641. To embed @file{img.png} with a height of 10 cm while retaining the original
  9642. height:width ratio, do the following
  9643. @example
  9644. #+ATTR_ODT: :height 10
  9645. [[./img.png]]
  9646. @end example
  9647. @end table
  9648. @node Math formatting in @acronym{ODT} export, Literal examples in @acronym{ODT} export, Images in @acronym{ODT} export, OpenDocument Text export
  9649. @subsection Math formatting in @acronym{ODT} export
  9650. The @acronym{ODT} exporter has special support for handling math.
  9651. @menu
  9652. * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
  9653. * Working with MathML or OpenDocument formula files:: How to embed equations in native format
  9654. @end menu
  9655. @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in @acronym{ODT} export, Math formatting in @acronym{ODT} export
  9656. @subsubsection Working with @LaTeX{} math snippets
  9657. @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
  9658. document in one of the following ways:
  9659. @cindex MathML
  9660. @enumerate
  9661. @item MathML
  9662. This option is activated on a per-file basis with
  9663. @example
  9664. #+OPTIONS: LaTeX:t
  9665. @end example
  9666. With this option, @LaTeX{} fragments are first converted into MathML
  9667. fragments using an external @LaTeX{}-to-MathML converter program. The
  9668. resulting MathML fragments are then embedded as an OpenDocument Formula in
  9669. the exported document.
  9670. @vindex org-latex-to-mathml-convert-command
  9671. @vindex org-latex-to-mathml-jar-file
  9672. You can specify the @LaTeX{}-to-MathML converter by customizing the variables
  9673. @code{org-latex-to-mathml-convert-command} and
  9674. @code{org-latex-to-mathml-jar-file}.
  9675. If you prefer to use @file{MathToWeb}@footnote{See
  9676. @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
  9677. converter, you can configure the above variables as shown below.
  9678. @lisp
  9679. (setq org-latex-to-mathml-convert-command
  9680. "java -jar %j -unicode -force -df %o %I"
  9681. org-latex-to-mathml-jar-file
  9682. "/path/to/mathtoweb.jar")
  9683. @end lisp
  9684. You can use the following commands to quickly verify the reliability of
  9685. the @LaTeX{}-to-MathML converter.
  9686. @table @kbd
  9687. @item M-x org-export-as-odf
  9688. Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file.
  9689. @item M-x org-export-as-odf-and-open
  9690. Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file and
  9691. open the formula file with the system-registered application.
  9692. @end table
  9693. @cindex dvipng
  9694. @item PNG images
  9695. This option is activated on a per-file basis with
  9696. @example
  9697. #+OPTIONS: LaTeX:dvipng
  9698. @end example
  9699. With this option, @LaTeX{} fragments are processed into PNG images and the
  9700. resulting images are embedded in the exported document. This method requires
  9701. that the @file{dvipng} program be available on your system.
  9702. @end enumerate
  9703. @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in @acronym{ODT} export
  9704. @subsubsection Working with MathML or OpenDocument formula files
  9705. For various reasons, you may find embedding @LaTeX{} math snippets in an
  9706. @acronym{ODT} document less than reliable. In that case, you can embed a
  9707. math equation by linking to its MathML(@file{.mml}) source or its
  9708. OpenDocument formula (@file{.odf}) file as shown below:
  9709. @example
  9710. [[./equation.mml]]
  9711. @end example
  9712. or
  9713. @example
  9714. [[./equation.odf]]
  9715. @end example
  9716. @node Literal examples in @acronym{ODT} export, Advanced topics in @acronym{ODT} export, Math formatting in @acronym{ODT} export, OpenDocument Text export
  9717. @subsection Literal examples in @acronym{ODT} export
  9718. Export of literal examples (@pxref{Literal examples}) with full fontification
  9719. is supported. This feature is enabled by default and is activated
  9720. automatically if an enhanced version of @file{htmlfontify.el} is available in
  9721. the @code{load-path}.@footnote{The @file{htmlfontify.el} that ships with
  9722. standard Emacs <= 24.1 has no support for @acronym{ODT} fontification. A
  9723. copy of the proposed version is available as an attachment to
  9724. @url{http://debbugs.gnu.org/cgi/bugreport.cgi?msg=5;filename=htmlfontify.el;att=9;bug=9914,
  9725. Emacs Bug #9914}.}
  9726. @vindex org-export-odt-fontify-srcblocks
  9727. The character styles used for fontification of the literal blocks are
  9728. auto-generated by the exporter in conjunction with @file{htmlfontify.el}
  9729. library and need not be included in the default @file{styles.xml} file.
  9730. These auto-generated styles have the @samp{OrgSrc} prefix and inherit their color
  9731. based on the face used by Emacs @code{font-lock} library.
  9732. @vindex org-export-odt-create-custom-styles-for-srcblocks
  9733. If you prefer to use your own custom styles for fontification and disable
  9734. their auto-generation altogether, you can do so by customizing the variable
  9735. @code{org-export-odt-create-custom-styles-for-srcblocks}.
  9736. You can turn off fontification support for literal examples by customizing
  9737. the variable @code{org-export-odt-fontify-srcblocks}.
  9738. @node Advanced topics in @acronym{ODT} export, , Literal examples in @acronym{ODT} export, OpenDocument Text export
  9739. @subsection Advanced topics in @acronym{ODT} export
  9740. If you rely heavily on @acronym{ODT} export, you may want to exploit the full
  9741. set of features that the exporter offers. This section describes features
  9742. that would be of interest to power users.
  9743. @menu
  9744. * Exporting and converting to other formats:: How to produce @samp{pdf} and other formats
  9745. * Working with OpenDocument style files:: Explore the internals
  9746. * Creating one-off styles:: How to produce custom highlighting etc
  9747. * Customizing tables in @acronym{ODT} export:: How to define and use Table templates
  9748. * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
  9749. @end menu
  9750. @node Exporting and converting to other formats, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export, Advanced topics in @acronym{ODT} export
  9751. @subsubsection Exporting and converting to other formats
  9752. @cindex convert
  9753. @cindex doc, docx
  9754. The @acronym{ODT} exporter adds support for exporting Org outlines to formats
  9755. that are not supported natively by Org. It also adds support to convert
  9756. document from one format to another. To use these features, you need to
  9757. configure a command-line converter. Once a command-line converter is
  9758. configured you can use it to extend the list of formats to which Org can
  9759. export. @xref{x-export-to-other-formats,,Automatically exporting to other
  9760. formats}. You can also use it to perform one-off document conversion as
  9761. detailed below.
  9762. @vindex org-export-odt-convert
  9763. @table @kbd
  9764. @item M-x org-export-odt-convert
  9765. Convert an existing document from one format to another as determined by the
  9766. variable @code{org-export-odt-convert-capabilities}
  9767. (@pxref{x-odt-converter-capabilities,,Configure converter
  9768. capabilities}). @strong{Please note} that you can use this command to even
  9769. convert documents that are produced outside of Org and in other formats than
  9770. @acronym{ODT} format.
  9771. @end table
  9772. @subsubheading Pre-configured converters
  9773. @cindex converter
  9774. The @acronym{ODT} exporter supports two converters out of the box:
  9775. @enumerate
  9776. @cindex @file{unoconv}
  9777. @item @file{unoconv}
  9778. This converter is available as an installable package in your favorite
  9779. distribution.
  9780. @cindex @file{BasicODConverter}
  9781. @item @file{BasicODConverter}
  9782. @vindex org-odt-data-dir
  9783. This converter is distributed as a LibreOffice extension and can be found in
  9784. your Org distribution. See the subdirectory pointed to by the variable
  9785. @code{org-odt-data-dir}.
  9786. @end enumerate
  9787. @subsubheading Installing a new converter
  9788. If you prefer to use a converter other than the two mentioned above, then you
  9789. may have to do additional configuration. You can proceed as follows:
  9790. @enumerate
  9791. @item Register the converter
  9792. @vindex org-export-odt-convert-processes
  9793. Name your converter and add it to the list of known converters by customizing
  9794. the variable @code{org-export-odt-convert-processes}. Also specify how the
  9795. converter can be invoked via command-line to effect the conversion.
  9796. @item Configure its capabilities
  9797. @vindex org-export-odt-convert-capabilities
  9798. @anchor{x-odt-converter-capabilities}
  9799. Specify the set of formats the converter can handle by customizing the
  9800. variable @code{org-export-odt-convert-capabilities}. Use the default value
  9801. for this variable as a guide for configuring your converter. As suggested by
  9802. the default setting, you can specify the full set of formats supported by the
  9803. converter and not limit yourself to specifying formats that are related to
  9804. just the OpenDocument Text format.
  9805. @item Choose the converter
  9806. @vindex org-export-odt-convert-process
  9807. Select the newly added converter as the preferred one by customizing the
  9808. variable @code{org-export-odt-convert-process}.
  9809. @end enumerate
  9810. @node Working with OpenDocument style files, Creating one-off styles, Exporting and converting to other formats, Advanced topics in @acronym{ODT} export
  9811. @subsubsection Working with OpenDocument style files
  9812. @cindex styles, custom
  9813. @cindex template, custom
  9814. This section explores the internals of the @acronym{ODT} exporter and the
  9815. means by which it produces styled documents. Read this section if you are
  9816. interested in exploring the automatic and custom OpenDocument styles used by
  9817. the exporter.
  9818. @anchor{x-factory-styles}
  9819. @subsubheading Factory styles
  9820. The @acronym{ODT} exporter relies on two files for generating its output.
  9821. These files are bundled with the distribution under the directory pointed to
  9822. by the variable @code{org-odt-styles-dir}. The two files are:
  9823. @itemize
  9824. @anchor{x-orgodtstyles-xml}
  9825. @item
  9826. @file{OrgOdtStyles.xml}
  9827. This file contributes to the @file{styles.xml} file of the final @samp{ODT}
  9828. document. This file gets modified for the following purposes:
  9829. @enumerate
  9830. @item
  9831. To control outline numbering based on user settings.
  9832. @item
  9833. To add styles generated by @file{htmlfontify.el} for fontification of code
  9834. blocks.
  9835. @end enumerate
  9836. @anchor{x-orgodtcontenttemplate-xml}
  9837. @item
  9838. @file{OrgOdtContentTemplate.xml}
  9839. This file contributes to the @file{content.xml} file of the final @samp{ODT}
  9840. document. The contents of the Org outline are inserted between the
  9841. @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
  9842. Apart from serving as a template file for the final @file{content.xml}, the
  9843. file serves the following purposes:
  9844. @enumerate
  9845. @item
  9846. It contains automatic styles for formatting of tables which are referenced by
  9847. the exporter.
  9848. @item
  9849. It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
  9850. elements that control how various entities - tables, images, equations etc -
  9851. are numbered.
  9852. @end enumerate
  9853. @end itemize
  9854. @anchor{x-overriding-factory-styles}
  9855. @subsubheading Overriding factory styles
  9856. The following two variables control the location from which the @acronym{ODT}
  9857. exporter picks up the custom styles and content template files. You can
  9858. customize these variables to override the factory styles used by the
  9859. exporter.
  9860. @itemize
  9861. @anchor{x-org-export-odt-styles-file}
  9862. @item
  9863. @code{org-export-odt-styles-file}
  9864. Use this variable to specify the @file{styles.xml} that will be used in the
  9865. final output. You can specify one of the following values:
  9866. @enumerate
  9867. @item A @file{styles.xml} file
  9868. Use this file instead of the default @file{styles.xml}
  9869. @item A @file{.odt} or @file{.ott} file
  9870. Use the @file{styles.xml} contained in the specified OpenDocument Text or
  9871. Template file
  9872. @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
  9873. Use the @file{styles.xml} contained in the specified OpenDocument Text or
  9874. Template file. Additionally extract the specified member files and embed
  9875. those within the final @samp{ODT} document.
  9876. Use this option if the @file{styles.xml} file references additional files
  9877. like header and footer images.
  9878. @item @code{nil}
  9879. Use the default @file{styles.xml}
  9880. @end enumerate
  9881. @anchor{x-org-export-odt-content-template-file}
  9882. @item
  9883. @code{org-export-odt-content-template-file}
  9884. Use this variable to specify the blank @file{content.xml} that will be used
  9885. in the final output.
  9886. @end itemize
  9887. @node Creating one-off styles, Customizing tables in @acronym{ODT} export, Working with OpenDocument style files, Advanced topics in @acronym{ODT} export
  9888. @subsubsection Creating one-off styles
  9889. There are times when you would want one-off formatting in the exported
  9890. document. You can achieve this by embedding raw OpenDocument XML in the Org
  9891. file. The use of this feature is better illustrated with couple of examples.
  9892. @enumerate
  9893. @item Embedding ODT tags as part of regular text
  9894. You can include simple OpenDocument tags by prefixing them with
  9895. @samp{@@}. For example, to highlight a region of text do the following:
  9896. @example
  9897. @@<text:span text:style-name="Highlight">This is a
  9898. highlighted text@@</text:span>. But this is a
  9899. regular text.
  9900. @end example
  9901. @strong{Hint:} To see the above example in action, edit your
  9902. @file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
  9903. custom @samp{Highlight} style as shown below.
  9904. @example
  9905. <style:style style:name="Highlight" style:family="text">
  9906. <style:text-properties fo:background-color="#ff0000"/>
  9907. </style:style>
  9908. @end example
  9909. @item Embedding a one-line OpenDocument XML
  9910. You can add a simple OpenDocument one-liner using the @code{#+ODT:}
  9911. directive. For example, to force a page break do the following:
  9912. @example
  9913. #+ODT: <text:p text:style-name="PageBreak"/>
  9914. @end example
  9915. @strong{Hint:} To see the above example in action, edit your
  9916. @file{styles.xml}(@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
  9917. custom @samp{PageBreak} style as shown below.
  9918. @example
  9919. <style:style style:name="PageBreak" style:family="paragraph"
  9920. style:parent-style-name="Text_20_body">
  9921. <style:paragraph-properties fo:break-before="page"/>
  9922. </style:style>
  9923. @end example
  9924. @item Embedding a block of OpenDocument XML
  9925. You can add a large block of OpenDocument XML using the
  9926. @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
  9927. For example, to create a one-off paragraph that uses bold text, do the
  9928. following:
  9929. @example
  9930. #+BEGIN_ODT
  9931. <text:p text:style-name="Text_20_body_20_bold">
  9932. This paragraph is specially formatted and uses bold text.
  9933. </text:p>
  9934. #+END_ODT
  9935. @end example
  9936. @end enumerate
  9937. @node Customizing tables in @acronym{ODT} export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in @acronym{ODT} export
  9938. @subsubsection Customizing tables in @acronym{ODT} export
  9939. @cindex tables, in ODT export
  9940. @cindex #+ATTR_ODT
  9941. You can override the default formatting of the table by specifying a custom
  9942. table style with the @code{#+ATTR_ODT} line. For a discussion on default
  9943. formatting of tables @pxref{Tables in @acronym{ODT} export}.
  9944. This feature closely mimics the way table templates are defined in the
  9945. OpenDocument-v1.2
  9946. specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
  9947. OpenDocument-v1.2 Specification}}
  9948. @subsubheading Custom table styles - an illustration
  9949. To have a quick preview of this feature, install the below setting and export
  9950. the table that follows.
  9951. @lisp
  9952. (setq org-export-odt-table-styles
  9953. (append org-export-odt-table-styles
  9954. '(("TableWithHeaderRowAndColumn" "Custom"
  9955. ((use-first-row-styles . t)
  9956. (use-first-column-styles . t)))
  9957. ("TableWithFirstRowandLastRow" "Custom"
  9958. ((use-first-row-styles . t)
  9959. (use-last-row-styles . t))))))
  9960. @end lisp
  9961. @example
  9962. #+ATTR_ODT: TableWithHeaderRowAndColumn
  9963. | Name | Phone | Age |
  9964. | Peter | 1234 | 17 |
  9965. | Anna | 4321 | 25 |
  9966. @end example
  9967. In the above example, you used a template named @samp{Custom} and installed
  9968. two table styles with the names @samp{TableWithHeaderRowAndColumn} and
  9969. @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
  9970. styles needed for producing the above template have been pre-defined for you.
  9971. These styles are available under the section marked @samp{Custom Table
  9972. Template} in @file{OrgOdtContentTemplate.xml}
  9973. (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
  9974. additional templates you have to define these styles yourselves.
  9975. @subsubheading Custom table styles - the nitty-gritty
  9976. To use this feature proceed as follows:
  9977. @enumerate
  9978. @item
  9979. Create a table template@footnote{See the @code{<table:table-template>}
  9980. element of the OpenDocument-v1.2 specification}
  9981. A table template is nothing but a set of @samp{table-cell} and
  9982. @samp{paragraph} styles for each of the following table cell categories:
  9983. @itemize @minus
  9984. @item Body
  9985. @item First column
  9986. @item Last column
  9987. @item First row
  9988. @item Last row
  9989. @item Even row
  9990. @item Odd row
  9991. @item Even column
  9992. @item Odd Column
  9993. @end itemize
  9994. The names for the above styles must be chosen based on the name of the table
  9995. template using a well-defined convention.
  9996. The naming convention is better illustrated with an example. For a table
  9997. template with the name @samp{Custom}, the needed style names are listed in
  9998. the following table.
  9999. @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
  10000. @headitem Table cell type
  10001. @tab @code{table-cell} style
  10002. @tab @code{paragraph} style
  10003. @item
  10004. @tab
  10005. @tab
  10006. @item Body
  10007. @tab @samp{CustomTableCell}
  10008. @tab @samp{CustomTableParagraph}
  10009. @item First column
  10010. @tab @samp{CustomFirstColumnTableCell}
  10011. @tab @samp{CustomFirstColumnTableParagraph}
  10012. @item Last column
  10013. @tab @samp{CustomLastColumnTableCell}
  10014. @tab @samp{CustomLastColumnTableParagraph}
  10015. @item First row
  10016. @tab @samp{CustomFirstRowTableCell}
  10017. @tab @samp{CustomFirstRowTableParagraph}
  10018. @item Last row
  10019. @tab @samp{CustomLastRowTableCell}
  10020. @tab @samp{CustomLastRowTableParagraph}
  10021. @item Even row
  10022. @tab @samp{CustomEvenRowTableCell}
  10023. @tab @samp{CustomEvenRowTableParagraph}
  10024. @item Odd row
  10025. @tab @samp{CustomOddRowTableCell}
  10026. @tab @samp{CustomOddRowTableParagraph}
  10027. @item Even column
  10028. @tab @samp{CustomEvenColumnTableCell}
  10029. @tab @samp{CustomEvenColumnTableParagraph}
  10030. @item Odd column
  10031. @tab @samp{CustomOddColumnTableCell}
  10032. @tab @samp{CustomOddColumnTableParagraph}
  10033. @end multitable
  10034. To create a table template with the name @samp{Custom}, define the above
  10035. styles in the
  10036. @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
  10037. of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
  10038. styles}).
  10039. @item
  10040. Define a table style@footnote{See the attributes @code{table:template-name},
  10041. @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
  10042. @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
  10043. @code{table:use-banding-rows-styles}, and
  10044. @code{table:use-banding-column-styles} of the @code{<table:table>} element in
  10045. the OpenDocument-v1.2 specification}
  10046. @vindex org-export-odt-table-styles
  10047. To define a table style, create an entry for the style in the variable
  10048. @code{org-export-odt-table-styles} and specify the following:
  10049. @itemize @minus
  10050. @item the name of the table template created in step (1)
  10051. @item the set of cell styles in that template that are to be activated
  10052. @end itemize
  10053. For example, the entry below defines two different table styles
  10054. @samp{TableWithHeaderRowsAndColumns} and @samp{TableWithHeaderColumns} based
  10055. on the same template @samp{Custom}. The styles achieve their intended effect
  10056. by selectively activating the individual cell styles in that template.
  10057. @lisp
  10058. (setq org-export-odt-table-styles
  10059. (append org-export-odt-table-styles
  10060. '(("TableWithHeaderRowAndColumn" "Custom"
  10061. ((use-first-row-styles . t)
  10062. (use-first-column-styles . t)))
  10063. ("TableWithFirstRowandLastRow" "Custom"
  10064. ((use-first-row-styles . t)
  10065. (use-last-row-styles . t))))))
  10066. @end lisp
  10067. @item
  10068. Associate a table with the table style
  10069. To do this, specify the table style created in step (2) as part of
  10070. the @code{ATTR_ODT} line as shown below.
  10071. @example
  10072. #+ATTR_ODT: TableWithHeaderRowAndColumn
  10073. | Name | Phone | Age |
  10074. | Peter | 1234 | 17 |
  10075. | Anna | 4321 | 25 |
  10076. @end example
  10077. @end enumerate
  10078. @node Validating OpenDocument XML, , Customizing tables in @acronym{ODT} export, Advanced topics in @acronym{ODT} export
  10079. @subsubsection Validating OpenDocument XML
  10080. Occasionally, you will discover that the document created by the
  10081. @acronym{ODT} exporter cannot be opened by your favorite application. One of
  10082. the common reasons for this is that the @file{.odt} file is corrupt. In such
  10083. cases, you may want to validate the document against the OpenDocument RELAX
  10084. NG Compact Syntax (RNC) schema.
  10085. For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
  10086. nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
  10087. general help with validation (and schema-sensitive editing) of XML files:
  10088. @inforef{Introduction,,nxml-mode}.
  10089. @vindex org-export-odt-schema-dir
  10090. If you have ready access to OpenDocument @file{.rnc} files and the needed
  10091. schema-locating rules in a single folder, you can customize the variable
  10092. @code{org-export-odt-schema-dir} to point to that directory. The
  10093. @acronym{ODT} exporter will take care of updating the
  10094. @code{rng-schema-locating-files} for you.
  10095. @c end opendocument
  10096. @node TaskJuggler export, Freemind export, OpenDocument Text export, Exporting
  10097. @section TaskJuggler export
  10098. @cindex TaskJuggler export
  10099. @cindex Project management
  10100. @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
  10101. It provides an optimizing scheduler that computes your project time lines and
  10102. resource assignments based on the project outline and the constraints that
  10103. you have provided.
  10104. The TaskJuggler exporter is a bit different from other exporters, such as the
  10105. @code{HTML} and @LaTeX{} exporters for example, in that it does not export all the
  10106. nodes of a document or strictly follow the order of the nodes in the
  10107. document.
  10108. Instead the TaskJuggler exporter looks for a tree that defines the tasks and
  10109. a optionally tree that defines the resources for this project. It then
  10110. creates a TaskJuggler file based on these trees and the attributes defined in
  10111. all the nodes.
  10112. @subsection TaskJuggler export commands
  10113. @table @kbd
  10114. @orgcmd{C-c C-e j,org-export-as-taskjuggler}
  10115. Export as TaskJuggler file.
  10116. @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
  10117. Export as TaskJuggler file and then open the file with TaskJugglerUI.
  10118. @end table
  10119. @subsection Tasks
  10120. @vindex org-export-taskjuggler-project-tag
  10121. Create your tasks as you usually do with Org mode. Assign efforts to each
  10122. task using properties (it is easiest to do this in the column view). You
  10123. should end up with something similar to the example by Peter Jones in
  10124. @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
  10125. Now mark the top node of your tasks with a tag named
  10126. @code{:taskjuggler_project:} (or whatever you customized
  10127. @code{org-export-taskjuggler-project-tag} to). You are now ready to export
  10128. the project plan with @kbd{C-c C-e J} which will export the project plan and
  10129. open a gantt chart in TaskJugglerUI.
  10130. @subsection Resources
  10131. @vindex org-export-taskjuggler-resource-tag
  10132. Next you can define resources and assign those to work on specific tasks. You
  10133. can group your resources hierarchically. Tag the top node of the resources
  10134. with @code{:taskjuggler_resource:} (or whatever you customized
  10135. @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
  10136. identifier (named @samp{resource_id}) to the resources (using the standard
  10137. Org properties commands, @pxref{Property syntax}) or you can let the exporter
  10138. generate identifiers automatically (the exporter picks the first word of the
  10139. headline as the identifier as long as it is unique---see the documentation of
  10140. @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
  10141. allocate resources to tasks. This is again done with the @samp{allocate}
  10142. property on the tasks. Do this in column view or when on the task type
  10143. @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
  10144. Once the allocations are done you can again export to TaskJuggler and check
  10145. in the Resource Allocation Graph which person is working on what task at what
  10146. time.
  10147. @subsection Export of properties
  10148. The exporter also takes TODO state information into consideration, i.e.@: if a
  10149. task is marked as done it will have the corresponding attribute in
  10150. TaskJuggler (@samp{complete 100}). Also it will export any property on a task
  10151. resource or resource node which is known to TaskJuggler, such as
  10152. @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
  10153. @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
  10154. @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
  10155. @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
  10156. @samp{scheduling}, etc for tasks.
  10157. @subsection Dependencies
  10158. The exporter will handle dependencies that are defined in the tasks either
  10159. with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
  10160. @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
  10161. @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
  10162. attribute can be either @samp{previous-sibling} or a reference to an
  10163. identifier (named @samp{task_id}) which is defined for another task in the
  10164. project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
  10165. dependencies separated by either space or comma. You can also specify
  10166. optional attributes on the dependency by simply appending it. The following
  10167. examples should illustrate this:
  10168. @example
  10169. * Preparation
  10170. :PROPERTIES:
  10171. :task_id: preparation
  10172. :ORDERED: t
  10173. :END:
  10174. * Training material
  10175. :PROPERTIES:
  10176. :task_id: training_material
  10177. :ORDERED: t
  10178. :END:
  10179. ** Markup Guidelines
  10180. :PROPERTIES:
  10181. :Effort: 2d
  10182. :END:
  10183. ** Workflow Guidelines
  10184. :PROPERTIES:
  10185. :Effort: 2d
  10186. :END:
  10187. * Presentation
  10188. :PROPERTIES:
  10189. :Effort: 2d
  10190. :BLOCKER: training_material @{ gapduration 1d @} preparation
  10191. :END:
  10192. @end example
  10193. @subsection Reports
  10194. @vindex org-export-taskjuggler-default-reports
  10195. TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource
  10196. allocation, etc). The user defines what kind of reports should be generated
  10197. for a project in the TaskJuggler file. The exporter will automatically insert
  10198. some default reports in the file. These defaults are defined in
  10199. @code{org-export-taskjuggler-default-reports}. They can be modified using
  10200. customize along with a number of other options. For a more complete list, see
  10201. @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
  10202. For more information and examples see the Org-taskjuggler tutorial at
  10203. @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
  10204. @node Freemind export, XOXO export, TaskJuggler export, Exporting
  10205. @section Freemind export
  10206. @cindex Freemind export
  10207. @cindex mind map
  10208. The Freemind exporter was written by Lennart Borgman.
  10209. @table @kbd
  10210. @orgcmd{C-c C-e m,org-export-as-freemind}
  10211. Export as Freemind mind map. For an Org file @file{myfile.org}, the Freemind
  10212. file will be @file{myfile.mm}.
  10213. @end table
  10214. @node XOXO export, iCalendar export, Freemind export, Exporting
  10215. @section XOXO export
  10216. @cindex XOXO export
  10217. Org mode contains an exporter that produces XOXO-style output.
  10218. Currently, this exporter only handles the general outline structure and
  10219. does not interpret any additional Org mode features.
  10220. @table @kbd
  10221. @orgcmd{C-c C-e x,org-export-as-xoxo}
  10222. Export as XOXO file. For an Org file @file{myfile.org}, the XOXO file will be
  10223. @file{myfile.html}.
  10224. @orgkey{C-c C-e v x}
  10225. Export only the visible part of the document.
  10226. @end table
  10227. @node iCalendar export, , XOXO export, Exporting
  10228. @section iCalendar export
  10229. @cindex iCalendar export
  10230. @vindex org-icalendar-include-todo
  10231. @vindex org-icalendar-use-deadline
  10232. @vindex org-icalendar-use-scheduled
  10233. @vindex org-icalendar-categories
  10234. @vindex org-icalendar-alarm-time
  10235. Some people use Org mode for keeping track of projects, but still prefer a
  10236. standard calendar application for anniversaries and appointments. In this
  10237. case it can be useful to show deadlines and other time-stamped items in Org
  10238. files in the calendar application. Org mode can export calendar information
  10239. in the standard iCalendar format. If you also want to have TODO entries
  10240. included in the export, configure the variable
  10241. @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
  10242. and TODO items as VTODO. It will also create events from deadlines that are
  10243. in non-TODO items. Deadlines and scheduling dates in TODO items will be used
  10244. to set the start and due dates for the TODO entry@footnote{See the variables
  10245. @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
  10246. As categories, it will use the tags locally defined in the heading, and the
  10247. file/tree category@footnote{To add inherited tags or the TODO state,
  10248. configure the variable @code{org-icalendar-categories}.}. See the variable
  10249. @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
  10250. time.
  10251. @vindex org-icalendar-store-UID
  10252. @cindex property, ID
  10253. The iCalendar standard requires each entry to have a globally unique
  10254. identifier (UID). Org creates these identifiers during export. If you set
  10255. the variable @code{org-icalendar-store-UID}, the UID will be stored in the
  10256. @code{:ID:} property of the entry and re-used next time you report this
  10257. entry. Since a single entry can give rise to multiple iCalendar entries (as
  10258. a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
  10259. prefixes to the UID, depending on what triggered the inclusion of the entry.
  10260. In this way the UID remains unique, but a synchronization program can still
  10261. figure out from which entry all the different instances originate.
  10262. @table @kbd
  10263. @orgcmd{C-c C-e i,org-export-icalendar-this-file}
  10264. Create iCalendar entries for the current file and store them in the same
  10265. directory, using a file extension @file{.ics}.
  10266. @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
  10267. @vindex org-agenda-files
  10268. Like @kbd{C-c C-e i}, but do this for all files in
  10269. @code{org-agenda-files}. For each of these files, a separate iCalendar
  10270. file will be written.
  10271. @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
  10272. @vindex org-combined-agenda-icalendar-file
  10273. Create a single large iCalendar file from all files in
  10274. @code{org-agenda-files} and write it to the file given by
  10275. @code{org-combined-agenda-icalendar-file}.
  10276. @end table
  10277. @vindex org-use-property-inheritance
  10278. @vindex org-icalendar-include-body
  10279. @cindex property, SUMMARY
  10280. @cindex property, DESCRIPTION
  10281. @cindex property, LOCATION
  10282. The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
  10283. property can be inherited from higher in the hierarchy if you configure
  10284. @code{org-use-property-inheritance} accordingly.} properties if the selected
  10285. entries have them. If not, the summary will be derived from the headline,
  10286. and the description from the body (limited to
  10287. @code{org-icalendar-include-body} characters).
  10288. How this calendar is best read and updated, depends on the application
  10289. you are using. The FAQ covers this issue.
  10290. @node Publishing, Working With Source Code, Exporting, Top
  10291. @chapter Publishing
  10292. @cindex publishing
  10293. Org includes a publishing management system that allows you to configure
  10294. automatic HTML conversion of @emph{projects} composed of interlinked org
  10295. files. You can also configure Org to automatically upload your exported HTML
  10296. pages and related attachments, such as images and source code files, to a web
  10297. server.
  10298. You can also use Org to convert files into PDF, or even combine HTML and PDF
  10299. conversion so that files are available in both formats on the server.
  10300. Publishing has been contributed to Org by David O'Toole.
  10301. @menu
  10302. * Configuration:: Defining projects
  10303. * Uploading files:: How to get files up on the server
  10304. * Sample configuration:: Example projects
  10305. * Triggering publication:: Publication commands
  10306. @end menu
  10307. @node Configuration, Uploading files, Publishing, Publishing
  10308. @section Configuration
  10309. Publishing needs significant configuration to specify files, destination
  10310. and many other properties of a project.
  10311. @menu
  10312. * Project alist:: The central configuration variable
  10313. * Sources and destinations:: From here to there
  10314. * Selecting files:: What files are part of the project?
  10315. * Publishing action:: Setting the function doing the publishing
  10316. * Publishing options:: Tweaking HTML/@LaTeX{} export
  10317. * Publishing links:: Which links keep working after publishing?
  10318. * Sitemap:: Generating a list of all pages
  10319. * Generating an index:: An index that reaches across pages
  10320. @end menu
  10321. @node Project alist, Sources and destinations, Configuration, Configuration
  10322. @subsection The variable @code{org-publish-project-alist}
  10323. @cindex org-publish-project-alist
  10324. @cindex projects, for publishing
  10325. @vindex org-publish-project-alist
  10326. Publishing is configured almost entirely through setting the value of one
  10327. variable, called @code{org-publish-project-alist}. Each element of the list
  10328. configures one project, and may be in one of the two following forms:
  10329. @lisp
  10330. ("project-name" :property value :property value ...)
  10331. @r{i.e.@: a well-formed property list with alternating keys and values}
  10332. @r{or}
  10333. ("project-name" :components ("project-name" "project-name" ...))
  10334. @end lisp
  10335. In both cases, projects are configured by specifying property values. A
  10336. project defines the set of files that will be published, as well as the
  10337. publishing configuration to use when publishing those files. When a project
  10338. takes the second form listed above, the individual members of the
  10339. @code{:components} property are taken to be sub-projects, which group
  10340. together files requiring different publishing options. When you publish such
  10341. a ``meta-project'', all the components will also be published, in the
  10342. sequence given.
  10343. @node Sources and destinations, Selecting files, Project alist, Configuration
  10344. @subsection Sources and destinations for files
  10345. @cindex directories, for publishing
  10346. Most properties are optional, but some should always be set. In
  10347. particular, Org needs to know where to look for source files,
  10348. and where to put published files.
  10349. @multitable @columnfractions 0.3 0.7
  10350. @item @code{:base-directory}
  10351. @tab Directory containing publishing source files
  10352. @item @code{:publishing-directory}
  10353. @tab Directory where output files will be published. You can directly
  10354. publish to a webserver using a file name syntax appropriate for
  10355. the Emacs @file{tramp} package. Or you can publish to a local directory and
  10356. use external tools to upload your website (@pxref{Uploading files}).
  10357. @item @code{:preparation-function}
  10358. @tab Function or list of functions to be called before starting the
  10359. publishing process, for example, to run @code{make} for updating files to be
  10360. published. The project property list is scoped into this call as the
  10361. variable @code{project-plist}.
  10362. @item @code{:completion-function}
  10363. @tab Function or list of functions called after finishing the publishing
  10364. process, for example, to change permissions of the resulting files. The
  10365. project property list is scoped into this call as the variable
  10366. @code{project-plist}.
  10367. @end multitable
  10368. @noindent
  10369. @node Selecting files, Publishing action, Sources and destinations, Configuration
  10370. @subsection Selecting files
  10371. @cindex files, selecting for publishing
  10372. By default, all files with extension @file{.org} in the base directory
  10373. are considered part of the project. This can be modified by setting the
  10374. properties
  10375. @multitable @columnfractions 0.25 0.75
  10376. @item @code{:base-extension}
  10377. @tab Extension (without the dot!) of source files. This actually is a
  10378. regular expression. Set this to the symbol @code{any} if you want to get all
  10379. files in @code{:base-directory}, even without extension.
  10380. @item @code{:exclude}
  10381. @tab Regular expression to match file names that should not be
  10382. published, even though they have been selected on the basis of their
  10383. extension.
  10384. @item @code{:include}
  10385. @tab List of files to be included regardless of @code{:base-extension}
  10386. and @code{:exclude}.
  10387. @item @code{:recursive}
  10388. @tab Non-nil means, check base-directory recursively for files to publish.
  10389. @end multitable
  10390. @node Publishing action, Publishing options, Selecting files, Configuration
  10391. @subsection Publishing action
  10392. @cindex action, for publishing
  10393. Publishing means that a file is copied to the destination directory and
  10394. possibly transformed in the process. The default transformation is to export
  10395. Org files as HTML files, and this is done by the function
  10396. @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
  10397. export}). But you also can publish your content as PDF files using
  10398. @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
  10399. @code{utf8} encoded files using the corresponding functions. If you want to
  10400. publish the Org file itself, but with @i{archived}, @i{commented}, and
  10401. @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
  10402. parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
  10403. produce @file{file.org} and @file{file.org.html} in the publishing
  10404. directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
  10405. source and publishing directories are equal. Note that with this kind of
  10406. setup, you need to add @code{:exclude "-source\\.org"} to the project
  10407. definition in @code{org-publish-project-alist} to prevent the published
  10408. source files from being considered as new org files the next time the project
  10409. is published.}. Other files like images only need to be copied to the
  10410. publishing destination; for this you may use @code{org-publish-attachment}.
  10411. For non-Org files, you always need to specify the publishing function:
  10412. @multitable @columnfractions 0.3 0.7
  10413. @item @code{:publishing-function}
  10414. @tab Function executing the publication of a file. This may also be a
  10415. list of functions, which will all be called in turn.
  10416. @item @code{:plain-source}
  10417. @tab Non-nil means, publish plain source.
  10418. @item @code{:htmlized-source}
  10419. @tab Non-nil means, publish htmlized source.
  10420. @end multitable
  10421. The function must accept three arguments: a property list containing at least
  10422. a @code{:publishing-directory} property, the name of the file to be
  10423. published, and the path to the publishing directory of the output file. It
  10424. should take the specified file, make the necessary transformation (if any)
  10425. and place the result into the destination folder.
  10426. @node Publishing options, Publishing links, Publishing action, Configuration
  10427. @subsection Options for the HTML/@LaTeX{} exporters
  10428. @cindex options, for publishing
  10429. The property list can be used to set many export options for the HTML
  10430. and @LaTeX{} exporters. In most cases, these properties correspond to user
  10431. variables in Org. The table below lists these properties along
  10432. with the variable they belong to. See the documentation string for the
  10433. respective variable for details.
  10434. @vindex org-export-html-link-up
  10435. @vindex org-export-html-link-home
  10436. @vindex org-export-default-language
  10437. @vindex org-display-custom-times
  10438. @vindex org-export-headline-levels
  10439. @vindex org-export-with-section-numbers
  10440. @vindex org-export-section-number-format
  10441. @vindex org-export-with-toc
  10442. @vindex org-export-preserve-breaks
  10443. @vindex org-export-with-archived-trees
  10444. @vindex org-export-with-emphasize
  10445. @vindex org-export-with-sub-superscripts
  10446. @vindex org-export-with-special-strings
  10447. @vindex org-export-with-footnotes
  10448. @vindex org-export-with-drawers
  10449. @vindex org-export-with-tags
  10450. @vindex org-export-with-todo-keywords
  10451. @vindex org-export-with-tasks
  10452. @vindex org-export-with-done-tasks
  10453. @vindex org-export-with-priority
  10454. @vindex org-export-with-TeX-macros
  10455. @vindex org-export-with-LaTeX-fragments
  10456. @vindex org-export-skip-text-before-1st-heading
  10457. @vindex org-export-with-fixed-width
  10458. @vindex org-export-with-timestamps
  10459. @vindex org-export-author-info
  10460. @vindex org-export-email-info
  10461. @vindex org-export-creator-info
  10462. @vindex org-export-time-stamp-file
  10463. @vindex org-export-with-tables
  10464. @vindex org-export-highlight-first-table-line
  10465. @vindex org-export-html-style-include-default
  10466. @vindex org-export-html-style-include-scripts
  10467. @vindex org-export-html-style
  10468. @vindex org-export-html-style-extra
  10469. @vindex org-export-html-link-org-files-as-html
  10470. @vindex org-export-html-inline-images
  10471. @vindex org-export-html-extension
  10472. @vindex org-export-html-table-tag
  10473. @vindex org-export-html-expand
  10474. @vindex org-export-html-with-timestamp
  10475. @vindex org-export-publishing-directory
  10476. @vindex org-export-html-preamble
  10477. @vindex org-export-html-postamble
  10478. @vindex user-full-name
  10479. @vindex user-mail-address
  10480. @vindex org-export-select-tags
  10481. @vindex org-export-exclude-tags
  10482. @multitable @columnfractions 0.32 0.68
  10483. @item @code{:link-up} @tab @code{org-export-html-link-up}
  10484. @item @code{:link-home} @tab @code{org-export-html-link-home}
  10485. @item @code{:language} @tab @code{org-export-default-language}
  10486. @item @code{:customtime} @tab @code{org-display-custom-times}
  10487. @item @code{:headline-levels} @tab @code{org-export-headline-levels}
  10488. @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
  10489. @item @code{:section-number-format} @tab @code{org-export-section-number-format}
  10490. @item @code{:table-of-contents} @tab @code{org-export-with-toc}
  10491. @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
  10492. @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
  10493. @item @code{:emphasize} @tab @code{org-export-with-emphasize}
  10494. @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
  10495. @item @code{:special-strings} @tab @code{org-export-with-special-strings}
  10496. @item @code{:footnotes} @tab @code{org-export-with-footnotes}
  10497. @item @code{:drawers} @tab @code{org-export-with-drawers}
  10498. @item @code{:tags} @tab @code{org-export-with-tags}
  10499. @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
  10500. @item @code{:tasks} @tab @code{org-export-with-tasks}
  10501. @item @code{:priority} @tab @code{org-export-with-priority}
  10502. @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
  10503. @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
  10504. @item @code{:latex-listings} @tab @code{org-export-latex-listings}
  10505. @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
  10506. @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
  10507. @item @code{:timestamps} @tab @code{org-export-with-timestamps}
  10508. @item @code{:author} @tab @code{user-full-name}
  10509. @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
  10510. @item @code{:author-info} @tab @code{org-export-author-info}
  10511. @item @code{:email-info} @tab @code{org-export-email-info}
  10512. @item @code{:creator-info} @tab @code{org-export-creator-info}
  10513. @item @code{:tables} @tab @code{org-export-with-tables}
  10514. @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
  10515. @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
  10516. @item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
  10517. @item @code{:style} @tab @code{org-export-html-style}
  10518. @item @code{:style-extra} @tab @code{org-export-html-style-extra}
  10519. @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
  10520. @item @code{:inline-images} @tab @code{org-export-html-inline-images}
  10521. @item @code{:html-extension} @tab @code{org-export-html-extension}
  10522. @item @code{:html-preamble} @tab @code{org-export-html-preamble}
  10523. @item @code{:html-postamble} @tab @code{org-export-html-postamble}
  10524. @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
  10525. @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
  10526. @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
  10527. @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
  10528. @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
  10529. @item @code{:select-tags} @tab @code{org-export-select-tags}
  10530. @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
  10531. @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
  10532. @end multitable
  10533. Most of the @code{org-export-with-*} variables have the same effect in
  10534. both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
  10535. @code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the
  10536. @LaTeX{} export. See @code{org-export-plist-vars} to check this list of
  10537. options.
  10538. @vindex org-publish-project-alist
  10539. When a property is given a value in @code{org-publish-project-alist},
  10540. its setting overrides the value of the corresponding user variable (if
  10541. any) during publishing. Options set within a file (@pxref{Export
  10542. options}), however, override everything.
  10543. @node Publishing links, Sitemap, Publishing options, Configuration
  10544. @subsection Links between published files
  10545. @cindex links, publishing
  10546. To create a link from one Org file to another, you would use
  10547. something like @samp{[[file:foo.org][The foo]]} or simply
  10548. @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
  10549. becomes a link to @file{foo.html}. In this way, you can interlink the
  10550. pages of your "org web" project and the links will work as expected when
  10551. you publish them to HTML. If you also publish the Org source file and want
  10552. to link to that, use an @code{http:} link instead of a @code{file:} link,
  10553. because @code{file:} links are converted to link to the corresponding
  10554. @file{html} file.
  10555. You may also link to related files, such as images. Provided you are careful
  10556. with relative file names, and provided you have also configured Org to upload
  10557. the related files, these links will work too. See @ref{Complex example}, for
  10558. an example of this usage.
  10559. Sometimes an Org file to be published may contain links that are
  10560. only valid in your production environment, but not in the publishing
  10561. location. In this case, use the property
  10562. @multitable @columnfractions 0.4 0.6
  10563. @item @code{:link-validation-function}
  10564. @tab Function to validate links
  10565. @end multitable
  10566. @noindent
  10567. to define a function for checking link validity. This function must
  10568. accept two arguments, the file name and a directory relative to which
  10569. the file name is interpreted in the production environment. If this
  10570. function returns @code{nil}, then the HTML generator will only insert a
  10571. description into the HTML file, but no link. One option for this
  10572. function is @code{org-publish-validate-link} which checks if the given
  10573. file is part of any project in @code{org-publish-project-alist}.
  10574. @node Sitemap, Generating an index, Publishing links, Configuration
  10575. @subsection Generating a sitemap
  10576. @cindex sitemap, of published pages
  10577. The following properties may be used to control publishing of
  10578. a map of files for a given project.
  10579. @multitable @columnfractions 0.35 0.65
  10580. @item @code{:auto-sitemap}
  10581. @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
  10582. or @code{org-publish-all}.
  10583. @item @code{:sitemap-filename}
  10584. @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
  10585. becomes @file{sitemap.html}).
  10586. @item @code{:sitemap-title}
  10587. @tab Title of sitemap page. Defaults to name of file.
  10588. @item @code{:sitemap-function}
  10589. @tab Plug-in function to use for generation of the sitemap.
  10590. Defaults to @code{org-publish-org-sitemap}, which generates a plain list
  10591. of links to all files in the project.
  10592. @item @code{:sitemap-sort-folders}
  10593. @tab Where folders should appear in the sitemap. Set this to @code{first}
  10594. (default) or @code{last} to display folders first or last,
  10595. respectively. Any other value will mix files and folders.
  10596. @item @code{:sitemap-sort-files}
  10597. @tab How the files are sorted in the site map. Set this to
  10598. @code{alphabetically} (default), @code{chronologically} or
  10599. @code{anti-chronologically}. @code{chronologically} sorts the files with
  10600. older date first while @code{anti-chronologically} sorts the files with newer
  10601. date first. @code{alphabetically} sorts the files alphabetically. The date of
  10602. a file is retrieved with @code{org-publish-find-date}.
  10603. @item @code{:sitemap-ignore-case}
  10604. @tab Should sorting be case-sensitive? Default @code{nil}.
  10605. @item @code{:sitemap-file-entry-format}
  10606. @tab With this option one can tell how a sitemap's entry is formatted in the
  10607. sitemap. This is a format string with some escape sequences: @code{%t} stands
  10608. for the title of the file, @code{%a} stands for the author of the file and
  10609. @code{%d} stands for the date of the file. The date is retrieved with the
  10610. @code{org-publish-find-date} function and formatted with
  10611. @code{org-publish-sitemap-date-format}. Default @code{%t}.
  10612. @item @code{:sitemap-date-format}
  10613. @tab Format string for the @code{format-time-string} function that tells how
  10614. a sitemap entry's date is to be formatted. This property bypasses
  10615. @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
  10616. @item @code{:sitemap-sans-extension}
  10617. @tab When non-nil, remove filenames' extensions from the generated sitemap.
  10618. Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
  10619. Defaults to @code{nil}.
  10620. @end multitable
  10621. @node Generating an index, , Sitemap, Configuration
  10622. @subsection Generating an index
  10623. @cindex index, in a publishing project
  10624. Org mode can generate an index across the files of a publishing project.
  10625. @multitable @columnfractions 0.25 0.75
  10626. @item @code{:makeindex}
  10627. @tab When non-nil, generate in index in the file @file{theindex.org} and
  10628. publish it as @file{theindex.html}.
  10629. @end multitable
  10630. The file will be created when first publishing a project with the
  10631. @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
  10632. "theindex.inc"}. You can then build around this include statement by adding
  10633. a title, style information, etc.
  10634. @node Uploading files, Sample configuration, Configuration, Publishing
  10635. @section Uploading files
  10636. @cindex rsync
  10637. @cindex unison
  10638. For those people already utilizing third party sync tools such as
  10639. @command{rsync} or @command{unison}, it might be preferable not to use the built in
  10640. @i{remote} publishing facilities of Org mode which rely heavily on
  10641. Tramp. Tramp, while very useful and powerful, tends not to be
  10642. so efficient for multiple file transfer and has been known to cause problems
  10643. under heavy usage.
  10644. Specialized synchronization utilities offer several advantages. In addition
  10645. to timestamp comparison, they also do content and permissions/attribute
  10646. checks. For this reason you might prefer to publish your web to a local
  10647. directory (possibly even @i{in place} with your Org files) and then use
  10648. @file{unison} or @file{rsync} to do the synchronization with the remote host.
  10649. Since Unison (for example) can be configured as to which files to transfer to
  10650. a certain remote destination, it can greatly simplify the project publishing
  10651. definition. Simply keep all files in the correct location, process your Org
  10652. files with @code{org-publish} and let the synchronization tool do the rest.
  10653. You do not need, in this scenario, to include attachments such as @file{jpg},
  10654. @file{css} or @file{gif} files in the project definition since the 3rd party
  10655. tool syncs them.
  10656. Publishing to a local directory is also much faster than to a remote one, so
  10657. that you can afford more easily to republish entire projects. If you set
  10658. @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
  10659. benefit of re-including any changed external files such as source example
  10660. files you might include with @code{#+INCLUDE}. The timestamp mechanism in
  10661. Org is not smart enough to detect if included files have been modified.
  10662. @node Sample configuration, Triggering publication, Uploading files, Publishing
  10663. @section Sample configuration
  10664. Below we provide two example configurations. The first one is a simple
  10665. project publishing only a set of Org files. The second example is
  10666. more complex, with a multi-component project.
  10667. @menu
  10668. * Simple example:: One-component publishing
  10669. * Complex example:: A multi-component publishing example
  10670. @end menu
  10671. @node Simple example, Complex example, Sample configuration, Sample configuration
  10672. @subsection Example: simple publishing configuration
  10673. This example publishes a set of Org files to the @file{public_html}
  10674. directory on the local machine.
  10675. @lisp
  10676. (setq org-publish-project-alist
  10677. '(("org"
  10678. :base-directory "~/org/"
  10679. :publishing-directory "~/public_html"
  10680. :section-numbers nil
  10681. :table-of-contents nil
  10682. :style "<link rel=\"stylesheet\"
  10683. href=\"../other/mystyle.css\"
  10684. type=\"text/css\"/>")))
  10685. @end lisp
  10686. @node Complex example, , Simple example, Sample configuration
  10687. @subsection Example: complex publishing configuration
  10688. This more complicated example publishes an entire website, including
  10689. Org files converted to HTML, image files, Emacs Lisp source code, and
  10690. style sheets. The publishing directory is remote and private files are
  10691. excluded.
  10692. To ensure that links are preserved, care should be taken to replicate
  10693. your directory structure on the web server, and to use relative file
  10694. paths. For example, if your Org files are kept in @file{~/org} and your
  10695. publishable images in @file{~/images}, you would link to an image with
  10696. @c
  10697. @example
  10698. file:../images/myimage.png
  10699. @end example
  10700. @c
  10701. On the web server, the relative path to the image should be the
  10702. same. You can accomplish this by setting up an "images" folder in the
  10703. right place on the web server, and publishing images to it.
  10704. @lisp
  10705. (setq org-publish-project-alist
  10706. '(("orgfiles"
  10707. :base-directory "~/org/"
  10708. :base-extension "org"
  10709. :publishing-directory "/ssh:user@@host:~/html/notebook/"
  10710. :publishing-function org-publish-org-to-html
  10711. :exclude "PrivatePage.org" ;; regexp
  10712. :headline-levels 3
  10713. :section-numbers nil
  10714. :table-of-contents nil
  10715. :style "<link rel=\"stylesheet\"
  10716. href=\"../other/mystyle.css\" type=\"text/css\"/>"
  10717. :html-preamble t)
  10718. ("images"
  10719. :base-directory "~/images/"
  10720. :base-extension "jpg\\|gif\\|png"
  10721. :publishing-directory "/ssh:user@@host:~/html/images/"
  10722. :publishing-function org-publish-attachment)
  10723. ("other"
  10724. :base-directory "~/other/"
  10725. :base-extension "css\\|el"
  10726. :publishing-directory "/ssh:user@@host:~/html/other/"
  10727. :publishing-function org-publish-attachment)
  10728. ("website" :components ("orgfiles" "images" "other"))))
  10729. @end lisp
  10730. @node Triggering publication, , Sample configuration, Publishing
  10731. @section Triggering publication
  10732. Once properly configured, Org can publish with the following commands:
  10733. @table @kbd
  10734. @orgcmd{C-c C-e X,org-publish}
  10735. Prompt for a specific project and publish all files that belong to it.
  10736. @orgcmd{C-c C-e P,org-publish-current-project}
  10737. Publish the project containing the current file.
  10738. @orgcmd{C-c C-e F,org-publish-current-file}
  10739. Publish only the current file.
  10740. @orgcmd{C-c C-e E,org-publish-all}
  10741. Publish every project.
  10742. @end table
  10743. @vindex org-publish-use-timestamps-flag
  10744. Org uses timestamps to track when a file has changed. The above functions
  10745. normally only publish changed files. You can override this and force
  10746. publishing of all files by giving a prefix argument to any of the commands
  10747. above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
  10748. This may be necessary in particular if files include other files via
  10749. @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
  10750. @comment node-name, next, previous, up
  10751. @comment Working With Source Code, Miscellaneous, Publishing, Top
  10752. @node Working With Source Code, Miscellaneous, Publishing, Top
  10753. @chapter Working with source code
  10754. @cindex Schulte, Eric
  10755. @cindex Davison, Dan
  10756. @cindex source code, working with
  10757. Source code can be included in Org mode documents using a @samp{src} block,
  10758. e.g.@:
  10759. @example
  10760. #+BEGIN_SRC emacs-lisp
  10761. (defun org-xor (a b)
  10762. "Exclusive or."
  10763. (if a (not b) b))
  10764. #+END_SRC
  10765. @end example
  10766. Org mode provides a number of features for working with live source code,
  10767. including editing of code blocks in their native major-mode, evaluation of
  10768. code blocks, converting code blocks into source files (known as @dfn{tangling}
  10769. in literate programming), and exporting code blocks and their
  10770. results in several formats. This functionality was contributed by Eric
  10771. Schulte and Dan Davison, and was originally named Org-babel.
  10772. The following sections describe Org mode's code block handling facilities.
  10773. @menu
  10774. * Structure of code blocks:: Code block syntax described
  10775. * Editing source code:: Language major-mode editing
  10776. * Exporting code blocks:: Export contents and/or results
  10777. * Extracting source code:: Create pure source code files
  10778. * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
  10779. * Library of Babel:: Use and contribute to a library of useful code blocks
  10780. * Languages:: List of supported code block languages
  10781. * Header arguments:: Configure code block functionality
  10782. * Results of evaluation:: How evaluation results are handled
  10783. * Noweb reference syntax:: Literate programming in Org mode
  10784. * Key bindings and useful functions:: Work quickly with code blocks
  10785. * Batch execution:: Call functions from the command line
  10786. @end menu
  10787. @comment node-name, next, previous, up
  10788. @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
  10789. @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
  10790. @section Structure of code blocks
  10791. @cindex code block, structure
  10792. @cindex source code, block structure
  10793. @cindex #+NAME
  10794. @cindex #+BEGIN_SRC
  10795. Live code blocks can be specified with a @samp{src} block or
  10796. inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
  10797. @ref{Easy Templates} system} The structure of a @samp{src} block is
  10798. @example
  10799. #+NAME: <name>
  10800. #+BEGIN_SRC <language> <switches> <header arguments>
  10801. <body>
  10802. #+END_SRC
  10803. @end example
  10804. The @code{#+NAME:} line is optional, and can be used to name the code
  10805. block. Live code blocks require that a language be specified on the
  10806. @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
  10807. @cindex source code, inline
  10808. Live code blocks can also be specified inline using
  10809. @example
  10810. src_<language>@{<body>@}
  10811. @end example
  10812. or
  10813. @example
  10814. src_<language>[<header arguments>]@{<body>@}
  10815. @end example
  10816. @table @code
  10817. @item <#+NAME: name>
  10818. This line associates a name with the code block. This is similar to the
  10819. @code{#+TBLNAME: NAME} lines that can be used to name tables in Org mode
  10820. files. Referencing the name of a code block makes it possible to evaluate
  10821. the block from other places in the file, from other files, or from Org mode
  10822. table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
  10823. and the behavior of Org mode when two or more blocks share the same name is
  10824. undefined.
  10825. @cindex #+NAME
  10826. @item <language>
  10827. The language of the code in the block (see @ref{Languages}).
  10828. @cindex source code, language
  10829. @item <switches>
  10830. Optional switches control code block export (see the discussion of switches in
  10831. @ref{Literal examples})
  10832. @cindex source code, switches
  10833. @item <header arguments>
  10834. Optional header arguments control many aspects of evaluation, export and
  10835. tangling of code blocks (see @ref{Header arguments}).
  10836. Header arguments can also be set on a per-buffer or per-subtree
  10837. basis using properties.
  10838. @item source code, header arguments
  10839. @item <body>
  10840. Source code in the specified language.
  10841. @end table
  10842. @comment node-name, next, previous, up
  10843. @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
  10844. @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
  10845. @section Editing source code
  10846. @cindex code block, editing
  10847. @cindex source code, editing
  10848. @kindex C-c '
  10849. Use @kbd{C-c '} to edit the current code block. This brings up
  10850. a language major-mode edit buffer containing the body of the code
  10851. block. Saving this buffer will write the new contents back to the Org
  10852. buffer. Use @kbd{C-c '} again to exit.
  10853. The @code{org-src-mode} minor mode will be active in the edit buffer. The
  10854. following variables can be used to configure the behavior of the edit
  10855. buffer. See also the customization group @code{org-edit-structure} for
  10856. further configuration options.
  10857. @table @code
  10858. @item org-src-lang-modes
  10859. If an Emacs major-mode named @code{<lang>-mode} exists, where
  10860. @code{<lang>} is the language named in the header line of the code block,
  10861. then the edit buffer will be placed in that major-mode. This variable
  10862. can be used to map arbitrary language names to existing major modes.
  10863. @item org-src-window-setup
  10864. Controls the way Emacs windows are rearranged when the edit buffer is created.
  10865. @item org-src-preserve-indentation
  10866. This variable is especially useful for tangling languages such as
  10867. Python, in which whitespace indentation in the output is critical.
  10868. @item org-src-ask-before-returning-to-edit-buffer
  10869. By default, Org will ask before returning to an open edit buffer. Set this
  10870. variable to nil to switch without asking.
  10871. @end table
  10872. To turn on native code fontification in the @emph{Org} buffer, configure the
  10873. variable @code{org-src-fontify-natively}.
  10874. @comment node-name, next, previous, up
  10875. @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
  10876. @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
  10877. @section Exporting code blocks
  10878. @cindex code block, exporting
  10879. @cindex source code, exporting
  10880. It is possible to export the @emph{code} of code blocks, the @emph{results}
  10881. of code block evaluation, @emph{both} the code and the results of code block
  10882. evaluation, or @emph{none}. For most languages, the default exports code.
  10883. However, for some languages (e.g.@: @code{ditaa}) the default exports the
  10884. results of code block evaluation. For information on exporting code block
  10885. bodies, see @ref{Literal examples}.
  10886. The @code{:exports} header argument can be used to specify export
  10887. behavior:
  10888. @subsubheading Header arguments:
  10889. @table @code
  10890. @item :exports code
  10891. The default in most languages. The body of the code block is exported, as
  10892. described in @ref{Literal examples}.
  10893. @item :exports results
  10894. The code block will be evaluated and the results will be placed in the
  10895. Org mode buffer for export, either updating previous results of the code
  10896. block located anywhere in the buffer or, if no previous results exist,
  10897. placing the results immediately after the code block. The body of the code
  10898. block will not be exported.
  10899. @item :exports both
  10900. Both the code block and its results will be exported.
  10901. @item :exports none
  10902. Neither the code block nor its results will be exported.
  10903. @end table
  10904. It is possible to inhibit the evaluation of code blocks during export.
  10905. Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
  10906. ensure that no code blocks are evaluated as part of the export process. This
  10907. can be useful in situations where potentially untrusted Org mode files are
  10908. exported in an automated fashion, for example when Org mode is used as the
  10909. markup language for a wiki.
  10910. @comment node-name, next, previous, up
  10911. @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
  10912. @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
  10913. @section Extracting source code
  10914. @cindex tangling
  10915. @cindex source code, extracting
  10916. @cindex code block, extracting source code
  10917. Creating pure source code files by extracting code from source blocks is
  10918. referred to as ``tangling''---a term adopted from the literate programming
  10919. community. During ``tangling'' of code blocks their bodies are expanded
  10920. using @code{org-babel-expand-src-block} which can expand both variable and
  10921. ``noweb'' style references (see @ref{Noweb reference syntax}).
  10922. @subsubheading Header arguments
  10923. @table @code
  10924. @item :tangle no
  10925. The default. The code block is not included in the tangled output.
  10926. @item :tangle yes
  10927. Include the code block in the tangled output. The output file name is the
  10928. name of the org file with the extension @samp{.org} replaced by the extension
  10929. for the block language.
  10930. @item :tangle filename
  10931. Include the code block in the tangled output to file @samp{filename}.
  10932. @end table
  10933. @kindex C-c C-v t
  10934. @subsubheading Functions
  10935. @table @code
  10936. @item org-babel-tangle
  10937. Tangle the current file. Bound to @kbd{C-c C-v t}.
  10938. @item org-babel-tangle-file
  10939. Choose a file to tangle. Bound to @kbd{C-c C-v f}.
  10940. @end table
  10941. @subsubheading Hooks
  10942. @table @code
  10943. @item org-babel-post-tangle-hook
  10944. This hook is run from within code files tangled by @code{org-babel-tangle}.
  10945. Example applications could include post-processing, compilation or evaluation
  10946. of tangled code files.
  10947. @end table
  10948. @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
  10949. @section Evaluating code blocks
  10950. @cindex code block, evaluating
  10951. @cindex source code, evaluating
  10952. @cindex #+RESULTS
  10953. Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
  10954. potential for that code to do harm. Org mode provides safeguards to ensure
  10955. that code is only evaluated after explicit confirmation from the user. For
  10956. information on these safeguards (and on how to disable them) see @ref{Code
  10957. evaluation security}.} and the results of evaluation optionally placed in the
  10958. Org mode buffer. The results of evaluation are placed following a line that
  10959. begins by default with @code{#+RESULTS} and optionally a cache identifier
  10960. and/or the name of the evaluated code block. The default value of
  10961. @code{#+RESULTS} can be changed with the customizable variable
  10962. @code{org-babel-results-keyword}.
  10963. By default, the evaluation facility is only enabled for Lisp code blocks
  10964. specified as @code{emacs-lisp}. However, source code blocks in many languages
  10965. can be evaluated within Org mode (see @ref{Languages} for a list of supported
  10966. languages and @ref{Structure of code blocks} for information on the syntax
  10967. used to define a code block).
  10968. @kindex C-c C-c
  10969. There are a number of ways to evaluate code blocks. The simplest is to press
  10970. @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
  10971. @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
  10972. evaluation from the @kbd{C-c C-c} key binding.}. This will call the
  10973. @code{org-babel-execute-src-block} function to evaluate the block and insert
  10974. its results into the Org mode buffer.
  10975. @cindex #+CALL
  10976. It is also possible to evaluate named code blocks from anywhere in an
  10977. Org mode buffer or an Org mode table. Live code blocks located in the current
  10978. Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
  10979. can be executed. Named code blocks can be executed with a separate
  10980. @code{#+CALL:} line or inline within a block of text.
  10981. The syntax of the @code{#+CALL:} line is
  10982. @example
  10983. #+CALL: <name>(<arguments>)
  10984. #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
  10985. @end example
  10986. The syntax for inline evaluation of named code blocks is
  10987. @example
  10988. ... call_<name>(<arguments>) ...
  10989. ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
  10990. @end example
  10991. @table @code
  10992. @item <name>
  10993. The name of the code block to be evaluated (see @ref{Structure of code blocks}).
  10994. @item <arguments>
  10995. Arguments specified in this section will be passed to the code block. These
  10996. arguments use standard function call syntax, rather than
  10997. header argument syntax. For example, a @code{#+CALL:} line that passes the
  10998. number four to a code block named @code{double}, which declares the header
  10999. argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
  11000. @item <inside header arguments>
  11001. Inside header arguments are passed through and applied to the named code
  11002. block. These arguments use header argument syntax rather than standard
  11003. function call syntax. Inside header arguments affect how the code block is
  11004. evaluated. For example, @code{[:results output]} will collect the results of
  11005. everything printed to @code{STDOUT} during execution of the code block.
  11006. @item <end header arguments>
  11007. End header arguments are applied to the calling instance and do not affect
  11008. evaluation of the named code block. They affect how the results are
  11009. incorporated into the Org mode buffer and how the call line is exported. For
  11010. example, @code{:results html} will insert the results of the call line
  11011. evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
  11012. For more examples of passing header arguments to @code{#+CALL:} lines see
  11013. @ref{Header arguments in function calls}.
  11014. @end table
  11015. @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
  11016. @section Library of Babel
  11017. @cindex babel, library of
  11018. @cindex source code, library
  11019. @cindex code block, library
  11020. The ``Library of Babel'' consists of code blocks that can be called from any
  11021. Org mode file. Code blocks defined in the ``Library of Babel'' can be called
  11022. remotely as if they were in the current Org mode buffer (see @ref{Evaluating
  11023. code blocks} for information on the syntax of remote code block evaluation).
  11024. The central repository of code blocks in the ``Library of Babel'' is housed
  11025. in an Org mode file located in the @samp{contrib} directory of Org mode.
  11026. Users can add code blocks they believe to be generally useful to their
  11027. ``Library of Babel.'' The code blocks can be stored in any Org mode file and
  11028. then loaded into the library with @code{org-babel-lob-ingest}.
  11029. @kindex C-c C-v i
  11030. Code blocks located in any Org mode file can be loaded into the ``Library of
  11031. Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
  11032. i}.
  11033. @node Languages, Header arguments, Library of Babel, Working With Source Code
  11034. @section Languages
  11035. @cindex babel, languages
  11036. @cindex source code, languages
  11037. @cindex code block, languages
  11038. Code blocks in the following languages are supported.
  11039. @multitable @columnfractions 0.28 0.3 0.22 0.2
  11040. @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
  11041. @item Asymptote @tab asymptote @tab Awk @tab awk
  11042. @item Emacs Calc @tab calc @tab C @tab C
  11043. @item C++ @tab C++ @tab Clojure @tab clojure
  11044. @item CSS @tab css @tab ditaa @tab ditaa
  11045. @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
  11046. @item gnuplot @tab gnuplot @tab Haskell @tab haskell
  11047. @item Java @tab java @tab @tab
  11048. @item Javascript @tab js @tab LaTeX @tab latex
  11049. @item Ledger @tab ledger @tab Lisp @tab lisp
  11050. @item Lilypond @tab lilypond @tab MATLAB @tab matlab
  11051. @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
  11052. @item Octave @tab octave @tab Org mode @tab org
  11053. @item Oz @tab oz @tab Perl @tab perl
  11054. @item Plantuml @tab plantuml @tab Python @tab python
  11055. @item R @tab R @tab Ruby @tab ruby
  11056. @item Sass @tab sass @tab Scheme @tab scheme
  11057. @item GNU Screen @tab screen @tab shell @tab sh
  11058. @item SQL @tab sql @tab SQLite @tab sqlite
  11059. @end multitable
  11060. Language-specific documentation is available for some languages. If
  11061. available, it can be found at
  11062. @uref{http://orgmode.org/worg/org-contrib/babel/languages}.
  11063. The @code{org-babel-load-languages} controls which languages are enabled for
  11064. evaluation (by default only @code{emacs-lisp} is enabled). This variable can
  11065. be set using the customization interface or by adding code like the following
  11066. to your emacs configuration.
  11067. @quotation
  11068. The following disables @code{emacs-lisp} evaluation and enables evaluation of
  11069. @code{R} code blocks.
  11070. @end quotation
  11071. @lisp
  11072. (org-babel-do-load-languages
  11073. 'org-babel-load-languages
  11074. '((emacs-lisp . nil)
  11075. (R . t)))
  11076. @end lisp
  11077. It is also possible to enable support for a language by loading the related
  11078. elisp file with @code{require}.
  11079. @quotation
  11080. The following adds support for evaluating @code{clojure} code blocks.
  11081. @end quotation
  11082. @lisp
  11083. (require 'ob-clojure)
  11084. @end lisp
  11085. @node Header arguments, Results of evaluation, Languages, Working With Source Code
  11086. @section Header arguments
  11087. @cindex code block, header arguments
  11088. @cindex source code, block header arguments
  11089. Code block functionality can be configured with header arguments. This
  11090. section provides an overview of the use of header arguments, and then
  11091. describes each header argument in detail.
  11092. @menu
  11093. * Using header arguments:: Different ways to set header arguments
  11094. * Specific header arguments:: List of header arguments
  11095. @end menu
  11096. @node Using header arguments, Specific header arguments, Header arguments, Header arguments
  11097. @subsection Using header arguments
  11098. The values of header arguments can be set in six different ways, each more
  11099. specific (and having higher priority) than the last.
  11100. @menu
  11101. * System-wide header arguments:: Set global default values
  11102. * Language-specific header arguments:: Set default values by language
  11103. * Buffer-wide header arguments:: Set default values for a specific buffer
  11104. * Header arguments in Org mode properties:: Set default values for a buffer or heading
  11105. * Code block specific header arguments:: The most common way to set values
  11106. * Header arguments in function calls:: The most specific level
  11107. @end menu
  11108. @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
  11109. @subsubheading System-wide header arguments
  11110. @vindex org-babel-default-header-args
  11111. System-wide values of header arguments can be specified by customizing the
  11112. @code{org-babel-default-header-args} variable:
  11113. @example
  11114. :session => "none"
  11115. :results => "replace"
  11116. :exports => "code"
  11117. :cache => "no"
  11118. :noweb => "no"
  11119. @end example
  11120. @c @example
  11121. @c org-babel-default-header-args is a variable defined in `org-babel.el'.
  11122. @c Its value is
  11123. @c ((:session . "none")
  11124. @c (:results . "replace")
  11125. @c (:exports . "code")
  11126. @c (:cache . "no")
  11127. @c (:noweb . "no"))
  11128. @c Documentation:
  11129. @c Default arguments to use when evaluating a code block.
  11130. @c @end example
  11131. For example, the following example could be used to set the default value of
  11132. @code{:noweb} header arguments to @code{yes}. This would have the effect of
  11133. expanding @code{:noweb} references by default when evaluating source code
  11134. blocks.
  11135. @lisp
  11136. (setq org-babel-default-header-args
  11137. (cons '(:noweb . "yes")
  11138. (assq-delete-all :noweb org-babel-default-header-args)))
  11139. @end lisp
  11140. @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
  11141. @subsubheading Language-specific header arguments
  11142. Each language can define its own set of default header arguments. See the
  11143. language-specific documentation available online at
  11144. @uref{http://orgmode.org/worg/org-contrib/babel}.
  11145. @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
  11146. @subsubheading Buffer-wide header arguments
  11147. Buffer-wide header arguments may be specified as properties through the use
  11148. of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
  11149. @ref{Property syntax}).
  11150. For example the following would set @code{session} to @code{*R*}, and
  11151. @code{results} to @code{silent} for every code block in the buffer, ensuring
  11152. that all execution took place in the same session, and no results would be
  11153. inserted into the buffer.
  11154. @example
  11155. #+PROPERTY: session *R*
  11156. #+PROPERTY: results silent
  11157. @end example
  11158. @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
  11159. @subsubheading Header arguments in Org mode properties
  11160. Header arguments are also read from Org mode properties (see @ref{Property
  11161. syntax}), which can be set on a buffer-wide or per-heading basis. An example
  11162. of setting a header argument for all code blocks in a buffer is
  11163. @example
  11164. #+PROPERTY: tangle yes
  11165. @end example
  11166. @vindex org-use-property-inheritance
  11167. When properties are used to set default header arguments, they are looked up
  11168. with inheritance, regardless of the value of
  11169. @code{org-use-property-inheritance}. In the following example the value of
  11170. the @code{:cache} header argument will default to @code{yes} in all code
  11171. blocks in the subtree rooted at the following heading:
  11172. @example
  11173. * outline header
  11174. :PROPERTIES:
  11175. :cache: yes
  11176. :END:
  11177. @end example
  11178. @kindex C-c C-x p
  11179. @vindex org-babel-default-header-args
  11180. Properties defined in this way override the properties set in
  11181. @code{org-babel-default-header-args}. It is convenient to use the
  11182. @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
  11183. in Org mode documents.
  11184. @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
  11185. @subsubheading Code block specific header arguments
  11186. The most common way to assign values to header arguments is at the
  11187. code block level. This can be done by listing a sequence of header
  11188. arguments and their values as part of the @code{#+BEGIN_SRC} line.
  11189. Properties set in this way override both the values of
  11190. @code{org-babel-default-header-args} and header arguments specified as
  11191. properties. In the following example, the @code{:results} header argument
  11192. is set to @code{silent}, meaning the results of execution will not be
  11193. inserted in the buffer, and the @code{:exports} header argument is set to
  11194. @code{code}, meaning only the body of the code block will be
  11195. preserved on export to HTML or @LaTeX{}.
  11196. @example
  11197. #+NAME: factorial
  11198. #+BEGIN_SRC haskell :results silent :exports code :var n=0
  11199. fac 0 = 1
  11200. fac n = n * fac (n-1)
  11201. #+END_SRC
  11202. @end example
  11203. Similarly, it is possible to set header arguments for inline code blocks
  11204. @example
  11205. src_haskell[:exports both]@{fac 5@}
  11206. @end example
  11207. Code block header arguments can span multiple lines using @code{#+HEADER:} or
  11208. @code{#+HEADERS:} lines preceding a code block or nested between the
  11209. @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
  11210. @cindex #+HEADER:
  11211. @cindex #+HEADERS:
  11212. Multi-line header arguments on an un-named code block:
  11213. @example
  11214. #+HEADERS: :var data1=1
  11215. #+BEGIN_SRC emacs-lisp :var data2=2
  11216. (message "data1:%S, data2:%S" data1 data2)
  11217. #+END_SRC
  11218. #+RESULTS:
  11219. : data1:1, data2:2
  11220. @end example
  11221. Multi-line header arguments on a named code block:
  11222. @example
  11223. #+NAME: named-block
  11224. #+HEADER: :var data=2
  11225. #+BEGIN_SRC emacs-lisp
  11226. (message "data:%S" data)
  11227. #+END_SRC
  11228. #+RESULTS: named-block
  11229. : data:2
  11230. @end example
  11231. @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
  11232. @comment node-name, next, previous, up
  11233. @subsubheading Header arguments in function calls
  11234. At the most specific level, header arguments for ``Library of Babel'' or
  11235. @code{#+CALL:} lines can be set as shown in the two examples below. For more
  11236. information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
  11237. blocks}.
  11238. The following will apply the @code{:exports results} header argument to the
  11239. evaluation of the @code{#+CALL:} line.
  11240. @example
  11241. #+CALL: factorial(n=5) :exports results
  11242. @end example
  11243. The following will apply the @code{:session special} header argument to the
  11244. evaluation of the @code{factorial} code block.
  11245. @example
  11246. #+CALL: factorial[:session special](n=5)
  11247. @end example
  11248. @node Specific header arguments, , Using header arguments, Header arguments
  11249. @subsection Specific header arguments
  11250. Header arguments consist of an initial colon followed by the name of the
  11251. argument in lowercase letters. The following header arguments are defined:
  11252. @menu
  11253. * var:: Pass arguments to code blocks
  11254. * results:: Specify the type of results and how they will
  11255. be collected and handled
  11256. * file:: Specify a path for file output
  11257. * dir:: Specify the default (possibly remote)
  11258. directory for code block execution
  11259. * exports:: Export code and/or results
  11260. * tangle:: Toggle tangling and specify file name
  11261. * mkdirp:: Toggle creation of parent directories of target
  11262. files during tangling
  11263. * comments:: Toggle insertion of comments in tangled
  11264. code files
  11265. * padline:: Control insertion of padding lines in tangled
  11266. code files
  11267. * no-expand:: Turn off variable assignment and noweb
  11268. expansion during tangling
  11269. * session:: Preserve the state of code evaluation
  11270. * noweb:: Toggle expansion of noweb references
  11271. * noweb-ref:: Specify block's noweb reference resolution target
  11272. * cache:: Avoid re-evaluating unchanged code blocks
  11273. * sep:: Delimiter for writing tabular results outside Org
  11274. * hlines:: Handle horizontal lines in tables
  11275. * colnames:: Handle column names in tables
  11276. * rownames:: Handle row names in tables
  11277. * shebang:: Make tangled files executable
  11278. * eval:: Limit evaluation of specific code blocks
  11279. * wrap:: Mark source block evaluation results
  11280. @end menu
  11281. Additional header arguments are defined on a language-specific basis, see
  11282. @ref{Languages}.
  11283. @node var, results, Specific header arguments, Specific header arguments
  11284. @subsubsection @code{:var}
  11285. The @code{:var} header argument is used to pass arguments to code blocks.
  11286. The specifics of how arguments are included in a code block vary by language;
  11287. these are addressed in the language-specific documentation. However, the
  11288. syntax used to specify arguments is the same across all languages. In every
  11289. case, variables require a default value when they are declared.
  11290. The values passed to arguments can either be literal values, references, or
  11291. Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}). References
  11292. include anything in the Org mode file that takes a @code{#+NAME:},
  11293. @code{#+TBLNAME:}, or @code{#+RESULTS:} line. This includes tables, lists,
  11294. @code{#+BEGIN_EXAMPLE} blocks, other code blocks, and the results of other
  11295. code blocks.
  11296. Argument values can be indexed in a manner similar to arrays (see @ref{var,
  11297. Indexable variable values}).
  11298. The following syntax is used to pass arguments to code blocks using the
  11299. @code{:var} header argument.
  11300. @example
  11301. :var name=assign
  11302. @end example
  11303. The argument, @code{assign}, can either be a literal value, such as a string
  11304. @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
  11305. literal example, another code block (with or without arguments), or the
  11306. results of evaluating another code block.
  11307. Here are examples of passing values by reference:
  11308. @table @dfn
  11309. @item table
  11310. an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line
  11311. @example
  11312. #+TBLNAME: example-table
  11313. | 1 |
  11314. | 2 |
  11315. | 3 |
  11316. | 4 |
  11317. #+NAME: table-length
  11318. #+BEGIN_SRC emacs-lisp :var table=example-table
  11319. (length table)
  11320. #+END_SRC
  11321. #+RESULTS: table-length
  11322. : 4
  11323. @end example
  11324. @item list
  11325. a simple list named with a @code{#+NAME:} line (note that nesting is not
  11326. carried through to the source code block)
  11327. @example
  11328. #+NAME: example-list
  11329. - simple
  11330. - not
  11331. - nested
  11332. - list
  11333. #+BEGIN_SRC emacs-lisp :var x=example-list
  11334. (print x)
  11335. #+END_SRC
  11336. #+RESULTS:
  11337. | simple | list |
  11338. @end example
  11339. @item code block without arguments
  11340. a code block name (from the example above), as assigned by @code{#+NAME:},
  11341. optionally followed by parentheses
  11342. @example
  11343. #+BEGIN_SRC emacs-lisp :var length=table-length()
  11344. (* 2 length)
  11345. #+END_SRC
  11346. #+RESULTS:
  11347. : 8
  11348. @end example
  11349. @item code block with arguments
  11350. a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
  11351. optional arguments passed within the parentheses following the
  11352. code block name using standard function call syntax
  11353. @example
  11354. #+NAME: double
  11355. #+BEGIN_SRC emacs-lisp :var input=8
  11356. (* 2 input)
  11357. #+END_SRC
  11358. #+RESULTS: double
  11359. : 16
  11360. #+NAME: squared
  11361. #+BEGIN_SRC emacs-lisp :var input=double(input=1)
  11362. (* input input)
  11363. #+END_SRC
  11364. #+RESULTS: squared
  11365. : 4
  11366. @end example
  11367. @item literal example
  11368. a literal example block named with a @code{#+NAME:} line
  11369. @example
  11370. #+NAME: literal-example
  11371. #+BEGIN_EXAMPLE
  11372. A literal example
  11373. on two lines
  11374. #+END_EXAMPLE
  11375. #+NAME: read-literal-example
  11376. #+BEGIN_SRC emacs-lisp :var x=literal-example
  11377. (concatenate 'string x " for you.")
  11378. #+END_SRC
  11379. #+RESULTS: read-literal-example
  11380. : A literal example
  11381. : on two lines for you.
  11382. @end example
  11383. @end table
  11384. @subsubheading Alternate argument syntax
  11385. It is also possible to specify arguments in a potentially more natural way
  11386. using the @code{#+NAME:} line of a code block. As in the following
  11387. example, arguments can be packed inside of parentheses, separated by commas,
  11388. following the source name.
  11389. @example
  11390. #+NAME: double(input=0, x=2)
  11391. #+BEGIN_SRC emacs-lisp
  11392. (* 2 (+ input x))
  11393. #+END_SRC
  11394. @end example
  11395. @subsubheading Indexable variable values
  11396. It is possible to reference portions of variable values by ``indexing'' into
  11397. the variables. Indexes are 0 based with negative values counting back from
  11398. the end. If an index is separated by @code{,}s then each subsequent section
  11399. will index into the next deepest nesting or dimension of the value. Note
  11400. that this indexing occurs @emph{before} other table related header arguments
  11401. like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
  11402. following example assigns the last cell of the first row the table
  11403. @code{example-table} to the variable @code{data}:
  11404. @example
  11405. #+NAME: example-table
  11406. | 1 | a |
  11407. | 2 | b |
  11408. | 3 | c |
  11409. | 4 | d |
  11410. #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
  11411. data
  11412. #+END_SRC
  11413. #+RESULTS:
  11414. : a
  11415. @end example
  11416. Ranges of variable values can be referenced using two integers separated by a
  11417. @code{:}, in which case the entire inclusive range is referenced. For
  11418. example the following assigns the middle three rows of @code{example-table}
  11419. to @code{data}.
  11420. @example
  11421. #+NAME: example-table
  11422. | 1 | a |
  11423. | 2 | b |
  11424. | 3 | c |
  11425. | 4 | d |
  11426. | 5 | 3 |
  11427. #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
  11428. data
  11429. #+END_SRC
  11430. #+RESULTS:
  11431. | 2 | b |
  11432. | 3 | c |
  11433. | 4 | d |
  11434. @end example
  11435. Additionally, an empty index, or the single character @code{*}, are both
  11436. interpreted to mean the entire range and as such are equivalent to
  11437. @code{0:-1}, as shown in the following example in which the entire first
  11438. column is referenced.
  11439. @example
  11440. #+NAME: example-table
  11441. | 1 | a |
  11442. | 2 | b |
  11443. | 3 | c |
  11444. | 4 | d |
  11445. #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
  11446. data
  11447. #+END_SRC
  11448. #+RESULTS:
  11449. | 1 | 2 | 3 | 4 |
  11450. @end example
  11451. It is possible to index into the results of code blocks as well as tables.
  11452. Any number of dimensions can be indexed. Dimensions are separated from one
  11453. another by commas, as shown in the following example.
  11454. @example
  11455. #+NAME: 3D
  11456. #+BEGIN_SRC emacs-lisp
  11457. '(((1 2 3) (4 5 6) (7 8 9))
  11458. ((10 11 12) (13 14 15) (16 17 18))
  11459. ((19 20 21) (22 23 24) (25 26 27)))
  11460. #+END_SRC
  11461. #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
  11462. data
  11463. #+END_SRC
  11464. #+RESULTS:
  11465. | 11 | 14 | 17 |
  11466. @end example
  11467. @subsubheading Emacs Lisp evaluation of variables
  11468. Emacs lisp code can be used to initialize variable values. When a variable
  11469. value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
  11470. evaluated as Emacs Lisp and the result of the evaluation will be assigned as
  11471. the variable value. The following example demonstrates use of this
  11472. evaluation to reliably pass the file-name of the Org mode buffer to a code
  11473. block---note that evaluation of header arguments is guaranteed to take place
  11474. in the original Org mode file, while there is no such guarantee for
  11475. evaluation of the code block body.
  11476. @example
  11477. #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
  11478. wc -w $filename
  11479. #+END_SRC
  11480. @end example
  11481. Note that values read from tables and lists will not be evaluated as
  11482. Emacs Lisp, as shown in the following example.
  11483. @example
  11484. #+NAME: table
  11485. | (a b c) |
  11486. #+HEADERS: :var data=table[0,0]
  11487. #+BEGIN_SRC perl
  11488. $data
  11489. #+END_SRC
  11490. #+RESULTS:
  11491. : (a b c)
  11492. @end example
  11493. @node results, file, var, Specific header arguments
  11494. @subsubsection @code{:results}
  11495. There are three classes of @code{:results} header argument. Only one option
  11496. per class may be supplied per code block.
  11497. @itemize @bullet
  11498. @item
  11499. @b{collection} header arguments specify how the results should be collected
  11500. from the code block
  11501. @item
  11502. @b{type} header arguments specify what type of result the code block will
  11503. return---which has implications for how they will be inserted into the
  11504. Org mode buffer
  11505. @item
  11506. @b{handling} header arguments specify how the results of evaluating the code
  11507. block should be handled.
  11508. @end itemize
  11509. @subsubheading Collection
  11510. The following options are mutually exclusive, and specify how the results
  11511. should be collected from the code block.
  11512. @itemize @bullet
  11513. @item @code{value}
  11514. This is the default. The result is the value of the last statement in the
  11515. code block. This header argument places the evaluation in functional
  11516. mode. Note that in some languages, e.g., Python, use of this result type
  11517. requires that a @code{return} statement be included in the body of the source
  11518. code block. E.g., @code{:results value}.
  11519. @item @code{output}
  11520. The result is the collection of everything printed to STDOUT during the
  11521. execution of the code block. This header argument places the
  11522. evaluation in scripting mode. E.g., @code{:results output}.
  11523. @end itemize
  11524. @subsubheading Type
  11525. The following options are mutually exclusive and specify what type of results
  11526. the code block will return. By default, results are inserted as either a
  11527. table or scalar depending on their value.
  11528. @itemize @bullet
  11529. @item @code{table}, @code{vector}
  11530. The results should be interpreted as an Org mode table. If a single value is
  11531. returned, it will be converted into a table with one row and one column.
  11532. E.g., @code{:results value table}.
  11533. @item @code{list}
  11534. The results should be interpreted as an Org mode list. If a single scalar
  11535. value is returned it will be converted into a list with only one element.
  11536. @item @code{scalar}, @code{verbatim}
  11537. The results should be interpreted literally---they will not be
  11538. converted into a table. The results will be inserted into the Org mode
  11539. buffer as quoted text. E.g., @code{:results value verbatim}.
  11540. @item @code{file}
  11541. The results will be interpreted as the path to a file, and will be inserted
  11542. into the Org mode buffer as a file link. E.g., @code{:results value file}.
  11543. @item @code{raw}, @code{org}
  11544. The results are interpreted as raw Org mode code and are inserted directly
  11545. into the buffer. If the results look like a table they will be aligned as
  11546. such by Org mode. E.g., @code{:results value raw}.
  11547. @item @code{html}
  11548. Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
  11549. block. E.g., @code{:results value html}.
  11550. @item @code{latex}
  11551. Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
  11552. E.g., @code{:results value latex}.
  11553. @item @code{code}
  11554. Result are assumed to be parsable code and are enclosed in a code block.
  11555. E.g., @code{:results value code}.
  11556. @item @code{pp}
  11557. The result is converted to pretty-printed code and is enclosed in a code
  11558. block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
  11559. @code{:results value pp}.
  11560. @item @code{wrap}
  11561. The result is wrapped in a RESULTS drawer. This can be useful for
  11562. inserting @code{raw} or @code{org} syntax results in such a way that their
  11563. extent is known and they can be automatically removed or replaced.
  11564. @end itemize
  11565. @subsubheading Handling
  11566. The following results options indicate what happens with the
  11567. results once they are collected.
  11568. @itemize @bullet
  11569. @item @code{silent}
  11570. The results will be echoed in the minibuffer but will not be inserted into
  11571. the Org mode buffer. E.g., @code{:results output silent}.
  11572. @item @code{replace}
  11573. The default value. Any existing results will be removed, and the new results
  11574. will be inserted into the Org mode buffer in their place. E.g.,
  11575. @code{:results output replace}.
  11576. @item @code{append}
  11577. If there are pre-existing results of the code block then the new results will
  11578. be appended to the existing results. Otherwise the new results will be
  11579. inserted as with @code{replace}.
  11580. @item @code{prepend}
  11581. If there are pre-existing results of the code block then the new results will
  11582. be prepended to the existing results. Otherwise the new results will be
  11583. inserted as with @code{replace}.
  11584. @end itemize
  11585. @node file, dir, results, Specific header arguments
  11586. @subsubsection @code{:file}
  11587. The header argument @code{:file} is used to specify an external file in which
  11588. to save code block results. After code block evaluation an Org mode style
  11589. @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
  11590. into the Org mode buffer. Some languages including R, gnuplot, dot, and
  11591. ditaa provide special handling of the @code{:file} header argument
  11592. automatically wrapping the code block body in the boilerplate code required
  11593. to save output to the specified file. This is often useful for saving
  11594. graphical output of a code block to the specified file.
  11595. The argument to @code{:file} should be either a string specifying the path to
  11596. a file, or a list of two strings in which case the first element of the list
  11597. should be the path to a file and the second a description for the link.
  11598. @node dir, exports, file, Specific header arguments
  11599. @subsubsection @code{:dir} and remote execution
  11600. While the @code{:file} header argument can be used to specify the path to the
  11601. output file, @code{:dir} specifies the default directory during code block
  11602. execution. If it is absent, then the directory associated with the current
  11603. buffer is used. In other words, supplying @code{:dir path} temporarily has
  11604. the same effect as changing the current directory with @kbd{M-x cd path}, and
  11605. then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
  11606. the value of the Emacs variable @code{default-directory}.
  11607. When using @code{:dir}, you should supply a relative path for file output
  11608. (e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
  11609. case that path will be interpreted relative to the default directory.
  11610. In other words, if you want your plot to go into a folder called @file{Work}
  11611. in your home directory, you could use
  11612. @example
  11613. #+BEGIN_SRC R :file myplot.png :dir ~/Work
  11614. matplot(matrix(rnorm(100), 10), type="l")
  11615. #+END_SRC
  11616. @end example
  11617. @subsubheading Remote execution
  11618. A directory on a remote machine can be specified using tramp file syntax, in
  11619. which case the code will be evaluated on the remote machine. An example is
  11620. @example
  11621. #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
  11622. plot(1:10, main=system("hostname", intern=TRUE))
  11623. #+END_SRC
  11624. @end example
  11625. Text results will be returned to the local Org mode buffer as usual, and file
  11626. output will be created on the remote machine with relative paths interpreted
  11627. relative to the remote directory. An Org mode link to the remote file will be
  11628. created.
  11629. So, in the above example a plot will be created on the remote machine,
  11630. and a link of the following form will be inserted in the org buffer:
  11631. @example
  11632. [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
  11633. @end example
  11634. Most of this functionality follows immediately from the fact that @code{:dir}
  11635. sets the value of the Emacs variable @code{default-directory}, thanks to
  11636. tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
  11637. install tramp separately in order for these features to work correctly.
  11638. @subsubheading Further points
  11639. @itemize @bullet
  11640. @item
  11641. If @code{:dir} is used in conjunction with @code{:session}, although it will
  11642. determine the starting directory for a new session as expected, no attempt is
  11643. currently made to alter the directory associated with an existing session.
  11644. @item
  11645. @code{:dir} should typically not be used to create files during export with
  11646. @code{:exports results} or @code{:exports both}. The reason is that, in order
  11647. to retain portability of exported material between machines, during export
  11648. links inserted into the buffer will @emph{not} be expanded against @code{default
  11649. directory}. Therefore, if @code{default-directory} is altered using
  11650. @code{:dir}, it is probable that the file will be created in a location to
  11651. which the link does not point.
  11652. @end itemize
  11653. @node exports, tangle, dir, Specific header arguments
  11654. @subsubsection @code{:exports}
  11655. The @code{:exports} header argument specifies what should be included in HTML
  11656. or @LaTeX{} exports of the Org mode file.
  11657. @itemize @bullet
  11658. @item @code{code}
  11659. The default. The body of code is included into the exported file. E.g.,
  11660. @code{:exports code}.
  11661. @item @code{results}
  11662. The result of evaluating the code is included in the exported file. E.g.,
  11663. @code{:exports results}.
  11664. @item @code{both}
  11665. Both the code and results are included in the exported file. E.g.,
  11666. @code{:exports both}.
  11667. @item @code{none}
  11668. Nothing is included in the exported file. E.g., @code{:exports none}.
  11669. @end itemize
  11670. @node tangle, mkdirp, exports, Specific header arguments
  11671. @subsubsection @code{:tangle}
  11672. The @code{:tangle} header argument specifies whether or not the code
  11673. block should be included in tangled extraction of source code files.
  11674. @itemize @bullet
  11675. @item @code{tangle}
  11676. The code block is exported to a source code file named after the full path
  11677. (including the directory) and file name (w/o extension) of the Org mode file.
  11678. E.g., @code{:tangle yes}.
  11679. @item @code{no}
  11680. The default. The code block is not exported to a source code file.
  11681. E.g., @code{:tangle no}.
  11682. @item other
  11683. Any other string passed to the @code{:tangle} header argument is interpreted
  11684. as a path (directory and file name relative to the directory of the Org mode
  11685. file) to which the block will be exported. E.g., @code{:tangle path}.
  11686. @end itemize
  11687. @node mkdirp, comments, tangle, Specific header arguments
  11688. @subsubsection @code{:mkdirp}
  11689. The @code{:mkdirp} header argument can be used to create parent directories
  11690. of tangled files when missing. This can be set to @code{yes} to enable
  11691. directory creation or to @code{no} to inhibit directory creation.
  11692. @node comments, padline, mkdirp, Specific header arguments
  11693. @subsubsection @code{:comments}
  11694. By default code blocks are tangled to source-code files without any insertion
  11695. of comments beyond those which may already exist in the body of the code
  11696. block. The @code{:comments} header argument can be set as follows to control
  11697. the insertion of extra comments into the tangled code file.
  11698. @itemize @bullet
  11699. @item @code{no}
  11700. The default. No extra comments are inserted during tangling.
  11701. @item @code{link}
  11702. The code block is wrapped in comments which contain pointers back to the
  11703. original Org file from which the code was tangled.
  11704. @item @code{yes}
  11705. A synonym for ``link'' to maintain backwards compatibility.
  11706. @item @code{org}
  11707. Include text from the Org mode file as a comment.
  11708. The text is picked from the leading context of the tangled code and is
  11709. limited by the nearest headline or source block as the case may be.
  11710. @item @code{both}
  11711. Turns on both the ``link'' and ``org'' comment options.
  11712. @item @code{noweb}
  11713. Turns on the ``link'' comment option, and additionally wraps expanded noweb
  11714. references in the code block body in link comments.
  11715. @end itemize
  11716. @node padline, no-expand, comments, Specific header arguments
  11717. @subsubsection @code{:padline}
  11718. Control in insertion of padding lines around code block bodies in tangled
  11719. code files. The default value is @code{yes} which results in insertion of
  11720. newlines before and after each tangled code block. The following arguments
  11721. are accepted.
  11722. @itemize @bullet
  11723. @item @code{yes}
  11724. Insert newlines before and after each code block body in tangled code files.
  11725. @item @code{no}
  11726. Do not insert any newline padding in tangled output.
  11727. @end itemize
  11728. @node no-expand, session, padline, Specific header arguments
  11729. @subsubsection @code{:no-expand}
  11730. By default, code blocks are expanded with @code{org-babel-expand-src-block}
  11731. during tangling. This has the effect of assigning values to variables
  11732. specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
  11733. references (see @ref{Noweb reference syntax}) with their targets. The
  11734. @code{:no-expand} header argument can be used to turn off this behavior.
  11735. @node session, noweb, no-expand, Specific header arguments
  11736. @subsubsection @code{:session}
  11737. The @code{:session} header argument starts a session for an interpreted
  11738. language where state is preserved.
  11739. By default, a session is not started.
  11740. A string passed to the @code{:session} header argument will give the session
  11741. a name. This makes it possible to run concurrent sessions for each
  11742. interpreted language.
  11743. @node noweb, noweb-ref, session, Specific header arguments
  11744. @subsubsection @code{:noweb}
  11745. The @code{:noweb} header argument controls expansion of ``noweb'' syntax
  11746. references (see @ref{Noweb reference syntax}) when the code block is
  11747. evaluated, tangled, or exported. The @code{:noweb} header argument can have
  11748. one of four values: @code{no}, @code{yes}, @code{tangle}, or
  11749. @code{no-export}.
  11750. @itemize @bullet
  11751. @item @code{no}
  11752. The default. ``Noweb'' syntax references in the body of the code block will
  11753. not be expanded before the code block is evaluated, tangled or exported.
  11754. @item @code{yes}
  11755. ``Noweb'' syntax references in the body of the code block will be
  11756. expanded before the code block is evaluated, tangled or exported.
  11757. @item @code{tangle}
  11758. ``Noweb'' syntax references in the body of the code block will be expanded
  11759. before the code block is tangled. However, ``noweb'' syntax references will
  11760. not be expanded when the code block is evaluated or exported.
  11761. @item @code{no-export}
  11762. ``Noweb'' syntax references in the body of the code block will be expanded
  11763. before the block is evaluated or tangled. However, ``noweb'' syntax
  11764. references will not be expanded when the code block is exported.
  11765. @end itemize
  11766. @subsubheading Noweb prefix lines
  11767. Noweb insertions are now placed behind the line prefix of the
  11768. @code{<<reference>>}.
  11769. This behavior is illustrated in the following example. Because the
  11770. @code{<<example>>} noweb reference appears behind the SQL comment syntax,
  11771. each line of the expanded noweb reference will be commented.
  11772. This code block:
  11773. @example
  11774. -- <<example>>
  11775. @end example
  11776. expands to:
  11777. @example
  11778. -- this is the
  11779. -- multi-line body of example
  11780. @end example
  11781. Note that noweb replacement text that does not contain any newlines will not
  11782. be affected by this change, so it is still possible to use inline noweb
  11783. references.
  11784. @node noweb-ref, cache, noweb, Specific header arguments
  11785. @subsubsection @code{:noweb-ref}
  11786. When expanding ``noweb'' style references the bodies of all code block with
  11787. @emph{either} a block name matching the reference name @emph{or} a
  11788. @code{:noweb-ref} header argument matching the reference name will be
  11789. concatenated together to form the replacement text.
  11790. By setting this header argument at the sub-tree or file level, simple code
  11791. block concatenation may be achieved. For example, when tangling the
  11792. following Org mode file, the bodies of code blocks will be concatenated into
  11793. the resulting pure code file@footnote{(The example needs property inheritance
  11794. to be turned on for the @code{noweb-ref} property, see @ref{Property
  11795. inheritance}).}.
  11796. @example
  11797. #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
  11798. <<fullest-disk>>
  11799. #+END_SRC
  11800. * the mount point of the fullest disk
  11801. :PROPERTIES:
  11802. :noweb-ref: fullest-disk
  11803. :END:
  11804. ** query all mounted disks
  11805. #+BEGIN_SRC sh
  11806. df \
  11807. #+END_SRC
  11808. ** strip the header row
  11809. #+BEGIN_SRC sh
  11810. |sed '1d' \
  11811. #+END_SRC
  11812. ** sort by the percent full
  11813. #+BEGIN_SRC sh
  11814. |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
  11815. #+END_SRC
  11816. ** extract the mount point
  11817. #+BEGIN_SRC sh
  11818. |awk '@{print $2@}'
  11819. #+END_SRC
  11820. @end example
  11821. The @code{org-babel-noweb-separator} variable holds the string used to
  11822. separate accumulate noweb references like those above. By default this
  11823. variable holds a newline.
  11824. @node cache, sep, noweb-ref, Specific header arguments
  11825. @subsubsection @code{:cache}
  11826. The @code{:cache} header argument controls the use of in-buffer caching of
  11827. the results of evaluating code blocks. It can be used to avoid re-evaluating
  11828. unchanged code blocks. This header argument can have one of two
  11829. values: @code{yes} or @code{no}.
  11830. @itemize @bullet
  11831. @item @code{no}
  11832. The default. No caching takes place, and the code block will be evaluated
  11833. every time it is called.
  11834. @item @code{yes}
  11835. Every time the code block is run a SHA1 hash of the code and arguments
  11836. passed to the block will be generated. This hash is packed into the
  11837. @code{#+RESULTS:} line and will be checked on subsequent
  11838. executions of the code block. If the code block has not
  11839. changed since the last time it was evaluated, it will not be re-evaluated.
  11840. @end itemize
  11841. Code block caches notice if the value of a variable argument
  11842. to the code block has changed. If this is the case, the cache is
  11843. invalidated and the code block is re-run. In the following example,
  11844. @code{caller} will not be re-run unless the results of @code{random} have
  11845. changed since it was last run.
  11846. @example
  11847. #+NAME: random
  11848. #+BEGIN_SRC R :cache yes
  11849. runif(1)
  11850. #+END_SRC
  11851. #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
  11852. 0.4659510825295
  11853. #+NAME: caller
  11854. #+BEGIN_SRC emacs-lisp :var x=random :cache yes
  11855. x
  11856. #+END_SRC
  11857. #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
  11858. 0.254227238707244
  11859. @end example
  11860. @node sep, hlines, cache, Specific header arguments
  11861. @subsubsection @code{:sep}
  11862. The @code{:sep} header argument can be used to control the delimiter used
  11863. when writing tabular results out to files external to Org mode. This is used
  11864. either when opening tabular results of a code block by calling the
  11865. @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
  11866. or when writing code block results to an external file (see @ref{file})
  11867. header argument.
  11868. By default, when @code{:sep} is not specified output tables are tab
  11869. delimited.
  11870. @node hlines, colnames, sep, Specific header arguments
  11871. @subsubsection @code{:hlines}
  11872. Tables are frequently represented with one or more horizontal lines, or
  11873. hlines. The @code{:hlines} argument to a code block accepts the
  11874. values @code{yes} or @code{no}, with a default value of @code{no}.
  11875. @itemize @bullet
  11876. @item @code{no}
  11877. Strips horizontal lines from the input table. In most languages this is the
  11878. desired effect because an @code{hline} symbol is interpreted as an unbound
  11879. variable and raises an error. Setting @code{:hlines no} or relying on the
  11880. default value yields the following results.
  11881. @example
  11882. #+TBLNAME: many-cols
  11883. | a | b | c |
  11884. |---+---+---|
  11885. | d | e | f |
  11886. |---+---+---|
  11887. | g | h | i |
  11888. #+NAME: echo-table
  11889. #+BEGIN_SRC python :var tab=many-cols
  11890. return tab
  11891. #+END_SRC
  11892. #+RESULTS: echo-table
  11893. | a | b | c |
  11894. | d | e | f |
  11895. | g | h | i |
  11896. @end example
  11897. @item @code{yes}
  11898. Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
  11899. @example
  11900. #+TBLNAME: many-cols
  11901. | a | b | c |
  11902. |---+---+---|
  11903. | d | e | f |
  11904. |---+---+---|
  11905. | g | h | i |
  11906. #+NAME: echo-table
  11907. #+BEGIN_SRC python :var tab=many-cols :hlines yes
  11908. return tab
  11909. #+END_SRC
  11910. #+RESULTS: echo-table
  11911. | a | b | c |
  11912. |---+---+---|
  11913. | d | e | f |
  11914. |---+---+---|
  11915. | g | h | i |
  11916. @end example
  11917. @end itemize
  11918. @node colnames, rownames, hlines, Specific header arguments
  11919. @subsubsection @code{:colnames}
  11920. The @code{:colnames} header argument accepts the values @code{yes},
  11921. @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
  11922. Note that the behavior of the @code{:colnames} header argument may differ
  11923. across languages. For example Emacs Lisp code blocks ignore the
  11924. @code{:colnames} header argument entirely given the ease with which tables
  11925. with column names may be handled directly in Emacs Lisp.
  11926. @itemize @bullet
  11927. @item @code{nil}
  11928. If an input table looks like it has column names
  11929. (because its second row is an hline), then the column
  11930. names will be removed from the table before
  11931. processing, then reapplied to the results.
  11932. @example
  11933. #+TBLNAME: less-cols
  11934. | a |
  11935. |---|
  11936. | b |
  11937. | c |
  11938. #+NAME: echo-table-again
  11939. #+BEGIN_SRC python :var tab=less-cols
  11940. return [[val + '*' for val in row] for row in tab]
  11941. #+END_SRC
  11942. #+RESULTS: echo-table-again
  11943. | a |
  11944. |----|
  11945. | b* |
  11946. | c* |
  11947. @end example
  11948. Please note that column names are not removed before the table is indexed
  11949. using variable indexing @xref{var, Indexable variable values}.
  11950. @item @code{no}
  11951. No column name pre-processing takes place
  11952. @item @code{yes}
  11953. Column names are removed and reapplied as with @code{nil} even if the table
  11954. does not ``look like'' it has column names (i.e.@: the second row is not an
  11955. hline)
  11956. @end itemize
  11957. @node rownames, shebang, colnames, Specific header arguments
  11958. @subsubsection @code{:rownames}
  11959. The @code{:rownames} header argument can take on the values @code{yes}
  11960. or @code{no}, with a default value of @code{no}.
  11961. @itemize @bullet
  11962. @item @code{no}
  11963. No row name pre-processing will take place.
  11964. @item @code{yes}
  11965. The first column of the table is removed from the table before processing,
  11966. and is then reapplied to the results.
  11967. @example
  11968. #+TBLNAME: with-rownames
  11969. | one | 1 | 2 | 3 | 4 | 5 |
  11970. | two | 6 | 7 | 8 | 9 | 10 |
  11971. #+NAME: echo-table-once-again
  11972. #+BEGIN_SRC python :var tab=with-rownames :rownames yes
  11973. return [[val + 10 for val in row] for row in tab]
  11974. #+END_SRC
  11975. #+RESULTS: echo-table-once-again
  11976. | one | 11 | 12 | 13 | 14 | 15 |
  11977. | two | 16 | 17 | 18 | 19 | 20 |
  11978. @end example
  11979. Please note that row names are not removed before the table is indexed using
  11980. variable indexing @xref{var, Indexable variable values}.
  11981. @end itemize
  11982. @node shebang, eval, rownames, Specific header arguments
  11983. @subsubsection @code{:shebang}
  11984. Setting the @code{:shebang} header argument to a string value
  11985. (e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
  11986. first line of any tangled file holding the code block, and the file
  11987. permissions of the tangled file are set to make it executable.
  11988. @node eval, wrap, shebang, Specific header arguments
  11989. @subsubsection @code{:eval}
  11990. The @code{:eval} header argument can be used to limit the evaluation of
  11991. specific code blocks. The @code{:eval} header argument can be useful for
  11992. protecting against the evaluation of dangerous code blocks or to ensure that
  11993. evaluation will require a query regardless of the value of the
  11994. @code{org-confirm-babel-evaluate} variable. The possible values of
  11995. @code{:eval} and their effects are shown below.
  11996. @table @code
  11997. @item never or no
  11998. The code block will not be evaluated under any circumstances.
  11999. @item query
  12000. Evaluation of the code block will require a query.
  12001. @item never-export or no-export
  12002. The code block will not be evaluated during export but may still be called
  12003. interactively.
  12004. @item query-export
  12005. Evaluation of the code block during export will require a query.
  12006. @end table
  12007. If this header argument is not set then evaluation is determined by the value
  12008. of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
  12009. security}.
  12010. @node wrap, , eval, Specific header arguments
  12011. @subsubsection @code{:wrap}
  12012. The @code{:wrap} header argument is used to mark the results of source block
  12013. evaluation. The header argument can be passed a string that will be appended
  12014. to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
  12015. results. If not string is specified then the results will be wrapped in a
  12016. @code{#+BEGIN/END_RESULTS} block.
  12017. @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
  12018. @section Results of evaluation
  12019. @cindex code block, results of evaluation
  12020. @cindex source code, results of evaluation
  12021. The way in which results are handled depends on whether a session is invoked,
  12022. as well as on whether @code{:results value} or @code{:results output} is
  12023. used. The following table shows the table possibilities. For a full listing
  12024. of the possible results header arguments see @ref{results}.
  12025. @multitable @columnfractions 0.26 0.33 0.41
  12026. @item @tab @b{Non-session} @tab @b{Session}
  12027. @item @code{:results value} @tab value of last expression @tab value of last expression
  12028. @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
  12029. @end multitable
  12030. Note: With @code{:results value}, the result in both @code{:session} and
  12031. non-session is returned to Org mode as a table (a one- or two-dimensional
  12032. vector of strings or numbers) when appropriate.
  12033. @subsection Non-session
  12034. @subsubsection @code{:results value}
  12035. This is the default. Internally, the value is obtained by wrapping the code
  12036. in a function definition in the external language, and evaluating that
  12037. function. Therefore, code should be written as if it were the body of such a
  12038. function. In particular, note that Python does not automatically return a
  12039. value from a function unless a @code{return} statement is present, and so a
  12040. @samp{return} statement will usually be required in Python.
  12041. This is the only one of the four evaluation contexts in which the code is
  12042. automatically wrapped in a function definition.
  12043. @subsubsection @code{:results output}
  12044. The code is passed to the interpreter as an external process, and the
  12045. contents of the standard output stream are returned as text. (In certain
  12046. languages this also contains the error output stream; this is an area for
  12047. future work.)
  12048. @subsection Session
  12049. @subsubsection @code{:results value}
  12050. The code is passed to an interpreter running as an interactive Emacs inferior
  12051. process. Only languages which provide tools for interactive evaluation of
  12052. code have session support, so some language (e.g., C and ditaa) do not
  12053. support the @code{:session} header argument, and in other languages (e.g.,
  12054. Python and Haskell) which have limitations on the code which may be entered
  12055. into interactive sessions, those limitations apply to the code in code blocks
  12056. using the @code{:session} header argument as well.
  12057. Unless the @code{:results output} option is supplied (see below) the result
  12058. returned is the result of the last evaluation performed by the
  12059. interpreter. (This is obtained in a language-specific manner: the value of
  12060. the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
  12061. in R).
  12062. @subsubsection @code{:results output}
  12063. The code is passed to the interpreter running as an interactive Emacs
  12064. inferior process. The result returned is the concatenation of the sequence of
  12065. (text) output from the interactive interpreter. Notice that this is not
  12066. necessarily the same as what would be sent to @code{STDOUT} if the same code
  12067. were passed to a non-interactive interpreter running as an external
  12068. process. For example, compare the following two blocks:
  12069. @example
  12070. #+BEGIN_SRC python :results output
  12071. print "hello"
  12072. 2
  12073. print "bye"
  12074. #+END_SRC
  12075. #+RESULTS:
  12076. : hello
  12077. : bye
  12078. @end example
  12079. In non-session mode, the `2' is not printed and does not appear.
  12080. @example
  12081. #+BEGIN_SRC python :results output :session
  12082. print "hello"
  12083. 2
  12084. print "bye"
  12085. #+END_SRC
  12086. #+RESULTS:
  12087. : hello
  12088. : 2
  12089. : bye
  12090. @end example
  12091. But in @code{:session} mode, the interactive interpreter receives input `2'
  12092. and prints out its value, `2'. (Indeed, the other print statements are
  12093. unnecessary here).
  12094. @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
  12095. @section Noweb reference syntax
  12096. @cindex code block, noweb reference
  12097. @cindex syntax, noweb
  12098. @cindex source code, noweb reference
  12099. The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
  12100. Programming system allows named blocks of code to be referenced by using the
  12101. familiar Noweb syntax:
  12102. @example
  12103. <<code-block-name>>
  12104. @end example
  12105. When a code block is tangled or evaluated, whether or not ``noweb''
  12106. references are expanded depends upon the value of the @code{:noweb} header
  12107. argument. If @code{:noweb yes}, then a Noweb reference is expanded before
  12108. evaluation. If @code{:noweb no}, the default, then the reference is not
  12109. expanded before evaluation. See the @ref{noweb-ref} header argument for
  12110. a more flexible way to resolve noweb references.
  12111. Note: the default value, @code{:noweb no}, was chosen to ensure that
  12112. correct code is not broken in a language, such as Ruby, where
  12113. @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
  12114. syntactically valid in languages that you use, then please consider setting
  12115. the default value.
  12116. Note: if noweb tangling is slow in large Org-mode files consider setting the
  12117. @code{*org-babel-use-quick-and-dirty-noweb-expansion*} variable to true.
  12118. This will result in faster noweb reference resolution at the expense of not
  12119. correctly resolving inherited values of the @code{:noweb-ref} header
  12120. argument.
  12121. @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
  12122. @section Key bindings and useful functions
  12123. @cindex code block, key bindings
  12124. Many common Org mode key sequences are re-bound depending on
  12125. the context.
  12126. Within a code block, the following key bindings
  12127. are active:
  12128. @multitable @columnfractions 0.25 0.75
  12129. @kindex C-c C-c
  12130. @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
  12131. @kindex C-c C-o
  12132. @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
  12133. @kindex C-up
  12134. @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
  12135. @kindex M-down
  12136. @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
  12137. @end multitable
  12138. In an Org mode buffer, the following key bindings are active:
  12139. @multitable @columnfractions 0.45 0.55
  12140. @kindex C-c C-v a
  12141. @kindex C-c C-v C-a
  12142. @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
  12143. @kindex C-c C-v b
  12144. @kindex C-c C-v C-b
  12145. @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
  12146. @kindex C-c C-v f
  12147. @kindex C-c C-v C-f
  12148. @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
  12149. @kindex C-c C-v g
  12150. @item @kbd{C-c C-v g} @tab @code{org-babel-goto-named-source-block}
  12151. @kindex C-c C-v h
  12152. @item @kbd{C-c C-v h} @tab @code{org-babel-describe-bindings}
  12153. @kindex C-c C-v l
  12154. @kindex C-c C-v C-l
  12155. @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
  12156. @kindex C-c C-v p
  12157. @kindex C-c C-v C-p
  12158. @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
  12159. @kindex C-c C-v s
  12160. @kindex C-c C-v C-s
  12161. @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
  12162. @kindex C-c C-v t
  12163. @kindex C-c C-v C-t
  12164. @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
  12165. @kindex C-c C-v z
  12166. @kindex C-c C-v C-z
  12167. @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
  12168. @end multitable
  12169. @c When possible these keybindings were extended to work when the control key is
  12170. @c kept pressed, resulting in the following additional keybindings.
  12171. @c @multitable @columnfractions 0.25 0.75
  12172. @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
  12173. @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
  12174. @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
  12175. @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
  12176. @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
  12177. @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
  12178. @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
  12179. @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
  12180. @c @end multitable
  12181. @node Batch execution, , Key bindings and useful functions, Working With Source Code
  12182. @section Batch execution
  12183. @cindex code block, batch execution
  12184. @cindex source code, batch execution
  12185. It is possible to call functions from the command line. This shell
  12186. script calls @code{org-babel-tangle} on every one of its arguments.
  12187. Be sure to adjust the paths to fit your system.
  12188. @example
  12189. #!/bin/sh
  12190. # -*- mode: shell-script -*-
  12191. #
  12192. # tangle files with org-mode
  12193. #
  12194. DIR=`pwd`
  12195. FILES=""
  12196. ORGINSTALL="~/src/org/lisp/org-install.el"
  12197. # wrap each argument in the code required to call tangle on it
  12198. for i in $@@; do
  12199. FILES="$FILES \"$i\""
  12200. done
  12201. emacs -Q --batch -l $ORGINSTALL \
  12202. --eval "(progn
  12203. (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
  12204. (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
  12205. (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
  12206. (mapc (lambda (file)
  12207. (find-file (expand-file-name file \"$DIR\"))
  12208. (org-babel-tangle)
  12209. (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
  12210. @end example
  12211. @node Miscellaneous, Hacking, Working With Source Code, Top
  12212. @chapter Miscellaneous
  12213. @menu
  12214. * Completion:: M-TAB knows what you need
  12215. * Easy Templates:: Quick insertion of structural elements
  12216. * Speed keys:: Electric commands at the beginning of a headline
  12217. * Code evaluation security:: Org mode files evaluate inline code
  12218. * Customization:: Adapting Org to your taste
  12219. * In-buffer settings:: Overview of the #+KEYWORDS
  12220. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  12221. * Clean view:: Getting rid of leading stars in the outline
  12222. * TTY keys:: Using Org on a tty
  12223. * Interaction:: Other Emacs packages
  12224. * org-crypt.el:: Encrypting Org files
  12225. @end menu
  12226. @node Completion, Easy Templates, Miscellaneous, Miscellaneous
  12227. @section Completion
  12228. @cindex completion, of @TeX{} symbols
  12229. @cindex completion, of TODO keywords
  12230. @cindex completion, of dictionary words
  12231. @cindex completion, of option keywords
  12232. @cindex completion, of tags
  12233. @cindex completion, of property keys
  12234. @cindex completion, of link abbreviations
  12235. @cindex @TeX{} symbol completion
  12236. @cindex TODO keywords completion
  12237. @cindex dictionary word completion
  12238. @cindex option keyword completion
  12239. @cindex tag completion
  12240. @cindex link abbreviations, completion of
  12241. Emacs would not be Emacs without completion, and Org mode uses it whenever it
  12242. makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
  12243. some of the completion prompts, you can specify your preference by setting at
  12244. most one of the variables @code{org-completion-use-iswitchb}
  12245. @code{org-completion-use-ido}.
  12246. Org supports in-buffer completion. This type of completion does
  12247. not make use of the minibuffer. You simply type a few letters into
  12248. the buffer and use the key to complete text right there.
  12249. @table @kbd
  12250. @kindex M-@key{TAB}
  12251. @item M-@key{TAB}
  12252. Complete word at point
  12253. @itemize @bullet
  12254. @item
  12255. At the beginning of a headline, complete TODO keywords.
  12256. @item
  12257. After @samp{\}, complete @TeX{} symbols supported by the exporter.
  12258. @item
  12259. After @samp{*}, complete headlines in the current buffer so that they
  12260. can be used in search links like @samp{[[*find this headline]]}.
  12261. @item
  12262. After @samp{:} in a headline, complete tags. The list of tags is taken
  12263. from the variable @code{org-tag-alist} (possibly set through the
  12264. @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
  12265. dynamically from all tags used in the current buffer.
  12266. @item
  12267. After @samp{:} and not in a headline, complete property keys. The list
  12268. of keys is constructed dynamically from all keys used in the current
  12269. buffer.
  12270. @item
  12271. After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
  12272. @item
  12273. After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
  12274. @samp{OPTIONS} which set file-specific options for Org mode. When the
  12275. option keyword is already complete, pressing @kbd{M-@key{TAB}} again
  12276. will insert example settings for this keyword.
  12277. @item
  12278. In the line after @samp{#+STARTUP: }, complete startup keywords,
  12279. i.e.@: valid keys for this line.
  12280. @item
  12281. Elsewhere, complete dictionary words using Ispell.
  12282. @end itemize
  12283. @end table
  12284. @node Easy Templates, Speed keys, Completion, Miscellaneous
  12285. @section Easy Templates
  12286. @cindex template insertion
  12287. @cindex insertion, of templates
  12288. Org mode supports insertion of empty structural elements (like
  12289. @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
  12290. strokes. This is achieved through a native template expansion mechanism.
  12291. Note that Emacs has several other template mechanisms which could be used in
  12292. a similar way, for example @file{yasnippet}.
  12293. To insert a structural element, type a @samp{<}, followed by a template
  12294. selector and @kbd{@key{TAB}}. Completion takes effect only when the above
  12295. keystrokes are typed on a line by itself.
  12296. The following template selectors are currently supported.
  12297. @multitable @columnfractions 0.1 0.9
  12298. @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
  12299. @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
  12300. @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
  12301. @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
  12302. @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
  12303. @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX}
  12304. @item @kbd{L} @tab @code{#+LaTeX:}
  12305. @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML}
  12306. @item @kbd{H} @tab @code{#+HTML:}
  12307. @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII}
  12308. @item @kbd{A} @tab @code{#+ASCII:}
  12309. @item @kbd{i} @tab @code{#+INDEX:} line
  12310. @item @kbd{I} @tab @code{#+INCLUDE:} line
  12311. @end multitable
  12312. For example, on an empty line, typing "<e" and then pressing TAB, will expand
  12313. into a complete EXAMPLE template.
  12314. You can install additional templates by customizing the variable
  12315. @code{org-structure-template-alist}. See the docstring of the variable for
  12316. additional details.
  12317. @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
  12318. @section Speed keys
  12319. @cindex speed keys
  12320. @vindex org-use-speed-commands
  12321. @vindex org-speed-commands-user
  12322. Single keys can be made to execute commands when the cursor is at the
  12323. beginning of a headline, i.e.@: before the first star. Configure the variable
  12324. @code{org-use-speed-commands} to activate this feature. There is a
  12325. pre-defined list of commands, and you can add more such commands using the
  12326. variable @code{org-speed-commands-user}. Speed keys do not only speed up
  12327. navigation and other commands, but they also provide an alternative way to
  12328. execute commands bound to keys that are not or not easily available on a TTY,
  12329. or on a small mobile device with a limited keyboard.
  12330. To see which commands are available, activate the feature and press @kbd{?}
  12331. with the cursor at the beginning of a headline.
  12332. @node Code evaluation security, Customization, Speed keys, Miscellaneous
  12333. @section Code evaluation and security issues
  12334. Org provides tools to work with the code snippets, including evaluating them.
  12335. Running code on your machine always comes with a security risk. Badly
  12336. written or malicious code can be executed on purpose or by accident. Org has
  12337. default settings which will only evaluate such code if you give explicit
  12338. permission to do so, and as a casual user of these features you should leave
  12339. these precautions intact.
  12340. For people who regularly work with such code, the confirmation prompts can
  12341. become annoying, and you might want to turn them off. This can be done, but
  12342. you must be aware of the risks that are involved.
  12343. Code evaluation can happen under the following circumstances:
  12344. @table @i
  12345. @item Source code blocks
  12346. Source code blocks can be evaluated during export, or when pressing @kbd{C-c
  12347. C-c} in the block. The most important thing to realize here is that Org mode
  12348. files which contain code snippets are, in a certain sense, like executable
  12349. files. So you should accept them and load them into Emacs only from trusted
  12350. sources---just like you would do with a program you install on your computer.
  12351. Make sure you know what you are doing before customizing the variables
  12352. which take off the default security brakes.
  12353. @defopt org-confirm-babel-evaluate
  12354. When t (the default), the user is asked before every code block evaluation.
  12355. When nil, the user is not asked. When set to a function, it is called with
  12356. two arguments (language and body of the code block) and should return t to
  12357. ask and nil not to ask.
  12358. @end defopt
  12359. For example, here is how to execute "ditaa" code (which is considered safe)
  12360. without asking:
  12361. @example
  12362. (defun my-org-confirm-babel-evaluate (lang body)
  12363. (not (string= lang "ditaa"))) ; don't ask for ditaa
  12364. (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
  12365. @end example
  12366. @item Following @code{shell} and @code{elisp} links
  12367. Org has two link types that can directly evaluate code (@pxref{External
  12368. links}). These links can be problematic because the code to be evaluated is
  12369. not visible.
  12370. @defopt org-confirm-shell-link-function
  12371. Function to queries user about shell link execution.
  12372. @end defopt
  12373. @defopt org-confirm-elisp-link-function
  12374. Functions to query user for Emacs Lisp link execution.
  12375. @end defopt
  12376. @item Formulas in tables
  12377. Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
  12378. either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
  12379. @end table
  12380. @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
  12381. @section Customization
  12382. @cindex customization
  12383. @cindex options, for customization
  12384. @cindex variables, for customization
  12385. There are more than 500 variables that can be used to customize
  12386. Org. For the sake of compactness of the manual, I am not
  12387. describing the variables here. A structured overview of customization
  12388. variables is available with @kbd{M-x org-customize}. Or select
  12389. @code{Browse Org Group} from the @code{Org->Customization} menu. Many
  12390. settings can also be activated on a per-file basis, by putting special
  12391. lines into the buffer (@pxref{In-buffer settings}).
  12392. @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
  12393. @section Summary of in-buffer settings
  12394. @cindex in-buffer settings
  12395. @cindex special keywords
  12396. Org mode uses special lines in the buffer to define settings on a
  12397. per-file basis. These lines start with a @samp{#+} followed by a
  12398. keyword, a colon, and then individual words defining a setting. Several
  12399. setting words can be in the same line, but you can also have multiple
  12400. lines for the keyword. While these settings are described throughout
  12401. the manual, here is a summary. After changing any of those lines in the
  12402. buffer, press @kbd{C-c C-c} with the cursor still in the line to
  12403. activate the changes immediately. Otherwise they become effective only
  12404. when the file is visited again in a new Emacs session.
  12405. @vindex org-archive-location
  12406. @table @kbd
  12407. @item #+ARCHIVE: %s_done::
  12408. This line sets the archive location for the agenda file. It applies for
  12409. all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
  12410. of the file. The first such line also applies to any entries before it.
  12411. The corresponding variable is @code{org-archive-location}.
  12412. @item #+CATEGORY:
  12413. This line sets the category for the agenda file. The category applies
  12414. for all subsequent lines until the next @samp{#+CATEGORY} line, or the
  12415. end of the file. The first such line also applies to any entries before it.
  12416. @item #+COLUMNS: %25ITEM .....
  12417. @cindex property, COLUMNS
  12418. Set the default format for columns view. This format applies when
  12419. columns view is invoked in locations where no @code{COLUMNS} property
  12420. applies.
  12421. @item #+CONSTANTS: name1=value1 ...
  12422. @vindex org-table-formula-constants
  12423. @vindex org-table-formula
  12424. Set file-local values for constants to be used in table formulas. This
  12425. line sets the local variable @code{org-table-formula-constants-local}.
  12426. The global version of this variable is
  12427. @code{org-table-formula-constants}.
  12428. @item #+FILETAGS: :tag1:tag2:tag3:
  12429. Set tags that can be inherited by any entry in the file, including the
  12430. top-level entries.
  12431. @item #+DRAWERS: NAME1 .....
  12432. @vindex org-drawers
  12433. Set the file-local set of drawers. The corresponding global variable is
  12434. @code{org-drawers}.
  12435. @item #+LINK: linkword replace
  12436. @vindex org-link-abbrev-alist
  12437. These lines (several are allowed) specify link abbreviations.
  12438. @xref{Link abbreviations}. The corresponding variable is
  12439. @code{org-link-abbrev-alist}.
  12440. @item #+PRIORITIES: highest lowest default
  12441. @vindex org-highest-priority
  12442. @vindex org-lowest-priority
  12443. @vindex org-default-priority
  12444. This line sets the limits and the default for the priorities. All three
  12445. must be either letters A-Z or numbers 0-9. The highest priority must
  12446. have a lower ASCII number than the lowest priority.
  12447. @item #+PROPERTY: Property_Name Value
  12448. This line sets a default inheritance value for entries in the current
  12449. buffer, most useful for specifying the allowed values of a property.
  12450. @cindex #+SETUPFILE
  12451. @item #+SETUPFILE: file
  12452. This line defines a file that holds more in-buffer setup. Normally this is
  12453. entirely ignored. Only when the buffer is parsed for option-setting lines
  12454. (i.e.@: when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
  12455. settings line, or when exporting), then the contents of this file are parsed
  12456. as if they had been included in the buffer. In particular, the file can be
  12457. any other Org mode file with internal setup. You can visit the file the
  12458. cursor is in the line with @kbd{C-c '}.
  12459. @item #+STARTUP:
  12460. @cindex #+STARTUP:
  12461. This line sets options to be used at startup of Org mode, when an
  12462. Org file is being visited.
  12463. The first set of options deals with the initial visibility of the outline
  12464. tree. The corresponding variable for global default settings is
  12465. @code{org-startup-folded}, with a default value @code{t}, which means
  12466. @code{overview}.
  12467. @vindex org-startup-folded
  12468. @cindex @code{overview}, STARTUP keyword
  12469. @cindex @code{content}, STARTUP keyword
  12470. @cindex @code{showall}, STARTUP keyword
  12471. @cindex @code{showeverything}, STARTUP keyword
  12472. @example
  12473. overview @r{top-level headlines only}
  12474. content @r{all headlines}
  12475. showall @r{no folding of any entries}
  12476. showeverything @r{show even drawer contents}
  12477. @end example
  12478. @vindex org-startup-indented
  12479. @cindex @code{indent}, STARTUP keyword
  12480. @cindex @code{noindent}, STARTUP keyword
  12481. Dynamic virtual indentation is controlled by the variable
  12482. @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
  12483. @example
  12484. indent @r{start with @code{org-indent-mode} turned on}
  12485. noindent @r{start with @code{org-indent-mode} turned off}
  12486. @end example
  12487. @vindex org-startup-align-all-tables
  12488. Then there are options for aligning tables upon visiting a file. This
  12489. is useful in files containing narrowed table columns. The corresponding
  12490. variable is @code{org-startup-align-all-tables}, with a default value
  12491. @code{nil}.
  12492. @cindex @code{align}, STARTUP keyword
  12493. @cindex @code{noalign}, STARTUP keyword
  12494. @example
  12495. align @r{align all tables}
  12496. noalign @r{don't align tables on startup}
  12497. @end example
  12498. @vindex org-startup-with-inline-images
  12499. When visiting a file, inline images can be automatically displayed. The
  12500. corresponding variable is @code{org-startup-with-inline-images}, with a
  12501. default value @code{nil} to avoid delays when visiting a file.
  12502. @cindex @code{inlineimages}, STARTUP keyword
  12503. @cindex @code{noinlineimages}, STARTUP keyword
  12504. @example
  12505. inlineimages @r{show inline images}
  12506. noinlineimages @r{don't show inline images on startup}
  12507. @end example
  12508. @vindex org-log-done
  12509. @vindex org-log-note-clock-out
  12510. @vindex org-log-repeat
  12511. Logging the closing and reopening of TODO items and clock intervals can be
  12512. configured using these options (see variables @code{org-log-done},
  12513. @code{org-log-note-clock-out} and @code{org-log-repeat})
  12514. @cindex @code{logdone}, STARTUP keyword
  12515. @cindex @code{lognotedone}, STARTUP keyword
  12516. @cindex @code{nologdone}, STARTUP keyword
  12517. @cindex @code{lognoteclock-out}, STARTUP keyword
  12518. @cindex @code{nolognoteclock-out}, STARTUP keyword
  12519. @cindex @code{logrepeat}, STARTUP keyword
  12520. @cindex @code{lognoterepeat}, STARTUP keyword
  12521. @cindex @code{nologrepeat}, STARTUP keyword
  12522. @cindex @code{logreschedule}, STARTUP keyword
  12523. @cindex @code{lognotereschedule}, STARTUP keyword
  12524. @cindex @code{nologreschedule}, STARTUP keyword
  12525. @cindex @code{logredeadline}, STARTUP keyword
  12526. @cindex @code{lognoteredeadline}, STARTUP keyword
  12527. @cindex @code{nologredeadline}, STARTUP keyword
  12528. @cindex @code{logrefile}, STARTUP keyword
  12529. @cindex @code{lognoterefile}, STARTUP keyword
  12530. @cindex @code{nologrefile}, STARTUP keyword
  12531. @example
  12532. logdone @r{record a timestamp when an item is marked DONE}
  12533. lognotedone @r{record timestamp and a note when DONE}
  12534. nologdone @r{don't record when items are marked DONE}
  12535. logrepeat @r{record a time when reinstating a repeating item}
  12536. lognoterepeat @r{record a note when reinstating a repeating item}
  12537. nologrepeat @r{do not record when reinstating repeating item}
  12538. lognoteclock-out @r{record a note when clocking out}
  12539. nolognoteclock-out @r{don't record a note when clocking out}
  12540. logreschedule @r{record a timestamp when scheduling time changes}
  12541. lognotereschedule @r{record a note when scheduling time changes}
  12542. nologreschedule @r{do not record when a scheduling date changes}
  12543. logredeadline @r{record a timestamp when deadline changes}
  12544. lognoteredeadline @r{record a note when deadline changes}
  12545. nologredeadline @r{do not record when a deadline date changes}
  12546. logrefile @r{record a timestamp when refiling}
  12547. lognoterefile @r{record a note when refiling}
  12548. nologrefile @r{do not record when refiling}
  12549. @end example
  12550. @vindex org-hide-leading-stars
  12551. @vindex org-odd-levels-only
  12552. Here are the options for hiding leading stars in outline headings, and for
  12553. indenting outlines. The corresponding variables are
  12554. @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
  12555. default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
  12556. @cindex @code{hidestars}, STARTUP keyword
  12557. @cindex @code{showstars}, STARTUP keyword
  12558. @cindex @code{odd}, STARTUP keyword
  12559. @cindex @code{even}, STARTUP keyword
  12560. @example
  12561. hidestars @r{make all but one of the stars starting a headline invisible.}
  12562. showstars @r{show all stars starting a headline}
  12563. indent @r{virtual indentation according to outline level}
  12564. noindent @r{no virtual indentation according to outline level}
  12565. odd @r{allow only odd outline levels (1,3,...)}
  12566. oddeven @r{allow all outline levels}
  12567. @end example
  12568. @vindex org-put-time-stamp-overlays
  12569. @vindex org-time-stamp-overlay-formats
  12570. To turn on custom format overlays over timestamps (variables
  12571. @code{org-put-time-stamp-overlays} and
  12572. @code{org-time-stamp-overlay-formats}), use
  12573. @cindex @code{customtime}, STARTUP keyword
  12574. @example
  12575. customtime @r{overlay custom time format}
  12576. @end example
  12577. @vindex constants-unit-system
  12578. The following options influence the table spreadsheet (variable
  12579. @code{constants-unit-system}).
  12580. @cindex @code{constcgs}, STARTUP keyword
  12581. @cindex @code{constSI}, STARTUP keyword
  12582. @example
  12583. constcgs @r{@file{constants.el} should use the c-g-s unit system}
  12584. constSI @r{@file{constants.el} should use the SI unit system}
  12585. @end example
  12586. @vindex org-footnote-define-inline
  12587. @vindex org-footnote-auto-label
  12588. @vindex org-footnote-auto-adjust
  12589. To influence footnote settings, use the following keywords. The
  12590. corresponding variables are @code{org-footnote-define-inline},
  12591. @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
  12592. @cindex @code{fninline}, STARTUP keyword
  12593. @cindex @code{nofninline}, STARTUP keyword
  12594. @cindex @code{fnlocal}, STARTUP keyword
  12595. @cindex @code{fnprompt}, STARTUP keyword
  12596. @cindex @code{fnauto}, STARTUP keyword
  12597. @cindex @code{fnconfirm}, STARTUP keyword
  12598. @cindex @code{fnplain}, STARTUP keyword
  12599. @cindex @code{fnadjust}, STARTUP keyword
  12600. @cindex @code{nofnadjust}, STARTUP keyword
  12601. @example
  12602. fninline @r{define footnotes inline}
  12603. fnnoinline @r{define footnotes in separate section}
  12604. fnlocal @r{define footnotes near first reference, but not inline}
  12605. fnprompt @r{prompt for footnote labels}
  12606. fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
  12607. fnconfirm @r{offer automatic label for editing or confirmation}
  12608. fnplain @r{create @code{[1]}-like labels automatically}
  12609. fnadjust @r{automatically renumber and sort footnotes}
  12610. nofnadjust @r{do not renumber and sort automatically}
  12611. @end example
  12612. @cindex org-hide-block-startup
  12613. To hide blocks on startup, use these keywords. The corresponding variable is
  12614. @code{org-hide-block-startup}.
  12615. @cindex @code{hideblocks}, STARTUP keyword
  12616. @cindex @code{nohideblocks}, STARTUP keyword
  12617. @example
  12618. hideblocks @r{Hide all begin/end blocks on startup}
  12619. nohideblocks @r{Do not hide blocks on startup}
  12620. @end example
  12621. @cindex org-pretty-entities
  12622. The display of entities as UTF-8 characters is governed by the variable
  12623. @code{org-pretty-entities} and the keywords
  12624. @cindex @code{entitiespretty}, STARTUP keyword
  12625. @cindex @code{entitiesplain}, STARTUP keyword
  12626. @example
  12627. entitiespretty @r{Show entities as UTF-8 characters where possible}
  12628. entitiesplain @r{Leave entities plain}
  12629. @end example
  12630. @item #+TAGS: TAG1(c1) TAG2(c2)
  12631. @vindex org-tag-alist
  12632. These lines (several such lines are allowed) specify the valid tags in
  12633. this file, and (potentially) the corresponding @emph{fast tag selection}
  12634. keys. The corresponding variable is @code{org-tag-alist}.
  12635. @item #+TBLFM:
  12636. This line contains the formulas for the table directly above the line.
  12637. @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
  12638. @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
  12639. @itemx #+DESCRIPTION:, #+KEYWORDS:,
  12640. @itemx #+LaTeX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
  12641. @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
  12642. These lines provide settings for exporting files. For more details see
  12643. @ref{Export options}.
  12644. @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
  12645. @vindex org-todo-keywords
  12646. These lines set the TODO keywords and their interpretation in the
  12647. current file. The corresponding variable is @code{org-todo-keywords}.
  12648. @end table
  12649. @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
  12650. @section The very busy C-c C-c key
  12651. @kindex C-c C-c
  12652. @cindex C-c C-c, overview
  12653. The key @kbd{C-c C-c} has many purposes in Org, which are all
  12654. mentioned scattered throughout this manual. One specific function of
  12655. this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
  12656. other circumstances it means something like @emph{``Hey Org, look
  12657. here and update according to what you see here''}. Here is a summary of
  12658. what this means in different contexts.
  12659. @itemize @minus
  12660. @item
  12661. If there are highlights in the buffer from the creation of a sparse
  12662. tree, or from clock display, remove these highlights.
  12663. @item
  12664. If the cursor is in one of the special @code{#+KEYWORD} lines, this
  12665. triggers scanning the buffer for these lines and updating the
  12666. information.
  12667. @item
  12668. If the cursor is inside a table, realign the table. This command
  12669. works even if the automatic table editor has been turned off.
  12670. @item
  12671. If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
  12672. the entire table.
  12673. @item
  12674. If the current buffer is a capture buffer, close the note and file it.
  12675. With a prefix argument, file it, without further interaction, to the
  12676. default location.
  12677. @item
  12678. If the cursor is on a @code{<<<target>>>}, update radio targets and
  12679. corresponding links in this buffer.
  12680. @item
  12681. If the cursor is in a property line or at the start or end of a property
  12682. drawer, offer property commands.
  12683. @item
  12684. If the cursor is at a footnote reference, go to the corresponding
  12685. definition, and vice versa.
  12686. @item
  12687. If the cursor is on a statistics cookie, update it.
  12688. @item
  12689. If the cursor is in a plain list item with a checkbox, toggle the status
  12690. of the checkbox.
  12691. @item
  12692. If the cursor is on a numbered item in a plain list, renumber the
  12693. ordered list.
  12694. @item
  12695. If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
  12696. block is updated.
  12697. @item
  12698. If the cursor is at a timestamp, fix the day name in the timestamp.
  12699. @end itemize
  12700. @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
  12701. @section A cleaner outline view
  12702. @cindex hiding leading stars
  12703. @cindex dynamic indentation
  12704. @cindex odd-levels-only outlines
  12705. @cindex clean outline view
  12706. Some people find it noisy and distracting that the Org headlines start with a
  12707. potentially large number of stars, and that text below the headlines is not
  12708. indented. While this is no problem when writing a @emph{book-like} document
  12709. where the outline headings are really section headings, in a more
  12710. @emph{list-oriented} outline, indented structure is a lot cleaner:
  12711. @example
  12712. @group
  12713. * Top level headline | * Top level headline
  12714. ** Second level | * Second level
  12715. *** 3rd level | * 3rd level
  12716. some text | some text
  12717. *** 3rd level | * 3rd level
  12718. more text | more text
  12719. * Another top level headline | * Another top level headline
  12720. @end group
  12721. @end example
  12722. @noindent
  12723. If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
  12724. with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
  12725. be achieved dynamically at display time using @code{org-indent-mode}. In
  12726. this minor mode, all lines are prefixed for display with the necessary amount
  12727. of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
  12728. property, such that @code{visual-line-mode} (or purely setting
  12729. @code{word-wrap}) wraps long lines (including headlines) correctly indented.
  12730. }. Also headlines are prefixed with additional stars, so that the amount of
  12731. indentation shifts by two@footnote{See the variable
  12732. @code{org-indent-indentation-per-level}.} spaces per level. All headline
  12733. stars but the last one are made invisible using the @code{org-hide}
  12734. face@footnote{Turning on @code{org-indent-mode} sets
  12735. @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
  12736. @code{nil}.} - see below under @samp{2.} for more information on how this
  12737. works. You can turn on @code{org-indent-mode} for all files by customizing
  12738. the variable @code{org-startup-indented}, or you can turn it on for
  12739. individual files using
  12740. @example
  12741. #+STARTUP: indent
  12742. @end example
  12743. If you want a similar effect in an earlier version of Emacs and/or Org, or if
  12744. you want the indentation to be hard space characters so that the plain text
  12745. file looks as similar as possible to the Emacs display, Org supports you in
  12746. the following way:
  12747. @enumerate
  12748. @item
  12749. @emph{Indentation of text below headlines}@*
  12750. You may indent text below each headline to make the left boundary line up
  12751. with the headline, like
  12752. @example
  12753. *** 3rd level
  12754. more text, now indented
  12755. @end example
  12756. @vindex org-adapt-indentation
  12757. Org supports this with paragraph filling, line wrapping, and structure
  12758. editing@footnote{See also the variable @code{org-adapt-indentation}.},
  12759. preserving or adapting the indentation as appropriate.
  12760. @item
  12761. @vindex org-hide-leading-stars
  12762. @emph{Hiding leading stars}@* You can modify the display in such a way that
  12763. all leading stars become invisible. To do this in a global way, configure
  12764. the variable @code{org-hide-leading-stars} or change this on a per-file basis
  12765. with
  12766. @example
  12767. #+STARTUP: hidestars
  12768. #+STARTUP: showstars
  12769. @end example
  12770. With hidden stars, the tree becomes:
  12771. @example
  12772. @group
  12773. * Top level headline
  12774. * Second level
  12775. * 3rd level
  12776. ...
  12777. @end group
  12778. @end example
  12779. @noindent
  12780. @vindex org-hide @r{(face)}
  12781. The leading stars are not truly replaced by whitespace, they are only
  12782. fontified with the face @code{org-hide} that uses the background color as
  12783. font color. If you are not using either white or black background, you may
  12784. have to customize this face to get the wanted effect. Another possibility is
  12785. to set this font such that the extra stars are @i{almost} invisible, for
  12786. example using the color @code{grey90} on a white background.
  12787. @item
  12788. @vindex org-odd-levels-only
  12789. Things become cleaner still if you skip all the even levels and use only odd
  12790. levels 1, 3, 5..., effectively adding two stars to go from one outline level
  12791. to the next@footnote{When you need to specify a level for a property search
  12792. or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
  12793. way we get the outline view shown at the beginning of this section. In order
  12794. to make the structure editing and export commands handle this convention
  12795. correctly, configure the variable @code{org-odd-levels-only}, or set this on
  12796. a per-file basis with one of the following lines:
  12797. @example
  12798. #+STARTUP: odd
  12799. #+STARTUP: oddeven
  12800. @end example
  12801. You can convert an Org file from single-star-per-level to the
  12802. double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
  12803. RET} in that file. The reverse operation is @kbd{M-x
  12804. org-convert-to-oddeven-levels}.
  12805. @end enumerate
  12806. @node TTY keys, Interaction, Clean view, Miscellaneous
  12807. @section Using Org on a tty
  12808. @cindex tty key bindings
  12809. Because Org contains a large number of commands, by default many of
  12810. Org's core commands are bound to keys that are generally not
  12811. accessible on a tty, such as the cursor keys (@key{left}, @key{right},
  12812. @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
  12813. together with modifiers like @key{Meta} and/or @key{Shift}. To access
  12814. these commands on a tty when special keys are unavailable, the following
  12815. alternative bindings can be used. The tty bindings below will likely be
  12816. more cumbersome; you may find for some of the bindings below that a
  12817. customized workaround suits you better. For example, changing a timestamp
  12818. is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
  12819. tty you would rather use @kbd{C-c .} to re-insert the timestamp.
  12820. @multitable @columnfractions 0.15 0.2 0.1 0.2
  12821. @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
  12822. @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
  12823. @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
  12824. @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
  12825. @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
  12826. @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
  12827. @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
  12828. @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
  12829. @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
  12830. @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
  12831. @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
  12832. @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
  12833. @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
  12834. @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
  12835. @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
  12836. @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
  12837. @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
  12838. @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
  12839. @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
  12840. @end multitable
  12841. @node Interaction, org-crypt.el, TTY keys, Miscellaneous
  12842. @section Interaction with other packages
  12843. @cindex packages, interaction with other
  12844. Org lives in the world of GNU Emacs and interacts in various ways
  12845. with other code out there.
  12846. @menu
  12847. * Cooperation:: Packages Org cooperates with
  12848. * Conflicts:: Packages that lead to conflicts
  12849. @end menu
  12850. @node Cooperation, Conflicts, Interaction, Interaction
  12851. @subsection Packages that Org cooperates with
  12852. @table @asis
  12853. @cindex @file{calc.el}
  12854. @cindex Gillespie, Dave
  12855. @item @file{calc.el} by Dave Gillespie
  12856. Org uses the Calc package for implementing spreadsheet
  12857. functionality in its tables (@pxref{The spreadsheet}). Org
  12858. checks for the availability of Calc by looking for the function
  12859. @code{calc-eval} which will have been autoloaded during setup if Calc has
  12860. been installed properly. As of Emacs 22, Calc is part of the Emacs
  12861. distribution. Another possibility for interaction between the two
  12862. packages is using Calc for embedded calculations. @xref{Embedded Mode,
  12863. , Embedded Mode, Calc, GNU Emacs Calc Manual}.
  12864. @item @file{constants.el} by Carsten Dominik
  12865. @cindex @file{constants.el}
  12866. @cindex Dominik, Carsten
  12867. @vindex org-table-formula-constants
  12868. In a table formula (@pxref{The spreadsheet}), it is possible to use
  12869. names for natural constants or units. Instead of defining your own
  12870. constants in the variable @code{org-table-formula-constants}, install
  12871. the @file{constants} package which defines a large number of constants
  12872. and units, and lets you use unit prefixes like @samp{M} for
  12873. @samp{Mega}, etc@. You will need version 2.0 of this package, available
  12874. at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
  12875. the function @code{constants-get}, which has to be autoloaded in your
  12876. setup. See the installation instructions in the file
  12877. @file{constants.el}.
  12878. @item @file{cdlatex.el} by Carsten Dominik
  12879. @cindex @file{cdlatex.el}
  12880. @cindex Dominik, Carsten
  12881. Org mode can make use of the CD@LaTeX{} package to efficiently enter
  12882. @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
  12883. @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
  12884. @cindex @file{imenu.el}
  12885. Imenu allows menu access to an index of items in a file. Org mode
  12886. supports Imenu---all you need to do to get the index is the following:
  12887. @lisp
  12888. (add-hook 'org-mode-hook
  12889. (lambda () (imenu-add-to-menubar "Imenu")))
  12890. @end lisp
  12891. @vindex org-imenu-depth
  12892. By default the index is two levels deep---you can modify the depth using
  12893. the option @code{org-imenu-depth}.
  12894. @item @file{remember.el} by John Wiegley
  12895. @cindex @file{remember.el}
  12896. @cindex Wiegley, John
  12897. Org used to use this package for capture, but no longer does.
  12898. @item @file{speedbar.el} by Eric M. Ludlam
  12899. @cindex @file{speedbar.el}
  12900. @cindex Ludlam, Eric M.
  12901. Speedbar is a package that creates a special frame displaying files and
  12902. index items in files. Org mode supports Speedbar and allows you to
  12903. drill into Org files directly from the Speedbar. It also allows you to
  12904. restrict the scope of agenda commands to a file or a subtree by using
  12905. the command @kbd{<} in the Speedbar frame.
  12906. @cindex @file{table.el}
  12907. @item @file{table.el} by Takaaki Ota
  12908. @kindex C-c C-c
  12909. @cindex table editor, @file{table.el}
  12910. @cindex @file{table.el}
  12911. @cindex Ota, Takaaki
  12912. Complex ASCII tables with automatic line wrapping, column- and row-spanning,
  12913. and alignment can be created using the Emacs table package by Takaaki Ota
  12914. (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
  12915. Org mode will recognize these tables and export them properly. Because of
  12916. interference with other Org mode functionality, you unfortunately cannot edit
  12917. these tables directly in the buffer. Instead, you need to use the command
  12918. @kbd{C-c '} to edit them, similar to source code snippets.
  12919. @table @kbd
  12920. @orgcmd{C-c ',org-edit-special}
  12921. Edit a @file{table.el} table. Works when the cursor is in a table.el table.
  12922. @c
  12923. @orgcmd{C-c ~,org-table-create-with-table.el}
  12924. Insert a @file{table.el} table. If there is already a table at point, this
  12925. command converts it between the @file{table.el} format and the Org mode
  12926. format. See the documentation string of the command
  12927. @code{org-convert-table} for the restrictions under which this is
  12928. possible.
  12929. @end table
  12930. @file{table.el} is part of Emacs since Emacs 22.
  12931. @item @file{footnote.el} by Steven L. Baur
  12932. @cindex @file{footnote.el}
  12933. @cindex Baur, Steven L.
  12934. Org mode recognizes numerical footnotes as provided by this package.
  12935. However, Org mode also has its own footnote support (@pxref{Footnotes}),
  12936. which makes using @file{footnote.el} unnecessary.
  12937. @end table
  12938. @node Conflicts, , Cooperation, Interaction
  12939. @subsection Packages that lead to conflicts with Org mode
  12940. @table @asis
  12941. @cindex @code{shift-selection-mode}
  12942. @vindex org-support-shift-select
  12943. In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
  12944. cursor motions combined with the shift key should start or enlarge regions.
  12945. This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
  12946. timestamps, TODO keywords, priorities, and item bullet types if the cursor is
  12947. at such a location. By default, @kbd{S-@key{cursor}} commands outside
  12948. special contexts don't do anything, but you can customize the variable
  12949. @code{org-support-shift-select}. Org mode then tries to accommodate shift
  12950. selection by (i) using it outside of the special contexts where special
  12951. commands apply, and by (ii) extending an existing active region even if the
  12952. cursor moves across a special context.
  12953. @item @file{CUA.el} by Kim. F. Storm
  12954. @cindex @file{CUA.el}
  12955. @cindex Storm, Kim. F.
  12956. @vindex org-replace-disputed-keys
  12957. Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
  12958. (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
  12959. region. In fact, Emacs 23 has this built-in in the form of
  12960. @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
  12961. 23, you probably don't want to use another package for this purpose. However,
  12962. if you prefer to leave these keys to a different package while working in
  12963. Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
  12964. Org will move the following key bindings in Org files, and in the agenda
  12965. buffer (but not during date selection).
  12966. @example
  12967. S-UP @result{} M-p S-DOWN @result{} M-n
  12968. S-LEFT @result{} M-- S-RIGHT @result{} M-+
  12969. C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
  12970. @end example
  12971. @vindex org-disputed-keys
  12972. Yes, these are unfortunately more difficult to remember. If you want
  12973. to have other replacement keys, look at the variable
  12974. @code{org-disputed-keys}.
  12975. @item @file{yasnippet.el}
  12976. @cindex @file{yasnippet.el}
  12977. The way Org mode binds the TAB key (binding to @code{[tab]} instead of
  12978. @code{"\t"}) overrules YASnippet's access to this key. The following code
  12979. fixed this problem:
  12980. @lisp
  12981. (add-hook 'org-mode-hook
  12982. (lambda ()
  12983. (org-set-local 'yas/trigger-key [tab])
  12984. (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
  12985. @end lisp
  12986. The latest version of yasnippet doesn't play well with Org mode. If the
  12987. above code does not fix the conflict, start by defining the following
  12988. function:
  12989. @lisp
  12990. (defun yas/org-very-safe-expand ()
  12991. (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
  12992. @end lisp
  12993. Then, tell Org mode what to do with the new function:
  12994. @lisp
  12995. (add-hook 'org-mode-hook
  12996. (lambda ()
  12997. (make-variable-buffer-local 'yas/trigger-key)
  12998. (setq yas/trigger-key [tab])
  12999. (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
  13000. (define-key yas/keymap [tab] 'yas/next-field)))
  13001. @end lisp
  13002. @item @file{windmove.el} by Hovav Shacham
  13003. @cindex @file{windmove.el}
  13004. This package also uses the @kbd{S-<cursor>} keys, so everything written
  13005. in the paragraph above about CUA mode also applies here. If you want make
  13006. the windmove function active in locations where Org mode does not have
  13007. special functionality on @kbd{S-@key{cursor}}, add this to your
  13008. configuration:
  13009. @lisp
  13010. ;; Make windmove work in org-mode:
  13011. (add-hook 'org-shiftup-final-hook 'windmove-up)
  13012. (add-hook 'org-shiftleft-final-hook 'windmove-left)
  13013. (add-hook 'org-shiftdown-final-hook 'windmove-down)
  13014. (add-hook 'org-shiftright-final-hook 'windmove-right)
  13015. @end lisp
  13016. @item @file{viper.el} by Michael Kifer
  13017. @cindex @file{viper.el}
  13018. @kindex C-c /
  13019. Viper uses @kbd{C-c /} and therefore makes this key not access the
  13020. corresponding Org mode command @code{org-sparse-tree}. You need to find
  13021. another key for this command, or override the key in
  13022. @code{viper-vi-global-user-map} with
  13023. @lisp
  13024. (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
  13025. @end lisp
  13026. @end table
  13027. @node org-crypt.el, , Interaction, Miscellaneous
  13028. @section org-crypt.el
  13029. @cindex @file{org-crypt.el}
  13030. @cindex @code{org-decrypt-entry}
  13031. Org-crypt will encrypt the text of an entry, but not the headline, or
  13032. properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
  13033. files.
  13034. Any text below a headline that has a @samp{:crypt:} tag will be automatically
  13035. be encrypted when the file is saved. If you want to use a different tag just
  13036. customize the @code{org-crypt-tag-matcher} setting.
  13037. To use org-crypt it is suggested that you have the following in your
  13038. @file{.emacs}:
  13039. @example
  13040. (require 'org-crypt)
  13041. (org-crypt-use-before-save-magic)
  13042. (setq org-tags-exclude-from-inheritance (quote ("crypt")))
  13043. (setq org-crypt-key nil)
  13044. ;; GPG key to use for encryption
  13045. ;; Either the Key ID or set to nil to use symmetric encryption.
  13046. (setq auto-save-default nil)
  13047. ;; Auto-saving does not cooperate with org-crypt.el: so you need
  13048. ;; to turn it off if you plan to use org-crypt.el quite often.
  13049. ;; Otherwise, you'll get an (annoying) message each time you
  13050. ;; start Org.
  13051. ;; To turn it off only locally, you can insert this:
  13052. ;;
  13053. ;; # -*- buffer-auto-save-file-name: nil; -*-
  13054. @end example
  13055. Excluding the crypt tag from inheritance prevents already encrypted text
  13056. being encrypted again.
  13057. @node Hacking, MobileOrg, Miscellaneous, Top
  13058. @appendix Hacking
  13059. @cindex hacking
  13060. This appendix covers some aspects where users can extend the functionality of
  13061. Org.
  13062. @menu
  13063. * Hooks:: Who to reach into Org's internals
  13064. * Add-on packages:: Available extensions
  13065. * Adding hyperlink types:: New custom link types
  13066. * Context-sensitive commands:: How to add functionality to such commands
  13067. * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
  13068. * Dynamic blocks:: Automatically filled blocks
  13069. * Special agenda views:: Customized views
  13070. * Extracting agenda information:: Postprocessing of agenda information
  13071. * Using the property API:: Writing programs that use entry properties
  13072. * Using the mapping API:: Mapping over all or selected entries
  13073. @end menu
  13074. @node Hooks, Add-on packages, Hacking, Hacking
  13075. @section Hooks
  13076. @cindex hooks
  13077. Org has a large number of hook variables that can be used to add
  13078. functionality. This appendix about hacking is going to illustrate the
  13079. use of some of them. A complete list of all hooks with documentation is
  13080. maintained by the Worg project and can be found at
  13081. @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
  13082. @node Add-on packages, Adding hyperlink types, Hooks, Hacking
  13083. @section Add-on packages
  13084. @cindex add-on packages
  13085. A large number of add-on packages have been written by various authors.
  13086. These packages are not part of Emacs, but they are distributed as contributed
  13087. packages with the separate release available at the Org mode home page at
  13088. @uref{http://orgmode.org}. The list of contributed packages, along with
  13089. documentation about each package, is maintained by the Worg project at
  13090. @uref{http://orgmode.org/worg/org-contrib/}.
  13091. @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
  13092. @section Adding hyperlink types
  13093. @cindex hyperlinks, adding new types
  13094. Org has a large number of hyperlink types built-in
  13095. (@pxref{Hyperlinks}). If you would like to add new link types, Org
  13096. provides an interface for doing so. Let's look at an example file,
  13097. @file{org-man.el}, that will add support for creating links like
  13098. @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
  13099. Emacs:
  13100. @lisp
  13101. ;;; org-man.el - Support for links to manpages in Org
  13102. (require 'org)
  13103. (org-add-link-type "man" 'org-man-open)
  13104. (add-hook 'org-store-link-functions 'org-man-store-link)
  13105. (defcustom org-man-command 'man
  13106. "The Emacs command to be used to display a man page."
  13107. :group 'org-link
  13108. :type '(choice (const man) (const woman)))
  13109. (defun org-man-open (path)
  13110. "Visit the manpage on PATH.
  13111. PATH should be a topic that can be thrown at the man command."
  13112. (funcall org-man-command path))
  13113. (defun org-man-store-link ()
  13114. "Store a link to a manpage."
  13115. (when (memq major-mode '(Man-mode woman-mode))
  13116. ;; This is a man page, we do make this link
  13117. (let* ((page (org-man-get-page-name))
  13118. (link (concat "man:" page))
  13119. (description (format "Manpage for %s" page)))
  13120. (org-store-link-props
  13121. :type "man"
  13122. :link link
  13123. :description description))))
  13124. (defun org-man-get-page-name ()
  13125. "Extract the page name from the buffer name."
  13126. ;; This works for both `Man-mode' and `woman-mode'.
  13127. (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
  13128. (match-string 1 (buffer-name))
  13129. (error "Cannot create link to this man page")))
  13130. (provide 'org-man)
  13131. ;;; org-man.el ends here
  13132. @end lisp
  13133. @noindent
  13134. You would activate this new link type in @file{.emacs} with
  13135. @lisp
  13136. (require 'org-man)
  13137. @end lisp
  13138. @noindent
  13139. Let's go through the file and see what it does.
  13140. @enumerate
  13141. @item
  13142. It does @code{(require 'org)} to make sure that @file{org.el} has been
  13143. loaded.
  13144. @item
  13145. The next line calls @code{org-add-link-type} to define a new link type
  13146. with prefix @samp{man}. The call also contains the name of a function
  13147. that will be called to follow such a link.
  13148. @item
  13149. @vindex org-store-link-functions
  13150. The next line adds a function to @code{org-store-link-functions}, in
  13151. order to allow the command @kbd{C-c l} to record a useful link in a
  13152. buffer displaying a man page.
  13153. @end enumerate
  13154. The rest of the file defines the necessary variables and functions.
  13155. First there is a customization variable that determines which Emacs
  13156. command should be used to display man pages. There are two options,
  13157. @code{man} and @code{woman}. Then the function to follow a link is
  13158. defined. It gets the link path as an argument---in this case the link
  13159. path is just a topic for the manual command. The function calls the
  13160. value of @code{org-man-command} to display the man page.
  13161. Finally the function @code{org-man-store-link} is defined. When you try
  13162. to store a link with @kbd{C-c l}, this function will be called to
  13163. try to make a link. The function must first decide if it is supposed to
  13164. create the link for this buffer type; we do this by checking the value
  13165. of the variable @code{major-mode}. If not, the function must exit and
  13166. return the value @code{nil}. If yes, the link is created by getting the
  13167. manual topic from the buffer name and prefixing it with the string
  13168. @samp{man:}. Then it must call the command @code{org-store-link-props}
  13169. and set the @code{:type} and @code{:link} properties. Optionally you
  13170. can also set the @code{:description} property to provide a default for
  13171. the link description when the link is later inserted into an Org
  13172. buffer with @kbd{C-c C-l}.
  13173. When it makes sense for your new link type, you may also define a function
  13174. @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
  13175. support for inserting such a link with @kbd{C-c C-l}. Such a function should
  13176. not accept any arguments, and return the full link with prefix.
  13177. @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
  13178. @section Context-sensitive commands
  13179. @cindex context-sensitive commands, hooks
  13180. @cindex add-ons, context-sensitive commands
  13181. @vindex org-ctrl-c-ctrl-c-hook
  13182. Org has several commands that act differently depending on context. The most
  13183. important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
  13184. Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
  13185. Add-ons can tap into this functionality by providing a function that detects
  13186. special context for that add-on and executes functionality appropriate for
  13187. the context. Here is an example from Dan Davison's @file{org-R.el} which
  13188. allows you to evaluate commands based on the @file{R} programming language
  13189. @footnote{@file{org-R.el} has been replaced by the Org mode functionality
  13190. described in @ref{Working With Source Code} and is now obsolete.}. For this
  13191. package, special contexts are lines that start with @code{#+R:} or
  13192. @code{#+RR:}.
  13193. @lisp
  13194. (defun org-R-apply-maybe ()
  13195. "Detect if this is context for org-R and execute R commands."
  13196. (if (save-excursion
  13197. (beginning-of-line 1)
  13198. (looking-at "#\\+RR?:"))
  13199. (progn (call-interactively 'org-R-apply)
  13200. t) ;; to signal that we took action
  13201. nil)) ;; to signal that we did not
  13202. (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
  13203. @end lisp
  13204. The function first checks if the cursor is in such a line. If that is the
  13205. case, @code{org-R-apply} is called and the function returns @code{t} to
  13206. signal that action was taken, and @kbd{C-c C-c} will stop looking for other
  13207. contexts. If the function finds it should do nothing locally, it returns
  13208. @code{nil} so that other, similar functions can have a try.
  13209. @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
  13210. @section Tables and lists in arbitrary syntax
  13211. @cindex tables, in other modes
  13212. @cindex lists, in other modes
  13213. @cindex Orgtbl mode
  13214. Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
  13215. frequent feature request has been to make it work with native tables in
  13216. specific languages, for example @LaTeX{}. However, this is extremely
  13217. hard to do in a general way, would lead to a customization nightmare,
  13218. and would take away much of the simplicity of the Orgtbl mode table
  13219. editor.
  13220. This appendix describes a different approach. We keep the Orgtbl mode
  13221. table in its native format (the @i{source table}), and use a custom
  13222. function to @i{translate} the table to the correct syntax, and to
  13223. @i{install} it in the right location (the @i{target table}). This puts
  13224. the burden of writing conversion functions on the user, but it allows
  13225. for a very flexible system.
  13226. Bastien added the ability to do the same with lists, in Orgstruct mode. You
  13227. can use Org's facilities to edit and structure lists by turning
  13228. @code{orgstruct-mode} on, then locally exporting such lists in another format
  13229. (HTML, @LaTeX{} or Texinfo.)
  13230. @menu
  13231. * Radio tables:: Sending and receiving radio tables
  13232. * A @LaTeX{} example:: Step by step, almost a tutorial
  13233. * Translator functions:: Copy and modify
  13234. * Radio lists:: Doing the same for lists
  13235. @end menu
  13236. @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
  13237. @subsection Radio tables
  13238. @cindex radio tables
  13239. To define the location of the target table, you first need to create two
  13240. lines that are comments in the current mode, but contain magic words for
  13241. Orgtbl mode to find. Orgtbl mode will insert the translated table
  13242. between these lines, replacing whatever was there before. For example:
  13243. @example
  13244. /* BEGIN RECEIVE ORGTBL table_name */
  13245. /* END RECEIVE ORGTBL table_name */
  13246. @end example
  13247. @noindent
  13248. Just above the source table, we put a special line that tells
  13249. Orgtbl mode how to translate this table and where to install it. For
  13250. example:
  13251. @cindex #+ORGTBL
  13252. @example
  13253. #+ORGTBL: SEND table_name translation_function arguments....
  13254. @end example
  13255. @noindent
  13256. @code{table_name} is the reference name for the table that is also used
  13257. in the receiver lines. @code{translation_function} is the Lisp function
  13258. that does the translation. Furthermore, the line can contain a list of
  13259. arguments (alternating key and value) at the end. The arguments will be
  13260. passed as a property list to the translation function for
  13261. interpretation. A few standard parameters are already recognized and
  13262. acted upon before the translation function is called:
  13263. @table @code
  13264. @item :skip N
  13265. Skip the first N lines of the table. Hlines do count as separate lines for
  13266. this parameter!
  13267. @item :skipcols (n1 n2 ...)
  13268. List of columns that should be skipped. If the table has a column with
  13269. calculation marks, that column is automatically discarded as well.
  13270. Please note that the translator function sees the table @emph{after} the
  13271. removal of these columns, the function never knows that there have been
  13272. additional columns.
  13273. @end table
  13274. @noindent
  13275. The one problem remaining is how to keep the source table in the buffer
  13276. without disturbing the normal workings of the file, for example during
  13277. compilation of a C file or processing of a @LaTeX{} file. There are a
  13278. number of different solutions:
  13279. @itemize @bullet
  13280. @item
  13281. The table could be placed in a block comment if that is supported by the
  13282. language. For example, in C mode you could wrap the table between
  13283. @samp{/*} and @samp{*/} lines.
  13284. @item
  13285. Sometimes it is possible to put the table after some kind of @i{END}
  13286. statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
  13287. in @LaTeX{}.
  13288. @item
  13289. You can just comment the table line-by-line whenever you want to process
  13290. the file, and uncomment it whenever you need to edit the table. This
  13291. only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
  13292. makes this comment-toggling very easy, in particular if you bind it to a
  13293. key.
  13294. @end itemize
  13295. @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
  13296. @subsection A @LaTeX{} example of radio tables
  13297. @cindex @LaTeX{}, and Orgtbl mode
  13298. The best way to wrap the source table in @LaTeX{} is to use the
  13299. @code{comment} environment provided by @file{comment.sty}. It has to be
  13300. activated by placing @code{\usepackage@{comment@}} into the document
  13301. header. Orgtbl mode can insert a radio table skeleton@footnote{By
  13302. default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
  13303. variable @code{orgtbl-radio-tables} to install templates for other
  13304. modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
  13305. be prompted for a table name, let's say we use @samp{salesfigures}. You
  13306. will then get the following template:
  13307. @cindex #+ORGTBL, SEND
  13308. @example
  13309. % BEGIN RECEIVE ORGTBL salesfigures
  13310. % END RECEIVE ORGTBL salesfigures
  13311. \begin@{comment@}
  13312. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  13313. | | |
  13314. \end@{comment@}
  13315. @end example
  13316. @noindent
  13317. @vindex @LaTeX{}-verbatim-environments
  13318. The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
  13319. @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
  13320. into the receiver location with name @code{salesfigures}. You may now
  13321. fill in the table---feel free to use the spreadsheet features@footnote{If
  13322. the @samp{#+TBLFM} line contains an odd number of dollar characters,
  13323. this may cause problems with font-lock in @LaTeX{} mode. As shown in the
  13324. example you can fix this by adding an extra line inside the
  13325. @code{comment} environment that is used to balance the dollar
  13326. expressions. If you are using AUC@TeX{} with the font-latex library, a
  13327. much better solution is to add the @code{comment} environment to the
  13328. variable @code{LaTeX-verbatim-environments}.}:
  13329. @example
  13330. % BEGIN RECEIVE ORGTBL salesfigures
  13331. % END RECEIVE ORGTBL salesfigures
  13332. \begin@{comment@}
  13333. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  13334. | Month | Days | Nr sold | per day |
  13335. |-------+------+---------+---------|
  13336. | Jan | 23 | 55 | 2.4 |
  13337. | Feb | 21 | 16 | 0.8 |
  13338. | March | 22 | 278 | 12.6 |
  13339. #+TBLFM: $4=$3/$2;%.1f
  13340. % $ (optional extra dollar to keep font-lock happy, see footnote)
  13341. \end@{comment@}
  13342. @end example
  13343. @noindent
  13344. When you are done, press @kbd{C-c C-c} in the table to get the converted
  13345. table inserted between the two marker lines.
  13346. Now let's assume you want to make the table header by hand, because you
  13347. want to control how columns are aligned, etc@. In this case we make sure
  13348. that the table translator skips the first 2 lines of the source
  13349. table, and tell the command to work as a @i{splice}, i.e.@: to not produce
  13350. header and footer commands of the target table:
  13351. @example
  13352. \begin@{tabular@}@{lrrr@}
  13353. Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
  13354. % BEGIN RECEIVE ORGTBL salesfigures
  13355. % END RECEIVE ORGTBL salesfigures
  13356. \end@{tabular@}
  13357. %
  13358. \begin@{comment@}
  13359. #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
  13360. | Month | Days | Nr sold | per day |
  13361. |-------+------+---------+---------|
  13362. | Jan | 23 | 55 | 2.4 |
  13363. | Feb | 21 | 16 | 0.8 |
  13364. | March | 22 | 278 | 12.6 |
  13365. #+TBLFM: $4=$3/$2;%.1f
  13366. \end@{comment@}
  13367. @end example
  13368. The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
  13369. Orgtbl mode. It uses a @code{tabular} environment to typeset the table
  13370. and marks horizontal lines with @code{\hline}. Furthermore, it
  13371. interprets the following parameters (see also @pxref{Translator functions}):
  13372. @table @code
  13373. @item :splice nil/t
  13374. When set to t, return only table body lines, don't wrap them into a
  13375. tabular environment. Default is nil.
  13376. @item :fmt fmt
  13377. A format to be used to wrap each field, it should contain @code{%s} for the
  13378. original field value. For example, to wrap each field value in dollars,
  13379. you could use @code{:fmt "$%s$"}. This may also be a property list with
  13380. column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
  13381. A function of one argument can be used in place of the strings; the
  13382. function must return a formatted string.
  13383. @item :efmt efmt
  13384. Use this format to print numbers with exponentials. The format should
  13385. have @code{%s} twice for inserting mantissa and exponent, for example
  13386. @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
  13387. may also be a property list with column numbers and formats, for example
  13388. @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
  13389. @code{efmt} has been applied to a value, @code{fmt} will also be
  13390. applied. Similar to @code{fmt}, functions of two arguments can be
  13391. supplied instead of strings.
  13392. @end table
  13393. @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
  13394. @subsection Translator functions
  13395. @cindex HTML, and Orgtbl mode
  13396. @cindex translator function
  13397. Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
  13398. (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
  13399. @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
  13400. Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
  13401. code that produces tables during HTML export.}, these all use a generic
  13402. translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
  13403. itself is a very short function that computes the column definitions for the
  13404. @code{tabular} environment, defines a few field and line separators and then
  13405. hands processing over to the generic translator. Here is the entire code:
  13406. @lisp
  13407. @group
  13408. (defun orgtbl-to-latex (table params)
  13409. "Convert the Orgtbl mode TABLE to LaTeX."
  13410. (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
  13411. org-table-last-alignment ""))
  13412. (params2
  13413. (list
  13414. :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
  13415. :tend "\\end@{tabular@}"
  13416. :lstart "" :lend " \\\\" :sep " & "
  13417. :efmt "%s\\,(%s)" :hline "\\hline")))
  13418. (orgtbl-to-generic table (org-combine-plists params2 params))))
  13419. @end group
  13420. @end lisp
  13421. As you can see, the properties passed into the function (variable
  13422. @var{PARAMS}) are combined with the ones newly defined in the function
  13423. (variable @var{PARAMS2}). The ones passed into the function (i.e.@: the
  13424. ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
  13425. would like to use the @LaTeX{} translator, but wanted the line endings to
  13426. be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
  13427. overrule the default with
  13428. @example
  13429. #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
  13430. @end example
  13431. For a new language, you can either write your own converter function in
  13432. analogy with the @LaTeX{} translator, or you can use the generic function
  13433. directly. For example, if you have a language where a table is started
  13434. with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
  13435. started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
  13436. separator is a TAB, you could call the generic translator like this (on
  13437. a single line!):
  13438. @example
  13439. #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
  13440. :lstart "!BL! " :lend " !EL!" :sep "\t"
  13441. @end example
  13442. @noindent
  13443. Please check the documentation string of the function
  13444. @code{orgtbl-to-generic} for a full list of parameters understood by
  13445. that function, and remember that you can pass each of them into
  13446. @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
  13447. using the generic function.
  13448. Of course you can also write a completely new function doing complicated
  13449. things the generic translator cannot do. A translator function takes
  13450. two arguments. The first argument is the table, a list of lines, each
  13451. line either the symbol @code{hline} or a list of fields. The second
  13452. argument is the property list containing all parameters specified in the
  13453. @samp{#+ORGTBL: SEND} line. The function must return a single string
  13454. containing the formatted table. If you write a generally useful
  13455. translator, please post it on @email{emacs-orgmode@@gnu.org} so that
  13456. others can benefit from your work.
  13457. @node Radio lists, , Translator functions, Tables in arbitrary syntax
  13458. @subsection Radio lists
  13459. @cindex radio lists
  13460. @cindex org-list-insert-radio-list
  13461. Sending and receiving radio lists works exactly the same way as sending and
  13462. receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
  13463. insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
  13464. @code{org-list-insert-radio-list}.
  13465. Here are the differences with radio tables:
  13466. @itemize @minus
  13467. @item
  13468. Orgstruct mode must be active.
  13469. @item
  13470. Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
  13471. @item
  13472. The available translation functions for radio lists don't take
  13473. parameters.
  13474. @item
  13475. @kbd{C-c C-c} will work when pressed on the first item of the list.
  13476. @end itemize
  13477. Here is a @LaTeX{} example. Let's say that you have this in your
  13478. @LaTeX{} file:
  13479. @cindex #+ORGLST
  13480. @example
  13481. % BEGIN RECEIVE ORGLST to-buy
  13482. % END RECEIVE ORGLST to-buy
  13483. \begin@{comment@}
  13484. #+ORGLST: SEND to-buy org-list-to-latex
  13485. - a new house
  13486. - a new computer
  13487. + a new keyboard
  13488. + a new mouse
  13489. - a new life
  13490. \end@{comment@}
  13491. @end example
  13492. Pressing `C-c C-c' on @code{a new house} and will insert the converted
  13493. @LaTeX{} list between the two marker lines.
  13494. @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
  13495. @section Dynamic blocks
  13496. @cindex dynamic blocks
  13497. Org documents can contain @emph{dynamic blocks}. These are
  13498. specially marked regions that are updated by some user-written function.
  13499. A good example for such a block is the clock table inserted by the
  13500. command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
  13501. Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
  13502. to the block and can also specify parameters for the function producing
  13503. the content of the block.
  13504. @cindex #+BEGIN:dynamic block
  13505. @example
  13506. #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
  13507. #+END:
  13508. @end example
  13509. Dynamic blocks are updated with the following commands
  13510. @table @kbd
  13511. @orgcmd{C-c C-x C-u,org-dblock-update}
  13512. Update dynamic block at point.
  13513. @orgkey{C-u C-c C-x C-u}
  13514. Update all dynamic blocks in the current file.
  13515. @end table
  13516. Updating a dynamic block means to remove all the text between BEGIN and
  13517. END, parse the BEGIN line for parameters and then call the specific
  13518. writer function for this block to insert the new content. If you want
  13519. to use the original content in the writer function, you can use the
  13520. extra parameter @code{:content}.
  13521. For a block with name @code{myblock}, the writer function is
  13522. @code{org-dblock-write:myblock} with as only parameter a property list
  13523. with the parameters given in the begin line. Here is a trivial example
  13524. of a block that keeps track of when the block update function was last
  13525. run:
  13526. @example
  13527. #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
  13528. #+END:
  13529. @end example
  13530. @noindent
  13531. The corresponding block writer function could look like this:
  13532. @lisp
  13533. (defun org-dblock-write:block-update-time (params)
  13534. (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
  13535. (insert "Last block update at: "
  13536. (format-time-string fmt (current-time)))))
  13537. @end lisp
  13538. If you want to make sure that all dynamic blocks are always up-to-date,
  13539. you could add the function @code{org-update-all-dblocks} to a hook, for
  13540. example @code{before-save-hook}. @code{org-update-all-dblocks} is
  13541. written in a way such that it does nothing in buffers that are not in
  13542. @code{org-mode}.
  13543. You can narrow the current buffer to the current dynamic block (like any
  13544. other block) with @code{org-narrow-to-block}.
  13545. @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
  13546. @section Special agenda views
  13547. @cindex agenda views, user-defined
  13548. @vindex org-agenda-skip-function
  13549. @vindex org-agenda-skip-function-global
  13550. Org provides a special hook that can be used to narrow down the selection
  13551. made by these agenda views: @code{agenda}, @code{todo}, @code{alltodo},
  13552. @code{tags}, @code{tags-todo}, @code{tags-tree}. You may specify a function
  13553. that is used at each match to verify if the match should indeed be part of
  13554. the agenda view, and if not, how much should be skipped. You can specify a
  13555. global condition that will be applied to all agenda views, this condition
  13556. would be stored in the variable @code{org-agenda-skip-function-global}. More
  13557. commonly, such a definition is applied only to specific custom searches,
  13558. using @code{org-agenda-skip-function}.
  13559. Let's say you want to produce a list of projects that contain a WAITING
  13560. tag anywhere in the project tree. Let's further assume that you have
  13561. marked all tree headings that define a project with the TODO keyword
  13562. PROJECT. In this case you would run a TODO search for the keyword
  13563. PROJECT, but skip the match unless there is a WAITING tag anywhere in
  13564. the subtree belonging to the project line.
  13565. To achieve this, you must write a function that searches the subtree for
  13566. the tag. If the tag is found, the function must return @code{nil} to
  13567. indicate that this match should not be skipped. If there is no such
  13568. tag, return the location of the end of the subtree, to indicate that
  13569. search should continue from there.
  13570. @lisp
  13571. (defun my-skip-unless-waiting ()
  13572. "Skip trees that are not waiting"
  13573. (let ((subtree-end (save-excursion (org-end-of-subtree t))))
  13574. (if (re-search-forward ":waiting:" subtree-end t)
  13575. nil ; tag found, do not skip
  13576. subtree-end))) ; tag not found, continue after end of subtree
  13577. @end lisp
  13578. Now you may use this function in an agenda custom command, for example
  13579. like this:
  13580. @lisp
  13581. (org-add-agenda-custom-command
  13582. '("b" todo "PROJECT"
  13583. ((org-agenda-skip-function 'my-skip-unless-waiting)
  13584. (org-agenda-overriding-header "Projects waiting for something: "))))
  13585. @end lisp
  13586. @vindex org-agenda-overriding-header
  13587. Note that this also binds @code{org-agenda-overriding-header} to get a
  13588. meaningful header in the agenda view.
  13589. @vindex org-odd-levels-only
  13590. @vindex org-agenda-skip-function
  13591. A general way to create custom searches is to base them on a search for
  13592. entries with a certain level limit. If you want to study all entries with
  13593. your custom search function, simply do a search for
  13594. @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
  13595. level number corresponds to order in the hierarchy, not to the number of
  13596. stars.}, and then use @code{org-agenda-skip-function} to select the entries
  13597. you really want to have.
  13598. You may also put a Lisp form into @code{org-agenda-skip-function}. In
  13599. particular, you may use the functions @code{org-agenda-skip-entry-if}
  13600. and @code{org-agenda-skip-subtree-if} in this form, for example:
  13601. @table @code
  13602. @item (org-agenda-skip-entry-if 'scheduled)
  13603. Skip current entry if it has been scheduled.
  13604. @item (org-agenda-skip-entry-if 'notscheduled)
  13605. Skip current entry if it has not been scheduled.
  13606. @item (org-agenda-skip-entry-if 'deadline)
  13607. Skip current entry if it has a deadline.
  13608. @item (org-agenda-skip-entry-if 'scheduled 'deadline)
  13609. Skip current entry if it has a deadline, or if it is scheduled.
  13610. @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
  13611. Skip current entry if the TODO keyword is TODO or WAITING.
  13612. @item (org-agenda-skip-entry-if 'todo 'done)
  13613. Skip current entry if the TODO keyword marks a DONE state.
  13614. @item (org-agenda-skip-entry-if 'timestamp)
  13615. Skip current entry if it has any timestamp, may also be deadline or scheduled.
  13616. @item (org-agenda-skip-entry 'regexp "regular expression")
  13617. Skip current entry if the regular expression matches in the entry.
  13618. @item (org-agenda-skip-entry 'notregexp "regular expression")
  13619. Skip current entry unless the regular expression matches.
  13620. @item (org-agenda-skip-subtree-if 'regexp "regular expression")
  13621. Same as above, but check and skip the entire subtree.
  13622. @end table
  13623. Therefore we could also have written the search for WAITING projects
  13624. like this, even without defining a special function:
  13625. @lisp
  13626. (org-add-agenda-custom-command
  13627. '("b" todo "PROJECT"
  13628. ((org-agenda-skip-function '(org-agenda-skip-subtree-if
  13629. 'regexp ":waiting:"))
  13630. (org-agenda-overriding-header "Projects waiting for something: "))))
  13631. @end lisp
  13632. @node Extracting agenda information, Using the property API, Special agenda views, Hacking
  13633. @section Extracting agenda information
  13634. @cindex agenda, pipe
  13635. @cindex Scripts, for agenda processing
  13636. @vindex org-agenda-custom-commands
  13637. Org provides commands to access agenda information for the command
  13638. line in Emacs batch mode. This extracted information can be sent
  13639. directly to a printer, or it can be read by a program that does further
  13640. processing of the data. The first of these commands is the function
  13641. @code{org-batch-agenda}, that produces an agenda view and sends it as
  13642. ASCII text to STDOUT. The command takes a single string as parameter.
  13643. If the string has length 1, it is used as a key to one of the commands
  13644. you have configured in @code{org-agenda-custom-commands}, basically any
  13645. key you can use after @kbd{C-c a}. For example, to directly print the
  13646. current TODO list, you could use
  13647. @example
  13648. emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
  13649. @end example
  13650. If the parameter is a string with 2 or more characters, it is used as a
  13651. tags/TODO match string. For example, to print your local shopping list
  13652. (all items with the tag @samp{shop}, but excluding the tag
  13653. @samp{NewYork}), you could use
  13654. @example
  13655. emacs -batch -l ~/.emacs \
  13656. -eval '(org-batch-agenda "+shop-NewYork")' | lpr
  13657. @end example
  13658. @noindent
  13659. You may also modify parameters on the fly like this:
  13660. @example
  13661. emacs -batch -l ~/.emacs \
  13662. -eval '(org-batch-agenda "a" \
  13663. org-agenda-span (quote month) \
  13664. org-agenda-include-diary nil \
  13665. org-agenda-files (quote ("~/org/project.org")))' \
  13666. | lpr
  13667. @end example
  13668. @noindent
  13669. which will produce a 30-day agenda, fully restricted to the Org file
  13670. @file{~/org/projects.org}, not even including the diary.
  13671. If you want to process the agenda data in more sophisticated ways, you
  13672. can use the command @code{org-batch-agenda-csv} to get a comma-separated
  13673. list of values for each agenda item. Each line in the output will
  13674. contain a number of fields separated by commas. The fields in a line
  13675. are:
  13676. @example
  13677. category @r{The category of the item}
  13678. head @r{The headline, without TODO keyword, TAGS and PRIORITY}
  13679. type @r{The type of the agenda entry, can be}
  13680. todo @r{selected in TODO match}
  13681. tagsmatch @r{selected in tags match}
  13682. diary @r{imported from diary}
  13683. deadline @r{a deadline}
  13684. scheduled @r{scheduled}
  13685. timestamp @r{appointment, selected by timestamp}
  13686. closed @r{entry was closed on date}
  13687. upcoming-deadline @r{warning about nearing deadline}
  13688. past-scheduled @r{forwarded scheduled item}
  13689. block @r{entry has date block including date}
  13690. todo @r{The TODO keyword, if any}
  13691. tags @r{All tags including inherited ones, separated by colons}
  13692. date @r{The relevant date, like 2007-2-14}
  13693. time @r{The time, like 15:00-16:50}
  13694. extra @r{String with extra planning info}
  13695. priority-l @r{The priority letter if any was given}
  13696. priority-n @r{The computed numerical priority}
  13697. @end example
  13698. @noindent
  13699. Time and date will only be given if a timestamp (or deadline/scheduled)
  13700. led to the selection of the item.
  13701. A CSV list like this is very easy to use in a post-processing script.
  13702. For example, here is a Perl program that gets the TODO list from
  13703. Emacs/Org and prints all the items, preceded by a checkbox:
  13704. @example
  13705. #!/usr/bin/perl
  13706. # define the Emacs command to run
  13707. $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
  13708. # run it and capture the output
  13709. $agenda = qx@{$cmd 2>/dev/null@};
  13710. # loop over all lines
  13711. foreach $line (split(/\n/,$agenda)) @{
  13712. # get the individual values
  13713. ($category,$head,$type,$todo,$tags,$date,$time,$extra,
  13714. $priority_l,$priority_n) = split(/,/,$line);
  13715. # process and print
  13716. print "[ ] $head\n";
  13717. @}
  13718. @end example
  13719. @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
  13720. @section Using the property API
  13721. @cindex API, for properties
  13722. @cindex properties, API
  13723. Here is a description of the functions that can be used to work with
  13724. properties.
  13725. @defun org-entry-properties &optional pom which
  13726. Get all properties of the entry at point-or-marker POM.@*
  13727. This includes the TODO keyword, the tags, time strings for deadline,
  13728. scheduled, and clocking, and any additional properties defined in the
  13729. entry. The return value is an alist. Keys may occur multiple times
  13730. if the property key was used several times.@*
  13731. POM may also be nil, in which case the current entry is used.
  13732. If WHICH is nil or `all', get all properties. If WHICH is
  13733. `special' or `standard', only get that subclass.
  13734. @end defun
  13735. @vindex org-use-property-inheritance
  13736. @defun org-entry-get pom property &optional inherit
  13737. Get value of PROPERTY for entry at point-or-marker POM. By default,
  13738. this only looks at properties defined locally in the entry. If INHERIT
  13739. is non-nil and the entry does not have the property, then also check
  13740. higher levels of the hierarchy. If INHERIT is the symbol
  13741. @code{selective}, use inheritance if and only if the setting of
  13742. @code{org-use-property-inheritance} selects PROPERTY for inheritance.
  13743. @end defun
  13744. @defun org-entry-delete pom property
  13745. Delete the property PROPERTY from entry at point-or-marker POM.
  13746. @end defun
  13747. @defun org-entry-put pom property value
  13748. Set PROPERTY to VALUE for entry at point-or-marker POM.
  13749. @end defun
  13750. @defun org-buffer-property-keys &optional include-specials
  13751. Get all property keys in the current buffer.
  13752. @end defun
  13753. @defun org-insert-property-drawer
  13754. Insert a property drawer at point.
  13755. @end defun
  13756. @defun org-entry-put-multivalued-property pom property &rest values
  13757. Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
  13758. strings. They will be concatenated, with spaces as separators.
  13759. @end defun
  13760. @defun org-entry-get-multivalued-property pom property
  13761. Treat the value of the property PROPERTY as a whitespace-separated list of
  13762. values and return the values as a list of strings.
  13763. @end defun
  13764. @defun org-entry-add-to-multivalued-property pom property value
  13765. Treat the value of the property PROPERTY as a whitespace-separated list of
  13766. values and make sure that VALUE is in this list.
  13767. @end defun
  13768. @defun org-entry-remove-from-multivalued-property pom property value
  13769. Treat the value of the property PROPERTY as a whitespace-separated list of
  13770. values and make sure that VALUE is @emph{not} in this list.
  13771. @end defun
  13772. @defun org-entry-member-in-multivalued-property pom property value
  13773. Treat the value of the property PROPERTY as a whitespace-separated list of
  13774. values and check if VALUE is in this list.
  13775. @end defun
  13776. @defopt org-property-allowed-value-functions
  13777. Hook for functions supplying allowed values for a specific property.
  13778. The functions must take a single argument, the name of the property, and
  13779. return a flat list of allowed values. If @samp{:ETC} is one of
  13780. the values, use the values as completion help, but allow also other values
  13781. to be entered. The functions must return @code{nil} if they are not
  13782. responsible for this property.
  13783. @end defopt
  13784. @node Using the mapping API, , Using the property API, Hacking
  13785. @section Using the mapping API
  13786. @cindex API, for mapping
  13787. @cindex mapping entries, API
  13788. Org has sophisticated mapping capabilities to find all entries satisfying
  13789. certain criteria. Internally, this functionality is used to produce agenda
  13790. views, but there is also an API that can be used to execute arbitrary
  13791. functions for each or selected entries. The main entry point for this API
  13792. is:
  13793. @defun org-map-entries func &optional match scope &rest skip
  13794. Call FUNC at each headline selected by MATCH in SCOPE.
  13795. FUNC is a function or a Lisp form. The function will be called without
  13796. arguments, with the cursor positioned at the beginning of the headline.
  13797. The return values of all calls to the function will be collected and
  13798. returned as a list.
  13799. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  13800. does not need to preserve point. After evaluation, the cursor will be
  13801. moved to the end of the line (presumably of the headline of the
  13802. processed entry) and search continues from there. Under some
  13803. circumstances, this may not produce the wanted results. For example,
  13804. if you have removed (e.g.@: archived) the current (sub)tree it could
  13805. mean that the next entry will be skipped entirely. In such cases, you
  13806. can specify the position from where search should continue by making
  13807. FUNC set the variable `org-map-continue-from' to the desired buffer
  13808. position.
  13809. MATCH is a tags/property/todo match as it is used in the agenda match view.
  13810. Only headlines that are matched by this query will be considered during
  13811. the iteration. When MATCH is nil or t, all headlines will be
  13812. visited by the iteration.
  13813. SCOPE determines the scope of this command. It can be any of:
  13814. @example
  13815. nil @r{the current buffer, respecting the restriction if any}
  13816. tree @r{the subtree started with the entry at point}
  13817. region @r{The entries within the active region, if any}
  13818. file @r{the current buffer, without restriction}
  13819. file-with-archives
  13820. @r{the current buffer, and any archives associated with it}
  13821. agenda @r{all agenda files}
  13822. agenda-with-archives
  13823. @r{all agenda files with any archive files associated with them}
  13824. (file1 file2 ...)
  13825. @r{if this is a list, all files in the list will be scanned}
  13826. @end example
  13827. @noindent
  13828. The remaining args are treated as settings for the skipping facilities of
  13829. the scanner. The following items can be given here:
  13830. @vindex org-agenda-skip-function
  13831. @example
  13832. archive @r{skip trees with the archive tag}
  13833. comment @r{skip trees with the COMMENT keyword}
  13834. function or Lisp form
  13835. @r{will be used as value for @code{org-agenda-skip-function},}
  13836. @r{so whenever the function returns t, FUNC}
  13837. @r{will not be called for that entry and search will}
  13838. @r{continue from the point where the function leaves it}
  13839. @end example
  13840. @end defun
  13841. The function given to that mapping routine can really do anything you like.
  13842. It can use the property API (@pxref{Using the property API}) to gather more
  13843. information about the entry, or in order to change metadata in the entry.
  13844. Here are a couple of functions that might be handy:
  13845. @defun org-todo &optional arg
  13846. Change the TODO state of the entry. See the docstring of the functions for
  13847. the many possible values for the argument ARG.
  13848. @end defun
  13849. @defun org-priority &optional action
  13850. Change the priority of the entry. See the docstring of this function for the
  13851. possible values for ACTION.
  13852. @end defun
  13853. @defun org-toggle-tag tag &optional onoff
  13854. Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
  13855. or @code{off} will not toggle tag, but ensure that it is either on or off.
  13856. @end defun
  13857. @defun org-promote
  13858. Promote the current entry.
  13859. @end defun
  13860. @defun org-demote
  13861. Demote the current entry.
  13862. @end defun
  13863. Here is a simple example that will turn all entries in the current file with
  13864. a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
  13865. Entries in comment trees and in archive trees will be ignored.
  13866. @lisp
  13867. (org-map-entries
  13868. '(org-todo "UPCOMING")
  13869. "+TOMORROW" 'file 'archive 'comment)
  13870. @end lisp
  13871. The following example counts the number of entries with TODO keyword
  13872. @code{WAITING}, in all agenda files.
  13873. @lisp
  13874. (length (org-map-entries t "/+WAITING" 'agenda))
  13875. @end lisp
  13876. @node MobileOrg, History and Acknowledgments, Hacking, Top
  13877. @appendix MobileOrg
  13878. @cindex iPhone
  13879. @cindex MobileOrg
  13880. @uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
  13881. @i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
  13882. @i{MobileOrg} offers offline viewing and capture support for an Org mode
  13883. system rooted on a ``real'' computer. It does also allow you to record
  13884. changes to existing entries. Android users should check out
  13885. @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
  13886. by Matt Jones.
  13887. This appendix describes the support Org has for creating agenda views in a
  13888. format that can be displayed by @i{MobileOrg}, and for integrating notes
  13889. captured and changes made by @i{MobileOrg} into the main system.
  13890. For changing tags and TODO states in MobileOrg, you should have set up the
  13891. customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
  13892. cover all important tags and TODO keywords, even if individual files use only
  13893. part of these. MobileOrg will also offer you states and tags set up with
  13894. in-buffer settings, but it will understand the logistics of TODO state
  13895. @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
  13896. (@pxref{Setting tags}) only for those set in these variables.
  13897. @menu
  13898. * Setting up the staging area:: Where to interact with the mobile device
  13899. * Pushing to MobileOrg:: Uploading Org files and agendas
  13900. * Pulling from MobileOrg:: Integrating captured and flagged items
  13901. @end menu
  13902. @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
  13903. @section Setting up the staging area
  13904. MobileOrg needs to interact with Emacs through a directory on a server. If you
  13905. are using a public server, you should consider to encrypt the files that are
  13906. uploaded to the server. This can be done with Org mode 7.02 and with
  13907. @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
  13908. installation on your system. To turn on encryption, set a password in
  13909. @i{MobileOrg} and, on the Emacs side, configure the variable
  13910. @code{org-mobile-use-encryption}@footnote{If you can safely store the
  13911. password in your Emacs setup, you might also want to configure
  13912. @code{org-mobile-encryption-password}. Please read the docstring of that
  13913. variable. Note that encryption will apply only to the contents of the
  13914. @file{.org} files. The file names themselves will remain visible.}.
  13915. The easiest way to create that directory is to use a free
  13916. @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
  13917. Dropbox, or if your version of MobileOrg does not support it, you can use a
  13918. webdav server. For more information, check out the documentation of MobileOrg and also this
  13919. @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
  13920. When MobileOrg first connects to your Dropbox, it will create a directory
  13921. @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
  13922. Emacs about it:
  13923. @lisp
  13924. (setq org-mobile-directory "~/Dropbox/MobileOrg")
  13925. @end lisp
  13926. Org mode has commands to put files for @i{MobileOrg} into that directory,
  13927. and to read captured notes from there.
  13928. @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
  13929. @section Pushing to MobileOrg
  13930. This operation copies all files currently listed in @code{org-mobile-files}
  13931. to the directory @code{org-mobile-directory}. By default this list contains
  13932. all agenda files (as listed in @code{org-agenda-files}), but additional files
  13933. can be included by customizing @code{org-mobile-files}. File names will be
  13934. staged with paths relative to @code{org-directory}, so all files should be
  13935. inside this directory. The push operation also creates a special Org file
  13936. @file{agendas.org} with all custom agenda view defined by the
  13937. user@footnote{While creating the agendas, Org mode will force ID properties
  13938. on all referenced entries, so that these entries can be uniquely identified
  13939. if @i{MobileOrg} flags them for further action. If you do not want to get
  13940. these properties in so many entries, you can set the variable
  13941. @code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then
  13942. rely on outline paths, in the hope that these will be unique enough.}.
  13943. Finally, Org writes the file @file{index.org}, containing links to all other
  13944. files. @i{MobileOrg} first reads this file from the server, and then
  13945. downloads all agendas and Org files listed in it. To speed up the download,
  13946. MobileOrg will only read files whose checksums@footnote{stored automatically
  13947. in the file @file{checksums.dat}} have changed.
  13948. @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
  13949. @section Pulling from MobileOrg
  13950. When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
  13951. files for viewing. It also appends captured entries and pointers to flagged
  13952. and changed entries to the file @file{mobileorg.org} on the server. Org has
  13953. a @emph{pull} operation that integrates this information into an inbox file
  13954. and operates on the pointers to flagged entries. Here is how it works:
  13955. @enumerate
  13956. @item
  13957. Org moves all entries found in
  13958. @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
  13959. operation.} and appends them to the file pointed to by the variable
  13960. @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
  13961. will be a top-level entry in the inbox file.
  13962. @item
  13963. After moving the entries, Org will attempt to implement the changes made in
  13964. @i{MobileOrg}. Some changes are applied directly and without user
  13965. interaction. Examples are all changes to tags, TODO state, headline and body
  13966. text that can be cleanly applied. Entries that have been flagged for further
  13967. action will receive a tag @code{:FLAGGED:}, so that they can be easily found
  13968. again. When there is a problem finding an entry or applying the change, the
  13969. pointer entry will remain in the inbox and will be marked with an error
  13970. message. You need to later resolve these issues by hand.
  13971. @item
  13972. Org will then generate an agenda view with all flagged entries. The user
  13973. should then go through these entries and do whatever actions are necessary.
  13974. If a note has been stored while flagging an entry in @i{MobileOrg}, that note
  13975. will be displayed in the echo area when the cursor is on the corresponding
  13976. agenda line.
  13977. @table @kbd
  13978. @kindex ?
  13979. @item ?
  13980. Pressing @kbd{?} in that special agenda will display the full flagging note in
  13981. another window and also push it onto the kill ring. So you could use @kbd{?
  13982. z C-y C-c C-c} to store that flagging note as a normal note in the entry.
  13983. Pressing @kbd{?} twice in succession will offer to remove the
  13984. @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
  13985. in a property). In this way you indicate that the intended processing for
  13986. this flagged entry is finished.
  13987. @end table
  13988. @end enumerate
  13989. @kindex C-c a ?
  13990. If you are not able to process all flagged entries directly, you can always
  13991. return to this agenda view@footnote{Note, however, that there is a subtle
  13992. difference. The view created automatically by @kbd{M-x org-mobile-pull
  13993. @key{RET}} is guaranteed to search all files that have been addressed by the
  13994. last pull. This might include a file that is not currently in your list of
  13995. agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
  13996. the current agenda files will be searched.} using @kbd{C-c a ?}.
  13997. @node History and Acknowledgments, Main Index, MobileOrg, Top
  13998. @appendix History and acknowledgments
  13999. @cindex acknowledgments
  14000. @cindex history
  14001. @cindex thanks
  14002. Org was born in 2003, out of frustration over the user interface of the Emacs
  14003. Outline mode. I was trying to organize my notes and projects, and using
  14004. Emacs seemed to be the natural way to go. However, having to remember eleven
  14005. different commands with two or three keys per command, only to hide and show
  14006. parts of the outline tree, that seemed entirely unacceptable to me. Also,
  14007. when using outlines to take notes, I constantly wanted to restructure the
  14008. tree, organizing it parallel to my thoughts and plans. @emph{Visibility
  14009. cycling} and @emph{structure editing} were originally implemented in the
  14010. package @file{outline-magic.el}, but quickly moved to the more general
  14011. @file{org.el}. As this environment became comfortable for project planning,
  14012. the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
  14013. @emph{table support}. These areas highlighted the two main goals that Org
  14014. still has today: to be a new, outline-based, plain text mode with innovative
  14015. and intuitive editing features, and to incorporate project planning
  14016. functionality directly into a notes file.
  14017. Since the first release, literally thousands of emails to me or to
  14018. @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
  14019. reports, feedback, new ideas, and sometimes patches and add-on code.
  14020. Many thanks to everyone who has helped to improve this package. I am
  14021. trying to keep here a list of the people who had significant influence
  14022. in shaping one or more aspects of Org. The list may not be
  14023. complete, if I have forgotten someone, please accept my apologies and
  14024. let me know.
  14025. Before I get to this list, a few special mentions are in order:
  14026. @table @i
  14027. @item Bastien Guerry
  14028. Bastien has written a large number of extensions to Org (most of them
  14029. integrated into the core by now), including the @LaTeX{} exporter and the plain
  14030. list parser. His support during the early days, when he basically acted as
  14031. co-maintainer, was central to the success of this project. Bastien also
  14032. invented Worg, helped establishing the Web presence of Org, and sponsors
  14033. hosting costs for the orgmode.org website.
  14034. @item Eric Schulte and Dan Davison
  14035. Eric and Dan are jointly responsible for the Org-babel system, which turns
  14036. Org into a multi-language environment for evaluating code and doing literate
  14037. programming and reproducible research.
  14038. @item John Wiegley
  14039. John has contributed a number of great ideas and patches directly to Org,
  14040. including the attachment system (@file{org-attach.el}), integration with
  14041. Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
  14042. items, habit tracking (@file{org-habits.el}), and encryption
  14043. (@file{org-crypt.el}). Also, the capture system is really an extended copy
  14044. of his great @file{remember.el}.
  14045. @item Sebastian Rose
  14046. Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
  14047. of an ignorant amateur. Sebastian has pushed this part of Org onto a much
  14048. higher level. He also wrote @file{org-info.js}, a Java script for displaying
  14049. webpages derived from Org using an Info-like or a folding interface with
  14050. single-key navigation.
  14051. @end table
  14052. @noindent OK, now to the full list of contributions! Again, please let me
  14053. know what I am missing here!
  14054. @itemize @bullet
  14055. @item
  14056. @i{Russel Adams} came up with the idea for drawers.
  14057. @item
  14058. @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
  14059. @item
  14060. @i{Christophe Bataillon} created the great unicorn logo that we use on the
  14061. Org mode website.
  14062. @item
  14063. @i{Alex Bochannek} provided a patch for rounding timestamps.
  14064. @item
  14065. @i{Jan Böcker} wrote @file{org-docview.el}.
  14066. @item
  14067. @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
  14068. @item
  14069. @i{Tom Breton} wrote @file{org-choose.el}.
  14070. @item
  14071. @i{Charles Cave}'s suggestion sparked the implementation of templates
  14072. for Remember, which are now templates for capture.
  14073. @item
  14074. @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
  14075. specified time.
  14076. @item
  14077. @i{Gregory Chernov} patched support for Lisp forms into table
  14078. calculations and improved XEmacs compatibility, in particular by porting
  14079. @file{nouline.el} to XEmacs.
  14080. @item
  14081. @i{Sacha Chua} suggested copying some linking code from Planner.
  14082. @item
  14083. @i{Baoqiu Cui} contributed the DocBook exporter.
  14084. @item
  14085. @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
  14086. came up with the idea of properties, and that there should be an API for
  14087. them.
  14088. @item
  14089. @i{Nick Dokos} tracked down several nasty bugs.
  14090. @item
  14091. @i{Kees Dullemond} used to edit projects lists directly in HTML and so
  14092. inspired some of the early development, including HTML export. He also
  14093. asked for a way to narrow wide table columns.
  14094. @item
  14095. @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
  14096. the Org-Babel documentation into the manual.
  14097. @item
  14098. @i{Christian Egli} converted the documentation into Texinfo format, inspired
  14099. the agenda, patched CSS formatting into the HTML exporter, and wrote
  14100. @file{org-taskjuggler.el}.
  14101. @item
  14102. @i{David Emery} provided a patch for custom CSS support in exported
  14103. HTML agendas.
  14104. @item
  14105. @i{Nic Ferrier} contributed mailcap and XOXO support.
  14106. @item
  14107. @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
  14108. @item
  14109. @i{John Foerch} figured out how to make incremental search show context
  14110. around a match in a hidden outline tree.
  14111. @item
  14112. @i{Raimar Finken} wrote @file{org-git-line.el}.
  14113. @item
  14114. @i{Mikael Fornius} works as a mailing list moderator.
  14115. @item
  14116. @i{Austin Frank} works as a mailing list moderator.
  14117. @item
  14118. @i{Eric Fraga} drove the development of BEAMER export with ideas and
  14119. testing.
  14120. @item
  14121. @i{Barry Gidden} did proofreading the manual in preparation for the book
  14122. publication through Network Theory Ltd.
  14123. @item
  14124. @i{Niels Giesen} had the idea to automatically archive DONE trees.
  14125. @item
  14126. @i{Nicolas Goaziou} rewrote much of the plain list code.
  14127. @item
  14128. @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
  14129. @item
  14130. @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
  14131. book.
  14132. @item
  14133. @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
  14134. task state change logging, and the clocktable. His clear explanations have
  14135. been critical when we started to adopt the Git version control system.
  14136. @item
  14137. @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
  14138. patches.
  14139. @item
  14140. @i{Phil Jackson} wrote @file{org-irc.el}.
  14141. @item
  14142. @i{Scott Jaderholm} proposed footnotes, control over whitespace between
  14143. folded entries, and column view for properties.
  14144. @item
  14145. @i{Matt Jones} wrote @i{MobileOrg Android}.
  14146. @item
  14147. @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
  14148. @item
  14149. @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
  14150. provided frequent feedback and some patches.
  14151. @item
  14152. @i{Matt Lundin} has proposed last-row references for table formulas and named
  14153. invisible anchors. He has also worked a lot on the FAQ.
  14154. @item
  14155. @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
  14156. and is a prolific contributor on the mailing list with competent replies,
  14157. small fixes and patches.
  14158. @item
  14159. @i{Jason F. McBrayer} suggested agenda export to CSV format.
  14160. @item
  14161. @i{Max Mikhanosha} came up with the idea of refiling.
  14162. @item
  14163. @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
  14164. basis.
  14165. @item
  14166. @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
  14167. happy.
  14168. @item
  14169. @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
  14170. @item
  14171. @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
  14172. and being able to quickly restrict the agenda to a subtree.
  14173. @item
  14174. @i{Todd Neal} provided patches for links to Info files and Elisp forms.
  14175. @item
  14176. @i{Greg Newman} refreshed the unicorn logo into its current form.
  14177. @item
  14178. @i{Tim O'Callaghan} suggested in-file links, search options for general
  14179. file links, and TAGS.
  14180. @item
  14181. @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
  14182. version of the reference card.
  14183. @item
  14184. @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
  14185. into Japanese.
  14186. @item
  14187. @i{Oliver Oppitz} suggested multi-state TODO items.
  14188. @item
  14189. @i{Scott Otterson} sparked the introduction of descriptive text for
  14190. links, among other things.
  14191. @item
  14192. @i{Pete Phillips} helped during the development of the TAGS feature, and
  14193. provided frequent feedback.
  14194. @item
  14195. @i{Martin Pohlack} provided the code snippet to bundle character insertion
  14196. into bundles of 20 for undo.
  14197. @item
  14198. @i{T.V. Raman} reported bugs and suggested improvements.
  14199. @item
  14200. @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
  14201. control.
  14202. @item
  14203. @i{Paul Rivier} provided the basic implementation of named footnotes. He
  14204. also acted as mailing list moderator for some time.
  14205. @item
  14206. @i{Kevin Rogers} contributed code to access VM files on remote hosts.
  14207. @item
  14208. @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
  14209. conflict with @file{allout.el}.
  14210. @item
  14211. @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
  14212. extensive patches.
  14213. @item
  14214. @i{Philip Rooke} created the Org reference card, provided lots
  14215. of feedback, developed and applied standards to the Org documentation.
  14216. @item
  14217. @i{Christian Schlauer} proposed angular brackets around links, among
  14218. other things.
  14219. @item
  14220. @i{Paul Sexton} wrote @file{org-ctags.el}.
  14221. @item
  14222. Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
  14223. @file{organizer-mode.el}.
  14224. @item
  14225. @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
  14226. examples, and remote highlighting for referenced code lines.
  14227. @item
  14228. @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
  14229. now packaged into Org's @file{contrib} directory.
  14230. @item
  14231. @i{Daniel Sinder} came up with the idea of internal archiving by locking
  14232. subtrees.
  14233. @item
  14234. @i{Dale Smith} proposed link abbreviations.
  14235. @item
  14236. @i{James TD Smith} has contributed a large number of patches for useful
  14237. tweaks and features.
  14238. @item
  14239. @i{Adam Spiers} asked for global linking commands, inspired the link
  14240. extension system, added support for mairix, and proposed the mapping API.
  14241. @item
  14242. @i{Ulf Stegemann} created the table to translate special symbols to HTML,
  14243. @LaTeX{}, UTF-8, Latin-1 and ASCII.
  14244. @item
  14245. @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
  14246. with links transformation to Org syntax.
  14247. @item
  14248. @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
  14249. chapter about publishing.
  14250. @item
  14251. @i{Jambunathan K} contributed the @acronym{ODT} exporter.
  14252. @item
  14253. @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
  14254. enabled source code highlighting in Gnus.
  14255. @item
  14256. @i{Stefan Vollmar} organized a video-recorded talk at the
  14257. Max-Planck-Institute for Neurology. He also inspired the creation of a
  14258. concept index for HTML export.
  14259. @item
  14260. @i{J@"urgen Vollmer} contributed code generating the table of contents
  14261. in HTML output.
  14262. @item
  14263. @i{Samuel Wales} has provided important feedback and bug reports.
  14264. @item
  14265. @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
  14266. keyword.
  14267. @item
  14268. @i{David Wainberg} suggested archiving, and improvements to the linking
  14269. system.
  14270. @item
  14271. @i{Carsten Wimmer} suggested some changes and helped fix a bug in
  14272. linking to Gnus.
  14273. @item
  14274. @i{Roland Winkler} requested additional key bindings to make Org
  14275. work on a tty.
  14276. @item
  14277. @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
  14278. and contributed various ideas and code snippets.
  14279. @item
  14280. @end itemize
  14281. @node Main Index, Key Index, History and Acknowledgments, Top
  14282. @unnumbered Concept index
  14283. @printindex cp
  14284. @node Key Index, Command and Function Index, Main Index, Top
  14285. @unnumbered Key index
  14286. @printindex ky
  14287. @node Command and Function Index, Variable Index, Key Index, Top
  14288. @unnumbered Command and function index
  14289. @printindex fn
  14290. @node Variable Index, , Command and Function Index, Top
  14291. @unnumbered Variable index
  14292. This is not a complete index of variables and faces, only the ones that are
  14293. mentioned in the manual. For a more complete list, use @kbd{M-x
  14294. org-customize @key{RET}} and then click yourself through the tree.
  14295. @printindex vr
  14296. @bye
  14297. @c Local variables:
  14298. @c fill-column: 77
  14299. @c indent-tabs-mode: nil
  14300. @c paragraph-start: "\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
  14301. @c paragraph-separate: "\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
  14302. @c End:
  14303. @c LocalWords: webdavhost pre