org.texi 756 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284
  1. \input texinfo @c -*- coding: utf-8 -*-
  2. @c %**start of header
  3. @setfilename ../../info/org.info
  4. @settitle The Org Manual
  5. @include docstyle.texi
  6. @include org-version.inc
  7. @c Version and Contact Info
  8. @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page}
  9. @set AUTHOR Carsten Dominik
  10. @set MAINTAINER Carsten Dominik
  11. @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
  12. @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
  13. @c %**end of header
  14. @finalout
  15. @c -----------------------------------------------------------------------------
  16. @c Macro definitions for commands and keys
  17. @c =======================================
  18. @c The behavior of the key/command macros will depend on the flag cmdnames
  19. @c When set, commands names are shown. When clear, they are not shown.
  20. @set cmdnames
  21. @c Below we define the following macros for Org key tables:
  22. @c orgkey{key} A key item
  23. @c orgcmd{key,cmd} Key with command name
  24. @c xorgcmd{key,cmd} Key with command name as @itemx
  25. @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
  26. @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
  27. @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
  28. @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
  29. @c different functions, so format as @itemx
  30. @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
  31. @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
  32. @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
  33. @c a key but no command
  34. @c Inserts: @item key
  35. @macro orgkey{key}
  36. @kindex \key\
  37. @item @kbd{\key\}
  38. @end macro
  39. @macro xorgkey{key}
  40. @kindex \key\
  41. @itemx @kbd{\key\}
  42. @end macro
  43. @c one key with a command
  44. @c Inserts: @item KEY COMMAND
  45. @macro orgcmd{key,command}
  46. @ifset cmdnames
  47. @kindex \key\
  48. @findex \command\
  49. @iftex
  50. @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
  51. @end iftex
  52. @ifnottex
  53. @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  54. @end ifnottex
  55. @end ifset
  56. @ifclear cmdnames
  57. @kindex \key\
  58. @item @kbd{\key\}
  59. @end ifclear
  60. @end macro
  61. @c One key with one command, formatted using @itemx
  62. @c Inserts: @itemx KEY COMMAND
  63. @macro xorgcmd{key,command}
  64. @ifset cmdnames
  65. @kindex \key\
  66. @findex \command\
  67. @iftex
  68. @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
  69. @end iftex
  70. @ifnottex
  71. @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  72. @end ifnottex
  73. @end ifset
  74. @ifclear cmdnames
  75. @kindex \key\
  76. @itemx @kbd{\key\}
  77. @end ifclear
  78. @end macro
  79. @c one key with a command, bit do not index the key
  80. @c Inserts: @item KEY COMMAND
  81. @macro orgcmdnki{key,command}
  82. @ifset cmdnames
  83. @findex \command\
  84. @iftex
  85. @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
  86. @end iftex
  87. @ifnottex
  88. @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  89. @end ifnottex
  90. @end ifset
  91. @ifclear cmdnames
  92. @item @kbd{\key\}
  93. @end ifclear
  94. @end macro
  95. @c one key with a command, and special text to replace key in item
  96. @c Inserts: @item TEXT COMMAND
  97. @macro orgcmdtkc{text,key,command}
  98. @ifset cmdnames
  99. @kindex \key\
  100. @findex \command\
  101. @iftex
  102. @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
  103. @end iftex
  104. @ifnottex
  105. @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  106. @end ifnottex
  107. @end ifset
  108. @ifclear cmdnames
  109. @kindex \key\
  110. @item @kbd{\text\}
  111. @end ifclear
  112. @end macro
  113. @c two keys with one command
  114. @c Inserts: @item KEY1 or KEY2 COMMAND
  115. @macro orgcmdkkc{key1,key2,command}
  116. @ifset cmdnames
  117. @kindex \key1\
  118. @kindex \key2\
  119. @findex \command\
  120. @iftex
  121. @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  122. @end iftex
  123. @ifnottex
  124. @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  125. @end ifnottex
  126. @end ifset
  127. @ifclear cmdnames
  128. @kindex \key1\
  129. @kindex \key2\
  130. @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
  131. @end ifclear
  132. @end macro
  133. @c Two keys with one command name, but different functions, so format as
  134. @c @itemx
  135. @c Inserts: @item KEY1
  136. @c @itemx KEY2 COMMAND
  137. @macro orgcmdkxkc{key1,key2,command}
  138. @ifset cmdnames
  139. @kindex \key1\
  140. @kindex \key2\
  141. @findex \command\
  142. @iftex
  143. @item @kbd{\key1\}
  144. @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  145. @end iftex
  146. @ifnottex
  147. @item @kbd{\key1\}
  148. @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  149. @end ifnottex
  150. @end ifset
  151. @ifclear cmdnames
  152. @kindex \key1\
  153. @kindex \key2\
  154. @item @kbd{\key1\}
  155. @itemx @kbd{\key2\}
  156. @end ifclear
  157. @end macro
  158. @c Same as previous, but use "or short"
  159. @c Inserts: @item KEY1 or short KEY2 COMMAND
  160. @macro orgcmdkskc{key1,key2,command}
  161. @ifset cmdnames
  162. @kindex \key1\
  163. @kindex \key2\
  164. @findex \command\
  165. @iftex
  166. @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  167. @end iftex
  168. @ifnottex
  169. @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  170. @end ifnottex
  171. @end ifset
  172. @ifclear cmdnames
  173. @kindex \key1\
  174. @kindex \key2\
  175. @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
  176. @end ifclear
  177. @end macro
  178. @c Same as previous, but use @itemx
  179. @c Inserts: @itemx KEY1 or short KEY2 COMMAND
  180. @macro xorgcmdkskc{key1,key2,command}
  181. @ifset cmdnames
  182. @kindex \key1\
  183. @kindex \key2\
  184. @findex \command\
  185. @iftex
  186. @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
  187. @end iftex
  188. @ifnottex
  189. @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
  190. @end ifnottex
  191. @end ifset
  192. @ifclear cmdnames
  193. @kindex \key1\
  194. @kindex \key2\
  195. @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
  196. @end ifclear
  197. @end macro
  198. @c two keys with two commands
  199. @c Inserts: @item KEY1 COMMAND1
  200. @c @itemx KEY2 COMMAND2
  201. @macro orgcmdkkcc{key1,key2,command1,command2}
  202. @ifset cmdnames
  203. @kindex \key1\
  204. @kindex \key2\
  205. @findex \command1\
  206. @findex \command2\
  207. @iftex
  208. @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
  209. @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
  210. @end iftex
  211. @ifnottex
  212. @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
  213. @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
  214. @end ifnottex
  215. @end ifset
  216. @ifclear cmdnames
  217. @kindex \key1\
  218. @kindex \key2\
  219. @item @kbd{\key1\}
  220. @itemx @kbd{\key2\}
  221. @end ifclear
  222. @end macro
  223. @c -----------------------------------------------------------------------------
  224. @iftex
  225. @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
  226. @end iftex
  227. @c Subheadings inside a table.
  228. @macro tsubheading{text}
  229. @ifinfo
  230. @subsubheading \text\
  231. @end ifinfo
  232. @ifnotinfo
  233. @item @b{\text\}
  234. @end ifnotinfo
  235. @end macro
  236. @copying
  237. This manual is for Org version @value{VERSION}.
  238. Copyright @copyright{} 2004--2017 Free Software Foundation, Inc.
  239. @quotation
  240. Permission is granted to copy, distribute and/or modify this document
  241. under the terms of the GNU Free Documentation License, Version 1.3 or
  242. any later version published by the Free Software Foundation; with no
  243. Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
  244. and with the Back-Cover Texts as in (a) below. A copy of the license
  245. is included in the section entitled ``GNU Free Documentation License.''
  246. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
  247. modify this GNU manual.''
  248. @end quotation
  249. @end copying
  250. @dircategory Emacs editing modes
  251. @direntry
  252. * Org Mode: (org). Outline-based notes management and organizer
  253. @end direntry
  254. @titlepage
  255. @title The Org Manual
  256. @subtitle Release @value{VERSION}
  257. @author by Carsten Dominik
  258. with contributions by Bastien Guerry, Nicolas Goaziou, Eric Schulte,
  259. Jambunathan K, Dan Davison, Thomas Dye, David O'Toole, and Philip Rooke.
  260. @c The following two commands start the copyright page.
  261. @page
  262. @vskip 0pt plus 1filll
  263. @insertcopying
  264. @end titlepage
  265. @c Output the short table of contents at the beginning.
  266. @shortcontents
  267. @c Output the table of contents at the beginning.
  268. @contents
  269. @ifnottex
  270. @node Top, Introduction, (dir), (dir)
  271. @top Org Mode Manual
  272. @insertcopying
  273. @end ifnottex
  274. @menu
  275. * Introduction:: Getting started
  276. * Document structure:: A tree works like your brain
  277. * Tables:: Pure magic for quick formatting
  278. * Hyperlinks:: Notes in context
  279. * TODO items:: Every tree branch can be a TODO item
  280. * Tags:: Tagging headlines and matching sets of tags
  281. * Properties and columns:: Storing information about an entry
  282. * Dates and times:: Making items useful for planning
  283. * Capture - Refile - Archive:: The ins and outs for projects
  284. * Agenda views:: Collecting information into views
  285. * Markup:: Prepare text for rich export
  286. * Exporting:: Sharing and publishing notes
  287. * Publishing:: Create a web site of linked Org files
  288. * Working with source code:: Export, evaluate, and tangle code blocks
  289. * Miscellaneous:: All the rest which did not fit elsewhere
  290. * Hacking:: How to hack your way around
  291. * MobileOrg:: Viewing and capture on a mobile device
  292. * History and acknowledgments:: How Org came into being
  293. * GNU Free Documentation License:: The license for this documentation.
  294. * Main Index:: An index of Org's concepts and features
  295. * Key Index:: Key bindings and where they are described
  296. * Command and Function Index:: Command names and some internal functions
  297. * Variable Index:: Variables mentioned in the manual
  298. @detailmenu
  299. --- The Detailed Node Listing ---
  300. Introduction
  301. * Summary:: Brief summary of what Org does
  302. * Installation:: Installing Org
  303. * Activation:: How to activate Org for certain buffers
  304. * Feedback:: Bug reports, ideas, patches etc.
  305. * Conventions:: Typesetting conventions in the manual
  306. Document structure
  307. * Outlines:: Org is based on Outline mode
  308. * Headlines:: How to typeset Org tree headlines
  309. * Visibility cycling:: Show and hide, much simplified
  310. * Motion:: Jumping to other headlines
  311. * Structure editing:: Changing sequence and level of headlines
  312. * Sparse trees:: Matches embedded in context
  313. * Plain lists:: Additional structure within an entry
  314. * Drawers:: Tucking stuff away
  315. * Blocks:: Folding blocks
  316. * Footnotes:: How footnotes are defined in Org's syntax
  317. * Orgstruct mode:: Structure editing outside Org
  318. * Org syntax:: Formal description of Org's syntax
  319. Visibility cycling
  320. * Global and local cycling:: Cycling through various visibility states
  321. * Initial visibility:: Setting the initial visibility state
  322. * Catching invisible edits:: Preventing mistakes when editing invisible parts
  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. * Lookup functions:: Lookup functions for searching tables
  338. * Editing and debugging formulas:: Fixing formulas
  339. * Updating the table:: Recomputing all dependent fields
  340. * Advanced features:: Field and column names, parameters and automatic recalc
  341. Hyperlinks
  342. * Link format:: How links in Org are formatted
  343. * Internal links:: Links to other places in the current file
  344. * External links:: URL-like links to the world
  345. * Handling links:: Creating, inserting and following
  346. * Using links outside Org:: Linking from my C source code?
  347. * Link abbreviations:: Shortcuts for writing complex links
  348. * Search options:: Linking to a specific location
  349. * Custom searches:: When the default search is not enough
  350. Internal links
  351. * Radio targets:: Make targets trigger links in plain text
  352. TODO items
  353. * TODO basics:: Marking and displaying TODO entries
  354. * TODO extensions:: Workflow and assignments
  355. * Progress logging:: Dates and notes for progress
  356. * Priorities:: Some things are more important than others
  357. * Breaking down tasks:: Splitting a task into manageable pieces
  358. * Checkboxes:: Tick-off lists
  359. Extended use of TODO keywords
  360. * Workflow states:: From TODO to DONE in steps
  361. * TODO types:: I do this, Fred does the rest
  362. * Multiple sets in one file:: Mixing it all, and still finding your way
  363. * Fast access to TODO states:: Single letter selection of a state
  364. * Per-file keywords:: Different files, different requirements
  365. * Faces for TODO keywords:: Highlighting states
  366. * TODO dependencies:: When one task needs to wait for others
  367. Progress logging
  368. * Closing items:: When was this entry marked DONE?
  369. * Tracking TODO state changes:: When did the status change?
  370. * Tracking your habits:: How consistent have you been?
  371. Tags
  372. * Tag inheritance:: Tags use the tree structure of the outline
  373. * Setting tags:: How to assign tags to a headline
  374. * Tag hierarchy:: Create a hierarchy of tags
  375. * Tag searches:: Searching for combinations of tags
  376. Properties and columns
  377. * Property syntax:: How properties are spelled out
  378. * Special properties:: Access to other Org mode features
  379. * Property searches:: Matching property values
  380. * Property inheritance:: Passing values down the tree
  381. * Column view:: Tabular viewing and editing
  382. * Property API:: Properties for Lisp programmers
  383. Column view
  384. * Defining columns:: The COLUMNS format property
  385. * Using column view:: How to create and use column view
  386. * Capturing column view:: A dynamic block for column view
  387. Defining columns
  388. * Scope of column definitions:: Where defined, where valid?
  389. * Column attributes:: Appearance and content of a column
  390. Dates and times
  391. * Timestamps:: Assigning a time to a tree entry
  392. * Creating timestamps:: Commands which insert timestamps
  393. * Deadlines and scheduling:: Planning your work
  394. * Clocking work time:: Tracking how long you spend on a task
  395. * Effort estimates:: Planning work effort in advance
  396. * Timers:: Notes with a running timer
  397. Creating timestamps
  398. * The date/time prompt:: How Org mode helps you entering date and time
  399. * Custom time format:: Making dates look different
  400. Deadlines and scheduling
  401. * Inserting deadline/schedule:: Planning items
  402. * Repeated tasks:: Items that show up again and again
  403. Clocking work time
  404. * Clocking commands:: Starting and stopping a clock
  405. * The clock table:: Detailed reports
  406. * Resolving idle time:: Resolving time when you've been idle
  407. Capture - Refile - Archive
  408. * Capture:: Capturing new stuff
  409. * Attachments:: Add files to tasks
  410. * RSS feeds:: Getting input from RSS feeds
  411. * Protocols:: External (e.g., Browser) access to Emacs and Org
  412. * Refile and copy:: Moving/copying a tree from one place to another
  413. * Archiving:: What to do with finished projects
  414. Capture
  415. * Setting up capture:: Where notes will be stored
  416. * Using capture:: Commands to invoke and terminate capture
  417. * Capture templates:: Define the outline of different note types
  418. Capture templates
  419. * Template elements:: What is needed for a complete template entry
  420. * Template expansion:: Filling in information about time and context
  421. * Templates in contexts:: Only show a template in a specific context
  422. Archiving
  423. * Moving subtrees:: Moving a tree to an archive file
  424. * Internal archiving:: Switch off a tree but keep it in the file
  425. Agenda views
  426. * Agenda files:: Files being searched for agenda information
  427. * Agenda dispatcher:: Keyboard access to agenda views
  428. * Built-in agenda views:: What is available out of the box?
  429. * Presentation and sorting:: How agenda items are prepared for display
  430. * Agenda commands:: Remote editing of Org trees
  431. * Custom agenda views:: Defining special searches and views
  432. * Exporting agenda views:: Writing a view to a file
  433. * Agenda column view:: Using column view for collected entries
  434. The built-in agenda views
  435. * Weekly/daily agenda:: The calendar page with current tasks
  436. * Global TODO list:: All unfinished action items
  437. * Matching tags and properties:: Structured information with fine-tuned search
  438. * Timeline:: Time-sorted view for single file
  439. * Search view:: Find entries by searching for text
  440. * Stuck projects:: Find projects you need to review
  441. Presentation and sorting
  442. * Categories:: Not all tasks are equal
  443. * Time-of-day specifications:: How the agenda knows the time
  444. * Sorting agenda items:: The order of things
  445. * Filtering/limiting agenda items:: Dynamically narrow the agenda
  446. Custom agenda views
  447. * Storing searches:: Type once, use often
  448. * Block agenda:: All the stuff you need in a single buffer
  449. * Setting options:: Changing the rules
  450. Markup for rich export
  451. * Paragraphs:: The basic unit of text
  452. * Emphasis and monospace:: Bold, italic, etc.
  453. * Horizontal rules:: Make a line
  454. * Images and tables:: Images, tables and caption mechanism
  455. * Literal examples:: Source code examples with special formatting
  456. * Special symbols:: Greek letters and other symbols
  457. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  458. * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
  459. Embedded @LaTeX{}
  460. * @LaTeX{} fragments:: Complex formulas made easy
  461. * Previewing @LaTeX{} fragments:: What will this snippet look like?
  462. * CDLaTeX mode:: Speed up entering of formulas
  463. Exporting
  464. * The export dispatcher:: The main exporter interface
  465. * Export settings:: Generic export settings
  466. * Table of contents:: The if and where of the table of contents
  467. * Include files:: Include additional files into a document
  468. * Macro replacement:: Use macros to create templates
  469. * Comment lines:: What will not be exported
  470. * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
  471. * Beamer export:: Exporting as a Beamer presentation
  472. * HTML export:: Exporting to HTML
  473. * @LaTeX{} export:: Exporting to @LaTeX{}, and processing to PDF
  474. * Markdown export:: Exporting to Markdown
  475. * OpenDocument Text export:: Exporting to OpenDocument Text
  476. * Org export:: Exporting to Org
  477. * Texinfo export:: Exporting to Texinfo
  478. * iCalendar export:: Exporting to iCalendar
  479. * Other built-in back-ends:: Exporting to a man page
  480. * Advanced configuration:: Fine-tuning the export output
  481. * Export in foreign buffers:: Author tables and lists in Org syntax
  482. Beamer export
  483. * Beamer export commands:: How to export Beamer documents.
  484. * Beamer specific export settings:: Export settings for Beamer export.
  485. * Sectioning Frames and Blocks in Beamer:: Blocks and sections in Beamer.
  486. * Beamer specific syntax:: Syntax specific to Beamer.
  487. * Editing support:: Helper functions for Org Beamer export.
  488. * A Beamer Example:: An complete Beamer example.
  489. HTML export
  490. * HTML Export commands:: How to invoke HTML export
  491. * HTML Specific export settings:: Export settings for HTML export
  492. * HTML doctypes:: Org can export to various (X)HTML flavors
  493. * HTML preamble and postamble:: How to insert a preamble and a postamble
  494. * Quoting HTML tags:: Using direct HTML in Org mode
  495. * Links in HTML export:: How links will be interpreted and formatted
  496. * Tables in HTML export:: How to modify the formatting of tables
  497. * Images in HTML export:: How to insert figures into HTML output
  498. * Math formatting in HTML export:: Beautiful math also on the web
  499. * Text areas in HTML export:: An alternative way to show an example
  500. * CSS support:: Changing the appearance of the output
  501. * JavaScript support:: Info and Folding in a web browser
  502. @LaTeX{} export
  503. * @LaTeX{} export commands:: How to export to @LaTeX{} and PDF
  504. * @LaTeX{} specific export settings:: Export settings for @LaTeX{}
  505. * @LaTeX{} header and sectioning:: Setting up the export file structure
  506. * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
  507. * Tables in @LaTeX{} export:: Specific attributes for tables
  508. * Images in @LaTeX{} export:: Specific attributes for images
  509. * Plain lists in @LaTeX{} export:: Specific attributes for plain lists
  510. * Source blocks in @LaTeX{} export:: Specific attributes for source blocks
  511. * Example blocks in @LaTeX{} export:: Specific attributes for example blocks
  512. * Special blocks in @LaTeX{} export:: Specific attributes for special blocks
  513. * Horizontal rules in @LaTeX{} export:: Specific attributes for horizontal rules
  514. OpenDocument Text export
  515. * Pre-requisites for ODT export:: What packages ODT exporter relies on
  516. * ODT export commands:: How to invoke ODT export
  517. * ODT specific export settings:: Export settings for ODT
  518. * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
  519. * Applying custom styles:: How to apply custom styles to the output
  520. * Links in ODT export:: How links will be interpreted and formatted
  521. * Tables in ODT export:: How Tables are exported
  522. * Images in ODT export:: How to insert images
  523. * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
  524. * Labels and captions in ODT export:: How captions are rendered
  525. * Literal examples in ODT export:: How source and example blocks are formatted
  526. * Advanced topics in ODT export:: Read this if you are a power user
  527. Math formatting in ODT export
  528. * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
  529. * Working with MathML or OpenDocument formula files:: How to embed equations in native format
  530. Advanced topics in ODT export
  531. * Configuring a document converter:: How to register a document converter
  532. * Working with OpenDocument style files:: Explore the internals
  533. * Creating one-off styles:: How to produce custom highlighting etc
  534. * Customizing tables in ODT export:: How to define and use Table templates
  535. * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
  536. Texinfo export
  537. * Texinfo export commands:: How to invoke Texinfo export
  538. * Texinfo specific export settings:: Export settings for Texinfo
  539. * Texinfo file header:: Generating the begining of a Texinfo file
  540. * Texinfo title and copyright page:: Creating title and copyright pages
  541. * Texinfo @samp{Top} node:: Installing a manual in Info Top node
  542. * Headings and sectioning structure:: Building document structure
  543. * Indices:: Creating indices
  544. * Quoting Texinfo code:: Incorporating literal Texinfo code
  545. * Plain lists in Texinfo export:: Specific attributes for plain lists
  546. * Tables in Texinfo export:: Specific attributes for tables
  547. * Images in Texinfo export:: Specific attributes for images
  548. * Special blocks in Texinfo export:: Specific attributes for special blocks
  549. * A Texinfo example:: Illustrating Org to Texinfo process
  550. Publishing
  551. * Configuration:: Defining projects
  552. * Uploading files:: How to get files up on the server
  553. * Sample configuration:: Example projects
  554. * Triggering publication:: Publication commands
  555. Configuration
  556. * Project alist:: The central configuration variable
  557. * Sources and destinations:: From here to there
  558. * Selecting files:: What files are part of the project?
  559. * Publishing action:: Setting the function doing the publishing
  560. * Publishing options:: Tweaking HTML/@LaTeX{} export
  561. * Publishing links:: Which links keep working after publishing?
  562. * Sitemap:: Generating a list of all pages
  563. * Generating an index:: An index that reaches across pages
  564. Sample configuration
  565. * Simple example:: One-component publishing
  566. * Complex example:: A multi-component publishing example
  567. Working with source code
  568. * Structure of code blocks:: Code block syntax described
  569. * Editing source code:: Language major-mode editing
  570. * Exporting code blocks:: Export contents and/or results
  571. * Extracting source code:: Create pure source code files
  572. * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
  573. * Library of Babel:: Use and contribute to a library of useful code blocks
  574. * Languages:: List of supported code block languages
  575. * Header arguments:: Configure code block functionality
  576. * Results of evaluation:: How evaluation results are handled
  577. * Noweb reference syntax:: Literate programming in Org mode
  578. * Key bindings and useful functions:: Work quickly with code blocks
  579. * Batch execution:: Call functions from the command line
  580. Header arguments
  581. * Using header arguments:: Different ways to set header arguments
  582. * Specific header arguments:: List of header arguments
  583. Using header arguments
  584. * System-wide header arguments:: Set globally, language-specific
  585. * Language-specific header arguments:: Set in the Org file's headers
  586. * Header arguments in Org mode properties:: Set in the Org file
  587. * Language-specific mode properties::
  588. * Code block specific header arguments:: The most commonly used method
  589. * Arguments in function calls:: The most specific level, takes highest priority
  590. Specific header arguments
  591. * var:: Pass arguments to @samp{src} code blocks
  592. * results:: Specify results type; how to collect
  593. * file:: Specify a path for output file
  594. * file-desc:: Specify a description for file results
  595. * file-ext:: Specify an extension for file output
  596. * output-dir:: Specify a directory for output file
  597. * dir:: Specify the default directory for code block execution
  598. * exports:: Specify exporting code, results, both, none
  599. * tangle:: Toggle tangling; or specify file name
  600. * mkdirp:: Toggle for parent directory creation for target files during tangling
  601. * comments:: Toggle insertion of comments in tangled code files
  602. * padline:: Control insertion of padding lines in tangled code files
  603. * no-expand:: Turn off variable assignment and noweb expansion during tangling
  604. * session:: Preserve the state of code evaluation
  605. * noweb:: Toggle expansion of noweb references
  606. * noweb-ref:: Specify block's noweb reference resolution target
  607. * noweb-sep:: String to separate noweb references
  608. * cache:: Avoid re-evaluating unchanged code blocks
  609. * sep:: Delimiter for writing tabular results outside Org
  610. * hlines:: Handle horizontal lines in tables
  611. * colnames:: Handle column names in tables
  612. * rownames:: Handle row names in tables
  613. * shebang:: Make tangled files executable
  614. * tangle-mode:: Set permission of tangled files
  615. * eval:: Limit evaluation of specific code blocks
  616. * wrap:: Mark source block evaluation results
  617. * post:: Post processing of results of code block evaluation
  618. * prologue:: Text to prepend to body of code block
  619. * epilogue:: Text to append to body of code block
  620. Miscellaneous
  621. * Completion:: M-TAB guesses completions
  622. * Easy templates:: Quick insertion of structural elements
  623. * Speed keys:: Electric commands at the beginning of a headline
  624. * Code evaluation security:: Org mode files evaluate inline code
  625. * Customization:: Adapting Org to changing tastes
  626. * In-buffer settings:: Overview of the #+KEYWORDS
  627. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  628. * Clean view:: Getting rid of leading stars in the outline
  629. * TTY keys:: Using Org on a tty
  630. * Interaction:: With other Emacs packages
  631. * org-crypt:: Encrypting Org files
  632. Interaction with other packages
  633. * Cooperation:: Packages Org cooperates with
  634. * Conflicts:: Packages that lead to conflicts
  635. Hacking
  636. * Hooks:: How to reach into Org's internals
  637. * Add-on packages:: Available extensions
  638. * Adding hyperlink types:: New custom link types
  639. * Adding export back-ends:: How to write new export back-ends
  640. * Context-sensitive commands:: How to add functionality to such commands
  641. * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
  642. * Dynamic blocks:: Automatically filled blocks
  643. * Special agenda views:: Customized views
  644. * Speeding up your agendas:: Tips on how to speed up your agendas
  645. * Extracting agenda information:: Post-processing of agenda information
  646. * Using the property API:: Writing programs that use entry properties
  647. * Using the mapping API:: Mapping over all or selected entries
  648. Tables and lists in arbitrary syntax
  649. * Radio tables:: Sending and receiving radio tables
  650. * A @LaTeX{} example:: Step by step, almost a tutorial
  651. * Translator functions:: Copy and modify
  652. * Radio lists:: Sending and receiving lists
  653. MobileOrg
  654. * Setting up the staging area:: For the mobile device
  655. * Pushing to MobileOrg:: Uploading Org files and agendas
  656. * Pulling from MobileOrg:: Integrating captured and flagged items
  657. @end detailmenu
  658. @end menu
  659. @node Introduction
  660. @chapter Introduction
  661. @cindex introduction
  662. @menu
  663. * Summary:: Brief summary of what Org does
  664. * Installation:: Installing Org
  665. * Activation:: How to activate Org for certain buffers
  666. * Feedback:: Bug reports, ideas, patches etc.
  667. * Conventions:: Typesetting conventions in the manual
  668. @end menu
  669. @node Summary
  670. @section Summary
  671. @cindex summary
  672. Org is a mode for keeping notes, maintaining TODO lists, and project planning
  673. with a fast and effective plain-text system. It also is an authoring system
  674. with unique support for literate programming and reproducible research.
  675. Org is implemented on top of Outline mode, which makes it possible to keep
  676. the content of large files well structured. Visibility cycling and structure
  677. editing help to work with the tree. Tables are easily created with a
  678. built-in table editor. Plain text URL-like links connect to websites,
  679. emails, Usenet messages, BBDB entries, and any files related to the projects.
  680. Org develops organizational tasks around notes files that contain lists or
  681. information about projects as plain text. Project planning and task
  682. management makes use of metadata which is part of an outline node. Based on
  683. this data, specific entries can be extracted in queries and create dynamic
  684. @i{agenda views} that also integrate the Emacs calendar and diary. Org can
  685. be used to implement many different project planning schemes, such as David
  686. Allen's GTD system.
  687. Org files can serve as a single source authoring system with export to many
  688. different formats such as HTML, @LaTeX{}, Open Document, and Markdown. New
  689. export backends can be derived from existing ones, or defined from scratch.
  690. Org files can include source code blocks, which makes Org uniquely suited for
  691. authoring technical documents with code examples. Org source code blocks are
  692. fully functional; they can be evaluated in place and their results can be
  693. captured in the file. This makes it possible to create a single file
  694. reproducible research compendium.
  695. Org keeps simple things simple. When first fired up, it should feel like a
  696. straightforward, easy to use outliner. Complexity is not imposed, but a
  697. large amount of functionality is available when needed. Org is a toolbox.
  698. Many users actually run only a (very personal) fraction of Org's capabilities, and
  699. know that there is more whenever they need it.
  700. All of this is achieved with strictly plain text files, the most portable and
  701. future-proof file format. Org runs in Emacs. Emacs is one of the most
  702. widely ported programs, so that Org mode is available on every major
  703. platform.
  704. @cindex FAQ
  705. There is a website for Org which provides links to the newest
  706. version of Org, as well as additional information, frequently asked
  707. questions (FAQ), links to tutorials, etc. This page is located at
  708. @uref{http://orgmode.org}.
  709. @cindex print edition
  710. An earlier version (7.3) of this manual is available as a
  711. @uref{http://www.network-theory.co.uk/org/manual/, paperback book from
  712. Network Theory Ltd.}
  713. @page
  714. @node Installation
  715. @section Installation
  716. @cindex installation
  717. Org is part of recent distributions of GNU Emacs, so you normally don't need
  718. to install it. If, for one reason or another, you want to install Org on top
  719. of this pre-packaged version, there are three ways to do it:
  720. @itemize @bullet
  721. @item By using Emacs package system.
  722. @item By downloading Org as an archive.
  723. @item By using Org's git repository.
  724. @end itemize
  725. We @b{strongly recommend} to stick to a single installation method.
  726. @subsubheading Using Emacs packaging system
  727. Recent Emacs distributions include a packaging system which lets you install
  728. Elisp libraries. You can install Org with @kbd{M-x package-install RET org}.
  729. @noindent @b{Important}: you need to do this in a session where no @code{.org} file has
  730. been visited, i.e., where no Org built-in function have been loaded.
  731. Otherwise autoload Org functions will mess up the installation.
  732. Then, to make sure your Org configuration is taken into account, initialize
  733. the package system with @code{(package-initialize)} in your Emacs init file
  734. before setting any Org option. If you want to use Org's package repository,
  735. check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
  736. @subsubheading Downloading Org as an archive
  737. You can download Org latest release from @uref{http://orgmode.org/, Org's
  738. website}. In this case, make sure you set the load-path correctly in your
  739. Emacs init file:
  740. @lisp
  741. (add-to-list 'load-path "~/path/to/orgdir/lisp")
  742. @end lisp
  743. The downloaded archive contains contributed libraries that are not included
  744. in Emacs. If you want to use them, add the @file{contrib} directory to your
  745. load-path:
  746. @lisp
  747. (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
  748. @end lisp
  749. Optionally, you can compile the files and/or install them in your system.
  750. Run @code{make help} to list compilation and installation options.
  751. @subsubheading Using Org's git repository
  752. You can clone Org's repository and install Org like this:
  753. @example
  754. $ cd ~/src/
  755. $ git clone git://orgmode.org/org-mode.git
  756. $ make autoloads
  757. @end example
  758. Note that in this case, @code{make autoloads} is mandatory: it defines Org's
  759. version in @file{org-version.el} and Org's autoloads in
  760. @file{org-loaddefs.el}.
  761. Remember to add the correct load-path as described in the method above.
  762. You can also compile with @code{make}, generate the documentation with
  763. @code{make doc}, create a local configuration with @code{make config} and
  764. install Org with @code{make install}. Please run @code{make help} to get
  765. the list of compilation/installation options.
  766. For more detailed explanations on Org's build system, please check the Org
  767. Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
  768. Worg}.
  769. @node Activation
  770. @section Activation
  771. @cindex activation
  772. @cindex autoload
  773. @cindex ELPA
  774. @cindex global key bindings
  775. @cindex key bindings, global
  776. @findex org-agenda
  777. @findex org-capture
  778. @findex org-store-link
  779. @findex org-iswitchb
  780. Org mode buffers need font-lock to be turned on: this is the default in
  781. Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
  782. with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
  783. There are compatibility issues between Org mode and some other Elisp
  784. packages, please take the time to check the list (@pxref{Conflicts}).
  785. The four Org commands @command{org-store-link}, @command{org-capture},
  786. @command{org-agenda}, and @command{org-iswitchb} should be accessible through
  787. global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
  788. suggested bindings for these keys, please modify the keys to your own
  789. liking.
  790. @lisp
  791. (global-set-key "\C-cl" 'org-store-link)
  792. (global-set-key "\C-ca" 'org-agenda)
  793. (global-set-key "\C-cc" 'org-capture)
  794. (global-set-key "\C-cb" 'org-iswitchb)
  795. @end lisp
  796. @cindex Org mode, turning on
  797. Files with the @file{.org} extension use Org mode by default. To turn on Org
  798. mode in a file that does not have the extension @file{.org}, make the first
  799. line of a file look like this:
  800. @example
  801. MY PROJECTS -*- mode: org; -*-
  802. @end example
  803. @vindex org-insert-mode-line-in-empty-file
  804. @noindent which will select Org mode for this buffer no matter what
  805. the file's name is. See also the variable
  806. @code{org-insert-mode-line-in-empty-file}.
  807. Many commands in Org work on the region if the region is @i{active}. To make
  808. use of this, you need to have @code{transient-mark-mode} turned on, which is
  809. the default. If you do not like @code{transient-mark-mode}, you can create
  810. an active region by using the mouse to select a region, or pressing
  811. @kbd{C-@key{SPC}} twice before moving the cursor.
  812. @node Feedback
  813. @section Feedback
  814. @cindex feedback
  815. @cindex bug reports
  816. @cindex maintainer
  817. @cindex author
  818. If you find problems with Org, or if you have questions, remarks, or ideas
  819. about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
  820. You can subscribe to the list
  821. @uref{https://lists.gnu.org/mailman/listinfo/emacs-orgmode, on this web page}.
  822. If you are not a member of the mailing list, your mail will be passed to the
  823. list after a moderator has approved it@footnote{Please consider subscribing
  824. to the mailing list, in order to minimize the work the mailing list
  825. moderators have to do.}.
  826. For bug reports, please first try to reproduce the bug with the latest
  827. version of Org available---if you are running an outdated version, it is
  828. quite possible that the bug has been fixed already. If the bug persists,
  829. prepare a report and provide as much information as possible, including the
  830. version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
  831. (@kbd{M-x org-version RET}), as well as the Org related setup in the Emacs
  832. init file. The easiest way to do this is to use the command
  833. @example
  834. @kbd{M-x org-submit-bug-report RET}
  835. @end example
  836. @noindent which will put all this information into an Emacs mail buffer so
  837. that you only need to add your description. If you are not sending the Email
  838. from within Emacs, please copy and paste the content into your Email program.
  839. Sometimes you might face a problem due to an error in your Emacs or Org mode
  840. setup. Before reporting a bug, it is very helpful to start Emacs with minimal
  841. customizations and reproduce the problem. Doing so often helps you determine
  842. if the problem is with your customization or with Org mode itself. You can
  843. start a typical minimal session with a command like the example below.
  844. @example
  845. $ emacs -Q -l /path/to/minimal-org.el
  846. @end example
  847. However if you are using Org mode as distributed with Emacs, a minimal setup
  848. is not necessary. In that case it is sufficient to start Emacs as
  849. @code{emacs -Q}. The @code{minimal-org.el} setup file can have contents as
  850. shown below.
  851. @lisp
  852. ;;; Minimal setup to load latest 'org-mode'
  853. ;; activate debugging
  854. (setq debug-on-error t
  855. debug-on-signal nil
  856. debug-on-quit nil)
  857. ;; add latest org-mode to load path
  858. (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
  859. (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
  860. @end lisp
  861. If an error occurs, a backtrace can be very useful (see below on how to
  862. create one). Often a small example file helps, along with clear information
  863. about:
  864. @enumerate
  865. @item What exactly did you do?
  866. @item What did you expect to happen?
  867. @item What happened instead?
  868. @end enumerate
  869. @noindent Thank you for helping to improve this program.
  870. @subsubheading How to create a useful backtrace
  871. @cindex backtrace of an error
  872. If working with Org produces an error with a message you don't
  873. understand, you may have hit a bug. The best way to report this is by
  874. providing, in addition to what was mentioned above, a @emph{backtrace}.
  875. This is information from the built-in debugger about where and how the
  876. error occurred. Here is how to produce a useful backtrace:
  877. @enumerate
  878. @item
  879. Reload uncompiled versions of all Org mode Lisp files. The backtrace
  880. contains much more information if it is produced with uncompiled code.
  881. To do this, use
  882. @example
  883. @kbd{C-u M-x org-reload RET}
  884. @end example
  885. @noindent
  886. or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
  887. menu.
  888. @item
  889. Go to the @code{Options} menu and select @code{Enter Debugger on Error}.
  890. @item
  891. Do whatever you have to do to hit the error. Don't forget to
  892. document the steps you take.
  893. @item
  894. When you hit the error, a @file{*Backtrace*} buffer will appear on the
  895. screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
  896. attach it to your bug report.
  897. @end enumerate
  898. @node Conventions
  899. @section Typesetting conventions used in this manual
  900. @subsubheading TODO keywords, tags, properties, etc.
  901. Org mainly uses three types of keywords: TODO keywords, tags and property
  902. names. In this manual we use the following conventions:
  903. @table @code
  904. @item TODO
  905. @itemx WAITING
  906. TODO keywords are written with all capitals, even if they are
  907. user-defined.
  908. @item boss
  909. @itemx ARCHIVE
  910. User-defined tags are written in lowercase; built-in tags with special
  911. meaning are written with all capitals.
  912. @item Release
  913. @itemx PRIORITY
  914. User-defined properties are capitalized; built-in properties with
  915. special meaning are written with all capitals.
  916. @end table
  917. Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
  918. and @i{environment keywords} (like @code{#+BEGIN_EXPORT html} to start
  919. a @code{HTML} environment). They are written in uppercase in the manual to
  920. enhance its readability, but you can use lowercase in your Org file.
  921. @subsubheading Key bindings and commands
  922. @kindex C-c a
  923. @findex org-agenda
  924. @kindex C-c c
  925. @findex org-capture
  926. The manual suggests a few global key bindings, in particular @kbd{C-c a} for
  927. @code{org-agenda} and @kbd{C-c c} for @code{org-capture}. These are only
  928. suggestions, but the rest of the manual assumes that these key bindings are in
  929. place in order to list commands by key access.
  930. Also, the manual lists both the keys and the corresponding commands for
  931. accessing a functionality. Org mode often uses the same key for different
  932. functions, depending on context. The command that is bound to such keys has
  933. a generic name, like @code{org-metaright}. In the manual we will, wherever
  934. possible, give the function that is internally called by the generic command.
  935. For example, in the chapter on document structure, @kbd{M-@key{right}} will
  936. be listed to call @code{org-do-demote}, while in the chapter on tables, it
  937. will be listed to call @code{org-table-move-column-right}. If you prefer,
  938. you can compile the manual without the command names by unsetting the flag
  939. @code{cmdnames} in @file{org.texi}.
  940. @node Document structure
  941. @chapter Document structure
  942. @cindex document structure
  943. @cindex structure of document
  944. Org is based on Outline mode and provides flexible commands to
  945. edit the structure of the document.
  946. @menu
  947. * Outlines:: Org is based on Outline mode
  948. * Headlines:: How to typeset Org tree headlines
  949. * Visibility cycling:: Show and hide, much simplified
  950. * Motion:: Jumping to other headlines
  951. * Structure editing:: Changing sequence and level of headlines
  952. * Sparse trees:: Matches embedded in context
  953. * Plain lists:: Additional structure within an entry
  954. * Drawers:: Tucking stuff away
  955. * Blocks:: Folding blocks
  956. * Footnotes:: How footnotes are defined in Org's syntax
  957. * Orgstruct mode:: Structure editing outside Org
  958. * Org syntax:: Formal description of Org's syntax
  959. @end menu
  960. @node Outlines
  961. @section Outlines
  962. @cindex outlines
  963. @cindex Outline mode
  964. Org is implemented on top of Outline mode. Outlines allow a
  965. document to be organized in a hierarchical structure, which (at least
  966. for me) is the best representation of notes and thoughts. An overview
  967. of this structure is achieved by folding (hiding) large parts of the
  968. document to show only the general document structure and the parts
  969. currently being worked on. Org greatly simplifies the use of
  970. outlines by compressing the entire show/hide functionality into a single
  971. command, @command{org-cycle}, which is bound to the @key{TAB} key.
  972. @node Headlines
  973. @section Headlines
  974. @cindex headlines
  975. @cindex outline tree
  976. @vindex org-special-ctrl-a/e
  977. @vindex org-special-ctrl-k
  978. @vindex org-ctrl-k-protect-subtree
  979. Headlines define the structure of an outline tree. The headlines in Org
  980. start with one or more stars, on the left margin@footnote{See the variables
  981. @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
  982. @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
  983. @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
  984. headings indented less than 30 stars.}. For example:
  985. @example
  986. * Top level headline
  987. ** Second level
  988. *** 3rd level
  989. some text
  990. *** 3rd level
  991. more text
  992. * Another top level headline
  993. @end example
  994. @vindex org-footnote-section
  995. @noindent Note that a headline named after @code{org-footnote-section},
  996. which defaults to @samp{Footnotes}, is considered as special. A subtree with
  997. this headline will be silently ignored by exporting functions.
  998. Some people find the many stars too noisy and would prefer an
  999. outline that has whitespace followed by a single star as headline
  1000. starters. @ref{Clean view}, describes a setup to realize this.
  1001. @vindex org-cycle-separator-lines
  1002. An empty line after the end of a subtree is considered part of it and
  1003. will be hidden when the subtree is folded. However, if you leave at
  1004. least two empty lines, one empty line will remain visible after folding
  1005. the subtree, in order to structure the collapsed view. See the
  1006. variable @code{org-cycle-separator-lines} to modify this behavior.
  1007. @node Visibility cycling
  1008. @section Visibility cycling
  1009. @cindex cycling, visibility
  1010. @cindex visibility cycling
  1011. @cindex trees, visibility
  1012. @cindex show hidden text
  1013. @cindex hide text
  1014. @menu
  1015. * Global and local cycling:: Cycling through various visibility states
  1016. * Initial visibility:: Setting the initial visibility state
  1017. * Catching invisible edits:: Preventing mistakes when editing invisible parts
  1018. @end menu
  1019. @node Global and local cycling
  1020. @subsection Global and local cycling
  1021. Outlines make it possible to hide parts of the text in the buffer.
  1022. Org uses just two commands, bound to @key{TAB} and
  1023. @kbd{S-@key{TAB}} to change the visibility in the buffer.
  1024. @cindex subtree visibility states
  1025. @cindex subtree cycling
  1026. @cindex folded, subtree visibility state
  1027. @cindex children, subtree visibility state
  1028. @cindex subtree, subtree visibility state
  1029. @table @asis
  1030. @orgcmd{@key{TAB},org-cycle}
  1031. @emph{Subtree cycling}: Rotate current subtree among the states
  1032. @example
  1033. ,-> FOLDED -> CHILDREN -> SUBTREE --.
  1034. '-----------------------------------'
  1035. @end example
  1036. @vindex org-cycle-emulate-tab
  1037. @vindex org-cycle-global-at-bob
  1038. The cursor must be on a headline for this to work@footnote{see, however,
  1039. the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
  1040. beginning of the buffer and the first line is not a headline, then
  1041. @key{TAB} actually runs global cycling (see below)@footnote{see the
  1042. option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
  1043. argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
  1044. @cindex global visibility states
  1045. @cindex global cycling
  1046. @cindex overview, global visibility state
  1047. @cindex contents, global visibility state
  1048. @cindex show all, global visibility state
  1049. @orgcmd{S-@key{TAB},org-global-cycle}
  1050. @itemx C-u @key{TAB}
  1051. @emph{Global cycling}: Rotate the entire buffer among the states
  1052. @example
  1053. ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
  1054. '--------------------------------------'
  1055. @end example
  1056. When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
  1057. CONTENTS view up to headlines of level N will be shown. Note that inside
  1058. tables, @kbd{S-@key{TAB}} jumps to the previous field.
  1059. @cindex set startup visibility, command
  1060. @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
  1061. Switch back to the startup visibility of the buffer (@pxref{Initial visibility}).
  1062. @cindex show all, command
  1063. @orgcmd{C-u C-u C-u @key{TAB},outline-show-all}
  1064. Show all, including drawers.
  1065. @cindex revealing context
  1066. @orgcmd{C-c C-r,org-reveal}
  1067. Reveal context around point, showing the current entry, the following heading
  1068. and the hierarchy above. Useful for working near a location that has been
  1069. exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
  1070. (@pxref{Agenda commands}). With a prefix argument show, on each
  1071. level, all sibling headings. With a double prefix argument, also show the
  1072. entire subtree of the parent.
  1073. @cindex show branches, command
  1074. @orgcmd{C-c C-k,outline-show-branches}
  1075. Expose all the headings of the subtree, CONTENT view for just one subtree.
  1076. @cindex show children, command
  1077. @orgcmd{C-c @key{TAB},outline-show-children}
  1078. Expose all direct children of the subtree. With a numeric prefix argument N,
  1079. expose all children down to level N@.
  1080. @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
  1081. Show the current subtree in an indirect buffer@footnote{The indirect buffer
  1082. (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual}) will contain the entire
  1083. buffer, but will be narrowed to the current tree. Editing the indirect
  1084. buffer will also change the original buffer, but without affecting visibility
  1085. in that buffer.}. With a numeric prefix argument N, go up to level N and
  1086. then take that tree. If N is negative then go up that many levels. With a
  1087. @kbd{C-u} prefix, do not remove the previously used indirect buffer.
  1088. @orgcmd{C-c C-x v,org-copy-visible}
  1089. Copy the @i{visible} text in the region into the kill ring.
  1090. @end table
  1091. @node Initial visibility
  1092. @subsection Initial visibility
  1093. @cindex visibility, initialize
  1094. @vindex org-startup-folded
  1095. @vindex org-agenda-inhibit-startup
  1096. @cindex @code{overview}, STARTUP keyword
  1097. @cindex @code{content}, STARTUP keyword
  1098. @cindex @code{showall}, STARTUP keyword
  1099. @cindex @code{showeverything}, STARTUP keyword
  1100. When Emacs first visits an Org file, the global state is set to OVERVIEW,
  1101. i.e., only the top level headlines are visible@footnote{When
  1102. @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default
  1103. visibility state when first opening a file for the agenda (@pxref{Speeding up
  1104. your agendas}).}. This can be configured through the variable
  1105. @code{org-startup-folded}, or on a per-file basis by adding one of the
  1106. following lines anywhere in the buffer:
  1107. @example
  1108. #+STARTUP: overview
  1109. #+STARTUP: content
  1110. #+STARTUP: showall
  1111. #+STARTUP: showeverything
  1112. @end example
  1113. @cindex property, VISIBILITY
  1114. @noindent
  1115. Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
  1116. and columns}) will get their visibility adapted accordingly. Allowed values
  1117. for this property are @code{folded}, @code{children}, @code{content}, and
  1118. @code{all}.
  1119. @table @asis
  1120. @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
  1121. Switch back to the startup visibility of the buffer, i.e., whatever is
  1122. requested by startup options and @samp{VISIBILITY} properties in individual
  1123. entries.
  1124. @end table
  1125. @node Catching invisible edits
  1126. @subsection Catching invisible edits
  1127. @vindex org-catch-invisible-edits
  1128. @cindex edits, catching invisible
  1129. Sometimes you may inadvertently edit an invisible part of the buffer and be
  1130. confused on what has been edited and how to undo the mistake. Setting
  1131. @code{org-catch-invisible-edits} to non-@code{nil} will help prevent this. See the
  1132. docstring of this option on how Org should catch invisible edits and process
  1133. them.
  1134. @node Motion
  1135. @section Motion
  1136. @cindex motion, between headlines
  1137. @cindex jumping, to headlines
  1138. @cindex headline navigation
  1139. The following commands jump to other headlines in the buffer.
  1140. @table @asis
  1141. @orgcmd{C-c C-n,org-next-visible-heading}
  1142. Next heading.
  1143. @orgcmd{C-c C-p,org-previous-visible-heading}
  1144. Previous heading.
  1145. @orgcmd{C-c C-f,org-forward-same-level}
  1146. Next heading same level.
  1147. @orgcmd{C-c C-b,org-backward-same-level}
  1148. Previous heading same level.
  1149. @orgcmd{C-c C-u,outline-up-heading}
  1150. Backward to higher level heading.
  1151. @orgcmd{C-c C-j,org-goto}
  1152. Jump to a different place without changing the current outline
  1153. visibility. Shows the document structure in a temporary buffer, where
  1154. you can use the following keys to find your destination:
  1155. @vindex org-goto-auto-isearch
  1156. @example
  1157. @key{TAB} @r{Cycle visibility.}
  1158. @key{down} / @key{up} @r{Next/previous visible headline.}
  1159. @key{RET} @r{Select this location.}
  1160. @kbd{/} @r{Do a Sparse-tree search}
  1161. @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
  1162. n / p @r{Next/previous visible headline.}
  1163. f / b @r{Next/previous headline same level.}
  1164. u @r{One level up.}
  1165. 0-9 @r{Digit argument.}
  1166. q @r{Quit}
  1167. @end example
  1168. @vindex org-goto-interface
  1169. @noindent
  1170. See also the option @code{org-goto-interface}.
  1171. @end table
  1172. @node Structure editing
  1173. @section Structure editing
  1174. @cindex structure editing
  1175. @cindex headline, promotion and demotion
  1176. @cindex promotion, of subtrees
  1177. @cindex demotion, of subtrees
  1178. @cindex subtree, cut and paste
  1179. @cindex pasting, of subtrees
  1180. @cindex cutting, of subtrees
  1181. @cindex copying, of subtrees
  1182. @cindex sorting, of subtrees
  1183. @cindex subtrees, cut and paste
  1184. @table @asis
  1185. @orgcmd{M-@key{RET},org-insert-heading}
  1186. @vindex org-M-RET-may-split-line
  1187. Insert a new heading/item with the same level as the one at point.
  1188. If the command is used at the @emph{beginning} of a line, and if there is
  1189. a heading or a plain list item (@pxref{Plain lists}) at point, the new
  1190. heading/item is created @emph{before} the current line. When used at the
  1191. beginning of a regular line of text, turn that line into a heading.
  1192. When this command is used in the middle of a line, the line is split and the
  1193. rest of the line becomes the new item or headline. If you do not want the
  1194. line to be split, customize @code{org-M-RET-may-split-line}.
  1195. Calling the command with a @kbd{C-u} prefix unconditionally inserts a new
  1196. heading at the end of the current subtree, thus preserving its contents.
  1197. With a double @kbd{C-u C-u} prefix, the new heading is created at the end of
  1198. the parent subtree instead.
  1199. @orgcmd{C-@key{RET},org-insert-heading-respect-content}
  1200. Insert a new heading at the end of the current subtree.
  1201. @orgcmd{M-S-@key{RET},org-insert-todo-heading}
  1202. @vindex org-treat-insert-todo-heading-as-state-change
  1203. Insert new TODO entry with same level as current heading. See also the
  1204. variable @code{org-treat-insert-todo-heading-as-state-change}.
  1205. @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
  1206. Insert new TODO entry with same level as current heading. Like
  1207. @kbd{C-@key{RET}}, the new headline will be inserted after the current
  1208. subtree.
  1209. @orgcmd{@key{TAB},org-cycle}
  1210. In a new entry with no text yet, the first @key{TAB} demotes the entry to
  1211. become a child of the previous one. The next @key{TAB} makes it a parent,
  1212. and so on, all the way to top level. Yet another @key{TAB}, and you are back
  1213. to the initial level.
  1214. @orgcmd{M-@key{left},org-do-promote}
  1215. Promote current heading by one level.
  1216. @orgcmd{M-@key{right},org-do-demote}
  1217. Demote current heading by one level.
  1218. @orgcmd{M-S-@key{left},org-promote-subtree}
  1219. Promote the current subtree by one level.
  1220. @orgcmd{M-S-@key{right},org-demote-subtree}
  1221. Demote the current subtree by one level.
  1222. @orgcmd{M-S-@key{up},org-move-subtree-up}
  1223. Move subtree up (swap with previous subtree of same
  1224. level).
  1225. @orgcmd{M-S-@key{down},org-move-subtree-down}
  1226. Move subtree down (swap with next subtree of same level).
  1227. @orgcmd{M-h,org-mark-element}
  1228. Mark the element at point. Hitting repeatedly will mark subsequent elements
  1229. of the one just marked. E.g., hitting @key{M-h} on a paragraph will mark it,
  1230. hitting @key{M-h} immediately again will mark the next one.
  1231. @orgcmd{C-c @@,org-mark-subtree}
  1232. Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees
  1233. of the same level than the marked subtree.
  1234. @orgcmd{C-c C-x C-w,org-cut-subtree}
  1235. Kill subtree, i.e., remove it from buffer but save in kill ring.
  1236. With a numeric prefix argument N, kill N sequential subtrees.
  1237. @orgcmd{C-c C-x M-w,org-copy-subtree}
  1238. Copy subtree to kill ring. With a numeric prefix argument N, copy the N
  1239. sequential subtrees.
  1240. @orgcmd{C-c C-x C-y,org-paste-subtree}
  1241. Yank subtree from kill ring. This does modify the level of the subtree to
  1242. make sure the tree fits in nicely at the yank position. The yank level can
  1243. also be specified with a numeric prefix argument, or by yanking after a
  1244. headline marker like @samp{****}.
  1245. @orgcmd{C-y,org-yank}
  1246. @vindex org-yank-adjusted-subtrees
  1247. @vindex org-yank-folded-subtrees
  1248. Depending on the options @code{org-yank-adjusted-subtrees} and
  1249. @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
  1250. paste subtrees folded and in a clever way, using the same command as @kbd{C-c
  1251. C-x C-y}. With the default settings, no level adjustment will take place,
  1252. but the yanked tree will be folded unless doing so would swallow text
  1253. previously visible. Any prefix argument to this command will force a normal
  1254. @code{yank} to be executed, with the prefix passed along. A good way to
  1255. force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
  1256. yank, it will yank previous kill items plainly, without adjustment and
  1257. folding.
  1258. @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
  1259. Clone a subtree by making a number of sibling copies of it. You will be
  1260. prompted for the number of copies to make, and you can also specify if any
  1261. timestamps in the entry should be shifted. This can be useful, for example,
  1262. to create a number of tasks related to a series of lectures to prepare. For
  1263. more details, see the docstring of the command
  1264. @code{org-clone-subtree-with-time-shift}.
  1265. @orgcmd{C-c C-w,org-refile}
  1266. Refile entry or region to a different location. @xref{Refile and copy}.
  1267. @orgcmd{C-c ^,org-sort}
  1268. Sort same-level entries. When there is an active region, all entries in the
  1269. region will be sorted. Otherwise the children of the current headline are
  1270. sorted. The command prompts for the sorting method, which can be
  1271. alphabetically, numerically, by time (first timestamp with active preferred,
  1272. creation time, scheduled time, deadline time), by priority, by TODO keyword
  1273. (in the sequence the keywords have been defined in the setup) or by the value
  1274. of a property. Reverse sorting is possible as well. You can also supply
  1275. your own function to extract the sorting key. With a @kbd{C-u} prefix,
  1276. sorting will be case-sensitive.
  1277. @orgcmd{C-x n s,org-narrow-to-subtree}
  1278. Narrow buffer to current subtree.
  1279. @orgcmd{C-x n b,org-narrow-to-block}
  1280. Narrow buffer to current block.
  1281. @orgcmd{C-x n w,widen}
  1282. Widen buffer to remove narrowing.
  1283. @orgcmd{C-c *,org-toggle-heading}
  1284. Turn a normal line or plain list item into a headline (so that it becomes a
  1285. subheading at its location). Also turn a headline into a normal line by
  1286. removing the stars. If there is an active region, turn all lines in the
  1287. region into headlines. If the first line in the region was an item, turn
  1288. only the item lines into headlines. Finally, if the first line is a
  1289. headline, remove the stars from all headlines in the region.
  1290. @end table
  1291. @cindex region, active
  1292. @cindex active region
  1293. @cindex transient mark mode
  1294. When there is an active region (Transient Mark mode), promotion and
  1295. demotion work on all headlines in the region. To select a region of
  1296. headlines, it is best to place both point and mark at the beginning of a
  1297. line, mark at the beginning of the first headline, and point at the line
  1298. just after the last headline to change. Note that when the cursor is
  1299. inside a table (@pxref{Tables}), the Meta-Cursor keys have different
  1300. functionality.
  1301. @node Sparse trees
  1302. @section Sparse trees
  1303. @cindex sparse trees
  1304. @cindex trees, sparse
  1305. @cindex folding, sparse trees
  1306. @cindex occur, command
  1307. @vindex org-show-context-detail
  1308. An important feature of Org mode is the ability to construct @emph{sparse
  1309. trees} for selected information in an outline tree, so that the entire
  1310. document is folded as much as possible, but the selected information is made
  1311. visible along with the headline structure above it@footnote{See also the
  1312. variable @code{org-show-context-detail} to decide how much context is shown
  1313. around each match.}. Just try it out and you will see immediately how it
  1314. works.
  1315. Org mode contains several commands for creating such trees, all these
  1316. commands can be accessed through a dispatcher:
  1317. @table @asis
  1318. @orgcmd{C-c /,org-sparse-tree}
  1319. This prompts for an extra key to select a sparse-tree creating command.
  1320. @orgcmdkkc{C-c / r,C-c / /,org-occur}
  1321. @vindex org-remove-highlights-with-change
  1322. Prompts for a regexp and shows a sparse tree with all matches. If
  1323. the match is in a headline, the headline is made visible. If the match is in
  1324. the body of an entry, headline and body are made visible. In order to
  1325. provide minimal context, also the full hierarchy of headlines above the match
  1326. is shown, as well as the headline following the match. Each match is also
  1327. highlighted; the highlights disappear when the buffer is changed by an
  1328. editing command@footnote{This depends on the option
  1329. @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
  1330. When called with a @kbd{C-u} prefix argument, previous highlights are kept,
  1331. so several calls to this command can be stacked.
  1332. @orgcmdkkc{M-g n,M-g M-n,next-error}
  1333. Jump to the next sparse tree match in this buffer.
  1334. @orgcmdkkc{M-g p,M-g M-p,previous-error}
  1335. Jump to the previous sparse tree match in this buffer.
  1336. @end table
  1337. @noindent
  1338. @vindex org-agenda-custom-commands
  1339. For frequently used sparse trees of specific search strings, you can
  1340. use the option @code{org-agenda-custom-commands} to define fast
  1341. keyboard access to specific sparse trees. These commands will then be
  1342. accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
  1343. For example:
  1344. @lisp
  1345. (setq org-agenda-custom-commands
  1346. '(("f" occur-tree "FIXME")))
  1347. @end lisp
  1348. @noindent will define the key @kbd{C-c a f} as a shortcut for creating
  1349. a sparse tree matching the string @samp{FIXME}.
  1350. The other sparse tree commands select headings based on TODO keywords,
  1351. tags, or properties and will be discussed later in this manual.
  1352. @kindex C-c C-e C-v
  1353. @cindex printing sparse trees
  1354. @cindex visible text, printing
  1355. To print a sparse tree, you can use the Emacs command
  1356. @code{ps-print-buffer-with-faces} which does not print invisible parts of the
  1357. document. Or you can use @kbd{C-c C-e C-v} to export only the visible part
  1358. of the document and print the resulting file.
  1359. @node Plain lists
  1360. @section Plain lists
  1361. @cindex plain lists
  1362. @cindex lists, plain
  1363. @cindex lists, ordered
  1364. @cindex ordered lists
  1365. Within an entry of the outline tree, hand-formatted lists can provide
  1366. additional structure. They also provide a way to create lists of checkboxes
  1367. (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
  1368. (@pxref{Exporting}) can parse and format them.
  1369. Org knows ordered lists, unordered lists, and description lists.
  1370. @itemize @bullet
  1371. @item
  1372. @emph{Unordered} list items start with @samp{-}, @samp{+}, or
  1373. @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
  1374. they will be seen as top-level headlines. Also, when you are hiding leading
  1375. stars to get a clean outline view, plain list items starting with a star may
  1376. be hard to distinguish from true headlines. In short: even though @samp{*}
  1377. is supported, it may be better to not use it for plain list items.} as
  1378. bullets.
  1379. @item
  1380. @vindex org-plain-list-ordered-item-terminator
  1381. @vindex org-list-allow-alphabetical
  1382. @emph{Ordered} list items start with a numeral followed by either a period or
  1383. a right parenthesis@footnote{You can filter out any of them by configuring
  1384. @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
  1385. @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
  1386. @samp{A)} by configuring @code{org-list-allow-alphabetical}. To minimize
  1387. confusion with normal text, those are limited to one character only. Beyond
  1388. that limit, bullets will automatically fallback to numbers.}. If you want a
  1389. list to start with a different value (e.g., 20), start the text of the item
  1390. with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
  1391. must be put @emph{before} the checkbox. If you have activated alphabetical
  1392. lists, you can also use counters like @code{[@@b]}.}. Those constructs can
  1393. be used in any item of the list in order to enforce a particular numbering.
  1394. @item
  1395. @emph{Description} list items are unordered list items, and contain the
  1396. separator @samp{ :: } to distinguish the description @emph{term} from the
  1397. description.
  1398. @end itemize
  1399. Items belonging to the same list must have the same indentation on the first
  1400. line. In particular, if an ordered list reaches number @samp{10.}, then the
  1401. 2--digit numbers must be written left-aligned with the other numbers in the
  1402. list. An item ends before the next line that is less or equally indented
  1403. than its bullet/number.
  1404. @vindex org-list-empty-line-terminates-plain-lists
  1405. A list ends whenever every item has ended, which means before any line less
  1406. or equally indented than items at top level. It also ends before two blank
  1407. lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
  1408. In that case, all items are closed. Here is an example:
  1409. @example
  1410. @group
  1411. ** Lord of the Rings
  1412. My favorite scenes are (in this order)
  1413. 1. The attack of the Rohirrim
  1414. 2. Eowyn's fight with the witch king
  1415. + this was already my favorite scene in the book
  1416. + I really like Miranda Otto.
  1417. 3. Peter Jackson being shot by Legolas
  1418. - on DVD only
  1419. He makes a really funny face when it happens.
  1420. But in the end, no individual scenes matter but the film as a whole.
  1421. Important actors in this film are:
  1422. - @b{Elijah Wood} :: He plays Frodo
  1423. - @b{Sean Astin} :: He plays Sam, Frodo's friend. I still remember
  1424. him very well from his role as Mikey Walsh in @i{The Goonies}.
  1425. @end group
  1426. @end example
  1427. Org supports these lists by tuning filling and wrapping commands to deal with
  1428. them correctly, and by exporting them properly (@pxref{Exporting}). Since
  1429. indentation is what governs the structure of these lists, many structural
  1430. constructs like @code{#+BEGIN_...} blocks can be indented to signal that they
  1431. belong to a particular item.
  1432. @vindex org-list-demote-modify-bullet
  1433. @vindex org-list-indent-offset
  1434. If you find that using a different bullet for a sub-list (than that used for
  1435. the current list-level) improves readability, customize the variable
  1436. @code{org-list-demote-modify-bullet}. To get a greater difference of
  1437. indentation between items and their sub-items, customize
  1438. @code{org-list-indent-offset}.
  1439. @vindex org-list-automatic-rules
  1440. The following commands act on items when the cursor is in the first line of
  1441. an item (the line with the bullet or number). Some of them imply the
  1442. application of automatic rules to keep list structure intact. If some of
  1443. these actions get in your way, configure @code{org-list-automatic-rules}
  1444. to disable them individually.
  1445. @table @asis
  1446. @orgcmd{@key{TAB},org-cycle}
  1447. @cindex cycling, in plain lists
  1448. @vindex org-cycle-include-plain-lists
  1449. Items can be folded just like headline levels. Normally this works only if
  1450. the cursor is on a plain list item. For more details, see the variable
  1451. @code{org-cycle-include-plain-lists}. If this variable is set to
  1452. @code{integrate}, plain list items will be treated like low-level
  1453. headlines. The level of an item is then given by the indentation of the
  1454. bullet/number. Items are always subordinate to real headlines, however; the
  1455. hierarchies remain completely separated. In a new item with no text yet, the
  1456. first @key{TAB} demotes the item to become a child of the previous
  1457. one. Subsequent @key{TAB}s move the item to meaningful levels in the list
  1458. and eventually get it back to its initial position.
  1459. @orgcmd{M-@key{RET},org-insert-heading}
  1460. @vindex org-M-RET-may-split-line
  1461. @vindex org-list-automatic-rules
  1462. Insert new item at current level. With a prefix argument, force a new
  1463. heading (@pxref{Structure editing}). If this command is used in the middle
  1464. of an item, that item is @emph{split} in two, and the second part becomes the
  1465. new item@footnote{If you do not want the item to be split, customize the
  1466. variable @code{org-M-RET-may-split-line}.}. If this command is executed
  1467. @emph{before item's body}, the new item is created @emph{before} the current
  1468. one.
  1469. @end table
  1470. @table @kbd
  1471. @kindex M-S-@key{RET}
  1472. @item M-S-@key{RET}
  1473. Insert a new item with a checkbox (@pxref{Checkboxes}).
  1474. @kindex S-@key{down}
  1475. @item S-up
  1476. @itemx S-down
  1477. @cindex shift-selection-mode
  1478. @vindex org-support-shift-select
  1479. @vindex org-list-use-circular-motion
  1480. Jump to the previous/next item in the current list@footnote{If you want to
  1481. cycle around items that way, you may customize
  1482. @code{org-list-use-circular-motion}.}, but only if
  1483. @code{org-support-shift-select} is off. If not, you can still use paragraph
  1484. jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
  1485. similar effect.
  1486. @kindex M-@key{up}
  1487. @kindex M-@key{down}
  1488. @item M-up
  1489. @itemx M-down
  1490. Move the item including subitems up/down@footnote{See
  1491. @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
  1492. previous/next item of same indentation). If the list is ordered, renumbering
  1493. is automatic.
  1494. @kindex M-@key{left}
  1495. @kindex M-@key{right}
  1496. @item M-left
  1497. @itemx M-right
  1498. Decrease/increase the indentation of an item, leaving children alone.
  1499. @kindex M-S-@key{left}
  1500. @kindex M-S-@key{right}
  1501. @item M-S-@key{left}
  1502. @itemx M-S-@key{right}
  1503. Decrease/increase the indentation of the item, including subitems.
  1504. Initially, the item tree is selected based on current indentation. When
  1505. these commands are executed several times in direct succession, the initially
  1506. selected region is used, even if the new indentation would imply a different
  1507. hierarchy. To use the new hierarchy, break the command chain with a cursor
  1508. motion or so.
  1509. As a special case, using this command on the very first item of a list will
  1510. move the whole list. This behavior can be disabled by configuring
  1511. @code{org-list-automatic-rules}. The global indentation of a list has no
  1512. influence on the text @emph{after} the list.
  1513. @kindex C-c C-c
  1514. @item C-c C-c
  1515. If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
  1516. state of the checkbox. In any case, verify bullets and indentation
  1517. consistency in the whole list.
  1518. @kindex C-c -
  1519. @vindex org-plain-list-ordered-item-terminator
  1520. @item C-c -
  1521. Cycle the entire list level through the different itemize/enumerate bullets
  1522. (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
  1523. depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
  1524. and its indentation. With a numeric prefix argument N, select the Nth bullet
  1525. from this list. If there is an active region when calling this, all selected
  1526. lines are converted to list items. With a prefix argument, selected text is
  1527. changed into a single item. If the first line already was a list item, any
  1528. item marker will be removed from the list. Finally, even without an active
  1529. region, a normal line will be converted into a list item.
  1530. @kindex C-c *
  1531. @item C-c *
  1532. Turn a plain list item into a headline (so that it becomes a subheading at
  1533. its location). @xref{Structure editing}, for a detailed explanation.
  1534. @kindex C-c C-*
  1535. @item C-c C-*
  1536. Turn the whole plain list into a subtree of the current heading. Checkboxes
  1537. (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
  1538. (resp. checked).
  1539. @kindex S-@key{left}
  1540. @kindex S-@key{right}
  1541. @item S-left/right
  1542. @vindex org-support-shift-select
  1543. This command also cycles bullet styles when the cursor in on the bullet or
  1544. anywhere in an item line, details depending on
  1545. @code{org-support-shift-select}.
  1546. @kindex C-c ^
  1547. @cindex sorting, of plain list
  1548. @item C-c ^
  1549. Sort the plain list. You will be prompted for the sorting method:
  1550. numerically, alphabetically, by time, by checked status for check lists,
  1551. or by a custom function.
  1552. @end table
  1553. @node Drawers
  1554. @section Drawers
  1555. @cindex drawers
  1556. @cindex visibility cycling, drawers
  1557. @cindex org-insert-drawer
  1558. @kindex C-c C-x d
  1559. Sometimes you want to keep information associated with an entry, but you
  1560. normally don't want to see it. For this, Org mode has @emph{drawers}. They
  1561. can contain anything but a headline and another drawer. Drawers look like
  1562. this:
  1563. @example
  1564. ** This is a headline
  1565. Still outside the drawer
  1566. :DRAWERNAME:
  1567. This is inside the drawer.
  1568. :END:
  1569. After the drawer.
  1570. @end example
  1571. You can interactively insert drawers at point by calling
  1572. @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
  1573. region, this command will put the region inside the drawer. With a prefix
  1574. argument, this command calls @code{org-insert-property-drawer} and add a
  1575. property drawer right below the current headline. Completion over drawer
  1576. keywords is also possible using @key{M-TAB}.
  1577. Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
  1578. show the entry, but keep the drawer collapsed to a single line. In order to
  1579. look inside the drawer, you need to move the cursor to the drawer line and
  1580. press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
  1581. storing properties (@pxref{Properties and columns}), and you can also arrange
  1582. for state change notes (@pxref{Tracking TODO state changes}) and clock times
  1583. (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
  1584. want to store a quick note in the LOGBOOK drawer, in a similar way to state
  1585. changes, use
  1586. @table @kbd
  1587. @kindex C-c C-z
  1588. @item C-c C-z
  1589. Add a time-stamped note to the LOGBOOK drawer.
  1590. @end table
  1591. @vindex org-export-with-drawers
  1592. @vindex org-export-with-properties
  1593. You can select the name of the drawers which should be exported with
  1594. @code{org-export-with-drawers}. In that case, drawer contents will appear in
  1595. export output. Property drawers are not affected by this variable: configure
  1596. @code{org-export-with-properties} instead.
  1597. @node Blocks
  1598. @section Blocks
  1599. @vindex org-hide-block-startup
  1600. @cindex blocks, folding
  1601. Org mode uses begin...end blocks for various purposes from including source
  1602. code examples (@pxref{Literal examples}) to capturing time logging
  1603. information (@pxref{Clocking work time}). These blocks can be folded and
  1604. unfolded by pressing TAB in the begin line. You can also get all blocks
  1605. folded at startup by configuring the option @code{org-hide-block-startup}
  1606. or on a per-file basis by using
  1607. @cindex @code{hideblocks}, STARTUP keyword
  1608. @cindex @code{nohideblocks}, STARTUP keyword
  1609. @example
  1610. #+STARTUP: hideblocks
  1611. #+STARTUP: nohideblocks
  1612. @end example
  1613. @node Footnotes
  1614. @section Footnotes
  1615. @cindex footnotes
  1616. Org mode supports the creation of footnotes.
  1617. A footnote is started by a footnote marker in square brackets in column 0, no
  1618. indentation allowed. It ends at the next footnote definition, headline, or
  1619. after two consecutive empty lines. The footnote reference is simply the
  1620. marker in square brackets, inside text. Markers always start with
  1621. @code{fn:}. For example:
  1622. @example
  1623. The Org homepage[fn:1] now looks a lot better than it used to.
  1624. ...
  1625. [fn:1] The link is: http://orgmode.org
  1626. @end example
  1627. Org mode extends the number-based syntax to @emph{named} footnotes and
  1628. optional inline definition. Here are the valid references:
  1629. @table @code
  1630. @item [fn:name]
  1631. A named footnote reference, where @code{name} is a unique label word, or, for
  1632. simplicity of automatic creation, a number.
  1633. @item [fn::This is the inline definition of this footnote]
  1634. A @LaTeX{}-like anonymous footnote where the definition is given directly at the
  1635. reference point.
  1636. @item [fn:name:a definition]
  1637. An inline definition of a footnote, which also specifies a name for the note.
  1638. Since Org allows multiple references to the same note, you can then use
  1639. @code{[fn:name]} to create additional references.
  1640. @end table
  1641. @vindex org-footnote-auto-label
  1642. Footnote labels can be created automatically, or you can create names yourself.
  1643. This is handled by the variable @code{org-footnote-auto-label} and its
  1644. corresponding @code{#+STARTUP} keywords. See the docstring of that variable
  1645. for details.
  1646. @noindent The following command handles footnotes:
  1647. @table @kbd
  1648. @kindex C-c C-x f
  1649. @item C-c C-x f
  1650. The footnote action command.
  1651. When the cursor is on a footnote reference, jump to the definition. When it
  1652. is at a definition, jump to the (first) reference.
  1653. @vindex org-footnote-define-inline
  1654. @vindex org-footnote-section
  1655. @vindex org-footnote-auto-adjust
  1656. Otherwise, create a new footnote. Depending on the option
  1657. @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
  1658. setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
  1659. definition will be placed right into the text as part of the reference, or
  1660. separately into the location determined by the option
  1661. @code{org-footnote-section}.
  1662. When this command is called with a prefix argument, a menu of additional
  1663. options is offered:
  1664. @example
  1665. s @r{Sort the footnote definitions by reference sequence. During editing,}
  1666. @r{Org makes no effort to sort footnote definitions into a particular}
  1667. @r{sequence. If you want them sorted, use this command, which will}
  1668. @r{also move entries according to @code{org-footnote-section}. Automatic}
  1669. @r{sorting after each insertion/deletion can be configured using the}
  1670. @r{option @code{org-footnote-auto-adjust}.}
  1671. r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
  1672. @r{after each insertion/deletion can be configured using the option}
  1673. @r{@code{org-footnote-auto-adjust}.}
  1674. S @r{Short for first @code{r}, then @code{s} action.}
  1675. n @r{Normalize the footnotes by collecting all definitions (including}
  1676. @r{inline definitions) into a special section, and then numbering them}
  1677. @r{in sequence. The references will then also be numbers.}
  1678. d @r{Delete the footnote at point, and all definitions of and references}
  1679. @r{to it.}
  1680. @end example
  1681. Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
  1682. corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
  1683. renumbering and sorting footnotes can be automatic after each insertion or
  1684. deletion.
  1685. @kindex C-c C-c
  1686. @item C-c C-c
  1687. If the cursor is on a footnote reference, jump to the definition. If it is a
  1688. the definition, jump back to the reference. When called at a footnote
  1689. location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
  1690. @kindex C-c C-o
  1691. @kindex mouse-1
  1692. @kindex mouse-2
  1693. @item C-c C-o @r{or} mouse-1/2
  1694. Footnote labels are also links to the corresponding definition/reference, and
  1695. you can use the usual commands to follow these links.
  1696. @vindex org-edit-footnote-reference
  1697. @kindex C-c '
  1698. @item C-c '
  1699. @item C-c '
  1700. Edit the footnote definition corresponding to the reference at point in
  1701. a seperate window. The window can be closed by pressing @kbd{C-c '}.
  1702. @end table
  1703. @node Orgstruct mode
  1704. @section The Orgstruct minor mode
  1705. @cindex Orgstruct mode
  1706. @cindex minor mode for structure editing
  1707. If you like the intuitive way the Org mode structure editing and list
  1708. formatting works, you might want to use these commands in other modes like
  1709. Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
  1710. this possible. Toggle the mode with @kbd{M-x orgstruct-mode RET}, or
  1711. turn it on by default, for example in Message mode, with one of:
  1712. @lisp
  1713. (add-hook 'message-mode-hook 'turn-on-orgstruct)
  1714. (add-hook 'message-mode-hook 'turn-on-orgstruct++)
  1715. @end lisp
  1716. When this mode is active and the cursor is on a line that looks to Org like a
  1717. headline or the first line of a list item, most structure editing commands
  1718. will work, even if the same keys normally have different functionality in the
  1719. major mode you are using. If the cursor is not in one of those special
  1720. lines, Orgstruct mode lurks silently in the shadows.
  1721. When you use @code{orgstruct++-mode}, Org will also export indentation and
  1722. autofill settings into that mode, and detect item context after the first
  1723. line of an item.
  1724. @vindex orgstruct-heading-prefix-regexp
  1725. You can also use Org structure editing to fold and unfold headlines in
  1726. @emph{any} file, provided you defined @code{orgstruct-heading-prefix-regexp}:
  1727. the regular expression must match the local prefix to use before Org's
  1728. headlines. For example, if you set this variable to @code{";; "} in Emacs
  1729. Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
  1730. commented lines. Some commands like @code{org-demote} are disabled when the
  1731. prefix is set, but folding/unfolding will work correctly.
  1732. @node Org syntax
  1733. @section Org syntax
  1734. @cindex Org syntax
  1735. A reference document providing a formal description of Org's syntax is
  1736. available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
  1737. Worg}, written and maintained by Nicolas Goaziou. It defines Org's core
  1738. internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
  1739. keywords}, @code{(greater) elements} and @code{objects}. Each part of an Org
  1740. file falls into one of the categories above.
  1741. To explore the abstract structure of an Org buffer, run this in a buffer:
  1742. @lisp
  1743. M-: (org-element-parse-buffer) RET
  1744. @end lisp
  1745. It will output a list containing the buffer's content represented as an
  1746. abstract structure. The export engine relies on the information stored in
  1747. this list. Most interactive commands (e.g., for structure editing) also
  1748. rely on the syntactic meaning of the surrounding context.
  1749. @cindex syntax checker
  1750. @cindex linter
  1751. You can check syntax in your documents using @code{org-lint} command.
  1752. @node Tables
  1753. @chapter Tables
  1754. @cindex tables
  1755. @cindex editing tables
  1756. Org comes with a fast and intuitive table editor. Spreadsheet-like
  1757. calculations are supported using the Emacs @file{calc} package
  1758. (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
  1759. @menu
  1760. * Built-in table editor:: Simple tables
  1761. * Column width and alignment:: Overrule the automatic settings
  1762. * Column groups:: Grouping to trigger vertical lines
  1763. * Orgtbl mode:: The table editor as minor mode
  1764. * The spreadsheet:: The table editor has spreadsheet capabilities
  1765. * Org-Plot:: Plotting from org tables
  1766. @end menu
  1767. @node Built-in table editor
  1768. @section The built-in table editor
  1769. @cindex table editor, built-in
  1770. Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
  1771. the first non-whitespace character is considered part of a table. @samp{|}
  1772. is also the column separator@footnote{To insert a vertical bar into a table
  1773. field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
  1774. might look like this:
  1775. @example
  1776. | Name | Phone | Age |
  1777. |-------+-------+-----|
  1778. | Peter | 1234 | 17 |
  1779. | Anna | 4321 | 25 |
  1780. @end example
  1781. A table is re-aligned automatically each time you press @key{TAB} or
  1782. @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
  1783. the next field (@key{RET} to the next row) and creates new table rows
  1784. at the end of the table or before horizontal lines. The indentation
  1785. of the table is set by the first line. Any line starting with
  1786. @samp{|-} is considered as a horizontal separator line and will be
  1787. expanded on the next re-align to span the whole table width. So, to
  1788. create the above table, you would only type
  1789. @example
  1790. |Name|Phone|Age|
  1791. |-
  1792. @end example
  1793. @noindent and then press @key{TAB} to align the table and start filling in
  1794. fields. Even faster would be to type @code{|Name|Phone|Age} followed by
  1795. @kbd{C-c @key{RET}}.
  1796. @vindex org-enable-table-editor
  1797. @vindex org-table-auto-blank-field
  1798. When typing text into a field, Org treats @key{DEL},
  1799. @key{Backspace}, and all character keys in a special way, so that
  1800. inserting and deleting avoids shifting other fields. Also, when
  1801. typing @emph{immediately after the cursor was moved into a new field
  1802. with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
  1803. field is automatically made blank. If this behavior is too
  1804. unpredictable for you, configure the options
  1805. @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
  1806. @table @kbd
  1807. @tsubheading{Creation and conversion}
  1808. @orgcmd{C-c |,org-table-create-or-convert-from-region}
  1809. Convert the active region to a table. If every line contains at least one
  1810. TAB character, the function assumes that the material is tab separated.
  1811. If every line contains a comma, comma-separated values (CSV) are assumed.
  1812. If not, lines are split at whitespace into fields. You can use a prefix
  1813. argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
  1814. C-u} forces TAB, @kbd{C-u C-u C-u} will prompt for a regular expression to
  1815. match the separator, and a numeric argument N indicates that at least N
  1816. consecutive spaces, or alternatively a TAB will be the separator.
  1817. @*
  1818. If there is no active region, this command creates an empty Org
  1819. table. But it is easier just to start typing, like
  1820. @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
  1821. @tsubheading{Re-aligning and field motion}
  1822. @orgcmd{C-c C-c,org-table-align}
  1823. Re-align the table and don't move to another field.
  1824. @c
  1825. @orgcmd{C-c SPC,org-table-blank-field}
  1826. Blank the field at point.
  1827. @c
  1828. @orgcmd{<TAB>,org-table-next-field}
  1829. Re-align the table, move to the next field. Creates a new row if
  1830. necessary.
  1831. @c
  1832. @orgcmd{S-@key{TAB},org-table-previous-field}
  1833. Re-align, move to previous field.
  1834. @c
  1835. @orgcmd{@key{RET},org-table-next-row}
  1836. Re-align the table and move down to next row. Creates a new row if
  1837. necessary. At the beginning or end of a line, @key{RET} still does
  1838. NEWLINE, so it can be used to split a table.
  1839. @c
  1840. @orgcmd{M-a,org-table-beginning-of-field}
  1841. Move to beginning of the current table field, or on to the previous field.
  1842. @orgcmd{M-e,org-table-end-of-field}
  1843. Move to end of the current table field, or on to the next field.
  1844. @tsubheading{Column and row editing}
  1845. @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
  1846. Move the current column left/right.
  1847. @c
  1848. @orgcmd{M-S-@key{left},org-table-delete-column}
  1849. Kill the current column.
  1850. @c
  1851. @orgcmd{M-S-@key{right},org-table-insert-column}
  1852. Insert a new column to the left of the cursor position.
  1853. @c
  1854. @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
  1855. Move the current row up/down.
  1856. @c
  1857. @orgcmd{M-S-@key{up},org-table-kill-row}
  1858. Kill the current row or horizontal line.
  1859. @c
  1860. @orgcmd{M-S-@key{down},org-table-insert-row}
  1861. Insert a new row above the current row. With a prefix argument, the line is
  1862. created below the current one.
  1863. @c
  1864. @orgcmd{C-c -,org-table-insert-hline}
  1865. Insert a horizontal line below current row. With a prefix argument, the line
  1866. is created above the current line.
  1867. @c
  1868. @orgcmd{C-c @key{RET},org-table-hline-and-move}
  1869. Insert a horizontal line below current row, and move the cursor into the row
  1870. below that line.
  1871. @c
  1872. @orgcmd{C-c ^,org-table-sort-lines}
  1873. Sort the table lines in the region. The position of point indicates the
  1874. column to be used for sorting, and the range of lines is the range
  1875. between the nearest horizontal separator lines, or the entire table. If
  1876. point is before the first column, you will be prompted for the sorting
  1877. column. If there is an active region, the mark specifies the first line
  1878. and the sorting column, while point should be in the last line to be
  1879. included into the sorting. The command prompts for the sorting type
  1880. (alphabetically, numerically, or by time). You can sort in normal or
  1881. reverse order. You can also supply your own key extraction and comparison
  1882. functions. When called with a prefix argument, alphabetic sorting will be
  1883. case-sensitive.
  1884. @tsubheading{Regions}
  1885. @orgcmd{C-c C-x M-w,org-table-copy-region}
  1886. Copy a rectangular region from a table to a special clipboard. Point and
  1887. mark determine edge fields of the rectangle. If there is no active region,
  1888. copy just the current field. The process ignores horizontal separator lines.
  1889. @c
  1890. @orgcmd{C-c C-x C-w,org-table-cut-region}
  1891. Copy a rectangular region from a table to a special clipboard, and
  1892. blank all fields in the rectangle. So this is the ``cut'' operation.
  1893. @c
  1894. @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
  1895. Paste a rectangular region into a table.
  1896. The upper left corner ends up in the current field. All involved fields
  1897. will be overwritten. If the rectangle does not fit into the present table,
  1898. the table is enlarged as needed. The process ignores horizontal separator
  1899. lines.
  1900. @c
  1901. @orgcmd{M-@key{RET},org-table-wrap-region}
  1902. Split the current field at the cursor position and move the rest to the line
  1903. below. If there is an active region, and both point and mark are in the same
  1904. column, the text in the column is wrapped to minimum width for the given
  1905. number of lines. A numeric prefix argument may be used to change the number
  1906. of desired lines. If there is no region, but you specify a prefix argument,
  1907. the current field is made blank, and the content is appended to the field
  1908. above.
  1909. @tsubheading{Calculations}
  1910. @cindex formula, in tables
  1911. @cindex calculations, in tables
  1912. @cindex region, active
  1913. @cindex active region
  1914. @cindex transient mark mode
  1915. @orgcmd{C-c +,org-table-sum}
  1916. Sum the numbers in the current column, or in the rectangle defined by
  1917. the active region. The result is shown in the echo area and can
  1918. be inserted with @kbd{C-y}.
  1919. @c
  1920. @orgcmd{S-@key{RET},org-table-copy-down}
  1921. @vindex org-table-copy-increment
  1922. When current field is empty, copy from first non-empty field above. When not
  1923. empty, copy current field down to next row and move cursor along with it.
  1924. Depending on the option @code{org-table-copy-increment}, integer field
  1925. values will be incremented during copy. Integers that are too large will not
  1926. be incremented. Also, a @code{0} prefix argument temporarily disables the
  1927. increment. This key is also used by shift-selection and related modes
  1928. (@pxref{Conflicts}).
  1929. @tsubheading{Miscellaneous}
  1930. @orgcmd{C-c `,org-table-edit-field}
  1931. Edit the current field in a separate window. This is useful for fields that
  1932. are not fully visible (@pxref{Column width and alignment}). When called with
  1933. a @kbd{C-u} prefix, just make the full field visible, so that it can be
  1934. edited in place. When called with two @kbd{C-u} prefixes, make the editor
  1935. window follow the cursor through the table and always show the current
  1936. field. The follow mode exits automatically when the cursor leaves the table,
  1937. or when you repeat this command with @kbd{C-u C-u C-c `}.
  1938. @c
  1939. @item M-x org-table-import RET
  1940. Import a file as a table. The table should be TAB or whitespace
  1941. separated. Use, for example, to import a spreadsheet table or data
  1942. from a database, because these programs generally can write
  1943. TAB-separated text files. This command works by inserting the file into
  1944. the buffer and then converting the region to a table. Any prefix
  1945. argument is passed on to the converter, which uses it to determine the
  1946. separator.
  1947. @orgcmd{C-c |,org-table-create-or-convert-from-region}
  1948. Tables can also be imported by pasting tabular text into the Org
  1949. buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
  1950. @kbd{C-c |} command (see above under @i{Creation and conversion}).
  1951. @c
  1952. @item M-x org-table-export RET
  1953. @findex org-table-export
  1954. @vindex org-table-export-default-format
  1955. Export the table, by default as a TAB-separated file. Use for data
  1956. exchange with, for example, spreadsheet or database programs. The format
  1957. used to export the file can be configured in the option
  1958. @code{org-table-export-default-format}. You may also use properties
  1959. @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
  1960. name and the format for table export in a subtree. Org supports quite
  1961. general formats for exported tables. The exporter format is the same as the
  1962. format used by Orgtbl radio tables, see @ref{Translator functions}, for a
  1963. detailed description.
  1964. @end table
  1965. If you don't like the automatic table editor because it gets in your
  1966. way on lines which you would like to start with @samp{|}, you can turn
  1967. it off with
  1968. @lisp
  1969. (setq org-enable-table-editor nil)
  1970. @end lisp
  1971. @noindent Then the only table command that still works is
  1972. @kbd{C-c C-c} to do a manual re-align.
  1973. @node Column width and alignment
  1974. @section Column width and alignment
  1975. @cindex narrow columns in tables
  1976. @cindex alignment in tables
  1977. The width of columns is automatically determined by the table editor. And
  1978. also the alignment of a column is determined automatically from the fraction
  1979. of number-like versus non-number fields in the column.
  1980. Sometimes a single field or a few fields need to carry more text, leading to
  1981. inconveniently wide columns. Or maybe you want to make a table with several
  1982. columns having a fixed width, regardless of content. To set the width of
  1983. a column, one field anywhere in the column may contain just the string
  1984. @samp{<N>} where @samp{N} is an integer specifying the width of the column in
  1985. characters. The next re-align will then set the width of this column to this
  1986. value.
  1987. @example
  1988. @group
  1989. |---+------------------------------| |---+--------|
  1990. | | | | | <6> |
  1991. | 1 | one | | 1 | one |
  1992. | 2 | two | ----\ | 2 | two |
  1993. | 3 | This is a long chunk of text | ----/ | 3 | This=> |
  1994. | 4 | four | | 4 | four |
  1995. |---+------------------------------| |---+--------|
  1996. @end group
  1997. @end example
  1998. @noindent
  1999. Fields that are wider become clipped and end in the string @samp{=>}.
  2000. Note that the full text is still in the buffer but is hidden.
  2001. To see the full text, hold the mouse over the field---a tool-tip window
  2002. will show the full content. To edit such a field, use the command
  2003. @kbd{C-c `} (that is @kbd{C-c} followed by the grave accent). This will
  2004. open a new window with the full field. Edit it and finish with @kbd{C-c
  2005. C-c}.
  2006. @vindex org-startup-align-all-tables
  2007. When visiting a file containing a table with narrowed columns, the
  2008. necessary character hiding has not yet happened, and the table needs to
  2009. be aligned before it looks nice. Setting the option
  2010. @code{org-startup-align-all-tables} will realign all tables in a file
  2011. upon visiting, but also slow down startup. You can also set this option
  2012. on a per-file basis with:
  2013. @example
  2014. #+STARTUP: align
  2015. #+STARTUP: noalign
  2016. @end example
  2017. If you would like to overrule the automatic alignment of number-rich columns
  2018. to the right and of string-rich columns to the left, you can use @samp{<r>},
  2019. @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
  2020. effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
  2021. also combine alignment and field width like this: @samp{<r10>}.
  2022. Lines which only contain these formatting cookies will be removed
  2023. automatically when exporting the document.
  2024. @node Column groups
  2025. @section Column groups
  2026. @cindex grouping columns in tables
  2027. When Org exports tables, it does so by default without vertical lines because
  2028. that is visually more satisfying in general. Occasionally however, vertical
  2029. lines can be useful to structure a table into groups of columns, much like
  2030. horizontal lines can do for groups of rows. In order to specify column
  2031. groups, you can use a special row where the first field contains only
  2032. @samp{/}. The further fields can either contain @samp{<} to indicate that
  2033. this column should start a group, @samp{>} to indicate the end of a group, or
  2034. @samp{<>} (no space between @samp{<} and @samp{>}) to make a column a group
  2035. of its own. Boundaries between column groups will upon export be marked with
  2036. vertical lines. Here is an example:
  2037. @example
  2038. | N | N^2 | N^3 | N^4 | ~sqrt(n)~ | ~sqrt[4](N)~ |
  2039. |---+-----+-----+-----+-----------+--------------|
  2040. | / | < | | > | < | > |
  2041. | 1 | 1 | 1 | 1 | 1 | 1 |
  2042. | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
  2043. | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
  2044. |---+-----+-----+-----+-----------+--------------|
  2045. #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
  2046. @end example
  2047. It is also sufficient to just insert the column group starters after
  2048. every vertical line you would like to have:
  2049. @example
  2050. | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  2051. |----+-----+-----+-----+---------+------------|
  2052. | / | < | | | < | |
  2053. @end example
  2054. @node Orgtbl mode
  2055. @section The Orgtbl minor mode
  2056. @cindex Orgtbl mode
  2057. @cindex minor mode for tables
  2058. If you like the intuitive way the Org table editor works, you
  2059. might also want to use it in other modes like Text mode or Mail mode.
  2060. The minor mode Orgtbl mode makes this possible. You can always toggle
  2061. the mode with @kbd{M-x orgtbl-mode RET}. To turn it on by default, for
  2062. example in Message mode, use
  2063. @lisp
  2064. (add-hook 'message-mode-hook 'turn-on-orgtbl)
  2065. @end lisp
  2066. Furthermore, with some special setup, it is possible to maintain tables
  2067. in arbitrary syntax with Orgtbl mode. For example, it is possible to
  2068. construct @LaTeX{} tables with the underlying ease and power of
  2069. Orgtbl mode, including spreadsheet capabilities. For details, see
  2070. @ref{Tables in arbitrary syntax}.
  2071. @node The spreadsheet
  2072. @section The spreadsheet
  2073. @cindex calculations, in tables
  2074. @cindex spreadsheet capabilities
  2075. @cindex @file{calc} package
  2076. The table editor makes use of the Emacs @file{calc} package to implement
  2077. spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
  2078. derive fields from other fields. While fully featured, Org's implementation
  2079. is not identical to other spreadsheets. For example, Org knows the concept
  2080. of a @emph{column formula} that will be applied to all non-header fields in a
  2081. column without having to copy the formula to each relevant field. There is
  2082. also a formula debugger, and a formula editor with features for highlighting
  2083. fields in the table corresponding to the references at the point in the
  2084. formula, moving these references by arrow keys
  2085. @menu
  2086. * References:: How to refer to another field or range
  2087. * Formula syntax for Calc:: Using Calc to compute stuff
  2088. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  2089. * Durations and time values:: How to compute durations and time values
  2090. * Field and range formulas:: Formula for specific (ranges of) fields
  2091. * Column formulas:: Formulas valid for an entire column
  2092. * Lookup functions:: Lookup functions for searching tables
  2093. * Editing and debugging formulas:: Fixing formulas
  2094. * Updating the table:: Recomputing all dependent fields
  2095. * Advanced features:: Field and column names, parameters and automatic recalc
  2096. @end menu
  2097. @node References
  2098. @subsection References
  2099. @cindex references
  2100. To compute fields in the table from other fields, formulas must
  2101. reference other fields or ranges. In Org, fields can be referenced
  2102. by name, by absolute coordinates, and by relative coordinates. To find
  2103. out what the coordinates of a field are, press @kbd{C-c ?} in that
  2104. field, or press @kbd{C-c @}} to toggle the display of a grid.
  2105. @subsubheading Field references
  2106. @cindex field references
  2107. @cindex references, to fields
  2108. Formulas can reference the value of another field in two ways. Like in
  2109. any other spreadsheet, you may reference fields with a letter/number
  2110. combination like @code{B3}, meaning the 2nd field in the 3rd row.
  2111. @vindex org-table-use-standard-references
  2112. However, Org prefers@footnote{Org will understand references typed by the
  2113. user as @samp{B4}, but it will not use this syntax when offering a formula
  2114. for editing. You can customize this behavior using the option
  2115. @code{org-table-use-standard-references}.} to use another, more general
  2116. representation that looks like this:
  2117. @example
  2118. @@@var{row}$@var{column}
  2119. @end example
  2120. Column specifications can be absolute like @code{$1},
  2121. @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
  2122. column of the field which is being computed) like @code{$+1} or @code{$-2}.
  2123. @code{$<} and @code{$>} are immutable references to the first and last
  2124. column, respectively, and you can use @code{$>>>} to indicate the third
  2125. column from the right.
  2126. The row specification only counts data lines and ignores horizontal separator
  2127. lines (hlines). Like with columns, you can use absolute row numbers
  2128. @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
  2129. current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
  2130. immutable references the first and last@footnote{For backward compatibility
  2131. you can also use special names like @code{$LR5} and @code{$LR12} to refer in
  2132. a stable way to the 5th and 12th field in the last row of the table.
  2133. However, this syntax is deprecated, it should not be used for new documents.
  2134. Use @code{@@>$} instead.} row in the table, respectively. You may also
  2135. specify the row relative to one of the hlines: @code{@@I} refers to the first
  2136. hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
  2137. line above the current line, @code{@@+I} to the first such line below the
  2138. current line. You can also write @code{@@III+2} which is the second data line
  2139. after the third hline in the table.
  2140. @code{@@0} and @code{$0} refer to the current row and column, respectively,
  2141. i.e., to the row/column for the field being computed. Also, if you omit
  2142. either the column or the row part of the reference, the current row/column is
  2143. implied.
  2144. Org's references with @emph{unsigned} numbers are fixed references
  2145. in the sense that if you use the same reference in the formula for two
  2146. different fields, the same field will be referenced each time.
  2147. Org's references with @emph{signed} numbers are floating
  2148. references because the same reference operator can reference different
  2149. fields depending on the field being calculated by the formula.
  2150. Here are a few examples:
  2151. @example
  2152. @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
  2153. $5 @r{column 5 in the current row (same as @code{E&})}
  2154. @@2 @r{current column, row 2}
  2155. @@-1$-3 @r{the field one row up, three columns to the left}
  2156. @@-I$2 @r{field just under hline above current row, column 2}
  2157. @@>$5 @r{field in the last row, in column 5}
  2158. @end example
  2159. @subsubheading Range references
  2160. @cindex range references
  2161. @cindex references, to ranges
  2162. You may reference a rectangular range of fields by specifying two field
  2163. references connected by two dots @samp{..}. If both fields are in the
  2164. current row, you may simply use @samp{$2..$7}, but if at least one field
  2165. is in a different row, you need to use the general @code{@@row$column}
  2166. format at least for the first field (i.e the reference must start with
  2167. @samp{@@} in order to be interpreted correctly). Examples:
  2168. @example
  2169. $1..$3 @r{first three fields in the current row}
  2170. $P..$Q @r{range, using column names (see under Advanced)}
  2171. $<<<..$>> @r{start in third column, continue to the last but one}
  2172. @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
  2173. @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left}
  2174. @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
  2175. @end example
  2176. @noindent Range references return a vector of values that can be fed
  2177. into Calc vector functions. Empty fields in ranges are normally suppressed,
  2178. so that the vector contains only the non-empty fields. For other options
  2179. with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
  2180. for Calc}.
  2181. @subsubheading Field coordinates in formulas
  2182. @cindex field coordinates
  2183. @cindex coordinates, of field
  2184. @cindex row, of field coordinates
  2185. @cindex column, of field coordinates
  2186. One of the very first actions during evaluation of Calc formulas and Lisp
  2187. formulas is to substitute @code{@@#} and @code{$#} in the formula with the
  2188. row or column number of the field where the current result will go to. The
  2189. traditional Lisp formula equivalents are @code{org-table-current-dline} and
  2190. @code{org-table-current-column}. Examples:
  2191. @table @code
  2192. @item if(@@# % 2, $#, string(""))
  2193. Insert column number on odd rows, set field to empty on even rows.
  2194. @item $2 = '(identity remote(FOO, @@@@#$1))
  2195. Copy text or values of each row of column 1 of the table named @code{FOO}
  2196. into column 2 of the current table.
  2197. @item @@3 = 2 * remote(FOO, @@1$$#)
  2198. Insert the doubled value of each column of row 1 of the table named
  2199. @code{FOO} into row 3 of the current table.
  2200. @end table
  2201. @noindent For the second/third example, the table named @code{FOO} must have
  2202. at least as many rows/columns as the current table. Note that this is
  2203. inefficient@footnote{The computation time scales as O(N^2) because the table
  2204. named @code{FOO} is parsed for each field to be read.} for large number of
  2205. rows/columns.
  2206. @subsubheading Named references
  2207. @cindex named references
  2208. @cindex references, named
  2209. @cindex name, of column or field
  2210. @cindex constants, in calculations
  2211. @cindex #+CONSTANTS
  2212. @vindex org-table-formula-constants
  2213. @samp{$name} is interpreted as the name of a column, parameter or
  2214. constant. Constants are defined globally through the option
  2215. @code{org-table-formula-constants}, and locally (for the file) through a
  2216. line like
  2217. @example
  2218. #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
  2219. @end example
  2220. @noindent
  2221. @vindex constants-unit-system
  2222. @pindex constants.el
  2223. Also properties (@pxref{Properties and columns}) can be used as
  2224. constants in table formulas: for a property @samp{:Xyz:} use the name
  2225. @samp{$PROP_Xyz}, and the property will be searched in the current
  2226. outline entry and in the hierarchy above it. If you have the
  2227. @file{constants.el} package, it will also be used to resolve constants,
  2228. including natural constants like @samp{$h} for Planck's constant, and
  2229. units like @samp{$km} for kilometers@footnote{@file{constants.el} can
  2230. supply the values of constants in two different unit systems, @code{SI}
  2231. and @code{cgs}. Which one is used depends on the value of the variable
  2232. @code{constants-unit-system}. You can use the @code{#+STARTUP} options
  2233. @code{constSI} and @code{constcgs} to set this value for the current
  2234. buffer.}. Column names and parameters can be specified in special table
  2235. lines. These are described below, see @ref{Advanced features}. All
  2236. names must start with a letter, and further consist of letters and
  2237. numbers.
  2238. @subsubheading Remote references
  2239. @cindex remote references
  2240. @cindex references, remote
  2241. @cindex references, to a different table
  2242. @cindex name, of column or field
  2243. @cindex constants, in calculations
  2244. @cindex #+NAME, for table
  2245. You may also reference constants, fields and ranges from a different table,
  2246. either in the current file or even in a different file. The syntax is
  2247. @example
  2248. remote(NAME-OR-ID,REF)
  2249. @end example
  2250. @noindent
  2251. where NAME can be the name of a table in the current file as set by a
  2252. @code{#+NAME: Name} line before the table. It can also be the ID of an
  2253. entry, even in a different file, and the reference then refers to the first
  2254. table in that entry. REF is an absolute field or range reference as
  2255. described above for example @code{@@3$3} or @code{$somename}, valid in the
  2256. referenced table.
  2257. Indirection of NAME-OR-ID: When NAME-OR-ID has the format @code{@@ROW$COLUMN}
  2258. it will be substituted with the name or ID found in this field of the current
  2259. table. For example @code{remote($1, @@>$2)} => @code{remote(year_2013,
  2260. @@>$1)}. The format @code{B3} is not supported because it can not be
  2261. distinguished from a plain table name or ID.
  2262. @node Formula syntax for Calc
  2263. @subsection Formula syntax for Calc
  2264. @cindex formula syntax, Calc
  2265. @cindex syntax, of formulas
  2266. A formula can be any algebraic expression understood by the Emacs @file{Calc}
  2267. package. Note that @file{calc} has the non-standard convention that @samp{/}
  2268. has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as
  2269. @samp{a/(b*c)}. Before evaluation by @code{calc-eval} (@pxref{Calling Calc
  2270. from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc,
  2271. GNU Emacs Calc Manual}), variable substitution takes place according to the
  2272. rules described above.
  2273. @cindex vectors, in table calculations
  2274. The range vectors can be directly fed into the Calc vector functions
  2275. like @samp{vmean} and @samp{vsum}.
  2276. @cindex format specifier
  2277. @cindex mode, for @file{calc}
  2278. @vindex org-calc-default-modes
  2279. A formula can contain an optional mode string after a semicolon. This
  2280. string consists of flags to influence Calc and other modes during
  2281. execution. By default, Org uses the standard Calc modes (precision
  2282. 12, angular units degrees, fraction and symbolic modes off). The display
  2283. format, however, has been changed to @code{(float 8)} to keep tables
  2284. compact. The default settings can be configured using the option
  2285. @code{org-calc-default-modes}.
  2286. @noindent List of modes:
  2287. @table @asis
  2288. @item @code{p20}
  2289. Set the internal Calc calculation precision to 20 digits.
  2290. @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
  2291. Normal, scientific, engineering or fixed format of the result of Calc passed
  2292. back to Org. Calc formatting is unlimited in precision as long as the Calc
  2293. calculation precision is greater.
  2294. @item @code{D}, @code{R}
  2295. Degree and radian angle modes of Calc.
  2296. @item @code{F}, @code{S}
  2297. Fraction and symbolic modes of Calc.
  2298. @item @code{T}, @code{t}
  2299. Duration computations in Calc or Lisp, @pxref{Durations and time values}.
  2300. @item @code{E}
  2301. If and how to consider empty fields. Without @samp{E} empty fields in range
  2302. references are suppressed so that the Calc vector or Lisp list contains only
  2303. the non-empty fields. With @samp{E} the empty fields are kept. For empty
  2304. fields in ranges or empty field references the value @samp{nan} (not a
  2305. number) is used in Calc formulas and the empty string is used for Lisp
  2306. formulas. Add @samp{N} to use 0 instead for both formula types. For the
  2307. value of a field the mode @samp{N} has higher precedence than @samp{E}.
  2308. @item @code{N}
  2309. Interpret all fields as numbers, use 0 for non-numbers. See the next section
  2310. to see how this is essential for computations with Lisp formulas. In Calc
  2311. formulas it is used only occasionally because there number strings are
  2312. already interpreted as numbers without @samp{N}.
  2313. @item @code{L}
  2314. Literal, for Lisp formulas only. See the next section.
  2315. @end table
  2316. @noindent
  2317. Unless you use large integer numbers or high-precision-calculation and
  2318. -display for floating point numbers you may alternatively provide a
  2319. @samp{printf} format specifier to reformat the Calc result after it has been
  2320. passed back to Org instead of letting Calc already do the
  2321. formatting@footnote{The @samp{printf} reformatting is limited in precision
  2322. because the value passed to it is converted into an @samp{integer} or
  2323. @samp{double}. The @samp{integer} is limited in size by truncating the
  2324. signed value to 32 bits. The @samp{double} is limited in precision to 64
  2325. bits overall which leaves approximately 16 significant decimal digits.}. A
  2326. few examples:
  2327. @example
  2328. $1+$2 @r{Sum of first and second field}
  2329. $1+$2;%.2f @r{Same, format result to two decimals}
  2330. exp($2)+exp($1) @r{Math functions can be used}
  2331. $0;%.1f @r{Reformat current cell to 1 decimal}
  2332. ($3-32)*5/9 @r{Degrees F -> C conversion}
  2333. $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
  2334. tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
  2335. sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
  2336. taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
  2337. @end example
  2338. Calc also contains a complete set of logical operations, (@pxref{Logical
  2339. Operations, , Logical Operations, calc, GNU Emacs Calc Manual}). For example
  2340. @table @code
  2341. @item if($1 < 20, teen, string(""))
  2342. "teen" if age $1 is less than 20, else the Org table result field is set to
  2343. empty with the empty string.
  2344. @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1
  2345. Sum of the first two columns. When at least one of the input fields is empty
  2346. the Org table result field is set to empty. @samp{E} is required to not
  2347. convert empty fields to 0. @samp{f-1} is an optional Calc format string
  2348. similar to @samp{%.1f} but leaves empty results empty.
  2349. @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
  2350. Mean value of a range unless there is any empty field. Every field in the
  2351. range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
  2352. in @samp{nan}. Then @samp{typeof == 12} detects the @samp{nan} from
  2353. @samp{vmean} and the Org table result field is set to empty. Use this when
  2354. the sample set is expected to never have missing values.
  2355. @item if("$1..$7" == "[]", string(""), vmean($1..$7))
  2356. Mean value of a range with empty fields skipped. Every field in the range
  2357. that is empty is skipped. When all fields in the range are empty the mean
  2358. value is not defined and the Org table result field is set to empty. Use
  2359. this when the sample set can have a variable size.
  2360. @item vmean($1..$7); EN
  2361. To complete the example before: Mean value of a range with empty fields
  2362. counting as samples with value 0. Use this only when incomplete sample sets
  2363. should be padded with 0 to the full size.
  2364. @end table
  2365. You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
  2366. and use them in formula syntax for Calc.
  2367. @node Formula syntax for Lisp
  2368. @subsection Emacs Lisp forms as formulas
  2369. @cindex Lisp forms, as table formulas
  2370. It is also possible to write a formula in Emacs Lisp. This can be useful
  2371. for string manipulation and control structures, if Calc's functionality is
  2372. not enough.
  2373. If a formula starts with an apostrophe followed by an opening parenthesis,
  2374. then it is evaluated as a Lisp form. The evaluation should return either a
  2375. string or a number. Just as with @file{calc} formulas, you can specify modes
  2376. and a printf format after a semicolon.
  2377. With Emacs Lisp forms, you need to be conscious about the way field
  2378. references are interpolated into the form. By default, a reference will be
  2379. interpolated as a Lisp string (in double-quotes) containing the field. If
  2380. you provide the @samp{N} mode switch, all referenced elements will be numbers
  2381. (non-number fields will be zero) and interpolated as Lisp numbers, without
  2382. quotes. If you provide the @samp{L} flag, all fields will be interpolated
  2383. literally, without quotes. I.e., if you want a reference to be interpreted
  2384. as a string by the Lisp form, enclose the reference operator itself in
  2385. double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
  2386. fields, so you can embed them in list or vector syntax.
  2387. Here are a few examples---note how the @samp{N} mode is used when we do
  2388. computations in Lisp:
  2389. @table @code
  2390. @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
  2391. Swap the first two characters of the content of column 1.
  2392. @item '(+ $1 $2);N
  2393. Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
  2394. @item '(apply '+ '($1..$4));N
  2395. Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
  2396. @end table
  2397. @node Durations and time values
  2398. @subsection Durations and time values
  2399. @cindex Duration, computing
  2400. @cindex Time, computing
  2401. @vindex org-table-duration-custom-format
  2402. If you want to compute time values use the @code{T} flag, either in Calc
  2403. formulas or Elisp formulas:
  2404. @example
  2405. @group
  2406. | Task 1 | Task 2 | Total |
  2407. |---------+----------+----------|
  2408. | 2:12 | 1:47 | 03:59:00 |
  2409. | 3:02:20 | -2:07:00 | 0.92 |
  2410. #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
  2411. @end group
  2412. @end example
  2413. Input duration values must be of the form @code{HH:MM[:SS]}, where seconds
  2414. are optional. With the @code{T} flag, computed durations will be displayed
  2415. as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
  2416. computed durations will be displayed according to the value of the option
  2417. @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
  2418. will display the result as a fraction of hours (see the second formula in the
  2419. example above).
  2420. Negative duration values can be manipulated as well, and integers will be
  2421. considered as seconds in addition and subtraction.
  2422. @node Field and range formulas
  2423. @subsection Field and range formulas
  2424. @cindex field formula
  2425. @cindex range formula
  2426. @cindex formula, for individual table field
  2427. @cindex formula, for range of fields
  2428. To assign a formula to a particular field, type it directly into the field,
  2429. preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
  2430. @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
  2431. the formula will be stored as the formula for this field, evaluated, and the
  2432. current field will be replaced with the result.
  2433. @cindex #+TBLFM
  2434. Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
  2435. below the table. If you type the equation in the 4th field of the 3rd data
  2436. line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
  2437. inserting/deleting/swapping columns and rows with the appropriate commands,
  2438. @i{absolute references} (but not relative ones) in stored formulas are
  2439. modified in order to still reference the same field. To avoid this, in
  2440. particular in range references, anchor ranges at the table borders (using
  2441. @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines using the
  2442. @code{@@I} notation. Automatic adaptation of field references does of course
  2443. not happen if you edit the table structure with normal editing
  2444. commands---then you must fix the equations yourself.
  2445. Instead of typing an equation into the field, you may also use the following
  2446. command
  2447. @table @kbd
  2448. @orgcmd{C-u C-c =,org-table-eval-formula}
  2449. Install a new formula for the current field. The command prompts for a
  2450. formula with default taken from the @samp{#+TBLFM:} line, applies
  2451. it to the current field, and stores it.
  2452. @end table
  2453. The left-hand side of a formula can also be a special expression in order to
  2454. assign the formula to a number of different fields. There is no keyboard
  2455. shortcut to enter such range formulas. To add them, use the formula editor
  2456. (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
  2457. directly.
  2458. @table @code
  2459. @item $2=
  2460. Column formula, valid for the entire column. This is so common that Org
  2461. treats these formulas in a special way, see @ref{Column formulas}.
  2462. @item @@3=
  2463. Row formula, applies to all fields in the specified row. @code{@@>=} means
  2464. the last row.
  2465. @item @@1$2..@@4$3=
  2466. Range formula, applies to all fields in the given rectangular range. This
  2467. can also be used to assign a formula to some but not all fields in a row.
  2468. @item $name=
  2469. Named field, see @ref{Advanced features}.
  2470. @end table
  2471. @node Column formulas
  2472. @subsection Column formulas
  2473. @cindex column formula
  2474. @cindex formula, for table column
  2475. When you assign a formula to a simple column reference like @code{$3=}, the
  2476. same formula will be used in all fields of that column, with the following
  2477. very convenient exceptions: (i) If the table contains horizontal separator
  2478. hlines with rows above and below, everything before the first such hline is
  2479. considered part of the table @emph{header} and will not be modified by column
  2480. formulas. Therefore a header is mandatory when you use column formulas and
  2481. want to add hlines to group rows, like for example to separate a total row at
  2482. the bottom from the summand rows above. (ii) Fields that already get a value
  2483. from a field/range formula will be left alone by column formulas. These
  2484. conditions make column formulas very easy to use.
  2485. To assign a formula to a column, type it directly into any field in the
  2486. column, preceded by an equal sign, like @samp{=$1+$2}. When you press
  2487. @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
  2488. the formula will be stored as the formula for the current column, evaluated
  2489. and the current field replaced with the result. If the field contains only
  2490. @samp{=}, the previously stored formula for this column is used. For each
  2491. column, Org will only remember the most recently used formula. In the
  2492. @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
  2493. left-hand side of a column formula cannot be the name of column, it must be
  2494. the numeric column reference or @code{$>}.
  2495. Instead of typing an equation into the field, you may also use the
  2496. following command:
  2497. @table @kbd
  2498. @orgcmd{C-c =,org-table-eval-formula}
  2499. Install a new formula for the current column and replace current field with
  2500. the result of the formula. The command prompts for a formula, with default
  2501. taken from the @samp{#+TBLFM} line, applies it to the current field and
  2502. stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
  2503. will apply it to that many consecutive fields in the current column.
  2504. @end table
  2505. @node Lookup functions
  2506. @subsection Lookup functions
  2507. @cindex lookup functions in tables
  2508. @cindex table lookup functions
  2509. Org has three predefined Emacs Lisp functions for lookups in tables.
  2510. @table @code
  2511. @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
  2512. @findex org-lookup-first
  2513. Searches for the first element @code{S} in list @code{S-LIST} for which
  2514. @lisp
  2515. (PREDICATE VAL S)
  2516. @end lisp
  2517. is @code{t}; returns the value from the corresponding position in list
  2518. @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
  2519. parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
  2520. order as the corresponding parameters are in the call to
  2521. @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
  2522. @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
  2523. is returned.
  2524. @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
  2525. @findex org-lookup-last
  2526. Similar to @code{org-lookup-first} above, but searches for the @i{last}
  2527. element for which @code{PREDICATE} is @code{t}.
  2528. @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
  2529. @findex org-lookup-all
  2530. Similar to @code{org-lookup-first}, but searches for @i{all} elements for
  2531. which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
  2532. values. This function can not be used by itself in a formula, because it
  2533. returns a list of values. However, powerful lookups can be built when this
  2534. function is combined with other Emacs Lisp functions.
  2535. @end table
  2536. If the ranges used in these functions contain empty fields, the @code{E} mode
  2537. for the formula should usually be specified: otherwise empty fields will not be
  2538. included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
  2539. in an incorrect mapping from an element of @code{S-LIST} to the corresponding
  2540. element of @code{R-LIST}.
  2541. These three functions can be used to implement associative arrays, count
  2542. matching cells, rank results, group data etc. For practical examples
  2543. see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
  2544. tutorial on Worg}.
  2545. @node Editing and debugging formulas
  2546. @subsection Editing and debugging formulas
  2547. @cindex formula editing
  2548. @cindex editing, of table formulas
  2549. @vindex org-table-use-standard-references
  2550. You can edit individual formulas in the minibuffer or directly in the field.
  2551. Org can also prepare a special buffer with all active formulas of a table.
  2552. When offering a formula for editing, Org converts references to the standard
  2553. format (like @code{B3} or @code{D&}) if possible. If you prefer to only work
  2554. with the internal format (like @code{@@3$2} or @code{$4}), configure the
  2555. option @code{org-table-use-standard-references}.
  2556. @table @kbd
  2557. @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
  2558. Edit the formula associated with the current column/field in the
  2559. minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
  2560. @orgcmd{C-u C-u C-c =,org-table-eval-formula}
  2561. Re-insert the active formula (either a
  2562. field formula, or a column formula) into the current field, so that you
  2563. can edit it directly in the field. The advantage over editing in the
  2564. minibuffer is that you can use the command @kbd{C-c ?}.
  2565. @orgcmd{C-c ?,org-table-field-info}
  2566. While editing a formula in a table field, highlight the field(s)
  2567. referenced by the reference at the cursor position in the formula.
  2568. @kindex C-c @}
  2569. @findex org-table-toggle-coordinate-overlays
  2570. @item C-c @}
  2571. Toggle the display of row and column numbers for a table, using overlays
  2572. (@command{org-table-toggle-coordinate-overlays}). These are updated each
  2573. time the table is aligned; you can force it with @kbd{C-c C-c}.
  2574. @kindex C-c @{
  2575. @findex org-table-toggle-formula-debugger
  2576. @item C-c @{
  2577. Toggle the formula debugger on and off
  2578. (@command{org-table-toggle-formula-debugger}). See below.
  2579. @orgcmd{C-c ',org-table-edit-formulas}
  2580. Edit all formulas for the current table in a special buffer, where the
  2581. formulas will be displayed one per line. If the current field has an
  2582. active formula, the cursor in the formula editor will mark it.
  2583. While inside the special buffer, Org will automatically highlight
  2584. any field or range reference at the cursor position. You may edit,
  2585. remove and add formulas, and use the following commands:
  2586. @table @kbd
  2587. @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
  2588. Exit the formula editor and store the modified formulas. With @kbd{C-u}
  2589. prefix, also apply the new formulas to the entire table.
  2590. @orgcmd{C-c C-q,org-table-fedit-abort}
  2591. Exit the formula editor without installing changes.
  2592. @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
  2593. Toggle all references in the formula editor between standard (like
  2594. @code{B3}) and internal (like @code{@@3$2}).
  2595. @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
  2596. Pretty-print or indent Lisp formula at point. When in a line containing
  2597. a Lisp formula, format the formula according to Emacs Lisp rules.
  2598. Another @key{TAB} collapses the formula back again. In the open
  2599. formula, @key{TAB} re-indents just like in Emacs Lisp mode.
  2600. @orgcmd{M-@key{TAB},lisp-complete-symbol}
  2601. Complete Lisp symbols, just like in Emacs Lisp mode.
  2602. @kindex S-@key{up}
  2603. @kindex S-@key{down}
  2604. @kindex S-@key{left}
  2605. @kindex S-@key{right}
  2606. @findex org-table-fedit-ref-up
  2607. @findex org-table-fedit-ref-down
  2608. @findex org-table-fedit-ref-left
  2609. @findex org-table-fedit-ref-right
  2610. @item S-@key{up}/@key{down}/@key{left}/@key{right}
  2611. Shift the reference at point. For example, if the reference is
  2612. @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
  2613. This also works for relative references and for hline references.
  2614. @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
  2615. Move the test line for column formulas in the Org buffer up and
  2616. down.
  2617. @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
  2618. Scroll the window displaying the table.
  2619. @kindex C-c @}
  2620. @findex org-table-toggle-coordinate-overlays
  2621. @item C-c @}
  2622. Turn the coordinate grid in the table on and off.
  2623. @end table
  2624. @end table
  2625. Making a table field blank does not remove the formula associated with
  2626. the field, because that is stored in a different line (the @samp{#+TBLFM}
  2627. line)---during the next recalculation the field will be filled again.
  2628. To remove a formula from a field, you have to give an empty reply when
  2629. prompted for the formula, or to edit the @samp{#+TBLFM} line.
  2630. @kindex C-c C-c
  2631. You may edit the @samp{#+TBLFM} directly and re-apply the changed
  2632. equations with @kbd{C-c C-c} in that line or with the normal
  2633. recalculation commands in the table.
  2634. @anchor{Using multiple #+TBLFM lines}
  2635. @subsubheading Using multiple #+TBLFM lines
  2636. @cindex #+TBLFM line, multiple
  2637. @cindex #+TBLFM
  2638. @cindex #+TBLFM, switching
  2639. @kindex C-c C-c
  2640. You may apply the formula temporarily. This is useful when you
  2641. switch the formula. Place multiple @samp{#+TBLFM} lines right
  2642. after the table, and then press @kbd{C-c C-c} on the formula to
  2643. apply. Here is an example:
  2644. @example
  2645. | x | y |
  2646. |---+---|
  2647. | 1 | |
  2648. | 2 | |
  2649. #+TBLFM: $2=$1*1
  2650. #+TBLFM: $2=$1*2
  2651. @end example
  2652. @noindent
  2653. Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
  2654. @example
  2655. | x | y |
  2656. |---+---|
  2657. | 1 | 2 |
  2658. | 2 | 4 |
  2659. #+TBLFM: $2=$1*1
  2660. #+TBLFM: $2=$1*2
  2661. @end example
  2662. @noindent
  2663. Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
  2664. will get the following result of applying only the first @samp{#+TBLFM} line.
  2665. @example
  2666. | x | y |
  2667. |---+---|
  2668. | 1 | 1 |
  2669. | 2 | 2 |
  2670. #+TBLFM: $2=$1*1
  2671. #+TBLFM: $2=$1*2
  2672. @end example
  2673. @subsubheading Debugging formulas
  2674. @cindex formula debugging
  2675. @cindex debugging, of table formulas
  2676. When the evaluation of a formula leads to an error, the field content
  2677. becomes the string @samp{#ERROR}. If you would like see what is going
  2678. on during variable substitution and calculation in order to find a bug,
  2679. turn on formula debugging in the @code{Tbl} menu and repeat the
  2680. calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
  2681. field. Detailed information will be displayed.
  2682. @node Updating the table
  2683. @subsection Updating the table
  2684. @cindex recomputing table fields
  2685. @cindex updating, table
  2686. Recalculation of a table is normally not automatic, but needs to be
  2687. triggered by a command. See @ref{Advanced features}, for a way to make
  2688. recalculation at least semi-automatic.
  2689. In order to recalculate a line of a table or the entire table, use the
  2690. following commands:
  2691. @table @kbd
  2692. @orgcmd{C-c *,org-table-recalculate}
  2693. Recalculate the current row by first applying the stored column formulas
  2694. from left to right, and all field/range formulas in the current row.
  2695. @c
  2696. @kindex C-u C-c *
  2697. @item C-u C-c *
  2698. @kindex C-u C-c C-c
  2699. @itemx C-u C-c C-c
  2700. Recompute the entire table, line by line. Any lines before the first
  2701. hline are left alone, assuming that these are part of the table header.
  2702. @c
  2703. @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
  2704. Iterate the table by recomputing it until no further changes occur.
  2705. This may be necessary if some computed fields use the value of other
  2706. fields that are computed @i{later} in the calculation sequence.
  2707. @item M-x org-table-recalculate-buffer-tables RET
  2708. @findex org-table-recalculate-buffer-tables
  2709. Recompute all tables in the current buffer.
  2710. @item M-x org-table-iterate-buffer-tables RET
  2711. @findex org-table-iterate-buffer-tables
  2712. Iterate all tables in the current buffer, in order to converge table-to-table
  2713. dependencies.
  2714. @end table
  2715. @node Advanced features
  2716. @subsection Advanced features
  2717. If you want the recalculation of fields to happen automatically, or if you
  2718. want to be able to assign @i{names}@footnote{Such names must start by an
  2719. alphabetic character and use only alphanumeric/underscore characters.} to
  2720. fields and columns, you need to reserve the first column of the table for
  2721. special marking characters.
  2722. @table @kbd
  2723. @orgcmd{C-#,org-table-rotate-recalc-marks}
  2724. Rotate the calculation mark in first column through the states @samp{ },
  2725. @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
  2726. change all marks in the region.
  2727. @end table
  2728. Here is an example of a table that collects exam results of students and
  2729. makes use of these features:
  2730. @example
  2731. @group
  2732. |---+---------+--------+--------+--------+-------+------|
  2733. | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
  2734. |---+---------+--------+--------+--------+-------+------|
  2735. | ! | | P1 | P2 | P3 | Tot | |
  2736. | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
  2737. | ^ | | m1 | m2 | m3 | mt | |
  2738. |---+---------+--------+--------+--------+-------+------|
  2739. | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
  2740. | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
  2741. |---+---------+--------+--------+--------+-------+------|
  2742. | | Average | | | | 25.0 | |
  2743. | ^ | | | | | at | |
  2744. | $ | max=50 | | | | | |
  2745. |---+---------+--------+--------+--------+-------+------|
  2746. #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
  2747. @end group
  2748. @end example
  2749. @noindent @b{Important}: please note that for these special tables,
  2750. recalculating the table with @kbd{C-u C-c *} will only affect rows that
  2751. are marked @samp{#} or @samp{*}, and fields that have a formula assigned
  2752. to the field itself. The column formulas are not applied in rows with
  2753. empty first field.
  2754. @cindex marking characters, tables
  2755. The marking characters have the following meaning:
  2756. @table @samp
  2757. @item !
  2758. The fields in this line define names for the columns, so that you may
  2759. refer to a column as @samp{$Tot} instead of @samp{$6}.
  2760. @item ^
  2761. This row defines names for the fields @emph{above} the row. With such
  2762. a definition, any formula in the table may use @samp{$m1} to refer to
  2763. the value @samp{10}. Also, if you assign a formula to a names field, it
  2764. will be stored as @samp{$name=...}.
  2765. @item _
  2766. Similar to @samp{^}, but defines names for the fields in the row
  2767. @emph{below}.
  2768. @item $
  2769. Fields in this row can define @emph{parameters} for formulas. For
  2770. example, if a field in a @samp{$} row contains @samp{max=50}, then
  2771. formulas in this table can refer to the value 50 using @samp{$max}.
  2772. Parameters work exactly like constants, only that they can be defined on
  2773. a per-table basis.
  2774. @item #
  2775. Fields in this row are automatically recalculated when pressing
  2776. @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
  2777. is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
  2778. lines will be left alone by this command.
  2779. @item *
  2780. Selects this line for global recalculation with @kbd{C-u C-c *}, but
  2781. not for automatic recalculation. Use this when automatic
  2782. recalculation slows down editing too much.
  2783. @item @w{ }
  2784. Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
  2785. All lines that should be recalculated should be marked with @samp{#}
  2786. or @samp{*}.
  2787. @item /
  2788. Do not export this line. Useful for lines that contain the narrowing
  2789. @samp{<N>} markers or column group markers.
  2790. @end table
  2791. Finally, just to whet your appetite for what can be done with the
  2792. fantastic @file{calc.el} package, here is a table that computes the Taylor
  2793. series of degree @code{n} at location @code{x} for a couple of
  2794. functions.
  2795. @example
  2796. @group
  2797. |---+-------------+---+-----+--------------------------------------|
  2798. | | Func | n | x | Result |
  2799. |---+-------------+---+-----+--------------------------------------|
  2800. | # | exp(x) | 1 | x | 1 + x |
  2801. | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
  2802. | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
  2803. | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
  2804. | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
  2805. | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
  2806. |---+-------------+---+-----+--------------------------------------|
  2807. #+TBLFM: $5=taylor($2,$4,$3);n3
  2808. @end group
  2809. @end example
  2810. @node Org-Plot
  2811. @section Org-Plot
  2812. @cindex graph, in tables
  2813. @cindex plot tables using Gnuplot
  2814. @cindex #+PLOT
  2815. Org-Plot can produce graphs of information stored in org tables, either
  2816. graphically or in ASCII-art.
  2817. @subheading Graphical plots using @file{Gnuplot}
  2818. Org-Plot produces 2D and 3D graphs using @file{Gnuplot}
  2819. @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
  2820. @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure
  2821. that you have both Gnuplot and Gnuplot mode installed on your system, then
  2822. call @kbd{C-c " g} or @kbd{M-x org-plot/gnuplot @key{RET}} on the following
  2823. table.
  2824. @example
  2825. @group
  2826. #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
  2827. | Sede | Max cites | H-index |
  2828. |-----------+-----------+---------|
  2829. | Chile | 257.72 | 21.39 |
  2830. | Leeds | 165.77 | 19.68 |
  2831. | Sao Paolo | 71.00 | 11.50 |
  2832. | Stockholm | 134.19 | 14.33 |
  2833. | Morelia | 257.56 | 17.67 |
  2834. @end group
  2835. @end example
  2836. Notice that Org Plot is smart enough to apply the table's headers as labels.
  2837. Further control over the labels, type, content, and appearance of plots can
  2838. be exercised through the @code{#+PLOT:} lines preceding a table. See below
  2839. for a complete list of Org-plot options. The @code{#+PLOT:} lines are
  2840. optional. For more information and examples see the Org-plot tutorial at
  2841. @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
  2842. @subsubheading Plot Options
  2843. @table @code
  2844. @item set
  2845. Specify any @command{gnuplot} option to be set when graphing.
  2846. @item title
  2847. Specify the title of the plot.
  2848. @item ind
  2849. Specify which column of the table to use as the @code{x} axis.
  2850. @item deps
  2851. Specify the columns to graph as a Lisp style list, surrounded by parentheses
  2852. and separated by spaces for example @code{dep:(3 4)} to graph the third and
  2853. fourth columns (defaults to graphing all other columns aside from the @code{ind}
  2854. column).
  2855. @item type
  2856. Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
  2857. @item with
  2858. Specify a @code{with} option to be inserted for every col being plotted
  2859. (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
  2860. Defaults to @code{lines}.
  2861. @item file
  2862. If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
  2863. @item labels
  2864. List of labels to be used for the @code{deps} (defaults to the column headers
  2865. if they exist).
  2866. @item line
  2867. Specify an entire line to be inserted in the Gnuplot script.
  2868. @item map
  2869. When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
  2870. flat mapping rather than a @code{3d} slope.
  2871. @item timefmt
  2872. Specify format of Org mode timestamps as they will be parsed by Gnuplot.
  2873. Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
  2874. @item script
  2875. If you want total control, you can specify a script file (place the file name
  2876. between double-quotes) which will be used to plot. Before plotting, every
  2877. instance of @code{$datafile} in the specified script will be replaced with
  2878. the path to the generated data file. Note: even if you set this option, you
  2879. may still want to specify the plot type, as that can impact the content of
  2880. the data file.
  2881. @end table
  2882. @subheading ASCII bar plots
  2883. While the cursor is on a column, typing @kbd{C-c " a} or
  2884. @kbd{M-x orgtbl-ascii-plot @key{RET}} create a new column containing an
  2885. ASCII-art bars plot. The plot is implemented through a regular column
  2886. formula. When the source column changes, the bar plot may be updated by
  2887. refreshing the table, for example typing @kbd{C-u C-c *}.
  2888. @example
  2889. @group
  2890. | Sede | Max cites | |
  2891. |---------------+-----------+--------------|
  2892. | Chile | 257.72 | WWWWWWWWWWWW |
  2893. | Leeds | 165.77 | WWWWWWWh |
  2894. | Sao Paolo | 71.00 | WWW; |
  2895. | Stockholm | 134.19 | WWWWWW: |
  2896. | Morelia | 257.56 | WWWWWWWWWWWH |
  2897. | Rochefourchat | 0.00 | |
  2898. #+TBLFM: $3='(orgtbl-ascii-draw $2 0.0 257.72 12)
  2899. @end group
  2900. @end example
  2901. The formula is an elisp call:
  2902. @lisp
  2903. (orgtbl-ascii-draw COLUMN MIN MAX WIDTH)
  2904. @end lisp
  2905. @table @code
  2906. @item COLUMN
  2907. is a reference to the source column.
  2908. @item MIN MAX
  2909. are the minimal and maximal values displayed. Sources values
  2910. outside this range are displayed as @samp{too small}
  2911. or @samp{too large}.
  2912. @item WIDTH
  2913. is the width in characters of the bar-plot. It defaults to @samp{12}.
  2914. @end table
  2915. @node Hyperlinks
  2916. @chapter Hyperlinks
  2917. @cindex hyperlinks
  2918. Like HTML, Org provides links inside a file, external links to
  2919. other files, Usenet articles, emails, and much more.
  2920. @menu
  2921. * Link format:: How links in Org are formatted
  2922. * Internal links:: Links to other places in the current file
  2923. * External links:: URL-like links to the world
  2924. * Handling links:: Creating, inserting and following
  2925. * Using links outside Org:: Linking from my C source code?
  2926. * Link abbreviations:: Shortcuts for writing complex links
  2927. * Search options:: Linking to a specific location
  2928. * Custom searches:: When the default search is not enough
  2929. @end menu
  2930. @node Link format
  2931. @section Link format
  2932. @cindex link format
  2933. @cindex format, of links
  2934. Org will recognize plain URL-like links and activate them as
  2935. clickable links. The general link format, however, looks like this:
  2936. @example
  2937. [[link][description]] @r{or alternatively} [[link]]
  2938. @end example
  2939. @noindent
  2940. Once a link in the buffer is complete (all brackets present), Org
  2941. will change the display so that @samp{description} is displayed instead
  2942. of @samp{[[link][description]]} and @samp{link} is displayed instead of
  2943. @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
  2944. which by default is an underlined face. You can directly edit the
  2945. visible part of a link. Note that this can be either the @samp{link}
  2946. part (if there is no description) or the @samp{description} part. To
  2947. edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
  2948. cursor on the link.
  2949. If you place the cursor at the beginning or just behind the end of the
  2950. displayed text and press @key{BACKSPACE}, you will remove the
  2951. (invisible) bracket at that location. This makes the link incomplete
  2952. and the internals are again displayed as plain text. Inserting the
  2953. missing bracket hides the link internals again. To show the
  2954. internal structure of all links, use the menu entry
  2955. @code{Org->Hyperlinks->Literal links}.
  2956. @node Internal links
  2957. @section Internal links
  2958. @cindex internal links
  2959. @cindex links, internal
  2960. @cindex targets, for links
  2961. @cindex property, CUSTOM_ID
  2962. If the link does not look like a URL, it is considered to be internal in the
  2963. current file. The most important case is a link like
  2964. @samp{[[#my-custom-id]]} which will link to the entry with the
  2965. @code{CUSTOM_ID} property @samp{my-custom-id}. You are responsible yourself
  2966. to make sure these custom IDs are unique in a file.
  2967. Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
  2968. lead to a text search in the current file.
  2969. The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
  2970. or with a mouse click (@pxref{Handling links}). Links to custom IDs will
  2971. point to the corresponding headline. The preferred match for a text link is
  2972. a @i{dedicated target}: the same string in double angular brackets, like
  2973. @samp{<<My Target>>}.
  2974. @cindex #+NAME
  2975. If no dedicated target exists, the link will then try to match the exact name
  2976. of an element within the buffer. Naming is done with the @code{#+NAME}
  2977. keyword, which has to be put in the line before the element it refers to, as
  2978. in the following example
  2979. @example
  2980. #+NAME: My Target
  2981. | a | table |
  2982. |----+------------|
  2983. | of | four cells |
  2984. @end example
  2985. If none of the above succeeds, Org will search for a headline that is exactly
  2986. the link text but may also include a TODO keyword and tags@footnote{To insert
  2987. a link targeting a headline, in-buffer completion can be used. Just type
  2988. a star followed by a few optional letters into the buffer and press
  2989. @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
  2990. completions.}.
  2991. During export, internal links will be used to mark objects and assign them
  2992. a number. Marked objects will then be referenced by links pointing to them.
  2993. In particular, links without a description will appear as the number assigned
  2994. to the marked object@footnote{When targeting a @code{#+NAME} keyword,
  2995. @code{#+CAPTION} keyword is mandatory in order to get proper numbering
  2996. (@pxref{Images and tables}).}. In the following excerpt from an Org buffer
  2997. @example
  2998. - one item
  2999. - <<target>>another item
  3000. Here we refer to item [[target]].
  3001. @end example
  3002. @noindent
  3003. The last sentence will appear as @samp{Here we refer to item 2} when
  3004. exported.
  3005. In non-Org files, the search will look for the words in the link text. In
  3006. the above example the search would be for @samp{my target}.
  3007. Following a link pushes a mark onto Org's own mark ring. You can
  3008. return to the previous position with @kbd{C-c &}. Using this command
  3009. several times in direct succession goes back to positions recorded
  3010. earlier.
  3011. @menu
  3012. * Radio targets:: Make targets trigger links in plain text
  3013. @end menu
  3014. @node Radio targets
  3015. @subsection Radio targets
  3016. @cindex radio targets
  3017. @cindex targets, radio
  3018. @cindex links, radio targets
  3019. Org can automatically turn any occurrences of certain target names
  3020. in normal text into a link. So without explicitly creating a link, the
  3021. text connects to the target radioing its position. Radio targets are
  3022. enclosed by triple angular brackets. For example, a target @samp{<<<My
  3023. Target>>>} causes each occurrence of @samp{my target} in normal text to
  3024. become activated as a link. The Org file is scanned automatically
  3025. for radio targets only when the file is first loaded into Emacs. To
  3026. update the target list during editing, press @kbd{C-c C-c} with the
  3027. cursor on or at a target.
  3028. @node External links
  3029. @section External links
  3030. @cindex links, external
  3031. @cindex external links
  3032. @cindex Gnus links
  3033. @cindex BBDB links
  3034. @cindex IRC links
  3035. @cindex URL links
  3036. @cindex file links
  3037. @cindex RMAIL links
  3038. @cindex MH-E links
  3039. @cindex USENET links
  3040. @cindex SHELL links
  3041. @cindex Info links
  3042. @cindex Elisp links
  3043. Org supports links to files, websites, Usenet and email messages, BBDB
  3044. database entries and links to both IRC conversations and their logs.
  3045. External links are URL-like locators. They start with a short identifying
  3046. string followed by a colon. There can be no space after the colon. The
  3047. following list shows examples for each link type.
  3048. @example
  3049. http://www.astro.uva.nl/~dominik @r{on the web}
  3050. doi:10.1000/182 @r{DOI for an electronic resource}
  3051. file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
  3052. /home/dominik/images/jupiter.jpg @r{same as above}
  3053. file:papers/last.pdf @r{file, relative path}
  3054. ./papers/last.pdf @r{same as above}
  3055. file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
  3056. /myself@@some.where:papers/last.pdf @r{same as above}
  3057. file:sometextfile::NNN @r{file, jump to line number}
  3058. file:projects.org @r{another Org file}
  3059. file:projects.org::some words @r{text search in Org file}@footnote{
  3060. The actual behavior of the search will depend on the value of
  3061. the option @code{org-link-search-must-match-exact-headline}. If its value
  3062. is @code{nil}, then a fuzzy text search will be done. If it is t, then only the
  3063. exact headline will be matched, ignoring spaces and cookies. If the value is
  3064. @code{query-to-create}, then an exact headline will be searched; if it is not
  3065. found, then the user will be queried to create it.}
  3066. file:projects.org::*task title @r{heading search in Org
  3067. file}@footnote{Headline searches always match the exact headline, ignoring
  3068. spaces and cookies. If the headline is not found and the value of the option
  3069. @code{org-link-search-must-match-exact-headline} is @code{query-to-create},
  3070. then the user will be queried to create it.}
  3071. docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
  3072. id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
  3073. news:comp.emacs @r{Usenet link}
  3074. mailto:adent@@galaxy.net @r{Mail link}
  3075. mhe:folder @r{MH-E folder link}
  3076. mhe:folder#id @r{MH-E message link}
  3077. rmail:folder @r{RMAIL folder link}
  3078. rmail:folder#id @r{RMAIL message link}
  3079. gnus:group @r{Gnus group link}
  3080. gnus:group#id @r{Gnus article link}
  3081. bbdb:R.*Stallman @r{BBDB link (with regexp)}
  3082. irc:/irc.com/#emacs/bob @r{IRC link}
  3083. info:org#External links @r{Info node or index link}
  3084. shell:ls *.org @r{A shell command}
  3085. elisp:org-agenda @r{Interactive Elisp command}
  3086. elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
  3087. @end example
  3088. @cindex VM links
  3089. @cindex WANDERLUST links
  3090. On top of these built-in link types, some are available through the
  3091. @code{contrib/} directory (@pxref{Installation}). For example, these links
  3092. to VM or Wanderlust messages are available when you load the corresponding
  3093. libraries from the @code{contrib/} directory:
  3094. @example
  3095. vm:folder @r{VM folder link}
  3096. vm:folder#id @r{VM message link}
  3097. vm://myself@@some.where.org/folder#id @r{VM on remote machine}
  3098. vm-imap:account:folder @r{VM IMAP folder link}
  3099. vm-imap:account:folder#id @r{VM IMAP message link}
  3100. wl:folder @r{WANDERLUST folder link}
  3101. wl:folder#id @r{WANDERLUST message link}
  3102. @end example
  3103. For customizing Org to add new link types @ref{Adding hyperlink types}.
  3104. A link should be enclosed in double brackets and may contain a descriptive
  3105. text to be displayed instead of the URL (@pxref{Link format}), for example:
  3106. @example
  3107. [[http://www.gnu.org/software/emacs/][GNU Emacs]]
  3108. @end example
  3109. @noindent
  3110. If the description is a file name or URL that points to an image, HTML
  3111. export (@pxref{HTML export}) will inline the image as a clickable
  3112. button. If there is no description at all and the link points to an
  3113. image,
  3114. that image will be inlined into the exported HTML file.
  3115. @cindex square brackets, around links
  3116. @cindex plain text external links
  3117. Org also finds external links in the normal text and activates them
  3118. as links. If spaces must be part of the link (for example in
  3119. @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
  3120. about the end of the link, enclose them in square brackets.
  3121. @node Handling links
  3122. @section Handling links
  3123. @cindex links, handling
  3124. Org provides methods to create a link in the correct syntax, to
  3125. insert it into an Org file, and to follow the link.
  3126. @table @kbd
  3127. @orgcmd{C-c l,org-store-link}
  3128. @cindex storing links
  3129. Store a link to the current location. This is a @emph{global} command (you
  3130. must create the key binding yourself) which can be used in any buffer to
  3131. create a link. The link will be stored for later insertion into an Org
  3132. buffer (see below). What kind of link will be created depends on the current
  3133. buffer:
  3134. @b{Org mode buffers}@*
  3135. For Org files, if there is a @samp{<<target>>} at the cursor, the link points
  3136. to the target. Otherwise it points to the current headline, which will also
  3137. be the description@footnote{If the headline contains a timestamp, it will be
  3138. removed from the link and result in a wrong link---you should avoid putting
  3139. timestamp in the headline.}.
  3140. @vindex org-id-link-to-org-use-id
  3141. @cindex property, CUSTOM_ID
  3142. @cindex property, ID
  3143. If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
  3144. will be stored. In addition or alternatively (depending on the value of
  3145. @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
  3146. be created and/or used to construct a link@footnote{The library
  3147. @file{org-id.el} must first be loaded, either through @code{org-customize} by
  3148. enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
  3149. 'org-id)} in your Emacs init file.}. So using this command in Org buffers
  3150. will potentially create two links: a human-readable from the custom ID, and
  3151. one that is globally unique and works even if the entry is moved from file to
  3152. file. Later, when inserting the link, you need to decide which one to use.
  3153. @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
  3154. Pretty much all Emacs mail clients are supported. The link will point to the
  3155. current article, or, in some GNUS buffers, to the group. The description is
  3156. constructed from the author and the subject.
  3157. @b{Web browsers: Eww, W3 and W3M}@*
  3158. Here the link will be the current URL, with the page title as description.
  3159. @b{Contacts: BBDB}@*
  3160. Links created in a BBDB buffer will point to the current entry.
  3161. @b{Chat: IRC}@*
  3162. @vindex org-irc-link-to-logs
  3163. For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t},
  3164. a @samp{file:/} style link to the relevant point in the logs for the current
  3165. conversation is created. Otherwise an @samp{irc:/} style link to the
  3166. user/channel/server under the point will be stored.
  3167. @b{Other files}@*
  3168. For any other files, the link will point to the file, with a search string
  3169. (@pxref{Search options}) pointing to the contents of the current line. If
  3170. there is an active region, the selected words will form the basis of the
  3171. search string. If the automatically created link is not working correctly or
  3172. accurately enough, you can write custom functions to select the search string
  3173. and to do the search for particular file types---see @ref{Custom searches}.
  3174. The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
  3175. @b{Agenda view}@*
  3176. When the cursor is in an agenda view, the created link points to the
  3177. entry referenced by the current line.
  3178. @c
  3179. @orgcmd{C-c C-l,org-insert-link}
  3180. @cindex link completion
  3181. @cindex completion, of links
  3182. @cindex inserting links
  3183. @vindex org-keep-stored-link-after-insertion
  3184. @vindex org-link-parameters
  3185. Insert a link@footnote{Note that you don't have to use this command to
  3186. insert a link. Links in Org are plain text, and you can type or paste them
  3187. straight into the buffer. By using this command, the links are automatically
  3188. enclosed in double brackets, and you will be asked for the optional
  3189. descriptive text.}. This prompts for a link to be inserted into the buffer.
  3190. You can just type a link, using text for an internal link, or one of the link
  3191. type prefixes mentioned in the examples above. The link will be inserted
  3192. into the buffer@footnote{After insertion of a stored link, the link will be
  3193. removed from the list of stored links. To keep it in the list later use, use
  3194. a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
  3195. @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
  3196. If some text was selected when this command is called, the selected text
  3197. becomes the default description.
  3198. @b{Inserting stored links}@*
  3199. All links stored during the
  3200. current session are part of the history for this prompt, so you can access
  3201. them with @key{up} and @key{down} (or @kbd{M-p/n}).
  3202. @b{Completion support}@* Completion with @key{TAB} will help you to insert
  3203. valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
  3204. defined through link abbreviations (@pxref{Link abbreviations}). If you
  3205. press @key{RET} after inserting only the @var{prefix}, Org will offer
  3206. specific completion support for some link types@footnote{This works if
  3207. a completion function is defined in the @samp{:complete} property of a link
  3208. in @code{org-link-parameters}.} For example, if you type @kbd{file
  3209. @key{RET}}, file name completion (alternative access: @kbd{C-u C-c C-l}, see
  3210. below) will be offered, and after @kbd{bbdb @key{RET}} you can complete
  3211. contact names.
  3212. @orgkey C-u C-c C-l
  3213. @cindex file name completion
  3214. @cindex completion, of file names
  3215. When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
  3216. a file will be inserted and you may use file name completion to select
  3217. the name of the file. The path to the file is inserted relative to the
  3218. directory of the current Org file, if the linked file is in the current
  3219. directory or in a sub-directory of it, or if the path is written relative
  3220. to the current directory using @samp{../}. Otherwise an absolute path
  3221. is used, if possible with @samp{~/} for your home directory. You can
  3222. force an absolute path with two @kbd{C-u} prefixes.
  3223. @c
  3224. @item C-c C-l @ @r{(with cursor on existing link)}
  3225. When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
  3226. link and description parts of the link.
  3227. @c
  3228. @cindex following links
  3229. @orgcmd{C-c C-o,org-open-at-point}
  3230. @vindex org-file-apps
  3231. @vindex org-link-frame-setup
  3232. Open link at point. This will launch a web browser for URLs (using
  3233. @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
  3234. the corresponding links, and execute the command in a shell link. When the
  3235. cursor is on an internal link, this command runs the corresponding search.
  3236. When the cursor is on a TAG list in a headline, it creates the corresponding
  3237. TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
  3238. date. Furthermore, it will visit text and remote files in @samp{file:} links
  3239. with Emacs and select a suitable application for local non-text files.
  3240. Classification of files is based on file extension only. See option
  3241. @code{org-file-apps}. If you want to override the default application and
  3242. visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
  3243. opening in Emacs, use a @kbd{C-u C-u} prefix.@*
  3244. If the cursor is on a headline, but not on a link, offer all links in the
  3245. headline and entry text. If you want to setup the frame configuration for
  3246. following links, customize @code{org-link-frame-setup}.
  3247. @orgkey @key{RET}
  3248. @vindex org-return-follows-link
  3249. When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
  3250. the link at point.
  3251. @c
  3252. @kindex mouse-2
  3253. @kindex mouse-1
  3254. @item mouse-2
  3255. @itemx mouse-1
  3256. On links, @kbd{mouse-1} and @kbd{mouse-2} will open the link just as @kbd{C-c
  3257. C-o} would.
  3258. @c
  3259. @kindex mouse-3
  3260. @item mouse-3
  3261. @vindex org-display-internal-link-with-indirect-buffer
  3262. Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
  3263. internal links to be displayed in another window@footnote{See the
  3264. option @code{org-display-internal-link-with-indirect-buffer}}.
  3265. @c
  3266. @orgcmd{C-c C-x C-v,org-toggle-inline-images}
  3267. @cindex inlining images
  3268. @cindex images, inlining
  3269. @vindex org-startup-with-inline-images
  3270. @cindex @code{inlineimages}, STARTUP keyword
  3271. @cindex @code{noinlineimages}, STARTUP keyword
  3272. Toggle the inline display of linked images. Normally this will only inline
  3273. images that have no description part in the link, i.e., images that will also
  3274. be inlined during export. When called with a prefix argument, also display
  3275. images that do have a link description. You can ask for inline images to be
  3276. displayed at startup by configuring the variable
  3277. @code{org-startup-with-inline-images}@footnote{with corresponding
  3278. @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}.
  3279. @orgcmd{C-c %,org-mark-ring-push}
  3280. @cindex mark ring
  3281. Push the current position onto the mark ring, to be able to return
  3282. easily. Commands following an internal link do this automatically.
  3283. @c
  3284. @orgcmd{C-c &,org-mark-ring-goto}
  3285. @cindex links, returning to
  3286. Jump back to a recorded position. A position is recorded by the
  3287. commands following internal links, and by @kbd{C-c %}. Using this
  3288. command several times in direct succession moves through a ring of
  3289. previously recorded positions.
  3290. @c
  3291. @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
  3292. @cindex links, finding next/previous
  3293. Move forward/backward to the next link in the buffer. At the limit of
  3294. the buffer, the search fails once, and then wraps around. The key
  3295. bindings for this are really too long; you might want to bind this also
  3296. to @kbd{C-n} and @kbd{C-p}
  3297. @lisp
  3298. (add-hook 'org-load-hook
  3299. (lambda ()
  3300. (define-key org-mode-map "\C-n" 'org-next-link)
  3301. (define-key org-mode-map "\C-p" 'org-previous-link)))
  3302. @end lisp
  3303. @end table
  3304. @node Using links outside Org
  3305. @section Using links outside Org
  3306. You can insert and follow links that have Org syntax not only in
  3307. Org, but in any Emacs buffer. For this, you should create two
  3308. global commands, like this (please select suitable global keys
  3309. yourself):
  3310. @lisp
  3311. (global-set-key "\C-c L" 'org-insert-link-global)
  3312. (global-set-key "\C-c o" 'org-open-at-point-global)
  3313. @end lisp
  3314. @node Link abbreviations
  3315. @section Link abbreviations
  3316. @cindex link abbreviations
  3317. @cindex abbreviation, links
  3318. Long URLs can be cumbersome to type, and often many similar links are
  3319. needed in a document. For this you can use link abbreviations. An
  3320. abbreviated link looks like this
  3321. @example
  3322. [[linkword:tag][description]]
  3323. @end example
  3324. @noindent
  3325. @vindex org-link-abbrev-alist
  3326. where the tag is optional.
  3327. The @i{linkword} must be a word, starting with a letter, followed by
  3328. letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
  3329. according to the information in the variable @code{org-link-abbrev-alist}
  3330. that relates the linkwords to replacement text. Here is an example:
  3331. @smalllisp
  3332. @group
  3333. (setq org-link-abbrev-alist
  3334. '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
  3335. ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
  3336. ("google" . "http://www.google.com/search?q=")
  3337. ("gmap" . "http://maps.google.com/maps?q=%s")
  3338. ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
  3339. ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
  3340. @end group
  3341. @end smalllisp
  3342. If the replacement text contains the string @samp{%s}, it will be
  3343. replaced with the tag. Using @samp{%h} instead of @samp{%s} will
  3344. url-encode the tag (see the example above, where we need to encode
  3345. the URL parameter.) Using @samp{%(my-function)} will pass the tag
  3346. to a custom function, and replace it by the resulting string.
  3347. If the replacement text doesn't contain any specifier, the tag will simply be
  3348. appended in order to create the link.
  3349. Instead of a string, you may also specify a function that will be
  3350. called with the tag as the only argument to create the link.
  3351. With the above setting, you could link to a specific bug with
  3352. @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
  3353. @code{[[google:OrgMode]]}, show the map location of the Free Software
  3354. Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
  3355. @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
  3356. what the Org author is doing besides Emacs hacking with
  3357. @code{[[ads:Dominik,C]]}.
  3358. If you need special abbreviations just for a single Org buffer, you
  3359. can define them in the file with
  3360. @cindex #+LINK
  3361. @example
  3362. #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
  3363. #+LINK: google http://www.google.com/search?q=%s
  3364. @end example
  3365. @noindent
  3366. In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
  3367. complete link abbreviations. You may also define a function that implements
  3368. special (e.g., completion) support for inserting such a link with @kbd{C-c
  3369. C-l}. Such a function should not accept any arguments, and return the full
  3370. link with prefix. You can add a completion function to a link like this:
  3371. @lisp
  3372. (org-link-set-parameters ``type'' :complete #'some-function)
  3373. @end lisp
  3374. @node Search options
  3375. @section Search options in file links
  3376. @cindex search option in file links
  3377. @cindex file links, searching
  3378. File links can contain additional information to make Emacs jump to a
  3379. particular location in the file when following a link. This can be a
  3380. line number or a search option after a double@footnote{For backward
  3381. compatibility, line numbers can also follow a single colon.} colon. For
  3382. example, when the command @kbd{C-c l} creates a link (@pxref{Handling
  3383. links}) to a file, it encodes the words in the current line as a search
  3384. string that can be used to find this line back later when following the
  3385. link with @kbd{C-c C-o}.
  3386. Here is the syntax of the different ways to attach a search to a file
  3387. link, together with an explanation:
  3388. @example
  3389. [[file:~/code/main.c::255]]
  3390. [[file:~/xx.org::My Target]]
  3391. [[file:~/xx.org::*My Target]]
  3392. [[file:~/xx.org::#my-custom-id]]
  3393. [[file:~/xx.org::/regexp/]]
  3394. @end example
  3395. @table @code
  3396. @item 255
  3397. Jump to line 255.
  3398. @item My Target
  3399. Search for a link target @samp{<<My Target>>}, or do a text search for
  3400. @samp{my target}, similar to the search in internal links, see
  3401. @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
  3402. link will become an HTML reference to the corresponding named anchor in
  3403. the linked file.
  3404. @item *My Target
  3405. In an Org file, restrict search to headlines.
  3406. @item #my-custom-id
  3407. Link to a heading with a @code{CUSTOM_ID} property
  3408. @item /regexp/
  3409. Do a regular expression search for @code{regexp}. This uses the Emacs
  3410. command @code{occur} to list all matches in a separate window. If the
  3411. target file is in Org mode, @code{org-occur} is used to create a
  3412. sparse tree with the matches.
  3413. @c If the target file is a directory,
  3414. @c @code{grep} will be used to search all files in the directory.
  3415. @end table
  3416. As a degenerate case, a file link with an empty file name can be used
  3417. to search the current file. For example, @code{[[file:::find me]]} does
  3418. a search for @samp{find me} in the current file, just as
  3419. @samp{[[find me]]} would.
  3420. @node Custom searches
  3421. @section Custom Searches
  3422. @cindex custom search strings
  3423. @cindex search strings, custom
  3424. The default mechanism for creating search strings and for doing the
  3425. actual search related to a file link may not work correctly in all
  3426. cases. For example, Bib@TeX{} database files have many entries like
  3427. @samp{year="1993"} which would not result in good search strings,
  3428. because the only unique identification for a Bib@TeX{} entry is the
  3429. citation key.
  3430. @vindex org-create-file-search-functions
  3431. @vindex org-execute-file-search-functions
  3432. If you come across such a problem, you can write custom functions to set
  3433. the right search string for a particular file type, and to do the search
  3434. for the string in the file. Using @code{add-hook}, these functions need
  3435. to be added to the hook variables
  3436. @code{org-create-file-search-functions} and
  3437. @code{org-execute-file-search-functions}. See the docstring for these
  3438. variables for more information. Org actually uses this mechanism
  3439. for Bib@TeX{} database files, and you can use the corresponding code as
  3440. an implementation example. See the file @file{org-bibtex.el}.
  3441. @node TODO items
  3442. @chapter TODO items
  3443. @cindex TODO items
  3444. Org mode does not maintain TODO lists as separate documents@footnote{Of
  3445. course, you can make a document that contains only long lists of TODO items,
  3446. but this is not required.}. Instead, TODO items are an integral part of the
  3447. notes file, because TODO items usually come up while taking notes! With Org
  3448. mode, simply mark any entry in a tree as being a TODO item. In this way,
  3449. information is not duplicated, and the entire context from which the TODO
  3450. item emerged is always present.
  3451. Of course, this technique for managing TODO items scatters them
  3452. throughout your notes file. Org mode compensates for this by providing
  3453. methods to give you an overview of all the things that you have to do.
  3454. @menu
  3455. * TODO basics:: Marking and displaying TODO entries
  3456. * TODO extensions:: Workflow and assignments
  3457. * Progress logging:: Dates and notes for progress
  3458. * Priorities:: Some things are more important than others
  3459. * Breaking down tasks:: Splitting a task into manageable pieces
  3460. * Checkboxes:: Tick-off lists
  3461. @end menu
  3462. @node TODO basics
  3463. @section Basic TODO functionality
  3464. Any headline becomes a TODO item when it starts with the word
  3465. @samp{TODO}, for example:
  3466. @example
  3467. *** TODO Write letter to Sam Fortune
  3468. @end example
  3469. @noindent
  3470. The most important commands to work with TODO entries are:
  3471. @table @kbd
  3472. @orgcmd{C-c C-t,org-todo}
  3473. @cindex cycling, of TODO states
  3474. @vindex org-use-fast-todo-selection
  3475. Rotate the TODO state of the current item among
  3476. @example
  3477. ,-> (unmarked) -> TODO -> DONE --.
  3478. '--------------------------------'
  3479. @end example
  3480. If TODO keywords have fast access keys (see @ref{Fast access to TODO
  3481. states}), you will be prompted for a TODO keyword through the fast selection
  3482. interface; this is the default behavior when
  3483. @code{org-use-fast-todo-selection} is non-@code{nil}.
  3484. The same rotation can also be done ``remotely'' from the timeline and agenda
  3485. buffers with the @kbd{t} command key (@pxref{Agenda commands}).
  3486. @orgkey{C-u C-c C-t}
  3487. When TODO keywords have no selection keys, select a specific keyword using
  3488. completion; otherwise force cycling through TODO states with no prompt. When
  3489. @code{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
  3490. selection interface.
  3491. @kindex S-@key{right}
  3492. @kindex S-@key{left}
  3493. @item S-@key{right} @ @r{/} @ S-@key{left}
  3494. @vindex org-treat-S-cursor-todo-selection-as-state-change
  3495. Select the following/preceding TODO state, similar to cycling. Useful
  3496. mostly if more than two TODO states are possible (@pxref{TODO
  3497. extensions}). See also @ref{Conflicts}, for a discussion of the interaction
  3498. with @code{shift-selection-mode}. See also the variable
  3499. @code{org-treat-S-cursor-todo-selection-as-state-change}.
  3500. @orgcmd{C-c / t,org-show-todo-tree}
  3501. @cindex sparse tree, for TODO
  3502. @vindex org-todo-keywords
  3503. View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
  3504. entire buffer, but shows all TODO items (with not-DONE state) and the
  3505. headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
  3506. / T}), search for a specific TODO@. You will be prompted for the keyword,
  3507. and you can also give a list of keywords like @code{KWD1|KWD2|...} to list
  3508. entries that match any one of these keywords. With a numeric prefix argument
  3509. N, show the tree for the Nth keyword in the option @code{org-todo-keywords}.
  3510. With two prefix arguments, find all TODO states, both un-done and done.
  3511. @orgcmd{C-c a t,org-todo-list}
  3512. Show the global TODO list. Collects the TODO items (with not-DONE states)
  3513. from all agenda files (@pxref{Agenda views}) into a single buffer. The new
  3514. buffer will be in @code{agenda-mode}, which provides commands to examine and
  3515. manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
  3516. @xref{Global TODO list}, for more information.
  3517. @orgcmd{S-M-@key{RET},org-insert-todo-heading}
  3518. Insert a new TODO entry below the current one.
  3519. @end table
  3520. @noindent
  3521. @vindex org-todo-state-tags-triggers
  3522. Changing a TODO state can also trigger tag changes. See the docstring of the
  3523. option @code{org-todo-state-tags-triggers} for details.
  3524. @node TODO extensions
  3525. @section Extended use of TODO keywords
  3526. @cindex extended TODO keywords
  3527. @vindex org-todo-keywords
  3528. By default, marked TODO entries have one of only two states: TODO and
  3529. DONE@. Org mode allows you to classify TODO items in more complex ways
  3530. with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
  3531. special setup, the TODO keyword system can work differently in different
  3532. files.
  3533. Note that @i{tags} are another way to classify headlines in general and
  3534. TODO items in particular (@pxref{Tags}).
  3535. @menu
  3536. * Workflow states:: From TODO to DONE in steps
  3537. * TODO types:: I do this, Fred does the rest
  3538. * Multiple sets in one file:: Mixing it all, and still finding your way
  3539. * Fast access to TODO states:: Single letter selection of a state
  3540. * Per-file keywords:: Different files, different requirements
  3541. * Faces for TODO keywords:: Highlighting states
  3542. * TODO dependencies:: When one task needs to wait for others
  3543. @end menu
  3544. @node Workflow states
  3545. @subsection TODO keywords as workflow states
  3546. @cindex TODO workflow
  3547. @cindex workflow states as TODO keywords
  3548. You can use TODO keywords to indicate different @emph{sequential} states
  3549. in the process of working on an item, for example@footnote{Changing
  3550. this variable only becomes effective after restarting Org mode in a
  3551. buffer.}:
  3552. @lisp
  3553. (setq org-todo-keywords
  3554. '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
  3555. @end lisp
  3556. The vertical bar separates the TODO keywords (states that @emph{need
  3557. action}) from the DONE states (which need @emph{no further action}). If
  3558. you don't provide the separator bar, the last state is used as the DONE
  3559. state.
  3560. @cindex completion, of TODO keywords
  3561. With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
  3562. to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
  3563. also use a numeric prefix argument to quickly select a specific state. For
  3564. example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
  3565. Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
  3566. define many keywords, you can use in-buffer completion
  3567. (@pxref{Completion}) or even a special one-key selection scheme
  3568. (@pxref{Fast access to TODO states}) to insert these words into the
  3569. buffer. Changing a TODO state can be logged with a timestamp, see
  3570. @ref{Tracking TODO state changes}, for more information.
  3571. @node TODO types
  3572. @subsection TODO keywords as types
  3573. @cindex TODO types
  3574. @cindex names as TODO keywords
  3575. @cindex types as TODO keywords
  3576. The second possibility is to use TODO keywords to indicate different
  3577. @emph{types} of action items. For example, you might want to indicate
  3578. that items are for ``work'' or ``home''. Or, when you work with several
  3579. people on a single project, you might want to assign action items
  3580. directly to persons, by using their names as TODO keywords. This would
  3581. be set up like this:
  3582. @lisp
  3583. (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
  3584. @end lisp
  3585. In this case, different keywords do not indicate a sequence, but rather
  3586. different types. So the normal work flow would be to assign a task to a
  3587. person, and later to mark it DONE@. Org mode supports this style by adapting
  3588. the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
  3589. @kbd{t} command in the timeline and agenda buffers.}. When used several
  3590. times in succession, it will still cycle through all names, in order to first
  3591. select the right type for a task. But when you return to the item after some
  3592. time and execute @kbd{C-c C-t} again, it will switch from any name directly
  3593. to DONE@. Use prefix arguments or completion to quickly select a specific
  3594. name. You can also review the items of a specific TODO type in a sparse tree
  3595. by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
  3596. Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
  3597. from all agenda files into a single buffer, you would use the numeric prefix
  3598. argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
  3599. @node Multiple sets in one file
  3600. @subsection Multiple keyword sets in one file
  3601. @cindex TODO keyword sets
  3602. Sometimes you may want to use different sets of TODO keywords in
  3603. parallel. For example, you may want to have the basic
  3604. @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
  3605. separate state indicating that an item has been canceled (so it is not
  3606. DONE, but also does not require action). Your setup would then look
  3607. like this:
  3608. @lisp
  3609. (setq org-todo-keywords
  3610. '((sequence "TODO" "|" "DONE")
  3611. (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
  3612. (sequence "|" "CANCELED")))
  3613. @end lisp
  3614. The keywords should all be different, this helps Org mode to keep track
  3615. of which subsequence should be used for a given entry. In this setup,
  3616. @kbd{C-c C-t} only operates within a subsequence, so it switches from
  3617. @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
  3618. (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
  3619. select the correct sequence. Besides the obvious ways like typing a
  3620. keyword or using completion, you may also apply the following commands:
  3621. @table @kbd
  3622. @kindex C-S-@key{right}
  3623. @kindex C-S-@key{left}
  3624. @kindex C-u C-u C-c C-t
  3625. @item C-u C-u C-c C-t
  3626. @itemx C-S-@key{right}
  3627. @itemx C-S-@key{left}
  3628. These keys jump from one TODO subset to the next. In the above example,
  3629. @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
  3630. @code{DONE} to @code{REPORT}, and any of the words in the second row to
  3631. @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
  3632. @code{shift-selection-mode} (@pxref{Conflicts}).
  3633. @kindex S-@key{right}
  3634. @kindex S-@key{left}
  3635. @item S-@key{right}
  3636. @itemx S-@key{left}
  3637. @kbd{S-@key{left}} and @kbd{S-@key{right}} and walk through @emph{all}
  3638. keywords from all sets, so for example @kbd{S-@key{right}} would switch
  3639. from @code{DONE} to @code{REPORT} in the example above. See also
  3640. @ref{Conflicts}, for a discussion of the interaction with
  3641. @code{shift-selection-mode}.
  3642. @end table
  3643. @node Fast access to TODO states
  3644. @subsection Fast access to TODO states
  3645. If you would like to quickly change an entry to an arbitrary TODO state
  3646. instead of cycling through the states, you can set up keys for single-letter
  3647. access to the states. This is done by adding the selection character after
  3648. each keyword, in parentheses@footnote{All characters are allowed except
  3649. @code{@@^!}, which have a special meaning here.}. For example:
  3650. @lisp
  3651. (setq org-todo-keywords
  3652. '((sequence "TODO(t)" "|" "DONE(d)")
  3653. (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
  3654. (sequence "|" "CANCELED(c)")))
  3655. @end lisp
  3656. @vindex org-fast-tag-selection-include-todo
  3657. If you then press @kbd{C-c C-t} followed by the selection key, the entry
  3658. will be switched to this state. @kbd{SPC} can be used to remove any TODO
  3659. keyword from an entry.@footnote{Check also the option
  3660. @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
  3661. state through the tags interface (@pxref{Setting tags}), in case you like to
  3662. mingle the two concepts. Note that this means you need to come up with
  3663. unique keys across both sets of keywords.}
  3664. @node Per-file keywords
  3665. @subsection Setting up keywords for individual files
  3666. @cindex keyword options
  3667. @cindex per-file keywords
  3668. @cindex #+TODO
  3669. @cindex #+TYP_TODO
  3670. @cindex #+SEQ_TODO
  3671. It can be very useful to use different aspects of the TODO mechanism in
  3672. different files. For file-local settings, you need to add special lines to
  3673. the file which set the keywords and interpretation for that file only. For
  3674. example, to set one of the two examples discussed above, you need one of the
  3675. following lines anywhere in the file:
  3676. @example
  3677. #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
  3678. @end example
  3679. @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
  3680. interpretation, but it means the same as @code{#+TODO}), or
  3681. @example
  3682. #+TYP_TODO: Fred Sara Lucy Mike | DONE
  3683. @end example
  3684. A setup for using several sets in parallel would be:
  3685. @example
  3686. #+TODO: TODO | DONE
  3687. #+TODO: REPORT BUG KNOWNCAUSE | FIXED
  3688. #+TODO: | CANCELED
  3689. @end example
  3690. @cindex completion, of option keywords
  3691. @kindex M-@key{TAB}
  3692. @noindent To make sure you are using the correct keyword, type
  3693. @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
  3694. @cindex DONE, final TODO keyword
  3695. Remember that the keywords after the vertical bar (or the last keyword
  3696. if no bar is there) must always mean that the item is DONE (although you
  3697. may use a different word). After changing one of these lines, use
  3698. @kbd{C-c C-c} with the cursor still in the line to make the changes
  3699. known to Org mode@footnote{Org mode parses these lines only when
  3700. Org mode is activated after visiting a file. @kbd{C-c C-c} with the
  3701. cursor in a line starting with @samp{#+} is simply restarting Org mode
  3702. for the current buffer.}.
  3703. @node Faces for TODO keywords
  3704. @subsection Faces for TODO keywords
  3705. @cindex faces, for TODO keywords
  3706. @vindex org-todo @r{(face)}
  3707. @vindex org-done @r{(face)}
  3708. @vindex org-todo-keyword-faces
  3709. Org mode highlights TODO keywords with special faces: @code{org-todo}
  3710. for keywords indicating that an item still has to be acted upon, and
  3711. @code{org-done} for keywords indicating that an item is finished. If
  3712. you are using more than 2 different states, you might want to use
  3713. special faces for some of them. This can be done using the option
  3714. @code{org-todo-keyword-faces}. For example:
  3715. @lisp
  3716. @group
  3717. (setq org-todo-keyword-faces
  3718. '(("TODO" . org-warning) ("STARTED" . "yellow")
  3719. ("CANCELED" . (:foreground "blue" :weight bold))))
  3720. @end group
  3721. @end lisp
  3722. While using a list with face properties as shown for CANCELED @emph{should}
  3723. work, this does not always seem to be the case. If necessary, define a
  3724. special face and use that. A string is interpreted as a color. The option
  3725. @code{org-faces-easy-properties} determines if that color is interpreted as a
  3726. foreground or a background color.
  3727. @node TODO dependencies
  3728. @subsection TODO dependencies
  3729. @cindex TODO dependencies
  3730. @cindex dependencies, of TODO states
  3731. @cindex TODO dependencies, NOBLOCKING
  3732. @vindex org-enforce-todo-dependencies
  3733. @cindex property, ORDERED
  3734. The structure of Org files (hierarchy and lists) makes it easy to define TODO
  3735. dependencies. Usually, a parent TODO task should not be marked DONE until
  3736. all subtasks (defined as children tasks) are marked as DONE@. And sometimes
  3737. there is a logical sequence to a number of (sub)tasks, so that one task
  3738. cannot be acted upon before all siblings above it are done. If you customize
  3739. the option @code{org-enforce-todo-dependencies}, Org will block entries
  3740. from changing state to DONE while they have children that are not DONE@.
  3741. Furthermore, if an entry has a property @code{ORDERED}, each of its children
  3742. will be blocked until all earlier siblings are marked DONE@. Here is an
  3743. example:
  3744. @example
  3745. * TODO Blocked until (two) is done
  3746. ** DONE one
  3747. ** TODO two
  3748. * Parent
  3749. :PROPERTIES:
  3750. :ORDERED: t
  3751. :END:
  3752. ** TODO a
  3753. ** TODO b, needs to wait for (a)
  3754. ** TODO c, needs to wait for (a) and (b)
  3755. @end example
  3756. You can ensure an entry is never blocked by using the @code{NOBLOCKING}
  3757. property:
  3758. @example
  3759. * This entry is never blocked
  3760. :PROPERTIES:
  3761. :NOBLOCKING: t
  3762. :END:
  3763. @end example
  3764. @table @kbd
  3765. @orgcmd{C-c C-x o,org-toggle-ordered-property}
  3766. @vindex org-track-ordered-property-with-tag
  3767. @cindex property, ORDERED
  3768. Toggle the @code{ORDERED} property of the current entry. A property is used
  3769. for this behavior because this should be local to the current entry, not
  3770. inherited like a tag. However, if you would like to @i{track} the value of
  3771. this property with a tag for better visibility, customize the option
  3772. @code{org-track-ordered-property-with-tag}.
  3773. @orgkey{C-u C-u C-u C-c C-t}
  3774. Change TODO state, circumventing any state blocking.
  3775. @end table
  3776. @vindex org-agenda-dim-blocked-tasks
  3777. If you set the option @code{org-agenda-dim-blocked-tasks}, TODO entries
  3778. that cannot be closed because of such dependencies will be shown in a dimmed
  3779. font or even made invisible in agenda views (@pxref{Agenda views}).
  3780. @cindex checkboxes and TODO dependencies
  3781. @vindex org-enforce-todo-dependencies
  3782. You can also block changes of TODO states by looking at checkboxes
  3783. (@pxref{Checkboxes}). If you set the option
  3784. @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
  3785. checkboxes will be blocked from switching to DONE.
  3786. If you need more complex dependency structures, for example dependencies
  3787. between entries in different trees or files, check out the contributed
  3788. module @file{org-depend.el}.
  3789. @page
  3790. @node Progress logging
  3791. @section Progress logging
  3792. @cindex progress logging
  3793. @cindex logging, of progress
  3794. Org mode can automatically record a timestamp and possibly a note when
  3795. you mark a TODO item as DONE, or even each time you change the state of
  3796. a TODO item. This system is highly configurable; settings can be on a
  3797. per-keyword basis and can be localized to a file or even a subtree. For
  3798. information on how to clock working time for a task, see @ref{Clocking
  3799. work time}.
  3800. @menu
  3801. * Closing items:: When was this entry marked DONE?
  3802. * Tracking TODO state changes:: When did the status change?
  3803. * Tracking your habits:: How consistent have you been?
  3804. @end menu
  3805. @node Closing items
  3806. @subsection Closing items
  3807. The most basic logging is to keep track of @emph{when} a certain TODO
  3808. item was finished. This is achieved with@footnote{The corresponding
  3809. in-buffer setting is: @code{#+STARTUP: logdone}}
  3810. @lisp
  3811. (setq org-log-done 'time)
  3812. @end lisp
  3813. @vindex org-closed-keep-when-no-todo
  3814. @noindent
  3815. Then each time you turn an entry from a TODO (not-done) state into any of the
  3816. DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
  3817. the headline. If you turn the entry back into a TODO item through further
  3818. state cycling, that line will be removed again. If you turn the entry back
  3819. to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line
  3820. will also be removed, unless you set @code{org-closed-keep-when-no-todo} to
  3821. non-@code{nil}. If you want to record a note along with the timestamp,
  3822. use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
  3823. lognotedone}.}
  3824. @lisp
  3825. (setq org-log-done 'note)
  3826. @end lisp
  3827. @noindent
  3828. You will then be prompted for a note, and that note will be stored below
  3829. the entry with a @samp{Closing Note} heading.
  3830. In the timeline (@pxref{Timeline}) and in the agenda
  3831. (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
  3832. display the TODO items with a @samp{CLOSED} timestamp on each day,
  3833. giving you an overview of what has been done.
  3834. @node Tracking TODO state changes
  3835. @subsection Tracking TODO state changes
  3836. @cindex drawer, for state change recording
  3837. @vindex org-log-states-order-reversed
  3838. @vindex org-log-into-drawer
  3839. @cindex property, LOG_INTO_DRAWER
  3840. When TODO keywords are used as workflow states (@pxref{Workflow states}), you
  3841. might want to keep track of when a state change occurred and maybe take a
  3842. note about this change. You can either record just a timestamp, or a
  3843. time-stamped note for a change. These records will be inserted after the
  3844. headline as an itemized list, newest first@footnote{See the option
  3845. @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
  3846. want to get the notes out of the way into a drawer (@pxref{Drawers}).
  3847. Customize @code{org-log-into-drawer} to get this behavior---the recommended
  3848. drawer for this is called @code{LOGBOOK}@footnote{Note that the
  3849. @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
  3850. show an entry---use @key{C-u SPC} to keep it folded here}. You can also
  3851. overrule the setting of this variable for a subtree by setting a
  3852. @code{LOG_INTO_DRAWER} property.
  3853. Since it is normally too much to record a note for every state, Org mode
  3854. expects configuration on a per-keyword basis for this. This is achieved by
  3855. adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
  3856. with timestamp) in parentheses after each keyword. For example, with the
  3857. setting
  3858. @lisp
  3859. (setq org-todo-keywords
  3860. '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
  3861. @end lisp
  3862. To record a timestamp without a note for TODO keywords configured with
  3863. @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
  3864. @noindent
  3865. @vindex org-log-done
  3866. You not only define global TODO keywords and fast access keys, but also
  3867. request that a time is recorded when the entry is set to
  3868. DONE@footnote{It is possible that Org mode will record two timestamps
  3869. when you are using both @code{org-log-done} and state change logging.
  3870. However, it will never prompt for two notes---if you have configured
  3871. both, the state change recording note will take precedence and cancel
  3872. the @samp{Closing Note}.}, and that a note is recorded when switching to
  3873. WAIT or CANCELED@. The setting for WAIT is even more special: the
  3874. @samp{!} after the slash means that in addition to the note taken when
  3875. entering the state, a timestamp should be recorded when @i{leaving} the
  3876. WAIT state, if and only if the @i{target} state does not configure
  3877. logging for entering it. So it has no effect when switching from WAIT
  3878. to DONE, because DONE is configured to record a timestamp only. But
  3879. when switching from WAIT back to TODO, the @samp{/!} in the WAIT
  3880. setting now triggers a timestamp even though TODO has no logging
  3881. configured.
  3882. You can use the exact same syntax for setting logging preferences local
  3883. to a buffer:
  3884. @example
  3885. #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
  3886. @end example
  3887. @cindex property, LOGGING
  3888. In order to define logging settings that are local to a subtree or a
  3889. single item, define a LOGGING property in this entry. Any non-empty
  3890. LOGGING property resets all logging settings to @code{nil}. You may then turn
  3891. on logging for this specific tree using STARTUP keywords like
  3892. @code{lognotedone} or @code{logrepeat}, as well as adding state specific
  3893. settings like @code{TODO(!)}. For example
  3894. @example
  3895. * TODO Log each state with only a time
  3896. :PROPERTIES:
  3897. :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
  3898. :END:
  3899. * TODO Only log when switching to WAIT, and when repeating
  3900. :PROPERTIES:
  3901. :LOGGING: WAIT(@@) logrepeat
  3902. :END:
  3903. * TODO No logging at all
  3904. :PROPERTIES:
  3905. :LOGGING: nil
  3906. :END:
  3907. @end example
  3908. @node Tracking your habits
  3909. @subsection Tracking your habits
  3910. @cindex habits
  3911. Org has the ability to track the consistency of a special category of TODOs,
  3912. called ``habits''. A habit has the following properties:
  3913. @enumerate
  3914. @item
  3915. You have enabled the @code{habits} module by customizing @code{org-modules}.
  3916. @item
  3917. The habit is a TODO item, with a TODO keyword representing an open state.
  3918. @item
  3919. The property @code{STYLE} is set to the value @code{habit}.
  3920. @item
  3921. The TODO has a scheduled date, usually with a @code{.+} style repeat
  3922. interval. A @code{++} style may be appropriate for habits with time
  3923. constraints, e.g., must be done on weekends, or a @code{+} style for an
  3924. unusual habit that can have a backlog, e.g., weekly reports.
  3925. @item
  3926. The TODO may also have minimum and maximum ranges specified by using the
  3927. syntax @samp{.+2d/3d}, which says that you want to do the task at least every
  3928. three days, but at most every two days.
  3929. @item
  3930. You must also have state logging for the @code{DONE} state enabled
  3931. (@pxref{Tracking TODO state changes}), in order for historical data to be
  3932. represented in the consistency graph. If it is not enabled it is not an
  3933. error, but the consistency graphs will be largely meaningless.
  3934. @end enumerate
  3935. To give you an idea of what the above rules look like in action, here's an
  3936. actual habit with some history:
  3937. @example
  3938. ** TODO Shave
  3939. SCHEDULED: <2009-10-17 Sat .+2d/4d>
  3940. :PROPERTIES:
  3941. :STYLE: habit
  3942. :LAST_REPEAT: [2009-10-19 Mon 00:36]
  3943. :END:
  3944. - State "DONE" from "TODO" [2009-10-15 Thu]
  3945. - State "DONE" from "TODO" [2009-10-12 Mon]
  3946. - State "DONE" from "TODO" [2009-10-10 Sat]
  3947. - State "DONE" from "TODO" [2009-10-04 Sun]
  3948. - State "DONE" from "TODO" [2009-10-02 Fri]
  3949. - State "DONE" from "TODO" [2009-09-29 Tue]
  3950. - State "DONE" from "TODO" [2009-09-25 Fri]
  3951. - State "DONE" from "TODO" [2009-09-19 Sat]
  3952. - State "DONE" from "TODO" [2009-09-16 Wed]
  3953. - State "DONE" from "TODO" [2009-09-12 Sat]
  3954. @end example
  3955. What this habit says is: I want to shave at most every 2 days (given by the
  3956. @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
  3957. today is the 15th, then the habit first appears in the agenda on Oct 17,
  3958. after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
  3959. after four days have elapsed.
  3960. What's really useful about habits is that they are displayed along with a
  3961. consistency graph, to show how consistent you've been at getting that task
  3962. done in the past. This graph shows every day that the task was done over the
  3963. past three weeks, with colors for each day. The colors used are:
  3964. @table @code
  3965. @item Blue
  3966. If the task wasn't to be done yet on that day.
  3967. @item Green
  3968. If the task could have been done on that day.
  3969. @item Yellow
  3970. If the task was going to be overdue the next day.
  3971. @item Red
  3972. If the task was overdue on that day.
  3973. @end table
  3974. In addition to coloring each day, the day is also marked with an asterisk if
  3975. the task was actually done that day, and an exclamation mark to show where
  3976. the current day falls in the graph.
  3977. There are several configuration variables that can be used to change the way
  3978. habits are displayed in the agenda.
  3979. @table @code
  3980. @item org-habit-graph-column
  3981. The buffer column at which the consistency graph should be drawn. This will
  3982. overwrite any text in that column, so it is a good idea to keep your habits'
  3983. titles brief and to the point.
  3984. @item org-habit-preceding-days
  3985. The amount of history, in days before today, to appear in consistency graphs.
  3986. @item org-habit-following-days
  3987. The number of days after today that will appear in consistency graphs.
  3988. @item org-habit-show-habits-only-for-today
  3989. If non-@code{nil}, only show habits in today's agenda view. This is set to true by
  3990. default.
  3991. @end table
  3992. Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
  3993. temporarily be disabled and they won't appear at all. Press @kbd{K} again to
  3994. bring them back. They are also subject to tag filtering, if you have habits
  3995. which should only be done in certain contexts, for example.
  3996. @node Priorities
  3997. @section Priorities
  3998. @cindex priorities
  3999. If you use Org mode extensively, you may end up with enough TODO items that
  4000. it starts to make sense to prioritize them. Prioritizing can be done by
  4001. placing a @emph{priority cookie} into the headline of a TODO item, like this
  4002. @example
  4003. *** TODO [#A] Write letter to Sam Fortune
  4004. @end example
  4005. @noindent
  4006. @vindex org-priority-faces
  4007. By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
  4008. @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
  4009. treated just like priority @samp{B}. Priorities make a difference only for
  4010. sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
  4011. have no inherent meaning to Org mode. The cookies can be highlighted with
  4012. special faces by customizing @code{org-priority-faces}.
  4013. Priorities can be attached to any outline node; they do not need to be TODO
  4014. items.
  4015. @table @kbd
  4016. @item @kbd{C-c ,}
  4017. @kindex @kbd{C-c ,}
  4018. @findex org-priority
  4019. Set the priority of the current headline (@command{org-priority}). The
  4020. command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
  4021. When you press @key{SPC} instead, the priority cookie is removed from the
  4022. headline. The priorities can also be changed ``remotely'' from the timeline
  4023. and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
  4024. @c
  4025. @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
  4026. @vindex org-priority-start-cycle-with-default
  4027. Increase/decrease priority of current headline@footnote{See also the option
  4028. @code{org-priority-start-cycle-with-default}.}. Note that these keys are
  4029. also used to modify timestamps (@pxref{Creating timestamps}). See also
  4030. @ref{Conflicts}, for a discussion of the interaction with
  4031. @code{shift-selection-mode}.
  4032. @end table
  4033. @vindex org-highest-priority
  4034. @vindex org-lowest-priority
  4035. @vindex org-default-priority
  4036. You can change the range of allowed priorities by setting the options
  4037. @code{org-highest-priority}, @code{org-lowest-priority}, and
  4038. @code{org-default-priority}. For an individual buffer, you may set
  4039. these values (highest, lowest, default) like this (please make sure that
  4040. the highest priority is earlier in the alphabet than the lowest
  4041. priority):
  4042. @cindex #+PRIORITIES
  4043. @example
  4044. #+PRIORITIES: A C B
  4045. @end example
  4046. @node Breaking down tasks
  4047. @section Breaking tasks down into subtasks
  4048. @cindex tasks, breaking down
  4049. @cindex statistics, for TODO items
  4050. @vindex org-agenda-todo-list-sublevels
  4051. It is often advisable to break down large tasks into smaller, manageable
  4052. subtasks. You can do this by creating an outline tree below a TODO item,
  4053. with detailed subtasks on the tree@footnote{To keep subtasks out of the
  4054. global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
  4055. the overview over the fraction of subtasks that are already completed, insert
  4056. either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
  4057. be updated each time the TODO status of a child changes, or when pressing
  4058. @kbd{C-c C-c} on the cookie. For example:
  4059. @example
  4060. * Organize Party [33%]
  4061. ** TODO Call people [1/2]
  4062. *** TODO Peter
  4063. *** DONE Sarah
  4064. ** TODO Buy food
  4065. ** DONE Talk to neighbor
  4066. @end example
  4067. @cindex property, COOKIE_DATA
  4068. If a heading has both checkboxes and TODO children below it, the meaning of
  4069. the statistics cookie become ambiguous. Set the property
  4070. @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
  4071. this issue.
  4072. @vindex org-hierarchical-todo-statistics
  4073. If you would like to have the statistics cookie count any TODO entries in the
  4074. subtree (not just direct children), configure
  4075. @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
  4076. include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
  4077. property.
  4078. @example
  4079. * Parent capturing statistics [2/20]
  4080. :PROPERTIES:
  4081. :COOKIE_DATA: todo recursive
  4082. :END:
  4083. @end example
  4084. If you would like a TODO entry to automatically change to DONE
  4085. when all children are done, you can use the following setup:
  4086. @example
  4087. (defun org-summary-todo (n-done n-not-done)
  4088. "Switch entry to DONE when all subentries are done, to TODO otherwise."
  4089. (let (org-log-done org-log-states) ; turn off logging
  4090. (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
  4091. (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
  4092. @end example
  4093. Another possibility is the use of checkboxes to identify (a hierarchy of) a
  4094. large number of subtasks (@pxref{Checkboxes}).
  4095. @node Checkboxes
  4096. @section Checkboxes
  4097. @cindex checkboxes
  4098. @vindex org-list-automatic-rules
  4099. Every item in a plain list@footnote{With the exception of description
  4100. lists. But you can allow it by modifying @code{org-list-automatic-rules}
  4101. accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
  4102. it with the string @samp{[ ]}. This feature is similar to TODO items
  4103. (@pxref{TODO items}), but is more lightweight. Checkboxes are not included
  4104. in the global TODO list, so they are often great to split a task into a
  4105. number of simple steps. Or you can use them in a shopping list. To toggle a
  4106. checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
  4107. @file{org-mouse.el}).
  4108. Here is an example of a checkbox list.
  4109. @example
  4110. * TODO Organize party [2/4]
  4111. - [-] call people [1/3]
  4112. - [ ] Peter
  4113. - [X] Sarah
  4114. - [ ] Sam
  4115. - [X] order food
  4116. - [ ] think about what music to play
  4117. - [X] talk to the neighbors
  4118. @end example
  4119. Checkboxes work hierarchically, so if a checkbox item has children that
  4120. are checkboxes, toggling one of the children checkboxes will make the
  4121. parent checkbox reflect if none, some, or all of the children are
  4122. checked.
  4123. @cindex statistics, for checkboxes
  4124. @cindex checkbox statistics
  4125. @cindex property, COOKIE_DATA
  4126. @vindex org-checkbox-hierarchical-statistics
  4127. The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
  4128. indicating how many checkboxes present in this entry have been checked off,
  4129. and the total number of checkboxes present. This can give you an idea on how
  4130. many checkboxes remain, even without opening a folded entry. The cookies can
  4131. be placed into a headline or into (the first line of) a plain list item.
  4132. Each cookie covers checkboxes of direct children structurally below the
  4133. headline/item on which the cookie appears@footnote{Set the option
  4134. @code{org-checkbox-hierarchical-statistics} if you want such cookies to
  4135. count all checkboxes below the cookie, not just those belonging to direct
  4136. children.}. You have to insert the cookie yourself by typing either
  4137. @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
  4138. result, as in the examples above. With @samp{[%]} you get information about
  4139. the percentage of checkboxes checked (in the above example, this would be
  4140. @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
  4141. count either checkboxes below the heading or TODO states of children, and it
  4142. will display whatever was changed last. Set the property @code{COOKIE_DATA}
  4143. to either @samp{checkbox} or @samp{todo} to resolve this issue.
  4144. @cindex blocking, of checkboxes
  4145. @cindex checkbox blocking
  4146. @cindex property, ORDERED
  4147. If the current outline node has an @code{ORDERED} property, checkboxes must
  4148. be checked off in sequence, and an error will be thrown if you try to check
  4149. off a box while there are unchecked boxes above it.
  4150. @noindent The following commands work with checkboxes:
  4151. @table @kbd
  4152. @orgcmd{C-c C-c,org-toggle-checkbox}
  4153. Toggle checkbox status or (with prefix arg) checkbox presence at point. With
  4154. a single prefix argument, add an empty checkbox or remove the current
  4155. one@footnote{@kbd{C-u C-c C-c} before the @emph{first} bullet in a list with
  4156. no checkbox will add checkboxes to the rest of the list.}. With a double
  4157. prefix argument, set it to @samp{[-]}, which is considered to be an
  4158. intermediate state.
  4159. @orgcmd{C-c C-x C-b,org-toggle-checkbox}
  4160. Toggle checkbox status or (with prefix arg) checkbox presence at point. With
  4161. double prefix argument, set it to @samp{[-]}, which is considered to be an
  4162. intermediate state.
  4163. @itemize @minus
  4164. @item
  4165. If there is an active region, toggle the first checkbox in the region
  4166. and set all remaining boxes to the same status as the first. With a prefix
  4167. arg, add or remove the checkbox for all items in the region.
  4168. @item
  4169. If the cursor is in a headline, toggle the state of the first checkbox in the
  4170. region between this headline and the next---so @emph{not} the entire
  4171. subtree---and propagate this new state to all other checkboxes in the same
  4172. area.
  4173. @item
  4174. If there is no active region, just toggle the checkbox at point.
  4175. @end itemize
  4176. @orgcmd{M-S-@key{RET},org-insert-todo-heading}
  4177. Insert a new item with a checkbox. This works only if the cursor is already
  4178. in a plain list item (@pxref{Plain lists}).
  4179. @orgcmd{C-c C-x o,org-toggle-ordered-property}
  4180. @vindex org-track-ordered-property-with-tag
  4181. @cindex property, ORDERED
  4182. Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
  4183. be checked off in sequence. A property is used for this behavior because
  4184. this should be local to the current entry, not inherited like a tag.
  4185. However, if you would like to @i{track} the value of this property with a tag
  4186. for better visibility, customize @code{org-track-ordered-property-with-tag}.
  4187. @orgcmd{C-c #,org-update-statistics-cookies}
  4188. Update the statistics cookie in the current outline entry. When called with
  4189. a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
  4190. updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
  4191. new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
  4192. changing TODO states. If you delete boxes/entries or add/change them by
  4193. hand, use this command to get things back into sync.
  4194. @end table
  4195. @node Tags
  4196. @chapter Tags
  4197. @cindex tags
  4198. @cindex headline tagging
  4199. @cindex matching, tags
  4200. @cindex sparse tree, tag based
  4201. An excellent way to implement labels and contexts for cross-correlating
  4202. information is to assign @i{tags} to headlines. Org mode has extensive
  4203. support for tags.
  4204. @vindex org-tag-faces
  4205. Every headline can contain a list of tags; they occur at the end of the
  4206. headline. Tags are normal words containing letters, numbers, @samp{_}, and
  4207. @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
  4208. @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
  4209. Tags will by default be in bold face with the same color as the headline.
  4210. You may specify special faces for specific tags using the option
  4211. @code{org-tag-faces}, in much the same way as you can for TODO keywords
  4212. (@pxref{Faces for TODO keywords}).
  4213. @menu
  4214. * Tag inheritance:: Tags use the tree structure of the outline
  4215. * Setting tags:: How to assign tags to a headline
  4216. * Tag hierarchy:: Create a hierarchy of tags
  4217. * Tag searches:: Searching for combinations of tags
  4218. @end menu
  4219. @node Tag inheritance
  4220. @section Tag inheritance
  4221. @cindex tag inheritance
  4222. @cindex inheritance, of tags
  4223. @cindex sublevels, inclusion into tags match
  4224. @i{Tags} make use of the hierarchical structure of outline trees. If a
  4225. heading has a certain tag, all subheadings will inherit the tag as
  4226. well. For example, in the list
  4227. @example
  4228. * Meeting with the French group :work:
  4229. ** Summary by Frank :boss:notes:
  4230. *** TODO Prepare slides for him :action:
  4231. @end example
  4232. @noindent
  4233. the final heading will have the tags @samp{:work:}, @samp{:boss:},
  4234. @samp{:notes:}, and @samp{:action:} even though the final heading is not
  4235. explicitly marked with all those tags. You can also set tags that all
  4236. entries in a file should inherit just as if these tags were defined in
  4237. a hypothetical level zero that surrounds the entire file. Use a line like
  4238. this@footnote{As with all these in-buffer settings, pressing @kbd{C-c C-c}
  4239. activates any changes in the line.}:
  4240. @cindex #+FILETAGS
  4241. @example
  4242. #+FILETAGS: :Peter:Boss:Secret:
  4243. @end example
  4244. @noindent
  4245. @vindex org-use-tag-inheritance
  4246. @vindex org-tags-exclude-from-inheritance
  4247. To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
  4248. To turn it off entirely, use @code{org-use-tag-inheritance}.
  4249. @vindex org-tags-match-list-sublevels
  4250. When a headline matches during a tags search while tag inheritance is turned
  4251. on, all the sublevels in the same tree will (for a simple match form) match
  4252. as well@footnote{This is only true if the search does not involve more
  4253. complex tests including properties (@pxref{Property searches}).}. The list
  4254. of matches may then become very long. If you only want to see the first tags
  4255. match in a subtree, configure @code{org-tags-match-list-sublevels} (not
  4256. recommended).
  4257. @vindex org-agenda-use-tag-inheritance
  4258. Tag inheritance is relevant when the agenda search tries to match a tag,
  4259. either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
  4260. types, @code{org-use-tag-inheritance} has no effect. Still, you may want to
  4261. have your tags correctly set in the agenda, so that tag filtering works fine,
  4262. with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control
  4263. this: the default value includes all agenda types, but setting this to @code{nil}
  4264. can really speed up agenda generation.
  4265. @node Setting tags
  4266. @section Setting tags
  4267. @cindex setting tags
  4268. @cindex tags, setting
  4269. @kindex M-@key{TAB}
  4270. Tags can simply be typed into the buffer at the end of a headline.
  4271. After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
  4272. also a special command for inserting tags:
  4273. @table @kbd
  4274. @orgcmd{C-c C-q,org-set-tags-command}
  4275. @cindex completion, of tags
  4276. @vindex org-tags-column
  4277. Enter new tags for the current headline. Org mode will either offer
  4278. completion or a special single-key interface for setting tags, see
  4279. below. After pressing @key{RET}, the tags will be inserted and aligned
  4280. to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
  4281. tags in the current buffer will be aligned to that column, just to make
  4282. things look nice. TAGS are automatically realigned after promotion,
  4283. demotion, and TODO state changes (@pxref{TODO basics}).
  4284. @orgcmd{C-c C-c,org-set-tags-command}
  4285. When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
  4286. @end table
  4287. @vindex org-tag-alist
  4288. Org supports tag insertion based on a @emph{list of tags}. By
  4289. default this list is constructed dynamically, containing all tags
  4290. currently used in the buffer. You may also globally specify a hard list
  4291. of tags with the variable @code{org-tag-alist}. Finally you can set
  4292. the default tags for a given file with lines like
  4293. @cindex #+TAGS
  4294. @example
  4295. #+TAGS: @@work @@home @@tennisclub
  4296. #+TAGS: laptop car pc sailboat
  4297. @end example
  4298. If you have globally defined your preferred set of tags using the
  4299. variable @code{org-tag-alist}, but would like to use a dynamic tag list
  4300. in a specific file, add an empty TAGS option line to that file:
  4301. @example
  4302. #+TAGS:
  4303. @end example
  4304. @vindex org-tag-persistent-alist
  4305. If you have a preferred set of tags that you would like to use in every file,
  4306. in addition to those defined on a per-file basis by TAGS option lines, then
  4307. you may specify a list of tags with the variable
  4308. @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
  4309. by adding a STARTUP option line to that file:
  4310. @example
  4311. #+STARTUP: noptag
  4312. @end example
  4313. By default Org mode uses the standard minibuffer completion facilities for
  4314. entering tags. However, it also implements another, quicker, tag selection
  4315. method called @emph{fast tag selection}. This allows you to select and
  4316. deselect tags with just a single key press. For this to work well you should
  4317. assign unique, case-sensitive, letters to most of your commonly used tags.
  4318. You can do this globally by configuring the variable @code{org-tag-alist} in
  4319. your Emacs init file. For example, you may find the need to tag many items
  4320. in different files with @samp{:@@home:}. In this case you can set something
  4321. like:
  4322. @lisp
  4323. (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
  4324. @end lisp
  4325. @noindent If the tag is only relevant to the file you are working on, then you
  4326. can instead set the TAGS option line as:
  4327. @example
  4328. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
  4329. @end example
  4330. @noindent The tags interface will show the available tags in a splash
  4331. window. If you want to start a new line after a specific tag, insert
  4332. @samp{\n} into the tag list
  4333. @example
  4334. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
  4335. @end example
  4336. @noindent or write them in two lines:
  4337. @example
  4338. #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
  4339. #+TAGS: laptop(l) pc(p)
  4340. @end example
  4341. @noindent
  4342. You can also group together tags that are mutually exclusive by using
  4343. braces, as in:
  4344. @example
  4345. #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
  4346. @end example
  4347. @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
  4348. and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
  4349. @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
  4350. these lines to activate any changes.
  4351. @noindent
  4352. To set these mutually exclusive groups in the variable @code{org-tag-alist},
  4353. you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
  4354. of the braces. Similarly, you can use @code{:newline} to indicate a line
  4355. break. The previous example would be set globally by the following
  4356. configuration:
  4357. @lisp
  4358. (setq org-tag-alist '((:startgroup . nil)
  4359. ("@@work" . ?w) ("@@home" . ?h)
  4360. ("@@tennisclub" . ?t)
  4361. (:endgroup . nil)
  4362. ("laptop" . ?l) ("pc" . ?p)))
  4363. @end lisp
  4364. If at least one tag has a selection key then pressing @kbd{C-c C-c} will
  4365. automatically present you with a special interface, listing inherited tags,
  4366. the tags of the current headline, and a list of all valid tags with
  4367. corresponding keys@footnote{Keys will automatically be assigned to tags which
  4368. have no configured keys.}.
  4369. Pressing keys assigned to tags will add or remove them from the list of tags
  4370. in the current line. Selecting a tag in a group of mutually exclusive tags
  4371. will turn off any other tags from that group.
  4372. In this interface, you can also use the following special keys:
  4373. @table @kbd
  4374. @kindex @key{TAB}
  4375. @item @key{TAB}
  4376. Enter a tag in the minibuffer, even if the tag is not in the predefined
  4377. list. You will be able to complete on all tags present in the buffer.
  4378. You can also add several tags: just separate them with a comma.
  4379. @kindex @key{SPC}
  4380. @item @key{SPC}
  4381. Clear all tags for this line.
  4382. @kindex @key{RET}
  4383. @item @key{RET}
  4384. Accept the modified set.
  4385. @item C-g
  4386. Abort without installing changes.
  4387. @item q
  4388. If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
  4389. @item !
  4390. Turn off groups of mutually exclusive tags. Use this to (as an
  4391. exception) assign several tags from such a group.
  4392. @item C-c
  4393. Toggle auto-exit after the next change (see below).
  4394. If you are using expert mode, the first @kbd{C-c} will display the
  4395. selection window.
  4396. @end table
  4397. @noindent
  4398. This method lets you assign tags to a headline with very few keys. With
  4399. the above setup, you could clear the current tags and set @samp{@@home},
  4400. @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
  4401. C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
  4402. @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
  4403. alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
  4404. @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
  4405. @key{RET} @key{RET}}.
  4406. @vindex org-fast-tag-selection-single-key
  4407. If you find that most of the time you need only a single key press to
  4408. modify your list of tags, set @code{org-fast-tag-selection-single-key}.
  4409. Then you no longer have to press @key{RET} to exit fast tag selection---it
  4410. will immediately exit after the first change. If you then occasionally
  4411. need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
  4412. selection process (in effect: start selection with @kbd{C-c C-c C-c}
  4413. instead of @kbd{C-c C-c}). If you set the variable to the value
  4414. @code{expert}, the special window is not even shown for single-key tag
  4415. selection, it comes up only when you press an extra @kbd{C-c}.
  4416. @node Tag hierarchy
  4417. @section Tag hierarchy
  4418. @cindex group tags
  4419. @cindex tags, groups
  4420. @cindex tag hierarchy
  4421. Tags can be defined in hierarchies. A tag can be defined as a @emph{group
  4422. tag} for a set of other tags. The group tag can be seen as the ``broader
  4423. term'' for its set of tags. Defining multiple @emph{group tags} and nesting
  4424. them creates a tag hierarchy.
  4425. One use-case is to create a taxonomy of terms (tags) that can be used to
  4426. classify nodes in a document or set of documents.
  4427. When you search for a group tag, it will return matches for all members in
  4428. the group and its subgroups. In an agenda view, filtering by a group tag
  4429. will display or hide headlines tagged with at least one of the members of the
  4430. group or any of its subgroups. This makes tag searches and filters even more
  4431. flexible.
  4432. You can set group tags by using brackets and inserting a colon between the
  4433. group tag and its related tags---beware that all whitespaces are mandatory so
  4434. that Org can parse this line correctly:
  4435. @example
  4436. #+TAGS: [ GTD : Control Persp ]
  4437. @end example
  4438. In this example, @samp{GTD} is the @emph{group tag} and it is related to two
  4439. other tags: @samp{Control}, @samp{Persp}. Defining @samp{Control} and
  4440. @samp{Persp} as group tags creates an hierarchy of tags:
  4441. @example
  4442. #+TAGS: [ Control : Context Task ]
  4443. #+TAGS: [ Persp : Vision Goal AOF Project ]
  4444. @end example
  4445. That can conceptually be seen as a hierarchy of tags:
  4446. @example
  4447. - GTD
  4448. - Persp
  4449. - Vision
  4450. - Goal
  4451. - AOF
  4452. - Project
  4453. - Control
  4454. - Context
  4455. - Task
  4456. @end example
  4457. You can use the @code{:startgrouptag}, @code{:grouptags} and
  4458. @code{:endgrouptag} keyword directly when setting @code{org-tag-alist}
  4459. directly:
  4460. @lisp
  4461. (setq org-tag-alist '((:startgrouptag)
  4462. ("GTD")
  4463. (:grouptags)
  4464. ("Control")
  4465. ("Persp")
  4466. (:endgrouptag)
  4467. (:startgrouptag)
  4468. ("Control")
  4469. (:grouptags)
  4470. ("Context")
  4471. ("Task")
  4472. (:endgrouptag)))
  4473. @end lisp
  4474. The tags in a group can be mutually exclusive if using the same group syntax
  4475. as is used for grouping mutually exclusive tags together; using curly
  4476. brackets.
  4477. @example
  4478. #+TAGS: @{ Context : @@Home @@Work @@Call @}
  4479. @end example
  4480. When setting @code{org-tag-alist} you can use @code{:startgroup} &
  4481. @code{:endgroup} instead of @code{:startgrouptag} & @code{:endgrouptag} to
  4482. make the tags mutually exclusive.
  4483. Furthermore, the members of a @emph{group tag} can also be regular
  4484. expressions, creating the possibility of a more dynamic and rule-based
  4485. tag structure. The regular expressions in the group must be specified
  4486. within @{ @}. Here is an expanded example:
  4487. @example
  4488. #+TAGS: [ Vision : @{V@@@.+@} ]
  4489. #+TAGS: [ Goal : @{G@@@.+@} ]
  4490. #+TAGS: [ AOF : @{AOF@@@.+@} ]
  4491. #+TAGS: [ Project : @{P@@@.+@} ]
  4492. @end example
  4493. Searching for the tag @samp{Project} will now list all tags also including
  4494. regular expression matches for @samp{P@@@.+}, and similarly for tag searches on
  4495. @samp{Vision}, @samp{Goal} and @samp{AOF}. For example, this would work well
  4496. for a project tagged with a common project-identifier, e.g. @samp{P@@2014_OrgTags}.
  4497. @kindex C-c C-x q
  4498. @vindex org-group-tags
  4499. If you want to ignore group tags temporarily, toggle group tags support
  4500. with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. If you
  4501. want to disable tag groups completely, set @code{org-group-tags} to @code{nil}.
  4502. @node Tag searches
  4503. @section Tag searches
  4504. @cindex tag searches
  4505. @cindex searching for tags
  4506. Once a system of tags has been set up, it can be used to collect related
  4507. information into special lists.
  4508. @table @kbd
  4509. @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
  4510. Create a sparse tree with all headlines matching a tags/property/TODO search.
  4511. With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  4512. @xref{Matching tags and properties}.
  4513. @orgcmd{C-c a m,org-tags-view}
  4514. Create a global list of tag matches from all agenda files. @xref{Matching
  4515. tags and properties}.
  4516. @orgcmd{C-c a M,org-tags-view}
  4517. @vindex org-tags-match-list-sublevels
  4518. Create a global list of tag matches from all agenda files, but check
  4519. only TODO items and force checking subitems (see the option
  4520. @code{org-tags-match-list-sublevels}).
  4521. @end table
  4522. These commands all prompt for a match string which allows basic Boolean logic
  4523. like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
  4524. @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
  4525. tagged as @samp{Kathy} or @samp{Sally}. The full syntax of the search string
  4526. is rich and allows also matching against TODO keywords, entry levels and
  4527. properties. For a complete description with many examples, see @ref{Matching
  4528. tags and properties}.
  4529. @node Properties and columns
  4530. @chapter Properties and columns
  4531. @cindex properties
  4532. A property is a key-value pair associated with an entry. Properties can be
  4533. set so they are associated with a single entry, with every entry in a tree,
  4534. or with every entry in an Org mode file.
  4535. There are two main applications for properties in Org mode. First,
  4536. properties are like tags, but with a value. Imagine maintaining a file where
  4537. you document bugs and plan releases for a piece of software. Instead of
  4538. using tags like @code{:release_1:}, @code{:release_2:}, you can use a
  4539. property, say @code{:Release:}, that in different subtrees has different
  4540. values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
  4541. implement (very basic) database capabilities in an Org buffer. Imagine
  4542. keeping track of your music CDs, where properties could be things such as the
  4543. album, artist, date of release, number of tracks, and so on.
  4544. Properties can be conveniently edited and viewed in column view
  4545. (@pxref{Column view}).
  4546. @menu
  4547. * Property syntax:: How properties are spelled out
  4548. * Special properties:: Access to other Org mode features
  4549. * Property searches:: Matching property values
  4550. * Property inheritance:: Passing values down the tree
  4551. * Column view:: Tabular viewing and editing
  4552. * Property API:: Properties for Lisp programmers
  4553. @end menu
  4554. @node Property syntax
  4555. @section Property syntax
  4556. @cindex property syntax
  4557. @cindex drawer, for properties
  4558. Properties are key-value pairs. When they are associated with a single entry
  4559. or with a tree they need to be inserted into a special drawer
  4560. (@pxref{Drawers}) with the name @code{PROPERTIES}, which has to be located
  4561. right below a headline, and its planning line (@pxref{Deadlines and
  4562. scheduling}) when applicable. Each property is specified on a single line,
  4563. with the key (surrounded by colons) first, and the value after it. Keys are
  4564. case-insensitives. Here is an example:
  4565. @example
  4566. * CD collection
  4567. ** Classic
  4568. *** Goldberg Variations
  4569. :PROPERTIES:
  4570. :Title: Goldberg Variations
  4571. :Composer: J.S. Bach
  4572. :Artist: Glen Gould
  4573. :Publisher: Deutsche Grammophon
  4574. :NDisks: 1
  4575. :END:
  4576. @end example
  4577. Depending on the value of @code{org-use-property-inheritance}, a property set
  4578. this way will either be associated with a single entry, or the subtree
  4579. defined by the entry, see @ref{Property inheritance}.
  4580. You may define the allowed values for a particular property @samp{:Xyz:}
  4581. by setting a property @samp{:Xyz_ALL:}. This special property is
  4582. @emph{inherited}, so if you set it in a level 1 entry, it will apply to
  4583. the entire tree. When allowed values are defined, setting the
  4584. corresponding property becomes easier and is less prone to typing
  4585. errors. For the example with the CD collection, we can predefine
  4586. publishers and the number of disks in a box like this:
  4587. @example
  4588. * CD collection
  4589. :PROPERTIES:
  4590. :NDisks_ALL: 1 2 3 4
  4591. :Publisher_ALL: "Deutsche Grammophon" Philips EMI
  4592. :END:
  4593. @end example
  4594. If you want to set properties that can be inherited by any entry in a
  4595. file, use a line like
  4596. @cindex property, _ALL
  4597. @cindex #+PROPERTY
  4598. @example
  4599. #+PROPERTY: NDisks_ALL 1 2 3 4
  4600. @end example
  4601. Contrary to properties set from a special drawer, you have to refresh the
  4602. buffer with @kbd{C-c C-c} to activate this change.
  4603. If you want to add to the value of an existing property, append a @code{+} to
  4604. the property name. The following results in the property @code{var} having
  4605. the value ``foo=1 bar=2''.
  4606. @cindex property, +
  4607. @example
  4608. #+PROPERTY: var foo=1
  4609. #+PROPERTY: var+ bar=2
  4610. @end example
  4611. It is also possible to add to the values of inherited properties. The
  4612. following results in the @code{genres} property having the value ``Classic
  4613. Baroque'' under the @code{Goldberg Variations} subtree.
  4614. @cindex property, +
  4615. @example
  4616. * CD collection
  4617. ** Classic
  4618. :PROPERTIES:
  4619. :GENRES: Classic
  4620. :END:
  4621. *** Goldberg Variations
  4622. :PROPERTIES:
  4623. :Title: Goldberg Variations
  4624. :Composer: J.S. Bach
  4625. :Artist: Glen Gould
  4626. :Publisher: Deutsche Grammophon
  4627. :NDisks: 1
  4628. :GENRES+: Baroque
  4629. :END:
  4630. @end example
  4631. Note that a property can only have one entry per Drawer.
  4632. @vindex org-global-properties
  4633. Property values set with the global variable
  4634. @code{org-global-properties} can be inherited by all entries in all
  4635. Org files.
  4636. @noindent
  4637. The following commands help to work with properties:
  4638. @table @kbd
  4639. @orgcmd{M-@key{TAB},pcomplete}
  4640. After an initial colon in a line, complete property keys. All keys used
  4641. in the current file will be offered as possible completions.
  4642. @orgcmd{C-c C-x p,org-set-property}
  4643. Set a property. This prompts for a property name and a value. If
  4644. necessary, the property drawer is created as well.
  4645. @item C-u M-x org-insert-drawer RET
  4646. @cindex org-insert-drawer
  4647. Insert a property drawer into the current entry. The drawer will be
  4648. inserted early in the entry, but after the lines with planning
  4649. information like deadlines.
  4650. @orgcmd{C-c C-c,org-property-action}
  4651. With the cursor in a property drawer, this executes property commands.
  4652. @orgcmd{C-c C-c s,org-set-property}
  4653. Set a property in the current entry. Both the property and the value
  4654. can be inserted using completion.
  4655. @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
  4656. Switch property at point to the next/previous allowed value.
  4657. @orgcmd{C-c C-c d,org-delete-property}
  4658. Remove a property from the current entry.
  4659. @orgcmd{C-c C-c D,org-delete-property-globally}
  4660. Globally remove a property, from all entries in the current file.
  4661. @orgcmd{C-c C-c c,org-compute-property-at-point}
  4662. Compute the property at point, using the operator and scope from the
  4663. nearest column format definition.
  4664. @end table
  4665. @node Special properties
  4666. @section Special properties
  4667. @cindex properties, special
  4668. Special properties provide an alternative access method to Org mode features,
  4669. like the TODO state or the priority of an entry, discussed in the previous
  4670. chapters. This interface exists so that you can include these states in
  4671. a column view (@pxref{Column view}), or to use them in queries. The
  4672. following property names are special and should not be used as keys in the
  4673. properties drawer:
  4674. @cindex property, special, ALLTAGS
  4675. @cindex property, special, BLOCKED
  4676. @cindex property, special, CLOCKSUM
  4677. @cindex property, special, CLOCKSUM_T
  4678. @cindex property, special, CLOSED
  4679. @cindex property, special, DEADLINE
  4680. @cindex property, special, FILE
  4681. @cindex property, special, ITEM
  4682. @cindex property, special, PRIORITY
  4683. @cindex property, special, SCHEDULED
  4684. @cindex property, special, TAGS
  4685. @cindex property, special, TIMESTAMP
  4686. @cindex property, special, TIMESTAMP_IA
  4687. @cindex property, special, TODO
  4688. @example
  4689. ALLTAGS @r{All tags, including inherited ones.}
  4690. BLOCKED @r{"t" if task is currently blocked by children or siblings.}
  4691. CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
  4692. @r{must be run first to compute the values in the current buffer.}
  4693. CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
  4694. @r{@code{org-clock-sum-today} must be run first to compute the}
  4695. @r{values in the current buffer.}
  4696. CLOSED @r{When was this entry closed?}
  4697. DEADLINE @r{The deadline time string, without the angular brackets.}
  4698. FILE @r{The filename the entry is located in.}
  4699. ITEM @r{The headline of the entry.}
  4700. PRIORITY @r{The priority of the entry, a string with a single letter.}
  4701. SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
  4702. TAGS @r{The tags defined directly in the headline.}
  4703. TIMESTAMP @r{The first keyword-less timestamp in the entry.}
  4704. TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
  4705. TODO @r{The TODO keyword of the entry.}
  4706. @end example
  4707. @node Property searches
  4708. @section Property searches
  4709. @cindex properties, searching
  4710. @cindex searching, of properties
  4711. To create sparse trees and special lists with selection based on properties,
  4712. the same commands are used as for tag searches (@pxref{Tag searches}).
  4713. @table @kbd
  4714. @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
  4715. Create a sparse tree with all matching entries. With a
  4716. @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  4717. @orgcmd{C-c a m,org-tags-view}
  4718. Create a global list of tag/property matches from all agenda files.
  4719. @xref{Matching tags and properties}.
  4720. @orgcmd{C-c a M,org-tags-view}
  4721. @vindex org-tags-match-list-sublevels
  4722. Create a global list of tag matches from all agenda files, but check
  4723. only TODO items and force checking of subitems (see the option
  4724. @code{org-tags-match-list-sublevels}).
  4725. @end table
  4726. The syntax for the search string is described in @ref{Matching tags and
  4727. properties}.
  4728. There is also a special command for creating sparse trees based on a
  4729. single property:
  4730. @table @kbd
  4731. @orgkey{C-c / p}
  4732. Create a sparse tree based on the value of a property. This first
  4733. prompts for the name of a property, and then for a value. A sparse tree
  4734. is created with all entries that define this property with the given
  4735. value. If you enclose the value in curly braces, it is interpreted as
  4736. a regular expression and matched against the property values.
  4737. @end table
  4738. @node Property inheritance
  4739. @section Property Inheritance
  4740. @cindex properties, inheritance
  4741. @cindex inheritance, of properties
  4742. @vindex org-use-property-inheritance
  4743. The outline structure of Org mode documents lends itself to an
  4744. inheritance model of properties: if the parent in a tree has a certain
  4745. property, the children can inherit this property. Org mode does not
  4746. turn this on by default, because it can slow down property searches
  4747. significantly and is often not needed. However, if you find inheritance
  4748. useful, you can turn it on by setting the variable
  4749. @code{org-use-property-inheritance}. It may be set to @code{t} to make
  4750. all properties inherited from the parent, to a list of properties
  4751. that should be inherited, or to a regular expression that matches
  4752. inherited properties. If a property has the value @code{nil}, this is
  4753. interpreted as an explicit undefine of the property, so that inheritance
  4754. search will stop at this value and return @code{nil}.
  4755. Org mode has a few properties for which inheritance is hard-coded, at
  4756. least for the special applications for which they are used:
  4757. @cindex property, COLUMNS
  4758. @table @code
  4759. @item COLUMNS
  4760. The @code{:COLUMNS:} property defines the format of column view
  4761. (@pxref{Column view}). It is inherited in the sense that the level
  4762. where a @code{:COLUMNS:} property is defined is used as the starting
  4763. point for a column view table, independently of the location in the
  4764. subtree from where columns view is turned on.
  4765. @item CATEGORY
  4766. @cindex property, CATEGORY
  4767. For agenda view, a category set through a @code{:CATEGORY:} property
  4768. applies to the entire subtree.
  4769. @item ARCHIVE
  4770. @cindex property, ARCHIVE
  4771. For archiving, the @code{:ARCHIVE:} property may define the archive
  4772. location for the entire subtree (@pxref{Moving subtrees}).
  4773. @item LOGGING
  4774. @cindex property, LOGGING
  4775. The LOGGING property may define logging settings for an entry or a
  4776. subtree (@pxref{Tracking TODO state changes}).
  4777. @end table
  4778. @node Column view
  4779. @section Column view
  4780. A great way to view and edit properties in an outline tree is
  4781. @emph{column view}. In column view, each outline node is turned into a
  4782. table row. Columns in this table provide access to properties of the
  4783. entries. Org mode implements columns by overlaying a tabular structure
  4784. over the headline of each item. While the headlines have been turned
  4785. into a table row, you can still change the visibility of the outline
  4786. tree. For example, you get a compact table by switching to CONTENTS
  4787. view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
  4788. is active), but you can still open, read, and edit the entry below each
  4789. headline. Or, you can switch to column view after executing a sparse
  4790. tree command and in this way get a table only for the selected items.
  4791. Column view also works in agenda buffers (@pxref{Agenda views}) where
  4792. queries have collected selected items, possibly from a number of files.
  4793. @menu
  4794. * Defining columns:: The COLUMNS format property
  4795. * Using column view:: How to create and use column view
  4796. * Capturing column view:: A dynamic block for column view
  4797. @end menu
  4798. @node Defining columns
  4799. @subsection Defining columns
  4800. @cindex column view, for properties
  4801. @cindex properties, column view
  4802. Setting up a column view first requires defining the columns. This is
  4803. done by defining a column format line.
  4804. @menu
  4805. * Scope of column definitions:: Where defined, where valid?
  4806. * Column attributes:: Appearance and content of a column
  4807. @end menu
  4808. @node Scope of column definitions
  4809. @subsubsection Scope of column definitions
  4810. To define a column format for an entire file, use a line like
  4811. @cindex #+COLUMNS
  4812. @example
  4813. #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  4814. @end example
  4815. To specify a format that only applies to a specific tree, add a
  4816. @code{:COLUMNS:} property to the top node of that tree, for example:
  4817. @example
  4818. ** Top node for columns view
  4819. :PROPERTIES:
  4820. :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  4821. :END:
  4822. @end example
  4823. If a @code{:COLUMNS:} property is present in an entry, it defines columns
  4824. for the entry itself, and for the entire subtree below it. Since the
  4825. column definition is part of the hierarchical structure of the document,
  4826. you can define columns on level 1 that are general enough for all
  4827. sublevels, and more specific columns further down, when you edit a
  4828. deeper part of the tree.
  4829. @node Column attributes
  4830. @subsubsection Column attributes
  4831. A column definition sets the attributes of a column. The general
  4832. definition looks like this:
  4833. @example
  4834. %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
  4835. @end example
  4836. @noindent
  4837. Except for the percent sign and the property name, all items are
  4838. optional. The individual parts have the following meaning:
  4839. @example
  4840. @var{width} @r{An integer specifying the width of the column in characters.}
  4841. @r{If omitted, the width will be determined automatically.}
  4842. @var{property} @r{The property that should be edited in this column.}
  4843. @r{Special properties representing meta data are allowed here}
  4844. @r{as well (@pxref{Special properties})}
  4845. @var{title} @r{The header text for the column. If omitted, the property}
  4846. @r{name is used.}
  4847. @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
  4848. @r{parent nodes are computed from the children@footnote{If
  4849. more than one summary type apply to the property, the parent
  4850. values are computed according to the first of them.}.}
  4851. @r{Supported summary types are:}
  4852. @{+@} @r{Sum numbers in this column.}
  4853. @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
  4854. @{$@} @r{Currency, short for @samp{+;%.2f}.}
  4855. @{min@} @r{Smallest number in column.}
  4856. @{max@} @r{Largest number.}
  4857. @{mean@} @r{Arithmetic mean of numbers.}
  4858. @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
  4859. @{X/@} @r{Checkbox status, @samp{[n/m]}.}
  4860. @{X%@} @r{Checkbox status, @samp{[n%]}.}
  4861. @{:@} @r{Sum times, HH:MM, plain numbers are
  4862. hours@footnote{A time can also be a duration, using effort
  4863. modifiers defined in @code{org-effort-durations}, e.g.,
  4864. @samp{3d 1h}. If any value in the column is as such, the
  4865. summary will also be an effort duration.}.}
  4866. @{:min@} @r{Smallest time value in column.}
  4867. @{:max@} @r{Largest time value.}
  4868. @{:mean@} @r{Arithmetic mean of time values.}
  4869. @{@@min@} @r{Minimum age@footnote{An age is defined as
  4870. a duration since a given time-stamp (@pxref{Timestamps}). It
  4871. can also be expressed as days, hours, minutes and seconds,
  4872. identified by @samp{d}, @samp{h}, @samp{m} and @samp{s}
  4873. suffixes, all mandatory, e.g., @samp{0d 13h 0m 10s}.} (in
  4874. days/hours/mins/seconds).}
  4875. @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
  4876. @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
  4877. @{est+@} @r{Add @samp{low-high} estimates.}
  4878. @end example
  4879. The @code{est+} summary type requires further explanation. It is used for
  4880. combining estimates, expressed as @samp{low-high} ranges or plain numbers.
  4881. For example, instead of estimating a particular task will take 5 days, you
  4882. might estimate it as 5--6 days if you're fairly confident you know how much
  4883. work is required, or 1--10 days if you don't really know what needs to be
  4884. done. Both ranges average at 5.5 days, but the first represents a more
  4885. predictable delivery.
  4886. When combining a set of such estimates, simply adding the lows and highs
  4887. produces an unrealistically wide result. Instead, @code{est+} adds the
  4888. statistical mean and variance of the sub-tasks, generating a final estimate
  4889. from the sum. For example, suppose you had ten tasks, each of which was
  4890. estimated at 0.5 to 2 days of work. Straight addition produces an estimate
  4891. of 5 to 20 days, representing what to expect if everything goes either
  4892. extremely well or extremely poorly. In contrast, @code{est+} estimates the
  4893. full job more realistically, at 10--15 days.
  4894. Numbers are right-aligned when a format specifier with an explicit width like
  4895. @code{%5d} or @code{%5.1f} is used.
  4896. @vindex org-columns-summary-types
  4897. You can also define custom summary types by setting
  4898. @code{org-columns-summary-types}, which see.
  4899. Here is an example for a complete columns definition, along with allowed
  4900. values.
  4901. @example
  4902. :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.}
  4903. %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
  4904. :Owner_ALL: Tammy Mark Karl Lisa Don
  4905. :Status_ALL: "In progress" "Not started yet" "Finished" ""
  4906. :Approved_ALL: "[ ]" "[X]"
  4907. @end example
  4908. @noindent
  4909. The first column, @samp{%25ITEM}, means the first 25 characters of the
  4910. item itself, i.e., of the headline. You probably always should start the
  4911. column definition with the @samp{ITEM} specifier. The other specifiers
  4912. create columns @samp{Owner} with a list of names as allowed values, for
  4913. @samp{Status} with four different possible values, and for a checkbox
  4914. field @samp{Approved}. When no width is given after the @samp{%}
  4915. character, the column will be exactly as wide as it needs to be in order
  4916. to fully display all values. The @samp{Approved} column does have a
  4917. modified title (@samp{Approved?}, with a question mark). Summaries will
  4918. be created for the @samp{Time_Estimate} column by adding time duration
  4919. expressions like HH:MM, and for the @samp{Approved} column, by providing
  4920. an @samp{[X]} status if all children have been checked. The
  4921. @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
  4922. sums of CLOCK intervals in the subtree, either for all clocks or just for
  4923. today.
  4924. @node Using column view
  4925. @subsection Using column view
  4926. @table @kbd
  4927. @tsubheading{Turning column view on and off}
  4928. @orgcmd{C-c C-x C-c,org-columns}
  4929. @vindex org-columns-default-format
  4930. Turn on column view. If the cursor is before the first headline in the file,
  4931. or the function called with the universal prefix argument, column view is
  4932. turned on for the entire file, using the @code{#+COLUMNS} definition. If the
  4933. cursor is somewhere inside the outline, this command searches the hierarchy,
  4934. up from point, for a @code{:COLUMNS:} property that defines a format. When
  4935. one is found, the column view table is established for the tree starting at
  4936. the entry that contains the @code{:COLUMNS:} property. If no such property
  4937. is found, the format is taken from the @code{#+COLUMNS} line or from the
  4938. variable @code{org-columns-default-format}, and column view is established
  4939. for the current entry and its subtree.
  4940. @orgcmd{r,org-columns-redo}
  4941. Recreate the column view, to include recent changes made in the buffer.
  4942. @orgcmd{g,org-columns-redo}
  4943. Same as @kbd{r}.
  4944. @orgcmd{q,org-columns-quit}
  4945. Exit column view.
  4946. @tsubheading{Editing values}
  4947. @item @key{left} @key{right} @key{up} @key{down}
  4948. Move through the column view from field to field.
  4949. @kindex S-@key{left}
  4950. @kindex S-@key{right}
  4951. @item S-@key{left}/@key{right}
  4952. Switch to the next/previous allowed value of the field. For this, you
  4953. have to have specified allowed values for a property.
  4954. @item 1..9,0
  4955. Directly select the Nth allowed value, @kbd{0} selects the 10th value.
  4956. @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
  4957. Same as @kbd{S-@key{left}/@key{right}}
  4958. @orgcmd{e,org-columns-edit-value}
  4959. Edit the property at point. For the special properties, this will
  4960. invoke the same interface that you normally use to change that
  4961. property. For example, when editing a TAGS property, the tag completion
  4962. or fast selection interface will pop up.
  4963. @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
  4964. When there is a checkbox at point, toggle it.
  4965. @orgcmd{v,org-columns-show-value}
  4966. View the full value of this property. This is useful if the width of
  4967. the column is smaller than that of the value.
  4968. @orgcmd{a,org-columns-edit-allowed}
  4969. Edit the list of allowed values for this property. If the list is found
  4970. in the hierarchy, the modified value is stored there. If no list is
  4971. found, the new value is stored in the first entry that is part of the
  4972. current column view.
  4973. @tsubheading{Modifying the table structure}
  4974. @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
  4975. Make the column narrower/wider by one character.
  4976. @orgcmd{S-M-@key{right},org-columns-new}
  4977. Insert a new column, to the left of the current column.
  4978. @orgcmd{S-M-@key{left},org-columns-delete}
  4979. Delete the current column.
  4980. @end table
  4981. @node Capturing column view
  4982. @subsection Capturing column view
  4983. Since column view is just an overlay over a buffer, it cannot be
  4984. exported or printed directly. If you want to capture a column view, use
  4985. a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
  4986. of this block looks like this:
  4987. @cindex #+BEGIN, columnview
  4988. @example
  4989. * The column view
  4990. #+BEGIN: columnview :hlines 1 :id "label"
  4991. #+END:
  4992. @end example
  4993. @noindent This dynamic block has the following parameters:
  4994. @table @code
  4995. @item :id
  4996. This is the most important parameter. Column view is a feature that is
  4997. often localized to a certain (sub)tree, and the capture block might be
  4998. at a different location in the file. To identify the tree whose view to
  4999. capture, you can use 4 values:
  5000. @cindex property, ID
  5001. @example
  5002. local @r{use the tree in which the capture block is located}
  5003. global @r{make a global view, including all headings in the file}
  5004. "file:@var{path-to-file}"
  5005. @r{run column view at the top of this file}
  5006. "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
  5007. @r{property with the value @i{label}. You can use}
  5008. @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
  5009. @r{the current entry and copy it to the kill-ring.}
  5010. @end example
  5011. @item :hlines
  5012. When @code{t}, insert an hline after every line. When a number @var{N}, insert
  5013. an hline before each headline with level @code{<= @var{N}}.
  5014. @item :vlines
  5015. When set to @code{t}, force column groups to get vertical lines.
  5016. @item :maxlevel
  5017. When set to a number, don't capture entries below this level.
  5018. @item :skip-empty-rows
  5019. When set to @code{t}, skip rows where the only non-empty specifier of the
  5020. column view is @code{ITEM}.
  5021. @item :indent
  5022. When non-@code{nil}, indent each @code{ITEM} field according to its level.
  5023. @end table
  5024. @noindent
  5025. The following commands insert or update the dynamic block:
  5026. @table @kbd