org.texi 394 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953
  1. \input texinfo
  2. @c %**start of header
  3. @setfilename ../../info/org
  4. @settitle The Org Manual
  5. @set VERSION 6.10pre01
  6. @set DATE October 2008
  7. @dircategory Emacs
  8. @direntry
  9. * Org Mode: (org). Outline-based notes management and organizer
  10. @end direntry
  11. @c Version and Contact Info
  12. @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
  13. @set AUTHOR Carsten Dominik
  14. @set MAINTAINER Carsten Dominik
  15. @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
  16. @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
  17. @c %**end of header
  18. @finalout
  19. @c Macro definitions
  20. @c Subheadings inside a table.
  21. @macro tsubheading{text}
  22. @ifinfo
  23. @subsubheading \text\
  24. @end ifinfo
  25. @ifnotinfo
  26. @item @b{\text\}
  27. @end ifnotinfo
  28. @end macro
  29. @copying
  30. This manual is for Org (version @value{VERSION}).
  31. Copyright @copyright{} 2004, 2005, 2006, 2007, 2008 Free Software Foundation
  32. @quotation
  33. Permission is granted to copy, distribute and/or modify this document
  34. under the terms of the GNU Free Documentation License, Version 1.2 or
  35. any later version published by the Free Software Foundation; with no
  36. Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
  37. and with the Back-Cover Texts as in (a) below. A copy of the license
  38. is included in the section entitled ``GNU Free Documentation License.''
  39. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
  40. modify this GNU manual. Buying copies from the FSF supports it in
  41. developing GNU and promoting software freedom.''
  42. This document is part of a collection distributed under the GNU Free
  43. Documentation License. If you want to distribute this document
  44. separately from the collection, you can do so by adding a copy of the
  45. license to the document, as described in section 6 of the license.
  46. @end quotation
  47. @end copying
  48. @titlepage
  49. @title The Org Manual
  50. @subtitle Release @value{VERSION}
  51. @author by Carsten Dominik
  52. @c The following two commands start the copyright page.
  53. @page
  54. @vskip 0pt plus 1filll
  55. @insertcopying
  56. @end titlepage
  57. @c Output the table of contents at the beginning.
  58. @contents
  59. @ifnottex
  60. @node Top, Introduction, (dir), (dir)
  61. @top Org Mode Manual
  62. @insertcopying
  63. @end ifnottex
  64. @menu
  65. * Introduction:: Getting started
  66. * Document Structure:: A tree works like your brain
  67. * Tables:: Pure magic for quick formatting
  68. * Hyperlinks:: Notes in context
  69. * TODO Items:: Every tree branch can be a TODO item
  70. * Tags:: Tagging headlines and matching sets of tags
  71. * Properties and Columns:: Storing information about an entry
  72. * Dates and Times:: Making items useful for planning
  73. * Capture:: Creating tasks and attaching files
  74. * Agenda Views:: Collecting information into views
  75. * Embedded LaTeX:: LaTeX fragments and formulas
  76. * Exporting:: Sharing and publishing of notes
  77. * Publishing:: Create a web site of linked Org files
  78. * Miscellaneous:: All the rest which did not fit elsewhere
  79. * Extensions:: Add-ons for Org mode
  80. * Hacking:: How hack your way around
  81. * History and Acknowledgments:: How Org came into being
  82. * Main Index:: An index of Org's concepts and features
  83. * Key Index:: Key bindings and where they are described
  84. @detailmenu
  85. --- The Detailed Node Listing ---
  86. Introduction
  87. * Summary:: Brief summary of what Org does
  88. * Installation:: How to install a downloaded version of Org
  89. * Activation:: How to activate Org for certain buffers
  90. * Feedback:: Bug reports, ideas, patches etc.
  91. * Conventions:: Type-setting conventions in the manual
  92. Document Structure
  93. * Outlines:: Org is based on Outline mode
  94. * Headlines:: How to typeset Org tree headlines
  95. * Visibility cycling:: Show and hide, much simplified
  96. * Motion:: Jumping to other headlines
  97. * Structure editing:: Changing sequence and level of headlines
  98. * Archiving:: Move done task trees to a different place
  99. * Sparse trees:: Matches embedded in context
  100. * Plain lists:: Additional structure within an entry
  101. * Drawers:: Tucking stuff away
  102. * Orgstruct mode:: Structure editing outside Org
  103. Archiving
  104. * ARCHIVE tag:: Marking a tree as inactive
  105. * Moving subtrees:: Moving a tree to an archive file
  106. Tables
  107. * Built-in table editor:: Simple tables
  108. * Narrow columns:: Stop wasting space in tables
  109. * Column groups:: Grouping to trigger vertical lines
  110. * Orgtbl mode:: The table editor as minor mode
  111. * The spreadsheet:: The table editor has spreadsheet capabilities
  112. * Org Plot:: Plotting from org tables
  113. The spreadsheet
  114. * References:: How to refer to another field or range
  115. * Formula syntax for Calc:: Using Calc to compute stuff
  116. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  117. * Field formulas:: Formulas valid for a single field
  118. * Column formulas:: Formulas valid for an entire column
  119. * Editing and debugging formulas:: Fixing formulas
  120. * Updating the table:: Recomputing all dependent fields
  121. * Advanced features:: Field names, parameters and automatic recalc
  122. Hyperlinks
  123. * Link format:: How links in Org are formatted
  124. * Internal links:: Links to other places in the current file
  125. * External links:: URL-like links to the world
  126. * Handling links:: Creating, inserting and following
  127. * Using links outside Org:: Linking from my C source code?
  128. * Link abbreviations:: Shortcuts for writing complex links
  129. * Search options:: Linking to a specific location
  130. * Custom searches:: When the default search is not enough
  131. Internal links
  132. * Radio targets:: Make targets trigger links in plain text
  133. TODO Items
  134. * TODO basics:: Marking and displaying TODO entries
  135. * TODO extensions:: Workflow and assignments
  136. * Progress logging:: Dates and notes for progress
  137. * Priorities:: Some things are more important than others
  138. * Breaking down tasks:: Splitting a task into manageable pieces
  139. * Checkboxes:: Tick-off lists
  140. Extended use of TODO keywords
  141. * Workflow states:: From TODO to DONE in steps
  142. * TODO types:: I do this, Fred does the rest
  143. * Multiple sets in one file:: Mixing it all, and still finding your way
  144. * Fast access to TODO states:: Single letter selection of a state
  145. * Per-file keywords:: Different files, different requirements
  146. * Faces for TODO keywords:: Highlighting states
  147. Progress logging
  148. * Closing items:: When was this entry marked DONE?
  149. * Tracking TODO state changes:: When did the status change?
  150. Tags
  151. * Tag inheritance:: Tags use the tree structure of the outline
  152. * Setting tags:: How to assign tags to a headline
  153. * Tag searches:: Searching for combinations of tags
  154. Properties and Columns
  155. * Property syntax:: How properties are spelled out
  156. * Special properties:: Access to other Org mode features
  157. * Property searches:: Matching property values
  158. * Property inheritance:: Passing values down the tree
  159. * Column view:: Tabular viewing and editing
  160. * Property API:: Properties for Lisp programmers
  161. Column view
  162. * Defining columns:: The COLUMNS format property
  163. * Using column view:: How to create and use column view
  164. * Capturing column view:: A dynamic block for column view
  165. Defining columns
  166. * Scope of column definitions:: Where defined, where valid?
  167. * Column attributes:: Appearance and content of a column
  168. Dates and Times
  169. * Timestamps:: Assigning a time to a tree entry
  170. * Creating timestamps:: Commands which insert timestamps
  171. * Deadlines and scheduling:: Planning your work
  172. * Clocking work time:: Tracking how long you spend on a task
  173. * Effort estimates:: Planning work effort in advance
  174. Creating timestamps
  175. * The date/time prompt:: How Org mode helps you entering date and time
  176. * Custom time format:: Making dates look different
  177. Deadlines and scheduling
  178. * Inserting deadline/schedule:: Planning items
  179. * Repeated tasks:: Items that show up again and again
  180. Capture
  181. * Remember:: Capture new tasks/ideas with little interruption
  182. * Attachments:: Add files to tasks.
  183. Remember
  184. * Setting up Remember:: Some code for .emacs to get things going
  185. * Remember templates:: Define the outline of different note types
  186. * Storing notes:: Directly get the note to where it belongs
  187. * Refiling notes:: Moving a note or task to a project
  188. Agenda Views
  189. * Agenda files:: Files being searched for agenda information
  190. * Agenda dispatcher:: Keyboard access to agenda views
  191. * Built-in agenda views:: What is available out of the box?
  192. * Presentation and sorting:: How agenda items are prepared for display
  193. * Agenda commands:: Remote editing of Org trees
  194. * Custom agenda views:: Defining special searches and views
  195. * Agenda column view:: Using column view for collected entries
  196. The built-in agenda views
  197. * Weekly/daily agenda:: The calendar page with current tasks
  198. * Global TODO list:: All unfinished action items
  199. * Matching tags and properties:: Structured information with fine-tuned search
  200. * Timeline:: Time-sorted view for single file
  201. * Keyword search:: Finding entries by keyword
  202. * Stuck projects:: Find projects you need to review
  203. Presentation and sorting
  204. * Categories:: Not all tasks are equal
  205. * Time-of-day specifications:: How the agenda knows the time
  206. * Sorting of agenda items:: The order of things
  207. Custom agenda views
  208. * Storing searches:: Type once, use often
  209. * Block agenda:: All the stuff you need in a single buffer
  210. * Setting Options:: Changing the rules
  211. * Exporting Agenda Views:: Writing agendas to files
  212. * Using the agenda elsewhere:: Using agenda information in other programs
  213. Embedded LaTeX
  214. * Math symbols:: TeX macros for symbols and Greek letters
  215. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  216. * LaTeX fragments:: Complex formulas made easy
  217. * Processing LaTeX fragments:: Previewing LaTeX processing
  218. * CDLaTeX mode:: Speed up entering of formulas
  219. Exporting
  220. * Markup rules:: Which structures are recognized?
  221. * Selective export:: Using tags to select and exclude trees
  222. * Export options:: Per-file export settings
  223. * The export dispatcher:: How to access exporter commands
  224. * ASCII export:: Exporting to plain ASCII
  225. * HTML export:: Exporting to HTML
  226. * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
  227. * XOXO export:: Exporting to XOXO
  228. * iCalendar export:: Exporting in iCalendar format
  229. Markup rules
  230. * Document title:: How the document title is determined
  231. * Headings and sections:: The main structure of the exported document
  232. * Table of contents:: If, where, how to create a table of contents
  233. * Initial text:: Text before the first headline
  234. * Lists:: Plain lists are exported
  235. * Paragraphs:: What determines beginning and ending
  236. * Literal examples:: Source code and other examples
  237. * Include files:: Include the contents of a file during export
  238. * Tables exported:: Tables are exported richly
  239. * Footnotes:: Numbers like [1]
  240. * Emphasis and monospace:: To bold or not to bold
  241. * TeX macros and LaTeX fragments:: Create special, rich export.
  242. * Horizontal rules:: A line across the page
  243. * Comment lines:: Some lines will not be exported
  244. HTML export
  245. * HTML Export commands:: How to invoke HTML export
  246. * Quoting HTML tags:: Using direct HTML in Org mode
  247. * Links:: Transformation of links for HTML
  248. * Images:: How to include images
  249. * CSS support:: Changing the appearance of the output
  250. * Javascript support:: Info and Folding in a web browser
  251. LaTeX and PDF export
  252. * LaTeX/PDF export commands::
  253. * Quoting LaTeX code:: Incorporating literal LaTeX code
  254. * Sectioning structure:: Changing sectioning in LaTeX output
  255. Publishing
  256. * Configuration:: Defining projects
  257. * Sample configuration:: Example projects
  258. * Triggering publication:: Publication commands
  259. Configuration
  260. * Project alist:: The central configuration variable
  261. * Sources and destinations:: From here to there
  262. * Selecting files:: What files are part of the project?
  263. * Publishing action:: Setting the function doing the publishing
  264. * Publishing options:: Tweaking HTML export
  265. * Publishing links:: Which links keep working after publishing?
  266. * Project page index:: Publishing a list of project files
  267. Sample configuration
  268. * Simple example:: One-component publishing
  269. * Complex example:: A multi-component publishing example
  270. Miscellaneous
  271. * Completion:: M-TAB knows what you need
  272. * Customization:: Adapting Org to your taste
  273. * In-buffer settings:: Overview of the #+KEYWORDS
  274. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  275. * Clean view:: Getting rid of leading stars in the outline
  276. * TTY keys:: Using Org on a tty
  277. * Interaction:: Other Emacs packages
  278. * Bugs:: Things which do not work perfectly
  279. Interaction with other packages
  280. * Cooperation:: Packages Org cooperates with
  281. * Conflicts:: Packages that lead to conflicts
  282. Extensions
  283. * Extensions in the contrib directory:: These come with the Org distro
  284. * Other extensions:: These you have to find on the web.
  285. Hacking
  286. * Adding hyperlink types:: New custom link types
  287. * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
  288. * Dynamic blocks:: Automatically filled blocks
  289. * Special agenda views:: Customized views
  290. * Using the property API:: Writing programs that use entry properties
  291. * Using the mapping API:: Mapping over all or selected entries
  292. Tables and lists in arbitrary syntax
  293. * Radio tables:: Sending and receiving
  294. * A LaTeX example:: Step by step, almost a tutorial
  295. * Translator functions:: Copy and modify
  296. * Radio lists:: Doing the same for lists
  297. @end detailmenu
  298. @end menu
  299. @node Introduction, Document Structure, Top, Top
  300. @chapter Introduction
  301. @cindex introduction
  302. @menu
  303. * Summary:: Brief summary of what Org does
  304. * Installation:: How to install a downloaded version of Org
  305. * Activation:: How to activate Org for certain buffers
  306. * Feedback:: Bug reports, ideas, patches etc.
  307. * Conventions:: Type-setting conventions in the manual
  308. @end menu
  309. @node Summary, Installation, Introduction, Introduction
  310. @section Summary
  311. @cindex summary
  312. Org is a mode for keeping notes, maintaining TODO lists, and doing
  313. project planning with a fast and effective plain-text system.
  314. Org develops organizational tasks around NOTES files that contain
  315. lists or information about projects as plain text. Org is
  316. implemented on top of Outline mode, which makes it possible to keep the
  317. content of large files well structured. Visibility cycling and
  318. structure editing help to work with the tree. Tables are easily created
  319. with a built-in table editor. Org supports TODO items, deadlines,
  320. time stamps, and scheduling. It dynamically compiles entries into an
  321. agenda that utilizes and smoothly integrates much of the Emacs calendar
  322. and diary. Plain text URL-like links connect to websites, emails,
  323. Usenet messages, BBDB entries, and any files related to the projects.
  324. For printing and sharing of notes, an Org file can be exported as a
  325. structured ASCII file, as HTML, or (TODO and agenda items only) as an
  326. iCalendar file. It can also serve as a publishing tool for a set of
  327. linked web pages.
  328. An important design aspect that distinguishes Org from for example
  329. Planner/Muse is that it encourages to store every piece of information
  330. only once. In Planner, you have project pages, day pages and possibly
  331. other files, duplicating some information such as tasks. In Org,
  332. you only have notes files. In your notes you mark entries as tasks,
  333. label them with tags and timestamps. All necessary lists like a
  334. schedule for the day, the agenda for a meeting, tasks lists selected by
  335. tags etc are created dynamically when you need them.
  336. Org keeps simple things simple. When first fired up, it should
  337. feel like a straightforward, easy to use outliner. Complexity is not
  338. imposed, but a large amount of functionality is available when you need
  339. it. Org is a toolbox and can be used in different ways, for
  340. example as:
  341. @example
  342. @r{@bullet{} outline extension with visibility cycling and structure editing}
  343. @r{@bullet{} ASCII system and table editor for taking structured notes}
  344. @r{@bullet{} ASCII table editor with spreadsheet-like capabilities}
  345. @r{@bullet{} TODO list editor}
  346. @r{@bullet{} full agenda and planner with deadlines and work scheduling}
  347. @r{@bullet{} environment to implement David Allen's GTD system}
  348. @r{@bullet{} a basic database application}
  349. @r{@bullet{} simple hypertext system, with HTML and LaTeX export}
  350. @r{@bullet{} publishing tool to create a set of interlinked webpages}
  351. @end example
  352. Org's automatic, context sensitive table editor with spreadsheet
  353. capabilities can be integrated into any major mode by activating the
  354. minor Orgtbl mode. Using a translation step, it can be used to maintain
  355. tables in arbitrary file types, for example in La@TeX{}. The structure
  356. editing and list creation capabilities can be used outside Org with
  357. the minor Orgstruct mode.
  358. @cindex FAQ
  359. There is a website for Org which provides links to the newest
  360. version of Org, as well as additional information, frequently asked
  361. questions (FAQ), links to tutorials etc. This page is located at
  362. @uref{http://orgmode.org}.
  363. @page
  364. @node Installation, Activation, Summary, Introduction
  365. @section Installation
  366. @cindex installation
  367. @cindex XEmacs
  368. @b{Important:} @i{If Org is part of the Emacs distribution or an
  369. XEmacs package, please skip this section and go directly to
  370. @ref{Activation}.}
  371. If you have downloaded Org from the Web, either as a distribution @file{.zip}
  372. or @file{.tar} file, or as a GIT archive, you must take the following steps
  373. to install it: Go into the unpacked Org distribution directory and edit the
  374. top section of the file @file{Makefile}. You must set the name of the Emacs
  375. binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
  376. directories where local Lisp and Info files are kept. If you don't have
  377. access to the system-wide directories, you can simply run Org directly from
  378. the distribution directory by adding the @file{lisp} subdirectory to the
  379. Emacs load path. To do this, add the following line to @file{.emacs}:
  380. @example
  381. (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
  382. @end example
  383. @noindent
  384. If you plan to use code from the @file{contrib} subdirectory, do a similar
  385. step for this directory:
  386. @example
  387. (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
  388. @end example
  389. @b{XEmacs users now need to install the file @file{noutline.el} from
  390. the @file{xemacs} sub-directory of the Org distribution. Use the
  391. command:}
  392. @example
  393. @b{make install-noutline}
  394. @end example
  395. @noindent Now byte-compile the Lisp files with the shell command:
  396. @example
  397. make
  398. @end example
  399. @noindent If you are running Org from the distribution directory, this is
  400. all. If you want to install into the system directories, use
  401. @example
  402. make install
  403. make install-info
  404. @end example
  405. @noindent Then add to @file{.emacs}:
  406. @lisp
  407. ;; This line only if Org is not part of the X/Emacs distribution.
  408. (require 'org-install)
  409. @end lisp
  410. @node Activation, Feedback, Installation, Introduction
  411. @section Activation
  412. @cindex activation
  413. @cindex autoload
  414. @cindex global key bindings
  415. @cindex key bindings, global
  416. @iftex
  417. @b{Important:} @i{If you use copy-and-paste to copy lisp code from the
  418. PDF documentation as viewed by some PDF viewers to your .emacs file, the
  419. single quote character comes out incorrectly and the code will not work.
  420. You need to fix the single quotes by hand, or copy from Info
  421. documentation.}
  422. @end iftex
  423. Add the following lines to your @file{.emacs} file. The last two lines
  424. define @emph{global} keys for the commands @command{org-store-link},
  425. @command{org-agenda}, and @command{org-iswitchb} - please choose suitable
  426. keys yourself.
  427. @lisp
  428. ;; The following lines are always needed. Choose your own keys.
  429. (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
  430. (global-set-key "\C-cl" 'org-store-link)
  431. (global-set-key "\C-ca" 'org-agenda)
  432. (global-set-key "\C-cb" 'org-iswitchb)
  433. @end lisp
  434. Furthermore, you must activate @code{font-lock-mode} in Org
  435. buffers, because significant functionality depends on font-locking being
  436. active. You can do this with either one of the following two lines
  437. (XEmacs user must use the second option):
  438. @lisp
  439. (global-font-lock-mode 1) ; for all buffers
  440. (add-hook 'org-mode-hook 'turn-on-font-lock) ; Org buffers only
  441. @end lisp
  442. @cindex Org mode, turning on
  443. With this setup, all files with extension @samp{.org} will be put
  444. into Org mode. As an alternative, make the first line of a file look
  445. like this:
  446. @example
  447. MY PROJECTS -*- mode: org; -*-
  448. @end example
  449. @noindent which will select Org mode for this buffer no matter what
  450. the file's name is. See also the variable
  451. @code{org-insert-mode-line-in-empty-file}.
  452. @node Feedback, Conventions, Activation, Introduction
  453. @section Feedback
  454. @cindex feedback
  455. @cindex bug reports
  456. @cindex maintainer
  457. @cindex author
  458. If you find problems with Org, or if you have questions, remarks, or ideas
  459. about it, please mail to the Org mailing list @code{emacs-orgmode@@gnu.org}.
  460. If you are not a member of the mailing list, your mail will be reviewed by a
  461. moderator and then passed through to the list.
  462. For bug reports, please provide as much information as possible,
  463. including the version information of Emacs (@kbd{C-h v emacs-version
  464. @key{RET}}) and Org (@kbd{C-h v org-version @key{RET}}), as well as
  465. the Org related setup in @file{.emacs}. If an error occurs, a
  466. backtrace can be very useful (see below on how to create one). Often a
  467. small example file helps, along with clear information about:
  468. @enumerate
  469. @item What exactly did you do?
  470. @item What did you expect to happen?
  471. @item What happened instead?
  472. @end enumerate
  473. @noindent Thank you for helping to improve this mode.
  474. @subsubheading How to create a useful backtrace
  475. @cindex backtrace of an error
  476. If working with Org produces an error with a message you don't
  477. understand, you may have hit a bug. The best way to report this is by
  478. providing, in addition to what was mentioned above, a @emph{Backtrace}.
  479. This is information from the built-in debugger about where and how the
  480. error occurred. Here is how to produce a useful backtrace:
  481. @enumerate
  482. @item
  483. Start a fresh Emacs or XEmacs, and make sure that it will load the
  484. original Lisp code in @file{org.el} instead of the compiled version in
  485. @file{org.elc}. The backtrace contains much more information if it is
  486. produced with uncompiled code. To do this, either rename @file{org.elc}
  487. to something else before starting Emacs, or ask Emacs explicitly to load
  488. @file{org.el} by using the command line
  489. @example
  490. emacs -l /path/to/org.el
  491. @end example
  492. @item
  493. Go to the @code{Options} menu and select @code{Enter Debugger on Error}
  494. (XEmacs has this option in the @code{Troubleshooting} sub-menu).
  495. @item
  496. Do whatever you have to do to hit the error. Don't forget to
  497. document the steps you take.
  498. @item
  499. When you hit the error, a @file{*Backtrace*} buffer will appear on the
  500. screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
  501. attach it to your bug report.
  502. @end enumerate
  503. @node Conventions, , Feedback, Introduction
  504. @section Typesetting conventions used in this manual
  505. Org uses three types of keywords: TODO keywords, tags, and property
  506. names. In this manual we use the following conventions:
  507. @table @code
  508. @item TODO
  509. @itemx WAITING
  510. TODO keywords are written with all capitals, even if they are
  511. user-defined.
  512. @item boss
  513. @itemx ARCHIVE
  514. User-defined tags are written in lowercase; built-in tags with special
  515. meaning are written with all capitals.
  516. @item Release
  517. @itemx PRIORITY
  518. User-defined properties are capitalized; built-in properties with
  519. special meaning are written with all capitals.
  520. @end table
  521. @node Document Structure, Tables, Introduction, Top
  522. @chapter Document Structure
  523. @cindex document structure
  524. @cindex structure of document
  525. Org is based on outline mode and provides flexible commands to
  526. edit the structure of the document.
  527. @menu
  528. * Outlines:: Org is based on Outline mode
  529. * Headlines:: How to typeset Org tree headlines
  530. * Visibility cycling:: Show and hide, much simplified
  531. * Motion:: Jumping to other headlines
  532. * Structure editing:: Changing sequence and level of headlines
  533. * Archiving:: Move done task trees to a different place
  534. * Sparse trees:: Matches embedded in context
  535. * Plain lists:: Additional structure within an entry
  536. * Drawers:: Tucking stuff away
  537. * Orgstruct mode:: Structure editing outside Org
  538. @end menu
  539. @node Outlines, Headlines, Document Structure, Document Structure
  540. @section Outlines
  541. @cindex outlines
  542. @cindex Outline mode
  543. Org is implemented on top of Outline mode. Outlines allow a
  544. document to be organized in a hierarchical structure, which (at least
  545. for me) is the best representation of notes and thoughts. An overview
  546. of this structure is achieved by folding (hiding) large parts of the
  547. document to show only the general document structure and the parts
  548. currently being worked on. Org greatly simplifies the use of
  549. outlines by compressing the entire show/hide functionality into a single
  550. command @command{org-cycle}, which is bound to the @key{TAB} key.
  551. @node Headlines, Visibility cycling, Outlines, Document Structure
  552. @section Headlines
  553. @cindex headlines
  554. @cindex outline tree
  555. Headlines define the structure of an outline tree. The headlines in
  556. Org start with one or more stars, on the left margin@footnote{See
  557. the variable @code{org-special-ctrl-a/e} to configure special behavior
  558. of @kbd{C-a} and @kbd{C-e} in headlines.}. For example:
  559. @example
  560. * Top level headline
  561. ** Second level
  562. *** 3rd level
  563. some text
  564. *** 3rd level
  565. more text
  566. * Another top level headline
  567. @end example
  568. @noindent Some people find the many stars too noisy and would prefer an
  569. outline that has whitespace followed by a single star as headline
  570. starters. @ref{Clean view} describes a setup to realize this.
  571. An empty line after the end of a subtree is considered part of it and
  572. will be hidden when the subtree is folded. However, if you leave at
  573. least two empty lines, one empty line will remain visible after folding
  574. the subtree, in order to structure the collapsed view. See the
  575. variable @code{org-cycle-separator-lines} to modify this behavior.
  576. @node Visibility cycling, Motion, Headlines, Document Structure
  577. @section Visibility cycling
  578. @cindex cycling, visibility
  579. @cindex visibility cycling
  580. @cindex trees, visibility
  581. @cindex show hidden text
  582. @cindex hide text
  583. Outlines make it possible to hide parts of the text in the buffer.
  584. Org uses just two commands, bound to @key{TAB} and
  585. @kbd{S-@key{TAB}} to change the visibility in the buffer.
  586. @cindex subtree visibility states
  587. @cindex subtree cycling
  588. @cindex folded, subtree visibility state
  589. @cindex children, subtree visibility state
  590. @cindex subtree, subtree visibility state
  591. @table @kbd
  592. @kindex @key{TAB}
  593. @item @key{TAB}
  594. @emph{Subtree cycling}: Rotate current subtree among the states
  595. @example
  596. ,-> FOLDED -> CHILDREN -> SUBTREE --.
  597. '-----------------------------------'
  598. @end example
  599. The cursor must be on a headline for this to work@footnote{see, however,
  600. the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
  601. beginning of the buffer and the first line is not a headline, then
  602. @key{TAB} actually runs global cycling (see below)@footnote{see the
  603. option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
  604. argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
  605. @cindex global visibility states
  606. @cindex global cycling
  607. @cindex overview, global visibility state
  608. @cindex contents, global visibility state
  609. @cindex show all, global visibility state
  610. @kindex S-@key{TAB}
  611. @item S-@key{TAB}
  612. @itemx C-u @key{TAB}
  613. @emph{Global cycling}: Rotate the entire buffer among the states
  614. @example
  615. ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
  616. '--------------------------------------'
  617. @end example
  618. When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
  619. CONTENTS view up to headlines of level N will be shown. Note that inside
  620. tables, @kbd{S-@key{TAB}} jumps to the previous field.
  621. @cindex show all, command
  622. @kindex C-u C-u C-u @key{TAB}
  623. @item C-u C-u C-u @key{TAB}
  624. Show all, including drawers.
  625. @kindex C-c C-r
  626. @item C-c C-r
  627. Reveal context around point, showing the current entry, the following heading
  628. and the hierarchy above. Useful for working near a location that has been
  629. exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
  630. (@pxref{Agenda commands}). With a prefix argument show, on each
  631. level, all sibling headings.
  632. @kindex C-c C-x b
  633. @item C-c C-x b
  634. Show the current subtree in an indirect buffer@footnote{The indirect
  635. buffer
  636. @ifinfo
  637. (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
  638. @end ifinfo
  639. @ifnotinfo
  640. (see the Emacs manual for more information about indirect buffers)
  641. @end ifnotinfo
  642. will contain the entire buffer, but will be narrowed to the current
  643. tree. Editing the indirect buffer will also change the original buffer,
  644. but without affecting visibility in that buffer.}. With a numeric
  645. prefix argument N, go up to level N and then take that tree. If N is
  646. negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
  647. the previously used indirect buffer.
  648. @end table
  649. When Emacs first visits an Org file, the global state is set to
  650. OVERVIEW, i.e. only the top level headlines are visible. This can be
  651. configured through the variable @code{org-startup-folded}, or on a
  652. per-file basis by adding one of the following lines anywhere in the
  653. buffer:
  654. @example
  655. #+STARTUP: overview
  656. #+STARTUP: content
  657. #+STARTUP: showall
  658. @end example
  659. @noindent
  660. Forthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
  661. and Columns}) will get their visibility adapted accordingly. Allowed values
  662. for this property are @code{folded}, @code{children}, @code{content}, and
  663. @code{all}.
  664. @table @kbd
  665. @kindex C-u C-u @key{TAB}
  666. @item C-u C-u @key{TAB}
  667. Switch back to the startup visibility of the buffer, i.e. whatever is
  668. requested by startup options and @samp{VISIBILITY} properties in individual
  669. entries.
  670. @end table
  671. @node Motion, Structure editing, Visibility cycling, Document Structure
  672. @section Motion
  673. @cindex motion, between headlines
  674. @cindex jumping, to headlines
  675. @cindex headline navigation
  676. The following commands jump to other headlines in the buffer.
  677. @table @kbd
  678. @kindex C-c C-n
  679. @item C-c C-n
  680. Next heading.
  681. @kindex C-c C-p
  682. @item C-c C-p
  683. Previous heading.
  684. @kindex C-c C-f
  685. @item C-c C-f
  686. Next heading same level.
  687. @kindex C-c C-b
  688. @item C-c C-b
  689. Previous heading same level.
  690. @kindex C-c C-u
  691. @item C-c C-u
  692. Backward to higher level heading.
  693. @kindex C-c C-j
  694. @item C-c C-j
  695. Jump to a different place without changing the current outline
  696. visibility. Shows the document structure in a temporary buffer, where
  697. you can use the following keys to find your destination:
  698. @example
  699. @key{TAB} @r{Cycle visibility.}
  700. @key{down} / @key{up} @r{Next/previous visible headline.}
  701. n / p @r{Next/previous visible headline.}
  702. f / b @r{Next/previous headline same level.}
  703. u @r{One level up.}
  704. 0-9 @r{Digit argument.}
  705. @key{RET} @r{Select this location.}
  706. @end example
  707. @end table
  708. @node Structure editing, Archiving, Motion, Document Structure
  709. @section Structure editing
  710. @cindex structure editing
  711. @cindex headline, promotion and demotion
  712. @cindex promotion, of subtrees
  713. @cindex demotion, of subtrees
  714. @cindex subtree, cut and paste
  715. @cindex pasting, of subtrees
  716. @cindex cutting, of subtrees
  717. @cindex copying, of subtrees
  718. @cindex subtrees, cut and paste
  719. @table @kbd
  720. @kindex M-@key{RET}
  721. @item M-@key{RET}
  722. Insert new heading with same level as current. If the cursor is in a
  723. plain list item, a new item is created (@pxref{Plain lists}). To force
  724. creation of a new headline, use a prefix argument, or first press @key{RET}
  725. to get to the beginning of the next line. When this command is used in
  726. the middle of a line, the line is split and the rest of the line becomes
  727. the new headline@footnote{If you do not want the line to be split,
  728. customize the variable @code{org-M-RET-may-split-line}.}. If the
  729. command is used at the beginning of a headline, the new headline is
  730. created before the current line. If at the beginning of any other line,
  731. the content of that line is made the new heading. If the command is
  732. used at the end of a folded subtree (i.e. behind the ellipses at the end
  733. of a headline), then a headline like the current one will be inserted
  734. after the end of the subtree.
  735. @kindex C-@key{RET}
  736. @item C-@key{RET}
  737. Just like @kbd{M-@key{RET}}, except when adding a new heading below the
  738. current heading, the new heading is placed after the body instead of before
  739. it. This command works from anywhere in the entry.
  740. @kindex M-S-@key{RET}
  741. @item M-S-@key{RET}
  742. Insert new TODO entry with same level as current heading.
  743. @kindex C-S-@key{RET}
  744. @item C-S-@key{RET}
  745. Insert new TODO entry with same level as current heading. Like
  746. @kbd{C-@key{RET}}, the new headline will be inserted after the current
  747. subtree.
  748. @kindex M-@key{left}
  749. @item M-@key{left}
  750. Promote current heading by one level.
  751. @kindex M-@key{right}
  752. @item M-@key{right}
  753. Demote current heading by one level.
  754. @kindex M-S-@key{left}
  755. @item M-S-@key{left}
  756. Promote the current subtree by one level.
  757. @kindex M-S-@key{right}
  758. @item M-S-@key{right}
  759. Demote the current subtree by one level.
  760. @kindex M-S-@key{up}
  761. @item M-S-@key{up}
  762. Move subtree up (swap with previous subtree of same
  763. level).
  764. @kindex M-S-@key{down}
  765. @item M-S-@key{down}
  766. Move subtree down (swap with next subtree of same level).
  767. @kindex C-c C-x C-w
  768. @kindex C-c C-x C-k
  769. @item C-c C-x C-w
  770. @itemx C-c C-x C-k
  771. Kill subtree, i.e. remove it from buffer but save in kill ring.
  772. With a numeric prefix argument N, kill N sequential subtrees.
  773. @kindex C-c C-x M-w
  774. @item C-c C-x M-w
  775. Copy subtree to kill ring. With a numeric prefix argument N, copy the N
  776. sequential subtrees.
  777. @kindex C-c C-x C-y
  778. @item C-c C-x C-y
  779. Yank subtree from kill ring. This does modify the level of the subtree to
  780. make sure the tree fits in nicely at the yank position. The yank level can
  781. also be specified with a numeric prefix argument, or by yanking after a
  782. headline marker like @samp{****}.
  783. @kindex C-c C-w
  784. @item C-c C-w
  785. Refile entry to a different location. @xref{Refiling notes}.
  786. @kindex C-c ^
  787. @item C-c ^
  788. Sort same-level entries. When there is an active region, all entries in the
  789. region will be sorted. Otherwise the children of the current headline are
  790. sorted. The command prompts for the sorting method, which can be
  791. alphabetically, numerically, by time (using the first time stamp in each
  792. entry), by priority, or by TODO keyword (in the sequence the keywords have
  793. been defined in the setup). Reverse sorting is possible as well. You can
  794. also supply your own function to extract the sorting key. With a @kbd{C-u}
  795. prefix, sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes,
  796. duplicate entries will also be removed.
  797. @kindex C-x n s
  798. @item C-x n s
  799. Narrow buffer to current subtree.
  800. @kindex C-x n w
  801. @item C-x n w
  802. Widen buffer to remove a narrowing.
  803. @kindex C-c *
  804. @item C-c *
  805. Turn a normal line or plain list item into a headline (so that it
  806. becomes a subheading at its location). Also turn a headline into a
  807. normal line by removing the stars. If there is an active region, turn
  808. all lines in the region into headlines. Or, if the first line is a
  809. headline, remove the stars from all headlines in the region.
  810. @end table
  811. @cindex region, active
  812. @cindex active region
  813. @cindex Transient mark mode
  814. When there is an active region (Transient mark mode), promotion and
  815. demotion work on all headlines in the region. To select a region of
  816. headlines, it is best to place both point and mark at the beginning of a
  817. line, mark at the beginning of the first headline, and point at the line
  818. just after the last headline to change. Note that when the cursor is
  819. inside a table (@pxref{Tables}), the Meta-Cursor keys have different
  820. functionality.
  821. @node Archiving, Sparse trees, Structure editing, Document Structure
  822. @section Archiving
  823. @cindex archiving
  824. When a project represented by a (sub)tree is finished, you may want
  825. to move the tree out of the way and to stop it from contributing to the
  826. agenda. Org mode knows two ways of archiving. You can mark a tree with
  827. the ARCHIVE tag, or you can move an entire (sub)tree to a different
  828. location.
  829. @menu
  830. * ARCHIVE tag:: Marking a tree as inactive
  831. * Moving subtrees:: Moving a tree to an archive file
  832. @end menu
  833. @node ARCHIVE tag, Moving subtrees, Archiving, Archiving
  834. @subsection The ARCHIVE tag
  835. @cindex internal archiving
  836. A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
  837. its location in the outline tree, but behaves in the following way:
  838. @itemize @minus
  839. @item
  840. It does not open when you attempt to do so with a visibility cycling
  841. command (@pxref{Visibility cycling}). You can force cycling archived
  842. subtrees with @kbd{C-@key{TAB}}, or by setting the option
  843. @code{org-cycle-open-archived-trees}. Also normal outline commands like
  844. @code{show-all} will open archived subtrees.
  845. @item
  846. During sparse tree construction (@pxref{Sparse trees}), matches in
  847. archived subtrees are not exposed, unless you configure the option
  848. @code{org-sparse-tree-open-archived-trees}.
  849. @item
  850. During agenda view construction (@pxref{Agenda Views}), the content of
  851. archived trees is ignored unless you configure the option
  852. @code{org-agenda-skip-archived-trees}, in which case these trees will always
  853. be included. In the agenda you can press the @kbd{v} key to get archives
  854. temporarily included.
  855. @item
  856. Archived trees are not exported (@pxref{Exporting}), only the headline
  857. is. Configure the details using the variable
  858. @code{org-export-with-archived-trees}.
  859. @end itemize
  860. The following commands help managing the ARCHIVE tag:
  861. @table @kbd
  862. @kindex C-c C-x a
  863. @item C-c C-x a
  864. Toggle the ARCHIVE tag for the current headline. When the tag is set,
  865. the headline changes to a shadowed face, and the subtree below it is
  866. hidden.
  867. @kindex C-u C-c C-x a
  868. @item C-u C-c C-x a
  869. Check if any direct children of the current headline should be archived.
  870. To do this, each subtree is checked for open TODO entries. If none are
  871. found, the command offers to set the ARCHIVE tag for the child. If the
  872. cursor is @emph{not} on a headline when this command is invoked, the
  873. level 1 trees will be checked.
  874. @kindex C-@kbd{TAB}
  875. @item C-@kbd{TAB}
  876. Cycle a tree even if it is tagged with ARCHIVE.
  877. @end table
  878. @node Moving subtrees, , ARCHIVE tag, Archiving
  879. @subsection Moving subtrees
  880. @cindex external archiving
  881. Once an entire project is finished, you may want to move it to a different
  882. location. Org can move it to an @emph{Archive Sibling} in the same tree, to a
  883. different tree in the current file, or to a different file, the archive file.
  884. @table @kbd
  885. @kindex C-c C-x A
  886. @item C-c C-x A
  887. Move the current entry to the @emph{Archive Sibling}. This is a sibling of
  888. the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}
  889. (@pxref{ARCHIVE tag}). The entry becomes a child of that sibling and in this
  890. way retains a lot of its original context, including inherited tags and
  891. approximate position in the outline.
  892. @kindex C-c C-x C-s
  893. @item C-c C-x C-s
  894. Archive the subtree starting at the cursor position to the location
  895. given by @code{org-archive-location}. Context information that could be
  896. lost like the file name, the category, inherited tags, and the TODO
  897. state will be store as properties in the entry.
  898. @kindex C-u C-c C-x C-s
  899. @item C-u C-c C-x C-s
  900. Check if any direct children of the current headline could be moved to
  901. the archive. To do this, each subtree is checked for open TODO entries.
  902. If none are found, the command offers to move it to the archive
  903. location. If the cursor is @emph{not} on a headline when this command
  904. is invoked, the level 1 trees will be checked.
  905. @end table
  906. @cindex archive locations
  907. The default archive location is a file in the same directory as the
  908. current file, with the name derived by appending @file{_archive} to the
  909. current file name. For information and examples on how to change this,
  910. see the documentation string of the variable
  911. @code{org-archive-location}. There is also an in-buffer option for
  912. setting this variable, for example@footnote{For backward compatibility,
  913. the following also works: If there are several such lines in a file,
  914. each specifies the archive location for the text below it. The first
  915. such line also applies to any text before its definition. However,
  916. using this method is @emph{strongly} deprecated as it is incompatible
  917. with the outline structure of the document. The correct method for
  918. setting multiple archive locations in a buffer is using a property.}:
  919. @example
  920. #+ARCHIVE: %s_done::
  921. @end example
  922. @noindent
  923. If you would like to have a special ARCHIVE location for a single entry
  924. or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
  925. location as the value (@pxref{Properties and Columns}).
  926. When a subtree is moved, it receives a number of special properties that
  927. record context information like the file from where the entry came, it's
  928. outline path the archiving time etc. Configure the variable
  929. @code{org-archive-save-context-info} to adjust the amount of information
  930. added.
  931. @node Sparse trees, Plain lists, Archiving, Document Structure
  932. @section Sparse trees
  933. @cindex sparse trees
  934. @cindex trees, sparse
  935. @cindex folding, sparse trees
  936. @cindex occur, command
  937. An important feature of Org mode is the ability to construct @emph{sparse
  938. trees} for selected information in an outline tree, so that the entire
  939. document is folded as much as possible, but the selected information is made
  940. visible along with the headline structure above it@footnote{See also the
  941. variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
  942. @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
  943. control on how much context is shown around each match.}. Just try it out
  944. and you will see immediately how it works.
  945. Org mode contains several commands creating such trees, all these
  946. commands can be accessed through a dispatcher:
  947. @table @kbd
  948. @kindex C-c /
  949. @item C-c /
  950. This prompts for an extra key to select a sparse-tree creating command.
  951. @kindex C-c / r
  952. @item C-c / r
  953. Occur. Prompts for a regexp and shows a sparse tree with all matches. If
  954. the match is in a headline, the headline is made visible. If the match is in
  955. the body of an entry, headline and body are made visible. In order to
  956. provide minimal context, also the full hierarchy of headlines above the match
  957. is shown, as well as the headline following the match. Each match is also
  958. highlighted; the highlights disappear when the buffer is changed by an
  959. editing command@footnote{depending on the option
  960. @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
  961. When called with a @kbd{C-u} prefix argument, previous highlights are kept,
  962. so several calls to this command can be stacked.
  963. @end table
  964. @noindent
  965. For frequently used sparse trees of specific search strings, you can
  966. use the variable @code{org-agenda-custom-commands} to define fast
  967. keyboard access to specific sparse trees. These commands will then be
  968. accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
  969. For example:
  970. @lisp
  971. (setq org-agenda-custom-commands
  972. '(("f" occur-tree "FIXME")))
  973. @end lisp
  974. @noindent will define the key @kbd{C-c a f} as a shortcut for creating
  975. a sparse tree matching the string @samp{FIXME}.
  976. The other sparse tree commands select headings based on TODO keywords,
  977. tags, or properties and will be discussed later in this manual.
  978. @kindex C-c C-e v
  979. @cindex printing sparse trees
  980. @cindex visible text, printing
  981. To print a sparse tree, you can use the Emacs command
  982. @code{ps-print-buffer-with-faces} which does not print invisible parts
  983. of the document @footnote{This does not work under XEmacs, because
  984. XEmacs uses selective display for outlining, not text properties.}.
  985. Or you can use the command @kbd{C-c C-e v} to export only the visible
  986. part of the document and print the resulting file.
  987. @node Plain lists, Drawers, Sparse trees, Document Structure
  988. @section Plain lists
  989. @cindex plain lists
  990. @cindex lists, plain
  991. @cindex lists, ordered
  992. @cindex ordered lists
  993. Within an entry of the outline tree, hand-formatted lists can provide
  994. additional structure. They also provide a way to create lists of
  995. checkboxes (@pxref{Checkboxes}). Org supports editing such lists,
  996. and the HTML exporter (@pxref{Exporting}) parses and formats them.
  997. Org knows ordered lists, unordered lists, and description lists.
  998. @itemize @bullet
  999. @item
  1000. @emph{Unordered} list items start with @samp{-}, @samp{+}, or
  1001. @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
  1002. they will be seen as top-level headlines. Also, when you are hiding leading
  1003. stars to get a clean outline view, plain list items starting with a star are
  1004. visually indistinguishable from true headlines. In short: even though
  1005. @samp{*} is supported, it may be better to not use it for plain list items.}
  1006. as bullets.
  1007. @item
  1008. @emph{Ordered} list items start with a numeral followed by either a period or
  1009. a right parenthesis, such as @samp{1.} or @samp{1)}.
  1010. @item
  1011. @emph{Description} list items are like unordered list items, but contain the
  1012. separator @samp{ :: } to separate the description @emph{term} from the
  1013. desciption.
  1014. @end itemize
  1015. Items belonging to the same list must have the same indentation on the first
  1016. line. In particular, if an ordered list reaches number @samp{10.}, then the
  1017. 2--digit numbers must be written left-aligned with the other numbers in the
  1018. list. Indentation also determines the end of a list item. It ends before
  1019. the next line that is indented like the bullet/number, or less. Empty lines
  1020. are part of the previous item, so you can have several paragraphs in one
  1021. item. If you would like an empty line to terminate all currently open plain
  1022. lists, configure the variable @code{org-empty-line-terminates-plain-lists}.
  1023. Here is an example:
  1024. @example
  1025. @group
  1026. ** Lord of the Rings
  1027. My favorite scenes are (in this order)
  1028. 1. The attack of the Rohirrim
  1029. 2. Eowyns fight with the witch king
  1030. + this was already my favorite scene in the book
  1031. + I really like Miranda Otto.
  1032. 3. Peter Jackson being shot by Legolas
  1033. - on DVD only
  1034. He makes a really funny face when it happens.
  1035. But in the end, not individual scenes matter but the film as a whole.
  1036. Important actors in this film are:
  1037. - @b{Elijah Wood} :: He plays the Frodo
  1038. - @b{Sean Austin} :: He plays the Sam, Frodos friend. I still remember
  1039. him very well from his role as Mikey Walsh a in the Goonies.
  1040. @end group
  1041. @end example
  1042. Org supports these lists by tuning filling and wrapping commands to
  1043. deal with them correctly@footnote{Org only changes the filling
  1044. settings for Emacs. For XEmacs, you should use Kyle E. Jones'
  1045. @file{filladapt.el}. To turn this on, put into @file{.emacs}:
  1046. @code{(require 'filladapt)}}, and by exporting them properly
  1047. (@pxref{Exporting}).
  1048. The following commands act on items when the cursor is in the first line
  1049. of an item (the line with the bullet or number).
  1050. @table @kbd
  1051. @kindex @key{TAB}
  1052. @item @key{TAB}
  1053. Items can be folded just like headline levels if you set the variable
  1054. @code{org-cycle-include-plain-lists}. The level of an item is then
  1055. given by the indentation of the bullet/number. Items are always
  1056. subordinate to real headlines, however; the hierarchies remain
  1057. completely separated.
  1058. If @code{org-cycle-include-plain-lists} has not been set, @key{TAB}
  1059. fixes the indentation of the current line in a heuristic way.
  1060. @kindex M-@key{RET}
  1061. @item M-@key{RET}
  1062. Insert new item at current level. With a prefix argument, force a new
  1063. heading (@pxref{Structure editing}). If this command is used in the middle
  1064. of a line, the line is @emph{split} and the rest of the line becomes the new
  1065. item@footnote{If you do not want the line to be split, customize the variable
  1066. @code{org-M-RET-may-split-line}.}. If this command is executed in the
  1067. @emph{whitespace before a bullet or number}, the new item is created
  1068. @emph{before} the current item. If the command is executed in the white
  1069. space before the text that is part of an item but does not contain the
  1070. bullet, a bullet is added to the current line.
  1071. @kindex M-S-@key{RET}
  1072. @item M-S-@key{RET}
  1073. Insert a new item with a checkbox (@pxref{Checkboxes}).
  1074. @kindex S-@key{up}
  1075. @kindex S-@key{down}
  1076. @item S-@key{up}
  1077. @itemx S-@key{down}
  1078. Jump to the previous/next item in the current list.
  1079. @kindex M-S-@key{up}
  1080. @kindex M-S-@key{down}
  1081. @item M-S-@key{up}
  1082. @itemx M-S-@key{down}
  1083. Move the item including subitems up/down (swap with previous/next item
  1084. of same indentation). If the list is ordered, renumbering is
  1085. automatic.
  1086. @kindex M-S-@key{left}
  1087. @kindex M-S-@key{right}
  1088. @item M-S-@key{left}
  1089. @itemx M-S-@key{right}
  1090. Decrease/increase the indentation of the item, including subitems.
  1091. Initially, the item tree is selected based on current indentation.
  1092. When these commands are executed several times in direct succession,
  1093. the initially selected region is used, even if the new indentation
  1094. would imply a different hierarchy. To use the new hierarchy, break
  1095. the command chain with a cursor motion or so.
  1096. @kindex C-c C-c
  1097. @item C-c C-c
  1098. If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
  1099. state of the checkbox. If not, this command makes sure that all the
  1100. items on this list level use the same bullet. Furthermore, if this is
  1101. an ordered list, make sure the numbering is OK.
  1102. @kindex C-c -
  1103. @item C-c -
  1104. Cycle the entire list level through the different itemize/enumerate bullets
  1105. (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}). With a numeric prefix
  1106. argument N, select the Nth bullet from this list. If there is an active
  1107. region when calling this, all lines will be converted to list items. If the
  1108. first line already was a list item, any item markers will be removed from the
  1109. list. Finally, even without an active region, a normal line will be
  1110. converted into a list item.
  1111. @end table
  1112. @node Drawers, Orgstruct mode, Plain lists, Document Structure
  1113. @section Drawers
  1114. @cindex drawers
  1115. @cindex visibility cycling, drawers
  1116. Sometimes you want to keep information associated with an entry, but you
  1117. normally don't want to see it. For this, Org mode has @emph{drawers}.
  1118. Drawers need to be configured with the variable
  1119. @code{org-drawers}@footnote{You can define drawers on a per-file basis
  1120. with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
  1121. look like this:
  1122. @example
  1123. ** This is a headline
  1124. Still outside the drawer
  1125. :DRAWERNAME:
  1126. This is inside the drawer.
  1127. :END:
  1128. After the drawer.
  1129. @end example
  1130. Visibility cycling (@pxref{Visibility cycling}) on the headline will
  1131. hide and show the entry, but keep the drawer collapsed to a single line.
  1132. In order to look inside the drawer, you need to move the cursor to the
  1133. drawer line and press @key{TAB} there. Org mode uses a drawer for
  1134. storing properties (@pxref{Properties and Columns}), and another one for
  1135. storing clock times (@pxref{Clocking work time}).
  1136. @node Orgstruct mode, , Drawers, Document Structure
  1137. @section The Orgstruct minor mode
  1138. @cindex Orgstruct mode
  1139. @cindex minor mode for structure editing
  1140. If you like the intuitive way the Org mode structure editing and list
  1141. formatting works, you might want to use these commands in other modes
  1142. like Text mode or Mail mode as well. The minor mode Orgstruct mode
  1143. makes this possible. You can always toggle the mode with @kbd{M-x
  1144. orgstruct-mode}. To turn it on by default, for example in Mail mode,
  1145. use
  1146. @lisp
  1147. (add-hook 'mail-mode-hook 'turn-on-orgstruct)
  1148. @end lisp
  1149. When this mode is active and the cursor is on a line that looks to
  1150. Org like a headline of the first line of a list item, most
  1151. structure editing commands will work, even if the same keys normally
  1152. have different functionality in the major mode you are using. If the
  1153. cursor is not in one of those special lines, Orgstruct mode lurks
  1154. silently in the shadow.
  1155. @node Tables, Hyperlinks, Document Structure, Top
  1156. @chapter Tables
  1157. @cindex tables
  1158. @cindex editing tables
  1159. Org comes with a fast and intuitive table editor. Spreadsheet-like
  1160. calculations are supported in connection with the Emacs @file{calc}
  1161. package
  1162. @ifinfo
  1163. (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
  1164. @end ifinfo
  1165. @ifnotinfo
  1166. (see the Emacs Calculator manual for more information about the Emacs
  1167. calculator).
  1168. @end ifnotinfo
  1169. @menu
  1170. * Built-in table editor:: Simple tables
  1171. * Narrow columns:: Stop wasting space in tables
  1172. * Column groups:: Grouping to trigger vertical lines
  1173. * Orgtbl mode:: The table editor as minor mode
  1174. * The spreadsheet:: The table editor has spreadsheet capabilities
  1175. * Org Plot:: Plotting from org tables
  1176. @end menu
  1177. @node Built-in table editor, Narrow columns, Tables, Tables
  1178. @section The built-in table editor
  1179. @cindex table editor, built-in
  1180. Org makes it easy to format tables in plain ASCII. Any line with
  1181. @samp{|} as the first non-whitespace character is considered part of a
  1182. table. @samp{|} is also the column separator. A table might look like
  1183. this:
  1184. @example
  1185. | Name | Phone | Age |
  1186. |-------+-------+-----|
  1187. | Peter | 1234 | 17 |
  1188. | Anna | 4321 | 25 |
  1189. @end example
  1190. A table is re-aligned automatically each time you press @key{TAB} or
  1191. @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
  1192. the next field (@key{RET} to the next row) and creates new table rows
  1193. at the end of the table or before horizontal lines. The indentation
  1194. of the table is set by the first line. Any line starting with
  1195. @samp{|-} is considered as a horizontal separator line and will be
  1196. expanded on the next re-align to span the whole table width. So, to
  1197. create the above table, you would only type
  1198. @example
  1199. |Name|Phone|Age|
  1200. |-
  1201. @end example
  1202. @noindent and then press @key{TAB} to align the table and start filling in
  1203. fields.
  1204. When typing text into a field, Org treats @key{DEL},
  1205. @key{Backspace}, and all character keys in a special way, so that
  1206. inserting and deleting avoids shifting other fields. Also, when
  1207. typing @emph{immediately after the cursor was moved into a new field
  1208. with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
  1209. field is automatically made blank. If this behavior is too
  1210. unpredictable for you, configure the variables
  1211. @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
  1212. @table @kbd
  1213. @tsubheading{Creation and conversion}
  1214. @kindex C-c |
  1215. @item C-c |
  1216. Convert the active region to table. If every line contains at least one
  1217. TAB character, the function assumes that the material is tab separated.
  1218. If every line contains a comma, comma-separated values (CSV) are assumed.
  1219. If not, lines are split at whitespace into fields. You can use a prefix
  1220. argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
  1221. C-u} forces TAB, and a numeric argument N indicates that at least N
  1222. consecutive spaces, or alternatively a TAB will be the separator.
  1223. @*
  1224. If there is no active region, this command creates an empty Org
  1225. table. But it's easier just to start typing, like
  1226. @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
  1227. @tsubheading{Re-aligning and field motion}
  1228. @kindex C-c C-c
  1229. @item C-c C-c
  1230. Re-align the table without moving the cursor.
  1231. @c
  1232. @kindex @key{TAB}
  1233. @item @key{TAB}
  1234. Re-align the table, move to the next field. Creates a new row if
  1235. necessary.
  1236. @c
  1237. @kindex S-@key{TAB}
  1238. @item S-@key{TAB}
  1239. Re-align, move to previous field.
  1240. @c
  1241. @kindex @key{RET}
  1242. @item @key{RET}
  1243. Re-align the table and move down to next row. Creates a new row if
  1244. necessary. At the beginning or end of a line, @key{RET} still does
  1245. NEWLINE, so it can be used to split a table.
  1246. @tsubheading{Column and row editing}
  1247. @kindex M-@key{left}
  1248. @kindex M-@key{right}
  1249. @item M-@key{left}
  1250. @itemx M-@key{right}
  1251. Move the current column left/right.
  1252. @c
  1253. @kindex M-S-@key{left}
  1254. @item M-S-@key{left}
  1255. Kill the current column.
  1256. @c
  1257. @kindex M-S-@key{right}
  1258. @item M-S-@key{right}
  1259. Insert a new column to the left of the cursor position.
  1260. @c
  1261. @kindex M-@key{up}
  1262. @kindex M-@key{down}
  1263. @item M-@key{up}
  1264. @itemx M-@key{down}
  1265. Move the current row up/down.
  1266. @c
  1267. @kindex M-S-@key{up}
  1268. @item M-S-@key{up}
  1269. Kill the current row or horizontal line.
  1270. @c
  1271. @kindex M-S-@key{down}
  1272. @item M-S-@key{down}
  1273. Insert a new row above the current row. With a prefix argument, the line is
  1274. created below the current one.
  1275. @c
  1276. @kindex C-c -
  1277. @item C-c -
  1278. Insert a horizontal line below current row. With a prefix argument, the line
  1279. is created above the current line.
  1280. @c
  1281. @kindex C-c ^
  1282. @item C-c ^
  1283. Sort the table lines in the region. The position of point indicates the
  1284. column to be used for sorting, and the range of lines is the range
  1285. between the nearest horizontal separator lines, or the entire table. If
  1286. point is before the first column, you will be prompted for the sorting
  1287. column. If there is an active region, the mark specifies the first line
  1288. and the sorting column, while point should be in the last line to be
  1289. included into the sorting. The command prompts for the sorting type
  1290. (alphabetically, numerically, or by time). When called with a prefix
  1291. argument, alphabetic sorting will be case-sensitive.
  1292. @tsubheading{Regions}
  1293. @kindex C-c C-x M-w
  1294. @item C-c C-x M-w
  1295. Copy a rectangular region from a table to a special clipboard. Point
  1296. and mark determine edge fields of the rectangle. The process ignores
  1297. horizontal separator lines.
  1298. @c
  1299. @kindex C-c C-x C-w
  1300. @item C-c C-x C-w
  1301. Copy a rectangular region from a table to a special clipboard, and
  1302. blank all fields in the rectangle. So this is the ``cut'' operation.
  1303. @c
  1304. @kindex C-c C-x C-y
  1305. @item C-c C-x C-y
  1306. Paste a rectangular region into a table.
  1307. The upper left corner ends up in the current field. All involved fields
  1308. will be overwritten. If the rectangle does not fit into the present table,
  1309. the table is enlarged as needed. The process ignores horizontal separator
  1310. lines.
  1311. @c
  1312. @kindex C-c C-q
  1313. @kindex M-@key{RET}
  1314. @item C-c C-q
  1315. @itemx M-@kbd{RET}
  1316. Wrap several fields in a column like a paragraph. If there is an active
  1317. region, and both point and mark are in the same column, the text in the
  1318. column is wrapped to minimum width for the given number of lines. A numeric
  1319. prefix argument may be used to change the number of desired lines. If there
  1320. is no region, the current field is split at the cursor position and the text
  1321. fragment to the right of the cursor is prepended to the field one line
  1322. down. If there is no region, but you specify a prefix argument, the current
  1323. field is made blank, and the content is appended to the field above.
  1324. @tsubheading{Calculations}
  1325. @cindex formula, in tables
  1326. @cindex calculations, in tables
  1327. @cindex region, active
  1328. @cindex active region
  1329. @cindex Transient mark mode
  1330. @kindex C-c +
  1331. @item C-c +
  1332. Sum the numbers in the current column, or in the rectangle defined by
  1333. the active region. The result is shown in the echo area and can
  1334. be inserted with @kbd{C-y}.
  1335. @c
  1336. @kindex S-@key{RET}
  1337. @item S-@key{RET}
  1338. When current field is empty, copy from first non-empty field above. When not
  1339. empty, copy current field down to next row and move cursor along with it.
  1340. Depending on the variable @code{org-table-copy-increment}, integer field
  1341. values will be incremented during copy. Integers that are too large will not
  1342. be incremented. Also, a @code{0} prefix argument temporarily dispables the
  1343. increment. This key is also used by CUA mode (@pxref{Cooperation}).
  1344. @tsubheading{Miscellaneous}
  1345. @kindex C-c `
  1346. @item C-c `
  1347. Edit the current field in a separate window. This is useful for fields
  1348. that are not fully visible (@pxref{Narrow columns}). When called with a
  1349. @kbd{C-u} prefix, just make the full field visible, so that it can be
  1350. edited in place.
  1351. @c
  1352. @item M-x org-table-import
  1353. Import a file as a table. The table should be TAB- or whitespace
  1354. separated. Useful, for example, to import a spreadsheet table or data
  1355. from a database, because these programs generally can write
  1356. TAB-separated text files. This command works by inserting the file into
  1357. the buffer and then converting the region to a table. Any prefix
  1358. argument is passed on to the converter, which uses it to determine the
  1359. separator.
  1360. @item C-c |
  1361. Tables can also be imported by pasting tabular text into the Org
  1362. buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
  1363. @kbd{C-c |} command (see above under @i{Creation and conversion}).
  1364. @c
  1365. @item M-x org-table-export
  1366. Export the table, by default as a TAB-separated file. Useful for data
  1367. exchange with, for example, spreadsheet or database programs. The format
  1368. used to export the file can be configured in the variable
  1369. @code{org-table-export-default-format}. You may also use properties
  1370. @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
  1371. name and the format for table export in a subtree. Org supports quite
  1372. general formats for exported tables. The exporter format is the same as the
  1373. format used by Orgtbl radio tables, see @ref{Translator functions} for a
  1374. detailed description.
  1375. @end table
  1376. If you don't like the automatic table editor because it gets in your
  1377. way on lines which you would like to start with @samp{|}, you can turn
  1378. it off with
  1379. @lisp
  1380. (setq org-enable-table-editor nil)
  1381. @end lisp
  1382. @noindent Then the only table command that still works is
  1383. @kbd{C-c C-c} to do a manual re-align.
  1384. @node Narrow columns, Column groups, Built-in table editor, Tables
  1385. @section Narrow columns
  1386. @cindex narrow columns in tables
  1387. The width of columns is automatically determined by the table editor.
  1388. Sometimes a single field or a few fields need to carry more text,
  1389. leading to inconveniently wide columns. To limit@footnote{This feature
  1390. does not work on XEmacs.} the width of a column, one field anywhere in
  1391. the column may contain just the string @samp{<N>} where @samp{N} is an
  1392. integer specifying the width of the column in characters. The next
  1393. re-align will then set the width of this column to no more than this
  1394. value.
  1395. @example
  1396. @group
  1397. |---+------------------------------| |---+--------|
  1398. | | | | | <6> |
  1399. | 1 | one | | 1 | one |
  1400. | 2 | two | ----\ | 2 | two |
  1401. | 3 | This is a long chunk of text | ----/ | 3 | This=> |
  1402. | 4 | four | | 4 | four |
  1403. |---+------------------------------| |---+--------|
  1404. @end group
  1405. @end example
  1406. @noindent
  1407. Fields that are wider become clipped and end in the string @samp{=>}.
  1408. Note that the full text is still in the buffer, it is only invisible.
  1409. To see the full text, hold the mouse over the field - a tool-tip window
  1410. will show the full content. To edit such a field, use the command
  1411. @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
  1412. open a new window with the full field. Edit it and finish with @kbd{C-c
  1413. C-c}.
  1414. When visiting a file containing a table with narrowed columns, the
  1415. necessary character hiding has not yet happened, and the table needs to
  1416. be aligned before it looks nice. Setting the option
  1417. @code{org-startup-align-all-tables} will realign all tables in a file
  1418. upon visiting, but also slow down startup. You can also set this option
  1419. on a per-file basis with:
  1420. @example
  1421. #+STARTUP: align
  1422. #+STARTUP: noalign
  1423. @end example
  1424. @node Column groups, Orgtbl mode, Narrow columns, Tables
  1425. @section Column groups
  1426. @cindex grouping columns in tables
  1427. When Org exports tables, it does so by default without vertical
  1428. lines because that is visually more satisfying in general. Occasionally
  1429. however, vertical lines can be useful to structure a table into groups
  1430. of columns, much like horizontal lines can do for groups of rows. In
  1431. order to specify column groups, you can use a special row where the
  1432. first field contains only @samp{/}. The further fields can either
  1433. contain @samp{<} to indicate that this column should start a group,
  1434. @samp{>} to indicate the end of a column, or @samp{<>} to make a column
  1435. a group of its own. Boundaries between column groups will upon export be
  1436. marked with vertical lines. Here is an example:
  1437. @example
  1438. | | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  1439. |---+----+-----+-----+-----+---------+------------|
  1440. | / | <> | < | | > | < | > |
  1441. | # | 1 | 1 | 1 | 1 | 1 | 1 |
  1442. | # | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
  1443. | # | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
  1444. |---+----+-----+-----+-----+---------+------------|
  1445. #+TBLFM: $3=$2^2::$4=$2^3::$5=$2^4::$6=sqrt($2)::$7=sqrt(sqrt(($2)))
  1446. @end example
  1447. It is also sufficient to just insert the column group starters after
  1448. every vertical line you'd like to have:
  1449. @example
  1450. | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
  1451. |----+-----+-----+-----+---------+------------|
  1452. | / | < | | | < | |
  1453. @end example
  1454. @node Orgtbl mode, The spreadsheet, Column groups, Tables
  1455. @section The Orgtbl minor mode
  1456. @cindex Orgtbl mode
  1457. @cindex minor mode for tables
  1458. If you like the intuitive way the Org table editor works, you
  1459. might also want to use it in other modes like Text mode or Mail mode.
  1460. The minor mode Orgtbl mode makes this possible. You can always toggle
  1461. the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
  1462. example in mail mode, use
  1463. @lisp
  1464. (add-hook 'mail-mode-hook 'turn-on-orgtbl)
  1465. @end lisp
  1466. Furthermore, with some special setup, it is possible to maintain tables
  1467. in arbitrary syntax with Orgtbl mode. For example, it is possible to
  1468. construct La@TeX{} tables with the underlying ease and power of
  1469. Orgtbl mode, including spreadsheet capabilities. For details, see
  1470. @ref{Tables in arbitrary syntax}.
  1471. @node The spreadsheet, Org Plot, Orgtbl mode, Tables
  1472. @section The spreadsheet
  1473. @cindex calculations, in tables
  1474. @cindex spreadsheet capabilities
  1475. @cindex @file{calc} package
  1476. The table editor makes use of the Emacs @file{calc} package to implement
  1477. spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
  1478. derive fields from other fields. While fully featured, Org's
  1479. implementation is not identical to other spreadsheets. For example,
  1480. Org knows the concept of a @emph{column formula} that will be
  1481. applied to all non-header fields in a column without having to copy the
  1482. formula to each relevant field.
  1483. @menu
  1484. * References:: How to refer to another field or range
  1485. * Formula syntax for Calc:: Using Calc to compute stuff
  1486. * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
  1487. * Field formulas:: Formulas valid for a single field
  1488. * Column formulas:: Formulas valid for an entire column
  1489. * Editing and debugging formulas:: Fixing formulas
  1490. * Updating the table:: Recomputing all dependent fields
  1491. * Advanced features:: Field names, parameters and automatic recalc
  1492. @end menu
  1493. @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
  1494. @subsection References
  1495. @cindex references
  1496. To compute fields in the table from other fields, formulas must
  1497. reference other fields or ranges. In Org, fields can be referenced
  1498. by name, by absolute coordinates, and by relative coordinates. To find
  1499. out what the coordinates of a field are, press @kbd{C-c ?} in that
  1500. field, or press @kbd{C-c @}} to toggle the display of a grid.
  1501. @subsubheading Field references
  1502. @cindex field references
  1503. @cindex references, to fields
  1504. Formulas can reference the value of another field in two ways. Like in
  1505. any other spreadsheet, you may reference fields with a letter/number
  1506. combination like @code{B3}, meaning the 2nd field in the 3rd row.
  1507. @c Such references are always fixed to that field, they don't change
  1508. @c when you copy and paste a formula to a different field. So
  1509. @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
  1510. @noindent
  1511. Org also uses another, more general operator that looks like this:
  1512. @example
  1513. @@row$column
  1514. @end example
  1515. @noindent
  1516. Column references can be absolute like @samp{1}, @samp{2},...@samp{N},
  1517. or relative to the current column like @samp{+1} or @samp{-2}.
  1518. The row specification only counts data lines and ignores horizontal
  1519. separator lines (hlines). You can use absolute row numbers
  1520. @samp{1}...@samp{N}, and row numbers relative to the current row like
  1521. @samp{+3} or @samp{-1}. Or specify the row relative to one of the
  1522. hlines: @samp{I} refers to the first hline@footnote{Note that only
  1523. hlines are counted that @emph{separate} table lines. If the table
  1524. starts with a hline above the header, it does not count.}, @samp{II} to
  1525. the second etc. @samp{-I} refers to the first such line above the
  1526. current line, @samp{+I} to the first such line below the current line.
  1527. You can also write @samp{III+2} which is the second data line after the
  1528. third hline in the table. Relative row numbers like @samp{-3} will not
  1529. cross hlines if the current line is too close to the hline. Instead,
  1530. the value directly at the hline is used.
  1531. @samp{0} refers to the current row and column. Also, if you omit
  1532. either the column or the row part of the reference, the current
  1533. row/column is implied.
  1534. Org's references with @emph{unsigned} numbers are fixed references
  1535. in the sense that if you use the same reference in the formula for two
  1536. different fields, the same field will be referenced each time.
  1537. Org's references with @emph{signed} numbers are floating
  1538. references because the same reference operator can reference different
  1539. fields depending on the field being calculated by the formula.
  1540. Here are a few examples:
  1541. @example
  1542. @@2$3 @r{2nd row, 3rd column}
  1543. C2 @r{same as previous}
  1544. $5 @r{column 5 in the current row}
  1545. E& @r{same as previous}
  1546. @@2 @r{current column, row 2}
  1547. @@-1$-3 @r{the field one row up, three columns to the left}
  1548. @@-I$2 @r{field just under hline above current row, column 2}
  1549. @end example
  1550. @subsubheading Range references
  1551. @cindex range references
  1552. @cindex references, to ranges
  1553. You may reference a rectangular range of fields by specifying two field
  1554. references connected by two dots @samp{..}. If both fields are in the
  1555. current row, you may simply use @samp{$2..$7}, but if at least one field
  1556. is in a different row, you need to use the general @code{@@row$column}
  1557. format at least for the first field (i.e the reference must start with
  1558. @samp{@@} in order to be interpreted correctly). Examples:
  1559. @example
  1560. $1..$3 @r{First three fields in the current row.}
  1561. $P..$Q @r{Range, using column names (see under Advanced)}
  1562. @@2$1..@@4$3 @r{6 fields between these two fields.}
  1563. A2..C4 @r{Same as above.}
  1564. @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
  1565. @end example
  1566. @noindent Range references return a vector of values that can be fed
  1567. into Calc vector functions. Empty fields in ranges are normally
  1568. suppressed, so that the vector contains only the non-empty fields (but
  1569. see the @samp{E} mode switch below). If there are no non-empty fields,
  1570. @samp{[0]} is returned to avoid syntax errors in formulas.
  1571. @subsubheading Named references
  1572. @cindex named references
  1573. @cindex references, named
  1574. @cindex name, of column or field
  1575. @cindex constants, in calculations
  1576. @samp{$name} is interpreted as the name of a column, parameter or
  1577. constant. Constants are defined globally through the variable
  1578. @code{org-table-formula-constants}, and locally (for the file) through a
  1579. line like
  1580. @example
  1581. #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
  1582. @end example
  1583. @noindent
  1584. Also properties (@pxref{Properties and Columns}) can be used as
  1585. constants in table formulas: For a property @samp{:Xyz:} use the name
  1586. @samp{$PROP_Xyz}, and the property will be searched in the current
  1587. outline entry and in the hierarchy above it. If you have the
  1588. @file{constants.el} package, it will also be used to resolve constants,
  1589. including natural constants like @samp{$h} for Planck's constant, and
  1590. units like @samp{$km} for kilometers@footnote{@file{Constant.el} can
  1591. supply the values of constants in two different unit systems, @code{SI}
  1592. and @code{cgs}. Which one is used depends on the value of the variable
  1593. @code{constants-unit-system}. You can use the @code{#+STARTUP} options
  1594. @code{constSI} and @code{constcgs} to set this value for the current
  1595. buffer.}. Column names and parameters can be specified in special table
  1596. lines. These are described below, see @ref{Advanced features}. All
  1597. names must start with a letter, and further consist of letters and
  1598. numbers.
  1599. @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
  1600. @subsection Formula syntax for Calc
  1601. @cindex formula syntax, Calc
  1602. @cindex syntax, of formulas
  1603. A formula can be any algebraic expression understood by the Emacs
  1604. @file{Calc} package. @b{Note that @file{calc} has the
  1605. non-standard convention that @samp{/} has lower precedence than
  1606. @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
  1607. evaluation by @code{calc-eval} (@pxref{Calling Calc from
  1608. Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
  1609. Emacs Calc Manual}),
  1610. @c FIXME: The link to the Calc manual in HTML does not work.
  1611. variable substitution takes place according to the rules described above.
  1612. @cindex vectors, in table calculations
  1613. The range vectors can be directly fed into the Calc vector functions
  1614. like @samp{vmean} and @samp{vsum}.
  1615. @cindex format specifier
  1616. @cindex mode, for @file{calc}
  1617. A formula can contain an optional mode string after a semicolon. This
  1618. string consists of flags to influence Calc and other modes during
  1619. execution. By default, Org uses the standard Calc modes (precision
  1620. 12, angular units degrees, fraction and symbolic modes off). The display
  1621. format, however, has been changed to @code{(float 5)} to keep tables
  1622. compact. The default settings can be configured using the variable
  1623. @code{org-calc-default-modes}.
  1624. @example
  1625. p20 @r{switch the internal precision to 20 digits}
  1626. n3 s3 e2 f4 @r{normal, scientific, engineering, or fixed display format}
  1627. D R @r{angle modes: degrees, radians}
  1628. F S @r{fraction and symbolic modes}
  1629. N @r{interpret all fields as numbers, use 0 for non-numbers}
  1630. T @r{force text interpretation}
  1631. E @r{keep empty fields in ranges}
  1632. @end example
  1633. @noindent
  1634. In addition, you may provide a @code{printf} format specifier to
  1635. reformat the final result. A few examples:
  1636. @example
  1637. $1+$2 @r{Sum of first and second field}
  1638. $1+$2;%.2f @r{Same, format result to two decimals}
  1639. exp($2)+exp($1) @r{Math functions can be used}
  1640. $0;%.1f @r{Reformat current cell to 1 decimal}
  1641. ($3-32)*5/9 @r{Degrees F -> C conversion}
  1642. $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
  1643. tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
  1644. sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
  1645. vmean($2..$7) @r{Compute column range mean, using vector function}
  1646. vmean($2..$7);EN @r{Same, but treat empty fields as 0}
  1647. taylor($3,x=7,2) @r{taylor series of $3, at x=7, second degree}
  1648. @end example
  1649. Calc also contains a complete set of logical operations. For example
  1650. @example
  1651. if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
  1652. @end example
  1653. @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
  1654. @subsection Emacs Lisp forms as formulas
  1655. @cindex Lisp forms, as table formulas
  1656. It is also possible to write a formula in Emacs Lisp; this can be useful
  1657. for string manipulation and control structures, if the Calc's
  1658. functionality is not enough. If a formula starts with a single quote
  1659. followed by an opening parenthesis, then it is evaluated as a lisp form.
  1660. The evaluation should return either a string or a number. Just as with
  1661. @file{calc} formulas, you can specify modes and a printf format after a
  1662. semicolon. With Emacs Lisp forms, you need to be conscious about the way
  1663. field references are interpolated into the form. By default, a
  1664. reference will be interpolated as a Lisp string (in double quotes)
  1665. containing the field. If you provide the @samp{N} mode switch, all
  1666. referenced elements will be numbers (non-number fields will be zero) and
  1667. interpolated as Lisp numbers, without quotes. If you provide the
  1668. @samp{L} flag, all fields will be interpolated literally, without quotes.
  1669. I.e., if you want a reference to be interpreted as a string by the Lisp
  1670. form, enclose the reference operator itself in double quotes, like
  1671. @code{"$3"}. Ranges are inserted as space-separated fields, so you can
  1672. embed them in list or vector syntax. A few examples, note how the
  1673. @samp{N} mode is used when we do computations in lisp.
  1674. @example
  1675. @r{Swap the first two characters of the content of column 1}
  1676. '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
  1677. @r{Add columns 1 and 2, equivalent to the Calc's @code{$1+$2}}
  1678. '(+ $1 $2);N
  1679. @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
  1680. '(apply '+ '($1..$4));N
  1681. @end example
  1682. @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
  1683. @subsection Field formulas
  1684. @cindex field formula
  1685. @cindex formula, for individual table field
  1686. To assign a formula to a particular field, type it directly into the
  1687. field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
  1688. press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
  1689. the field, the formula will be stored as the formula for this field,
  1690. evaluated, and the current field replaced with the result.
  1691. Formulas are stored in a special line starting with @samp{#+TBLFM:}
  1692. directly below the table. If you typed the equation in the 4th field of
  1693. the 3rd data line in the table, the formula will look like
  1694. @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
  1695. with the appropriate commands, @i{absolute references} (but not relative
  1696. ones) in stored formulas are modified in order to still reference the
  1697. same field. Of cause this is not true if you edit the table structure
  1698. with normal editing commands - then you must fix the equations yourself.
  1699. Instead of typing an equation into the field, you may also use the
  1700. following command
  1701. @table @kbd
  1702. @kindex C-u C-c =
  1703. @item C-u C-c =
  1704. Install a new formula for the current field. The command prompts for a
  1705. formula, with default taken from the @samp{#+TBLFM:} line, applies
  1706. it to the current field and stores it.
  1707. @end table
  1708. @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
  1709. @subsection Column formulas
  1710. @cindex column formula
  1711. @cindex formula, for table column
  1712. Often in a table, the same formula should be used for all fields in a
  1713. particular column. Instead of having to copy the formula to all fields
  1714. in that column, Org allows to assign a single formula to an entire
  1715. column. If the table contains horizontal separator hlines, everything
  1716. before the first such line is considered part of the table @emph{header}
  1717. and will not be modified by column formulas.
  1718. To assign a formula to a column, type it directly into any field in the
  1719. column, preceded by an equal sign, like @samp{=$1+$2}. When you press
  1720. @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the
  1721. field, the formula will be stored as the formula for the current column,
  1722. evaluated and the current field replaced with the result. If the field
  1723. contains only @samp{=}, the previously stored formula for this column is
  1724. used. For each column, Org will only remember the most recently
  1725. used formula. In the @samp{TBLFM:} line, column formulas will look like
  1726. @samp{$4=$1+$2}.
  1727. Instead of typing an equation into the field, you may also use the
  1728. following command:
  1729. @table @kbd
  1730. @kindex C-c =
  1731. @item C-c =
  1732. Install a new formula for the current column and replace current field with
  1733. the result of the formula. The command prompts for a formula, with default
  1734. taken from the @samp{#+TBLFM} line, applies it to the current field and
  1735. stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command
  1736. will apply it to that many consecutive fields in the current column.
  1737. @end table
  1738. @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
  1739. @subsection Editing and debugging formulas
  1740. @cindex formula editing
  1741. @cindex editing, of table formulas
  1742. You can edit individual formulas in the minibuffer or directly in the
  1743. field. Org can also prepare a special buffer with all active
  1744. formulas of a table. When offering a formula for editing, Org
  1745. converts references to the standard format (like @code{B3} or @code{D&})
  1746. if possible. If you prefer to only work with the internal format (like
  1747. @code{@@3$2} or @code{$4}), configure the variable
  1748. @code{org-table-use-standard-references}.
  1749. @table @kbd
  1750. @kindex C-c =
  1751. @kindex C-u C-c =
  1752. @item C-c =
  1753. @itemx C-u C-c =
  1754. Edit the formula associated with the current column/field in the
  1755. minibuffer. See @ref{Column formulas} and @ref{Field formulas}.
  1756. @kindex C-u C-u C-c =
  1757. @item C-u C-u C-c =
  1758. Re-insert the active formula (either a
  1759. field formula, or a column formula) into the current field, so that you
  1760. can edit it directly in the field. The advantage over editing in the
  1761. minibuffer is that you can use the command @kbd{C-c ?}.
  1762. @kindex C-c ?
  1763. @item C-c ?
  1764. While editing a formula in a table field, highlight the field(s)
  1765. referenced by the reference at the cursor position in the formula.
  1766. @kindex C-c @}
  1767. @item C-c @}
  1768. Toggle the display of row and column numbers for a table, using
  1769. overlays. These are updated each time the table is aligned, you can
  1770. force it with @kbd{C-c C-c}.
  1771. @kindex C-c @{
  1772. @item C-c @{
  1773. Toggle the formula debugger on and off. See below.
  1774. @kindex C-c '
  1775. @item C-c '
  1776. Edit all formulas for the current table in a special buffer, where the
  1777. formulas will be displayed one per line. If the current field has an
  1778. active formula, the cursor in the formula editor will mark it.
  1779. While inside the special buffer, Org will automatically highlight
  1780. any field or range reference at the cursor position. You may edit,
  1781. remove and add formulas, and use the following commands:
  1782. @table @kbd
  1783. @kindex C-c C-c
  1784. @kindex C-x C-s
  1785. @item C-c C-c
  1786. @itemx C-x C-s
  1787. Exit the formula editor and store the modified formulas. With @kbd{C-u}
  1788. prefix, also apply the new formulas to the entire table.
  1789. @kindex C-c C-q
  1790. @item C-c C-q
  1791. Exit the formula editor without installing changes.
  1792. @kindex C-c C-r
  1793. @item C-c C-r
  1794. Toggle all references in the formula editor between standard (like
  1795. @code{B3}) and internal (like @code{@@3$2}).
  1796. @kindex @key{TAB}
  1797. @item @key{TAB}
  1798. Pretty-print or indent lisp formula at point. When in a line containing
  1799. a lisp formula, format the formula according to Emacs Lisp rules.
  1800. Another @key{TAB} collapses the formula back again. In the open
  1801. formula, @key{TAB} re-indents just like in Emacs lisp mode.
  1802. @kindex M-@key{TAB}
  1803. @item M-@key{TAB}
  1804. Complete Lisp symbols, just like in Emacs lisp mode.
  1805. @kindex S-@key{up}
  1806. @kindex S-@key{down}
  1807. @kindex S-@key{left}
  1808. @kindex S-@key{right}
  1809. @item S-@key{up}/@key{down}/@key{left}/@key{right}
  1810. Shift the reference at point. For example, if the reference is
  1811. @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
  1812. This also works for relative references, and for hline references.
  1813. @kindex M-S-@key{up}
  1814. @kindex M-S-@key{down}
  1815. @item M-S-@key{up}/@key{down}
  1816. Move the test line for column formulas in the Org buffer up and
  1817. down.
  1818. @kindex M-@key{up}
  1819. @kindex M-@key{down}
  1820. @item M-@key{up}/@key{down}
  1821. Scroll the window displaying the table.
  1822. @kindex C-c @}
  1823. @item C-c @}
  1824. Turn the coordinate grid in the table on and off.
  1825. @end table
  1826. @end table
  1827. Making a table field blank does not remove the formula associated with
  1828. the field, because that is stored in a different line (the @samp{TBLFM}
  1829. line) - during the next recalculation the field will be filled again.
  1830. To remove a formula from a field, you have to give an empty reply when
  1831. prompted for the formula, or to edit the @samp{#+TBLFM} line.
  1832. @kindex C-c C-c
  1833. You may edit the @samp{#+TBLFM} directly and re-apply the changed
  1834. equations with @kbd{C-c C-c} in that line, or with the normal
  1835. recalculation commands in the table.
  1836. @subsubheading Debugging formulas
  1837. @cindex formula debugging
  1838. @cindex debugging, of table formulas
  1839. When the evaluation of a formula leads to an error, the field content
  1840. becomes the string @samp{#ERROR}. If you would like see what is going
  1841. on during variable substitution and calculation in order to find a bug,
  1842. turn on formula debugging in the @code{Tbl} menu and repeat the
  1843. calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
  1844. field. Detailed information will be displayed.
  1845. @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
  1846. @subsection Updating the table
  1847. @cindex recomputing table fields
  1848. @cindex updating, table
  1849. Recalculation of a table is normally not automatic, but needs to be
  1850. triggered by a command. See @ref{Advanced features} for a way to make
  1851. recalculation at least semi-automatically.
  1852. In order to recalculate a line of a table or the entire table, use the
  1853. following commands:
  1854. @table @kbd
  1855. @kindex C-c *
  1856. @item C-c *
  1857. Recalculate the current row by first applying the stored column formulas
  1858. from left to right, and all field formulas in the current row.
  1859. @c
  1860. @kindex C-u C-c *
  1861. @item C-u C-c *
  1862. @kindex C-u C-c C-c
  1863. @itemx C-u C-c C-c
  1864. Recompute the entire table, line by line. Any lines before the first
  1865. hline are left alone, assuming that these are part of the table header.
  1866. @c
  1867. @kindex C-u C-u C-c *
  1868. @kindex C-u C-u C-c C-c
  1869. @item C-u C-u C-c *
  1870. @itemx C-u C-u C-c C-c
  1871. Iterate the table by recomputing it until no further changes occur.
  1872. This may be necessary if some computed fields use the value of other
  1873. fields that are computed @i{later} in the calculation sequence.
  1874. @end table
  1875. @node Advanced features, , Updating the table, The spreadsheet
  1876. @subsection Advanced features
  1877. If you want the recalculation of fields to happen automatically, or if
  1878. you want to be able to assign @i{names} to fields and columns, you need
  1879. to reserve the first column of the table for special marking characters.
  1880. @table @kbd
  1881. @kindex C-#
  1882. @item C-#
  1883. Rotate the calculation mark in first column through the states @samp{},
  1884. @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
  1885. change all marks in the region.
  1886. @end table
  1887. Here is an example of a table that collects exam results of students and
  1888. makes use of these features:
  1889. @example
  1890. @group
  1891. |---+---------+--------+--------+--------+-------+------|
  1892. | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
  1893. |---+---------+--------+--------+--------+-------+------|
  1894. | ! | | P1 | P2 | P3 | Tot | |
  1895. | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
  1896. | ^ | | m1 | m2 | m3 | mt | |
  1897. |---+---------+--------+--------+--------+-------+------|
  1898. | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
  1899. | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
  1900. |---+---------+--------+--------+--------+-------+------|
  1901. | | Average | | | | 29.7 | |
  1902. | ^ | | | | | at | |
  1903. | $ | max=50 | | | | | |
  1904. |---+---------+--------+--------+--------+-------+------|
  1905. #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
  1906. @end group
  1907. @end example
  1908. @noindent @b{Important}: Please note that for these special tables,
  1909. recalculating the table with @kbd{C-u C-c *} will only affect rows that
  1910. are marked @samp{#} or @samp{*}, and fields that have a formula assigned
  1911. to the field itself. The column formulas are not applied in rows with
  1912. empty first field.
  1913. @cindex marking characters, tables
  1914. The marking characters have the following meaning:
  1915. @table @samp
  1916. @item !
  1917. The fields in this line define names for the columns, so that you may
  1918. refer to a column as @samp{$Tot} instead of @samp{$6}.
  1919. @item ^
  1920. This row defines names for the fields @emph{above} the row. With such
  1921. a definition, any formula in the table may use @samp{$m1} to refer to
  1922. the value @samp{10}. Also, if you assign a formula to a names field, it
  1923. will be stored as @samp{$name=...}.
  1924. @item _
  1925. Similar to @samp{^}, but defines names for the fields in the row
  1926. @emph{below}.
  1927. @item $
  1928. Fields in this row can define @emph{parameters} for formulas. For
  1929. example, if a field in a @samp{$} row contains @samp{max=50}, then
  1930. formulas in this table can refer to the value 50 using @samp{$max}.
  1931. Parameters work exactly like constants, only that they can be defined on
  1932. a per-table basis.
  1933. @item #
  1934. Fields in this row are automatically recalculated when pressing
  1935. @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
  1936. is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
  1937. lines will be left alone by this command.
  1938. @item *
  1939. Selects this line for global recalculation with @kbd{C-u C-c *}, but
  1940. not for automatic recalculation. Use this when automatic
  1941. recalculation slows down editing too much.
  1942. @item
  1943. Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
  1944. All lines that should be recalculated should be marked with @samp{#}
  1945. or @samp{*}.
  1946. @item /
  1947. Do not export this line. Useful for lines that contain the narrowing
  1948. @samp{<N>} markers.
  1949. @end table
  1950. Finally, just to whet your appetite on what can be done with the
  1951. fantastic @file{calc} package, here is a table that computes the Taylor
  1952. series of degree @code{n} at location @code{x} for a couple of
  1953. functions.
  1954. @example
  1955. @group
  1956. |---+-------------+---+-----+--------------------------------------|
  1957. | | Func | n | x | Result |
  1958. |---+-------------+---+-----+--------------------------------------|
  1959. | # | exp(x) | 1 | x | 1 + x |
  1960. | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
  1961. | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
  1962. | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
  1963. | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
  1964. | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
  1965. |---+-------------+---+-----+--------------------------------------|
  1966. #+TBLFM: $5=taylor($2,$4,$3);n3
  1967. @end group
  1968. @end example
  1969. @page
  1970. @node Org Plot, , The spreadsheet, Tables
  1971. @section Org Plot
  1972. @cindex graph, in tables
  1973. @cindex plot tables using gnuplot
  1974. Org Plot can produce 2D and 3D graphs of information stored in org tables
  1975. using @file{Gnuplot} (see @uref{http://www.gnuplot.info/, the Gnuplot
  1976. website}) and @file{gnuplot-mode} (see
  1977. @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html, the
  1978. gnuplot-mode website}). To see this in action ensure that you have both
  1979. Gnuplot and Gnuplot-mode installed on your system, then call
  1980. @code{org-plot/gnuplot} on the following table.
  1981. @example
  1982. @group
  1983. #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
  1984. | Sede | Max cites | H-index |
  1985. |-----------+-----------+---------|
  1986. | Chile | 257.72 | 21.39 |
  1987. | Leeds | 165.77 | 19.68 |
  1988. | Sao Paolo | 71.00 | 11.50 |
  1989. | Stockholm | 134.19 | 14.33 |
  1990. | Morelia | 257.56 | 17.67 |
  1991. @end group
  1992. @end example
  1993. Notice that Org Plot is smart enough to apply the tables headers as labels.
  1994. Further control over the labels, type, content, and appearance of plots can
  1995. be exercised through the @code{#+Plot:} lines preceding a table. See below
  1996. for a complete list of Org plot options. For more information and examples
  1997. @uref{http://orgmode.org/worg/org-tutorials/org-plot.php, the org-plot
  1998. tutorial}.
  1999. @subsubheading Plot Options
  2000. @table @code
  2001. @item set
  2002. Specify any @file{gnuplot} option to be set when graphing.
  2003. @item title
  2004. Specify the title of the plot.
  2005. @item ind
  2006. Specify which column of the table to use as the @code{x} axis.
  2007. @item deps
  2008. Specify the columns to graph as a lisp style list, surrounded by parenthesis
  2009. and separated by spaces for example @code{dep:(3 4)} to graph the third and
  2010. fourth columns (defaults to graphing all other columns aside from the ind
  2011. column).
  2012. @item type
  2013. Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
  2014. @item with
  2015. Specify a @code{with} option to be inserted for every col being plotted
  2016. (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
  2017. Defaults to 'lines'.
  2018. @item file
  2019. If you want to plot to a file specify the @code{"path/to/desired/output-file"}.
  2020. @item labels
  2021. List of labels to be used for the deps (defaults to column headers if they
  2022. exist).
  2023. @item line
  2024. Specify an entire line to be inserted in the gnuplot script.
  2025. @item map
  2026. When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
  2027. flat mapping rather than a @code{3d} slope.
  2028. @item script
  2029. If you want total control you can specify a script file (place the file name
  2030. between double quotes) which will be used to plot. Before plotting, every
  2031. instance of @code{$datafile} in the specified script will be replaced with
  2032. the path to the generated data file. Note even if you set this option you
  2033. may still want to specify the plot type, as that can impact the content of
  2034. the data file.
  2035. @end table
  2036. @node Hyperlinks, TODO Items, Tables, Top
  2037. @chapter Hyperlinks
  2038. @cindex hyperlinks
  2039. Like HTML, Org provides links inside a file, external links to
  2040. other files, Usenet articles, emails, and much more.
  2041. @menu
  2042. * Link format:: How links in Org are formatted
  2043. * Internal links:: Links to other places in the current file
  2044. * External links:: URL-like links to the world
  2045. * Handling links:: Creating, inserting and following
  2046. * Using links outside Org:: Linking from my C source code?
  2047. * Link abbreviations:: Shortcuts for writing complex links
  2048. * Search options:: Linking to a specific location
  2049. * Custom searches:: When the default search is not enough
  2050. @end menu
  2051. @node Link format, Internal links, Hyperlinks, Hyperlinks
  2052. @section Link format
  2053. @cindex link format
  2054. @cindex format, of links
  2055. Org will recognize plain URL-like links and activate them as
  2056. clickable links. The general link format, however, looks like this:
  2057. @example
  2058. [[link][description]] @r{or alternatively} [[link]]
  2059. @end example
  2060. Once a link in the buffer is complete (all brackets present), Org
  2061. will change the display so that @samp{description} is displayed instead
  2062. of @samp{[[link][description]]} and @samp{link} is displayed instead of
  2063. @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
  2064. which by default is an underlined face. You can directly edit the
  2065. visible part of a link. Note that this can be either the @samp{link}
  2066. part (if there is no description) or the @samp{description} part. To
  2067. edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
  2068. cursor on the link.
  2069. If you place the cursor at the beginning or just behind the end of the
  2070. displayed text and press @key{BACKSPACE}, you will remove the
  2071. (invisible) bracket at that location. This makes the link incomplete
  2072. and the internals are again displayed as plain text. Inserting the
  2073. missing bracket hides the link internals again. To show the
  2074. internal structure of all links, use the menu entry
  2075. @code{Org->Hyperlinks->Literal links}.
  2076. @node Internal links, External links, Link format, Hyperlinks
  2077. @section Internal links
  2078. @cindex internal links
  2079. @cindex links, internal
  2080. @cindex targets, for links
  2081. If the link does not look like a URL, it is considered to be internal in
  2082. the current file. Links such as @samp{[[My Target]]} or @samp{[[My
  2083. Target][Find my target]]} lead to a text search in the current file.
  2084. The link can be followed with @kbd{C-c C-o} when the cursor is on the
  2085. link, or with a mouse click (@pxref{Handling links}). The preferred
  2086. match for such a link is a dedicated target: the same string in double
  2087. angular brackets. Targets may be located anywhere; sometimes it is
  2088. convenient to put them into a comment line. For example
  2089. @example
  2090. # <<My Target>>
  2091. @end example
  2092. @noindent In HTML export (@pxref{HTML export}), such targets will become
  2093. named anchors for direct access through @samp{http} links@footnote{Note
  2094. that text before the first headline is usually not exported, so the
  2095. first such target should be after the first headline.}.
  2096. If no dedicated target exists, Org will search for the words in the
  2097. link. In the above example the search would be for @samp{my target}.
  2098. Links starting with a star like @samp{*My Target} restrict the search to
  2099. headlines. When searching, Org mode will first try an exact match, but
  2100. then move on to more and more lenient searches. For example, the link
  2101. @samp{[[*My Targets]]} will find any of the following:
  2102. @example
  2103. ** My targets
  2104. ** TODO my targets are bright
  2105. ** my 20 targets are
  2106. @end example
  2107. To insert a link targeting a headline, in-buffer completion can be used.
  2108. Just type a star followed by a few optional letters into the buffer and
  2109. press @kbd{M-@key{TAB}}. All headlines in the current buffer will be
  2110. offered as completions. @xref{Handling links}, for more commands
  2111. creating links.
  2112. Following a link pushes a mark onto Org's own mark ring. You can
  2113. return to the previous position with @kbd{C-c &}. Using this command
  2114. several times in direct succession goes back to positions recorded
  2115. earlier.
  2116. @menu
  2117. * Radio targets:: Make targets trigger links in plain text
  2118. @end menu
  2119. @node Radio targets, , Internal links, Internal links
  2120. @subsection Radio targets
  2121. @cindex radio targets
  2122. @cindex targets, radio
  2123. @cindex links, radio targets
  2124. Org can automatically turn any occurrences of certain target names
  2125. in normal text into a link. So without explicitly creating a link, the
  2126. text connects to the target radioing its position. Radio targets are
  2127. enclosed by triple angular brackets. For example, a target @samp{<<<My
  2128. Target>>>} causes each occurrence of @samp{my target} in normal text to
  2129. become activated as a link. The Org file is scanned automatically
  2130. for radio targets only when the file is first loaded into Emacs. To
  2131. update the target list during editing, press @kbd{C-c C-c} with the
  2132. cursor on or at a target.
  2133. @node External links, Handling links, Internal links, Hyperlinks
  2134. @section External links
  2135. @cindex links, external
  2136. @cindex external links
  2137. @cindex links, external
  2138. @cindex Gnus links
  2139. @cindex BBDB links
  2140. @cindex IRC links
  2141. @cindex URL links
  2142. @cindex file links
  2143. @cindex VM links
  2144. @cindex RMAIL links
  2145. @cindex WANDERLUST links
  2146. @cindex MH-E links
  2147. @cindex USENET links
  2148. @cindex SHELL links
  2149. @cindex Info links
  2150. @cindex elisp links
  2151. Org supports links to files, websites, Usenet and email messages,
  2152. BBDB database entries and links to both IRC conversations and their
  2153. logs. External links are URL-like locators. They start with a short
  2154. identifying string followed by a colon. There can be no space after
  2155. the colon. The following list shows examples for each link type.
  2156. @example
  2157. http://www.astro.uva.nl/~dominik @r{on the web}
  2158. file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
  2159. /home/dominik/images/jupiter.jpg @r{same as above}
  2160. file:papers/last.pdf @r{file, relative path}
  2161. ./papers/last.pdf @r{same as above}
  2162. news:comp.emacs @r{Usenet link}
  2163. mailto:adent@@galaxy.net @r{Mail link}
  2164. vm:folder @r{VM folder link}
  2165. vm:folder#id @r{VM message link}
  2166. vm://myself@@some.where.org/folder#id @r{VM on remote machine}
  2167. wl:folder @r{WANDERLUST folder link}
  2168. wl:folder#id @r{WANDERLUST message link}
  2169. mhe:folder @r{MH-E folder link}
  2170. mhe:folder#id @r{MH-E message link}
  2171. rmail:folder @r{RMAIL folder link}
  2172. rmail:folder#id @r{RMAIL message link}
  2173. gnus:group @r{Gnus group link}
  2174. gnus:group#id @r{Gnus article link}
  2175. bbdb:Richard Stallman @r{BBDB link}
  2176. irc:/irc.com/#emacs/bob @r{IRC link}
  2177. shell:ls *.org @r{A shell command}
  2178. elisp:(find-file-other-frame "Elisp.org") @r{An elisp form to evaluate}
  2179. @end example
  2180. A link should be enclosed in double brackets and may contain a
  2181. descriptive text to be displayed instead of the URL (@pxref{Link
  2182. format}), for example:
  2183. @example
  2184. [[http://www.gnu.org/software/emacs/][GNU Emacs]]
  2185. @end example
  2186. @noindent
  2187. If the description is a file name or URL that points to an image, HTML
  2188. export (@pxref{HTML export}) will inline the image as a clickable
  2189. button. If there is no description at all and the link points to an
  2190. image,
  2191. that image will be inlined into the exported HTML file.
  2192. @cindex angular brackets, around links
  2193. @cindex plain text external links
  2194. Org also finds external links in the normal text and activates them
  2195. as links. If spaces must be part of the link (for example in
  2196. @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
  2197. about the end of the link, enclose them in angular brackets.
  2198. @node Handling links, Using links outside Org, External links, Hyperlinks
  2199. @section Handling links
  2200. @cindex links, handling
  2201. Org provides methods to create a link in the correct syntax, to
  2202. insert it into an Org file, and to follow the link.
  2203. @table @kbd
  2204. @kindex C-c l
  2205. @cindex storing links
  2206. @item C-c l
  2207. Store a link to the current location. This is a @emph{global} command
  2208. which can be used in any buffer to create a link. The link will be
  2209. stored for later insertion into an Org buffer (see below). For
  2210. Org files, if there is a @samp{<<target>>} at the cursor, the
  2211. link points to the target. Otherwise it points to the current
  2212. headline. For VM, Rmail, Wanderlust, MH-E, Gnus and BBDB buffers, the
  2213. link will indicate the current article/entry. For W3 and W3M buffers,
  2214. the link goes to the current URL. For IRC links, if you set the
  2215. variable @code{org-irc-link-to-logs} to non-nil then @kbd{C-c l} will
  2216. store a @samp{file:/} style link to the relevant point in the logs for
  2217. the current conversation. Otherwise an @samp{irc:/} style link to the
  2218. user/channel/server under the point will be stored. For any other
  2219. files, the link will point to the file, with a search string
  2220. (@pxref{Search options}) pointing to the contents of the current line.
  2221. If there is an active region, the selected words will form the basis
  2222. of the search string. If the automatically created link is not
  2223. working correctly or accurately enough, you can write custom functions
  2224. to select the search string and to do the search for particular file
  2225. types - see @ref{Custom searches}. The key binding @kbd{C-c l} is
  2226. only a suggestion - see @ref{Installation}.
  2227. @c
  2228. @kindex C-c C-l
  2229. @cindex link completion
  2230. @cindex completion, of links
  2231. @cindex inserting links
  2232. @item C-c C-l
  2233. Insert a link. This prompts for a link to be inserted into the buffer. You
  2234. can just type a link, using text for an internal link, or one of the link
  2235. type prefixes mentioned in the examples above. All links stored during the
  2236. current session are part of the history for this prompt, so you can access
  2237. them with @key{up} and @key{down} (or @kbd{M-p/n}). Completion, on the other
  2238. hand, will help you to insert valid link prefixes like @samp{http:} or
  2239. @samp{ftp:}, including the prefixes defined through link abbreviations
  2240. (@pxref{Link abbreviations}). The link will be inserted into the
  2241. buffer@footnote{After insertion of a stored link, the link will be removed
  2242. from the list of stored links. To keep it in the list later use, use a
  2243. triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
  2244. @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
  2245. If some text was selected when this command is called, the selected text
  2246. becomes the default description.@* Note that you don't have to use this
  2247. command to insert a link. Links in Org are plain text, and you can type
  2248. or paste them straight into the buffer. By using this command, the links are
  2249. automatically enclosed in double brackets, and you will be asked for the
  2250. optional descriptive text.
  2251. @c
  2252. @c If the link is a @samp{file:} link and
  2253. @c the linked file is located in the same directory as the current file or
  2254. @c a subdirectory of it, the path of the file will be inserted relative to
  2255. @c the current directory.
  2256. @c
  2257. @kindex C-u C-c C-l
  2258. @cindex file name completion
  2259. @cindex completion, of file names
  2260. @item C-u C-c C-l
  2261. When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
  2262. a file will be inserted and you may use file name completion to select
  2263. the name of the file. The path to the file is inserted relative to the
  2264. directory of the current org file, if the linked file is in the current
  2265. directory or in a sub-directory of it, or if the path is written relative
  2266. to the current directory using @samp{../}. Otherwise an absolute path
  2267. is used, if possible with @samp{~/} for your home directory. You can
  2268. force an absolute path with two @kbd{C-u} prefixes.
  2269. @c
  2270. @item C-c C-l @r{(with cursor on existing link)}
  2271. When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
  2272. link and description parts of the link.
  2273. @c
  2274. @cindex following links
  2275. @kindex C-c C-o
  2276. @item C-c C-o
  2277. Open link at point. This will launch a web browser for URLs (using
  2278. @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
  2279. the corresponding links, and execute the command in a shell link. When the
  2280. cursor is on an internal link, this commands runs the corresponding search.
  2281. When the cursor is on a TAG list in a headline, it creates the corresponding
  2282. TAGS view. If the cursor is on a time stamp, it compiles the agenda for that
  2283. date. Furthermore, it will visit text and remote files in @samp{file:} links
  2284. with Emacs and select a suitable application for local non-text files.
  2285. Classification of files is based on file extension only. See option
  2286. @code{org-file-apps}. If you want to override the default application and
  2287. visit the file with Emacs, use a @kbd{C-u} prefix.
  2288. @c
  2289. @kindex mouse-2
  2290. @kindex mouse-1
  2291. @item mouse-2
  2292. @itemx mouse-1
  2293. On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
  2294. would. Under Emacs 22, also @kbd{mouse-1} will follow a link.
  2295. @c
  2296. @kindex mouse-3
  2297. @item mouse-3
  2298. Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
  2299. internal links to be displayed in another window@footnote{See the
  2300. variable @code{org-display-internal-link-with-indirect-buffer}}.
  2301. @c
  2302. @cindex mark ring
  2303. @kindex C-c %
  2304. @item C-c %
  2305. Push the current position onto the mark ring, to be able to return
  2306. easily. Commands following an internal link do this automatically.
  2307. @c
  2308. @cindex links, returning to
  2309. @kindex C-c &
  2310. @item C-c &
  2311. Jump back to a recorded position. A position is recorded by the
  2312. commands following internal links, and by @kbd{C-c %}. Using this
  2313. command several times in direct succession moves through a ring of
  2314. previously recorded positions.
  2315. @c
  2316. @kindex C-c C-x C-n
  2317. @kindex C-c C-x C-p
  2318. @cindex links, finding next/previous
  2319. @item C-c C-x C-n
  2320. @itemx C-c C-x C-p
  2321. Move forward/backward to the next link in the buffer. At the limit of
  2322. the buffer, the search fails once, and then wraps around. The key
  2323. bindings for this are really too long, you might want to bind this also
  2324. to @kbd{C-n} and @kbd{C-p}
  2325. @lisp
  2326. (add-hook 'org-load-hook
  2327. (lambda ()
  2328. (define-key 'org-mode-map "\C-n" 'org-next-link)
  2329. (define-key 'org-mode-map "\C-p" 'org-previous-link)))
  2330. @end lisp
  2331. @end table
  2332. @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
  2333. @section Using links outside Org
  2334. You can insert and follow links that have Org syntax not only in
  2335. Org, but in any Emacs buffer. For this, you should create two
  2336. global commands, like this (please select suitable global keys
  2337. yourself):
  2338. @lisp
  2339. (global-set-key "\C-c L" 'org-insert-link-global)
  2340. (global-set-key "\C-c o" 'org-open-at-point-global)
  2341. @end lisp
  2342. @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
  2343. @section Link abbreviations
  2344. @cindex link abbreviations
  2345. @cindex abbreviation, links
  2346. Long URLs can be cumbersome to type, and often many similar links are
  2347. needed in a document. For this you can use link abbreviations. An
  2348. abbreviated link looks like this
  2349. @example
  2350. [[linkword:tag][description]]
  2351. @end example
  2352. @noindent
  2353. where the tag is optional. Such abbreviations are resolved according to
  2354. the information in the variable @code{org-link-abbrev-alist} that
  2355. relates the linkwords to replacement text. Here is an example:
  2356. @lisp
  2357. @group
  2358. (setq org-link-abbrev-alist
  2359. '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
  2360. ("google" . "http://www.google.com/search?q=")
  2361. ("ads" . "http://adsabs.harvard.edu/cgi-bin/
  2362. nph-abs_connect?author=%s&db_key=AST")))
  2363. @end group
  2364. @end lisp
  2365. If the replacement text contains the string @samp{%s}, it will be
  2366. replaced with the tag. Otherwise the tag will be appended to the string
  2367. in order to create the link. You may also specify a function that will
  2368. be called with the tag as the only argument to create the link.
  2369. With the above setting, you could link to a specific bug with
  2370. @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
  2371. @code{[[google:OrgMode]]} and find out what the Org author is
  2372. doing besides Emacs hacking with @code{[[ads:Dominik,C]]}.
  2373. If you need special abbreviations just for a single Org buffer, you
  2374. can define them in the file with
  2375. @example
  2376. #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
  2377. #+LINK: google http://www.google.com/search?q=%s
  2378. @end example
  2379. @noindent
  2380. In-buffer completion @pxref{Completion} can be used after @samp{[} to
  2381. complete link abbreviations.
  2382. @node Search options, Custom searches, Link abbreviations, Hyperlinks
  2383. @section Search options in file links
  2384. @cindex search option in file links
  2385. @cindex file links, searching
  2386. File links can contain additional information to make Emacs jump to a
  2387. particular location in the file when following a link. This can be a
  2388. line number or a search option after a double@footnote{For backward
  2389. compatibility, line numbers can also follow a single colon.} colon. For
  2390. example, when the command @kbd{C-c l} creates a link (@pxref{Handling
  2391. links}) to a file, it encodes the words in the current line as a search
  2392. string that can be used to find this line back later when following the
  2393. link with @kbd{C-c C-o}.
  2394. Here is the syntax of the different ways to attach a search to a file
  2395. link, together with an explanation:
  2396. @example
  2397. [[file:~/code/main.c::255]]
  2398. [[file:~/xx.org::My Target]]
  2399. [[file:~/xx.org::*My Target]]
  2400. [[file:~/xx.org::/regexp/]]
  2401. @end example
  2402. @table @code
  2403. @item 255
  2404. Jump to line 255.
  2405. @item My Target
  2406. Search for a link target @samp{<<My Target>>}, or do a text search for
  2407. @samp{my target}, similar to the search in internal links, see
  2408. @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
  2409. link will become an HTML reference to the corresponding named anchor in
  2410. the linked file.
  2411. @item *My Target
  2412. In an Org file, restrict search to headlines.
  2413. @item /regexp/
  2414. Do a regular expression search for @code{regexp}. This uses the Emacs
  2415. command @code{occur} to list all matches in a separate window. If the
  2416. target file is in Org mode, @code{org-occur} is used to create a
  2417. sparse tree with the matches.
  2418. @c If the target file is a directory,
  2419. @c @code{grep} will be used to search all files in the directory.
  2420. @end table
  2421. As a degenerate case, a file link with an empty file name can be used
  2422. to search the current file. For example, @code{[[file:::find me]]} does
  2423. a search for @samp{find me} in the current file, just as
  2424. @samp{[[find me]]} would.
  2425. @node Custom searches, , Search options, Hyperlinks
  2426. @section Custom Searches
  2427. @cindex custom search strings
  2428. @cindex search strings, custom
  2429. The default mechanism for creating search strings and for doing the
  2430. actual search related to a file link may not work correctly in all
  2431. cases. For example, BibTeX database files have many entries like
  2432. @samp{year="1993"} which would not result in good search strings,
  2433. because the only unique identification for a BibTeX entry is the
  2434. citation key.
  2435. If you come across such a problem, you can write custom functions to set
  2436. the right search string for a particular file type, and to do the search
  2437. for the string in the file. Using @code{add-hook}, these functions need
  2438. to be added to the hook variables
  2439. @code{org-create-file-search-functions} and
  2440. @code{org-execute-file-search-functions}. See the docstring for these
  2441. variables for more information. Org actually uses this mechanism
  2442. for Bib@TeX{} database files, and you can use the corresponding code as
  2443. an implementation example. See the file @file{org-bibtex.el}.
  2444. @node TODO Items, Tags, Hyperlinks, Top
  2445. @chapter TODO Items
  2446. @cindex TODO items
  2447. Org mode does not maintain TODO lists as separate documents@footnote{Of
  2448. course, you can make a document that contains inly long lists of TODO items,
  2449. but this is not required.}. Instead, TODO items are an integral part of the
  2450. notes file, because TODO items usually come up while taking notes! With Org
  2451. mode, simply mark any entry in a tree as being a TODO item. In this way,
  2452. information is not duplicated, and the entire context from which the TODO
  2453. item emerged is always present.
  2454. Of course, this technique for managing TODO items scatters them
  2455. throughout your notes file. Org mode compensates for this by providing
  2456. methods to give you an overview of all the things that you have to do.
  2457. @menu
  2458. * TODO basics:: Marking and displaying TODO entries
  2459. * TODO extensions:: Workflow and assignments
  2460. * Progress logging:: Dates and notes for progress
  2461. * Priorities:: Some things are more important than others
  2462. * Breaking down tasks:: Splitting a task into manageable pieces
  2463. * Checkboxes:: Tick-off lists
  2464. @end menu
  2465. @node TODO basics, TODO extensions, TODO Items, TODO Items
  2466. @section Basic TODO functionality
  2467. Any headline becomes a TODO item when it starts with the word
  2468. @samp{TODO}, for example:
  2469. @example
  2470. *** TODO Write letter to Sam Fortune
  2471. @end example
  2472. @noindent
  2473. The most important commands to work with TODO entries are:
  2474. @table @kbd
  2475. @kindex C-c C-t
  2476. @cindex cycling, of TODO states
  2477. @item C-c C-t
  2478. Rotate the TODO state of the current item among
  2479. @example
  2480. ,-> (unmarked) -> TODO -> DONE --.
  2481. '--------------------------------'
  2482. @end example
  2483. The same rotation can also be done ``remotely'' from the timeline and
  2484. agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
  2485. @kindex C-u C-c C-t
  2486. @item C-u C-c C-t
  2487. Select a specific keyword using completion or (if it has been set up)
  2488. the fast selection interface. For the latter, you need to assign keys
  2489. to TODO states, see @ref{Per-file keywords} and @ref{Setting tags} for
  2490. more information.
  2491. @kindex S-@key{right}
  2492. @kindex S-@key{left}
  2493. @item S-@key{right}
  2494. @itemx S-@key{left}
  2495. Select the following/preceding TODO state, similar to cycling. Useful
  2496. mostly if more than two TODO states are possible (@pxref{TODO
  2497. extensions}).
  2498. @kindex C-c C-v
  2499. @kindex C-c / t
  2500. @cindex sparse tree, for TODO
  2501. @item C-c C-v
  2502. @itemx C-c / t
  2503. View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds
  2504. the entire buffer, but shows all TODO items and the headings hierarchy
  2505. above them. With a prefix argument, search for a specific TODO. You will be
  2506. prompted for the keyword, and you can also give a list of keywords like
  2507. @code{KWD1|KWD2|...}. With numeric prefix argument N, show the tree for the
  2508. Nth keyword in the variable @code{org-todo-keywords}. With two prefix
  2509. arguments, find all TODO and DONE entries.
  2510. @kindex C-c a t
  2511. @item C-c a t
  2512. Show the global TODO list. Collects the TODO items from all agenda
  2513. files (@pxref{Agenda Views}) into a single buffer. The new buffer will
  2514. be in @code{agenda-mode}, which provides commands to examine and
  2515. manipulate the TODO entries from the new buffer (@pxref{Agenda
  2516. commands}). @xref{Global TODO list}, for more information.
  2517. @kindex S-M-@key{RET}
  2518. @item S-M-@key{RET}
  2519. Insert a new TODO entry below the current one.
  2520. @end table
  2521. @noindent
  2522. Changing a TODO state can also trigger tag changes. See the docstring of the
  2523. option @code{org-todo-state-tags-triggers} for details.
  2524. @node TODO extensions, Progress logging, TODO basics, TODO Items
  2525. @section Extended use of TODO keywords
  2526. @cindex extended TODO keywords
  2527. By default, marked TODO entries have one of only two states: TODO and
  2528. DONE. Org mode allows you to classify TODO items in more complex ways
  2529. with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
  2530. special setup, the TODO keyword system can work differently in different
  2531. files.
  2532. Note that @i{tags} are another way to classify headlines in general and
  2533. TODO items in particular (@pxref{Tags}).
  2534. @menu
  2535. * Workflow states:: From TODO to DONE in steps
  2536. * TODO types:: I do this, Fred does the rest
  2537. * Multiple sets in one file:: Mixing it all, and still finding your way
  2538. * Fast access to TODO states:: Single letter selection of a state
  2539. * Per-file keywords:: Different files, different requirements
  2540. * Faces for TODO keywords:: Highlighting states
  2541. @end menu
  2542. @node Workflow states, TODO types, TODO extensions, TODO extensions
  2543. @subsection TODO keywords as workflow states
  2544. @cindex TODO workflow
  2545. @cindex workflow states as TODO keywords
  2546. You can use TODO keywords to indicate different @emph{sequential} states
  2547. in the process of working on an item, for example@footnote{Changing
  2548. this variable only becomes effective after restarting Org mode in a
  2549. buffer.}:
  2550. @lisp
  2551. (setq org-todo-keywords
  2552. '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
  2553. @end lisp
  2554. The vertical bar separates the TODO keywords (states that @emph{need
  2555. action}) from the DONE states (which need @emph{no further action}). If
  2556. you don't provide the separator bar, the last state is used as the DONE
  2557. state.
  2558. @cindex completion, of TODO keywords
  2559. With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
  2560. to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
  2561. also use a numeric prefix argument to quickly select a specific state. For
  2562. example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
  2563. Or you can use @kbd{S-left} to go backward through the sequence. If you
  2564. define many keywords, you can use in-buffer completion
  2565. (@pxref{Completion}) or even a special one-key selection scheme
  2566. (@pxref{Fast access to TODO states}) to insert these words into the
  2567. buffer. Changing a TODO state can be logged with a timestamp, see
  2568. @ref{Tracking TODO state changes} for more information.
  2569. @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
  2570. @subsection TODO keywords as types
  2571. @cindex TODO types
  2572. @cindex names as TODO keywords
  2573. @cindex types as TODO keywords
  2574. The second possibility is to use TODO keywords to indicate different
  2575. @emph{types} of action items. For example, you might want to indicate
  2576. that items are for ``work'' or ``home''. Or, when you work with several
  2577. people on a single project, you might want to assign action items
  2578. directly to persons, by using their names as TODO keywords. This would
  2579. be set up like this:
  2580. @lisp
  2581. (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
  2582. @end lisp
  2583. In this case, different keywords do not indicate a sequence, but rather
  2584. different types. So the normal work flow would be to assign a task to a
  2585. person, and later to mark it DONE. Org mode supports this style by adapting
  2586. the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
  2587. @kbd{t} command in the timeline and agenda buffers.}. When used several
  2588. times in succession, it will still cycle through all names, in order to first
  2589. select the right type for a task. But when you return to the item after some
  2590. time and execute @kbd{C-c C-t} again, it will switch from any name directly
  2591. to DONE. Use prefix arguments or completion to quickly select a specific
  2592. name. You can also review the items of a specific TODO type in a sparse tree
  2593. by using a numeric prefix to @kbd{C-c C-v}. For example, to see all things
  2594. Lucy has to do, you would use @kbd{C-3 C-c C-v}. To collect Lucy's items
  2595. from all agenda files into a single buffer, you would use the numeric prefix
  2596. argument as well when creating the global TODO list: @kbd{C-3 C-c t}.
  2597. @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
  2598. @subsection Multiple keyword sets in one file
  2599. @cindex TODO keyword sets
  2600. Sometimes you may want to use different sets of TODO keywords in
  2601. parallel. For example, you may want to have the basic
  2602. @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
  2603. separate state indicating that an item has been canceled (so it is not
  2604. DONE, but also does not require action). Your setup would then look
  2605. like this:
  2606. @lisp
  2607. (setq org-todo-keywords
  2608. '((sequence "TODO" "|" "DONE")
  2609. (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
  2610. (sequence "|" "CANCELED")))
  2611. @end lisp
  2612. The keywords should all be different, this helps Org mode to keep track
  2613. of which subsequence should be used for a given entry. In this setup,
  2614. @kbd{C-c C-t} only operates within a subsequence, so it switches from
  2615. @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
  2616. (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
  2617. select the correct sequence. Besides the obvious ways like typing a
  2618. keyword or using completion, you may also apply the following commands:
  2619. @table @kbd
  2620. @kindex C-S-@key{right}
  2621. @kindex C-S-@key{left}
  2622. @item C-S-@key{right}
  2623. @itemx C-S-@key{left}
  2624. These keys jump from one TODO subset to the next. In the above example,
  2625. @kbd{C-S-@key{right}} would jump from @code{TODO} or @code{DONE} to
  2626. @code{REPORT}, and any of the words in the second row to @code{CANCELED}.
  2627. @kindex S-@key{right}
  2628. @kindex S-@key{left}
  2629. @item S-@key{right}
  2630. @itemx S-@key{left}
  2631. @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through
  2632. @emph{all} keywords from all sets, so for example @kbd{S-@key{<right>}}
  2633. would switch from @code{DONE} to @code{REPORT} in the example above.
  2634. @end table
  2635. @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
  2636. @subsection Fast access to TODO states
  2637. If you would like to quickly change an entry to an arbitrary TODO state
  2638. instead of cycling through the states, you can set up keys for
  2639. single-letter access to the states. This is done by adding the section
  2640. key after each keyword, in parenthesis. For example:
  2641. @lisp
  2642. (setq org-todo-keywords
  2643. '((sequence "TODO(t)" "|" "DONE(d)")
  2644. (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
  2645. (sequence "|" "CANCELED(c)")))
  2646. @end lisp
  2647. If you then press @code{C-u C-c C-t} followed by the selection key, the
  2648. entry will be switched to this state. @key{SPC} can be used to remove
  2649. any TODO keyword from an entry. Should you like this way of selecting
  2650. TODO states a lot, you might want to set the variable
  2651. @code{org-use-fast-todo-selection} to @code{t} and make this behavior
  2652. the default. Check also the variable
  2653. @code{org-fast-tag-selection-include-todo}, it allows to change the TODO
  2654. state through the tags interface (@pxref{Setting tags}), in case you
  2655. like to mingle the two concepts.
  2656. @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
  2657. @subsection Setting up keywords for individual files
  2658. @cindex keyword options
  2659. @cindex per-file keywords
  2660. It can be very useful to use different aspects of the TODO mechanism in
  2661. different files. For file-local settings, you need to add special lines
  2662. to the file which set the keywords and interpretation for that file
  2663. only. For example, to set one of the two examples discussed above, you
  2664. need one of the following lines, starting in column zero anywhere in the
  2665. file:
  2666. @example
  2667. #+SEQ_TODO: TODO FEEDBACK VERIFY | DONE CANCELED
  2668. @end example
  2669. or
  2670. @example
  2671. #+TYP_TODO: Fred Sara Lucy Mike | DONE
  2672. @end example
  2673. A setup for using several sets in parallel would be:
  2674. @example
  2675. #+SEQ_TODO: TODO | DONE
  2676. #+SEQ_TODO: REPORT BUG KNOWNCAUSE | FIXED
  2677. #+SEQ_TODO: | CANCELED
  2678. @end example
  2679. @cindex completion, of option keywords
  2680. @kindex M-@key{TAB}
  2681. @noindent To make sure you are using the correct keyword, type
  2682. @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
  2683. @cindex DONE, final TODO keyword
  2684. Remember that the keywords after the vertical bar (or the last keyword
  2685. if no bar is there) must always mean that the item is DONE (although you
  2686. may use a different word). After changing one of these lines, use
  2687. @kbd{C-c C-c} with the cursor still in the line to make the changes
  2688. known to Org mode@footnote{Org mode parses these lines only when
  2689. Org mode is activated after visiting a file. @kbd{C-c C-c} with the
  2690. cursor in a line starting with @samp{#+} is simply restarting Org mode
  2691. for the current buffer.}.
  2692. @node Faces for TODO keywords, , Per-file keywords, TODO extensions
  2693. @subsection Faces for TODO keywords
  2694. @cindex faces, for TODO keywords
  2695. Org mode highlights TODO keywords with special faces: @code{org-todo}
  2696. for keywords indicating that an item still has to be acted upon, and
  2697. @code{org-done} for keywords indicating that an item is finished. If
  2698. you are using more than 2 different states, you might want to use
  2699. special faces for some of them. This can be done using the variable
  2700. @code{org-todo-keyword-faces}. For example:
  2701. @lisp
  2702. (setq org-todo-keyword-faces
  2703. '(("TODO" . org-warning)
  2704. ("DEFERRED" . shadow)
  2705. ("CANCELED" . (:foreground "blue" :weight bold))))
  2706. @end lisp
  2707. While using a list with face properties as shown for CANCELED
  2708. @emph{should} work, this does not aways seem to be the case. If
  2709. necessary, define a special face and use that.
  2710. @page
  2711. @node Progress logging, Priorities, TODO extensions, TODO Items
  2712. @section Progress logging
  2713. @cindex progress logging
  2714. @cindex logging, of progress
  2715. Org mode can automatically record a time stamp and possibly a note when
  2716. you mark a TODO item as DONE, or even each time you change the state of
  2717. a TODO item. This system is highly configurable, settings can be on a
  2718. per-keyword basis and can be localized to a file or even a subtree. For
  2719. information on how to clock working time for a task, see @ref{Clocking
  2720. work time}.
  2721. @menu
  2722. * Closing items:: When was this entry marked DONE?
  2723. * Tracking TODO state changes:: When did the status change?
  2724. @end menu
  2725. @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
  2726. @subsection Closing items
  2727. The most basic logging is to keep track of @emph{when} a certain TODO
  2728. item was finished. This is achieved with@footnote{The corresponding
  2729. in-buffer setting is: @code{#+STARTUP: logdone}}.
  2730. @lisp
  2731. (setq org-log-done 'time)
  2732. @end lisp
  2733. @noindent
  2734. Then each time you turn an entry from a TODO (not-done) state into any
  2735. of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
  2736. just after the headline. If you turn the entry back into a TODO item
  2737. through further state cycling, that line will be removed again. If you
  2738. want to record a note along with the timestamp, use@footnote{The
  2739. corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
  2740. @lisp
  2741. (setq org-log-done 'note)
  2742. @end lisp
  2743. @noindent
  2744. You will then be prompted for a note, and that note will be stored below
  2745. the entry with a @samp{Closing Note} heading.
  2746. In the timeline (@pxref{Timeline}) and in the agenda
  2747. (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
  2748. display the TODO items with a @samp{CLOSED} timestamp on each day,
  2749. giving you an overview of what has been done.
  2750. @node Tracking TODO state changes, , Closing items, Progress logging
  2751. @subsection Tracking TODO state changes
  2752. When TODO keywords are used as workflow states (@pxref{Workflow
  2753. states}), you might want to keep track of when a state change occurred
  2754. and maybe take a note about this change. Since it is normally too much
  2755. to record a note for every state, Org mode expects configuration on a
  2756. per-keyword basis for this. This is achieved by adding special markers
  2757. @samp{!} (for a time stamp) and @samp{@@} (for a note) in parenthesis
  2758. after each keyword. For example, with the setting
  2759. @lisp
  2760. (setq org-todo-keywords
  2761. '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
  2762. @end lisp
  2763. @noindent
  2764. you not only define global TODO keywords and fast access keys, but also
  2765. request that a time is recorded when the entry is turned into
  2766. DONE@footnote{It is possible that Org mode will record two time stamps
  2767. when you are using both @code{org-log-done} and state change logging.
  2768. However, it will never prompt for two notes - if you have configured
  2769. both, the state change recording note will take precedence and cancel
  2770. the @samp{Closing Note}.}, and that a note is recorded when switching to
  2771. WAIT or CANCELED. The setting for WAIT is even more special: The
  2772. @samp{!} after the slash means that in addition to the note taken when
  2773. entering the state, a time stamp should be recorded when @i{leaving} the
  2774. WAIT state, if and only if the @i{target} state does not configure
  2775. logging for entering it. So it has no effect when switching from WAIT
  2776. to DONE, because DONE is configured to record a timestamp only. But
  2777. when switching from WAIT back to TODO, the @samp{/!} in the WAIT
  2778. setting now triggers a timestamp even though TODO has no logging
  2779. configured.
  2780. You can use the exact same syntax for setting logging preferences local
  2781. to a buffer:
  2782. @example
  2783. #+SEQ_TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
  2784. @end example
  2785. In order to define logging settings that are local to a subtree or a
  2786. single item, define a LOGGING property in this entry. Any non-empty
  2787. LOGGING property resets all logging settings to nil. You may then turn
  2788. on logging for this specific tree using STARTUP keywords like
  2789. @code{lognotedone} or @code{logrepeat}, as well as adding state specific
  2790. settings like @code{TODO(!)}. For example
  2791. @example
  2792. * TODO Log each state with only a time
  2793. :PROPERTIES:
  2794. :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
  2795. :END:
  2796. * TODO Only log when switching to WAIT, and when repeating
  2797. :PROPERTIES:
  2798. :LOGGING: WAIT(@@) logrepeat
  2799. :END:
  2800. * TODO No logging at all
  2801. :PROPERTIES:
  2802. :LOGGING: nil
  2803. :END:
  2804. @end example
  2805. @node Priorities, Breaking down tasks, Progress logging, TODO Items
  2806. @section Priorities
  2807. @cindex priorities
  2808. If you use Org mode extensively, you may end up enough TODO items that
  2809. it starts to make sense to prioritize them. Prioritizing can be done by
  2810. placing a @emph{priority cookie} into the headline of a TODO item, like
  2811. this
  2812. @example
  2813. *** TODO [#A] Write letter to Sam Fortune
  2814. @end example
  2815. @noindent
  2816. By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
  2817. @samp{C}. @samp{A} is the highest priority. An entry without a cookie
  2818. is treated as priority @samp{B}. Priorities make a difference only in
  2819. the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they have
  2820. no inherent meaning to Org mode.
  2821. Priorities can be attached to any outline tree entries; they do not need
  2822. to be TODO items.
  2823. @table @kbd
  2824. @kindex @kbd{C-c ,}
  2825. @item @kbd{C-c ,}
  2826. Set the priority of the current headline. The command prompts for a
  2827. priority character @samp{A}, @samp{B} or @samp{C}. When you press
  2828. @key{SPC} instead, the priority cookie is removed from the headline.
  2829. The priorities can also be changed ``remotely'' from the timeline and
  2830. agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
  2831. @c
  2832. @kindex S-@key{up}
  2833. @kindex S-@key{down}
  2834. @item S-@key{up}
  2835. @itemx S-@key{down}
  2836. Increase/decrease priority of current headline@footnote{See also the
  2837. option @code{org-priority-start-cycle-with-default'}.}. Note that these
  2838. keys are also used to modify time stamps (@pxref{Creating timestamps}).
  2839. Furthermore, these keys are also used by CUA mode (@pxref{Conflicts}).
  2840. @end table
  2841. You can change the range of allowed priorities by setting the variables
  2842. @code{org-highest-priority}, @code{org-lowest-priority}, and
  2843. @code{org-default-priority}. For an individual buffer, you may set
  2844. these values (highest, lowest, default) like this (please make sure that
  2845. the highest priority is earlier in the alphabet than the lowest
  2846. priority):
  2847. @example
  2848. #+PRIORITIES: A C B
  2849. @end example
  2850. @node Breaking down tasks, Checkboxes, Priorities, TODO Items
  2851. @section Breaking tasks down into subtasks
  2852. @cindex tasks, breaking down
  2853. It is often advisable to break down large tasks into smaller, manageable
  2854. subtasks. You can do this by creating an outline tree below a TODO item,
  2855. with detailed subtasks on the tree@footnote{To keep subtasks out of the
  2856. global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
  2857. the overview over the fraction of subtasks that are already completed, insert
  2858. either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
  2859. be updates each time the todo status of a child changes. For example:
  2860. @example
  2861. * Organize Party [33%]
  2862. ** TODO Call people [1/2]
  2863. *** TODO Peter
  2864. *** DONE Sarah
  2865. ** TODO Buy food
  2866. ** DONE Talk to neighbor
  2867. @end example
  2868. If you would like a TODO entry to automatically change to DONE when all
  2869. chilrden are done, you can use the following setup:
  2870. @example
  2871. (defun org-summary-todo (n-done n-not-done)
  2872. "Switch entry to DONE when all subentries are done, to TODO otherwise."
  2873. (let (org-log-done org-log-states) ; turn off logging
  2874. (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
  2875. (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
  2876. @end example
  2877. Another possibility is the use of checkboxes to identify (a hierarchy of) a
  2878. large number of subtasks (@pxref{Checkboxes}).
  2879. @node Checkboxes, , Breaking down tasks, TODO Items
  2880. @section Checkboxes
  2881. @cindex checkboxes
  2882. Every item in a plain list (@pxref{Plain lists}) can be made into a
  2883. checkbox by starting it with the string @samp{[ ]}. This feature is
  2884. similar to TODO items (@pxref{TODO Items}), but is more lightweight.
  2885. Checkboxes are not included into the global TODO list, so they are often
  2886. great to split a task into a number of simple steps. Or you can use
  2887. them in a shopping list. To toggle a checkbox, use @kbd{C-c C-c}, or
  2888. use the mouse (thanks to Piotr Zielinski's @file{org-mouse.el}).
  2889. Here is an example of a checkbox list.
  2890. @example
  2891. * TODO Organize party [2/4]
  2892. - [-] call people [1/3]
  2893. - [ ] Peter
  2894. - [X] Sarah
  2895. - [ ] Sam
  2896. - [X] order food
  2897. - [ ] think about what music to play
  2898. - [X] talk to the neighbors
  2899. @end example
  2900. Checkboxes work hierarchically, so if a checkbox item has children that
  2901. are checkboxes, toggling one of the children checkboxes will make the
  2902. parent checkbox reflect if none, some, or all of the children are
  2903. checked.
  2904. @cindex statistics, for checkboxes
  2905. @cindex checkbox statistics
  2906. The @samp{[2/4]} and @samp{[1/3]} in the first and second line are
  2907. cookies indicating how many checkboxes present in this entry have been
  2908. checked off, and the total number of checkboxes are present. This can
  2909. give you an idea on how many checkboxes remain, even without opening a
  2910. folded entry. The cookies can be placed into a headline or into (the
  2911. first line of) a plain list item. Each cookie covers all checkboxes
  2912. structurally below the headline/item on which the cookie appear. You
  2913. have to insert the cookie yourself by typing either @samp{[/]} or
  2914. @samp{[%]}. With @samp{[/]} you get an @samp{n out of m} result, as in
  2915. the examples above. With @samp{[%]} you get information about the
  2916. percentage of checkboxes checked (in the above example, this would be
  2917. @samp{[50%]} and @samp{[33%]}, respectively).
  2918. @noindent The following commands work with checkboxes:
  2919. @table @kbd
  2920. @kindex C-c C-c
  2921. @item C-c C-c
  2922. Toggle checkbox at point. With a prefix argument, set it to @samp{[-]},
  2923. which is considered to be an intermediate state.
  2924. @kindex C-c C-x C-b
  2925. @item C-c C-x C-b
  2926. Toggle checkbox at point.
  2927. @itemize @minus
  2928. @item
  2929. If there is an active region, toggle the first checkbox in the region
  2930. and set all remaining boxes to the same status as the first. If you
  2931. want to toggle all boxes in the region independently, use a prefix
  2932. argument.
  2933. @item
  2934. If the cursor is in a headline, toggle checkboxes in the region between
  2935. this headline and the next (so @emph{not} the entire subtree).
  2936. @item
  2937. If there is no active region, just toggle the checkbox at point.
  2938. @end itemize
  2939. @kindex M-S-@key{RET}
  2940. @item M-S-@key{RET}
  2941. Insert a new item with a checkbox.
  2942. This works only if the cursor is already in a plain list item
  2943. (@pxref{Plain lists}).
  2944. @kindex C-c #
  2945. @item C-c #
  2946. Update the checkbox statistics in the current outline entry. When
  2947. called with a @kbd{C-u} prefix, update the entire file. Checkbox
  2948. statistic cookies are updated automatically if you toggle checkboxes
  2949. with @kbd{C-c C-c} and make new ones with @kbd{M-S-@key{RET}}. If you
  2950. delete boxes or add/change them by hand, use this command to get things
  2951. back into synch. Or simply toggle any checkbox twice with @kbd{C-c C-c}.
  2952. @end table
  2953. @node Tags, Properties and Columns, TODO Items, Top
  2954. @chapter Tags
  2955. @cindex tags
  2956. @cindex headline tagging
  2957. @cindex matching, tags
  2958. @cindex sparse tree, tag based
  2959. An excellent way to implement labels and contexts for cross-correlating
  2960. information is to assign @i{tags} to headlines. Org mode has extensive
  2961. support for tags.
  2962. Every headline can contain a list of tags; they occur at the end of the
  2963. headline. Tags are normal words containing letters, numbers, @samp{_},
  2964. and @samp{@@}. Tags must be preceded and followed by a single colon,
  2965. e.g., @samp{:work:}. Several tags can be specified, as in
  2966. @samp{:work:urgent:}.
  2967. @menu
  2968. * Tag inheritance:: Tags use the tree structure of the outline
  2969. * Setting tags:: How to assign tags to a headline
  2970. * Tag searches:: Searching for combinations of tags
  2971. @end menu
  2972. @node Tag inheritance, Setting tags, Tags, Tags
  2973. @section Tag inheritance
  2974. @cindex tag inheritance
  2975. @cindex inheritance, of tags
  2976. @cindex sublevels, inclusion into tags match
  2977. @i{Tags} make use of the hierarchical structure of outline trees. If a
  2978. heading has a certain tag, all subheadings will inherit the tag as
  2979. well. For example, in the list
  2980. @example
  2981. * Meeting with the French group :work:
  2982. ** Summary by Frank :boss:notes:
  2983. *** TODO Prepare slides for him :action:
  2984. @end example
  2985. @noindent
  2986. the final heading will have the tags @samp{:work:}, @samp{:boss:},
  2987. @samp{:notes:}, and @samp{:action:} even though the final heading is not
  2988. explicitly marked with those tags. You can also set tags that all entries in
  2989. a file should inherit as if these tags would be defined in a hypothetical
  2990. level zero that surounds the entire file.
  2991. @example
  2992. #+FILETAGS: :Peter:Boss:Secret:
  2993. @end example
  2994. @noindent
  2995. To limit tag inheritance to specific tags, or to turn it off entirely, use
  2996. the variable @code{org-use-tag-inheritance}.
  2997. When a headline matches during a tags search while tag inheritance is turned
  2998. on, all the sublevels in the same tree will match as well@footnote{This is
  2999. only true if the the search does not involve more complex tests including
  3000. properties (@pxref{Property searches}).}. The list of matches may then
  3001. become very long. If you only want to see the first tags match in a subtree,
  3002. configure the variable @code{org-tags-match-list-sublevels}.
  3003. @node Setting tags, Tag searches, Tag inheritance, Tags
  3004. @section Setting tags
  3005. @cindex setting tags
  3006. @cindex tags, setting
  3007. @kindex M-@key{TAB}
  3008. Tags can simply be typed into the buffer at the end of a headline.
  3009. After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
  3010. also a special command for inserting tags:
  3011. @table @kbd
  3012. @kindex C-c C-q
  3013. @item C-c C-q
  3014. @cindex completion, of tags
  3015. Enter new tags for the current headline. Org mode will either offer
  3016. completion or a special single-key interface for setting tags, see
  3017. below. After pressing @key{RET}, the tags will be inserted and aligned
  3018. to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
  3019. tags in the current buffer will be aligned to that column, just to make
  3020. things look nice. TAGS are automatically realigned after promotion,
  3021. demotion, and TODO state changes (@pxref{TODO basics}).
  3022. @kindex C-c C-c
  3023. @item C-c C-c
  3024. When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
  3025. @end table
  3026. Org will support tag insertion based on a @emph{list of tags}. By
  3027. default this list is constructed dynamically, containing all tags
  3028. currently used in the buffer. You may also globally specify a hard list
  3029. of tags with the variable @code{org-tag-alist}. Finally you can set
  3030. the default tags for a given file with lines like
  3031. @example
  3032. #+TAGS: @@work @@home @@tennisclub
  3033. #+TAGS: laptop car pc sailboat
  3034. @end example
  3035. If you have globally defined your preferred set of tags using the
  3036. variable @code{org-tag-alist}, but would like to use a dynamic tag list
  3037. in a specific file, add an empty TAGS option line to that file:
  3038. @example
  3039. #+TAGS:
  3040. @end example
  3041. By default Org mode uses the standard minibuffer completion facilities for
  3042. entering tags. However, it also implements another, quicker, tag selection
  3043. method called @emph{fast tag selection}. This allows you to select and
  3044. deselect tags with just a single key press. For this to work well you should
  3045. assign unique letters to most of your commonly used tags. You can do this
  3046. globally by configuring the variable @code{org-tag-alist} in your
  3047. @file{.emacs} file. For example, you may find the need to tag many items in
  3048. different files with @samp{:@@home:}. In this case you can set something
  3049. like:
  3050. @lisp
  3051. (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
  3052. @end lisp
  3053. @noindent If the tag is only relevant to the file you are working on then you
  3054. can, instead, set the TAGS option line as:
  3055. @example
  3056. #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
  3057. @end example
  3058. @noindent
  3059. You can also group together tags that are mutually exclusive. By using
  3060. braces, as in:
  3061. @example
  3062. #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
  3063. @end example
  3064. @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
  3065. and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
  3066. @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
  3067. these lines to activate any changes.
  3068. @noindent
  3069. To set these mutually exclusive groups in the variable @code{org-mode-alist}
  3070. you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
  3071. of the braces. The previous example would be set globally by the following
  3072. configuration:
  3073. @lisp
  3074. (setq org-tag-alist '((:startgroup . nil)
  3075. ("@@work" . ?w) ("@@home" . ?h)
  3076. ("@@tennisclub" . ?t)
  3077. (:endgroup . nil)
  3078. ("laptop" . ?l) ("pc" . ?p)))
  3079. @end lisp
  3080. If at least one tag has a selection key then pressing @kbd{C-c C-c} will
  3081. automatically present you with a special interface, listing inherited tags,
  3082. the tags of the current headline, and a list of all valid tags with
  3083. corresponding keys@footnote{Keys will automatically be assigned to tags which
  3084. have no configured keys.}. In this interface, you can use the following
  3085. keys:
  3086. @table @kbd
  3087. @item a-z...
  3088. Pressing keys assigned to tags will add or remove them from the list of
  3089. tags in the current line. Selecting a tag in a group of mutually
  3090. exclusive tags will turn off any other tags from that group.
  3091. @kindex @key{TAB}
  3092. @item @key{TAB}
  3093. Enter a tag in the minibuffer, even if the tag is not in the predefined
  3094. list. You will be able to complete on all tags present in the buffer.
  3095. @kindex @key{SPC}
  3096. @item @key{SPC}
  3097. Clear all tags for this line.
  3098. @kindex @key{RET}
  3099. @item @key{RET}
  3100. Accept the modified set.
  3101. @item C-g
  3102. Abort without installing changes.
  3103. @item q
  3104. If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
  3105. @item !
  3106. Turn off groups of mutually exclusive tags. Use this to (as an
  3107. exception) assign several tags from such a group.
  3108. @item C-c
  3109. Toggle auto-exit after the next change (see below).
  3110. If you are using expert mode, the first @kbd{C-c} will display the
  3111. selection window.
  3112. @end table
  3113. @noindent
  3114. This method lets you assign tags to a headline with very few keys. With
  3115. the above setup, you could clear the current tags and set @samp{@@home},
  3116. @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
  3117. C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
  3118. @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
  3119. alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
  3120. @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
  3121. @key{RET} @key{RET}}.
  3122. If you find that most of the time, you need only a single key press to
  3123. modify your list of tags, set the variable
  3124. @code{org-fast-tag-selection-single-key}. Then you no longer have to
  3125. press @key{RET} to exit fast tag selection - it will immediately exit
  3126. after the first change. If you then occasionally need more keys, press
  3127. @kbd{C-c} to turn off auto-exit for the current tag selection process
  3128. (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
  3129. C-c}). If you set the variable to the value @code{expert}, the special
  3130. window is not even shown for single-key tag selection, it comes up only
  3131. when you press an extra @kbd{C-c}.
  3132. @node Tag searches, , Setting tags, Tags
  3133. @section Tag searches
  3134. @cindex tag searches
  3135. @cindex searching for tags
  3136. Once a system of tags has been set up, it can be used to collect related
  3137. information into special lists.
  3138. @table @kbd
  3139. @kindex C-c \
  3140. @kindex C-c / T
  3141. @item C-c \
  3142. @itemx C-c / T
  3143. Create a sparse tree with all headlines matching a tags search. With a
  3144. @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
  3145. @kindex C-c a m
  3146. @item C-c a m
  3147. Create a global list of tag matches from all agenda files.
  3148. @xref{Matching tags and properties}.
  3149. @kindex C-c a M
  3150. @item C-c a M
  3151. Create a global list of tag matches from all agenda files, but check
  3152. only TODO items and force checking subitems (see variable
  3153. @code{org-tags-match-list-sublevels}).
  3154. @end table
  3155. @cindex Boolean logic, for tag searches
  3156. A @i{tags} search string can use Boolean operators @samp{&} for AND and
  3157. @samp{|} for OR. @samp{&} binds more strongly than @samp{|}.
  3158. Parenthesis are currently not implemented. A tag may also be preceded
  3159. by @samp{-}, to select against it, and @samp{+} is syntactic sugar for
  3160. positive selection. The AND operator @samp{&} is optional when @samp{+}
  3161. or @samp{-} is present. Examples:
  3162. @table @samp
  3163. @item +work-boss
  3164. Select headlines tagged @samp{:work:}, but discard those also tagged
  3165. @samp{:boss:}.
  3166. @item work|laptop
  3167. Selects lines tagged @samp{:work:} or @samp{:laptop:}.
  3168. @item work|laptop&night
  3169. Like before, but require the @samp{:laptop:} lines to be tagged also
  3170. @samp{:night:}.
  3171. @end table
  3172. @cindex TODO keyword matching, with tags search
  3173. If you are using multi-state TODO keywords (@pxref{TODO extensions}), it
  3174. can be useful to also match on the TODO keyword. This can be done by
  3175. adding a condition after a slash to a tags match. The syntax is similar
  3176. to the tag matches, but should be applied with consideration: For
  3177. example, a positive selection on several TODO keywords can not
  3178. meaningfully be combined with boolean AND. However, @emph{negative
  3179. selection} combined with AND can be meaningful. To make sure that only
  3180. lines are checked that actually have any TODO keyword, use @kbd{C-c a
  3181. M}, or equivalently start the TODO part after the slash with @samp{!}.
  3182. Examples:
  3183. @table @samp
  3184. @item work/WAITING
  3185. Select @samp{:work:}-tagged TODO lines with the specific TODO
  3186. keyword @samp{WAITING}.
  3187. @item work/!-WAITING-NEXT
  3188. Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
  3189. nor @samp{NEXT}
  3190. @item work/+WAITING|+NEXT
  3191. Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
  3192. @samp{NEXT}.
  3193. @end table
  3194. @cindex regular expressions, with tags search
  3195. Any element of the tag/todo match can be a regular expression - in this
  3196. case it must be enclosed in curly braces. For example,
  3197. @samp{work+@{^boss.*@}} matches headlines that contain the tag
  3198. @samp{:work:} and any tag @i{starting} with @samp{boss}.
  3199. @cindex level, require for tags/property match
  3200. @cindex category, require for tags/property match
  3201. You can also require a headline to be of a certain level or category, by
  3202. writing instead of any TAG an expression like @samp{LEVEL=3} or
  3203. @samp{CATEGORY="work"}, respectively. For example, a search
  3204. @samp{+LEVEL=3+boss/-DONE} lists all level three headlines that have the
  3205. tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE.
  3206. @node Properties and Columns, Dates and Times, Tags, Top
  3207. @chapter Properties and Columns
  3208. @cindex properties
  3209. Properties are a set of key-value pairs associated with an entry. There
  3210. are two main applications for properties in Org mode. First, properties
  3211. are like tags, but with a value. Second, you can use properties to
  3212. implement (very basic) database capabilities in an Org buffer. For
  3213. an example of the first application, imagine maintaining a file where
  3214. you document bugs and plan releases of a piece of software. Instead of
  3215. using tags like @code{:release_1:}, @code{:release_2:}, one can use a
  3216. property, say @code{:Release:}, that in different subtrees has different
  3217. values, such as @code{1.0} or @code{2.0}. For an example of the second
  3218. application of properties, imagine keeping track of your music CD's,
  3219. where properties could be things such as the album artist, date of
  3220. release, number of tracks, and so on.
  3221. Properties can be conveniently edited and viewed in column view
  3222. (@pxref{Column view}).
  3223. @menu
  3224. * Property syntax:: How properties are spelled out
  3225. * Special properties:: Access to other Org mode features
  3226. * Property searches:: Matching property values
  3227. * Property inheritance:: Passing values down the tree
  3228. * Column view:: Tabular viewing and editing
  3229. * Property API:: Properties for Lisp programmers
  3230. @end menu
  3231. @node Property syntax, Special properties, Properties and Columns, Properties and Columns
  3232. @section Property syntax
  3233. @cindex property syntax
  3234. @cindex drawer, for properties
  3235. Properties are key-value pairs. They need to be inserted into a special
  3236. drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
  3237. is specified on a single line, with the key (surrounded by colons)
  3238. first, and the value after it. Here is an example:
  3239. @example
  3240. * CD collection
  3241. ** Classic
  3242. *** Goldberg Variations
  3243. :PROPERTIES:
  3244. :Title: Goldberg Variations
  3245. :Composer: J.S. Bach
  3246. :Artist: Glen Gould
  3247. :Publisher: Deutsche Grammphon
  3248. :NDisks: 1
  3249. :END:
  3250. @end example
  3251. You may define the allowed values for a particular property @samp{:Xyz:}
  3252. by setting a property @samp{:Xyz_ALL:}. This special property is
  3253. @emph{inherited}, so if you set it in a level 1 entry, it will apply to
  3254. the entire tree. When allowed values are defined, setting the
  3255. corresponding property becomes easier and is less prone to typing
  3256. errors. For the example with the CD collection, we can predefine
  3257. publishers and the number of disks in a box like this:
  3258. @example
  3259. * CD collection
  3260. :PROPERTIES:
  3261. :NDisks_ALL: 1 2 3 4
  3262. :Publisher_ALL: "Deutsche Grammophon" Phillips EMI
  3263. :END:
  3264. @end example
  3265. If you want to set properties that can be inherited by any entry in a
  3266. file, use a line like
  3267. @example
  3268. #+PROPERTY: NDisks_ALL 1 2 3 4
  3269. @end example
  3270. Property values set with the global variable
  3271. @code{org-global-properties} can be inherited by all entries in all
  3272. Org files.
  3273. @noindent
  3274. The following commands help to work with properties:
  3275. @table @kbd
  3276. @kindex M-@key{TAB}
  3277. @item M-@key{TAB}
  3278. After an initial colon in a line, complete property keys. All keys used
  3279. in the current file will be offered as possible completions.
  3280. @kindex C-c C-x p
  3281. @item C-c C-x p
  3282. Set a property. This prompts for a property name and a value. If
  3283. necessary, the property drawer is created as well.
  3284. @item M-x org-insert-property-drawer
  3285. Insert a property drawer into the current entry. The drawer will be
  3286. inserted early in the entry, but after the lines with planning
  3287. information like deadlines.
  3288. @kindex C-c C-c
  3289. @item C-c C-c
  3290. With the cursor in a property drawer, this executes property commands.
  3291. @item C-c C-c s
  3292. Set a property in the current entry. Both the property and the value
  3293. can be inserted using completion.
  3294. @kindex S-@key{right}
  3295. @kindex S-@key{left}
  3296. @item S-@key{left}/@key{right}
  3297. Switch property at point to the next/previous allowed value.
  3298. @item C-c C-c d
  3299. Remove a property from the current entry.
  3300. @item C-c C-c D
  3301. Globally remove a property, from all entries in the current file.
  3302. @item C-c C-c c
  3303. Compute the property at point, using the operator and scope from the
  3304. nearest column format definition.
  3305. @end table
  3306. @node Special properties, Property searches, Property syntax, Properties and Columns
  3307. @section Special properties
  3308. @cindex properties, special
  3309. Special properties provide alternative access method to Org mode
  3310. features discussed in the previous chapters, like the TODO state or the
  3311. priority of an entry. This interface exists so that you can include
  3312. these states into columns view (@pxref{Column view}), or to use them in
  3313. queries. The following property names are special and should not be
  3314. used as keys in the properties drawer:
  3315. @example
  3316. TODO @r{The TODO keyword of the entry.}
  3317. TAGS @r{The tags defined directly in the headline.}
  3318. ALLTAGS @r{All tags, including inherited ones.}
  3319. PRIORITY @r{The priority of the entry, a string with a single letter.}
  3320. DEADLINE @r{The deadline time string, without the angular brackets.}
  3321. SCHEDULED @r{The scheduling time stamp, without the angular brackets.}
  3322. TIMESTAMP @r{The first keyword-less time stamp in the entry.}
  3323. TIMESTAMP_IA @r{The first inactive time stamp in the entry.}
  3324. CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
  3325. @r{must be run first to compute the values.}
  3326. @end example
  3327. @node Property searches, Property inheritance, Special properties, Properties and Columns
  3328. @section Property searches
  3329. @cindex properties, searching
  3330. @cindex searching, of properties
  3331. To create sparse trees and special lists with selection based on properties,
  3332. the same commands are used as for tag searches (@pxref{Tag searches}), and
  3333. the same logic applies. For example, here is a search string:
  3334. @example
  3335. +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
  3336. +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
  3337. @end example
  3338. @noindent
  3339. The type of comparison will depend on how the comparison value is written:
  3340. @itemize @minus
  3341. @item
  3342. If the comparison value is a plain number, a numerical comparison is done,
  3343. and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
  3344. @samp{>=}, and @samp{<>}.
  3345. @item
  3346. If the comparison value is enclosed in double
  3347. quotes, a string comparison is done, and the same operators are allowed.
  3348. @item
  3349. If the comparison value is enclosed in double quotes @emph{and} angular
  3350. brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
  3351. assumed to be date/time specifications in the standard Org way@footnote{The
  3352. only special values that will be recognized are @samp{"<now>"} for now, and
  3353. @samp{"<today>"} today at 0:00 hours, i.e. without a time specification.}, and
  3354. the comparison will be done accordingly.
  3355. @item
  3356. If the comparison value is enclosed
  3357. in curly braces, a regexp match is performed, with @samp{=} meaning that the
  3358. regexp matches the property value, and @samp{<>} meaning that it does not
  3359. match.
  3360. @end itemize
  3361. So the search string in the example finds entries tagged @samp{:work:} but
  3362. not @samp{:boss:}, which also have a priority value @samp{A}, a
  3363. @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
  3364. property that is numerically smaller than 2, a @samp{:With:} property that is
  3365. matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
  3366. on or after October 11, 2008.
  3367. You can configure Org mode to use property inheritance during a search, but
  3368. beware that this can slow down searches considerably. See @ref{Property
  3369. inheritance} for details.
  3370. There is also a special command for creating sparse trees based on a
  3371. single property:
  3372. @table @kbd
  3373. @kindex C-c / p
  3374. @item C-c / p
  3375. Create a sparse tree based on the value of a property. This first
  3376. prompts for the name of a property, and then for a value. A sparse tree
  3377. is created with all entries that define this property with the given
  3378. value. If you enclose the value into curly braces, it is interpreted as
  3379. a regular expression and matched against the property values.
  3380. @end table
  3381. @node Property inheritance, Column view, Property searches, Properties and Columns
  3382. @section Property Inheritance
  3383. @cindex properties, inheritance
  3384. @cindex inheritance, of properties
  3385. The outline structure of Org mode documents lends itself for an
  3386. inheritance model of properties: If the parent in a tree has a certain
  3387. property, the children can inherit this property. Org mode does not
  3388. turn this on by default, because it can slow down property searches
  3389. significantly and is often not needed. However, if you find inheritance
  3390. useful, you can turn it on by setting the variable
  3391. @code{org-use-property-inheritance}. It may be set to @code{t}, to make
  3392. all properties inherited from the parent, to a list of properties
  3393. that should be inherited, or to a regular expression that matches
  3394. inherited properties.
  3395. Org mode has a few properties for which inheritance is hard-coded, at
  3396. least for the special applications for which they are used:
  3397. @table @code
  3398. @item COLUMNS
  3399. The @code{:COLUMNS:} property defines the format of column view
  3400. (@pxref{Column view}). It is inherited in the sense that the level
  3401. where a @code{:COLUMNS:} property is defined is used as the starting
  3402. point for a column view table, independently of the location in the
  3403. subtree from where columns view is turned on.
  3404. @item CATEGORY
  3405. For agenda view, a category set through a @code{:CATEGORY:} property
  3406. applies to the entire subtree.
  3407. @item ARCHIVE
  3408. For archiving, the @code{:ARCHIVE:} property may define the archive
  3409. location for the entire subtree (@pxref{Moving subtrees}).
  3410. @item LOGGING
  3411. The LOGGING property may define logging settings for an entry or a
  3412. subtree (@pxref{Tracking TODO state changes}).
  3413. @end table
  3414. @node Column view, Property API, Property inheritance, Properties and Columns
  3415. @section Column view
  3416. A great way to view and edit properties in an outline tree is
  3417. @emph{column view}. In column view, each outline item is turned into a
  3418. table row. Columns in this table provide access to properties of the
  3419. entries. Org mode implements columns by overlaying a tabular structure
  3420. over the headline of each item. While the headlines have been turned
  3421. into a table row, you can still change the visibility of the outline
  3422. tree. For example, you get a compact table by switching to CONTENTS
  3423. view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
  3424. is active), but you can still open, read, and edit the entry below each
  3425. headline. Or, you can switch to column view after executing a sparse
  3426. tree command and in this way get a table only for the selected items.
  3427. Column view also works in agenda buffers (@pxref{Agenda Views}) where
  3428. queries have collected selected items, possibly from a number of files.
  3429. @menu
  3430. * Defining columns:: The COLUMNS format property
  3431. * Using column view:: How to create and use column view
  3432. * Capturing column view:: A dynamic block for column view
  3433. @end menu
  3434. @node Defining columns, Using column view, Column view, Column view
  3435. @subsection Defining columns
  3436. @cindex column view, for properties
  3437. @cindex properties, column view
  3438. Setting up a column view first requires defining the columns. This is
  3439. done by defining a column format line.
  3440. @menu
  3441. * Scope of column definitions:: Where defined, where valid?
  3442. * Column attributes:: Appearance and content of a column
  3443. @end menu
  3444. @node Scope of column definitions, Column attributes, Defining columns, Defining columns
  3445. @subsubsection Scope of column definitions
  3446. To define a column format for an entire file, use a line like
  3447. @example
  3448. #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  3449. @end example
  3450. To specify a format that only applies to a specific tree, add a
  3451. @code{:COLUMNS:} property to the top node of that tree, for example:
  3452. @example
  3453. ** Top node for columns view
  3454. :PROPERTIES:
  3455. :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
  3456. :END:
  3457. @end example
  3458. If a @code{:COLUMNS:} property is present in an entry, it defines columns
  3459. for the entry itself, and for the entire subtree below it. Since the
  3460. column definition is part of the hierarchical structure of the document,
  3461. you can define columns on level 1 that are general enough for all
  3462. sublevels, and more specific columns further down, when you edit a
  3463. deeper part of the tree.
  3464. @node Column attributes, , Scope of column definitions, Defining columns
  3465. @subsubsection Column attributes
  3466. A column definition sets the attributes of a column. The general
  3467. definition looks like this:
  3468. @example
  3469. %[width]property[(title)][@{summary-type@}]
  3470. @end example
  3471. @noindent
  3472. Except for the percent sign and the property name, all items are
  3473. optional. The individual parts have the following meaning:
  3474. @example
  3475. width @r{An integer specifying the width of the column in characters.}
  3476. @r{If omitted, the width will be determined automatically.}
  3477. property @r{The property that should be edited in this column.}
  3478. (title) @r{The header text for the column. If omitted, the}
  3479. @r{property name is used.}
  3480. @{summary-type@} @r{The summary type. If specified, the column values for}
  3481. @r{parent nodes are computed from the children.}
  3482. @r{Supported summary types are:}
  3483. @{+@} @r{Sum numbers in this column.}
  3484. @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
  3485. @{$@} @r{Currency, short for @samp{+;%.2f}.}
  3486. @{:@} @r{Sum times, HH:MM:SS, plain numbers are hours.}
  3487. @{X@} @r{Checkbox status, [X] if all children are [X].}
  3488. @{X/@} @r{Checkbox status, [n/m].}
  3489. @{X%@} @r{Checkbox status, [n%].}
  3490. @end example
  3491. @noindent
  3492. Here is an example for a complete columns definition, along with allowed
  3493. values.
  3494. @example
  3495. :COLUMNS: %20ITEM %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.}
  3496. %10Time_Estimate@{:@} %CLOCKSUM
  3497. :Owner_ALL: Tammy Mark Karl Lisa Don
  3498. :Status_ALL: "In progress" "Not started yet" "Finished" ""
  3499. :Approved_ALL: "[ ]" "[X]"
  3500. @end example
  3501. The first column, @samp{%25ITEM}, means the first 25 characters of the
  3502. item itself, i.e. of the headline. You probably always should start the
  3503. column definition with the @samp{ITEM} specifier. The other specifiers
  3504. create columns @samp{Owner} with a list of names as allowed values, for
  3505. @samp{Status} with four different possible values, and for a checkbox
  3506. field @samp{Approved}. When no width is given after the @samp{%}
  3507. character, the column will be exactly as wide as it needs to be in order
  3508. to fully display all values. The @samp{Approved} column does have a
  3509. modified title (@samp{Approved?}, with a question mark). Summaries will
  3510. be created for the @samp{Time_Estimate} column by adding time duration
  3511. expressions like HH:MM, and for the @samp{Approved} column, by providing
  3512. an @samp{[X]} status if all children have been checked. The
  3513. @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
  3514. in the subtree.
  3515. @node Using column view, Capturing column view, Defining columns, Column view
  3516. @subsection Using column view
  3517. @table @kbd
  3518. @tsubheading{Turning column view on and off}
  3519. @kindex C-c C-x C-c
  3520. @item C-c C-x C-c
  3521. Create the column view for the local environment. This command searches
  3522. the hierarchy, up from point, for a @code{:COLUMNS:} property that defines
  3523. a format. When one is found, the column view table is established for
  3524. the entire tree, starting from the entry that contains the @code{:COLUMNS:}
  3525. property. If none is found, the format is taken from the @code{#+COLUMNS}
  3526. line or from the variable @code{org-columns-default-format}, and column
  3527. view is established for the current entry and its subtree.
  3528. @kindex r
  3529. @item r
  3530. Recreate the column view, to include recent changes made in the buffer.
  3531. @kindex g
  3532. @item g
  3533. Same as @kbd{r}.
  3534. @kindex q
  3535. @item q
  3536. Exit column view.
  3537. @tsubheading{Editing values}
  3538. @item @key{left} @key{right} @key{up} @key{down}
  3539. Move through the column view from field to field.
  3540. @kindex S-@key{left}
  3541. @kindex S-@key{right}
  3542. @item S-@key{left}/@key{right}
  3543. Switch to the next/previous allowed value of the field. For this, you
  3544. have to have specified allowed values for a property.
  3545. @item 1..9,0
  3546. Directly select the nth allowed value, @kbd{0} selects the 10th value.
  3547. @kindex n
  3548. @kindex p
  3549. @itemx n / p
  3550. Same as @kbd{S-@key{left}/@key{right}}
  3551. @kindex e
  3552. @item e
  3553. Edit the property at point. For the special properties, this will
  3554. invoke the same interface that you normally use to change that
  3555. property. For example, when editing a TAGS property, the tag completion
  3556. or fast selection interface will pop up.
  3557. @kindex C-c C-c
  3558. @item C-c C-c
  3559. When there is a checkbox at point, toggle it.
  3560. @kindex v
  3561. @item v
  3562. View the full value of this property. This is useful if the width of
  3563. the column is smaller than that of the value.
  3564. @kindex a
  3565. @item a
  3566. Edit the list of allowed values for this property. If the list is found
  3567. in the hierarchy, the modified values is stored there. If no list is
  3568. found, the new value is stored in the first entry that is part of the
  3569. current column view.
  3570. @tsubheading{Modifying the table structure}
  3571. @kindex <
  3572. @kindex >
  3573. @item < / >
  3574. Make the column narrower/wider by one character.
  3575. @kindex S-M-@key{right}
  3576. @item S-M-@key{right}
  3577. Insert a new column, to the left of the current column.
  3578. @kindex S-M-@key{left}
  3579. @item S-M-@key{left}
  3580. Delete the current column.
  3581. @end table
  3582. @node Capturing column view, , Using column view, Column view
  3583. @subsection Capturing column view
  3584. Since column view is just an overlay over a buffer, it cannot be
  3585. exported or printed directly. If you want to capture a column view, use
  3586. this @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
  3587. of this block looks like this:
  3588. @cindex #+BEGIN: columnview
  3589. @example
  3590. * The column view
  3591. #+BEGIN: columnview :hlines 1 :id "label"
  3592. #+END:
  3593. @end example
  3594. @noindent This dynamic block has the following parameters:
  3595. @table @code
  3596. @item :id
  3597. This is most important parameter. Column view is a feature that is
  3598. often localized to a certain (sub)tree, and the capture block might be
  3599. in a different location in the file. To identify the tree whose view to
  3600. capture, you can use 3 values:
  3601. @example
  3602. local @r{use the tree in which the capture block is located}
  3603. global @r{make a global view, including all headings in the file}
  3604. "label" @r{call column view in the tree that has an @code{:ID:}}
  3605. @r{property with the value @i{label}. You can use}
  3606. @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
  3607. @r{the current entry and copy it to the kill-ring.}
  3608. @end example
  3609. @item :hlines
  3610. When @code{t}, insert a hline after every line. When a number N, insert
  3611. a hline before each headline with level @code{<= N}.
  3612. @item :vlines
  3613. When set to @code{t}, enforce column groups to get vertical lines.
  3614. @item :maxlevel
  3615. When set to a number, don't capture entries below this level.
  3616. @item :skip-empty-rows
  3617. When set to @code{t}, skip row where the only non-empty specifier of the
  3618. column view is @code{ITEM}.
  3619. @end table
  3620. @noindent
  3621. The following commands insert or update the dynamic block:
  3622. @table @kbd
  3623. @kindex C-c C-x i
  3624. @item C-c C-x i
  3625. Insert a dynamic block capturing a column view. You will be prompted
  3626. for the scope or id of the view.
  3627. @kindex C-c C-c
  3628. @item C-c C-c
  3629. @kindex C-c C-x C-u
  3630. @itemx C-c C-x C-u
  3631. Update dynamical block at point. The cursor needs to be in the
  3632. @code{#+BEGIN} line of the dynamic block.
  3633. @kindex C-u C-c C-x C-u
  3634. @item C-u C-c C-x C-u
  3635. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  3636. you have several clock table blocks in a buffer.
  3637. @end table
  3638. You can add formulas to the column view table and you may add plotting
  3639. instructions in front of the table - these will survive an update of the
  3640. block. If there is a @code{#+TBLFM:} after the table, the table will
  3641. actually be recalculated automatically after an update.
  3642. @node Property API, , Column view, Properties and Columns
  3643. @section The Property API
  3644. @cindex properties, API
  3645. @cindex API, for properties
  3646. There is a full API for accessing and changing properties. This API can
  3647. be used by Emacs Lisp programs to work with properties and to implement
  3648. features based on them. For more information see @ref{Using the
  3649. property API}.
  3650. @node Dates and Times, Capture, Properties and Columns, Top
  3651. @chapter Dates and Times
  3652. @cindex dates
  3653. @cindex times
  3654. @cindex time stamps
  3655. @cindex date stamps
  3656. To assist project planning, TODO items can be labeled with a date and/or
  3657. a time. The specially formatted string carrying the date and time
  3658. information is called a @emph{timestamp} in Org mode. This may be a
  3659. little confusing because timestamp is often used as indicating when
  3660. something was created or last changed. However, in Org mode this term
  3661. is used in a much wider sense.
  3662. @menu
  3663. * Timestamps:: Assigning a time to a tree entry
  3664. * Creating timestamps:: Commands which insert timestamps
  3665. * Deadlines and scheduling:: Planning your work
  3666. * Clocking work time:: Tracking how long you spend on a task
  3667. * Effort estimates:: Planning work effort in advance
  3668. @end menu
  3669. @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
  3670. @section Timestamps, deadlines and scheduling
  3671. @cindex time stamps
  3672. @cindex ranges, time
  3673. @cindex date stamps
  3674. @cindex deadlines
  3675. @cindex scheduling
  3676. A time stamp is a specification of a date (possibly with time or a range
  3677. of times) in a special format, either @samp{<2003-09-16 Tue>} or
  3678. @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
  3679. 12:00-12:30>}@footnote{This is the standard ISO date/time format. To
  3680. use an alternative format, see @ref{Custom time format}.}. A time stamp
  3681. can appear anywhere in the headline or body of an Org tree entry. Its
  3682. presence causes entries to be shown on specific dates in the agenda
  3683. (@pxref{Weekly/daily agenda}). We distinguish:
  3684. @table @var
  3685. @item Plain time stamp; Event; Appointment
  3686. @cindex timestamp
  3687. A simple time stamp just assigns a date/time to an item. This is just
  3688. like writing down an appointment or event in a paper agenda. In the
  3689. timeline and agenda displays, the headline of an entry associated with a
  3690. plain time stamp will be shown exactly on that date.
  3691. @example
  3692. * Meet Peter at the movies <2006-11-01 Wed 19:15>
  3693. * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
  3694. @end example
  3695. @item Time stamp with repeater interval
  3696. @cindex timestamp, with repeater interval
  3697. A time stamp may contain a @emph{repeater interval}, indicating that it
  3698. applies not only on the given date, but again and again after a certain
  3699. interval of N days (d), weeks (w), months(m), or years(y). The
  3700. following will show up in the agenda every Wednesday:
  3701. @example
  3702. * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
  3703. @end example
  3704. @item Diary-style sexp entries
  3705. For more complex date specifications, Org mode supports using the
  3706. special sexp diary entries implemented in the Emacs calendar/diary
  3707. package. For example
  3708. @example
  3709. * The nerd meeting on every 2nd Thursday of the month
  3710. <%%(diary-float t 4 2)>
  3711. @end example
  3712. @item Time/Date range
  3713. @cindex timerange
  3714. @cindex date range
  3715. Two time stamps connected by @samp{--} denote a range. The headline
  3716. will be shown on the first and last day of the range, and on any dates
  3717. that are displayed and fall in the range. Here is an example:
  3718. @example
  3719. ** Meeting in Amsterdam
  3720. <2004-08-23 Mon>--<2004-08-26 Thu>
  3721. @end example
  3722. @item Inactive time stamp
  3723. @cindex timestamp, inactive
  3724. @cindex inactive timestamp
  3725. Just like a plain time stamp, but with square brackets instead of
  3726. angular ones. These time stamps are inactive in the sense that they do
  3727. @emph{not} trigger an entry to show up in the agenda.
  3728. @example
  3729. * Gillian comes late for the fifth time [2006-11-01 Wed]
  3730. @end example
  3731. @end table
  3732. @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
  3733. @section Creating timestamps
  3734. @cindex creating timestamps
  3735. @cindex timestamps, creating
  3736. For Org mode to recognize time stamps, they need to be in the specific
  3737. format. All commands listed below produce time stamps in the correct
  3738. format.
  3739. @table @kbd
  3740. @kindex C-c .
  3741. @item C-c .
  3742. Prompt for a date and insert a corresponding time stamp. When the cursor is
  3743. at an existing time stamp in the buffer, the command is used to modify this
  3744. timestamp instead of inserting a new one. When this command is used twice in
  3745. succession, a time range is inserted.
  3746. @c
  3747. @kindex C-u C-c .
  3748. @item C-u C-c .
  3749. Like @kbd{C-c .}, but use the alternative format which contains date
  3750. and time. The default time can be rounded to multiples of 5 minutes,
  3751. see the option @code{org-time-stamp-rounding-minutes}.
  3752. @c
  3753. @kindex C-c !
  3754. @item C-c !
  3755. Like @kbd{C-c .}, but insert an inactive time stamp that will not cause
  3756. an agenda entry.
  3757. @c
  3758. @kindex C-c <
  3759. @item C-c <
  3760. Insert a time stamp corresponding to the cursor date in the Calendar.
  3761. @c
  3762. @kindex C-c >
  3763. @item C-c >
  3764. Access the Emacs calendar for the current date. If there is a
  3765. timestamp in the current line, go to the corresponding date
  3766. instead.
  3767. @c
  3768. @kindex C-c C-o
  3769. @item C-c C-o
  3770. Access the agenda for the date given by the time stamp or -range at
  3771. point (@pxref{Weekly/daily agenda}).
  3772. @c
  3773. @kindex S-@key{left}
  3774. @kindex S-@key{right}
  3775. @item S-@key{left}
  3776. @itemx S-@key{right}
  3777. Change date at cursor by one day. These key bindings conflict with
  3778. CUA mode (@pxref{Conflicts}).
  3779. @c
  3780. @kindex S-@key{up}
  3781. @kindex S-@key{down}
  3782. @item S-@key{up}
  3783. @itemx S-@key{down}
  3784. Change the item under the cursor in a timestamp. The cursor can be on a
  3785. year, month, day, hour or minute. Note that if the cursor is in a
  3786. headline and not at a time stamp, these same keys modify the priority of
  3787. an item. (@pxref{Priorities}). The key bindings also conflict with
  3788. CUA mode (@pxref{Conflicts}).
  3789. @c
  3790. @kindex C-c C-y
  3791. @cindex evaluate time range
  3792. @item C-c C-y
  3793. Evaluate a time range by computing the difference between start and end.
  3794. With a prefix argument, insert result after the time range (in a table: into
  3795. the following column).
  3796. @end table
  3797. @menu
  3798. * The date/time prompt:: How Org mode helps you entering date and time
  3799. * Custom time format:: Making dates look different
  3800. @end menu
  3801. @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
  3802. @subsection The date/time prompt
  3803. @cindex date, reading in minibuffer
  3804. @cindex time, reading in minibuffer
  3805. When Org mode prompts for a date/time, the default is shown as an ISO
  3806. date, and the prompt therefore seems to ask for an ISO date. But it
  3807. will in fact accept any string containing some date and/or time
  3808. information, and it is really smart about interpreting your input. You
  3809. can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
  3810. copied from an email message. Org mode will find whatever information
  3811. is in there and derive anything you have not specified from the
  3812. @emph{default date and time}. The default is usually the current date
  3813. and time, but when modifying an existing time stamp, or when entering
  3814. the second stamp of a range, it is taken from the stamp in the buffer.
  3815. When filling in information, Org mode assumes that most of the time you
  3816. will want to enter a date in the future: If you omit the month/year and
  3817. the given day/month is @i{before} today, it will assume that you mean a
  3818. future date@footnote{See the variable
  3819. @code{org-read-date-prefer-future}.}.
  3820. For example, lets assume that today is @b{June 13, 2006}. Here is how
  3821. various inputs will be interpreted, the items filled in by Org mode are
  3822. in @b{bold}.
  3823. @example
  3824. 3-2-5 --> 2003-02-05
  3825. 14 --> @b{2006}-@b{06}-14
  3826. 12 --> @b{2006}-@b{07}-12
  3827. Fri --> nearest Friday (defaultdate or later)
  3828. sep 15 --> @b{2006}-11-15
  3829. feb 15 --> @b{2007}-02-15
  3830. sep 12 9 --> 2009-09-12
  3831. 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
  3832. 22 sept 0:34 --> @b{2006}-09-22 0:34
  3833. w4 --> ISO week for of the current year @b{2006}
  3834. 2012 w4 fri --> Friday of ISO week 4 in 2012
  3835. 2012-w04-5 --> Same as above
  3836. @end example
  3837. Furthermore you can specify a relative date by giving, as the
  3838. @emph{first} thing in the input: a plus/minus sign, a number and a
  3839. letter [dwmy] to indicate change in days weeks, months, years. With a
  3840. single plus or minus, the date is always relative to today. With a
  3841. double plus or minus, it is relative to the default date. If instead of
  3842. a single letter, you use the abbreviation of day name, the date will be
  3843. the nth such day. E.g.
  3844. @example
  3845. +0 --> today
  3846. . --> today
  3847. +4d --> four days from today
  3848. +4 --> same as above
  3849. +2w --> two weeks from today
  3850. ++5 --> five days from default date
  3851. +2tue --> second tuesday from now.
  3852. @end example
  3853. The function understands English month and weekday abbreviations. If
  3854. you want to use unabbreviated names and/or other languages, configure
  3855. the variables @code{parse-time-months} and @code{parse-time-weekdays}.
  3856. @cindex calendar, for selecting date
  3857. Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
  3858. you don't need/want the calendar, configure the variable
  3859. @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
  3860. prompt, either by clicking on a date in the calendar, or by pressing
  3861. @key{RET}, the date selected in the calendar will be combined with the
  3862. information entered at the prompt. You can control the calendar fully
  3863. from the minibuffer:
  3864. @kindex <
  3865. @kindex >
  3866. @kindex mouse-1
  3867. @kindex S-@key{right}
  3868. @kindex S-@key{left}
  3869. @kindex S-@key{down}
  3870. @kindex S-@key{up}
  3871. @kindex M-S-@key{right}
  3872. @kindex M-S-@key{left}
  3873. @kindex @key{RET}
  3874. @example
  3875. > / < @r{Scroll calendar forward/backward by one month.}
  3876. mouse-1 @r{Select date by clicking on it.}
  3877. S-@key{right}/@key{left} @r{One day forward/backward.}
  3878. S-@key{down}/@key{up} @r{One week forward/backward.}
  3879. M-S-@key{right}/@key{left} @r{One month forward/backward.}
  3880. @key{RET} @r{Choose date in calendar.}
  3881. @end example
  3882. The actions of the date/time prompt may seem complex, but I assure you they
  3883. will grow on you, and you will start getting annoyed by pretty much any other
  3884. way of entering a date/time out there. To help you understand what is going
  3885. on, the current interpretation of your input will be displayed live in the
  3886. minibuffer@footnote{If you find this distracting, turn the display of with
  3887. @code{org-read-date-display-live}.}.
  3888. @node Custom time format, , The date/time prompt, Creating timestamps
  3889. @subsection Custom time format
  3890. @cindex custom date/time format
  3891. @cindex time format, custom
  3892. @cindex date format, custom
  3893. Org mode uses the standard ISO notation for dates and times as it is
  3894. defined in ISO 8601. If you cannot get used to this and require another
  3895. representation of date and time to keep you happy, you can get it by
  3896. customizing the variables @code{org-display-custom-times} and
  3897. @code{org-time-stamp-custom-formats}.
  3898. @table @kbd
  3899. @kindex C-c C-x C-t
  3900. @item C-c C-x C-t
  3901. Toggle the display of custom formats for dates and times.
  3902. @end table
  3903. @noindent
  3904. Org mode needs the default format for scanning, so the custom date/time
  3905. format does not @emph{replace} the default format - instead it is put
  3906. @emph{over} the default format using text properties. This has the
  3907. following consequences:
  3908. @itemize @bullet
  3909. @item
  3910. You cannot place the cursor onto a time stamp anymore, only before or
  3911. after.
  3912. @item
  3913. The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
  3914. each component of a time stamp. If the cursor is at the beginning of
  3915. the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
  3916. just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
  3917. time will be changed by one minute.
  3918. @item
  3919. If the time stamp contains a range of clock times or a repeater, these
  3920. will not be overlayed, but remain in the buffer as they were.
  3921. @item
  3922. When you delete a time stamp character-by-character, it will only
  3923. disappear from the buffer after @emph{all} (invisible) characters
  3924. belonging to the ISO timestamp have been removed.
  3925. @item
  3926. If the custom time stamp format is longer than the default and you are
  3927. using dates in tables, table alignment will be messed up. If the custom
  3928. format is shorter, things do work as expected.
  3929. @end itemize
  3930. @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
  3931. @section Deadlines and scheduling
  3932. A time stamp may be preceded by special keywords to facilitate planning:
  3933. @table @var
  3934. @item DEADLINE
  3935. @cindex DEADLINE keyword
  3936. Meaning: the task (most likely a TODO item, though not necessarily) is supposed
  3937. to be finished on that date.
  3938. On the deadline date, the task will be listed in the agenda. In
  3939. addition, the agenda for @emph{today} will carry a warning about the
  3940. approaching or missed deadline, starting
  3941. @code{org-deadline-warning-days} before the due date, and continuing
  3942. until the entry is marked DONE. An example:
  3943. @example
  3944. *** TODO write article about the Earth for the Guide
  3945. The editor in charge is [[bbdb:Ford Prefect]]
  3946. DEADLINE: <2004-02-29 Sun>
  3947. @end example
  3948. You can specify a different lead time for warnings for a specific
  3949. deadlines using the following syntax. Here is an example with a warning
  3950. period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
  3951. @item SCHEDULED
  3952. @cindex SCHEDULED keyword
  3953. Meaning: you are planning to start working on that task on the given
  3954. date.
  3955. The headline will be listed under the given date@footnote{It will still
  3956. be listed on that date after it has been marked DONE. If you don't like
  3957. this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
  3958. addition, a reminder that the scheduled date has passed will be present
  3959. in the compilation for @emph{today}, until the entry is marked DONE.
  3960. I.e., the task will automatically be forwarded until completed.
  3961. @example
  3962. *** TODO Call Trillian for a date on New Years Eve.
  3963. SCHEDULED: <2004-12-25 Sat>
  3964. @end example
  3965. @noindent
  3966. @b{Important:} Scheduling an item in Org mode should @i{not} be
  3967. understood in the same way that we understand @i{scheduling a meeting}.
  3968. Setting a date for a meeting is just a simple appointment, you should
  3969. mark this entry with a simple plain time stamp, to get this item shown
  3970. on the date where it applies. This is a frequent mis-understanding from
  3971. Org-users. In Org mode, @i{scheduling} means setting a date when you
  3972. want to start working on an action item.
  3973. @end table
  3974. You may use time stamps with repeaters in scheduling and deadline
  3975. entries. Org mode will issue early and late warnings based on the
  3976. assumption that the time stamp represents the @i{nearest instance} of
  3977. the repeater. However, the use of diary sexp entries like
  3978. @c
  3979. @code{<%%(diary-float t 42)>}
  3980. @c
  3981. in scheduling and deadline timestamps is limited. Org mode does not
  3982. know enough about the internals of each sexp function to issue early and
  3983. late warnings. However, it will show the item on each day where the
  3984. sexp entry matches.
  3985. @menu
  3986. * Inserting deadline/schedule:: Planning items
  3987. * Repeated tasks:: Items that show up again and again
  3988. @end menu
  3989. @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
  3990. @subsection Inserting deadlines or schedules
  3991. The following commands allow to quickly insert a deadline or to schedule
  3992. an item:
  3993. @table @kbd
  3994. @c
  3995. @kindex C-c C-d
  3996. @item C-c C-d
  3997. Insert @samp{DEADLINE} keyword along with a stamp. The insertion will
  3998. happen in the line directly following the headline. When called with a
  3999. prefix arg, an existing deadline will be removed from the entry.
  4000. @c FIXME Any CLOSED timestamp will be removed.????????
  4001. @c
  4002. @kindex C-c / d
  4003. @cindex sparse tree, for deadlines
  4004. @item C-c / d
  4005. Create a sparse tree with all deadlines that are either past-due, or
  4006. which will become due within @code{org-deadline-warning-days}.
  4007. With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
  4008. prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
  4009. all deadlines due tomorrow.
  4010. @c
  4011. @kindex C-c C-s
  4012. @item C-c C-s
  4013. Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
  4014. happen in the line directly following the headline. Any CLOSED
  4015. timestamp will be removed. When called with a prefix argument, remove
  4016. the scheduling date from the entry.
  4017. @c
  4018. @kindex C-c C-x C-k
  4019. @kindex k a
  4020. @kindex k s
  4021. @item C-c C-x C-k
  4022. Mark the current entry for agenda action. After you have marked the entry
  4023. like this, you can open the agenda or the calendar to find an appropriate
  4024. date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
  4025. schedule the marked item.
  4026. @end table
  4027. @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
  4028. @subsection Repeated tasks
  4029. Some tasks need to be repeated again and again. Org mode helps to
  4030. organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
  4031. or plain time stamp. In the following example
  4032. @example
  4033. ** TODO Pay the rent
  4034. DEADLINE: <2005-10-01 Sat +1m>
  4035. @end example
  4036. the @code{+1m} is a repeater; the intended interpretation is that the
  4037. task has a deadline on <2005-10-01> and repeats itself every (one) month
  4038. starting from that time. If you need both a repeater and a special
  4039. warning period in a deadline entry, the repeater comes first and the
  4040. warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
  4041. Deadlines and scheduled items produce entries in the agenda when they
  4042. are over-due, so it is important to be able to mark such an entry as
  4043. completed once you have done so. When you mark a DEADLINE or a SCHEDULE
  4044. with the TODO keyword DONE, it will no longer produce entries in the
  4045. agenda. The problem with this is, however, that then also the
  4046. @emph{next} instance of the repeated entry will not be active. Org mode
  4047. deals with this in the following way: When you try to mark such an entry
  4048. DONE (using @kbd{C-c C-t}), it will shift the base date of the repeating
  4049. time stamp by the repeater interval, and immediately set the entry state
  4050. back to TODO. In the example above, setting the state to DONE would
  4051. actually switch the date like this:
  4052. @example
  4053. ** TODO Pay the rent
  4054. DEADLINE: <2005-11-01 Tue +1m>
  4055. @end example
  4056. A timestamp@footnote{You can change this using the option
  4057. @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
  4058. @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
  4059. will aslo be prompted for a note.} will be added under the deadline, to keep
  4060. a record that you actually acted on the previous instance of this deadline.
  4061. As a consequence of shifting the base date, this entry will no longer be
  4062. visible in the agenda when checking past dates, but all future instances
  4063. will be visible.
  4064. With the @samp{+1m} cookie, the date shift will always be exactly one
  4065. month. So if you have not payed the rent for three months, marking this
  4066. entry DONE will still keep it as an overdue deadline. Depending on the
  4067. task, this may not be the best way to handle it. For example, if you
  4068. forgot to call you father for 3 weeks, it does not make sense to call
  4069. him 3 times in a single day to make up for it. Finally, there are tasks
  4070. like changing batteries which should always repeat a certain time
  4071. @i{after} the last time you did it. For these tasks, Org mode has
  4072. special repeaters markers with @samp{++} and @samp{.+}. For example:
  4073. @example
  4074. ** TODO Call Father
  4075. DEADLINE: <2008-02-10 Sun ++1w>
  4076. Marking this DONE will shift the date by at least one week,
  4077. but also by as many weeks as it takes to get this date into
  4078. the future. However, it stays on a Sunday, even if you called
  4079. and marked it done on Saturday.
  4080. ** TODO Check the batteries in the smoke detectors
  4081. DEADLINE: <2005-11-01 Tue .+1m>
  4082. Marking this DONE will shift the date to one month after
  4083. today.
  4084. @end example
  4085. You may have both scheduling and deadline information for a specific
  4086. task - just make sure that the repeater intervals on both are the same.
  4087. @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
  4088. @section Clocking work time
  4089. Org mode allows you to clock the time you spent on specific tasks in a
  4090. project. When you start working on an item, you can start the clock.
  4091. When you stop working on that task, or when you mark the task done, the
  4092. clock is stopped and the corresponding time interval is recorded. It
  4093. also computes the total time spent on each subtree of a project.
  4094. @table @kbd
  4095. @kindex C-c C-x C-i
  4096. @item C-c C-x C-i
  4097. Start the clock on the current item (clock-in). This inserts the CLOCK
  4098. keyword together with a timestamp. If this is not the first clocking of
  4099. this item, the multiple CLOCK lines will be wrapped into a
  4100. @code{:CLOCK:} drawer (see also the variable
  4101. @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
  4102. select the task from a list of recently clocked tasks. With two @kbd{C-u
  4103. C-u} prefixes, clock into the task at point and mark it as the default task.
  4104. The default task will always be available when selecting a clocking task,
  4105. with letter @kbd{d}.
  4106. @kindex C-c C-x C-o
  4107. @item C-c C-x C-o
  4108. Stop the clock (clock-out). The inserts another timestamp at the same
  4109. location where the clock was last started. It also directly computes
  4110. the resulting time in inserts it after the time range as @samp{=>
  4111. HH:MM}. See the variable @code{org-log-note-clock-out} for the
  4112. possibility to record an additional note together with the clock-out
  4113. time stamp@footnote{The corresponding in-buffer setting is:
  4114. @code{#+STARTUP: lognoteclock-out}}.
  4115. @kindex C-c C-y
  4116. @item C-c C-y
  4117. Recompute the time interval after changing one of the time stamps. This
  4118. is only necessary if you edit the time stamps directly. If you change
  4119. them with @kbd{S-@key{cursor}} keys, the update is automatic.
  4120. @kindex C-c C-t
  4121. @item C-c C-t
  4122. Changing the TODO state of an item to DONE automatically stops the clock
  4123. if it is running in this same item.
  4124. @kindex C-c C-x C-x
  4125. @item C-c C-x C-x
  4126. Cancel the current clock. This is useful if a clock was started by
  4127. mistake, or if you ended up working on something else.
  4128. @kindex C-c C-x C-j
  4129. @item C-c C-x C-j
  4130. Jump to the entry that contains the currently running clock. With a
  4131. @kbd{C-u} prefix arg, select the target task from a list of recently clocked
  4132. tasks.
  4133. @kindex C-c C-x C-d
  4134. @item C-c C-x C-d
  4135. Display time summaries for each subtree in the current buffer. This
  4136. puts overlays at the end of each headline, showing the total time
  4137. recorded under that heading, including the time of any subheadings. You
  4138. can use visibility cycling to study the tree, but the overlays disappear
  4139. when you change the buffer (see variable
  4140. @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
  4141. @kindex C-c C-x C-r
  4142. @item C-c C-x C-r
  4143. Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
  4144. report as an Org mode table into the current file. When the cursor is
  4145. at an existing clock table, just update it. When called with a prefix
  4146. argument, jump to the first clock report in the current document and
  4147. update it.
  4148. @cindex #+BEGIN: clocktable
  4149. @example
  4150. #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
  4151. #+END: clocktable
  4152. @end example
  4153. @noindent
  4154. If such a block already exists at point, its content is replaced by the
  4155. new table. The @samp{BEGIN} line can specify options:
  4156. @example
  4157. :maxlevel @r{Maximum level depth to which times are listed in the table.}
  4158. :emphasize @r{When @code{t}, emphasize level one and level two items}
  4159. :scope @r{The scope to consider. This can be any of the following:}
  4160. nil @r{the current buffer or narrowed region}
  4161. file @r{the full current buffer}
  4162. subtree @r{the subtree where the clocktable is located}
  4163. treeN @r{the surrounding level N tree, for example @code{tree3}}
  4164. tree @r{the surrounding level 1 tree}
  4165. agenda @r{all agenda files}
  4166. ("file"..) @r{scan these files}
  4167. file-with-archives @r{current file and its archives}
  4168. agenda-with-archives @r{all agenda files, including archives}
  4169. :block @r{The time block to consider. This block is specified either}
  4170. @r{absolute, or relative to the current time and may be any of}
  4171. @r{these formats:}
  4172. 2007-12-31 @r{New year eve 2007}
  4173. 2007-12 @r{December 2007}
  4174. 2007-W50 @r{ISO-week 50 in 2007}
  4175. 2007 @r{the year 2007}
  4176. today, yesterday, today-N @r{a relative day}
  4177. thisweek, lastweek, thisweek-N @r{a relative week}
  4178. thismonth, lastmonth, thismonth-N @r{a relative month}
  4179. thisyear, lastyear, thisyear-N @r{a relative year}
  4180. @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
  4181. :tstart @r{A time string specifying when to start considering times}
  4182. :tend @r{A time string specifying when to stop considering times}
  4183. :step @r{@code{week} or @code{day}, to split the table into chunks.}
  4184. @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
  4185. :link @r{Link the item headlines in the table to their origins}
  4186. @end example
  4187. So to get a clock summary of the current level 1 tree, for the current
  4188. day, you could write
  4189. @example
  4190. #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
  4191. #+END: clocktable
  4192. @end example
  4193. and to use a specific time range you could write@footnote{Note that all
  4194. parameters must be specified in a single line - the line is broken here
  4195. only to fit it onto the manual.}
  4196. @example
  4197. #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
  4198. :tend "<2006-08-10 Thu 12:00>"
  4199. #+END: clocktable
  4200. @end example
  4201. @kindex C-c C-c
  4202. @item C-c C-c
  4203. @kindex C-c C-x C-u
  4204. @itemx C-c C-x C-u
  4205. Update dynamical block at point. The cursor needs to be in the
  4206. @code{#+BEGIN} line of the dynamic block.
  4207. @kindex C-u C-c C-x C-u
  4208. @item C-u C-c C-x C-u
  4209. Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
  4210. you have several clock table blocks in a buffer.
  4211. @kindex S-@key{left}
  4212. @kindex S-@key{right}
  4213. @item S-@key{left}
  4214. @itemx S-@key{right}
  4215. Shift the current @code{:block} interval and update the table. The cursor
  4216. needs to be in the @code{#+BEGIN: clocktable} line for this command. If
  4217. @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
  4218. @end table
  4219. The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
  4220. the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
  4221. worked on or closed during a day.
  4222. @node Effort estimates, , Clocking work time, Dates and Times
  4223. @section Effort estimates
  4224. @cindex Effort estimates
  4225. If you want to plan your work in a very detailed way, or if you need to
  4226. produce offers with quotations of the estimated work effort, you may want to
  4227. assign effort estimates to entries. If you are also clocking your work, you
  4228. may later want to compare the planned effort with the actual working time, a
  4229. great way to improve planning estimates. Effort estimates are stored in a
  4230. special property @samp{Effort}@footnote{You may change the property being
  4231. used with the variable @code{org-effort-property}.}. Clearly the best way to
  4232. work with effort estimates is through column view (@pxref{Column view}). You
  4233. should start by setting up discrete values for effort estimates, and a
  4234. @code{COLUMNS} format that displays these values together with clock sums (if
  4235. you want to clock your time). For a specific buffer you can use
  4236. @example
  4237. #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
  4238. #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
  4239. @end example
  4240. @noindent
  4241. or, even better, you can set up these values globally by customizing the
  4242. variables @code{org-global-properties} and @code{org-columns-default-format}.
  4243. In particular if you want to use this setup also in the agenda, a global
  4244. setup may be advised.
  4245. The way to assign estimates to individual items is then to switch to column
  4246. mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
  4247. value. The values you enter will immediately be summed up in the hierarchy.
  4248. In the column next to it, any clocked time will be displayed.
  4249. If you switch to column view in the daily/weekly agenda, the effort column
  4250. will summarize the estimated work effort for each day@footnote{Please note
  4251. the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
  4252. column view}).}, and you can use this to find space in your schedule. To get
  4253. an overview of the entire part of the day that is committed, you can set the
  4254. option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
  4255. appointments on a day that take place over a specified time interval will
  4256. then also be added to the load estimate of the day.
  4257. Effort estimates can be used in secondary agenda filtering that is triggered
  4258. with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
  4259. these estimates defined consistently, two or three key presses will narrow
  4260. down the list to stuff that fits into an available time slot.
  4261. @node Capture, Agenda Views, Dates and Times, Top
  4262. @chapter Capture
  4263. @cindex capture
  4264. An important part of any organization system is the ability to quickly
  4265. capture new ideas and tasks, and to associate reference material with them.
  4266. Org uses the @file{remember} package to create tasks, and stores files
  4267. related to a task (@i{attachments}) in a special directory.
  4268. @menu
  4269. * Remember:: Capture new tasks/ideas with little interruption
  4270. * Attachments:: Add files to tasks.
  4271. @end menu
  4272. @node Remember, Attachments, Capture, Capture
  4273. @section Remember
  4274. @cindex @file{remember.el}
  4275. The @i{Remember} package by John Wiegley lets you store quick notes with
  4276. little interruption of your work flow. See
  4277. @uref{http://www.emacswiki.org/cgi-bin/wiki/RememberMode} for more
  4278. information. It is an excellent way to add new notes and tasks to
  4279. Org files. Org significantly expands the possibilities of
  4280. @i{remember}: You may define templates for different note types, and
  4281. associate target files and headlines with specific templates. It also
  4282. allows you to select the location where a note should be stored
  4283. interactively, on the fly.
  4284. @menu
  4285. * Setting up Remember:: Some code for .emacs to get things going
  4286. * Remember templates:: Define the outline of different note types
  4287. * Storing notes:: Directly get the note to where it belongs
  4288. * Refiling notes:: Moving a note or task to a project
  4289. @end menu
  4290. @node Setting up Remember, Remember templates, Remember, Remember
  4291. @subsection Setting up Remember
  4292. The following customization will tell @i{remember} to use org files as
  4293. target, and to create annotations compatible with Org links.
  4294. @example
  4295. (org-remember-insinuate)
  4296. (setq org-directory "~/path/to/my/orgfiles/")
  4297. (setq org-default-notes-file (concat org-directory "/notes.org"))
  4298. (define-key global-map "\C-cr" 'org-remember)
  4299. @end example
  4300. The last line binds the command @code{org-remember} to a global
  4301. key@footnote{Please select your own key, @kbd{C-c r} is only a
  4302. suggestion.}. @code{org-remember} basically just calls @code{remember},
  4303. but it makes a few things easier: If there is an active region, it will
  4304. automatically copy the region into the remember buffer. It also allows
  4305. to jump to the buffer and location where remember notes are being
  4306. stored: Just call @code{org-remember} with a prefix argument. If you
  4307. use two prefix arguments, Org jumps to the location where the last
  4308. remember note was stored.
  4309. You can also call @code{org-remember} in a special way from the agenda,
  4310. using the @kbd{k r} key combination. With this access, any time stamps
  4311. inserted by the selected remember template (see below) will default to
  4312. the cursor date in the agenda, rather than to the current date.
  4313. @node Remember templates, Storing notes, Setting up Remember, Remember
  4314. @subsection Remember templates
  4315. @cindex templates, for remember
  4316. In combination with Org, you can use templates to generate
  4317. different types of @i{remember} notes. For example, if you would like
  4318. to use one template to create general TODO entries, another one for
  4319. journal entries, and a third one for collecting random ideas, you could
  4320. use:
  4321. @example
  4322. (setq org-remember-templates
  4323. '(("Todo" ?t "* TODO %?\n %i\n %a" "~/org/TODO.org" "Tasks")
  4324. ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org")
  4325. ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
  4326. @end example
  4327. @noindent In these entries, the first string is just a name, and the
  4328. character specifies how to select the template. It is useful if the
  4329. character is also the first letter of the name. The next string specifies
  4330. the template. Two more (optional) strings give the file in which, and the
  4331. headline under which the new note should be stored. The file (if not present
  4332. or @code{nil}) defaults to @code{org-default-notes-file}, the heading to
  4333. @code{org-remember-default-headline}. If the file name is not an absolute
  4334. path, it will be interpreted relative to @code{org-directory}. The heading
  4335. can also be the symbols @code{top} or @code{bottom} to send note as level 1
  4336. entries to the beginning or end of the file, respectively.
  4337. An optional sixth element specifies the contexts in which the user can select
  4338. the template. This element can be a list of major modes or a function.
  4339. @code{org-remember} will first check whether the function returns @code{t} or
  4340. if we are in any of the listed major mode, and exclude templates fo which
  4341. this condition is not fulfilled. Templates that do not specify this element
  4342. at all, or that use @code{nil} or @code{t} as a value will always be
  4343. selectable.
  4344. So for example:
  4345. @example
  4346. (setq org-remember-templates
  4347. '(("Bug" ?b "* BUG %?\n %i\n %a" "~/org/BUGS.org" "Bugs" (emacs-lisp-mode))
  4348. ("Journal" ?j "* %U %?\n\n %i\n %a" "~/org/JOURNAL.org" "X" my-check)
  4349. ("Idea" ?i "* %^@{Title@}\n %i\n %a" "~/org/JOURNAL.org" "New Ideas")))
  4350. @end example
  4351. The first template will only be available when invoking @code{org-remember}
  4352. from an buffer in @code{emacs-lisp-mode}. The second template will only be
  4353. available when the function @code{my-check} returns @code{t}. The third
  4354. template will be proposed in any context.
  4355. When you call @kbd{M-x org-remember} (or @kbd{M-x remember}) to remember
  4356. something, Org will prompt for a key to select the template (if you have
  4357. more than one template) and then prepare the buffer like
  4358. @example
  4359. * TODO
  4360. [[file:link to where you called remember]]
  4361. @end example
  4362. @noindent
  4363. During expansion of the template, special @kbd{%}-escapes allow dynamic
  4364. insertion of content:
  4365. @example
  4366. %^@{prompt@} @r{prompt the user for a string and replace this sequence with it.}
  4367. @r{You may specify a default value and a completion table with}
  4368. @r{%^@{prompt|default|completion2|completion3...@}}
  4369. @r{The arrow keys access a prompt-specific history.}
  4370. %a @r{annotation, normally the link created with @code{org-store-link}}
  4371. %A @r{like @code{%a}, but prompt for the description part}
  4372. %i @r{initial content, the region when remember is called with C-u.}
  4373. @r{The entire text will be indented like @code{%i} itself.}
  4374. %t @r{time stamp, date only}
  4375. %T @r{time stamp with date and time}
  4376. %u, %U @r{like the above, but inactive time stamps}
  4377. %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
  4378. @r{You may define a prompt like @code{%^@{Birthday@}t}}
  4379. %n @r{user name (taken from @code{user-full-name})}
  4380. %c @r{Current kill ring head.}
  4381. %x @r{Content of the X clipboard.}
  4382. %^C @r{Interactive selection of which kill or clip to use.}
  4383. %^L @r{Like @code{%^C}, but insert as link.}
  4384. %^g @r{prompt for tags, with completion on tags in target file.}
  4385. %k @r{title of currently clocked task}
  4386. %K @r{link to currently clocked task}
  4387. %^G @r{prompt for tags, with completion all tags in all agenda files.}
  4388. %^@{prop@}p @r{Prompt the user for a value for property @code{prop}}
  4389. %:keyword @r{specific information for certain link types, see below}
  4390. %[pathname] @r{insert the contents of the file given by @code{pathname}}
  4391. %(sexp) @r{evaluate elisp @code{(sexp)} and replace with the result}
  4392. %! @r{immediately store note after completing the template}
  4393. @r{(skipping the @kbd{C-c C-c} that normally triggers storing)}
  4394. %& @r{jump to target location immediately after storing note}
  4395. @end example
  4396. @noindent
  4397. For specific link types, the following keywords will be
  4398. defined@footnote{If you define your own link types (@pxref{Adding
  4399. hyperlink types}), any property you store with
  4400. @code{org-store-link-props} can be accessed in remember templates in a
  4401. similar way.}:
  4402. @example
  4403. Link type | Available keywords
  4404. -------------------+----------------------------------------------
  4405. bbdb | %:name %:company
  4406. bbdb | %::server %:port %:nick
  4407. vm, wl, mh, rmail | %:type %:subject %:message-id
  4408. | %:from %:fromname %:fromaddress
  4409. | %:to %:toname %:toaddress
  4410. | %:fromto @r{(either "to NAME" or "from NAME")@footnote{This will always be the other, not the user. See the variable @code{org-from-is-user-regexp}.}}
  4411. gnus | %:group, @r{for messages also all email fields}
  4412. w3, w3m | %:url
  4413. info | %:file %:node
  4414. calendar | %:date"
  4415. @end example
  4416. @noindent
  4417. To place the cursor after template expansion use:
  4418. @example
  4419. %? @r{After completing the template, position cursor here.}
  4420. @end example
  4421. @noindent
  4422. If you change your mind about which template to use, call
  4423. @code{org-remember} in the remember buffer. You may then select a new
  4424. template that will be filled with the previous context information.
  4425. @node Storing notes, Refiling notes, Remember templates, Remember
  4426. @subsection Storing notes
  4427. When you are finished preparing a note with @i{remember}, you have to press
  4428. @kbd{C-c C-c} to file the note away. If you have started the clock in the
  4429. remember buffer, you will first be asked if you want to clock out
  4430. now@footnote{To avoid this query, configure the variable
  4431. @code{org-remember-clock-out-on-exit}.}. If you answer @kbd{n}, the clock
  4432. will continue to run after the note was filed away.
  4433. The handler will then store the note in the file and under the headline
  4434. specified in the template, or it will use the default file and headlines.
  4435. The window configuration will be restored, sending you back to the working
  4436. context before the call to @code{remember}. To re-use the location found
  4437. during the last call to @code{remember}, exit the remember buffer with
  4438. @kbd{C-0 C-c C-c}, i.e. specify a zero prefix argument to @kbd{C-c C-c}.
  4439. Another special case is @kbd{C-2 C-c C-c} which files the note as a child of
  4440. the currently clocked item.
  4441. If you want to store the note directly to a different place, use
  4442. @kbd{C-1 C-c C-c} instead to exit remember@footnote{Configure the
  4443. variable @code{org-remember-store-without-prompt} to make this behavior
  4444. the default.}. The handler will then first prompt for a target file -
  4445. if you press @key{RET}, the value specified for the template is used.
  4446. Then the command offers the headings tree of the selected file, with the
  4447. cursor position at the default headline (if you had specified one in the
  4448. template). You can either immediately press @key{RET} to get the note
  4449. placed there. Or you can use the following keys to find a different
  4450. location:
  4451. @example
  4452. @key{TAB} @r{Cycle visibility.}
  4453. @key{down} / @key{up} @r{Next/previous visible headline.}
  4454. n / p @r{Next/previous visible headline.}
  4455. f / b @r{Next/previous headline same level.}
  4456. u @r{One level up.}
  4457. @c 0-9 @r{Digit argument.}
  4458. @end example
  4459. @noindent
  4460. Pressing @key{RET} or @key{left} or @key{right}
  4461. then leads to the following result.
  4462. @multitable @columnfractions 0.2 0.15 0.65
  4463. @item @b{Cursor position} @tab @b{Key} @tab @b{Note gets inserted}
  4464. @item on headline @tab @key{RET} @tab as sublevel of the heading at cursor, first or last
  4465. @item @tab @tab depending on @code{org-reverse-note-order}.
  4466. @item @tab @key{left}/@key{right} @tab as same level, before/after current heading
  4467. @item buffer-start @tab @key{RET} @tab as level 2 heading at end of file or level 1 at beginning
  4468. @item @tab @tab depending on @code{org-reverse-note-order}.
  4469. @item not on headline @tab @key{RET}
  4470. @tab at cursor position, level taken from context.
  4471. @end multitable
  4472. Before inserting the text into a tree, the function ensures that the text has
  4473. a headline, i.e. a first line that starts with a @samp{*}. If not, a
  4474. headline is constructed from the current date. If you have indented the text
  4475. of the note below the headline, the indentation will be adapted if inserting
  4476. the note into the tree requires demotion from level 1.
  4477. @node Refiling notes, , Storing notes, Remember
  4478. @subsection Refiling notes
  4479. @cindex refiling notes
  4480. Remember is usually used to quickly capture notes and tasks into one or
  4481. a few capture lists. When reviewing the captured data, you may want to
  4482. refile some of the entries into a different list, for example into a
  4483. project. Cutting, finding the right location and then pasting the note
  4484. is cumbersome. To simplify this process, you can use the following
  4485. special command:
  4486. @table @kbd
  4487. @kindex C-c C-w
  4488. @item C-c C-w
  4489. Refile the entry at point. This command offers possible locations for
  4490. refiling the entry and lets you select one with completion. The item is
  4491. filed below the target heading as a subitem. Depending on
  4492. @code{org-reverse-note-order}, it will be either the first of last
  4493. subitem.@* By default, all level 1 headlines in the current buffer are
  4494. considered to be targets, but you can have more complex definitions
  4495. across a number of files. See the variable @code{org-refile-targets}
  4496. for details. If you would like to select a location via a file-pathlike
  4497. completion along the outline path, see the variable
  4498. @code{org-refile-use-outline-path}.
  4499. @kindex C-u C-c C-w
  4500. @item C-u C-c C-w
  4501. Use the refile interface to jump to a heading.
  4502. @kindex C-u C-u C-c C-w
  4503. @item C-u C-u C-c C-w
  4504. Jump to the location where @code{org-refile} last moved a tree to.
  4505. @end table
  4506. @node Attachments, , Remember, Capture
  4507. @section Attachments
  4508. @cindex attachments
  4509. It is often useful to associate reference material with an outline node/task.
  4510. Small chunks of plain text can simply be stored in the subtree of a project.
  4511. Hyperlinks (@pxref{Hyperlinks}) can be used to establish associations with
  4512. files that live elsewhere on your computer or in the cloud, like emails or
  4513. source code files belonging to a project. Another method is @i{attachments},
  4514. which are files located in a directory belonging to an outline node. Org
  4515. uses directories named by the unique ID of each entry. These directories are
  4516. located in the @file{data} directory which lives in the same directory where
  4517. your org-file lives@footnote{If you move entries or Org-files from one
  4518. directory to the next, you may want to configure @code{org-attach-directory}
  4519. to contain an absolute path.}. If you initialize this directory with
  4520. @code{git-init}, Org will automatically commit changes when it sees them.
  4521. The attachment system has been contributed to Org by John Wiegley.
  4522. @noindent The following commands deal with attachments.
  4523. @table @kbd
  4524. @kindex C-c C-a
  4525. @item C-c C-a
  4526. The dispatcher for commands related to the attachment system. After these
  4527. keys, a list of commands is displayed and you need to press an additional key
  4528. to select a command:
  4529. @table @kbd
  4530. @kindex C-c C-a a
  4531. @item a
  4532. Select a file and move it into the task's attachment directory. The file
  4533. will be copied, moved, or linked, depending on @code{org-attach-method}.
  4534. Note that hard links are not supported on all systems.
  4535. @kindex C-c C-a c
  4536. @kindex C-c C-a m
  4537. @kindex C-c C-a l
  4538. @item c/m/l
  4539. Attach a file using the copy/move/link method.
  4540. Note that hard links are not supported on all systems.
  4541. @kindex C-c C-a n
  4542. @item n
  4543. Create a new attachment as an Emacs buffer.
  4544. @kindex C-c C-a z
  4545. @item z
  4546. Synchronize the current task with its attachment directory, in case you added
  4547. attachments yourself.
  4548. @kindex C-c C-a o
  4549. @item o
  4550. Open current task's attachment. If there are more than one, prompt for a
  4551. file name first. Opening will follow the rules set by @code{org-file-apps}.
  4552. For more details, see the information on following hyperlings
  4553. (@pxref{Handling links}).
  4554. @kindex C-c C-a O
  4555. @item O
  4556. Also open the attachment, but force opening the file in Emacs.
  4557. @kindex C-c C-a f
  4558. @item f
  4559. Open the current task's attachment directory.
  4560. @kindex C-c C-a F
  4561. @item F
  4562. Also open the directory, but force using @code{dired} in Emacs.
  4563. @kindex C-c C-a d
  4564. @item d
  4565. Select and delete a single attachment.
  4566. @kindex C-c C-a D
  4567. @item D
  4568. Delete all of a task's attachments. A safer way is to open the directory in
  4569. dired and delete from there.
  4570. @end table
  4571. @end table
  4572. @node Agenda Views, Embedded LaTeX, Capture, Top
  4573. @chapter Agenda Views
  4574. @cindex agenda views
  4575. Due to the way Org works, TODO items, time-stamped items, and
  4576. tagged headlines can be scattered throughout a file or even a number of
  4577. files. To get an overview of open action items, or of events that are
  4578. important for a particular date, this information must be collected,
  4579. sorted and displayed in an organized way.
  4580. Org can select items based on various criteria, and display them
  4581. in a separate buffer. Seven different view types are provided:
  4582. @itemize @bullet
  4583. @item
  4584. an @emph{agenda} that is like a calendar and shows information
  4585. for specific dates,
  4586. @item
  4587. a @emph{TODO list} that covers all unfinished
  4588. action items,
  4589. @item
  4590. a @emph{match view}, showings headlines based on the tags, properties and
  4591. TODO state associated with them,
  4592. @item
  4593. a @emph{timeline view} that shows all events in a single Org file,
  4594. in time-sorted view,
  4595. @item
  4596. a @emph{keyword search view} that shows all entries from multiple files
  4597. that contain specified keywords.
  4598. @item
  4599. a @emph{stuck projects view} showing projects that currently don't move
  4600. along, and
  4601. @item
  4602. @emph{custom views} that are special tag/keyword searches and
  4603. combinations of different views.
  4604. @end itemize
  4605. @noindent
  4606. The extracted information is displayed in a special @emph{agenda
  4607. buffer}. This buffer is read-only, but provides commands to visit the
  4608. corresponding locations in the original Org files, and even to
  4609. edit these files remotely.
  4610. Two variables control how the agenda buffer is displayed and whether the
  4611. window configuration is restored when the agenda exits:
  4612. @code{org-agenda-window-setup} and
  4613. @code{org-agenda-restore-windows-after-quit}.
  4614. @menu
  4615. * Agenda files:: Files being searched for agenda information
  4616. * Agenda dispatcher:: Keyboard access to agenda views
  4617. * Built-in agenda views:: What is available out of the box?
  4618. * Presentation and sorting:: How agenda items are prepared for display
  4619. * Agenda commands:: Remote editing of Org trees
  4620. * Custom agenda views:: Defining special searches and views
  4621. * Agenda column view:: Using column view for collected entries
  4622. @end menu
  4623. @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
  4624. @section Agenda files
  4625. @cindex agenda files
  4626. @cindex files for agenda
  4627. The information to be shown is normally collected from all @emph{agenda
  4628. files}, the files listed in the variable
  4629. @code{org-agenda-files}@footnote{If the value of that variable is not a
  4630. list, but a single file name, then the list of agenda files will be
  4631. maintained in that external file.}. If a directory is part of this list,
  4632. all files with the extension @file{.org} in this directory will be part
  4633. of the list.
  4634. Thus even if you only work with a single Org file, this file should
  4635. be put into that list@footnote{When using the dispatcher, pressing
  4636. @kbd{<} before selecting a command will actually limit the command to
  4637. the current file, and ignore @code{org-agenda-files} until the next
  4638. dispatcher command.}. You can customize @code{org-agenda-files}, but
  4639. the easiest way to maintain it is through the following commands
  4640. @cindex files, adding to agenda list
  4641. @table @kbd
  4642. @kindex C-c [
  4643. @item C-c [
  4644. Add current file to the list of agenda files. The file is added to
  4645. the front of the list. If it was already in the list, it is moved to
  4646. the front. With a prefix argument, file is added/moved to the end.
  4647. @kindex C-c ]
  4648. @item C-c ]
  4649. Remove current file from the list of agenda files.
  4650. @kindex C-,
  4651. @kindex C-'
  4652. @item C-,
  4653. @itemx C-'
  4654. Cycle through agenda file list, visiting one file after the other.
  4655. @kindex M-x org-iswitchb
  4656. @item M-x org-iswitchb
  4657. Command to use an @code{iswitchb}-like interface to switch to and between Org
  4658. buffers.
  4659. @end table
  4660. @noindent
  4661. The Org menu contains the current list of files and can be used
  4662. to visit any of them.
  4663. If you would like to focus the agenda temporarily onto a file not in
  4664. this list, or onto just one file in the list or even only a subtree in a
  4665. file, this can be done in different ways. For a single agenda command,
  4666. you may press @kbd{<} once or several times in the dispatcher
  4667. (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
  4668. extended period, use the following commands:
  4669. @table @kbd
  4670. @kindex C-c C-x <
  4671. @item C-c C-x <
  4672. Permanently restrict the agenda to the current subtree. When with a
  4673. prefix argument, or with the cursor before the first headline in a file,
  4674. the agenda scope is set to the entire file. This restriction remains in
  4675. effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
  4676. or @kbd{>} in the agenda dispatcher. If there is a window displaying an
  4677. agenda view, the new restriction takes effect immediately.
  4678. @kindex C-c C-x <
  4679. @item C-c C-x <
  4680. Remove the permanent restriction created by @kbd{C-c C-x <}.
  4681. @end table
  4682. @noindent
  4683. When working with @file{Speedbar}, you can use the following commands in
  4684. the Speedbar frame:
  4685. @table @kbd
  4686. @kindex <
  4687. @item < @r{in the speedbar frame}
  4688. Permanently restrict the agenda to the item at the cursor in the
  4689. Speedbar frame, either an Org file or a subtree in such a file.
  4690. If there is a window displaying an agenda view, the new restriction takes
  4691. effect immediately.
  4692. @kindex <
  4693. @item > @r{in the speedbar frame}
  4694. Lift the restriction again.
  4695. @end table
  4696. @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
  4697. @section The agenda dispatcher
  4698. @cindex agenda dispatcher
  4699. @cindex dispatching agenda commands
  4700. The views are created through a dispatcher that should be bound to a
  4701. global key, for example @kbd{C-c a} (@pxref{Installation}). In the
  4702. following we will assume that @kbd{C-c a} is indeed how the dispatcher
  4703. is accessed and list keyboard access to commands accordingly. After
  4704. pressing @kbd{C-c a}, an additional letter is required to execute a
  4705. command. The dispatcher offers the following default commands:
  4706. @table @kbd
  4707. @item a
  4708. Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
  4709. @item t @r{/} T
  4710. Create a list of all TODO items (@pxref{Global TODO list}).
  4711. @item m @r{/} M
  4712. Create a list of headlines matching a TAGS expression (@pxref{Matching
  4713. tags and properties}).
  4714. @item L
  4715. Create the timeline view for the current buffer (@pxref{Timeline}).
  4716. @item s
  4717. Create a list of entries selected by a boolean expression of keywords
  4718. and/or regular expressions that must or must not occur in the entry.
  4719. @item /
  4720. Search for a regular expression in all agenda files and additionally in
  4721. the files listed in @code{org-agenda-multi-occur-extra-files}. This
  4722. uses the Emacs command @code{multi-occur}. A prefix argument can be
  4723. used to specify the number of context lines for each match, default is
  4724. 1.
  4725. @item # @r{/} !
  4726. Create a list of stuck projects (@pxref{Stuck projects}).
  4727. @item <
  4728. Restrict an agenda command to the current buffer@footnote{For backward
  4729. compatibility, you can also press @kbd{1} to restrict to the current
  4730. buffer.}. After pressing @kbd{<}, you still need to press the character
  4731. selecting the command.
  4732. @item < <
  4733. If there is an active region, restrict the following agenda command to
  4734. the region. Otherwise, restrict it to the current subtree@footnote{For
  4735. backward compatibility, you can also press @kbd{0} to restrict to the
  4736. current buffer.}. After pressing @kbd{< <}, you still need to press the
  4737. character selecting the command.
  4738. @end table
  4739. You can also define custom commands that will be accessible through the
  4740. dispatcher, just like the default commands. This includes the
  4741. possibility to create extended agenda buffers that contain several
  4742. blocks together, for example the weekly agenda, the global TODO list and
  4743. a number of special tags matches. @xref{Custom agenda views}.
  4744. @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
  4745. @section The built-in agenda views
  4746. In this section we describe the built-in views.
  4747. @menu
  4748. * Weekly/daily agenda:: The calendar page with current tasks
  4749. * Global TODO list:: All unfinished action items
  4750. * Matching tags and properties:: Structured information with fine-tuned search
  4751. * Timeline:: Time-sorted view for single file
  4752. * Keyword search:: Finding entries by keyword
  4753. * Stuck projects:: Find projects you need to review
  4754. @end menu
  4755. @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
  4756. @subsection The weekly/daily agenda
  4757. @cindex agenda
  4758. @cindex weekly agenda
  4759. @cindex daily agenda
  4760. The purpose of the weekly/daily @emph{agenda} is to act like a page of a
  4761. paper agenda, showing all the tasks for the current week or day.
  4762. @table @kbd
  4763. @cindex org-agenda, command
  4764. @kindex C-c a a
  4765. @item C-c a a
  4766. Compile an agenda for the current week from a list of org files. The agenda
  4767. shows the entries for each day. With a numeric prefix@footnote{For backward
  4768. compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
  4769. listed before the agenda. This feature is deprecated, use the dedicated TODO
  4770. list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
  4771. C-c a a}) you may set the number of days to be displayed (see also the
  4772. variable @code{org-agenda-ndays})
  4773. @end table
  4774. Remote editing from the agenda buffer means, for example, that you can
  4775. change the dates of deadlines and appointments from the agenda buffer.
  4776. The commands available in the Agenda buffer are listed in @ref{Agenda
  4777. commands}.
  4778. @subsubheading Calendar/Diary integration
  4779. @cindex calendar integration
  4780. @cindex diary integration
  4781. Emacs contains the calendar and diary by Edward M. Reingold. The
  4782. calendar displays a three-month calendar with holidays from different
  4783. countries and cultures. The diary allows you to keep track of
  4784. anniversaries, lunar phases, sunrise/set, recurrent appointments
  4785. (weekly, monthly) and more. In this way, it is quite complementary to
  4786. Org. It can be very useful to combine output from Org with
  4787. the diary.
  4788. In order to include entries from the Emacs diary into Org mode's
  4789. agenda, you only need to customize the variable
  4790. @lisp
  4791. (setq org-agenda-include-diary t)
  4792. @end lisp
  4793. @noindent After that, everything will happen automatically. All diary
  4794. entries including holidays, anniversaries etc will be included in the
  4795. agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
  4796. @key{RET} can be used from the agenda buffer to jump to the diary
  4797. file in order to edit existing diary entries. The @kbd{i} command to
  4798. insert new entries for the current date works in the agenda buffer, as
  4799. well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
  4800. Sunrise/Sunset times, show lunar phases and to convert to other
  4801. calendars, respectively. @kbd{c} can be used to switch back and forth
  4802. between calendar and agenda.
  4803. If you are using the diary only for sexp entries and holidays, it is
  4804. faster to not use the above setting, but instead to copy or even move
  4805. the entries into an Org file. Org mode evaluates diary-style sexp
  4806. entries, and does it faster because there is no overhead for first
  4807. creating the diary display. Note that the sexp entries must start at
  4808. the left margin, no white space is allowed before them. For example,
  4809. the following segment of an Org file will be processed and entries
  4810. will be made in the agenda:
  4811. @example
  4812. * Birthdays and similar stuff
  4813. #+CATEGORY: Holiday
  4814. %%(org-calendar-holiday) ; special function for holiday names
  4815. #+CATEGORY: Ann
  4816. %%(diary-anniversary 14 5 1956) Arthur Dent is %d years old
  4817. %%(diary-anniversary 2 10 1869) Mahatma Gandhi would be %d years old
  4818. @end example
  4819. @subsubheading Appointment reminders
  4820. @cindex @file{appt.el}
  4821. @cindex appointment reminders
  4822. Org can interact with Emacs appointments notification facility.
  4823. To add all the appointments of your agenda files, use the command
  4824. @code{org-agenda-to-appt}. This commands also lets you filter through
  4825. the list of your appointments and add only those belonging to a specific
  4826. category or matching a regular expression. See the docstring for
  4827. details.
  4828. @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
  4829. @subsection The global TODO list
  4830. @cindex global TODO list
  4831. @cindex TODO list, global
  4832. The global TODO list contains all unfinished TODO items, formatted and
  4833. collected into a single place.
  4834. @table @kbd
  4835. @kindex C-c a t
  4836. @item C-c a t
  4837. Show the global TODO list. This collects the TODO items from all
  4838. agenda files (@pxref{Agenda Views}) into a single buffer. The buffer is in
  4839. @code{agenda-mode}, so there are commands to examine and manipulate
  4840. the TODO entries directly from that buffer (@pxref{Agenda commands}).
  4841. @kindex C-c a T
  4842. @item C-c a T
  4843. @cindex TODO keyword matching
  4844. Like the above, but allows selection of a specific TODO keyword. You
  4845. can also do this by specifying a prefix argument to @kbd{C-c a t}. With
  4846. a @kbd{C-u} prefix you are prompted for a keyword, and you may also
  4847. specify several keywords by separating them with @samp{|} as boolean OR
  4848. operator. With a numeric prefix, the Nth keyword in
  4849. @code{org-todo-keywords} is selected.
  4850. @kindex r
  4851. The @kbd{r} key in the agenda buffer regenerates it, and you can give
  4852. a prefix argument to this command to change the selected TODO keyword,
  4853. for example @kbd{3 r}. If you often need a search for a specific
  4854. keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
  4855. Matching specific TODO keywords can also be done as part of a tags
  4856. search (@pxref{Tag searches}).
  4857. @end table
  4858. Remote editing of TODO items means that you can change the state of a
  4859. TODO entry with a single key press. The commands available in the
  4860. TODO list are described in @ref{Agenda commands}.
  4861. @cindex sublevels, inclusion into TODO list
  4862. Normally the global TODO list simply shows all headlines with TODO
  4863. keywords. This list can become very long. There are two ways to keep
  4864. it more compact:
  4865. @itemize @minus
  4866. @item
  4867. Some people view a TODO item that has been @emph{scheduled} for
  4868. execution (@pxref{Timestamps}) as no longer @emph{open}. Configure the
  4869. variable @code{org-agenda-todo-ignore-scheduled} to exclude scheduled
  4870. items from the global TODO list.
  4871. @item
  4872. TODO items may have sublevels to break up the task into subtasks. In
  4873. such cases it may be enough to list only the highest level TODO headline
  4874. and omit the sublevels from the global list. Configure the variable
  4875. @code{org-agenda-todo-list-sublevels} to get this behavior.
  4876. @end itemize
  4877. @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
  4878. @subsection Matching tags and properties
  4879. @cindex matching, of tags
  4880. @cindex matching, of properties
  4881. @cindex tags view
  4882. @cindex match view
  4883. If headlines in the agenda files are marked with @emph{tags}
  4884. (@pxref{Tags}), you can select headlines based on the tags that apply
  4885. to them and collect them into an agenda buffer.
  4886. @table @kbd
  4887. @kindex C-c a m
  4888. @item C-c a m
  4889. Produce a list of all headlines that match a given set of tags. The
  4890. command prompts for a selection criterion, which is a boolean logic
  4891. expression with tags, like @samp{+work+urgent-withboss} or
  4892. @samp{work|home} (@pxref{Tags}). If you often need a specific search,
  4893. define a custom command for it (@pxref{Agenda dispatcher}).
  4894. @kindex C-c a M
  4895. @item C-c a M
  4896. Like @kbd{C-c a m}, but only select headlines that are also TODO items
  4897. and force checking subitems (see variable
  4898. @code{org-tags-match-list-sublevels}). Matching specific TODO keywords
  4899. together with a tags match is also possible, see @ref{Tag searches}.
  4900. @end table
  4901. The commands available in the tags list are described in @ref{Agenda
  4902. commands}.
  4903. @node Timeline, Keyword search, Matching tags and properties, Built-in agenda views
  4904. @subsection Timeline for a single file
  4905. @cindex timeline, single file
  4906. @cindex time-sorted view
  4907. The timeline summarizes all time-stamped items from a single Org mode
  4908. file in a @emph{time-sorted view}. The main purpose of this command is
  4909. to give an overview over events in a project.
  4910. @table @kbd
  4911. @kindex C-c a L
  4912. @item C-c a L
  4913. Show a time-sorted view of the org file, with all time-stamped items.
  4914. When called with a @kbd{C-u} prefix, all unfinished TODO entries
  4915. (scheduled or not) are also listed under the current date.
  4916. @end table
  4917. @noindent
  4918. The commands available in the timeline buffer are listed in
  4919. @ref{Agenda commands}.
  4920. @node Keyword search, Stuck projects, Timeline, Built-in agenda views
  4921. @subsection Keyword search
  4922. @cindex keyword search
  4923. @cindex searching, for keywords
  4924. This agenda view is a general text search facility for Org mode entries.
  4925. It is particularly useful to find notes.
  4926. @table @kbd
  4927. @kindex C-c a s
  4928. @item C-c a s
  4929. This is a special search that lets you select entries by keywords or
  4930. regular expression, using a boolean logic. For example, the search
  4931. string
  4932. @example
  4933. +computer +wifi -ethernet -@{8\.11[bg]@}
  4934. @end example
  4935. @noindent
  4936. will search for note entries that contain the keywords @code{computer}
  4937. and @code{wifi}, but not the keyword @code{ethernet}, and which are also
  4938. not matched by the regular expression @code{8\.11[bg]}, meaning to
  4939. exclude both 8.11b and 8.11g.
  4940. Note that in addition to the agenda files, this command will also search
  4941. the files listed in @code{org-agenda-text-search-extra-files}.
  4942. @end table
  4943. @node Stuck projects, , Keyword search, Built-in agenda views
  4944. @subsection Stuck projects
  4945. If you are following a system like David Allen's GTD to organize your
  4946. work, one of the ``duties'' you have is a regular review to make sure
  4947. that all projects move along. A @emph{stuck} project is a project that
  4948. has no defined next actions, so it will never show up in the TODO lists
  4949. Org mode produces. During the review, you need to identify such
  4950. projects and define next actions for them.
  4951. @table @kbd
  4952. @kindex C-c a #
  4953. @item C-c a #
  4954. List projects that are stuck.
  4955. @kindex C-c a !
  4956. @item C-c a !
  4957. Customize the variable @code{org-stuck-projects} to define what a stuck
  4958. project is and how to find it.
  4959. @end table
  4960. You almost certainly will have to configure this view before it will
  4961. work for you. The built-in default assumes that all your projects are
  4962. level-2 headlines, and that a project is not stuck if it has at least
  4963. one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
  4964. Let's assume that you, in your own way of using Org mode, identify
  4965. projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
  4966. indicate a project that should not be considered yet. Let's further
  4967. assume that the TODO keyword DONE marks finished projects, and that NEXT
  4968. and TODO indicate next actions. The tag @@SHOP indicates shopping and
  4969. is a next action even without the NEXT tag. Finally, if the project
  4970. contains the special word IGNORE anywhere, it should not be listed
  4971. either. In this case you would start by identifying eligible projects
  4972. with a tags/todo match @samp{+PROJECT/-MAYBE-DONE}, and then check for
  4973. TODO, NEXT, @@SHOP, and IGNORE in the subtree to identify projects that
  4974. are not stuck. The correct customization for this is
  4975. @lisp
  4976. (setq org-stuck-projects
  4977. '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
  4978. "\\<IGNORE\\>"))
  4979. @end lisp
  4980. @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
  4981. @section Presentation and sorting
  4982. @cindex presentation, of agenda items
  4983. Before displaying items in an agenda view, Org mode visually prepares
  4984. the items and sorts them. Each item occupies a single line. The line
  4985. starts with a @emph{prefix} that contains the @emph{category}
  4986. (@pxref{Categories}) of the item and other important information. You can
  4987. customize the prefix using the option @code{org-agenda-prefix-format}.
  4988. The prefix is followed by a cleaned-up version of the outline headline
  4989. associated with the item.
  4990. @menu
  4991. * Categories:: Not all tasks are equal
  4992. * Time-of-day specifications:: How the agenda knows the time
  4993. * Sorting of agenda items:: The order of things
  4994. @end menu
  4995. @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
  4996. @subsection Categories
  4997. @cindex category
  4998. The category is a broad label assigned to each agenda item. By default,
  4999. the category is simply derived from the file name, but you can also
  5000. specify it with a special line in the buffer, like this@footnote{For
  5001. backward compatibility, the following also works: If there are several
  5002. such lines in a file, each specifies the category for the text below it.
  5003. The first category also applies to any text before the first CATEGORY
  5004. line. However, using this method is @emph{strongly} deprecated as it is
  5005. incompatible with the outline structure of the document. The correct
  5006. method for setting multiple categories in a buffer is using a
  5007. property.}:
  5008. @example
  5009. #+CATEGORY: Thesis
  5010. @end example
  5011. @noindent
  5012. If you would like to have a special CATEGORY for a single entry or a
  5013. (sub)tree, give the entry a @code{:CATEGORY:} property with the location
  5014. as the value (@pxref{Properties and Columns}).
  5015. @noindent
  5016. The display in the agenda buffer looks best if the category is not
  5017. longer than 10 characters.
  5018. @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
  5019. @subsection Time-of-day specifications
  5020. @cindex time-of-day specification
  5021. Org mode checks each agenda item for a time-of-day specification. The
  5022. time can be part of the time stamp that triggered inclusion into the
  5023. agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
  5024. ranges can be specified with two time stamps, like
  5025. @c
  5026. @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
  5027. In the headline of the entry itself, a time(range) may also appear as
  5028. plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
  5029. integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
  5030. specifications in diary entries are recognized as well.
  5031. For agenda display, Org mode extracts the time and displays it in a
  5032. standard 24 hour format as part of the prefix. The example times in
  5033. the previous paragraphs would end up in the agenda like this:
  5034. @example
  5035. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  5036. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  5037. 19:00...... The Vogon reads his poem
  5038. 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
  5039. @end example
  5040. @cindex time grid
  5041. If the agenda is in single-day mode, or for the display of today, the
  5042. timed entries are embedded in a time grid, like
  5043. @example
  5044. 8:00...... ------------------
  5045. 8:30-13:00 Arthur Dent lies in front of the bulldozer
  5046. 10:00...... ------------------
  5047. 12:00...... ------------------
  5048. 12:45...... Ford Prefect arrives and takes Arthur to the pub
  5049. 14:00...... ------------------
  5050. 16:00...... ------------------
  5051. 18:00...... ------------------
  5052. 19:00...... The Vogon reads his poem
  5053. 20:00...... ------------------
  5054. 20:30-22:15 Marwin escorts the Hitchhikers to the bridge
  5055. @end example
  5056. The time grid can be turned on and off with the variable
  5057. @code{org-agenda-use-time-grid}, and can be configured with
  5058. @code{org-agenda-time-grid}.
  5059. @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
  5060. @subsection Sorting of agenda items
  5061. @cindex sorting, of agenda items
  5062. @cindex priorities, of agenda items
  5063. Before being inserted into a view, the items are sorted. How this is
  5064. done depends on the type of view.
  5065. @itemize @bullet
  5066. @item
  5067. For the daily/weekly agenda, the items for each day are sorted. The
  5068. default order is to first collect all items containing an explicit
  5069. time-of-day specification. These entries will be shown at the beginning
  5070. of the list, as a @emph{schedule} for the day. After that, items remain
  5071. grouped in categories, in the sequence given by @code{org-agenda-files}.
  5072. Within each category, items are sorted by priority (@pxref{Priorities}),
  5073. which is composed of the base priority (2000 for priority @samp{A}, 1000
  5074. for @samp{B}, and 0 for @samp{C}), plus additional increments for
  5075. overdue scheduled or deadline items.
  5076. @item
  5077. For the TODO list, items remain in the order of categories, but within
  5078. each category, sorting takes place according to priority
  5079. (@pxref{Priorities}).
  5080. @item
  5081. For tags matches, items are not sorted at all, but just appear in the
  5082. sequence in which they are found in the agenda files.
  5083. @end itemize
  5084. Sorting can be customized using the variable
  5085. @code{org-agenda-sorting-strategy}, and may also include criteria based on
  5086. the estimated effort of an entry (@pxref{Effort estimates}).
  5087. @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
  5088. @section Commands in the agenda buffer
  5089. @cindex commands, in agenda buffer
  5090. Entries in the agenda buffer are linked back to the org file or diary
  5091. file where they originate. You are not allowed to edit the agenda
  5092. buffer itself, but commands are provided to show and jump to the
  5093. original entry location, and to edit the org-files ``remotely'' from
  5094. the agenda buffer. In this way, all information is stored only once,
  5095. removing the risk that your agenda and note files may diverge.
  5096. Some commands can be executed with mouse clicks on agenda lines. For
  5097. the other commands, the cursor needs to be in the desired line.
  5098. @table @kbd
  5099. @tsubheading{Motion}
  5100. @cindex motion commands in agenda
  5101. @kindex n
  5102. @item n
  5103. Next line (same as @key{up} and @kbd{C-p}).
  5104. @kindex p
  5105. @item p
  5106. Previous line (same as @key{down} and @kbd{C-n}).
  5107. @tsubheading{View/Go to org file}
  5108. @kindex mouse-3
  5109. @kindex @key{SPC}
  5110. @item mouse-3
  5111. @itemx @key{SPC}
  5112. Display the original location of the item in another window.
  5113. @c
  5114. @kindex L
  5115. @item L
  5116. Display original location and recenter that window.
  5117. @c
  5118. @kindex mouse-2
  5119. @kindex mouse-1
  5120. @kindex @key{TAB}
  5121. @item mouse-2
  5122. @itemx mouse-1
  5123. @itemx @key{TAB}
  5124. Go to the original location of the item in another window. Under Emacs
  5125. 22, @kbd{mouse-1} will also works for this.
  5126. @c
  5127. @kindex @key{RET}
  5128. @itemx @key{RET}
  5129. Go to the original location of the item and delete other windows.
  5130. @c
  5131. @kindex f
  5132. @item f
  5133. Toggle Follow mode. In Follow mode, as you move the cursor through
  5134. the agenda buffer, the other window always shows the corresponding
  5135. location in the org file. The initial setting for this mode in new
  5136. agenda buffers can be set with the variable
  5137. @code{org-agenda-start-with-follow-mode}.
  5138. @c
  5139. @kindex b
  5140. @item b
  5141. Display the entire subtree of the current item in an indirect buffer. With a
  5142. numeric prefix argument N, go up to level N and then take that tree. If N is
  5143. negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
  5144. previously used indirect buffer.
  5145. @c
  5146. @kindex l
  5147. @item l
  5148. Toggle Logbook mode. In Logbook mode, entries that where marked DONE while
  5149. logging was on (variable @code{org-log-done}) are shown in the agenda,
  5150. as are entries that have been clocked on that day.
  5151. @c
  5152. @kindex v
  5153. @item v
  5154. Toggle Archives mode. In archives mode, trees that are marked are also
  5155. scanned when producing the agenda. When you call this command with a
  5156. @kbd{C-u} prefix argument, even all archive files are included. To exit
  5157. archives mode, press @kbd{v} again.
  5158. @c
  5159. @kindex R
  5160. @item R
  5161. Toggle Clockreport mode. In clockreport mode, the daily/weekly agenda will
  5162. always show a table with the clocked times for the timespan and file scope
  5163. covered by the current agenda view. The initial setting for this mode in new
  5164. agenda buffers can be set with the variable
  5165. @code{org-agenda-start-with-clockreport-mode}.
  5166. @tsubheading{Change display}
  5167. @cindex display changing, in agenda
  5168. @kindex o
  5169. @item o
  5170. Delete other windows.
  5171. @c
  5172. @kindex d
  5173. @kindex w
  5174. @kindex m
  5175. @kindex y
  5176. @item d w m y
  5177. Switch to day/week/month/year view. When switching to day or week view,
  5178. this setting becomes the default for subsequent agenda commands. Since
  5179. month and year views are slow to create, they do not become the default.
  5180. A numeric prefix argument may be used to jump directly to a specific day
  5181. of the year, ISO week, month, or year, respectively. For example,
  5182. @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
  5183. setting day, week, or month view, a year may be encoded in the prefix
  5184. argument as well. For example, @kbd{200712 w} will jump to week 12 in
  5185. 2007. If such a year specification has only one or two digits, it will
  5186. be mapped to the interval 1938-2037.
  5187. @c
  5188. @kindex D
  5189. @item D
  5190. Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
  5191. @c
  5192. @kindex G
  5193. @item G
  5194. Toggle the time grid on and off. See also the variables
  5195. @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
  5196. @c
  5197. @kindex r
  5198. @item r
  5199. Recreate the agenda buffer, for example to reflect the changes
  5200. after modification of the time stamps of items with S-@key{left} and
  5201. S-@key{right}. When the buffer is the global TODO list, a prefix
  5202. argument is interpreted to create a selective list for a specific TODO
  5203. keyword.
  5204. @kindex g
  5205. @item g
  5206. Same as @kbd{r}.
  5207. @c
  5208. @kindex s
  5209. @kindex C-x C-s
  5210. @item s
  5211. @itemx C-x C-s
  5212. Save all Org buffers in the current Emacs session.
  5213. @c
  5214. @kindex @key{right}
  5215. @item @key{right}
  5216. Display the following @code{org-agenda-ndays} days. For example, if
  5217. the display covers a week, switch to the following week. With prefix
  5218. arg, go forward that many times @code{org-agenda-ndays} days.
  5219. @c
  5220. @kindex @key{left}
  5221. @item @key{left}
  5222. Display the previous dates.
  5223. @c
  5224. @kindex .
  5225. @item .
  5226. Go to today.
  5227. @c
  5228. @kindex C-c C-x C-c
  5229. @item C-c C-x C-c
  5230. Invoke column view (@pxref{Column view}) in the agenda buffer. The column
  5231. view format is taken from the entry at point, or (if there is no entry at
  5232. point), from the first entry in the agenda view. So whatever the format for
  5233. that entry would be in the original buffer (taken from a property, from a
  5234. @code{#+COLUMNS} line, or from the default variable
  5235. @code{org-columns-default-format}), will be used in the agenda.
  5236. @tsubheading{Secondary filtering and query editing}
  5237. @cindex filtering, by tag and effort, in agenda
  5238. @cindex tag filtering, in agenda
  5239. @cindex effort filtering, in agenda
  5240. @cindex query editing, in agenda
  5241. @kindex /
  5242. @item /
  5243. Filter the current agenda view with respect to a tag and/or effort estimates.
  5244. The difference between this and a custom agenda commands is that filtering is
  5245. very fast, so that you can switch quickly between different filters without
  5246. having to recreate the agenda.
  5247. You will be prompted for a tag selection letter. Pressing @key{TAB} at that
  5248. prompt will offer use completion to select a tag (including any tags that do
  5249. not have a selection character). The command then hides all entries that do
  5250. not contain or inherit this tag. When called with prefix arg, remove the
  5251. entries that @emph{do} have the tag. A second @kbd{/} at the prompt will
  5252. turn off the filter and unhide any hidden entries. If the first key you
  5253. press is either @kbd{+} or @kbd{-}, the previous filter will be narrowed by
  5254. requiring or forbidding the selected additional tag. Instead of pressing
  5255. @kbd{+} or @kbd{-}, you can also use the @kbd{\} command.
  5256. In order to filter for effort estimates, you should set-up allowed
  5257. efforts globally, for example
  5258. @lisp
  5259. (setq org-global-properties
  5260. '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
  5261. @end lisp
  5262. You can then filter for an effort by first typing an operator, one of @kbd{<},
  5263. @kbd{>}, and @kbd{=}, and then the one-digit index of an effort estimate in
  5264. your array of allowed values, where @kbd{0} means the 10th value. The filter
  5265. will then restrict to entries with effort smaller-or-equal, equal, or
  5266. larger-or-equal than the selected value. If the digits 0-9 are not used as
  5267. fast access keys to tags, you can also simply press the index digit directly
  5268. without an operator. In this case, @kbd{<} will be assumed.
  5269. @kindex \
  5270. @item \
  5271. Narrow the current agenda filter by an additional condition. When called with
  5272. prefix arg, remove the entries that @emph{do} have the tag, or that do match
  5273. the effort criterion. You can achieve the same effect by pressing @kbd{+} or
  5274. @kbd{-} as the first key after the @kbd{/} command.
  5275. @kindex [
  5276. @kindex ]
  5277. @kindex @{
  5278. @kindex @}
  5279. @item [ ] @{ @}
  5280. In the @i{search view} (@pxref{Keyword search}), these keys add new search
  5281. words (@kbd{[} and @kbd{]}) or new regular expressions (@kbd{@{} and
  5282. @kbd{@}}) to the query string. The opening bracket/brace will add a positive
  5283. search term prefixed by @samp{+}, indicating that this search term @i{must}
  5284. occur/match in the entry. The closing bracket/brace will add a negative
  5285. search term which @i{must not} occur/match in the entry for it to be
  5286. selected.
  5287. @tsubheading{Remote editing}
  5288. @cindex remote editing, from agenda
  5289. @item 0-9
  5290. Digit argument.
  5291. @c
  5292. @cindex undoing remote-editing events
  5293. @cindex remote editing, undo
  5294. @kindex C-_
  5295. @item C-_
  5296. Undo a change due to a remote editing command. The change is undone
  5297. both in the agenda buffer and in the remote buffer.
  5298. @c
  5299. @kindex t
  5300. @item t
  5301. Change the TODO state of the item, both in the agenda and in the
  5302. original org file.
  5303. @c
  5304. @kindex C-k
  5305. @item C-k
  5306. Delete the current agenda item along with the entire subtree belonging
  5307. to it in the original Org file. If the text to be deleted remotely
  5308. is longer than one line, the kill needs to be confirmed by the user. See
  5309. variable @code{org-agenda-confirm-kill}.
  5310. @c
  5311. @kindex a
  5312. @item a
  5313. Toggle the ARCHIVE tag for the current headline.
  5314. @c
  5315. @kindex A
  5316. @item A
  5317. Move the subtree corresponding to the current entry to its @emph{Archive
  5318. Sibling}.
  5319. @c
  5320. @kindex $
  5321. @item $
  5322. Archive the subtree corresponding to the current headline. This means the
  5323. entry will be moved to the configured archive location, most likely a
  5324. different file.
  5325. @c
  5326. @kindex T
  5327. @item T
  5328. Show all tags associated with the current item. Because of
  5329. inheritance, this may be more than the tags listed in the line itself.
  5330. @c
  5331. @kindex :
  5332. @item :
  5333. Set tags for the current headline. If there is an active region in the
  5334. agenda, change a tag for all headings in the region.
  5335. @c
  5336. @kindex ,
  5337. @item ,
  5338. Set the priority for the current item. Org mode prompts for the
  5339. priority character. If you reply with @key{SPC}, the priority cookie
  5340. is removed from the entry.
  5341. @c
  5342. @kindex P
  5343. @item P
  5344. Display weighted priority of current item.
  5345. @c
  5346. @kindex +
  5347. @kindex S-@key{up}
  5348. @item +
  5349. @itemx S-@key{up}
  5350. Increase the priority of the current item. The priority is changed in
  5351. the original buffer, but the agenda is not resorted. Use the @kbd{r}
  5352. key for this.
  5353. @c
  5354. @kindex -
  5355. @kindex S-@key{down}
  5356. @item -
  5357. @itemx S-@key{down}
  5358. Decrease the priority of the current item.
  5359. @c
  5360. @kindex C-c C-a
  5361. @item C-c C-a
  5362. Dispatcher for all command related to attachments.
  5363. @c
  5364. @kindex C-c C-s
  5365. @item C-c C-s
  5366. Schedule this item
  5367. @c
  5368. @kindex C-c C-d
  5369. @item C-c C-d
  5370. Set a deadline for this item.
  5371. @c
  5372. @kindex k
  5373. @item k
  5374. Agenda actions, to set dates for selected items to the cursor date.
  5375. This command also works in the calendar! The command prompts for an
  5376. additonal key:
  5377. @example
  5378. m @r{Mark the entry at point for action. You can also make entries}
  5379. @r{in Org files with @kbd{C-c C-x C-k}.}
  5380. d @r{Set the deadline of the marked entry to the date at point.}
  5381. s @r{Schedule the marked entry at the date at point.}
  5382. r @r{Call @code{org-remember} with the cursor date as default date.}
  5383. @end example
  5384. Press @kbd{r} afterwards to refresh the agenda and see the effect of the
  5385. command.
  5386. @c
  5387. @kindex S-@key{right}
  5388. @item S-@key{right}
  5389. Change the time stamp associated with the current line by one day into the
  5390. future. With a numeric prefix argument, change it by that many days. For
  5391. example, @kbd{3 6 5 S-@key{right}} will change it by a year. The stamp is
  5392. changed in the original org file, but the change is not directly reflected in
  5393. the agenda buffer. Use the @kbd{r} key to update the buffer.
  5394. @c
  5395. @kindex S-@key{left}
  5396. @item S-@key{left}
  5397. Change the time stamp associated with the current line by one day
  5398. into the past.
  5399. @c
  5400. @kindex >
  5401. @item >
  5402. Change the time stamp associated with the current line to today.
  5403. The key @kbd{>} has been chosen, because it is the same as @kbd{S-.}
  5404. on my keyboard.
  5405. @c
  5406. @kindex I
  5407. @item I
  5408. Start the clock on the current item. If a clock is running already, it
  5409. is stopped first.
  5410. @c
  5411. @kindex O
  5412. @item O
  5413. Stop the previously started clock.
  5414. @c
  5415. @kindex X
  5416. @item X
  5417. Cancel the currently running clock.
  5418. @kindex J
  5419. @item J
  5420. Jump to the running clock in another window.
  5421. @tsubheading{Calendar commands}
  5422. @cindex calendar commands, from agenda
  5423. @kindex c
  5424. @item c
  5425. Open the Emacs calendar and move to the date at the agenda cursor.
  5426. @c
  5427. @item c
  5428. When in the calendar, compute and show the Org mode agenda for the
  5429. date at the cursor.
  5430. @c
  5431. @cindex diary entries, creating from agenda
  5432. @kindex i
  5433. @item i
  5434. Insert a new entry into the diary. Prompts for the type of entry
  5435. (day, weekly, monthly, yearly, anniversary, cyclic) and creates a new
  5436. entry in the diary, just as @kbd{i d} etc. would do in the calendar.
  5437. The date is taken from the cursor position.
  5438. @c
  5439. @kindex M
  5440. @item M
  5441. Show the phases of the moon for the three months around current date.
  5442. @c
  5443. @kindex S
  5444. @item S
  5445. Show sunrise and sunset times. The geographical location must be set
  5446. with calendar variables, see documentation of the Emacs calendar.
  5447. @c
  5448. @kindex C
  5449. @item C
  5450. Convert the date at cursor into many other cultural and historic
  5451. calendars.
  5452. @c
  5453. @kindex H
  5454. @item H
  5455. Show holidays for three month around the cursor date.
  5456. @item M-x org-export-icalendar-combine-agenda-files
  5457. Export a single iCalendar file containing entries from all agenda files.
  5458. This is a globally available command, and also available in the agenda menu.
  5459. @tsubheading{Exporting to a file}
  5460. @kindex C-x C-w
  5461. @item C-x C-w
  5462. @cindex exporting agenda views
  5463. @cindex agenda views, exporting
  5464. Write the agenda view to a file. Depending on the extension of the
  5465. selected file name, the view will be exported as HTML (extension
  5466. @file{.html} or @file{.htm}), Postscript (extension @file{.ps}), or
  5467. plain text (any other extension). Use the variable
  5468. @code{org-agenda-exporter-settings} to set options for @file{ps-print}
  5469. and for @file{htmlize} to be used during export.
  5470. @tsubheading{Quit and Exit}
  5471. @kindex q
  5472. @item q
  5473. Quit agenda, remove the agenda buffer.
  5474. @c
  5475. @kindex x
  5476. @cindex agenda files, removing buffers
  5477. @item x
  5478. Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
  5479. for the compilation of the agenda. Buffers created by the user to
  5480. visit org files will not be removed.
  5481. @end table
  5482. @node Custom agenda views, Agenda column view, Agenda commands, Agenda Views
  5483. @section Custom agenda views
  5484. @cindex custom agenda views
  5485. @cindex agenda views, custom
  5486. Custom agenda commands serve two purposes: to store and quickly access
  5487. frequently used TODO and tags searches, and to create special composite
  5488. agenda buffers. Custom agenda commands will be accessible through the
  5489. dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
  5490. @menu
  5491. * Storing searches:: Type once, use often
  5492. * Block agenda:: All the stuff you need in a single buffer
  5493. * Setting Options:: Changing the rules
  5494. * Exporting Agenda Views:: Writing agendas to files
  5495. * Using the agenda elsewhere:: Using agenda information in other programs
  5496. @end menu
  5497. @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
  5498. @subsection Storing searches
  5499. The first application of custom searches is the definition of keyboard
  5500. shortcuts for frequently used searches, either creating an agenda
  5501. buffer, or a sparse tree (the latter covering of course only the current
  5502. buffer).
  5503. @kindex C-c a C
  5504. Custom commands are configured in the variable
  5505. @code{org-agenda-custom-commands}. You can customize this variable, for
  5506. example by pressing @kbd{C-c a C}. You can also directly set it with
  5507. Emacs Lisp in @file{.emacs}. The following example contains all valid
  5508. search types:
  5509. @lisp
  5510. @group
  5511. (setq org-agenda-custom-commands
  5512. '(("w" todo "WAITING")
  5513. ("W" todo-tree "WAITING")
  5514. ("u" tags "+boss-urgent")
  5515. ("v" tags-todo "+boss-urgent")
  5516. ("U" tags-tree "+boss-urgent")
  5517. ("f" occur-tree "\\<FIXME\\>")
  5518. ("h" . "HOME+Name tags searches") ; description for "h" prefix
  5519. ("hl" tags "+home+Lisa")
  5520. ("hp" tags "+home+Peter")
  5521. ("hk" tags "+home+Kim")))
  5522. @end group
  5523. @end lisp
  5524. @noindent
  5525. The initial string in each entry defines the keys you have to press
  5526. after the dispatcher command @kbd{C-c a} in order to access the command.
  5527. Usually this will be just a single character, but if you have many
  5528. similar commands, you can also define two-letter combinations where the
  5529. first character is the same in several combinations and serves as a
  5530. prefix key@footnote{You can provide a description for a prefix key by
  5531. inserting a cons cell with the prefix and the description.}. The second
  5532. parameter is the search type, followed by the string or regular
  5533. expression to be used for the matching. The example above will
  5534. therefore define:
  5535. @table @kbd
  5536. @item C-c a w
  5537. as a global search for TODO entries with @samp{WAITING} as the TODO
  5538. keyword
  5539. @item C-c a W
  5540. as the same search, but only in the current buffer and displaying the
  5541. results as a sparse tree
  5542. @item C-c a u
  5543. as a global tags search for headlines marked @samp{:boss:} but not
  5544. @samp{:urgent:}
  5545. @item C-c a v
  5546. as the same search as @kbd{C-c a u}, but limiting the search to
  5547. headlines that are also TODO items
  5548. @item C-c a U
  5549. as the same search as @kbd{C-c a u}, but only in the current buffer and
  5550. displaying the result as a sparse tree
  5551. @item C-c a f
  5552. to create a sparse tree (again: current buffer only) with all entries
  5553. containing the word @samp{FIXME}
  5554. @item C-c a h
  5555. as a prefix command for a HOME tags search where you have to press an
  5556. additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
  5557. Peter, or Kim) as additional tag to match.
  5558. @end table
  5559. @node Block agenda, Setting Options, Storing searches, Custom agenda views
  5560. @subsection Block agenda
  5561. @cindex block agenda
  5562. @cindex agenda, with block views
  5563. Another possibility is the construction of agenda views that comprise
  5564. the results of @emph{several} commands, each of which creates a block in
  5565. the agenda buffer. The available commands include @code{agenda} for the
  5566. daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
  5567. for the global TODO list (as constructed with @kbd{C-c a t}), and the
  5568. matching commands discussed above: @code{todo}, @code{tags}, and
  5569. @code{tags-todo}. Here are two examples:
  5570. @lisp
  5571. @group
  5572. (setq org-agenda-custom-commands
  5573. '(("h" "Agenda and Home-related tasks"
  5574. ((agenda "")
  5575. (tags-todo "home")
  5576. (tags "garden")))
  5577. ("o" "Agenda and Office-related tasks"
  5578. ((agenda "")
  5579. (tags-todo "work")
  5580. (tags "office")))))
  5581. @end group
  5582. @end lisp
  5583. @noindent
  5584. This will define @kbd{C-c a h} to create a multi-block view for stuff
  5585. you need to attend to at home. The resulting agenda buffer will contain
  5586. your agenda for the current week, all TODO items that carry the tag
  5587. @samp{home}, and also all lines tagged with @samp{garden}. Finally the
  5588. command @kbd{C-c a o} provides a similar view for office tasks.
  5589. @node Setting Options, Exporting Agenda Views, Block agenda, Custom agenda views
  5590. @subsection Setting options for custom commands
  5591. @cindex options, for custom agenda views
  5592. Org mode contains a number of variables regulating agenda construction
  5593. and display. The global variables define the behavior for all agenda
  5594. commands, including the custom commands. However, if you want to change
  5595. some settings just for a single custom view, you can do so. Setting
  5596. options requires inserting a list of variable names and values at the
  5597. right spot in @code{org-agenda-custom-commands}. For example:
  5598. @lisp
  5599. @group
  5600. (setq org-agenda-custom-commands
  5601. '(("w" todo "WAITING"
  5602. ((org-agenda-sorting-strategy '(priority-down))
  5603. (org-agenda-prefix-format " Mixed: ")))
  5604. ("U" tags-tree "+boss-urgent"
  5605. ((org-show-following-heading nil)
  5606. (org-show-hierarchy-above nil)))
  5607. ("N" search ""
  5608. ((org-agenda-files '("~org/notes.org"))
  5609. (org-agenda-text-search-extra-files nil)))))
  5610. @end group
  5611. @end lisp
  5612. @noindent
  5613. Now the @kbd{C-c a w} command will sort the collected entries only by
  5614. priority, and the prefix format is modified to just say @samp{ Mixed: }
  5615. instead of giving the category of the entry. The sparse tags tree of
  5616. @kbd{C-c a U} will now turn out ultra-compact, because neither the
  5617. headline hierarchy above the match, nor the headline following the match
  5618. will be shown. The command @kbd{C-c a N} will do a text search limited
  5619. to only a single file.
  5620. For command sets creating a block agenda,
  5621. @code{org-agenda-custom-commands} has two separate spots for setting
  5622. options. You can add options that should be valid for just a single
  5623. command in the set, and options that should be valid for all commands in
  5624. the set. The former are just added to the command entry, the latter
  5625. must come after the list of command entries. Going back to the block
  5626. agenda example (@pxref{Block agenda}), let's change the sorting strategy
  5627. for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
  5628. the results for GARDEN tags query in the opposite order,
  5629. @code{priority-up}. This would look like this:
  5630. @lisp
  5631. @group
  5632. (setq org-agenda-custom-commands
  5633. '(("h" "Agenda and Home-related tasks"
  5634. ((agenda)
  5635. (tags-todo "home")
  5636. (tags "garden"
  5637. ((org-agenda-sorting-strategy '(priority-up)))))
  5638. ((org-agenda-sorting-strategy '(priority-down))))
  5639. ("o" "Agenda and Office-related tasks"
  5640. ((agenda)
  5641. (tags-todo "work")
  5642. (tags "office")))))
  5643. @end group
  5644. @end lisp
  5645. As you see, the values and parenthesis setting is a little complex.
  5646. When in doubt, use the customize interface to set this variable - it
  5647. fully supports its structure. Just one caveat: When setting options in
  5648. this interface, the @emph{values} are just lisp expressions. So if the
  5649. value is a string, you need to add the double quotes around the value
  5650. yourself.
  5651. @node Exporting Agenda Views, Using the agenda elsewhere, Setting Options, Custom agenda views
  5652. @subsection Exporting Agenda Views
  5653. @cindex agenda views, exporting
  5654. If you are away from your computer, it can be very useful to have a
  5655. printed version of some agenda views to carry around. Org mode can
  5656. export custom agenda views as plain text, HTML@footnote{You need to
  5657. install Hrvoje Niksic' @file{htmlize.el}.} postscript, and iCalendar
  5658. files. If you want to do this only occasionally, use the command
  5659. @table @kbd
  5660. @kindex C-x C-w
  5661. @item C-x C-w
  5662. @cindex exporting agenda views
  5663. @cindex agenda views, exporting
  5664. Write the agenda view to a file. Depending on the extension of the
  5665. selected file name, the view will be exported as HTML (extension
  5666. @file{.html} or @file{.htm}), Postscript (extension @file{.ps}),
  5667. iCalendar (extension @file{.ics}), or plain text (any other extension).
  5668. Use the variable @code{org-agenda-exporter-settings} to
  5669. set options for @file{ps-print} and for @file{htmlize} to be used during
  5670. export, for example
  5671. @lisp
  5672. (setq org-agenda-exporter-settings
  5673. '((ps-number-of-columns 2)
  5674. (ps-landscape-mode t)
  5675. (htmlize-output-type 'css)))
  5676. @end lisp
  5677. @end table
  5678. If you need to export certain agenda views frequently, you can associate
  5679. any custom agenda command with a list of output file names
  5680. @footnote{If you want to store standard views like the weekly agenda
  5681. or the global TODO list as well, you need to define custom commands for
  5682. them in order to be able to specify file names.}. Here is an example
  5683. that first does define custom commands for the agenda and the global
  5684. todo list, together with a number of files to which to export them.
  5685. Then we define two block agenda commands and specify file names for them
  5686. as well. File names can be relative to the current working directory,
  5687. or absolute.
  5688. @lisp
  5689. @group
  5690. (setq org-agenda-custom-commands
  5691. '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
  5692. ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
  5693. ("h" "Agenda and Home-related tasks"
  5694. ((agenda "")
  5695. (tags-todo "home")
  5696. (tags "garden"))
  5697. nil
  5698. ("~/views/home.html"))
  5699. ("o" "Agenda and Office-related tasks"
  5700. ((agenda)
  5701. (tags-todo "work")
  5702. (tags "office"))
  5703. nil
  5704. ("~/views/office.ps" "~/calendars/office.ics"))))
  5705. @end group
  5706. @end lisp
  5707. The extension of the file name determines the type of export. If it is
  5708. @file{.html}, Org mode will use the @file{htmlize.el} package to convert
  5709. the buffer to HTML and save it to this file name. If the extension is
  5710. @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
  5711. postscript output. If the extension is @file{.ics}, iCalendar export is
  5712. run export over all files that were used to construct the agenda, and
  5713. limit the export to entries listed in the agenda now. Any other
  5714. extension produces a plain ASCII file.
  5715. The export files are @emph{not} created when you use one of those
  5716. commands interactively because this might use too much overhead.
  5717. Instead, there is a special command to produce @emph{all} specified
  5718. files in one step:
  5719. @table @kbd
  5720. @kindex C-c a e
  5721. @item C-c a e
  5722. Export all agenda views that have export file names associated with
  5723. them.
  5724. @end table
  5725. You can use the options section of the custom agenda commands to also
  5726. set options for the export commands. For example:
  5727. @lisp
  5728. (setq org-agenda-custom-commands
  5729. '(("X" agenda ""
  5730. ((ps-number-of-columns 2)
  5731. (ps-landscape-mode t)
  5732. (org-agenda-prefix-format " [ ] ")
  5733. (org-agenda-with-colors nil)
  5734. (org-agenda-remove-tags t))
  5735. ("theagenda.ps"))))
  5736. @end lisp
  5737. @noindent
  5738. This command sets two options for the postscript exporter, to make it
  5739. print in two columns in landscape format - the resulting page can be cut
  5740. in two and then used in a paper agenda. The remaining settings modify
  5741. the agenda prefix to omit category and scheduling information, and
  5742. instead include a checkbox to check off items. We also remove the tags
  5743. to make the lines compact, and we don't want to use colors for the
  5744. black-and-white printer. Settings specified in
  5745. @code{org-agenda-exporter-settings} will also apply, but the settings
  5746. in @code{org-agenda-custom-commands} take precedence.
  5747. @noindent
  5748. From the command line you may also use
  5749. @example
  5750. emacs -f org-batch-store-agenda-views -kill
  5751. @end example
  5752. @noindent
  5753. or, if you need to modify some parameters@footnote{Quoting may depend on the
  5754. system you use, please check th FAQ for examples.}
  5755. @example
  5756. emacs -eval '(org-batch-store-agenda-views \
  5757. org-agenda-ndays 30 \
  5758. org-agenda-start-day "2007-11-01" \
  5759. org-agenda-include-diary nil \
  5760. org-agenda-files (quote ("~/org/project.org")))' \
  5761. -kill
  5762. @end example
  5763. @noindent
  5764. which will create the agenda views restricted to the file
  5765. @file{~/org/project.org}, without diary entries and with 30 days
  5766. extent.
  5767. @node Using the agenda elsewhere, , Exporting Agenda Views, Custom agenda views
  5768. @subsection Using agenda information outside of Org
  5769. @cindex agenda, pipe
  5770. @cindex Scripts, for agenda processing
  5771. Org provides commands to access agenda information for the command
  5772. line in emacs batch mode. This extracted information can be sent
  5773. directly to a printer, or it can be read by a program that does further
  5774. processing of the data. The first of these commands is the function
  5775. @code{org-batch-agenda}, that produces an agenda view and sends it as
  5776. ASCII text to STDOUT. The command takes a single string as parameter.
  5777. If the string has length 1, it is used as a key to one of the commands
  5778. you have configured in @code{org-agenda-custom-commands}, basically any
  5779. key you can use after @kbd{C-c a}. For example, to directly print the
  5780. current TODO list, you could use
  5781. @example
  5782. emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
  5783. @end example
  5784. If the parameter is a string with 2 or more characters, it is used as a
  5785. tags/todo match string. For example, to print your local shopping list
  5786. (all items with the tag @samp{shop}, but excluding the tag
  5787. @samp{NewYork}), you could use
  5788. @example
  5789. emacs -batch -l ~/.emacs \
  5790. -eval '(org-batch-agenda "+shop-NewYork")' | lpr
  5791. @end example
  5792. @noindent
  5793. You may also modify parameters on the fly like this:
  5794. @example
  5795. emacs -batch -l ~/.emacs \
  5796. -eval '(org-batch-agenda "a" \
  5797. org-agenda-ndays 30 \
  5798. org-agenda-include-diary nil \
  5799. org-agenda-files (quote ("~/org/project.org")))' \
  5800. | lpr
  5801. @end example
  5802. @noindent
  5803. which will produce a 30 day agenda, fully restricted to the Org file
  5804. @file{~/org/projects.org}, not even including the diary.
  5805. If you want to process the agenda data in more sophisticated ways, you
  5806. can use the command @code{org-batch-agenda-csv} to get a comma-separated
  5807. list of values for each agenda item. Each line in the output will
  5808. contain a number of fields separated by commas. The fields in a line
  5809. are:
  5810. @example
  5811. category @r{The category of the item}
  5812. head @r{The headline, without TODO kwd, TAGS and PRIORITY}
  5813. type @r{The type of the agenda entry, can be}
  5814. todo @r{selected in TODO match}
  5815. tagsmatch @r{selected in tags match}
  5816. diary @r{imported from diary}
  5817. deadline @r{a deadline}
  5818. scheduled @r{scheduled}
  5819. timestamp @r{appointment, selected by timestamp}
  5820. closed @r{entry was closed on date}
  5821. upcoming-deadline @r{warning about nearing deadline}
  5822. past-scheduled @r{forwarded scheduled item}
  5823. block @r{entry has date block including date}
  5824. todo @r{The TODO keyword, if any}
  5825. tags @r{All tags including inherited ones, separated by colons}
  5826. date @r{The relevant date, like 2007-2-14}
  5827. time @r{The time, like 15:00-16:50}
  5828. extra @r{String with extra planning info}
  5829. priority-l @r{The priority letter if any was given}
  5830. priority-n @r{The computed numerical priority}
  5831. @end example
  5832. @noindent
  5833. Time and date will only be given if a timestamp (or deadline/scheduled)
  5834. lead to the selection of the item.
  5835. A CSV list like this is very easy to use in a post processing script.
  5836. For example, here is a Perl program that gets the TODO list from
  5837. Emacs/Org and prints all the items, preceded by a checkbox:
  5838. @example
  5839. @group
  5840. #!/usr/bin/perl
  5841. # define the Emacs command to run
  5842. $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
  5843. # run it and capture the output
  5844. $agenda = qx@{$cmd 2>/dev/null@};
  5845. # loop over all lines
  5846. foreach $line (split(/\n/,$agenda)) @{
  5847. # get the individual values
  5848. ($category,$head,$type,$todo,$tags,$date,$time,$extra,
  5849. $priority_l,$priority_n) = split(/,/,$line);
  5850. # proccess and print
  5851. print "[ ] $head\n";
  5852. @}
  5853. @end group
  5854. @end example
  5855. @node Agenda column view, , Custom agenda views, Agenda Views
  5856. @section Using column view in the agenda
  5857. @cindex column view, in agenda
  5858. @cindex agenda, column view
  5859. Column view (@pxref{Column view}) is normally used to view and edit
  5860. properties embedded in the hierarchical structure of an Org file. It can be
  5861. quite useful to use column view also from the agenda, where entries are
  5862. collected by certain criteria.
  5863. @table @kbd
  5864. @kindex C-c C-x C-c
  5865. @item C-c C-x C-c
  5866. Turn on column view in the agenda.
  5867. @end table
  5868. To understand how to use this properly, it is important to realize that the
  5869. entries in the agenda are no longer in their proper outline environment.
  5870. This causes the following issues:
  5871. @enumerate
  5872. @item
  5873. Org needs to make a decision which @code{COLUMNS} format to use. Since the
  5874. entries in the agenda are collected from different files, and different files
  5875. may have different @code{COLUMNS} formats, this is a non-trivial problem.
  5876. Org first checks if the variable @code{org-overriding-columns-format} is
  5877. currently set, and if yes takes the format from there. Otherwise it takes
  5878. the format associated with the first item in the agenda, or, if that item
  5879. does not have a specific format (defined in a property, or in it's file), it
  5880. uses @code{org-columns-default-format}.
  5881. @item
  5882. If any of the columns has a summary type defined (@pxref{Column attributes}),
  5883. turning on column view in the agenda will visit all relevant agenda files and
  5884. make sure that the computations of this property are up to date. This is
  5885. also true for the special @code{CLOCKSUM} property. Org will then sum the
  5886. values displayed in the agenda. In the daily/weekly agenda, the sums will
  5887. cover a single day, in all other views they cover the entire block. It is
  5888. vital to realize that the agenda may show the same entry @emph{twice} (for
  5889. example as scheduled and as a deadline), and it may show two entries from the
  5890. same hierarchy (for example a @emph{parent} and it's @emph{child}). In these
  5891. cases, the summation in the agenda will lead to incorrect results because
  5892. some values will count double.
  5893. @item
  5894. When the column view in the agenda shows the @code{CLOCKSUM}, that is always
  5895. the entire clocked time for this item. So even in the daily/weekly agenda,
  5896. the clocksum listed in column view may originate from times outside the
  5897. current view. This has the advantage that you can compare these values with
  5898. a column listing the planned total effort for a task - one of the major
  5899. applications for column view in the agenda. If you want information about
  5900. clocked time in the displayed period use clock table mode (press @kbd{R} in
  5901. the agenda).
  5902. @end enumerate
  5903. @node Embedded LaTeX, Exporting, Agenda Views, Top
  5904. @chapter Embedded LaTeX
  5905. @cindex @TeX{} interpretation
  5906. @cindex La@TeX{} interpretation
  5907. Plain ASCII is normally sufficient for almost all note taking. One
  5908. exception, however, are scientific notes which need to be able to contain
  5909. mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{}
  5910. is a macro system based on Donald E. Knuth's @TeX{} system. Many of the
  5911. features described here as ``La@TeX{}'' are really from @TeX{}, but for
  5912. simplicity I am blurring this distinction.} is widely used to typeset
  5913. scientific documents. Org mode supports embedding La@TeX{} code into its
  5914. files, because many academics are used to reading La@TeX{} source code, and
  5915. because it can be readily processed into images for HTML production.
  5916. It is not necessary to mark La@TeX{} macros and code in any special way.
  5917. If you observe a few conventions, Org mode knows how to find it and what
  5918. to do with it.
  5919. @menu
  5920. * Math symbols:: TeX macros for symbols and Greek letters
  5921. * Subscripts and superscripts:: Simple syntax for raising/lowering text
  5922. * LaTeX fragments:: Complex formulas made easy
  5923. * Processing LaTeX fragments:: Previewing LaTeX processing
  5924. * CDLaTeX mode:: Speed up entering of formulas
  5925. @end menu
  5926. @node Math symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
  5927. @section Math symbols
  5928. @cindex math symbols
  5929. @cindex TeX macros
  5930. You can use La@TeX{} macros to insert special symbols like @samp{\alpha}
  5931. to indicate the Greek letter, or @samp{\to} to indicate an arrow.
  5932. Completion for these macros is available, just type @samp{\} and maybe a
  5933. few letters, and press @kbd{M-@key{TAB}} to see possible completions.
  5934. Unlike La@TeX{} code, Org mode allows these macros to be present
  5935. without surrounding math delimiters, for example:
  5936. @example
  5937. Angles are written as Greek letters \alpha, \beta and \gamma.
  5938. @end example
  5939. During HTML export (@pxref{HTML export}), these symbols are translated
  5940. into the proper syntax for HTML, for the above examples this is
  5941. @samp{&alpha;} and @samp{&rarr;}, respectively. If you need such a symbol
  5942. inside a word, terminate it like this: @samp{\Aacute@{@}stor}.
  5943. @node Subscripts and superscripts, LaTeX fragments, Math symbols, Embedded LaTeX
  5944. @section Subscripts and superscripts
  5945. @cindex subscript
  5946. @cindex superscript
  5947. Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super-
  5948. and subscripts. Again, these can be used without embedding them in
  5949. math-mode delimiters. To increase the readability of ASCII text, it is
  5950. not necessary (but OK) to surround multi-character sub- and superscripts
  5951. with curly braces. For example
  5952. @example
  5953. The mass if the sun is M_sun = 1.989 x 10^30 kg. The radius of
  5954. the sun is R_@{sun@} = 6.96 x 10^8 m.
  5955. @end example
  5956. To avoid interpretation as raised or lowered text, you can quote
  5957. @samp{^} and @samp{_} with a backslash: @samp{\_} and @samp{\^}.
  5958. During HTML export (@pxref{HTML export}), subscript and superscripts
  5959. are surrounded with @code{<sub>} and @code{<sup>} tags, respectively.
  5960. @node LaTeX fragments, Processing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
  5961. @section LaTeX fragments
  5962. @cindex LaTeX fragments
  5963. With symbols, sub- and superscripts, HTML is pretty much at its end when
  5964. it comes to representing mathematical formulas@footnote{Yes, there is
  5965. MathML, but that is not yet fully supported by many browsers, and there
  5966. is no decent converter for turning La@TeX{} or ASCII representations of
  5967. formulas into MathML. So for the time being, converting formulas into
  5968. images seems the way to go.}. More complex expressions need a dedicated
  5969. formula processor. To this end, Org mode can contain arbitrary La@TeX{}
  5970. fragments. It provides commands to preview the typeset result of these
  5971. fragments, and upon export to HTML, all fragments will be converted to
  5972. images and inlined into the HTML document@footnote{The La@TeX{} export
  5973. will not use images for displaying La@TeX{} fragments but include these
  5974. fragments directly into the La@TeX{} code.}. For this to work you
  5975. need to be on a system with a working La@TeX{} installation. You also
  5976. need the @file{dvipng} program, available at
  5977. @url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that
  5978. will be used when processing a fragment can be configured with the
  5979. variable @code{org-format-latex-header}.
  5980. La@TeX{} fragments don't need any special marking at all. The following
  5981. snippets will be identified as La@TeX{} source code:
  5982. @itemize @bullet
  5983. @item
  5984. Environments of any kind. The only requirement is that the
  5985. @code{\begin} statement appears on a new line, preceded by only
  5986. whitespace.
  5987. @item
  5988. Text within the usual La@TeX{} math delimiters. To avoid conflicts with
  5989. currency specifications, single @samp{$} characters are only recognized
  5990. as math delimiters if the enclosed text contains at most two line breaks,
  5991. is directly attached to the @samp{$} characters with no whitespace in
  5992. between, and if the closing @samp{$} is followed by whitespace or
  5993. punctuation. For the other delimiters, there is no such restriction, so
  5994. when in doubt, use @samp{\(...\)} as inline math delimiters.
  5995. @end itemize
  5996. @noindent For example:
  5997. @example
  5998. \begin@{equation@} % arbitrary environments,
  5999. x=\sqrt@{b@} % even tables, figures
  6000. \end@{equation@} % etc
  6001. If $a^2=b$ and \( b=2 \), then the solution must be
  6002. either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
  6003. @end example
  6004. @noindent
  6005. If you need any of the delimiter ASCII sequences for other purposes, you
  6006. can configure the option @code{org-format-latex-options} to deselect the
  6007. ones you do not wish to have interpreted by the La@TeX{} converter.
  6008. @node Processing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
  6009. @section Processing LaTeX fragments
  6010. @cindex LaTeX fragments, preview
  6011. La@TeX{} fragments can be processed to produce a preview images of the
  6012. typeset expressions:
  6013. @table @kbd
  6014. @kindex C-c C-x C-l
  6015. @item C-c C-x C-l
  6016. Produce a preview image of the La@TeX{} fragment at point and overlay it
  6017. over the source code. If there is no fragment at point, process all
  6018. fragments in the current entry (between two headlines). When called
  6019. with a prefix argument, process the entire subtree. When called with
  6020. two prefix arguments, or when the cursor is before the first headline,
  6021. process the entire buffer.
  6022. @kindex C-c C-c
  6023. @item C-c C-c
  6024. Remove the overlay preview images.
  6025. @end table
  6026. During HTML export (@pxref{HTML export}), all La@TeX{} fragments are
  6027. converted into images and inlined into the document if the following
  6028. setting is active:
  6029. @lisp
  6030. (setq org-export-with-LaTeX-fragments t)
  6031. @end lisp
  6032. @node CDLaTeX mode, , Processing LaTeX fragments, Embedded LaTeX
  6033. @section Using CDLaTeX to enter math
  6034. @cindex CDLaTeX
  6035. CDLaTeX mode is a minor mode that is normally used in combination with a
  6036. major La@TeX{} mode like AUCTeX in order to speed-up insertion of
  6037. environments and math templates. Inside Org mode, you can make use of
  6038. some of the features of CDLaTeX mode. You need to install
  6039. @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
  6040. AUCTeX) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
  6041. Don't use CDLaTeX mode itself under Org mode, but use the light
  6042. version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
  6043. on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
  6044. Org files with
  6045. @lisp
  6046. (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
  6047. @end lisp
  6048. When this mode is enabled, the following features are present (for more
  6049. details see the documentation of CDLaTeX mode):
  6050. @itemize @bullet
  6051. @kindex C-c @{
  6052. @item
  6053. Environment templates can be inserted with @kbd{C-c @{}.
  6054. @item
  6055. @kindex @key{TAB}
  6056. The @key{TAB} key will do template expansion if the cursor is inside a
  6057. La@TeX{} fragment@footnote{Org mode has a method to test if the cursor is
  6058. inside such a fragment, see the documentation of the function
  6059. @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
  6060. expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
  6061. correctly inside the first brace. Another @key{TAB} will get you into
  6062. the second brace. Even outside fragments, @key{TAB} will expand
  6063. environment abbreviations at the beginning of a line. For example, if
  6064. you write @samp{equ} at the beginning of a line and press @key{TAB},
  6065. this abbreviation will be expanded to an @code{equation} environment.
  6066. To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
  6067. @item
  6068. @kindex _
  6069. @kindex ^
  6070. Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these
  6071. characters together with a pair of braces. If you use @key{TAB} to move
  6072. out of the braces, and if the braces surround only a single character or
  6073. macro, they are removed again (depending on the variable
  6074. @code{cdlatex-simplify-sub-super-scripts}).
  6075. @item
  6076. @kindex `
  6077. Pressing the backquote @kbd{`} followed by a character inserts math
  6078. macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds
  6079. after the backquote, a help window will pop up.
  6080. @item
  6081. @kindex '
  6082. Pressing the normal quote @kbd{'} followed by another character modifies
  6083. the symbol before point with an accent or a font. If you wait more than
  6084. 1.5 seconds after the backquote, a help window will pop up. Character
  6085. modification will work only inside La@TeX{} fragments, outside the quote
  6086. is normal.
  6087. @end itemize
  6088. @node Exporting, Publishing, Embedded LaTeX, Top
  6089. @chapter Exporting
  6090. @cindex exporting
  6091. Org mode documents can be exported into a variety of other formats. For
  6092. printing and sharing of notes, ASCII export produces a readable and
  6093. simple version of an Org file. HTML export allows you to publish a
  6094. notes file on the web, while the XOXO format provides a solid base for
  6095. exchange with a broad range of other applications. La@TeX{} export lets
  6096. you use Org mode and its structured editing functions to easily create
  6097. La@TeX{} files. To incorporate entries with associated times like
  6098. deadlines or appointments into a desktop calendar program like iCal,
  6099. Org mode can also produce extracts in the iCalendar format. Currently
  6100. Org mode only supports export, not import of these different formats.
  6101. @menu
  6102. * Markup rules:: Which structures are recognized?
  6103. * Selective export:: Using tags to select and exclude trees
  6104. * Export options:: Per-file export settings
  6105. * The export dispatcher:: How to access exporter commands
  6106. * ASCII export:: Exporting to plain ASCII
  6107. * HTML export:: Exporting to HTML
  6108. * LaTeX and PDF export:: Exporting to LaTeX, and processing to PDF
  6109. * XOXO export:: Exporting to XOXO
  6110. * iCalendar export:: Exporting in iCalendar format
  6111. @end menu
  6112. @node Markup rules, Selective export, Exporting, Exporting
  6113. @section Markup rules
  6114. When exporting Org mode documents, the exporter tries to reflect the
  6115. structure of the document as accurately as possible in the back-end. Since
  6116. export targets like HTML or La@TeX{} allow much richer formatting, Org mode
  6117. has rules how to prepare text for rich export. This section summarizes the
  6118. markup rule used in an Org mode buffer.
  6119. @menu
  6120. * Document title:: How the document title is determined
  6121. * Headings and sections:: The main structure of the exported document
  6122. * Table of contents:: If, where, how to create a table of contents
  6123. * Initial text:: Text before the first headline
  6124. * Lists:: Plain lists are exported
  6125. * Paragraphs:: What determines beginning and ending
  6126. * Literal examples:: Source code and other examples
  6127. * Include files:: Include the contents of a file during export
  6128. * Tables exported:: Tables are exported richly
  6129. * Footnotes:: Numbers like [1]
  6130. * Emphasis and monospace:: To bold or not to bold
  6131. * TeX macros and LaTeX fragments:: Create special, rich export.
  6132. * Horizontal rules:: A line across the page
  6133. * Comment lines:: Some lines will not be exported
  6134. @end menu
  6135. @node Document title, Headings and sections, Markup rules, Markup rules
  6136. @subheading Document title
  6137. @cindex document title, markup rules
  6138. @noindent
  6139. The title of the exported document is taken from the special line
  6140. @example
  6141. #+TITLE: This is the title of the document
  6142. @end example
  6143. @noindent
  6144. If this line does not exist, the title is derived from the first non-empty,
  6145. non-comment line in the buffer. If no such line exists, or if you have
  6146. turned off exporting of the text before the first headline (see below), the
  6147. title will be the file name without extension.
  6148. If you are exporting only a subtree by marking is as the region, the heading
  6149. of the subtree will become the title of the document. If the subtree has a
  6150. property @code{EXPORT_TITLE}, that will take precedence.
  6151. @node Headings and sections, Table of contents, Document title, Markup rules
  6152. @subheading Headings and sections
  6153. @cindex headings and sections, markup rules
  6154. The outline structure of the document as described in @ref{Document
  6155. Structure} forms the basis for defining sections of the exported document.
  6156. However, since the outline structure is also used for (for example) lists of
  6157. tasks, only the first three outline levels will be used as headings. Deeper
  6158. levels will become itemized lists. You can change the location of this
  6159. switch, globally by setting the variable @code{org-headline-levels}, or on a
  6160. per file basis with a line
  6161. @example
  6162. #+OPTIONS: H:4
  6163. @end example
  6164. @node Table of contents, Initial text, Headings and sections, Markup rules
  6165. @subheading Table of contents
  6166. @cindex table of contents, markup rules
  6167. The table of contents is normally inserted directly before the first headline
  6168. of the file. If you would like to get it to a different location, insert the
  6169. string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
  6170. location. The depth of the table of contents is by default the same as the
  6171. number of headline levels, but you can choose a smaller number or turn off
  6172. the table of contents entirely by configuring the variable
  6173. @code{org-export-with-toc}, or on a per-file basis with a line like
  6174. @example
  6175. #+OPTIONS: toc:2 (only to two levels in TOC)
  6176. #+OPTIONS: toc:nil (no TOC at all)
  6177. @end example
  6178. @node Initial text, Lists, Table of contents, Markup rules
  6179. @subheading Text before the first headline
  6180. @cindex text before first headline, markup rules
  6181. @cindex #+TEXT
  6182. Org mode normally exports the text before the first headline, and even uses
  6183. the first line as the document title. The text will be fully marked up. If
  6184. you need to include literal HTML or La@TeX{} code, use the special constructs
  6185. described below in the sections for the individual exporters.
  6186. Some people like to use the space before the first headline for setup and
  6187. internal links and therefore would like to control the exported text before
  6188. the first headline in a different way. You can do so by setting the variable
  6189. @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
  6190. basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
  6191. @noindent
  6192. If you still want to have some text before the first headline, use the
  6193. @code{#+TEXT} construct:
  6194. @example
  6195. #+OPTIONS: skip:t
  6196. #+TEXT: This text will go before the *first* headline.
  6197. #+TEXT: [TABLE-OF-CONTENTS]
  6198. #+TEXT: This goes between the table of contents and the first headline
  6199. @end example
  6200. @node Lists, Paragraphs, Initial text, Markup rules
  6201. @subheading Lists
  6202. @cindex lists, markup rules
  6203. Plain lists as described in @ref{Plain lists} are translated to the back-ends
  6204. syntax for such lists. Most back-ends support unordered, ordered, and
  6205. description lists.
  6206. @node Paragraphs, Literal examples, Lists, Markup rules
  6207. @subheading Paragraphs, line breaks, and quoting
  6208. @cindex paragraphs, markup rules
  6209. Paragraphs are separated by at least one empty line. If you need to enforce
  6210. a line break within a paragraph, use @samp{\\} at the end of a line.
  6211. To keep the line breaks in a region, but otherwise use normal formatting, you
  6212. can use this construct, which can also be used to format poetry.
  6213. @example
  6214. #+BEGIN_VERSE
  6215. Great clouds overhead
  6216. Tiny black birds rise and fall
  6217. Snow covers Emacs
  6218. -- AlexSchroeder
  6219. #+END_VERSE
  6220. @end example
  6221. When quoting a passage from another document, it is customary to format this
  6222. as a paragraph that is indented on both the left and the right margin. You
  6223. can include quotations in Org mode documents like this:
  6224. @example
  6225. #+BEGIN_QUOTE
  6226. Everything should be made as simple as possible,
  6227. but not any simpler -- Albert Einstein
  6228. #+END_QUOTE
  6229. @end example
  6230. @node Literal examples, Include files, Paragraphs, Markup rules
  6231. @subheading Literal examples
  6232. @cindex literal examples, markup rules
  6233. You can include literal examples that should not be subjected to
  6234. markup. Such examples will be typeset in monospace, so this is well suited
  6235. for source code and similar examples.
  6236. @cindex #+BEGIN_EXAMPLE
  6237. @example
  6238. #+BEGIN_EXAMPLE
  6239. Some example from a text file.
  6240. #+END_EXAMPLE
  6241. @end example
  6242. For simplicity when using small examples, you can also start the example
  6243. lines with a colon:
  6244. @example
  6245. : Some example from a text file.
  6246. @end example
  6247. @cindex formatting source code, markup rules
  6248. If the example is source code from a programming language, or any other text
  6249. that can be marked up by font-lock in Emacs, you can ask for the example to
  6250. look like the fontified Emacs buffer@footnote{Currently this works only for
  6251. the HTML back-end, and requires the @file{htmlize.el} package version 1.34 or
  6252. later.}. This is done with the @samp{src} block, where you also need to
  6253. specify the name of the major mode that should be used to fontify the
  6254. example:
  6255. @cindex #+BEGIN_SRC
  6256. @example
  6257. #+BEGIN_SRC emacs-lisp
  6258. (defun org-xor (a b)
  6259. "Exclusive or."
  6260. (if a (not b) b))
  6261. #+END_SRC
  6262. @end example
  6263. @table @kbd
  6264. @kindex C-c '
  6265. @item C-c '
  6266. Edit the source code example at point in its native mode. This works by
  6267. switching to an indirect buffer, narrowing the buffer and switching to the
  6268. other mode. You need to exit by pressing @kbd{C-c '} again@footnote{Upon
  6269. exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to
  6270. keep them from being interpreted by Org as outline nodes or special
  6271. comments. These commas will be striped for editing with @kbd{C-c '}, and
  6272. also for export.}. Fixed-width
  6273. regions (where each line starts with a colon followed by a space) will be
  6274. edited using @code{artist-mode}@footnote{You may select a different-mode with
  6275. the variable @code{org-edit-fixed-width-region-mode}.} to allow creating
  6276. ASCII drawings easily. Using this command in an empty line will create a new
  6277. fixed-width region.
  6278. @end table
  6279. @node Include files, Tables exported, Literal examples, Markup rules
  6280. @subheading Include files
  6281. @cindex include files, markup rules
  6282. During export, you can include the content of another file. For example, to
  6283. include your .emacs file, you could use:
  6284. @cindex #+INCLUDE
  6285. @example
  6286. #+INCLUDE: "~/.emacs" src emacs-lisp
  6287. @end example
  6288. The optional second and third parameter are the markup (@samp{quote},
  6289. @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
  6290. language for formatting the contents. The markup is optional, if it is not
  6291. given, the text will be assumed to be in Org mode format and will be
  6292. processed normally. The include line will also allow additional keyword
  6293. parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
  6294. first line and for each following line. For example, to include a file as an
  6295. item, use
  6296. @example
  6297. #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
  6298. @end example
  6299. @table @kbd
  6300. @kindex C-c '
  6301. @item C-c '
  6302. Visit the include file at point.
  6303. @end table
  6304. @node Tables exported, Footnotes, Include files, Markup rules
  6305. @subheading Tables
  6306. @cindex tables, markup rules
  6307. Both the native Org mode tables (@pxref{Tables}) and tables formatted with
  6308. the @file{table.el} package will be exported properly. For Org mode tables,
  6309. the lines before the first horizontal separator line will become table header
  6310. lines.
  6311. @node Footnotes, Emphasis and monospace, Tables exported, Markup rules
  6312. @subheading Footnotes
  6313. @cindex footnotes, markup rules
  6314. @cindex @file{footnote.el}
  6315. @kindex C-c !
  6316. Numbers in square brackets are treated as footnote markers, and lines
  6317. starting with such a marker are interpreted as the footnote itself. You can
  6318. use the Emacs package @file{footnote.el} to create footnotes@footnote{The
  6319. @file{footnote} package uses @kbd{C-c !} to invoke its commands. This
  6320. binding conflicts with the Org mode command for inserting inactive time
  6321. stamps. You could use the variable @code{footnote-prefix} to switch
  6322. footnotes commands to another key. Or, if you are too used to this binding,
  6323. you could use @code{org-replace-disputed-keys} and @code{org-disputed-keys}
  6324. to change the settings in Org.}. For example:
  6325. @example
  6326. The Org homepage[1] now looks a lot better than it used to.
  6327. [1] The link is: http://orgmode.org
  6328. @end example
  6329. @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnotes, Markup rules
  6330. @subheading Emphasis and monospace
  6331. @cindex underlined text, markup rules
  6332. @cindex bold text, markup rules
  6333. @cindex italic text, markup rules
  6334. @cindex verbatim text, markup rules
  6335. @cindex code text, markup rules
  6336. @cindex strike-through text, markup rules
  6337. You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
  6338. and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
  6339. in the code and verbatim string is not processed for Org mode specific
  6340. syntax, it is exported verbatim.
  6341. @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules
  6342. @subheading @TeX{} macros and La@TeX{} fragments
  6343. @cindex LaTeX fragments, markup rules
  6344. @cindex TeX macros, markup rules
  6345. @cindex HTML entities
  6346. @cindex LaTeX entities
  6347. A @TeX{}-like syntax is used to specify special characters. Where possible,
  6348. these will be transformed into the native format of the exporter back-end.
  6349. Strings like @code{\alpha} will be exported as @code{&alpha;} in the HTML
  6350. output, and as @code{$\alpha$} in the La@TeX{} output. Similarly,
  6351. @code{\nbsp} will become @code{&nbsp;} in HTML and @code{~} in La@TeX{}.
  6352. This applies for a large number of entities, with names taken from both HTML
  6353. and La@TeX{}, see the variable @code{org-html-entities} for the complete
  6354. list. If you are unsure about a name, use @kbd{M-@key{TAB}} for completion
  6355. after having types the backslash and maybe a few characters
  6356. (@pxref{Completion}).
  6357. La@TeX{} fragments are converted into images for HTML export, and they are
  6358. written literally into the La@TeX{} export. See also @ref{Embedded LaTeX}.
  6359. Finally, @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
  6360. @samp{...} are all converted into special commands creating hyphens of
  6361. different lengths or a compact set of dots.
  6362. @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules
  6363. @subheading Horizontal rules
  6364. @cindex horizontal rules, markup rules
  6365. A line consisting of only dashes, and at least 5 of them, will be
  6366. exported as a horizontal line (@samp{<hr/>} in HTML).
  6367. @node Comment lines, , Horizontal rules, Markup rules
  6368. @subheading Comment lines
  6369. @cindex comment lines
  6370. @cindex exporting, not
  6371. Lines starting with @samp{#} in column zero are treated as comments and will
  6372. never be exported. Also entire subtrees starting with the word
  6373. @samp{COMMENT} will never be exported. Finally, regions surrounded by
  6374. @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
  6375. @table @kbd
  6376. @kindex C-c ;
  6377. @item C-c ;
  6378. Toggle the COMMENT keyword at the beginning of an entry.
  6379. @end table
  6380. @node Selective export, Export options, Markup rules, Exporting
  6381. @section Selective export
  6382. @cindex export, selective by tags
  6383. You may use tags to select the parts of a document that should be exported,
  6384. or to exclude parts from export. This behavior is governed by two variables:
  6385. @code{org-export-select-tags} and @code{org-export-exclude-tags}.
  6386. Org first checks if any of the @emph{select} tags is present in the buffer.
  6387. If yes, all trees that do not carry one of these tags will be excluded. If a
  6388. selected tree is a subtree, the heading hierarchy above it will also be
  6389. selected for export, but not the text below those headings.
  6390. @noindent
  6391. If none of the select tags is found, the whole buffer will be selected for
  6392. export.
  6393. @noindent
  6394. Finally, all subtrees that are marked by any of the @emph{exclude} tags will
  6395. be removed from the export buffer.
  6396. @node Export options, The export dispatcher, Selective export, Exporting
  6397. @section Export options
  6398. @cindex options, for export
  6399. @cindex completion, of option keywords
  6400. The exporter recognizes special lines in the buffer which provide
  6401. additional information. These lines may be put anywhere in the file.
  6402. The whole set of lines can be inserted into the buffer with @kbd{C-c
  6403. C-e t}. For individual lines, a good way to make sure the keyword is
  6404. correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
  6405. (@pxref{Completion}).
  6406. @table @kbd
  6407. @kindex C-c C-e t
  6408. @item C-c C-e t
  6409. Insert template with export options, see example below.
  6410. @end table
  6411. @cindex #+TITLE:
  6412. @cindex #+AUTHOR:
  6413. @cindex #+DATE:
  6414. @cindex #+EMAIL:
  6415. @cindex #+LANGUAGE:
  6416. @cindex #+TEXT:
  6417. @cindex #+OPTIONS:
  6418. @cindex #+LINK_UP:
  6419. @cindex #+LINK_HOME:
  6420. @cindex #+EXPORT_SELECT_TAGS:
  6421. @cindex #+EXPORT_EXCLUDE_TAGS:
  6422. @example
  6423. #+TITLE: the title to be shown (default is the buffer name)
  6424. #+AUTHOR: the author (default taken from @code{user-full-name})
  6425. #+DATE: A date, fixed, of a format string for @code{format-time-string}
  6426. #+EMAIL: his/her email address (default from @code{user-mail-address})
  6427. #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
  6428. #+TEXT: Some descriptive text to be inserted at the beginning.
  6429. #+TEXT: Several lines may be given.
  6430. #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
  6431. #+LINK_UP: the ``up'' link of an exported page
  6432. #+LINK_HOME: the ``home'' link of an exported page
  6433. #+EXPORT_SELECT_TAGS: Tags that select a tree for export
  6434. #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
  6435. @end example
  6436. @noindent
  6437. The OPTIONS line is a compact@footnote{If you want to configure many options
  6438. this way, you can use several OPTIONS lines.} form to specify export settings. Here
  6439. you can:
  6440. @cindex headline levels
  6441. @cindex section-numbers
  6442. @cindex table of contents
  6443. @cindex line-break preservation
  6444. @cindex quoted HTML tags
  6445. @cindex fixed-width sections
  6446. @cindex tables
  6447. @cindex @TeX{}-like syntax for sub- and superscripts
  6448. @cindex footnotes
  6449. @cindex special strings
  6450. @cindex emphasized text
  6451. @cindex @TeX{} macros
  6452. @cindex La@TeX{} fragments
  6453. @cindex author info, in export
  6454. @cindex time info, in export
  6455. @example
  6456. H: @r{set the number of headline levels for export}
  6457. num: @r{turn on/off section-numbers}
  6458. toc: @r{turn on/off table of contents, or set level limit (integer)}
  6459. \n: @r{turn on/off line-break-preservation}
  6460. @@: @r{turn on/off quoted HTML tags}
  6461. :: @r{turn on/off fixed-width sections}
  6462. |: @r{turn on/off tables}
  6463. ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
  6464. @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
  6465. @r{the simple @code{a_b} will be left as it is.}
  6466. -: @r{turn on/off conversion of special strings.}
  6467. f: @r{turn on/off footnotes like this[1].}
  6468. *: @r{turn on/off emphasized text (bold, italic, underlined)}
  6469. TeX: @r{turn on/off simple @TeX{} macros in plain text}
  6470. LaTeX: @r{turn on/off La@TeX{} fragments}
  6471. skip: @r{turn on/off skipping the text before the first heading}
  6472. author: @r{turn on/off inclusion of author name/email into exported file}
  6473. creator: @r{turn on/off inclusion of creator info into exported file}
  6474. timestamp: @r{turn on/off inclusion creation time into exported file}
  6475. d: @r{turn on/off inclusion of drawers}
  6476. @end example
  6477. These options take effect in both the HTML and La@TeX{} export, except
  6478. for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and
  6479. @code{nil} for the La@TeX{} export.
  6480. When exporting only a single subtree by selecting it with @kbd{C-c @@} before
  6481. calling an export command, the subtree can overrule some of the file's export
  6482. settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
  6483. @code{EXPORT_TEXT}, and @code{EXPORT_OPTIONS}.
  6484. @node The export dispatcher, ASCII export, Export options, Exporting
  6485. @section The export dispatcher
  6486. @cindex dispatcher, for export commands
  6487. All export commands can be reached using the export dispatcher, which is a
  6488. prefix key that prompts for an additional key specifying the command.
  6489. Normally the entire file is exported, but if there is an active region that
  6490. contains one outline tree, the first heading is used as document title and
  6491. the subtrees are exported.
  6492. @table @kbd
  6493. @kindex C-c C-e
  6494. @item C-c C-e
  6495. Dispatcher for export and publishing commands. Displays a help-window
  6496. listing the additional key(s) needed to launch an export or publishing
  6497. command. The prefix arg is passed through to the exporter. If the option
  6498. @code{org-export-run-in-background} is set, Org will run the command in the
  6499. background if that seems useful for the specific command (i.e. commands that
  6500. write to a file).
  6501. @kindex C-c C-e v
  6502. @item C-c C-e v
  6503. Like @kbd{C-c C-e}, but only export the text that is currently visible
  6504. (i.e. not hidden by outline visibility).
  6505. @kindex C-u C-u C-c C-e
  6506. @item C-u C-u C-c C-e
  6507. Call an the exporter, but reverse the setting of
  6508. @code{org-export-run-in-background}, i.e. request background processing if
  6509. not set, or force processing in the current Emacs process if st.
  6510. @end table
  6511. @node ASCII export, HTML export, The export dispatcher, Exporting
  6512. @section ASCII export
  6513. @cindex ASCII export
  6514. ASCII export produces a simple and very readable version of an Org mode
  6515. file.
  6516. @cindex region, active
  6517. @cindex active region
  6518. @cindex Transient mark mode
  6519. @table @kbd
  6520. @kindex C-c C-e a
  6521. @item C-c C-e a
  6522. Export as ASCII file. For an org file @file{myfile.org}, the ASCII file
  6523. will be @file{myfile.txt}. The file will be overwritten without
  6524. warning. If there is an active region, only the region will be
  6525. exported. If the selected region is a single tree@footnote{To select the
  6526. current subtree, use @kbd{C-c @@}.}, the tree head will
  6527. become the document title. If the tree head entry has or inherits an
  6528. @code{EXPORT_FILE_NAME} property, that name will be used for the
  6529. export.
  6530. @kindex C-c C-e v a
  6531. @item C-c C-e v a
  6532. Export only the visible part of the document.
  6533. @end table
  6534. @cindex headline levels, for exporting
  6535. In the exported version, the first 3 outline levels will become
  6536. headlines, defining a general document structure. Additional levels
  6537. will be exported as itemized lists. If you want that transition to occur
  6538. at a different level, specify it with a prefix argument. For example,
  6539. @example
  6540. @kbd{C-1 C-c C-e a}
  6541. @end example
  6542. @noindent
  6543. creates only top level headlines and does the rest as items. When
  6544. headlines are converted to items, the indentation of the text following
  6545. the headline is changed to fit nicely under the item. This is done with
  6546. the assumption that the first body line indicates the base indentation of
  6547. the body text. Any indentation larger than this is adjusted to preserve
  6548. the layout relative to the first line. Should there be lines with less
  6549. indentation than the first, these are left alone.
  6550. @node HTML export, LaTeX and PDF export, ASCII export, Exporting
  6551. @section HTML export
  6552. @cindex HTML export
  6553. Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
  6554. HTML formatting, in ways similar to John Grubers @emph{markdown}
  6555. language, but with additional support for tables.
  6556. @menu
  6557. * HTML Export commands:: How to invoke HTML export
  6558. * Quoting HTML tags:: Using direct HTML in Org mode
  6559. * Links:: Transformation of links for HTML
  6560. * Images:: How to include images
  6561. * CSS support:: Changing the appearance of the output
  6562. * Javascript support:: Info and Folding in a web browser
  6563. @end menu
  6564. @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
  6565. @subsection HTML export commands
  6566. @cindex region, active
  6567. @cindex active region
  6568. @cindex Transient mark mode
  6569. @table @kbd
  6570. @kindex C-c C-e h
  6571. @item C-c C-e h
  6572. Export as HTML file @file{myfile.html}. For an org file @file{myfile.org},
  6573. the ASCII file will be @file{myfile.html}. The file will be overwritten
  6574. without warning. If there is an active region, only the region will be
  6575. exported. If the selected region is a single tree@footnote{To select the
  6576. current subtree, use @kbd{C-c @@}.}, the tree head will become the document
  6577. title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
  6578. property, that name will be used for the export.
  6579. @kindex C-c C-e b
  6580. @item C-c C-e b
  6581. Export as HTML file and immediately open it with a browser.
  6582. @kindex C-c C-e H
  6583. @item C-c C-e H
  6584. Export to a temporary buffer, do not create a file.
  6585. @kindex C-c C-e R
  6586. @item C-c C-e R
  6587. Export the active region to a temporary buffer. With a prefix argument, do
  6588. not produce the file header and footer, but just the plain HTML section for
  6589. the region. This is good for cut-and-paste operations.
  6590. @kindex C-c C-e v h
  6591. @kindex C-c C-e v b
  6592. @kindex C-c C-e v H
  6593. @kindex C-c C-e v R
  6594. @item C-c C-e v h
  6595. @item C-c C-e v b
  6596. @item C-c C-e v H
  6597. @item C-c C-e v R
  6598. Export only the visible part of the document.
  6599. @item M-x org-export-region-as-html
  6600. Convert the region to HTML under the assumption that it was Org mode
  6601. syntax before. This is a global command that can be invoked in any
  6602. buffer.
  6603. @item M-x org-replace-region-by-HTML
  6604. Replace the active region (assumed to be in Org mode syntax) by HTML
  6605. code.
  6606. @end table
  6607. @cindex headline levels, for exporting
  6608. In the exported version, the first 3 outline levels will become headlines,
  6609. defining a general document structure. Additional levels will be exported as
  6610. itemized lists. If you want that transition to occur at a different level,
  6611. specify it with a numeric prefix argument. For example,
  6612. @example
  6613. @kbd{C-2 C-c C-e b}
  6614. @end example
  6615. @noindent
  6616. creates two levels of headings and does the rest as items.
  6617. @node Quoting HTML tags, Links, HTML Export commands, HTML export
  6618. @subsection Quoting HTML tags
  6619. Plain @samp{<} and @samp{>} are always transformed to @samp{&lt;} and
  6620. @samp{&gt;} in HTML export. If you want to include simple HTML tags
  6621. which should be interpreted as such, mark them with @samp{@@} as in
  6622. @samp{@@<b>bold text@@</b>}. Note that this really works only for
  6623. simple tags. For more extensive HTML that should be copied verbatim to
  6624. the exported file use either
  6625. @example
  6626. #+HTML: Literal HTML code for export
  6627. @end example
  6628. @noindent or
  6629. @cindex #+BEGIN_HTML
  6630. @example
  6631. #+BEGIN_HTML
  6632. All lines between these markers are exported literally
  6633. #+END_HTML
  6634. @end example
  6635. @node Links, Images, Quoting HTML tags, HTML export
  6636. @subsection Links
  6637. @cindex links, in HTML export
  6638. @cindex internal links, in HTML export
  6639. @cindex external links, in HTML export
  6640. Internal links (@pxref{Internal links}) will continue to work in HTML
  6641. files only if they match a dedicated @samp{<<target>>}. Automatic links
  6642. created by radio targets (@pxref{Radio targets}) will also work in the
  6643. HTML file. Links to external files will still work if the HTML file is
  6644. in the same directory as the Org file. Links to other @file{.org}
  6645. files will be translated into HTML links under the assumption that an
  6646. HTML version also exists of the linked file. For information related to
  6647. linking files while publishing them to a publishing directory see
  6648. @ref{Publishing links}.
  6649. If you want to specify attributes for links, you can do so using a special
  6650. syntax. Here is an example that sets @code{alt} and @code{title} attributes
  6651. for an inlined image:
  6652. @example
  6653. [[./img/a.jpg@{@{alt="This is image A" title="Image with no action"@}@}]]
  6654. @end example
  6655. @node Images, CSS support, Links, HTML export
  6656. @subsection Images
  6657. @cindex images, inline in HTML
  6658. @cindex inlining images in HTML
  6659. HTML export can inline images given as links in the Org file, and
  6660. it can make an image the clickable part of a link. By
  6661. default@footnote{but see the variable
  6662. @code{org-export-html-inline-images}}, images are inlined if a link does
  6663. not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
  6664. while @samp{[[file:myimg.jpg][the image]]} will just produce a link
  6665. @samp{the image} that points to the image. If the description part
  6666. itself is a @code{file:} link or a @code{http:} URL pointing to an
  6667. image, this image will be inlined and activated so that clicking on the
  6668. image will activate the link. For example, to include a thumbnail that
  6669. will link to a high resolution version of the image, you could use:
  6670. @example
  6671. [[file:highres.jpg][file:thumb.jpg]]
  6672. @end example
  6673. @noindent
  6674. and you could use @code{http} addresses just as well.
  6675. @node CSS support, Javascript support, Images, HTML export
  6676. @subsection CSS support
  6677. @cindex CSS, for HTML export
  6678. @cindex HTML export, CSS
  6679. You can also give style information for the exported file. The HTML
  6680. exporter assigns the following CSS classes to appropriate parts of the
  6681. document - your style specifications may change these:
  6682. @example
  6683. .todo @r{TODO keywords}
  6684. .done @r{the DONE keyword}
  6685. .timestamp @r{time stamp}
  6686. .timestamp-kwd @r{keyword associated with a time stamp, like SCHEDULED}
  6687. .tag @r{tag in a headline}
  6688. .target @r{target for links}
  6689. @end example
  6690. Each exported files contains a compact default style that defines these
  6691. classes in a basic way. You may overwrite these settings, or add to them by
  6692. using the variables @code{org-export-html-style} (for Org-wide settings) and
  6693. @code{org-export-html-style-extra} (for more granular settings, like
  6694. file-local settings). To set the latter variable individually for each
  6695. file, you can use
  6696. @example
  6697. #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
  6698. @end example
  6699. @noindent
  6700. For longer style definitions, you can use several such lines.
  6701. @c FIXME: More about header and footer styles
  6702. @c FIXME: Talk about links and targets.
  6703. @node Javascript support, , CSS support, HTML export
  6704. @subsection Javascript supported display of web pages
  6705. @emph{Sebastian Rose} has written a JavaScript program especially designed to
  6706. enhance the web viewing experience of HTML files created with Org. This
  6707. program allows to view large files in two different ways. The first one is
  6708. an @emph{Info}-like mode where each section is displayed separately and
  6709. navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
  6710. as well, press @kbd{?} for an overview of the available keys). The second
  6711. view type is a @emph{folding} view much like Org provides it inside Emacs.
  6712. The script is available at @url{http://orgmode.org/org-info.js} and you can
  6713. find the documentation for it at
  6714. @url{http://orgmode.org/worg/code/org-info-js/org-info.js.html}. We are
  6715. serving the script from our site, but if you use it a lot, you might not want
  6716. to be dependent on @url{orgmode.org} and prefer to install a local copy on
  6717. your own web server.
  6718. To use the script, you need to make sure that the @file{org-jsinfo.el} module
  6719. gets loaded. It should be loaded by default, try @kbd{M-x customize-variable
  6720. @key{RET} org-modules @key{RET}} to convince yourself that this is indeed the
  6721. case. All it then takes to make use of the program is adding a single line
  6722. to the Org file:
  6723. @example
  6724. #+INFOJS_OPT: view:info toc:nil
  6725. @end example
  6726. @noindent
  6727. If this line is found, the HTML header will automatically contain the code
  6728. needed to invoke the script. Using the line above, you can set the following
  6729. viewing options:
  6730. @example
  6731. path: @r{The path to the script. The default is to grab the script from}
  6732. @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
  6733. @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
  6734. view: @r{Initial view when website is first shown. Possible values are:}
  6735. info @r{Info-like interface with one section per page.}
  6736. overview @r{Folding interface, initially showing only top-level.}
  6737. content @r{Folding interface, starting with all headlines visible.}
  6738. showall @r{Folding interface, all headlines and text visible.}
  6739. sdepth: @r{Maximum headline level that will still become an independent}
  6740. @r{section for info and folding modes. The default is taken from}
  6741. @r{@code{org-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
  6742. @r{If this is smaller than in @code{org-headline-levels}, each}
  6743. @r{info/folding section can still contain children headlines.}
  6744. toc: @r{Should the table of content @emph{initially} be visible?}
  6745. @r{Even when @code{nil}, you can always get to the toc with @kbd{i}.}
  6746. tdepth: @r{The depth of the table of contents. The defaults are taken from}
  6747. @r{the variables @code{org-headline-levels} and @code{org-export-with-toc}.}
  6748. ftoc: @r{Does the css of the page specify a fixed position for the toc?}
  6749. @r{If yes, the toc will never be displayed as a section.}
  6750. ltoc: @r{Should there be short contents (children) in each section?}
  6751. mouse: @r{Headings are highlighted when the mouse is over them. Should be}
  6752. @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
  6753. buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
  6754. @r{default), only one such button will be present.}
  6755. @end example
  6756. You can choose default values for these options by customizing the variable
  6757. @code{org-infojs-options}. If you always want to apply the script to your
  6758. pages, configure the variable @code{org-export-html-use-infojs}.
  6759. @node LaTeX and PDF export, XOXO export, HTML export, Exporting
  6760. @section LaTeX and PDF export
  6761. @cindex LaTeX export
  6762. @cindex PDF export
  6763. Org mode contains a La@TeX{} exporter written by Bastien Guerry. With
  6764. further processing, this backend is also used to produce PDF output. Since
  6765. the LaTeX output uses @file{hyperref} to implement links and cross
  6766. references, the PDF output file will be fully linked.
  6767. @menu
  6768. * LaTeX/PDF export commands::
  6769. * Quoting LaTeX code:: Incorporating literal LaTeX code
  6770. * Sectioning structure:: Changing sectioning in LaTeX output
  6771. @end menu
  6772. @node LaTeX/PDF export commands, Quoting LaTeX code, LaTeX and PDF export, LaTeX and PDF export
  6773. @subsection LaTeX export commands
  6774. @table @kbd
  6775. @kindex C-c C-e l
  6776. @item C-c C-e l
  6777. Export as La@TeX{} file @file{myfile.tex}. For an org file
  6778. @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
  6779. be overwritten without warning. If there is an active region, only the
  6780. region will be exported. If the selected region is a single tree@footnote{To
  6781. select the current subtree, use @kbd{C-c @@}.}, the tree head will become the
  6782. document title. If the tree head entry has or inherits an
  6783. @code{EXPORT_FILE_NAME} property, that name will be used for the export.
  6784. @kindex C-c C-e L
  6785. @item C-c C-e L
  6786. Export to a temporary buffer, do not create a file.
  6787. @kindex C-c C-e v l
  6788. @kindex C-c C-e v L
  6789. @item C-c C-e v l
  6790. @item C-c C-e v L
  6791. Export only the visible part of the document.
  6792. @item M-x org-export-region-as-latex
  6793. Convert the region to La@TeX{} under the assumption that it was Org mode
  6794. syntax before. This is a global command that can be invoked in any
  6795. buffer.
  6796. @item M-x org-replace-region-by-latex
  6797. Replace the active region (assumed to be in Org mode syntax) by La@TeX{}
  6798. code.
  6799. @kindex C-c C-e p
  6800. @item C-c C-e p
  6801. Export as LaTeX and then process to PDF.
  6802. @kindex C-c C-e d
  6803. @item C-c C-e d
  6804. Export as LaTeX and then process to PDF, then open the resulting PDF file.
  6805. @end table
  6806. @cindex headline levels, for exporting
  6807. In the exported version, the first 3 outline levels will become
  6808. headlines, defining a general document structure. Additional levels
  6809. will be exported as description lists. The exporter can ignore them or
  6810. convert them to a custom string depending on
  6811. @code{org-latex-low-levels}.
  6812. If you want that transition to occur at a different level, specify it
  6813. with a numeric prefix argument. For example,
  6814. @example
  6815. @kbd{C-2 C-c C-e l}
  6816. @end example
  6817. @noindent
  6818. creates two levels of headings and does the rest as items.
  6819. @node Quoting LaTeX code, Sectioning structure, LaTeX/PDF export commands, LaTeX and PDF export
  6820. @subsection Quoting LaTeX code
  6821. Embedded La@TeX{} as described in @ref{Embedded LaTeX} will be correctly
  6822. inserted into the La@TeX{} file. Furthermore, you can add special code
  6823. that should only be present in La@TeX{} export with the following
  6824. constructs:
  6825. @example
  6826. #+LaTeX: Literal LaTeX code for export
  6827. @end example
  6828. @noindent or
  6829. @cindex #+BEGIN_LaTeX
  6830. @example
  6831. #+BEGIN_LaTeX
  6832. All lines between these markers are exported literally
  6833. #+END_LaTeX
  6834. @end example
  6835. @node Sectioning structure, , Quoting LaTeX code, LaTeX and PDF export
  6836. @subsection Sectioning structure
  6837. @cindex LaTeX class
  6838. @cindex LaTeX sectioning structure
  6839. By default, the La@TeX{} output uses the class @code{article}.
  6840. You can change this globally by setting a different value for
  6841. @code{org-export-latex-default-class} or locally by adding an option like
  6842. @code{#+LaTeX_CLASS: myclass} in your file. The class should be listed in
  6843. @code{org-export-latex-classes}, where you can also define the sectioning
  6844. structure for each class, as well as defining additonal classes.
  6845. @node XOXO export, iCalendar export, LaTeX and PDF export, Exporting
  6846. @section XOXO export
  6847. @cindex XOXO export
  6848. Org mode contains an exporter that produces XOXO-style output.
  6849. Currently, this exporter only handles the general outline structure and
  6850. does not interpret any additional Org mode features.
  6851. @table @kbd
  6852. @kindex C-c C-e x
  6853. @item C-c C-e x
  6854. Export as XOXO file @file{myfile.html}.
  6855. @kindex C-c C-e v
  6856. @item C-c C-e v x
  6857. Export only the visible part of the document.
  6858. @end table
  6859. @node iCalendar export, , XOXO export, Exporting
  6860. @section iCalendar export
  6861. @cindex iCalendar export
  6862. Some people like to use Org mode for keeping track of projects, but still
  6863. prefer a standard calendar application for anniversaries and appointments.
  6864. In this case it can be useful to have deadlines and other time-stamped items
  6865. in Org files show up in the calendar application. Org mode can export
  6866. calendar information in the standard iCalendar format. If you also want to
  6867. have TODO entries included in the export, configure the variable
  6868. @code{org-icalendar-include-todo}. iCalendar export will export plain time
  6869. stamps as VEVENT, and TODO items as VTODO. It will also create events from
  6870. deadlines that are in non-TODO items. Deadlines and scheduling dates in TODO
  6871. items will be used to set the start and due dates for the todo
  6872. entry@footnote{See the variables @code{org-icalendar-use-deadline} and
  6873. @code{org-icalendar-use-scheduled}.}. As categories, it will use the tags
  6874. locally defined in the heading, and the file/tree category@footnote{To add
  6875. inherited tags or the TODO state, configure the variable
  6876. @code{org-icalendar-categories}.}.
  6877. The iCalendar standard requires each entry to have a globally unique
  6878. identifier (UID). Org creates these identifiers during export. If you set
  6879. the variable @code{org-icalendar-store-UID}, the UID will be stored in the
  6880. @code{:ID:} property of the entry and re-used next time you report this
  6881. entry. Since a single entry can give rise to multiple iCalendar entries (as
  6882. a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
  6883. prefixes to the UID, depending on what triggered the inclusion of the entry.
  6884. In this way the UID remains unique, but a synchronization program can still
  6885. figure out from which entry all the different instances originate.
  6886. @table @kbd
  6887. @kindex C-c C-e i
  6888. @item C-c C-e i
  6889. Create iCalendar entries for the current file and store them in the same
  6890. directory, using a file extension @file{.ics}.
  6891. @kindex C-c C-e I
  6892. @item C-c C-e I
  6893. Like @kbd{C-c C-e i}, but do this for all files in
  6894. @code{org-agenda-files}. For each of these files, a separate iCalendar
  6895. file will be written.
  6896. @kindex C-c C-e c
  6897. @item C-c C-e c
  6898. Create a single large iCalendar file from all files in
  6899. @code{org-agenda-files} and write it to the file given by
  6900. @code{org-combined-agenda-icalendar-file}.
  6901. @end table
  6902. The export will honor SUMMARY, DESCRIPTION and LOCATION properties if
  6903. the selected entries have them. If not, the summary will be derived
  6904. from the headline, and the description from the body (limited to
  6905. @code{org-icalendar-include-body} characters).
  6906. How this calendar is best read and updated, that depends on the application
  6907. you are using. The FAQ covers this issue.
  6908. @node Publishing, Miscellaneous, Exporting, Top
  6909. @chapter Publishing
  6910. @cindex publishing
  6911. Org includes@footnote{@file{org-publish.el} is not distributed with
  6912. Emacs 21, if you are still using Emacs 21, you need you need to download
  6913. this file separately.} a publishing management system that allows you to
  6914. configure automatic HTML conversion of @emph{projects} composed of
  6915. interlinked org files. This system is called @emph{org-publish}. You can
  6916. also configure org-publish to automatically upload your exported HTML
  6917. pages and related attachments, such as images and source code files, to
  6918. a web server. Org-publish turns Org into a web-site authoring tool.
  6919. You can also use Org-publish to convert files into La@TeX{}, or even
  6920. combine HTML and La@TeX{} conversion so that files are available in both
  6921. formats on the server@footnote{Since La@TeX{} files on a server are not
  6922. that helpful, you surely want to perform further conversion on them --
  6923. e.g. convert them to @code{PDF} format.}.
  6924. Org-publish has been contributed to Org by David O'Toole.
  6925. @menu
  6926. * Configuration:: Defining projects
  6927. * Sample configuration:: Example projects
  6928. * Triggering publication:: Publication commands
  6929. @end menu
  6930. @node Configuration, Sample configuration, Publishing, Publishing
  6931. @section Configuration
  6932. Publishing needs significant configuration to specify files, destination
  6933. and many other properties of a project.
  6934. @menu
  6935. * Project alist:: The central configuration variable
  6936. * Sources and destinations:: From here to there
  6937. * Selecting files:: What files are part of the project?
  6938. * Publishing action:: Setting the function doing the publishing
  6939. * Publishing options:: Tweaking HTML export
  6940. * Publishing links:: Which links keep working after publishing?
  6941. * Project page index:: Publishing a list of project files
  6942. @end menu
  6943. @node Project alist, Sources and destinations, Configuration, Configuration
  6944. @subsection The variable @code{org-publish-project-alist}
  6945. @cindex org-publish-project-alist
  6946. @cindex projects, for publishing
  6947. Org-publish is configured almost entirely through setting the value of
  6948. one variable, called @code{org-publish-project-alist}.
  6949. Each element of the list configures one project, and may be in one of
  6950. the two following forms:
  6951. @lisp
  6952. ("project-name" :property value :property value ...)
  6953. @r{or}
  6954. ("project-name" :components ("project-name" "project-name" ...))
  6955. @end lisp
  6956. In both cases, projects are configured by specifying property values.
  6957. A project defines the set of files that will be published, as well as
  6958. the publishing configuration to use when publishing those files. When
  6959. a project takes the second form listed above, the individual members
  6960. of the ``components'' property are taken to be components of the
  6961. project, which group together files requiring different publishing
  6962. options. When you publish such a ``meta-project'' all the components
  6963. will also publish.
  6964. @node Sources and destinations, Selecting files, Project alist, Configuration
  6965. @subsection Sources and destinations for files
  6966. @cindex directories, for publishing
  6967. Most properties are optional, but some should always be set. In
  6968. particular, org-publish needs to know where to look for source files,
  6969. and where to put published files.
  6970. @multitable @columnfractions 0.3 0.7
  6971. @item @code{:base-directory}
  6972. @tab Directory containing publishing source files
  6973. @item @code{:publishing-directory}
  6974. @tab Directory (possibly remote) where output files will be published.
  6975. @item @code{:preparation-function}
  6976. @tab Function called before starting the publishing process, for example to
  6977. run @code{make} for updating files to be published.
  6978. @item @code{:completion-function}
  6979. @tab Function called after finishing the publishing process, for example to
  6980. change permissions of the resulting files.
  6981. @end multitable
  6982. @noindent
  6983. @node Selecting files, Publishing action, Sources and destinations, Configuration
  6984. @subsection Selecting files
  6985. @cindex files, selecting for publishing
  6986. By default, all files with extension @file{.org} in the base directory
  6987. are considered part of the project. This can be modified by setting the
  6988. properties
  6989. @multitable @columnfractions 0.25 0.75
  6990. @item @code{:base-extension}
  6991. @tab Extension (without the dot!) of source files. This actually is a
  6992. regular expression.
  6993. @item @code{:exclude}
  6994. @tab Regular expression to match file names that should not be
  6995. published, even though they have been selected on the basis of their
  6996. extension.
  6997. @item @code{:include}
  6998. @tab List of files to be included regardless of @code{:base-extension}
  6999. and @code{:exclude}.
  7000. @end multitable
  7001. @node Publishing action, Publishing options, Selecting files, Configuration
  7002. @subsection Publishing action
  7003. @cindex action, for publishing
  7004. Publishing means that a file is copied to the destination directory and
  7005. possibly transformed in the process. The default transformation is to export
  7006. Org files as HTML files, and this is done by the function
  7007. @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
  7008. export}). But you also can publish your files in La@TeX{} by using the
  7009. function @code{org-publish-org-to-latex} instead, or as PDF files using
  7010. @code{org-publish-org-to-pdf}. Other files like images only need to be
  7011. copied to the publishing destination. For non-Org files, you need to provide
  7012. your own publishing function:
  7013. @multitable @columnfractions 0.3 0.7
  7014. @item @code{:publishing-function}
  7015. @tab Function executing the publication of a file. This may also be a
  7016. list of functions, which will all be called in turn.
  7017. @end multitable
  7018. The function must accept two arguments: a property list containing at
  7019. least a @code{:publishing-directory} property, and the name of the file
  7020. to be published. It should take the specified file, make the necessary
  7021. transformation (if any) and place the result into the destination folder.
  7022. You can write your own publishing function, but @code{org-publish}
  7023. provides one for attachments (files that only need to be copied):
  7024. @code{org-publish-attachment}.
  7025. @node Publishing options, Publishing links, Publishing action, Configuration
  7026. @subsection Options for the HTML/LaTeX exporters
  7027. @cindex options, for publishing
  7028. The property list can be used to set many export options for the HTML
  7029. and La@TeX{} exporters. In most cases, these properties correspond to user
  7030. variables in Org. The table below lists these properties along
  7031. with the variable they belong to. See the documentation string for the
  7032. respective variable for details.
  7033. @multitable @columnfractions 0.3 0.7
  7034. @item @code{:language} @tab @code{org-export-default-language}
  7035. @item @code{:headline-levels} @tab @code{org-export-headline-levels}
  7036. @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
  7037. @item @code{:table-of-contents} @tab @code{org-export-with-toc}
  7038. @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
  7039. @item @code{:emphasize} @tab @code{org-export-with-emphasize}
  7040. @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
  7041. @item @code{:special-strings} @tab @code{org-export-with-special-strings}
  7042. @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
  7043. @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
  7044. @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
  7045. @item @code{:timestamps} @tab @code{org-export-with-timestamps}
  7046. @item @code{:author-info} @tab @code{org-export-author-info}
  7047. @item @code{:creator-info} @tab @code{org-export-creator-info}
  7048. @item @code{:tags} @tab @code{org-export-with-tags}
  7049. @item @code{:tables} @tab @code{org-export-with-tables}
  7050. @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
  7051. @item @code{:style} @tab @code{org-export-html-style}
  7052. @item @code{:style-extra} @tab @code{org-export-html-style-extra}
  7053. @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
  7054. @item @code{:inline-images} @tab @code{org-export-html-inline-images}
  7055. @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
  7056. @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
  7057. @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
  7058. @item @code{:preamble} @tab @code{org-export-html-preamble}
  7059. @item @code{:postamble} @tab @code{org-export-html-postamble}
  7060. @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
  7061. @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
  7062. @item @code{:author} @tab @code{user-full-name}
  7063. @item @code{:email} @tab @code{user-mail-address}
  7064. @item @code{:select-tags} @tab @code{org-export-select-tags}
  7065. @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
  7066. @end multitable
  7067. If you use several email addresses, separate them by a semi-column.
  7068. Most of the @code{org-export-with-*} variables have the same effect in
  7069. both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and
  7070. @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
  7071. La@TeX{} export.
  7072. When a property is given a value in @code{org-publish-project-alist},
  7073. its setting overrides the value of the corresponding user variable (if
  7074. any) during publishing. Options set within a file (@pxref{Export
  7075. options}), however, override everything.
  7076. @node Publishing links, Project page index, Publishing options, Configuration
  7077. @subsection Links between published files
  7078. @cindex links, publishing
  7079. To create a link from one Org file to another, you would use
  7080. something like @samp{[[file:foo.org][The foo]]} or simply
  7081. @samp{file:foo.org.} (@pxref{Hyperlinks}). Upon publishing this link
  7082. becomes a link to @file{foo.html}. In this way, you can interlink the
  7083. pages of your "org web" project and the links will work as expected when
  7084. you publish them to HTML.
  7085. You may also link to related files, such as images. Provided you are
  7086. careful with relative pathnames, and provided you have also configured
  7087. @code{org-publish} to upload the related files, these links will work
  7088. too. @ref{Complex example} for an example of this usage.
  7089. Sometime an Org file to be published may contain links that are
  7090. only valid in your production environment, but not in the publishing
  7091. location. In this case, use the property
  7092. @multitable @columnfractions 0.4 0.6
  7093. @item @code{:link-validation-function}
  7094. @tab Function to validate links
  7095. @end multitable
  7096. @noindent
  7097. to define a function for checking link validity. This function must
  7098. accept two arguments, the file name and a directory relative to which
  7099. the file name is interpreted in the production environment. If this
  7100. function returns @code{nil}, then the HTML generator will only insert a
  7101. description into the HTML file, but no link. One option for this
  7102. function is @code{org-publish-validate-link} which checks if the given
  7103. file is part of any project in @code{org-publish-project-alist}.
  7104. @node Project page index, , Publishing links, Configuration
  7105. @subsection Project page index
  7106. @cindex index, of published pages
  7107. The following properties may be used to control publishing of an
  7108. index of files or summary page for a given project.
  7109. @multitable @columnfractions 0.25 0.75
  7110. @item @code{:auto-index}
  7111. @tab When non-nil, publish an index during org-publish-current-project or
  7112. org-publish-all.
  7113. @item @code{:index-filename}
  7114. @tab Filename for output of index. Defaults to @file{index.org} (which
  7115. becomes @file{index.html}).
  7116. @item @code{:index-title}
  7117. @tab Title of index page. Defaults to name of file.
  7118. @item @code{:index-function}
  7119. @tab Plug-in function to use for generation of index.
  7120. Defaults to @code{org-publish-org-index}, which generates a plain list
  7121. of links to all files in the project.
  7122. @end multitable
  7123. @node Sample configuration, Triggering publication, Configuration, Publishing
  7124. @section Sample configuration
  7125. Below we provide two example configurations. The first one is a simple
  7126. project publishing only a set of Org files. The second example is
  7127. more complex, with a multi-component project.
  7128. @menu
  7129. * Simple example:: One-component publishing
  7130. * Complex example:: A multi-component publishing example
  7131. @end menu
  7132. @node Simple example, Complex example, Sample configuration, Sample configuration
  7133. @subsection Example: simple publishing configuration
  7134. This example publishes a set of Org files to the @file{public_html}
  7135. directory on the local machine.
  7136. @lisp
  7137. (setq org-publish-project-alist
  7138. '(("org"
  7139. :base-directory "~/org/"
  7140. :publishing-directory "~/public_html"
  7141. :section-numbers nil
  7142. :table-of-contents nil
  7143. :style "<link rel=stylesheet
  7144. href=\"../other/mystyle.css\"
  7145. type=\"text/css\">")))
  7146. @end lisp
  7147. @node Complex example, , Simple example, Sample configuration
  7148. @subsection Example: complex publishing configuration
  7149. This more complicated example publishes an entire website, including
  7150. org files converted to HTML, image files, emacs lisp source code, and
  7151. style sheets. The publishing-directory is remote and private files are
  7152. excluded.
  7153. To ensure that links are preserved, care should be taken to replicate
  7154. your directory structure on the web server, and to use relative file
  7155. paths. For example, if your org files are kept in @file{~/org} and your
  7156. publishable images in @file{~/images}, you'd link to an image with
  7157. @c
  7158. @example
  7159. file:../images/myimage.png
  7160. @end example
  7161. @c
  7162. On the web server, the relative path to the image should be the
  7163. same. You can accomplish this by setting up an "images" folder in the
  7164. right place on the web server, and publishing images to it.
  7165. @lisp
  7166. (setq org-publish-project-alist
  7167. '(("orgfiles"
  7168. :base-directory "~/org/"
  7169. :base-extension "org"
  7170. :publishing-directory "/ssh:user@@host:~/html/notebook/"
  7171. :publishing-function org-publish-org-to-html
  7172. :exclude "PrivatePage.org" ;; regexp
  7173. :headline-levels 3
  7174. :section-numbers nil
  7175. :table-of-contents nil
  7176. :style "<link rel=stylesheet
  7177. href=\"../other/mystyle.css\" type=\"text/css\">"
  7178. :auto-preamble t
  7179. :auto-postamble nil)
  7180. ("images"
  7181. :base-directory "~/images/"
  7182. :base-extension "jpg\\|gif\\|png"
  7183. :publishing-directory "/ssh:user@@host:~/html/images/"
  7184. :publishing-function org-publish-attachment)
  7185. ("other"
  7186. :base-directory "~/other/"
  7187. :base-extension "css\\|el"
  7188. :publishing-directory "/ssh:user@@host:~/html/other/"
  7189. :publishing-function org-publish-attachment)
  7190. ("website" :components ("orgfiles" "images" "other"))))
  7191. @end lisp
  7192. @node Triggering publication, , Sample configuration, Publishing
  7193. @section Triggering publication
  7194. Once org-publish is properly configured, you can publish with the
  7195. following functions:
  7196. @table @kbd
  7197. @item C-c C-e C
  7198. Prompt for a specific project and publish all files that belong to it.
  7199. @item C-c C-e P
  7200. Publish the project containing the current file.
  7201. @item C-c C-e F
  7202. Publish only the current file.
  7203. @item C-c C-e A
  7204. Publish all projects.
  7205. @end table
  7206. Org uses timestamps to track when a file has changed. The above
  7207. functions normally only publish changed files. You can override this and
  7208. force publishing of all files by giving a prefix argument.
  7209. @node Miscellaneous, Extensions, Publishing, Top
  7210. @chapter Miscellaneous
  7211. @menu
  7212. * Completion:: M-TAB knows what you need
  7213. * Customization:: Adapting Org to your taste
  7214. * In-buffer settings:: Overview of the #+KEYWORDS
  7215. * The very busy C-c C-c key:: When in doubt, press C-c C-c
  7216. * Clean view:: Getting rid of leading stars in the outline
  7217. * TTY keys:: Using Org on a tty
  7218. * Interaction:: Other Emacs packages
  7219. * Bugs:: Things which do not work perfectly
  7220. @end menu
  7221. @node Completion, Customization, Miscellaneous, Miscellaneous
  7222. @section Completion
  7223. @cindex completion, of @TeX{} symbols
  7224. @cindex completion, of TODO keywords
  7225. @cindex completion, of dictionary words
  7226. @cindex completion, of option keywords
  7227. @cindex completion, of tags
  7228. @cindex completion, of property keys
  7229. @cindex completion, of link abbreviations
  7230. @cindex @TeX{} symbol completion
  7231. @cindex TODO keywords completion
  7232. @cindex dictionary word completion
  7233. @cindex option keyword completion
  7234. @cindex tag completion
  7235. @cindex link abbreviations, completion of
  7236. Org supports in-buffer completion. This type of completion does
  7237. not make use of the minibuffer. You simply type a few letters into
  7238. the buffer and use the key to complete text right there.
  7239. @table @kbd
  7240. @kindex M-@key{TAB}
  7241. @item M-@key{TAB}
  7242. Complete word at point
  7243. @itemize @bullet
  7244. @item
  7245. At the beginning of a headline, complete TODO keywords.
  7246. @item
  7247. After @samp{\}, complete @TeX{} symbols supported by the exporter.
  7248. @item
  7249. After @samp{*}, complete headlines in the current buffer so that they
  7250. can be used in search links like @samp{[[*find this headline]]}.
  7251. @item
  7252. After @samp{:} in a headline, complete tags. The list of tags is taken
  7253. from the variable @code{org-tag-alist} (possibly set through the
  7254. @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
  7255. dynamically from all tags used in the current buffer.
  7256. @item
  7257. After @samp{:} and not in a headline, complete property keys. The list
  7258. of keys is constructed dynamically from all keys used in the current
  7259. buffer.
  7260. @item
  7261. After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
  7262. @item
  7263. After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
  7264. @samp{OPTIONS} which set file-specific options for Org mode. When the
  7265. option keyword is already complete, pressing @kbd{M-@key{TAB}} again
  7266. will insert example settings for this keyword.
  7267. @item
  7268. In the line after @samp{#+STARTUP: }, complete startup keywords,
  7269. i.e. valid keys for this line.
  7270. @item
  7271. Elsewhere, complete dictionary words using Ispell.
  7272. @end itemize
  7273. @end table
  7274. @node Customization, In-buffer settings, Completion, Miscellaneous
  7275. @section Customization
  7276. @cindex customization
  7277. @cindex options, for customization
  7278. @cindex variables, for customization
  7279. There are more than 180 variables that can be used to customize
  7280. Org. For the sake of compactness of the manual, I am not
  7281. describing the variables here. A structured overview of customization
  7282. variables is available with @kbd{M-x org-customize}. Or select
  7283. @code{Browse Org Group} from the @code{Org->Customization} menu. Many
  7284. settings can also be activated on a per-file basis, by putting special
  7285. lines into the buffer (@pxref{In-buffer settings}).
  7286. @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
  7287. @section Summary of in-buffer settings
  7288. @cindex in-buffer settings
  7289. @cindex special keywords
  7290. Org mode uses special lines in the buffer to define settings on a
  7291. per-file basis. These lines start with a @samp{#+} followed by a
  7292. keyword, a colon, and then individual words defining a setting. Several
  7293. setting words can be in the same line, but you can also have multiple
  7294. lines for the keyword. While these settings are described throughout
  7295. the manual, here is a summary. After changing any of those lines in the
  7296. buffer, press @kbd{C-c C-c} with the cursor still in the line to
  7297. activate the changes immediately. Otherwise they become effective only
  7298. when the file is visited again in a new Emacs session.
  7299. @table @kbd
  7300. @item #+ARCHIVE: %s_done::
  7301. This line sets the archive location for the agenda file. It applies for
  7302. all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
  7303. of the file. The first such line also applies to any entries before it.
  7304. The corresponding variable is @code{org-archive-location}.
  7305. @item #+CATEGORY:
  7306. This line sets the category for the agenda file. The category applies
  7307. for all subsequent lines until the next @samp{#+CATEGORY} line, or the
  7308. end of the file. The first such line also applies to any entries before it.
  7309. @item #+COLUMNS: %25ITEM .....
  7310. Set the default format for columns view. This format applies when
  7311. columns view is invoked in location where no @code{COLUMNS} property
  7312. applies.
  7313. @item #+CONSTANTS: name1=value1 ...
  7314. Set file-local values for constants to be used in table formulas. This
  7315. line set the local variable @code{org-table-formula-constants-local}.
  7316. The global version of this variable is
  7317. @code{org-table-formula-constants}.
  7318. @item #+FILETAGS: :tag1:tag2:tag3:
  7319. Set tags that can be inherited by any entry in the file, including the
  7320. top-level entries.
  7321. @item #+DRAWERS: NAME1 .....
  7322. Set the file-local set of drawers. The corresponding global variable is
  7323. @code{org-drawers}.
  7324. @item #+LINK: linkword replace
  7325. These lines (several are allowed) specify link abbreviations.
  7326. @xref{Link abbreviations}. The corresponding variable is
  7327. @code{org-link-abbrev-alist}.
  7328. @item #+PRIORITIES: highest lowest default
  7329. This line sets the limits and the default for the priorities. All three
  7330. must be either letters A-Z or numbers 0-9. The highest priority must
  7331. have a lower ASCII number that the lowest priority.
  7332. @item #+PROPERTY: Property_Name Value
  7333. This line sets a default inheritance value for entries in the current
  7334. buffer, most useful for specifying the allowed values of a property.
  7335. @item #+SETUPFILE: file
  7336. This line defines a file that holds more in-buffer setup. Normally this is
  7337. entirely ignored. Only when the buffer is parsed for option-setting lines
  7338. (i.e. when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
  7339. settings line, or when exporting), then the contents of this file are parsed
  7340. as if they had been included in the buffer. In particlar, the file can be
  7341. any other Org mode file with internal setup. You can visit the file the
  7342. cursor is in the line with @kbd{C-c '}.
  7343. @item #+STARTUP:
  7344. This line sets options to be used at startup of Org mode, when an
  7345. Org file is being visited. The first set of options deals with the
  7346. initial visibility of the outline tree. The corresponding variable for
  7347. global default settings is @code{org-startup-folded}, with a default
  7348. value @code{t}, which means @code{overview}.
  7349. @cindex @code{overview}, STARTUP keyword
  7350. @cindex @code{content}, STARTUP keyword
  7351. @cindex @code{showall}, STARTUP keyword
  7352. @example
  7353. overview @r{top-level headlines only}
  7354. content @r{all headlines}
  7355. showall @r{no folding at all, show everything}
  7356. @end example
  7357. Then there are options for aligning tables upon visiting a file. This
  7358. is useful in files containing narrowed table columns. The corresponding
  7359. variable is @code{org-startup-align-all-tables}, with a default value
  7360. @code{nil}.
  7361. @cindex @code{align}, STARTUP keyword
  7362. @cindex @code{noalign}, STARTUP keyword
  7363. @example
  7364. align @r{align all tables}
  7365. noalign @r{don't align tables on startup}
  7366. @end example
  7367. Logging closing and reinstating TODO items, and clock intervals
  7368. (variables @code{org-log-done}, @code{org-log-note-clock-out}, and
  7369. @code{org-log-repeat}) can be configured using these options.
  7370. @cindex @code{logdone}, STARTUP keyword
  7371. @cindex @code{lognotedone}, STARTUP keyword
  7372. @cindex @code{nologdone}, STARTUP keyword
  7373. @cindex @code{lognoteclock-out}, STARTUP keyword
  7374. @cindex @code{nolognoteclock-out}, STARTUP keyword
  7375. @cindex @code{logrepeat}, STARTUP keyword
  7376. @cindex @code{lognoterepeat}, STARTUP keyword
  7377. @cindex @code{nologrepeat}, STARTUP keyword
  7378. @example
  7379. logdone @r{record a timestamp when an item is marked DONE}
  7380. lognotedone @r{record timestamp and a note when DONE}
  7381. nologdone @r{don't record when items are marked DONE}
  7382. logrepeat @r{record a time when reinstating a repeating item}
  7383. lognoterepeat @r{record a note when reinstating a repeating item}
  7384. nologrepeat @r{do not record when reinstating repeating item}
  7385. lognoteclock-out @r{record a note when clocking out}
  7386. nolognoteclock-out @r{don't record a note when clocking out}
  7387. @end example
  7388. Here are the options for hiding leading stars in outline headings, and for
  7389. indenting outlines. The corresponding variables are
  7390. @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
  7391. default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
  7392. @cindex @code{hidestars}, STARTUP keyword
  7393. @cindex @code{showstars}, STARTUP keyword
  7394. @cindex @code{odd}, STARTUP keyword
  7395. @cindex @code{even}, STARTUP keyword
  7396. @example
  7397. hidestars @r{make all but one of the stars starting a headline invisible.}
  7398. showstars @r{show all stars starting a headline}
  7399. indent @r{virtual indentation according to outline level}
  7400. noindent @r{no virtual indentation according to outline level}
  7401. odd @r{allow only odd outline levels (1,3,...)}
  7402. oddeven @r{allow all outline levels}
  7403. @end example
  7404. To turn on custom format overlays over time stamps (variables
  7405. @code{org-put-time-stamp-overlays} and
  7406. @code{org-time-stamp-overlay-formats}), use
  7407. @cindex @code{customtime}, STARTUP keyword
  7408. @example
  7409. customtime @r{overlay custom time format}
  7410. @end example
  7411. The following options influence the table spreadsheet (variable
  7412. @code{constants-unit-system}).
  7413. @cindex @code{constcgs}, STARTUP keyword
  7414. @cindex @code{constSI}, STARTUP keyword
  7415. @example
  7416. constcgs @r{@file{constants.el} should use the c-g-s unit system}
  7417. constSI @r{@file{constants.el} should use the SI unit system}
  7418. @end example
  7419. @item #+TAGS: TAG1(c1) TAG2(c2)
  7420. These lines (several such lines are allowed) specify the valid tags in
  7421. this file, and (potentially) the corresponding @emph{fast tag selection}
  7422. keys. The corresponding variable is @code{org-tag-alist}.
  7423. @item #+TBLFM:
  7424. This line contains the formulas for the table directly above the line.
  7425. @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+OPTIONS, #+DATE:
  7426. These lines provide settings for exporting files. For more details see
  7427. @ref{Export options}.
  7428. @item #+SEQ_TODO: #+TYP_TODO:
  7429. These lines set the TODO keywords and their interpretation in the
  7430. current file. The corresponding variables are @code{org-todo-keywords}
  7431. and @code{org-todo-interpretation}.
  7432. @end table
  7433. @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
  7434. @section The very busy C-c C-c key
  7435. @kindex C-c C-c
  7436. @cindex C-c C-c, overview
  7437. The key @kbd{C-c C-c} has many purposes in Org, which are all
  7438. mentioned scattered throughout this manual. One specific function of
  7439. this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
  7440. other circumstances it means something like @emph{Hey Org, look
  7441. here and update according to what you see here}. Here is a summary of
  7442. what this means in different contexts.
  7443. @itemize @minus
  7444. @item
  7445. If there are highlights in the buffer from the creation of a sparse
  7446. tree, or from clock display, remove these highlights.
  7447. @item
  7448. If the cursor is in one of the special @code{#+KEYWORD} lines, this
  7449. triggers scanning the buffer for these lines and updating the
  7450. information.
  7451. @item
  7452. If the cursor is inside a table, realign the table. This command
  7453. works even if the automatic table editor has been turned off.
  7454. @item
  7455. If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
  7456. the entire table.
  7457. @item
  7458. If the cursor is inside a table created by the @file{table.el} package,
  7459. activate that table.
  7460. @item
  7461. If the current buffer is a remember buffer, close the note and file it.
  7462. With a prefix argument, file it, without further interaction, to the
  7463. default location.
  7464. @item
  7465. If the cursor is on a @code{<<<target>>>}, update radio targets and
  7466. corresponding links in this buffer.
  7467. @item
  7468. If the cursor is in a property line or at the start or end of a property
  7469. drawer, offer property commands.
  7470. @item
  7471. If the cursor is in a plain list item with a checkbox, toggle the status
  7472. of the checkbox.
  7473. @item
  7474. If the cursor is on a numbered item in a plain list, renumber the
  7475. ordered list.
  7476. @item
  7477. If the cursor is on the @code{#+BEGIN} line of a dynamical block, the
  7478. block is updated.
  7479. @end itemize
  7480. @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
  7481. @section A cleaner outline view
  7482. @cindex hiding leading stars
  7483. @cindex dynamic indentation
  7484. @cindex odd-levels-only outlines
  7485. @cindex clean outline view
  7486. Some people find it noisy and distracting that the Org headlines are starting
  7487. with a potentially large number of stars, and that text below the headlines
  7488. is not indented. This is not really a problem when you are writing a book
  7489. where the outline headings are really section headlines. However, in a more
  7490. list-oriented outline, it is clear that an indented structure is a lot
  7491. cleaner, as can be seen by comparing the two columns in the following
  7492. example:
  7493. @example
  7494. @group
  7495. * Top level headline | * Top level headline
  7496. ** Second level | * Second level
  7497. *** 3rd level | * 3rd level
  7498. some text | some text
  7499. *** 3rd level | * 3rd level
  7500. more text | more text
  7501. * Another top level headline | * Another top level headline
  7502. @end group
  7503. @end example
  7504. @noindent
  7505. It is non-trivial to make such a look work in Emacs, but Org contains three
  7506. separate features that, combined, achieve just that.
  7507. @enumerate
  7508. @item
  7509. @emph{Indentation of text below headlines}@*
  7510. You may indent text below each headline to make the left boundary line up
  7511. with the headline, like
  7512. @example
  7513. *** 3rd level
  7514. more text, now indented
  7515. @end example
  7516. A good way to get this indentation is by hand, and Org supports this with
  7517. paragraph filling, line wrapping, and structure editing@footnote{See also the
  7518. variable @code{org-adapt-indentation}.} preserving or adapting the
  7519. indentation appropriate. A different approach would be to have a way to
  7520. automatically indent lines according to outline structure by adding overlays
  7521. or text properties. But I have not yet found a robust and efficient way to
  7522. do this in large files.
  7523. @item
  7524. @emph{Hiding leading stars}@* You can modify the display in such a way that
  7525. all leading stars become invisible. To do this in a global way, configure
  7526. the variable @code{org-hide-leading-stars} or change this on a per-file basis
  7527. with
  7528. @example
  7529. #+STARTUP: hidestars
  7530. @end example
  7531. @noindent
  7532. Note that the opposite behavior is selected with @code{showstars}.
  7533. With hidden stars, the tree becomes:
  7534. @example
  7535. @group
  7536. * Top level headline
  7537. * Second level
  7538. * 3rd level
  7539. ...
  7540. @end group
  7541. @end example
  7542. @noindent
  7543. Note that the leading stars are not truly replaced by whitespace, they
  7544. are only fontified with the face @code{org-hide} that uses the
  7545. background color as font color. If you are not using either white or
  7546. black background, you may have to customize this face to get the wanted
  7547. effect. Another possibility is to set this font such that the extra
  7548. stars are @i{almost} invisible, for example using the color
  7549. @code{grey90} on a white background.
  7550. @item
  7551. Things become cleaner still if you skip all the even levels and use only odd
  7552. levels 1, 3, 5..., effectively adding two stars to go from one outline level
  7553. to the next. In this way we get the outline view shown at the beginning of
  7554. this section. In order to make the structure editing and export commands
  7555. handle this convention correctly, configure the variable
  7556. @code{org-odd-levels-only}, or set this on a per-file basis with one of the
  7557. following lines:
  7558. @example
  7559. #+STARTUP: odd
  7560. #+STARTUP: oddeven
  7561. @end example
  7562. You can convert an Org file from single-star-per-level to the
  7563. double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
  7564. RET} in that file. The reverse operation is @kbd{M-x
  7565. org-convert-to-oddeven-levels}.
  7566. @end enumerate
  7567. @node TTY keys, Interaction, Clean view, Miscellaneous
  7568. @section Using Org on a tty
  7569. @cindex tty key bindings
  7570. Because Org contains a large number of commands, by default much of
  7571. Org's core commands are bound to keys that are generally not
  7572. accessible on a tty, such as the cursor keys (@key{left}, @key{right},
  7573. @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
  7574. together with modifiers like @key{Meta} and/or @key{Shift}. To access
  7575. these commands on a tty when special keys are unavailable, the following
  7576. alternative bindings can be used. The tty bindings below will likely be
  7577. more cumbersome; you may find for some of the bindings below that a
  7578. customized work-around suits you better. For example, changing a time
  7579. stamp is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
  7580. tty you would rather use @kbd{C-c .} to re-insert the timestamp.
  7581. @multitable @columnfractions 0.15 0.2 0.2
  7582. @item @b{Default} @tab @b{Alternative 1} @tab @b{Alternative 2}
  7583. @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab
  7584. @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{@key{Esc} @key{left}}
  7585. @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab
  7586. @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{@key{Esc} @key{right}}
  7587. @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab
  7588. @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{@key{Esc} @key{up}}
  7589. @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab
  7590. @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{@key{Esc} @key{down}}
  7591. @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab
  7592. @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab
  7593. @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{@key{Esc} @key{RET}}
  7594. @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab
  7595. @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab
  7596. @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab
  7597. @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab
  7598. @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab
  7599. @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab
  7600. @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab
  7601. @end multitable
  7602. @node Interaction, Bugs, TTY keys, Miscellaneous
  7603. @section Interaction with other packages
  7604. @cindex packages, interaction with other
  7605. Org lives in the world of GNU Emacs and interacts in various ways
  7606. with other code out there.
  7607. @menu
  7608. * Cooperation:: Packages Org cooperates with
  7609. * Conflicts:: Packages that lead to conflicts
  7610. @end menu
  7611. @node Cooperation, Conflicts, Interaction, Interaction
  7612. @subsection Packages that Org cooperates with
  7613. @table @asis
  7614. @cindex @file{calc.el}
  7615. @item @file{calc.el} by Dave Gillespie
  7616. Org uses the Calc package for implementing spreadsheet
  7617. functionality in its tables (@pxref{The spreadsheet}). Org
  7618. checks for the availability of Calc by looking for the function
  7619. @code{calc-eval} which should be autoloaded in your setup if Calc has
  7620. been installed properly. As of Emacs 22, Calc is part of the Emacs
  7621. distribution. Another possibility for interaction between the two
  7622. packages is using Calc for embedded calculations. @xref{Embedded Mode,
  7623. , Embedded Mode, Calc, GNU Emacs Calc Manual}.
  7624. @cindex @file{constants.el}
  7625. @item @file{constants.el} by Carsten Dominik
  7626. In a table formula (@pxref{The spreadsheet}), it is possible to use
  7627. names for natural constants or units. Instead of defining your own
  7628. constants in the variable @code{org-table-formula-constants}, install
  7629. the @file{constants} package which defines a large number of constants
  7630. and units, and lets you use unit prefixes like @samp{M} for
  7631. @samp{Mega} etc. You will need version 2.0 of this package, available
  7632. at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
  7633. the function @code{constants-get}, which has to be autoloaded in your
  7634. setup. See the installation instructions in the file
  7635. @file{constants.el}.
  7636. @item @file{cdlatex.el} by Carsten Dominik
  7637. @cindex @file{cdlatex.el}
  7638. Org mode can make use of the CDLaTeX package to efficiently enter
  7639. La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}.
  7640. @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
  7641. @cindex @file{imenu.el}
  7642. Imenu allows menu access to an index of items in a file. Org mode
  7643. supports Imenu - all you need to do to get the index is the following:
  7644. @lisp
  7645. (add-hook 'org-mode-hook
  7646. (lambda () (imenu-add-to-menubar "Imenu")))
  7647. @end lisp
  7648. By default the index is two levels deep - you can modify the depth using
  7649. the option @code{org-imenu-depth}.
  7650. @item @file{remember.el} by John Wiegley
  7651. @cindex @file{remember.el}
  7652. Org cooperates with remember, see @ref{Remember}.
  7653. @file{Remember.el} is not part of Emacs, find it on the web.
  7654. @item @file{speedbar.el} by Eric M. Ludlam
  7655. @cindex @file{speedbar.el}
  7656. Speedbar is a package that creates a special frame displaying files and
  7657. index items in files. Org mode supports Speedbar and allows you to
  7658. drill into Org files directly from the Speedbar. It also allows to
  7659. restrict the scope of agenda commands to a file or a subtree by using
  7660. the command @kbd{<} in the Speedbar frame.
  7661. @cindex @file{table.el}
  7662. @item @file{table.el} by Takaaki Ota
  7663. @kindex C-c C-c
  7664. @cindex table editor, @file{table.el}
  7665. @cindex @file{table.el}
  7666. Complex ASCII tables with automatic line wrapping, column- and
  7667. row-spanning, and alignment can be created using the Emacs table
  7668. package by Takaaki Ota (@uref{http://sourceforge.net/projects/table},
  7669. and also part of Emacs 22).
  7670. When @key{TAB} or @kbd{C-c C-c} is pressed in such a table, Org mode
  7671. will call @command{table-recognize-table} and move the cursor into the
  7672. table. Inside a table, the keymap of Org mode is inactive. In order
  7673. to execute Org mode-related commands, leave the table.
  7674. @table @kbd
  7675. @kindex C-c C-c
  7676. @item C-c C-c
  7677. Recognize @file{table.el} table. Works when the cursor is in a
  7678. table.el table.
  7679. @c
  7680. @kindex C-c ~
  7681. @item C-c ~
  7682. Insert a table.el table. If there is already a table at point, this
  7683. command converts it between the table.el format and the Org mode
  7684. format. See the documentation string of the command
  7685. @code{org-convert-table} for the restrictions under which this is
  7686. possible.
  7687. @end table
  7688. @file{table.el} is part of Emacs 22.
  7689. @cindex @file{footnote.el}
  7690. @item @file{footnote.el} by Steven L. Baur
  7691. Org mode recognizes numerical footnotes as provided by this package
  7692. (@pxref{Footnotes}).
  7693. @end table
  7694. @node Conflicts, , Cooperation, Interaction
  7695. @subsection Packages that lead to conflicts with Org mode
  7696. @table @asis
  7697. @cindex @file{allout.el}
  7698. @item @file{allout.el} by Ken Manheimer
  7699. Startup of Org may fail with the error message
  7700. @code{(wrong-type-argument keymapp nil)} when there is an outdated
  7701. version @file{allout.el} on the load path, for example the version
  7702. distributed with Emacs 21.x. Upgrade to Emacs 22 and this problem will
  7703. disappear. If for some reason you cannot do this, make sure that org.el
  7704. is loaded @emph{before} @file{allout.el}, for example by putting
  7705. @code{(require 'org)} early enough into your @file{.emacs} file.
  7706. @cindex @file{CUA.el}
  7707. @item @file{CUA.el} by Kim. F. Storm
  7708. Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by
  7709. CUA mode (as well as pc-select-mode and s-region-mode) to select and
  7710. extend the region. If you want to use one of these packages along with
  7711. Org, configure the variable @code{org-replace-disputed-keys}. When
  7712. set, Org will move the following key bindings in Org files, and
  7713. in the agenda buffer (but not during date selection).
  7714. @example
  7715. S-UP -> M-p S-DOWN -> M-n
  7716. S-LEFT -> M-- S-RIGHT -> M-+
  7717. @end example
  7718. Yes, these are unfortunately more difficult to remember. If you want
  7719. to have other replacement keys, look at the variable
  7720. @code{org-disputed-keys}.
  7721. @item @file{windmove.el} by Hovav Shacham
  7722. @cindex @file{windmove.el}
  7723. Also this package uses the @kbd{S-<cursor>} keys, so everything written
  7724. in the paragraph above about CUA mode also applies here.
  7725. @cindex @file{footnote.el}
  7726. @item @file{footnote.el} by Steven L. Baur
  7727. Org supports the syntax of the footnote package, but only the
  7728. numerical footnote markers. Also, the default key for footnote
  7729. commands, @kbd{C-c !} is already used by Org. You could use the
  7730. variable @code{footnote-prefix} to switch footnotes commands to another
  7731. key. Or, you could use @code{org-replace-disputed-keys} and
  7732. @code{org-disputed-keys} to change the settings in Org.
  7733. @end table
  7734. @node Bugs, , Interaction, Miscellaneous
  7735. @section Bugs
  7736. @cindex bugs
  7737. Here is a list of things that should work differently, but which I
  7738. have found too hard to fix.
  7739. @itemize @bullet
  7740. @item
  7741. If a table field starts with a link, and if the corresponding table
  7742. column is narrowed (@pxref{Narrow columns}) to a width too small to
  7743. display the link, the field would look entirely empty even though it is
  7744. not. To prevent this, Org throws an error. The work-around is to
  7745. make the column wide enough to fit the link, or to add some text (at
  7746. least 2 characters) before the link in the same field.
  7747. @item
  7748. Narrowing table columns does not work on XEmacs, because the
  7749. @code{format} function does not transport text properties.
  7750. @item
  7751. Text in an entry protected with the @samp{QUOTE} keyword should not
  7752. autowrap.
  7753. @item
  7754. When the application called by @kbd{C-c C-o} to open a file link fails
  7755. (for example because the application does not exist or refuses to open
  7756. the file), it does so silently. No error message is displayed.
  7757. @item
  7758. Recalculating a table line applies the formulas from left to right.
  7759. If a formula uses @emph{calculated} fields further down the row,
  7760. multiple recalculation may be needed to get all fields consistent. You
  7761. may use the command @code{org-table-iterate} (@kbd{C-u C-c *}) to
  7762. recalculate until convergence.
  7763. @item
  7764. The exporters work well, but could be made more efficient.
  7765. @end itemize
  7766. @node Extensions, Hacking, Miscellaneous, Top
  7767. @appendix Extensions
  7768. This appendix lists the extension modules that have been written for Org.
  7769. Many of these extensions live in the @file{contrib} directory of the Org
  7770. distribution, others are available somewhere on the web.
  7771. @menu
  7772. * Extensions in the contrib directory:: These come with the Org distro
  7773. * Other extensions:: These you have to find on the web.
  7774. @end menu
  7775. @node Extensions in the contrib directory, Other extensions, Extensions, Extensions
  7776. @section Extensions in the @file{contrib} directory
  7777. @table @asis
  7778. @item @file{org-annotate-file.el} by @i{Philip Jackson}
  7779. Annotate a file with org syntax, in a separate file, with links back to
  7780. the annotated file.
  7781. @item @file{org-annotation-helper.el} by @i{Bastien Guerry and Daniel E. German}
  7782. Call @i{remember} directly from Firefox/Opera, or from Adobe Reader.
  7783. When activating a special link or bookmark, Emacs receives a trigger to
  7784. create a note with a link back to the website. Requires some setup, a
  7785. detailes description is in
  7786. @file{contrib/packages/org-annotation-helper}.
  7787. @item @file{org-bookmark.el} by @i{Tokuya Kameshima}
  7788. Support for links to Emacs bookmarks.
  7789. @item @file{org-depend.el} by @i{Carsten Dominik}
  7790. TODO dependencies for Org-mode. Make TODO state changes in one entry
  7791. trigger changes in another, or be blocked by the state of another
  7792. entry. Also, easily create chains of TODO items with exactly one
  7793. active item at any time.
  7794. @item @file{org-elisp-symbol.el} by @i{Bastien Guerry}
  7795. Org links to emacs-lisp symbols. This can create annotated links that
  7796. exactly point to the definition location of a variable of function.
  7797. @item @file{org-eval.el} by @i{Carsten Dominik}
  7798. The @code{<lisp>} tag, adapted from Emacs Wiki and Emacs Muse, allows
  7799. to include text in a document that is the result of evaluating some
  7800. code. Other scripting languages like @code{perl} can be supported with
  7801. this package as well.
  7802. @item @file{org-expiry.el} by @i{Bastien Guerry}
  7803. Expiry mechanism for Org entries.
  7804. @item @file{org-indent.el} by @i{Carsten Dominik}
  7805. Dynamic indentation of Org outlines. The plan is to indent an outline
  7806. according to level, but so far this is too hard for a proper and stable
  7807. implementation. Still, it works somewhat.
  7808. @item @file{org-interactive-query.el} by @i{Christopher League}
  7809. Interactive modification of tags queries. After running a general
  7810. query in Org, this package allows to narrow down the results by adding
  7811. more tags or keywords.
  7812. @item @file{org-mairix.el} by @i{Georg C. F. Greve}
  7813. Hook mairix search into Org for different MUAs.
  7814. @item @file{org-man.el} by @i{Carsten Dominik}
  7815. Support for links to manpages in Org-mode.
  7816. @item @file{org-mtags.el} by @i{Carsten Dominik}
  7817. Support for some Muse-like tags in Org-mode. This package allows you
  7818. to write @code{<example>} and @code{<src>} and other syntax copied from
  7819. Emacs Muse, right inside an Org file. The goal here is to make it easy
  7820. to publish the same file using either org-publish or Muse.
  7821. @item @file{org-panel.el} by @i{Lennard Borgman}
  7822. Simplified and display-aided access to some Org commands.
  7823. @c @item @file{org-plot.el} by @i{Eric Schulte}
  7824. @c Plotting Org tables with Gnuplot.
  7825. @item @file{org-registry.el} by @i{Bastien Guerry}
  7826. A registry for Org links, to find out from where links point to a given
  7827. file or location.
  7828. @item @file{org2rem.el} by @i{Bastien Guerry}
  7829. Convert org appointments into reminders for the @file{remind} program.
  7830. @item @file{org-screen.el} by @i{Andrew Hyatt}
  7831. Visit screen sessions through Org-mode links.
  7832. @item @file{org-toc.el} by @i{Bastien Guerry}
  7833. Table of contents in a separate buffer, with fast access to sections
  7834. and easy visibility cycling.
  7835. @item @file{orgtbl-sqlinsert.el} by @i{Jason Riedy}
  7836. Convert Org-mode tables to SQL insertions. Documentation for this can
  7837. be found on the Worg pages.
  7838. @end table
  7839. @node Other extensions, , Extensions in the contrib directory, Extensions
  7840. @section Other extensions
  7841. @i{TO BE DONE}
  7842. @node Hacking, History and Acknowledgments, Extensions, Top
  7843. @appendix Hacking
  7844. This appendix covers some aspects where users can extend the functionality of
  7845. Org.
  7846. @menu
  7847. * Adding hyperlink types:: New custom link types
  7848. * Tables in arbitrary syntax:: Orgtbl for LaTeX and other programs
  7849. * Dynamic blocks:: Automatically filled blocks
  7850. * Special agenda views:: Customized views
  7851. * Using the property API:: Writing programs that use entry properties
  7852. * Using the mapping API:: Mapping over all or selected entries
  7853. @end menu
  7854. @node Adding hyperlink types, Tables in arbitrary syntax, Hacking, Hacking
  7855. @section Adding hyperlink types
  7856. @cindex hyperlinks, adding new types
  7857. Org has a large number of hyperlink types built-in
  7858. (@pxref{Hyperlinks}). If you would like to add new link types, it
  7859. provides an interface for doing so. Let's look at an example file
  7860. @file{org-man.el} that will add support for creating links like
  7861. @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
  7862. emacs:
  7863. @lisp
  7864. ;;; org-man.el - Support for links to manpages in Org
  7865. (require 'org)
  7866. (org-add-link-type "man" 'org-man-open)
  7867. (add-hook 'org-store-link-functions 'org-man-store-link)
  7868. (defcustom org-man-command 'man
  7869. "The Emacs command to be used to display a man page."
  7870. :group 'org-link
  7871. :type '(choice (const man) (const woman)))
  7872. (defun org-man-open (path)
  7873. "Visit the manpage on PATH.
  7874. PATH should be a topic that can be thrown at the man command."
  7875. (funcall org-man-command path))
  7876. (defun org-man-store-link ()
  7877. "Store a link to a manpage."
  7878. (when (memq major-mode '(Man-mode woman-mode))
  7879. ;; This is a man page, we do make this link
  7880. (let* ((page (org-man-get-page-name))
  7881. (link (concat "man:" page))
  7882. (description (format "Manpage for %s" page)))
  7883. (org-store-link-props
  7884. :type "man"
  7885. :link link
  7886. :description description))))
  7887. (defun org-man-get-page-name ()
  7888. "Extract the page name from the buffer name."
  7889. ;; This works for both `Man-mode' and `woman-mode'.
  7890. (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
  7891. (match-string 1 (buffer-name))
  7892. (error "Cannot create link to this man page")))
  7893. (provide 'org-man)
  7894. ;;; org-man.el ends here
  7895. @end lisp
  7896. @noindent
  7897. You would activate this new link type in @file{.emacs} with
  7898. @lisp
  7899. (require 'org-man)
  7900. @end lisp
  7901. @noindent
  7902. Let's go through the file and see what it does.
  7903. @enumerate
  7904. @item
  7905. It does @code{(require 'org)} to make sure that @file{org.el} has been
  7906. loaded.
  7907. @item
  7908. The next line calls @code{org-add-link-type} to define a new link type
  7909. with prefix @samp{man}. The call also contains the name of a function
  7910. that will be called to follow such a link.
  7911. @item
  7912. The next line adds a function to @code{org-store-link-functions}, in
  7913. order to allow the command @kbd{C-c l} to record a useful link in a
  7914. buffer displaying a man page.
  7915. @end enumerate
  7916. The rest of the file defines the necessary variables and functions.
  7917. First there is a customization variable that determines which emacs
  7918. command should be used to display man pages. There are two options,
  7919. @code{man} and @code{woman}. Then the function to follow a link is
  7920. defined. It gets the link path as an argument - in this case the link
  7921. path is just a topic for the manual command. The function calls the
  7922. value of @code{org-man-command} to display the man page.
  7923. Finally the function @code{org-man-store-link} is defined. When you try
  7924. to store a link with @kbd{C-c l}, also this function will be called to
  7925. try to make a link. The function must first decide if it is supposed to
  7926. create the link for this buffer type, we do this by checking the value
  7927. of the variable @code{major-mode}. If not, the function must exit and
  7928. return the value @code{nil}. If yes, the link is created by getting the
  7929. manual topic from the buffer name and prefixing it with the string
  7930. @samp{man:}. Then it must call the command @code{org-store-link-props}
  7931. and set the @code{:type} and @code{:link} properties. Optionally you
  7932. can also set the @code{:description} property to provide a default for
  7933. the link description when the link is later inserted into an Org
  7934. buffer with @kbd{C-c C-l}.
  7935. @node Tables in arbitrary syntax, Dynamic blocks, Adding hyperlink types, Hacking
  7936. @section Tables and lists in arbitrary syntax
  7937. @cindex tables, in other modes
  7938. @cindex lists, in other modes
  7939. @cindex Orgtbl mode
  7940. Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
  7941. frequent feature request has been to make it work with native tables in
  7942. specific languages, for example La@TeX{}. However, this is extremely
  7943. hard to do in a general way, would lead to a customization nightmare,
  7944. and would take away much of the simplicity of the Orgtbl mode table
  7945. editor.
  7946. This appendix describes a different approach. We keep the Orgtbl mode
  7947. table in its native format (the @i{source table}), and use a custom
  7948. function to @i{translate} the table to the correct syntax, and to
  7949. @i{install} it in the right location (the @i{target table}). This puts
  7950. the burden of writing conversion functions on the user, but it allows
  7951. for a very flexible system.
  7952. Bastien added the ability to do the same with lists. You can use Org's
  7953. facilities to edit and structure lists by turning @code{orgstruct-mode}
  7954. on, then locally exporting such lists in another format (HTML, La@TeX{}
  7955. or Texinfo.)
  7956. @menu
  7957. * Radio tables:: Sending and receiving
  7958. * A LaTeX example:: Step by step, almost a tutorial
  7959. * Translator functions:: Copy and modify
  7960. * Radio lists:: Doing the same for lists
  7961. @end menu
  7962. @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
  7963. @subsection Radio tables
  7964. @cindex radio tables
  7965. To define the location of the target table, you first need to create two
  7966. lines that are comments in the current mode, but contain magic words for
  7967. Orgtbl mode to find. Orgtbl mode will insert the translated table
  7968. between these lines, replacing whatever was there before. For example:
  7969. @example
  7970. /* BEGIN RECEIVE ORGTBL table_name */
  7971. /* END RECEIVE ORGTBL table_name */
  7972. @end example
  7973. @noindent
  7974. Just above the source table, we put a special line that tells
  7975. Orgtbl mode how to translate this table and where to install it. For
  7976. example:
  7977. @example
  7978. #+ORGTBL: SEND table_name translation_function arguments....
  7979. @end example
  7980. @noindent
  7981. @code{table_name} is the reference name for the table that is also used
  7982. in the receiver lines. @code{translation_function} is the Lisp function
  7983. that does the translation. Furthermore, the line can contain a list of
  7984. arguments (alternating key and value) at the end. The arguments will be
  7985. passed as a property list to the translation function for
  7986. interpretation. A few standard parameters are already recognized and
  7987. acted upon before the translation function is called:
  7988. @table @code
  7989. @item :skip N
  7990. Skip the first N lines of the table. Hlines do count as separate lines for
  7991. this parameter!
  7992. @item :skipcols (n1 n2 ...)
  7993. List of columns that should be skipped. If the table has a column with
  7994. calculation marks, that column is automatically discarded as well.
  7995. Please note that the translator function sees the table @emph{after} the
  7996. removal of these columns, the function never knows that there have been
  7997. additional columns.
  7998. @end table
  7999. @noindent
  8000. The one problem remaining is how to keep the source table in the buffer
  8001. without disturbing the normal workings of the file, for example during
  8002. compilation of a C file or processing of a La@TeX{} file. There are a
  8003. number of different solutions:
  8004. @itemize @bullet
  8005. @item
  8006. The table could be placed in a block comment if that is supported by the
  8007. language. For example, in C mode you could wrap the table between
  8008. @samp{/*} and @samp{*/} lines.
  8009. @item
  8010. Sometimes it is possible to put the table after some kind of @i{END}
  8011. statement, for example @samp{\bye} in TeX and @samp{\end@{document@}}
  8012. in La@TeX{}.
  8013. @item
  8014. You can just comment the table line by line whenever you want to process
  8015. the file, and uncomment it whenever you need to edit the table. This
  8016. only sounds tedious - the command @kbd{M-x orgtbl-toggle-comment} does
  8017. make this comment-toggling very easy, in particular if you bind it to a
  8018. key.
  8019. @end itemize
  8020. @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
  8021. @subsection A LaTeX example of radio tables
  8022. @cindex LaTeX, and Orgtbl mode
  8023. The best way to wrap the source table in La@TeX{} is to use the
  8024. @code{comment} environment provided by @file{comment.sty}. It has to be
  8025. activated by placing @code{\usepackage@{comment@}} into the document
  8026. header. Orgtbl mode can insert a radio table skeleton@footnote{By
  8027. default this works only for La@TeX{}, HTML, and Texinfo. Configure the
  8028. variable @code{orgtbl-radio-tables} to install templates for other
  8029. modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
  8030. be prompted for a table name, lets say we use @samp{salesfigures}. You
  8031. will then get the following template:
  8032. @cindex #+ORGTBL: SEND
  8033. @example
  8034. % BEGIN RECEIVE ORGTBL salesfigures
  8035. % END RECEIVE ORGTBL salesfigures
  8036. \begin@{comment@}
  8037. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  8038. | | |
  8039. \end@{comment@}
  8040. @end example
  8041. @noindent
  8042. The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
  8043. @code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it
  8044. into the receiver location with name @code{salesfigures}. You may now
  8045. fill in the table, feel free to use the spreadsheet features@footnote{If
  8046. the @samp{#+TBLFM} line contains an odd number of dollar characters,
  8047. this may cause problems with font-lock in LaTeX mode. As shown in the
  8048. example you can fix this by adding an extra line inside the
  8049. @code{comment} environment that is used to balance the dollar
  8050. expressions. If you are using AUCTeX with the font-latex library, a
  8051. much better solution is to add the @code{comment} environment to the
  8052. variable @code{LaTeX-verbatim-environments}.}:
  8053. @example
  8054. % BEGIN RECEIVE ORGTBL salesfigures
  8055. % END RECEIVE ORGTBL salesfigures
  8056. \begin@{comment@}
  8057. #+ORGTBL: SEND salesfigures orgtbl-to-latex
  8058. | Month | Days | Nr sold | per day |
  8059. |-------+------+---------+---------|
  8060. | Jan | 23 | 55 | 2.4 |
  8061. | Feb | 21 | 16 | 0.8 |
  8062. | March | 22 | 278 | 12.6 |
  8063. #+TBLFM: $4=$3/$2;%.1f
  8064. % $ (optional extra dollar to keep font-lock happy, see footnote)
  8065. \end@{comment@}
  8066. @end example
  8067. @noindent
  8068. When you are done, press @kbd{C-c C-c} in the table to get the converted
  8069. table inserted between the two marker lines.
  8070. Now lets assume you want to make the table header by hand, because you
  8071. want to control how columns are aligned etc. In this case we make sure
  8072. that the table translator does skip the first 2 lines of the source
  8073. table, and tell the command to work as a @i{splice}, i.e. to not produce
  8074. header and footer commands of the target table:
  8075. @example
  8076. \begin@{tabular@}@{lrrr@}
  8077. Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
  8078. % BEGIN RECEIVE ORGTBL salesfigures
  8079. % END RECEIVE ORGTBL salesfigures
  8080. \end@{tabular@}
  8081. %
  8082. \begin@{comment@}
  8083. #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
  8084. | Month | Days | Nr sold | per day |
  8085. |-------+------+---------+---------|
  8086. | Jan | 23 | 55 | 2.4 |
  8087. | Feb | 21 | 16 | 0.8 |
  8088. | March | 22 | 278 | 12.6 |
  8089. #+TBLFM: $4=$3/$2;%.1f
  8090. \end@{comment@}
  8091. @end example
  8092. The La@TeX{} translator function @code{orgtbl-to-latex} is already part of
  8093. Orgtbl mode. It uses a @code{tabular} environment to typeset the table
  8094. and marks horizontal lines with @code{\hline}. Furthermore, it
  8095. interprets the following parameters (see also @ref{Translator functions}):
  8096. @table @code
  8097. @item :splice nil/t
  8098. When set to t, return only table body lines, don't wrap them into a
  8099. tabular environment. Default is nil.
  8100. @item :fmt fmt
  8101. A format to be used to wrap each field, should contain @code{%s} for the
  8102. original field value. For example, to wrap each field value in dollars,
  8103. you could use @code{:fmt "$%s$"}. This may also be a property list with
  8104. column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
  8105. A function of one argument can be used in place of the strings; the
  8106. function must return a formatted string.
  8107. @item :efmt efmt
  8108. Use this format to print numbers with exponentials. The format should
  8109. have @code{%s} twice for inserting mantissa and exponent, for example
  8110. @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
  8111. may also be a property list with column numbers and formats, for example
  8112. @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
  8113. @code{efmt} has been applied to a value, @code{fmt} will also be
  8114. applied. Similar to @code{fmt}, functions of two arguments can be
  8115. supplied instead of strings.
  8116. @end table
  8117. @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
  8118. @subsection Translator functions
  8119. @cindex HTML, and Orgtbl mode
  8120. @cindex translator function
  8121. Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
  8122. (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
  8123. @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
  8124. Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
  8125. code that produces tables during HTML export.}, these all use a generic
  8126. translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
  8127. itself is a very short function that computes the column definitions for the
  8128. @code{tabular} environment, defines a few field and line separators and then
  8129. hands over to the generic translator. Here is the entire code:
  8130. @lisp
  8131. @group
  8132. (defun orgtbl-to-latex (table params)
  8133. "Convert the Orgtbl mode TABLE to LaTeX."
  8134. (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
  8135. org-table-last-alignment ""))
  8136. (params2
  8137. (list
  8138. :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
  8139. :tend "\\end@{tabular@}"
  8140. :lstart "" :lend " \\\\" :sep " & "
  8141. :efmt "%s\\,(%s)" :hline "\\hline")))
  8142. (orgtbl-to-generic table (org-combine-plists params2 params))))
  8143. @end group
  8144. @end lisp
  8145. As you can see, the properties passed into the function (variable
  8146. @var{PARAMS}) are combined with the ones newly defined in the function
  8147. (variable @var{PARAMS2}). The ones passed into the function (i.e. the
  8148. ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
  8149. would like to use the La@TeX{} translator, but wanted the line endings to
  8150. be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
  8151. overrule the default with
  8152. @example
  8153. #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
  8154. @end example
  8155. For a new language, you can either write your own converter function in
  8156. analogy with the La@TeX{} translator, or you can use the generic function
  8157. directly. For example, if you have a language where a table is started
  8158. with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
  8159. started with @samp{!BL!}, ended with @samp{!EL!} and where the field
  8160. separator is a TAB, you could call the generic translator like this (on
  8161. a single line!):
  8162. @example
  8163. #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
  8164. :lstart "!BL! " :lend " !EL!" :sep "\t"
  8165. @end example
  8166. @noindent
  8167. Please check the documentation string of the function
  8168. @code{orgtbl-to-generic} for a full list of parameters understood by
  8169. that function and remember that you can pass each of them into
  8170. @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
  8171. using the generic function.
  8172. Of course you can also write a completely new function doing complicated
  8173. things the generic translator cannot do. A translator function takes
  8174. two arguments. The first argument is the table, a list of lines, each
  8175. line either the symbol @code{hline} or a list of fields. The second
  8176. argument is the property list containing all parameters specified in the
  8177. @samp{#+ORGTBL: SEND} line. The function must return a single string
  8178. containing the formatted table. If you write a generally useful
  8179. translator, please post it on @code{emacs-orgmode@@gnu.org} so that
  8180. others can benefit from your work.
  8181. @node Radio lists, , Translator functions, Tables in arbitrary syntax
  8182. @subsection Radio lists
  8183. @cindex radio lists
  8184. @cindex org-list-insert-radio-list
  8185. Sending and receiving radio lists works exactly the same way than
  8186. sending and receiving radio tables (@pxref{Radio tables}) @footnote{You
  8187. need to load the @code{org-export-latex.el} package to use radio lists
  8188. since the relevant code is there for now.}. As for radio tables, you
  8189. can insert radio lists templates in HTML, La@TeX{} and Texinfo modes by
  8190. calling @code{org-list-insert-radio-list}.
  8191. Here are the differences with radio tables:
  8192. @itemize @minus
  8193. @item
  8194. Use @code{ORGLST} instead of @code{ORGTBL}.
  8195. @item
  8196. The available translation functions for radio lists don't take
  8197. parameters.
  8198. @item
  8199. `C-c C-c' will work when pressed on the first item of the list.
  8200. @end itemize
  8201. Here is a La@TeX{} example. Let's say that you have this in your
  8202. La@TeX{} file:
  8203. @example
  8204. % BEGIN RECEIVE ORGLST to-buy
  8205. % END RECEIVE ORGLST to-buy
  8206. \begin@{comment@}
  8207. #+ORGLIST: SEND to-buy orgtbl-to-latex
  8208. - a new house
  8209. - a new computer
  8210. + a new keyboard
  8211. + a new mouse
  8212. - a new life
  8213. \end@{comment@}
  8214. @end example
  8215. Pressing `C-c C-c' on @code{a new house} and will insert the converted
  8216. La@TeX{} list between the two marker lines.
  8217. @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
  8218. @section Dynamic blocks
  8219. @cindex dynamic blocks
  8220. Org documents can contain @emph{dynamic blocks}. These are
  8221. specially marked regions that are updated by some user-written function.
  8222. A good example for such a block is the clock table inserted by the
  8223. command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
  8224. Dynamic block are enclosed by a BEGIN-END structure that assigns a name
  8225. to the block and can also specify parameters for the function producing
  8226. the content of the block.
  8227. #+BEGIN:dynamic block
  8228. @example
  8229. #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
  8230. #+END:
  8231. @end example
  8232. Dynamic blocks are updated with the following commands
  8233. @table @kbd
  8234. @kindex C-c C-x C-u
  8235. @item C-c C-x C-u
  8236. Update dynamic block at point.
  8237. @kindex C-u C-c C-x C-u
  8238. @item C-u C-c C-x C-u
  8239. Update all dynamic blocks in the current file.
  8240. @end table
  8241. Updating a dynamic block means to remove all the text between BEGIN and
  8242. END, parse the BEGIN line for parameters and then call the specific
  8243. writer function for this block to insert the new content. If you want
  8244. to use the original content in the writer function, you can use the
  8245. extra parameter @code{:content}.
  8246. For a block with name @code{myblock}, the writer function is
  8247. @code{org-dblock-write:myblock} with as only parameter a property list
  8248. with the parameters given in the begin line. Here is a trivial example
  8249. of a block that keeps track of when the block update function was last
  8250. run:
  8251. @example
  8252. #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
  8253. #+END:
  8254. @end example
  8255. @noindent
  8256. The corresponding block writer function could look like this:
  8257. @lisp
  8258. (defun org-dblock-write:block-update-time (params)
  8259. (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
  8260. (insert "Last block update at: "
  8261. (format-time-string fmt (current-time)))))
  8262. @end lisp
  8263. If you want to make sure that all dynamic blocks are always up-to-date,
  8264. you could add the function @code{org-update-all-dblocks} to a hook, for
  8265. example @code{before-save-hook}. @code{org-update-all-dblocks} is
  8266. written in a way that is does nothing in buffers that are not in
  8267. @code{org-mode}.
  8268. @node Special agenda views, Using the property API, Dynamic blocks, Hacking
  8269. @section Special agenda views
  8270. @cindex agenda views, user-defined
  8271. Org provides a special hook that can be used to narrow down the
  8272. selection made by any of the agenda views. You may specify a function
  8273. that is used at each match to verify if the match should indeed be part
  8274. of the agenda view, and if not, how much should be skipped.
  8275. Let's say you want to produce a list of projects that contain a WAITING
  8276. tag anywhere in the project tree. Let's further assume that you have
  8277. marked all tree headings that define a project with the TODO keyword
  8278. PROJECT. In this case you would run a TODO search for the keyword
  8279. PROJECT, but skip the match unless there is a WAITING tag anywhere in
  8280. the subtree belonging to the project line.
  8281. To achieve this, you must write a function that searches the subtree for
  8282. the tag. If the tag is found, the function must return @code{nil} to
  8283. indicate that this match should not be skipped. If there is no such
  8284. tag, return the location of the end of the subtree, to indicate that
  8285. search should continue from there.
  8286. @lisp
  8287. (defun my-skip-unless-waiting ()
  8288. "Skip trees that are not waiting"
  8289. (let ((subtree-end (save-excursion (org-end-of-subtree t))))
  8290. (if (re-search-forward ":waiting:" subtree-end t)
  8291. nil ; tag found, do not skip
  8292. subtree-end))) ; tag not found, continue after end of subtree
  8293. @end lisp
  8294. Now you may use this function in an agenda custom command, for example
  8295. like this:
  8296. @lisp
  8297. (org-add-agenda-custom-command
  8298. '("b" todo "PROJECT"
  8299. ((org-agenda-skip-function 'my-org-waiting-projects)
  8300. (org-agenda-overriding-header "Projects waiting for something: "))))
  8301. @end lisp
  8302. Note that this also binds @code{org-agenda-overriding-header} to get a
  8303. meaningful header in the agenda view.
  8304. A general way to create custom searches is to base them on a search for
  8305. entries with a certain level limit. If you want to study all entries with
  8306. your custom search function, simply do a search for @samp{LEVEL>0}, and then
  8307. use @code{org-agenda-skip-function} to select the entries you really want to
  8308. have.
  8309. You may also put a Lisp form into @code{org-agenda-skip-function}. In
  8310. particular, you may use the functions @code{org-agenda-skip-entry-if}
  8311. and @code{org-agenda-skip-subtree-if} in this form, for example:
  8312. @table @code
  8313. @item '(org-agenda-skip-entry-if 'scheduled)
  8314. Skip current entry if it has been scheduled.
  8315. @item '(org-agenda-skip-entry-if 'notscheduled)
  8316. Skip current entry if it has not been scheduled.
  8317. @item '(org-agenda-skip-entry-if 'deadline)
  8318. Skip current entry if it has a deadline.
  8319. @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
  8320. Skip current entry if it has a deadline, or if it is scheduled.
  8321. @item '(org-agenda-skip-entry 'regexp "regular expression")
  8322. Skip current entry if the regular expression matches in the entry.
  8323. @item '(org-agenda-skip-entry 'notregexp "regular expression")
  8324. Skip current entry unless the regular expression matches.
  8325. @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
  8326. Same as above, but check and skip the entire subtree.
  8327. @end table
  8328. Therefore we could also have written the search for WAITING projects
  8329. like this, even without defining a special function:
  8330. @lisp
  8331. (org-add-agenda-custom-command
  8332. '("b" todo "PROJECT"
  8333. ((org-agenda-skip-function '(org-agenda-skip-subtree-if
  8334. 'regexp ":waiting:"))
  8335. (org-agenda-overriding-header "Projects waiting for something: "))))
  8336. @end lisp
  8337. @node Using the property API, Using the mapping API, Special agenda views, Hacking
  8338. @section Using the property API
  8339. @cindex API, for properties
  8340. @cindex properties, API
  8341. Here is a description of the functions that can be used to work with
  8342. properties.
  8343. @defun org-entry-properties &optional pom which
  8344. Get all properties of the entry at point-or-marker POM.
  8345. This includes the TODO keyword, the tags, time strings for deadline,
  8346. scheduled, and clocking, and any additional properties defined in the
  8347. entry. The return value is an alist, keys may occur multiple times
  8348. if the property key was used several times.
  8349. POM may also be nil, in which case the current entry is used.
  8350. If WHICH is nil or `all', get all properties. If WHICH is
  8351. `special' or `standard', only get that subclass.
  8352. @end defun
  8353. @defun org-entry-get pom property &optional inherit
  8354. Get value of PROPERTY for entry at point-or-marker POM. By default,
  8355. this only looks at properties defined locally in the entry. If INHERIT
  8356. is non-nil and the entry does not have the property, then also check
  8357. higher levels of the hierarchy. If INHERIT is the symbol
  8358. @code{selective}, use inheritance if and only if the setting of
  8359. @code{org-use-property-inheritance} selects PROPERTY for inheritance.
  8360. @end defun
  8361. @defun org-entry-delete pom property
  8362. Delete the property PROPERTY from entry at point-or-marker POM.
  8363. @end defun
  8364. @defun org-entry-put pom property value
  8365. Set PROPERTY to VALUE for entry at point-or-marker POM.
  8366. @end defun
  8367. @defun org-buffer-property-keys &optional include-specials
  8368. Get all property keys in the current buffer.
  8369. @end defun
  8370. @defun org-insert-property-drawer
  8371. Insert a property drawer at point.
  8372. @end defun
  8373. @defun org-entry-put-multivalued-property pom property &rest values
  8374. Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
  8375. strings. They will be concatenated, with spaces as separators.
  8376. @end defun
  8377. @defun org-entry-get-multivalued-property pom property
  8378. Treat the value of the property PROPERTY as a whitespace-separated list of
  8379. values and return the values as a list of strings.
  8380. @end defun
  8381. @defun org-entry-add-to-multivalued-property pom property value
  8382. Treat the value of the property PROPERTY as a whitespace-separated list of
  8383. values and make sure that VALUE is in this list.
  8384. @end defun
  8385. @defun org-entry-remove-from-multivalued-property pom property value
  8386. Treat the value of the property PROPERTY as a whitespace-separated list of
  8387. values and make sure that VALUE is @emph{not} in this list.
  8388. @end defun
  8389. @defun org-entry-member-in-multivalued-property pom property value
  8390. Treat the value of the property PROPERTY as a whitespace-separated list of
  8391. values and check if VALUE is in this list.
  8392. @end defun
  8393. @node Using the mapping API, , Using the property API, Hacking
  8394. @section Using the mapping API
  8395. @cindex API, for mapping
  8396. @cindex mapping entries, API
  8397. Org has sophisticated mapping capabilities to find all entries satisfying
  8398. certain criteria. Internally, this functionality is used to produce agenda
  8399. views, but there is also an API that can be used to execute arbitrary
  8400. functions for each or selected entries. The main entry point for this API
  8401. is:
  8402. @defun org-map-entries func &optional match scope &rest skip
  8403. Call FUNC at each headline selected by MATCH in SCOPE.
  8404. FUNC is a function or a lisp form. The function will be called without
  8405. arguments, with the cursor positioned at the beginning of the headline.
  8406. The return values of all calls to the function will be collected and
  8407. returned as a list.
  8408. MATCH is a tags/property/todo match as it is used in the agenda match view.
  8409. Only headlines that are matched by this query will be considered during
  8410. the iteration. When MATCH is nil or t, all headlines will be
  8411. visited by the iteration.
  8412. SCOPE determines the scope of this command. It can be any of:
  8413. @example
  8414. nil @r{the current buffer, respecting the restriction if any}
  8415. tree @r{the subtree started with the entry at point}
  8416. file @r{the current buffer, without restriction}
  8417. file-with-archives
  8418. @r{the current buffer, and any archives associated with it}
  8419. agenda @r{all agenda files}
  8420. agenda-with-archives
  8421. @r{all agenda files with any archive files associated with them}
  8422. (file1 file2 ...)
  8423. @r{if this is a list, all files in the list will be scanned}
  8424. @end example
  8425. The remaining args are treated as settings for the skipping facilities of
  8426. the scanner. The following items can be given here:
  8427. @example
  8428. archive @r{skip trees with the archive tag}
  8429. comment @r{skip trees with the COMMENT keyword}
  8430. function or Lisp form
  8431. @r{will be used as value for @code{org-agenda-skip-function},}
  8432. @r{so whenever the the function returns t, FUNC}
  8433. @r{will not be called for that entry and search will}
  8434. @r{continue from the point where the function leaves it}
  8435. @end example
  8436. @end defun
  8437. The function given to that mapping routine can really do anything you like.
  8438. It can uce the property API (@pxref{Using the property API}) to gather more
  8439. information about the entry, or in order to change metadate in the entry.
  8440. Here are a couple of functions that might be handy:
  8441. @defun org-todo &optional arg
  8442. Change the TODO state of the entry, see the docstring of the functions for
  8443. the many possible values for the argument ARG.
  8444. @end defun
  8445. @defun org-priority &optional action
  8446. Change the priority of the entry, see the docstring of this function for the
  8447. possible values for ACTION.
  8448. @end defun
  8449. @defun org-toggle-tag tag &optional onoff
  8450. Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
  8451. or @code{off} will not toggle tag, but ensure that it is either on or off.
  8452. @end defun
  8453. @defun org-promote
  8454. Promote the current entry.
  8455. @end defun
  8456. @defun org-demote
  8457. Demote the current entry.
  8458. @end defun
  8459. Here is a simple example that will turn all entries in the current file with
  8460. a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
  8461. Entries in comment trees and in archive trees will be ignored.
  8462. @lisp
  8463. (org-map-entries
  8464. '(org-todo "UPCOMING")
  8465. "+TOMORROW" 'file 'archive 'comment)
  8466. @end lisp
  8467. The following example counts the number of entries with TODO keyword
  8468. @code{WAITING}, in all agenda files.
  8469. @lisp
  8470. (length (org-map-entries t "/+WAITING" nil 'agenda))
  8471. @end lisp
  8472. @node History and Acknowledgments, Main Index, Hacking, Top
  8473. @appendix History and Acknowledgments
  8474. @cindex acknowledgments
  8475. @cindex history
  8476. @cindex thanks
  8477. Org was borne in 2003, out of frustration over the user interface
  8478. of the Emacs Outline mode. I was trying to organize my notes and
  8479. projects, and using Emacs seemed to be the natural way to go. However,
  8480. having to remember eleven different commands with two or three keys per
  8481. command, only to hide and show parts of the outline tree, that seemed
  8482. entirely unacceptable to me. Also, when using outlines to take notes, I
  8483. constantly want to restructure the tree, organizing it parallel to my
  8484. thoughts and plans. @emph{Visibility cycling} and @emph{structure
  8485. editing} were originally implemented in the package
  8486. @file{outline-magic.el}, but quickly moved to the more general
  8487. @file{org.el}. As this environment became comfortable for project
  8488. planning, the next step was adding @emph{TODO entries}, basic @emph{time
  8489. stamps}, and @emph{table support}. These areas highlight the two main
  8490. goals that Org still has today: To create a new, outline-based,
  8491. plain text mode with innovative and intuitive editing features, and to
  8492. incorporate project planning functionality directly into a notes file.
  8493. A special thanks goes to @i{Bastien Guerry} who has not only writen a large
  8494. number of extensions to Org (most of them integrated into the core by now),
  8495. but has also helped the development and maintenance of Org so much that he
  8496. should be considered co-author of this package.
  8497. Since the first release, literally thousands of emails to me or on
  8498. @code{emacs-orgmode@@gnu.org} have provided a constant stream of bug
  8499. reports, feedback, new ideas, and sometimes patches and add-on code.
  8500. Many thanks to everyone who has helped to improve this package. I am
  8501. trying to keep here a list of the people who had significant influence
  8502. in shaping one or more aspects of Org. The list may not be
  8503. complete, if I have forgotten someone, please accept my apologies and
  8504. let me know.
  8505. @itemize @bullet
  8506. @item
  8507. @i{Russel Adams} came up with the idea for drawers.
  8508. @item
  8509. @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
  8510. @item
  8511. @i{Christophe Bataillon} created the great unicorn logo that we use on the
  8512. Org-mode website.
  8513. @item
  8514. @i{Alex Bochannek} provided a patch for rounding time stamps.
  8515. @item
  8516. @i{Charles Cave}'s suggestion sparked the implementation of templates
  8517. for Remember.
  8518. @item
  8519. @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
  8520. specified time.
  8521. @item
  8522. @i{Gregory Chernov} patched support for lisp forms into table
  8523. calculations and improved XEmacs compatibility, in particular by porting
  8524. @file{nouline.el} to XEmacs.
  8525. @item
  8526. @i{Sacha Chua} suggested to copy some linking code from Planner.
  8527. @item
  8528. @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
  8529. came up with the idea of properties, and that there should be an API for
  8530. them.
  8531. @item
  8532. @i{Kees Dullemond} used to edit projects lists directly in HTML and so
  8533. inspired some of the early development, including HTML export. He also
  8534. asked for a way to narrow wide table columns.
  8535. @item
  8536. @i{Christian Egli} converted the documentation into Texinfo format,
  8537. patched CSS formatting into the HTML exporter, and inspired the agenda.
  8538. @item
  8539. @i{David Emery} provided a patch for custom CSS support in exported
  8540. HTML agendas.
  8541. @item
  8542. @i{Nic Ferrier} contributed mailcap and XOXO support.
  8543. @item
  8544. @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
  8545. @item
  8546. @i{John Foerch} figured out how to make incremental search show context
  8547. around a match in a hidden outline tree.
  8548. @item
  8549. @i{Niels Giesen} had the idea to automatically archive DONE trees.
  8550. @item
  8551. @i{Bastien Guerry} wrote the La@TeX{} exporter and @file{org-bibtex.el}, and
  8552. has been prolific with patches, ideas, and bug reports.
  8553. @item
  8554. @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
  8555. @item
  8556. @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
  8557. task state change logging, and the clocktable. His clear explanations have
  8558. been critical when we started to adopt the GIT version control system.
  8559. @item
  8560. @i{Manuel Hermenegildo} has contributed various ideas, small fixed and
  8561. patches.
  8562. @item
  8563. @i{Phil Jackson} wrote @file{org-irc.el}.
  8564. @item
  8565. @i{Scott Jaderholm} proposed footnotes, control over whitespace between
  8566. folded entries, and column view for properties.
  8567. @item
  8568. @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
  8569. @item
  8570. @i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also
  8571. provided frequent feedback and some patches.
  8572. @item
  8573. @i{Jason F. McBrayer} suggested agenda export to CSV format.
  8574. @item
  8575. @i{Max Mikhanosha} came up with the idea of refiling.
  8576. @item
  8577. @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
  8578. basis.
  8579. @item
  8580. @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
  8581. happy.
  8582. @item
  8583. @i{Rick Moynihan} proposed to allow multiple TODO sequences in a file
  8584. and to be able to quickly restrict the agenda to a subtree.
  8585. @item
  8586. @i{Todd Neal} provided patches for links to Info files and elisp forms.
  8587. @item
  8588. @i{Tim O'Callaghan} suggested in-file links, search options for general
  8589. file links, and TAGS.
  8590. @item
  8591. @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
  8592. into Japanese.
  8593. @item
  8594. @i{Oliver Oppitz} suggested multi-state TODO items.
  8595. @item
  8596. @i{Scott Otterson} sparked the introduction of descriptive text for
  8597. links, among other things.
  8598. @item
  8599. @i{Pete Phillips} helped during the development of the TAGS feature, and
  8600. provided frequent feedback.
  8601. @item
  8602. @i{T.V. Raman} reported bugs and suggested improvements.
  8603. @item
  8604. @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
  8605. control.
  8606. @item
  8607. @i{Kevin Rogers} contributed code to access VM files on remote hosts.
  8608. @item
  8609. @i{Sebastian Rose} wrote @file{org-info.js}, a Java script for displaying
  8610. webpages derived from Org using an Info-like, or a folding interface with
  8611. single key navigation.
  8612. @item
  8613. @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
  8614. conflict with @file{allout.el}.
  8615. @item
  8616. @i{Jason Riedy} generalized the send-receive mechanism for orgtbl tables with
  8617. extensive patches.
  8618. @item
  8619. @i{Philip Rooke} created the Org reference card, provided lots
  8620. of feedback, developed and applied standards to the Org documentation.
  8621. @item
  8622. @i{Christian Schlauer} proposed angular brackets around links, among
  8623. other things.
  8624. @item
  8625. @i{Eric Schulte} wrote @file{org-plot.el}.
  8626. @item
  8627. Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
  8628. @file{organizer-mode.el}.
  8629. @item
  8630. @i{Ilya Shlyakhter} proposed the Archive Sibling.
  8631. @item
  8632. @i{Daniel Sinder} came up with the idea of internal archiving by locking
  8633. subtrees.
  8634. @item
  8635. @i{Dale Smith} proposed link abbreviations.
  8636. @item
  8637. @i{James TD Smith} has contributed a large number of patches for useful
  8638. tweaks and features.
  8639. @item
  8640. @i{Adam Spiers} asked for global linking commands, inspired the link
  8641. extension system, added support for mairix, and proposed the mapping API.
  8642. @item
  8643. @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
  8644. chapter about publishing.
  8645. @item
  8646. @i{J@"urgen Vollmer} contributed code generating the table of contents
  8647. in HTML output.
  8648. @item
  8649. @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
  8650. keyword.
  8651. @item
  8652. @i{David Wainberg} suggested archiving, and improvements to the linking
  8653. system.
  8654. @item
  8655. @i{John Wiegley} wrote @file{emacs-wiki.el}, @file{planner.el}, and
  8656. @file{muse.el}, which have similar goals as Org. Initially the
  8657. development of Org was fully independent because I was not aware of the
  8658. existence of these packages. But with time I have accasionally looked
  8659. at John's code and learned a lot from it. John has also contributed a
  8660. number of great ideas and patches directly to Org, including the attachment
  8661. system (@file{org-attach.el}) and integration with Apple Mail
  8662. (@file{org-mac-message.el}).
  8663. @item
  8664. @i{Carsten Wimmer} suggested some changes and helped fix a bug in
  8665. linking to Gnus.
  8666. @item
  8667. @i{Roland Winkler} requested additional key bindings to make Org
  8668. work on a tty.
  8669. @item
  8670. @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
  8671. and contributed various ideas and code snippets.
  8672. @end itemize
  8673. @node Main Index, Key Index, History and Acknowledgments, Top
  8674. @unnumbered The Main Index
  8675. @printindex cp
  8676. @node Key Index, , Main Index, Top
  8677. @unnumbered Key Index
  8678. @printindex ky
  8679. @bye
  8680. @ignore
  8681. arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
  8682. @end ignore
  8683. @c Local variables:
  8684. @c ispell-local-dictionary: "en_US-w_accents"
  8685. @c ispell-local-pdict: "./.aspell.org.pws"
  8686. @c fill-column: 77
  8687. @c End: